A valid request URL is required to generate request examples{
"shipmentType": "STH",
"_links": {
"empty": true
},
"acceptedDate": "2023-11-07T05:31:56Z",
"alternateContact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "Commercial",
"attributes": {},
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"latitude": "<string>",
"longitude": "<string>",
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"attributes": {},
"companyOrOrganization": "<string>",
"email": "<string>",
"firstName": "<string>",
"fullName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"attributes": {},
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"shortFullName": "<string>"
},
"appeasementReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"assignedLocationCode": "<string>",
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"canceledItems": [
{
"actualPrice": 123,
"allocatedQuantity": 123,
"allowsBackOrder": true,
"allowsFutureAllocate": true,
"allowsSubstitution": true,
"appeasementReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"autoSubstitution": true,
"backorderReleaseDate": "2023-11-07T05:31:56Z",
"blockAssignment": true,
"bundleInfo": {
"attributes": {},
"imageUrl": "<string>",
"name": "<string>",
"productCode": "<string>",
"quantity": 123,
"unitPrice": 123
},
"canceledReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"cartItemId": "<string>",
"childItemIds": [
"<string>"
],
"condition": "<string>",
"creditCurrencyCode": "<string>",
"creditValue": 123,
"data": {},
"duty": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": {}
}
],
"giftCards": [
{
"activationDate": "2023-11-07T05:31:56Z",
"cardNumber": "<string>",
"code": "<string>",
"creditType": "<string>",
"creditValue": 123,
"currencyCode": "<string>",
"currentBalance": 123,
"customerId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"initialBalance": 123
}
],
"giftMessage": "<string>",
"goodsType": "Physical",
"handling": 123,
"handlingDiscount": 123,
"handlingTax": 123,
"height": 123,
"holdBlockAssignment": true,
"imageUrl": "<string>",
"inventoryAllocations": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"condition": "<string>",
"date": "2023-11-07T05:31:56Z",
"fulfilledDate": "2023-11-07T05:31:56Z",
"inventoryId": 123,
"lotCode": "<string>",
"originalQuantity": 123,
"quantity": 123,
"serialNumber": "<string>",
"sku": "<string>",
"status": "<string>"
}
],
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"isAssemblyRequired": true,
"isGift": true,
"isPackagedStandAlone": true,
"isReservedInventory": true,
"isTaxable": true,
"itemDiscount": 123,
"itemTax": 123,
"length": 123,
"lineId": 123,
"lineItemAdjustment": 123,
"lineItemCost": 123,
"locatorName": "<string>",
"manageStock": true,
"name": "<string>",
"optionAttributeFQN": "<string>",
"options": [
{
"attributeFQN": "<string>",
"attributes": {},
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": {},
"stringValue": "<string>",
"value": {}
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "Internal",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"returnRuleInfo": {
"attributes": {},
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipmentItemAttributes": [
{
"attributeDefinitionId": 123,
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
{}
]
}
],
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"stockValidationStatus": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteQuantity": 123,
"substitutionType": "PRE_FULFILLMENT",
"taxData": {},
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"timeFenceDays": 123,
"transferQuantity": 123,
"trueTransferQuantity": 123,
"unitPrice": 123,
"upc": "<string>",
"validatedQuantity": 123,
"variationProductCode": "<string>",
"weight": 123,
"weightUnit": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedOrderHandlingFee": 123,
"weightedOrderHandlingFeeDiscount": 123,
"weightedOrderHandlingFeeTax": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123,
"width": 123
}
],
"carrier": "<string>",
"cartId": "<string>",
"changeMessages": [
{
"amount": 123,
"appId": "<string>",
"appKey": "<string>",
"appName": "<string>",
"appeasementReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"attributes": {},
"changeMessageId": "<string>",
"correlationId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"identifier": "<string>",
"message": "<string>",
"metadata": "<string>",
"newValue": "<string>",
"oldValue": "<string>",
"subject": "<string>",
"subjectType": "<string>",
"success": true,
"userDisplayName": "<string>",
"userFirstName": "<string>",
"userId": "<string>",
"userLastName": "<string>",
"verb": "<string>"
}
],
"channel": "<string>",
"childShipmentNumbers": [
123
],
"currencyCode": "<string>",
"currentRunId": "<string>",
"customer": {
"customerContact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "Commercial",
"attributes": {},
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"latitude": "<string>",
"longitude": "<string>",
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"attributes": {},
"companyOrOrganization": "<string>",
"email": "<string>",
"firstName": "<string>",
"fullName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"attributes": {},
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"shortFullName": "<string>"
},
"data": {},
"isDestinationCommercial": true
},
"customerAccountId": 123,
"customerAddressId": 123,
"customerTaxId": "<string>",
"data": {},
"deliveryWindow": {
"endTime": "2023-11-07T05:31:56Z",
"startTime": "2023-11-07T05:31:56Z"
},
"destination": {
"data": {},
"destinationContact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "Commercial",
"attributes": {},
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"latitude": "<string>",
"longitude": "<string>",
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"attributes": {},
"companyOrOrganization": "<string>",
"email": "<string>",
"firstName": "<string>",
"fullName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"attributes": {},
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"shortFullName": "<string>"
},
"isDestinationCommercial": true,
"locationCode": "<string>"
},
"dutyAdjustment": 123,
"dutyTotal": 123,
"email": "<string>",
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"externalOrderId": "<string>",
"fulfillmentDate": "2023-11-07T05:31:56Z",
"fulfillmentLocationCode": "<string>",
"fulfillmentPriority": 123,
"fulfillmentStatus": "NotFulfilled",
"futureDate": "2023-11-07T05:31:56Z",
"groupId": "<string>",
"handlingAdjustment": 123,
"handlingSubtotal": 123,
"handlingTaxAdjustment": 123,
"handlingTaxTotal": 123,
"handlingTotal": 123,
"holdReleaseDate": "2023-11-07T05:31:56Z",
"isAutoAssigned": true,
"isCrossDockEligible": true,
"isDropship": true,
"isExpress": true,
"isFlatRateShipping": true,
"isHistoricalImport": true,
"isImmutable": true,
"isOptInForSms": true,
"items": [
{
"actualPrice": 123,
"allocatedQuantity": 123,
"allowsBackOrder": true,
"allowsFutureAllocate": true,
"allowsSubstitution": true,
"appeasementReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"autoSubstitution": true,
"backorderReleaseDate": "2023-11-07T05:31:56Z",
"bundleInfo": {
"attributes": {},
"imageUrl": "<string>",
"name": "<string>",
"productCode": "<string>",
"quantity": 123,
"unitPrice": 123
},
"cartItemId": "<string>",
"childItemIds": [
"<string>"
],
"condition": "<string>",
"creditCurrencyCode": "<string>",
"creditValue": 123,
"data": {},
"duty": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": {}
}
],
"giftCards": [
{
"activationDate": "2023-11-07T05:31:56Z",
"cardNumber": "<string>",
"code": "<string>",
"creditType": "<string>",
"creditValue": 123,
"currencyCode": "<string>",
"currentBalance": 123,
"customerId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"initialBalance": 123
}
],
"giftMessage": "<string>",
"goodsType": "Physical",
"handling": 123,
"handlingDiscount": 123,
"handlingTax": 123,
"height": 123,
"imageUrl": "<string>",
"inventoryAllocations": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"condition": "<string>",
"date": "2023-11-07T05:31:56Z",
"fulfilledDate": "2023-11-07T05:31:56Z",
"inventoryId": 123,
"lotCode": "<string>",
"originalQuantity": 123,
"quantity": 123,
"serialNumber": "<string>",
"sku": "<string>",
"status": "<string>"
}
],
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"isAssemblyRequired": true,
"isGift": true,
"isPackagedStandAlone": true,
"isReservedInventory": true,
"isTaxable": true,
"itemDiscount": 123,
"itemTax": 123,
"length": 123,
"lineId": 123,
"lineItemAdjustment": 123,
"lineItemCost": 123,
"locatorName": "<string>",
"manageStock": true,
"name": "<string>",
"optionAttributeFQN": "<string>",
"options": [
{
"attributeFQN": "<string>",
"attributes": {},
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": {},
"stringValue": "<string>",
"value": {}
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "Internal",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"returnRuleInfo": {
"attributes": {},
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipmentItemAttributes": [
{
"attributeDefinitionId": 123,
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
{}
]
}
],
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"stockValidationStatus": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteQuantity": 123,
"substitutionType": "PRE_FULFILLMENT",
"taxData": {},
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"timeFenceDays": 123,
"transferQuantity": 123,
"trueTransferQuantity": 123,
"unitPrice": 123,
"upc": "<string>",
"validatedQuantity": 123,
"variationProductCode": "<string>",
"weight": 123,
"weightUnit": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedOrderHandlingFee": 123,
"weightedOrderHandlingFeeDiscount": 123,
"weightedOrderHandlingFeeTax": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123,
"width": 123
}
],
"lastCancellationDate": "2023-11-07T05:31:56Z",
"lineItemSubtotal": 123,
"lineItemTaxAdjustment": 123,
"lineItemTaxTotal": 123,
"lineItemTotal": 123,
"lowestComplianceLevel": "<string>",
"masterTrackingNumber": "<string>",
"minutesSinceOnWorkflowStep": 123,
"minutesSinceOrdered": 123,
"mutabilityInfo": {
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"blockedActions": [
"<string>"
],
"reason": "<string>"
},
"orderId": "<string>",
"orderNumber": 123,
"orderSubmitDate": "2023-11-07T05:31:56Z",
"orderType": "Offline",
"originalEdd": "2023-11-07T05:31:56Z",
"originalShipmentNumber": 123,
"packageReceivingEligible": true,
"packages": [
{
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"carrier": "<string>",
"carrierName": "<string>",
"cartonization": {
"attributes": {},
"boxes": [
{
"boxId": 123,
"dimensions": {
"height": 123,
"length": 123,
"unit": "<string>",
"width": 123
},
"items": [
{
"dimensions": {
"height": 123,
"length": 123,
"unit": "<string>",
"width": 123
},
"lineId": 123,
"origin": {
"x": 123,
"y": 123,
"z": 123
},
"quantity": 123,
"sourceShipmentNumber": 123,
"uniqueId": "<string>",
"weight": 123,
"weightUnit": "<string>"
}
],
"name": "<string>",
"volumeUtilization": 123,
"weightUnit": "<string>",
"weightUsed": 123,
"weightUtilization": 123
}
],
"packingSuggestionId": "<string>"
},
"fullyMatched": true,
"fxcbDocumentsUrl": "<string>",
"fxcbPackNotificationId": "<string>",
"hasLabel": true,
"integratorId": "<string>",
"labelFormat": "<string>",
"manifestId": "<string>",
"measurements": {
"attributes": {},
"height": {
"attributes": {},
"unit": "<string>",
"value": 123
},
"length": {
"attributes": {},
"unit": "<string>",
"value": 123
},
"weight": {
"attributes": {},
"unit": "<string>",
"value": 123
},
"width": {
"attributes": {},
"unit": "<string>",
"value": 123
}
},
"packageConsolidationId": "<string>",
"packageId": "<string>",
"packagingType": "<string>",
"packingSlipItemDetails": [
{
"attributes": {},
"lineId": 123,
"originalOrderItemId": "<string>",
"quantity": 123,
"receivedQuantity": 123,
"substitutedQuantity": 123
}
],
"packingSlipNumber": 123,
"receiptStatus": "NOT_RECEIVED",
"receivedBy": "<string>",
"receivedDate": "2023-11-07T05:31:56Z",
"receivingMethod": "TRACKING_NUMBER_RECEIPT",
"returnCarrier": "<string>",
"returnTrackingNumbers": [
"<string>"
],
"returnTrackings": [
{
"attributes": {},
"number": "<string>",
"url": "<string>"
}
],
"shippingMethodCode": "<string>",
"shippingMethodName": "<string>",
"signatureRequired": true,
"stringBarcode": "<string>",
"trackingNumbers": [
"<string>"
],
"trackings": [
{
"attributes": {},
"number": "<string>",
"url": "<string>"
}
]
}
],
"packagesPendingCount": 123,
"packagesReceivedCount": 123,
"packagesTotalCount": 123,
"parentCheckoutNumber": 123,
"parentShipmentNumber": 123,
"paymentInvoice": {
"currency": "<string>",
"data": {},
"invoiceDate": "2023-11-07T05:31:56Z",
"invoiceNumber": "<string>",
"lineItems": [
{
"data": {},
"description": "<string>",
"lineItemType": "<string>",
"quantity": 123,
"sku": "<string>",
"totalPrice": 123,
"unitPrice": 123
}
],
"rawEdiData": "<string>",
"references": {
"data": {},
"orderNumber": 123,
"purchaseOrderNumber": "<string>",
"shipmentId": "<string>"
},
"taxes": [
{
"amount": 123,
"data": {},
"jurisdiction": "<string>",
"rate": 123,
"type": "<string>"
}
],
"terms": {
"data": {},
"dueDate": "2023-11-07T05:31:56Z",
"paymentTerms": "<string>"
},
"totalAmount": 123,
"vendor": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "Commercial",
"attributes": {},
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"latitude": "<string>",
"longitude": "<string>",
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"data": {},
"name": "<string>",
"taxId": "<string>",
"vendorId": "<string>"
}
},
"pickStatus": "AVAILABLE",
"pickType": "NORMAL",
"pickWaveNumber": 123,
"pickupInfo": {},
"priorityInfo": {
"history": [
{
"action": "<string>",
"priority": 123,
"ruleCode": "<string>",
"ruleType": "<string>",
"shipmentStatus": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"prioritizedAt": "2023-11-07T05:31:56Z",
"priority": 123,
"ruleCode": "<string>",
"ruleType": "<string>",
"statusWhenPrioritized": "<string>"
},
"readyForPickup": true,
"readyForPickupDate": "2023-11-07T05:31:56Z",
"readyToCapture": true,
"reassignedItems": [
{
"actualPrice": 123,
"allocatedQuantity": 123,
"allowsBackOrder": true,
"allowsFutureAllocate": true,
"allowsSubstitution": true,
"appeasementReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"autoSubstitution": true,
"backorderReleaseDate": "2023-11-07T05:31:56Z",
"blockAssignment": true,
"bundleInfo": {
"attributes": {},
"imageUrl": "<string>",
"name": "<string>",
"productCode": "<string>",
"quantity": 123,
"unitPrice": 123
},
"cartItemId": "<string>",
"childItemIds": [
"<string>"
],
"condition": "<string>",
"creditCurrencyCode": "<string>",
"creditValue": 123,
"data": {},
"duty": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": {}
}
],
"fulfillmentLocationCode": "<string>",
"giftCards": [
{
"activationDate": "2023-11-07T05:31:56Z",
"cardNumber": "<string>",
"code": "<string>",
"creditType": "<string>",
"creditValue": 123,
"currencyCode": "<string>",
"currentBalance": 123,
"customerId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"initialBalance": 123
}
],
"giftMessage": "<string>",
"goodsType": "Physical",
"handling": 123,
"handlingDiscount": 123,
"handlingTax": 123,
"height": 123,
"holdBlockAssignment": true,
"imageUrl": "<string>",
"inventoryAllocations": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"condition": "<string>",
"date": "2023-11-07T05:31:56Z",
"fulfilledDate": "2023-11-07T05:31:56Z",
"inventoryId": 123,
"lotCode": "<string>",
"originalQuantity": 123,
"quantity": 123,
"serialNumber": "<string>",
"sku": "<string>",
"status": "<string>"
}
],
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"isAssemblyRequired": true,
"isGift": true,
"isPackagedStandAlone": true,
"isReservedInventory": true,
"isTaxable": true,
"itemDiscount": 123,
"itemTax": 123,
"length": 123,
"lineId": 123,
"lineItemAdjustment": 123,
"lineItemCost": 123,
"locatorName": "<string>",
"manageStock": true,
"name": "<string>",
"optionAttributeFQN": "<string>",
"options": [
{
"attributeFQN": "<string>",
"attributes": {},
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": {},
"stringValue": "<string>",
"value": {}
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "Internal",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"reassignedReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"returnRuleInfo": {
"attributes": {},
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipmentItemAttributes": [
{
"attributeDefinitionId": 123,
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
{}
]
}
],
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"stockValidationStatus": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteQuantity": 123,
"substitutionType": "PRE_FULFILLMENT",
"taxData": {},
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"timeFenceDays": 123,
"transferQuantity": 123,
"trueTransferQuantity": 123,
"unitPrice": 123,
"upc": "<string>",
"validatedQuantity": 123,
"variationProductCode": "<string>",
"weight": 123,
"weightUnit": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedOrderHandlingFee": 123,
"weightedOrderHandlingFeeDiscount": 123,
"weightedOrderHandlingFeeTax": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123,
"width": 123
}
],
"receivedDate": "2023-11-07T05:31:56Z",
"rejectedItems": [
{
"actualPrice": 123,
"allocatedQuantity": 123,
"allowsBackOrder": true,
"allowsFutureAllocate": true,
"allowsSubstitution": true,
"appeasementReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"autoSubstitution": true,
"backorderReleaseDate": "2023-11-07T05:31:56Z",
"blockAssignment": true,
"bundleInfo": {
"attributes": {},
"imageUrl": "<string>",
"name": "<string>",
"productCode": "<string>",
"quantity": 123,
"unitPrice": 123
},
"cartItemId": "<string>",
"childItemIds": [
"<string>"
],
"condition": "<string>",
"creditCurrencyCode": "<string>",
"creditValue": 123,
"data": {},
"duty": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": {}
}
],
"giftCards": [
{
"activationDate": "2023-11-07T05:31:56Z",
"cardNumber": "<string>",
"code": "<string>",
"creditType": "<string>",
"creditValue": 123,
"currencyCode": "<string>",
"currentBalance": 123,
"customerId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"initialBalance": 123
}
],
"giftMessage": "<string>",
"goodsType": "Physical",
"handling": 123,
"handlingDiscount": 123,
"handlingTax": 123,
"height": 123,
"holdBlockAssignment": true,
"imageUrl": "<string>",
"inventoryAllocations": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"condition": "<string>",
"date": "2023-11-07T05:31:56Z",
"fulfilledDate": "2023-11-07T05:31:56Z",
"inventoryId": 123,
"lotCode": "<string>",
"originalQuantity": 123,
"quantity": 123,
"serialNumber": "<string>",
"sku": "<string>",
"status": "<string>"
}
],
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"isAssemblyRequired": true,
"isGift": true,
"isPackagedStandAlone": true,
"isReservedInventory": true,
"isTaxable": true,
"itemDiscount": 123,
"itemTax": 123,
"length": 123,
"lineId": 123,
"lineItemAdjustment": 123,
"lineItemCost": 123,
"locatorName": "<string>",
"manageStock": true,
"name": "<string>",
"optionAttributeFQN": "<string>",
"options": [
{
"attributeFQN": "<string>",
"attributes": {},
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": {},
"stringValue": "<string>",
"value": {}
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "Internal",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"rejectedReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"returnRuleInfo": {
"attributes": {},
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipmentItemAttributes": [
{
"attributeDefinitionId": 123,
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
{}
]
}
],
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"stockValidationStatus": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteQuantity": 123,
"substitutionType": "PRE_FULFILLMENT",
"taxData": {},
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"timeFenceDays": 123,
"transferQuantity": 123,
"trueTransferQuantity": 123,
"unitPrice": 123,
"upc": "<string>",
"validatedQuantity": 123,
"variationProductCode": "<string>",
"weight": 123,
"weightUnit": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedOrderHandlingFee": 123,
"weightedOrderHandlingFeeDiscount": 123,
"weightedOrderHandlingFeeTax": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123,
"width": 123
}
],
"runInfo": [
{
"action": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"queue": "<string>",
"routedLocationCode": "<string>",
"runId": "<string>",
"runType": "<string>",
"shipmentStatus": "<string>"
}
],
"sentCustomerAtStoreNotification": true,
"sentCustomerInTransitNotification": true,
"shipDate": "2023-11-07T05:31:56Z",
"shipmentAdjustment": 123,
"shipmentAttributes": [
{
"attributeDefinitionId": 123,
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
{}
]
}
],
"shipmentConsolidationId": "<string>",
"shipmentGroup": "<string>",
"shipmentNotes": [
{
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"noteId": "<string>",
"noteText": "<string>",
"role": "<string>",
"username": "<string>"
}
],
"shipmentNumber": 123,
"shipmentStatus": "READY",
"shipmentStatusReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"shippingAdjustment": 123,
"shippingMethodCode": "<string>",
"shippingMethodName": "<string>",
"shippingSubtotal": 123,
"shippingTaxAdjustment": 123,
"shippingTaxTotal": 123,
"shippingTotal": 123,
"shopperNotes": {
"comments": "<string>",
"deliveryInstructions": "<string>",
"giftMessage": "<string>"
},
"siteId": 123,
"slas": [
{
"atRiskTrackingInfo": {
"code": "<string>",
"endDate": "<string>",
"name": "<string>",
"startDate": "<string>"
},
"attributes": {},
"compliantTrackingInfo": {
"code": "<string>",
"endDate": "<string>",
"name": "<string>",
"startDate": "<string>"
},
"endDisplayValue": "<string>",
"nonCompliantTrackingInfo": {
"code": "<string>",
"endDate": "<string>",
"name": "<string>",
"startDate": "<string>"
},
"slaCode": "<string>",
"slaComplianceLevel": "<string>",
"slaDefinitionId": "<string>",
"slaDefinitionNumber": 123,
"slaDefinitionStatus": "<string>",
"slaDueDate": "2023-11-07T05:31:56Z",
"slaId": 123,
"slaName": "<string>",
"slaStatus": "<string>",
"startDisplayValue": "<string>"
}
],
"substitutedItems": [
{
"actualPrice": 123,
"allocatedQuantity": 123,
"allowsBackOrder": true,
"allowsFutureAllocate": true,
"allowsSubstitution": true,
"appeasementReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"autoSubstitution": true,
"backorderReleaseDate": "2023-11-07T05:31:56Z",
"bundleInfo": {
"attributes": {},
"imageUrl": "<string>",
"name": "<string>",
"productCode": "<string>",
"quantity": 123,
"unitPrice": 123
},
"cartItemId": "<string>",
"childItemIds": [
"<string>"
],
"condition": "<string>",
"creditCurrencyCode": "<string>",
"creditValue": 123,
"data": {},
"duty": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": {}
}
],
"giftCards": [
{
"activationDate": "2023-11-07T05:31:56Z",
"cardNumber": "<string>",
"code": "<string>",
"creditType": "<string>",
"creditValue": 123,
"currencyCode": "<string>",
"currentBalance": 123,
"customerId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"initialBalance": 123
}
],
"giftMessage": "<string>",
"goodsType": "Physical",
"handling": 123,
"handlingDiscount": 123,
"handlingTax": 123,
"height": 123,
"imageUrl": "<string>",
"inventoryAllocations": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"condition": "<string>",
"date": "2023-11-07T05:31:56Z",
"fulfilledDate": "2023-11-07T05:31:56Z",
"inventoryId": 123,
"lotCode": "<string>",
"originalQuantity": 123,
"quantity": 123,
"serialNumber": "<string>",
"sku": "<string>",
"status": "<string>"
}
],
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"isAssemblyRequired": true,
"isGift": true,
"isPackagedStandAlone": true,
"isReservedInventory": true,
"isTaxable": true,
"itemDiscount": 123,
"itemTax": 123,
"length": 123,
"lineId": 123,
"lineItemAdjustment": 123,
"lineItemCost": 123,
"locatorName": "<string>",
"manageStock": true,
"name": "<string>",
"optionAttributeFQN": "<string>",
"options": [
{
"attributeFQN": "<string>",
"attributes": {},
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": {},
"stringValue": "<string>",
"value": {}
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "Internal",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"returnRuleInfo": {
"attributes": {},
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipmentItemAttributes": [
{
"attributeDefinitionId": 123,
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
{}
]
}
],
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"stockValidationStatus": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteItemLineIds": [
123
],
"substituteQuantity": 123,
"substituteReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"substitutionType": "PRE_FULFILLMENT",
"taxData": {},
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"timeFenceDays": 123,
"transferQuantity": 123,
"trueTransferQuantity": 123,
"unitPrice": 123,
"upc": "<string>",
"validatedQuantity": 123,
"variationProductCode": "<string>",
"weight": 123,
"weightUnit": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedOrderHandlingFee": 123,
"weightedOrderHandlingFeeDiscount": 123,
"weightedOrderHandlingFeeTax": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123,
"width": 123
}
],
"taxData": {},
"tenantId": 123,
"total": 123,
"transferShipmentNumbers": [
123
],
"transferredItems": [
{
"actualPrice": 123,
"allocatedQuantity": 123,
"allowsBackOrder": true,
"allowsFutureAllocate": true,
"allowsSubstitution": true,
"appeasementReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"autoSubstitution": true,
"backorderReleaseDate": "2023-11-07T05:31:56Z",
"blockAssignment": true,
"bundleInfo": {
"attributes": {},
"imageUrl": "<string>",
"name": "<string>",
"productCode": "<string>",
"quantity": 123,
"unitPrice": 123
},
"cartItemId": "<string>",
"childItemIds": [
"<string>"
],
"condition": "<string>",
"creditCurrencyCode": "<string>",
"creditValue": 123,
"data": {},
"duty": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": {}
}
],
"fulfillmentLocationCode": "<string>",
"giftCards": [
{
"activationDate": "2023-11-07T05:31:56Z",
"cardNumber": "<string>",
"code": "<string>",
"creditType": "<string>",
"creditValue": 123,
"currencyCode": "<string>",
"currentBalance": 123,
"customerId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"initialBalance": 123
}
],
"giftMessage": "<string>",
"goodsType": "Physical",
"handling": 123,
"handlingDiscount": 123,
"handlingTax": 123,
"height": 123,
"holdBlockAssignment": true,
"imageUrl": "<string>",
"inventoryAllocations": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"condition": "<string>",
"date": "2023-11-07T05:31:56Z",
"fulfilledDate": "2023-11-07T05:31:56Z",
"inventoryId": 123,
"lotCode": "<string>",
"originalQuantity": 123,
"quantity": 123,
"serialNumber": "<string>",
"sku": "<string>",
"status": "<string>"
}
],
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"isAssemblyRequired": true,
"isGift": true,
"isPackagedStandAlone": true,
"isReservedInventory": true,
"isTaxable": true,
"itemDiscount": 123,
"itemTax": 123,
"length": 123,
"lineId": 123,
"lineItemAdjustment": 123,
"lineItemCost": 123,
"locatorName": "<string>",
"manageStock": true,
"name": "<string>",
"optionAttributeFQN": "<string>",
"options": [
{
"attributeFQN": "<string>",
"attributes": {},
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": {},
"stringValue": "<string>",
"value": {}
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "Internal",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"rejectedReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"returnRuleInfo": {
"attributes": {},
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipmentItemAttributes": [
{
"attributeDefinitionId": 123,
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
{}
]
}
],
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"stockValidationStatus": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteQuantity": 123,
"substitutionType": "PRE_FULFILLMENT",
"taxData": {},
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"timeFenceDays": 123,
"transferQuantity": 123,
"trueTransferQuantity": 123,
"unitPrice": 123,
"upc": "<string>",
"validatedQuantity": 123,
"variationProductCode": "<string>",
"weight": 123,
"weightUnit": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedOrderHandlingFee": 123,
"weightedOrderHandlingFeeDiscount": 123,
"weightedOrderHandlingFeeTax": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123,
"width": 123
}
],
"transitTime": "<string>",
"userId": "<string>",
"workflowProcessContainerId": "<string>",
"workflowProcessId": "<string>",
"workflowProcessVersion": "<string>",
"workflowState": {
"activeTaskName": "<string>",
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"completedDate": "2023-11-07T05:31:56Z",
"processInstanceId": "<string>",
"shipmentState": "<string>",
"taskList": [
{
"_links": {},
"active": true,
"activeDate": "2023-11-07T05:31:56Z",
"completed": true,
"completedDate": "2023-11-07T05:31:56Z",
"completedDurationMillis": 123,
"description": "<string>",
"inputs": [
{
"helpMessage": "<string>",
"label": "<string>",
"maxLength": 123,
"maximum": 123,
"minLength": 123,
"minimum": 123,
"name": "<string>",
"options": [
{}
],
"pattern": "<string>",
"required": true,
"type": "STRING"
}
],
"name": "<string>",
"skippable": true,
"subject": "<string>",
"taskId": "<string>"
}
],
"variables": {}
}
}deleteShipmentPackages
Delete shipment packages in bulk.
A valid request URL is required to generate request examples{
"shipmentType": "STH",
"_links": {
"empty": true
},
"acceptedDate": "2023-11-07T05:31:56Z",
"alternateContact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "Commercial",
"attributes": {},
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"latitude": "<string>",
"longitude": "<string>",
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"attributes": {},
"companyOrOrganization": "<string>",
"email": "<string>",
"firstName": "<string>",
"fullName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"attributes": {},
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"shortFullName": "<string>"
},
"appeasementReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"assignedLocationCode": "<string>",
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"canceledItems": [
{
"actualPrice": 123,
"allocatedQuantity": 123,
"allowsBackOrder": true,
"allowsFutureAllocate": true,
"allowsSubstitution": true,
"appeasementReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"autoSubstitution": true,
"backorderReleaseDate": "2023-11-07T05:31:56Z",
"blockAssignment": true,
"bundleInfo": {
"attributes": {},
"imageUrl": "<string>",
"name": "<string>",
"productCode": "<string>",
"quantity": 123,
"unitPrice": 123
},
"canceledReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"cartItemId": "<string>",
"childItemIds": [
"<string>"
],
"condition": "<string>",
"creditCurrencyCode": "<string>",
"creditValue": 123,
"data": {},
"duty": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": {}
}
],
"giftCards": [
{
"activationDate": "2023-11-07T05:31:56Z",
"cardNumber": "<string>",
"code": "<string>",
"creditType": "<string>",
"creditValue": 123,
"currencyCode": "<string>",
"currentBalance": 123,
"customerId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"initialBalance": 123
}
],
"giftMessage": "<string>",
"goodsType": "Physical",
"handling": 123,
"handlingDiscount": 123,
"handlingTax": 123,
"height": 123,
"holdBlockAssignment": true,
"imageUrl": "<string>",
"inventoryAllocations": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"condition": "<string>",
"date": "2023-11-07T05:31:56Z",
"fulfilledDate": "2023-11-07T05:31:56Z",
"inventoryId": 123,
"lotCode": "<string>",
"originalQuantity": 123,
"quantity": 123,
"serialNumber": "<string>",
"sku": "<string>",
"status": "<string>"
}
],
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"isAssemblyRequired": true,
"isGift": true,
"isPackagedStandAlone": true,
"isReservedInventory": true,
"isTaxable": true,
"itemDiscount": 123,
"itemTax": 123,
"length": 123,
"lineId": 123,
"lineItemAdjustment": 123,
"lineItemCost": 123,
"locatorName": "<string>",
"manageStock": true,
"name": "<string>",
"optionAttributeFQN": "<string>",
"options": [
{
"attributeFQN": "<string>",
"attributes": {},
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": {},
"stringValue": "<string>",
"value": {}
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "Internal",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"returnRuleInfo": {
"attributes": {},
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipmentItemAttributes": [
{
"attributeDefinitionId": 123,
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
{}
]
}
],
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"stockValidationStatus": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteQuantity": 123,
"substitutionType": "PRE_FULFILLMENT",
"taxData": {},
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"timeFenceDays": 123,
"transferQuantity": 123,
"trueTransferQuantity": 123,
"unitPrice": 123,
"upc": "<string>",
"validatedQuantity": 123,
"variationProductCode": "<string>",
"weight": 123,
"weightUnit": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedOrderHandlingFee": 123,
"weightedOrderHandlingFeeDiscount": 123,
"weightedOrderHandlingFeeTax": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123,
"width": 123
}
],
"carrier": "<string>",
"cartId": "<string>",
"changeMessages": [
{
"amount": 123,
"appId": "<string>",
"appKey": "<string>",
"appName": "<string>",
"appeasementReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"attributes": {},
"changeMessageId": "<string>",
"correlationId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"identifier": "<string>",
"message": "<string>",
"metadata": "<string>",
"newValue": "<string>",
"oldValue": "<string>",
"subject": "<string>",
"subjectType": "<string>",
"success": true,
"userDisplayName": "<string>",
"userFirstName": "<string>",
"userId": "<string>",
"userLastName": "<string>",
"verb": "<string>"
}
],
"channel": "<string>",
"childShipmentNumbers": [
123
],
"currencyCode": "<string>",
"currentRunId": "<string>",
"customer": {
"customerContact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "Commercial",
"attributes": {},
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"latitude": "<string>",
"longitude": "<string>",
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"attributes": {},
"companyOrOrganization": "<string>",
"email": "<string>",
"firstName": "<string>",
"fullName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"attributes": {},
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"shortFullName": "<string>"
},
"data": {},
"isDestinationCommercial": true
},
"customerAccountId": 123,
"customerAddressId": 123,
"customerTaxId": "<string>",
"data": {},
"deliveryWindow": {
"endTime": "2023-11-07T05:31:56Z",
"startTime": "2023-11-07T05:31:56Z"
},
"destination": {
"data": {},
"destinationContact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "Commercial",
"attributes": {},
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"latitude": "<string>",
"longitude": "<string>",
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"attributes": {},
"companyOrOrganization": "<string>",
"email": "<string>",
"firstName": "<string>",
"fullName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"attributes": {},
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"shortFullName": "<string>"
},
"isDestinationCommercial": true,
"locationCode": "<string>"
},
"dutyAdjustment": 123,
"dutyTotal": 123,
"email": "<string>",
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"externalOrderId": "<string>",
"fulfillmentDate": "2023-11-07T05:31:56Z",
"fulfillmentLocationCode": "<string>",
"fulfillmentPriority": 123,
"fulfillmentStatus": "NotFulfilled",
"futureDate": "2023-11-07T05:31:56Z",
"groupId": "<string>",
"handlingAdjustment": 123,
"handlingSubtotal": 123,
"handlingTaxAdjustment": 123,
"handlingTaxTotal": 123,
"handlingTotal": 123,
"holdReleaseDate": "2023-11-07T05:31:56Z",
"isAutoAssigned": true,
"isCrossDockEligible": true,
"isDropship": true,
"isExpress": true,
"isFlatRateShipping": true,
"isHistoricalImport": true,
"isImmutable": true,
"isOptInForSms": true,
"items": [
{
"actualPrice": 123,
"allocatedQuantity": 123,
"allowsBackOrder": true,
"allowsFutureAllocate": true,
"allowsSubstitution": true,
"appeasementReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"autoSubstitution": true,
"backorderReleaseDate": "2023-11-07T05:31:56Z",
"bundleInfo": {
"attributes": {},
"imageUrl": "<string>",
"name": "<string>",
"productCode": "<string>",
"quantity": 123,
"unitPrice": 123
},
"cartItemId": "<string>",
"childItemIds": [
"<string>"
],
"condition": "<string>",
"creditCurrencyCode": "<string>",
"creditValue": 123,
"data": {},
"duty": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": {}
}
],
"giftCards": [
{
"activationDate": "2023-11-07T05:31:56Z",
"cardNumber": "<string>",
"code": "<string>",
"creditType": "<string>",
"creditValue": 123,
"currencyCode": "<string>",
"currentBalance": 123,
"customerId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"initialBalance": 123
}
],
"giftMessage": "<string>",
"goodsType": "Physical",
"handling": 123,
"handlingDiscount": 123,
"handlingTax": 123,
"height": 123,
"imageUrl": "<string>",
"inventoryAllocations": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"condition": "<string>",
"date": "2023-11-07T05:31:56Z",
"fulfilledDate": "2023-11-07T05:31:56Z",
"inventoryId": 123,
"lotCode": "<string>",
"originalQuantity": 123,
"quantity": 123,
"serialNumber": "<string>",
"sku": "<string>",
"status": "<string>"
}
],
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"isAssemblyRequired": true,
"isGift": true,
"isPackagedStandAlone": true,
"isReservedInventory": true,
"isTaxable": true,
"itemDiscount": 123,
"itemTax": 123,
"length": 123,
"lineId": 123,
"lineItemAdjustment": 123,
"lineItemCost": 123,
"locatorName": "<string>",
"manageStock": true,
"name": "<string>",
"optionAttributeFQN": "<string>",
"options": [
{
"attributeFQN": "<string>",
"attributes": {},
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": {},
"stringValue": "<string>",
"value": {}
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "Internal",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"returnRuleInfo": {
"attributes": {},
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipmentItemAttributes": [
{
"attributeDefinitionId": 123,
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
{}
]
}
],
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"stockValidationStatus": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteQuantity": 123,
"substitutionType": "PRE_FULFILLMENT",
"taxData": {},
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"timeFenceDays": 123,
"transferQuantity": 123,
"trueTransferQuantity": 123,
"unitPrice": 123,
"upc": "<string>",
"validatedQuantity": 123,
"variationProductCode": "<string>",
"weight": 123,
"weightUnit": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedOrderHandlingFee": 123,
"weightedOrderHandlingFeeDiscount": 123,
"weightedOrderHandlingFeeTax": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123,
"width": 123
}
],
"lastCancellationDate": "2023-11-07T05:31:56Z",
"lineItemSubtotal": 123,
"lineItemTaxAdjustment": 123,
"lineItemTaxTotal": 123,
"lineItemTotal": 123,
"lowestComplianceLevel": "<string>",
"masterTrackingNumber": "<string>",
"minutesSinceOnWorkflowStep": 123,
"minutesSinceOrdered": 123,
"mutabilityInfo": {
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"blockedActions": [
"<string>"
],
"reason": "<string>"
},
"orderId": "<string>",
"orderNumber": 123,
"orderSubmitDate": "2023-11-07T05:31:56Z",
"orderType": "Offline",
"originalEdd": "2023-11-07T05:31:56Z",
"originalShipmentNumber": 123,
"packageReceivingEligible": true,
"packages": [
{
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"carrier": "<string>",
"carrierName": "<string>",
"cartonization": {
"attributes": {},
"boxes": [
{
"boxId": 123,
"dimensions": {
"height": 123,
"length": 123,
"unit": "<string>",
"width": 123
},
"items": [
{
"dimensions": {
"height": 123,
"length": 123,
"unit": "<string>",
"width": 123
},
"lineId": 123,
"origin": {
"x": 123,
"y": 123,
"z": 123
},
"quantity": 123,
"sourceShipmentNumber": 123,
"uniqueId": "<string>",
"weight": 123,
"weightUnit": "<string>"
}
],
"name": "<string>",
"volumeUtilization": 123,
"weightUnit": "<string>",
"weightUsed": 123,
"weightUtilization": 123
}
],
"packingSuggestionId": "<string>"
},
"fullyMatched": true,
"fxcbDocumentsUrl": "<string>",
"fxcbPackNotificationId": "<string>",
"hasLabel": true,
"integratorId": "<string>",
"labelFormat": "<string>",
"manifestId": "<string>",
"measurements": {
"attributes": {},
"height": {
"attributes": {},
"unit": "<string>",
"value": 123
},
"length": {
"attributes": {},
"unit": "<string>",
"value": 123
},
"weight": {
"attributes": {},
"unit": "<string>",
"value": 123
},
"width": {
"attributes": {},
"unit": "<string>",
"value": 123
}
},
"packageConsolidationId": "<string>",
"packageId": "<string>",
"packagingType": "<string>",
"packingSlipItemDetails": [
{
"attributes": {},
"lineId": 123,
"originalOrderItemId": "<string>",
"quantity": 123,
"receivedQuantity": 123,
"substitutedQuantity": 123
}
],
"packingSlipNumber": 123,
"receiptStatus": "NOT_RECEIVED",
"receivedBy": "<string>",
"receivedDate": "2023-11-07T05:31:56Z",
"receivingMethod": "TRACKING_NUMBER_RECEIPT",
"returnCarrier": "<string>",
"returnTrackingNumbers": [
"<string>"
],
"returnTrackings": [
{
"attributes": {},
"number": "<string>",
"url": "<string>"
}
],
"shippingMethodCode": "<string>",
"shippingMethodName": "<string>",
"signatureRequired": true,
"stringBarcode": "<string>",
"trackingNumbers": [
"<string>"
],
"trackings": [
{
"attributes": {},
"number": "<string>",
"url": "<string>"
}
]
}
],
"packagesPendingCount": 123,
"packagesReceivedCount": 123,
"packagesTotalCount": 123,
"parentCheckoutNumber": 123,
"parentShipmentNumber": 123,
"paymentInvoice": {
"currency": "<string>",
"data": {},
"invoiceDate": "2023-11-07T05:31:56Z",
"invoiceNumber": "<string>",
"lineItems": [
{
"data": {},
"description": "<string>",
"lineItemType": "<string>",
"quantity": 123,
"sku": "<string>",
"totalPrice": 123,
"unitPrice": 123
}
],
"rawEdiData": "<string>",
"references": {
"data": {},
"orderNumber": 123,
"purchaseOrderNumber": "<string>",
"shipmentId": "<string>"
},
"taxes": [
{
"amount": 123,
"data": {},
"jurisdiction": "<string>",
"rate": 123,
"type": "<string>"
}
],
"terms": {
"data": {},
"dueDate": "2023-11-07T05:31:56Z",
"paymentTerms": "<string>"
},
"totalAmount": 123,
"vendor": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "Commercial",
"attributes": {},
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"latitude": "<string>",
"longitude": "<string>",
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"data": {},
"name": "<string>",
"taxId": "<string>",
"vendorId": "<string>"
}
},
"pickStatus": "AVAILABLE",
"pickType": "NORMAL",
"pickWaveNumber": 123,
"pickupInfo": {},
"priorityInfo": {
"history": [
{
"action": "<string>",
"priority": 123,
"ruleCode": "<string>",
"ruleType": "<string>",
"shipmentStatus": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"prioritizedAt": "2023-11-07T05:31:56Z",
"priority": 123,
"ruleCode": "<string>",
"ruleType": "<string>",
"statusWhenPrioritized": "<string>"
},
"readyForPickup": true,
"readyForPickupDate": "2023-11-07T05:31:56Z",
"readyToCapture": true,
"reassignedItems": [
{
"actualPrice": 123,
"allocatedQuantity": 123,
"allowsBackOrder": true,
"allowsFutureAllocate": true,
"allowsSubstitution": true,
"appeasementReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"autoSubstitution": true,
"backorderReleaseDate": "2023-11-07T05:31:56Z",
"blockAssignment": true,
"bundleInfo": {
"attributes": {},
"imageUrl": "<string>",
"name": "<string>",
"productCode": "<string>",
"quantity": 123,
"unitPrice": 123
},
"cartItemId": "<string>",
"childItemIds": [
"<string>"
],
"condition": "<string>",
"creditCurrencyCode": "<string>",
"creditValue": 123,
"data": {},
"duty": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": {}
}
],
"fulfillmentLocationCode": "<string>",
"giftCards": [
{
"activationDate": "2023-11-07T05:31:56Z",
"cardNumber": "<string>",
"code": "<string>",
"creditType": "<string>",
"creditValue": 123,
"currencyCode": "<string>",
"currentBalance": 123,
"customerId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"initialBalance": 123
}
],
"giftMessage": "<string>",
"goodsType": "Physical",
"handling": 123,
"handlingDiscount": 123,
"handlingTax": 123,
"height": 123,
"holdBlockAssignment": true,
"imageUrl": "<string>",
"inventoryAllocations": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"condition": "<string>",
"date": "2023-11-07T05:31:56Z",
"fulfilledDate": "2023-11-07T05:31:56Z",
"inventoryId": 123,
"lotCode": "<string>",
"originalQuantity": 123,
"quantity": 123,
"serialNumber": "<string>",
"sku": "<string>",
"status": "<string>"
}
],
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"isAssemblyRequired": true,
"isGift": true,
"isPackagedStandAlone": true,
"isReservedInventory": true,
"isTaxable": true,
"itemDiscount": 123,
"itemTax": 123,
"length": 123,
"lineId": 123,
"lineItemAdjustment": 123,
"lineItemCost": 123,
"locatorName": "<string>",
"manageStock": true,
"name": "<string>",
"optionAttributeFQN": "<string>",
"options": [
{
"attributeFQN": "<string>",
"attributes": {},
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": {},
"stringValue": "<string>",
"value": {}
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "Internal",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"reassignedReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"returnRuleInfo": {
"attributes": {},
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipmentItemAttributes": [
{
"attributeDefinitionId": 123,
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
{}
]
}
],
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"stockValidationStatus": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteQuantity": 123,
"substitutionType": "PRE_FULFILLMENT",
"taxData": {},
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"timeFenceDays": 123,
"transferQuantity": 123,
"trueTransferQuantity": 123,
"unitPrice": 123,
"upc": "<string>",
"validatedQuantity": 123,
"variationProductCode": "<string>",
"weight": 123,
"weightUnit": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedOrderHandlingFee": 123,
"weightedOrderHandlingFeeDiscount": 123,
"weightedOrderHandlingFeeTax": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123,
"width": 123
}
],
"receivedDate": "2023-11-07T05:31:56Z",
"rejectedItems": [
{
"actualPrice": 123,
"allocatedQuantity": 123,
"allowsBackOrder": true,
"allowsFutureAllocate": true,
"allowsSubstitution": true,
"appeasementReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"autoSubstitution": true,
"backorderReleaseDate": "2023-11-07T05:31:56Z",
"blockAssignment": true,
"bundleInfo": {
"attributes": {},
"imageUrl": "<string>",
"name": "<string>",
"productCode": "<string>",
"quantity": 123,
"unitPrice": 123
},
"cartItemId": "<string>",
"childItemIds": [
"<string>"
],
"condition": "<string>",
"creditCurrencyCode": "<string>",
"creditValue": 123,
"data": {},
"duty": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": {}
}
],
"giftCards": [
{
"activationDate": "2023-11-07T05:31:56Z",
"cardNumber": "<string>",
"code": "<string>",
"creditType": "<string>",
"creditValue": 123,
"currencyCode": "<string>",
"currentBalance": 123,
"customerId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"initialBalance": 123
}
],
"giftMessage": "<string>",
"goodsType": "Physical",
"handling": 123,
"handlingDiscount": 123,
"handlingTax": 123,
"height": 123,
"holdBlockAssignment": true,
"imageUrl": "<string>",
"inventoryAllocations": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"condition": "<string>",
"date": "2023-11-07T05:31:56Z",
"fulfilledDate": "2023-11-07T05:31:56Z",
"inventoryId": 123,
"lotCode": "<string>",
"originalQuantity": 123,
"quantity": 123,
"serialNumber": "<string>",
"sku": "<string>",
"status": "<string>"
}
],
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"isAssemblyRequired": true,
"isGift": true,
"isPackagedStandAlone": true,
"isReservedInventory": true,
"isTaxable": true,
"itemDiscount": 123,
"itemTax": 123,
"length": 123,
"lineId": 123,
"lineItemAdjustment": 123,
"lineItemCost": 123,
"locatorName": "<string>",
"manageStock": true,
"name": "<string>",
"optionAttributeFQN": "<string>",
"options": [
{
"attributeFQN": "<string>",
"attributes": {},
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": {},
"stringValue": "<string>",
"value": {}
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "Internal",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"rejectedReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"returnRuleInfo": {
"attributes": {},
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipmentItemAttributes": [
{
"attributeDefinitionId": 123,
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
{}
]
}
],
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"stockValidationStatus": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteQuantity": 123,
"substitutionType": "PRE_FULFILLMENT",
"taxData": {},
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"timeFenceDays": 123,
"transferQuantity": 123,
"trueTransferQuantity": 123,
"unitPrice": 123,
"upc": "<string>",
"validatedQuantity": 123,
"variationProductCode": "<string>",
"weight": 123,
"weightUnit": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedOrderHandlingFee": 123,
"weightedOrderHandlingFeeDiscount": 123,
"weightedOrderHandlingFeeTax": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123,
"width": 123
}
],
"runInfo": [
{
"action": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"queue": "<string>",
"routedLocationCode": "<string>",
"runId": "<string>",
"runType": "<string>",
"shipmentStatus": "<string>"
}
],
"sentCustomerAtStoreNotification": true,
"sentCustomerInTransitNotification": true,
"shipDate": "2023-11-07T05:31:56Z",
"shipmentAdjustment": 123,
"shipmentAttributes": [
{
"attributeDefinitionId": 123,
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
{}
]
}
],
"shipmentConsolidationId": "<string>",
"shipmentGroup": "<string>",
"shipmentNotes": [
{
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"noteId": "<string>",
"noteText": "<string>",
"role": "<string>",
"username": "<string>"
}
],
"shipmentNumber": 123,
"shipmentStatus": "READY",
"shipmentStatusReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"shippingAdjustment": 123,
"shippingMethodCode": "<string>",
"shippingMethodName": "<string>",
"shippingSubtotal": 123,
"shippingTaxAdjustment": 123,
"shippingTaxTotal": 123,
"shippingTotal": 123,
"shopperNotes": {
"comments": "<string>",
"deliveryInstructions": "<string>",
"giftMessage": "<string>"
},
"siteId": 123,
"slas": [
{
"atRiskTrackingInfo": {
"code": "<string>",
"endDate": "<string>",
"name": "<string>",
"startDate": "<string>"
},
"attributes": {},
"compliantTrackingInfo": {
"code": "<string>",
"endDate": "<string>",
"name": "<string>",
"startDate": "<string>"
},
"endDisplayValue": "<string>",
"nonCompliantTrackingInfo": {
"code": "<string>",
"endDate": "<string>",
"name": "<string>",
"startDate": "<string>"
},
"slaCode": "<string>",
"slaComplianceLevel": "<string>",
"slaDefinitionId": "<string>",
"slaDefinitionNumber": 123,
"slaDefinitionStatus": "<string>",
"slaDueDate": "2023-11-07T05:31:56Z",
"slaId": 123,
"slaName": "<string>",
"slaStatus": "<string>",
"startDisplayValue": "<string>"
}
],
"substitutedItems": [
{
"actualPrice": 123,
"allocatedQuantity": 123,
"allowsBackOrder": true,
"allowsFutureAllocate": true,
"allowsSubstitution": true,
"appeasementReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"autoSubstitution": true,
"backorderReleaseDate": "2023-11-07T05:31:56Z",
"bundleInfo": {
"attributes": {},
"imageUrl": "<string>",
"name": "<string>",
"productCode": "<string>",
"quantity": 123,
"unitPrice": 123
},
"cartItemId": "<string>",
"childItemIds": [
"<string>"
],
"condition": "<string>",
"creditCurrencyCode": "<string>",
"creditValue": 123,
"data": {},
"duty": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": {}
}
],
"giftCards": [
{
"activationDate": "2023-11-07T05:31:56Z",
"cardNumber": "<string>",
"code": "<string>",
"creditType": "<string>",
"creditValue": 123,
"currencyCode": "<string>",
"currentBalance": 123,
"customerId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"initialBalance": 123
}
],
"giftMessage": "<string>",
"goodsType": "Physical",
"handling": 123,
"handlingDiscount": 123,
"handlingTax": 123,
"height": 123,
"imageUrl": "<string>",
"inventoryAllocations": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"condition": "<string>",
"date": "2023-11-07T05:31:56Z",
"fulfilledDate": "2023-11-07T05:31:56Z",
"inventoryId": 123,
"lotCode": "<string>",
"originalQuantity": 123,
"quantity": 123,
"serialNumber": "<string>",
"sku": "<string>",
"status": "<string>"
}
],
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"isAssemblyRequired": true,
"isGift": true,
"isPackagedStandAlone": true,
"isReservedInventory": true,
"isTaxable": true,
"itemDiscount": 123,
"itemTax": 123,
"length": 123,
"lineId": 123,
"lineItemAdjustment": 123,
"lineItemCost": 123,
"locatorName": "<string>",
"manageStock": true,
"name": "<string>",
"optionAttributeFQN": "<string>",
"options": [
{
"attributeFQN": "<string>",
"attributes": {},
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": {},
"stringValue": "<string>",
"value": {}
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "Internal",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"returnRuleInfo": {
"attributes": {},
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipmentItemAttributes": [
{
"attributeDefinitionId": 123,
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
{}
]
}
],
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"stockValidationStatus": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteItemLineIds": [
123
],
"substituteQuantity": 123,
"substituteReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"substitutionType": "PRE_FULFILLMENT",
"taxData": {},
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"timeFenceDays": 123,
"transferQuantity": 123,
"trueTransferQuantity": 123,
"unitPrice": 123,
"upc": "<string>",
"validatedQuantity": 123,
"variationProductCode": "<string>",
"weight": 123,
"weightUnit": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedOrderHandlingFee": 123,
"weightedOrderHandlingFeeDiscount": 123,
"weightedOrderHandlingFeeTax": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123,
"width": 123
}
],
"taxData": {},
"tenantId": 123,
"total": 123,
"transferShipmentNumbers": [
123
],
"transferredItems": [
{
"actualPrice": 123,
"allocatedQuantity": 123,
"allowsBackOrder": true,
"allowsFutureAllocate": true,
"allowsSubstitution": true,
"appeasementReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"autoSubstitution": true,
"backorderReleaseDate": "2023-11-07T05:31:56Z",
"blockAssignment": true,
"bundleInfo": {
"attributes": {},
"imageUrl": "<string>",
"name": "<string>",
"productCode": "<string>",
"quantity": 123,
"unitPrice": 123
},
"cartItemId": "<string>",
"childItemIds": [
"<string>"
],
"condition": "<string>",
"creditCurrencyCode": "<string>",
"creditValue": 123,
"data": {},
"duty": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": {}
}
],
"fulfillmentLocationCode": "<string>",
"giftCards": [
{
"activationDate": "2023-11-07T05:31:56Z",
"cardNumber": "<string>",
"code": "<string>",
"creditType": "<string>",
"creditValue": 123,
"currencyCode": "<string>",
"currentBalance": 123,
"customerId": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"initialBalance": 123
}
],
"giftMessage": "<string>",
"goodsType": "Physical",
"handling": 123,
"handlingDiscount": 123,
"handlingTax": 123,
"height": 123,
"holdBlockAssignment": true,
"imageUrl": "<string>",
"inventoryAllocations": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"condition": "<string>",
"date": "2023-11-07T05:31:56Z",
"fulfilledDate": "2023-11-07T05:31:56Z",
"inventoryId": 123,
"lotCode": "<string>",
"originalQuantity": 123,
"quantity": 123,
"serialNumber": "<string>",
"sku": "<string>",
"status": "<string>"
}
],
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"isAssemblyRequired": true,
"isGift": true,
"isPackagedStandAlone": true,
"isReservedInventory": true,
"isTaxable": true,
"itemDiscount": 123,
"itemTax": 123,
"length": 123,
"lineId": 123,
"lineItemAdjustment": 123,
"lineItemCost": 123,
"locatorName": "<string>",
"manageStock": true,
"name": "<string>",
"optionAttributeFQN": "<string>",
"options": [
{
"attributeFQN": "<string>",
"attributes": {},
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": {},
"stringValue": "<string>",
"value": {}
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "Internal",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"rejectedReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"returnRuleInfo": {
"attributes": {},
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipmentItemAttributes": [
{
"attributeDefinitionId": 123,
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
{}
]
}
],
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"stockValidationStatus": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteQuantity": 123,
"substitutionType": "PRE_FULFILLMENT",
"taxData": {},
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"timeFenceDays": 123,
"transferQuantity": 123,
"trueTransferQuantity": 123,
"unitPrice": 123,
"upc": "<string>",
"validatedQuantity": 123,
"variationProductCode": "<string>",
"weight": 123,
"weightUnit": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedOrderHandlingFee": 123,
"weightedOrderHandlingFeeDiscount": 123,
"weightedOrderHandlingFeeTax": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123,
"width": 123
}
],
"transitTime": "<string>",
"userId": "<string>",
"workflowProcessContainerId": "<string>",
"workflowProcessId": "<string>",
"workflowProcessVersion": "<string>",
"workflowState": {
"activeTaskName": "<string>",
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"completedDate": "2023-11-07T05:31:56Z",
"processInstanceId": "<string>",
"shipmentState": "<string>",
"taskList": [
{
"_links": {},
"active": true,
"activeDate": "2023-11-07T05:31:56Z",
"completed": true,
"completedDate": "2023-11-07T05:31:56Z",
"completedDurationMillis": 123,
"description": "<string>",
"inputs": [
{
"helpMessage": "<string>",
"label": "<string>",
"maxLength": 123,
"maximum": 123,
"minLength": 123,
"minimum": 123,
"name": "<string>",
"options": [
{}
],
"pattern": "<string>",
"required": true,
"type": "STRING"
}
],
"name": "<string>",
"skippable": true,
"subject": "<string>",
"taskId": "<string>"
}
],
"variables": {}
}
}Authorizations
JWT Authorization header using the Bearer scheme.
Headers
If-Match
Path Parameters
shipmentNumber
Response
OK
Shipment type code
STH, BOPIS, BOPIS_Curbside, Transfer, Curbside, Digital, Delivery "STH"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Run currently mutating this shipment (== Kibo.Jobs jobId); null when idle (FR-059d)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
NotFulfilled, Fulfilled Show child attributes
Show child attributes
Show child attributes
Show child attributes
Offline, Online 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.
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).
Show child attributes
Show child attributes
US4 progress display: packagesTotalCount minus packagesReceivedCount. Null when not eligible/flag disabled.
US4 progress display: count of packages with receiptStatus=RECEIVED. Null when not eligible/flag disabled.
US4 progress display: total expected package count. Null when not eligible/flag disabled.
Show child attributes
Show child attributes
AVAILABLE, IN_WAVE, PICKED, TRANSFER, COMPLETE NORMAL, SINGLE, MULTIPLE Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Capped per-run history of operations that created/mutated this shipment (FR-059d)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
READY, REASSIGNED, BACKORDER, CANCELED, FULFILLED, CUSTOMER_CARE, DELETED, FUTURE Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes

