Open-API

GetServiceList

GET/3pp/base/v1/service

3PP could get OC's foundational service data through this API.
When 3PP place non-MF orders to OC, they need to tell OC from which warehouse the outbound order should be shipped and by which shipping service they want the outbound order to be fulfilled.
In this scenario, 3PP need to get OC's service list by this API

Request

Header Params

clientKey

string

required

clientKey

vAuthorization

string

required

vAuthorization

Request samples

Responses

OK(200)

Unauthorized(401)

Forbidden(403)

Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

code

integer <int32>

optional

data

array[object (service region) {2}]

optional

productList

array[object (OuterProductDTO) {2}]

optional

shippingOptionList

serviceRegion

string

required

The service region that OCH covered, value sample: DE, US-west

>= 0 characters<= 50 characters

errors

array[object (CommonVendorResponseErrorMsgDto) {3}]

optional

code

string

optional

string

optional

message

string

optional

message

string

optional

messageId

string

optional

success

boolean

optional

{
  "code": 0,
  "data": [
    {
      "productList": [
        {
          "shippingServiceCode": "string",
          "shippingServiceNameList": [
            {
              "applyPlatform": "string",
              "language": "string",
              "shippingServiceName": "string"
            }
          ]
        }
      ],
      "serviceRegion": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "id": "string",
      "message": "string"
    }
  ],
  "message": "string",
  "messageId": "string",
  "success": true
}

Last modified: 1 年前