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": "32d9a04c-7618-4fa3-a9b5-ff9c08e0bc6a",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/ISKLCGT0JJY7AQZH9F8MLV3R",
      "recipient_first_name": "Michael",
      "recipient_last_name": "Franci",
      "recipient_email": "michael@ongoody.com",
      "card_id": "8abe0ca4-c6bb-4989-bfa0-384a86c85563",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "afc0d17e-ce8f-489b-a77d-a2f340799f56",
      "expires_at": null,
      "cart": {
        "id": "51763799-f3ae-48f5-82e4-c7cc53bd47a9",
        "items": [
          {
            "id": "425c2efa-5ffb-4a58-ac5b-43ae9b5408b7",
            "quantity": 1,
            "product": {
              "id": "69f2ec90-97d6-4f72-97ce-283eb6b4daa0",
              "name": "Cookies",
              "brand": {
                "id": "d60325e7-edde-4ba5-9537-035ebd6857da",
                "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": "15554712565@test.ongoody.com"
      },
      "workspace_id": "bfd6471c-86a9-445b-a1f6-d59cceec5369",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "A5PKGLOJNTORFEQYTK2GKF9C",
      "payment_link": null
    },
    {
      "id": "be567857-7ae1-4857-a12a-6e59c6df9d23",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/CDCZESKY1IY4LPZZN0DJRYID",
      "recipient_first_name": "Alena",
      "recipient_last_name": "Kenter",
      "recipient_email": "alena@ongoody.com",
      "card_id": "8abe0ca4-c6bb-4989-bfa0-384a86c85563",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "afc0d17e-ce8f-489b-a77d-a2f340799f56",
      "expires_at": null,
      "cart": {
        "id": "51763799-f3ae-48f5-82e4-c7cc53bd47a9",
        "items": [
          {
            "id": "425c2efa-5ffb-4a58-ac5b-43ae9b5408b7",
            "quantity": 1,
            "product": {
              "id": "69f2ec90-97d6-4f72-97ce-283eb6b4daa0",
              "name": "Cookies",
              "brand": {
                "id": "d60325e7-edde-4ba5-9537-035ebd6857da",
                "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": "15554712565@test.ongoody.com"
      },
      "workspace_id": "bfd6471c-86a9-445b-a1f6-d59cceec5369",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "YBH6XQAKXVISYFC4HJF9D5GK",
      "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