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": "172555b3-75bd-430b-a6ad-38e7e8274824",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/NB8WJFJ6BSV3KHUO48RTJP8P",
      "recipient_first_name": "Alena",
      "recipient_last_name": "Kenter",
      "recipient_email": "alena@ongoody.com",
      "card_id": "7ae97dd1-93ac-4989-84e0-b4feac1cba74",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "1381198c-50d8-47f1-9965-65395b33b829",
      "expires_at": null,
      "cart": {
        "id": "aee5e64f-6f61-49d4-9f96-525b783ae409",
        "items": [
          {
            "id": "ff7f5b8b-61ad-4b79-8b92-321304c925bc",
            "quantity": 1,
            "product": {
              "id": "83669e6b-3a4c-4b35-8286-afeeb618b45a",
              "name": "Cookies",
              "brand": {
                "id": "b542e28a-66e8-41f9-ac77-62f05f0fd418",
                "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": "15556371626@test.ongoody.com"
      },
      "workspace_id": "5a020532-1ff0-422d-b830-90b3defe6898",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "ROJMLBWKWFPYOVVXN9PI31G4",
      "payment_link": null
    },
    {
      "id": "ea9150f5-a2a5-4516-a118-e4e62b7a764d",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/TPYDYAEUHNIJGRGZRXUSF2G2",
      "recipient_first_name": "Michael",
      "recipient_last_name": "Franci",
      "recipient_email": "michael@ongoody.com",
      "card_id": "7ae97dd1-93ac-4989-84e0-b4feac1cba74",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "1381198c-50d8-47f1-9965-65395b33b829",
      "expires_at": null,
      "cart": {
        "id": "aee5e64f-6f61-49d4-9f96-525b783ae409",
        "items": [
          {
            "id": "ff7f5b8b-61ad-4b79-8b92-321304c925bc",
            "quantity": 1,
            "product": {
              "id": "83669e6b-3a4c-4b35-8286-afeeb618b45a",
              "name": "Cookies",
              "brand": {
                "id": "b542e28a-66e8-41f9-ac77-62f05f0fd418",
                "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": "15556371626@test.ongoody.com"
      },
      "workspace_id": "5a020532-1ff0-422d-b830-90b3defe6898",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "4SJS08TPSE5JXHSFGCGGOWRJ",
      "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

The response is of type object.