Content
Overview
API Request Format
API Response Format
API Registration and Throughput
Testing the API
Other API Responses
Securing the Communication
Overview
The Product API is a REST API endpoint that allows two software systems to talk to each other via a request/response-based communication. This API provides a list of competitor product listings currently matched to a requested SKU, including the latest extracted data for Price, Regular Price, Shipping Price, and Availability for each listing.
API Request Rormat
Base URL: https://static-api.360pi.com
Path: /api/v1/product/sku/<your_sku>?key=<your_key>
Method: GET.
Replace <your_sku> with your desired SKU alphanumeric code.
Replace <your_key> with your API authentication key. Note: Please see the 'Registering your application' section in this document for more information.
API Response Format
{"products": [
{
"upc": <str>, // your product's UPC
"model_number": <str>, // your product's model number
"sku": <str>, // your product's SKU alphanumeric code
"title": <str>, // your product's title
"image_url": <str>, // your product's image URL
"stores": <list<dict>> [
{
"url": <str>, // product's listing URL
"price": <float>, // product listing's price
"shipping_price": <float>, // product listing's shipping price
"availability": <boolean>, // product listing's stock information
"crawl_date": <date YYYY-MM-DDTHH:MM:SS>, // last crawl timestamp in UTC
"store_name": <str>, // e-commerce store name
"id": <str>, // unique id of this product in Wiser systems
"in_cart": <boolean>, // if price was extracted after adding item to cart
"regular_price": <float> // listing's regular price, aka “strike through price”
},
{
// more product match information, until all active matches are covered.
},
]
}
], "status": "OK"
}
Note: If you're subscribed to regional price intel (multiple zip codes set for a particular competitor domain), the Products API endpoint will return data for the main zip code, or average price across all zip codes, following the existing environment configuration.
API Registration and Throughput
Your application needs an API key to authenticate the requests made to the Wiser API endpoints. If you have multiple environments (catalogs), you will need a key for each one of the environments or only for the one(s) you wish to use APIs.
Each API key has a rate limit of 200 requests per minute, and the total monthly usage is limited per key. This API typically responds with data in under one second, excluding any client-side network speed restrictions.
Please reach out to your Wiser representative for more information about creating a key and configuring usage limits.
Testing the API
For a simple test, you can make API requests and see the responses using a simple web browser (ex: Google Chrome). You just need to insert the full URL in the browser with the right parameters.
Example:
Other API Responses
During implementation, besides successful response data, your application also needs to be prepared to handle these other response scenarios.
Incorrect SKU alphanumeric code:
Response code: 200
Response data:
{
"products": [],
"status": "OK"
}Incorrect API key:
Response code: 401
Response data: {"status": "error"}
Timeout:
Response code: 504
Response data: N/A
Note: The response will timeout after 210 seconds.
Usage limit reached:
Response code: 200
Response data:
{
"status": <str>"error"
"reason": <str> "Too many requests",
"limit": <int>
"key": <str>
"hit_rate": <int>
}
Securing the Communication
Data security is critical when integrating with Web APIs. Please make sure you're using common security practices, such as using proper connection security using HTTPS and keeping your API secret key safe to ensure bad actors cannot access your data.
Common security mistakes include sharing the complete request URL (including your API key) with peers in insecure channels, which may expose the API key to bad actors. So please review your data security policies and processes accordingly.