Order Batches
Payment Methods
Commerce User Payment Methods
Workspaces
Schemas
- Schemas
Orders
Retrieve an order
GET
/
v1
/
orders
/
{id}
Retrieve an order
Copy
Ask AI
curl --request GET \
--url https://api.ongoody.com/v1/orders/{id} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"id": "1d862e7b-6ca8-4480-a9c8-48e5970a5463",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/UXJJGYRA7YGNZ43KECV2DATR",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "00cdc35a-d331-4f79-94ef-29ae3444c695",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "9866dfa6-66ca-40d2-9bd2-2ddd0b926122",
"expires_at": null,
"cart": {
"id": "5caf251e-3935-4e2f-8885-87af9a2b88f9",
"items": [
{
"id": "8784b049-218b-409c-9f0d-6ba76742b00b",
"quantity": 1,
"product": {
"id": "f69bf60c-c3f8-4d31-815f-bf26209d61d6",
"name": "Cookies",
"brand": {
"id": "3fda9ed2-ee23-4c3d-9aa1-708f2e262197",
"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": "15555978403@test.ongoody.com"
},
"workspace_id": "362fe269-6ab0-4de8-a5d1-cdef192fa3c6",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "IUHDN3GWNB2ZNDP4UQYZB9NL",
"event_times": {
"created_at": "2025-05-18T05:07:37Z",
"notified_at": null,
"opened_at": null,
"accepted_at": null,
"thank_you_added_at": null,
"pending_payment_at": null,
"paid_at": null,
"shipped_at": null,
"delivered_at": null
},
"payment_link": null
}
Authorizations
Your Goody API key.
Path Parameters
id
Response
200
application/json
Order retrieved
An individual order contains the gift link to be sent to the recipient (if applicable) and other information about the order.
Retrieve an order
Copy
Ask AI
curl --request GET \
--url https://api.ongoody.com/v1/orders/{id} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"id": "1d862e7b-6ca8-4480-a9c8-48e5970a5463",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/UXJJGYRA7YGNZ43KECV2DATR",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "00cdc35a-d331-4f79-94ef-29ae3444c695",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "9866dfa6-66ca-40d2-9bd2-2ddd0b926122",
"expires_at": null,
"cart": {
"id": "5caf251e-3935-4e2f-8885-87af9a2b88f9",
"items": [
{
"id": "8784b049-218b-409c-9f0d-6ba76742b00b",
"quantity": 1,
"product": {
"id": "f69bf60c-c3f8-4d31-815f-bf26209d61d6",
"name": "Cookies",
"brand": {
"id": "3fda9ed2-ee23-4c3d-9aa1-708f2e262197",
"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": "15555978403@test.ongoody.com"
},
"workspace_id": "362fe269-6ab0-4de8-a5d1-cdef192fa3c6",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "IUHDN3GWNB2ZNDP4UQYZB9NL",
"event_times": {
"created_at": "2025-05-18T05:07:37Z",
"notified_at": null,
"opened_at": null,
"accepted_at": null,
"thank_you_added_at": null,
"pending_payment_at": null,
"paid_at": null,
"shipped_at": null,
"delivered_at": null
},
"payment_link": null
}
Assistant
Responses are generated using AI and may contain mistakes.