← API documentation

Shopee Brazil: get product details

Inspect one public product page for pricing, identity, images and other fields when available from the source.

5 credits per request. Public data only; GeckoAPI is independent of the marketplace.

Try this endpoint

Region, pagination and limitations

Search takes keyword or a /search URL; page is not supported. Use each result URL for product details. This endpoint covers Brazil with BRL prices. Requests can take up to one minute: allow 90 seconds in your client. These are public product data, not seller account operations or affiliate commissions.

HTTP request

cURL
curl -X POST https://api.geckoapi.com.br/v1/extract \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://shopee.com.br/Smart-TV-LED-32-Roku-TV-Dolby-Audio-Philco-PTV32CRB-i.412968566.58207918412",
  "target": "shopee.com.br",
  "type": "pdp"
}'

Replace YOUR_API_KEY with your own server-side credential. Read the quickstart for authentication and error handling.

Supported inputs

FieldRequirementMeaning
urlrequiredComplete public search or product URL. Keep its country and query parameters.
targetrequiredSource identifier shown in the example.
typerequiredplp for search; pdp for product details.

Conditional means an alternative input can satisfy the request, such as keyword or search URL. Fields absent from this table are unsupported for this endpoint.

Example response

One possible response, not a guarantee of current price or availability. Product text stays in the source language. Fields may be missing or null; preserve that distinction in your database.

JSON
{
  "requestId": "66666666-1111-4111-8111-666666666666",
  "executionId": "66666666-2222-4222-8222-666666666666",
  "data": {
    "canonicalUrl": "https://shopee.com.br/Rel%C3%B3gio-Technos-Quadrado-Executive-2115TVM0A-Pulseira-Couro-Legitimo-i.1157985386.23897901346",
    "url": "https://shopee.com.br/Rel%C3%B3gio-Technos-Quadrado-Executive-2115TVM0A-Pulseira-Couro-Legitimo-i.1157985386.23897901346",
    "name": "Relogio Technos Quadrado Executive 2115TVM0A Pulseira Couro Legitimo",
    "itemId": "23897901346",
    "shopId": "1157985386",
    "sku": "23897901346",
    "sellerId": "1157985386",
    "sellerUserId": "1158329411",
    "sellerName": "Zilla Relogios",
    "sellerUsername": "zillaz.relogios",
    "sellerUrl": "https://shopee.com.br/zillaz.relogios",
    "sellerLocation": "Paicandu, Parana",
    "sellerProducts": 69,
    "sellerFollowers": 655,
    "sellerRating": 4.931507,
    "sellerResponseRate": 100,
    "sellerResponseTimeSeconds": 3822,
    "sellerIsOfficialShop": false,
    "sellerIsShopeeVerified": false,
    "sellerIsPreferredPlus": false,
    "brand": {
      "name": "Technos"
    },
    "currency": "BRL",
    "priceHint": "no Pix >",
    "freeShipping": false,
    "shippingFromLocation": "Parana",
    "shippingChannels": [
      {
        "name": "Entrega Padrao",
        "shippingFee": 0,
        "shippingFeeBeforeDiscount": 8.15,
        "estimatedDeliveryText": "Receba entre 18 e 23/abr",
        "estimatedDeliveryTimeMinDays": 2,
        "estimatedDeliveryTimeMaxDays": 7
      }
    ],
    "availability": "InStock",
    "itemStatus": "normal",
    "itemCondition": "new",
    "stock": 10,
    "soldCount": 124,
    "likedCount": 842,
    "aggregateRating": {
      "ratingValue": 4.96875,
      "reviewCount": 32,
      "bestRating": 5
    },
    "breadcrumbs": [
      {
        "name": "Shopee",
        "url": "https://shopee.com.br/"
      },
      {
        "name": "Relogios",
        "url": "https://shopee.com.br/Rel%C3%B3gios-cat.11059996"
      }
    ],
    "additionalProperties": [
      {
        "name": "Material da Correia",
        "value": "Couro"
      }
    ],
    "tierVariations": [
      {
        "name": "Cor",
        "options": [
          "Preto",
          "Marrom"
        ]
      }
    ],
    "variants": [
      "Preto",
      "Marrom"
    ],
    "description": "Descricao do produto",
    "mainImage": {
      "url": "https://down-br.img.susercontent.com/file/br-11134207-7r98o-m17evk1ooacz76"
    },
    "images": [
      {
        "url": "https://down-br.img.susercontent.com/file/br-11134207-7r98o-m17evk1ooacz76"
      },
      {
        "url": "https://down-br.img.susercontent.com/file/br-11134207-7r98o-m17evk1opoxfe8"
      }
    ],
    "videos": [
      {
        "url": "https://mms.vod.susercontent.com/video.mp4",
        "thumbnailUrl": "https://down-br.img.susercontent.com/file/br-11110105-7r98o-thumbhash",
        "durationSeconds": 38
      }
    ]
  }
}

Response fields

Field paths and types
{
  "requestId": "string (uuid)",
  "executionId": "string (uuid)",
  "notFound": "boolean (optional; true when the upstream entity was not found and data is null)",
  "data.canonicalUrl": "string",
  "data.url": "string",
  "data.name": "string",
  "data.itemId": "string",
  "data.shopId": "string",
  "data.sku": "string",
  "data.sellerId": "string",
  "data.sellerUserId": "string",
  "data.sellerName": "string",
  "data.sellerUsername": "string",
  "data.sellerUrl": "string",
  "data.sellerLocation": "string",
  "data.sellerProducts": "number",
  "data.sellerFollowers": "number",
  "data.sellerRating": "number",
  "data.sellerResponseRate": "number",
  "data.sellerResponseTimeSeconds": "number",
  "data.sellerIsOfficialShop": "boolean",
  "data.sellerIsShopeeVerified": "boolean",
  "data.sellerIsPreferredPlus": "boolean",
  "data.brand.name": "string",
  "data.currency": "string",
  "data.price": "number (optional; when present in Shopee's embedded PDP state)",
  "data.regularPrice": "number (optional; when present in Shopee's embedded PDP state)",
  "data.priceHint": "string (optional)",
  "data.pixDiscount": "number (optional)",
  "data.freeShipping": "boolean",
  "data.shippingFromLocation": "string",
  "data.shippingChannels[].name": "string",
  "data.shippingChannels[].shippingFee": "number",
  "data.shippingChannels[].shippingFeeBeforeDiscount": "number (optional)",
  "data.shippingChannels[].estimatedDeliveryText": "string (optional)",
  "data.shippingChannels[].estimatedDeliveryTimeMinDays": "number (optional)",
  "data.shippingChannels[].estimatedDeliveryTimeMaxDays": "number (optional)",
  "data.availability": "string",
  "data.itemStatus": "string",
  "data.itemCondition": "string",
  "data.stock": "number",
  "data.soldCount": "number | null",
  "data.likedCount": "number",
  "data.aggregateRating.ratingValue": "number",
  "data.aggregateRating.reviewCount": "number",
  "data.aggregateRating.bestRating": "number",
  "data.breadcrumbs[].name": "string",
  "data.breadcrumbs[].url": "string",
  "data.additionalProperties[].name": "string",
  "data.additionalProperties[].value": "string",
  "data.tierVariations[].name": "string",
  "data.tierVariations[].options[]": "string",
  "data.variants[]": "string",
  "data.description": "string",
  "data.mainImage.url": "string",
  "data.images[].url": "string",
  "data.videos[].url": "string",
  "data.videos[].thumbnailUrl": "string",
  "data.videos[].durationSeconds": "number"
}