Skip to main content
GET
/
v1
/
order_batches
List order batches
curl --request GET \
  --url https://api.ongoody.com/v1/order_batches \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "eca6809f-fe0b-4749-89ef-6dae4fac5973",
      "send_status": "complete",
      "from_name": "Pearline",
      "message": null,
      "orders_count": 2,
      "orders_preview": [
        {
          "id": "c5fdafbd-14fa-4525-b867-c4d91ce8535c",
          "status": "created",
          "individual_gift_link": "https://gifts.ongoody.com/gift/PV51LE2TUFETHLLD6BHVRA7Z",
          "recipient_first_name": "Alena",
          "recipient_last_name": "Kenter",
          "recipient_email": "[email protected]",
          "card_id": "398b24e4-b325-45bb-8ac9-d9ed6dce8f7c",
          "message": "Test Message",
          "thank_you_note": null,
          "view_count_recipient": 0,
          "is_swapped": false,
          "order_batch_id": "eca6809f-fe0b-4749-89ef-6dae4fac5973",
          "expires_at": null,
          "cart": {
            "id": "9a36cffc-dc1b-4199-a3ee-85e78e118670",
            "items": [
              {
                "id": "09bd3a63-e073-4b6d-b600-6a4f85f3813b",
                "quantity": 1,
                "product": {
                  "id": "390b746d-de3d-4186-9d8f-599bec542484",
                  "name": "Cookies",
                  "brand": {
                    "id": "e0c1cb6a-1a39-4a84-826b-b02e433af5fd",
                    "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": "[email protected]"
          },
          "workspace_id": "cadbbf70-a777-416d-9263-46db33ac099b",
          "workspace_name": "Test Team",
          "original_cart": null,
          "original_amounts": null,
          "reference_id": "1FZ1QACKPALZYZQQH40SPSGT",
          "payment_link": null
        },
        {
          "id": "6f6b8c9a-f815-438c-a4fc-541dcd9b5eea",
          "status": "created",
          "individual_gift_link": "https://gifts.ongoody.com/gift/1DBDVONEFVS6RKWZSOBU4CIA",
          "recipient_first_name": "Michael",
          "recipient_last_name": "Franci",
          "recipient_email": "[email protected]",
          "card_id": "398b24e4-b325-45bb-8ac9-d9ed6dce8f7c",
          "message": "Test Message",
          "thank_you_note": null,
          "view_count_recipient": 0,
          "is_swapped": false,
          "order_batch_id": "eca6809f-fe0b-4749-89ef-6dae4fac5973",
          "expires_at": null,
          "cart": {
            "id": "9a36cffc-dc1b-4199-a3ee-85e78e118670",
            "items": [
              {
                "id": "09bd3a63-e073-4b6d-b600-6a4f85f3813b",
                "quantity": 1,
                "product": {
                  "id": "390b746d-de3d-4186-9d8f-599bec542484",
                  "name": "Cookies",
                  "brand": {
                    "id": "e0c1cb6a-1a39-4a84-826b-b02e433af5fd",
                    "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": "[email protected]"
          },
          "workspace_id": "cadbbf70-a777-416d-9263-46db33ac099b",
          "workspace_name": "Test Team",
          "original_cart": null,
          "original_amounts": null,
          "reference_id": "3DSXD1ZTPQXHZ6S9ETGNKZFN",
          "payment_link": null
        }
      ],
      "recipients_count": 2,
      "recipients_preview": [
        {
          "first_name": "Alena",
          "last_name": "Kenter",
          "email": "[email protected]"
        },
        {
          "first_name": "Michael",
          "last_name": "Franci",
          "email": "[email protected]"
        }
      ],
      "cart": {
        "id": "9a36cffc-dc1b-4199-a3ee-85e78e118670",
        "items": [
          {
            "id": "09bd3a63-e073-4b6d-b600-6a4f85f3813b",
            "quantity": 1,
            "product": {
              "id": "390b746d-de3d-4186-9d8f-599bec542484",
              "name": "Cookies",
              "brand": {
                "id": "e0c1cb6a-1a39-4a84-826b-b02e433af5fd",
                "name": "Cookie Company"
              }
            }
          }
        ]
      },
      "is_scheduled_send": false,
      "scheduled_send_on": null,
      "expires_at": null,
      "send_method": null,
      "batch_name": "Thank You from Skiles-Baumbach",
      "card_id": "398b24e4-b325-45bb-8ac9-d9ed6dce8f7c",
      "sender": {
        "first_name": "Test",
        "last_name": "User",
        "email": "[email protected]"
      },
      "workspace_id": "cadbbf70-a777-416d-9263-46db33ac099b",
      "workspace_name": "Test Team",
      "reference_id": "Q4GDSKRZHOGD6208HP9XXGEC"
    },
    {
      "id": "5b63a43c-84d4-4afe-929f-6cac3a70f659",
      "send_status": "complete",
      "from_name": "Mimi",
      "message": null,
      "orders_count": 2,
      "orders_preview": [
        {
          "id": "29289827-d103-4671-b2e7-8d439a34319d",
          "status": "created",
          "individual_gift_link": "https://gifts.ongoody.com/gift/1N9CIDM2NVUJ2CWMC4PERJT0",
          "recipient_first_name": "Alena",
          "recipient_last_name": "Kenter",
          "recipient_email": "[email protected]",
          "card_id": "398b24e4-b325-45bb-8ac9-d9ed6dce8f7c",
          "message": "Test Message",
          "thank_you_note": null,
          "view_count_recipient": 0,
          "is_swapped": false,
          "order_batch_id": "5b63a43c-84d4-4afe-929f-6cac3a70f659",
          "expires_at": null,
          "cart": {
            "id": "fda4a859-7116-4cfe-ad03-ecb062ef1290",
            "items": [
              {
                "id": "837f54d2-ecfb-4d26-8699-0ce5c29b3e9c",
                "quantity": 1,
                "product": {
                  "id": "4577cb62-d1bf-4c1e-8ac7-6f8205cf9717",
                  "name": "Cookies",
                  "brand": {
                    "id": "e0c1cb6a-1a39-4a84-826b-b02e433af5fd",
                    "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": "[email protected]"
          },
          "workspace_id": "cadbbf70-a777-416d-9263-46db33ac099b",
          "workspace_name": "Test Team",
          "original_cart": null,
          "original_amounts": null,
          "reference_id": "POBABW8QKQ3WZEM6MZMYPNLB",
          "payment_link": null
        },
        {
          "id": "97a67069-bac2-47a4-bd8d-44e9581ea963",
          "status": "created",
          "individual_gift_link": "https://gifts.ongoody.com/gift/BIL8FQGCIURIMJAOYMCKHNCG",
          "recipient_first_name": "Michael",
          "recipient_last_name": "Franci",
          "recipient_email": "[email protected]",
          "card_id": "398b24e4-b325-45bb-8ac9-d9ed6dce8f7c",
          "message": "Test Message",
          "thank_you_note": null,
          "view_count_recipient": 0,
          "is_swapped": false,
          "order_batch_id": "5b63a43c-84d4-4afe-929f-6cac3a70f659",
          "expires_at": null,
          "cart": {
            "id": "fda4a859-7116-4cfe-ad03-ecb062ef1290",
            "items": [
              {
                "id": "837f54d2-ecfb-4d26-8699-0ce5c29b3e9c",
                "quantity": 1,
                "product": {
                  "id": "4577cb62-d1bf-4c1e-8ac7-6f8205cf9717",
                  "name": "Cookies",
                  "brand": {
                    "id": "e0c1cb6a-1a39-4a84-826b-b02e433af5fd",
                    "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": "[email protected]"
          },
          "workspace_id": "cadbbf70-a777-416d-9263-46db33ac099b",
          "workspace_name": "Test Team",
          "original_cart": null,
          "original_amounts": null,
          "reference_id": "HVCH6WC3GIK9Q4G2R4EW7D7Q",
          "payment_link": null
        }
      ],
      "recipients_count": 2,
      "recipients_preview": [
        {
          "first_name": "Alena",
          "last_name": "Kenter",
          "email": "[email protected]"
        },
        {
          "first_name": "Michael",
          "last_name": "Franci",
          "email": "[email protected]"
        }
      ],
      "cart": {
        "id": "fda4a859-7116-4cfe-ad03-ecb062ef1290",
        "items": [
          {
            "id": "837f54d2-ecfb-4d26-8699-0ce5c29b3e9c",
            "quantity": 1,
            "product": {
              "id": "4577cb62-d1bf-4c1e-8ac7-6f8205cf9717",
              "name": "Cookies",
              "brand": {
                "id": "e0c1cb6a-1a39-4a84-826b-b02e433af5fd",
                "name": "Cookie Company"
              }
            }
          }
        ]
      },
      "is_scheduled_send": false,
      "scheduled_send_on": null,
      "expires_at": null,
      "send_method": null,
      "batch_name": "Thank You from Thompson, Mohr and Welch",
      "card_id": "398b24e4-b325-45bb-8ac9-d9ed6dce8f7c",
      "sender": {
        "first_name": "Test",
        "last_name": "User",
        "email": "[email protected]"
      },
      "workspace_id": "cadbbf70-a777-416d-9263-46db33ac099b",
      "workspace_name": "Test Team",
      "reference_id": "QXJAIL02QJ5AMTO3HFWZOUZQ"
    }
  ],
  "list_meta": {
    "total_count": 2
  }
}

Authorizations

Authorization
string
header
required

Your Goody API key.

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

Order batches retrieved

data
object[]
list_meta
object