Skip to main content
POST
/
v1
/
pvt
/
POS
/
orders
/
{orderId}
/
cancel
This is shortcut for the original /orders/cancel endpoint for canceling orders.
curl --request POST \
  --url https://api.bonifiq.com.br/v1/pvt/POS/orders/{orderId}/cancel \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "OrderCancelledDate": "2023-11-07T05:31:56Z",
  "OrderStatus": "<string>"
}
'
{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "isCanceled": true,
    "UpdatedAt": "2023-11-07T05:31:56Z",
    "Status": 0
  },
  "HasError": true
}

Authorizations

Authorization
string
header
required

Use API Basic Auth Keys

Path Parameters

orderId
string
required

Body

application/json

Order cancel request body

OrderCancelledDate
string<date-time>

Date when the order has been cancel.

OrderStatus
string | null

Order status.

Response

200 - application/json
ErrorMessage
string | null

Error message or description

ErrorCode
integer<int32> | null

Optional error code, if available

Result
object
HasError
boolean

If true the request had an error.