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.

Response Code	Status
200	Successful Response
401	Unauthorized Request
500	Internal Server Error e.g. Timeout

📘
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.

Parameter	Format	Example
email	user@domain	jsmith@yotpo.com
URL	http://www.domain/full path of resource	http://www.gkshops.com/USBthingy.html
Date	YYYY-MM-DD	2017-12-31

UTF-8 support:

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