Orders
Retrieve an order
Orders
Retrieve an order
GET
/
v1
/
orders
/
{id}
curl --request GET \
--url https://api.ongoody.com/v1/orders/{id} \
--header 'Authorization: Bearer <token>'
{
"id": "2ef0c33d-c8cd-4967-8189-43a49b803659",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/KP6XB0LZKL3GN2IKNSRFTVSQ",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "c8b6c76d-41ae-4fbf-9231-9a4ca6367371",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "e7f73598-77bb-4412-9f31-6754f5cd28fd",
"expires_at": null,
"cart": {
"id": "9fa2a4a5-5e0f-4ec3-99c6-17a43b0551d5",
"items": [
{
"id": "e78b5541-b47c-4503-a70e-cef3928f2b62",
"quantity": 1,
"product": {
"id": "58f560cf-0a61-40ac-9e44-323e34c812f2",
"name": "Cookies",
"brand": {
"id": "34736c3f-27c0-4db4-a843-94aa7d7c971d",
"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": "15552568525@test.ongoody.com"
},
"workspace_id": "5603ea1d-b7dc-4ea6-8c5d-1c2369724f01",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "I6JOVLRFPP2CGTRRPJ6JQPEN",
"event_times": {
"created_at": "2025-01-21T19:20:53Z",
"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.
curl --request GET \
--url https://api.ongoody.com/v1/orders/{id} \
--header 'Authorization: Bearer <token>'
{
"id": "2ef0c33d-c8cd-4967-8189-43a49b803659",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/KP6XB0LZKL3GN2IKNSRFTVSQ",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "c8b6c76d-41ae-4fbf-9231-9a4ca6367371",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "e7f73598-77bb-4412-9f31-6754f5cd28fd",
"expires_at": null,
"cart": {
"id": "9fa2a4a5-5e0f-4ec3-99c6-17a43b0551d5",
"items": [
{
"id": "e78b5541-b47c-4503-a70e-cef3928f2b62",
"quantity": 1,
"product": {
"id": "58f560cf-0a61-40ac-9e44-323e34c812f2",
"name": "Cookies",
"brand": {
"id": "34736c3f-27c0-4db4-a843-94aa7d7c971d",
"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": "15552568525@test.ongoody.com"
},
"workspace_id": "5603ea1d-b7dc-4ea6-8c5d-1c2369724f01",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "I6JOVLRFPP2CGTRRPJ6JQPEN",
"event_times": {
"created_at": "2025-01-21T19:20:53Z",
"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
}