Get Order Receipt
GEThttps://api.uber.com/v1/business/orders/{order_id}/receipt¶ Use
The Business Receipt endpoint gives up-to-date data on order details after its completion.
¶ Authorization
OAuth 2.0 bearer token with the business.receipts scope.
¶ Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
order_id |
string |
Yes | Unique identifier representing a order. |
¶ Header Parameters
| Name | Type | Required | Description |
|---|---|---|---|
x-uber-organizationuuid |
string |
Yes | Unique identifier of organization which requested the order |
¶ Example Request
curl -H 'Authorization: Bearer <TOKEN>' \
-H 'Accept-Language: en_US' \
-H 'Content-Type: application/json' \
-H 'x-uber-organizationuuid: <ORGANIZATION_UUID>'
'https://api.uber.com/v1/business/orders/<ORDER_ID>/receipt'
¶ Rides Order Response
Status-Code: 200 OK
{
"entities":
[
{
"entity_id": "ORG_ID",
"entity_type": "ORGANIZATION",
"roles":
[
"CONSUMER"
],
"organization":
{
"organization_name": "ORG_NAME"
}
},
{
"entity_id": "USER_ID",
"entity_type": "USER",
"roles":
[
"REQUESTER",
"CONSUMER",
"PAYER"
],
"user":
{
"first_name": "USER_FIRST_NAME",
"last_name": "USER_LAST_NAME",
"email": "USER_EMAIL",
"organization_id": "ORG_ID",
"employee_id": "EMP_ID",
"program_id": "PRG_ID"
}
}
],
"programs":
[
{
"program_id": "PRG_ID",
"program_name": "General travel",
"owner_entity_id": "ORG_ID",
"program_type": "RIDES"
}
],
"order_id": "00000000-0000-0000-0000-000000000000",
"order_type": "RIDES",
"status": "COMPLETED",
"order_request_time": {
"timestamp_utc": "2024-05-12T03:40:00.000Z",
"timestamp_local": "2024-05-12T11:40:00.000+08:00"
},
"timezone": "Australia/Perth",
"product_name": "UberX",
"transport_detail":
{
"usage_type": "INDIVIDUAL",
"bill_split_type": "SINGLE_PAYER",
"duration": "00:29:03",
"pickup_time": {
"timestamp_utc": "2024-05-12T03:36:27.000Z",
"timestamp_local": "2024-05-12T11:36:27.000+08:00"
},
"pickup_location":
{
"address": "22 Kincardine Crescent, Floreat, WA 6014, AU",
"point": {
"latitude": -31.93072,
"longitude": 115.79128
},
"city": "Floreat",
"state": "STATE",
"country": "Australia"
},
"dropoff_time": {
"timestamp_utc": "2024-05-12T04:05:30.000Z",
"timestamp_local": "2024-05-12T12:05:30.000+08:00"
},
"dropoff_location":
{
"address": "Perth Airport (PER), Perth, WA 6065, AU",
"point": {
"latitude": -31.93372,
"longitude": 115.95996
},
"city": "Floreat",
"state": "STATE",
"country": "Australia"
},
"distance":
{
"value": 12.34,
"unit": "MILES"
}
},
"payment_detail":
{
"transactions":
[
{
"transaction_id": "TXN_ID",
"transaction_type": "FARE",
"time": {
"timestamp_utc": "2024-05-12T04:05:48.733Z",
"timestamp_local": "2024-05-12T12:05:48.733+08:00"
},
"local_currency_amount":
{
"value": 3723000,
"currency_code": "AUD"
},
"home_currency_amount":
{
"value": 2337000,
"currency_code": "USD"
},
"network_transaction_id": "NTID",
"entity_id": "USER_ID",
"taxes": [
{
"amount": {
"currency_code": "USD",
"amount": 7000
},
"name": "transport.fare.charges.sf_city_tax",
"rate": "0.0325"
},
{
"amount": {
"currency_code": "USD",
"amount": 39000
},
"name": "transport.fare.charges.sf_city_tax",
"rate": "0.0325"
}
]
}
],
"fares":
[
{
"name":"Booking Fee",
"fare_type": "FARE",
"amount":
{
"value": 3385000,
"currency_code": "AUD"
}
},
{
"name":"Georgia for-hire ground transport excise tax",
"fare_type": "TAX",
"amount":
{
"value": 338000,
"currency_code": "AUD"
}
},
{
"name": "Promotion",
"amount": {
"currency_code": "USD",
"value": -489000
},
"fare_type": "DEDUCTION"
}
],
"charges":
[
{
"charge_entity_type": "UBER",
"entity_charges":
[
{
"charge_type": "FARE",
"amount":
{
"value": 980000,
"currency_code": "USD"
}
},
{
"charge_type": "TAX",
"amount":
{
"value": 0,
"currency_code": "USD"
}
}
],
"name": "Uber",
"tax_id": "TAX_ID",
"location": {
"address":"Somewhere in UK",
"country":"UK"
},
"documents":
[
{
"url": "INVOICE_PDF_URL",
"id": "INVOICE_ID",
"created_time": {
"timestamp_utc": "2024-02-23T20:45:21.239Z",
"timestamp_local": "2024-02-24T04:45:21.239+08:00"
},
"document_type": "INVOICE"
}
]
},
{
"charge_entity_type": "DRIVER",
"entity_charges":
[
{
"charge_type": "FARE",
"amount":
{
"value": 980000,
"currency_code": "USD"
}
},
{
"charge_type": "TAX",
"amount":
{
"value": 0,
"currency_code": "USD"
}
}
],
"name": "DRIVER_NAME",
"address": "Somewhere in UK",
"tax_id": "VAT Reg No: 12345",
"documents":
[
{
"url": "INVOICE_PDF_URL",
"id": "INVOICE_ID",
"created_time": {
"timestamp_utc": "2024-02-23T20:45:21.239Z",
"timestamp_local": "2024-02-24T04:45:21.239+08:00"
},
"document_type": "INVOICE"
}
]
}
],
"order_amount":
{
"value": 3723000,
"currency_code": "AUD"
}
}
}
¶ Eats Order Response
Status-Code: 200 OK
{
"entities":
[
{
"entity_id": "ORG_ID",
"entity_type": "ORGANIZATION",
"roles":
[
"CONSUMER"
],
"organization":
{
"organization_name": "ORG_NAME"
}
},
{
"entity_id": "USER_ID",
"entity_type": "USER",
"roles":
[
"REQUESTER",
"CONSUMER",
"PAYER"
],
"user":
{
"first_name": "USER_FIRST_NAME",
"last_name": "USER_LAST_NAME",
"email": "USER_EMAIL",
"organization_id": "ORG_ID",
"employee_id": "EMP_ID",
"program_id": "ProgramID"
}
}
],
"programs":
[
{
"program_id": "ProgramID",
"program_name": "Employee Eats",
"owner_entity_id": "ORG_ID",
"program_type": "EATS"
}
],
"vouchers": [
{
"voucher_id":"VOUCHER_ID",
"campaign_id":"CAMPAIGN_ID",
"campaign_name":"campaign_name",
"owner_entity_id":"ORG_ID"
}
],
"order_id": "c6a86b00-cc79-45e2-b037-3335495deb90",
"order_type": "EATS",
"status": "COMPLETED",
"order_request_time": {
"timestamp_utc": "2024-05-08T16:23:42.000Z",
"timestamp_local": "2024-05-08T12:23:42.000-04:00"
},
"timezone": "America/New_York",
"product_name": "EATS",
"payment_detail":
{
"transactions":
[
{
"transaction_id": "TXN_ID",
"fare_type": "FARE",
"time": {
"timestamp_utc": "2024-05-08T18:07:36.523Z",
"timestamp_local": "2024-05-08T14:07:36.523-04:00"
},
"local_currency_amount":
{
"value": 13852000,
"currency_code": "USD"
},
"network_transaction_id": "NTID",
"entity_id": "USER_ID"
}
],
"fares":
[
{
"name":"Meal Fare",
"fare_type": "FARE",
"amount":
{
"value": 12593000,
"currency_code": "USD"
}
},
{
"name":"tax",
"fare_type": "TAX",
"amount":
{
"value": 768000,
"currency_code": "USD"
}
}
],
"charges":
[
{
"charge_entity_type": "UBER",
"entity_charges":
[
{
"charge_type": "FARE",
"amount":
{
"value": 4963000,
"currency_code": "USD"
}
},
{
"charge_type": "TAX",
"amount":
{
"value": 0,
"currency_code": "USD"
}
},
{
"charge_type": "OTHERS",
"amount":
{
"value": 756000,
"currency_code": "USD"
}
}
],
"name": "Uber",
"address": "Somewhere in UK",
"tax_id": "TAX_ID",
"documents":
[
{
"url": "INVOICE_PDF_URL",
"id": "INVOICE_ID",
"created_time": {
"timestamp_utc": "2024-02-23T20:45:21.239Z",
"timestamp_local": "2024-02-23T15:45:21.239000-05:00"
},
"document_type": "INVOICE"
}
]
},
{
"charge_entity_type": "RESTAURANT",
"entity_charges":
[
{
"charge_type": "FARE",
"amount":
{
"value": 980000,
"currency_code": "USD"
}
},
{
"charge_type": "TAX",
"amount":
{
"value": 0,
"currency_code": "USD"
}
}
],
"name": "RESTAURANT_NAME",
"address": "22 Kincardine Crescent, Floreat, WA 6014, AU",
"tax_id": "TAX_ID"
}
],
"order_amount":
{
"value": 13852000,
"currency_code": "USD"
}
},
"eats_detail":
{
"usage_type": "INDIVIDUAL",
"bill_split_type": "SINGLE_PAYER",
"fulfillment_type":"DELIVERY",
"delivered_at":"2024-09-12T23:58:23.000Z",
"delivery_time": {
"timestamp_utc": "2024-09-12T23:58:23.000Z",
"timestamp_local": "2024-09-12T19:58:23.000000-0400"
},
"cart_items":
[
{
"entity_id": "USER_ID",
"name": "JUNIOR’S BURGER (BEEF)",
"amount":
{
"value": 1250000,
"currency_code": "USD"
},
"quantity": 1
},
{
"entity_id": "USER_ID",
"name": "French Fries",
"amount":
{
"value": 499000,
"currency_code": "USD"
},
"quantity": 1
},
{
"entity_id": "USER_ID",
"name": "BURRITO BURGER (CHICKEN)",
"quantity": 1,
"amount":
{
"value": 1499000,
"currency_code": "USD"
}
},
{
"entity_id": "USER_ID",
"name": "EXPLOSION BURGER (VEGGIE)",
"quantity": 1,
"amount":
{
"value": 1899000,
"currency_code": "USD"
}
},
{
"entity_id": "USER_ID",
"name": "AMERICAN BURGER (BEEF)",
"quantity": 1,
"amount":
{
"value": 1250000,
"currency_code": "USD"
}
}
],
"delivery_location":
{
"address": "Orlando, FL 32837-8409, US",
"point":{
"longitude": -81.39123,
"latitude": 28.123123
}
}
"stores":
[
{
"name": "STORE_NAME",
"store_id": "STORE_ID",
"location":
{
"address": "Circle",
"city": "Orlando",
"country": "US"
}
}
]
}
}
¶ Response Body Parameters
| Name | Type | Description |
|---|---|---|
order_id |
string |
The unique UUID of the order. |
order_request_time |
object |
The Order Request Time. |
order_request_time.timestamp_utc |
string |
The Order Request timestamp in UTC . |
order_request_time.timestamp_local |
string |
The Order Request timestamp in local timezone. |
order_type |
string |
The Type of Order (RIDES/EATS). |
timezone |
string |
The order timezone based on pickup/delivery location. |
status |
string |
The Order Status (COMPLETED/CANCELED). |
product_name |
string |
Name of the product for the order (eg: UberX, Uber Comfort etc). |
entities |
array |
Entities involved in the order. |
entities.entity_id |
string |
The unique UUID for the entity. |
entities.entity_type |
string |
The type of the entity. |
entities.roles |
array |
Role of the entity in the order. (REQUESTER/CONSUMER/PAYER) |
entities.user |
object |
Details for User Entity. |
entities.user.first_name |
string |
First name of the user. |
entities.user.last_name |
string |
Last name of the user. |
entities.user.employee_id |
string |
EmployeeId of the user provided by the org. |
entities.user.email |
string |
Email of the user linked to the organization. |
entities.user.phone |
string |
Phone of the user linked to the organization. |
entities.user.organization_id |
string |
Id of the organization that the user is associated with. |
entities.user.program_id |
string |
ProgramId of the order |
entities.organization |
object |
Details for organization entity associated with the order. |
entities.organization.name |
string |
Name of the organization |
transport_detail |
object |
The object containing details about RIDES order type |
transport_detail.usage_type |
string |
The type RIDES order (INDIVIDUAL/GROUP) |
transport_detail.bill_split_type |
string |
Type to identify if there was a SINGLE_PAYER/MULTI_PAYER for the order |
transport_detail.duration |
string |
The ride duration in format HH:MM:SS. |
transport_detail.pickup_time |
object |
The time object for pickup. |
transport_detail.pickup_time.timestamp_utc |
string |
The UTC Timestamp for pickup. |
transport_detail.pickup_time.timestamp_local |
string |
The Local Timestamp for pickup. |
transport_detail.pickup_location |
object |
The Location for pickup. |
transport_detail.pickup_location.point.latitude |
float |
The latitude for pickup location. |
transport_detail.pickup_location.point.longitude |
float |
The longitude for pickup location. |
transport_detail.pickup_location.address |
string |
The address for pickup location. |
transport_detail.pickup_location.city |
string |
The city for pickup location. |
transport_detail.pickup_location.state |
string |
The state for pickup location. |
transport_detail.pickup_location.country |
string |
The country for pickup location. |
transport_detail.dropoff_time |
object |
The time object for dropoff. |
transport_detail.dropoff_time.timestamp_utc |
string |
The UTC Timestamp for dropoff. |
transport_detail.dropoff_time.timestamp_local |
string |
The Local Timestamp for dropoff. |
transport_detail.dropoff_location |
object |
The Location for dropoff. |
transport_detail.dropoff_location.point.latitude |
float |
The latitude for dropoff location. |
transport_detail.dropoff_location.point.longitude |
float |
The longitude for dropoff location. |
transport_detail.dropoff_location.address |
string |
The address for dropoff location. |
transport_detail.dropoff_location.city |
string |
The city for dropoff location. |
transport_detail.dropoff_location.state |
string |
The state for dropoff location. |
transport_detail.dropoff_location.country |
string |
The country for dropoff location. |
transport_detail.distance |
object |
The distance of the trip. |
transport_detail.distance.value |
float |
The value of the distance for the trip. |
transport_detail.distance.unit |
string |
The units for the distance for the trip. |
eats_detail |
object |
The object containing details about EATS order type |
eats_detail.fulfillment_type |
string |
The fulfillment type of the eats order. (PICKUP/DELIVERY) |
eats_detail.usage_type |
string |
The EATS order type (INDIVIDUAL/GROUP) |
eats_detail.bill_split_type |
string |
Type to identify if there was a SINGLE_PAYER/MULTI_PAYER for the order |
eats_detail.delivery_time |
object |
The order delivery time |
eats_detail.delivery_time.timestamp_utc |
string |
The order delivery time utc timestamp |
eats_detail.delivery_time.timestamp_local |
string |
The order delivery time local timestamp |
eats_detail.stores |
array |
The store details for the eats order. |
eats_detail.stores.name |
string |
The name of the store. |
eats_detail.stores.store_id |
string |
The unique identifier for the store. |
eats_detail.stores.location |
object |
The location of the store. |
eats_detail.stores.location.address |
string |
The address for store location. |
eats_detail.stores.location.city |
string |
The city for store location. |
eats_detail.stores.location.state |
string |
The state for store location. |
eats_detail.stores.location.country |
string |
The country for store location. |
eats_detail.delivery_location |
object |
The delivery location details. |
eats_detail.delivery_location.point.latitude |
float |
The latitude for delivery location. |
eats_detail.delivery_location.point.longitude |
float |
The longitude for delivery location. |
eats_detail.delivery_location.address |
string |
The address for delivery location. |
eats_detail.delivery_location.city |
string |
The city for delivery location. |
eats_detail.delivery_location.state |
string |
The state for the delivery location. |
eats_detail.delivery_location.country |
string |
The country for the delivery location. |
eats_detail.cart_items |
array |
The cart items for the eats order. |
eats_detail.cart_items.name |
string |
The name of the cart item. |
eats_detail.cart_items.entity_id |
string |
The identifier for entity consuming the cart item. |
eats_detail.cart_items.store_id |
string |
The store identifier from which the cart item was ordered. |
eats_detail.cart_items.quantity |
integer |
The quantity of cart item in the order. |
eats_detail.cart_items.amount |
object |
The amount for the cart item. |
eats_detail.cart_items.amount.value |
integer |
The value of the cart item amount. To be divided by 10e5 to get decimal values for the currency. |
eats_detail.cart_items.amount.currency_code |
string |
The ISO currency code of the cart item amount. |
programs |
object |
The object containing program details for the order. |
programs.program_id |
string |
The unique identifier for the program. |
programs.program_name |
string |
The name of the program for the order. |
programs.program_type |
string |
The type of program for the order. |
programs.owner_entity_id |
string |
The organization to which the program is associated with. |
vouchers |
object |
The object containing voucher details applied to the order if any. |
vouchers.voucher_id |
string |
The unique identifier of the voucher applied to the order. |
vouchers.campaign_id |
string |
The unique identifier of the campaign for the voucher. |
vouchers.campaign_name |
string |
The name of the voucher campaign. |
vouchers.owner_entity_id |
string |
The organization identifier to which the voucher is associated with. |
payment_detail |
object |
The object containing payment details for the order. |
payment_detail.order_amount |
object |
The object containing total amount paid for the order. |
payment_detail.order_amount.value |
integer |
The value of the order amount. To be divided by 10e5 to get decimal values for the currency. |
payment_detail.order_amount.currency_code |
string |
The ISO currency code of the order amount. |
payment_detail.expense_details |
array |
The object containing expense related details for the order. (Optional) |
payment_detail.expense_details.expense_code |
string |
The expense code associated with the order. |
payment_detail.expense_details.expense_memo |
string |
The expense memo associated with the order. |
payment_detail.expense_details.entity_id |
string |
The employee identifier associated with the expense details. |
payment_detail.fares |
array |
The object containing fare break down for the order. |
payment_detail.fares.name |
string |
The name of the fare. |
payment_detail.fares.amount |
float |
The amount for the fare. |
payment_detail.fares.amount.value |
integer |
The value of amount for the fare. To be divided by 10e5 to get decimal values for the currency. |
payment_detail.fares.amount.currency_code |
string |
The ISO currency code for the fare amount. |
payment_detail.fares.fare_type |
string |
The type of fare (FARE/TAX/TIP/DEDUCTION/OTHERS). |
payment_detail.charges |
array |
The object containing charge details by entities fulfilling the order. [Available only in select regions] |
payment_detail.charges.charge_entity_type |
string |
The type of charge entity (UBER/RESTAURANT/DRIVER). |
payment_detail.charges.name |
string |
The name of the charging entity. |
payment_detail.charges.address |
string |
The address of charging entity. |
payment_detail.charges.tax_id |
string |
The tax id of the charging entity. |
payment_detail.charges.entity_charges |
array |
The object containing charges levied by the entity. [Available only in select regions] |
payment_detail.charges.entity_charges.charge_type |
string |
The type of charge for the entity. |
payment_detail.charges.entity_charges.amount |
object |
The amount of charge. |
payment_detail.charges.entity_charges.amount.value |
integer |
The value of charge amount. To be divided by 10e5 to get decimal values for the currency. |
payment_detail.charges.entity_charges.amount.currency_code |
string |
The ISO currency code of charge amount. |
payment_detail.charges.documents |
string |
The documents like invoices for the charges. |
payment_detail.charges.documents.id |
string |
The unique identifier for the document. |
payment_detail.charges.documents.created_time |
object |
The Document created time. |
payment_detail.charges.documents.created_time.timestamp_utc |
string |
The document created timestamp in UTC. |
payment_detail.charges.documents.created_time.timestamp_local |
string |
The document created timestamp in local timezone. |
payment_detail.charges.documents.url |
string |
The url for the document. |
payment_detail.charges.documents.document_type |
string |
The type of document (INVOICE). |
payment_detail.charges.location |
object |
The location details for charging entity. |
payment_detail.charges.location.address |
string |
The address of charging entity. |
payment_detail.charges.location.country |
string |
The Country Code of charging entity. |
payment_detail.transactions |
array |
The array containing transactions for the order. |
payment_detail.transactions.transaction_id |
string |
The unique identifier for the transaction. |
payment_detail.transactions.transaction_type |
string |
The type of transaction (FARE/TIP/FARE_AND_TIP/ADJUSTMENT). |
payment_detail.transactions.time |
object |
The time for the transaction. |
payment_detail.transactions.time.timestamp_utc |
string |
The timestamp in UTC for the transaction. |
payment_detail.transactions.time.timestamp_local |
string |
The timestamp local for the transaction. |
payment_detail.transactions.local_currency_amount |
object |
The transaction amount in local currency. |
payment_detail.transactions.local_currency_amount.value |
integer |
The value of the transaction amount in local currency. To be divided by 10e5 to get decimal values for the currency. |
payment_detail.transactions.local_currency_amount.currency_code |
string |
The ISO currency code of the transaction amount in local currency. |
payment_detail.transactions.home_currency_amount |
object |
The transaction amount in organization home currency. [Available for centralized billing organizations] |
payment_detail.transactions.home_currency_amount.value |
integer |
The value of the transaction amount in organization home currency. To be divided by 10e5 to get decimal values for the currency. |
payment_detail.transactions.home_currency_amount.currency_code |
string |
The ISO currency code of the transaction amount in organization home currency. |
payment_detail.transactions.short_reference |
string |
The short reference of the transaction. |
payment_detail.transactions.network_transaction_id |
string |
The network transaction id obtained from credit card network. |
payment_detail.transactions.entity_id |
string |
The unique identifier of the user or organization associated with the transaction. |
payment_detail.transactions.payment_instrument |
object |
The details of payment instrument used in the transaction. |
payment_detail.transactions.payment_instrument.payment_instrument_type |
string |
The type of the payment instrument. |
payment_detail.transactions.payment_instrument.voucher_details |
object |
The details of voucher if any used for the transaction. |
payment_detail.transactions.payment_instrument.voucher_details.voucher_id |
string |
The voucher id of the voucher used for the transaction. |
payment_detail.transactions.payment_instrument.card_details |
object |
The details of card used for the transaction. |
payment_detail.transactions.payment_instrument.card_details.network |
string |
The network of the card used for the transaction (VISA/MASTERCARD/DISCOVER etc). |
payment_detail.transactions.payment_instrument.card_details.last4 |
string |
The last4 digit of the card used in the transaction. |
payment_detail.transactions.transaction_receipt_pdf |
string |
The pdf url for the transaction. [Will be populated later] |
payment_detail.transactions.taxes |
array |
The list of taxes associated with the transaction. |
payment_detail.transactions.taxes.name |
string |
The name of the tax. |
payment_detail.transactions.taxes.amount |
object |
The amount of the tax. |
payment_detail.transactions.taxes.amount.value |
integer |
The value of the tax amount. To be divided by 10e5 to get decimal values for the currency. |
payment_detail.transactions.taxes.amount.currency_code |
string |
The ISO currency code of the tax amount. |
payment_detail.transactions.taxes.rate |
array |
The rate at which the tax is charged. |
payment_detail.transactions.taxes.rate_type |
array |
The rate type for the tax charged. |
payment_detail.transactions.taxes.authority |
object |
The tax authority details. |
payment_detail.transactions.taxes.authority.state |
string |
The tax authority state. |
payment_detail.transactions.taxes.authority.country |
string |
The tax authority country. |
¶ Error Responses
| HTTP Status | Code | Description |
|---|---|---|
| 400 | bad_request |
Request specific message |
| 401 | not_authenticated |
Request made without authentication |
| 403 | not_authorized |
Caller not authorized to make this request |
| 404 | not_found |
Entity being fetched not found |
| 429 | rate_limited |
Rate limit exceeded |
| 500 | server_error |
We have experienced a problem |