KIBO OMS DOCUMENTATION

Update Backorder

A backordered shipment can have its expected release date updated prior to the actual release of the package.

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

The .json address above can be used to access the schema within Postman. An example use of the Update Backorder API follows below, or view the schema or the sample Postman collection.

Example

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

  • Shipment ID 111111
  • Expected release date 07/04/2017

Required Parameters

The request has the following necessary properties, with no optional parameters:

ParameterTypeDescription
shipmentIDintegerA unique identifier for the shipment. The minimum value is "1".
releaseDatestringThe new date the backordered shipment will be released (max 8 weeks from creation date). Time granularity is not supported and will be ignored (date-time).

The Full Request

The complete request to update a backorder is simple. This sets the shipment’s expected release date as specified.

{
 "shipmentID":111111,
 "releaseDate":"2017-07-07"
}

 

 

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


ProductOMS Dev: Update Backorder