Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

shipmentNumber
integer<int32>
required
orderId
string
required

Query Parameters

responseFields
string

limits which fields are returned in the response body

Body

application/json
newShipment
object
originalShipment
object

Response

OK

alternateContact
object
attributes
object[] | null
auditInfo
object
backorderCreatedDate
integer<int32> | null
canceledItems
object[] | null
changeMessages
object[] | null
cost
number<double> | null
currencyCode
string | null
customer
object
customerAccountId
integer<int32> | null
customerTaxId
string | null
read-only
data
object | null
destination
object
dutyAdjustment
number<double>
dutyTotal
number<double>
email
string | null
expectedDeliveryDate
string<date-time> | null
externalOrderId
string | null
externalShipmentId
string | null
fulfillmentDate
string<date-time> | null
fulfillmentLocationCode
string | null
fulfillmentStatus
string | null
futureDate
string<date-time> | null
groupId
string | null

Identifier of the order-level shipping group (ShippingGrouping.Id) whose items are fulfilled by this shipment. Distinct from the internal routing group key stored on the domain entity.

handlingAdjustment
number<double>
handlingSubtotal
number<double>
handlingTaxAdjustment
number<double>
handlingTaxTotal
number<double>
handlingTotal
number<double>
holdReleaseDate
string<date-time> | null
id
string | null

ID of the shipment

isExpress
boolean | null
isFlatRateShipping
boolean | null
isTransfer
boolean | null
items
object[] | null
lineItemSubtotal
number<double>
lineItemTaxAdjustment
number<double>
lineItemTaxTotal
number<double>
lineItemTotal
number<double>
number
integer<int32> | null
orderId
string | null
orderNumber
integer<int32>
orderSubmitDate
string<date-time> | null
origin
object
originalShipmentNumber
integer<int32> | null
packages
object[] | null
parentCheckoutNumber
integer<int32> | null
parentShipmentNumber
integer<int32> | null
pickStatus
string | null
pickType
string | null
pickupInfo
object | null
readyToCapture
boolean
shipmentAdjustment
number<double>
shipmentNotes
object[] | null
shipmentStatus
string | null
shipmentStatusReason
object
shipmentType
string | null
shippingAdjustment
number<double>
shippingMethodCode
string | null
shippingMethodName
string | null
shippingSubtotal
number<double>
shippingTaxAdjustment
number<double>
shippingTaxTotal
number<double>
shippingTotal
number<double>
shopperNotes
object
substitutedItems
object[] | null
taxData
object | null
total
number<double>
transferShipmentNumbers
integer<int32>[] | null
workflowProcessContainerId
string | null
workflowProcessId
string | null
workflowState
object