Consulta uma variante de produto

GET/v1/variants/{variantId}

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros do caminho

variantIdstringobrigatório
Identificador público (var_/prv_…)

Respostas

200Sucesso

idstringobrigatório
Identificador público (var_/prv_…)
skustringobrigatóriopode ser nulo
O seu SKU; null quando não há.
namestringobrigatóriopode ser nulo
Nome da variante.
slugstringobrigatóriopode ser nulo
Slug da variante.
fiscalobjectobrigatóriopode ser nulo
O que a variante muda no perfil fiscal do produto; null = nada.
+10 campos de fiscal
- nbsstring
  Código NBS (serviço).
- ncmstring
  Código NCM (mercadoria).
- ceststring
  Código CEST (mercadoria).
- gtinstring
  GTIN/EAN.
- kindstring
  service (NFS-e) ou goods (NF-e).
  Valores:servicegoods
- unitstring
  Unidade comercial.
- origininteger
  Origem da mercadoria (0 a 8).
- cClassTribstring
  Classificação tributária do IBS/CBS.
- serviceCodestring
  Item da lista de serviços da LC 116.
- cityServiceCodestring
  Código do serviço na sua prefeitura.
imagesum de[]obrigatóriopode ser nulo
URLs das imagens; null quando não há.
enabledbooleanobrigatório
Se a variante está à venda.
pricingobjectobrigatório
Preço e modelo de cobrança da variante.
+22 campos de pricing
- typestringobrigatório
  oneTime (uma venda) ou recurring (um plano de assinatura).
  Valores:oneTimerecurring
- tiersanypode ser nulo
  As faixas de preço; null fora de tiered.
- cyclesintegerobrigatóriopode ser nulo
  Número de ciclos até a assinatura acabar; null = até ser cancelada.
- schemastringobrigatório
  Como o preço é calculado: unit, tiered ou package.
  Valores:unittieredpackage
- currencystringobrigatório
  Moeda (ISO 4217).
- oldPriceintegerobrigatóriopode ser nulo
  O preço antes de um desconto, em centavos; null quando não há.
- daysTrialintegerobrigatóriopode ser nulo
  Duração do período de teste, em dias; null quando não há.
- tiersModestringobrigatóriopode ser nulo
  graduated ou volume; null fora de tiered.
- unitPriceintegerobrigatóriopode ser nulo
  Preço unitário, em centavos; null em tiered.
- usageTypestringobrigatório
  licensed ou metered.
- billingTypestringobrigatóriopode ser nulo
  Quando um ciclo é cobrado: prepaid, postpaid ou exactday; null em venda avulsa.
- costPerItemintegerobrigatóriopode ser nulo
  O seu custo por unidade, em centavos; null quando não definido.
- trialIntervalstringobrigatóriopode ser nulo
  Unidade da duração do teste; null quando não há.
- meterEventNamestringobrigatóriopode ser nulo
  Nome do medidor de uso; null fora de metered.
- billingExactDayintegerobrigatóriopode ser nulo
  Dia do mês em que o ciclo é cobrado; null quando não é fixo.
- renewalShippingbooleanobrigatório
  Planos recorrentes: se o frete cotado no checkout é cobrado em cada renovação.
- billingFrequencystringobrigatóriopode ser nulo
  Unidade do intervalo de cobrança; null em venda avulsa.
- usageAggregationstringobrigatóriopode ser nulo
  Como o uso é agregado; null fora de metered.
- transformQuantityanypode ser nulo
  Unidades por bloco e arredondamento; null fora de package.
- trialIntervalCountintegerobrigatóriopode ser nulo
  Duração do teste, em unidades de trialInterval; null quando não há.
- billingFrequencyCountintegerobrigatóriopode ser nulo
  Quantas unidades por ciclo; null em venda avulsa.
- renewalMethodDiscountbooleanobrigatório
  Planos recorrentes: se o desconto do meio de pagamento do checkout se estende às renovações.
primarybooleanobrigatório
Se é a variante principal do produto.
metadataobjectobrigatóriopode ser nulo
Os seus metadados chave-valor; null quando não há.
createdAtstringobrigatório
Quando o recurso foi criado (ISO 8601, UTC).
productIdstringobrigatório
O produto a que a variante pertence.
updatedAtstringobrigatório
Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).
attributesobjectobrigatóriopode ser nulo
Atributos livres da variante; null quando não há.
checkoutUrlstringobrigatóriopode ser nulo
URL do checkout hospedado desta variante; null quando não há.
descriptionstringobrigatóriopode ser nulo
Descrição; null quando não há.
externalReferencestringobrigatóriopode ser nulo
O seu próprio identificador da variante; null quando não há.

401Não autenticado (credencial ausente ou inválida)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

403Sem permissão

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

404Não encontrado

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorLista todas as variantes de produto PróximaExclui uma variante de produto

{ "id": "var_0a1b2c3d4e5f60718293", "sku": "string", "name": "Acme Ltda", "slug": "string", "fiscal": { "nbs": "string", "ncm": "string", "cest": "string", "gtin": "string", "kind": "service", "unit": "string", "origin": 0, "cClassTrib": "string", "serviceCode": "string", "cityServiceCode": "string" }, "images": [ "string" ], "enabled": true, "pricing": { "type": "oneTime", "cycles": 0, "schema": "unit", "currency": "BRL", "oldPrice": 5000, "daysTrial": 0, "tiersMode": "string", "unitPrice": 5000, "usageType": "string", "billingType": "string", "costPerItem": 0, "trialInterval": "string", "meterEventName": "string", "billingExactDay": 0, "renewalShipping": true, "billingFrequency": "string", "usageAggregation": "string", "trialIntervalCount": 0, "billingFrequencyCount": 0, "renewalMethodDiscount": true }, "primary": true, "metadata": {}, "createdAt": "string", "productId": "prd_0a1b2c3d4e5f60718293", "updatedAt": "string", "attributes": {}, "checkoutUrl": "string", "description": "string", "externalReference": "string" }