order

order.shipment.event.add

Add a tracking event to the shipment.

post/order.shipment.event.add.json

Request

Base URL: https://api.api2cart.com/v1.1
URL: https://api.api2cart.com/v1.1/order.shipment.event.add.json
Auth: API key in header x-api-key and API key in header x-store-key

Request body

shipment_idstring required

Defines the shipment to which the tracking event will be added

order_idstring

Defines the order to which the shipment belongs

statusstring required

Defines the tracking event status (e.g. in_transit, delivered, out_for_delivery)

store_idstring

Store Id

address_1string

Specifies the street address of the event location

citystring

Specifies city

countrystring

Specifies ISO code or name of country

statestring

Specifies ISO code or name of state

postcodestring

Specifies postcode

messagestring

Defines a message associated with the tracking event.

latitudenumber

Latitude coordinate of the event location.

longitudenumber

Longitude coordinate of the event location.

created_atstring

Defines the date of entity creation

estimated_delivery_atstring

Estimated delivery date and time in ISO 8601 format.

idempotency_keystring

A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong>

Example request

{
  "shipment_id": "200000002",
  "status": "disabled",
  "store_id": "1",
  "address_1": "1234 Main St",
  "city": "Chicago",
  "country": "US",
  "state": "IL",
  "postcode": "12345",
  "message": "Package has arrived at the sorting facility.",
  "created_at": "2014-08-09 13:13:13",
  "estimated_delivery_at": "2025-03-15T10:00:00-03:00",
  "idempotency_key": "098f6bcd4621d373cade4e832627b4f6"
}

Response

successful operation

return_codeinteger

return_messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.