Pré-requisitos
|
Objetivos |
A API Externa foi criada para você que possui uma plataforma de e-commerce própria e precisa integrar seus pedidos com o SAP B1; ou seja, você pode construir uma integração com a API de Pedidos do Bahn para envia-los; a partir daí o Bahn se encarrega de enviar as informações para o SAP, respeitando todos os demais parâmetros que você já tem configurado.
Vale lembrar que a API Externa seria apenas para Pedidos, não sendo possível controle de estoque, preço ou atualização de status.
🚨 Atenção
No decorrer deste artigo estaremos sempre utilizando a URL de Testes da API Externa; Ao contratar a funcionalidade, a equipe Nordware enviará a URL e Acessos da API de Produção.
🚩Importante!
A funcionalidade já está disponível para o plano Enterprise, porém pode ser adquirida de forma avulsa nos demais planos; caso seja de seu interesse entre em contato com a gente! 🤩
|
Realizando o login |
Para o acesso ao endpoint de pedidos é necessário realizar o login, através de usuário e senha, o qual irá gerar um token.
https://api.stage.bahn.nordware.io/v1/login
{
"userName": "string",
"password": "string"
}
Atenção!
O token gerado irá expirar após 3 horas, devendo realizar um novo login.
|
Endpoint de Pedidos |
Através do endpoint de pedidos você poderá realizar a consulta e a inserção de pedidos.
Atenção!
A API possui um limite de 60 requisições por minuto.
👉 Consultando Pedidos
https://api.stage.bahn.nordware.io/v1/order
Os seguintes parâmetros devem ser utilizados:
Campo | Tipo | Observação |
---|---|---|
EcommerceName | String | Nome do E-commerce no Bahn (Case Sensitive) |
OrderNumber | String | Número do pedido em sua plataforma |
A autenticação deve ser via Bearer Token, utilizando o Token obtido no através do Login. Acesse a documentação da API para obter mais informações e exemplo do response.
👉 Adicionando Pedidos
https://api.stage.bahn.nordware.io/v1/order
Para adicionar um pedido fique atento aos campos que são de preenchimento obrigatório. Acesse a documentação da API para mais informações e exemplo de request.
Campos adicionais - No pedido
Através do objeto orderAdditionalFields
você poderá enviar dados para campos de usuário no SAP Busines One, que estejam na tabela de Pedido de Venda (ORDR)
[
{
...,
"orderAdditionalFields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
...
}
]
Para o additionalProp
preencha sempre o nome do campo de usuário no SAP e o value será a informação que deve ser inserida no referido campo, conforme exemplo abaixo
[
{
...,
"orderAdditionalFields": {
"U_NORD_Extra01": "Exemplo 01",
"U_NORD_Extra02": "Exemplo 02",
"U_NORD_Extra03": "Exemplo 03"
},
...
}
]
Campos adicionais - No parceiro de negócios
Através do objeto CustomerAdditionalFields
você poderá enviar dados para campos de usuário no SAP Busines One, que estejam na tabela do Parceiro de Negócios (OCRD);
[
{
...,
"CustomerAdditionalFields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
...
}
]
O preenchimento é o mesmo conforme explicado para o pedido de venda; informando na propriedade o campo de usuário e no valor a informação que deve ser inserida.
👉 Campos da API
Atente para os campos com asterisco ( * ) são os de envio obrigatório
[
{
"id": 0,
"ecommerceName"*: "string",
"channel": "string",
"number"*: "string",
"orderEcommerceID": 0,
"purchaseDate": "2023-04-06T16:51:57.016Z",
"importedDate": "2023-04-06T16:51:57.016Z",
"sellerName": "string",
"brandName": "string",
"warehouseCode"*: "string",
"observation": "string",
"status": "string",
"additionalFields": "string",
"orderAdditionalFields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"customerAdditionalFields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"ecommerceOrder": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
},
"shipping"*: {
"id": 0,
"method"*: "string",
"price"*: 0,
"quotedPrice": 0,
"dueDate": "2023-04-06T16:51:57.016Z",
"address"*: {
"id": 0,
"ibgeCode": "string",
"name"*: "string",
"street"*: "string",
"number"*: "string",
"complement": "string",
"district"* : "string",
"city"*: "string",
"country"*: "string",
"uf"*: "string",
"zipCode"*: "string",
"phone": "string",
"mobile": "string",
"taxIdentification"*: "string",
"addressType": "string"
}
},
"payment"*: {
"id": 0,
"method"*: "string",
"total"*: 0,
"discount": 0,
"additional": 0,
"installments"*: 0,
"dueDate"*: "2023-04-06T16:51:57.016Z",
"currency": "string",
"transactionCode": "string",
"address"*: {
"id": 0,
"ibgeCode": "string",
"name"*: "string",
"street"*: "string",
"number"*: "string",
"complement": "string",
"district"*: "string",
"city"*: "string",
"country"*: "string",
"uf"*: "string",
"zipCode"*: "string",
"phone": "string",
"mobile": "string",
"taxIdentification"*: "string",
"addressType": "string"
},
"tid": "string",
"creditCardBrand": "string",
"nsu": "string",
"couponCode": "string",
"couponDescription": "string",
"giftVoucher": "string",
"subTotal": 0
},
"customer"*: {
"id": 0,
"name"*: "string",
"email"*: "string",
"taxIdentification"*: "string",
"phoneNumber": "string",
"reseller": {
"id": 0,
"stateRegistry": "string",
"corporateName": "string"
},
"additionalFields": "string"
},
"products"*: [
{
"id": 0,
"discount": 0,
"price"*: 0,
"quantity"*: 0,
"sku"*: "string",
"name"*: "string"
}
],
"customerFields": [
{
"id": 0,
"name": "string",
"value": "string"
}
],
"tenantId": 0,
"tenant": {
"id": 0,
"name": "string"
}
}
]
|