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": "45cc590e-f3a1-4159-bf3a-75b5069014dd",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/FDDAQEY7N0O6WY9Z5PPXU4IY",
      "recipient_first_name": "Alena",
      "recipient_last_name": "Kenter",
      "recipient_email": "alena@ongoody.com",
      "card_id": "74b67d4d-ec46-4f3e-b682-9f1e0dfa3617",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "74b152ce-189a-4c76-8933-ee5446fbccbb",
      "expires_at": null,
      "cart": {
        "id": "4325520a-692c-42c3-a9cb-6efd53acace2",
        "items": [
          {
            "id": "53d648c1-f04f-4cf5-b4b2-7b12cae5b22f",
            "quantity": 1,
            "product": {
              "id": "eaf264ab-c962-4371-9f61-5201d329d597",
              "name": "Cookies",
              "brand": {
                "id": "3d3f2041-1af8-4288-9100-59b97059b1ee",
                "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": "15557505552@test.ongoody.com"
      },
      "workspace_id": "3f23b0ae-a9f7-4a2b-8994-78d32bd66bda",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "F55TTQD5CBI37KPC1ZI7S9EY",
      "payment_link": null
    },
    {
      "id": "fa525bd8-9883-435a-a80c-0ef812b8ff80",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/6OH2ICRYLPNDD8BBBDWDKVAA",
      "recipient_first_name": "Michael",
      "recipient_last_name": "Franci",
      "recipient_email": "michael@ongoody.com",
      "card_id": "74b67d4d-ec46-4f3e-b682-9f1e0dfa3617",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "74b152ce-189a-4c76-8933-ee5446fbccbb",
      "expires_at": null,
      "cart": {
        "id": "4325520a-692c-42c3-a9cb-6efd53acace2",
        "items": [
          {
            "id": "53d648c1-f04f-4cf5-b4b2-7b12cae5b22f",
            "quantity": 1,
            "product": {
              "id": "eaf264ab-c962-4371-9f61-5201d329d597",
              "name": "Cookies",
              "brand": {
                "id": "3d3f2041-1af8-4288-9100-59b97059b1ee",
                "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": "15557505552@test.ongoody.com"
      },
      "workspace_id": "3f23b0ae-a9f7-4a2b-8994-78d32bd66bda",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "RGAGBWX8WWYNP0W1MMRJJTQO",
      "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