Skip to main content
POST
/
commerce
/
shipments
/
bulk
Error
A valid request URL is required to generate request examples
{
  "_embedded": {},
  "_links": {}
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Body

application/json

newShipments

​
orderId
string
required
​
orderNumber
integer<int32>
required
​
shipmentType
string
required
​
total
number<bigdecimal>
required
​
acceptedDate
string<date-time>
​
alternateContact
Contact · object
​
appeasementReason
AppeasementReason · object
​
assignedLocationCode
string
​
attributes
object
​
auditInfo
AuditInfo0 · object
​
canceledItems
CanceledItem · object[]
​
cartId
string
​
changeMessages
ChangeMessage · object[]
​
childShipmentNumbers
integer<int32>[]
​
currencyCode
string
​
customer
Customer · object
​
customerAccountId
integer<int32>
​
customerAddressId
integer<int32>
​
customerTaxId
string
​
data
object
​
destination
Destination · object
​
dutyAdjustment
number<bigdecimal>
​
dutyTotal
number<bigdecimal>
​
email
string
​
externalOrderId
string
​
fulfillmentDate
string<date-time>
​
fulfillmentLocationCode
string
​
fulfillmentStatus
enum<string>
Available options:
Fulfilled,
NotFulfilled
​
futureDate
string<date-time>
​
handlingAdjustment
number<bigdecimal>
​
handlingSubtotal
number<bigdecimal>
​
handlingTaxAdjustment
number<bigdecimal>
​
handlingTaxTotal
number<bigdecimal>
​
handlingTotal
number<bigdecimal>
​
isAutoAssigned
boolean
​
isExpress
boolean
​
isHistoricalImport
boolean
​
isOptInForSms
boolean
​
items
Item · object[]
​
lineItemSubtotal
number<bigdecimal>
​
lineItemTaxAdjustment
number<bigdecimal>
​
lineItemTaxTotal
number<bigdecimal>
​
lineItemTotal
number<bigdecimal>
​
orderSubmitDate
string<date-time>
​
originalShipmentNumber
integer<int32>
​
packages
Package · object[]
​
parentCheckoutNumber
integer<int32>
​
parentShipmentNumber
integer<int32>
​
pickStatus
enum<string>
Available options:
AVAILABLE,
COMPLETE,
IN_WAVE,
PICKED,
TRANSFER
​
pickType
enum<string>
Available options:
MULTIPLE,
NORMAL,
SINGLE
​
pickWaveNumber
integer<int32>
​
pickupInfo
object
​
readyForPickup
boolean
​
readyForPickupDate
string<date-time>
​
readyToCapture
boolean
​
reassignedItems
ReassignedItem · object[]
​
receivedDate
string<date-time>
​
rejectedItems
RejectedItem · object[]
​
sentCustomerAtStoreNotification
boolean
​
sentCustomerInTransitNotification
boolean
​
shipmentAdjustment
number<bigdecimal>
​
shipmentNotes
ShipmentNote · object[]
​
shipmentNumber
integer<int32>
​
shipmentStatus
enum<string>
Available options:
BACKORDER,
CANCELED,
CUSTOMER_CARE,
DELETED,
FULFILLED,
FUTURE,
READY,
REASSIGNED
​
shipmentStatusReason
ShipmentStatusReason · object
​
shippingAdjustment
number<bigdecimal>
​
shippingMethodCode
string
​
shippingMethodName
string
​
shippingSubtotal
number<bigdecimal>
​
shippingTaxAdjustment
number<bigdecimal>
​
shippingTaxTotal
number<bigdecimal>
​
shippingTotal
number<bigdecimal>
​
shopperNotes
ShopperNotes · object
​
siteId
integer<int32>
​
taxData
object
​
tenantId
integer<int32>
​
transferShipmentNumbers
integer<int32>[]
​
transferredItems
TransferredItem · object[]
​
transitTime
string
​
userId
string
​
workflowProcessContainerId
string
​
workflowProcessId
string
​
workflowState
WorkflowState · object

Response

OK

​
_embedded
object
​
_links
object