Skip to main content
GET
/
v1
/
order_batches
/
{id}
/
orders
Retrieve orders for an order batch
curl --request GET \
  --url https://api.ongoody.com/v1/order_batches/{id}/orders \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "94070873-ca63-402d-b1d4-871792e946a4",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/QOXS2IPF7MD9NDBO3MT6EOCR",
      "recipient_first_name": "Alena",
      "recipient_last_name": "Kenter",
      "recipient_email": "alena@ongoody.com",
      "card_id": "220a5e06-1869-4bf5-b956-e2e89357fea6",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "626cef5e-da38-4b18-bd36-cb1e4e7b414a",
      "expires_at": null,
      "cart": {
        "id": "56268e8c-3e23-48a0-ba08-fe6398962623",
        "items": [
          {
            "id": "6bcbd5bc-dd2e-4b84-a0f3-5d1e82598ff5",
            "quantity": 1,
            "product": {
              "id": "5ec12187-f822-4003-b02c-b14a0d11eee5",
              "name": "Cookies",
              "brand": {
                "id": "e1a3c711-56e1-4642-909f-69f3658a6b75",
                "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": "15556911048@test.ongoody.com"
      },
      "workspace_id": "40356d26-fa43-43b4-b5f8-c96190a509d3",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "KCVPLQAHOINGEBYUCLP10ORQ",
      "payment_link": null
    },
    {
      "id": "cfd611e8-a1c3-4f8e-9d4f-ddda4874e18d",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/U1MVTFYO3YBKRDOPNSGCZGR0",
      "recipient_first_name": "Michael",
      "recipient_last_name": "Franci",
      "recipient_email": "michael@ongoody.com",
      "card_id": "220a5e06-1869-4bf5-b956-e2e89357fea6",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "626cef5e-da38-4b18-bd36-cb1e4e7b414a",
      "expires_at": null,
      "cart": {
        "id": "56268e8c-3e23-48a0-ba08-fe6398962623",
        "items": [
          {
            "id": "6bcbd5bc-dd2e-4b84-a0f3-5d1e82598ff5",
            "quantity": 1,
            "product": {
              "id": "5ec12187-f822-4003-b02c-b14a0d11eee5",
              "name": "Cookies",
              "brand": {
                "id": "e1a3c711-56e1-4642-909f-69f3658a6b75",
                "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": "15556911048@test.ongoody.com"
      },
      "workspace_id": "40356d26-fa43-43b4-b5f8-c96190a509d3",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "IQTU7HZWUCYMZDZOB2BPXSR5",
      "payment_link": null
    }
  ],
  "list_meta": {
    "total_count": 2
  }
}

Authorizations

Authorization
string
header
required

Your Goody API key.

Path Parameters

id
string
required

Order batch ID

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

Orders retrieved with pagination

data
object[]
list_meta
object