SKUQuery v3 - Open-API

The seller has SKUs maintained on the OC site, and then they query their SKUs that already exist on the OC site to the 3PP platform.
This interface is for querying SKU information and returns details such as the OCSKUID, name, dimensional weight, and other relevant information. The input parameter SKUlist requires at least one entry. The request supports pagination, with the default response being the first page and a maximum of 200 entries per page.

此接口为 SKU 信息查询接口，返回商品的 OCSKUID，名称，尺重等信息。
入参 SKUList 至少有一个必填。
请求支持分页，默认返回第一页，每页上限 200。

Request

Header Params

clientKey

string

required

clientKey

Example:

bd1d1971-d0db-11ea-b4a1-00505694c27b

vAuthorization

string

required

vAuthorization

Example:

Access-Token

string

required

Access-Token

Example:

Body Params application/json

apiVersion

string

optional

data

object

optional

endTime

string

optional

The motified time of SKU
Format: YYYY-MM-DD+ time zone, UTC ISO8601，
ex：2018-11-28 + 0800

mfskulist

array[object (MfSkuIdDTO) {1}]

optional

referenceSKUIDList

array[object (ReferenceSkuIdDTO) {2}]

optional

seller SKU ID list

sellerSKUIDList

array[object (SellerSkuIdDTO) {1}]

optional

seller SKU ID list

startTime

string

optional

The motified time of SKU
Format: YYYY-MM-DD+ time zone, UTC ISO8601，
ex：2018-11-28 + 0800

page

integer

optional

limit

integer

optional

messageId

string

optional

timestamp

integer <int64>

optional

Example

{
    "apiVersion": "string",
    "data": {
        "sellerSKUIDList": [
            {
                "sellerSKUID": "test202506160001"
            }
        ],
        "mfskulist": [
            {
                "mfskuid": "OC0000255648111"
            }
        ],
        "referenceSKUIDList": [
            {
                "ebayCustomLabel": "Hc_ebay_auto_test",
                "referenceSKUID": "test202506160001"
            }
        ],
        "limit": 0,
        "startTime": "2022-02-22+0800",
        "endTime": "2025-02-22+0800",
        "page": 0
    },
    "messageId": "string",
    "timestamp": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

code

integer <int32>

optional

data

array[object (SkuQueryResponseV3) {35}]

optional

WeeeRegistrationNo

string

optional

Weee registration Number can be created on OC's seller portal.

actualHeight

number

optional

actual height, which is provided by WH

actualLength

number

optional

actual length, which is provided by WH

actualWeight

number

optional

actual weight, which is provided by WH

actualWidth

number

optional

actual width, which is provided by WH

barcodeList

array[object (SkuBarDto) {2}]

optional

Barcode list.

batteryForm

string

optional

PB=Pure Battery; BCE=Battery contained in equipment,; BPE=Battery packed with equipment

batteryNumber

integer <int32>

optional

Battery quantity of this SKU.

batteryType

string

optional

Value is limited to the codes predefined on the left side of the equal sign:
BC = Button Cell,
OLB = Other Lithium Battery,
OT = Others

batteryTypeNew

string

optional

Value is limited to the codes predefined on the left side of the equal sign:
PLB = Pure Lithium Battery -,
ALB = Assorted Lithium Battery -,
OPB = Other Pure Battery -,
OAB = Other Assorted Battery -,
BB = Button Cell -,
BLB = Built-in Lithium Battery -,
OBB = Other Built-in Battery -

countryOfOrigin

string

optional

countryOfOrigin

dimensionUnit

string

optional

dimensionUnit ex:cm

fileList

array[object (ExternalFileDTO) {3}]

optional

file list

hscodeList

array[object (HsCodeDestinationCountry) {4}]

optional

hscodeList

isPolybag

boolean

optional

Whether to use waterproof bag: false- No, true- Yes. If empty，default value will be set as No.
The filed will be invalid if "Shipping In Own Packaging" of this SKU is set as "Multiple Parcels Preferred".

Example:

false

itemID

string

optional

ebay Listing

leafCategoryDescription

string

optional

Same as above.

leafCategoryID

string

optional

2-character country code(ISO-3166) + 2-character language code(ISO 639-1)
en-US, zh-CN, de-DE

mfskuid

string

optional

needUNLabel

boolean

optional

UNLabel

Example:

false

referenceSKUID

string

optional

The unique SKU ID in 3PP platform

registeredHeight

number

optional

registered height, which is provided by seller

registeredLength

number

optional

registered length, which is provided by seller

registeredWeight

number

optional

registered weight, which is provided by seller

registeredWidth

number

optional

registered width, which is provided by seller

salesURL

string

optional

selling URL

sellerSKUID

string

optional

The SKU ID which is input by seller when they registed SKU on OC's portal or 3pp creation API;
ps: This value may change if user modify this field on OC's portal

serviceRegionList

array[object (ExternalServiceRegion) {11}]

optional

Set SKU information based on the country of fulfillment Center (warehouse).

sioc

boolean

optional

skudescription

string

optional

skunameList

array[object (ExternalSkuQueryResultSkuNameDTO) {3}]

optional

skupictureURLList

array[object (ExternalSkuQueryResultPictureUrlDTO) {1}]

optional

tag

string

optional

LD=Liquid, PO=Powder, PA=Paste, LDPO=Liquid&Powder，POPA=Powder&Paste，LDPA=Liquid&Paste，LDPOPA=Liquid&Powder&Paste， NA=None of Above

weightUnit

string

optional

Unit of weight value

withBattery

boolean

optional

true means "this SKU is with battery"

Example:

false

errors

array[object (CommonVendorResponseErrorMsgDto) {3}]

optional

code

string

optional

string

optional

message

string

optional

message

string

optional

messageId

string

optional

success

boolean

optional

page

integer

optional

limit

integer

optional

total

integer

optional

pages

integer

optional

Examples

SuccessException

{
    "code": 0,
    "data": [
        {
            "MFSKUID": "OC0000255648111",
            "SIOC": true,
            "SKUNameList": [
                {
                    "SKUName": "test202506121815",
                    "languageCode": "zh-CN"
                }
            ],
            "SKUPictureURLList": [],
            "WeeeRegistrationNo": "",
            "actualHeight": 1.00,
            "actualLength": 1.00,
            "actualWeight": 0.155,
            "actualWidth": 1.00,
            "barcodeList": [
                {
                    "barcode": "OC0000255648111",
                    "barcodeType": "2"
                }
            ],
            "countryOfOrigin": "DE",
            "dimensionUnit": "cm",
            "fileList": [],
            "hscodeList": [],
            "isPolybag": false,
            "needUNLabel": false,
            "referenceSKUID": "test202506121815",
            "registeredHeight": 0.00,
            "registeredLength": 0.00,
            "registeredWeight": 0.000,
            "registeredWidth": 0.00,
            "salesURL": "https://fulfillment-stage-cn.orangeconnex.com/sku/RegisterSku?from=add",
            "sellerSKUID": "test202506121815",
            "serviceRegionList": [
                {
                    "ResponsiblePersonCode": "",
                    "serviceRegion": "DE",
                    "status": "Registered",
                    "vasCode": "N",
                    "verifyStatus": "REGISTERED",
                    "withBrand": "WOB"
                }
            ],
            "weightUnit": "kg",
            "withBattery": false
        },
        {
            "MFSKUID": "OC0000255654028",
            "SIOC": true,
            "SKUNameList": [
                {
                    "SKUName": "test202506160001",
                    "languageCode": "zh-CN"
                }
            ],
            "SKUPictureURLList": [],
            "WeeeRegistrationNo": "",
            "barcodeList": [
                {
                    "barcode": "test202506160001",
                    "barcodeType": "1"
                }
            ],
            "batteryTypeNew": "PLB",
            "countryOfOrigin": "",
            "dimensionUnit": "cm",
            "fileList": [
                {
                    "fileType": "MSDS",
                    "fileUrl": "https://mftestfile.blob.core.chinacloudapi.cn/mf-hk-test-file/attachment/sku/msds/2025/6/16/1042122870056026809.pdf"
                },
                {
                    "fileRegion": "DE",
                    "fileType": "CE",
                    "fileUrl": "https://mftestfile.blob.core.chinacloudapi.cn/mf-hk-test-file/attachment/sku/ce/2025/6/16/1042123011567649464.pdf"
                }
            ],
            "hscodeList": [],
            "isPolybag": false,
            "needUNLabel": true,
            "referenceSKUID": "test202506160001",
            "registeredHeight": 0.00,
            "registeredLength": 0.00,
            "registeredWeight": 0.000,
            "registeredWidth": 0.00,
            "salesURL": "https://fulfillment-stage-cn.orangeconnex.com",
            "sellerSKUID": "test202506160001",
            "serviceRegionList": [
                {
                    "ResponsiblePersonCode": "RP000000403EF",
                    "serviceRegion": "DE",
                    "status": "UnderVerification",
                    "vasCode": "N",
                    "verifyStatus": "UNDER VERIFICATION",
                    "withBrand": "WOB"
                }
            ],
            "weightUnit": "kg",
            "withBattery": true
        }
    ],
    "errors": [],
    "limit": 100,
    "page": 1,
    "pages": 1,
    "total": 2
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found