Skip to main content
PUT
Error

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Headers

If-Match
string

If-Match

x-vol-site
integer<int32>
x-vol-tenant
integer<int32>
required

Path Parameters

packageConsolidationId
string
required

packageConsolidationId

shipmentNumber
integer<int32>
required

shipmentNumber

Body

application/json

packageDto

attributes
object
auditInfo
AuditInfo · object
carrier
string
carrierName
string
cartonization
CartonizationDto · object
fullyMatched
boolean

Whether every line item's received+substituted quantity matched its expected quantity for this package. Null until received or when not eligible/flag disabled.

fxcbDocumentsUrl
string
fxcbPackNotificationId
string
hasLabel
boolean
integratorId
string
labelFormat
string
manifestId
string
measurements
PackageMeasurements · object
packageConsolidationId
string
packageId
string
packagingType
string
packingSlipItemDetails
PackingSlipItemDetailDto · object[]
packingSlipNumber
integer<int32>
receiptStatus
enum<string>

Package-level receipt status (NOT_RECEIVED/RECEIVED). Null when not eligible/tenant attribute disabled.

Available options:
NOT_RECEIVED,
RECEIVED
receivedBy
string

User ID that received this package. Null until received or when not eligible/flag disabled.

receivedDate
string<date-time>

Timestamp this package was marked received. Null until received or when not eligible/flag disabled.

receivingMethod
enum<string>

Method used to receive this package (TRACKING_NUMBER_RECEIPT/ITEM_VALIDATION). Null until received or when not eligible/flag disabled.

Available options:
TRACKING_NUMBER_RECEIPT,
ITEM_VALIDATION,
WHOLE_SHIPMENT_RECEIPT
returnCarrier
string
returnTrackingNumbers
string[]
returnTrackings
Tracking · object[]
shippingMethodCode
string
shippingMethodName
string
signatureRequired
boolean
stringBarcode
string
trackingNumbers
string[]
trackings
Tracking · object[]

Response

OK

attributes
object
packageConsolidationId
string
packageConsolidations
PackageConsolidationDto · object[]
shipmentConsolidationId
string