EtshopAPI Platform
EN / 中文
API REFERENCE

Response Status Codes

All endpoints return HTTP status 200. Check the code field in the response body for the business result.

All endpoints return HTTP status 200. Check the code field in the response body for the business result.

Enum Values

Code Description
200 Success
400 Bad request: invalid parameters or business error. See message for details.
401 Unauthorized: the API key is missing or invalid, or the account is disabled. A disabled or deleted API key stops working within 60 seconds.
404 Resource not found, e.g. the shop/product does not exist or the queried shop is not being monitored
409 Duplicate operation, e.g. the shop is already being monitored
429 Too many requests: the per-minute request limit is exceeded (200 requests per minute per account by default). Please try again later.
403001 Access denied: insufficient credits of the required type (Credits, Keyword Credits or Monitor Credits; see credits.type in the response)
403002 Access denied: no permission to view. Shops/products must have been returned by a list or details endpoint within 3 days; keywords must have been searched via Keyword Search within 30 days.
500 Internal server error. Credits deducted by this request are refunded automatically.

About 403002

Some endpoints are free but require the data to be obtained through a charged endpoint first, to prevent bulk fetching by ID without going through the lists:

After the period expires, simply call the corresponding charged endpoint again. See Billing Rules.

Search the existing endpoint names and paths