API Reference Shipping RatesShipsi’s APIs (Application Programming Interface) power its technology for ecommerce delivery. Behind these APIs is a software layer integrating and aggregating driver networks in 5,000+ cities.
From getting shipping rates to viewing checkout analytics to scheduling deliveries, Shipsi has an entire suite of APIs. Shipsi API reference documentation can be found throughout our product documentation. You can use this page to browse the various APIs or jump right in to Shipping Rates or Create Delivery.
An API is an application programming interface - or more simply, a set of rules which allow programs talk to each other, exposing permissible data and functionality across the internet in a format which is consistent.
REST is an acronym for Representational State Transfer. This is an architectural pattern that explains how distributed systems can expose a consistent interface. When the term ‘REST API’ is used it is typically referencing an API accessed via HTTP protocol at a defined set of URLs.
These URLs hold different resources - such as information or content at that location, which is returned in either JSON, HTML, images, or audio files. Often, resources have multiple methods that can be performed over HTTP, like GET, POST, PUT and DELETE.
Shipsi offers many different REST APIs for finding shipping rates, creating deliveries, checking analytics, managing locations, and much more. With the Shipsi technology offering, each product has a separate API, but you can work with each in a similar manner, whether over HTTP or using Shipsi’s guides for different programming languages.
All URLs referenced within this document have the same base URL, which are predictable and resource-oriented
This REST API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.
The Shipsi API uses API keys to authenticate requests. You can view your API key in your account settings within your self-serve portal
Shipsi uses conventional HTTP response codes to indicate the success or failure of an API request. Generally it can be known: Codes within the 2xx range mean success. Codes within the 4xx range mean failure due to the information given (such as, a required parameter was omitted, an address was invalid, the scheduled time is in the past.). Codes within the 5xx range mean their is an error on our end.
Because many 4xx errors can be handled programmatically we do our best to provide a code which explains the reported error.
200 - OK
Everything worked as expected.
400 - Bad Request
The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized
No valid API key provided.
402 - Request Failed
The parameters were valid but the request failed.
403 - Forbidden
The API key doesn't have permissions to perform the request.
404- Not Found
The request resources doesn’t exist
409 - Conflict
Conflict with another request
429 - Too Many Requests
Too many requests at once, try exponential backoff
500, 502, 503, 504 - Server Errors
Something is wrong on our end
no_service_available - SHIPSI not activated
This SHIPSI account is not active since it is missing required information. Please log into the SHIPSI Portal to complete your required information.
outside_of_delivery_network_radius - Outside of delivery network radius
The destination address is outside the delivery radius of any eligible pickup locations.
disable_next_day_delivery_merchant - No delivery option matching eligible location(s) operating hours
There are no pickup locations which have operating hours during this time to accept orders. Contact SHIPSI support to active other delivery options that could expand your delivery window.
location_items_not_available - One or more items excluded from delivery from eligible location(s)
At least one item in the order is excluded for SHIPSI delivery at the eligible location. All items in an order must be included (and not excluded) at a single, eligible location. Inclusions/Exclusions by location are managed in the SHIPSI Portal in Location Settings.
no_merchant_pickup_location - No availability through delivery networks
No delivery agent within the SHIPSI network is available. This may be based on destination coverage and/or timing of delivery.
Some objects allow the request for more information shown as an expanded response using the expand request parameter. On all API requests this parameter is available, but only applies to that request alone. Responses can be expanded once or multiple times in nested fashion.
To expand a response you must use the applicable related object ID within the response properties given. A good example of this is the Compare Rates API request will return quote IDs. Those quote ID objects can be expanded inline with the expand request parameter. Within this documentation we note objects which can be expanded with the expand request parameter.
You can expand recursively by specifying nested fields after a dot (.). For example, requesting location_id.location_package on shipping rate will expand the location_id property into a full Location object, and will then expand the location_package property on that location into a full Package object.
This parameter can be used on any endpoint that returns expandable fields. Using multiple deep expansions on requests can be slow.
Expansions have a maximum depth of three levels.
The Shipsi API supports built in idempotency. Many requests can be retried with the same parameters repeatedly and not cause any negative result.
Requests to endpoints which action events that carry a cost or associated live event are idempotent by default. All of these requests must be unique or will fail.
Request results only save if an endpoint starts executing. If request parameters failed validation, or the request conflicted with another that was executing concurrently, no idempotent result is saved because no API endpoint began execution. These requests can always be retried.
Using Shipsi's REST API, find the cost of delivery for all providers in your area and choose the best delivery provider for your business.
Below we will explore how to Get Rate
Get best rates by posting to the Get Rate resource
To use the Shipping Rates resource, make an HTTP POST to the resource:
ID of the sub account requested for get rate.
This is an array of pre-qualified a group of stores to be considered for a specific delivery (typically if conducting location-level SKU inventory/eligibility outside Shipsi). Do not include this object to have Shipsi to search across all locations to find the optimal fulfillment location (requires Shipsi to have access to store level SKU availability).
Shipsi location ID is used to identify where order pickup will occur (can be used in lieu of Retailer Location ID, but one of these two identifiers is required if specifying fulfillment location). If both are left blank, then Shipsi will apply business rules to determine a fulfillment location. If conflicting location ids are provided, the Shipsi ID will be used.
Retailer location ID to identify where order pickup will occur (can be used in lieu of Shipsi Location ID, but one of these two identifiers is required if specifying fulfillment location). If both are left blank, then Shipsi will apply business rules to determine a fulfillment location. If conflicting location ids are provided, the Shipsi ID will be used.
If this is set to true then SHIPSI will apply store rules to any rate quotes. Default is true if not provided. If false, rules such as operating hours, etc are not applied.
Object containing information for delivery destination
Address for the delivery destination
Address 2 for the delivery destination
City for the destination of delivery
State or Province for delivery destination
Country for the delivery destination. Default US.
Zip code for the delivery destination
Name of the product
Product type, such as "Alcohol", "Fragile" "Balloon". Currently defined by retailer.
Product Category sub-type, such as "Alcohol", "Fragile" "Balloon". Currently defined by retailer.
Quantity of product ordered
Listed price of product. This should be provided in cents.(So $24.99 should be 2499)
SKU identifier of the product (used for retailer reference in identifying item and reporting)
The cost of the item being delivered.
Volume of product (in packaging). Unit is cubic inches.
Dimensions of product, WxDxH (with packaging). Unit is inches.
Returns a rate object if the call succeeded.
Name of the delivery solution that Shipsi is providing
Description of Delivery solution
Required fulfillment/pick up location which quote is based on. (This is the Shipsi reference ID)
Required fulfillment/pick up location which quote is based on. (This is the retailer reference ID)
Delivery network through which this order is being placed to force a particular network. This should almost always be null/empty.
Quote code ID reference that is provided by Shipsi in the Rate API call.
Price to be presented to consumers based on business rules set in portal. This may not be representative of the actual cost of the delivery. This value will be presented in cents. (So $5.00 will return as 500)
Price for delivery through the Shipsi network. This value will be presented in cents. (So $5.00 will return as 500)
Currency code (ISO 4217)
ID of the sub account requested for get direct delivery rate.
This is an array of pre-qualified a group of stores to be considered for a specific delivery (typically if conducting location-level SKU inventory/eligibility outside Shipsi). Do not include this object to have Shipsi to search across all locations to find the optimal fulfillment location (requires Shipsi to have access to store level SKU availability).
Object containing the pickup or destination location information
Object containing direct pickup location and contact information
Object containing information for delivery destination
Address for the pickup or delivery destination
Address 2 for the pickup or delivery destination
City for the pickup or delivery destination
State or Province for pickup or delivery destination
Country for pickup or delivery destination
Zip code for pickup or delivery destination
Recipient or pickup contact email address
Recipient phone number to contact if needed or pickup contact
Recipient phone number country code or pickup contact
Name of the product
Product type, such as "Alcohol", "Fragile" "Balloon". Currently defined by retailer.
Product Category sub-type, such as "Alcohol", "Fragile" "Balloon". Currently defined by retailer.
Quantity of product ordered
Listed price of product. This should be provided in cents.(So $24.99 should be 2499)
SKU identifier of the product (used for retailer reference in identifying item and reporting)
The cost of the item being delivered.
Volume of product (in packaging). Unit is cubic inches.
Dimensions of product, WxDxH (with packaging). Unit is inches.
Returns a rate object if the call succeeded.
Name of the delivery solution that Shipsi is providing
Description of Delivery solution
Delivery network through which this order is being placed to force a particular network. This should almost always be null/empty.
Quote code ID reference that is provided by Shipsi in the Rate API call.
Price to be presented to consumers based on business rules set in portal. This may not be representative of the actual cost of the delivery. This value will be presented in cents. (So $5.00 will return as 500)
Price for delivery through the Shipsi network. This value will be presented in cents. (So $5.00 will return as 500)
Currency code (ISO 4217)
No problem! Get help now from our support team to get you up and running.
curl --location --request POST 'https://app.shipsi.com/api/v1/shippingrates/getrate' \
--header 'Content-Type: application/json' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: XXXXXXXXXXXXX' \
--header 'mode: live' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"qualified_pickup_locations": [{
"shipsi_location_id": "5be2b3e7830552b0756d4144",
"retailer_location_id": "1046"
},
{
"shipsi_location_id": "5b7ba0bb830552bb77070da2",
"retailer_location_id": "3181
"
}
],
"use_store_operating_logic": true
,
"destination": {
"location": {
"address_line1": "212 Pacific Ave",
"address_line2": "Apt 2",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"order_items": [{
"item_name": "Widget A",
"content_category": "",
"content_sub-category": "",
"quantity": "1
",
"price": "1600
",
"currency_code": "usd",
"sku": "A991",
"weight": "",
"volume": "",
"dimensions": ""
},
{
"item_name": "Widget B",
"content_category": "",
"content_sub-category": "",
"quantity": "1
",
"price": "1400
",
"currency_code": "usd",
"sku": "B991",
"weight": "",
"volume": "",
"dimensions": ""
}
]
}
}'
Example JSON API response
{
"service_name": "SHIPSI Instant Delivery",
"description": "3 hour delivery with real-time tracking.",
"shipsi_location_id": "5b7ba0bb830552bb77070da2",
"retailer_location_id": "3181
",
"delivery_network": "ts5",
"quote_code": "5f7492a8b21d8cb4474e720f",
"consumer_delivery_price": 1500
,
"shipsi_delivery_price": 1100
,
"currency_code": "usd",
"status": true,
"error_code": "",
"message": "All delivery rates."
}
curl --location --request POST 'https://app.shipsi.com/api/v1/shippingrates/getrate' \
--header 'Content-Type: application/json' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'mode: live' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"qualified_pickup_locations": [{
"shipsi_location_id": "5be2b3e7830552b0756d4144",
"retailer_location_id": "1046"
},
{
"shipsi_location_id": "5b7ba0bb830552bb77070da2",
"retailer_location_id": "3181
"
}
],
"use_store_operating_logic": true
,
"destination": {
"location": {
"address_line1": "212 Pacific Ave",
"address_line2": "Apt 2",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"order_items": [{
"item_name": "Widget A",
"content_category": "",
"content_sub-category": "",
"quantity": "1
",
"price": "1600
",
"currency_code": "usd",
"sku": "A991",
"weight": "",
"volume": "",
"dimensions": ""
},
{
"item_name": "Widget B",
"content_category": "",
"content_sub-category": "",
"quantity": "1
",
"price": "1400
",
"currency_code": "usd",
"sku": "B991",
"weight": "",
"volume": "",
"dimensions": ""
}
]
}
}'
Example JSON API response
{
"service_name": "SHIPSI Instant Delivery",
"description": "3 hour delivery with real-time tracking.",
"shipsi_location_id": "5b7ba0bb830552bb77070da2",
"retailer_location_id": "3181
",
"delivery_network": "ts5",
"quote_code": "5f7492a8b21d8cb4474e720f",
"consumer_delivery_price": 1500
,
"shipsi_delivery_price": 1100
,
"currency_code": "usd",
"status": true,
"error_code": "",
"message": "All delivery rates."
}
curl --location --request POST 'https://app.shipsi.com/api/v1/shippingrates/getrate' \
--header 'Content-Type: application/json' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'mode: live' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"qualified_pickup_locations": [{
"shipsi_location_id": "5be2b3e7830552b0756d4144",
"retailer_location_id": "1046"
},
{
"shipsi_location_id": "5b7ba0bb830552bb77070da2",
"retailer_location_id": "3181
"
}
],
"use_store_operating_logic": true
,
"destination": {
"location": {
"address_line1": "212 Pacific Ave",
"address_line2": "Apt 2",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"order_items": [{
"item_name": "Widget A",
"content_category": "",
"content_sub-category": "",
"quantity": "1
",
"price": "1600
",
"currency_code": "usd",
"sku": "A991",
"weight": "",
"volume": "",
"dimensions": ""
},
{
"item_name": "Widget B",
"content_category": "",
"content_sub-category": "",
"quantity": "1
",
"price": "1400
",
"currency_code": "usd",
"sku": "B991",
"weight": "",
"volume": "",
"dimensions": ""
}
]
}
}'
Example JSON API response
{
"service_name": "SHIPSI Instant Delivery",
"description": "3 hour delivery with real-time tracking.",
"shipsi_location_id": "5b7ba0bb830552bb77070da2",
"retailer_location_id": "3181
",
"delivery_network": "ts5",
"quote_code": "5f7492a8b21d8cb4474e720f",
"consumer_delivery_price": 1500
,
"shipsi_delivery_price": 1100
,
"currency_code": "usd",
"status": true,
"error_code": "",
"message": "All delivery rates."
}
curl --location --request POST 'https://app.shipsi.com/api/v1/shippingrates/getrate' \
--header 'Content-Type: application/json' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'mode: live' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"qualified_pickup_locations": [{
"shipsi_location_id": "5be2b3e7830552b0756d4144",
"retailer_location_id": "1046"
},
{
"shipsi_location_id": "5b7ba0bb830552bb77070da2",
"retailer_location_id": "3181
"
}
],
"use_store_operating_logic": true
,
"destination": {
"location": {
"address_line1": "212 Pacific Ave",
"address_line2": "Apt 2",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"order_items": [{
"item_name": "Widget A",
"content_category": "",
"content_sub-category": "",
"quantity": "1
",
"price": "1600
",
"currency_code": "usd",
"sku": "A991",
"weight": "",
"volume": "",
"dimensions": ""
},
{
"item_name": "Widget B",
"content_category": "",
"content_sub-category": "",
"quantity": "1
",
"price": "1400
",
"currency_code": "usd",
"sku": "B991",
"weight": "",
"volume": "",
"dimensions": ""
}
]
}
}'
Example JSON API response
{
"service_name": "SHIPSI Instant Delivery",
"description": "3 hour delivery with real-time tracking.",
"shipsi_location_id": "5b7ba0bb830552bb77070da2",
"retailer_location_id": "3181
",
"delivery_network": "ts5",
"quote_code": "5f7492a8b21d8cb4474e720f",
"consumer_delivery_price": 1500
,
"shipsi_delivery_price": 1100
,
"currency_code": "usd",
"status": true,
"error_code": "",
"message": "All delivery rates."
}
curl --location --request POST 'https://app.shipsi.com/api/v1/shippingrates/getrate' \
--header 'Content-Type: application/json' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'mode: live' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"qualified_pickup_locations": [{
"shipsi_location_id": "5be2b3e7830552b0756d4144",
"retailer_location_id": "1046"
},
{
"shipsi_location_id": "5b7ba0bb830552bb77070da2",
"retailer_location_id": "3181
"
}
],
"use_store_operating_logic": true
,
"destination": {
"location": {
"address_line1": "212 Pacific Ave",
"address_line2": "Apt 2",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"order_items": [{
"item_name": "Widget A",
"content_category": "",
"content_sub-category": "",
"quantity": "1
",
"price": "1600
",
"currency_code": "usd",
"sku": "A991",
"weight": "",
"volume": "",
"dimensions": ""
},
{
"item_name": "Widget B",
"content_category": "",
"content_sub-category": "",
"quantity": "1
",
"price": "1400
",
"currency_code": "usd",
"sku": "B991",
"weight": "",
"volume": "",
"dimensions": ""
}
]
}
}'
Example JSON API response
{
"service_name": "SHIPSI Instant Delivery",
"description": "3 hour delivery with real-time tracking.",
"shipsi_location_id": "5b7ba0bb830552bb77070da2",
"retailer_location_id": "3181
",
"delivery_network": "ts5",
"quote_code": "5f7492a8b21d8cb4474e720f",
"consumer_delivery_price": 1500
,
"shipsi_delivery_price": 1100
,
"currency_code": "usd",
"status": true,
"error_code": "",
"message": "All delivery rates."
}
curl --location --request POST 'https://app.shipsi.com/api/v1/shippingrates/getrate' \
--header 'Content-Type: application/json' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'mode: live' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"qualified_pickup_locations": [{
"shipsi_location_id": "5be2b3e7830552b0756d4144",
"retailer_location_id": "1046"
},
{
"shipsi_location_id": "5b7ba0bb830552bb77070da2",
"retailer_location_id": "3181
"
}
],
"use_store_operating_logic": true
,
"destination": {
"location": {
"address_line1": "212 Pacific Ave",
"address_line2": "Apt 2",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"order_items": [{
"item_name": "Widget A",
"content_category": "",
"content_sub-category": "",
"quantity": "1
",
"price": "1600
",
"currency_code": "usd",
"sku": "A991",
"weight": "",
"volume": "",
"dimensions": ""
},
{
"item_name": "Widget B",
"content_category": "",
"content_sub-category": "",
"quantity": "1
",
"price": "1400
",
"currency_code": "usd",
"sku": "B991",
"weight": "",
"volume": "",
"dimensions": ""
}
]
}
}'
Example JSON API response
{
"service_name": "SHIPSI Instant Delivery",
"description": "3 hour delivery with real-time tracking.",
"shipsi_location_id": "5b7ba0bb830552bb77070da2",
"retailer_location_id": "3181
",
"delivery_network": "ts5",
"quote_code": "5f7492a8b21d8cb4474e720f",
"consumer_delivery_price": 1500
,
"shipsi_delivery_price": 1100
,
"currency_code": "usd",
"status": true,
"error_code": "",
"message": "All delivery rates."
}
curl --location --request POST 'https://app.shipsi.com/api/v1/shippingrates/getrate' \
--header 'Content-Type: application/json' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'mode: live' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"qualified_pickup_locations": [{
"shipsi_location_id": "5be2b3e7830552b0756d4144",
"retailer_location_id": "1046"
},
{
"shipsi_location_id": "5b7ba0bb830552bb77070da2",
"retailer_location_id": "3181
"
}
],
"use_store_operating_logic": true
,
"destination": {
"location": {
"address_line1": "212 Pacific Ave",
"address_line2": "Apt 2",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"order_items": [{
"item_name": "Widget A",
"content_category": "",
"content_sub-category": "",
"quantity": "1
",
"price": "1600
",
"currency_code": "usd",
"sku": "A991",
"weight": "",
"volume": "",
"dimensions": ""
},
{
"item_name": "Widget B",
"content_category": "",
"content_sub-category": "",
"quantity": "1
",
"price": "1400
",
"currency_code": "usd",
"sku": "B991",
"weight": "",
"volume": "",
"dimensions": ""
}
]
}
}'
Example JSON API response
{
"service_name": "SHIPSI Instant Delivery",
"description": "3 hour delivery with real-time tracking.",
"shipsi_location_id": "5b7ba0bb830552bb77070da2",
"retailer_location_id": "3181
",
"delivery_network": "ts5",
"quote_code": "5f7492a8b21d8cb4474e720f",
"consumer_delivery_price": 1500
,
"shipsi_delivery_price": 1100
,
"currency_code": "usd",
"status": true,
"error_code": "",
"message": "All delivery rates."
}
curl -X GET \
'https://app.shipsi.com/api/v1/shippingrates/listrate?quote_code=5f6223beb21d8c6658c23c7f' \
-H 'cache-control: no-cache' \
-H 'content-type: application/json' \
-H 'mode: live' \
-H 'x-api-key: XXXXXXXXXX' \
-H 'x-api-pass: xxxxxxxxxxxxx'
Example JSON API response
{
"status": true,
"data": {
"listed_rates": {
"quote_code": "12345678000",
"all_rates": {
"postmate": {
"location_id": "111111111",
"delivery-network": "ts2",
"price": 10.99
},
"doordash": {
"location_id": "111111111",
"delivery-network": "ts5",
"price": 11.99
},
"nowninja": {
"location_id": "111111111",
"delivery-network": "ts7",
"price": 9.99
}
}
}
},
"message": "Data found"
}
curl -X POST \
https://app.shipsi.com/api/v1/shippingrates/comparerate \
-H 'cache-control: no-cache' \
-H 'content-type: application/json' \
-H 'mode: live' \
-H 'x-api-key: XXXXXXXXXX' \
-H 'x-api-pass: xxxxxxxxxxxxx' \
-d '{
"compare_rates": {
"quote_code":["5f6223beb21d8c6658c23c7f"]
}
}'
Example JSON API response
{
"data": [
{
"compare_rates": {
"quote_code": "12345678000",
"destination": {
"address1": "2512 N Ontario St",
"address2": null,
"address3": null,
"city": "Burbank",
"province": "CA",
"country": "US",
"postal_code": "91504",
},
"items": [
{
"price": 199
,
"quantity": 199
,
"weight": null,
"sku": "362-2631-48",
}
],
"rates": {
"location_id": "5ad469445a5146e0b67fe28f",
"deliver_network": "ts2",
"price": 700
}
}
}
{
"compare_rates": {
"quote_code": "13345879949",
"destination": {
"address1": "2517 S James St",
"address2": null,
"address3": null,
"city": "Burbank",
"province": "CA",
"country": "US",
"postal_code": "91504",
},
"items": [
{
"price": 499
,
"quantity": 2
,
"weight": null,
"sku": "512-2911-48",
}
],
"rates": {
"location_id": "5ad469445a5146e0b67fe28f",
"deliver_network": "ts2",
"price": 450
}
}
}
],
"status": true,
"error_code": "",
"message": "Data found"
}
Example JSON API response
{
"rates": [
{
"service_name": "SHIPSI delivery",
"description": "30 hour delivery",
"locationid": "5b7ba0bb830552bb77070da2",
"delivery_network": "ts2",
"quote_code": "dqt_MKxwToNW2gfr6k",
"total_price": "832",
"currency": "usd",
"dropoff_eta": "24"
}
],
"message": "All delivery rates."
}
Example JSON API response
{
"rates": [
{
"service_name": "SHIPSI delivery",
"description": "30 hour delivery",
"locationid": "5b7ba0bb830552bb77070da2",
"delivery_network": "ts2",
"quote_code": "dqt_MKxwToNW2gfr6k",
"total_price": "832",
"currency": "usd",
"dropoff_eta": "24"
}
],
"message": "All delivery rates."
}
Example JSON API response
{
"rates": [
{
"service_name": "SHIPSI delivery",
"description": "30 hour delivery",
"locationid": "5b7ba0bb830552bb77070da2",
"delivery_network": "ts2",
"quote_code": "dqt_MKxwToNW2gfr6k",
"total_price": "832",
"currency": "usd",
"dropoff_eta": "24"
}
],
"message": "All delivery rates."
}
curl --location --request POST 'https://app.shipsi.com/api/v1/direct/getrate' \
--header 'Content-Type: application/json' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'mode: live' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"qualified_pickup_locations": {
"direct_delivery_pickup": {
"location": {
"address_line1": "400 Jefferson St",
"address_line2": "",
"city": "San Francisco",
"state": "CA",
"zip_code": "94109
",
"country": "US"
}
}
},
"destination": {
"location": {
"address_line1": "212 Pacific Ave",
"address_line2": "Apt 2",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"order_items": [{
"item_name": "Widget A",
"content_category": "",
"content_sub-category": "",
"quantity": "1
",
"price": "1600
",
"currency_code": "usd",
"sku": "A991",
"weight": "",
"volume": "",
"dimensions": ""
},
{
"item_name": "Widget B",
"content_category": "",
"content_sub-category": "",
"quantity": "1
",
"price": "1400
",
"currency_code": "usd",
"sku": "B991",
"weight": "",
"volume": "",
"dimensions": ""
}
]
}
}'
Example JSON API response
{
"service_name": "SHIPSI Instant Delivery",
"description": "3 hour delivery with real-time tracking.",
"delivery_network": "ts5",
"quote_code": "5f7492a8b21d8cb4474e720f",
"consumer_delivery_price": 1500
,
"shipsi_delivery_price": 1100
,
"currency_code": "usd",
"status": true,
"error_code": "",
"message": "All delivery rates.",
"direct_delivery_pickup": {
"location": {
"address_line1": "400 Jefferson St",
"address_line2": "",
"city": "San Francisco",
"state": "CA",
"zip_code": "94109
",
"country": "US"
}
}
}