Shipping Options
Sample Call
URL: /api/shipping/options?total_weight=1000&country_code=US
Parameters
| total_weight |
Total weight in grams |
| country_code |
Two letter ISO country code. Countries and codes are available from the shipping/countries feed. |
Response
| service |
Service identification code |
| description |
Readable service name and delivery time estimate |
| cost |
Cost for this weight and destination in US Dollars |
Sample Response (JSON)
[{"service":"HKA-BGA","description":"Hong Kong Post Airmail (1-8 weeks)","cost":"391"},{"country":"US","service":"HKD-BGA","description":"DHL Hong Kong (2-5 days)","cost":"143","refreshed":"2016-08-09 13:21:59"},{"service":"DHL-BGA","description":"DHL Next Day (1-2 days)","cost":"278"}]
Shipping Methods
Sample Call
URL: /api/shipping/methods
No Parameters
Response
| service |
Service identification code |
| description |
Readable service name and delivery time estimate |
Sample Response (JSON)
[{ "service": "HHPYDD","description": "PostNL Airmail (3-15 days)"},{"service": "HLGHDD","description": "PostNL Airmail Registered (3-15 days)"},{"service": "HKDHLDLJ","description": "DHL Hong Kong (1-7 days)"}]
Shipping Countries
Sample Call
URL: /api/shipping/countries
No Parameters
Response
| name |
Country name |
| code |
2 Digit ISO country code |
| code3 |
3 Digit ISO country code |
| phone_code |
Country international phone code |
| phone_display |
Readable 2 digit ISO country code and international phone code |
| postcode_required |
Is post code required? |
| isEU |
Is EU VAT taxable? |
Sample Response (JSON)
[{"name":"United States","code":"US","code3":"USA","phone_code":"1","phone_display":"US +1","postcode_required":"0","isEU":"0"}]
Shipping Remote Area Fee Check
Sample Call
URL: /api/shipping/remotearea?service=HKD-BGA&country_code=FI&postcode=40900
Parameters
| service |
Service code from shipping methods feed |
| country_code |
Two letter ISO country code. Countries and codes are available from the shipping/countries feed. |
| postcode |
Destination postcode |
| address_book_id (optional) |
Existing address book id. Will fetch information from address book and will overwrite country code and postcode |
Response
| remotearea |
Is there a remote area delivery fee for this destination and service. True/false. |
Sample Response (JSON)
[{"service":"HKD-BGA","country_code":"FI","postcode":"40900","remotearea":true}]