API Reference

When shipments have been successfully ported into the 3PL's WMS, you should acknowledge the shipment. Acknowledging the shipment helps the customer service team at the merchant gain visibility into the fulfillment process.

Log in to see full request history
curl --location --request PUT 'https://{merchant}.fulfil.io/services/3pl/v1/customer-shipments/acknowledge.json' \ --data-raw '{ "shipments": [ { "id": 1, "warehouse": 5, //optional warehouse id if shipment needs to be fulfilled from a different warehouse "tpl_reference": "ORD-123" // external 3PL order reference number which can be used to track the order in Fulfil } ] }'

Responses

200
When all shipments in the payload are successfully acknowledged

207
When one or more shipments could not be acknowledged. Check the errors attribute on the shipments object in Responses

{ "shipments": [ {"id": 1234, "acknowledged_at": "2020-05-01T12:32:01", errors: null}, {"id": 1235, "acknowledged_at": null, errors: ["Shipment not found"]}, {"id": 1236, "acknowledged_at": "2020-05-01T12:32:01", errors: ["This shipment is already acknowledged"]}, {"id": 1236, "acknowledged_at": null, errors: ["The shipment is cancelled"]}, {"id": 1236, "acknowledged_at": null, errors: ["The shipment cannot be acknowledged"]}, ] }

400
When the payload is incorrect or cannot be processed

{ "errors": ["Shipments not present in request payload"] }
Path Params
string
required
Defaults to demo

The merchant_Id (subdomain) of your fulfil instance

Body Params
shipments
array of objects
required

an array of objects with the shipment id of each shipment to be acknowledged

shipments*
Responses

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