WHwhatnot
Orders

Cancel an order

Cancel an order that hasn't been fulfilled, and return the order afterwards. Requires write:orders.

post/orders/{order_id}/cancel

Request

  • Base URL
    https://api.whatnot.com/seller-api/rest/v2
  • URL
    https://api.whatnot.com/seller-api/rest/v2/orders/{order_id}/cancel
  • Auth
    OAuth 2
    Authorization code: https://api.whatnot.com/seller-api/rest/oauth/authorize
    Token URL: https://api.whatnot.com/seller-api/rest/oauth/token

Path parameters

order_idstring required

The order's ID.

Request body

reason'item_damaged' | 'item_sold' | 'item_missing' | 'break_did_not_fill' | 'other' required

Response

Successful Response

idstring required

The order's ID.

urlstring nullable required

The url of the order in the seller's dashboard.

status'pending' | 'pending_fulfillment' | 'completed' | 'cancelled' | 'failed' required
show_idstring nullable required

The show the order was placed in; null for orders placed anywhere else.

transaction_type'buy_it_now' | 'auction' | 'giveaway' | 'other' required
created_atstring date-time nullable required

Creation timestamp, if recorded.

updated_atstring date-time nullable required

Last update timestamp, if recorded.

cancelled_atstring date-time nullable required

When the order was cancelled, if it was.

Example response

{
  "amounts": {
    "applied_discount": {
      "amount": {
        "amount": "2",
        "currency": "USD"
      },
      "type": "fixed_price"
    },
    "shipping": {
      "amount": "5.99",
      "currency": "USD"
    },
    "subtotal": {
      "amount": "42",
      "currency": "USD"
    },
    "tax": {
      "amount": "3.78",
      "currency": "USD"
    },
    "total": {
      "amount": "49.77",
      "currency": "USD"
    }
  },
  "buyer": {
    "display_name": "Card Collector",
    "id": "6789",
    "username": "cardcollector"
  },
  "created_at": "2026-09-21T12:00:00.000Z",
  "id": "123456",
  "show_id": "0b6f3c1e-8a52-4d2e-9f7a-3c5d1e2f4a6b",
  "status": "pending_fulfillment",
  "transaction_type": "auction",
  "updated_at": "2026-09-21T13:00:00.000Z",
  "url": "https://www.whatnot.com/dashboard/orders/5f0c2b7e-1d3a-4c6b-9e8f-7a6b5c4d3e2f"
}

Changes

No recorded changes to this operation across all 1 revision of this API.