uStore API Help

Introduction

The uStore Application Programming Interface (API) is available in the form of REST API. This technology is recommended for use when developing new, custom-made applications and integrations that are based on the uStore platform.

General Information

uStore APIs are accessible using HTTP or HTTPS protocols, depending on the uStore configuration.

APIs receive and return JSON objects. The "Content-Type" header with the "application/json" value should be added to all requests.

In case of an error, all uStore APIs throw an exception, resulting in a "Bad Request" (400) HTTP error received by the client.

Authentication

Each uStore API receives a security token that is used by uStore for authentication and authorization of the caller. The security token is a string generated by the login API that receives the user's email, password and the store’s unique ID, and returns a security token.

The API caller provides the generated security token to other APIs using the HTTP request header:

Header name: Authorization

Header value: uStore [security_token]

The security token can be used for calling APIs for one hour only. After this period, an AccessDenied error is thrown by all APIs that receive the expired security token.

The website/application can always call the logout API. This API receives a security token and releases it. As a result, all APIs that receive a security token that was released throw an AccessDenied exception.

Localization

Most of uStore APIs return results according to the requested localization.

The API caller can provide a localization to any API using the HTTP request header:

Header name: Accept-Language

Header value: [language_code] E.g. "en-US"

If a localization was not provided to an API or it does not exist for the store, then the API will use the store’s setup localization.

The localization used by the API – whether provided by the caller or chosen by the API – is returned in the HTTP response header:

Header name: Content-Language

Header value: [language_code] E.g. "fr-FR"

API	Description
GET v1/store/categories	Gets the top level product categories of a store, using pagination. Categories that do not contain online products on any level are filtered out.
GET v1/store/categories/{categoryID}/categories	Gets the sub-categories of a specific product category, using pagination. Categories that do not contain online products on any level are filtered out.
GET v1/store/categories/id	Gets the category's unique ID by its friendly ID.
GET v1/store/categories/{categoryID}	Gets the category by its unique ID.
GET v1/store/categories/tree	Gets the tree of product categories of a store. Categories that do not contain online products on any level are filtered out.

Orders

API	Description
GET v1/store/login/user/orders/summary	Gets the summary of orders of the currently logged-in user, who is identified by the provided security token.
POST v1/store/login/user/orders/draft/items	Creates a draft order item of a product. Note: The API supports kit and static products only.
GET v1/store/login/user/orders/unsubmitted/items/{orderItemID}	Gets the order item that has not been submitted by its unique ID. Note: The API supports kit and static products only.
PUT v1/store/login/user/orders/unsubmitted/items/{orderItemID}	Updates the order item that has not been submitted. Note: The API supports kit and static products only.
POST v1/store/login/user/orders/unsubmitted/items/{orderItemID}/price/calculate	Gets the price of the order item that has not been submitted. Note: The API supports kit and static products only.
POST v1/store/login/user/orders/submitted/items/{orderItemID}/reorder	Reorders the submitted order item. Note: The API supports kit and static products only.
GET v1/store/login/user/orders/submitted/items/last/status	Gets the information about the last submitted order item of a product. Note: The API supports kit and static products only.
POST v1/store/login/user/orders/unsubmitted/items/{orderItemID}/addToCart	Adds a draft order item to the shopping cart. Note: The API supports static products only.
POST v1/store/login/user/orders/unsubmitted/items/{orderItemID}/saveForLater	Adds a draft order item to the 'save for later' section in the shopping cart. Note: The API supports static products only.

Products

API	Description
GET v1/store/products/id	Gets the product's unique ID by its friendly ID.
GET v1/store/products/{productID}	Gets the product by its unique ID.
GET v1/store/categories/{categoryID}/products	Gets the online products of a specific product category, using pagination.
GET v1/store/products/search	Gets the products using a search string.
GET v1/store/products	Gets the products by their unique IDs.
GET v1/store/products/{productID}/thumbnails	Gets product thumbnails.

Properties

API	Description
POST v1/store/login/user/orders/unsubmitted/items/{orderItemID}/properties/{propertyID}/files	Appends files to the order item property.
DELETE v1/store/login/user/orders/unsubmitted/items/{orderItemID}/properties/{propertyID}/files	Delete files of the order item property

Store

API	Description
POST v1/store/login	Logs the user into the store.
POST v1/store/login/renew	Renews the user session.
DELETE v1/store/login	Logs the user out from the store.
GET v1/store/login/user	Gets the currently logged-in user, who is identified by the provided security token.
GET v1/store	Gets the store to which the user is currently logged in. The store unique ID and the currently logged-in user are identified by the provided security token.
GET v1/store/cultures	Gets the cultures of the store.
GET v1/store/currencies	Gets the currencies of the store.