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": "df8e85b2-7d62-42c9-b5ff-53b8b2553c88",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/FSVSEBAXIDKFYCPZRJOIEPLN",
      "recipient_first_name": "Alena",
      "recipient_last_name": "Kenter",
      "recipient_email": "alena@ongoody.com",
      "card_id": "402be0b5-e054-4560-94a6-961d48a0136c",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "f388325b-6ac0-4c93-87fb-a484d729fb1b",
      "expires_at": null,
      "cart": {
        "id": "42428538-f157-476b-a2dd-b15ab5f91f8c",
        "items": [
          {
            "id": "3b9d7601-313c-44fa-859f-681cd916d841",
            "quantity": 1,
            "product": {
              "id": "e961f687-a2b5-4443-b1c8-8409e72c9f7e",
              "name": "Cookies",
              "brand": {
                "id": "3112d5de-bc71-4ba7-911c-0e6518e0ffba",
                "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": "15553041792@test.ongoody.com"
      },
      "workspace_id": "f82b6dc6-307d-44fb-ae3f-7fb3eb4ae1fd",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "SB1HYIB55EGMQKASEUR5KSZP",
      "payment_link": null
    },
    {
      "id": "6122db51-d7ea-4124-aa4e-dcedaa3780dc",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/I9NFGCM3QA8A5P9ILM7MDI3J",
      "recipient_first_name": "Michael",
      "recipient_last_name": "Franci",
      "recipient_email": "michael@ongoody.com",
      "card_id": "402be0b5-e054-4560-94a6-961d48a0136c",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "f388325b-6ac0-4c93-87fb-a484d729fb1b",
      "expires_at": null,
      "cart": {
        "id": "42428538-f157-476b-a2dd-b15ab5f91f8c",
        "items": [
          {
            "id": "3b9d7601-313c-44fa-859f-681cd916d841",
            "quantity": 1,
            "product": {
              "id": "e961f687-a2b5-4443-b1c8-8409e72c9f7e",
              "name": "Cookies",
              "brand": {
                "id": "3112d5de-bc71-4ba7-911c-0e6518e0ffba",
                "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": "15553041792@test.ongoody.com"
      },
      "workspace_id": "f82b6dc6-307d-44fb-ae3f-7fb3eb4ae1fd",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "N4Y7FPNTOPZULINM01NPFEUG",
      "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

The response is of type object.