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

# order.shipment.event.list

`GET /order.shipment.event.list.json`

## Request

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

Get list of shipment tracking events.

## Query parameters

- `shipment_id` string, required
- `order_id` string
- `store_id` string
- `start` integer
- `count` integer
- `page_cursor` string
- `response_fields` string

## Response `200`

successful operation

- ModelResponseOrderShipmentEventList
  - `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` ResponseOrderShipmentEventListResult
    - `total_count` integer, nullable
    - `events` ShipmentEvent[]
      - `id` string
      - `status` string
      - `created_at` A2CDateTime
        - `value` string, nullable
        - `format` string
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `estimated_delivery_at` A2CDateTime
        - `value` string, nullable
        - `format` string
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `message` string, nullable
      - `address` CustomerAddress
        - `id` string
        - `type` string
        - `first_name` string, nullable
        - `last_name` string, nullable
        - `postcode` string
        - `address1` string
        - `address2` string, nullable
        - `phone` string, nullable
        - `phone_mobile` string, nullable
        - `city` string
        - `country` Country
          - `code2` string
          - `code3` string
          - `name` string
          - `additional_fields` object, nullable
          - `custom_fields` object, nullable
        - `state` State
          - `code` string
          - `name` string
          - `additional_fields` object, nullable
          - `custom_fields` object, nullable
        - `company` string, nullable
        - `fax` string, nullable
        - `website` string, nullable
        - `gender` string, nullable
        - `region` string, nullable
        - `default` boolean
        - `tax_id` string, nullable
        - `identification_number` string, nullable
        - `alias` string, 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
  - `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)