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

# order.shipment.event.add

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

Add a tracking event to the shipment.

## Request body

- OrderShipmentEventAdd
  - `shipment_id` string, required: Defines the shipment to which the tracking event will be added
  - `order_id` string: Defines the order to which the shipment belongs
  - `status` string, required: Defines the tracking event status (e.g. in_transit, delivered, out_for_delivery)
  - `store_id` string: Store Id
  - `address_1` string: Specifies the street address of the event location
  - `city` string: Specifies city
  - `country` string: Specifies ISO code or name of country
  - `state` string: Specifies ISO code or name of state
  - `postcode` string: Specifies postcode
  - `message` string: Defines a message associated with the tracking event.
  - `latitude` number: Latitude coordinate of the event location.
  - `longitude` number: Longitude coordinate of the event location.
  - `created_at` string: Defines the date of entity creation
  - `estimated_delivery_at` string: Estimated delivery date and time in ISO 8601 format.
  - `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
    - `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)