YAyampi
Catálogo - SKUs

Criar SKU

Changed on

Cria um novo SKU para um produto

post/{alias}/catalog/skus

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/catalog/skus
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

Request body

idinteger

ID do SKU

store_idinteger

ID da loja dona do SKU

product_idinteger required

ID do produto ao qual o SKU pertence. Em produtos sem variação, só é aceito um SKU por produto.

skustring required

Código do SKU. Deve ser único na loja.

tokenstring

Token único do SKU, gerado pela Yampi na criação

erp_idinteger

ID do SKU no ERP

barcodestring

Código de barras do SKU. Na criação, precisa ser um código de barras válido.

allow_sell_without_customizationboolean

Permite finalizar a compra sem preencher as personalizações vinculadas ao SKU

price_costnumber float required

Preço de custo do SKU, usado internamente para cálculo de margem

price_salenumber float required

Preço de tabela do SKU, sem descontos aplicados

price_discountnumber float

Preço promocional do SKU. Quando maior que zero, substitui o preço de tabela na loja.

weightnumber float required

Peso do SKU em kg. Obrigatório, exceto em produtos digitais.

heightnumber float required

Altura do SKU em cm. Obrigatória, exceto em produtos digitais.

widthnumber float required

Largura do SKU em cm. Obrigatória, exceto em produtos digitais.

lengthnumber float required

Comprimento do SKU em cm. Obrigatório, exceto em produtos digitais.

quantity_managedboolean required

Habilita o controle de estoque do SKU. Só com este campo habilitado o campo current_stock é considerado.

availabilityinteger required

Prazo de disponibilidade do SKU, em dias, somado ao prazo de entrega do estoque

availability_soldoutinteger required

Comportamento quando o estoque zera. -1: torna o SKU indisponível. 0: continua vendendo sem prazo adicional. >0: define um novo prazo de entrega em dias.

blocked_saleboolean required

Bloqueia a venda deste SKU

orderinteger

Ordem de exibição do SKU na página do produto

variations_values_idsinteger[] required

IDs dos valores de variação que identificam o SKU. Obrigatório em produtos com variação, com exatamente um valor por variação cadastrada no produto.

customizations_idsinteger[]

IDs das personalizações vinculadas ao SKU

Example request

{
  "images": [
    {
      "url": "https://www.site.com/image1.jpg"
    }
  ]
}

Response

SKU criado com sucesso

idinteger

ID do SKU

product_idinteger

ID do produto ao qual o SKU pertence

seller_idinteger

ID do vendedor

skustring

Código do SKU

tokenstring

Token único do SKU

erp_idstring

ID do SKU no ERP

blocked_saleboolean

Vendas bloqueadas

barcodestring

Código de barras do SKU

titlestring

Título completo do SKU

allow_sell_without_customizationboolean

Permite vender sem personalização obrigatória

price_costnumber float

Preço de custo do SKU

price_salenumber float

Preço de tabela do SKU, sem descontos aplicados

price_discountnumber float

Preço promocional cadastrado no SKU. Quando maior que zero, substitui o preço de tabela

combinationsstring[]

Combinações de variações associadas ao SKU

weightnumber float

Peso do SKU em kg

heightnumber float

Altura do SKU em cm

widthnumber float

Largura do SKU em cm

lengthnumber float

Comprimento do SKU em cm

quantity_managedboolean

Indica se o controle de estoque está habilitado

availabilityinteger

Prazo de disponibilidade do SKU, em dias, somado ao prazo de entrega do estoque

availability_soldoutinteger

Comportamento quando o estoque zera. -1: torna o SKU indisponível. 0: continua vendendo sem prazo adicional. >0: define um novo prazo de entrega em dias.

orderinteger

Ordem de exibição do SKU para a página de produtos

days_availability_formatedstring

Disponibilidade formatada em dias

total_in_stockinteger

Quantidade total em estoque

stock_status'in_stock' | 'out_of_stock' | 'low_stock'

Status do estoque

total_ordersinteger

Número total de pedidos realizados

image_reference_sku_idinteger

ID do SKU de referência da imagem

purchase_urlstring url

URL para a compra do produto

Example response

{
  "sku": "SKU-TEST-API",
  "erp_id": "01-753-Rose",
  "barcode": "barcode-test",
  "title": "Produto X - Variação 030303 Amarelo",
  "allow_sell_without_customization": true,
  "quantity_managed": true,
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "customizations": {
    "data": [
      {
        "name": "Primeira Letra",
        "description": "Descrição",
        "type": "select",
        "required": true,
        "max_chars": 1
      }
    ]
  }
}

Changes

  • bbafb577e11cRevision changes
    • breaking

      the request property // became required

    • breaking

      the / request property type changed from string to integer

    • info

      the request optional property became read-only

    • info

      the request optional property became read-only