KIBO OMS DOCUMENTATION

Assign Shipment

Much like the Assign Order API, the Assign Shipment API will assign a shipment to a fulfiller. It can do this either automatically or manually based on a provided Location ID.

This API can also be used to reassign, backorder, and cancel items from a shipment. For cancellation, the request body should only contain the items that will be rejected from the assignment. These actions can split shipments by assigning each item separately. See the examples for how to do this, but note that orders cannot be split once fulfilled. They can only be split while the shipment is in pullInventory or printPackingSlip. See the Transition State guide for an explanation of these states.

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

The .json address above can be used to access the schema within Postman. An example use of the Assign Shipment API follows here — or go directly to the schema or the sample Postman Collection.

Example

The example will demonstrate how to manage orders with the assignment, cancellation, and backorder structures for Assign Shipment calls. There are not different endpoints for each of these, only differences in the body content that determine what should be done with the shipment items.

Required Parameters

Each of the three actions that can be done to a shipment with this API require:

ParameterTypeDescription
shipmentIDintegerA unique identifier for the shipment. The minimum value is "1".
sendEmailsbooleanShould emails be sent?
rectifyOrderbooleanShould the order be rectified?
packageAssignmentarrayThe details for how to assign the shipment.

Package Assignment Options

The Package Assignment property can be defined by any of three possible options. One is the standard assign option, while the others are the cancel and backorder actions that can be performed by this API.

Option One: Assign

The following properties are available to assign a shipment. AutoAssign, locationID, shippingAmount, shippingTaxAmount, and itemAssign are required.

ParameterTypeDescription
shipmentIDintegerA unique identifier for the shipment. The minimum value is "1".
autoAssignbooleanWhether the order should be auto assigned to a fulfiller.
locationIDintegerA unique identifier for the fulfillment location. The minimum value is "1".
shippingAmountnumberThe shipping amount of the shipment. The minimum value is "0".
shippingTaxAmountnumberThe shipping tax amount of the shipment. The minimum value is "0".
shippingTaxRatenumberThe shipping tax rate of the shipment. The minimum value is "0".
shipmentStatusenumThe current status of the shipment (READY or ASSIGNED).

Option Two: Cancel

Only one property is required to cancel a shipment assignment.

ParameterTypeDescription
shipmentStatusenumThe current status of the shipment (CANCELLED).

Option Three: Backorder

To assign a shipment to backorder, use the following structure. Only shipmentStatus is required.

ParameterTypeDescription
shipmentStatusenumThe current status of the shipment (BACKORDER).
backOrderReleaseDatestringThe date the shipment will be released from backorder. Supports date-time format.

Item Assign

Each of these options can be combined with an Item Assign (/packageAssignment/itemAssign/) object to specify the package items being assigned. The Item Assign parameters are listed below, but only an orderItemID is required.

ParameterTypeDescription
orderItemIDintegerA unique identifier for the order item. The minimum value is "0".
itemTaxAmountnumberThe amount of tax on the order item. The minimum value is "0".
itemTaxRatenumberThe rate of tax on the order item. The minimum value is "0".
quantityintegerThe quantity of order items included.
dispositionReasonenumThe reason for the cancellation (customer_changed_mind, created_by_mistake, etc.).
dispositionOtherReasonstringIf dispositionReason is ’other’, provide an explanation here. The minimum length is 1 and the maximum length is 255.

The Assign Request

This is the entire request that will assign a shipment. There are two items defined in this sample, one being automatically assigned and the other manually assigned to Location 11111.

{  
   "shipmentID":0123456,
   "sendEmails":false,
   "rectifyOrder":true,
   "packageAssignment":[
   	  {  
         "autoAssign":true,
         "itemAssign":[  
            {  
               "orderItemID":6543210,
               "quantity":1
            }
         ]
      },
      {  
         "autoAssign":false,
         "locationID":11111,
         "shippingAmount":2.00,
         "shippingTaxAmount":0,
         "itemAssign":[  
            {  
               "orderItemID":96969696,
               "itemTaxAmount":0,
               "quantity":1
            }
         ]
      }
   ]
}

 

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

The Cancel Request

The Item Assign block should only contain the items that will be rejected from the assignment.

{  
   "shipmentID":0123456,
   "sendEmails":false,
   "rectifyOrder":true,
   "packageAssignment":[  
      {  
         "shipmentStatus":"CANCELLED",
         "itemAssign":[  
            {  
               "orderItemID":434343
            }
         ]
      }
   ]
}

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

The Backorder Request

This is the entire request that will place an order in backorder.

{  
   "shipmentID":0123456,
   "sendEmails":false,
   "rectifyOrder":true,
   "packageAssignment":[  
      {  
         "shipmentStatus":"BACKORDER",
         "itemAssign":[  
            {  
               "orderItemID":89898989,
               "quantity":1,
               "backOrderDuration":7
            }
         ]
      }
   ]
}

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


Megan MayfieldOMS Dev: Assign Shipment