v1

latestOpenAPI 3.0.02026-07-2411031.3 KB

Consultar todos os pedidos

Obtenha a lista e as informações de todos os pedidos cadastrados.

get/orders

Query parameters

merchant_idstring

Token que identifica o estabelecimento comercial

numberstring

Número do pedido.

referencestring

Referência do pedido.

status'DRAFT' | 'ENTERED' | 'CANCELED' | 'PAID' | 'RE-ENTERED'

Status do pedido.

terminal_numberstring

Número lógico.

pagestring

Número da página a ser retornada na consulta. A paginação inicia em 0

page_sizestring

Quantidade de itens retornados por página.

last_query_datestring

Data inicial utilizada como referência para a última consulta.

Headers

client-idstring required

Token da aplicação gerado durante o processo de cadastro.

access-tokenstring required

Token de acesso gerado durante o processo de cadastro.

merchant-idstring required

Identificador do estabelecimento comercial gerado durante o processo de cadastro.

Response

Consulta efetuada com sucesso

idstring

UUID que identifica unicamente o pedido

numberstring

Número do pedido. Geralmente, esse número representa o identificador do pedido em um sistema externo através da integração com parceiros.

referencestring

Referência do pedido. Utilizada para facilitar seu acesso ou localização.

status'ENTERED' | 'RE-ENTERED' | 'PAID' | 'CLOSED' | 'DRAFT'

Status do pedido.

created_atstring

Data de criação do pedido. A data deve estar no formato: YYYY-MM-DDThh:mm:ssZ.

updated_atstring

Data da última atualização do pedido. A data deve estar no formato: YYYY-MM-DDThh:mm:ssZ

pricestring

Valor total do pedido em centavos. Exemplo: O valor R$ 10,00 é representado como 1000

remainingstring

Valor restante do pagamento do pedido em centavos. Exemplo: O valor R$ 10,00 é representado como 1000

payment_codestring

Forma de pagamento estabelecida na criação do pedido. Caso não seja informado, será necessário escolher a forma no POS. Funcionalidade indisponível para LIO.

All 11 operations