Order Batches
Payment Methods
Commerce User Payment Methods
Workspaces
Schemas
- Schemas
Orders
List all orders
GET
/
v1
/
orders
curl --request GET \
--url https://api.ongoody.com/v1/orders \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "dad975b9-c1d6-46a0-979b-beeaae3259a3",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/O2B1FMDZGWSSCSI8WRV1TWCS",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "f9aa7ab2-83ba-4cba-bda8-98eb97760297",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "2b9a6bbc-8283-49a8-9c54-657d2ac4dd0d",
"expires_at": null,
"cart": {
"id": "2a48d079-c916-40c4-9fd1-8495071f3bd0",
"items": [
{
"id": "8a28b9f0-ca63-4c9f-b5b5-4f129c6b96ec",
"quantity": 1,
"product": {
"id": "3c633c95-ab15-4bd3-b2c5-40dc35c51a05",
"name": "Cookies",
"brand": {
"id": "2cc8b4fb-0a95-4a5c-b8c0-c10bc4b32cd0",
"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": "15553149993@test.ongoody.com"
},
"workspace_id": "e47194a9-a259-4189-8b2c-3661bb65a794",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "72AV3Q545KJKMUEZI5EI4S6Y",
"payment_link": null
},
{
"id": "9659c393-7ab5-4945-9f3b-892011015bd5",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/C48IQBQPTJDD739F94VLYZ18",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "f9aa7ab2-83ba-4cba-bda8-98eb97760297",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "2b9a6bbc-8283-49a8-9c54-657d2ac4dd0d",
"expires_at": null,
"cart": {
"id": "2a48d079-c916-40c4-9fd1-8495071f3bd0",
"items": [
{
"id": "8a28b9f0-ca63-4c9f-b5b5-4f129c6b96ec",
"quantity": 1,
"product": {
"id": "3c633c95-ab15-4bd3-b2c5-40dc35c51a05",
"name": "Cookies",
"brand": {
"id": "2cc8b4fb-0a95-4a5c-b8c0-c10bc4b32cd0",
"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": "15553149993@test.ongoody.com"
},
"workspace_id": "e47194a9-a259-4189-8b2c-3661bb65a794",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "UGEVVBYCNWHDU8ZWHMG7CWEH",
"payment_link": null
}
],
"list_meta": {
"total_count": 2
}
}
Authorizations
Your Goody API key.
Query Parameters
Page for pagination, starting at 1
Required range:
x >= 1
Items per page for pagination
Required range:
1 <= x <= 100
Response
200 - application/json
Orders retrieved
The response is of type object
.
curl --request GET \
--url https://api.ongoody.com/v1/orders \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "dad975b9-c1d6-46a0-979b-beeaae3259a3",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/O2B1FMDZGWSSCSI8WRV1TWCS",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "f9aa7ab2-83ba-4cba-bda8-98eb97760297",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "2b9a6bbc-8283-49a8-9c54-657d2ac4dd0d",
"expires_at": null,
"cart": {
"id": "2a48d079-c916-40c4-9fd1-8495071f3bd0",
"items": [
{
"id": "8a28b9f0-ca63-4c9f-b5b5-4f129c6b96ec",
"quantity": 1,
"product": {
"id": "3c633c95-ab15-4bd3-b2c5-40dc35c51a05",
"name": "Cookies",
"brand": {
"id": "2cc8b4fb-0a95-4a5c-b8c0-c10bc4b32cd0",
"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": "15553149993@test.ongoody.com"
},
"workspace_id": "e47194a9-a259-4189-8b2c-3661bb65a794",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "72AV3Q545KJKMUEZI5EI4S6Y",
"payment_link": null
},
{
"id": "9659c393-7ab5-4945-9f3b-892011015bd5",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/C48IQBQPTJDD739F94VLYZ18",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "f9aa7ab2-83ba-4cba-bda8-98eb97760297",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "2b9a6bbc-8283-49a8-9c54-657d2ac4dd0d",
"expires_at": null,
"cart": {
"id": "2a48d079-c916-40c4-9fd1-8495071f3bd0",
"items": [
{
"id": "8a28b9f0-ca63-4c9f-b5b5-4f129c6b96ec",
"quantity": 1,
"product": {
"id": "3c633c95-ab15-4bd3-b2c5-40dc35c51a05",
"name": "Cookies",
"brand": {
"id": "2cc8b4fb-0a95-4a5c-b8c0-c10bc4b32cd0",
"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": "15553149993@test.ongoody.com"
},
"workspace_id": "e47194a9-a259-4189-8b2c-3661bb65a794",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "UGEVVBYCNWHDU8ZWHMG7CWEH",
"payment_link": null
}
],
"list_meta": {
"total_count": 2
}
}
Assistant
Responses are generated using AI and may contain mistakes.