Action

Orders API

Introduction to the Orders API. Use these endpoints to manage orders in the ShipmentX system.

Get Orders

Details about get an orders. Include request/response examples, required fields, and validation rules here.

GET /tmsapi/getOrders HTTP/1.1
Host: https://devdemov1.shipmentx.com
Authorization: Bearer <Token>
Request:
Parameter Type Position # Description
Authorization String Header @Required Authorization: Bearer {TOKEN_HERE}
page_size Numeric Body @Optional Records limit, like Number of records for each request
Response:
Success code: 200 
{
    "page_size": 2,
    "results": [
        {
            "order_id": "ORD12345",
            "sender_id": "SENDER001",
            "receiver_id": "RECEIVER001",
            "timezone": "PST",
            "timeoffset": "-08:00",
            "pickup_startdatetime": "2025-01-28 08:00:00",
            "pickup_enddatetime": "2025-01-28 12:00:00",
            "pickup_company": "ABC Logistics",
            "pickup_country": "USA",
            "pickup_city": "San Francisco",
            "pickup_province": "California",
            "pickup_pincode": "94105",
            "pickup_address1": "123 Market Street",
            "pickup_address2": "Suite 500",
            "delivery_startdatetime": "2025-01-29 10:00:00",
            "delivery_enddatetime": "2025-01-29 15:00:00",
            "delivery_company": "XYZ Delivery",
            "delivery_country": "USA",
            "delivery_city": "Los Angeles",
            "delivery_province": "California",
            "delivery_pincode": "90001",
            "delivery_address1": "456 Sunset Boulevard",
            "delivery_address2": "Apt 12B",
            "total_packages": 2,
            "total_weight": 15,
            "gross_weight_uom": "kg",
            "chargeable_weight": 15.5,
            "chargeable_weight_uom": "kg",
            "total_volume": 2.5,
            "volume_uom": "m3",
            "goods_value": 500,
            "currency": "USD",
            "transport_mode": "Air",
            "dedicated_vehicle": "No",
            "vehicle_type": "Van",
            "order_status": "Dispatched",
            "createdon": "2025-01-27 14:00:00",
            "packages": [
                {
                    "package_type": "Box",
                    "item_name": "Electronics",
                    "description": "Laptops",
                    "weight": 10,
                    "weight_uom": "kg",
                    "volume": 1.5,
                    "volume_uom": "m3",
                    "length": 50,
                    "length_uom": "cm",
                    "width": 40,
                    "width_uom": "cm",
                    "height": 30,
                    "height_uom": "cm",
                    "stackable": "Yes",
                    "hazardous": "No",
                    "allow_mixed_freight": "Yes",
                    "inner_cargos": [
                        {
                            "cargo_type": "Item",
                            "item_name": "Laptop",
                            "goods_description": "MacBook Pro",
                            "quantity": 5,
                            "scanned_quantity": 5,
                            "weight": 2,
                            "weight_uom": "kg",
                            "volume": 0.3,
                            "volume_uom": "m3",
                            "length": 15,
                            "length_uom": "cm",
                            "width": 20,
                            "width_uom": "cm",
                            "height": 2,
                            "height_uom": "cm",
                            "stackable": "Yes"
                        }
                    ]
                }
            ],
            "order_references": [
                {
                    "name": "DQ",
                    "value": "REF001"
                },
                {
                    "name": "SD",
                    "value": "REF002"
                }
            ],
            "involved_parties": [
                {
                    "party_type": "Sender",
                    "party_name": "John Doe",
                    "party_company": "ABC Logistics",
                    "email": "johndoe@abclogistics.com",
                    "contact_number": "+1 123-456-7890",
                    "country": "USA",
                    "city": "San Francisco",
                    "province": "California",
                    "pincode": "94105",
                    "address_area1": "123 Market Street",
                    "address_area2": "Suite 500"
                }
            ]
        },
        {
            "order_id": "ORD67890",
            "sender_id": "SENDER002",
            "receiver_id": "RECEIVER002",
            "timezone": "EST",
            "timeoffset": "-05:00",
            "pickup_startdatetime": "2025-01-28 09:00:00",
            "pickup_enddatetime": "2025-01-28 11:00:00",
            "pickup_company": "Global Shipping",
            "pickup_country": "USA",
            "pickup_city": "New York",
            "pickup_province": "New York",
            "pickup_pincode": "10001",
            "pickup_address1": "789 Madison Avenue",
            "pickup_address2": "",
            "delivery_startdatetime": "2025-01-29 13:00:00",
            "delivery_enddatetime": "2025-01-29 18:00:00",
            "delivery_company": "FastTrack Delivery",
            "delivery_country": "USA",
            "delivery_city": "Miami",
            "delivery_province": "Florida",
            "delivery_pincode": "33101",
            "delivery_address1": "123 Ocean Drive",
            "delivery_address2": "",
            "total_packages": 1,
            "total_weight": 25,
            "gross_weight_uom": "kg",
            "chargeable_weight": 26,
            "chargeable_weight_uom": "kg",
            "total_volume": 3.2,
            "volume_uom": "m3",
            "goods_value": 1200,
            "currency": "USD",
            "transport_mode": "Ground",
            "dedicated_vehicle": "Yes",
            "vehicle_type": "Truck",
            "order_status": "In Transit",
            "createdon": "2025-01-27 16:00:00",
            "packages": [
                {
                    "package_type": "Pallet",
                    "item_name": "Furniture",
                    "description": "Office Chairs",
                    "weight": 25,
                    "weight_uom": "kg",
                    "volume": 3.2,
                    "volume_uom": "m3",
                    "length": 100,
                    "length_uom": "cm",
                    "width": 80,
                    "width_uom": "cm",
                    "height": 120,
                    "height_uom": "cm",
                    "stackable": "No",
                    "hazardous": "No",
                    "allow_mixed_freight": "No",
                    "inner_cargos": []
                }
            ],
            "order_references": [
                {
                    "name": "DQ",
                    "value": "REF003"
                },
                {
                    "name": "SD",
                    "value": "REF004"
                }
            ],
            "involved_parties": [
                {
                    "party_type": "Receiver",
                    "party_name": "Jane Smith",
                    "party_company": "Global Interiors",
                    "email": "janesmith@globalinteriors.com",
                    "contact_number": "+1 987-654-3210",
                    "country": "USA",
                    "city": "Miami",
                    "province": "Florida",
                    "pincode": "33101",
                    "address_area1": "123 Ocean Drive",
                    "address_area2": ""
                }
            ]
        }
    ],
    "total_count": 2,
    "total_pages": 1
}
Failure code: 401 
{
    "results": [],
    "error": {
        "message": "Not authorized to access resource",
        "details": "Not authorized"
    }
}
Failure code: 405 
{
    "results": [],
    "error": {
        "status": false,
        "error": "Unknown method"
    }
}

Create Order

Details about creating an order. Include request/response examples, required fields, and validation rules here.

POST /tmsapi/createOrder HTTP/1.1
Host: https://devdemov1.shipmentx.com
Authorization: Bearer <Token>
Request:
{
    "order_id": "ORD12345",
    "sender_id": "SENDER001",
    "receiver_id": "RECEIVER001",
    "timezone": "PST",
    "timeoffset": "-08:00",
    "pickup_startdatetime": "2025-01-30 08:00:00",
    "pickup_enddatetime": "2025-01-30 12:00:00",
    "pickup_company": "ABC Logistics",
    "pickup_country": "USA",
    "pickup_city": "San Francisco",
    "pickup_province": "California",
    "pickup_pincode": "94105",
    "pickup_address1": "123 Market Street",
    "pickup_address2": "Suite 500",
    "delivery_startdatetime": "2025-01-31 10:00:00",
    "delivery_enddatetime": "2025-01-31 15:00:00",
    "delivery_company": "XYZ Delivery",
    "delivery_country": "USA",
    "delivery_city": "Los Angeles",
    "delivery_province": "California",
    "delivery_pincode": "90001",
    "delivery_address1": "456 Sunset Boulevard",
    "delivery_address2": "Apt 12B",
    "total_packages": 3,
    "total_weight": 25,
    "gross_weight_uom": "kg",
    "chargeable_weight": 25.5,
    "chargeable_weight_uom": "kg",
    "total_volume": 3.5,
    "volume_uom": "m3",
    "goods_value": 1000,
    "currency": "USD",
    "transport_mode": "Air",
    "dedicated_vehicle": "No",
    "vehicle_type": "Van",
    "order_status": "Pending",
    "createdon": "2025-01-29 14:00:00",
    "packages": [
        {
            "package_type": "Box",
            "item_name": "Electronics",
            "description": "Smartphones",
            "weight": 10,
            "weight_uom": "kg",
            "volume": 1.2,
            "volume_uom": "m3",
            "length": 50,
            "length_uom": "cm",
            "width": 30,
            "width_uom": "cm",
            "height": 20,
            "height_uom": "cm",
            "stackable": "Yes",
            "hazardous": "No",
            "allow_mixed_freight": "Yes",
            "inner_cargos": [
                {
                    "cargo_type": "Item",
                    "item_name": "iPhone 14",
                    "goods_description": "Apple Smartphones",
                    "quantity": 10,
                    "scanned_quantity": 10,
                    "weight": 1,
                    "weight_uom": "kg",
                    "volume": 0.1,
                    "volume_uom": "m3",
                    "length": 15,
                    "length_uom": "cm",
                    "width": 10,
                    "width_uom": "cm",
                    "height": 5,
                    "height_uom": "cm",
                    "stackable": "Yes"
                }
            ]
        }
    ],
    "order_references": [
        {
            "name": "DQ",
            "value": "REF001"
        },
        {
            "name": "SD",
            "value": "REF002"
        }
    ],
    "involved_parties": [
        {
            "party_type": "Sender",
            "party_name": "John Doe",
            "party_company": "ABC Logistics",
            "email": "johndoe@abclogistics.com",
            "contact_number": "+1 123-456-7890",
            "country": "USA",
            "city": "San Francisco",
            "province": "California",
            "pincode": "94105",
            "address_area1": "123 Market Street",
            "address_area2": "Suite 500"
        }
    ]
}
Request data paramer's description
Parameter Type Position # Description
Authorization String Header @Required Authorization: Bearer {TOKEN_HERE}
order_id String/Numeric Body @Required Customer Order Reference Number
sender_id String/Numeric Body @Required Sender Identification Number
receiver_id String/Numeric Body @Required Receiver Identification Number
timezone Timezone Body @Required Country Timezone like Asia/Kolkata
timeoffset String Body @Required Country Timezone offset value in hours, like IST+05.30
pickup_startdatetime Datetime Body @Required Order Early Pickup Datetime
pickup_enddatetime Datetime Body @Required Order Late Pickup Datetime
pickup_company String Body @Required Pickup Location Company Name
pickup_country String Body @Required Pickup Location Country Name
pickup_city String Body @Required Pickup Location City Name
pickup_province String Body @Required Pickup Location Province/State Name
pickup_pincode String/Numeric Body @Required Pickup Location Postal Code
pickup_address1 String Body @Required Pickup Location Address Line 1
pickup_address2 String Body @Required Pickup Location Address Line 2
delivery_startdatetime Datetime Body @Required Order Early Delivery Datetime
delivery_enddatetime Datetime Body @Required Order Late Delivery Datetime
delivery_company String Body @Required Delivery Location Company Name
delivery_country String Body @Required Delivery Location Country Name
delivery_city String Body @Required Delivery Location City Name
delivery_province String Body @Required Delivery Location Province/State Name
delivery_pincode String/Numeric Body @Required Delivery Location Postal Code
delivery_address1 String Body @Required Delivery Location Address Line 1
delivery_address2 String Body @Required Delivery Location Address Line 2
total_packages Numeric Body @Required Total Number of packages
total_weight Numeric Body @Required Total Weight Value
gross_weight_uom String Body @Required Gross Weight Unit of Measurement (KG,Ton)
chargeable_weight Numeric Body @Required Chargeable Weight Value
chargeable_weight_uom String Body @Required Chargeable Weight Unit of Measurement (G/KG/Ton)
total_volume Numeric Body @Required Total Volume Value
volume_uom String Body @Required Volume Unit of Measurement (CBM)
goods_value Numeric Body @Required Goods Cost Value
currency String Body @Required Currency Code like USD
transport_mode String Body @Required Mode of Transport (ROAD, AIR, SEA, RAIL)
dedicated_vehicle String Body @Optional Dedicated Vehicle required or not (example: true/false)
vehicle_type String Body @Optional Expected/Required Vehicle Type for transportation
order_status String Body @Optional Order Current Status like OPEN/ACTIVE
createdon Datetime Body @Optional Order Transaction Datetime
package_type String Body @Required Type of Packages like Bag,Box,Carton/Piece,Crate,Drum,Pallet/Skid,Roll,Tube
item_name String Body @Required Item Name
description String Body @Optional Item Description
stackable String Body @Optional Is this required Stackable, value like like true/false
hazardous String Body @Optional Is this Hazardous Material, value like true/false
allow_mixed_freight String Body @Optional Mixed freight is allowed in shipping, value like true/false
cargo_type String Body @Optional Inner cargo type
goods_description String Body @Optional Inner cargo item description
quantity Numeric Body @Optional Quantity
scanned_quantity Numeric Body @Optional Scanned Quantity
name Datetime String @Optional Order Reference Name
value String Body @Optional Order Reference Value
party_type String Body @Optional Involved party type name like Shipper/Consignee/Freight Payer/Carrier,etc
party_name String Body @Optional Involved party name
party_company String Body @Optional Involved party company name
email String Body @Optional Involved party email id
contact_number String Body @Optional Involved party contact number
country String Body @Optional Involved party country name
city String Body @Optional Involved party city name
province String Body @Optional Involved party province name
pincode Numeric/String Body @Optional Involved party pincode
address_area1 String Body @Optional Involved party address line 1
address_area2 String Body @Optional Involved party address line 2
Response:
Success code: 200 
{
    "status": true,
    "message": "Order created successfully",
    "data": {
        "order_id": {
            "customer_id": "John Doe",
            "carrier_id": "Jane Smith",
            "orders_data": [
                {
                    "SAP_ORDER": "ORD12345",
                    "SX_ORDER": 125060001
                }
            ]
        }
    }
}
Success code: 400 
{
    "results": [],
    "status": false,
    "message": "Invalid or missing body parameter",
    "errors": {
        "field_name": "Field error"
    }
}
Success code: 401 
{
    "results": [],
    "error": {
        "message": "Not authorized to access resource",
        "details": "Not authorized"
    }
}

Update Order

Details about updating an order. Describe the endpoint, request/response examples, and error handling here. 

POST /tmsapi/updateOrder HTTP/1.1
Host: https://devdemov1.shipmentx.com
Authorization: Bearer <Token>
Request:
{
    "order_id": "ORD12345",
    "sender_id": "SENDER001",
    "receiver_id": "RECEIVER001",
    "timezone": "PST",
    "timeoffset": "-08:00",
    "pickup_startdatetime": "2025-01-30 08:00:00",
    "pickup_enddatetime": "2025-01-30 12:00:00",
    "pickup_company": "ABC Logistics",
    "pickup_country": "USA",
    "pickup_city": "San Francisco",
    "pickup_province": "California",
    "pickup_pincode": "94105",
    "pickup_address1": "123 Market Street",
    "pickup_address2": "Suite 500",
    "delivery_startdatetime": "2025-01-31 10:00:00",
    "delivery_enddatetime": "2025-01-31 15:00:00",
    "delivery_company": "XYZ Delivery",
    "delivery_country": "USA",
    "delivery_city": "Los Angeles",
    "delivery_province": "California",
    "delivery_pincode": "90001",
    "delivery_address1": "456 Sunset Boulevard",
    "delivery_address2": "Apt 12B",
    "total_packages": 3,
    "total_weight": 25,
    "gross_weight_uom": "kg",
    "chargeable_weight": 25.5,
    "chargeable_weight_uom": "kg",
    "total_volume": 3.5,
    "volume_uom": "m3",
    "goods_value": 1000,
    "currency": "USD",
    "transport_mode": "Air",
    "dedicated_vehicle": "No",
    "vehicle_type": "Van",
    "order_status": "Pending",
    "createdon": "2025-01-29 14:00:00",
    "packages": [
        {
            "package_type": "Box",
            "item_name": "Electronics",
            "description": "Smartphones",
            "weight": 10,
            "weight_uom": "kg",
            "volume": 1.2,
            "volume_uom": "m3",
            "length": 50,
            "length_uom": "cm",
            "width": 30,
            "width_uom": "cm",
            "height": 20,
            "height_uom": "cm",
            "stackable": "Yes",
            "hazardous": "No",
            "allow_mixed_freight": "Yes",
            "inner_cargos": [
                {
                    "cargo_type": "Item",
                    "item_name": "iPhone 14",
                    "goods_description": "Apple Smartphones",
                    "quantity": 10,
                    "scanned_quantity": 10,
                    "weight": 1,
                    "weight_uom": "kg",
                    "volume": 0.1,
                    "volume_uom": "m3",
                    "length": 15,
                    "length_uom": "cm",
                    "width": 10,
                    "width_uom": "cm",
                    "height": 5,
                    "height_uom": "cm",
                    "stackable": "Yes"
                }
            ]
        }
    ],
    "order_references": [
        {
            "name": "DQ",
            "value": "REF001"
        },
        {
            "name": "SD",
            "value": "REF002"
        }
    ],
    "involved_parties": [
        {
            "party_type": "Sender",
            "party_name": "John Doe",
            "party_company": "ABC Logistics",
            "email": "johndoe@abclogistics.com",
            "contact_number": "+1 123-456-7890",
            "country": "USA",
            "city": "San Francisco",
            "province": "California",
            "pincode": "94105",
            "address_area1": "123 Market Street",
            "address_area2": "Suite 500"
        }
    ]
}
Request data paramer's description
Parameter Type Position # Description
Authorization String Header @Required Authorization: Bearer {TOKEN_HERE}
order_id String/Numeric Body @Required Customer Order Reference Number
sender_id String/Numeric Body @Required Sender Identification Number
receiver_id String/Numeric Body @Required Receiver Identification Number
timezone Timezone Body @Optional Country Timezone like Asia/Kolkata
timeoffset String Body @Optional Country Timezone offset value in hours, like IST+05.30
pickup_startdatetime Datetime Body @Optional Order Early Pickup Datetime
pickup_enddatetime Datetime Body @Optional Order Late Pickup Datetime
pickup_company String Body @Optional Pickup Location Company Name
pickup_country String Body @Optional Pickup Location Country Name
pickup_city String Body @Optional Pickup Location City Name
pickup_province String Body @Optional Pickup Location Province/State Name
pickup_pincode String/Numeric Body @Optional Pickup Location Postal Code
pickup_address1 String Body @Optional Pickup Location Address Line 1
pickup_address2 String Body @Optional Pickup Location Address Line 2
delivery_startdatetime Datetime Body @Optional Order Early Delivery Datetime
delivery_enddatetime Datetime Body @Optional Order Late Delivery Datetime
delivery_company String Body @Optional Delivery Location Company Name
delivery_country String Body @Optional Delivery Location Country Name
delivery_city String Body @Optional Delivery Location City Name
delivery_province String Body @Optional Delivery Location Province/State Name
delivery_pincode String/Numeric Body @Optional Delivery Location Postal Code
delivery_address1 String Body @Optional Delivery Location Address Line 1
delivery_address2 String Body @Optional Delivery Location Address Line 2
total_packages Numeric Body @Optional Total Number of packages
total_weight Numeric Body @Optional Total Weight Value
gross_weight_uom String Body @Optional Gross Weight Unit of Measurement (KG,Ton)
chargeable_weight Numeric Body @Optional Chargeable Weight Value
chargeable_weight_uom String Body @Optional Chargeable Weight Unit of Measurement (G/KG/Ton)
total_volume Numeric Body @Optional Total Volume Value
volume_uom String Body @Optional Volume Unit of Measurement (CBM)
goods_value Numeric Body @Optional Goods Cost Value
currency String Body @Optional Currency Code like USD
transport_mode String Body @Optional Mode of Transport (ROAD, AIR, SEA, RAIL)
dedicated_vehicle String Body @Optional Dedicated Vehicle required or not (example: true/false)
vehicle_type String Body @Optional Expected/Required Vehicle Type for transportation
order_status String Body @Optional Order Current Status like OPEN/ACTIVE
createdon Datetime Body @Optional Order Transaction Datetime
package_type String Body @Required Type of Packages like Bag,Box,Carton/Piece,Crate,Drum,Pallet/Skid,Roll,Tube
item_name String Body @Required Item Name
description String Body @Optional Item Description
stackable String Body @Optional Is this required Stackable, value like like true/false
hazardous String Body @Optional Is this Hazardous Material, value like true/false
allow_mixed_freight String Body @Optional Mixed freight is allowed in shipping, value like true/false
cargo_type String Body @Optional Inner cargo type
goods_description String Body @Optional Inner cargo item description
quantity Numeric Body @Optional Quantity
scanned_quantity Numeric Body @Optional Scanned Quantity
name Datetime String @Optional Order Reference Name
value String Body @Optional Order Reference Value
party_type String Body @Optional Involved party type name like Shipper/Consignee/Freight Payer/Carrier,etc
party_name String Body @Optional Involved party name
party_company String Body @Optional Involved party company name
email String Body @Optional Involved party email id
contact_number String Body @Optional Involved party contact number
country String Body @Optional Involved party country name
city String Body @Optional Involved party city name
province String Body @Optional Involved party province name
pincode Numeric/String Body @Optional Involved party pincode
address_area1 String Body @Optional Involved party address line 1
address_area2 String Body @Optional Involved party address line 2
Response:
Success code: 200 
{
    "status": true,
    "message": "Order updated successfully",
    "data": {
        "order_id": {
            "customer_id": "John Doe",
            "carrier_id": "Jane Smith",
            "orders_data": [
                {
                    "SAP_ORDER": "ORD12345",
                    "SX_ORDER": "1738129043"
                }
            ]
        }
    }
}
Success code: 400 
{
    "results": [],
    "status": false,
    "message": "Invalid or missing body parameter",
    "errors": {
        "field_name": "Field error"
    }
}
Success code: 401 
{
    "results": [],
    "error": {
        "message": "Not authorized to access resource",
        "details": "Not authorized"
    }
}

Delete Order

Details about deleting an order. Provide information on required parameters, authorization, and expected responses. 

POST /tmsapi/deleteOrder HTTP/1.1
Host: https://devdemov1.shipmentx.com
Authorization: Bearer <Token>
Request:
{
    "order_id": "ORD12345"
}
Request data paramer's description
Parameter Type Position # Description
Authorization String Header @Required Authorization: Bearer {TOKEN_HERE}
order_id String/Numeric Body @Required Customer Order Reference Number
Response:
Success code: 200 
{
    "status": true,
    "message": "Order Deleted successfully"
}
Success code: 400 
{
    "results": [],
    "error": {
        "message": "Invalid or missing body parameter",
        "details": "Input data failed validation"
    }
}
Success code: 401 
{
    "results": [],
    "error": {
        "message": "Not authorized to access resource",
        "details": "Not authorized"
    }
}

Order Status Update

Details about updating an order status. Provide information on required parameters, authorization, and expected responses.

POST /tmsapi/statusOrder HTTP/1.1
Host: https://devdemov1.shipmentx.com
Authorization: Bearer <Token>
Request:
{
    "data": [
        {
            "order_id": "ORD12345",
            "order_type": "Delivery",
            "origin": "San Francisco, CA, USA",
            "destination": "Los Angeles, CA, USA",
            "status_code": "IN_TRANSIT",
            "status_name": "In Transit",
            "status_location": "Santa Barbara, CA, USA",
            "status_datetime": "2025-01-28T10:30:00",
            "status_description": "The shipment is on the way.",
            "current_location": "Santa Barbara, CA, USA",
            "current_location_datetime": "2025-01-28T10:00:00",
            "latitude": "34.4208",
            "longitude": "-119.6982",
            "pickupDate": "2025-01-27",
            "pickupTime": "08:00:00",
            "deliveryDate": "2025-01-29",
            "deliveryTime": "15:00:00",
            "estimatedPickup": {
                "startDate": "2025-01-27",
                "startTime": "07:30:00",
                "endDate": "2025-01-27",
                "endTime": "08:30:00"
            },
            "estimatedDelivery": {
                "startDate": "2025-01-29",
                "startTime": "14:00:00",
                "endDate": "2025-01-29",
                "endTime": "15:30:00"
            },
            "totalWeight": "25.5",
            "totalQuantity": "100",
            "totalPackages": "5",
            "statusHistory": [
                {
                    "statusCode": "PICKED_UP",
                    "statusName": "Picked Up",
                    "statusDate": "2025-01-27",
                    "statusTime": "08:10:00",
                    "quantity": "100",
                    "packageType": "Box",
                    "packageDescription": "Electronics",
                    "location": {
                        "line": "123 Market Street",
                        "city": "San Francisco",
                        "state": "California",
                        "postalCode": "94105",
                        "country": "USA",
                        "latitude": "37.7749",
                        "longitude": "-122.4194"
                    },
                    "status_description": "Order has been picked up from the origin location."
                },
                {
                    "statusCode": "IN_TRANSIT",
                    "statusName": "In Transit",
                    "statusDate": "2025-01-28",
                    "statusTime": "10:30:00",
                    "quantity": "100",
                    "packageType": "Box",
                    "packageDescription": "Electronics",
                    "location": {
                        "line": "Highway 101",
                        "city": "Santa Barbara",
                        "state": "California",
                        "postalCode": "93101",
                        "country": "USA",
                        "latitude": "34.4208",
                        "longitude": "-119.6982"
                    },
                    "status_description": "Shipment is in transit and passing through Santa Barbara."
                }
            ]
        }
    ]
}
Request data paramer's description
Parameter Type Position # Description
Authorization String Header @Required Authorization: Bearer {TOKEN_HERE}
order_id String/Numeric Body @Required Customer Order Reference Number
order_type String Body @Optional Type of Order
origin String Body @Optional Origin location of the order
destination String Body @Optional Destination location of the order
status_code String Body @Optional Current status code of the order
status_location String Body @Optional Current status code of the order
status_name String Body @Optional Status name describing the current state
status_datetime Datetime Body @Optional Datetime of the current status
status_description String Body @Optional Description of the current status
current_location String Body @Optional Current location of the order
current_location_datetime Datetime Body @Optional Datetime of the current location update
latitude String Body @Optional Current latitude of the order's location
longitude String Body @Optional Current longitude of the order's location
pickupDate Date Body @Optional Date of the pickup
pickupTime Time Body @Optional Time of the pickup
deliveryDate Date Body @Optional Date of the delivery
deliveryTime Time Body @Optional Time of the delivery
estimatedPickup Object
Fields:
startDate: Date
startTime: Time
endDate: Date
endTime: Time 		Body @Optional Details of the estimated pickup, including start and end dates and times
totalWeight Numeric Body @Optional Total weight of the order
totalQuantity Numeric Body @Optional Total quantity of items in the order
totalPackages Numeric Body @Optional Total number of packages in the order
statusHistory Array of Objects
Fields:
statusCode: String
statusName: String
statusDate: String
statusTime: String
quantity: Numeric
packageType: String
packageDescription: String
location: Object
status-description: String 		Body @Optional History of statuses related to the order, including location and status description
Response:
Success code: 200 
{
    "status": true,
    "message": "Order Status updated successfully"
}
Success code: 400 
{
    "results": [],
    "status": false,
    "message": "Invalid or missing body parameter",
    "errors": {
        "data[0]": {
            "field_name": "Field error"
        }
    }
}
Success code: 401 
{
    "results": [],
    "error": {
        "message": "Not authorized to access resource",
        "details": "Not authorized"
    }
}