v1

latestOpenAPI 3.0.02026-07-2411031.3 KB

Consultar um pedido

Cria um pedido no servidor do Order Manager.

get/orders/{id}

Path parameters

idstring required

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

OK

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_astring

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.