API Reference

Create or Update Receiving

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

General description

  • ERP push to ShipMonk
  • items.[].lot or any of its property can be null

ASN & Receiving Key

  • When updating a Receiving, the identifying properties are receiving_key and asn in this order.
    • In case both are supplied
      • First, Receiving is retrieved by receiving_key. If found, it is updated with new ASN if current ASN is different than asn in the request body.
      • If not found, Receiving is retrieved by asn. If found, it is updated with new receiving_key in the request body.
      • If not found, new Receiving is created with receiving_key and asn being its unique identifiers.
    • In case only asn is supplied
      • First, Receiving is retrieved by asn. If found, receiving_key of the Receiving is left as-is as it cannot be deleted upon setting up.
      • If not found, new Receiving is created with asn being its unique identifier.
    • In case only receiving_key is supplied
      • The request is rejected, as asn is required field.

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…
Body Params
string
required
length ≤ 255

Code of the warehouse where the goods will be received. Determines which facility processes the shipment.

string
required
length ≤ 255

Advance Shipping Notice (ASN) number, a supplier-provided identifier for the incoming shipment. Used as the natural key for upserting the receiving.

string
required
length ≤ 255

Name of the supplier sending the goods.

date
required

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

string
enum
required

Type of handling unit used to ship the goods.

items
array of objects
required

Line items expected in this receiving, one entry per product (and lot, if tracked).

items*
integer | null
≥ 0
Defaults to null

Total number of handling units (as specified by handling_unit_type) in the shipment. Omit or pass null if unknown.

string | null
Defaults to null

Optional client-supplied reference (e.g. purchase order number) for this receiving. Stored as-is and returned on subsequent reads.

string | null
Defaults to null

Free-text description of the shipment. Optional; use to attach human-readable context such as supplier remarks or handling notes.

string | null
Defaults to null

Bill of lading (BoL) number from the carrier's contract of carriage; optional, supply when the inbound shipment has one for cross-referencing.

Receiving Category | null
Defaults to null

Optional classification of the receiving (e.g. standard, transfer, return). Omit if no specific category applies.

custom_data
array of objects
Defaults to []

Optional list of custom name/value pairs to attach arbitrary metadata to the receiving for reporting or integration use.

custom_data
cartons
array of objects | null
Defaults to null

Cartons in the packing hierarchy (equivalent to EDI 856 Pack level). Each carton has a unique carton_key and may reference a pallet. Absent, null, or [] all normalize to an empty list.

cartons
pallets
array of objects | null
Defaults to null

Pallets in the packing hierarchy (equivalent to EDI 856 Tare level). Each pallet has a unique pallet_key referenced by cartons. Absent, null, or [] all normalize to an empty list.

pallets
tracking_numbers
array of strings | null
Defaults to null

Tracking numbers of packets in this receiving. When omitted on update, the existing tracking numbers are left untouched. When provided as an empty list, all tracking numbers are removed. When provided with values, the existing tracking numbers are replaced with the new list.

tracking_numbers
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