Skip to content
Scrappa Get API key
AliExpress API 1 credit/request

AliExpress Store Benefits API Documentation

GET https://scrappa.co/api/aliexpress/store/benefits

AliExpress Store Benefits API Documentation Get the service badges of one store, such as items as described, communication and shipping speed, each with its score and a flag that shows whether it is above the category average. The response also lists store highlights such as followers and store age, and the seller country. Take seller_id and store_id from the seller block of the product response. An unknown store answers 404. Currency and language follow the market of the request, so they can differ between calls. Failed requests are never charged.

AliExpress Store Benefits API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/aliexpress/store/benefits
Auth header
x-api-key
Cost
1 credit/request
seller_id = 1234567890 store_id = 1234567890
Response preview
200 OK
{
    "data": {
        "badges": [
            {
                "title": "Items as description",
                "value": "5.0",
                "above_category_average": true
            },
            {
                "title": "Communication",
                "value": "4.8",
                "above_category_average": true
            }
        ],
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

2 required parameters needed before sending a request.

seller_id string Required

Seller number of 4 to 20 digits, e.g. 2678280160. Take it from seller.seller_id of the product response.

Example value 1234567890
store_id string Required

Store number of 4 to 20 digits, e.g. 1103573332. Take it from seller.store_id of the product response.

Example value 1234567890

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "badges": [
            {
                "title": "Items as description",
                "value": "5.0",
                "above_category_average": true
            },
            {
                "title": "Communication",
                "value": "4.8",
                "above_category_average": true
            }
        ],
        "store_id": "1103573332",
        "seller_id": "2678280160",
        "highlights": [
            "30.0K followers",
            "2-year old store"
        ],
        "seller_country": "CN"
    },
    "meta": {
        "billable": true,
        "endpoint_family": "store_benefits"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A parameter is missing or invalid. This response is not billable.

{
    "errors": {
        "seller_id": [
            "A seller_id is required. Take it from the product response (seller.seller_id)."
        ]
    },
    "message": "The request validation failed"
}
404

Resource Not Found

The product or store does not exist. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested AliExpress resource was not found."
    },
    "success": false
}
503

Service Unavailable

AliExpress could not be reached. Retry after a short pause. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": true
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "AliExpress is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.