---
title: Line Updated
slug: fourkites-api-reference/line-updated
createdAt: 2026-06-04T06:41:05.000Z
---

The LINE\_UPDATED callback is triggered when one or more line items within an existing order are modified in FourKites. Use this callback to track granular line-level changes — such as quantity adjustments, status updates, or shipment associations — without processing a full order update.

The payload includes full order context alongside the updated line item details. Unlike ORDER\_UPDATED, this callback does not include a shipmentDetails object.

## Request Parameter

```json
{                                                                                                                                                                                              
    "messageType": "LINE_UPDATED",                                                                                                                                                               
    "companyPermalink": "string",                                                                                                                                                                
    "fourKitesOrderId": "550e8400-e29b-41d4-a716-446655440000",                                                                                                                                  
    "createdAt": "2025-01-15T10:30:45.123456789Z",                                                                                                                                               
    "uuid": "string",                                                                                                                                                                            
    "subStatusType": "order",                                                                                                                                                                    
    "subStatus": "string",                                                                                                                                                                       
    "eventTimestamp": "2025-01-15T10:30:45.123456789Z",                                                                                                                                          
    "timezone": "Coordinated Universal Time",                                                                                                                                                    
    "timezoneShortName": "UTC",                                                                                                                                                                  
    "timezoneOffset": 0,                                                                                                                                                                         
    "isSuccess": true,                                                                                                                                                                           
    "updatedAt": "2025-01-15T10:30:45.123456789Z",                                                                                                                                               
    "requestId": "string",                                                                                                                                                                       
    "orderDetails": {                                                                                                                                                                            
      "orderNumber": "string",                                                                                                                                                                   
      "orderStatus": "string",                                                                                                                                                                   
      "orderStatusTime": "2025-01-15T10:30:45.123456789Z",                                                                                                                                       
      "orderType": "PO",                                                                                                                                                                         
      "orderPaymentType": "string",                                                                                                                                                              
      "orderTransportType": "domestic",                                                                                                                                                          
      "orderActualShipDate": "2025-01-15T10:30:45.123456789Z",                                                                                                                                   
      "orderDestinationETA": "2025-01-15T10:30:45.123456789Z",                                                                                                                                   
      "orderPickupETA": "2025-01-15T10:30:45.123456789Z",                                                                                                                                        
      "orderActualDeliveryDate": "2025-01-15T10:30:45.123456789Z",                                                                                                                               
      "orderRequiredDeliveryDate": "2025-01-15T10:30:45.123456789Z",                                                                                                                             
      "orderMustShipByDate": "2025-01-15T10:30:45.123456789Z",                                                                                                                                   
      "orderETA": "2025-01-15T10:30:45.123456789Z",                                                                                                                                              
      "orderETAStatus": "ON_TIME",                                                                                                                                                               
      "orderDestination": "string",                                                                                                                                                              
      "orderReferenceNumbers": ["string"],                                                                                                                                                       
      "orderEURL": "string",                                                                                                                                                                     
      "releaseDate": "2025-01-15T10:30:45.123456789Z",                                                                                                                                           
      "holdDate": "2025-01-15T10:30:45.123456789Z",                                                                                                                                              
      "originalRequiredDeliveryDate": "2025-01-15T10:30:45.123456789Z",                                                                                                                          
      "originalShipDate": "2025-01-15T10:30:45.123456789Z",                                                                                                                                      
      "latestDeliveryDate": "2025-01-15T10:30:45.123456789Z",                                                                                                                                    
      "orderCreationDate": "2025-01-15T10:30:45.123456789Z",                                                                                                                                     
      "lastUpdatedTime": "2025-01-15T10:30:45.123456789Z",                                                                                                                                       
      "currencyCode": "string",                                                                                                                                                                  
      "totalMonetaryAmountIncludingTaxes": "string",                                                                                                                                             
      "totalMonetaryAmountExcludingTaxes": "string",                                                                                                                                             
      "totalTaxAmount": "string",                                                                                                                                                                
      "isOrderFreeOfExciseTaxDuty": "string",                                                                                                                                                    
      "totalTariffCost": 0.0,                                                                                                                                                                    
      "totalTariffPercentage": 0,                                                                                                                                                                
      "status": "string",                                                                                                                                                                        
      "orderStatusCode": "string",                                                                                                                                                               
      "orderPriority": "NORMAL",                                                                                                                                                                 
      "sourceType": "erp",                                                                                                                                                                       
      "orderEntryType": "string",                                                                                                                                                                
      "orderInstructionCode": "string",                                                                                                                                                          
      "additionalOrderInstruction": "string",                                                                                                                                                    
      "paymentMethodCode": "string",                                                                                                                                                             
      "numberOfDeliveries": 0,                                                                                                                                                                   
      "numberOfShipments": 0,                                                                                                                                                                    
      "numberOfLineItems": 0,                                                                                                                                                                    
      "referenceNumbers": [                                                                                                                                                                      
        {                                                                                                                                                                                        
          "type": "string",                                                                                                                                                                      
          "value": "string"                                                                                                                                                                      
        }                                                                                                                                                                                        
      ],                                                                                                                                                                                         
      "reasonCodes": ["string"],                                                                                                                                                                 
      "buyer": {                                                                                                                                                                                 
        "gln": "string",                                                                                                                                                                         
        "id": "string",                                                                                                                                                                          
        "organisationName": "string",                                                                                                                                                            
        "address": {                                                                                                                                                                             
          "name": "string",                                                                                                                                                                      
          "addressLine1": "string",                                                                                                                                                              
          "addressLine2": "string",                                                                                                                                                              
          "city": "string",                                                                                                                                                                      
          "state": "string",                                                                                                                                                                     
          "country": "string",                                                                                                                                                                   
          "zip": "string",                                                                                                                                                                       
          "locationType": "Factory",                                                                                                                                                             
          "idNumber": "string"                                                                                                                                                                   
        },                                                                                                                                                                                       
        "contact": {                                                                                                                                                                             
          "firstName": "string",                                                                                                                                                                 
          "lastName": "string",                                                                                                                                                                  
          "email": "string",                                                                                                                                                                     
          "phone": "string"                                                                                                                                                                      
        }                                                                                                                                                                                        
      },                                                                                                                                                                                         
      "seller": {                                                                                                                                                                                
        "gln": "string",                                                                                                                                                                         
        "id": "string",                                                                                                                                                                          
        "organisationName": "string",                                                                                                                                                            
        "address": {                                                                                                                                                                             
          "name": "string",                                                                                                                                                                      
          "addressLine1": "string",                                                                                                                                                              
          "addressLine2": "string",                                                                                                                                                              
          "city": "string",                                                                                                                                                                      
          "state": "string",                                                                                                                                                                     
          "country": "string",                                                                                                                                                                   
          "zip": "string",                                                                                                                                                                       
          "locationType": "Factory",                                                                                                                                                             
          "idNumber": "string"                                                                                                                                                                   
        },                                                                                                                                                                                       
        "contact": {                                                                                                                                                                             
          "firstName": "string",                                                                                                                                                                 
          "lastName": "string",                                                                                                                                                                  
          "email": "string",                                                                                                                                                                     
          "phone": "string"                                                                                                                                                                      
        }                                                                                                                                                                                        
      },                                                                                                                                                                                         
      "shipFrom": {                                                                                                                                                                              
        "gln": "string",                                                                                                                                                                         
        "id": "string",                                                                                                                                                                          
        "organisationName": "string",                                                                                                                                                            
        "address": {                                                                                                                                                                             
          "name": "string",                                                                                                                                                                      
          "addressLine1": "string",                                                                                                                                                              
          "addressLine2": "string",                                                                                                                                                              
          "city": "string",                                                                                                                                                                      
          "state": "string",                                                                                                                                                                     
          "country": "string",                                                                                                                                                                   
          "zip": "string",                                                                                                                                                                       
          "locationType": "Factory",                                                                                                                                                             
          "idNumber": "string"                                                                                                                                                                   
        },                                                                                                                                                                                       
        "contact": {                                                                                                                                                                             
          "firstName": "string",                                                                                                                                                                 
          "lastName": "string",                                                                                                                                                                  
          "email": "string",                                                                                                                                                                     
          "phone": "string"                                                                                                                                                                      
        }                                                                                                                                                                                        
      },                                                                                                                                                                                         
      "shipTo": {                                                                                                                                                                                
        "gln": "string",                                                                                                                                                                         
        "id": "string",                                                                                                                                                                          
        "organisationName": "string",                                                                                                                                                            
        "address": {                                                                                                                                                                             
          "name": "string",                                                                                                                                                                      
          "addressLine1": "string",                                                                                                                                                              
          "addressLine2": "string",                                                                                                                                                              
          "city": "string",                                                                                                                                                                      
          "state": "string",                                                                                                                                                                     
          "country": "string",                                                                                                                                                                   
          "zip": "string",                                                                                                                                                                       
          "locationType": "DC",                                                                                                                                                                  
          "idNumber": "string"                                                                                                                                                                   
        },                                                                                                                                                                                       
        "contact": {                                                                                                                                                                             
          "firstName": "string",                                                                                                                                                                 
          "lastName": "string",                                                                                                                                                                  
          "email": "string",                                                                                                                                                                     
          "phone": "string"                                                                                                                                                                      
        }                                                                                                                                                                                        
      },                                                                                                                                                                                         
      "billTo": {                                                                                                                                                                                
        "gln": "string",                                                                                                                                                                         
        "id": "string",                                                                                                                                                                          
        "organisationName": "string",                                                                                                                                                            
        "address": {                                                                                                                                                                             
          "name": "string",                                                                                                                                                                      
          "addressLine1": "string",                                                                                                                                                              
          "addressLine2": "string",                                                                                                                                                              
          "city": "string",                                                                                                                                                                      
          "state": "string",                                                                                                                                                                     
          "country": "string",                                                                                                                                                                   
          "zip": "string",                                                                                                                                                                       
          "locationType": "string",                                                                                                                                                              
          "idNumber": "string"                                                                                                                                                                   
        },                                                                                                                                                                                       
        "contact": {                                                                                                                                                                             
          "firstName": "string",                                                                                                                                                                 
          "lastName": "string",                                                                                                                                                                  
          "email": "string",                                                                                                                                                                     
          "phone": "string"                                                                                                                                                                      
        }                                                                                                                                                                                        
      },                                                                                                                                                                                         
      "pickupFrom": {                                                                                                                                                                            
        "gln": "string",                                                                                                                                                                         
        "id": "string",                                                                                                                                                                          
        "organisationName": "string",                                                                                                                                                            
        "address": {                                                                                                                                                                             
          "name": "string",                                                                                                                                                                      
          "addressLine1": "string",                                                                                                                                                              
          "addressLine2": "string",                                                                                                                                                              
          "city": "string",                                                                                                                                                                      
          "state": "string",                                                                                                                                                                     
          "country": "string",                                                                                                                                                                   
          "zip": "string",                                                                                                                                                                       
          "locationType": "string",                                                                                                                                                              
          "idNumber": "string"                                                                                                                                                                   
        },                                                                                                                                                                                       
        "contact": {                                                                                                                                                                             
          "firstName": "string",                                                                                                                                                                 
          "lastName": "string",                                                                                                                                                                  
          "email": "string",                                                                                                                                                                     
          "phone": "string"                                                                                                                                                                      
        }                                                                                                                                                                                        
      },                                                                                                                                                                                         
      "pickupETAStatus": "ON_TIME",                                                                                                                                                              
      "externalUrl": [                                                                                                                                                                           
        {                                                                                                                                                                                        
          "name": "string",                                                                                                                                                                      
          "url": "string"                                                                                                                                                                        
        }                                                                                                                                                                                        
      ],                                                                                                                                                                                         
      "deliveryTerms": {                                                                                                                                                                         
        "inCoTermsCode": "string",                                                                                                                                                               
        "deliveryInstructions": "string"                                                                                                                                                         
      },                                                                                                                                                                                         
      "shipmentReference": ["string"],                                                                                                                                                           
      "orderAvpList": [                                                                                                                                                                          
        {                                                                                                                                                                                        
          "customKey": "customValue"                                                                                                                                                             
        }                                                                                                                                                                                        
      ],                                                                                                                                                                                         
      "shipmentNumbers": ["string"],                                                                                                                                                             
      "trackingNumbers": ["string"],                                                                                                                                                             
      "deliveryIdentifiers": ["string"],                                                                                                                                                         
      "lineItems": [                                                                                                                                                                             
        {                                                                                                                                                                                        
          "itemName": "string",                                                                                                                                                                  
          "lineItemNumber": "string",                                                                                                                                                            
          "itemDescription": "string",                                                                                                                                                           
          "lineMabd": "2025-01-15T10:30:45.123456789Z",                                                                                                                                          
          "lineShipDate": "2025-01-15T10:30:45.123456789Z",                                                                                                                                      
          "lineShipTo": {                                                                                                                                                                        
            "gln": "string",                                                                                                                                                                     
            "id": "string",                                                                                                                                                                      
            "organisationName": "string",                                                                                                                                                        
            "address": {                                                                                                                                                                         
              "name": "string",                                                                                                                                                                  
              "addressLine1": "string",                                                                                                                                                          
              "addressLine2": "string",                                                                                                                                                          
              "city": "string",                                                                                                                                                                  
              "state": "string",                                                                                                                                                                 
              "country": "string",                                                                                                                                                               
              "zip": "string",                                                                                                                                                                   
              "locationType": "string",                                                                                                                                                          
              "idNumber": "string"                                                                                                                                                               
            },                                                                                                                                                                                   
            "contact": {                                                                                                                                                                         
              "firstName": "string",                                                                                                                                                             
              "lastName": "string",                                                                                                                                                              
              "email": "string",                                                                                                                                                                 
              "phone": "string"                                                                                                                                                                  
            }                                                                                                                                                                                    
          },                                                                                                                                                                                     
          "lineShipFrom": {                                                                                                                                                                      
            "gln": "string",                                                                                                                                                                     
            "id": "string",                                                                                                                                                                      
            "organisationName": "string",                                                                                                                                                        
            "address": {                                                                                                                                                                         
              "name": "string",                                                                                                                                                                  
              "addressLine1": "string",                                                                                                                                                          
              "addressLine2": "string",                                                                                                                                                          
              "city": "string",                                                                                                                                                                  
              "state": "string",                                                                                                                                                                 
              "country": "string",                                                                                                                                                               
              "zip": "string",                                                                                                                                                                   
              "locationType": "string",                                                                                                                                                          
              "idNumber": "string"                                                                                                                                                               
            },                                                                                                                                                                                   
            "contact": {                                                                                                                                                                         
              "firstName": "string",                                                                                                                                                             
              "lastName": "string",                                                                                                                                                              
              "email": "string",                                                                                                                                                                 
              "phone": "string"                                                                                                                                                                  
            }                                                                                                                                                                                    
          },                                                                                                                                                                                     
          "externalUrl": [                                                                                                                                                                       
            {                                                                                                                                                                                    
              "name": "string",                                                                                                                                                                  
              "url": "string"                                                                                                                                                                    
            }                                                                                                                                                                                    
          ],                                                                                                                                                                                     
          "requestedQuantity": 0.0,                                                                                                                                                              
          "shippedQuantity": 0.0,                                                                                                                                                                
          "quantityUnit": "string",                                                                                                                                                              
          "netPrice": 0.0,                                                                                                                                                                       
          "netAmount": 0.0,                                                                                                                                                                      
          "weightUnit": "string",                                                                                                                                                                
          "distributionMethod": "string",                                                                                                                                                        
          "itemNetWeight": 0.0,                                                                                                                                                                  
          "itemGrossWeight": 0.0,                                                                                                                                                                
          "additionalOrderLineInstruction": "string",                                                                                                                                            
          "promoDate": "string",                                                                                                                                                                 
          "holdDate": "string",                                                                                                                                                                  
          "originalLineRequiredDeliveryDate": "string",                                                                                                                                          
          "originalLineShipDate": "string",                                                                                                                                                      
          "lineItemActionCode": "updated",                                                                                                                                                       
          "orderLineItemInstructionCode": "string",                                                                                                                                              
          "orderLineItemPriority": "NORMAL",                                                                                                                                                     
          "transactionalTradeItem": {                                                                                                                                                            
            "transactionalItemData": {                                                                                                                                                           
              "itemNumber": "string",                                                                                                                                                            
              "itemNameOnInvoice": "string"                                                                                                                                                      
            },                                                                                                                                                                                   
            "color": {                                                                                                                                                                           
              "colorCode": "string",                                                                                                                                                             
              "colorName": "string"                                                                                                                                                              
            },                                                                                                                                                                                   
            "size": {                                                                                                                                                                            
              "sizeCode": "string",                                                                                                                                                              
              "sizeName": "string"                                                                                                                                                               
            }                                                                                                                                                                                    
          },                                                                                                                                                                                     
          "avpList": {},                                                                                                                                                                         
          "caseDetails": [                                                                                                                                                                       
            {                                                                                                                                                                                    
              "caseNumber": "string",                                                                                                                                                            
              "caseQuantity": 0.0,                                                                                                                                                               
              "innerPackQuantity": 0.0                                                                                                                                                           
            }                                                                                                                                                                                    
          ],                                                                                                                                                                                     
          "product": {                                                                                                                                                                           
            "productId": "string",                                                                                                                                                               
            "productName": "string",                                                                                                                                                             
            "productDescription": "string",                                                                                                                                                      
            "productSku": "string",                                                                                                                                                              
            "productCategory": "string",                                                                                                                                                         
            "gtin": "string",                                                                                                                                                                    
            "commodityTypeCode": "string",                                                                                                                                                       
            "productOwner": "string",                                                                                                                                                            
            "productUpc": "string",                                                                                                                                                              
            "additionalTradeItemClassificationCode": "string",                                                                                                                                   
            "gpcCategoryCode": "string",                                                                                                                                                         
            "gpcCategoryName": "string",                                                                                                                                                         
            "gpcAttributeTypeCode": "string",                                                                                                                                                    
            "gpcAttributeTypeName": "string",                                                                                                                                                    
            "gpcAttributeValueCode": "string",                                                                                                                                                   
            "gpcAttributeValueName": "string"                                                                                                                                                    
          },                                                                                                                                                                                     
          "referenceNumbers": [                                                                                                                                                                  
            {                                                                                                                                                                                    
              "type": "string",                                                                                                                                                                  
              "value": "string"                                                                                                                                                                  
            }                                                                                                                                                                                    
          ],                                                                                                                                                                                     
          "htsCode": "string",                                                                                                                                                                   
          "tariffCost": 0.0,                                                                                                                                                                     
          "tariffPercentage": 0,                                                                                                                                                                 
          "supplierHtsCode": "string",                                                                                                                                                           
          "lineStatus": "string",                                                                                                                                                                
          "shipmentIds": [123],                                                                                                                                                                  
          "shipmentNumbers": ["SHIP001"],                                                                                                                                                        
          "deliveryIds": ["DEL001"]                                                                                                                                                              
        }                                                                                                                                                                                        
      ]                                                                                                                                                                                          
    }                                                                                                                                                                                            
  }
```

# Field Descriptions

## Top-Level Fields

| **Field Name**<br />        | **Description**<br />                                       | **Key Always Present?**<br /> | **Value Always Present?**<br /> | **Data Type**<br /> | **Max Length**<br /> |
| --------------------------- | ----------------------------------------------------------- | ----------------------------- | ------------------------------- | ------------------- | -------------------- |
| **messageType**<br />       | The type of callback message (e.g., LINE\_UPDATED)<br />    | Yes<br />                     | Yes<br />                       | String<br />        | No Max<br />         |
| **companyPermalink**<br />  | The unique permalink identifier for the company<br />       | Yes<br />                     | Yes<br />                       | String<br />        | No Max<br />         |
| **fourKitesOrderId**<br />  | The unique FourKites-generated UUID for the order<br />     | Yes<br />                     | Yes<br />                       | String (UUID)<br /> | No Max<br />         |
| **createdAt**<br />         | The timestamp when the callback was generated<br />         | Yes<br />                     | Yes<br />                       | Timestamp<br />     | No Max<br />         |
| **uuid**<br />              | Unique ID for the callback<br />                            | Yes<br />                     | Yes<br />                       | String<br />        | No Max<br />         |
| **subStatusType**<br />     | The category of the sub-status (e.g., order)<br />          | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **subStatus**<br />         | The sub-status value<br />                                  | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **eventTimestamp**<br />    | The timestamp of the triggering event<br />                 | Yes<br />                     | Yes<br />                       | Timestamp<br />     | No Max<br />         |
| **timezone**<br />          | Full timezone name (e.g., Coordinated Universal Time)<br /> | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **timezoneShortName**<br /> | Abbreviated timezone name (e.g., UTC)<br />                 | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **timezoneOffset**<br />    | UTC offset in hours<br />                                   | Yes<br />                     | No<br />                        | Integer<br />       | No Max<br />         |
| **isSuccess**<br />         | Indicates if the event was processed successfully<br />     | Yes<br />                     | Yes<br />                       | Boolean<br />       | —<br />              |
| **updatedAt**<br />         | Timestamp of the last update to the callback<br />          | Yes<br />                     | Yes<br />                       | Timestamp<br />     | No Max<br />         |
| **requestId**<br />         | Unique identifier for the API request<br />                 | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **orderDetails**<br />      | Object containing full order details<br />                  | Yes<br />                     | No<br />                        | Object<br />        | No Max<br />         |

## orderDetails Object

| **Field Name**<br />                        | **Description**<br />                                       | **Key Always Present?**<br /> | **Value Always Present?**<br /> | **Data Type**<br />  | **Max Length**<br /> |
| ------------------------------------------- | ----------------------------------------------------------- | ----------------------------- | ------------------------------- | -------------------- | -------------------- |
| **orderNumber**<br />                       | The unique identifier for the order<br />                   | Yes<br />                     | Yes<br />                       | String<br />         | No Max<br />         |
| **orderStatus**<br />                       | The current status of the order<br />                       | Yes<br />                     | Yes<br />                       | String<br />         | No Max<br />         |
| **orderStatusTime**<br />                   | Timestamp of the current order status<br />                 | Yes<br />                     | No<br />                        | Timestamp<br />      | No Max<br />         |
| **orderType**<br />                         | Type of order (e.g., PO)<br />                              | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **orderPaymentType**<br />                  | Payment type for the order<br />                            | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **orderTransportType**<br />                | Transport type (e.g., domestic, international)<br />        | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **orderActualShipDate**<br />               | Actual ship date of the order<br />                         | Yes<br />                     | No<br />                        | Timestamp<br />      | No Max<br />         |
| **orderDestinationETA**<br />               | Estimated arrival time at the destination<br />             | Yes<br />                     | No<br />                        | Timestamp<br />      | No Max<br />         |
| **orderPickupETA**<br />                    | Estimated pickup time<br />                                 | Yes<br />                     | No<br />                        | Timestamp<br />      | No Max<br />         |
| **orderActualDeliveryDate**<br />           | Actual delivery date of the order<br />                     | Yes<br />                     | No<br />                        | Timestamp<br />      | No Max<br />         |
| **orderRequiredDeliveryDate**<br />         | Required delivery date for the order<br />                  | Yes<br />                     | No<br />                        | Timestamp<br />      | No Max<br />         |
| **orderMustShipByDate**<br />               | Latest date by which the order must ship<br />              | Yes<br />                     | No<br />                        | Timestamp<br />      | No Max<br />         |
| **orderETA**<br />                          | Overall ETA for the order<br />                             | Yes<br />                     | No<br />                        | Timestamp<br />      | No Max<br />         |
| **orderETAStatus**<br />                    | ETA status of the order (e.g., ON\_TIME, LATE)<br />        | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **orderDestination**<br />                  | Destination of the order<br />                              | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **orderReferenceNumbers**<br />             | List of reference numbers associated with the order<br />   | Yes<br />                     | No<br />                        | Array\[String]<br /> | No Max<br />         |
| **orderEURL**<br />                         | External URL for the order<br />                            | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **releaseDate**<br />                       | Date the order was released<br />                           | Yes<br />                     | No<br />                        | Timestamp<br />      | No Max<br />         |
| **holdDate**<br />                          | Date the order was placed on hold<br />                     | Yes<br />                     | No<br />                        | Timestamp<br />      | No Max<br />         |
| **originalRequiredDeliveryDate**<br />      | Original required delivery date before any changes<br />    | Yes<br />                     | No<br />                        | Timestamp<br />      | No Max<br />         |
| **originalShipDate**<br />                  | Original planned ship date<br />                            | Yes<br />                     | No<br />                        | Timestamp<br />      | No Max<br />         |
| **latestDeliveryDate**<br />                | Latest acceptable delivery date<br />                       | Yes<br />                     | No<br />                        | Timestamp<br />      | No Max<br />         |
| **orderCreationDate**<br />                 | Date the order was created in the source system<br />       | Yes<br />                     | Yes<br />                       | Timestamp<br />      | No Max<br />         |
| **lastUpdatedTime**<br />                   | Timestamp of the last update to the order<br />             | Yes<br />                     | No<br />                        | Timestamp<br />      | No Max<br />         |
| **currencyCode**<br />                      | Currency code for monetary values (e.g., USD)<br />         | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **totalMonetaryAmountIncludingTaxes**<br /> | Total order value including taxes<br />                     | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **totalMonetaryAmountExcludingTaxes**<br /> | Total order value excluding taxes<br />                     | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **totalTaxAmount**<br />                    | Total tax amount for the order<br />                        | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **isOrderFreeOfExciseTaxDuty**<br />        | Indicates if the order is exempt from excise tax/duty<br /> | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **totalTariffCost**<br />                   | Total tariff cost applied to the order<br />                | Yes<br />                     | No<br />                        | Float<br />          | No Max<br />         |
| **totalTariffPercentage**<br />             | Total tariff percentage applied to the order<br />          | Yes<br />                     | No<br />                        | Integer<br />        | No Max<br />         |
| **status**<br />                            | General status of the order<br />                           | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **orderStatusCode**<br />                   | Status code for the order<br />                             | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **orderPriority**<br />                     | Priority level of the order (e.g., NORMAL, HIGH)<br />      | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **sourceType**<br />                        | Source system type (e.g., erp)<br />                        | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **orderEntryType**<br />                    | Method by which the order was entered<br />                 | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **orderInstructionCode**<br />              | Instruction code for the order<br />                        | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **additionalOrderInstruction**<br />        | Free-text additional instructions for the order<br />       | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **paymentMethodCode**<br />                 | Code representing the payment method<br />                  | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **numberOfDeliveries**<br />                | Total number of deliveries for the order<br />              | Yes<br />                     | No<br />                        | Integer<br />        | No Max<br />         |
| **numberOfShipments**<br />                 | Total number of shipments for the order<br />               | Yes<br />                     | No<br />                        | Integer<br />        | No Max<br />         |
| **numberOfLineItems**<br />                 | Total number of line items in the order<br />               | Yes<br />                     | No<br />                        | Integer<br />        | No Max<br />         |
| **referenceNumbers**<br />                  | Typed reference number pairs (type + value)<br />           | Yes<br />                     | No<br />                        | Array\[Object]<br /> | No Max<br />         |
| **reasonCodes**<br />                       | List of reason codes associated with the order<br />        | Yes<br />                     | No<br />                        | Array\[String]<br /> | No Max<br />         |
| **pickupETAStatus**<br />                   | ETA status for pickup (e.g., ON\_TIME, LATE)<br />          | Yes<br />                     | No<br />                        | String<br />         | No Max<br />         |
| **externalUrl**<br />                       | List of named external URLs related to the order<br />      | Yes<br />                     | No<br />                        | Array\[Object]<br /> | No Max<br />         |
| **deliveryTerms**<br />                     | Incoterms code and delivery instructions<br />              | Yes<br />                     | No<br />                        | Object<br />         | No Max<br />         |
| **shipmentReference**<br />                 | List of associated shipment reference numbers<br />         | Yes<br />                     | No<br />                        | Array\[String]<br /> | No Max<br />         |
| **orderAvpList**<br />                      | Custom key-value attribute pairs for the order<br />        | Yes<br />                     | No<br />                        | Array\[Object]<br /> | No Max<br />         |
| **shipmentNumbers**<br />                   | List of shipment numbers linked to the order<br />          | Yes<br />                     | No<br />                        | Array\[String]<br /> | No Max<br />         |
| **trackingNumbers**<br />                   | List of tracking numbers for the order<br />                | Yes<br />                     | No<br />                        | Array\[String]<br /> | No Max<br />         |
| **deliveryIdentifiers**<br />               | List of delivery identifiers for the order<br />            | Yes<br />                     | No<br />                        | Array\[String]<br /> | No Max<br />         |
| **buyer**<br />                             | Party details for the buyer<br />                           | Yes<br />                     | No<br />                        | Object<br />         | No Max<br />         |
| **seller**<br />                            | Party details for the seller<br />                          | Yes<br />                     | No<br />                        | Object<br />         | No Max<br />         |
| **shipFrom**<br />                          | Party and address details for the ship-from location<br />  | Yes<br />                     | No<br />                        | Object<br />         | No Max<br />         |
| **shipTo**<br />                            | Party and address details for the ship-to location<br />    | Yes<br />                     | No<br />                        | Object<br />         | No Max<br />         |
| **billTo**<br />                            | Party and address details for the bill-to location<br />    | Yes<br />                     | No<br />                        | Object<br />         | No Max<br />         |
| **pickupFrom**<br />                        | Party and address details for the pickup location<br />     | Yes<br />                     | No<br />                        | Object<br />         | No Max<br />         |
| **lineItems**<br />                         | List of line items included in the order<br />              | Yes<br />                     | No<br />                        | Array\[Object]<br /> | No Max<br />         |

## Party Object Fields

*Applies to: buyer, seller, shipFrom, shipTo, billTo, pickupFrom*

| **Field Name**<br />           | **Description**<br />                      | **Key Always Present?**<br /> | **Value Always Present?**<br /> | **Data Type**<br /> | **Max Length**<br /> |
| ------------------------------ | ------------------------------------------ | ----------------------------- | ------------------------------- | ------------------- | -------------------- |
| **gln**<br />                  | Global Location Number of the party<br />  | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **id**<br />                   | Internal identifier for the party<br />    | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **organisationName**<br />     | Name of the organization<br />             | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **address.name**<br />         | Name of the location<br />                 | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **address.addressLine1**<br /> | Primary street address<br />               | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **address.addressLine2**<br /> | Secondary address line<br />               | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **address.city**<br />         | City<br />                                 | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **address.state**<br />        | State or province<br />                    | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **address.country**<br />      | Country<br />                              | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **address.zip**<br />          | Postal or ZIP code<br />                   | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **address.locationType**<br /> | Type of location (e.g., Factory, DC)<br /> | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **address.idNumber**<br />     | Location ID number<br />                   | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **contact.firstName**<br />    | First name of the contact person<br />     | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **contact.lastName**<br />     | Last name of the contact person<br />      | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **contact.email**<br />        | Email address of the contact<br />         | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |
| **contact.phone**<br />        | Phone number of the contact<br />          | Yes<br />                     | No<br />                        | String<br />        | No Max<br />         |

## lineItems — Per Line Item Fields

*Includes all fields from ORDER\_CREATED plus lineStatus, shipmentIds, shipmentNumbers, and deliveryIds.*

| **Field Name**<br />                                                     | **Description**<br />                                        | **Key Always Present?**<br /> | **Value Always Present?**<br /> | **Data Type**<br />   | **Max Length**<br /> |
| ------------------------------------------------------------------------ | ------------------------------------------------------------ | ----------------------------- | ------------------------------- | --------------------- | -------------------- |
| **itemName**<br />                                                       | Name of the line item<br />                                  | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **lineItemNumber**<br />                                                 | Line item number<br />                                       | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **itemDescription**<br />                                                | Description of the item<br />                                | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **lineMabd**<br />                                                       | Must-arrive-by date for the line item<br />                  | Yes<br />                     | No<br />                        | Timestamp<br />       | No Max<br />         |
| **lineShipDate**<br />                                                   | Planned ship date for the line item<br />                    | Yes<br />                     | No<br />                        | Timestamp<br />       | No Max<br />         |
| **lineShipTo**<br />                                                     | Ship-to party details for the line item<br />                | Yes<br />                     | No<br />                        | Object<br />          | No Max<br />         |
| **lineShipFrom**<br />                                                   | Ship-from party details for the line item<br />              | Yes<br />                     | No<br />                        | Object<br />          | No Max<br />         |
| **externalUrl**<br />                                                    | Named external URLs for the line item<br />                  | Yes<br />                     | No<br />                        | Array\[Object]<br />  | No Max<br />         |
| **requestedQuantity**<br />                                              | Quantity requested for the line item<br />                   | Yes<br />                     | No<br />                        | Float<br />           | No Max<br />         |
| **shippedQuantity**<br />                                                | Quantity actually shipped<br />                              | Yes<br />                     | No<br />                        | Float<br />           | No Max<br />         |
| **quantityUnit**<br />                                                   | Unit of measure for quantity<br />                           | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **netPrice**<br />                                                       | Net price per unit<br />                                     | Yes<br />                     | No<br />                        | Float<br />           | No Max<br />         |
| **netAmount**<br />                                                      | Total net amount for the line item<br />                     | Yes<br />                     | No<br />                        | Float<br />           | No Max<br />         |
| **weightUnit**<br />                                                     | Unit of measure for weight<br />                             | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **distributionMethod**<br />                                             | Method of distribution for the line item<br />               | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **itemNetWeight**<br />                                                  | Net weight of the item<br />                                 | Yes<br />                     | No<br />                        | Float<br />           | No Max<br />         |
| **itemGrossWeight**<br />                                                | Gross weight of the item<br />                               | Yes<br />                     | No<br />                        | Float<br />           | No Max<br />         |
| **additionalOrderLineInstruction**<br />                                 | Additional free-text instructions for the line<br />         | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **promoDate**<br />                                                      | Promotional date associated with the line item<br />         | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **holdDate**<br />                                                       | Hold date for the line item<br />                            | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **originalLineRequiredDeliveryDate**<br />                               | Original required delivery date for the line<br />           | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **originalLineShipDate**<br />                                           | Original planned ship date for the line<br />                | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **lineItemActionCode**<br />                                             | Action code for the line item (e.g., added, updated)<br />   | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **orderLineItemInstructionCode**<br />                                   | Instruction code for the line item<br />                     | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **orderLineItemPriority**<br />                                          | Priority of the line item (e.g., NORMAL, HIGH)<br />         | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **lineStatus**<br />                                                     | Current status of the line item<br />                        | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **shipmentIds**<br />                                                    | List of shipment IDs associated with the line item<br />     | Yes<br />                     | No<br />                        | Array\[Integer]<br /> | No Max<br />         |
| **shipmentNumbers**<br />                                                | List of shipment numbers associated with the line item<br /> | Yes<br />                     | No<br />                        | Array\[String]<br />  | No Max<br />         |
| **deliveryIds**<br />                                                    | List of delivery IDs associated with the line item<br />     | Yes<br />                     | No<br />                        | Array\[String]<br />  | No Max<br />         |
| **transactionalTradeItem.transactionalItemData.itemNumber**<br />        | Item number from the trade item data<br />                   | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **transactionalTradeItem.transactionalItemData.itemNameOnInvoice**<br /> | Item name as it appears on the invoice<br />                 | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **transactionalTradeItem.color.colorCode**<br />                         | Color code for the item<br />                                | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **transactionalTradeItem.color.colorName**<br />                         | Color name for the item<br />                                | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **transactionalTradeItem.size.sizeCode**<br />                           | Size code for the item<br />                                 | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **transactionalTradeItem.size.sizeName**<br />                           | Size name for the item<br />                                 | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **avpList**<br />                                                        | Custom attribute key-value pairs for the line item<br />     | Yes<br />                     | No<br />                        | Object<br />          | No Max<br />         |
| **caseDetails.caseNumber**<br />                                         | Case number for packaging<br />                              | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **caseDetails.caseQuantity**<br />                                       | Quantity per case<br />                                      | Yes<br />                     | No<br />                        | Float<br />           | No Max<br />         |
| **caseDetails.innerPackQuantity**<br />                                  | Inner pack quantity within the case<br />                    | Yes<br />                     | No<br />                        | Float<br />           | No Max<br />         |
| **product.productId**<br />                                              | Unique product identifier<br />                              | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **product.productName**<br />                                            | Name of the product<br />                                    | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **product.productDescription**<br />                                     | Description of the product<br />                             | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **product.productSku**<br />                                             | SKU of the product<br />                                     | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **product.productCategory**<br />                                        | Category of the product<br />                                | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **product.gtin**<br />                                                   | Global Trade Item Number<br />                               | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **product.commodityTypeCode**<br />                                      | Commodity type code for the product<br />                    | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **product.productOwner**<br />                                           | Owner of the product<br />                                   | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **product.productUpc**<br />                                             | Universal Product Code<br />                                 | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **product.additionalTradeItemClassificationCode**<br />                  | Additional classification code for the trade item<br />      | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **product.gpcCategoryCode**<br />                                        | GPC category code<br />                                      | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **product.gpcCategoryName**<br />                                        | GPC category name<br />                                      | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **product.gpcAttributeTypeCode**<br />                                   | GPC attribute type code<br />                                | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **product.gpcAttributeTypeName**<br />                                   | GPC attribute type name<br />                                | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **product.gpcAttributeValueCode**<br />                                  | GPC attribute value code<br />                               | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **product.gpcAttributeValueName**<br />                                  | GPC attribute value name<br />                               | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **referenceNumbers**<br />                                               | Typed reference numbers for the line item<br />              | Yes<br />                     | No<br />                        | Array\[Object]<br />  | No Max<br />         |
| **htsCode**<br />                                                        | Harmonized Tariff Schedule code for the item<br />           | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
| **tariffCost**<br />                                                     | Tariff cost for the line item<br />                          | Yes<br />                     | No<br />                        | Float<br />           | No Max<br />         |
| **tariffPercentage**<br />                                               | Tariff percentage for the line item<br />                    | Yes<br />                     | No<br />                        | Integer<br />         | No Max<br />         |
| **supplierHtsCode**<br />                                                | Supplier-provided HTS code<br />                             | Yes<br />                     | No<br />                        | String<br />          | No Max<br />         |
