GET
/
v1
/
order_batches
/
{id}
curl --request GET \
  --url https://api.ongoody.com/v1/order_batches/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "fc279b29-b063-408b-aedd-53aeed6a9ebf",
  "send_status": "complete",
  "from_name": "Reuben",
  "message": null,
  "orders_count": 2,
  "orders_preview": [
    {
      "id": "86004eab-be24-4a68-904d-a5749070df8b",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/TRE0GOZ98PZUEITSPDNH8MDN",
      "recipient_first_name": "Alena",
      "recipient_last_name": "Kenter",
      "recipient_email": "alena@ongoody.com",
      "card_id": "501d2557-6434-4885-ac74-780f5aa14749",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "fc279b29-b063-408b-aedd-53aeed6a9ebf",
      "expires_at": null,
      "cart": {
        "id": "b6122489-0327-46b3-bacd-82e597d0f10d",
        "items": [
          {
            "id": "edbac911-aa70-41ee-bfa6-fd1b7ac82083",
            "quantity": 1,
            "product": {
              "id": "db30816c-e72d-42b7-9b29-44a287c51fd3",
              "name": "Cookies",
              "brand": {
                "id": "3932d90f-fe34-40dd-992c-8bc0e13aa838",
                "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": "15558773688@test.ongoody.com"
      },
      "workspace_id": "59fa0115-1a09-4f4a-996a-293309601cfe",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "LOKB2XS6QOMUSML6RYSQW1RB",
      "payment_link": null
    },
    {
      "id": "81b57223-b7f6-4046-acbb-dd52019fa986",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/OAW7IQLDVV6GZXUHG58L7BGK",
      "recipient_first_name": "Michael",
      "recipient_last_name": "Franci",
      "recipient_email": "michael@ongoody.com",
      "card_id": "501d2557-6434-4885-ac74-780f5aa14749",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "fc279b29-b063-408b-aedd-53aeed6a9ebf",
      "expires_at": null,
      "cart": {
        "id": "b6122489-0327-46b3-bacd-82e597d0f10d",
        "items": [
          {
            "id": "edbac911-aa70-41ee-bfa6-fd1b7ac82083",
            "quantity": 1,
            "product": {
              "id": "db30816c-e72d-42b7-9b29-44a287c51fd3",
              "name": "Cookies",
              "brand": {
                "id": "3932d90f-fe34-40dd-992c-8bc0e13aa838",
                "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": "15558773688@test.ongoody.com"
      },
      "workspace_id": "59fa0115-1a09-4f4a-996a-293309601cfe",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "YQCGA6GIQAZ8M8B3XYJDAWKH",
      "payment_link": null
    }
  ],
  "recipients_count": 2,
  "recipients_preview": [
    {
      "first_name": "Alena",
      "last_name": "Kenter",
      "email": "alena@ongoody.com"
    },
    {
      "first_name": "Michael",
      "last_name": "Franci",
      "email": "michael@ongoody.com"
    }
  ],
  "cart": {
    "id": "b6122489-0327-46b3-bacd-82e597d0f10d",
    "items": [
      {
        "id": "edbac911-aa70-41ee-bfa6-fd1b7ac82083",
        "quantity": 1,
        "product": {
          "id": "db30816c-e72d-42b7-9b29-44a287c51fd3",
          "name": "Cookies",
          "brand": {
            "id": "3932d90f-fe34-40dd-992c-8bc0e13aa838",
            "name": "Cookie Company"
          }
        }
      }
    ]
  },
  "is_scheduled_send": false,
  "scheduled_send_on": null,
  "expires_at": null,
  "send_method": null,
  "batch_name": "Thank You from Dibbert-Harvey",
  "card_id": "501d2557-6434-4885-ac74-780f5aa14749",
  "sender": {
    "first_name": "Test",
    "last_name": "User",
    "email": "15558773688@test.ongoody.com"
  },
  "workspace_id": "59fa0115-1a09-4f4a-996a-293309601cfe",
  "workspace_name": "Test Team",
  "reference_id": "7Y0KZ3JF3WT9HFJRPWQ8F6QS"
}

Authorizations

​
Authorization
string
header
required

Your Goody API key.

Path Parameters

​
id
string
required

Order batch ID

Response

200
application/json
Scheduled order batch retrieved

An order batch is the primary resource created by the API. Order batches contain an array of orders.