v1
latestOpenAPI 3.1.02026-08-045026.6 KBConsultar vendas
Através deste endpoint é possível consultar os Pedidos de uma ou mais lojas vinculadas em um token
get/search_sales
Query parameters
p_date_column_filterstring required
Indica a coluna que será utilizada para o filtro de período. Opções: shift_date, created_at e updated_at
p_filter_date_startstring date-time required
Data de inicio do período em que será feita a consulta
p_filter_date_endstring date-time required
Data de fim do período em que será feita a consulta. O período da consulta não pode ultrapassar 15 dias, caso ultrapasse, a consulta retornará erro
p_limitinteger
Limite de registros que serão retornados. O padrão é 300, mas pode ser alterado para até 1.000
p_offsetinteger
Indica a partir de qual registro a consulta deve começar a retornar resultados, importante para realizar a paginação dos dados
Headers
Authorizationstring
Token JWT gerado no sistema Saipos
Response
200
Example response
[
{
"id_store": 32136,
"id_sale": 294449468,
"id_sale_type": 4,
"created_at": "2024-07-01T07:28:18",
"updated_at": "2024-07-13T08:19:09",
"shift_date": "2024-07-01",
"totals": {
"total_amount": 12,
"total_discount": 12,
"total_amount_items": 24
},
"store_shift": {
"desc_store_shift": "Dia",
"starting_time": "07:00"
},
"partner_delivery": {
"created_at": "2024-07-01T07:28:18"
},
"ticket": {
"number": 3
},
"schedule": {
"schedule_datetime": "2024-07-01T07:28:18"
},
"nfce": {
"serie": "4",
"numero": 42866,
"data_emissao": "2024-07-01T07:28:54"
},
"payments": [
{
"payment_amount": 12,
"created_at": "2024-07-01T07:28:49",
"desc_store_payment_type": "DÉBITO"
}
],
"payment_transaction_smartpos": [
{
"id_pos_partner": "USER-DEFINED",
"payment_amount": 12,
"authorization_code": "A1B2C3",
"authorization_date_time": "2024-07-01T07:30:00",
"approved": true,
"id_transaction": "1234567890",
"card_label": "Visa",
"payment_method": "DÉBITO",
"created_at": "2024-07-01T07:28:49",
"updated_at": "2024-07-01T07:31:00"
}
],
"payment_transaction_tef": [
{
"payment_amount": 50,
"approved": true,
"created_at": "2024-07-01T07:35:00",
"updated_at": "2024-07-01T07:36:30",
"card_label": "Mastercard",
"nsu": "987654321",
"processed_at": "2024-07-01T07:40:00",
"id_authorizer": "REDE"
}
]
}
]