Open-API
  1. SKU
Open-API
  • eBay fulfillment openAPI
  • OAuth
    • URL(getAuthorizationCode)
      GET
    • AccessToken
      POST
    • Refresh AccessToken
      POST
  • SKU
    • SKUCreation v3
      POST
    • SKUQuery v3
      POST
    • SKU Label
      POST
    • SKUSetupEFService
      POST
    • QuerySKUEFService
      POST
  • Stock
    • GetStockMovement
      POST
    • StockSnapshot v2
      POST
  • Inbound
    • PlaceInboundOrder
      POST
    • Inbound Order List Query
      POST
    • Inbound Order Detail Query
      POST
    • Inbound Label Query
      POST
    • Upload TrackingNo
      POST
    • Upload Clearance Doc
      POST
  • Outbound
    • Place Outbound Order
      POST
    • Outbound Order Query v2
      POST
    • Outbound Order Cancellation
      POST
  • Warehouse
    • GetServiceList
      GET
  • Pricing
    • Cost Estimation Request
      POST
    • Cost Estimation Response
      POST
  1. SKU

SKUSetupEFService

Sandbox
https://openapi-stage-hk.orangeconnex.com/openapi
Sandbox
https://openapi-stage-hk.orangeconnex.com/openapi
POST
/3pp/sku/v1/setupEF
SKU
This API is used to join/exit EF services.

Request

Header Params
clientKey
string 
required
clientKey
vAuthorization
string 
required
vAuthorization
Access-Token
string 
required
Access-Token
Body Params application/json
apiVersion
string 
optional
data
object (ExternalSkuJoinEfDTO) 
optional
domesticServicesList
array[object (ExternalDomesticService) {3}] 
optional
Domestic Services List
ebayIDList
array[object (ExternalEBayID) {5}] 
optional
fulfillmentCenterCode
string 
required
fulfillment Center Code
internationalService
object (ExternalInternationalService) 
optional
International Service
mfSkuId
string 
required
The SKU ID which is generated by OC，
boundle SKU are not supported.
>= 0 characters<= 50 characters
messageId
string 
optional
timestamp
integer <int64>
optional
Example
{
    "apiVersion": "string",
    "data": {
        "domesticServicesList": [
            {
                "isJoinDomesticService": 0,
                "shippingServiceCode": "string",
                "shippingServiceRegionList": [
                    {
                        "additionalQuantityValue": 0,
                        "shippingCost": 0,
                        "shippingServiceRegion": "string"
                    }
                ]
            }
        ],
        "ebayIDList": [
            {
                "Autoflip": 0,
                "DefaultInventory": 0,
                "customLabel": "string",
                "ebayID": "string",
                "isJoinEF": 0
            }
        ],
        "fulfillmentCenterCode": "string",
        "internationalService": {
            "countryList": [
                {
                    "additionalQuantityValue": 0,
                    "destinationCountry": "st",
                    "shippingCost": 0
                }
            ],
            "internationalShippingServiceCode": "string",
            "isJoinInternationalService": 0
        },
        "mfSkuId": "string"
    },
    "messageId": "string",
    "timestamp": 0
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://openapi-stage-hk.orangeconnex.com/openapi/3pp/sku/v1/setupEF' \
--header 'clientKey;' \
--header 'vAuthorization;' \
--header 'Access-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiVersion": "string",
    "data": {
        "domesticServicesList": [
            {
                "isJoinDomesticService": 0,
                "shippingServiceCode": "string",
                "shippingServiceRegionList": [
                    {
                        "additionalQuantityValue": 0,
                        "shippingCost": 0,
                        "shippingServiceRegion": "string"
                    }
                ]
            }
        ],
        "ebayIDList": [
            {
                "Autoflip": 0,
                "DefaultInventory": 0,
                "customLabel": "string",
                "ebayID": "string",
                "isJoinEF": 0
            }
        ],
        "fulfillmentCenterCode": "string",
        "internationalService": {
            "countryList": [
                {
                    "additionalQuantityValue": 0,
                    "destinationCountry": "st",
                    "shippingCost": 0
                }
            ],
            "internationalShippingServiceCode": "string",
            "isJoinInternationalService": 0
        },
        "mfSkuId": "string"
    },
    "messageId": "string",
    "timestamp": 0
}'

Responses

🟢200OK
application/json
Body
code
integer <int32>
optional
data
string 
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
{
    "code": 0,
    "data": "string",
    "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
Previous
SKU Label
Next
QuerySKUEFService
Built with