API ReferenceLocationsWebhooksShipsi’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
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 Location_Package API request will loation_packages. Those location_package 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, you can add new store locations, edit rules across stores, and effect changes to your all locations with a simple API call.
Below we'll explore how you can use Shipsi’s location API to do so.
Add a pick-up location by posting to the Locations resource.
You will also need the location_id to use the Edit, List, and Location Packages resource.
To use the Locations resource, make an HTTPS POST to the resource:
Retailer location ID is used to identify where order pickups 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 typically the retailer's internal reference ID or name for a location. If conflicting location ids are provided, the Shipsi ID will be used.
Boolean if this location is participating in shipsi (default is true)
Location manager name / main contact at location responsible for delivery
Main number to the location
Contact mobile phone number (and where text notifications will be sent). Multiple values can be sent as an array.
Notification address where delivery updates and new pending deliveries are sent. Multiple values can be sent as an array.
Boolean if text notifications should be sent when pick up is nearby (default is false)
Pick up notes (ie go to front register, etc)
Object that contains the location address details
Address of pickup location
Address 2 of pickup location
City of pickup location
State or Province of pickup location
Country of pickup location (default is US)
Zip code of pickup location
Maximum weight of products for delivery at location. Must be greater than zero. Unit is lbs. (Default is 5)
Maximum radius for delivery of items. Must be greater than zero. Unit is miles. (Default is 10)
The country code of the location.
The alternate phone code of the location.
The alternate telephone number of the location.
The notification email address of the location.
The exact word match for the location.
The exact word not matched for the location.
The range from the location.
The range to the location.
The active days for the location.
The incative days for the location.
The location package name for the location.
The extension number.
The maximum allowed delivery radius in miles for a customer to be eligible for delivery from this location.
The location delivery time promoted.
Time (in minutes) needed at location to prepare and order. This should always be provided as it is used to ensure the store has adequate time to prepare an order before closing. Must be greater than zero. (Default is 10)
Timezone of the location
Object that contains an array of days of the week. Each day contains hours of operation for this location.(opening and closing).
Returns a success code if a location is added successfully.
Retail id of the location
The primary contact at the location.
The main phone number of the location.
The phone number of the location.
The eligible shipsi location.
Sending notification when pickup is ready.
Location pickup notes.
Recipient delivery address line one.
Recipient delivery address line second.
The city of the location.
The state of the location.
The country of the location.
The zip code of the location.
The maximum allowed weight of delivers to be eligible for pickup from this location.
The max delivery radius.
The country code of the location.
The alternate phone code of the location.
The alternate telephone number of the location.
The notification email address of the location.
The exact word match for the location.
The exact word not matched for the location.
The range from the location.
The range to the location.
The active days for the location.
The incative days for the location.
The location package name for the location.
The extension number.
The maximum allowed delivery radius in miles for a customer to be eligible for delivery from this location.
The location delivery time promoted.
The amount of time in which the location needs to prepare an order after it being scheduled for delivery from the location.
The timezone which the location is in.
The days and hours which the location is open and available each week.
The date and hours which the location is open and overrides operation_hours.
Returns a success code with the edit location is updated successfully.
You can set your IMS webhook URL via the self-serve portal, and SHIPSI will connect to your inventory management system (IMS) to request information about SKU availability and quantity for your local fulfillment locations and where fulfillment should occur.
y providing and IMS webhook you will enable to SHIPSI to perform a real-time check of your inventory levels to determine which locations can fulfill the entirety of the delivery for pickup. This webhook can connect to wherever you maintain information about your fulfillment location inventory (web store, order management system, inventory management system, etc).
You do not need to provide an IMS webhook if you are pre-determining inventory/fulfillment locations through your own systems, or if you do not need to qualify for inventory levels at locations (such as always available stock), or if you are using a pre-integrated platform (such as Shopify) with local inventory visible.
Your IMS webhook URL will receive an HTTPS POST request with the application/x-www-raw-urlencoded content type.
ID of the sub account requested for check inventory.
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.
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.
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.
ORShipsi 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.
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 is available to sell-thru.
No problem! Get help now from our support team to get you up and running.
curl -X POST \
https://app.shipsi.com/api/v1/locations/addlocation \
-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_location_id": "aae",
"eligible_shipsi_location": true,
"location_manager_name": "test",
"location_main_line_phone_number": "610-592-1321",
"notification_cell_phone_number":["281-763-5455
"],
"notification_email_address": ["rye@shipsi.com"],
"send_notification_when_pickup_nearby": false,
"location_pickup_notes": "Come to customer service area",
"pickup_location": {
"address_line1": "677 South Marengo Avenue, Pasadena, CA, USA",
"address_line2": "Suite 200",
"city": "Los Angeles County",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"max_delivery_weight": "",
"max_delivery_radius": "",
"alternate_country_code":[
"US"
],
"alternate_phone_code":[
"1
"
],
"pick_and_pack_time": "30
",
"location_timezone": "EST",
"operating_hours": {
"Sunday": {
"open": "10:00",
"close": "18:00"
},
"Monday": {
"open": "10:00",
"close": "18:00"
},
"Tuesday": {
"open": "10:00",
"close": "18:00"
},
"Wednesday": {
"open": "10:00",
"close": "18:00"
},
"Thursday": {
"open": "10:00",
"close": "18:00"
},
"Friday": {
"open": "10:00",
"close": "18:00"
},
"Saturday": {
"open": "10:00",
"close": "18:00"
}
},
"extension_no":"1
",
"Location_delivery_promoted_time":"300
",
"sku_filter":{
"type":"inclusion",
"Exact_words_match":"test",
"Exact_words_notmatch":"test_text",
"Range_from":"10
",
"Range_to":"20
"
},
"holiday_calender":{
"active_dates":["2020-09-29"],
"inactive_dates":["2020-09-30"]
},
"location_package":""
}'
Example JSON API response
{
"shipsi_location_id": "5f745156b21d8c493f4e720e",
"status": true,
"error_code": "",
"message": "Location has been successfully saved"
}
curl -X POST \
https://app.shipsi.com/api/v1/locations/addlocation \
-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_location_id": "aae",
"eligible_shipsi_location": true,
"location_manager_name": "test",
"location_main_line_phone_number": "610-592-1321",
"notification_cell_phone_number":["281-763-5455
"],
"notification_email_address": ["rye@shipsi.com"],
"send_notification_when_pickup_nearby": false,
"location_pickup_notes": "Come to customer service area",
"pickup_location": {
"address_line1": "677 South Marengo Avenue, Pasadena, CA, USA",
"address_line2": "Suite 200",
"city": "Los Angeles County",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"max_delivery_weight": "",
"max_delivery_radius": "",
"alternate_country_code":[
"US"
],
"alternate_phone_code":[
"1
"
],
"pick_and_pack_time": "30
",
"location_timezone": "EST",
"operating_hours": {
"Sunday": {
"open": "10:00",
"close": "18:00"
},
"Monday": {
"open": "10:00",
"close": "18:00"
},
"Tuesday": {
"open": "10:00",
"close": "18:00"
},
"Wednesday": {
"open": "10:00",
"close": "18:00"
},
"Thursday": {
"open": "10:00",
"close": "18:00"
},
"Friday": {
"open": "10:00",
"close": "18:00"
},
"Saturday": {
"open": "10:00",
"close": "18:00"
}
},
"extension_no":"1
",
"Location_delivery_promoted_time":"300
",
"sku_filter":{
"type":"inclusion",
"Exact_words_match":"test",
"Exact_words_notmatch":"test_text",
"Range_from":"10
",
"Range_to":"20
"
},
"holiday_calender":{
"active_dates":["2020-09-29"],
"inactive_dates":["2020-09-30"]
},
"location_package":""
}'
Example JSON API response
{
"shipsi_location_id": "5f745156b21d8c493f4e720e",
"status": true,
"error_code": "",
"message": "Location has been successfully saved"
}
curl -X POST \
https://app.shipsi.com/api/v1/locations/addlocation \
-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_location_id": "aae",
"eligible_shipsi_location": true,
"location_manager_name": "test",
"location_main_line_phone_number": "610-592-1321",
"notification_cell_phone_number":["281-763-5455
"],
"notification_email_address": ["rye@shipsi.com"],
"send_notification_when_pickup_nearby": false,
"location_pickup_notes": "Come to customer service area",
"pickup_location": {
"address_line1": "677 South Marengo Avenue, Pasadena, CA, USA",
"address_line2": "Suite 200",
"city": "Los Angeles County",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"max_delivery_weight": "",
"max_delivery_radius": "",
"alternate_country_code":[
"US"
],
"alternate_phone_code":[
"1
"
],
"pick_and_pack_time": "30
",
"location_timezone": "EST",
"operating_hours": {
"Sunday": {
"open": "10:00",
"close": "18:00"
},
"Monday": {
"open": "10:00",
"close": "18:00"
},
"Tuesday": {
"open": "10:00",
"close": "18:00"
},
"Wednesday": {
"open": "10:00",
"close": "18:00"
},
"Thursday": {
"open": "10:00",
"close": "18:00"
},
"Friday": {
"open": "10:00",
"close": "18:00"
},
"Saturday": {
"open": "10:00",
"close": "18:00"
}
},
"extension_no":"1
",
"Location_delivery_promoted_time":"300
",
"sku_filter":{
"type":"inclusion",
"Exact_words_match":"test",
"Exact_words_notmatch":"test_text",
"Range_from":"10
",
"Range_to":"20
"
},
"holiday_calender":{
"active_dates":["2020-09-29"],
"inactive_dates":["2020-09-30"]
},
"location_package":""
}'
Example JSON API response
{
"shipsi_location_id": "5f745156b21d8c493f4e720e",
"status": true,
"error_code": "",
"message": "Location has been successfully saved"
}
curl -X POST \
https://app.shipsi.com/api/v1/locations/addlocation \
-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_location_id": "aae",
"eligible_shipsi_location": true,
"location_manager_name": "test",
"location_main_line_phone_number": "610-592-1321",
"notification_cell_phone_number":["281-763-5455
"],
"notification_email_address": ["rye@shipsi.com"],
"send_notification_when_pickup_nearby": false,
"location_pickup_notes": "Come to customer service area",
"pickup_location": {
"address_line1": "677 South Marengo Avenue, Pasadena, CA, USA",
"address_line2": "Suite 200",
"city": "Los Angeles County",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"max_delivery_weight": "",
"max_delivery_radius": "",
"alternate_country_code":[
"US"
],
"alternate_phone_code":[
"1
"
],
"pick_and_pack_time": "30
",
"location_timezone": "EST",
"operating_hours": {
"Sunday": {
"open": "10:00",
"close": "18:00"
},
"Monday": {
"open": "10:00",
"close": "18:00"
},
"Tuesday": {
"open": "10:00",
"close": "18:00"
},
"Wednesday": {
"open": "10:00",
"close": "18:00"
},
"Thursday": {
"open": "10:00",
"close": "18:00"
},
"Friday": {
"open": "10:00",
"close": "18:00"
},
"Saturday": {
"open": "10:00",
"close": "18:00"
}
},
"extension_no":"1
",
"Location_delivery_promoted_time":"300
",
"sku_filter":{
"type":"inclusion",
"Exact_words_match":"test",
"Exact_words_notmatch":"test_text",
"Range_from":"10
",
"Range_to":"20
"
},
"holiday_calender":{
"active_dates":["2020-09-29"],
"inactive_dates":["2020-09-30"]
},
"location_package":""
}'
Example JSON API response
{
"shipsi_location_id": "5f745156b21d8c493f4e720e",
"status": true,
"error_code": "",
"message": "Location has been successfully saved"
}
curl -X POST \
https://app.shipsi.com/api/v1/locations/addlocation \
-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_location_id": "aae",
"eligible_shipsi_location": true,
"location_manager_name": "test",
"location_main_line_phone_number": "610-592-1321",
"notification_cell_phone_number":["281-763-5455
"],
"notification_email_address": ["rye@shipsi.com"],
"send_notification_when_pickup_nearby": false,
"location_pickup_notes": "Come to customer service area",
"pickup_location": {
"address_line1": "677 South Marengo Avenue, Pasadena, CA, USA",
"address_line2": "Suite 200",
"city": "Los Angeles County",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"max_delivery_weight": "",
"max_delivery_radius": "",
"alternate_country_code":[
"US"
],
"alternate_phone_code":[
"1
"
],
"pick_and_pack_time": "30
",
"location_timezone": "EST",
"operating_hours": {
"Sunday": {
"open": "10:00",
"close": "18:00"
},
"Monday": {
"open": "10:00",
"close": "18:00"
},
"Tuesday": {
"open": "10:00",
"close": "18:00"
},
"Wednesday": {
"open": "10:00",
"close": "18:00"
},
"Thursday": {
"open": "10:00",
"close": "18:00"
},
"Friday": {
"open": "10:00",
"close": "18:00"
},
"Saturday": {
"open": "10:00",
"close": "18:00"
}
},
"extension_no":"1
",
"Location_delivery_promoted_time":"300
",
"sku_filter":{
"type":"inclusion",
"Exact_words_match":"test",
"Exact_words_notmatch":"test_text",
"Range_from":"10
",
"Range_to":"20
"
},
"holiday_calender":{
"active_dates":["2020-09-29"],
"inactive_dates":["2020-09-30"]
},
"location_package":""
}'
Example JSON API response
{
"shipsi_location_id": "5f745156b21d8c493f4e720e",
"status": true,
"error_code": "",
"message": "Location has been successfully saved"
}
curl -X POST \
https://app.shipsi.com/api/v1/locations/addlocation \
-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_location_id": "aae",
"eligible_shipsi_location": true,
"location_manager_name": "test",
"location_main_line_phone_number": "610-592-1321",
"notification_cell_phone_number":["281-763-5455
"],
"notification_email_address": ["rye@shipsi.com"],
"send_notification_when_pickup_nearby": false,
"location_pickup_notes": "Come to customer service area",
"pickup_location": {
"address_line1": "677 South Marengo Avenue, Pasadena, CA, USA",
"address_line2": "Suite 200",
"city": "Los Angeles County",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"max_delivery_weight": "",
"max_delivery_radius": "",
"alternate_country_code":[
"US"
],
"alternate_phone_code":[
"1
"
],
"pick_and_pack_time": "30
",
"location_timezone": "EST",
"operating_hours": {
"Sunday": {
"open": "10:00",
"close": "18:00"
},
"Monday": {
"open": "10:00",
"close": "18:00"
},
"Tuesday": {
"open": "10:00",
"close": "18:00"
},
"Wednesday": {
"open": "10:00",
"close": "18:00"
},
"Thursday": {
"open": "10:00",
"close": "18:00"
},
"Friday": {
"open": "10:00",
"close": "18:00"
},
"Saturday": {
"open": "10:00",
"close": "18:00"
}
},
"extension_no":"1
",
"Location_delivery_promoted_time":"300
",
"sku_filter":{
"type":"inclusion",
"Exact_words_match":"test",
"Exact_words_notmatch":"test_text",
"Range_from":"10
",
"Range_to":"20
"
},
"holiday_calender":{
"active_dates":["2020-09-29"],
"inactive_dates":["2020-09-30"]
},
"location_package":""
}'
Example JSON API response
{
"shipsi_location_id": "5f745156b21d8c493f4e720e",
"status": true,
"error_code": "",
"message": "Location has been successfully saved"
}
curl -X POST \
https://app.shipsi.com/api/v1/locations/addlocation \
-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_location_id": "aae",
"eligible_shipsi_location": true,
"location_manager_name": "test",
"location_main_line_phone_number": "610-592-1321",
"notification_cell_phone_number":["281-763-5455
"],
"notification_email_address": ["rye@shipsi.com"],
"send_notification_when_pickup_nearby": false,
"location_pickup_notes": "Come to customer service area",
"pickup_location": {
"address_line1": "677 South Marengo Avenue, Pasadena, CA, USA",
"address_line2": "Suite 200",
"city": "Los Angeles County",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"max_delivery_weight": "",
"max_delivery_radius": "",
"alternate_country_code":[
"US"
],
"alternate_phone_code":[
"1
"
],
"pick_and_pack_time": "30
",
"location_timezone": "EST",
"operating_hours": {
"Sunday": {
"open": "10:00",
"close": "18:00"
},
"Monday": {
"open": "10:00",
"close": "18:00"
},
"Tuesday": {
"open": "10:00",
"close": "18:00"
},
"Wednesday": {
"open": "10:00",
"close": "18:00"
},
"Thursday": {
"open": "10:00",
"close": "18:00"
},
"Friday": {
"open": "10:00",
"close": "18:00"
},
"Saturday": {
"open": "10:00",
"close": "18:00"
}
},
"extension_no":"1
",
"Location_delivery_promoted_time":"300
",
"sku_filter":{
"type":"inclusion",
"Exact_words_match":"test",
"Exact_words_notmatch":"test_text",
"Range_from":"10
",
"Range_to":"20
"
},
"holiday_calender":{
"active_dates":["2020-09-29"],
"inactive_dates":["2020-09-30"]
},
"location_package":""
}'
Example JSON API response
{
"shipsi_location_id": "5f745156b21d8c493f4e720e",
"status": true,
"error_code": "",
"message": "Location has been successfully saved"
}
curl --location --request PUT 'https://app.shipsi.com/api/v1/locations/editlocation' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'mode: live' \
--header 'Content-Type: application/json' \
--header 'Cookie: ci_session=79c72434006dbe79cac9601fd4a0656d632dfdf2' \
--data-raw '{
"shipsi_location_id": "5f7463a9b21d8ce1344e7216",
"retailer_location_id": "AAEE",
"edit_location_information": {
"location_manager_name": "test",
"location_main_line_phone_number": "611-592-1111
",
"eligible_shipsi_location": true,
"send_notification_when_pickup_nearby": true,
"location_pickup_notes": "Go to first register",
"pickup_location": {
"address_line1": "1242 Washington St",
"address_line2": "Suite 100",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94109
"
},
"max_delivery_weight": "100
",
"max_delivery_radius": "90
",
"pick_and_pack_time": "30
",
"location_timezone": "EST",
"alternate_country_code":[
"US"
],
"alternate_phone_code":[
"1
"
],
"notification_cell_phone_number":[
"281-763-5455
"
],
"notification_email_address": [
"rye@shipsi.com"
],
"operating_hours": {
"Sunday": {
"open": "12:00",
"close": "18:00"
},
"Monday": {
"open": "10:00",
"close": "18:00"
},
"Tuesday": {
"open": "10:00",
"close": "18:00"
},
"Wednesday": {
"open": "10:00",
"close": "18:00"
},
"Thursday": {
"open": "10:00",
"close": "18:00"
},
"Friday": {
"open": "10:00",
"close": "18:00"
},
"Saturday": {
"open": "10:00",
"close": "18:00"
}
},
"extension_no":"1
",
"Location_delivery_promoted_time":"180
",
"sku_filter":{
"type":"exclusion",
"Exact_words_match":"test",
"Exact_words_notmatch":"test_text",
"Range_from":"10
",
"Range_to":"20
"
},
"holiday_calender":{
"active_dates":["2020-09-28"],
"inactive_dates":["2020-09-30"]
},
"custom_operation_hours": {
"2025-06-15": {
"open": "09:00",
"close": "18:00"
},
"2025-06-28": {
"open": "09:00",
"close": "18:00"
},
"2025-07-07": {
"open": "09:00",
"close": "18:00"
}
}
}
}'
Example JSON API response
{
"status": true,
"error_code": "",
"message": "Location has been successfully saved"
}
curl -X PUT \
https://app.shipsi.com/api/v1/locations/locationpackages \
-H 'cache-control: no-cache' \
-H 'content-type: application/json' \
-H 'mode: live' \
-H 'x-api-key: XXXXXXXXXX' \
-H 'x-api-pass: xxxxxxxxxxxxx' \
-d '{
"Location_package":{
"Location_id": "5f645d59b21d8cd518c23c80",
"Package": "pro"
}
}'
Example JSON API response
{
"status": true,
"error_code": "",
"message": "Package updated successfully to pro for this location"
}
curl -X GET \
https://app.shipsi.com/api/v1/locations/listlocations \
-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
{
"data": [
{
"id": "5be2b3e7830552b0756d4144",
"locationname": "1046",
"Location_package": "Basic",
"contactname": "test",
"phonenumber": "281-763-5455",
"locationaddress": "677 South Marengo Avenue, Pasadena, CA, USA, Los Angeles County, CA, 91106, US",
"locationcity": "Los Angeles County",
"locationstate": "CA",
"locationcountry": "US",
"locationzip": "91106",
"max_weight": "10",
"zip_radius": "20",
"email_notification": "rye@shipsi.com",
"order_wait_time": "30
",
"promoted_delivery_time": "300",
"Alert_Driver_Nearby": "1",
"Pickup_Notes": "test",
"time_zone": "EST",
"filter_inventory": {
"type": "inclusion",
"exact_character": "test_text",
"noexact_character": "test_text",
"range_from": "10",
"range_to": "20"
},
"active_dates": [
"2020-09-29"
],
"inactive_dates": [
"2020-09-30"
],
"active_days": {
"Sunday": {
"open": "10:00",
"close": "18:00"
},
"Monday": {
"open": "10:00",
"close": "18:00"
},
"Tuesday": {
"open": "10:00",
"close": "18:00"
},
"Wednesday": {
"open": "10:00",
"close": "18:00"
},
"Thursday": {
"open": "10:00",
"close": "18:00"
},
"Friday": {
"open": "10:00",
"close": "18:00"
},
"Saturday": {
"open": "10:00",
"close": "18:00"
}
}
},
{
"id": "5b7ba0bb830552bb77070da2",
"locationname": "1046",
"Location_package": "Basic",
"contactname": "test",
"phonenumber": "281-763-5455",
"locationaddress": "677 South Marengo Avenue, Pasadena, CA, USA, Los Angeles County, CA, 91106, US",
"locationcity": "Los Angeles County",
"locationstate": "CA",
"locationcountry": "US",
"locationzip": "91106",
"max_weight": "10",
"zip_radius": "20",
"email_notification": "rye@shipsi.com",
"order_wait_time": "30
",
"promoted_delivery_time": "300",
"Alert_Driver_Nearby": "1",
"Pickup_Notes": "test",
"time_zone": "EST",
"filter_inventory": {
"type": "inclusion",
"exact_character": "test_text",
"noexact_character": "test_text",
"range_from": "10",
"range_to": "20"
},
"active_dates": [
"2020-09-29"
],
"inactive_dates": [
"2020-09-30"
],
"active_days": {
"Sunday": {
"open": "10:00",
"close": "18:00"
},
"Monday": {
"open": "10:00",
"close": "18:00"
},
"Tuesday": {
"open": "10:00",
"close": "18:00"
},
"Wednesday": {
"open": "10:00",
"close": "18:00"
},
"Thursday": {
"open": "10:00",
"close": "18:00"
},
"Friday": {
"open": "10:00",
"close": "18:00"
},
"Saturday": {
"open": "10:00",
"close": "18:00"
}
}
},
{
"id": "5f630cbdb21d8cfd6bc23c81",
"locationname": "1046",
"Location_package": "Basic",
"contactname": "test",
"phonenumber": "281-763-5455",
"locationaddress": "677 South Marengo Avenue, Pasadena, CA, USA, Los Angeles County, CA, 91106, US",
"locationcity": "Los Angeles County",
"locationstate": "CA",
"locationcountry": "US",
"locationzip": "91106",
"max_weight": "10",
"zip_radius": "20",
"email_notification": "rye@shipsi.com",
"order_wait_time": "30
",
"promoted_delivery_time": "300",
"Alert_Driver_Nearby": "1",
"Pickup_Notes": "test",
"time_zone": "EST",
"filter_inventory": {
"type": "inclusion",
"exact_character": "test_text",
"noexact_character": "test_text",
"range_from": "10",
"range_to": "20"
},
"active_dates": [
"2020-09-29"
],
"inactive_dates": [
"2020-09-30"
],
"active_days": {
"Sunday": {
"open": "10:00",
"close": "18:00"
},
"Monday": {
"open": "10:00",
"close": "18:00"
},
"Tuesday": {
"open": "10:00",
"close": "18:00"
},
"Wednesday": {
"open": "10:00",
"close": "18:00"
},
"Thursday": {
"open": "10:00",
"close": "18:00"
},
"Friday": {
"open": "10:00",
"close": "18:00"
},
"Saturday": {
"open": "10:00",
"close": "18:00"
}
}
},
{
"id": "5f645d59b21d8cd518c23c80",
"locationname": "Acctest",
"Location_package": "Basic",
"contactname": "test",
"phonenumber": "281-763-5455",
"locationaddress": "677 South Marengo Avenue, Pasadena, CA, USA, Los Angeles County, CA, 91106, US",
"locationcity": "Los Angeles County",
"locationstate": "CA",
"locationcountry": "US",
"locationzip": "91106",
"max_weight": "10",
"zip_radius": "20",
"email_notification": "rye@shipsi.com",
"order_wait_time": "30
",
"promoted_delivery_time": "300",
"Alert_Driver_Nearby": "1",
"Pickup_Notes": "test",
"time_zone": "EST",
"filter_inventory": {
"type": "inclusion",
"exact_character": "test_text",
"noexact_character": "test_text",
"range_from": "10",
"range_to": "20"
},
"active_dates": [
"2020-09-29"
],
"inactive_dates": [
"2020-09-30"
],
"active_days": {
"Sunday": {
"open": "10:00",
"close": "18:00"
},
"Monday": {
"open": "10:00",
"close": "18:00"
},
"Tuesday": {
"open": "10:00",
"close": "18:00"
},
"Wednesday": {
"open": "10:00",
"close": "18:00"
},
"Thursday": {
"open": "10:00",
"close": "18:00"
},
"Friday": {
"open": "10:00",
"close": "18:00"
},
"Saturday": {
"open": "10:00",
"close": "18:00"
}
}
},
{
"id": "5f6c7c48b21d8c725c206df2",
"locationname": "Acctest_test",
"Location_package": "Basic",
"contactname": "test",
"phonenumber": "281-763-5455",
"locationaddress": "677 South Marengo Avenue, Pasadena, CA, USA, Los Angeles County, CA, 91106, US",
"locationcity": "Los Angeles County",
"locationstate": "CA",
"locationcountry": "US",
"locationzip": "91106",
"max_weight": "10",
"zip_radius": "20",
"email_notification": "rye@shipsi.com",
"order_wait_time": "30
",
"promoted_delivery_time": "300",
"Alert_Driver_Nearby": "1",
"Pickup_Notes": "test",
"time_zone": "EST",
"filter_inventory": {
"type": "inclusion",
"exact_character": "test_text",
"noexact_character": "test_text",
"range_from": "10",
"range_to": "20"
},
"active_dates": [
"2020-09-29"
],
"inactive_dates": [
"2020-09-30"
],
"active_days": {
"Sunday": {
"open": "10:00",
"close": "18:00"
},
"Monday": {
"open": "10:00",
"close": "18:00"
},
"Tuesday": {
"open": "10:00",
"close": "18:00"
},
"Wednesday": {
"open": "10:00",
"close": "18:00"
},
"Thursday": {
"open": "10:00",
"close": "18:00"
},
"Friday": {
"open": "10:00",
"close": "18:00"
},
"Saturday": {
"open": "10:00",
"close": "18:00"
}
}
}
],
"status": true,
"error_code": "success",
"message": "Location has been listed"
}
Example JSON API response
{ "status": success, "error_code": "", "message": "location added successfully." }
Example JSON API response
{ "status": success, "error_code": "", "message": "location added successfully." }
Example JSON API response
{ "status": success, "error_code": "", "message": "location added successfully." }
Example JSON API response
{ "status": success, "error_code": "", "message": "location added successfully." }
curl --location --request POST 'https://app.shipsi.com/api/v1/checkinventory' \
--header 'Content-Type: application/json' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'mode: live' \
--header 'Cookie: __cfduid=d950b6408abae079679f5587b1a1f7a4c1613029358' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"qualified_pickup_locations": [
{
"shipsi_location_id": "603c18b1b21d8ce333ca5728",
"retailer_location_id": "California Alternate Location"
},
{
"shipsi_location_id": "603c181db21d8c6645ca5729",
"retailer_location_id": "California Location"
}
],
"sku_list": [
{
"sku": "Ring1-ABC"
},
{
"sku": "Necklace2-BBC"
}
]
}'
Example JSON API response
{
"response_data": [
{
"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"
},
{
"retailer_location_id": "California Location",
"sku": "Ring1-ABC",
"qty_available_to_sell": "101"
},
{
"retailer_location_id": "California Location",
"sku": "Necklace2-BBC",
"qty_available_to_sell": "10"
}
],
"status": "true",
"error_code": "",
"message": "Inventory Listing"
}
curl --location --request POST 'https://app.shipsi.com/api/v1/checkinventory' \
--header 'Content-Type: application/json' \
--header 'x-api-key: XXXXXXXXXX' \
--header 'x-api-pass: xxxxxxxxxxxxx' \
--header 'mode: live' \
--header 'Cookie: __cfduid=d950b6408abae079679f5587b1a1f7a4c1613029358' \
--data-raw '{
"retailer_child_id" : "cus_XXXXXXX
",
"qualified_pickup_locations": [
{
"shipsi_location_id": "603c18b1b21d8ce333ca5728",
"retailer_location_id": "California Alternate Location"
},
{
"shipsi_location_id": "603c181db21d8c6645ca5729",
"retailer_location_id": "California Location"
}
],
"sku_list": [
{
"sku": "Ring1-ABC"
},
{
"sku": "Necklace2-BBC"
}
]
}'
Example JSON API response
{
"response_data": [
{
"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"
},
{
"retailer_location_id": "California Location",
"sku": "Ring1-ABC",
"qty_available_to_sell": "101"
},
{
"retailer_location_id": "California Location",
"sku": "Necklace2-BBC",
"qty_available_to_sell": "10"
}
],
"status": "true",
"error_code": "",
"message": "Inventory Listing"
}