Orders

Cancel before it reaches a supplier

Pulls an order back and refunds it in full, in the same statement. Orders are batched to suppliers each morning, so this is the window in which a mistake is cheaply reversible. Requires the order scope.

post/v1/orders/{order_id}/cancel

Request

  • Base URL: https://api.placementapi.com
  • URL: https://api.placementapi.com/v1/orders/{order_id}/cancel
  • Auth: HTTP bearer

Path parameters

order_idstring required

Response

OK

order_idstring
status'cancelled'
credits_returnedinteger

Changes

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