v1

latestOpenAPI 3.1.02026-07-2622098.6 KB

Consultar pedido pelo código

get/api/v1/shipmentsV2/{id}

Path parameters

IDinteger required

Response

200

shipment_idstring

date_createdstring

namestring

fantasy_namestring

internal_statusstring

statusstring

substatusstring

date_handlingstring

date_shippedstring

date_first_visitstring

date_deliveredstring

{"stackTrail":"paths:/api/v1/shipmentsV2/{id}:get:responses:200:content:application/json:schema:properties:external_label_id","oasType":"schema","type":"unknown"}

external_shipment_idstring

external_order_idstring

receiver_address_address_linestring

receiver_address_citystring

receiver_address_neighborhoodstring

receiver_address_zip_codestring

receiver_address_zonestring

receiver_address_receiver_namestring

receiver_address_latitudestring

receiver_address_longitudestring

base_coststring

external_seller_idinteger

receiver_address_receiver_phonestring

{"stackTrail":"paths:/api/v1/shipmentsV2/{id}:get:responses:200:content:application/json:schema:properties:integration_name","oasType":"schema","type":"unknown"}

export_typestring

delivery_preferencestring

created_atstring

updated_atstring

{"stackTrail":"paths:/api/v1/shipmentsV2/{id}:get:responses:200:content:application/json:schema:properties:date_cancelled","oasType":"schema","type":"unknown"}

client_data_idinteger

client_namestring

account_idinteger

account_namestring

collection_address_linestring

{"stackTrail":"paths:/api/v1/shipmentsV2/{id}:get:responses:200:content:application/json:schema:properties:collection_address_neighborhood","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipmentsV2/{id}:get:responses:200:content:application/json:schema:properties:collection_address_number","oasType":"schema","type":"unknown"}

collection_address_citystring

collection_address_statestring

collection_address_zip_codestring

{"stackTrail":"paths:/api/v1/shipmentsV2/{id}:get:responses:200:content:application/json:schema:properties:collection_phones","oasType":"schema","type":"unknown"}

collection_latitudenumber

collection_longitudenumber

{"stackTrail":"paths:/api/v1/shipmentsV2/{id}:get:responses:200:content:application/json:schema:properties:size_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipmentsV2/{id}:get:responses:200:content:application/json:schema:properties:size_color","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipmentsV2/{id}:get:responses:200:content:application/json:schema:properties:size_abbreviation","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipmentsV2/{id}:get:responses:200:content:application/json:schema:properties:size_weight","oasType":"schema","type":"unknown"}

label_urlstring

original_statusstring

{"stackTrail":"paths:/api/v1/shipmentsV2/{id}:get:responses:200:content:application/json:schema:properties:original_substatus","oasType":"schema","type":"unknown"}

Example response

{
  "shipment_id": "98765432101",
  "date_created": "2026-04-14 14:14:28",
  "name": "Loja Teste",
  "fantasy_name": "EMPRESA TESTE COMERCIO LTDA",
  "internal_status": "new",
  "status": "ENTREGUE",
  "date_handling": "2026-04-14 14:14:33",
  "date_shipped": "2026-04-15 15:58:19",
  "date_first_visit": "2026-04-15 17:49:36",
  "date_delivered": "2026-04-15 17:49:36",
  "external_shipment_id": "98765432101",
  "external_order_id": "3000012345678901",
  "receiver_address_address_line": "Rua Exemplo 123",
  "receiver_address_city": "São Paulo",
  "receiver_address_neighborhood": "Bairro Teste",
  "receiver_address_zip_code": "01010000",
  "receiver_address_zone": "NORTE_3",
  "receiver_address_receiver_name": "João da Silva",
  "receiver_address_latitude": "-23.500000",
  "receiver_address_longitude": "-46.600000",
  "base_cost": "11.0000",
  "external_seller_id": 1234567890,
  "receiver_address_receiver_phone": "XXXXXXXXXXX",
  "export_type": "manual",
  "delivery_preference": "business",
  "created_at": "2026-04-14 14:14:49",
  "updated_at": "2026-04-15 17:49:51",
  "client_data_id": 99999,
  "client_name": "Loja Teste",
  "account_id": 88888,
  "account_name": "MARKETPLACE TESTE",
  "collection_address_line": "Avenida Modelo 500",
  "collection_address_city": "São Paulo",
  "collection_address_state": "SP",
  "collection_address_zip_code": "02020000",
  "collection_latitude": -23.55,
  "collection_longitude": -46.65,
  "label_url": "https://etiquetas.exemplo.com.br/98765432101.pdf",
  "original_status": "delivered",
  "items": [
    {
      "external_item_id": "MLB9999999999",
      "description": "Produto Exemplo Para Documentação",
      "quantity": 1,
      "category": "MLB0000",
      "dimensions": "6.0x19.0x20.0,90.0"
    }
  ],
  "history": [
    {
      "id": 300000001,
      "external_shipment_id": "98765432101",
      "key": "status_delivered",
      "value": "2026-04-15 17:49:58",
      "sale_channel_id": 1,
      "master_id": 999,
      "latitude": "-23.500001",
      "longitude": "-46.600001",
      "distance": "0.00",
      "url_comprovante": "https://etiquetas.exemplo.com.br/comprovantes/99999999_1234567890_1.png",
      "driver_id": 500001,
      "romaneio_id": 70000001,
      "doc_driver": "111.222.333-44",
      "name_driver": "MOTORISTA TESTE - (TARDE)",
      "receiver_name": "João da Silva",
      "receiver_doc": "12345678900",
      "receiver_grau": "proprio",
      "created_at": "2026-04-15 17:50:00",
      "origin": "app",
      "geocode_location_app": "real-time",
      "car_type_driver": "Moto",
      "board_driver": "ABC1D23"
    }
  ]
}