Cancel

This endpoint cancels an order, indicating that the customer no longer wants the product that was initially ordered.

Payload `authenticated`

CancelPayload

number

required

The id of the order to be canceled.

Success

Error

order.cancel.success

status

enum<string>

required

Response number

Allowed values:

200201202

success

string

required

Response flag

The cancel() method receives the id of the order to be cancelled when the developer simply calls it.

This endpoint may trigger two events, the onCanceled and onNotCanceled events.

This event is triggered when cancelling an order process is done without having any errors coming back from the backend.

This event is triggered when cancelling an order process is not completed and an error has occurred.