API - Responses

Data Format

Hiboutik API only sends JSON-encoded data in responses.

Pagination

Large data sets are returned as paginated data, with 250 results per page.
When this occurs pagination information will be returned in the result headers.

Content-Range X-Y/Z where X and Y are the first and last results of the page and Z the total number of results for the request

link: <https://myshop.hiboutik.com/api/products_sold/1/2020/06/20/?p=1>; rel="start",
<https://myshop.hiboutik.com/api/products_sold/1/2020/06/20/?p=1>; rel="prev", 
<https://myshop.hiboutik.com/api/products_sold/1/2020/06/20/?p=2>; rel="current",
<https://myshop.hiboutik.com/api/products_sold/1/2020/06/20/?p=3>; rel="last"

Link gives the direct HTTP requests to get the first page, the last page, the current page and the next page of results for the request.
You can request a different page by passing a different page (p) parameter like:

https://myshop.hiboutik.com/api/customers/?p=25

Response status codes

When Hiboutik receives a request, a number of different HTTP status codes can be returned in the response depending on the original request:

Code Status Description
200 OK The request was successfully processed.
401 Unauthorized API access is not granted or the necessary authentication credentials are not present in the request or are incorrect.
403 Forbidden The server is refusing to respond to the request. This is generally because you have not requested the appropriate scope or access rights for this action.
406 Not Acceptable The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request.
422 Unprocessable Entity The request body was well-formed but contains semantical errors. The response body will provide more details.
429 Too Many Requests The request was not accepted because the application has exceeded the rate limit. See the API Call Limit documentation.
500 Internal Server Error An internal error occurred in Hiboutik. Please send a message so that Hiboutik staff can investigate.
503 Service Unavailable The server is currently unavailable.
504 Gateway Timeout The request could not complete in time. Try breaking it down in multiple smaller requests.

Envoyez nous un message

Cliquez ici

  • FR +33 (0)1 48 78 40 06
  • FR +41 (0)21 519 00 17
  • FR +32 (0)2 318 82 77
  • FR +34 (0)912 69 39 94