Get orders by period

Get Order by Period allows you to request orders data from the company reports by time frame

Authorization

Bearer token with finance scope.

Query params

Name

Value / Type

Desc.

businessId

string

company UUID

limit

uint64

Size of result [1..50] - max =50

offset

uint64

Results starts from offset item. (zero based index)

since

int32

Earlier scheduled time to return
ISO8601 format. Example: 2021-02-20T13:34:27Z

to

int32

Latest scheduled time to return. ISO8601 format. Example: 2021-03-20T13:34:27Z

Request

curl --request GET \
  --url 'https://business-api.gett.com/v1/reports?businessId=[companyuuid]&limit=[limit]&offset=[offset]&since=[since]&to=[to]'
curl --request GET \
curl --url 'https://business-api.gett.com/v1/reports?businessId=6eaaa6c-a8cf-22b500f506&limit=100&offset=0&since=2020-02-20T00:00:00Z&to=2020-03-20T13:34:27Z' \

Response

{
    "result_size": 50,
    "total_orders_in_period": 179,
    "totals": [
        {
            "sum_total_exc_tax": 1233.5,
            "sum_total_inc_tax": 1233.5,
            "orders_count": 53,
            "currency_code": "GBP"
        },
        {
            "sum_total_exc_tax": 4788.26,
            "sum_total_inc_tax": 5594.44,
            "orders_count": 126,
            "currency_code": "ILS"
        }
    ],
      [
      "orders":[...]
  ]
}

Response by "orders"

{
  "id": 5823647,
  "status": "completed",
  "business_id": "78da5445-067c-451d-a1a7-6a54e2e20cdb",
  "country": "GB",
  "category": "transportation",
  "product_name": "Black Cab",
  "tariff_area": "",
  "timezone": "Europe/London",
  "payment_summary": {
    "currency_code": "GBP",
    "total_exc_tax": 47.7,
    "total_inc_tax": 57.24,
    "total_tax": 8.67
  },
  "calculation": {
    "additional_fee": {
      "summary": {
        "amount": null,
        "amount_exc_tax": null,
        "amount_inc_tax": null,
        "tax": null
      }
    },
    "cancellation": {
      "details": {
        "cancelled_before_arrival_fee": 0,
        "cancelled_on_arrival_fee": 0
      },
      "summary": {
        "amount": null,
        "amount_exc_tax": null,
        "amount_inc_tax": null,
        "tax": null
      }
    },
    "commissions": {
      "details": {
        "line_items": [
          {
            "amount": 4.34,
            "amount_exc_tax": 4.34,
            "amount_inc_tax": 5.21,
            "fee": 10,
            "name": "Handling Fee",
            "type": "percentage_ride"
          }
        ]
      },
      "summary": {
        "amount": null,
        "amount_exc_tax": 4.34,
        "amount_inc_tax": 5.21,
        "tax": null
      }
    },
    "driving": {
      "summary": {
        "amount": 43.36,
        "amount_exc_tax": 43.36,
        "amount_inc_tax": 52.03,
        "tax": 8.67
      }
    },
    "extras": {
      "details": {
        "all_extras_info": null,
        "charged_extras_price": null
      },
      "summary": {
        "amount": null,
        "amount_exc_tax": null,
        "amount_inc_tax": null,
        "tax": null
      }
    },
    "stop_points": {
      "summary": {
        "amount": 0,
        "amount_exc_tax": 0,
        "amount_inc_tax": 0,
        "tax": 0
      }
    },
    "surge": {
      "details": {
        "rate": 0
      },
      "summary": {
        "amount": 0,
        "amount_exc_tax": 0,
        "amount_inc_tax": 0,
        "tax": null
      }
    },
    "tax": {
      "conditional_tax": {
        "amount": 0,
        "applied_rate": 0
      },
      "sales_tax": {
        "amount": 8.67,
        "applied_rate": 20
      }
    },
    "tips": {
      "details": {
        "rate": 0
      },
      "summary": {
        "amount": 0,
        "amount_exc_tax": 0,
        "amount_inc_tax": 0,
        "tax": null
      }
    },
    "tolls": {
      "details": {
        "items": null
      },
      "summary": {
        "amount": 0,
        "amount_exc_tax": 0,
        "amount_inc_tax": 0,
        "tax": 0
      }
    },
    "total_without_commissions": {
      "summary": {
        "amount": 43.36,
        "amount_exc_tax": 43.36,
        "amount_inc_tax": 52.03,
        "tax": null
      }
    },
    "waiting": {
      "summary": {
        "amount": 0,
        "amount_exc_tax": 0,
        "amount_inc_tax": 0,
        "tax": 0
      },
      "details": {
        "free_time_min": 2,
        "paid_time_min": 0
      }
    }
  },
  "stops": [
    {
      "location": {
        "latitude": "51.473648",
        "longitude": "-0.324434",
        "full_address": "West Middlesex Hospital, Finance Officer,  Twickenham Road, ISLEWORTH, Middlesex, ENGLAND, TW7 6AG",
        "postcode": "TW7 6AF"
      },
      "actions": [
        {
          "type": "pick_up",
          "user": {
            "name": "John Smith",
            "phone": "440000000000",
            "email": "[email protected]",
            "cost_center": "",
            "department": "",
            "employee_external_id": "",
            "employee_id": "4973d449-6d0b-4c61-9c24-87a960c9cf3d"
          }
        }
      ],
      "type": "origin",
      "notes": ""
    },
    {
      "location": {
        "latitude": "51.480495",
        "longitude": "-0.4454942",
        "full_address": "Renaissance London Heathrow Hotel, Bath Road,  Heathrow, HOUNSLOW, Middlesex, ENGLAND, TW6 2AQ",
        "postcode": "TW6 2AQ"
      },
      "actions": [
        {
          "type": "drop_off",
          "user": {
            "name": "John Smith",
            "phone": "440000000000",
            "email": "[email protected]",
            "cost_center": "",
            "department": "",
            "employee_external_id": "",
            "employee_id": "4973d449-6d0b-4c61-9c24-87a960c9cf3d"
          }
        }
      ],
      "type": "destination",
      "notes": ""
    }
  ],
  "references": [
    {
      "id": 6562,
      "title": "JobReference",
      "value": "123:345"
    }
  ],
  "distance": {
    "ride_distance_unit": "miles",
    "ride_distance": 7
  },
  "emissions": {
    "CO2_emissions": 0.3,
    "CO2_emissions_unit": "kg",
    "fuel_type": "hybrid electric"
  },
  "duration_minutes": 0,
  "note_to_driver": "message text",
  "payment_type": "account",
  "scheduled_at": "2021-09-01T18:10:00+0100",
  "requested_at": "2021-09-01T17:49:14+0100",
  "will_arrive_at_pickup": "2021-09-01T17:59:18+0100",
  "pickedup_at": "2021-09-01T18:11:44+0100",
  "droppedoff_at": "2021-09-01T18:35:38+0100",
  "created_by_customer_care": "",
  "platform": "api"
}

What’s Next
Did this page help you?