Guidelines & conventions

Before you start using the API, we recommend you review these guidelines.

Protocol support:

The Yotpo API supports both HTTP and HTTPS requests.

Data format:

Data must be in JSON format. As such, the HTTP header content-type must be set to: application/json

Pagination:

Use the following parameters to paginate results in API requests which support pagination:
page - Number of pages to return
count - Number of results to return per page

Status code:

Yotpo API uses standard HTTP response codes to indicate the success of failure status of an API endpoint.

📘

Note:

Certain API calls return special responses to indicate specific errors.
Special responses are noted for relevant API endpoints within the documentation.

Parameters:

Email and URL parameters you send in the calls must be in the correct format, otherwise the call will not be processed.

UTF-8 support:

The Yotpo API calls support special characters according to the UTF-8 coding.