v1

latestOpenAPI 3.1.02026-07-2622098.6 KB

Listar todas as entregas de determinada transportadora

get/api/v1/all_shipments_v5

Path parameters

pagestring required
per_pagestring required
Startdatestring date required
enddatestring date required
status[]string[] required
client_idstring required
internal_codestring required

Response

200

pageinteger
per_pageinteger
totalinteger

Example response

{
  "per_page": 10,
  "total": 2,
  "data": [
    {
      "shipment_id": "99999999999",
      "date_created": "2026-04-14 15:13:52",
      "client_id": 100001,
      "user_id": 100002,
      "system_id": 100003,
      "name": "EMPRESA_TESTE",
      "client_data_name": "JOAO TESTE - (EMPRESA_TESTE)",
      "fantasy_name": "JOAO TESTE - (EMPRESA_TESTE)",
      "client_settings": "{\"is_zpl\": false}",
      "receiver_address_receiver_name": "Maria da Silva",
      "status": "ENTREGUE",
      "internal_status": "NOVO",
      "date_shipped": "2026-04-15 12:49:30",
      "date_first_visit": "2026-04-15 15:35:50",
      "date_delivered": "2026-04-15 15:35:50",
      "account_name": "LOJA_TESTE",
      "account_id": 200001,
      "collection_address_line": "Rua Exemplo 123",
      "collection_address_city": "São Paulo",
      "collection_address_state": "SP",
      "collection_address_zip_code": "01000000",
      "collection_latitude": -23.55052,
      "collection_longitude": -46.633308,
      "settings": "{}",
      "id": 300001,
      "receiver_address_address_line": "Avenida Teste 456",
      "receiver_address_street_number": "456",
      "receiver_address_city": "São Paulo",
      "receiver_address_neighborhood": "Bairro Exemplo",
      "receiver_address_zip_code": "02000000",
      "receiver_address_receiver_phone": "11999999999",
      "receiver_address_latitude": "-23.560000",
      "receiver_address_longitude": "-46.640000",
      "receiver_address_comment": "Referência: Apartamento",
      "receiver_address_state": "SP",
      "receiver_address_zone": "LESTE_1",
      "downloaded": 1,
      "delivery_preference": "residential",
      "created_at": "2026-04-14 15:14:28",
      "updated_at": "2026-04-15 15:36:16",
      "sale_channel_id": 1,
      "external_shipment_id": "99999999999",
      "external_order_id": "2000000000000000",
      "external_seller_id": 999999999,
      "last_status": "ENTREGUE",
      "date_estimated_delivery": "2026-04-15 00:00:00",
      "obs_status": "FINALIZADA",
      "channel": "mercadolivre",
      "items": [
        {
          "external_item_id": "MLB0000000000",
          "description": "Produto Exemplo Para Documentação",
          "quantity": 1,
          "category": "MLB000000",
          "dimensions": "7.0x15.0x19.0,190.0"
        }
      ],
      "history": [
        {
          "id": 400001,
          "external_shipment_id": "99999999999",
          "key": "status_delivered",
          "value": "2026-04-15 16:52:10",
          "sale_channel_id": 1,
          "master_id": 999,
          "latitude": "-23.550000",
          "longitude": "-46.630000",
          "distance": "4.81",
          "url_comprovante": "https://example.com/comprovantes/comprovante_1.png",
          "driver_id": 500001,
          "romaneio_id": 600001,
          "doc_driver": "000.000.000-00",
          "name_driver": "JOAO MOTORISTA ( MANHA )",
          "receiver_name": "Maria da Silva",
          "receiver_doc": "123",
          "receiver_grau": "proprio",
          "created_at": "2026-04-15 16:52:11",
          "origin": "app",
          "geocode_location_app": "real-time",
          "car_type_driver": "Moto",
          "board_driver": "ABC1D23"
        }
      ]
    }
  ]
}