v1

latestOpenAPI 3.1.02026-07-24290162.6 KB

Pesquisar etiqueta

get/api/v2/me/orders/search

Query parameters

qstring required

Informar o código de autorização, protocolo, código de rastreio, ID do envio ou documento.

Headers

Acceptstring required

Content-typestring 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/search:get:responses:200:content:application/json:schema:items:properties:contract","oasType":"schema","type":"unknown"}

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

quotenumber

pricenumber

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

discountnumber

delivery_mininteger

delivery_maxinteger

statusstring

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

insurance_valueinteger

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

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

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

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

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

formatstring

billed_weightnumber

receiptboolean

own_handboolean

collectboolean

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

reverseboolean

non_commercialboolean

authorization_codestring

trackingstring

self_trackingstring

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

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

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

paid_atstring

generated_atstring

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

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

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

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

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

created_atstring

updated_atstring

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

tagsobject[]

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

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

Example response

[
  {
    "id": "04c13ada-68e6-41df-a2c6-ff5f3e7560f8",
    "protocol": "ORD-20220395512",
    "service_id": 3,
    "quote": 25.35,
    "price": 25.35,
    "discount": 5.71,
    "delivery_min": 5,
    "delivery_max": 6,
    "status": "released",
    "insurance_value": 50,
    "format": "box",
    "billed_weight": 3.5,
    "authorization_code": "2022032921",
    "tracking": "ME220021P41BR",
    "self_tracking": "ME220021P41BR",
    "paid_at": "2022-03-29 21:17:26",
    "generated_at": "2022-03-29 21:38:30",
    "created_at": "2022-03-29 20:24:17",
    "updated_at": "2022-03-29 21:38:30",
    "details": {
      "gateway": "25.35",
      "discount": "0.00",
      "subtotal": "25.35",
      "total": "25.35"
    },
    "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": 3,
      "name": ".Package",
      "type": "normal",
      "range": "interstate",
      "company": {
        "id": 2,
        "name": "Jadlog",
        "picture": "/images/shipping-companies/jadlog.png"
      }
    },
    "agency": {
      "id": 24,
      "name": "CO SANTO ANDRE 01",
      "initials": "CO-QSE-01",
      "code": "1008367",
      "company_name": "ABC SPEEDY WAY TURISMO E TRANSPORTES LTDA"
    },
    "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
      }
    ],
    "volumes": [
      {
        "id": 99763,
        "height": "10.00",
        "width": "15.00",
        "length": "20.00",
        "diameter": "0.00",
        "weight": "3.50",
        "format": "box",
        "created_at": "2022-03-29 20:24:17",
        "updated_at": "2022-03-29 20:24:17"
      }
    ]
  }
]