Shipsi’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 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, 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
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 Create Delivery API request will return order IDs. Those order 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, programmatically schedule deliveries or cancel them with ease.
Below we will explore how to Create and Cancel Delivery.
POST a request for delivery to the Create Delivery resource
You will also need the order_id to use the Cancel resource
To use the Create Delivery resource, make an HTTPS POST to the resource:
ID of the sub account requested for create delivery.
Unique order identifer from the retailer system. This is the Order Number or Order ID. Typically generated from your e-commerce platform and used as the order reference by your organization/associates.
Providing a date/time will schedule a pickup at this time. If null value/empty string is provided, the order is scheduled for pick up immediately. If the value provided is "TBD", then the delivery is stored in the system pending a separate API call to schedule delivery. A datetime in the past will produce an error.
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.
This is the time the consumer order was placed on the retailer system.
For retailers who have multiple unique order IDs, this can be used to store a different reference to the order (this is not typically used but provided as an alternative reference number for retailers)
If the Boolean is set to true, then the driver will verify ID and confirm the recipient name and he/she meets the age criteria for delivery. Default is false (if not specified) This may be set automatically if item level taxonomies (category/subcategory) are used.
If the Boolean is set to true, then the driver will require a signature in order to complete this delivery. Default is false (if not specified). This may be set automatically if item level taxonomies (category/subcategory) are used.
Total cost of the order (inclusive of items, delivery, tax). Presented in cents ($31.52 should be 3152)
Total tax applied to the order. Presented in cents ($4.05 should be 405)
This is the shipping fee that has been collected from the consumer in placing this delivery. This would be inclusive of any shipping discounts, shipping cost overrides, etc. It is only used for reporting purposes.
Delivery network through which this order is being placed to force a particular network. This should almost always be null/empty.
Delivery notes provided to the delivery partner/driver
Identifying information about how the delivery/order was placed (examples could include Associate ID, Store IDs, Retail Channel, etc)
If this is set to true then add the pack time to the create delivery request. It will also add to the requested_date_time of pickup (time). If this is set to false, then no additional time is added to the delivery time (and if no requested date time of pickup is included, delivery is scheduled for earliest available time)
If this is set to true then SHIPSI will apply store rules to any create delivery calls. Default is true if not provided. If false, rules such as operating hours, etc are not applied.
Object array containing the items in the order
Title of the item
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)
Currency code (ISO 4217)
SKU identifier of the product (used for retailer reference in identifying item and reporting)
Weight of product (with packaging). Unit in lbs.
Volume of product (in packaging). Unit is cubic inches.
Dimensions of product, WxDxH (with packaging). Unit is inches.
Object containing information for delivery destination
Object containing the destination location information
Address for the delivery destination
Address 2 for the delivery destination
This identifies the destination as either Residential or Business
These are specific requirements to access the destination (such as gate access codes)
City for the destination of delivery
State or Province for delivery destination
Country for the delivery destination. US is default.
Zip code for the delivery destination
Recipient first name
Recipient last name
Business name for delivery destination
Recipient email address
Recipient phone number to contact if needed
Recipient phone number country code
Using Shipsi's REST API, programmatically schedule deliveries or cancel them with ease.
Below we will explore how to Create and Cancel Delivery.
POST a request for delivery to the Create Delivery resource
You will also need the order_id to use the Cancel resource
To use the Create Direct Delivery resource, make an HTTPS POST to the resource:
ID of the sub account requested for create direct delivery.
Unique order identifer from the retailer system. This is the Order Number or Order ID. Typically generated from your e-commerce platform and used as the order reference by your organization/associates.
Providing a date/time will schedule a pickup at this time. If null value/empty string is provided, the order is scheduled for pick up immediately. If the value provided is "TBD", then the delivery is stored in the system pending a separate API call to schedule delivery. A datetime in the past will produce an error.
This is the time the consumer order was placed on the retailer system.
For retailers who have multiple unique order IDs, this can be used to store a different reference to the order (this is not typically used but provided as an alternative reference number for retailers)
If the Boolean is set to true, then the driver will verify ID and confirm the recipient name and he/she meets the age criteria for delivery. Default is false (if not specified) This may be set automatically if item level taxonomies (category/subcategory) are used.
If the Boolean is set to true, then the driver will require a signature in order to complete this delivery. Default is false (if not specified). This may be set automatically if item level taxonomies (category/subcategory) are used.
Total cost of the order (inclusive of items, delivery, tax). Presented in cents ($31.52 should be 3152)
Total tax applied to the order. Presented in cents ($4.05 should be 405)
This is the shipping fee that has been collected from the consumer in placing this delivery. This would be inclusive of any shipping discounts, shipping cost overrides, etc. It is only used for reporting purposes.
Delivery network through which this order is being placed to force a particular network. This should almost always be null/empty.
Delivery notes provided to the delivery partner/driver
Identifying information about how the delivery/order was placed (examples could include Associate ID, Store IDs, Retail Channel, etc)
Object array containing the items in the order
Title of the item
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)
Currency code (ISO 4217)
SKU identifier of the product (used for retailer reference in identifying item and reporting)
Weight of product (with packaging). Unit in lbs.
Volume of product (in packaging). Unit is cubic inches.
Dimensions of product, WxDxH (with packaging). Unit is inches.
Object containing information for pickup location
Object containing information for delivery destination
Object containing the pickup or destination location information
Address for the pickup or delivery destination
Address 2 for the pickup or delivery destination
This identifies the destination as either Residential or Business
These are specific requirements to access the destination (such as gate access codes)
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 first name
Recipient last name
Business name for 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
ID of the sub account requested for schedule delivery.
Unique order id generated by our system to identify each delivery.
Unique shipsi delivery id generated by our system to identify each delivery.
Unique order id generated by our system to identify each delivery.
Location id for each delivery.
Retailer location id of the delivery.
Returns a success code if the call succeeded.
ID of the sub account requested for cancel delivery.
Order id of the delivery.
Unique delivery id generated by our system to identify each delivery.
Returns a success code if the call succeeded.
ID of the sub account requested for delivery eligibility check.
This is the zip code provided by the client (typically from the consumer) that is the destination zip code for delivery.
This is the identifier used across your systems. It is passed in as the unique identifier of the items to be checked for fulfillment (such as the items in cart), and this same identifier needs to be available in your IMS to determine available qty for fulfillment.
This is the zip code provided by the client (typically from the consumer) that is the destination zip code for delivery.
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). This is most likely the identifier to be used as it will also be the identifier within your IMS.
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). This will always be passed, but can be ignored if the retailer_location_id is being used by your IMS.
Name of the delivery solution that Shipsi is providing.
Description of delivery solution.
This is the identifier used across your systems. It is passed in as the unique identifier of the items to checked for fulfillment (such as the items in cart), and this same identifier needs to be available in your IMS to determine available qty for fulfillment.
This is the inventory available to sell for the particular SKU at the specified fulfillment location (specified by either a retailer_location_id or shipsi_location_id). This number should account for any inventory on hold, safety stock, or other criteria to determine availability. This number will be the quantity that SHIPSI considers available to sell-thru.
You can set your webhook URL via the self-serve portal to be notified about events that happen in real time for various resources.
For Create Delivery, webhooks can be configured receiving status updates on a specific order delivery with status event callbacks.
Webhook response format
Your webhook will receive additional callbacks as the delivery status changes for an order to reflect the current known status of the delivery
When you programmatically schedule a delivery with SHIPSI, you may want to be alerted to the various stages in that deliveries process and whether it is delivered successfully. By providing an Event Status Callback URL you will send all status alerts to this URL.
SHIPSI sends status event changes and updates to that URL any time one of these changes occurs.
Event Status
Description
Event Status
Description
finding driver
Finding driver
pickup in progress
Driver enroute to pickup location
(Tracking URL)
out for delivery
Delivery Picked up/enroute to destination
(Tracking URL)
delivered
Delivery Complete/Delivered
(Tracking URL)
cancel
Delivery Cancelled
(Tracking URL)
Your status delivery URL will receive an HTTPS POST request with the application/x-www-raw-urlencoded content type.
The body of the event status delivery message will look similar to what is shown to the right.
Your webhook will receive additional callbacks as the delivery status changes for an order to reflect the current known status of the delivery
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/delivery/createdelivery' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'x-product-id: xxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--header 'mode: live' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"order_id": "000000001",
"requested_date_and_time_of_pickup": "2020-10-02T12:00:00Z",
"shipsi_location_id": "5f6c7c48b21d8c725c206df2",
"retailer_location_id": "592831
",
"retailer_transaction_date": "2020-09-28 11:59:00",
"retailer_reference_order_id": "8229228
",
"id_verification_required": false
,
"signature_required": true
,
"order_total": "100
",
"order_tax": "0.00
",
"shipping_fee_collected": "100
",
"delivery_network": "ts2",
"delivery_notes": "Test",
"referral_reference": "ARodman",
"add_pack_time": false
,
"use_store_operating_logic": true
,
"order_items": [{
"item_name":"Item One",
"content_category": "CatOne",
"content_sub-category": "SubOne",
"quantity": "1
",
"price": "10
",
"currency_code": "USD",
"sku": "A99I",
"weight": "2
",
"volume": "5
",
"dimensions": "2-3-2"
},
{
"item_name":"Item Two",
"content_category": "Type two",
"content_sub-category": "Sub two",
"quantity": "1
",
"price": "1400
",
"currency_code": "usd",
"sku": "B991",
"weight": "2
",
"volume": "1
",
"dimensions": "1-2-1"
}
],
"destination": {
"location": {
"address_line1": "212 Pacific Ave",
"address_line2": "Apt 2",
"location_type": "Business",
"location_access_details": "Store",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"recipient": {
"first_name": "Winne",
"last_name": "Pooh",
"business_name": "Company",
"email": "wpooh@briar.com",
"phone": "212-981-3231",
"phone_code": "1
"
}
}
}'
Example JSON API response
{
"shipsi_delivery_id": "99324813131
",
"status": true,
"error_code": "",
"message": "Delivery created successfully.",
"tracking_url": "https://app.shipsi.com/shipsi-job-track/605a5372b21d8c423ecf2345
"
}
curl --location --request POST 'https://app.shipsi.com/api/v1/delivery/createdelivery' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'x-product-id: xxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--header 'mode: live' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"order_id": "000000001",
"requested_date_and_time_of_pickup": "2020-10-02T12:00:00Z",
"shipsi_location_id": "5f6c7c48b21d8c725c206df2",
"retailer_location_id": "592831
",
"retailer_transaction_date": "2020-09-28 11:59:00",
"retailer_reference_order_id": "8229228
",
"id_verification_required": false
,
"signature_required": true
,
"order_total": "100
",
"order_tax": "0.00
",
"shipping_fee_collected": "100
",
"delivery_network": "ts2",
"delivery_notes": "Test",
"referral_reference": "ARodman",
"add_pack_time": false
,
"use_store_operating_logic": true
,
"order_items": [{
"item_name":"Item One",
"content_category": "CatOne",
"content_sub-category": "SubOne",
"quantity": "1
",
"price": "10
",
"currency_code": "USD",
"sku": "A99I",
"weight": "2
",
"volume": "5
",
"dimensions": "2-3-2"
},
{
"item_name":"Item Two",
"content_category": "Type two",
"content_sub-category": "Sub two",
"quantity": "1
",
"price": "1400
",
"currency_code": "usd",
"sku": "B991",
"weight": "2
",
"volume": "1
",
"dimensions": "1-2-1"
}
],
"destination": {
"location": {
"address_line1": "212 Pacific Ave",
"address_line2": "Apt 2",
"location_type": "Business",
"location_access_details": "Store",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"recipient": {
"first_name": "Winne",
"last_name": "Pooh",
"business_name": "Company",
"email": "wpooh@briar.com",
"phone": "212-981-3231",
"phone_code": "1
"
}
}
}'
Example JSON API response
{
"shipsi_delivery_id": "99324813131
",
"status": true,
"error_code": "",
"message": "Delivery created successfully.",
"tracking_url": "https://app.shipsi.com/shipsi-job-track/605a5372b21d8c423ecf2345
"
}
curl --location --request POST 'https://app.shipsi.com/api/v1/delivery/createdelivery' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'x-product-id: xxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--header 'mode: live' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"order_id": "000000001",
"requested_date_and_time_of_pickup": "2020-10-02T12:00:00Z",
"shipsi_location_id": "5f6c7c48b21d8c725c206df2",
"retailer_location_id": "592831
",
"retailer_transaction_date": "2020-09-28 11:59:00",
"retailer_reference_order_id": "8229228
",
"id_verification_required": false
,
"signature_required": true
,
"order_total": "100
",
"order_tax": "0.00
",
"shipping_fee_collected": "100
",
"delivery_network": "ts2",
"delivery_notes": "Test",
"referral_reference": "ARodman",
"add_pack_time": false
,
"use_store_operating_logic": true
,
"order_items": [{
"item_name":"Item One",
"content_category": "CatOne",
"content_sub-category": "SubOne",
"quantity": "1
",
"price": "10
",
"currency_code": "USD",
"sku": "A99I",
"weight": "2
",
"volume": "5
",
"dimensions": "2-3-2"
},
{
"item_name":"Item Two",
"content_category": "Type two",
"content_sub-category": "Sub two",
"quantity": "1
",
"price": "1400
",
"currency_code": "usd",
"sku": "B991",
"weight": "2
",
"volume": "1
",
"dimensions": "1-2-1"
}
],
"destination": {
"location": {
"address_line1": "212 Pacific Ave",
"address_line2": "Apt 2",
"location_type": "Business",
"location_access_details": "Store",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"recipient": {
"first_name": "Winne",
"last_name": "Pooh",
"business_name": "Company",
"email": "wpooh@briar.com",
"phone": "212-981-3231",
"phone_code": "1
"
}
}
}'
Example JSON API response
{
"shipsi_delivery_id": "99324813131
",
"status": true,
"error_code": "",
"message": "Delivery created successfully.",
"tracking_url": "https://app.shipsi.com/shipsi-job-track/605a5372b21d8c423ecf2345
"
}
curl --location --request POST 'https://app.shipsi.com/api/v1/delivery/createdelivery' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'x-product-id: xxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--header 'mode: live' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"order_id": "000000001",
"requested_date_and_time_of_pickup": "2020-10-02T12:00:00Z",
"shipsi_location_id": "5f6c7c48b21d8c725c206df2",
"retailer_location_id": "592831
",
"retailer_transaction_date": "2020-09-28 11:59:00",
"retailer_reference_order_id": "8229228
",
"id_verification_required": false
,
"signature_required": true
,
"order_total": "100
",
"order_tax": "0.00
",
"shipping_fee_collected": "100
",
"delivery_network": "ts2",
"delivery_notes": "Test",
"referral_reference": "ARodman",
"add_pack_time": false
,
"use_store_operating_logic": true
,
"order_items": [{
"item_name":"Item One",
"content_category": "CatOne",
"content_sub-category": "SubOne",
"quantity": "1
",
"price": "10
",
"currency_code": "USD",
"sku": "A99I",
"weight": "2
",
"volume": "5
",
"dimensions": "2-3-2"
},
{
"item_name":"Item Two",
"content_category": "Type two",
"content_sub-category": "Sub two",
"quantity": "1
",
"price": "1400
",
"currency_code": "usd",
"sku": "B991",
"weight": "2
",
"volume": "1
",
"dimensions": "1-2-1"
}
],
"destination": {
"location": {
"address_line1": "212 Pacific Ave",
"address_line2": "Apt 2",
"location_type": "Business",
"location_access_details": "Store",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"recipient": {
"first_name": "Winne",
"last_name": "Pooh",
"business_name": "Company",
"email": "wpooh@briar.com",
"phone": "212-981-3231",
"phone_code": "1
"
}
}
}'
Example JSON API response
{
"shipsi_delivery_id": "99324813131
",
"status": true,
"error_code": "",
"message": "Delivery created successfully.",
"tracking_url": "https://app.shipsi.com/shipsi-job-track/605a5372b21d8c423ecf2345
"
}
curl --location --request POST 'https://app.shipsi.com/api/v1/delivery/createdelivery' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'x-product-id: xxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--header 'mode: live' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"order_id": "000000001",
"requested_date_and_time_of_pickup": "2020-10-02T12:00:00Z",
"shipsi_location_id": "5f6c7c48b21d8c725c206df2",
"retailer_location_id": "592831
",
"retailer_transaction_date": "2020-09-28 11:59:00",
"retailer_reference_order_id": "8229228
",
"id_verification_required": false
,
"signature_required": true
,
"order_total": "100
",
"order_tax": "0.00
",
"shipping_fee_collected": "100
",
"delivery_network": "ts2",
"delivery_notes": "Test",
"referral_reference": "ARodman",
"add_pack_time": false
,
"use_store_operating_logic": true
,
"order_items": [{
"item_name":"Item One",
"content_category": "CatOne",
"content_sub-category": "SubOne",
"quantity": "1
",
"price": "10
",
"currency_code": "USD",
"sku": "A99I",
"weight": "2
",
"volume": "5
",
"dimensions": "2-3-2"
},
{
"item_name":"Item Two",
"content_category": "Type two",
"content_sub-category": "Sub two",
"quantity": "1
",
"price": "1400
",
"currency_code": "usd",
"sku": "B991",
"weight": "2
",
"volume": "1
",
"dimensions": "1-2-1"
}
],
"destination": {
"location": {
"address_line1": "212 Pacific Ave",
"address_line2": "Apt 2",
"location_type": "Business",
"location_access_details": "Store",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"recipient": {
"first_name": "Winne",
"last_name": "Pooh",
"business_name": "Company",
"email": "wpooh@briar.com",
"phone": "212-981-3231",
"phone_code": "1
"
}
}
}'
Example JSON API response
{
"shipsi_delivery_id": "99324813131
",
"status": true,
"error_code": "",
"message": "Delivery created successfully.",
"tracking_url": "https://app.shipsi.com/shipsi-job-track/605a5372b21d8c423ecf2345
"
}
curl --location --request POST 'https://app.shipsi.com/api/v1/delivery/createdelivery' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'x-product-id: xxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--header 'mode: live' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"order_id": "000000001",
"requested_date_and_time_of_pickup": "2020-10-02T12:00:00Z",
"shipsi_location_id": "5f6c7c48b21d8c725c206df2",
"retailer_location_id": "592831
",
"retailer_transaction_date": "2020-09-28 11:59:00",
"retailer_reference_order_id": "8229228
",
"id_verification_required": false
,
"signature_required": true
,
"order_total": "100
",
"order_tax": "0.00
",
"shipping_fee_collected": "100
",
"delivery_network": "ts2",
"delivery_notes": "Test",
"referral_reference": "ARodman",
"add_pack_time": false
,
"use_store_operating_logic": true
,
"order_items": [{
"item_name":"Item One",
"content_category": "CatOne",
"content_sub-category": "SubOne",
"quantity": "1
",
"price": "10
",
"currency_code": "USD",
"sku": "A99I",
"weight": "2
",
"volume": "5
",
"dimensions": "2-3-2"
},
{
"item_name":"Item Two",
"content_category": "Type two",
"content_sub-category": "Sub two",
"quantity": "1
",
"price": "1400
",
"currency_code": "usd",
"sku": "B991",
"weight": "2
",
"volume": "1
",
"dimensions": "1-2-1"
}
],
"destination": {
"location": {
"address_line1": "212 Pacific Ave",
"address_line2": "Apt 2",
"location_type": "Business",
"location_access_details": "Store",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"recipient": {
"first_name": "Winne",
"last_name": "Pooh",
"business_name": "Company",
"email": "wpooh@briar.com",
"phone": "212-981-3231",
"phone_code": "1
"
}
}
}'
Example JSON API response
{
"shipsi_delivery_id": "99324813131
",
"status": true,
"error_code": "",
"message": "Delivery created successfully.",
"tracking_url": "https://app.shipsi.com/shipsi-job-track/605a5372b21d8c423ecf2345
"
}
curl --location --request POST 'https://app.shipsi.com/api/v1/delivery/createdelivery' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'x-product-id: xxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--header 'mode: live' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"order_id": "000000001",
"requested_date_and_time_of_pickup": "2020-10-02T12:00:00Z",
"shipsi_location_id": "5f6c7c48b21d8c725c206df2",
"retailer_location_id": "592831
",
"retailer_transaction_date": "2020-09-28 11:59:00",
"retailer_reference_order_id": "8229228
",
"id_verification_required": false
,
"signature_required": true
,
"order_total": "100
",
"order_tax": "0.00
",
"shipping_fee_collected": "100
",
"delivery_network": "ts2",
"delivery_notes": "Test",
"referral_reference": "ARodman",
"add_pack_time": false
,
"use_store_operating_logic": true
,
"order_items": [{
"item_name":"Item One",
"content_category": "CatOne",
"content_sub-category": "SubOne",
"quantity": "1
",
"price": "10
",
"currency_code": "USD",
"sku": "A99I",
"weight": "2
",
"volume": "5
",
"dimensions": "2-3-2"
},
{
"item_name":"Item Two",
"content_category": "Type two",
"content_sub-category": "Sub two",
"quantity": "1
",
"price": "1400
",
"currency_code": "usd",
"sku": "B991",
"weight": "2
",
"volume": "1
",
"dimensions": "1-2-1"
}
],
"destination": {
"location": {
"address_line1": "212 Pacific Ave",
"address_line2": "Apt 2",
"location_type": "Business",
"location_access_details": "Store",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"recipient": {
"first_name": "Winne",
"last_name": "Pooh",
"business_name": "Company",
"email": "wpooh@briar.com",
"phone": "212-981-3231",
"phone_code": "1
"
}
}
}'
Example JSON API response
{
"shipsi_delivery_id": "99324813131
",
"status": true,
"error_code": "",
"message": "Delivery created successfully."
"tracking_url": "https://app.shipsi.com/shipsi-job-track/605a5372b21d8c423ecf2345
"
}
curl -X PUT \
https://app.shipsi.com/api/v1/delivery/editdelivery \
-H 'cache-control: no-cache' \
-H 'content-type: application/json' \
-H 'mode: live' \
-H 'x-api-key: XXXXXXXXXX' \
-H 'x-api-pass: xxxxxxxxxxxxx' \
-d '{
"deliveryid":"5eba5088ef18e8d31e684f91",
"items": [
{
"title": "Test",
"item_content_category": "ty",
"item_content_sub-category": "sub",
"item_quantity": "12
",
"item_price": "123
",
"currency_code": "USD",
"item_sku": "2922",
"item_weight" : "3
",
"item_volume" : "2
",
"item_dimensions" : "L-W-H (recommended)"
}
],
"dropoff": {
"location": {
"delivery_address_line_1" : "Miami Beach",
"delivery_address_line_2" : "FL1",
"delivery_location_type": "Business",
"delivery_access_details": "Kleen",
"delivery_city" : "Miami",
"delivery_state" : "FL",
"delivery_country" : "US",
"delivery_zip_code" : "922829"
}
},
"dropoff_recipient": {
"recipient_first_name": "Jhon",
"recipient_last_name": "Doe",
"recipient_business_name": "Test Company",
"recipient_email": "test@test.com",
"recipient_phone_number" : "9330339330
",
"recipient_phone_country_code": "21
"
}
}'
Example JSON API response
{
"status": true,
"error_code": "",
"message": "Delivery has been successfully updated"
}
curl --location --request GET 'https://app.shipsi.com/api/v1/delivery/listdeliveries?delivery_id=5f7186d3b21d8cf45e4e720e&page=1&limit=1' \
--header 'Content-Type: application/json' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'mode: live' \
Example JSON API response
{
"data": [
{
"delivery_id": "5dbc201a830552a837486588",
"platform_order_number": "1
",
"scheduled_datetime": "2019-11-01 14:30:00",
"location_id": "5b7ba0bb830552bb77070da2",
"transaction_date": "",
"suborder_id": "",
"total_price": "",
"Total_tax": "",
"delivery_network": "ts2",
"delivery_notes": "",
"referring_id": "",
"items": [
{
"title": "12IN blue latex balloons",
"quantity": "1
",
"price": "",
"currency_code": "",
"sku": "",
"variant": "",
"grams": ""
}
],
"dropoff": {
"location": {
"address1": "3181 Northeast 165th Street",
"address_2": "North Miami Beach",
"city": "Miami",
"province": "FL",
"zip": "33441
",
"country": "US",
"latitude": "",
"longitude": "",
"address": ""
}
},
"dropoff_recipient": {
"first_name": "",
"last_name": "",
"company_name": "",
"email": "",
"zip": "",
"phone": "862-210-4613
",
"phone_code": "",
"address1": "25 Green Pond Rd",
"address2": "",
"city": "Rockaway",
"province": "NJ",
"country": "US"
}
},
{
"delivery_id": "5dbc21b68305525240486581",
"platform_order_number": "2
",
"scheduled_datetime": "2019-11-01 14:30:00",
"location_id": "5b7ba0bb830552bb77070da2",
"transaction_date": "",
"suborder_id": "",
"total_price": "",
"Total_tax": "",
"delivery_network": "ts2",
"delivery_notes": "",
"referring_id": "",
"items": [
{
"title": "12IN blue latex balloons",
"quantity": "1
",
"price": "",
"currency_code": "",
"sku": "",
"variant": "",
"grams": ""
}
],
"dropoff": {
"location": {
"address1": "3181 Northeast 165th Street",
"address_2": "North Miami Beach",
"city": "Miami",
"province": "FL",
"zip": "33441
",
"country": "US",
"latitude": "",
"longitude": "",
"address": ""
}
},
"dropoff_recipient": {
"first_name": "",
"last_name": "",
"company_name": "",
"email": "",
"zip": "",
"phone": "862-210-4613
",
"phone_code": "",
"address1": "25 Green Pond Rd",
"address2": "",
"city": "Rockaway",
"province": "NJ",
"country": "US"
}
}
],
"status": true,
"error_code": "success",
"message": "Delivery has been listed",
"total_count": 3
}
curl --location --request POST 'https://app.shipsi.com/api/v1/direct/createdelivery' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'x-product-id: xxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--header 'mode: live' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"order_id": "000000001",
"requested_date_and_time_of_pickup": "2020-10-02T12:00:00Z",
"retailer_transaction_date": "2020-09-28 11:59:00",
"retailer_reference_order_id": "8229228
",
"id_verification_required": false
,
"signature_required": true
,
"order_total": "100
",
"order_tax": "0.00
",
"shipping_fee_collected": "100
",
"delivery_network": "ts2",
"delivery_notes": "Test",
"referral_reference": "ARodman",
"order_items": [{
"item_name":"Item One",
"content_category": "CatOne",
"content_sub-category": "SubOne",
"quantity": "1
",
"price": "10
",
"currency_code": "USD",
"sku": "A99I",
"weight": "2
",
"volume": "5
",
"dimensions": "2-3-2"
},
{
"item_name":"Item Two",
"content_category": "Type two",
"content_sub-category": "Sub two",
"quantity": "1
",
"price": "1400
",
"currency_code": "usd",
"sku": "B991",
"weight": "2
",
"volume": "1
",
"dimensions": "1-2-1"
}
],
"direct_delivery_pickup": {
"location": {
"address_line1": "400 Jefferson St",
"address_line2": "Apt2",
"city": "San Francisco",
"state": "CA",
"zip_code": "94109
",
"country": "US",
"pickup_notes":"Ring bell twice",
"phone":"610-564-3322",
"phone_code":"1
",
"email":"wpooh@briar.com"
}
},
"destination": {
"location": {
"address_line1": "212 Pacific Ave",
"address_line2": "Apt 2",
"location_type": "Business",
"location_access_details": "Store",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"recipient": {
"first_name": "Winne",
"last_name": "Pooh",
"business_name": "Company",
"email": "wpooh@briar.com",
"phone": "212-981-3231",
"phone_code": "1
"
}
}
}'
Example JSON API response
{
"shipsi_delivery_id": "99324813131
",
"status": true,
"error_code": "",
"message": "Delivery created successfully."
"tracking_url": "https://app.shipsi.com/shipsi-job-track/605a5372b21d8c423ecf2345
"
}
curl -X PUT \
https://app.shipsi.com/api/canceldelivery \
-H 'cache-control: no-cache' \
-H 'content-type: application/json' \
-H 'mode: live' \
-H 'x-api-key: XXXXXXXXXX' \
-H 'x-api-pass: xxxxxxxxxxxxx' \
-d '{
"retailer_child_id" : "cus_XXXXXXX
",
"order_id": "#000105",
"shipsi_delivery_id": "5ef4b1b4ef18e8cc758b4568"
}'
Example JSON API response
{
"status": true,
"error_code": "",
"message": "Delivery canceled"
}
curl --location --request POST 'https://app.shipsi.com/api/v1/delivery_eligibilty_check' \
--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
",
"zip_code": "90291",
"sku_List": [
{
"sku": "Ring1-ABC"
},
{
"sku": "Necklace2-BBC"
}
]
}'
Example JSON API response
{
"zip_code": "90291
",
"service_name": "SHIPSI Same-Day Delivery (1-2 hours)",
"description": "Get it today within 2 hours.",
"shipsi_location_id": "603c18b1b21d8ce333ca5728
",
"retailer_location_id": "California Alternate Location",
"status": true,,
"error_code": "",
"sku_list": [
{
"retailer_location_id": "California Alternate Location",
"sku": "Ring1-ABC",
"qty_available_to_sell": "55
"
},
{
"retailer_location_id": "California Alternate Location",
"sku": "Necklace2-BBC",
"qty_available_to_sell": "22
"
}
]
}
curl --location --request POST 'https://app.shipsi.com/api/v1/delivery/schedule' \
--header 'Content-Type: application/json' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'mode: live' \
--header 'Cookie: ci_session=95b1ddaeb338d402193427261db8707ed658afec' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"order_id": "000108",
"shipsi_delivery_id": "5f74e888b21d8cf44b4e720f",
"requested_date_and_time_of_pickup": "2020-10-02T12:00:00Z",
"shipsi_location_id": "",
"retailer_location_id": ""
}'
Example JSON API response
{
"status": true,
"error_code": "",
"message": "Delivery scheduled"
}
curl --location --request POST 'https://xyz.com/' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'order_id: 5f6dd76bb21d8c7603206df13w' \
--header 'Content-Type: application/json' \
--data-raw '{
"order_id":"0000001046",
"shipsi_delivery_id":"920602ee2865319",
"event_status":"Finding Driver",
"tracking_url":"https://app.shipsi.com/track/20fhk09Kdjasw129ed3ek23me343",
"datetime":"2020-09-25 12:11:52"
}'
curl --location --request POST 'https://xyz.com/' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'order_id: 5f6dd76bb21d8c7603206df13w' \
--header 'Content-Type: application/json' \
--data-raw '{
"order_id":"0000001046",
"shipsi_delivery_id":"920602ee2865319",
"event_status":"Finding Driver",
"tracking_url":"https://app.shipsi.com/track/20fhk09Kdjasw129ed3ek23me343",
"datetime":"2020-09-25 12:11:52"
}'
curl --location --request POST 'https://xyz.com/' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'order_id: 5f6dd76bb21d8c7603206df13w' \
--header 'Content-Type: application/json' \
--data-raw '{
"order_id":"0000001046",
"shipsi_delivery_id":"920602ee2865319",
"event_status":"Finding Driver",
"tracking_url":"https://app.shipsi.com/track/20fhk09Kdjasw129ed3ek23me343",
"datetime":"2020-09-25 12:11:52"
}'
{
"status": true,
"error_code": "",
"message": "Job created successfully." "order_id": "#1234"
}
{
"status": true,
"error_code": "",
"message": "Job created successfully." "order_id": "#1234"
}
{
"status": true,
"error_code": "",
"message": "Job created successfully." "order_id": "#1234"
}