Included in this document:
- Description
- Requests
- Headers
- Parameters
- Return format
- Root object
- Carrier
- Request example
- Response example
Description
Get the available services associated with the access_key token.
Requests
Method: GET
Content Type: application/json
URL: https://api.gosweetspot.com/api/availableservices
Headers
access_key : your unqiue api key provided by GSS.
site_id : which site you are requesting action for.
Parameters
None
Return format
A JSON Object of available carriers.
Root Object
Carriers - Array of Carrier.
Carrier
| Attribute | Type | Description |
|---|---|---|
| AccountNumber | string | Account number of carrier |
| CarrierId | integer | Id of carrier |
| CarrierName | string | Name of carrier |
| CarrierType | string | type of carrier |
| Services | Array of strings | available services of carrier |
Request example
curl --location 'https://api.gosweetspot.com/api/availableservices' \ --header 'access_key;' \ --header 'site_id;'
Response example
{
"Carriers": [
{
"CarrierId": 779,
"CarrierName": "FedEx",
"CarrierType": "FedEx",
"Services": [
"All"
],
"AccountNumber": "1234"
},
{
"CarrierId": 432,
"CarrierName": "Post Haste",
"CarrierType": "PostHaste",
"Services": [
"Overnight",
"Standard",
"2 Day Inter Island"
],
"AccountNumber": "1234"
},
{
"CarrierId": 805,
"CarrierName": "NZ Post",
"CarrierType": "NZPost",
"Services": [
"Air Parcels",
"Air Parcels Small",
"Air Satchel Tracked",
"Intl Courier",
"Intl Courier (EX)"
],
"AccountNumber": "1234"
},
{
"CarrierId": 205,
"CarrierName": "Mainstream AKL",
"CarrierType": "Mainstream",
"Services": [
"Standard",
"Standard m3+",
"Bulk Freight"
],
"AccountNumber": "1234"
},
{
"CarrierId": 542,
"CarrierName": "NZ Couriers",
"CarrierType": "NZCouriers",
"Services": [
"Overnight",
"Standard",
"2 Day Inter Island"
],
"AccountNumber": "1234"
}
]
}