Skip to main content
PUT
Error

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Headers

If-Match
string

If-Match

Path Parameters

shipmentNumber
integer<int32>
required

shipmentNumber

Body

application/json

items

actualPrice
number
allocatedQuantity
integer<int32>
allowsBackOrder
boolean
allowsFutureAllocate
boolean
allowsSubstitution
boolean
appeasementReason
AppeasementReason · object
attributes
object
auditInfo
AuditInfo · object
autoSubstitution
boolean
backorderReleaseDate
string<date-time>
bundleInfo
BundleInfo · object
cartItemId
string
childItemIds
string[]
condition
string
creditCurrencyCode
string
creditValue
number
data
object
duty
number
expectedDeliveryDate
string<date-time>
fulfillmentFields
FulfillmentField · object[]
giftCards
GiftCard · object[]
giftMessage
string
goodsType
enum<string>
Available options:
Physical,
Digital,
DigitalCredit,
DigitalGiftCard,
Service
handling
number
handlingDiscount
number
handlingTax
number
height
number
imageUrl
string
inventoryAllocations
InventoryAllocation · object[]
inventoryTags
InventoryTag · object[]
isAssemblyRequired
boolean
isGift
boolean
isPackagedStandAlone
boolean
isReservedInventory
boolean
isTaxable
boolean
itemDiscount
number
itemTax
number
length
number
lineId
integer<int32>
lineItemAdjustment
number
lineItemCost
number
locatorName
string
manageStock
boolean
name
string
optionAttributeFQN
string
options
ProductOption · object[]
originalLineId
integer<int32>
originalOrderItemId
string
originalQuantity
integer<int32>
overridePrice
number
parentItemId
string
partNumber
string
priceMode
enum<string>
Available options:
Internal,
External
productCode
string
purchaseLocation
string
quantity
integer<int32>
readyForPickupQuantity
integer<int32>
returnRuleInfo
ReturnRuleInfo · object
serialNumber
string
shipmentItemAttributes
ShipmentItemAttribute · object[]
shipping
number
shippingDiscount
number
shippingTax
number
sku
string
stockValidationStatus
string
substituteInfo
SubstituteInfo · object
substituteQuantity
integer<int32>
substitutionType
enum<string>
Available options:
PRE_FULFILLMENT,
AT_FULFILLMENT
taxData
object
taxableHandling
number
taxableLineItemCost
number
taxableShipping
number
timeFenceDays
integer<int32>
transferQuantity
integer<int32>
trueTransferQuantity
integer<int32>
unitPrice
number
upc
string
validatedQuantity
integer<int32>
variationProductCode
string
weight
number
weightUnit
string
weightedDutyAdjustment
number
weightedHandlingAdjustment
number
weightedHandlingTaxAdjustment
number
weightedLineItemTaxAdjustment
number
weightedOrderHandlingFee
number
weightedOrderHandlingFeeDiscount
number
weightedOrderHandlingFeeTax
number
weightedShipmentAdjustment
number
weightedShippingAdjustment
number
weightedShippingTaxAdjustment
number
width
number

Response

OK

shipmentType
enum<string>
required

Shipment type code

Available options:
STH,
BOPIS,
BOPIS_Curbside,
Transfer,
Curbside,
Digital,
Delivery
Example:

"STH"

acceptedDate
string<date-time>
alternateContact
Contact · object
appeasementReason
AppeasementReason · object
assignedLocationCode
string
attributes
object
auditInfo
AuditInfo · object
canceledItems
CanceledItem · object[]
carrier
string
cartId
string
changeMessages
ChangeMessage · object[]
channel
string
childShipmentNumbers
integer<int32>[]
currencyCode
string
currentRunId
string

Run currently mutating this shipment (== Kibo.Jobs jobId); null when idle (FR-059d)

customer
Customer · object
customerAccountId
integer<int32>
customerAddressId
integer<int32>
customerTaxId
string
data
object
deliveryWindow
DeliveryWindow · object
destination
Destination · object
dutyAdjustment
number
dutyTotal
number
email
string
expectedDeliveryDate
string<date-time>
externalOrderId
string
fulfillmentDate
string<date-time>
fulfillmentLocationCode
string
fulfillmentPriority
integer<int32>
fulfillmentStatus
enum<string>
Available options:
NotFulfilled,
Fulfilled
futureDate
string<date-time>
groupId
string
handlingAdjustment
number
handlingSubtotal
number
handlingTaxAdjustment
number
handlingTaxTotal
number
handlingTotal
number
holdReleaseDate
string<date-time>
isAutoAssigned
boolean
isCrossDockEligible
boolean
isDropship
boolean
isExpress
boolean
isFlatRateShipping
boolean
isHistoricalImport
boolean
isImmutable
boolean
isOptInForSms
boolean
items
Item · object[]
lastCancellationDate
string<date-time>
lineItemSubtotal
number
lineItemTaxAdjustment
number
lineItemTaxTotal
number
lineItemTotal
number
lowestComplianceLevel
string
masterTrackingNumber
string
minutesSinceOnWorkflowStep
integer<int64>
minutesSinceOrdered
integer<int64>
mutabilityInfo
MutabilityInfo · object
orderId
string
orderNumber
integer<int32>
orderSubmitDate
string<date-time>
orderType
enum<string>
Available options:
Offline,
Online
originalEdd
string<date-time>

First expectedDeliveryDate this shipment ever carried (write-once, never cleared); non-null marks that the shipment has, at some point, had an EDD. Server-managed (FR-060); ignored on inbound writes.

originalShipmentNumber
integer<int32>
packageReceivingEligible
boolean

FR-014/FR-016 multi-package-receiving eligibility signal. Only present when the MULTI_PACKAGE_RECEIVING_FOR_TRANSFER_SHIPMENTS tenant attribute is enabled and the transfer shipment has at least one package; null otherwise so tenants without the attribute enabled see no shape change (US2-AC2).

packages
Package · object[]
packagesPendingCount
integer<int32>

US4 progress display: packagesTotalCount minus packagesReceivedCount. Null when not eligible/flag disabled.

packagesReceivedCount
integer<int32>

US4 progress display: count of packages with receiptStatus=RECEIVED. Null when not eligible/flag disabled.

packagesTotalCount
integer<int32>

US4 progress display: total expected package count. Null when not eligible/flag disabled.

parentCheckoutNumber
integer<int32>
parentShipmentNumber
integer<int32>
paymentInvoice
PaymentInvoice · object
pickStatus
enum<string>
Available options:
AVAILABLE,
IN_WAVE,
PICKED,
TRANSFER,
COMPLETE
pickType
enum<string>
Available options:
NORMAL,
SINGLE,
MULTIPLE
pickWaveNumber
integer<int32>
pickupInfo
object
priorityInfo
PriorityInfo · object
readyForPickup
boolean
readyForPickupDate
string<date-time>
readyToCapture
boolean
reassignedItems
ReassignedItem · object[]
receivedDate
string<date-time>
rejectedItems
RejectedItem · object[]
runInfo
RunInfo · object[]

Capped per-run history of operations that created/mutated this shipment (FR-059d)

sentCustomerAtStoreNotification
boolean
sentCustomerInTransitNotification
boolean
shipDate
string<date-time>
shipmentAdjustment
number
shipmentAttributes
ShipmentAttribute · object[]
shipmentConsolidationId
string
shipmentGroup
string
shipmentNotes
ShipmentNote · object[]
shipmentNumber
integer<int32>
shipmentStatus
enum<string>
Available options:
READY,
REASSIGNED,
BACKORDER,
CANCELED,
FULFILLED,
CUSTOMER_CARE,
DELETED,
FUTURE
shipmentStatusReason
ShipmentStatusReason · object
shippingAdjustment
number
shippingMethodCode
string
shippingMethodName
string
shippingSubtotal
number
shippingTaxAdjustment
number
shippingTaxTotal
number
shippingTotal
number
shopperNotes
ShopperNotes · object
siteId
integer<int32>
slas
Sla · object[]
substitutedItems
SubstitutedItem · object[]
taxData
object
tenantId
integer<int32>
total
number
transferShipmentNumbers
integer<int32>[]
transferredItems
TransferredItem · object[]
transitTime
string
userId
string
workflowProcessContainerId
string
workflowProcessId
string
workflowProcessVersion
string
workflowState
WorkflowState · object