This method allows to take informations about carriers available for the customer.
Use
Method | Url |
---|---|
GET | /restful/export/carriers |
Authentication
Remember to authenticate properly, using HTTP Basic Authentication with your API-Key as username and your password.
Request Headers
This method works using JSON or XML format, set the following headers to choose the format you want to use:
Key | Value |
---|---|
Accept | application/xml or application/json |
Content-type | application/xml or application/json |
Response Body
The Response Body contains the follow parameters:
- carrier : carrier name with relative ID
Example XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<collection>
<carrier name="DHL" id="10"/>
<carrier name="UPS" id="20"/>
<carrier name="GLS" id="30"/>
<carrier name="Bartolini" id="40"/>
</collection>
Example JSON Response
[
{
"cost": 9.80,
"name": "TNT",
"id": 39
}
]
Note
- Your supplier can customize the available carriers for each user. Carrier list may be different for each user and may vary over time;
- The list of available carriers does not contain information about carriers' shipping rates nor maximum weight. If the carrier indicated in API call does not offer rates for the order shipping country or for the order total weight a default carrier will be assigned;