Orders
List all orders
GET
/
v1
/
orders
List orders
curl --request GET \
--url https://api.ongoody.com/v1/orders \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "7a449dc9-8a31-4a90-abbd-19143552aa52",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/1FE9DWTJC4T85G8QN5SDB3LH",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "2d738268-5496-43e1-ad4d-cca8b7810fc3",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "9e3ede84-8280-479f-ac9b-9007bb45a23c",
"expires_at": null,
"cart": {
"id": "987e757c-8faa-42b2-8845-3f98794a7b5b",
"items": [
{
"id": "fdd90649-ed42-461f-8672-f9cc3f051bc9",
"quantity": 1,
"product": {
"id": "31de335c-3a0e-4dcf-807f-9f32e7ccc108",
"name": "Cookies",
"brand": {
"id": "46ab78f4-729a-4b31-9cbc-32266daedd04",
"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": "15552492933@test.ongoody.com"
},
"workspace_id": "01e3dd01-1967-4069-9edc-d6755de1b7f3",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "BTGGI5EEFNIHTGXXEJ16CDCJ",
"payment_link": null
},
{
"id": "d248f1c5-44e8-432b-8941-5a93f6eec845",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/JKVE5ZLZADLVN2GRUJUSARIW",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "2d738268-5496-43e1-ad4d-cca8b7810fc3",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "9e3ede84-8280-479f-ac9b-9007bb45a23c",
"expires_at": null,
"cart": {
"id": "987e757c-8faa-42b2-8845-3f98794a7b5b",
"items": [
{
"id": "fdd90649-ed42-461f-8672-f9cc3f051bc9",
"quantity": 1,
"product": {
"id": "31de335c-3a0e-4dcf-807f-9f32e7ccc108",
"name": "Cookies",
"brand": {
"id": "46ab78f4-729a-4b31-9cbc-32266daedd04",
"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": "15552492933@test.ongoody.com"
},
"workspace_id": "01e3dd01-1967-4069-9edc-d6755de1b7f3",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "4XLDWNOT1MFZROIUSJ8K84Y8",
"payment_link": null
}
],
"list_meta": {
"total_count": 2
}
}Authorizations
Your Goody API key.
Query Parameters
Page for pagination, starting at 1
Required range:
x >= 1Items per page for pagination
Required range:
1 <= x <= 100ISO 8601
ISO 8601
⌘I
List orders
curl --request GET \
--url https://api.ongoody.com/v1/orders \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "7a449dc9-8a31-4a90-abbd-19143552aa52",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/1FE9DWTJC4T85G8QN5SDB3LH",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "2d738268-5496-43e1-ad4d-cca8b7810fc3",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "9e3ede84-8280-479f-ac9b-9007bb45a23c",
"expires_at": null,
"cart": {
"id": "987e757c-8faa-42b2-8845-3f98794a7b5b",
"items": [
{
"id": "fdd90649-ed42-461f-8672-f9cc3f051bc9",
"quantity": 1,
"product": {
"id": "31de335c-3a0e-4dcf-807f-9f32e7ccc108",
"name": "Cookies",
"brand": {
"id": "46ab78f4-729a-4b31-9cbc-32266daedd04",
"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": "15552492933@test.ongoody.com"
},
"workspace_id": "01e3dd01-1967-4069-9edc-d6755de1b7f3",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "BTGGI5EEFNIHTGXXEJ16CDCJ",
"payment_link": null
},
{
"id": "d248f1c5-44e8-432b-8941-5a93f6eec845",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/JKVE5ZLZADLVN2GRUJUSARIW",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "2d738268-5496-43e1-ad4d-cca8b7810fc3",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "9e3ede84-8280-479f-ac9b-9007bb45a23c",
"expires_at": null,
"cart": {
"id": "987e757c-8faa-42b2-8845-3f98794a7b5b",
"items": [
{
"id": "fdd90649-ed42-461f-8672-f9cc3f051bc9",
"quantity": 1,
"product": {
"id": "31de335c-3a0e-4dcf-807f-9f32e7ccc108",
"name": "Cookies",
"brand": {
"id": "46ab78f4-729a-4b31-9cbc-32266daedd04",
"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": "15552492933@test.ongoody.com"
},
"workspace_id": "01e3dd01-1967-4069-9edc-d6755de1b7f3",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "4XLDWNOT1MFZROIUSJ8K84Y8",
"payment_link": null
}
],
"list_meta": {
"total_count": 2
}
}