Cancel

PUT{{api_url}}/shop/order/{{orderid}}/cancel

Cancels an order. The order stays in InfiPlex, flagged canceled. If the order came from a marketplace that InfiPlex sends cancellations to, InfiPlex also sends the cancellation to that marketplace.

The request takes no body and cancels the whole order.

Example

Cancel order 103521:

{{api_url}}/shop/order/103521/cancel

Response

{"orderid": "103521"}
FieldTypeDescription
orderidstringThe InfiPlex order ID that was canceled.

Before you build

  • orderid is the InfiPlex order ID (shop_orderid), not the marketplace order number. To find an order from its marketplace order number, use Order Search with text_search.
  • Confirm the order before calling. For marketplaces that receive cancellations, the cancellation goes to the marketplace, not just to InfiPlex.
  • Canceling does not change inventory. If the order's units should go back into stock, adjust them with Inventory Set or Inventory Set Bulk.
  • A canceled order shows is_canceled as 1 on Order Get, and Order Search finds canceled orders with is_canceled=1.
  • This is not the same as setting the canceled status with Update Status. That changes only the order's status label and is not sent to any marketplace.
  • Your API key needs Order write permission. A key without it gets 403 Forbidden.

Related guides:

Authorization

Bearer token, sent in the Authorization header. Inherited from the collection.

Headers

KeyValueDescription
Content-Typeapplication/json

Example Request

curl --location --request PUT '{{api_url}}/shop/order/{{orderid}}/cancel' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{auth_token}}'

Example Responses

Cancel

Request

curl --location --request PUT 'https://example.com/api/admin/shop/order/103521/cancel' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json'

Response 200 OK

{
    "orderid": "103521"
}