Listar Pedidos
Listando Produtos
Para listar os pedidos criados em nossa plataforma e suas informações, realize a consulta via GET na rota Url/segments/{segmentId}/orders.
O SegmentID deverá ser informado, saiba mais em Login via API. O uso de seu Bearer Token também será necessário.
Listar Pedidos
GET {Url}/segments/{segmentId}/orders
Path Parameters
segmentId*
string
ID de Segmento
Query Parameters
phonerNumber
string
Número do telefone
code
string
Código
paymentType
string
Tipo de meio de pagamento
cardFlag
string
Bandeira do Cartão
company
string
Empresa
origin
string
Origem do pedido
status
string
Estado do pedido
dateRange
string
Intervalo de Datas
initialDate
string
Data inicial
finalDate
string
Data final
originApp
string
Canal de Venda
saleChannel
string
ID do canal de venda
orderManualApproval
string
Se o pedido é aprovação manual ou não
deliveryType
string
Forma de envio
noOrderPost
boolean
Filtrar somente pedidos sem postagens
page
number
Número da página
pendings
string
Mostrar apenas os pedidos pendentes
exported
string
Mostrar apenas os pedidos pendentes de exportação
limit
number
Limite de registros por página
[
{
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"code": "string",
"segment": "string",
"origin": "pos-facil",
"observation": "string",
"company": {},
"customer": {},
"device": {},
"cashier": {},
"status": "open",
"subtotal": 0,
"discountAmount": 0,
"amount": 0,
"shippingAmount": 0,
"paidAmount": 0,
"changeAmount": 0,
"items": [],
"transactions": [],
"table": {},
"tableTicket": {},
"deliveryType": "widthdraw",
"paymentType": "card"
}
]Caso a requisição esteja correta, o código 200 OK será retornado.
Prossiga para as próximas sessões para entender mais sobre nossas funções disponíveis.
Outros Erros: Caso sejam retornados outros erros, favor entrar em contato com o time de integração.
Last updated
Was this helpful?