[Bahn] API de Tracking 2/2 – Nordware

Endpoint de Atualização de Status de Rastreamento

Método: PATCH

URL: https://api.bahn.nordware.io/Order/Status

URL de Stage: https://api.stage.bahn.nordware.io/Order/Status

Descrição:
Este endpoint permite a atualização de status de rastreamento. É possível enviar uma lista contendo até 100 entradas em uma única solicitação. Cada entrada na lista deve conter as informações necessárias para atualizar.

Cabeçalhos da Solicitação:

Cabeçalho	Valor
`Authorization`	`Bearer seu_bearer_token`
`Content-Type`	`application/json`

Parâmetros da Solicitação:

O corpo da solicitação deve conter uma lista de até 100 entradas, onde cada entrada tem os seguintes campos:

Parâmetro	Tipo	Descrição
`orderNumber`	String	Identificador único do pedido associado.
`trackingNumber`	String	N° do Tracking.
`trackingURL`	String	URL do Tracking.
`acessKey`	String	Chave da Nota.
`shippedAt`	DateTime	Data de envio.
`deliveredAt`	DateTime	Data de entrega.
`ecommerceName`	String	Nome do ecommerce.
`xml`	String	XML em base64.
`invoiceNumber`	String	Nº nota fiscal

Respostas:

Código 200 (OK): A solicitação foi bem-sucedida. O corpo da resposta pode conter informações adicionais.

    {
      [
        {
          "itemIndex": 0,
          "orderNumber": "1",
          "success": true,
          "errors": []
        },
        {
          "itemIndex": 1,
          "orderNumber": "2",
          "success": false,
          "errors": [
            {
              "orderIndex": 1,
              "orderNumber": "2",
              "error": "EcommerceName é obrigatório"
            }
          ]
        }
      ]
    }

Código 401 (Não Autorizado): O token de acesso é inválido ou expirou.

{
  "error": "invalid_token",
  "message": "Token de acesso inválido. Faça a autenticação novamente."
}

Código 400 (Solicitação Inválida): A solicitação contém dados inválidos ou está fora do formato esperado.

{
  "error": "invalid_request",
  "message": "A solicitação contém dados inválidos. Verifique a estrutura do corpo da solicitação."
}

Exemplo de Uso:

Atualização de Status de Rastreamento:

- Envie uma solicitação PATCH para https://api.bahn.nordware.io/Order/Status incluindo o token de acesso no cabeçalho de autorização.
- O corpo da solicitação deve conter uma lista de até 100 entradas, cada uma descrevendo um novo status de rastreamento para um evento específico.

Observações:

Certifique-se de seguir o formato especificado para o corpo da solicitação.
Este endpoint suporta a atualização de até 100 status de rastreamento em uma única solicitação. Caso necessite criar mais, divida as solicitações em lotes de 100.

Este artigo é a continuação do tema, clique aqui para acessar a parte 1.

Artigos relacionados