---
title: "order.shipment.update"
method: PUT
path: "/order.shipment.update.json"
tags: ["order"]
---

# order.shipment.update

`PUT /order.shipment.update.json`

## Request

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

Update order's shipment information.

## Request body

- OrderShipmentUpdate
  - `shipment_id` string, required: Shipment id indicates the number of delivery
  - `order_id` string: Defines the order that will be updated
  - `store_id` string: Store Id
  - `shipment_provider` string: Defines company name that provide tracking of shipment
  - `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
  - `delivered_at` string: Defines the date of delivery
  - `replace` boolean: Allows rewrite tracking numbers
  - `send_notifications` boolean: Send notifications to customer after order was created
  - `tracking_provider` string: Defines name of the company which provides shipment tracking
  - `items` object[]: Defines items in the order that will be shipped
    - `order_product_id` string
    - `quantity` number
  - `admin_comment` string: Specifies admin's order comment
  - `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
    - `updated_items` integer

---

[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)