POST /api/orders/order-cancel-request HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "description": "Please cancel this item.",
  "orderProductId": 1,
  "reasonId": 2
}

{
  "status": 1,
  "message": "Order cancel request submitted successfully."
}

Order cancellation

Create a cancellation request for an order product.

Authentication: Customer bearer token required.

Feature area: Orders

Implementation source: src/api/store/controllers/CustomerOrderController.ts

Request example provenance: Source request fields; response message may differ based on handler result.

Response example provenance: Source request fields; response message may differ based on handler result.

Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.

POST

api

orders

order-cancel-request

POST /api/orders/order-cancel-request HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "description": "Please cancel this item.",
  "orderProductId": 1,
  "reasonId": 2
}

{
  "status": 1,
  "message": "Order cancel request submitted successfully."
}

Authorizations

Authorization

string

header

required

Paste the JWT access token returned by the corresponding login endpoint.

Body

application/json

Sample request body. Source request fields; response message may differ based on handler result.

description

string

orderProductId

integer

reasonId

integer

Response

200 - application/json

Successful response. Source request fields; response message may differ based on handler result.

status

integer

message

string

Store API

Vendor API

Create a cancellation request for an order product.

Authorizations

Body

Response