DesenvolvedoresReferência da APICatálogo

Consultar produto

GET
/products/{productId}

Aceita o id ou o slug do produto. Traz preços, imagens, campos de checkout, benefícios e ofertas relacionadas.

Chave: Chave publicável ou secreta.

Escopo: catalog:read.

Limite: 120 requisições a cada 1 min, além do limite geral de 600 por minuto por chave.

Autorização

headerAutorizaçãoBearer <chave de API>

Chave publicável (pk_…). Pode ir para o navegador; dá acesso só ao catálogo, ao carrinho e ao checkout.

Parâmetros de caminho

productId*string

Id (UUID) ou slug do produto.

Tamanho1 <= length <= 160

Corpo da resposta

Sucesso.

application/json
  1. response
data*
meta*
curl -X GET 'https://minepag.com.br/api/v1/products/string'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "slug": "string",    "name": "string",    "summary": "string",    "description": "string",    "type": "digital",    "seoTitle": "string",    "seoDescription": "string",    "maxQuantityPerOrder": -9007199254740991,    "prices": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "type": "one_time",        "amount": -9007199254740991,        "originalAmount": -9007199254740991,        "compareAtAmount": -9007199254740991,        "discountPercent": 0,        "offer": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "name": "string",          "headline": "string"        },        "minimumAmount": -9007199254740991,        "interval": "day",        "intervalCount": -9007199254740991,        "trialDays": -9007199254740991,        "isDefault": true,        "sku": "string",        "available": -9007199254740991,        "stock": "available",        "attributes": [          {            "option": "string",            "value": "string"          }        ]      }    ],    "images": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "type": "string",        "url": "string",        "alt": "string",        "width": -9007199254740991,        "height": -9007199254740991,        "priceId": "b245ceea-4bc7-4619-ae4c-559a1faf418e"      }    ],    "checkoutFields": [      {        "key": "string",        "label": "string",        "type": "text",        "required": true,        "choices": [          null        ],        "helpText": "string",        "priceId": "b245ceea-4bc7-4619-ae4c-559a1faf418e",        "placeholder": "string",        "minLength": -9007199254740991,        "maxLength": -9007199254740991,        "minValue": 0,        "maxValue": 0      }    ],    "benefits": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "type": "download",        "typeLabel": "string",        "name": "string",        "description": "string",        "priceId": "b245ceea-4bc7-4619-ae4c-559a1faf418e"      }    ],    "relatedOffers": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "type": "catalog_sale",        "name": "string",        "headline": "string",        "description": "string",        "ctaLabel": "string",        "products": [          {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "slug": "string",            "name": "string"          }        ]      }    ]  },  "meta": {    "requestId": "string"  }}