Open-API
  1. Pricing
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. Pricing

Cost Estimation Response

Sandbox
Sandbox
POST
/calculate/v1/getFreightTrialDetail
Pricing
If request include specific shippingServiceCode, this API will response related costs, such as fulfillment fees, packaging fees, remote surcharge, congestion surcharge, bulky surcharge, peak season surcharge, home delivery surcharges, etc.
If the request does not include any specific shippingServiceCodes, this API will response all supported shipping Service and related fees.

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 (Get Calculate Result Request) 
optional
referenceId
string 
required
The request unique code from [API:Cost Estimation Request], which was used to get the response of this API
messageId
string 
optional
timestamp
integer <int64>
optional
Example
{
  "apiVersion": "",
  "data": {
    "referenceId": "16957823453791"
  },
  "messageId": "16957823453791",
  "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/calculate/v1/getFreightTrialDetail' \
--header 'clientKey;' \
--header 'vAuthorization;' \
--header 'Access-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "apiVersion": "",
  "data": {
    "referenceId": "16957823453791"
  },
  "messageId": "16957823453791",
  "timestamp": 0
}'

Responses

🟢200OK
application/json
Body
code
integer <int32>
optional
data
array[object (Calculate Result) {7}] 
optional
calculateId
string 
required
calculate id
ebayFee
number 
required
Ebay total fee
freightTrialChannelResults
array[object (Calculate Channel Result) {14}] 
required
mfservice channel related result
noEbayFee
number 
required
non-ebay total fee
productOuterCode
string 
required
Shipping service code
productOuterName
string 
required
Shipping service name
success
boolean 
required
Whether this request of cost estimation is success
Example:
false
errors
array[object (CalculateCommonVendorResponseErrorMsgDto) {5}] 
optional
channelCode
string 
optional
errorMessage
string 
optional
productOuterCode
string 
optional
productOuterName
string 
optional
success
boolean 
optional
message
string 
optional
messageId
string 
optional
success
boolean 
optional
Examples
{
  "code": 1,
  "message": "Authentication Fail:clientKey missing",
  "messageId": "16957823453791"
}
🟢201Created
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
Modified at 2023-10-24 10:06:26
Previous
Cost Estimation Request
Built with