Retorna listagem de pedidos

Requisição

Parâmetros Path

page

integer

requerido

Número da página. Tamanho da página 100 registros

Parâmetros Query

status

string

opcional

Filtro de status opcional, valores possíveis "Em aberto", "Faturado", "Cancelado", "Orçamento", "Aprovados", "Não Aprovados"

search

string

opcional

Filtro para buscar por nome do cliente ou código do pedido

Exemplos de Requisição

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Respostas

🟢200OK

application/json

Response

Body

array of:

success

boolean

opcional

message

string

opcional

Padrão:

Vendas encontradas

response

array[object (saleListObject) {10}]

opcional

_id

string

opcional

Id

code

integer

opcional

Código único

dateCreated

string

opcional

Data da venda

customerId

string

opcional

Id do cliente do pedido

personName

string

opcional

Nome do cliente

type

enum<string>

opcional

Tipo do pedido.

Valores permitidos:

VendaAssistência TécnicaOrçamentoCompraVenda ConsignadaVenda RepresentaçãoBonificação/Remessa

status

enum<string>

opcional

Valores permitidos:

Em abertoFaturado

po

string

opcional

Id da OP do pedido (se houver)

nfe

string

opcional

Id da NFe

nfeStatus

enum<string>

opcional

Status da NFe do pedido

Valores permitidos:

AutorizadaPendenteCanceladaDenegada

Exemplo

[
  {
    "success": true,
    "message": "Vendas encontradas",
    "response": [
      {
        "_id": "string",
        "code": 0,
        "dateCreated": "string",
        "customerId": "string",
        "personName": "string",
        "type": "Venda",
        "status": "Em aberto",
        "po": "string",
        "nfe": "string",
        "nfeStatus": "Autorizada"
      }
    ]
  }
]

🟠400Bad Request

🔴500Server Error