API Reference

When a shipment has been labelled and shipped, use this endpoint to mark a group of shipments as shipped.

Log in to see full request history

Partial receipt

If a shipment was received partially (the supplier short shipped), then you should only receive the quantity that was received.

Receiving strategy

When a partial receipt is completed, it's possible to send back to Fulfil how to split the partially received items:

  • finalize_and_start_new - receive the items on the existing Fulfil supplier shipment and mark it as 'done'. Any remaining items to receive are split on to a new supplier shipment, to receive in the future.
  • split_and_keep_open- The existing supplier shipment will remain open for the yet to receive items. The partially received items are split onto a new supplier shipment and marked as 'done'.

Over shipments

If a supplier ships more than the expected quantity, then the quantity should be the actual quantity received.

If an over shipment has a completely different SKU that was not part of the ASN, you will need to co-ordinate with the merchant to issue a new PO (for just new items that were not expected as part of this shipment) and then receive against that ASN.

Best practice

The best practice is to send the line ids in the call to mark a shipment as received. This helps Fulfil and the merchant identify the exact line against which the receiving was done. If you are unable to achieve this, please contact our support team for an alternative method.

Lot numbers

If the lot number does not already exist, a new lot number will be created automatically for you.

Path Params
string
required
Defaults to demo

The merchant_Id (subdomain) of your fulfil instance

Body Params
shipments
array of objects
shipments
Responses

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