Consulte o merchant

curl --request GET \
  --url https://api.dev.connect.onbeefapp.com.br/v1/merchant \
  --header 'Authorization: Bearer <token>'

{
  "lastUpdate": "<string>",
  "TTL": 123,
  "id": "<string>",
  "status": "<string>",
  "categories": [
    {
      "id": "<string>",
      "name": "<string>",
      "index": 123,
      "status": "<string>",
      "externalCode": "<string>",
      "productsId": {}
    }
  ],
  "products": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "price": 123,
      "unit": "<string>",
      "status": "<string>",
      "stock": 123,
      "externalCode": "<string>",
      "ean": "<string>",
      "sku": "<string>",
      "media": {},
      "cuts": [
        {}
      ]
    }
  ]
}

GET

merchant

Consulte o merchant

curl --request GET \
  --url https://api.dev.connect.onbeefapp.com.br/v1/merchant \
  --header 'Authorization: Bearer <token>'

{
  "lastUpdate": "<string>",
  "TTL": 123,
  "id": "<string>",
  "status": "<string>",
  "categories": [
    {
      "id": "<string>",
      "name": "<string>",
      "index": 123,
      "status": "<string>",
      "externalCode": "<string>",
      "productsId": {}
    }
  ],
  "products": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "price": 123,
      "unit": "<string>",
      "status": "<string>",
      "stock": 123,
      "externalCode": "<string>",
      "ean": "<string>",
      "sku": "<string>",
      "media": {},
      "cuts": [
        {}
      ]
    }
  ]
}

Este endpoint retorna o status, as categorias e os produtos da loja. O campo TTL informa o tempo de cache dos dados.

Campos da resposta

200: Sucesso

lastUpdate

string

Timestamp ISO 8601 da última atualização dos dados do merchant na plataforma Onbeef (por exemplo, "2025-08-22T16:13:37.000000Z").

TTL

integer

Time-to-live do cache em segundos. Após esse tempo, a resposta em cache é invalidada e uma nova leitura será feita.

string

UUID único do merchant na plataforma Onbeef (por exemplo, "e9e7e242-fbee-4e43-9c3f-251c1e6588fb").

status

string

Disponibilidade atual do merchant. Um dos valores "AVAILABLE" ou "UNAVAILABLE".

401: Não autorizado

Token ausente ou inválido. Reautentique-se e tente novamente. Veja Erros.

503: Serviço indisponível

Serviço temporariamente indisponível ou token inválido. Veja Erros.

Exemplo

Requisição

curl https://api.dev.connect.onbeefapp.com.br/v1/merchant \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'

Resposta (truncada)

{
  "lastUpdate": "2025-08-22T16:13:37.000000Z",
  "TTL": 600,
  "id": "e9e7e242-fbee-4e43-9c3f-251c1e6588fb",
  "status": "AVAILABLE",
  "categories": [
    {
      "id": "bdfbb2f3-af2a-4ad7-8714-f3c75531e78f",
      "name": "Kits",
      "index": 0,
      "status": "AVAILABLE",
      "externalCode": "72BD8D",
      "productsId": [
        "1db3abc1-d295-4873-be31-ef64050a31f7",
        "e74dd75f-2a7c-416a-997d-02bab6adc10b"
      ]
    },
    {
      "id": "82532a6d-c6d4-44c7-ab32-a8eca9bb29ca",
      "name": "Churrasco",
      "index": 1,
      "status": "AVAILABLE",
      "externalCode": "4C951B",
      "productsId": [ "..." ]
    }
  ],
  "products": [
    {
      "id": "1db3abc1-d295-4873-be31-ef64050a31f7",
      "name": "Picanha Angus Premium",
      "description": "Picanha de raça Angus, maturada 21 dias.",
      "price": 89.90,
      "unit": "KG",
      "status": "AVAILABLE",
      "stock": 15.5,
      "externalCode": "PIC001",
      "ean": "7891234560001",
      "sku": "PIC-ANG-001",
      "media": [
        "https://cdn.onbeefapp.com.br/products/picanha-angus.jpg"
      ],
      "cuts": [
        { "id": "cut-001", "name": "Sem osso", "spice": { "id": "spice-001", "name": "Natural" } },
        { "id": "cut-002", "name": "Com gordura", "spice": null }
      ]
    }
  ]
}

Use o valor de TTL para decidir com que agressividade cachear esta resposta do seu lado. Se TTL for 600, o cache da Onbeef pode servir dados obsoletos por até 10 minutos: leve isso em conta ao esperar que mudanças rápidas de catálogo sejam refletidas.

Obter token Status da sincronização

⌘I

Visão geral

Autenticação

Merchant

Pedidos

Logística

Consulte o merchant

Campos da resposta

200: Sucesso

401: Não autorizado

503: Serviço indisponível

Exemplo

Requisição

Resposta (truncada)

​Campos da resposta

​200: Sucesso

​401: Não autorizado

​503: Serviço indisponível

​Exemplo

​Requisição

​Resposta (truncada)

Campos da resposta

200: Sucesso

401: Não autorizado

503: Serviço indisponível

Exemplo

Requisição

Resposta (truncada)