--- title: "Get journey's sales" method: GET path: "/api/v4/journey/{journey_id}/sales" tags: ["Sales"] --- # Get journey's sales `GET /api/v4/journey/{journey_id}/sales` ## Request - Base URL: `https://cabify-sandbox.com` - URL: `https://cabify-sandbox.com/api/v4/journey/{journey_id}/sales` - Auth: HTTP bearer Fetch the sales of the journey ## Path parameters - `journey_id` string, required ## Response `200` Success - Sale[] - `code` string: Code of the Sale. - `concept` Concept: Prices of the Sale detailed. - `type` string: Type of the element being sold. - `type_object` union - object: Entity description in a Sale. - `charge_code` string: Charge code of the Journey of the Sale. - `country` string: Country of the Journey of the Sale. - `description` string: The Description includes the detail of the Journey associated to the Sale. - `dropoff` StopResponse: Stop of a journey. A journey needs to have at least 2 stops: the first one is considered the pickup point the last one the destination. - `addr` string: If an address was provided when creating the journey this field will have its value. - `city` string: City name where the address is located, e.g. Madrid. - `contact` Contact: Contact details on each Stop. Include this object if you want the Driver to see additional Contact details on each Stop. - `mobile_cc` string: Mobile Country Code of the Contact of the Stop passed when creating the Journey. - `mobile_num` string: Mobile Number of the Contact of the Stop passed when creating the Journey. - `name` string: Name of the Contact of the Stop passed when creating the Journey. - `stop_action` 'pickup' | 'dropoff': Action to be performed on the Stop. Possible values: 'pickup', 'dropoff'. Ignored when it is included in the `contact` field (`stop/contact`), i.e. only taken into account when specific for the contacts within `stop/contacts`. - `contacts` Contact[]: List of contacts for the stop, in case of multiple contacts. - `mobile_cc` string: Mobile Country Code of the Contact of the Stop passed when creating the Journey. - `mobile_num` string: Mobile Number of the Contact of the Stop passed when creating the Journey. - `name` string: Name of the Contact of the Stop passed when creating the Journey. - `stop_action` 'pickup' | 'dropoff': Action to be performed on the Stop. Possible values: 'pickup', 'dropoff'. Ignored when it is included in the `contact` field (`stop/contact`), i.e. only taken into account when specific for the contacts within `stop/contacts`. - `country` string: Country name where the address is located, e.g. España. - `hit_at` string, date-time: DateTime when the driver arrived at the indicated point. - `id` string: Id of the stop. - `instr` string: Set of instructions for the Driver. - `loc` number[], required: The actual coordinates of the address. Required floats per location latitude and longitude. - `meeting_point` MeetingPoint: A specific meeting point within a hub location (e.g. a terminal at an airport). Obtained from the hub data returned in the estimates response. - `id` string, required: Unique identifier of the meeting point. - `loc` number[], required: Coordinates of the meeting point as [latitude, longitude]. - `name` string, required: Display name of the meeting point. - `name` string: A short name for previously stored addresses. These can be viewed in places. - `num` string: Street number. - `postal_code` string: Postal code of the address. - `end_at` string, date-time: DateTime when the Journey ended. - `id` string: ID of the Journey of the Sale. - `pickup` StopResponse: Stop of a journey. A journey needs to have at least 2 stops: the first one is considered the pickup point the last one the destination. - `addr` string: If an address was provided when creating the journey this field will have its value. - `city` string: City name where the address is located, e.g. Madrid. - `contact` Contact: Contact details on each Stop. Include this object if you want the Driver to see additional Contact details on each Stop. - `mobile_cc` string: Mobile Country Code of the Contact of the Stop passed when creating the Journey. - `mobile_num` string: Mobile Number of the Contact of the Stop passed when creating the Journey. - `name` string: Name of the Contact of the Stop passed when creating the Journey. - `stop_action` 'pickup' | 'dropoff': Action to be performed on the Stop. Possible values: 'pickup', 'dropoff'. Ignored when it is included in the `contact` field (`stop/contact`), i.e. only taken into account when specific for the contacts within `stop/contacts`. - `contacts` Contact[]: List of contacts for the stop, in case of multiple contacts. - `mobile_cc` string: Mobile Country Code of the Contact of the Stop passed when creating the Journey. - `mobile_num` string: Mobile Number of the Contact of the Stop passed when creating the Journey. - `name` string: Name of the Contact of the Stop passed when creating the Journey. - `stop_action` 'pickup' | 'dropoff': Action to be performed on the Stop. Possible values: 'pickup', 'dropoff'. Ignored when it is included in the `contact` field (`stop/contact`), i.e. only taken into account when specific for the contacts within `stop/contacts`. - `country` string: Country name where the address is located, e.g. España. - `hit_at` string, date-time: DateTime when the driver arrived at the indicated point. - `id` string: Id of the stop. - `instr` string: Set of instructions for the Driver. - `loc` number[], required: The actual coordinates of the address. Required floats per location latitude and longitude. - `meeting_point` MeetingPoint: A specific meeting point within a hub location (e.g. a terminal at an airport). Obtained from the hub data returned in the estimates response. - `id` string, required: Unique identifier of the meeting point. - `loc` number[], required: Coordinates of the meeting point as [latitude, longitude]. - `name` string, required: Display name of the meeting point. - `name` string: A short name for previously stored addresses. These can be viewed in places. - `num` string: Street number. - `postal_code` string: Postal code of the address. - `region` string: Region where the Journey happened. - `start_at` string, date-time: DateTime when the Journey started. - object - `description` string: Description usually indicating the reason of the Rectification. - `rectified_sale_id` string: ID of the Sale which was rectified. - `currency` string: Currency of the Sale. - `invoice_date` string, date: Date of the Invoice of the Sale. - `price_details` PriceDetail - `discount` integer: Total discount in cents with taxes. - `tax_rate` integer: Tax Rate. - `tax_type` string: Tax Type. Usually is 'iva_av'. - `total` integer: Total amount in cents with taxes. ## Other responses - `400`: Bad request - `401`: Unauthorized - `404`: Not found - `500`: Internal server error --- [API](https://skmtc.dev/cabify/apis/ride-hailing-api.md) - [All operations](https://skmtc.dev/cabify/apis/ride-hailing-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cabify/apis/ride-hailing-api/revisions/22a12845e173?raw)