Endpoint: Buscando Pedidos

Endpoint para busca de pedidos cadastrados na plataforma SULTS.

URL: https://api.sults.com.br/api/v1/comercial/pedido

Método: GET

Observação

A busca da lista de pedidos é paginada. O endpoint é limitado a 100 registros por página.

Parâmetros

Headers

Header	Valor
Authorization	<token_de_acesso>
Content-Type	application/json;charset=UTF-8

Query parameters

Filtro	Valor	Descrição
start	Integer	Início da paginação (número da página). Padrão 0
limit	Integer	Número de registros por página. Máximo 100. Padrão 100
id	Integer	Código do pedido
situacao	Integer referente a situação: 2 – Aguardando 3 – Faturado 4 – Enviado 5 – Entregue	Situação atual do pedido
unidadeId	Integer	Código da unidade do pedido
fornecedorId	Integer	Código do fornecedor do pedido
compradorId	Integer	Código da pessoa a qual efetuou o pedido
dtPedidoStart	String	Data de realização do pedido. Busca os pedido realizados a partir da data informada. Essa data deve ser uma string em UTC ISO 8601. Exemplo: 2022-08-29T10:02:55Z
dtPedidoEnd	String	Data de realização do pedido. Busca os pedidos realizados anteriores à data informada. Essa data deve ser uma string em UTC ISO 8601. Exemplo: 2022-08-29T10:02:55Z
cancelado	Boolean	Pedidos cancelados (por padrão é false) true – somente os pedidos cancelados. false – somente os pedidos ativos.
canceladoEmStart	String	Data de exclusão do pedido. (necessita do parâmetro cancelado igual a true) Busca os pedidos excluídos a partir da data informada. Essa data deve ser uma string em UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
canceladoEmEnd	String	Data de exclusão do pedido. (necessita do parâmetro cancelado igual a true) Busca os pedido excluídos anteriores à data informada. Essa data deve ser uma string em UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z

Exemplo

fetch("https://api.sults.com.br/api/v1/comercial/pedido", {
	method: "GET",
	headers: {
		"Authorization": "<token_de_acesso>",
                "Content-Type":"application/json;charset=UTF-8"
	}
})

Resposta

{
	"data": [
		{
			"id": 110,
			"criado": "2022-07-29T03:35:18Z",
			"valor": 302.00,
			"valorMin": 0.00,
			"situacaoId": 2,
			"unidade": {
				"id": 88,
				"nome": "SULTS",
				"razaoSocial": "SULTS",
				"cnpj": "99999999999999"
			},
			"comprador": {
				"id": 108,
				"nome": "John Doe da Silva",
				"celular": "34999999999",
				"email": "johndoe@sults.com.br"
			},
			"endereco": {
				"cep": "38000000",
				"rua": "Rua genérica 01",
				"numero": "1200",
				"bairro": "Centro",
				"complemento": "",
				"cidade": "Uberaba",
				"uf": "MG"
			},
            "meioPagamento": {
				"id": 1,
				"nome": "A Combinar"
			},
            "meioEntrega": {
				"id": 3,
				"nome": "A Combinar"
			},
			"fornecedor": {
				"id": 37,
                "nome": "Empresa Teste LTDA",
                "razaoSocial": "Empresa Teste LTDA",
                "cnpj": "99999999999999",
                "telefone": [
                    "99999999999999"
                ]
			},
			"cancelado": true,
			"canceladoMotivo": "Motivo do cancelamento",
			"canceladoEm": "2024-02-22T10:43:00Z",
			"canceladoPor": {
				"id": 1,
				"nome": "User Teste"
			}
		}
	],
	"start": 0,
	"limit": 100,
	"size": 1,
	"totalPage": 1
}

Campos de resposta

Campos principais

Nome Atributo	Tipo	Descrição
id	Integer	Código do pedido
criado	String	Data de realização do pedido. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
valor	Decimal	Valor total do pedido
valorMin	Decimal	Valor mínimo do pedido
situacaoId	Integer	Situação atual do pedido: 2 – Aguardando 3 – Faturado 4 – Enviado 5 – Entregue
unidade	Objeto Unidade	Unidade do comprador do pedido. Os campos relacionados a esse objeto estão listados em uma tabela abaixo.
comprador	Objeto Pessoa	Pessoa que efetuou o pedido. Os campos relacionados a esse objeto estão listados em uma tabela abaixo.
compradorObservacao	String	Observação do comprador em relação ao pedido
endereco	Objeto Endereco	Endereço do comprador. Os campos relacionados a esse objeto estão listados em uma tabela abaixo.
meioPagamento	Objeto MeioPagamento – id – nome	Meio de pagamento do pedido
meioEntrega	Objeto MeioEntrega: – id – nome	Meio de entrega do pedido
fornecedor	Objeto Fornecedor	Fornecedor do pedido. Os campos relacionados a esse objeto estão listados em uma tabela abaixo.
observacao	String	Observação do fornecedor em relação ao pedido
mensagem	String	Mensagem destinada ao comprador
cancelado	Boolean	Pedido cancelado: true – Cancelado false – Ativo
canceladoMotivo	String	Motivo pelo cancelamento do pedido
canceladoEm	String	Data de conclusão do pedido. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
canceladoPor	Objeto Pessoa – id – nome	Pessoa que cancelou o pedido

Campos do Objeto Unidade

Nome Atributo	Tipo	Descrição
id	Integer	Código da unidade do comprador
nome	String	Nome fantasia da unidade do comprador
razaoSocial	String	Razão social da unidade do comprador
cnpj	String	CNPJ da unidade do comprador

Campos do Objeto Pessoa

Nome Atributo	Tipo	Descrição
id	Integer	Código da pessoa
nome	String	Nome da pessoa
celular	String	Celular da pessoa
email	String	E-mail da pessoa

Campos do Objeto Endereco

Nome Atributo	Tipo	Descrição
cep	String	CEP do endereço do comprador
rua	String	Rua do endereço do comprador
numero	String	Número do endereço do comprador
bairro	String	Bairro do endereço do comprador
complemento	String	Complemento do endereço do comprador
cidade	String	Cidade do endereço do comprador
uf	String	UF do endereço do comprador

Campos do Objeto Fornecedor

Nome Atributo	Tipo	Descrição
id	Integer	Código do fornecedor do pedido
nome	String	Nome fantasia do fornecedor do pedido
razaoSocial	String	Razão social do fornecedor do pedido
cnpj	String	CNPJ do fornecedor do pedido