Outbound Order Cancellation

Sandbox

POST

/3pp/outbound/v1/cancel

Outbound

3PP sync cancelled orders to OC.
If the seller doesn't want OC to fulfill orders they placed previously, seller can cancel these orders through 3PP and 3PP needs to sync canceled orders to OC.

Request

Header Params

clientKey

string

required

clientKey

vAuthorization

string

required

vAuthorization

Access-Token

string

required

First please get the access_token thru accessToken&refreshToken API and refresh accseeToken.
Then pass the value following the below format to Header.
Bearer+one space+access_token valueExample:
Thru the API get Access_token value, which is 'accesstokenvaluexxxxxxxx'.
Header Value is as below:
Bearer accesstokenvaluexxxxxxxx

Body Params application/json

apiVersion

string

optional

data

object (ExternalOrderCancelRequestDTO)

optional

cancelReason

string

optional

Cancellation reasons

cancelTime

string

required

The time seller submit canceling request on 3PP site, Date+Time Zone，UTC ISO8601 format ，example：2018-11-28T20:09:57+0800

orderNumber

string

required

Unique order number generated by OC

messageId

string

optional

timestamp

integer <int64>

optional

Example

{
  "apiVersion": "string",
  "data": {
    "cancelReason": "string",
    "cancelTime": "string",
    "orderNumber": "string"
  },
  "messageId": "string",
  "timestamp": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://openapi-stage-hk.orangeconnex.com/openapi/3pp/outbound/v1/cancel' \
--header 'clientKey;' \
--header 'vAuthorization;' \
--header 'Access-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiVersion": "string",
    "data": {
        "cancelReason": "string",
        "cancelTime": "string",
        "orderNumber": "string"
    },
    "messageId": "string",
    "timestamp": 0
}'

Responses

🟢200OK

application/json

Body

code

integer <int32>

optional

errors

array[object (CommonVendorResponseErrorMsgDto) {3}]

optional

code

string

optional

string

optional

message

string

optional

message

string

optional

messageId

string

optional

success

boolean

optional

Example

{
  "code": 0,
  "errors": [
    {
      "code": "string",
      "id": "string",
      "message": "string"
    }
  ],
  "message": "string",
  "messageId": "string",
  "success": true
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Modified at 2023-10-19 08:25:59

Outbound Order Query v2

GetServiceList