A valid request URL is required to generate request examples[
{
"alternateContact": {
"email": "<string>",
"firstName": "<string>",
"lastNameOrSurname": "<string>",
"phoneNumber": "<string>"
},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"backorderCreatedDate": 123,
"canceledItems": [
{
"actualPrice": 123,
"allowsSubstitution": true,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"backorderReleaseDate": "2023-11-07T05:31:56Z",
"bundleInfo": {
"attributes": {},
"imageUrl": "<string>",
"name": "<string>",
"productCode": "<string>",
"quantity": 123,
"unitPrice": 123
},
"cartItemId": "<string>",
"childItemIds": [
"<string>"
],
"condition": "<string>",
"data": {},
"duty": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": null
}
],
"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>",
"handling": 123,
"handlingDiscount": 123,
"handlingTax": 123,
"imageUrl": "<string>",
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"isAssemblyRequired": true,
"isGift": true,
"isPackagedStandAlone": true,
"isReservedInventory": true,
"isSubstitutable": true,
"isTaxable": true,
"itemDiscount": 123,
"itemTax": 123,
"lineId": 123,
"lineItemAdjustment": 123,
"lineItemCost": 123,
"locatorName": "<string>",
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"name": "<string>",
"optionAttributeFQN": "<string>",
"options": [
{
"attributeFQN": "<string>",
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": "<unknown>",
"stringValue": "<string>",
"value": "<unknown>"
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentId": "<string>",
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "<string>",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"returnRuleInfo": {
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteQuantity": 123,
"substitutionType": "<string>",
"taxData": {},
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"unitPrice": 123,
"upc": "<string>",
"variationProductCode": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123,
"canceledReason": {
"description": "<string>",
"moreInfo": "<string>",
"reasonCode": "<string>"
}
}
],
"changeMessages": [
{
"amount": 123,
"appId": "<string>",
"appKey": "<string>",
"appName": "<string>",
"attributes": {},
"correlationId": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"identifier": "<string>",
"message": "<string>",
"metadata": "<unknown>",
"newValue": "<string>",
"oldValue": "<string>",
"subject": "<string>",
"subjectType": "<string>",
"success": true,
"userFirstName": "<string>",
"userId": "<string>",
"userLastName": "<string>",
"userScopeType": "<string>",
"verb": "<string>"
}
],
"cost": 123,
"currencyCode": "<string>",
"customer": {
"customerContact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"companyOrOrganization": "<string>",
"email": "<string>",
"firstName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
}
},
"data": "<unknown>",
"isDestinationCommercial": true
},
"customerAccountId": 123,
"customerTaxId": "<string>",
"data": {},
"destination": {
"data": {},
"destinationContact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"companyOrOrganization": "<string>",
"email": "<string>",
"firstName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
}
},
"id": "<string>",
"isDestinationCommercial": true
},
"dutyAdjustment": 123,
"dutyTotal": 123,
"email": "<string>",
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"externalOrderId": "<string>",
"externalShipmentId": "<string>",
"fulfillmentDate": "2023-11-07T05:31:56Z",
"fulfillmentLocationCode": "<string>",
"fulfillmentStatus": "<string>",
"futureDate": "2023-11-07T05:31:56Z",
"handlingAdjustment": 123,
"handlingSubtotal": 123,
"handlingTaxAdjustment": 123,
"handlingTaxTotal": 123,
"handlingTotal": 123,
"holdReleaseDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"isExpress": true,
"isFlatRateShipping": true,
"isTransfer": true,
"items": [
{
"actualPrice": 123,
"allowsSubstitution": true,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"backorderReleaseDate": "2023-11-07T05:31:56Z",
"bundleInfo": {
"attributes": {},
"imageUrl": "<string>",
"name": "<string>",
"productCode": "<string>",
"quantity": 123,
"unitPrice": 123
},
"cartItemId": "<string>",
"childItemIds": [
"<string>"
],
"condition": "<string>",
"data": {},
"duty": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": null
}
],
"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>",
"handling": 123,
"handlingDiscount": 123,
"handlingTax": 123,
"imageUrl": "<string>",
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"isAssemblyRequired": true,
"isGift": true,
"isPackagedStandAlone": true,
"isReservedInventory": true,
"isSubstitutable": true,
"isTaxable": true,
"itemDiscount": 123,
"itemTax": 123,
"lineId": 123,
"lineItemAdjustment": 123,
"lineItemCost": 123,
"locatorName": "<string>",
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"name": "<string>",
"optionAttributeFQN": "<string>",
"options": [
{
"attributeFQN": "<string>",
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": "<unknown>",
"stringValue": "<string>",
"value": "<unknown>"
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentId": "<string>",
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "<string>",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"returnRuleInfo": {
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteQuantity": 123,
"substitutionType": "<string>",
"taxData": {},
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"unitPrice": 123,
"upc": "<string>",
"variationProductCode": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123
}
],
"lineItemSubtotal": 123,
"lineItemTaxAdjustment": 123,
"lineItemTaxTotal": 123,
"lineItemTotal": 123,
"number": 123,
"orderId": "<string>",
"orderNumber": 123,
"orderSubmitDate": "2023-11-07T05:31:56Z",
"origin": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"companyOrOrganization": "<string>",
"email": "<string>",
"firstName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
}
},
"originalShipmentNumber": 123,
"packages": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"availableActions": [
"<string>"
],
"changeMessages": [
{
"amount": 123,
"appId": "<string>",
"appKey": "<string>",
"appName": "<string>",
"attributes": {},
"correlationId": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"identifier": "<string>",
"message": "<string>",
"metadata": "<unknown>",
"newValue": "<string>",
"oldValue": "<string>",
"subject": "<string>",
"subjectType": "<string>",
"success": true,
"userFirstName": "<string>",
"userId": "<string>",
"userLastName": "<string>",
"userScopeType": "<string>",
"verb": "<string>"
}
],
"code": "<string>",
"fulfillmentDate": "2023-11-07T05:31:56Z",
"fulfillmentLocationCode": "<string>",
"id": "<string>",
"items": [
{
"fulfillmentItemType": "<string>",
"lineId": 123,
"optionAttributeFQN": "<string>",
"productCode": "<string>",
"quantity": 123
}
],
"status": "<string>",
"attributes": {},
"carrier": "<string>",
"fxcbDocumentsUrl": "<string>",
"fxcbPackNotificationId": "<string>",
"hasLabel": true,
"integratorId": "<string>",
"labelFormat": "<string>",
"manifestId": "<string>",
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"packageId": "<string>",
"packagingType": "<string>",
"packingSlipItemDetails": [
{
"attributes": {},
"lineId": 123,
"originalOrderItemId": "<string>",
"quantity": 123
}
],
"packingSlipNumber": 123,
"returnCarrier": "<string>",
"returnTrackingNumbers": [
"<string>"
],
"returnTrackings": [
{
"attributes": {},
"number": "<string>",
"url": "<string>"
}
],
"shipmentId": "<string>",
"shippingMethodCode": "<string>",
"shippingMethodName": "<string>",
"signatureRequired": true,
"trackingNumber": "<string>",
"trackingNumbers": [
"<string>"
],
"trackings": [
{
"attributes": {},
"number": "<string>",
"url": "<string>"
}
]
}
],
"parentCheckoutNumber": 123,
"parentShipmentNumber": 123,
"pickStatus": "<string>",
"pickType": "<string>",
"pickupInfo": {},
"readyToCapture": true,
"shipmentAdjustment": 123,
"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>"
}
],
"shipmentStatus": "<string>",
"shipmentStatusReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"shipmentType": "<string>",
"shippingAdjustment": 123,
"shippingMethodCode": "<string>",
"shippingMethodName": "<string>",
"shippingSubtotal": 123,
"shippingTaxAdjustment": 123,
"shippingTaxTotal": 123,
"shippingTotal": 123,
"shopperNotes": {
"comments": "<string>",
"deliveryInstructions": "<string>",
"giftMessage": "<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": null
}
],
"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": "<string>",
"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": null,
"stringValue": "<string>",
"value": null
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "<string>",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"returnRuleInfo": {
"attributes": {},
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteItemLineIds": [
123
],
"substituteQuantity": 123,
"substituteReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"substitutionType": "<string>",
"taxData": null,
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"transferQuantity": 123,
"trueTransferQuantity": 123,
"unitPrice": 123,
"upc": "<string>",
"variationProductCode": "<string>",
"weight": 123,
"weightUnit": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123,
"width": 123
}
],
"taxData": {},
"total": 123,
"transferShipmentNumbers": [
123
],
"workflowProcessContainerId": "<string>",
"workflowProcessId": "<string>",
"workflowState": {
"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": [
{
"active": true,
"attributes": {},
"completed": true,
"completedDate": "2023-11-07T05:31:56Z",
"description": "<string>",
"inputs": [
{
"helpMessage": "<string>",
"label": "<string>",
"maxLength": 123,
"maximum": 123,
"minLength": 123,
"minimum": 123,
"name": "<string>",
"options": [
"<unknown>"
],
"pattern": "<string>",
"required": true,
"type": "<string>"
}
],
"links": {},
"name": "<string>",
"skippable": true,
"subject": "<string>",
"taskId": "<string>"
}
]
}
}
]Allows spliting an existing shipment.
A valid request URL is required to generate request examples[
{
"alternateContact": {
"email": "<string>",
"firstName": "<string>",
"lastNameOrSurname": "<string>",
"phoneNumber": "<string>"
},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"backorderCreatedDate": 123,
"canceledItems": [
{
"actualPrice": 123,
"allowsSubstitution": true,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"backorderReleaseDate": "2023-11-07T05:31:56Z",
"bundleInfo": {
"attributes": {},
"imageUrl": "<string>",
"name": "<string>",
"productCode": "<string>",
"quantity": 123,
"unitPrice": 123
},
"cartItemId": "<string>",
"childItemIds": [
"<string>"
],
"condition": "<string>",
"data": {},
"duty": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": null
}
],
"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>",
"handling": 123,
"handlingDiscount": 123,
"handlingTax": 123,
"imageUrl": "<string>",
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"isAssemblyRequired": true,
"isGift": true,
"isPackagedStandAlone": true,
"isReservedInventory": true,
"isSubstitutable": true,
"isTaxable": true,
"itemDiscount": 123,
"itemTax": 123,
"lineId": 123,
"lineItemAdjustment": 123,
"lineItemCost": 123,
"locatorName": "<string>",
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"name": "<string>",
"optionAttributeFQN": "<string>",
"options": [
{
"attributeFQN": "<string>",
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": "<unknown>",
"stringValue": "<string>",
"value": "<unknown>"
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentId": "<string>",
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "<string>",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"returnRuleInfo": {
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteQuantity": 123,
"substitutionType": "<string>",
"taxData": {},
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"unitPrice": 123,
"upc": "<string>",
"variationProductCode": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123,
"canceledReason": {
"description": "<string>",
"moreInfo": "<string>",
"reasonCode": "<string>"
}
}
],
"changeMessages": [
{
"amount": 123,
"appId": "<string>",
"appKey": "<string>",
"appName": "<string>",
"attributes": {},
"correlationId": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"identifier": "<string>",
"message": "<string>",
"metadata": "<unknown>",
"newValue": "<string>",
"oldValue": "<string>",
"subject": "<string>",
"subjectType": "<string>",
"success": true,
"userFirstName": "<string>",
"userId": "<string>",
"userLastName": "<string>",
"userScopeType": "<string>",
"verb": "<string>"
}
],
"cost": 123,
"currencyCode": "<string>",
"customer": {
"customerContact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"companyOrOrganization": "<string>",
"email": "<string>",
"firstName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
}
},
"data": "<unknown>",
"isDestinationCommercial": true
},
"customerAccountId": 123,
"customerTaxId": "<string>",
"data": {},
"destination": {
"data": {},
"destinationContact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"companyOrOrganization": "<string>",
"email": "<string>",
"firstName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
}
},
"id": "<string>",
"isDestinationCommercial": true
},
"dutyAdjustment": 123,
"dutyTotal": 123,
"email": "<string>",
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"externalOrderId": "<string>",
"externalShipmentId": "<string>",
"fulfillmentDate": "2023-11-07T05:31:56Z",
"fulfillmentLocationCode": "<string>",
"fulfillmentStatus": "<string>",
"futureDate": "2023-11-07T05:31:56Z",
"handlingAdjustment": 123,
"handlingSubtotal": 123,
"handlingTaxAdjustment": 123,
"handlingTaxTotal": 123,
"handlingTotal": 123,
"holdReleaseDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"isExpress": true,
"isFlatRateShipping": true,
"isTransfer": true,
"items": [
{
"actualPrice": 123,
"allowsSubstitution": true,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"backorderReleaseDate": "2023-11-07T05:31:56Z",
"bundleInfo": {
"attributes": {},
"imageUrl": "<string>",
"name": "<string>",
"productCode": "<string>",
"quantity": 123,
"unitPrice": 123
},
"cartItemId": "<string>",
"childItemIds": [
"<string>"
],
"condition": "<string>",
"data": {},
"duty": 123,
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": null
}
],
"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>",
"handling": 123,
"handlingDiscount": 123,
"handlingTax": 123,
"imageUrl": "<string>",
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"isAssemblyRequired": true,
"isGift": true,
"isPackagedStandAlone": true,
"isReservedInventory": true,
"isSubstitutable": true,
"isTaxable": true,
"itemDiscount": 123,
"itemTax": 123,
"lineId": 123,
"lineItemAdjustment": 123,
"lineItemCost": 123,
"locatorName": "<string>",
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"name": "<string>",
"optionAttributeFQN": "<string>",
"options": [
{
"attributeFQN": "<string>",
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": "<unknown>",
"stringValue": "<string>",
"value": "<unknown>"
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentId": "<string>",
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "<string>",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"returnRuleInfo": {
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteQuantity": 123,
"substitutionType": "<string>",
"taxData": {},
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"unitPrice": 123,
"upc": "<string>",
"variationProductCode": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123
}
],
"lineItemSubtotal": 123,
"lineItemTaxAdjustment": 123,
"lineItemTaxTotal": 123,
"lineItemTotal": 123,
"number": 123,
"orderId": "<string>",
"orderNumber": 123,
"orderSubmitDate": "2023-11-07T05:31:56Z",
"origin": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"companyOrOrganization": "<string>",
"email": "<string>",
"firstName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
}
},
"originalShipmentNumber": 123,
"packages": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"availableActions": [
"<string>"
],
"changeMessages": [
{
"amount": 123,
"appId": "<string>",
"appKey": "<string>",
"appName": "<string>",
"attributes": {},
"correlationId": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"identifier": "<string>",
"message": "<string>",
"metadata": "<unknown>",
"newValue": "<string>",
"oldValue": "<string>",
"subject": "<string>",
"subjectType": "<string>",
"success": true,
"userFirstName": "<string>",
"userId": "<string>",
"userLastName": "<string>",
"userScopeType": "<string>",
"verb": "<string>"
}
],
"code": "<string>",
"fulfillmentDate": "2023-11-07T05:31:56Z",
"fulfillmentLocationCode": "<string>",
"id": "<string>",
"items": [
{
"fulfillmentItemType": "<string>",
"lineId": 123,
"optionAttributeFQN": "<string>",
"productCode": "<string>",
"quantity": 123
}
],
"status": "<string>",
"attributes": {},
"carrier": "<string>",
"fxcbDocumentsUrl": "<string>",
"fxcbPackNotificationId": "<string>",
"hasLabel": true,
"integratorId": "<string>",
"labelFormat": "<string>",
"manifestId": "<string>",
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"packageId": "<string>",
"packagingType": "<string>",
"packingSlipItemDetails": [
{
"attributes": {},
"lineId": 123,
"originalOrderItemId": "<string>",
"quantity": 123
}
],
"packingSlipNumber": 123,
"returnCarrier": "<string>",
"returnTrackingNumbers": [
"<string>"
],
"returnTrackings": [
{
"attributes": {},
"number": "<string>",
"url": "<string>"
}
],
"shipmentId": "<string>",
"shippingMethodCode": "<string>",
"shippingMethodName": "<string>",
"signatureRequired": true,
"trackingNumber": "<string>",
"trackingNumbers": [
"<string>"
],
"trackings": [
{
"attributes": {},
"number": "<string>",
"url": "<string>"
}
]
}
],
"parentCheckoutNumber": 123,
"parentShipmentNumber": 123,
"pickStatus": "<string>",
"pickType": "<string>",
"pickupInfo": {},
"readyToCapture": true,
"shipmentAdjustment": 123,
"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>"
}
],
"shipmentStatus": "<string>",
"shipmentStatusReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"shipmentType": "<string>",
"shippingAdjustment": 123,
"shippingMethodCode": "<string>",
"shippingMethodName": "<string>",
"shippingSubtotal": 123,
"shippingTaxAdjustment": 123,
"shippingTaxTotal": 123,
"shippingTotal": 123,
"shopperNotes": {
"comments": "<string>",
"deliveryInstructions": "<string>",
"giftMessage": "<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": null
}
],
"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": "<string>",
"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": null,
"stringValue": "<string>",
"value": null
}
],
"originalLineId": 123,
"originalOrderItemId": "<string>",
"originalQuantity": 123,
"overridePrice": 123,
"parentItemId": "<string>",
"partNumber": "<string>",
"priceMode": "<string>",
"productCode": "<string>",
"purchaseLocation": "<string>",
"quantity": 123,
"readyForPickupQuantity": 123,
"returnRuleInfo": {
"attributes": {},
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"ruleCode": "<string>"
},
"serialNumber": "<string>",
"shipping": 123,
"shippingDiscount": 123,
"shippingTax": 123,
"sku": "<string>",
"substituteInfo": {
"optIn": "<string>",
"substituteProductCode": "<string>",
"substituteVariantCode": "<string>"
},
"substituteItemLineIds": [
123
],
"substituteQuantity": 123,
"substituteReason": {
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"substitutionType": "<string>",
"taxData": null,
"taxableHandling": 123,
"taxableLineItemCost": 123,
"taxableShipping": 123,
"transferQuantity": 123,
"trueTransferQuantity": 123,
"unitPrice": 123,
"upc": "<string>",
"variationProductCode": "<string>",
"weight": 123,
"weightUnit": "<string>",
"weightedDutyAdjustment": 123,
"weightedHandlingAdjustment": 123,
"weightedHandlingTaxAdjustment": 123,
"weightedLineItemTaxAdjustment": 123,
"weightedShipmentAdjustment": 123,
"weightedShippingAdjustment": 123,
"weightedShippingTaxAdjustment": 123,
"width": 123
}
],
"taxData": {},
"total": 123,
"transferShipmentNumbers": [
123
],
"workflowProcessContainerId": "<string>",
"workflowProcessId": "<string>",
"workflowState": {
"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": [
{
"active": true,
"attributes": {},
"completed": true,
"completedDate": "2023-11-07T05:31:56Z",
"description": "<string>",
"inputs": [
{
"helpMessage": "<string>",
"label": "<string>",
"maxLength": 123,
"maximum": 123,
"minLength": 123,
"minimum": 123,
"name": "<string>",
"options": [
"<unknown>"
],
"pattern": "<string>",
"required": true,
"type": "<string>"
}
],
"links": {},
"name": "<string>",
"skippable": true,
"subject": "<string>",
"taskId": "<string>"
}
]
}
}
]JWT Authorization header using the Bearer scheme.
limits which fields are returned in the response body
Success
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
ID of the shipment
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes