Criar complemento

POST

Markdown (LLM)

Cria um complemento.

Escopo:catalog:write

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

Parâmetros do body

namestring

Nome do complemento.

"Molho Nola"

descriptionstring

Descrição do complemento.

"Descrição de exemplo"

labelstring

Selo do cardápio: newrecommendedbestSellerlimitedEdition

"new"

pricenumber

Preço de venda.

2

codestring

Código interno.

"ABC123"

barcodestring

Código de barras.

"ABC123"

unitstring

Unidade de medida (Default: UN).

Enum

UNUnidade
KGQuilograma
GGrama
LLitro

"UN"

featuredPrintboolean

Indica se tem destaque na impressão.

true

Parâmetros da resposta

complementIdnumber

Identificador do complemento.

2587090

storeIdnumber

Identificador da empresa.

107

namestring

Nome do complemento.

"Molho Nola"

descriptionstring

Descrição do complemento.

"Molho Nola"

labelstring

Selo do cardápio: newrecommendedbestSellerlimitedEdition

"new"

pricenumber

Preço de venda.

2

codestring

Código interno.

"MN1"

barcodestring

Código de barras.

"7891000315507"

unitstring

Unidade de medida (Default: UN).

Enum

UNUnidade
KGQuilograma
GGrama
LLitro

"UN"

activeboolean

Indica se está ativo em pelo menos um cardápio da empresa. Somente leitura.

true

featuredPrintboolean

Indica se tem destaque na impressão.

false

Body (JSON)

json

12345{
  "name": "Molho Nola",
  "price": 2,
  "unit": "UN"
}

Linguagem

Produção

Requisição

POST /v1/catalog/complements

12345678910111213import axios from "axios";
const { data } = await axios({
  method: "post",
  url: "https://api.beefood.app/v1/catalog/complements",
  headers: {
    Authorization: `Bearer ${accessToken}`,
  },
  data: {
    "name": "Molho Nola",
    "price": 2,
    "unit": "UN"
  },
});

Resposta

json

1234567891011121314151617181920212223242526272829303132333435363738{
  "complementId": 2587090,
  "storeId": 107,
  "name": "Molho Nola",
  "description": "Molho Nola",
  "label": "new",
  "price": 2,
  "code": "MN1",
  "barcode": "7891000315507",
  "unit": "UN",
  "active": true,
  "featuredPrint": false,
  "cost": {
    "base": 0,
    "supply": 0,
    "total": 0
  },
  "menus": [
    {
      "merchantId": 122,
      "name": "BeeFood - Cardápio Digital",
      "active": true,
      "delivery": true,
      "deliveryPrice": 2,
      "dineIn": true,
      "dineInPrice": 2,
      "totem": false,
      "sortOrder": 1,
      "cashbackEnabled": false
    }
  ],
  "groups": [
    {
      "optionId": 5672302,
      "name": "Pop Barbecue + Pop Nola Rose : Deseja acrescentar algum ingrediente?"
    }
  ]
}