Get Receiving

ASN & Receiving Key

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

  • If both are supplied, they must both match a single Receiving.
  • Supplying only one of the parameters is strongly advised.

LineKey

When item objects are supplied with a line_key string field, those items are uniquely identified and can be referenced by it later — for example, to change expected quantity. Line Key must be unique per receiving.

  • line_key is optional. Null or missing values are expected and supported.
  • Lines without a line_key can still be updated: they are matched by product and lot. If a product and lot combination are specified multiple times in a single POST request, they are grouped and their quantities summed.
  • On update, if exactly one existing line matches a given product and lot, that line is updated.
  • If multiple keyless lines share the same product and lot, they cannot be told apart and are replaced as a group, with the request treated as the source of truth.
  • Supply a line_key whenever you need to reliably target a specific line — especially when a receiving has more than one line for the same product and lot.
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

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