Atualização de Dados de Pedidos

Este endpoint é chamado automaticamente quando ocorrem mudanças no status de um pedido. A API deve responder com um código HTTP 2XX (200, 201, etc.) em no máximo 10 segundos. Códigos de redirecionamento (3XX) não serão seguidos e serão considerados como falha.

TOKEN_NAME e o TOKEN_VALUE são parâmetros para garantir a segurança das informações, podem ser definidos quais são os valores utilizados. Após, esses dados devem ser encaminhados para a configuração pela Frenet para sempre serem enviados estes campos com os valor definidos nas chamadas de webhook.

Também vale ressaltar que esses dois parâmetros são opcionais, é apenas um fator de segurança a mais e que os webhooks funcionam mesmo sem enviar estes dados.

Exemplo de utilização:

TOKEN_NAME = FRENET_INTEGRATIONTOKEN_VALUE = 99A29DC8105FD2FA39D8CDC04733938D

Especificações Técnicas

Método HTTPPOSTHeaders
Content-Type: application/json [TOKEN_NAME]: [TOKEN_VALUE] (Substitua [TOKEN_NAME] e [TOKEN_VALUE] pelas credenciais de autenticação).

Body (Exemplo)

{
  
    "OrderId": "PLAT-ORDER-ID",
    "ShipmentId": 21255,
    "ShipmentStatus": 5,
    "Volume": {
        "VolumeId": 1213,
        "CarrierHeight": 15,
        "CarrierWidth": 10,
        "CarrierLength": 12,
        "CarrierWeight": 0.400,
        "CarrierPrice": 25.59
    },
    "Balance": 50.50
}

Detalhes dos campos

OrderID
Descrição: Identificador único do pedido da plataforma. Tipo: String.

ShipmentId
Descrição: Identificador único do envio. Tipo: Número inteiro.

ShipmentStatus
Descrição: Código do status atual do pedido. Veja a lista de status abaixo. Tipo: Número inteiro.

Volume
Descrição: Detalhes do volume enviado. Campos: CarrierHeight: Altura do pacote (em cm). CarrierWidth: Largura do pacote (em cm). CarrierLength: Comprimento do pacote (em cm). CarrierWeight: Peso do pacote (em kg). CarrierPrice: Custo do frete (em R$).

Balance
Descrição: Saldo atual na carteira do usuário. Tipo: Número decimal.

Status de Pedidos (ShipmentStatus)