Ir para o conteúdo

Consultar histórico de entrega

Este endpoint permite que o vendedor (seller) recupere o historico de uma entrega utilizando o id como referência.

Escopo requerido

Valor Descrição
open:order-delivery:read Permite a leitura de entregas e dados relacionados.

Parâmetros da URL

Campo Tipo Descrição Obrigatório
id string ID da entrega na plataforma. Sim

Filtros

Campo Tipo Descrição Obrigatorio
created_at__ge String (datetime ISO 8601) Filtra pedidos a partir da data informada (ex.: "2023-06-27T12:15:37.729Z") Não
created_at__le String (datetime ISO 8601) Filtra pedidos até a data informada (ex.: "2023-06-27T12:15:37.729Z") Não

Paginação e Ordenação

Campo Tipo Descrição Obrigatório
_limit Inteiro Determina a quantidade de registros a serem retornados. Valor padrão 50. Não
_offset Inteiro Posição de registro de referência, a partir dele serão retornados os próximos N registros. Valor padrão 0. Não
_sort String Ordenação, sendo permitido os seguintes valores: Não
- created_at:asc
- created_at:desc (default)

Chamada:

curl -X 'GET' \
  'https://services.magalu.com/seller/v1/deliveries/{id}/histories' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \

Resposta:

{
  "meta": {
    "page": {
      "limit": 20,
      "offset": 150,
      "max_limit": 100
    },
    "links": {
      "previous": "?_offset=130&_limit=20",
      "next": "?_offset=170&_limit=20",
      "self": "?_offset=150&_limit=20"
    }
  },
  "results": [
    {
      "status": "new|approved|invoiced|shipped|delivered|cancelled|frozen",
      "description": "Informação curta sobre o status ou o motivo",
      "created_at": "2021-07-22T13:06:28.000Z",
      "extras": {
        "chave": "valor"
      }
    }
  ]
}

Códigos de retorno

Código Descrição
200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error