neatcar

Endpoint

List Carwash History

The List Carwash History endpoint allows an authenticated user to retrieve a chronological record of their past carwash transactions within the Neatcar platform. Access to this endpoint requires a valid user token, ensuring that only the history associated with the authenticated user is returned. The response includes details such as date, location, and service information for each carwash visit.

GET

/user/history/carwash?userUUID=4d06009b-fbdb-44bb-9329-b50334bf9538&carwashPaymentIntentUUID=5b57354f-acc1-4b2b-9120-1c41c51cbeca

The userUUID is the UUID of the user that you want to get the carwash history for. It is required and the user must have been created from your reseller account to get his history.

The carwashPaymentIntentUUID is the UUID of the carwash payment intent that you want to get the carwash history for. It is optional and if provided, need to have been created for the user and by your reseller account.

Carwash History Model data

The following list provides a selection of key values included in the model; however, it is non-exhaustive. Developers can expect to find additional fields and data within the model, offering comprehensive information about each carwash history. This abbreviated list serves as a starting point for understanding the structure of the model and the types of information available for each carwash history.

code
The carwash code that was bought
transaction.pricePaid
The price paid for the carwash before taxes
transaction.taxPaid
The tax paid for the carwash
transaction.storeId
The id of the store where the carwash was bought
networkCarwashType
The network carwash type that was bought. This field will only be present if the carwash was bought from a network (by the networkCarwashTypeId)
storeCarwashType
The store carwash type that was bought. This field will only be present if the carwash was bought from a store (by the storeCarwashTypeId)

Response example

If a carwashPaymentIntentUUID is provided, the 'history' array will only contain the carwash history for the payment intent. If not provided, the 'history' array will contain the carwash history for all the carwashes bought by the user.

Below is an example of the API endpoint response, showcasing the structure and format of the data returned by the specified endpoint. This example serves as a practical illustration, demonstrating how developers can expect the information to be organized and presented when interacting with the API. It provides insight into the content and layout of the response, facilitating effective integration and utilization of the endpoint within your applications.