Atualiza um produto

PATCH/v1/products/{productId}

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

Parâmetros do caminho

productIdstringobrigatório
Identificador público (prd_/pro_…)

Corpo da requisição

namestring
Nome do produto (o slug é derivado dele).
typestring
physical (enviado), digital ou other.
Valores:physicaldigitalother
fiscalobjectpode ser nulo
Perfil fiscal do produto; null limpa.
+10 campos de fiscal
- nbsstring
  Código NBS, 9 dígitos (serviço).
- ncmstring
  Código NCM, 8 dígitos (mercadoria).
- ceststring
  Código CEST, 7 dígitos (mercadoria com substituição tributária).
- gtinstring
  GTIN/EAN — 8, 12, 13 ou 14 dígitos.
- kindstring
  service emite NFS-e, goods emite NF-e. Omitido: um produto physical é mercadoria, os outros são serviço.
  Valores:servicegoods
- unitstring
  Unidade comercial (UN, KG, CX…).
- origininteger
  Origem da mercadoria (tabela A do ICMS, 0 a 8; 0 = nacional).
- cClassTribstring
  Classificação tributária do IBS/CBS (cClassTrib, 6 dígitos).
- serviceCodestring
  Item da lista de serviços da LC 116 (01.07 ou 0107).
- cityServiceCodestring
  Código do serviço na sua prefeitura.
imagesstring (uri)[]
URLs de imagem. Para anexar um arquivo, envie-o antes (POST /v1/assets/uploads e depois a confirmação) e mande a URL do arquivo.
enabledboolean
Se o produto está à venda.
categorystring
Categoria, texto livre.
languagestring
Idioma do produto (ex.: pt-BR).
salesPagestring
URL da página de vendas.
descriptionstring
Descrição.
warrantyDaysinteger
Garantia oferecida ao comprador, em dias (7 a 3650).
externalReferencestring
O seu próprio identificador do produto.

Respostas

200Sucesso

idstringobrigatório
Identificador público (prd_/pro_…)
namestringobrigatório
Nome do produto.
slugstringobrigatóriopode ser nulo
Slug, derivado do nome.
typestringobrigatório
physical, digital ou other.
Valores:physicaldigitalother
fiscalobjectobrigatóriopode ser nulo
Perfil fiscal do produto; null quando não há.
+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 o produto está à venda.
categorystringobrigatório
Categoria.
languagestringobrigatóriopode ser nulo
Idioma do produto.
salesQtyintegerobrigatóriopode ser nulo
Número de vendas do produto; null quando desconhecido.
variantsobject[]obrigatório
As variantes do produto.
+17 campos de variants
- 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á.
createdAtstringobrigatório
Quando o recurso foi criado (ISO 8601, UTC).
salesPagestringobrigatóriopode ser nulo
URL da página de vendas; null quando não há.
updatedAtstringobrigatório
Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).
descriptionstringobrigatóriopode ser nulo
Descrição; null quando não há.
warrantyDaysintegerobrigatório
Garantia oferecida ao comprador, em dias.
imageAssetIdsanypode ser nulo
Ids dos arquivos de imagem; null quando não há.
externalReferencestringobrigatóriopode ser nulo
O seu próprio identificador do produto; null quando não há.

400Requisição inválida (validação)

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

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

AnteriorAtualiza um produto PróximaExclui um produto