A backordered shipment is released when the product has been removed from holding and the shipment can enter the appropriate order processing stage.
The .json address above can be used to access the schema within Postman. An example use of the Release Backorder API follows below, or view the schema or the sample Postman collection.
This example case creates a call that will release the following backordered shipment:
- Shipment ID 999999
- In Order ID 111111
The request always has the following necessary parameters. However, note that while locationID is not listed as required in the schema, it is a special case. The locationID parameter is optional for non-inventory clients, but must be provided by inventory clients.
|orderID||integer||A unique identifier for the order. The minimum value is “1”.|
|shipmentID||integer||A unique identifier for the shipment. The minimum value is “1”.|
The request can also include the following additional properties:
|locationID||integer|| A unique identifier for the location. As noted above, it is optional for non-inventory clients but must be provided by inventory clients. The minimum value is “1”.|
|sendEmails||boolean||Should emails be sent?|
|rectifyOrder||boolean||Should the order be rectified?|
The Full Request
The complete request to release a backorder is simple and designates which shipment to change the state of.
The returned response follows the same structure as the Get Shipment API, providing information about the shipment and order that was released.