Update Delivery

Update the delivery registered under the license_number provided.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

id required	string Reference (entity_ID) for the delivery you are updating. Example: 80d15c7713a74feeb4c1c5f533697644
state required	string Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating. Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

header Parameters

x-api-key required	string Trace API key header Example: b123x21wbHlkYXBpa2V5
Authorization required	string Company and user credentials authentication Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5

Request Body schema: application/json

required	object (license_base)
required	object The action to be performed on the delivery.
order_id	string The order ID associated with the action, required for certain actions like voiding an order.
payment_method	string The payment method used for the delivery, required for completing a delivery.
accepted_packages	Array of strings List of accepted Lot IDs for the delivery, required for completing a delivery.
update_date required	string <date-time> The date and time when the action is performed in ISO 8601 format.

Responses

200

400

Bad Request

put/{state}/v1/deliveries/{id}

Request samples

Payload

application/json

{"license": {"license_number": "1231235123"
},
"actions": {"id": "TRCDA001"
},
"update_date": "2025-09-12T09:09:50Z"
}

Response samples

application/json

{"results": {"type": "object",
"data": {"license": {"license_number": "S0028"
},
"id": "cbabf0b1ca4c4880810b984c19ca69a1",
"estimated_departure": null,
"actual_departure": "2025-09-12T17:28:55Z",
"total_orders": 2,
"orders_completed": 0,
"delivery_type": {"id": "KOMDT0001",
"name": "in_house"
},
"transporter": {"license": {"license_number": "S0028"
},
"vehicle": {"id": "48fbdc23cb394734945cc135ab4bf512",
"make": "Dodge",
"model": "Ram",
"year": null,
"color": null,
"vin": null,
"plate_number": "deliveryemp123plt"
},
"personnel": [{"employee_id": "27721bbc23434cb0b4fa1838d6c2d588",
"first_name": "Terry",
"last_name": "Cruz",
"phone_number": "123-456-7890",
"identification": [{"type": {"id": "CAKOMIT001",
"name": "valid_state_id"
},
"id": "dlem321dl"
}
]
}
]
},
"orders": [{"id": "7164f85b8ebc4c5ba62ff3ae9373f478",
"order_number": "0000004903",
"license": {"license_number": "S0028"
},
"order_type": {"id": "TRCOT0001",
"name": "delivery"
},
"stop_number": null,
"delivery_information": {"ext_consumer_id": "9a21182dd12b41389068ea5e049e0e2b",
"consumer_id": "40636c51c7c24d7aa4242447e0c4c5dd",
"customer_name": "test name",
"customer_address_1": "123 easy st",
"customer_address_2": "none",
"customer_city": "somewhereville",
"customer_county": "Larimer",
"customer_state": "CO",
"customer_zip": "90210",
"delivery_fee": null,
"estimated_departure_time": "2025-09-11T09:09:50Z",
"estimated_arrival_time": "2025-09-11T12:09:50Z",
"actual_arrival_time": null,
"notes": null,
"planned_route": "drive down the street, turn left at the light.  Go 3 blocks, turn left at down st."
},
"order_information": {"customer_types": {"id": "DMKOMCT0001",
"name": "consumer"
},
"terminal": null,
"external_id": "0020",
"created_at": null,
"identifications": [{"type": {"id": "DMKOMIT0001"
},
"id": "CADLC12356",
"birthday": "2002-02-06T00:00:01Z"
},
{"type": {"id": "DMKOMIT0002"
},
"id": "123123123123",
"birthday": "2002-02-06T00:00:01Z"
}
],
"employees": {"id": null
},
"line_items": [{"lot": {"id": "d435ab19f3264c629dd48e816f88722f"
},
"discount": null,
"quantity": "1.00",
"unit_price": "12.00",
"taxes": [{"type": {"id": "KOMTAX0001"
},
"name": "Imported Record",
"rate": null,
"total": "1.00"
},
{"type": {"id": "KOMTAX0002"
},
"name": "Imported Record",
"rate": null,
"total": "1.00"
},
{"type": {"id": "KOMTAX0005"
},
"name": "Imported Record",
"rate": null,
"total": "1.00"
}
],
"total": "15.00"
},
{"lot": {"id": "1e9ab37c5f604f30a57762c2b84a8088"
},
"discount": "1.00",
"quantity": "1.00",
"unit_price": "10.00",
"taxes": [ ],
"total": "9.00"
}
],
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"totals": {"quantity": "2.00",
"subtotal": "21.00",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"total": "1.0"
},
{"type": {"id": "KOMTAX0002",
"name": "Excise Tax"
},
"total": "1.0"
},
{"type": {"id": "KOMTAX0005",
"name": "County Tax"
},
"total": "1.0"
}
],
"total": "24.00"
},
"payments": [ ]
},
"entity_state": [{"state": "active",
"date": "2025-09-12T17:28:56Z",
"reason": "Order Created",
"actioned_by": "user_generated"
},
{"state": "updated",
"date": "2025-09-15T13:35:58Z",
"reason": "Order Updated",
"actioned_by": "user_generated"
},
{"state": "started_delivery",
"date": "2025-09-15T13:34:07Z",
"reason": "start delivery",
"actioned_by": "system_generated"
}
]
},
{"id": "eb77b1d620bb46e69a4942b691af1b90",
"order_number": "0000004904",
"license": {"license_number": "S0028"
},
"order_type": {"id": "TRCOT0001",
"name": "delivery"
},
"stop_number": null,
"delivery_information": {"ext_consumer_id": "751e419e0f7043c290051aa436fe2cf3",
"consumer_id": "f2dff397f80842f2b8bdbc765fed7f16",
"customer_name": "Nick",
"customer_address_1": "124 easy st",
"customer_address_2": "none",
"customer_city": "somewhereville",
"customer_county": "Larimer",
"customer_state": "CO",
"customer_zip": "90210",
"delivery_fee": null,
"estimated_departure_time": "2025-09-11T10:09:50Z",
"estimated_arrival_time": "2025-09-11T13:09:50Z",
"actual_arrival_time": null,
"notes": null,
"planned_route": "right next door"
},
"order_information": {"customer_types": {"id": "DMKOMCT0001",
"name": "consumer"
},
"terminal": null,
"external_id": "0021",
"created_at": null,
"identifications": [{"type": {"id": "DMKOMIT0001"
},
"id": "CADLC12356",
"birthday": "2002-02-06T00:00:01Z"
},
{"type": {"id": "DMKOMIT0002"
},
"id": "123123123123",
"birthday": "2002-02-06T00:00:01Z"
}
],
"employees": {"id": null
},
"line_items": [{"lot": {"id": "1e9ab37c5f604f30a57762c2b84a8088"
},
"discount": "1.00",
"quantity": "1.00",
"unit_price": "10.00",
"taxes": [ ],
"total": "9.00"
}
],
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"totals": {"quantity": "1.00",
"subtotal": "9.00",
"taxes": [ ],
"total": "9.00"
},
"payments": [ ]
},
"entity_state": [{"state": "active",
"date": "2025-09-12T17:28:56Z",
"reason": "Order Created",
"actioned_by": "user_generated"
},
{"state": "updated",
"date": "2025-09-15T13:35:58Z",
"reason": "Order Updated",
"actioned_by": "user_generated"
},
{"state": "started_delivery",
"date": "2025-09-15T13:34:07Z",
"reason": "start delivery",
"actioned_by": "system_generated"
}
]
}
],
"entity_state": [{"state": "active",
"date": "2025-09-12T17:28:55Z",
"reason": "Delivery Created",
"actioned_by": "user_generated"
},
{"state": "started_delivery",
"date": "2025-09-15T13:34:07Z",
"reason": "start delivery",
"actioned_by": "system_generated"
},
{"state": "updated",
"date": "2025-09-15T13:35:58Z",
"reason": "Delivery Updated",
"actioned_by": "user_generated"
}
]
}
},
"warnings": [ ]
}