v1

latestOpenAPI 3.1.02026-07-2678221359.6 KB

Bifrost

Buscar pedidos realizados

Lista os pedidos realizados

get/bifrost/orders

Query parameters

yearinteger nullable

Ano

monthsinteger nullable

Mês

start_datestring nullable

Data de início

end_datestring nullable

Data de fim

start_valueinteger nullable

Valor inicial

end_valueinteger nullable

Valor final

statestring nullable

Estado

protocolstring nullable

Protocolo

license_platestring nullable

Placa

renavamstring nullable

Renavam

statusstring nullable

Status

status_instring nullable

Status em

payment_type_instring nullable

Tipo de pagamento em

pageinteger nullable

Página

sizeinteger nullable

Limite de itens por página

order_bystring nullable

Ordenar por Enum: "STATE" "PROTOCOL" "CREATED_AT" "LICENSE_PLATE"

Response

Relatório de pedidos

Example response

{
  "pagination": {
    "count": 0,
    "offset_page": 0,
    "total_pages": 0
  },
  "portal_orders": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "customer": {
        "id": 0,
        "license_plate": "AYX1F22",
        "renavam": "01234567910"
      },
      "establishment": {
        "created_at": "2019-08-24T14:15:22Z",
        "id": 0,
        "title": "Parceiro API",
        "updated_at": "2019-08-24T14:15:22Z"
      },
      "id": 0,
      "items": [
        {
          "amount": 0,
          "canceled": true,
          "category": "string",
          "created_at": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": 0,
          "settled": true,
          "status": "string",
          "title": "string",
          "type": "string",
          "unique_key": "string",
          "updated_at": "2019-08-24T14:15:22Z"
        }
      ],
      "order": {
        "base_amount": 1286.57,
        "created_at": "2019-08-24T14:15:22Z",
        "id": 0,
        "initial_amount": 1286.57,
        "protocol": "BWADPTAP",
        "state": "string",
        "status": "CHECKOUT_SUCCESS",
        "total_amount": 1286.57,
        "updated_at": "2019-08-24T14:15:22Z"
      },
      "payments": [
        {
          "amount": 0,
          "capture_date": "2019-08-24T14:15:22Z",
          "created_at": "2019-08-24T14:15:22Z",
          "id": 0,
          "installments": 1,
          "installments_amount": 1286.56,
          "status": "CAPTURED",
          "type": "PIX",
          "updated_at": "2019-08-24T14:15:22Z"
        }
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "vehicle": {
        "color": "Branca",
        "model": "FORD FIESTA 1.6L SE 16V FLEX 4P MANUAL",
        "owner": "Fulano de Tal",
        "year": "2014"
      }
    }
  ]
}