OMS DOCUMENTATIONRESOURCE CENTER

These guides provide examples for many tasks that a developer will need to be familiar with during implementation.

KIBO OMS DEVELOPMENT

Documentation

Release Backorder

A backordered shipment is released when the product has been removed from holding and the shipment can enter the appropriate order processing stage.

Version2.0
Callhttps://integration.shopatron.com/api/v2/shipment/action/releaseBackorder
Supported FormatsJSON
HTTP MethodPOST
Schemahttps://integration.shopatron.com/api/v2/schema/shipment/action/releaseBackorder.json

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.

Example

This example case creates a call that will release the following backordered shipment:

  • Shipment ID 999999
  • In Order ID 111111

Required Parameters

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.

ParameterTypeDescription
orderIDintegerA unique identifier for the order. The minimum value is “1”.
shipmentIDintegerA unique identifier for the shipment. The minimum value is “1”.

Optional Parameters

The request can also include the following additional properties:

ParameterTypeDescription
locationIDinteger 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”.
sendEmailsbooleanShould emails be sent?
rectifyOrderbooleanShould 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.

{ 
 "orderID":111111,
 "shipmentID":999999,
 "locationID":012345,
 "sendEmails":false,
 "rectifyOrder":true
}

The returned response follows the same structure as the Get Shipment API, providing information about the shipment and order that was released.