Orders

List Orders

Changed on

Return list of recent orders.

get/orders/list

Request

  • Base URL: https://api.thanks.io/api/v2
  • URL: https://api.thanks.io/api/v2/orders/list
  • Auth: HTTP bearer

Query parameters

items_per_pageinteger

Number of items to return per page.

sub_account_idinteger

Filter results by Sub Account ID.

type'postcard' | 'postcard6x9' | 'postcard6x11' | 'letter' | 'windowlessletter' | 'notecard' | 'giftcard' | 'magnacard' | '4x6-postcard' | '6x9-postcard'

Only return orders of this mailer type. postcard returns 4x6 postcards only; postcard6x9 returns all 6x9 postcards, including 6x9 orders placed before 6x9 had its own type. 4x6-postcard and 6x9-postcard are accepted as aliases for postcard and postcard6x9.

creative_idinteger

Only return orders sent as this creative from your Creatives library. Use an id from List Creatives.

campaigninteger

Only return orders sent by a campaign. Pass the ID of the campaign's mailing list: every order sent by that list's campaign actions is returned, including actions that have since been deleted.

Response

OK

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 25,
    "to": 1,
    "total": 1
  }
}

Changes

  • 9b6aa91faff7Revision changes
    • info

      added the new optional query request parameter campaign

    • info

      added the new optional query request parameter creative_id

  • c76fc453c7caRevision changes
    • warning

      deleted the query request parameter campaign

    • warning

      deleted the query request parameter creative_id