POST
/
v1
/
orders
/
{id}
/
cancel
curl --request POST \
  --url https://api.ongoody.com/v1/orders/{id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "id": "0f551406-56be-468c-842a-e512a5cf8993",
  "status": "failed",
  "individual_gift_link": "https://gifts.ongoody.com/gift/KOKDCDG0CJR7L7NKG2OH29EY",
  "recipient_first_name": "Alena",
  "recipient_last_name": "Kenter",
  "recipient_email": "alena@ongoody.com",
  "card_id": "3ce0b4f1-1216-4afe-8701-ee8dbfe8251a",
  "message": "Test Message",
  "thank_you_note": null,
  "view_count_recipient": 0,
  "is_swapped": false,
  "order_batch_id": "adc154c5-d3f9-4e57-b7fd-c3b769f9289a",
  "expires_at": null,
  "cart": {
    "id": "8c3f994a-4317-4d9a-b499-ed10a440e011",
    "items": [
      {
        "id": "33d79407-c9d4-496e-aff4-dda0ee0b86f7",
        "quantity": 1,
        "product": {
          "id": "d331e2a0-2f2a-4d7f-b29b-a29c3c3051cd",
          "name": "Cookies",
          "brand": {
            "id": "d1d0df9a-9eab-4409-8d47-be632451af22",
            "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": "15552839974@test.ongoody.com"
  },
  "workspace_id": "3075861c-6678-4cc1-95e2-37dd1f24cf6e",
  "workspace_name": "Test Team",
  "original_cart": null,
  "original_amounts": null,
  "reference_id": "SAVWCIEL10ROW00L9UEJ6HKI",
  "payment_link": null
}

Authorizations

​
Authorization
string
header
required

Your Goody API key.

Path Parameters

​
id
string
required

id

Response

200
application/json

Order canceled

An individual order contains the gift link to be sent to the recipient (if applicable) and other information about the order.