Retornar uma lista de cobranças

get

https://api-staging.shipay.com.br/orders/list

Este serviço retorna uma lista de cobranças de acordo com o filtro desejado.

IMPORTANTE:

Para garantir que obtenham o status atualizado, as janelas de consulta devem ocorrer com um intervalo mínimo de 1 minuto.
O intervalo de consulta utilizando os filtros de data não pode ultrapassar 24 horas.

Query Params

store_id

string

Identificador da loja criada na Shipay.

order_id

string

Identificador da cobrança na Shipay.

psp_provider

string

Nome do PSP.

status

string

Status da cobrança na Shipay.

external_id

string

Número de equivalência ao seu_número (Identificador do Boleto). Este campo é para controle do cliente.

customer_id

string

Identificador do customer na Shipay.

offset

integer

Quantidade de registros que foram desconsiderados, desde o primeiro registro, no retorno da consulta.

limit

string

Limite de registros por página.

start_date

string

Data e horário inicial do filtro (YYYY-MM-DDT00:00:00).

end_date

string

Data e horário final do filtro (YYYY-MM-DDT23:59:59).

payment_start_date

string

Data e horário inicial do pagamento (YYYY-MM-DDT00:00:00).

payment_end_date

string

Data e horário final do pagamento (YYYY-MM-DDT23:59:59).

Response

200OK