v1

latestOpenAPI 3.1.02026-07-24290162.6 KB

Listar informações de uma etiqueta

get/api/v2/me/orders/{id}

Path parameters

idstring required

Id da order correspondente à etiqueta de envio

Headers

Acceptstring required

Authorizationstring required

User-Agentstring required

É obrigatório que seja adicionado o cabeçalho HTTP User-Agent com o nome da sua aplicação junto a um email de contato/suporte.

Response

200

idstring

protocolstring

service_idinteger

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:agency_id","oasType":"schema","type":"unknown"}

contractstring

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:service_code","oasType":"schema","type":"unknown"}

quotenumber

pricenumber

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:coupon","oasType":"schema","type":"unknown"}

discountnumber

delivery_mininteger

delivery_maxinteger

statusstring

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:reminder","oasType":"schema","type":"unknown"}

insurance_valueinteger

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:weight","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:width","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:height","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:length","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:diameter","oasType":"schema","type":"unknown"}

formatstring

billed_weightnumber

receiptboolean

own_handboolean

collectboolean

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:collect_scheduled_at","oasType":"schema","type":"unknown"}

reverseboolean

non_commercialboolean

authorization_codestring

trackingstring

self_trackingstring

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:delivery_receipt","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:additional_info","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:cte_key","oasType":"schema","type":"unknown"}

paid_atstring

generated_atstring

posted_atstring

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:delivered_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:canceled_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:suspended_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:expired_at","oasType":"schema","type":"unknown"}

created_atstring

updated_atstring

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:parse_pi_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:agency","oasType":"schema","type":"unknown"}

tagsobject[]

{"stackTrail":"paths:/api/v2/me/orders/{id}:get:responses:200:content:application/json:schema:properties:generated_key","oasType":"schema","type":"unknown"}

Example response

{
  "id": "34105e98-bb32-4e85-8b0f-8bd2c888eb31",
  "protocol": "ORD-20220395517",
  "service_id": 1,
  "contract": "9912415671",
  "quote": 31.13,
  "price": 31.13,
  "discount": 4.15,
  "delivery_min": 8,
  "delivery_max": 9,
  "status": "posted",
  "insurance_value": 50,
  "format": "box",
  "billed_weight": 3.5,
  "authorization_code": "2022032920",
  "tracking": "ME220021P96BR",
  "self_tracking": "ME220021P96BR",
  "paid_at": "2022-03-29 20:43:37",
  "generated_at": "2022-03-29 20:43:50",
  "posted_at": "2022-03-29 21:00:06",
  "created_at": "2022-03-29 20:24:51",
  "updated_at": "2022-03-29 21:00:06",
  "from": {
    "name": "Teste ME",
    "phone": "5598105050",
    "email": "melhorenvio@teste.com",
    "document": "16571478358",
    "company_document": "04517623000197",
    "state_register": "563025255115",
    "postal_code": "7110000",
    "address": "Rua Teste",
    "location_number": "100",
    "complement": "CASA",
    "district": "Bairro Teste",
    "city": "Guarulhos",
    "state_abbr": "SP",
    "country_id": "BR",
    "note": "observação"
  },
  "to": {
    "name": "Melhor Envio Teste",
    "phone": "1999999999",
    "email": "melhorenvio@teste.com",
    "document": "73646548010",
    "company_document": "89794131000100",
    "state_register": "123456",
    "postal_code": "26210000",
    "address": "Avenida Marechal Floriano Peixoto",
    "location_number": "123",
    "complement": "Ap 2",
    "district": "Centro",
    "city": "Nova Iguacu",
    "state_abbr": "RJ",
    "country_id": "BR",
    "note": "observação"
  },
  "service": {
    "id": 1,
    "name": "PAC",
    "status": "available",
    "type": "normal",
    "range": "interstate",
    "restrictions": "{\"insurance_value\":{\"min\":0,\"max\":3000},\"formats\":{\"box\":{\"weight\":{\"min\":0.001,\"max\":30},\"width\":{\"min\":11,\"max\":105},\"height\":{\"min\":2,\"max\":105},\"length\":{\"min\":16,\"max\":105},\"sum\":200},\"roll\":{\"weight\":{\"min\":0.001,\"max\":30},\"diameter\":{\"min\":5,\"max\":91},\"length\":{\"min\":18,\"max\":105},\"sum\":200},\"letter\":{\"weight\":{\"min\":0.001,\"max\":0.5},\"width\":{\"min\":11,\"max\":60},\"length\":{\"min\":16,\"max\":60}}}}",
    "requirements": "[\"names\",\"addresses\"]",
    "optionals": "[\"AR\",\"MP\",\"VD\"]",
    "company": {
      "id": 1,
      "name": "Correios",
      "status": "available",
      "picture": "/images/shipping-companies/correios.png"
    }
  },
  "invoice": {
    "model": "55",
    "number": "9248",
    "serie": "1",
    "key": "31190307586261000184550010000092481404848162",
    "issued_at": "2019-03-01 00:00:00"
  },
  "products": [
    {
      "name": "Papel adesivo para etiquetas 1",
      "quantity": 3,
      "unitary_value": 100
    }
  ],
  "conciliation": {
    "status": "paid",
    "from_postal_code": "7110000",
    "from_city": "Guarulhos",
    "from_state_abbr": "SP",
    "to_postal_code": "26210000",
    "to_city": "Nova Iguacu",
    "to_state_abbr": "RJ",
    "authorization_code": "2022032920",
    "tracking": "ME220021P96BR",
    "quote": 38.13,
    "price": 38.13,
    "discount": 11.15,
    "value": 7,
    "type": "debit",
    "insurance_value": 50,
    "format": "box",
    "billed_weight": 3.5,
    "distinct_metrics": true,
    "paid_at": "2022-03-29 21:05:40",
    "created_at": "2022-03-29 21:00:08",
    "updated_at": "2022-03-29 21:05:40",
    "user": {
      "id": "779f4d62-c5b4-41e3-b0b0-ae2eb1509825",
      "protocol": 3477,
      "firstname": "Magno",
      "lastname": "Fonseca da Silva",
      "email": "magno.silva@melhorenvio.com",
      "document": "00773389016",
      "birthdate": "1983-10-14 00:00:00",
      "email_confirmed_at": "2021-06-22 12:17:00",
      "access_at": "2021-09-01 12:31:29",
      "created_at": "2021-06-22 12:17:00",
      "updated_at": "2021-06-22 12:17:38"
    },
    "group": {
      "id": "ded4290f-64fc-4de4-b5fa-e82cf9eba60d",
      "protocol": "CGP-2022038647",
      "total": 7,
      "type": "debit",
      "status": "paid",
      "paid_at": "2022-03-29 21:05:40",
      "created_at": "2022-03-29 21:05:40",
      "updated_at": "2022-03-29 21:05:40"
    }
  },
  "volumes": [
    {
      "id": 99768,
      "height": "10.00",
      "width": "15.00",
      "length": "20.00",
      "diameter": "0.00",
      "weight": "3.50",
      "format": "box",
      "created_at": "2022-03-29 20:24:51",
      "updated_at": "2022-03-29 20:24:51"
    }
  ]
}