Criando Negociação e link Emissão Online

Criando a negocição e recebendo o link de integração com Emissão Online

POST /v1/organization/CLIENT_ID/orders

Este endpoint serve para você criar uma negociação dentro do SPro e ter como resultado o link de integração com o Emissão Online. Este link deverá ser passado para o seu cliente para ele criar a solicitação no Emissão Online de modo a você conseguir acompanhar o ciclo de vida dela.

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: /v1/organization/CLIENT_ID

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.

Body:

{
    "type": "sell_order",
    "payment_modality_id": 4,
    "company_id": 211,
    "customer_id": 244,
    "details": [
        {
            "product_id": 2
        }
    ]
}

Detalhes dos campos

Nome	Tipo	Obrigatório	Descrição
type	string	sim	passar sempre: sell_order
payment_modality_id	integer	sim	Id da modalidade de pagamento. Ver os ids das modalidades liberadas aqui
company_id	integer	sim	Id da empresa do seu cliente (retornado no momento do cadastro ou consulta)
customer_id	integer	sim	Id do representante legal do seu cliente (retornado no momento do cadastro ou consulta)
details			Estrutura para passar os detalhes
product_id	integer	sim	Id do produto. Ver os ids dos produtos liberadas aqui

Response:

200

{
	"order": {
		"id": 567,
		"ulid": "01jee3ha0mn8t5hxv3tvx5nhq7",
		"status": {
			"id": 1,
			"code": "new",
			"label": "Novo"
		},
		"type": "sell_order",
		"public_token": null,
		"order_id": null,
		"order_code": null,
		"status_date": "2024-12-06",
		"obs": null,
		"created_at": "2024-12-06",
		"update_at": null,
		"details": [
			{
				"id": 584,
				"original_unit_value": "0.00",
				"additional_unit_value": "0.00",
				"final_unit_value": "0.00",
				"quantity": 1,
				"amount": "0.00",
				"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": "https:\/\/emissao-online-hom.soluti.com.br\/arpartnerhom\/spro-contadores\/?d=MzM2MTUzNDg4Nzc%3D&i=MzEw&s=MTk3NzY%3D&v=KktkUjai5YsEZEX68TZy0w%3D%3D&data=Tfas8RxDtZuWq3g9%2ByoaTq1WiZijs1iK7FWDwc2smV%2BaVuJawB%2BmlqvuYKO76jm5I%2BolHcvA5mIfxBsNoOlPx5Wx2co43zEWYtUbg5xLWwd4C0pHEnzgrdR1l3y5BG58XzUuNsuJt%2FjdSJKDVeHaOME7MpxBH69wz738H6wq09MfhTWOU3DhvV4I5irf%2FZQIep%2BMJEnrrq9eswo00PiueOiCJgzz9P4tzaqsF9Bcq60F4FcBrHSwkj%2FThsrPq%2FBmLpYwzP%2BA8v0UNsyul2o11zOgchvXUJvL7Ew4xPcOWPL9Q03q10a3lsUdBu6ShoLYF9KYRIL4Lmwiho7daf8oTRR8MrB3GzLUjzaIuNYczLZU5EjtwZq7emYE%2FnXTUUhJNjWSO9IqgYS4LM28pT%2FH9nF2CdGIe%2BUPO34B9twQgZzVRSdVJ69yzFkbUUedxtheED3hIrJme4nRN2aj3tFpWAs376WTZVjMVRfxtxGRNdx%2BWVsQknYu9Cl8Ec9H0aP5nzsYYJKJCQVDnZISpp%2FR2QpqxxRloWS3TzNyiRRlKQVQuZEoznfi6AyrPSHnhpdOvUX4hvLBl2AQ%2FLlxNWyFStH9eHERukHRvrge%2BWU7OSpbSgSqhwG7%2FC2lMoGMclbyFdW2Xv1%2BGJ9p1yo0eJgimjMdDca2RktT%2B2STUQk9qDALq8qtWyGhyVk9EgKnq9AkhbRXS4VX3kQ6p7Mh0nwnnWVPIMCIb7e4of1YQnRcWtw%3D",
				"created_at": "2024-12-06"
			}
		]
	}
}

401

403

404

Campos importantes:

Grupo	Campo	Descrição
order		Estrutura de dados da Negociação
	ulid	Código da Negociação (você vai precisar deste número para consultar o status)
	status	Status da Negocição: - new: Quando a Negociação foi criada; - payment_confirmed: Quando é anexado um voucher a Negociação; - processing: Foi criada a Solicitação no SisAr mais ainda não foi aprovada; - approved_certificate: A Solicitação foi aprovada no SisAr e está pronta para ser emitida.
details		Detalhes da Negociação
product		Dados do produto
	solicitation_sisar	Número da Solicitação do SisAr. Esse campo fica vazio até que a solicitação é criada no SisAr. Ele também é parte do usuário de emissão, sendo ele: solicitation_sisar:CPF/CNPJ do cliente.
	solicitation_link	Link de integração com o Emissão Online. Este link é passado para o cliente para ele fazer a Emissão Online usando o BirdID dele (sem a necessidade de fazer video-conferência novamente).