Supreme
Overview
Supreme System is a US-based carrier that deals with Shipping and Tracking. PB- SendTech Solutions trades with its services within US.
Onboarding of a Supreme Carrier Account
To register a Supreme carrier account, the user must have the following essentials:
- Account Number
- Carrier ID
- Security credentials in the form of a Username and Password
To onboard a Supreme carrier account, an API request call is made, that covers all the essentials. Below is the Sample Request.
{
"accountNumber": "XXXX",
"carrierID": "SUPRMSYS",
"description": "SUPREME",
"parameters": {
"username": "CondeAxis",
"password": "XXXXXXX"
}
}
If the request to onboard the Supreme carrier account is successful, the response will look like the below Sample Response.
{
"carrierAccountID": "p1odPPEQnoz",
"description": "SUPREME",
"carrierID": "SUPRMSYS",
"accountNumber": "XXXX",
"parameters": {
"username": "CondeAxis"
},
"carrierAccountType": "Shipping",
"provisioningType": "API"
}
API Operations for Shipping with Supreme
The APIs integrate with Supreme through the following operations:
Operations | Method | Resource Path |
---|---|---|
Add a Carrier Account | POST | /api/v1/carrierAccounts |
Rate a Parcel | POST | /api/v1/rates |
Create a Shipping Label | POST | /api/v1/shipments |
Reprint a Label | GET | /api/v1/shipments/{{shipmentId}}/reprint |
Void a Label | PUT | /api/v1/shipments/{{shipmentId}}/cancel |
Get Tracking Information | GET | /api/v1/tracking/{{trackingNumber}} |
Metadata
Metadata provides information about Supreme carrier services, including origin and destination countries, supported carrier services, supported package types, and supported special services. Users can select specific origin and destination countries from the provided dropdown menu to dynamically view relevant metadata specific to those countries.