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

Body Params application/json

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

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