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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

warehouse

string

required

length ≤ 255

Identifier of the ShipMonk warehouse where the goods will be received.

asn

string

required

length ≤ 255

Advanced Shipping Notice number — a unique identifier for the incoming shipment.

supplier_name

string

required

length ≤ 255

Name of the supplier sending the goods.

estimated_delivery

date

required

Anticipated delivery date in ISO 8601 format (YYYY-MM-DD).

handling_unit_type

string

enum

required

Type of handling unit used for this receiving.

items

array of objects

required

Product line items to be received.

items*

handling_unit_quantity

integer | null

≥ 0

Defaults to null

Number of handling units (e.g. pallets or boxes) in this shipment.

receiving_key

string | null

Defaults to null

Optional unique identifier for the receiving or purchase order on your side.

description

string | null

Defaults to null

Free-text description of the shipment.

bol_number

string | null

Defaults to null

Bill of lading number — a legal document issued by a carrier to a shipper that serves as a contract of carriage and receipt for goods.

200Success