Criar produto

POST

Markdown (LLM)

Cria um produto.

Escopo:catalog:write

Limite:300 requisições a cada 3 minutos.

Parâmetros do body

barcodestring

Código de barras.

"7891000315507"

codestring

Código interno.

"25"

namestring

Nome do produto.

"4 Esferas do Dragão de Pepperoni"

descriptionstring

Descrição do produto.

"Mussarela e pepperoni."

internalNotesstring

Observações internas.

"Disponível por tempo indeterminado."

labelstring

Selo do cardápio: newrecommendedbestSellerlimitedEdition

"new"

unitstring

Unidade de medida (Default: UN).

Enum

UNUnidade
KGQuilograma
GGrama
LLitro

"UN"

pricenumber

Preço padrão.

19.99

featuredboolean

Indica se está em destaque.

false

featuredPrintboolean

Indica se tem destaque na impressão.

false

serviceFeeActiveboolean

Indica se a taxa de serviço está ativa.

true

scheduleOnlyboolean

Indica se a venda é apenas por agendamento.

false

scaleActiveboolean

Indica se a balança está ativa.

false

scaleShelfLifeDaysnumber

Validade em dias na balança.

0

sectorIdnumber

Identificador de um setor da mesma empresa.

1997

Parâmetros da resposta

productIdnumber

Identificador do produto.

131822

storeIdnumber

Identificador da empresa.

107

barcodestring

Código de barras.

"7891234567890"

codestring

Código interno.

"25"

typestring

Tipo derivado do PDV: "product". Somente leitura.

Enum

productDados do produto
menuCardápio do produto
restrictionsRestrições alimentares
groupsOrdem dos grupos

"product"

namestring

Nome do produto.

"Pizza de Frango com Catupiry"

descriptionstring

Descrição do produto.

"Mussarela, frango e requeijão."

internalNotesstring

Observações internas.

"Disponível por tempo indeterminado."

labelstring

Selo do cardápio: newrecommendedbestSellerlimitedEdition

"new"

unitstring

Unidade de medida (Default: UN).

Enum

UNUnidade
KGQuilograma
GGrama
LLitro

"UN"

pricenumber

Preço padrão.

19.99

featuredboolean

Indica se está em destaque.

false

featuredPrintboolean

Indica se tem destaque na impressão.

false

serviceFeeActiveboolean

Indica se a taxa de serviço está ativa.

true

scheduleOnlyboolean

Indica se a venda é apenas por agendamento.

false

scaleActiveboolean

Indica se a balança está ativa.

false

scaleShelfLifeDaysnumber

Validade em dias na balança.

0

sectorIdnumber

Identificador de um setor da mesma empresa.

1997

sectorNamestring

Nome do setor. Somente leitura.

"Pizzas"

comboboolean

Indica se é combo. Somente leitura: vira true quando o produto tem ao menos um grupo vinculado e volta a false quando o último é desvinculado.

false

Body (JSON)

json

1234567891011121314151617181920{
  "name": "4 Esferas do Dragão de Pepperoni",
  "description": "Mussarela e pepperoni.",
  "sectorId": 1997,
  "label": "new",
  "featured": false,
  "price": 19.99,
  "code": "25",
  "barcode": "7891000315507",
  "unit": "UN",
  "cost": {
    "base": 8.5
  },
  "featuredPrint": false,
  "serviceFeeActive": true,
  "scheduleOnly": false,
  "internalNotes": "Disponível por tempo indeterminado.",
  "scaleActive": false,
  "scaleShelfLifeDays": 0
}

Linguagem

Produção

Requisição

POST /v1/catalog/products

12345678910111213141516171819202122232425262728import axios from "axios";
const { data } = await axios({
  method: "post",
  url: "https://api.beefood.app/v1/catalog/products",
  headers: {
    Authorization: `Bearer ${accessToken}`,
  },
  data: {
    "name": "4 Esferas do Dragão de Pepperoni",
    "description": "Mussarela e pepperoni.",
    "sectorId": 1997,
    "label": "new",
    "featured": false,
    "price": 19.99,
    "code": "25",
    "barcode": "7891000315507",
    "unit": "UN",
    "cost": {
      "base": 8.5
    },
    "featuredPrint": false,
    "serviceFeeActive": true,
    "scheduleOnly": false,
    "internalNotes": "Disponível por tempo indeterminado.",
    "scaleActive": false,
    "scaleShelfLifeDays": 0
  },
});

Resposta

json

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798{
  "productId": 131822,
  "storeId": 107,
  "barcode": "7891234567890",
  "code": "25",
  "type": "product",
  "name": "Pizza de Frango com Catupiry",
  "description": "Mussarela, frango e requeijão.",
  "internalNotes": "Disponível por tempo indeterminado.",
  "label": "new",
  "unit": "UN",
  "price": 19.99,
  "featured": false,
  "featuredPrint": false,
  "serviceFeeActive": true,
  "scheduleOnly": false,
  "scaleActive": false,
  "scaleShelfLifeDays": 0,
  "sectorId": 1997,
  "sectorName": "Pizzas",
  "combo": false,
  "cost": {
    "base": 0,
    "supply": 0,
    "total": 0
  },
  "menus": [
    {
      "merchantId": 122,
      "name": "BeeFood - Cardápio Digital",
      "active": true,
      "delivery": true,
      "deliveryPrice": 19.99,
      "dineIn": true,
      "dineInPrice": 19.99,
      "totem": false,
      "promotionPrice": 15.99,
      "sortOrder": 1,
      "featuredOrder": 2,
      "cashbackEnabled": true,
      "upsell": [
        {
          "productId": 2586827,
          "name": "7 Esferas do Dragão de Pepperoni"
        }
      ]
    }
  ],
  "restrictions": {
    "vegetarian": false,
    "vegan": false,
    "organic": false,
    "glutenFree": false,
    "sugarFree": false,
    "lactoseFree": false,
    "natural": false,
    "iced": false,
    "serves": 1
  },
  "groups": [
    {
      "groupId": 5668252,
      "name": "Escolha seus Condimentos:",
      "active": true,
      "delivery": true,
      "dineIn": true,
      "required": true,
      "sortOrder": 1,
      "priceFormation": "gift",
      "minQuantity": 1,
      "maxQuantity": 1,
      "selectionMode": "single",
      "options": [
        {
          "optionId": 5670994,
          "productId": 2586516,
          "name": "Sachê Ketchup",
          "type": "complement",
          "active": true,
          "delivery": true,
          "dineIn": true,
          "minQuantity": 1,
          "maxQuantity": 1,
          "price": 0,
          "deliveryPrice": 0,
          "dineInPrice": 0,
          "sortOrder": 0,
          "image": {
            "original": "https://domain.com/opt.webp",
            "thumbnail60": "https://domain.com/opt-60.jpg",
            "thumbnail120": "https://domain.com/opt-120.jpg",
            "thumbnailWeb": "https://domain.com/opt.webp"
          }
        }
      ]
    }
  ]
}