v1

latestOpenAPI 3.0.02026-07-2671191208.7 KB
Estabelecimentos

Lista extrato do estabelecimento

get/v1/marketplace/establishments/extract

Query parameters

filtersstring
Example:{ "status": "CREATED" }

JSON com filtros. Campos filtráveis: created_at

searchstring
Example:Dado a se buscar

Texto de busca.

perPagenumber

Quantidade de registros por página.

pagenumber

Página.

sortersstring
Example:[ { "column": "created_at", "direction": "DESC" } ]

JSON com lista de ordenadores.

Headers

integration-keystring required

Chave de integração.

x-tokenstring required

x-token utilizado para autenticação. Pode ser encontrado em nosso portal, na guia de integração com a api pública.

establishment_idstring required

ID do estabelecimento.

Response

totalnumber required

Total de registros.

perPagenumber required

Registros por página.

pagenumber required

Página atual.

lastPagenumber required

Última página.