Cancel order

What is it for?

Cancels an order. It can only be cancelled while the warehouse has not yet shipped it.

Conditions

  • Requires authentication.
  • Validations:
    The order MUST be in one of these statuses:
    • → To be confirmed
    • → Pending
    • → Ready to prepare
    • If the order is in PICKING, PACKING, PREPARED, SHIPPED or RETURNED:
    • Error: ORDER_CANNOT_BE_CANCELED (HTTP 400)
    • Message: "The order with ID {id} cannot be cancelled."

Parameters

Fill in the fields in Body Params, Query Params and/or Path Params as applicable.

Expected response

HTTP 204 → No content

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

How to obtain it: use List orders or the id returned when creating the order.

Responses
204

Order cancelled successfully (no content)

400

Invalid ID or malformed request

404

Order not found

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here!