Orders

Track Order

Changed on

Return Summary of delivery status for the 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

Path parameters

orderIdstring required

Response

OK

Example response

{
  "data": {
    "id": 42708,
    "order": {
      "id": 42708,
      "message": "Hey %FIRST_NAME%!,\n\nTHANK YOU for allowing us the opportunity to HELP you with your plan!",
      "size": "4x6",
      "type": "postcard",
      "display_type": "Postcard-4x6",
      "style": 1,
      "front_image": "https://cdn.thanks.io/letter-backgrounds/bg0.png",
      "authorization_total": 73,
      "grand_total": 73,
      "order_total": 73,
      "total_estimated_recipients": 1,
      "total_recipients": 1,
      "recipient_count": 1,
      "status": "Fulfilled",
      "method": "Campaign",
      "metadata": {
        "crm_deal_id": "D-1042"
      },
      "created_at": "2025-09-08T16:05:12.000000Z",
      "updated_at": "2025-09-08T16:06:08.000000Z"
    },
    "stats": {
      "printed": 1
    },
    "errors": [
      {
        "name": "Current Resident",
        "address": "1 Main Street",
        "address2": "",
        "city": "Fake City",
        "province": "FC",
        "postal_code": "12345",
        "country": "US",
        "failure": "USPS lists address as 'no-stat' - address is unlikely to receive mail."
      }
    ],
    "returned": [
      {
        "name": "Current Resident",
        "address": "1 Main Street",
        "address2": "",
        "city": "Fake City",
        "province": "FC",
        "postal_code": "12345",
        "country": "US"
      }
    ]
  }
}

Changes