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

# order.shipment.add.batch

`POST /order.shipment.add.batch.json`

## Request

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

Add a shipments to the orders.

## Request body

- OrderShipmentAddBatch
  - `payload` object[], required: Contains an array of order shipment objects. The list of properties may vary depending on the specific platform.
    - `order_id` string, required
    - `store_id` string
    - `warehouse_id` string
    - `carrier_id` string
    - `carrier_name` string
    - `tracking_number` string, required
    - `tracking_link` string
    - `shipment_provider` string
    - `items` object[]
      - `order_product_id` string, required
      - `quantity` number, required
    - `send_notifications` boolean
  - `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
    - `job_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)