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": "22af8524-ac10-4619-89e7-1798632359ca",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/NR0NXLTBL1SIU5TJ8BJADMXJ",
      "recipient_first_name": "Alena",
      "recipient_last_name": "Kenter",
      "recipient_email": "[email protected]",
      "card_id": "6758d760-fd9d-469a-ad69-f8742012bdf1",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "9e8e8be2-e6c8-4e80-8419-309a8a5d460a",
      "expires_at": null,
      "cart": {
        "id": "f9361258-49fa-463b-8b39-bd328b2df49d",
        "items": [
          {
            "id": "13471a2e-79b6-48fa-a8ce-0b0018e2ea6c",
            "quantity": 1,
            "product": {
              "id": "4900fd6c-a4d7-490b-b78e-6bb0dccb5cc4",
              "name": "Cookies",
              "brand": {
                "id": "5322479a-f5f8-461f-9411-ad635707a898",
                "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": "[email protected]"
      },
      "workspace_id": "3a69e120-70a4-46c2-9cff-ed8230c03c0c",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "ENQY55XDBQCBBIOCHLNFIG7E",
      "payment_link": null
    },
    {
      "id": "5542bccf-2c06-4cff-9f30-6a7ad5993aa9",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/HWPWK4F9RNZVUSZ21MFDVBHO",
      "recipient_first_name": "Michael",
      "recipient_last_name": "Franci",
      "recipient_email": "[email protected]",
      "card_id": "6758d760-fd9d-469a-ad69-f8742012bdf1",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "9e8e8be2-e6c8-4e80-8419-309a8a5d460a",
      "expires_at": null,
      "cart": {
        "id": "f9361258-49fa-463b-8b39-bd328b2df49d",
        "items": [
          {
            "id": "13471a2e-79b6-48fa-a8ce-0b0018e2ea6c",
            "quantity": 1,
            "product": {
              "id": "4900fd6c-a4d7-490b-b78e-6bb0dccb5cc4",
              "name": "Cookies",
              "brand": {
                "id": "5322479a-f5f8-461f-9411-ad635707a898",
                "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": "[email protected]"
      },
      "workspace_id": "3a69e120-70a4-46c2-9cff-ed8230c03c0c",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "5JT7DH9PTMZC7ESZB1ISESCI",
      "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