order

order.shipment.tracking.add

Add order shipment's tracking info.

post/order.shipment.tracking.add.json

Request

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

Request body

order_idstring

Defines the order id

shipment_idstring required

Shipment id indicates the number of delivery

carrier_idstring

Defines tracking carrier id

store_idstring

Store Id

tracking_providerstring

Defines name of the company which provides shipment tracking

tracking_numberstring required

Defines tracking number

tracking_linkstring

Defines custom tracking link

send_notificationsboolean

Send notifications to customer after tracking was created

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",
  "carrier_id": "USPS",
  "store_id": "1",
  "tracking_provider": "Custom tracker",
  "tracking_number": "1А6745",
  "tracking_link": "http://example.com?someParam=value",
  "send_notifications": true,
  "idempotency_key": "098f6bcd4621d373cade4e832627b4f6"
}

Response

successful operation

return_codeinteger

return_messagestring

Changes

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