GET
/
v1
/
order_batches
/
{id}
/
orders
curl --request GET \
  --url https://api.ongoody.com/v1/order_batches/{id}/orders \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "6bc14127-e7af-4e4a-ae45-5aa365c9663e",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/FV5WEL2MA27WTEJVPDDM5UR5",
      "recipient_first_name": "Alena",
      "recipient_last_name": "Kenter",
      "recipient_email": "alena@ongoody.com",
      "card_id": "824893c8-83e8-4d26-99ca-5e01738fa701",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "6428d772-4c2e-4fa9-aa2e-d34ac94fa699",
      "expires_at": null,
      "cart": {
        "id": "681027a5-cec6-40e0-a7e1-29d7f46ebf11",
        "items": [
          {
            "id": "5e225f77-e2b3-439d-ac0d-08ce1739fe47",
            "quantity": 1,
            "product": {
              "id": "56a8348f-c812-4b4a-aa3b-207556d62b84",
              "name": "Cookies",
              "brand": {
                "id": "8031c07d-f9d7-43bb-a409-7a3182b8c598",
                "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": "15557380194@test.ongoody.com"
      },
      "workspace_id": "97960cea-14cf-4044-a2af-2dc037d08113",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "FOG9YGQYETTTIP2S1QHNVQKR",
      "payment_link": null
    },
    {
      "id": "cd4df240-f359-4782-be62-d83da2e88918",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/XLIXB7XVYQICGUAQUKG5CYPO",
      "recipient_first_name": "Michael",
      "recipient_last_name": "Franci",
      "recipient_email": "michael@ongoody.com",
      "card_id": "824893c8-83e8-4d26-99ca-5e01738fa701",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "6428d772-4c2e-4fa9-aa2e-d34ac94fa699",
      "expires_at": null,
      "cart": {
        "id": "681027a5-cec6-40e0-a7e1-29d7f46ebf11",
        "items": [
          {
            "id": "5e225f77-e2b3-439d-ac0d-08ce1739fe47",
            "quantity": 1,
            "product": {
              "id": "56a8348f-c812-4b4a-aa3b-207556d62b84",
              "name": "Cookies",
              "brand": {
                "id": "8031c07d-f9d7-43bb-a409-7a3182b8c598",
                "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": "15557380194@test.ongoody.com"
      },
      "workspace_id": "97960cea-14cf-4044-a2af-2dc037d08113",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "NZGFMMSKHB28HOZTHDJMWAOO",
      "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

200
application/json
Orders retrieved with pagination
data
object[]

An individual order contains the gift link to be sent to the recipient (if applicable) and other information about the order.

list_meta
object