Criar um pedido

post

https://api.cielo.com.br/sandbox-lio/order-management/v1/orders

Cria um pedido no servidor do Order Manager.

Ambiente	Método	Endpoint
Sandbox	post	`https://api.cielo.com.br/sandbox-lio/order-management/v1/orders`
Produção	post	`https://api.cielo.com.br/order-management/v1/orders`

Na interface L300 V3 (LIO), os parâmetros paymentCode e installments não funcionam.
Nos dispositivos da Nova Smart (L300 V4, L400 e DX800), o pedido é exibido com a forma de pagamento definida em paymentCode já selecionada, simplificando a experiência do usuário e reduzindo erros operacionais. Confira os valores aceitos no campo paymentCode.
Se o campo installments for informado, mas não atender à regra de parcela mínima, deve ser gerado um novo pedido

Por padrão, um pedido cadastrado é sincronizado com todos os terminais do mesmo EC. Mas, ao criar um pedido por integração remota para os modelos L400, L300 V4 e N950U, é possível definir um terminal específico como destino. Nesse caso, o pedido fica disponível apenas nesse terminal, e não nos demais do EC. Para os modelos DX800 e L300 V3, esse recurso ainda não está disponível. Aprenda como criar um pedido para um terminal específico.

Body Params

number

string

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

reference

string

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

status

string

enum

required

Defaults to DRAFT

Status do pedido.

Allowed:

items

array of objects

required

Lista de itens contidos no pedido.

items*

transactions

array of objects

required

Lista de transações de pagamento (ou outros tipos) efetuadas no pedido.

transactions*

price

string

required

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

remaining

string

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

payment_code

string

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.

installments

integer

Número de parcelas. Use 0 para pagamento à vista.

terminal_number

string

Número lógico do terminal para o qual o pedido será criado, por exemplo 1234567-8. O dígito verificador não é obrigatório. Se você informar o terminal_number, o pedido será atrelado a um terminal específico. Se não informado, o pedido é criado para todos os terminais do EC.

Headers

client-id

string

required

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

access-token

string

required

Token de acesso gerado durante o processo de cadastro.

merchant-id

string

required

Identificador do estabelecimento comercial gerado durante o processo de cadastro.

Responses

401

Não autorizado

201Pedido criado com sucesso

403Proibido

422Requisição inválida