Guides
Guides

Introduction

Suggest Edits

Gett B2C API Documentation

Welcome to the Gett B2C API documentation. This API allows you to integrate Gett's transportation and delivery services into your applications, enabling you to create, manage, and track private orders for your customers.

What You Can Do

With the Gett B2C API, you can:

  • Create Private Orders: Book transportation and delivery services for your customers
  • Get Price Estimates: Retrieve aggregated pricing information with two pricing models:
    • Fixed Price: Guaranteed price locked at booking time
    • Meter Price: Estimated price, final cost determined by taxi meter
  • Manage Orders: Cancel existing orders when needed
  • Track Order Status: Monitor the progress of active orders

API Base URL

All API requests should be made to:

https://api.gett.com

Getting Started

To get started with the Gett B2C API, you'll need:

  1. Partner Credentials: A client_id and client_secret provided by Gett
  2. Partner ID: A unique identifier for your organization
  3. Product IDs: Identifiers for the specific services you want to offer

📘

Getting Credentials

Contact the Gett team to obtain your partner credentials and configure your integration.

Quick Start Guide

1. Authenticate

First, obtain a bearer token using your credentials:

curl --request POST 'https://api.gett.com/v1/oauth/token' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'client_id=YOUR_CLIENT_ID' \
  --data-urlencode 'client_secret=YOUR_CLIENT_SECRET' \
  --data-urlencode 'grant_type=client_credentials' \
  --data-urlencode 'scope=demand_partner'

2. Get Price Estimates

Before creating an order, get pricing information and service availability. The response includes an estimation_id that you'll use as quote_id:

curl --location 'https://api.gett.com/v1/private/preorder/aggregated?partner_id=YOUR_PARTNER_ID' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data '{
    "stops": [
      {
        "type": "origin",
        "location": {
          "lat": 51.473401, 
          "lng": -0.0221145
        }
      },
      {
        "type": "destination",
        "location": {
          "lat": 51.4712475, 
          "lng": 0.0357987
        }
      }
    ],
    "category": "transportation",
    "locale": "en",
    "payment_type": "cash"
  }'

The response includes pricing with price_concept field:

  • "fixed_price": Price is guaranteed when you book
  • "meter" or "meter_range": Estimated price (possibly with min/max range), actual cost determined by taxi meter

3. Create an Order

Once you have the pricing, create an order using the product_id and estimation_id (as quote_id):

curl --request POST 'https://api.gett.com/v1/private/orders/create' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data '{
    "partner_id": "YOUR_PARTNER_ID",
    "product_id": "YOUR_PRODUCT_ID",
    "quote_id": "YOUR_ESTIMATION_ID",
    "user_accepted_terms_and_privacy": true,
    "category": "transportation",
    "lc": "en",
    "stops": [...],
    "payment": {
      "payment_type": "cash"
    }
  }'

📘

Price Commitment

The quote_id (estimation_id from pricing response) is required for all orders. When price_concept is "fixed_price", this locks in the displayed price. For "meter" pricing, the final fare is determined by the taxi meter.

Integration Workflow

The typical flow for creating an order:

  1. Authenticate → Get bearer token
  2. Get Pricing → Call aggregated endpoint with route details
  3. Display Options → Show available services with pricing type:
    • Fixed Price services: Display exact guaranteed price
    • Meter services: Display estimated price with disclaimer
  4. User Selects → User chooses a service
  5. Create Order → Submit order with product_id and quote_id (the estimation_id from step 2)
  6. Track Order → Monitor order status and driver location

❗️

Always Get Fresh Pricing

Prices and availability change in real-time. Never cache pricing data for more than 2-3 minutes.

Documentation Structure

This documentation is organized into the following sections:

Support

For technical support or questions about your integration, please contact the Gett API support team.

❗️

Testing Required

Always test your integration thoroughly in a development environment before going live.

Updated 7 days ago