Version: v202201

OpenAPI

Shoplazza OpenAPI for 2022-01 lets apps read and write Shoplazza store data. Use this reference to understand the request model, authentication requirements, rate limits, and HTTP status responses for this version.

AuthenticationSend a valid app access token with every request.Rate limitsDesign integrations to stay within platform limits.Status and error codesHandle the broader 2022-01 HTTP status code set.

Authentication

All OpenAPI requests require authentication. Include the app access token in the access-token request header.

Field	Value
Security scheme type	apiKey
Header parameter name	access-token

Rate limits

Shoplazza APIs are rate-limited to protect platform stability. If requests are too frequent, slow down the client, queue background jobs, cache repeated reads, and retry after a short delay.

Status and error codes

The following table provides an overview of common HTTP status codes and their meanings when interacting with the 2022-01 Shoplazza API.

Status code	Details
200 OK	The request was successfully processed by Shoplazza.
400 Bad Request	The request was not understood by the server, generally due to bad syntax or because the Content-Type header was not set to application/json. This can also be returned when authentication credentials are missing or invalid, or when the request input format or structure is invalid.
401 Unauthorized	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 returned if the application has not requested the appropriate scope for the action.
404 Not Found	The requested resource was not found.
405 Method Not Allowed	The server recognizes the request but rejects the specific HTTP method.
406 Not Acceptable	The server cannot produce a response that matches the client's request, such as refunding an order that is not in after-sale status.
422 Unprocessable Entity	The request parameters are formatted incorrectly. Common causes include incorrect parameter types, invalid time formats, invalid parameter values, or rare internal server issues.
429 Too Many Requests	The request was not accepted because the application exceeded the API rate limit. Reduce request frequency and review the rate limit guidance.
500 Internal Server Error	An internal error occurred in Shoplazza. Simplify or retry your request. If the issue persists, record error codes and timestamps and contact Partner Support.