Split shipment

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns: The new Shipment entity.

Permissions required: View Orders and Edit Orders.

The Split shipment method is used to split quantities of one or more shipment items in an existing shipment into a new shipment.

For example, say an order is placed for 10 shirts, all of which are rated as a single shipment, and that single shipment needs to be separated into two shipments of 5 shirts each. You can use the Split shipment method to move 5 of the shirts to a new, separate shipment.

Note that the Split shipment method does not assign a shipping and handling price to the new shipment, and the shipping and handling price of the original shipment will not be changed.

Path Params
int32
required

The ID of the shipment that should be split into a new shipment.

Body Params
ShipmentItems
array of objects

The collection of shipment items that should be split into a new shipment.

ShipmentItems
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here!