Sign in

v3

latestOpenAPI 3.1.02026-08-0619186200.1 KB
Receivings

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.
get/v1/integrations/receiving

Query parameters

receivingKeystring nullable

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.

asnstring nullable

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

Response

Success

idinteger required

Server-assigned numeric identifier of the receiving. Use this value to reference the receiving in subsequent API calls.

warehousestring required

Code of the warehouse where the goods are being received.

receiving_keystring nullable required

Client-supplied reference (e.g. purchase order number) for the receiving, or null if none was provided at creation.

asnstring required

Advance Shipping Notice (ASN) number, a supplier-provided identifier for the incoming shipment.

bol_numberstring nullable required

Bill of Lading (BOL) number from the carrier transport document, or null if not provided.

supplier_namestring required

Name of the supplier sending the goods.

handling_unit_type'small_boxes' | 'single_sku_pallet' | 'mixed_sku_pallet' | 'container_20_palletized' | 'container_20_non_palletized' | 'container_40_palletized' | 'container_40_non_palletized' | 'container_53_palletized' | 'container_53_non_palletized' | 'unknown' required
handling_unit_quantityinteger required

Total number of handling units (as specified by handling_unit_type) in the shipment.

estimated_deliverystring required

Estimated date when the shipment is expected to arrive at the warehouse, in ISO 8601 format (YYYY-MM-DD).

descriptionstring nullable required

Free-form notes about the receiving, or null if none were provided.

status'awaiting' | 'arrived' | 'in_progress' | 'received' required
created_atstring date-time required

Timestamp when the receiving record was created, in ISO 8601 format.

updated_atstring date-time required

Timestamp when the receiving record was last modified, in ISO 8601 format.

arrived_atstring date-time nullable required

Timestamp when the shipment physically arrived at the warehouse, in ISO 8601 format. Null until arrival.

received_atstring date-time nullable required

Timestamp when all goods finished being received and counted, in ISO 8601 format. Null until processing is complete.

All 23 operations