Cria uma variante de produto

Parâmetros do caminho

• productIdstringobrigatório

  Identificador público (prd_/pro_…)

Corpo da requisição

• skustring

  O seu SKU.

• namestringobrigatório

  Nome da variante.

• fiscalobjectpode ser nulo

  O que a variante muda no 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 a variante está à venda.

• pricingobjectobrigatório

  Preço e modelo de cobrança da variante.

  +22 campos de pricing

  • typestring

    oneTime (uma venda) ou recurring (um plano de assinatura).

    Valores:oneTimerecurring
  • tiersobject[]

    As faixas de preço (schema=tiered), em ordem crescente de upTo.

    +3 campos de tiers

    • upTointegerpode ser nulo

      Limite superior da faixa (unidades); null = sem limite (a última faixa).

    • flatPriceintegerpode ser nulo

      Valor fixo somado quando a faixa é atingida, em centavos.

    • unitPriceintegerobrigatório

      Preço unitário dentro da faixa, em centavos.

  • cyclesintegerpode ser nulo

    Número de ciclos até a assinatura acabar; null = até ser cancelada.

  • schemastring

    Como o preço é calculado: unit (preço × quantidade), tiered (por faixas de quantidade) ou package (por bloco de unidades).

    Valores:unittieredpackage
  • currencystring

    Código de moeda ISO 4217

  • oldPriceinteger

    O preço antes de um desconto, em centavos — mostrado riscado.

  • daysTrialinteger

    Duração do período de teste de um plano recorrente, em dias.

  • tiersModestring

    graduated: cada faixa precifica as próprias unidades; volume: a faixa atingida precifica todas as unidades.

    Valores:graduatedvolume
  • unitPriceinteger

    Preço unitário, em centavos (mínimo 500 em unit; não usado em tiered).

  • usageTypestring

    licensed (quantidade fixa) ou metered (cobrado pelo uso que você reporta).

    Valores:licensedmetered
  • billingTypestring

    Quando um ciclo é cobrado: prepaid (no início), postpaid (no fim) ou exactday (em billingExactDay).

    Valores:prepaidpostpaidexactday
  • costPerIteminteger

    O seu custo por unidade, em centavos (para os seus relatórios de margem).

  • trialIntervalstring

    Unidade da duração do teste.

    Valores:dayweekmonthyear
  • meterEventNamestring

    Nome do medidor de uso que você reporta (só metered).

  • billingExactDayinteger

    Dia do mês em que o ciclo é cobrado (billingType=exactday).

  • renewalShippingboolean

    Planos recorrentes: cobrar o frete cotado no checkout em CADA renovação (padrão true).

  • billingFrequencystring

    Unidade do intervalo de cobrança.

    Valores:dailyweeklymonthlyyearly
  • usageAggregationstring

    Como os registros de uso de um ciclo são agregados: sum, max, lastDuringPeriod ou lastEver.

    Valores:summaxlastDuringPeriodlastEver
  • transformQuantityobject

    Em schema=package: quantas unidades formam um bloco, e como um bloco parcial é arredondado.

    +2 campos de transformQuantity

    • roundstring

      Como um bloco parcial é arredondado.

      Valores:updown
    • divideByintegerobrigatório

      Unidades por bloco.

  • trialIntervalCountinteger

    Duração do teste, em unidades de trialInterval.

  • billingFrequencyCountinteger

    Quantas unidades de billingFrequency por ciclo.

  • renewalMethodDiscountboolean

    Planos recorrentes: estender o desconto do meio de pagamento do checkout às renovações cobradas pelo mesmo meio (padrão false).

• metadataobject

  Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.

• attributesobject

  Atributos livres da variante (tamanho, cor…).

• descriptionstring

  Descrição.

• externalReferencestring

  O seu próprio identificador da variante.

Respostas