SKUCreation v3 - Open-API

This API is used to sync Seller's SKU from 3PP to OC.
The seller has SKUs maintained on the 3PP site, and they want to enroll in the eBay fulfillment program. Then they sync their SKUs that already existed on the 3PP site to the OC platform. This API support batch sync.
The max number of SKU in a single request is 2000.
In one call, 3PP should sync no more than 200 SKUs.

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

array[object (SkuCreationRequestV3) {32}]

optional

WeeeRegistrationNo

string

optional

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

barcodeList

array[object (SkuBarDto) {2}]

optional

Sku barcode List

batteryForm

string

optional

Value is limited to the codes predefined on the left side of the equal sign:
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 - 1 纯锂电池,
ALB = Assorted Lithium Battery - 2 配套锂电池,
OPB = Other Pure Battery - 3 其他纯电池,
OAB = Other Assorted Battery - 4 其他配套电池,
BB = Button Cell - 5 纽扣类型,
BLB = Built-in Lithium Battery - 6 内置锂电池,
OBB = Other Built-in Battery - 7 其他内置电池

countryOfOrigin

string

optional

the origin country of SKU.
2-char country code(ISO-3166) such as：EN, CN, US, DE

dimensionUnit

string

optional

Value is limited to the codes predefined on the left side of the equal sign:
cm=centimeter,
ft=feet,
in=inch,
m=meter
If the request contains length value, this dimensionUnit is mandatory.cm is preferred;1m=100cm;1ft=30.48cm;1in=2.54cm;

fileList

array[object (ExternalFileDTO) {3}]

optional

fileList

hscodeList

array[object (HsCodeDestinationCountry) {4}]

optional

hscodeList

isCombined

boolean

optional

true Consolidation preferred ，false Multiple parcels preferred

Example:

false

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

For this SKU, if the seller has published a listing on eBay and uses eBay categories to manage SKU on the 3PP site, 3PP should sync the eBay leaf category to OC. Otherwise, leave this field as null.

referenceSKUID

string

required

This is the unique SKU ID in 3PP platform

registeredHeight

number

optional

Height registered by seller

registeredLength

number

optional

Length registered by seller

registeredWeight

number

optional

Weight registered by seller

registeredWidth

number

optional

Width registered by seller

remark

string

optional

Remarks

salesURL

string

optional

Sale URL of SKU on sales platform.

serviceRegionList

array[object (ExternalServiceRegion) {11}]

optional

Seller has to publish a listing on eBay for this SKU.
Be care, the custom label is based on listing site, for example: use custom label on DE eBay site for DE fulfillment center.

sioc

boolean

optional

skudescription

string

optional

skunameList

array[object (ExternalSkuNameDTO) {3}]

optional

SKUPictureURLList

array[object (SKUPictureURL) {1}]

optional

tag

string

optional

Value is limited to the codes predefined here. (left side of the equal sign:
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

Value is limited to the codes predefined on the left side of the equal sign:
g=gram,
kg=kilogram,
lb=pounds,
oz=ounce
If the request contains weight value, then this weightUnit is mandatory.Kg is preferred;1g=0.001kg;1lb=0.453kg;1oz=0.028kg;

withBattery

boolean

optional

true means "this SKU is with battery"

Example:

false

producerInfo

string

optional

sku 制造商

skuCategory

string

optional

sku 品类，枚举: [ 'Motors', 'Electronics', 'Collectibles-Art', 'Clothing-Accessories', 'Business-Industrial', 'Home-Garden', 'Sporting-Goods', 'Jewelry-Watches', 'Other-Categories' ]

messageId

string

optional

timestamp

integer <int64>

optional

Example

{
  "data": [
    {
      "batteryForm": "PB",
      "batteryNumber": 3,
      "batteryType": "OLB",
      "SKUdescription": "Alte Berufe",
      "countryOfOrigin": "GB",
      "SKUPictureURLList": [
        {
          "SKUPictureURL": "https://mf-seller-static-cn.orangeconnex.com//attachement/2020/8/10/400242276476911680.jpg"
        }
      ],
      "leafCategoryID": "85980",
      "leafCategoryDescription": "Godsmack",
      "dimensionUnit": "cm",
      "serviceRegionList": [
        {
          "serviceRegion": "DE",
          "ebayCustomLabel": "",
          "withBrand": "AFOB",
          "brandName": "Apple",
          "ResponsiblePersonCode": "4324343243",
          "vasCode": "A18"
        },
        {
          "serviceRegion": "UK",
          "ebayCustomLabel": "",
          "withBrand": "AFOB",
          "brandName": "Apple",
          "ResponsiblePersonCode": "4324343243"
        }
      ],
      "fileList": [
        {
          "fileType": "MSDS",
          "fileUrl": "https://mf-seller-static-cn.orangeconnex.com/attachement/2020/10/29/429312232363393088.pdf"
        },
        {
          "fileType": "CE",
          "fileRegion": "DE",
          "fileUrl": "https://mf-seller-static-cn.orangeconnex.com/attachement/2020/10/29/429312232363393088.pdf"
        },
        {
          "fileType": "BRANDAUTH",
          "fileRegion": "DE",
          "fileUrl": "https://mf-seller-static-pre-release-cn.orangeconnex.com/attachement/sku/brand_registration/2021/6/18/513398518610657280.pdf"
        },
        {
          "fileType": "UN",
          "fileRegion": "",
          "fileUrl": "https://mf-seller-static-pre-release-cn.orangeconnex.com/attachement/sku/brand_registration/2021/6/18/513398518610657280.pdf"
        },
        {
          "fileType": "DOT",
          "fileRegion": "US",
          "fileUrl": "https://mf-seller-static-pre-release-cn.orangeconnex.com/attachement/sku/brand_registration/2021/6/18/513398518610657280.pdf"
        },
        {
          "fileType": "CPC",
          "fileRegion": "US",
          "fileUrl": "https://mf-seller-static-pre-release-cn.orangeconnex.com/attachement/sku/brand_registration/2021/6/18/513398518610657280.pdf"
        }
      ],
      "registeredHeight": 43,
      "registeredLength": 12,
      "registeredWeight": 24,
      "registeredWidth": 24,
      "remark": "phone",
      "SKUNameList": [
        {
          "SKUName": "iphone X-车灯",
          "languageCode": "en-US",
          "attributeDescription": "Green, Large"
        }
      ],
      "salesURL": "https://i.ebay.com/100004770263.html",
      "referenceSKUID": "3PP20254545154546566753",
      "itemID": "43325436546546554354654",
      "hscodeList": [
        {
          "destinationCountry": "OEU",
          "hsCode": "12345678",
          "declaredValue": "1",
          "currency": "EUR"
        },
        {
          "destinationCountry": "IE",
          "hsCode": "0123456789",
          "declaredValue": "1",
          "currency": "EUR"
        }
      ],
      "tag": "PO",
      "weightUnit": "kg",
      "withBattery": true,
      "SIOC": true
    }
  ],
  "messageId": "20200430022533014",
  "timestamp": 1588227933039
}

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/sku/v3/creation' \
--header 'clientKey;' \
--header 'vAuthorization;' \
--header 'Access-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": [
        {
            "batteryForm": "PB",
            "batteryNumber": 3,
            "batteryType": "OLB",
            "SKUdescription": "Alte Berufe",
            "countryOfOrigin": "GB",
            "SKUPictureURLList": [
                {
                    "SKUPictureURL": "https://mf-seller-static-cn.orangeconnex.com//attachement/2020/8/10/400242276476911680.jpg"
                }
            ],
            "leafCategoryID": "85980",
            "leafCategoryDescription": "Godsmack",
            "dimensionUnit": "cm",
            "serviceRegionList": [
                {
                    "serviceRegion": "DE",
                    "ebayCustomLabel": "",
                    "withBrand": "AFOB",
                    "brandName": "Apple",
                    "ResponsiblePersonCode": "4324343243",
                    "vasCode": "A18"
                },
                {
                    "serviceRegion": "UK",
                    "ebayCustomLabel": "",
                    "withBrand": "AFOB",
                    "brandName": "Apple",
                    "ResponsiblePersonCode": "4324343243"
                }
            ],
            "fileList": [
                {
                    "fileType": "MSDS",
                    "fileUrl": "https://mf-seller-static-cn.orangeconnex.com/attachement/2020/10/29/429312232363393088.pdf"
                },
                {
                    "fileType": "CE",
                    "fileRegion": "DE",
                    "fileUrl": "https://mf-seller-static-cn.orangeconnex.com/attachement/2020/10/29/429312232363393088.pdf"
                },
                {
                    "fileType": "BRANDAUTH",
                    "fileRegion": "DE",
                    "fileUrl": "https://mf-seller-static-pre-release-cn.orangeconnex.com/attachement/sku/brand_registration/2021/6/18/513398518610657280.pdf"
                },
                {
                    "fileType": "UN",
                    "fileRegion": "",
                    "fileUrl": "https://mf-seller-static-pre-release-cn.orangeconnex.com/attachement/sku/brand_registration/2021/6/18/513398518610657280.pdf"
                },
                {
                    "fileType": "DOT",
                    "fileRegion": "US",
                    "fileUrl": "https://mf-seller-static-pre-release-cn.orangeconnex.com/attachement/sku/brand_registration/2021/6/18/513398518610657280.pdf"
                },
                {
                    "fileType": "CPC",
                    "fileRegion": "US",
                    "fileUrl": "https://mf-seller-static-pre-release-cn.orangeconnex.com/attachement/sku/brand_registration/2021/6/18/513398518610657280.pdf"
                }
            ],
            "registeredHeight": 43,
            "registeredLength": 12,
            "registeredWeight": 24,
            "registeredWidth": 24,
            "remark": "phone",
            "SKUNameList": [
                {
                    "SKUName": "iphone X-车灯",
                    "languageCode": "en-US",
                    "attributeDescription": "Green, Large"
                }
            ],
            "salesURL": "https://i.ebay.com/100004770263.html",
            "referenceSKUID": "3PP20254545154546566753",
            "itemID": "43325436546546554354654",
            "hscodeList": [
                {
                    "destinationCountry": "OEU",
                    "hsCode": "12345678",
                    "declaredValue": "1",
                    "currency": "EUR"
                },
                {
                    "destinationCountry": "IE",
                    "hsCode": "0123456789",
                    "declaredValue": "1",
                    "currency": "EUR"
                }
            ],
            "tag": "PO",
            "weightUnit": "kg",
            "withBattery": true,
            "SIOC": true
        }
    ],
    "messageId": "20200430022533014",
    "timestamp": 1588227933039
}'

Responses

🟢200OK

application/json

Body

code

integer <int32>

optional

data

array[object (CustomResponse) {2}]

optional

mfskuid

string

optional

referenceSKUID

string

required

Unique SKU ID of 3PP system
It was SKUID in SKUCreation API

errors

array[object (CommonVendorResponseErrorMsgDto) {3}]

optional

code

string

optional

string

optional

message

string

optional

message

string

optional

messageId

string

optional

success

boolean

optional

Examples

SuccessException

{
  "code": 0,
  "data": [
    {
      "MFSKUID": "OC0123456789012",
      "referenceSKUID": "3PP43434565786y6"
    },
    {
      "MFSKUID": "OC0123456789013",
      "referenceSKUID": "3PP43892432473"
    }
  ],
  "message": "Interface call succeeded.",
  "messageId": "20200430022533014"
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found