Listando Negociações

Listando as negociações

GET /v1/organization/CLIENT_ID/orders?status=STATUS

Após a negociação ser criada e você ter passado o link de Emissão Online para o seu cliente, você pode acompanhar o status da Negocição através deste endpoint. Aqui você terá além do status, todos os outros dados da negociação, com destaque para o número da solicitação no SisAr e o link de integração com o Emissão Online (caso precise para passar novamente para o seu cliente)

circle-info

Todos os endpoints, necessitarão dos 2 tokens no Header e deverá ser passado na URL o CLIENT_ID. Esse assunto foi tratado em Primeiros Passos, caso não tenha este código, acione o time de suporte.

Headers:

Name
Value

Content-Type

application/json

Accept

application/json

Authorization

Bearer <token de Autenticação>

x-spro-authorization

<token de Autorização>

URL Parameters: exemplo: organization/CLIENT_ID/orders?status=UM_STATUS_PERMITIDO

Campo
Exemplo de Valor
Descrição

CLIENT_ID

01jawvcvfahk52qsaerzfa0tyj

Código da sua empresa (passado pelo time de integração após o setup). Detalhado em: Primeiros passos.

STATUS

new

É possível passar um dos status abaixo: - new - payment_confirmed - processing - approved_certificate

Body: vazio

Response:

{
	"data": [
		{
			"id": 19,
			"ulid": "01j0xke0rwjxmc4294ck9p50v3",
			"status": {
				"id": 1,
				"code": "new",
				"label": "Novo"
			},
			"type": "sell_order",
			"public_token": null,
			"order_id": null,
			"order_code": null,
			"status_date": "2024-06-21",
			"obs": null,
			"amount": "25.99",
			"created_at": "2024-06-21",
			"update_at": null,
			"payment_modality": {
				"id": 3,
				"name": "Ultilizar voucher pré-pago",
				"code": "PRE_PAID_VOUCHER",
				"status": true,
				"created_at": "2024-06-20",
				"updated_at": "2024-08-21"
			},
			"payment_method": null,
			"company": {
				"id": 1,
				"ulid": "01j0trm8a0g3c6hygz4m0axh0e",
				"status": true,
				"type": "J",
				"registration_number": "09461647000195",
				"alias": "Soluti - Solucoes Em Negocios Inteligentes S\/a",
				"name": "Soluti - Solucoes Em Negocios Inteligentes S\/a",
				"email": "teste@soluti.com.br",
				"phone": "(55)55555-5555",
				"whatsapp": "(55)55555-5555",
				"country_id": 1058,
				"state_id": 52,
				"city_id": 5208707,
				"address": "teste",
				"number": "0",
				"complement": "..",
				"neighborhood": "Jardim Goiás",
				"postal_code": "74805100",
				"all_customers_has_birdid": null
			},
			"customer": {
				"id": 1,
				"ulid": "01j0trm9ya5j53bdj71gc1gt7p",
				"status": true,
				"registration_number": "02570606107",
				"name": "Nome do representante legal",
				"email": "nome.representante@soluti.com.br",
				"phone": "(88)88888-8888",
				"whatsapp": "(88)88888-8888",
				"bird_id": {
					"is_valid": true,
					"verified_at": "2024-06-20 09:06:05"
				},
				"videoconference": {
					"verification": false,
					"link": null
				}
			},
			"details": [
				{
					"id": 20,
					"original_unit_value": "25.99",
					"additional_unit_value": "0.00",
					"final_unit_value": "25.99",
					"quantity": 1,
					"amount": "25.99",
					"product": {
						"id": 2,
						"certificate_type": "A1",
						"person_type": "PJ",
						"sku": 19776,
						"sisar_id": 310,
						"name": "Certificado PJ A1 - Spro Contadores",
						"validate": 1,
						"description": "ACS PJ A1 V5 G2 - SPRO CONTADORES",
						"min_price": "10.00",
						"max_price": "199.99",
						"status": true,
						"slug": "certificado-pj-a1-spro-contadores",
						"created_at": "2024-07-03",
						"updated_at": "2024-07-03"
					},
					"solicitation_sisar": null,
					"solicitation_link": null,
					"created_at": "2024-06-21"
				}
			]
		},
		{
			"id": 12,
			"ulid": "01j0ty6c9pgrke5q9wkzgmfh1b",
			"status": {
				"id": 1,
				"code": "new",
				"label": "Novo"
			},
			"type": "sell_order",
			"public_token": null,
			"order_id": null,
			"order_code": null,
			"status_date": "2024-06-20",
			"obs": "Pedido de venda",
			"amount": "25.99",
			"created_at": "2024-06-20",
			"update_at": null,
			"payment_modality": {
				"id": 2,
				"name": "Ultilizar voucher pré-pago",
				"code": "PRE_PAID_VOUCHER",
				"status": true,
				"created_at": "2024-06-20",
				"updated_at": "2024-08-21"
			},
			"payment_method": null,
			"company": {
				"id": 1,
				"ulid": "01j0trm8a0g3c6hygz4m0axh0e",
				"status": true,
				"type": "J",
				"registration_number": "09461647000195",
				"alias": "Soluti - Solucoes Em Negocios Inteligentes S\/a",
				"name": "Soluti - Solucoes Em Negocios Inteligentes S\/a",
				"email": "teste@soluti.com.br",
				"phone": "(55)55555-5555",
				"whatsapp": "(55)55555-5555",
				"country_id": 1058,
				"state_id": 52,
				"city_id": 5208707,
				"address": "Rua teste",
				"number": "0",
				"complement": "..",
				"neighborhood": "Jardim Goiás",
				"postal_code": "74805100",
				"all_customers_has_birdid": null
			},
			"customer": {
				"id": 1,
				"ulid": "01j0trm9ya5j53bdj71gc1gt7p",
				"status": true,
				"registration_number": "02270606108",
				"name": "Nome do Representante",
				"email": "nome.representante@soluti.com.br",
				"phone": "(88)88888-8888",
				"whatsapp": "(88)88888-8888",
				"bird_id": {
					"is_valid": true,
					"verified_at": "2024-06-20 09:06:05"
				},
				"videoconference": {
					"verification": false,
					"link": null
				}
			},
			"details": [
				{
					"id": 13,
					"original_unit_value": "25.99",
					"additional_unit_value": "0.00",
					"final_unit_value": "25.99",
					"quantity": 1,
					"amount": "25.99",
					"product": {
						"id": 2,
						"certificate_type": "A1",
						"person_type": "PJ",
						"sku": 19776,
						"sisar_id": 310,
						"name": "Certificado PJ A1 - Spro Contadores",
						"validate": 1,
						"description": "ACS PJ A1 V5 G2 - SPRO CONTADORES",
						"min_price": "10.00",
						"max_price": "199.99",
						"status": true,
						"slug": "certificado-pj-a1-spro-contadores",
						"created_at": "2024-07-03",
						"updated_at": "2024-07-03"
					},
					"solicitation_sisar": null,
					"solicitation_link": null,
					"created_at": "2024-06-20"
				}
			]
		}
	],
	"links": {
		"first": "https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01j0trb4rwg94t9eekc7qpzpcc\/orders?page=1",
		"last": "https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01j0trb4rwg94t9eekc7qpzpcc\/orders?page=1",
		"prev": null,
		"next": null
	},
	"meta": {
		"current_page": 1,
		"from": 1,
		"last_page": 1,
		"links": [
			{
				"url": null,
				"label": "&laquo; Anterior",
				"active": false
			},
			{
				"url": "https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01j0trb4rwg94t9eekc7qpzpcc\/orders?page=1",
				"label": "1",
				"active": true
			},
			{
				"url": null,
				"label": "Próximo &raquo;",
				"active": false
			}
		],
		"path": "https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01j0trb4rwg94t9eekc7qpzpcc\/orders",
		"per_page": 10,
		"to": 7,
		"total": 7
	}
}
circle-info

Os dados retornam paginados

Last updated