Skip to main content
GET
/
v1
/
order_batches
List order batches
curl --request GET \
  --url https://api.ongoody.com/v1/order_batches \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "046cd5ae-f7cd-4ee5-9af9-6ee6bfcd5ff5",
      "send_status": "complete",
      "from_name": "Myron",
      "message": null,
      "orders_count": 2,
      "orders_preview": [
        {
          "id": "3032f143-71be-4af4-968e-c9a707cdfbaf",
          "status": "created",
          "individual_gift_link": "https://gifts.ongoody.com/gift/F2I99SL0LI8MCL0KHXPC13SV",
          "recipient_first_name": "Alena",
          "recipient_last_name": "Kenter",
          "recipient_email": "alena@ongoody.com",
          "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
          "message": "Test Message",
          "thank_you_note": null,
          "view_count_recipient": 0,
          "is_swapped": false,
          "order_batch_id": "046cd5ae-f7cd-4ee5-9af9-6ee6bfcd5ff5",
          "expires_at": null,
          "cart": {
            "id": "e3ac44ba-8521-44f5-9abe-295973256045",
            "items": [
              {
                "id": "93dabf0b-88f5-4dc4-aafe-a6a07fd4d727",
                "quantity": 1,
                "product": {
                  "id": "621e2bfc-be45-45bb-a26b-d5a1c9f05c08",
                  "name": "Cookies",
                  "brand": {
                    "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                    "name": "Cookie Company"
                  }
                }
              }
            ]
          },
          "shipments": [],
          "amounts": {
            "amount_product": 2000,
            "amount_shipping": 500,
            "amount_processing_fee": 0,
            "amount_pre_tax_total": 2500,
            "amount_tax": null,
            "amount_total": null,
            "amount_global_relay_cost": null
          },
          "sender": {
            "first_name": "Test",
            "last_name": "User",
            "email": "15554175617@test.ongoody.com"
          },
          "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
          "workspace_name": "Test Team",
          "original_cart": null,
          "original_amounts": null,
          "reference_id": "UFIXHDFULQKNQHYYWFJA8DPF",
          "payment_link": null
        },
        {
          "id": "b0435662-ba90-4426-8da7-787ab599c629",
          "status": "created",
          "individual_gift_link": "https://gifts.ongoody.com/gift/YAKIHKEVCHDWSJ9ROC4XJI1I",
          "recipient_first_name": "Michael",
          "recipient_last_name": "Franci",
          "recipient_email": "michael@ongoody.com",
          "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
          "message": "Test Message",
          "thank_you_note": null,
          "view_count_recipient": 0,
          "is_swapped": false,
          "order_batch_id": "046cd5ae-f7cd-4ee5-9af9-6ee6bfcd5ff5",
          "expires_at": null,
          "cart": {
            "id": "e3ac44ba-8521-44f5-9abe-295973256045",
            "items": [
              {
                "id": "93dabf0b-88f5-4dc4-aafe-a6a07fd4d727",
                "quantity": 1,
                "product": {
                  "id": "621e2bfc-be45-45bb-a26b-d5a1c9f05c08",
                  "name": "Cookies",
                  "brand": {
                    "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                    "name": "Cookie Company"
                  }
                }
              }
            ]
          },
          "shipments": [],
          "amounts": {
            "amount_product": 2000,
            "amount_shipping": 500,
            "amount_processing_fee": 0,
            "amount_pre_tax_total": 2500,
            "amount_tax": null,
            "amount_total": null,
            "amount_global_relay_cost": null
          },
          "sender": {
            "first_name": "Test",
            "last_name": "User",
            "email": "15554175617@test.ongoody.com"
          },
          "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
          "workspace_name": "Test Team",
          "original_cart": null,
          "original_amounts": null,
          "reference_id": "NFZKOAQY25WTAW497GINZYCX",
          "payment_link": null
        }
      ],
      "recipients_count": 2,
      "recipients_preview": [
        {
          "first_name": "Alena",
          "last_name": "Kenter",
          "email": "alena@ongoody.com"
        },
        {
          "first_name": "Michael",
          "last_name": "Franci",
          "email": "michael@ongoody.com"
        }
      ],
      "cart": {
        "id": "e3ac44ba-8521-44f5-9abe-295973256045",
        "items": [
          {
            "id": "93dabf0b-88f5-4dc4-aafe-a6a07fd4d727",
            "quantity": 1,
            "product": {
              "id": "621e2bfc-be45-45bb-a26b-d5a1c9f05c08",
              "name": "Cookies",
              "brand": {
                "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                "name": "Cookie Company"
              }
            }
          }
        ]
      },
      "is_scheduled_send": false,
      "scheduled_send_on": null,
      "expires_at": null,
      "send_method": null,
      "batch_name": "Thank You from Hill, Walker and Barton",
      "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
      "sender": {
        "first_name": "Test",
        "last_name": "User",
        "email": "15554175617@test.ongoody.com"
      },
      "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
      "workspace_name": "Test Team",
      "reference_id": "JXX2IYUYRBZBORKZHT3EOIWW"
    },
    {
      "id": "60f1e518-3ab3-4388-ac9f-366be13f977a",
      "send_status": "complete",
      "from_name": "Eusebio",
      "message": null,
      "orders_count": 2,
      "orders_preview": [
        {
          "id": "5b53b89a-0f2d-4e77-8e9c-d24821b28410",
          "status": "created",
          "individual_gift_link": "https://gifts.ongoody.com/gift/HLSGY3PVVBZDNWGX5QCTWCI9",
          "recipient_first_name": "Alena",
          "recipient_last_name": "Kenter",
          "recipient_email": "alena@ongoody.com",
          "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
          "message": "Test Message",
          "thank_you_note": null,
          "view_count_recipient": 0,
          "is_swapped": false,
          "order_batch_id": "60f1e518-3ab3-4388-ac9f-366be13f977a",
          "expires_at": null,
          "cart": {
            "id": "6dc52b7c-c69d-4628-b338-83f90ab869a6",
            "items": [
              {
                "id": "0571a053-0287-4584-9362-57a3e347d18d",
                "quantity": 1,
                "product": {
                  "id": "a5645f2c-1dea-489d-b14f-149a9edebde8",
                  "name": "Cookies",
                  "brand": {
                    "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                    "name": "Cookie Company"
                  }
                }
              }
            ]
          },
          "shipments": [],
          "amounts": {
            "amount_product": 2000,
            "amount_shipping": 500,
            "amount_processing_fee": 0,
            "amount_pre_tax_total": 2500,
            "amount_tax": null,
            "amount_total": null,
            "amount_global_relay_cost": null
          },
          "sender": {
            "first_name": "Test",
            "last_name": "User",
            "email": "15554175617@test.ongoody.com"
          },
          "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
          "workspace_name": "Test Team",
          "original_cart": null,
          "original_amounts": null,
          "reference_id": "KCRSFLWWCODWMXZCRPGCNXQZ",
          "payment_link": null
        },
        {
          "id": "ada453df-5e51-47fd-9e5e-7bcc594f8600",
          "status": "created",
          "individual_gift_link": "https://gifts.ongoody.com/gift/R2OIBM8I99CW983CRIB6VV9D",
          "recipient_first_name": "Michael",
          "recipient_last_name": "Franci",
          "recipient_email": "michael@ongoody.com",
          "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
          "message": "Test Message",
          "thank_you_note": null,
          "view_count_recipient": 0,
          "is_swapped": false,
          "order_batch_id": "60f1e518-3ab3-4388-ac9f-366be13f977a",
          "expires_at": null,
          "cart": {
            "id": "6dc52b7c-c69d-4628-b338-83f90ab869a6",
            "items": [
              {
                "id": "0571a053-0287-4584-9362-57a3e347d18d",
                "quantity": 1,
                "product": {
                  "id": "a5645f2c-1dea-489d-b14f-149a9edebde8",
                  "name": "Cookies",
                  "brand": {
                    "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                    "name": "Cookie Company"
                  }
                }
              }
            ]
          },
          "shipments": [],
          "amounts": {
            "amount_product": 2000,
            "amount_shipping": 500,
            "amount_processing_fee": 0,
            "amount_pre_tax_total": 2500,
            "amount_tax": null,
            "amount_total": null,
            "amount_global_relay_cost": null
          },
          "sender": {
            "first_name": "Test",
            "last_name": "User",
            "email": "15554175617@test.ongoody.com"
          },
          "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
          "workspace_name": "Test Team",
          "original_cart": null,
          "original_amounts": null,
          "reference_id": "7IDP80VTVNB3DFWUNRBPACZU",
          "payment_link": null
        }
      ],
      "recipients_count": 2,
      "recipients_preview": [
        {
          "first_name": "Alena",
          "last_name": "Kenter",
          "email": "alena@ongoody.com"
        },
        {
          "first_name": "Michael",
          "last_name": "Franci",
          "email": "michael@ongoody.com"
        }
      ],
      "cart": {
        "id": "6dc52b7c-c69d-4628-b338-83f90ab869a6",
        "items": [
          {
            "id": "0571a053-0287-4584-9362-57a3e347d18d",
            "quantity": 1,
            "product": {
              "id": "a5645f2c-1dea-489d-b14f-149a9edebde8",
              "name": "Cookies",
              "brand": {
                "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                "name": "Cookie Company"
              }
            }
          }
        ]
      },
      "is_scheduled_send": false,
      "scheduled_send_on": null,
      "expires_at": null,
      "send_method": null,
      "batch_name": "Thank You from Barrows Inc",
      "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
      "sender": {
        "first_name": "Test",
        "last_name": "User",
        "email": "15554175617@test.ongoody.com"
      },
      "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
      "workspace_name": "Test Team",
      "reference_id": "XXROJBTWMAYQS4RCEKI6VG4N"
    }
  ],
  "list_meta": {
    "total_count": 2
  }
}

Authorizations

Authorization
string
header
required

Your Goody API key.

Query Parameters

page
integer
default:1

Page for pagination, starting at 1

Required range: x >= 1
per_page
integer
default:20

Items per page for pagination

Required range: 1 <= x <= 100

Response

200 - application/json

Order batches retrieved

data
object[]
list_meta
object