---
title: "Track Order"
method: GET
path: "/orders/{orderId}/track"
tags: ["Orders"]
---

# Track Order

`GET /orders/{orderId}/track`

## Request

- Base URL: `https://api.thanks.io/api/v2`
- URL: `https://api.thanks.io/api/v2/orders/{orderId}/track`
- Auth: HTTP bearer

Return Summary of delivery status for the order.

## Path parameters

- `orderId` string, required

## Response `200`

OK

- object
  - `data` object
    - `id` integer
    - `order` Order
      - `id` integer
      - `message` string
      - `size` string: Only valid for postcards
      - `sub_account_id` integer, nullable
      - `type` 'postcard' | 'postcard6x9' | 'postcard6x11' | 'letter' | 'notecard' | 'giftcard' | 'windowlessletter'
      - `display_type` string
      - `style` integer: Handwriting Style ID used for this order
      - `front_image` string
      - `high_quality_preview` string: PDF of the high quality preview of the order
      - `authorization_total` integer
      - `grand_total` integer
      - `order_total` integer
      - `total_estimated_recipients` integer
      - `total_recipients` integer
      - `recipient_count` integer
      - `status` string
      - `method` string
      - `cancellable` boolean
      - `total_scans` integer
      - `metadata` object, nullable: The metadata object submitted with the order, returned exactly as it was sent. Null when the order was created without metadata.
      - `created_at` string, date-time
      - `updated_at` string, date-time
    - `stats` object
      - `delivered` integer: Number of items delivered
      - `processing` integer: Number of items currently being processed
      - `printed` integer: Number of items printed
      - `in_transit` integer: Number of items in transit
      - `in_local_area` integer: Number of items in the local delivery area
      - `processed_for_delivery` integer: Number of items processed for delivery
      - `re_routed` integer: Number of items re-routed
      - `returned_to_sender` integer: Number of items returned to sender
      - `failed` integer: Number of items that failed to be delivered
      - `scans` integer: Number of times the item has been scanned
      - `multi_scans` integer: Number of times the item has been scanned multiple times
    - `errors` object[]: Array of recipients with errors
      - `name` string
      - `address` string
      - `address2` string
      - `city` string
      - `province` string
      - `postal_code` string
      - `country` string
      - `failure` string
    - `returned` object[]: Array of recipients whose mailers were returned
      - `name` string
      - `address` string
      - `address2` string
      - `city` string
      - `province` string
      - `postal_code` string
      - `country` string

## Changes

- **2026-10-01** `02de08ab2a47`: 1 warning
  - added the new `postcard6x9` enum value to the `data/order/type` response property for the response status `200`
- **2026-08-20** `4f2a64d375d2`: 1 info
  - added the optional property `data/order/metadata` to the response with the `200` status
- **2025-09-10** `94e89686cb6b`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/thanks-io/apis/thanks-io-api/changes/orders/:orderId/track/get.md)

---

[API](https://skmtc.dev/thanks-io/apis/thanks-io-api.md) · [All operations](https://skmtc.dev/thanks-io/apis/thanks-io-api/llms.txt) · [OpenAPI document](https://skmtc.dev/thanks-io/apis/thanks-io-api/revisions/c403fbf3dc0f?raw)