POST
/
v1
/
orders
/
{id}
/
cancel
curl --request POST \
  --url https://api.ongoody.com/v1/orders/{id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "id": "5801675e-6ca7-4ceb-9af5-e66c8e6e1bdd",
  "status": "failed",
  "individual_gift_link": "https://gifts.ongoody.com/gift/QFFBPKRVLG0UQATYL76CQTYE",
  "recipient_first_name": "Michael",
  "recipient_last_name": "Franci",
  "recipient_email": "michael@ongoody.com",
  "card_id": "7f4ca806-449a-4884-865b-ece0db0a144e",
  "message": "Test Message",
  "thank_you_note": null,
  "view_count_recipient": 0,
  "is_swapped": false,
  "order_batch_id": "a50962f3-cd78-4788-a09a-3765dcd58546",
  "expires_at": null,
  "cart": {
    "id": "da562559-b55c-484a-bae3-5bf4ec47ff4f",
    "items": [
      {
        "id": "1ba8a905-fe2f-4721-94e4-4d1035a41049",
        "quantity": 1,
        "product": {
          "id": "adceb9b4-4eff-47f7-acda-afcee562d2e7",
          "name": "Cookies",
          "brand": {
            "id": "46c4f6f8-5423-4d57-a19c-929d889a1cf4",
            "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": "15555357125@test.ongoody.com"
  },
  "workspace_id": "be4a885d-3cde-4e16-a7f5-730639a94cfa",
  "workspace_name": "Test Team",
  "original_cart": null,
  "original_amounts": null,
  "reference_id": "BEUUD9WDRPUTQRUTOTX0NBZQ",
  "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.