Async Order Create
8 min
This API is called to create new Orders (PO) through Async API. Customer can integrate this API into their process and push Order payload JSON directly.
This API supports JSON payload. Please contact FourKites support to integrate using this API.
For the list of codes that go into orderInstructionCode, click on the button below.
Note: All date fields in this API use UTC exclusively.
You can update your Orders using the simpleUpdate parameter. Read more about it here.
Production
PUT
https://api.fourkites.com/api/v1/async/order/?request_id=%3CYOUR_REQUEST_ID%3E
curl --location --request PUT 'https://api.fourkites.com/api/v1/async/order/?request_id=%3CYOUR_REQUEST_ID%3E' \
--header 'apikey: <YOUR_API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
"order": {
"orderNumber": "PO44839202",
"simpleUpdate": "true",
"orderTypeCode": "PO",
"orderPriority": "HIGH",
"orderStatusCode": "0273TF",
"status": "on order",
"transportType": "domestic",
"unitOfMeasure": "EA",
"totalQuantity": "100",
"totalMonetaryAmountIncludingTaxes": "6778",
"totalMonetaryAmountExcludingTaxes": "5454",
"totalTaxAmount": "123",
"isOrderFreeOfExciseTaxDuty": "YES",
"currencyCode": "USD",
"orderEntryType": "MOBILE",
"paymentMethodCode": "prepaid",
"orderInstructionCode": "CASE_SPLITTING_NOT_ALLOWED",
"additionalOrderInstruction": "last order was not delivered on time",
"orderCreationDate": "2021-02-28T11:00:27.464596Z",
"shipDate": "2021-02-28T11:00:27.464596Z",
"requiredDeliveryDateTime": "2021-02-28T11:00:27.464596Z",
"shipmentReference": [
"44839202",
"44839203",
"44839204"
],
"latestDeliveryDate": "2021-02-28T11:00:27.464596Z",
"lastUpdatedTime": "2021-02-28T11:00:27.464596Z",
"externalUrl": [
{
"name": "link 1",
"url": "value"
},
{
"name": "link 2",
"url": "value"
}
],
"reasonCodes": [
"reasoncode"
],
"orderAvpList": [
{
"additionalFields": {
"key1": "ZOR"
}
}
],
"referenceNumbers": [
{
"type": "IDOC",
"value": "16273"
}
],
"releaseDate": "2021-02-28T11:00:27.464596Z",
"pickupFrom": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Supplier Facility"
},
"organisationName": "organisation 123"
},
"deliveryTerms": {
"inCoTermsCode": "EXW",
"deliveryInstructions": "leave at door"
},
"holdDate": "2021-02-28T11:00:27.464596Z",
"orderLogisticalInformation": {
"shipFrom": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Customer Facility"
},
"organisationName": "organisation 12"
},
"shipTo": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Cross Dock"
},
"organisationName": "organisation abc"
}
},
"buyer": {
"id": "2",
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Store"
},
"organisationName": "organisation dce"
},
"seller": {
"id": "2",
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Customer Facility"
},
"organisationName": "seller 1234"
},
"billTo": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Customer Facility"
},
"organisationName": "Organisation FGH"
},
"lineItems": [
{
"itemName": "item-101",
"lineItemNumber": "item-gs1_001",
"lineMabd": "2024-11-28T11:00:27.464596Z",
"lineShipTo": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Cross Dock"
},
"organisationName": "organisation abc"
},
"lineShipFrom": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Customer Facility"
},
"organisationName": "organisation 12"
},
"lineShipDate": "2024-11-28T11:00:27.464596Z",
"itemDescription": "item desc 101",
"requestedQuantity": 100,
"shippedQuantity": 100,
"promoDate": "2021-02-28T11:00:27.464596Z",
"lineItemActionCode": "UPDATED",
"quantityUnit": "CS",
"netPrice": 100,
"netAmount": "2000",
"itemNetWeight": 10,
"itemGrossWeight": 1,
"weightUnit": "kg",
"additionalOrderLineInstruction": "",
"externalUrl": [
{
"name": "link 1",
"url": "value"
},
{
"name": "link 2",
"url": "value"
}
],
"referenceNumbers": [
{
"type": "IDOC",
"value": "DTXT"
}
],
"distributionMethod": "ee",
"avpList": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
"orderLineItemInstructionCode": "orderLineItemInstructionCode",
"orderLineItemPriority": "HIGH",
"caseDetails": [
{
"casePackId": "case-101",
"casePackQuantity": 1,
"casePackDescription": "case desc 101",
"casePackSize": 1,
"casePackCategory": "case cat-101"
}
],
"product": {
"productId": "666451",
"productSku": "666451",
"productCategory": "books",
"productUpc": "666451",
"commodityTypeCode": "1234567891",
"gtin": "GTIN7382022",
"productOwner": "xyz",
"additionalTradeItemClassificationCode": "additionalTradeItemClassificationCode",
"gpcCategoryCode": "ee",
"gpcCategoryName": "ee",
"gpcAttributeTypeCode": "ee",
"gpcAttributeTypeName": "ee",
"gpcAttributeValueCode": "ee",
"gpcAttributeValueName": "ee"
},
"htsCode": "8471.30.01",
"supplierHtsCode": "8471.30.01",
"transactionalTradeItem": {
"transactionalItemData": {
"availableForSaleDate": "2021-02-28T11:00:27.464596Z",
"batchNumber": "case",
"bestBeforeDate": "2021-02-28T11:00:27.464596Z",
"countryOfOrigin": "case",
"itemExpirationDate": "2021-02-28T11:00:27.464596Z",
"lotNumber": "1",
"packagingDate": "2021-02-28T11:00:27.464596Z",
"productionDate": "2021-02-28T11:00:27.464596Z",
"productQualityIndication": "2",
"sellByDate": "2021-02-28T11:00:27.464596Z",
"serialNumber": "23",
"shelfLife": "4",
"tradeItemQuantity": "3",
"transactionalItemDimensions": {
"depth": "12",
"height": "12",
"width": "234",
"uom": "kg"
},
"transactionalItemVolume": {
"measurementType": "ee",
"measurementValue": "ee"
},
"transactionalItemWeight": {
"measurementType": "ee",
"measurementValue": "ee"
},
"transactionalItemLogisticUnitInformation": {
"maximumStackingFactor": "12",
"numberOfLayers": "12",
"numberOfUnitsPerLayer": "12",
"numberOfPallets": "12",
"dimensionsOfLogisticUnit": {
"depth": "11",
"height": "11",
"width": "1",
"uom": "kg"
}
}
},
"color": {
"colorDescription": "wewe",
"colorCode": "red"
},
"size": {
"descriptiveSize": "1",
"sizeCode": "12"
}
}
}
]
},
"deliveries": [
{
"deliveryID": "test_d_323",
"deliveryStatus": "i",
"deliveryType": "Inbound",
"eventTime": "2023-09-21T00:00:00Z",
"requestedWarehouseAppointmentTime": "2023-09-21T00:00:00Z",
"warehouseAppointmentTime": "2023-09-21T00:00:00Z",
"eventSource": "erp",
"trailerNumber": "T123987",
"shipmentNumber": "LOAD-123",
"referenceNumbers":[{
"type": "key",
"value":"value"
}],
"shipmentReferenceNumbers": [
"44839202",
"44839203",
"44839204"
],
"simpleUpdate": "true",
"externalUrl": [
{
"name": "link 1",
"url": "value"
},
{
"name": "link 2",
"url": "value"
}
],
"avpList": {
"key1": "value1",
"key2": "value2"
},
"plannedPickupDate": "2023-09-21T08:00:00Z",
"plannedDeliveryDate": "2023-09-21T16:00:00Z",
"deliveryOrigin": {
"gln": "0860001234567",
"id": "DC-DAL-001",
"name": "Walmart Distribution Center Dallas",
"contact": {
"departmentName": "Shipping Department",
"personName": "John Smith",
"responsibility": "Shipping Manager",
"communicationChannel": [
{
"communicationChannelCode": "EMAIL",
"communicationValue": "[email protected]"
},
{
"communicationChannelCode": "PHONE",
"communicationValue": "+1-214-555-0123"
}
]
},
"address": {
"addressLine1": "1500 Distribution Way",
"addressLine2": "Building A, Dock 12",
"city": "Dallas",
"state": "TX",
"country": "USA",
"zip": "75247",
"name": "Walmart DC Dallas"
},
"organisationName": "Walmart Distribution Services"
},
"deliveryDestination": {
"gln": "0860009876543",
"id": "STR-AUS-045",
"name": "Walmart Supercenter #045",
"contact": {
"departmentName": "Receiving Department",
"personName": "Maria Garcia",
"responsibility": "Receiving Manager",
"communicationChannel": [
{
"communicationChannelCode": "EMAIL",
"communicationValue": "[email protected]"
},
{
"communicationChannelCode": "PHONE",
"communicationValue": "+1-512-555-0456"
}
]
},
"address": {
"addressLine1": "9900 S Interstate 35",
"addressLine2": "Receiving Dock B",
"city": "Austin",
"state": "TX",
"country": "USA",
"zip": "78748",
"name": "Walmart Supercenter Austin"
},
"organisationName": "Walmart Inc."
},
"caseLevelDetails": [
{
"packageID": "CASE-2025-07-24-001",
"description": "Organic Whole Milk - 1 Gallon",
"linePackageQty": 4,
"qtyUom": "GAL",
"packageType": "Crate",
"packageDimensions": "16x12x10",
"linePackageWt": "34.0",
"packageNetWt": "32.0",
"packageGrossWt": "34.5",
"wtUom": "LBS",
"packageTiHi": "8x6",
"lineLotNumber": "LOT-MLK-20250720",
"lineBatchNumber": "BATCH-7245",
"lineManufactureDate": "2025-07-20",
"lineExpiry": "2025-08-03",
"lineCountryOfOrigin": "USA"
},
{
"packageID": "CASE-2025-07-24-002",
"description": "Greek Yogurt Variety Pack - 32oz",
"linePackageQty": 12,
"qtyUom": "EA",
"packageType": "Box",
"packageDimensions": "20x15x8",
"linePackageWt": "26.0",
"packageNetWt": "24.0",
"packageGrossWt": "26.5",
"wtUom": "LBS",
"packageTiHi": "10x8",
"lineLotNumber": "LOT-YOG-20250721",
"lineBatchNumber": "BATCH-8956",
"lineManufactureDate": "2025-07-21",
"lineExpiry": "2025-08-20",
"lineCountryOfOrigin": "USA"
}
],
"facility": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"addressLine2": "Marine Drive",
"locationType": "Supplier Facility"
},
"organisationName": "organisation 123"
},
"orderDetails": [
{
"orderID": "PO44839202",
"lineDetails": [
{
"lineItemNumber": "item-gs1_001",
"productId": "666451",
"sku": "666451",
"upc": "666451",
"quantity": "100",
"unitOfMeasure": "unit",
"lotNumber": "LOT8383",
"manufactureDate": "2023-09-21T00:00:00Z",
"expirationDate": "2023-09-21T00:00:00Z",
"grade": "GRA73922",
"supplierHtsCode": "8471.30.01"
}
]
}
]
}
]
}'Click here for additional parameters under line items.
Staging
PUT
https://api-staging.fourkites.com/api/v1/async/order/?request_id=%3CYOUR_REQUEST_ID%3E
curl --location --request PUT 'https://api-staging.fourkites.com/api/v1/async/order/?request_id=%3CYOUR_REQUEST_ID%3E' \
--header 'apikey: <YOUR_API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
"order": {
"orderNumber": "PO44839202",
"simpleUpdate": "true",
"orderTypeCode": "PO",
"orderPriority": "HIGH",
"orderStatusCode": "0273TF",
"status": "on order",
"transportType": "domestic",
"unitOfMeasure": "EA",
"totalQuantity": "100",
"totalMonetaryAmountIncludingTaxes": "6778",
"totalMonetaryAmountExcludingTaxes": "5454",
"totalTaxAmount": "123",
"isOrderFreeOfExciseTaxDuty": "YES",
"currencyCode": "USD",
"orderEntryType": "MOBILE",
"paymentMethodCode": "prepaid",
"orderInstructionCode": "CASE_SPLITTING_NOT_ALLOWED",
"additionalOrderInstruction": "last order was not delivered on time",
"orderCreationDate": "2021-02-28T11:00:27.464596Z",
"shipDate": "2021-02-28T11:00:27.464596Z",
"requiredDeliveryDateTime": "2021-02-28T11:00:27.464596Z",
"shipmentReference": [
"44839202",
"44839203",
"44839204"
],
"latestDeliveryDate": "2021-02-28T11:00:27.464596Z",
"lastUpdatedTime": "2021-02-28T11:00:27.464596Z",
"externalUrl": [
{
"name": "link 1",
"url": "value"
},
{
"name": "link 2",
"url": "value"
}
],
"reasonCodes": [
"reasoncode"
],
"orderAvpList": [
{
"additionalFields": {
"key1": "ZOR"
}
}
],
"referenceNumbers": [
{
"type": "IDOC",
"value": "16273"
}
],
"releaseDate": "2021-02-28T11:00:27.464596Z",
"pickupFrom": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Supplier Facility"
},
"organisationName": "organisation 123"
},
"deliveryTerms": {
"inCoTermsCode": "EXW",
"deliveryInstructions": "leave at door"
},
"holdDate": "2021-02-28T11:00:27.464596Z",
"orderLogisticalInformation": {
"shipFrom": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Customer Facility"
},
"organisationName": "organisation 12"
},
"shipTo": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Cross Dock"
},
"organisationName": "organisation abc"
}
},
"buyer": {
"id": "2",
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Store"
},
"organisationName": "organisation dce"
},
"seller": {
"id": "2",
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Customer Facility"
},
"organisationName": "seller 1234"
},
"billTo": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Customer Facility"
},
"organisationName": "Organisation FGH"
},
"lineItems": [
{
"itemName": "item-101",
"lineItemNumber": "item-gs1_001",
"lineMabd": "2024-11-28T11:00:27.464596Z",
"lineShipTo": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Cross Dock"
},
"organisationName": "organisation abc"
},
"lineShipFrom": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Customer Facility"
},
"organisationName": "organisation 12"
},
"lineShipDate": "2024-11-28T11:00:27.464596Z",
"itemDescription": "item desc 101",
"requestedQuantity": 100,
"shippedQuantity": 100,
"promoDate": "2021-02-28T11:00:27.464596Z",
"lineItemActionCode": "UPDATED",
"quantityUnit": "CS",
"netPrice": 100,
"netAmount": "2000",
"itemNetWeight": 10,
"itemGrossWeight": 1,
"weightUnit": "kg",
"additionalOrderLineInstruction": "",
"externalUrl": [
{
"name": "link 1",
"url": "value"
},
{
"name": "link 2",
"url": "value"
}
],
"referenceNumbers": [
{
"type": "IDOC",
"value": "DTXT"
}
],
"distributionMethod": "ee",
"avpList": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
"orderLineItemInstructionCode": "orderLineItemInstructionCode",
"orderLineItemPriority": "HIGH",
"caseDetails": [
{
"casePackId": "case-101",
"casePackQuantity": 1,
"casePackDescription": "case desc 101",
"casePackSize": 1,
"casePackCategory": "case cat-101"
}
],
"product": {
"productId": "666451",
"productSku": "666451",
"productCategory": "books",
"productUpc": "666451",
"commodityTypeCode": "1234567891",
"gtin": "GTIN7382022",
"productOwner": "xyz",
"additionalTradeItemClassificationCode": "additionalTradeItemClassificationCode",
"gpcCategoryCode": "ee",
"gpcCategoryName": "ee",
"gpcAttributeTypeCode": "ee",
"gpcAttributeTypeName": "ee",
"gpcAttributeValueCode": "ee",
"gpcAttributeValueName": "ee"
},
"htsCode": "8471.30.01",
"supplierHtsCode": "8471.30.01",
"transactionalTradeItem": {
"transactionalItemData": {
"availableForSaleDate": "2021-02-28T11:00:27.464596Z",
"batchNumber": "case",
"bestBeforeDate": "2021-02-28T11:00:27.464596Z",
"countryOfOrigin": "case",
"itemExpirationDate": "2021-02-28T11:00:27.464596Z",
"lotNumber": "1",
"packagingDate": "2021-02-28T11:00:27.464596Z",
"productionDate": "2021-02-28T11:00:27.464596Z",
"productQualityIndication": "2",
"sellByDate": "2021-02-28T11:00:27.464596Z",
"serialNumber": "23",
"shelfLife": "4",
"tradeItemQuantity": "3",
"transactionalItemDimensions": {
"depth": "12",
"height": "12",
"width": "234",
"uom": "kg"
},
"transactionalItemVolume": {
"measurementType": "ee",
"measurementValue": "ee"
},
"transactionalItemWeight": {
"measurementType": "ee",
"measurementValue": "ee"
},
"transactionalItemLogisticUnitInformation": {
"maximumStackingFactor": "12",
"numberOfLayers": "12",
"numberOfUnitsPerLayer": "12",
"numberOfPallets": "12",
"dimensionsOfLogisticUnit": {
"depth": "11",
"height": "11",
"width": "1",
"uom": "kg"
}
}
},
"color": {
"colorDescription": "wewe",
"colorCode": "red"
},
"size": {
"descriptiveSize": "1",
"sizeCode": "12"
}
}
}
]
},
"deliveries": [
{
"deliveryID": "test_d_323",
"deliveryStatus": "i",
"deliveryType": "Inbound",
"eventTime": "2023-09-21T00:00:00Z",
"requestedWarehouseAppointmentTime": "2023-09-21T00:00:00Z",
"warehouseAppointmentTime": "2023-09-21T00:00:00Z",
"eventSource": "erp",
"trailerNumber": "T123987",
"shipmentNumber": "LOAD-123",
"referenceNumbers":[{
"type": "key",
"value":"value"
}],
"shipmentReferenceNumbers": [
"44839202",
"44839203",
"44839204"
],
"simpleUpdate": "true",
"externalUrl": [
{
"name": "link 1",
"url": "value"
},
{
"name": "link 2",
"url": "value"
}
],
"avpList": {
"key1": "value1",
"key2": "value2"
},
"plannedPickupDate": "2023-09-21T08:00:00Z",
"plannedDeliveryDate": "2023-09-21T16:00:00Z",
"deliveryOrigin": {
"gln": "0860001234567",
"id": "DC-DAL-001",
"name": "Walmart Distribution Center Dallas",
"contact": {
"departmentName": "Shipping Department",
"personName": "John Smith",
"responsibility": "Shipping Manager",
"communicationChannel": [
{
"communicationChannelCode": "EMAIL",
"communicationValue": "[email protected]"
},
{
"communicationChannelCode": "PHONE",
"communicationValue": "+1-214-555-0123"
}
]
},
"address": {
"addressLine1": "1500 Distribution Way",
"addressLine2": "Building A, Dock 12",
"city": "Dallas",
"state": "TX",
"country": "USA",
"zip": "75247",
"name": "Walmart DC Dallas"
},
"organisationName": "Walmart Distribution Services"
},
"deliveryDestination": {
"gln": "0860009876543",
"id": "STR-AUS-045",
"name": "Walmart Supercenter #045",
"contact": {
"departmentName": "Receiving Department",
"personName": "Maria Garcia",
"responsibility": "Receiving Manager",
"communicationChannel": [
{
"communicationChannelCode": "EMAIL",
"communicationValue": "[email protected]"
},
{
"communicationChannelCode": "PHONE",
"communicationValue": "+1-512-555-0456"
}
]
},
"address": {
"addressLine1": "9900 S Interstate 35",
"addressLine2": "Receiving Dock B",
"city": "Austin",
"state": "TX",
"country": "USA",
"zip": "78748",
"name": "Walmart Supercenter Austin"
},
"organisationName": "Walmart Inc."
},
"caseLevelDetails": [
{
"packageID": "CASE-2025-07-24-001",
"description": "Organic Whole Milk - 1 Gallon",
"linePackageQty": 4,
"qtyUom": "GAL",
"packageType": "Crate",
"packageDimensions": "16x12x10",
"linePackageWt": "34.0",
"packageNetWt": "32.0",
"packageGrossWt": "34.5",
"wtUom": "LBS",
"packageTiHi": "8x6",
"lineLotNumber": "LOT-MLK-20250720",
"lineBatchNumber": "BATCH-7245",
"lineManufactureDate": "2025-07-20",
"lineExpiry": "2025-08-03",
"lineCountryOfOrigin": "USA"
},
{
"packageID": "CASE-2025-07-24-002",
"description": "Greek Yogurt Variety Pack - 32oz",
"linePackageQty": 12,
"qtyUom": "EA",
"packageType": "Box",
"packageDimensions": "20x15x8",
"linePackageWt": "26.0",
"packageNetWt": "24.0",
"packageGrossWt": "26.5",
"wtUom": "LBS",
"packageTiHi": "10x8",
"lineLotNumber": "LOT-YOG-20250721",
"lineBatchNumber": "BATCH-8956",
"lineManufactureDate": "2025-07-21",
"lineExpiry": "2025-08-20",
"lineCountryOfOrigin": "USA"
}
],
"facility": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"addressLine2": "Marine Drive",
"locationType": "Supplier Facility"
},
"organisationName": "organisation 123"
},
"orderDetails": [
{
"orderID": "PO44839202",
"lineDetails": [
{
"lineItemNumber": "item-gs1_001",
"productId": "666451",
"sku": "666451",
"upc": "666451",
"quantity": "100",
"unitOfMeasure": "unit",
"lotNumber": "LOT8383",
"manufactureDate": "2023-09-21T00:00:00Z",
"expirationDate": "2023-09-21T00:00:00Z",
"grade": "GRA73922",
"supplierHtsCode": "8471.30.01"
}
]
}
]
}
]
}'Azure - Production
PUT
https://api.ng.fourkites.com/api/v1/async/order/?request_id=%3CYOUR_REQUEST_ID%3E
curl --location --request PUT 'https://api.ng.fourkites.com/api/v1/async/order/?request_id=%3CYOUR_REQUEST_ID%3E' \
--header 'apikey: <YOUR_API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
"order": {
"orderNumber": "PO44839202",
"simpleUpdate": "true",
"orderTypeCode": "PO",
"orderPriority": "HIGH",
"orderStatusCode": "0273TF",
"status": "on order",
"transportType": "domestic",
"unitOfMeasure": "EA",
"totalQuantity": "100",
"totalMonetaryAmountIncludingTaxes": "6778",
"totalMonetaryAmountExcludingTaxes": "5454",
"totalTaxAmount": "123",
"isOrderFreeOfExciseTaxDuty": "YES",
"currencyCode": "USD",
"orderEntryType": "MOBILE",
"paymentMethodCode": "prepaid",
"orderInstructionCode": "CASE_SPLITTING_NOT_ALLOWED",
"additionalOrderInstruction": "last order was not delivered on time",
"orderCreationDate": "2021-02-28T11:00:27.464596Z",
"shipDate": "2021-02-28T11:00:27.464596Z",
"requiredDeliveryDateTime": "2021-02-28T11:00:27.464596Z",
"shipmentReference": [
"44839202",
"44839203",
"44839204"
],
"latestDeliveryDate": "2021-02-28T11:00:27.464596Z",
"lastUpdatedTime": "2021-02-28T11:00:27.464596Z",
"externalUrl": [
{
"name": "link 1",
"url": "value"
},
{
"name": "link 2",
"url": "value"
}
],
"reasonCodes": [
"reasoncode"
],
"orderAvpList": [
{
"additionalFields": {
"key1": "ZOR"
}
}
],
"referenceNumbers": [
{
"type": "IDOC",
"value": "16273"
}
],
"releaseDate": "2021-02-28T11:00:27.464596Z",
"pickupFrom": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Supplier Facility"
},
"organisationName": "organisation 123"
},
"deliveryTerms": {
"inCoTermsCode": "EXW",
"deliveryInstructions": "leave at door"
},
"holdDate": "2021-02-28T11:00:27.464596Z",
"orderLogisticalInformation": {
"shipFrom": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Customer Facility"
},
"organisationName": "organisation 12"
},
"shipTo": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Cross Dock"
},
"organisationName": "organisation abc"
}
},
"buyer": {
"id": "2",
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Store"
},
"organisationName": "organisation dce"
},
"seller": {
"id": "2",
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Customer Facility"
},
"organisationName": "seller 1234"
},
"billTo": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Customer Facility"
},
"organisationName": "Organisation FGH"
},
"lineItems": [
{
"itemName": "item-101",
"lineItemNumber": "item-gs1_001",
"lineMabd": "2024-11-28T11:00:27.464596Z",
"lineShipTo": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Cross Dock"
},
"organisationName": "organisation abc"
},
"lineShipFrom": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Customer Facility"
},
"organisationName": "organisation 12"
},
"lineShipDate": "2024-11-28T11:00:27.464596Z",
"itemDescription": "item desc 101",
"requestedQuantity": 100,
"shippedQuantity": 100,
"promoDate": "2021-02-28T11:00:27.464596Z",
"lineItemActionCode": "UPDATED",
"quantityUnit": "CS",
"netPrice": 100,
"netAmount": "2000",
"itemNetWeight": 10,
"itemGrossWeight": 1,
"weightUnit": "kg",
"additionalOrderLineInstruction": "",
"externalUrl": [
{
"name": "link 1",
"url": "value"
},
{
"name": "link 2",
"url": "value"
}
],
"referenceNumbers": [
{
"type": "IDOC",
"value": "DTXT"
}
],
"distributionMethod": "ee",
"avpList": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
"orderLineItemInstructionCode": "orderLineItemInstructionCode",
"orderLineItemPriority": "HIGH",
"caseDetails": [
{
"casePackId": "case-101",
"casePackQuantity": 1,
"casePackDescription": "case desc 101",
"casePackSize": 1,
"casePackCategory": "case cat-101"
}
],
"product": {
"productId": "666451",
"productSku": "666451",
"productCategory": "books",
"productUpc": "666451",
"commodityTypeCode": "1234567891",
"gtin": "GTIN7382022",
"productOwner": "xyz",
"additionalTradeItemClassificationCode": "additionalTradeItemClassificationCode",
"gpcCategoryCode": "ee",
"gpcCategoryName": "ee",
"gpcAttributeTypeCode": "ee",
"gpcAttributeTypeName": "ee",
"gpcAttributeValueCode": "ee",
"gpcAttributeValueName": "ee"
},
"htsCode": "8471.30.01",
"supplierHtsCode": "8471.30.01",
"transactionalTradeItem": {
"transactionalItemData": {
"availableForSaleDate": "2021-02-28T11:00:27.464596Z",
"batchNumber": "case",
"bestBeforeDate": "2021-02-28T11:00:27.464596Z",
"countryOfOrigin": "case",
"itemExpirationDate": "2021-02-28T11:00:27.464596Z",
"lotNumber": "1",
"packagingDate": "2021-02-28T11:00:27.464596Z",
"productionDate": "2021-02-28T11:00:27.464596Z",
"productQualityIndication": "2",
"sellByDate": "2021-02-28T11:00:27.464596Z",
"serialNumber": "23",
"shelfLife": "4",
"tradeItemQuantity": "3",
"transactionalItemDimensions": {
"depth": "12",
"height": "12",
"width": "234",
"uom": "kg"
},
"transactionalItemVolume": {
"measurementType": "ee",
"measurementValue": "ee"
},
"transactionalItemWeight": {
"measurementType": "ee",
"measurementValue": "ee"
},
"transactionalItemLogisticUnitInformation": {
"maximumStackingFactor": "12",
"numberOfLayers": "12",
"numberOfUnitsPerLayer": "12",
"numberOfPallets": "12",
"dimensionsOfLogisticUnit": {
"depth": "11",
"height": "11",
"width": "1",
"uom": "kg"
}
}
},
"color": {
"colorDescription": "wewe",
"colorCode": "red"
},
"size": {
"descriptiveSize": "1",
"sizeCode": "12"
}
}
}
]
},
"deliveries": [
{
"deliveryID": "test_d_323",
"deliveryStatus": "i",
"deliveryType": "Inbound",
"eventTime": "2023-09-21T00:00:00Z",
"requestedWarehouseAppointmentTime": "2023-09-21T00:00:00Z",
"warehouseAppointmentTime": "2023-09-21T00:00:00Z",
"eventSource": "erp",
"trailerNumber": "T123987",
"shipmentNumber": "LOAD-123",
"referenceNumbers":[{
"type": "key",
"value":"value"
}],
"shipmentReferenceNumbers": [
"44839202",
"44839203",
"44839204"
],
"simpleUpdate": "true",
"externalUrl": [
{
"name": "link 1",
"url": "value"
},
{
"name": "link 2",
"url": "value"
}
],
"avpList": {
"key1": "value1",
"key2": "value2"
},
"plannedPickupDate": "2023-09-21T08:00:00Z",
"plannedDeliveryDate": "2023-09-21T16:00:00Z",
"deliveryOrigin": {
"gln": "0860001234567",
"id": "DC-DAL-001",
"name": "Walmart Distribution Center Dallas",
"contact": {
"departmentName": "Shipping Department",
"personName": "John Smith",
"responsibility": "Shipping Manager",
"communicationChannel": [
{
"communicationChannelCode": "EMAIL",
"communicationValue": "[email protected]"
},
{
"communicationChannelCode": "PHONE",
"communicationValue": "+1-214-555-0123"
}
]
},
"address": {
"addressLine1": "1500 Distribution Way",
"addressLine2": "Building A, Dock 12",
"city": "Dallas",
"state": "TX",
"country": "USA",
"zip": "75247",
"name": "Walmart DC Dallas"
},
"organisationName": "Walmart Distribution Services"
},
"deliveryDestination": {
"gln": "0860009876543",
"id": "STR-AUS-045",
"name": "Walmart Supercenter #045",
"contact": {
"departmentName": "Receiving Department",
"personName": "Maria Garcia",
"responsibility": "Receiving Manager",
"communicationChannel": [
{
"communicationChannelCode": "EMAIL",
"communicationValue": "[email protected]"
},
{
"communicationChannelCode": "PHONE",
"communicationValue": "+1-512-555-0456"
}
]
},
"address": {
"addressLine1": "9900 S Interstate 35",
"addressLine2": "Receiving Dock B",
"city": "Austin",
"state": "TX",
"country": "USA",
"zip": "78748",
"name": "Walmart Supercenter Austin"
},
"organisationName": "Walmart Inc."
},
"caseLevelDetails": [
{
"packageID": "CASE-2025-07-24-001",
"description": "Organic Whole Milk - 1 Gallon",
"linePackageQty": 4,
"qtyUom": "GAL",
"packageType": "Crate",
"packageDimensions": "16x12x10",
"linePackageWt": "34.0",
"packageNetWt": "32.0",
"packageGrossWt": "34.5",
"wtUom": "LBS",
"packageTiHi": "8x6",
"lineLotNumber": "LOT-MLK-20250720",
"lineBatchNumber": "BATCH-7245",
"lineManufactureDate": "2025-07-20",
"lineExpiry": "2025-08-03",
"lineCountryOfOrigin": "USA"
},
{
"packageID": "CASE-2025-07-24-002",
"description": "Greek Yogurt Variety Pack - 32oz",
"linePackageQty": 12,
"qtyUom": "EA",
"packageType": "Box",
"packageDimensions": "20x15x8",
"linePackageWt": "26.0",
"packageNetWt": "24.0",
"packageGrossWt": "26.5",
"wtUom": "LBS",
"packageTiHi": "10x8",
"lineLotNumber": "LOT-YOG-20250721",
"lineBatchNumber": "BATCH-8956",
"lineManufactureDate": "2025-07-21",
"lineExpiry": "2025-08-20",
"lineCountryOfOrigin": "USA"
}
],
"facility": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"addressLine2": "Marine Drive",
"locationType": "Supplier Facility"
},
"organisationName": "organisation 123"
},
"orderDetails": [
{
"orderID": "PO44839202",
"lineDetails": [
{
"lineItemNumber": "item-gs1_001",
"productId": "666451",
"sku": "666451",
"upc": "666451",
"quantity": "100",
"unitOfMeasure": "unit",
"lotNumber": "LOT8383",
"manufactureDate": "2023-09-21T00:00:00Z",
"expirationDate": "2023-09-21T00:00:00Z",
"grade": "GRA73922",
"supplierHtsCode": "8471.30.01"
}
]
}
]
}
]
}'Azure - Staging
PUT
https://api-staging.ng.fourkites.com/api/v1/async/order/?request_id=%3CYOUR_REQUEST_ID%3E
curl --location --request PUT 'https://api-staging.ng.fourkites.com/api/v1/async/order/?request_id=%3CYOUR_REQUEST_ID%3E' \
--header 'apikey: <YOUR_API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
"order": {
"orderNumber": "PO44839202",
"simpleUpdate": "true",
"orderTypeCode": "PO",
"orderPriority": "HIGH",
"orderStatusCode": "0273TF",
"status": "on order",
"transportType": "domestic",
"unitOfMeasure": "EA",
"totalQuantity": "100",
"totalMonetaryAmountIncludingTaxes": "6778",
"totalMonetaryAmountExcludingTaxes": "5454",
"totalTaxAmount": "123",
"isOrderFreeOfExciseTaxDuty": "YES",
"currencyCode": "USD",
"orderEntryType": "MOBILE",
"paymentMethodCode": "prepaid",
"orderInstructionCode": "CASE_SPLITTING_NOT_ALLOWED",
"additionalOrderInstruction": "last order was not delivered on time",
"orderCreationDate": "2021-02-28T11:00:27.464596Z",
"shipDate": "2021-02-28T11:00:27.464596Z",
"requiredDeliveryDateTime": "2021-02-28T11:00:27.464596Z",
"shipmentReference": [
"44839202",
"44839203",
"44839204"
],
"latestDeliveryDate": "2021-02-28T11:00:27.464596Z",
"lastUpdatedTime": "2021-02-28T11:00:27.464596Z",
"externalUrl": [
{
"name": "link 1",
"url": "value"
},
{
"name": "link 2",
"url": "value"
}
],
"reasonCodes": [
"reasoncode"
],
"orderAvpList": [
{
"additionalFields": {
"key1": "ZOR"
}
}
],
"referenceNumbers": [
{
"type": "IDOC",
"value": "16273"
}
],
"releaseDate": "2021-02-28T11:00:27.464596Z",
"pickupFrom": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Supplier Facility"
},
"organisationName": "organisation 123"
},
"deliveryTerms": {
"inCoTermsCode": "EXW",
"deliveryInstructions": "leave at door"
},
"holdDate": "2021-02-28T11:00:27.464596Z",
"orderLogisticalInformation": {
"shipFrom": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Customer Facility"
},
"organisationName": "organisation 12"
},
"shipTo": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Cross Dock"
},
"organisationName": "organisation abc"
}
},
"buyer": {
"id": "2",
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Store"
},
"organisationName": "organisation dce"
},
"seller": {
"id": "2",
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Customer Facility"
},
"organisationName": "seller 1234"
},
"billTo": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Customer Facility"
},
"organisationName": "Organisation FGH"
},
"lineItems": [
{
"itemName": "item-101",
"lineItemNumber": "item-gs1_001",
"lineMabd": "2024-11-28T11:00:27.464596Z",
"lineShipTo": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Cross Dock"
},
"organisationName": "organisation abc"
},
"lineShipFrom": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"locationType": "Customer Facility"
},
"organisationName": "organisation 12"
},
"lineShipDate": "2024-11-28T11:00:27.464596Z",
"itemDescription": "item desc 101",
"requestedQuantity": 100,
"shippedQuantity": 100,
"promoDate": "2021-02-28T11:00:27.464596Z",
"lineItemActionCode": "UPDATED",
"quantityUnit": "CS",
"netPrice": 100,
"netAmount": "2000",
"itemNetWeight": 10,
"itemGrossWeight": 1,
"weightUnit": "kg",
"additionalOrderLineInstruction": "",
"externalUrl": [
{
"name": "link 1",
"url": "value"
},
{
"name": "link 2",
"url": "value"
}
],
"referenceNumbers": [
{
"type": "IDOC",
"value": "DTXT"
}
],
"distributionMethod": "ee",
"avpList": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
"orderLineItemInstructionCode": "orderLineItemInstructionCode",
"orderLineItemPriority": "HIGH",
"caseDetails": [
{
"casePackId": "case-101",
"casePackQuantity": 1,
"casePackDescription": "case desc 101",
"casePackSize": 1,
"casePackCategory": "case cat-101"
}
],
"product": {
"productId": "666451",
"productSku": "666451",
"productCategory": "books",
"productUpc": "666451",
"commodityTypeCode": "1234567891",
"gtin": "GTIN7382022",
"productOwner": "xyz",
"additionalTradeItemClassificationCode": "additionalTradeItemClassificationCode",
"gpcCategoryCode": "ee",
"gpcCategoryName": "ee",
"gpcAttributeTypeCode": "ee",
"gpcAttributeTypeName": "ee",
"gpcAttributeValueCode": "ee",
"gpcAttributeValueName": "ee"
},
"htsCode": "8471.30.01",
"supplierHtsCode": "8471.30.01",
"transactionalTradeItem": {
"transactionalItemData": {
"availableForSaleDate": "2021-02-28T11:00:27.464596Z",
"batchNumber": "case",
"bestBeforeDate": "2021-02-28T11:00:27.464596Z",
"countryOfOrigin": "case",
"itemExpirationDate": "2021-02-28T11:00:27.464596Z",
"lotNumber": "1",
"packagingDate": "2021-02-28T11:00:27.464596Z",
"productionDate": "2021-02-28T11:00:27.464596Z",
"productQualityIndication": "2",
"sellByDate": "2021-02-28T11:00:27.464596Z",
"serialNumber": "23",
"shelfLife": "4",
"tradeItemQuantity": "3",
"transactionalItemDimensions": {
"depth": "12",
"height": "12",
"width": "234",
"uom": "kg"
},
"transactionalItemVolume": {
"measurementType": "ee",
"measurementValue": "ee"
},
"transactionalItemWeight": {
"measurementType": "ee",
"measurementValue": "ee"
},
"transactionalItemLogisticUnitInformation": {
"maximumStackingFactor": "12",
"numberOfLayers": "12",
"numberOfUnitsPerLayer": "12",
"numberOfPallets": "12",
"dimensionsOfLogisticUnit": {
"depth": "11",
"height": "11",
"width": "1",
"uom": "kg"
}
}
},
"color": {
"colorDescription": "wewe",
"colorCode": "red"
},
"size": {
"descriptiveSize": "1",
"sizeCode": "12"
}
}
}
]
},
"deliveries": [
{
"deliveryID": "test_d_323",
"deliveryStatus": "i",
"deliveryType": "Inbound",
"eventTime": "2023-09-21T00:00:00Z",
"requestedWarehouseAppointmentTime": "2023-09-21T00:00:00Z",
"warehouseAppointmentTime": "2023-09-21T00:00:00Z",
"eventSource": "erp",
"trailerNumber": "T123987",
"shipmentNumber": "LOAD-123",
"referenceNumbers":[{
"type": "key",
"value":"value"
}],
"shipmentReferenceNumbers": [
"44839202",
"44839203",
"44839204"
],
"simpleUpdate": "true",
"externalUrl": [
{
"name": "link 1",
"url": "value"
},
{
"name": "link 2",
"url": "value"
}
],
"avpList": {
"key1": "value1",
"key2": "value2"
},
"plannedPickupDate": "2023-09-21T08:00:00Z",
"plannedDeliveryDate": "2023-09-21T16:00:00Z",
"deliveryOrigin": {
"gln": "0860001234567",
"id": "DC-DAL-001",
"name": "Walmart Distribution Center Dallas",
"contact": {
"departmentName": "Shipping Department",
"personName": "John Smith",
"responsibility": "Shipping Manager",
"communicationChannel": [
{
"communicationChannelCode": "EMAIL",
"communicationValue": "[email protected]"
},
{
"communicationChannelCode": "PHONE",
"communicationValue": "+1-214-555-0123"
}
]
},
"address": {
"addressLine1": "1500 Distribution Way",
"addressLine2": "Building A, Dock 12",
"city": "Dallas",
"state": "TX",
"country": "USA",
"zip": "75247",
"name": "Walmart DC Dallas"
},
"organisationName": "Walmart Distribution Services"
},
"deliveryDestination": {
"gln": "0860009876543",
"id": "STR-AUS-045",
"name": "Walmart Supercenter #045",
"contact": {
"departmentName": "Receiving Department",
"personName": "Maria Garcia",
"responsibility": "Receiving Manager",
"communicationChannel": [
{
"communicationChannelCode": "EMAIL",
"communicationValue": "[email protected]"
},
{
"communicationChannelCode": "PHONE",
"communicationValue": "+1-512-555-0456"
}
]
},
"address": {
"addressLine1": "9900 S Interstate 35",
"addressLine2": "Receiving Dock B",
"city": "Austin",
"state": "TX",
"country": "USA",
"zip": "78748",
"name": "Walmart Supercenter Austin"
},
"organisationName": "Walmart Inc."
},
"caseLevelDetails": [
{
"packageID": "CASE-2025-07-24-001",
"description": "Organic Whole Milk - 1 Gallon",
"linePackageQty": 4,
"qtyUom": "GAL",
"packageType": "Crate",
"packageDimensions": "16x12x10",
"linePackageWt": "34.0",
"packageNetWt": "32.0",
"packageGrossWt": "34.5",
"wtUom": "LBS",
"packageTiHi": "8x6",
"lineLotNumber": "LOT-MLK-20250720",
"lineBatchNumber": "BATCH-7245",
"lineManufactureDate": "2025-07-20",
"lineExpiry": "2025-08-03",
"lineCountryOfOrigin": "USA"
},
{
"packageID": "CASE-2025-07-24-002",
"description": "Greek Yogurt Variety Pack - 32oz",
"linePackageQty": 12,
"qtyUom": "EA",
"packageType": "Box",
"packageDimensions": "20x15x8",
"linePackageWt": "26.0",
"packageNetWt": "24.0",
"packageGrossWt": "26.5",
"wtUom": "LBS",
"packageTiHi": "10x8",
"lineLotNumber": "LOT-YOG-20250721",
"lineBatchNumber": "BATCH-8956",
"lineManufactureDate": "2025-07-21",
"lineExpiry": "2025-08-20",
"lineCountryOfOrigin": "USA"
}
],
"facility": {
"gln": "L-PAS-123",
"contact": {
"departmentName": "Purchase",
"personName": "Tony",
"responsibility": "Inbound Analyst",
"communicationChannel": [
{
"communicationChannelCode": "Email",
"communicationValue": "[email protected]"
}
]
},
"address": {
"addressLine1": "11 Grant Road",
"city": "Sterling",
"country": "US",
"name": "Distribution Center 55",
"state": "IL",
"zip": "54321",
"addressLine2": "Marine Drive",
"locationType": "Supplier Facility"
},
"organisationName": "organisation 123"
},
"orderDetails": [
{
"orderID": "PO44839202",
"lineDetails": [
{
"lineItemNumber": "item-gs1_001",
"productId": "666451",
"sku": "666451",
"upc": "666451",
"quantity": "100",
"unitOfMeasure": "unit",
"lotNumber": "LOT8383",
"manufactureDate": "2023-09-21T00:00:00Z",
"expirationDate": "2023-09-21T00:00:00Z",
"grade": "GRA73922",
"supplierHtsCode": "8471.30.01"
}
]
}
]
}
]
}'New Line Items
Field Name | Required or not | Data Type | Description |
|---|---|---|---|
lineMabd | Not required | String | Must arrive by date for a specific line item |
lineShipTo | Not required | Object | Ship to object with parameters related to stops |
lineShipFrom | Not required | Object | Ship from object with parameters related to stops |
lineShipDate | Not required | String | Date when the line item is supposed to be shipped |
Response Attributes
Name | Format | Description |
|---|---|---|
timestamp | String | Timestamp of request |
message | String | Success or Error Message depends on request outcome |
data | String | Exception in case of error processing request |
Error
Code | Resolution |
|---|---|
200 | Request accepted successfully |
401 | Unauthorized request |
400 | Bad request (wrong xml format) |
500 | Exception while processing request |
429 | Request throttling limit reached. Please re-try or Increase the throttling limit. |
List of codes allowed in orderInstructionCode
Code Value | Name | Definition |
|---|---|---|
BACK_ORDERS_ACCEPTED | Back orders accepted | Back orders accepted when partial delivery |
BACK_ORDERS_NOT_ACCEPTED | Back orders not accepted | No back orders accepted when partial delivery |
CASE_SPLITTING_ALLOWED | Case Splitting Allowed | The standard case may be split apart |
CASE_SPLITTING_NOT_ALLOWED | Case Splitting Not Allowed | The standard case must not be split apart |
FRESH_ITEM_REQUIRED | Fresh item required | The goods that are not delivered have to be re-ordered by the buyer. Supplier only delivers the goods they have in stock at that moment. One order leads to one delivery. |
OVER_SHIP_ALLOWED | Over ship Allowed | The quantity of an item contained in a case may be larger than the quantity ordered. |
OVER_SHIP_NOT_ALLOWED | Over ship Not Allowed | The quantity of an item contained in a case must not be larger than the quantity ordered. Any overage needs to be sent to the warehouse or back to the supplier. |
PACK_SEPARATELY | Pack separately | The items for this order must be packed separately from other orders in one or more logistic unit(s) which may all be part of the same shipment or consignment. |
PARTIAL_DELIVERY_ALLOWED | PARTIAL_DELIVERY_ALLOWED | The supplier keeps delivering until the entire order is fulfilled. One order can lead to many deliveries. The buyer doesn't need to place a new order; they just waits for the other goods to be delivered. |
STANDARD_CASE_NOT_REQUIRED | Standard Case Not Required | The order may be delivered in non-standard case |
STANDARD_CASE_REQUIRED | Standard Case Required | The order must be delivered in standard case |