GET
/
v1
/
orders
List orders
curl --request GET \
  --url https://api.ongoody.com/v1/orders \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "7a30350d-bb00-4abe-aaa8-89fab3dd40a9",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/BTPVSMSRABEAPK7HAV9AOTVO",
      "recipient_first_name": "Michael",
      "recipient_last_name": "Franci",
      "recipient_email": "michael@ongoody.com",
      "card_id": "b77c620a-564a-49bb-9d4a-f9a71cb36924",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "66992fdc-0039-42fd-9d45-9313354e79b9",
      "expires_at": null,
      "cart": {
        "id": "24383eb4-4796-40b9-91c3-2ba887106e89",
        "items": [
          {
            "id": "b80e0017-2552-40a2-bf56-e4d4da02419a",
            "quantity": 1,
            "product": {
              "id": "a74a466c-6093-4bfb-bdd9-3ab3e7d64884",
              "name": "Cookies",
              "brand": {
                "id": "6fd32c73-2629-4748-9c86-adf0153e7f31",
                "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": "15558013508@test.ongoody.com"
      },
      "workspace_id": "f4d7e51a-1b9c-46f3-bb09-21e460a61c98",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "UUGLAABIHEP1EZDTTODRX7Q6",
      "payment_link": null
    },
    {
      "id": "58c0e4ec-4573-45f0-806a-bdc36d27bdb9",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/QDDGA4LRP7AKSH0GYCH75GTU",
      "recipient_first_name": "Alena",
      "recipient_last_name": "Kenter",
      "recipient_email": "alena@ongoody.com",
      "card_id": "b77c620a-564a-49bb-9d4a-f9a71cb36924",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "66992fdc-0039-42fd-9d45-9313354e79b9",
      "expires_at": null,
      "cart": {
        "id": "24383eb4-4796-40b9-91c3-2ba887106e89",
        "items": [
          {
            "id": "b80e0017-2552-40a2-bf56-e4d4da02419a",
            "quantity": 1,
            "product": {
              "id": "a74a466c-6093-4bfb-bdd9-3ab3e7d64884",
              "name": "Cookies",
              "brand": {
                "id": "6fd32c73-2629-4748-9c86-adf0153e7f31",
                "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": "15558013508@test.ongoody.com"
      },
      "workspace_id": "f4d7e51a-1b9c-46f3-bb09-21e460a61c98",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "ST1ANZDAFJZOGPJ2PAZA2FT3",
      "payment_link": null
    }
  ],
  "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

Orders retrieved

data
object[]
list_meta
object