Cancel an order

Cancel an order by updating it

Request

UAT URL

PUT https://api-uat.staging.nexway.build/connect/order/cancel

Production URL

PUT https://api.nexway.store/connect/order/cancel

Request headers

Parameter name Value Description Additional
secret string

Access secret

Required

Request body

The request body takes a complete CancelOrderRequest resource, containing the following writable properties:

{
    "comment": "string",
    "partnerOrderNumber": "string",
    "reasonCode": "int32"
}

Properties

Name Type Description Additional
comment string

A text in complement of the reason

Optional
partnerOrderNumber string

Your unique order number

reasonCode int32

The reason of cancellation. Possible values - 2: Order Cancelled, 3: Unsatisfied customer, 4: Double Order, 5: Product Error, 6: Incompatible product, 16: Fraud/Charge back

Authorisation

This request requires the use of one of following authorisation methods: OAuth2.

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Success

CancelOrderResponse
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error

Failure

Example

{
    "comment": "XXXXXX",
    "partnerOrderNumber": "XXXXXXXXXX",
    "reasonCode": 2
}

Explore this API

request

request

Request Content-Type
secret

Access secret

Response Content-Type

Choose an authorisation method:

Access Token Access token to be used for request
Try it out!