---
title: "order.shipment.list"
method: GET
path: "/order.shipment.list.json"
tags: ["order"]
---

# order.shipment.list

`GET /order.shipment.list.json`

## Request

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

Get list of shipments per order.

## Query parameters

- `start` integer
- `count` integer
- `page_cursor` string
- `order_id` string, required
- `store_id` string
- `created_from` string
- `created_to` string
- `modified_from` string
- `modified_to` string
- `response_fields` string
- `params` string
- `exclude` string

## Response `200`

successful operation

- ModelResponseOrderShipmentList
  - `return_code` integer, nullable
  - `return_message` string, nullable
  - `pagination` Pagination
    - `previous` string, nullable
    - `next` string, nullable
    - `additional_fields` object, nullable
    - `custom_fields` object, nullable
  - `result` ResponseOrderShipmentListResult
    - `shipment_count` integer, nullable
    - `shipment` Shipment[]
      - `id` string
      - `order_id` string
      - `name` string, nullable
      - `warehouse_id` string, nullable
      - `shipment_provider` string, nullable
      - `tracking_numbers` ShipmentTrackingNumber[]
        - `carrier_id` string, nullable
        - `tracking_number` string, nullable
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `created_at` A2CDateTime
        - `value` string, nullable
        - `format` string
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `modified_time` A2CDateTime
        - `value` string, nullable
        - `format` string
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `items` ShipmentItem[]
        - `order_product_id` string, nullable
        - `product_id` string, nullable
        - `variant_id` string, nullable
        - `model` string, nullable
        - `name` string, nullable
        - `price` number, nullable
        - `quantity` number, nullable
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `is_shipped` boolean, nullable
      - `delivered_at` A2CDateTime
        - `value` string, nullable
        - `format` string
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `additional_fields` object, nullable
      - `custom_fields` object, nullable
    - `additional_fields` object, nullable
    - `custom_fields` object, nullable
  - `additional_fields` object, nullable
  - `custom_fields` object, nullable

---

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