Product GET

A product is primarily a merchant object, which represents an item for sale on the Shopwave platform. A product can be placed into a basket and be sold with associated transactions. Products can have associated stock detail per store, which are tracked and can be reported on.

This API GET call allows you to retrieve each of these product objects with full detail.

The endpoint you need to use for this is:

/product

Request

Headers

Key Details Example
Authorization* {token_type} {access_token} Bearer c3499c2729730a7f807efb8676a92dcb6f8a3f8f
Method* GET GET
x-accept-version {recommended_latest_version_number} 2
productIds {optional_comma_separated_productIds } 1,2,3
storeId {optional_storeId } pulls stock levels for this storeId 1,2,3
categoryIds {optional_categoryIds } pulls only products for the provided category IDs 1,2,3

* Required header

Response

Headers

Key Details Data Type Example
statusCode Very important to check this for shopwave server uptime. 200 for success. int 200

Body

Key Details Data Type
products[{productId}].id unique product Id Int
products[{productId}].barcode The unique barcode for the product. String
products[{productId}].name A name which is able to identify the product. String
products[{productId}].details Extra details which are important for the product. String
products[{productId}].tags Tags (comma separated), which are associated with the product. String
products[{productId}].timestamp The date at which the product was added. DateTime
products[{productId}].activeDate The date at which the product became active. If this is null then the product is not currently active. DateTime
products[{productId}].deleteDate The date at which the product was deleted. If this is null then the product is not deleted. DateTime
products[{productId}].images An array of product image URL strings. Array
products[{productId}].totalStock No. of all stock for the given storeId, if this product is inventory managed for this storeId. Int
products[{productId}].stockSold No. of stock sold for the given storeId, if this product is inventory managed for this storeId. Int
products[{productId}].stockLeft No. of stock remaining for the given storeId, if this product is inventory managed for this storeId. Int
products[{productId}].instances[...].id Unique Product Instance Id Int
products[{productId}].instances[...].price Price for this instance of the product. String
products[{productId}].instances[...].taxPercentage Tax percentage for this instance of the product. String
products[{productId}].instances[...].timestamp The date at which the instance was added. DateTime
products[{productId}].instances[...].name The overriding name for this instance. String
products[{productId}].instances[...].activeDate The date at which the instance became active. If this is null then the instance is not currently active. DateTime
products[{productId}].instances[...].tags Tags (comma separated), which are associated with the instance. String

                                                

Status Codes

Error

Please check the live API calls for more details on the API messages.

ID Status Code Title Details
908 401 Expired Token Token expired or invalid. Please renew your token
911 401 Authorization Header Invalid The authorization header is invalid. The correct format is Authorization: {token_type} {accessToken}
912 403 Resource Not Allowed For Specified User The user does not own this resource and its forbidden
899 500 Unknown Error Something went wrong. Please contact the site administrator
917 500 Internal Server Error Something went wrong.

Success

Please check the live API calls for more details on the API messages.

ID Status Code Title Details
203 200 Request Processed Successfully The request has been successfully completed.
204 204 No content to return End of the page or no content to return for your request
202 200 Token is valid Token is validated and found valid.
preloader