The St Regis Group Core Shipping Calculator provides rate estimates and
an FOB point given a product, a quantity, and a valid address.
Request
All requests must be valid JSON data. Starred fields are required.
Body
- id * (String)
- Your St Regis Group API ID
- password * (String)
- Your St Regis Group API Password
- version * (String)
- The version of the API to use. This documentation is for version "1"
- shippers (Array of String, String)
- One or more shipping providers to display results from. Valid options are "ups" and "fedex". Default "all"
- sku * (String)
- A valid St Regis Group SKU
- quantity * (Integer)
- A quantity of product to rate. This must be an integer greater than zero.
- address * (Address object)
- Describes the destination
Address object
- city (String)
- The city being shipped to
- stateOrProvinceCode (String, ISO 3166-2)
- The state or province being shipped to
- country * (String, ISO 3166-1)
- The country being shipped to
- postalCode * (String)
- The postal code or ZIP being shipped to
Example request
{
"id": "api@stregisgrp.com",
"password": "XXXXXX",
"version": "1",
"sku": "P156 B BLUE",
"quantity": 1300,
"address": {
"city": "Markham",
"stateOrProvinceCode": "ON",
"postalCode": "L6G1A6",
"country": "CA"
}
}
Response (Successful)
Body
- fob (FOB object)
- Describes where the shipment originates
- shipment (Shipment object)
- Describes the shipment
- rates (Array of Rate objects)
- An array of quoted rates
- messages (Array of Strings)
- If the request only partially completes, any errors will list here.
Shipment object
- sku (String)
- The SKU given in the request
- quantity (Integer)
- The quantity of product given in the request
- totalWeight (String)
- The total weight of the shipment
- totalWeightUom (String)
- The unit of measurement for the weight
- cartons (Array of Carton objects)
- The cartons in the shipment
FOB Object
- addressLines (Array of Strings)
- The origin address
- city (String)
- The origin city
- stateOrProvinceCode (String)
- The origin state or province
- country (String)
- The origin country
- postalCode (String)
- The origin postal code or ZIP
Carton Object
- width (String)
- The width of the carton
- height (String)
- The height of the carton
- length (String)
- The length of the carton
- dimensionUom (String)
- The unit of measure for the carton's dimensions
- quantity (Integer)
- The number of products in the carton
- quantityUom (String)
- The unit of measure for the product
- weight (String)
- The weight of the carton
- weightUom (String)
- The unit of measure for the weight of the carton
Rate Object
- service (String)
- The name of the service
- carrierCode (String)
- The carrier's internal code for the service.
- cost (String)
- The cost of shipping with the given service
- currency (String)
- The currency the cost is displayed in
Example response
{
"fob": {
"addressLines": [
"271 Yorktech Drive"
],
"city": "Markham",
"stateOrProvinceCode": "ON",
"countryCode": "CA",
"postalCode": "L6G1A6"
},
"shipment": {
"sku": "P156 B BLUE",
"quantity": 25,
"totalWeight": "4.73",
"totalWeightUom": "LB",
"cartons": [
{
"width": "16",
"height": "14",
"length": "4",
"dimensionUom": "IN",
"quantity": "25.00",
"quantityUom": "EACH",
"weight": "4.73",
"weightUom": "LB"
}
]
},
"rates": [
{
"service": "UPS Standard",
"cost": "5.60",
"currency": "CAD"
},
{
"service": "UPS 2nd Day",
"cost": "10.31",
"currency": "CAD"
},
]
"messages": [ "Rates could not be returned from Fedex." ]
}
Response (Unsuccessful)
Body
- message
- A string detailing the error that occurred while processing your request
If you have any questions or concerns, please contact our team at api@stregisgrp.com