API Reference

Create or Update 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.
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!