🔗Listar Vendas

Listar Vendas

Para listar venda é necessário seguir este roteiro de detalhe. O procedimento requer o envio de uma solicitação utilizando o método GET.

Esta solicitação pode ser realizada de duas maneiras distintas: utilizando dados no formato JSON ou através de Multipart/fomr-data.

URL de Solicitação:

https://api.zsystems.com.br/vendas/lista

Cabeçalhos Exigidos para a Requisição:

  • Content-Type: Necessário especificar como multipart/form-data ou application/json, adaptado ao método de envio dos dados.

  • Authorization: Precisa incluir um 'TokenAPI', precedido por Bearer, para confirmar a autenticação e conceder permissão para realizar a solicitação.

Detalhes dos Parâmetros da Solicitação:

Id
Tipo
Descrição

limit

Define a quantidade de vendas a serem exibidos por página

page

Número atual da página

startDate

Data inicial a ser pesquisada

endDate

Data final a ser pesquisada

price_range

Intervalo de valores

bandeira

Bandeira do cartão

status

Status do pedido (Venda)

omni2

Nome do estabeleciemento

cliente

Nome do cliente

formaPagamento

boleto = Boleto debito = Débito creditoVista = Crédito à Vista creditoParcelado = Crédito Parcelado pix = Pix

tipoVenda

1 = Presencial 2 = Online 3 = Link de Pagamento

Exemplo de requisição:

{
		page: 1,
		limit: 2,
		startDate: '2023-04-05',
		endDate: '2023-04-05',
		bandeira: [
				"mastercard",
			],
		formaPagamento: [
				"creditoVisa",
			],
		status: [
			2,
			]
		tipoVenda: [
			2,
			]
		price_range: [
				200,
				200,
			]
		omni2: "Made Nova Madeiras Ltda",
		cliente: "Nikolas Roger"
	}

Exemplo de resultado:


	"success": true,
	"message": "Vendas",
	"vendas": [
		{
			"id": 50123248,
			"cliente": {
				"id": 22791676,
				"nome": "Nikolas Roger de Moura Bararua"
			},
			"estabelecimento": {
				"id": 158,
				"nome_fantasia": "Made Nova Madeiras Ltda"
			},
			"created": "2023-04-05T14:49:42.000Z",
			"modified": "2023-04-05T14:59:01.000Z",
			"bandeira": null,
			"removed": null,
			"parcelas": 1,
			"pos_identification_number": null,
			"status_pedido_id": 1,
			"tipo_pagamento": "boleto",
			"valor_bruto": "122.22",
			"valor_liquido": "122.22"
		},
		{
			"id": 50116580,
			"cliente": {
				"id": 21601480,
				"nome": "Bruno agenda online"
			},
			"estabelecimento": {
				"id": 158,
				"nome_fantasia": "Made Nova Madeiras Ltda"
			},
			"created": "2023-04-05T13:33:44.000Z",
			"modified": "2023-04-05T13:35:02.000Z",
			"bandeira": "visa",
			"removed": null,
			"parcelas": 1,
			"pos_identification_number": null,
			"status_pedido_id": 2,
			"tipo_pagamento": "credit",
			"valor_bruto": "200.00",
			"valor_liquido": "192.02"
		}
	]
}

Last updated