GET
/
v1
/
order_batches
/
{id}
curl --request GET \
  --url https://api.ongoody.com/v1/order_batches/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "c97583e0-8305-40f7-9e23-973a92c64581",
  "send_status": "complete",
  "from_name": "Herlinda",
  "message": null,
  "orders_count": 2,
  "orders_preview": [
    {
      "id": "33febcbf-6bed-4902-a077-263d66176964",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/N8ANGSC5GMDAZXLZKBLLUUDQ",
      "recipient_first_name": "Alena",
      "recipient_last_name": "Kenter",
      "recipient_email": "alena@ongoody.com",
      "card_id": "4cb1ac24-f238-49ef-a537-0196fc2757d2",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "c97583e0-8305-40f7-9e23-973a92c64581",
      "expires_at": null,
      "cart": {
        "id": "afaec8ae-66fc-41ea-b4a0-e0fa9985213b",
        "items": [
          {
            "id": "d11f394b-9e71-495d-8d1e-cf2f734cf78c",
            "quantity": 1,
            "product": {
              "id": "b3a0ac83-05dd-45fc-94a4-b66e9debe27d",
              "name": "Cookies",
              "brand": {
                "id": "28d2e9ef-0503-4715-9e70-5e2e91c0f752",
                "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": "15556935707@test.ongoody.com"
      },
      "workspace_id": "6b55a6d4-5c6f-4715-84a8-adfbfc25ff56",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "WXTAQ0MHMY8RICJU9XARHB4B",
      "payment_link": null
    },
    {
      "id": "e5603128-f4c7-43fb-9448-3dbedec6120d",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/RBJWQDAR4FZ7DEFXD8YWWOXQ",
      "recipient_first_name": "Michael",
      "recipient_last_name": "Franci",
      "recipient_email": "michael@ongoody.com",
      "card_id": "4cb1ac24-f238-49ef-a537-0196fc2757d2",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "c97583e0-8305-40f7-9e23-973a92c64581",
      "expires_at": null,
      "cart": {
        "id": "afaec8ae-66fc-41ea-b4a0-e0fa9985213b",
        "items": [
          {
            "id": "d11f394b-9e71-495d-8d1e-cf2f734cf78c",
            "quantity": 1,
            "product": {
              "id": "b3a0ac83-05dd-45fc-94a4-b66e9debe27d",
              "name": "Cookies",
              "brand": {
                "id": "28d2e9ef-0503-4715-9e70-5e2e91c0f752",
                "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": "15556935707@test.ongoody.com"
      },
      "workspace_id": "6b55a6d4-5c6f-4715-84a8-adfbfc25ff56",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "YIOTWKAL7ZFLTDSMENCAQRYG",
      "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": "afaec8ae-66fc-41ea-b4a0-e0fa9985213b",
    "items": [
      {
        "id": "d11f394b-9e71-495d-8d1e-cf2f734cf78c",
        "quantity": 1,
        "product": {
          "id": "b3a0ac83-05dd-45fc-94a4-b66e9debe27d",
          "name": "Cookies",
          "brand": {
            "id": "28d2e9ef-0503-4715-9e70-5e2e91c0f752",
            "name": "Cookie Company"
          }
        }
      }
    ]
  },
  "is_scheduled_send": false,
  "scheduled_send_on": null,
  "expires_at": null,
  "send_method": null,
  "batch_name": "Thank You from Kihn, Schultz and Price",
  "card_id": "4cb1ac24-f238-49ef-a537-0196fc2757d2",
  "sender": {
    "first_name": "Test",
    "last_name": "User",
    "email": "15556935707@test.ongoody.com"
  },
  "workspace_id": "6b55a6d4-5c6f-4715-84a8-adfbfc25ff56",
  "workspace_name": "Test Team",
  "reference_id": "VREUYCVOI3AEJSPOKIX5OR0I"
}

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.