---
title: "order.shipment.tracking.add"
method: POST
path: "/order.shipment.tracking.add.json"
tags: ["order"]
---

# order.shipment.tracking.add

`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`

Add order shipment's tracking info.

## Request body

- OrderShipmentTrackingAdd
  - `order_id` string: Defines the order id
  - `shipment_id` string, required: Shipment id indicates the number of delivery
  - `carrier_id` string: Defines tracking carrier id
  - `store_id` string: Store Id
  - `tracking_provider` string: Defines name of the company which provides shipment tracking
  - `tracking_number` string, required: Defines tracking number
  - `tracking_link` string: Defines custom tracking link
  - `send_notifications` boolean: Send notifications to customer after tracking was created
  - `idempotency_key` string: 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>

## Response `200`

successful operation

- object
  - `return_code` integer
  - `return_message` string
  - `result` object
    - `shipment_tracking_id` string

---

[API](https://skmtc.dev/api2cart/apis/api2cart-openapi.md) · [All operations](https://skmtc.dev/api2cart/apis/api2cart-openapi/llms.txt) · [OpenAPI document](https://skmtc.dev/api2cart/apis/api2cart-openapi/revisions/c34440741693?raw)