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": "1a900096-2649-4a07-a0e6-2e87e9e32dda",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/TUBM86CZICNHHO9PRFQB5Z9L",
      "recipient_first_name": "Alena",
      "recipient_last_name": "Kenter",
      "recipient_email": "alena@ongoody.com",
      "card_id": "9100c315-c065-4601-9885-fac5b542d293",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "f19e56ca-6f62-420c-903d-2050251a54f8",
      "expires_at": null,
      "cart": {
        "id": "c7c57b60-ff3b-4ed7-99c5-ad909c0252d2",
        "items": [
          {
            "id": "7f3a45d3-ded4-4bb3-b9d3-58ac00097e80",
            "quantity": 1,
            "product": {
              "id": "0aa9addc-1e88-49f1-9415-a279fdbd388e",
              "name": "Cookies",
              "brand": {
                "id": "42a33233-f54b-4690-8508-f4900cf38ebd",
                "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": "15559222579@test.ongoody.com"
      },
      "workspace_id": "dfa26ded-63c0-4970-96e3-a0d98d3183d2",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "UMFMWISWB53SIGNXLMH2QZAR",
      "payment_link": null
    },
    {
      "id": "313c02e0-a489-4c81-b3ba-0eafd87f3df2",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/ARY9VSBL8QFVCOFR5GCMU8WD",
      "recipient_first_name": "Michael",
      "recipient_last_name": "Franci",
      "recipient_email": "michael@ongoody.com",
      "card_id": "9100c315-c065-4601-9885-fac5b542d293",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "f19e56ca-6f62-420c-903d-2050251a54f8",
      "expires_at": null,
      "cart": {
        "id": "c7c57b60-ff3b-4ed7-99c5-ad909c0252d2",
        "items": [
          {
            "id": "7f3a45d3-ded4-4bb3-b9d3-58ac00097e80",
            "quantity": 1,
            "product": {
              "id": "0aa9addc-1e88-49f1-9415-a279fdbd388e",
              "name": "Cookies",
              "brand": {
                "id": "42a33233-f54b-4690-8508-f4900cf38ebd",
                "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": "15559222579@test.ongoody.com"
      },
      "workspace_id": "dfa26ded-63c0-4970-96e3-a0d98d3183d2",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "BLWQXIDFVASWPRXMVUKZ0GDS",
      "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