GET
/
v1
/
orders
curl --request GET \
  --url https://api.ongoody.com/v1/orders \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "6dfdb010-945f-4260-bbe3-bd0ff21d5598",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/V2DYHIARVTLFZIFTZTDVDOYF",
      "recipient_first_name": "Michael",
      "recipient_last_name": "Franci",
      "recipient_email": "michael@ongoody.com",
      "card_id": "cfe3810b-e277-4ace-ae6c-809e80f7ad74",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "f3ab0916-cd20-496e-a39b-25a27a28850c",
      "expires_at": null,
      "cart": {
        "id": "255d1a42-b103-47ce-893e-5432984c8a7d",
        "items": [
          {
            "id": "a34f9e16-66ef-4430-b3a3-2c64dc670ca2",
            "quantity": 1,
            "product": {
              "id": "0468017c-5704-4ae4-a3c9-c342cd959aa6",
              "name": "Cookies",
              "brand": {
                "id": "4afb210d-de93-4a27-b139-16ef71364d27",
                "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": "15554828287@test.ongoody.com"
      },
      "workspace_id": "6b8e507f-eba5-49c1-99d7-bd8b717000e3",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "TCBGZDXNU4BUIV4JXBGR2CZP",
      "payment_link": null
    },
    {
      "id": "c9566a11-84cf-4bad-8a05-0f97af2c5af7",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/XVWDAMO6UUSLWEHEFTH4BDDV",
      "recipient_first_name": "Alena",
      "recipient_last_name": "Kenter",
      "recipient_email": "alena@ongoody.com",
      "card_id": "cfe3810b-e277-4ace-ae6c-809e80f7ad74",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "f3ab0916-cd20-496e-a39b-25a27a28850c",
      "expires_at": null,
      "cart": {
        "id": "255d1a42-b103-47ce-893e-5432984c8a7d",
        "items": [
          {
            "id": "a34f9e16-66ef-4430-b3a3-2c64dc670ca2",
            "quantity": 1,
            "product": {
              "id": "0468017c-5704-4ae4-a3c9-c342cd959aa6",
              "name": "Cookies",
              "brand": {
                "id": "4afb210d-de93-4a27-b139-16ef71364d27",
                "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": "15554828287@test.ongoody.com"
      },
      "workspace_id": "6b8e507f-eba5-49c1-99d7-bd8b717000e3",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "DABR7WFZPOQHEGY3HRHMYMZF",
      "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

The response is of type object.