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

AliExpress Product Description API Documentation

GET https://scrappa.co/api/aliexpress/product/description

AliExpress Product Description API Documentation Get the seller description of one product as plain text, a list of images and ordered blocks of text and images. Pass the description_ref value from the product response. Currency and language follow the market of the request, so they can differ between calls. Failed requests are never charged.

AliExpress Product Description API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/aliexpress/product/description
Auth header
x-api-key
Cost
1 credit/request
description_ref = example
Response preview
200 OK
{
    "data": {
        "text": "INS Korean Polka Dots Candy Color Soft TPU Phone Case for iPhone 18 17 16 15 14 13 12 Pro Max 16E 17E 18Pro Silicone cream Cover",
        "blocks": [
            {
                "type": "text",
                "content": "INS Korean Polka Dots Candy Color Soft TPU Phone Case for iPhone 18 17 16 15 14 13 12 Pro Max 16E 17E 18Pro Silicone cream Cover"
            },
            {
                "url": "https://ae-pic-a1.aliexpress-media.com/kf/Sb8917597b08046b1b5279cfa1a43fac4o.jpg",
                "type": "image"
            }
        ],
        "images": [
...

Parameters

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

Runnable path

1 required parameter needed before sending a request.

description_ref string Required

The description_ref value from the product response.

Example value example

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": {
        "text": "INS Korean Polka Dots Candy Color Soft TPU Phone Case for iPhone 18 17 16 15 14 13 12 Pro Max 16E 17E 18Pro Silicone cream Cover",
        "blocks": [
            {
                "type": "text",
                "content": "INS Korean Polka Dots Candy Color Soft TPU Phone Case for iPhone 18 17 16 15 14 13 12 Pro Max 16E 17E 18Pro Silicone cream Cover"
            },
            {
                "url": "https://ae-pic-a1.aliexpress-media.com/kf/Sb8917597b08046b1b5279cfa1a43fac4o.jpg",
                "type": "image"
            }
        ],
        "images": [
            "https://ae-pic-a1.aliexpress-media.com/kf/Sb8917597b08046b1b5279cfa1a43fac4o.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/S89ac12d4040f4dd8802e4d4609f1b503C.jpg"
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "description"
    },
    "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": {
        "description_ref": [
            "The description_ref must be the value from the product response."
        ]
    },
    "message": "The request validation failed"
}
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.