Takeat
Versão da documentação
Takeat
RestauranteCatálogoProdutos

Nova API V1.0 · Referência

Editar parcialmente categoria de produtos

Atualização parcial: campos omitidos permanecem intactos. Com OAuth, exige `products:write`; a sessão autenticada do restaurante também é aceita. `brand_id` não pode ser alterado. Envie `updated_at` da última consulta como `expected_updated_at` para rejeitar uma revisão obsoleta. O nome é normalizado removendo espaços nas extremidades. Escopo products:write ou sessão autenticada de restaurante. Isolamento pelo restaurante autorizado. Disponibilidades de cada canal são independentes; omissões preservam campos. Marca deve pertencer ao restaurante e não pode ser trocada na edição. Não expõe exclusão, imagens, horários ou configurações de integração.

Console de requisiçõesConfigure os dados, envie e inspecione a resposta.
PUTProxy seguro
RequisiçãoEdite os campos antes de enviar
PUT
/v1/product-categories/{categoryId}

Atualização parcial: campos omitidos permanecem intactos. Com OAuth, exige products:write; a sessão autenticada do restaurante também é aceita. brand_id não pode ser alterado. Envie updated_at da última consulta como expected_updated_at para rejeitar uma revisão obsoleta. O nome é normalizado removendo espaços nas extremidades. Escopo products:write ou sessão autenticada de restaurante. Isolamento pelo restaurante autorizado. Disponibilidades de cada canal são independentes; omissões preservam campos. Marca deve pertencer ao restaurante e não pode ser trocada na edição. Não expõe exclusão, imagens, horários ou configurações de integração.

Authorization

bearerAuth
AuthorizationBearer <token>

Access token OAuth obtido em POST /oauth/token ou sessão autenticada do restaurante emitida pelo login Takeat. Tokens OAuth exigem os escopos de cada operação. A sessão não usa escopos de integração e fica limitada ao restaurant_id assinado. Chaves tk_ não são aceitas.

In: header

Path Parameters

categoryId*integer

Query Parameters

restaurant_id?integer

Omitido para sessões de restaurante ou credenciais com uma única loja. Obrigatório quando uma chave ou autorização OAuth multilojas, ou um parceiro, cobre várias lojas. É validado contra as lojas atualmente autorizadas pela credencial. Em uma sessão, um valor diferente do restaurant_id assinado responde 403.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Atualização parcial. Pelo menos um campo editável deve ser enviado; expected_updated_at sozinho não constitui uma alteração. Campos omitidos mantêm seus valores atuais.

Atualização parcial. Pelo menos um campo editável deve ser enviado; expected_updated_at sozinho não constitui uma alteração. Campos omitidos mantêm seus valores atuais.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

Consultar categoria de produtos GET

Retorna uma categoria de produtos não removida do restaurante autorizado. Com OAuth, exige `products:read`; a sessão autenticada do restaurante também é aceita. Escopo products:read ou sessão autenticada de restaurante. Isolamento pelo restaurante autorizado. Disponibilidades de cada canal são independentes; omissões preservam campos. Marca deve pertencer ao restaurante e não pode ser trocada na edição. Não expõe exclusão, imagens, horários ou configurações de integração.

Listar complementos por categoria GET

Retorna categorias de complementos e seus itens no formato compatível com o API Legado. Com OAuth, exige o escopo `complements:read`; a sessão do restaurante também é aceita.