Sincronize o catálogo

Envie o catálogo completo ou uma atualização parcial. A API retorna 204 e processa o payload de forma assíncrona. Consulte o resultado em GET /v1/merchantStatus.

Antes da primeira sincronização, registre a integração com PUT /v1/merchantOnboarding.

Corpo da requisição

merchantStatus

string

required

Disponibilidade da loja após a sincronização: "AVAILABLE" ou "UNAVAILABLE".

entityType

string

required

Tipo de sincronização. Um dos valores:

MERCHANT: sincronização completa: categorias, itens e ofertas (o caso descrito nesta página).
ITEM: atualização apenas de itens (produtos).
ITEM_OFFER: atualização apenas de ofertas (preço e disponibilidade).

onlyAddProducts

boolean

Quando true, os produtos são adicionados sem desassociar os existentes das categorias. Quando false (ou omitido), a associação de produtos das categorias é substituída pelo conteúdo enviado.

updatedObjects

array

required

Array de objetos de merchant. Para entityType: "MERCHANT", o primeiro objeto deve conter o id do merchant (seu identificador de loja no PDV) e as listas categories, items e itemOffers.

Show Campos de updatedObjects[]

string

required

Identificador da sua loja no PDV. É armazenado como pdv_external_id do merchant.

Campos da resposta

204: Sem conteúdo

O catálogo foi recebido e enfileirado para processamento assíncrono. Consulte GET /v1/merchantStatus para confirmar SUCCESS.

401: Não autorizado

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

Exemplo

Requisição

curl -X PUT https://api.dev.connect.onbeefapp.com.br/v1/merchantUpdate \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
  -H 'Content-Type: application/json' \
  -d '{
    "merchantStatus": "AVAILABLE",
    "entityType": "MERCHANT",
    "onlyAddProducts": false,
    "updatedObjects": [
      {
        "id": "9b2f4c1e-0a3d-4e8c-9d6a-2b7f1c0d5e3a",
        "categories": [
          {
            "id": "3f8a1b2c-4d5e-4f70-8192-a3b4c5d6e7f8",
            "name": "Carnes Bovinas",
            "index": 0,
            "status": "AVAILABLE",
            "itemOfferId": ["7c9e2f4a-1b3d-4e6f-8a90-b1c2d3e4f5a6"]
          }
        ],
        "items": [
          {
            "id": "5a6b7c8d-9e0f-4a2b-3c4d-5e6f7a8b9c0d",
            "name": "Picanha",
            "description": "Peça de picanha bovina, vendida por peso",
            "externalCode": "1001",
            "ean": "7891234567890",
            "unit": "KG",
            "image": { "url": "https://example.com/images/picanha.jpg" }
          }
        ],
        "itemOffers": [
          {
            "id": "7c9e2f4a-1b3d-4e6f-8a90-b1c2d3e4f5a6",
            "itemId": "5a6b7c8d-9e0f-4a2b-3c4d-5e6f7a8b9c0d",
            "status": "AVAILABLE",
            "price": { "value": 89.90 }
          }
        ]
      }
    ]
  }'

A API responde 204 No Content. Em seguida, faça polling em GET /v1/merchantStatus até status ser SUCCESS.

O processamento é assíncrono. Um 204 significa apenas que o payload foi aceito e enfileirado, não que o catálogo já está publicado. Confirme sempre com GET /v1/merchantStatus.

Para ocultar temporariamente um produto sem removê-lo, defina o status do itemOffer correspondente como "UNAVAILABLE" em vez de omiti-lo do payload.

Visão geral

Autenticação

Merchant

Pedidos

Logística

Corpo da requisição

Campos da resposta

204: Sem conteúdo

401: Não autorizado

Exemplo

Requisição

​Corpo da requisição

​Campos da resposta

​204: Sem conteúdo

​401: Não autorizado

​Exemplo

​Requisição

Corpo da requisição

Campos da resposta

204: Sem conteúdo

401: Não autorizado

Exemplo

Requisição