Integração do pedido de venda via API

    {
        //Obrigatório: Chave da aplicação
        accessKey: string
        //Obrigatório: Segredo da chave informada
        secret: string
        //Obrigatório: Nome do tenant em que se deseja efetuar o login
        tenantName: string
        //Opcional: Escopo do token da autenticação. Se não for informado será usado o valor padrão 'desktop'
        scope : string
    }

Detalhes dos parâmetros:

• accessKey: Chave de aplicação gerada no momento da criação da aplicação, disponível no caminho: Tecnologia > Administração > Gerenciamento de aplicações. A chave se encontra no campo Chave de acesso das propriedades da aplicação;
• secret: Chave única gerada no momento da criação da aplicação, disponível no caminho: Tecnologia > Administração > Gerenciamento de aplicações. A chave se encontra no campo Secret das propriedades da aplicação, e deve ser copiada logo após a sua criação.
• Tanto o secret como o accessKey são valores únicos responsáveis pela identificação da aplicação que está tentando conectar com o ERP;
• tenantName: Identificação do cliente que o parceiro representa e utiliza a base de dados.

• Cadastrar uma aplicação no Senior X: Para mais detalhes, consulte o tópico Utilizando a aplicaçãodo artigo Consumindo uma API, disponível no portal de APIs da Senior;
• Registrar a aplicação no portal de API: Para realizar o cadastro, siga o tutorial do artigo Criando uma Aplicação, disponível no portal de APIs da Senior;
• Associar a aplicação a um papel: Para conceder permissões de uso dos módulos do ERP senior X para integração, associe a aplicação a um papel em: Tecnologia > Administração > Autorização > Gestão de papéis.
• Ativar a replicação para o datacenter: Esse serviço é essencial para que a integração realize as consultas. Para isso, siga os passos abaixo:
Para que a propriedade Ativar replicação de entidades para a base centralizada esteja visível, o processo deve ser realizado pelo tenant administrador do ambiente.
1. Acesse Tecnologia > Configuração > Por tenant;
2. Na seção Domínios e serviços, encontre o domínio erpx;
3. Clique no botão Editar do serviço datacenter;
4. Nas propriedades do serviço datacenter, clique na guia Sistema;
5. Defina a propriedade Ativar replicação de entidades para a base centralizada como Verdadeiro.

• id (uuid?): Identificador único da entidade. Campo opcional.
• company (company): Informações sobre a empresa. Campo obrigatório.
• branch (branch): Dados da filial que está fazendo o pedido. Campo obrigatório.
• customer (customer): Dados do cliente que está fazendo a solicitação. Campo obrigatório.
• representative (representative?): Informações sobre o representante responsável pelo pedido. Campo opcional.
• paymentTerms (recDefaultData?): Condições de pagamento aplicáveis à transação. Campo opcional.
• paymentMethod (paymentMethod?): Forma de pagamento escolhida. Campo opcional.
• shippingCompany (recDefaultData?): Dados da transportadora responsável pela entrega. Campo opcional.
• redispatchCompany (recDefaultData?): Dados da transportadora de redespacho, caso aplicável. Campo opcional.
• deliveryAddress (recDefaultData?): Endereço de entrega dos produtos. Campo opcional.
• issueDate (date?): Data de emissão do pedido. Campo opcional.
• items (item): Lista de itens que compõem o pedido. Campo obrigatório.
• externalId (string?): Identificação externa do pedido, usada para integração com outros sistemas. Campo opcional.
• observation (string (999)?): Observações gerais sobre o pedido. Campo opcional, com limite de 999 caracteres.
• shippingCost (money?): Valor do frete. Valor mínimo: 0.00, máximo: 9999999999999.99. Campo opcional, com valor padrão de 0.
• discount (money?): Valor total de desconto aplicado ao pedido. Valor mínimo: 0.00, máximo: 9999999999999.99. Campo opcional, com valor padrão de 0.
• close (boolean?): Indica se o pedido deve ser fechado. Campo opcional, com valor padrão false.
• origin (externalIntegration?): Indicação da origem externa do pedido, para integração com sistemas externos. Campo opcional.
• expectedDeliveryDate (date?): Data prevista para a entrega do pedido. Campo opcional.
• freightType (enumCifFob?): Tipo de frete (CIF ou FOB). Campo opcional.
• customerOrderNumber (string (20)?): Número do pedido informado pelo cliente. Campo opcional, com limite de 20 caracteres.
• keepInstallments (boolean?): Indica se as parcelas devem ser mantidas no faturamento. Campo opcional, com valor padrão false.
• fiscalAddress (recDefaultData?): Endereço fiscal do cliente ou empresa. Campo opcional.
• productTransaction (recDefaultData?): Dados referentes à transação de produtos. Campo opcional.
• serviceTransaction (recDefaultData?): Dados referentes à transação de serviços. Campo opcional.

Veja no cURL abaixo o exemplo de chamada de API para criação de pedido de venda:

curl --location 'api.senior.com.br/erpx_com_ven/pedido/apis/order' \
--header 'client_id: acf0b99e-087d-4cf1-8783-fcadd69f6177' \
--header 'authorization: Bearer Knt5O79ZpfJVH90ivqfrc34Ci8SQKrBC' \
--header 'Content-Type: application/json' \
--data '{
    "externalId": "RFEFpXQmwdqDfbBiwzjA",
    "company": {
        "code": 1
    },
    "branch": {
        "code": 1
    },
    "customer": {
        "code": 752
    },
    "paymentTerms": {
        "code": "003"
    },
    "paymentMethod": {
        "code": 15
    },
    "items": [
        {
            "product": {
                "code": "01.01.001"
            },
            "price": 1,
            "quantity": 1
        }
    ],
    "close": true,
    "origin": "FORCA_DE_VENDA"
}'

Na plataforma Senior X, siga o caminho: Tecnologia > Customização > Events Hub > Webhooks. Nessa seção, você deverá criar dois registros que serão responsáveis por notificar seu sistema sempre que um evento ocorrer.

1. Criação de Webhooks:
   • Crie um registro para o evento erpx_com_ven/pedido/orderGenerationSuccess, que será acionado quando um pedido for gerado com sucesso;
   • Crie outro registro para o evento erpx_com_ven/pedido/orderGenerationError, que será acionado em caso de erro na geração do pedido.
2. Configuração:
   • Para cada evento, adicione a URL que deverá ser chamada quando o evento ocorrer;
   • Inclua as credenciais de autenticação, caso sejam necessárias;
   • Se desejar, é possível cadastrar múltiplas URLs para o mesmo evento;
   • Certifique-se de ativar o endpoint após a configuração.
3. Verificação de logs:
   • Em caso de falhas na integração, você pode verificar os logs. Acesse a seção "Ações" no endpoint cadastrado e clique em "Detalhes" para visualizar as informações.

Os endpoints cadastrados retornam os seguintes conteúdos:

Em caso de exceção

{
	"message": "conteúdo do erro",
	"externalOrderId": "externalId"
}

E em caso de sucesso

{
	"orderId": "id do pedido gerado (UUID)",
	"orderNumber": "Numero do pedido gerado",
	"orderStatus": "Status do pedido de venda",
	"externalOrderId": "externalId",
	"orderValue": "valor do pedido"
}