API Reference

Get Receiving

get
https://api.shipmonk.com/v1/integrations/receiving

ASN & Receiving Key

When retrieving a Receiving, you must supply either receivingKey or asn parameter.

  • In case both is supplied, they must both match a single Receiving.
  • Using only one of the parameters is strongly advised.

LineKey

  • When item objects are supplied with line_key string field, these items are then uniquely identified and can be referenced by it, if needed to change expected quantity.
  • Line Key must be unique per receiving.
  • Null/missing values are also expected. Such lines are then grouped by product and lot if supplied multiple times in the POST request.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string | null
Defaults to null

Optional filter to retrieve a receiving by its external reference key (e.g. purchase order number) assigned by the client when the receiving was created. Returns the matching receiving or null if not found.

string | null
Defaults to null

Optional filter to retrieve a receiving by its Advance Shipping Notice (ASN) number, a supplier-provided identifier for the incoming shipment.

Response

Updated about 1 month ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago