Skip to main content
GET
/
v1
/
orders
List orders
curl --request GET \
  --url https://api.ongoody.com/v1/orders \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "8d2563d0-9bf0-4d81-a86f-4b18fb266c52",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/Z8OGSTT8DARYN8BHVXPMRAYZ",
      "recipient_first_name": "Michael",
      "recipient_last_name": "Franci",
      "recipient_email": "[email protected]",
      "card_id": "b9df3c91-8761-4e60-aac1-683e078d0c8f",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "6850176d-2d5e-41a0-812f-f1d9ec08153c",
      "expires_at": null,
      "cart": {
        "id": "1630bb3f-9515-4a0f-b2f0-69ceda3b1140",
        "items": [
          {
            "id": "816abda7-5f61-48fe-96ae-69f1ff9d2039",
            "quantity": 1,
            "product": {
              "id": "3a12b2a7-207d-49ab-9f21-02e7891e36a3",
              "name": "Cookies",
              "brand": {
                "id": "9baf9fd7-f5a4-44ea-af0f-f14bd819f59c",
                "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": "f4f041f1-0f63-4662-9ac1-e7a45e24950c",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "KROGNEDQGEOZEN3QOUBCEGGZ",
      "payment_link": null
    },
    {
      "id": "6cd5d049-5ee8-4033-b678-936fd20899d2",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/ILE8UU0AHWAOZXEPAEEBZYJC",
      "recipient_first_name": "Alena",
      "recipient_last_name": "Kenter",
      "recipient_email": "[email protected]",
      "card_id": "b9df3c91-8761-4e60-aac1-683e078d0c8f",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "6850176d-2d5e-41a0-812f-f1d9ec08153c",
      "expires_at": null,
      "cart": {
        "id": "1630bb3f-9515-4a0f-b2f0-69ceda3b1140",
        "items": [
          {
            "id": "816abda7-5f61-48fe-96ae-69f1ff9d2039",
            "quantity": 1,
            "product": {
              "id": "3a12b2a7-207d-49ab-9f21-02e7891e36a3",
              "name": "Cookies",
              "brand": {
                "id": "9baf9fd7-f5a4-44ea-af0f-f14bd819f59c",
                "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": "f4f041f1-0f63-4662-9ac1-e7a45e24950c",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "NIM0LKU63ZXJQE6JYRYUZALI",
      "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
created_at[after]
string<date-time> | null

ISO 8601

created_at[before]
string<date-time> | null

ISO 8601

Response

200 - application/json

Orders retrieved

data
object[]
list_meta
object