Outbound Order Cancellation
POST
/3pp/outbound/v1/cancel3PP 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
Responses
OK(200)
Created(201)
Unauthorized(401)
Forbidden(403)
Not Found(404)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
code
integer <int32>
optional
errors
array[object (CommonVendorResponseErrorMsgDto) {3}]
optional
code
string
optional
id
string
optional
message
string
optional
message
string
optional
messageId
string
optional
success
boolean
optional
Example
Not configured
Last modified: 1 年前