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

# order.shipment.add

`POST /order.shipment.add.json`

## Request

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

Add a shipment to the order.

## Request body

- OrderShipmentAdd
  - `order_id` string: Defines the order for which the shipment will be created
  - `warehouse_id` string: This parameter is used for selecting a warehouse where you need to set/modify a product quantity.
  - `store_id` string: Store Id
  - `shipment_provider` string: Defines company name that provide tracking of shipment
  - `shipping_method` string: Define shipping method
  - `items` object[]: Defines items in the order that will be shipped
    - `order_product_id` string
    - `quantity` number
  - `tracking_numbers` object[]: Defines shipment's tracking numbers that have to be added</br> How set tracking numbers to appropriate carrier:<ul><li>tracking_numbers[]=a2c.demo1,a2c.demo2 - set default carrier</li><li>tracking_numbers[<b>carrier_id</b>]=a2c.demo - set appropriate carrier</li></ul>To get the list of carriers IDs that are available in your store, use the <a href = "https://api2cart.com/docs/#/cart/CartInfo">cart.info</a > method
    - `carrier_id` string
    - `tracking_number` string
  - `tracking_link` string: Defines custom tracking link
  - `is_shipped` boolean: Defines shipment's status
  - `send_notifications` boolean: Send notifications to customer after shipment was created
  - `adjust_stock` boolean: This parameter is used for adjust stock.
  - `check_process_status` boolean: Disable or enable check process status. Please note that the response will be slower due to additional requests to the store.
  - `tracking_provider` string: Defines name of the company which provides shipment tracking
  - `admin_comment` string: Specifies admin's order comment
  - `mail_class` string: Mail class for the shipment (e.g., priority, express).
  - `ship_date` string: Ship date.
  - `weight` number: Weight
  - `weight_unit` string: Weight Unit
  - `length` number: Defines product's length
  - `width` number: Defines product's width
  - `height` number: Defines product's height
  - `dimensions_unit` string: Weight Unit
  - `shipping_label_cost` number: Cost of the shipping label.
  - `shipping_label_currency` string: Currency code for the shipping label cost (3-letter ISO code).
  - `revenue_eligibility` boolean: Revenue eligibility flag.
  - `ship_from_country` string: Country code the shipment is sent from (2-letter ISO code).
  - `ship_to_country` string: Country code the shipment is sent to (2-letter ISO code).
  - `incoterm` string: International commercial term for the shipment (e.g., DAP, DDP).
  - `duty_amount` number: Duty amount for international shipment.
  - `duty_currency` string: Currency code for the duty amount (3-letter ISO code).
  - `enable_cache` boolean: If the value is 'true' and order exist in our cache, we will use order.info from cache to prepare shipment items.
  - `use_latest_api_version` boolean: Use the latest platform API version
  - `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_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)