Ir para o conteúdo

Webhook de Separação (WMS)

POST https://wms-de-exemplo/separacao

Através deste Webhook é possível realizar uma solicitação de separação sempre que um frete for contratado.

Envio:

Parâmetros do corpo da requisição:

Nome Descrição Formato / Exemplo Informado
id Identificador do frete contratado na Frete Rápido. Pode ser utilizado para rastrear o frete String de 13 caracteres *
order_number Número do pedido na loja String Eventual
parent_order_number Número do pedido pai na loja String Eventual
payment_type Forma de pagamento do pedido String Eventual
channel Canal de venda String Eventual
subchannel Subcanal de venda String Eventual
notes Observação(texto livre) do cliente sobre o pedido String Eventual
charge_type Tipo de cobrança String *
order_date Data de criação do pedido na loja Datetime (YYYY-MM-DD HH:mm:ss) Eventual
collection_date Data de possível coleta informada pelo Embarcador. Date Eventual
expected_delivery_date Data prevista de entrega calculado no ato da cotação, com base nos dias úteis para entrega. Sendo apenas uma referência, podendo ser diferente a depender das operações de cada transportadora. Date (YYYY-MM-DD) Eventual
order_value Valor total do pedido Numérico (float) Eventual
dispatcher Objeto com dados de endereço do expedidor da carga (se houver) Objeto em json Se houver expedidor
 registered_number CNPJ do expedidor da carga String de 14 caracteres sem formatação Se houver expedidor
 state_inscription Inscrição Estadual do expedidor da carga String Se houver expedidor
 name Razão Social do expedidor da carga String Se houver expedidor
 trade_name Nome Fantasia do expedidor da carga String Se houver expedidor
 address Endereço do expedidor Objeto em json Se houver expedidor
  street Logradouro do expedidor String Se houver expedidor
  number Número do local do expedidor String Se houver expedidor
  complement Complemento do endereço (se houver) String Eventual
  neighborhood Bairro do expedidor String Se houver expedidor
  city Cidade do expedidor String Se houver expedidor
  state Estado do expedidor (exemplo: MG) String Se houver expedidor
  zipcode CEP do expedidor / retirada da carga String Se houver expedidor
invoices Array de objetos com as informações da(s) NF-e(s) Array de objetos Eventual
 key Chave da NF String Se houver NF
 issue_date Data de emissão NF DateTime ("YYYY-MM-DD hh:mm:ss") Eventual
 number Número da NF String Se houver NF
 volumes_quantity Quantidade de Volumes da NF String Eventual
 serie Série da NF String Se houver NF
 total_value Valor da NF Numérico (float) Se houver NF
 items_value Valor dos itens da NF Numérico (float) Se houver NF
 cfop Código Fiscal de Operações e Prestações da NF Numérico (float) Eventual
 operation_type Tipo de operação da NF Numérico (float) Eventual
 issuance_type Tipo de emissão da NF Numérico (float) Eventual
 authorization_protocol Protocolo de autorização da NF Numérico (float) Eventual
content_declarations Array de objetos com os dados das declarações de conteúdo Array de objetos Eventual
 number Número identificador da declaração String Se houver DC
 description Descrição do item a ser transportado String Se houver DC
 total_value Valor total da declaração Numérico (float) Se houver DC
 items_value Valor total dos itens da declaração Numérico (float) Se houver DC
metadata Array com os metadados da cotação Array em json Eventual
 key Chave do metadado String Se houver metadados
 value Valor do metadado String Se houver metadados
recipient Objeto com alguns dados do destinatário Objeto em json *
 name Nome ou Razão Social do destinatário String de até 255 caracteres *
 registered_number Registro federal do destinatário (CNPJ ou CPF) String *
 state_inscription Registro estadual do destinatário (Inscrição Estadual) String Se o destinatário for pessoa jurídica
 email Endereço de e-mail do destinatário String Eventual
 phone Telefone do destinatário String Numérica sem formatação Eventual
volumes Dados dos volumes do ponto de expedição Array de Objetos *
 category Tipo do volume/Categoria do produto (vide tabela de tipos de volumes) String *
 sku SKU do volume/produto informado String Eventual
 description Descrição do produto/item String Eventual
 amount Quantidade do mesmo volume/item Inteiro *
 amount_volumes Quantidade de itens dentro do volume Inteiro *
 width Largura em Metros do volume/produto unitário Float (até 3 casas decimais — ex.: 0.001 m) *
 height Altura em Metros do volume/produto unitário Float (até 3 casas decimais — ex.: 0.001 m) *
 length Comprimento em Metros do volume/produto unitário Float (até 3 casas decimais — ex.: 0.001 m) *
 unitary_price Valor unitário do volume/item informado Float *
 unitary_weight Peso unitário (em Kg) do volume/item Float (até 3 casas decimais — ex.: 0.001 kg) *
 tag Tag do volume/produto informado String Eventual
 items Itens presentes neste volume (Caso estejam consolidados) Array de Objetos Eventual
  sku SKU do volume/produto informado String Eventual
  description Descrição do produto/item String Eventual
  amount Quantidade do mesmo volume/item Inteiro *
  width Largura em Metros do volume/produto unitário Float (até 3 casas decimais — ex.: 0.001 m) *
  height Altura em Metros do volume/produto unitário Float (até 3 casas decimais — ex.: 0.001 m) *
  length Comprimento em Metros do volume/produto unitário Float (até 3 casas decimais — ex.: 0.001 m) *
  unitary_price Valor unitário do volume/item informado Float *
  unitary_weight Peso unitário (em Kg) do volume/item Float (até 3 casas decimais — ex.: 0.001 kg) *
  tag Tag do volume/produto informado String Eventual
  consolidate Indica se o item foi consolidado Booleano *
  overlaid Indica se o item foi sobreposto Booleano Opcional
  rotate Indica se o volume foi rotacionado/tombado Booleano Opcional
carrier Informações sobre a transportadora do frete Objeto em json *
 registered_number CNPJ da transportadora String de 14 caracteres sem formatação *
 name Razão Social da transportadora String *
 trade_name Nome Fantasia da transportadora String Eventual
 service Serviço contratado String Eventual
 service_code Código de serviço Correios String Caso seja transportadora seja Correios
 alias Apelido externo da transportadora String Caso DE/PARA esteja configurado e ocorra match

* Informados sempre

Exemplo de envio: 

{
  "id": "FR260227C8OKW",
  "dispatcher": {
    "registered_number": "17184406000174",
    "state_inscription": "ISENTO",
    "name": "Frete Rapido Desenvolvimento de Tecnologia Logistica S/a",
    "trade_name": "Frete Rapido",
    "address": {
      "street": "Av. Dez de Abril",
      "number": "10",
      "complement": "",
      "neighborhood": "Centro",
      "city": "Baixo Guandu",
      "state": "ES",
      "zipcode": "29730000"
    }
  },
  "invoices": [
    {
      "number": "123",
      "serie": "123",
      "key": "00000000000000000000000000000000000000000000",
      "volumes_quantity": 1,
      "total_value": 15.5,
      "items_value": 15.5,
      "issue_date": "2024-11-08 08:40:00",
      "cfop": "0013",
      "operation_type": "0",
      "issuance_type": "0",
      "authorization_protocol": "135250414833"
    }
  ],
  "content_declarations": [
    {
      "number": "FR-99cdf0e1-a6a9-4027-b065-a196cd3031f8",
      "description": "declaração teste",
      "total_value": 100,
      "items_value": 100,
      "issue_date": "2025-03-17 10:00:00 +0000 UTC"
    }
  ],
  "metadata": [
    {
      "key": "origem",
      "value": "postman"
    }
  ],
  "order_number": "",
  "parent_order_number": "",
  "payment_type": "CIF",
  "channel": "a",
  "subchannel": "",
  "notes": "",
  "charge_type": "CIF",
  "order_date": "0001-01-01 00:00:00 +0000 UTC",
  "collection_date": "2025-03-03 00:00:00 +0000 UTC",
  "expected_delivery_date": "2025-03-05 00:00:00 +0000 UTC",
  "carrier": {
    "registered_number": "04884082000135",
    "name": "JADLOG LOGISTICA S.A",
    "trade_name": "JADLOG LOGISTICA S.A",
    "service": "Expresso",
    "service_code": "",
    "alias": ""
  },
  "order_value": 114.05,
  "recipient": {
    "name": "John Doe",
    "registered_number": "00000000000",
    "state_inscription": "ISENTO",
    "email": "[email protected]",
    "phone": "11555555555"
  },
  "volumes": [
    {
      "category": "75",
      "sku": "",
      "description": "Caixa teste",
      "amount": 1,
      "width": 0.05,
      "height": 0.5,
      "length": 0.05,
      "unitary_weight": 3.599,
      "unitary_price": 126,
      "amount_volumes": 3,
      "items": [
        {
          "category": "7",
          "sku": "Item teste 1",
          "amount": 2,
          "width": 0.01,
          "height": 0.01,
          "length": 0.01,
          "unitary_weight": 1.2,
          "unitary_price": 42,
          "consolidate": true,
          "overlaid": false,
          "rotate": false,
          "tag": "1"
        },
        {
          "category": "7",
          "sku": "Item teste 2",
          "amount": 1,
          "width": 0.01,
          "height": 0.01,
          "length": 0.01,
          "unitary_weight": 1.2,
          "unitary_price": 42,
          "consolidate": true,
          "overlaid": false,
          "rotate": false,
          "tag": "2"
        }
      ]
    },
    {
      "category": "7",
      "sku": "teste 3",
      "description": "",
      "amount": 1,
      "width": 0.1,
      "height": 0.1,
      "length": 0.1,
      "unitary_weight": 1.2,
      "unitary_price": 42,
      "amount_volumes": 1
    }
  ]
}

Resposta:

  • Se a requisição obtiver sucesso, deve ser retornado o código de resposta HTTP 200. Senão, pode ser retornado uma mensagem de erro para que possamos investigar.
Voltar ao topo