API Reference

Mark received

Use this endpoint to mark a group of shipments as done.

Partial receipt

If a shipment was received partially, 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 return shipment and mark it as 'done'. Any remaining items to receive are split onto a new return shipment to be received in the future.
  • split_and_keep_open—The existing return shipment will remain open for the yet-to-be-received items. The partially received items are split onto a new shipment and marked as 'done'.

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.

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!