Cost Estimation Request

Sandbox

https://openapi-stage-hk.orangeconnex.com/openapi

POST

/calculate/v1/freightTrial

Each request is regarded as a parcel, one parcel could include multiple SKUs and different quantities.
Input the fulfillment center, consignee address info, seller OCSKUID or parcel dimension and weight.
In the Parcel, if SKUType is OCSKUID, parcel dimension and weight is not required. If the SKUType is not OCSKUID, the parcel dimension and weight are required.
Each request should have a unique referenceid. Get result by referenceid later.

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 (Calculate Request)

optional

companyName

string

optional

The company name or business name of the consignee.

consigneeAddress1

string

optional

The consignee's address line 1

consigneeAddress2

string

optional

The consignee's address line 2

consigneeCity

string

optional

The consignee's city

consigneeCountryCode

string

required

The consignee's destination country, 2-character country code(ISO-3166)

consigneeEmail

string

optional

The consignee's email address

consigneeName

string

optional

The consignee's full name

consigneePhone

string

optional

The consignee's contact Number

consigneePostCode

string

required

The consignee's zip code

consigneeProvinceOrState

string

optional

The consignee's Province/state

houseNumber

string

optional

The consignee's house number

intlSelfPayment

boolean

optional

Whether this is international service are self-paid:
true:yes,
false:no
Default regard as yes.

Example:

false

mfservice

boolean

optional

Whether this service is eBay order；
true:ebay order (autofulfill not included);
false: non-eBay order;
Default regard as non-eBay order.

Example:

false

referenceId

string

required

The request unique code, which will be used to get the response of [API: Cost estimation Reponse].

serviceRegion

string

required

Fulfillment Center:
UK,DE,US-East,US-South,US-West,AU-Sydney,AU-Melbourne;

serviceType

string

optional

Service Type: EF,OCN. Default will regard asEF

shippingServiceCode

array[string]

optional

shippingServiceCode list. Acquire from the[API:Get Service List].If empty, it will return all supported service and pricing

skuList

array[object (Calculate Sku Info) {9}]

optional

sku info List

skuType

boolean

optional

Whether the skus are OCSKUID.
true:yes,
false:no;
If SKUs are OCSKUID, it will check whether the SKUs are verified, no necessary to input sku info such as dimension, weight, siop, battery,etc. However. If SKU are not OCSKUID, SKU info are required.

Example:

false

messageId

string

optional

timestamp

integer <int64>

optional

Example

{
  "apiVersion": "",
  "data": {
    "companyName": "test",
    "consigneeAddress1": "test",
    "consigneeAddress2": "test",
    "consigneeCity": "test",
    "consigneeCountryCode": "AU",
    "consigneeEmail": "test@test.com",
    "consigneeName": "Amy Test",
    "consigneePhone": "5700011111",
    "consigneePostCode": "4610",
    "consigneeProvinceOrState": "test",
    "houseNumber": "202",
    "intlSelfPayment": true,
    "mfservice": true,
    "referenceId": "16957823453791",
    "serviceRegion": "AU",
    "serviceType": "EF",
    "shippingServiceCode": [],
    "skuList": [
      {
        "height": 15,
        "length": 10,
        "pieceQuantity": 1,
        "polybag": "true",
        "siop": false,
        "skuId": "OC0000250294068",
        "weight": 1000,
        "width": 2,
        "withBattery": false
      }
    ],
    "skuType": true,
    "warehouseRegionCode": "AU"
  },
  "messageId": "7891955650647900161",
  "timestamp": 0
}

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/calculate/v1/freightTrial' \
--header 'clientKey;' \
--header 'vAuthorization;' \
--header 'Access-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "apiVersion": "",
  "data": {
    "companyName": "test",
    "consigneeAddress1": "test",
    "consigneeAddress2": "test",
    "consigneeCity": "test",
    "consigneeCountryCode": "AU",
    "consigneeEmail": "test@test.com",
    "consigneeName": "Amy Test",
    "consigneePhone": "5700011111",
    "consigneePostCode": "4610",
    "consigneeProvinceOrState": "test",
    "houseNumber": "202",
    "intlSelfPayment": true,
    "mfservice": true,
    "referenceId": "16957823453791",
    "serviceRegion": "AU",
    "serviceType": "EF",
    "shippingServiceCode": [],
    "skuList": [
      {
        "height": 15,
        "length": 10,
        "pieceQuantity": 1,
        "polybag": "true",
        "siop": false,
        "skuId": "OC0000250294068",
        "weight": 1000,
        "width": 2,
        "withBattery": false
      }
    ],
    "skuType": true,
    "warehouseRegionCode": "AU"
  },
  "messageId": "7891955650647900161",
  "timestamp": 0
}'

Responses

🟢200OK

application/json

Body

code

integer <int32>

optional

data

boolean

optional

errors

array[object (CommonVendorResponseErrorMsgDto) {3}]

optional

code

string

optional

string

optional

message

string

optional

message

string

optional

messageId

string

optional

success

boolean

optional

Examples

ExceptionSuccess

{"code":1,"message":"Authentication Fail:clientKey missing"}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Modified at 2023-11-30 02:58:57

GetServiceList

Cost Estimation Response