/purchases

Purchases

The Purchases API is intended for Manheim’s Buyer customers to retrieve the details about their purchases at Manheim auctions. This API provides the buyer side view of the transactions.

This document describes the contract and resources provided by the Purchases API. This API is RESTful and provides access to resources via URI paths (aka endpoints). To use the RESTful contract, your application will have to make HTTP GET requests to the desired endpoints. The response payload content type is application/json. The contract is intended for Manheim’s Buyer customers who wish to integrate their application/system with the Purchases API for their purchase related transactions.

URLs and Environments

The base URL for the Purchases API is /orders/purchases. This document describes each method endpoint starting with this base URL.

Actual requests will require the protocol and host URL for one of the Manheim environments:

QA: https://integration5.api.manheim.com
Pre-Production: https://uat.api.manheim.com
Production: https://api.manheim.com

See API Access and Environments for more information about Manheim API environments.

Authentication & Authorization

To use this API, you must have a Mashery API Package Key that is active with the inventory:customer scope assigned to it.
When requesting an access token for this API, use the client credentials grant type and the inventory:customer scope.

The request header must include the Authorization key with a value of Basic followed by your Base64 encoded Mashery key:secret pair. Note that you must Base64 encode your Mashery key:secret. For details of how to do this refer to Preparing the Authorization Header.

Attribute	Value
Authorization	Basic
Content-Type	application/x-www-form-urlencoded
grant_type	client_credentials
scope	inventory:customer

Example cURL:

curl --location --request POST 'https://integration5.api.manheim.com/oauth2/token.oauth2' \
--header 'Authorization: Basic aDNod2dtNDQ0NWtqenB0XXXXXXXXXXXXX=' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'scope=inventory:customer'

For details on how to request a token and additional information on authentication and authorization, please refer to Authentication and Authorization.

Endpoints (HTTP GET Requests) are listed below :

1. Retrieve Manheim Buyer Customer’s purchases by Customer ID

Endpoint

GET /orders/purchases/customer/{ID}

Description

The {ID} placeholder in the URL should be replaced with the buyer customer’s auction access dealer number.

2. Retrieve Manheim Buyer Customer’s purchases by Customer ID, Auction and VIN

Endpoint

GET /orders/purchases/customer/{ID}/auction/{auctionCode}/vin/{VIN}

Description

The {ID} placeholder in the URL should be replaced with the buyer customer’s auction access dealer number.
The {auctionCode} placeholder should be replaced with the desired Manheim auction location code.
The {VIN} placeholder should be replaced with the vehicle's 17-digit vehicle identification number.

3. Retrieve Manheim Buyer Customer’s purchases by Customer ID, Auction and Sale Key

Endpoint

GET /orders/purchases/customer/{ID}?auction={auctionCode}&saleYear={saleYear}&saleNumber={saleNumber}&laneNumber={laneNumber}&runNumber={runNumber}

Description

The {ID} placeholder in the URL should be replaced with the buyer customer’s auction access dealer number.
The {auctionCode} placeholder should be replaced with the desired Manheim auction location code.
The {saleYear} placeholder should be replaced with the 4-digit sale year, e.g. 2020.
The {saleNumber} placeholder should be replaced with the 2-digit sale number, e.g. 11.
The {laneNumber} placeholder should be replaced with the 2-digit lane number, e.g. 45.
The {runNumber} placeholder should be replaced with the 4-digit run number, e.g. 0001.

4. Retrieve Manheim Buyer Customer’s purchases by purchase ID

Endpoint

GET /orders/purchases/id/{ID}

Description

The {ID} placeholder in the URL should be replaced with the purchase id of the transaction.

Common Return Codes

Response Code	Description	Possible Next Actions
200 OK	The request completed successfully; the response includes the transactions in JSON representation	No action necessary
400 Bad Request	ERROR: Response is blank or message contains details about the parameter that is invalid or missing	If the response is blank, the request may be malformed or if there is a message, a parameter is missing or invalid; correct and resubmit
401 Unauthorized	ERROR: Access denied due to incorrect credentials, malformed API token, or because user does not have access	Validate the token or contact us for API access
403 Forbidden	ERROR: The server refused to authorize the request. The authentication credentials were provided in the request, but the server considers them insufficient to grant access	User is authenticated, but doesn’t have sufficient privileges to access the requested resource
404 Not Found	ERROR: The requested resource did not exist, or no data match found for the specified input parameters in the request	Modify request and resubmit
500 Server Error	ERROR: An unexpected condition that prevented the requested transactions from being retrieved; the response may include details about the error's cause	Response may contain details about what went wrong

Request Parameters

In order to retrieve purchases for a Manheim Buyer Customer by Customer ID:

GET /orders/purchases/customer/{ID}

The only required parameter is customer ID in this endpoint:

Parameter	Type	Requirement	Description
customer	String	Required	Customer’s auction access dealer number

For the above endpoint, the user may also use available OPTIONAL query parameters from the table below.

Optional Request Parameters

Field	Type	Description
days	Integer	The age of purchase transactions, expressed in days, which the API is to report (such as "7" to represent the past week); defaults to 30 if omitted and accepted values may be any positive numeric value between 1 and 396 (13 months)
startDate	Date	Date in ISO format(yyyy-MM-dd) from which the API should start pulling the purchases. Always works in conjunction with endDate. If not passed in the request, this filter doesn’t have a default value, hence wouldn’t get applied. Maximum window allowed is 396 days per API call
endDate	Date	Date in ISO format(yyyy-MM-dd) up to which the API should consider pulling the purchases. Always works in conjunction with startDate. If not passed in the request, this filter doesn’t have a default value, hence wouldn’t get applied. Maximum window allowed is 396 days per API call
auction	String	Manheim auction facility at which a purchased vehicle was sold; defaults to all auctions if omitted
limit	Integer	Number of purchase records which may be returned in a single page; defaults to 25 if omitted and accepted values may be any positive numeric value between 1 and 500
start	Integer	Allows the response to begin at a certain record number

NOTE:

For this endpoint, API calls would work either by days OR by startDate/endDate combination. Both of these combinations shouldn’t be applied together in a single request.
If not passed in the request, days default to the last 30 days from now. If you decide to use days parameter while calling this endpoint, it is recommended to keep days to a lower number (preferably 1 or 2) to avoid paging through a huge response.
If you decide to use startDate/endDate instead of days while calling this endpoint, note that startDate/endDate don’t have default values. You would need to pass both the dates in yyyy-MM-dd format satisfying the rules mentioned in the table above. Again, it is recommended to keep the window very small between startDate and endDate to avoid paging through a huge response.

Recommendations:

If you are planning to call the above endpoint, it is highly recommended to make the API call for as small window(time frame) as possible for optimal performance and optimal response time from the API.
The preferred approach is to make the API call for a single purchase transaction at a time using either of the endpoints below (as applicable):
- Customer ID, auction code, and VIN
- Customer ID, auction code, and Sale Key (combination of sale year, sale number, lane number and run number)
- Purchase ID

2. In order to retrieve Manheim Buyer Customer’s purchases by Customer Id, Auction and VIN:

GET /orders/purchases/customer/{ID}/auction/{auctionCode}/vin/{VIN}

This method requires the customer ID, auction code, and VIN in the request URL.

Parameter	Type	Requirement	Description
customer	String	Required	Customer’s auction access dealer number
auction	String	Required	Manheim facilitating auction code
vin	String	Required	Vehicle's 17-digit identification number

3. In order to retrieve Manheim Buyer Customer’s purchases by Customer Id, Auction and Sale Key:

GET /orders/purchases/customer/{ID}?auction={auctionCode}&saleYear={saleYear}&saleNumber={saleNumber}&laneNumber={laneNumber}&runNumber={runNumber}

This method requires the customer ID, auction code, and Sale Key (combination of sale year, sale number, lane number and run number) in the request URL.

Parameter	Type	Requirement	Description
customer	String	Required	Customer’s auction access dealer number
auction	String	Required	Manheim facilitating auction code
saleYear	Integer	Required	Numeric Sale Year, e.g. 2020
saleNumber	Integer	Required	Numeric Sale Number, e.g. 11
laneNumber	Integer	Required	Numeric Sale Lane number, e.g. 45
runNumber	Integer	Required	Numeric Sale Run number, e.g. 0001

4. In order to retrieve purchases for a Manheim Buyer Customer by Purchase ID:

GET /orders/purchases/id/{ID}

The only required parameter is purchase ID in this endpoint:

Parameter	Type	Requirement	Description
id	String	Required	Guid for the Purchase transaction

Sample Requests

Here is an example of a valid API call :

GET /orders/purchases/customer/5000000

Note : There are no query parameters specified in this sample endpoint. As also described in the aforementioned table for optional query parameters, this request would pull :

max 25 transactions (default value for limit)
for the last 30 days (default search window if days OR startDate/endDate are missing in the request)
at all Manheim auctions (default value for auction)
including all applicable vehicles that are sold

More Examples

The following samples showcase the usage of several optional query parameters (as needed). The query parameters can be specified in any order.

Pull purchases for customer (5000000) for the last 1 day:

GET /orders/purchases/customer/5000000?days=1

Pull purchases for customer (5000000) between 15-Sep-21 to 16-Sep-21:

GET /orders/purchases/customer/5000000?startDate=2021-09-15&endDate=2021-09-16

Pull all purchases for customer (5000000) in the last 1 day at RAA auction:

GET  /orders/purchases/customer/5000000?days=1&auction=RAA

Pull transactions for customer (5000000) for a specific VIN at NVAA auction:

GET  /orders/purchases/customer/5000000/auction/NVAA/vin/2T3ZFREV4JW432117

Pull transactions for customer (5000000) at DALA auction for a specific sale key:

GET  /orders/purchases/customer/5000000?auction=DALA&saleYear=2021&saleNumber=37&laneNumber=47&runNumber=43

Pull purchases by purchase Id:

GET  /orders/purchases/id/83851E77297824A1E0532936680CC45Z

Response Details

If the request was successful and the response has purchases to be returned, information about the response data fields is described in the following tables. If the field is an array, items in the array may be repeated to reflect all of the data elements returned based on the request.

Field	Type	Description
href	String	Unique system-generated URL for this collection of purchases
limit	Integer	Number of purchase records which may be returned in a single page; default of 25
count	Integer	Number of purchases returned on the page as determined by the limit
next	String	URL for the next page of purchases whose size is determined by the limit if the number of records exceeds the limit
previous	String	URL for the preceding page of purchases determined by the limit, if the preceding page exists
items	Array	Contains a block of purchase records; each record has the fields listed in the table below

Paging through the response

When returning a collection of resources, up to three additional properties might get included in the response object to facilitate pagination: first, previous and next. These are links that the API caller can follow to progress through the entire collection of results.

When rendering the first page of the results, first and previous links will not be included in the response.

Also as mentioned in the request parameters section, the limit parameter allows the caller to specify an arbitrary page size. The default limit is 25 and the maximum supported is 500.

For example:

GET  /orders/purchases/customer/5000000?days=1&limit=10

would return

{
    "href": "https://api.manheim.com/orders/purchases/customer/5000000?days=1&limit=10",
    "next": "https://api.manheim.com/orders/purchases/customer/5000000?days=1&limit=10&start=11",
    "limit": 10,
    "count": 10,
    "items": [
        ……
    ]
}

And invoking the "next" link above would return:

{
    "href": "https://api.manheim.com/orders/purchases/customer/5000000?days=1&limit=10&start=11",
    "previous": "https://api.manheim.com/orders/purchases/customer/5000000?days=1&limit=10&start=1",
    "next": "https://api.manheim.com/orders/purchases/customer/5000000?days=1&limit=10&start=21",
    "limit": "10",
    "count": 10,
    "items": [
        ……
    ]
}

Items Section Details

consignment

As described above, items is an array of purchases for the buyer. Each item may contain consignment fields, as described in the table below. Values written in ALL CAPS indicate a defined list of accepted values.

Field	Type	Description
href	String	Unique system-generated URL for this purchase
purchaseDate	Date	Date of purchase of the vehicle
purchasePrice	Integer	Amount for which the vehicle was purchased
currency	String	The ISO code (e.g., "USD") for the money used in the purchase transaction
vehicleStatus	String	Readiness of the vehicle for removal from Manheim’s auction lot: Available - Ready for Pickup Available - Arrange gate release Left lot Not Ready for Pickup
vehicleStatusTs	Date	Datetime when the vehicleStatus moved to the current state
checkOutDate	Date	Date when the vehicle was checked out
purchaseApplication	String	The channel through which the vehicle was purchased
purchaseMethod	String	The Manheim system through which the vehicle was purchased
purchaseOfferExists	Boolean	Value indicating whether an active purchase offer exists on this purchase: true – active purchase offer exists false – no active purchase offer exists
blockTimestamp	Date	For Simulcast and traditional auctions, the time when the vehicle crossed the block; for OVE, the time when the vehicle was purchased
consignment	Object	Container of information describing the vehicle, physical location of the vehicle and the seller
consignment.unit	Object	Container of information describing the vehicle
consignment.unit.modelYear	Integer	The model year applicable to the vehicle
consignment.unit.make	String	The manufacturer name applicable to the vehicle
consignment.unit.model	String	The model name applicable to the vehicle
consignment.unit.vin	String	The industry-standard identification number assigned to the vehicle
consignment.unit.trim	String	The trim level of the vehicle
consignment.unit.body	String	The body type of the vehicle
consignment.unit.engineDescription	String	The type of engine in the vehicle
consignment.unit.interiorColor	String	The vehicle’s interior color
consignment.unit.exteriorColor	String	The vehicle’s exterior color
consignment.unit.odometerReading	Integer	The amount measured on the vehicle’s odometer
consignment.unit.odometerUnits	String	The unit of measurement for the vehicle’s odometer: MILES KILOMETERS HOURS
consignment.unit.vehicleType	String	The general class to which the vehicle belongs
consignment.unit.drivable	Boolean	true if the vehicle is drivable, false otherwise
consignment.unit.keyAvailable	Boolean	true if the vehicle’s key is present; false otherwise
consignment.unit.grade	Decimal	The current condition grade assigned to the vehicle
consignment.unit.workOrderNumber	Integer	The Manheim identifier for a customer work request applicable to the vehicle
consignment.unit.seller	Object	Container of information describing the seller details
consignment.unit.seller.dealerName	String	The name of the customer who offered the vehicle for sale
consignment.unit.physicalLocation	Object	Container of information describing the physical location of the purchased vehicle
consignment.unit.physicalLocation.href	String	System-generated URL that identifies the vehicle’s associated physical location resource and provides (with appropriate authorization) access to more details about the vehicle’s physical location
consignment.unit.physicalLocation.offsite	Boolean	true if the vehicle is located on Manheim premises; false otherwise
consignment.unit.physicalLocation.locationName	String	The name assigned to the vehicle’s physical location
consignment.unit.physicalLocation.locationCode	String	The Manheim code which uniquely identifies the physical location
consignment.unit.physicalLocation.address	Object	Container of information describing the physical location’s address
consignment.unit.physicalLocation.address.address1	String	The physical location’s street address
consignment.unit.physicalLocation.address.address2	String	Additional street address line for the physical location
consignment.unit.physicalLocation.address.city	String	The city of the physical location
consignment.unit.physicalLocation.address.stateProvinceRegion	String	The state or province of the physical location
consignment.unit.physicalLocation.address.country	String	The state or province of the physical location
consignment.unit.physicalLocation.address.postalCode	Integer	The postal code of the physical location
consignment.unit.physicalLocation.contact	Object	Container of information describing the physical location’s contact for true offsite vehicles only
consignment.unit.physicalLocation.contact.phone	String	Phone number of the true offsite physical location’s contact
consignment.unit.lotLocation	Object	Container of information describing the lot location of the purchased vehicle
consignment.unit.lotLocation.lotLocationCode	String	Lot location code of the vehicle at the Manheim auction
consignment.unit.lotLocation.lotLocationDescription	String	Description of the lot location of the vehicle at the Manheim auction

offering

Each item will contain offering related fields, as described in the table below. Values written in ALL CAPS indicate a defined list of accepted values.

Field	Type	Description
offering	Object	Container of information describing about the vehicle offering and the operating location
offering.startDate	Date	The date when the sale window applicable to the vehicle was opened
offering.endDate	Date	The date when the sale window applicable to the vehicle was closed
offering.operatingLocation	Object	Container of information describing the operating location of the vehicle
offering.operatingLocation.href	String	System-generated URL that identifies the vehicle’s associated operating location resource and provides (with appropriate authorization) access to more details about the vehicle’s operating location
offering.operatingLocation.locationName	String	The name of the Manheim auction facilitating the vehicle’s sale
offering.operatingLocation.locationCode	String	The identifier for the Manheim auction facilitating the vehicle’s sale
offering.saleKey	Object	Container of information about the sale key of the purchased vehicle (if applicable), as described by the fields below
offering.saleKey.saleYear	Integer	Year of sale of the vehicle
offering.saleKey.saleNumber	Integer	Number of the sale for the vehicle at a specific auction
offering.saleKey.laneNumber	Integer	Number of the lane in which the vehicle will appear at the auction
offering.saleKey.runNumber	Integer	Number of the run in which the vehicle will appear in a lane at the auction
offering.offeringApplication	String	The Manheim system through which the vehicle is offered for sale
offering.offerMethod	String	The channel through which the vehicle is offered for sale
offering.registrationDate	Date	Date the vehicle was registered at the auction
offering.saleType	String	The sale category applicable to the vehicle
offering.bidRestriction	String	The lowest bid the seller is willing to accept for the vehicle (for OVE only)
offering.offeringStatus	String	The vehicle’s sale status
offering.offeringStatusReason	String	An explanation of the vehicle’s sale status
offering.asIs	Boolean	Status indicating whether the vehicle is sold "as-is:" true - vehicle is being sold "as-is" and is not eligible for arbitration false - vehicle is not sold "as-is" and may be eligible for arbitration
offering.salvage	Boolean	Status indicating whether a vehicle is designated as "salvage:" true - vehicle has been designated as "salvage" false - vehicle has not been designated as "salvage"
offering.disclosures	Array	Contains an array of disclosure codes pertaining to the vehicle to describe the auction lights: "GUARANTEE" for green light "CAUTION" "NO TITLE" for blue light

buyer

Each item will contain buyer related fields, as described in the table below. Values written in ALL CAPS indicate a defined list of accepted values.

Field	Type	Description
buyer	Object	Container of information describing the buyer of the vehicle
buyer.dealerNumber	Integer	Dealer number of the buyer
buyer.dealerName	String	Name of the buyer
buyer.bidderBadge	Integer	Bidder badge number of the buyer
buyer.rep	Object	Container of information about the representative of the buyer
buyer.rep.repNumber	Integer	Dealer number of the buyer
buyer.rep.repName	String	Rep number of buyer representative

invoice

Each item will contain invoice related fields, as described in the table below.

Field	Type	Description
invoice	Object	Contains a block of information about the invoice details of the purchase
invoice.href	String	Href to access information about the invoice details of the purchase

Error response

In the event of an error, appropriate HTTP status code will be returned. Whenever possible, an error response body will also be included accompanying the HTTP status code.

For Example:

GET  /orders/purchases/customer/5000000?startDate=2021-09-14

would return HTTP status code of “400 Bad Request”

accompanied with below error response body:

{
    "errors": [
        {
            "property": "endDate",
            "message": "startDate was entered but endDate is not present in the request",
            "developerMessage": "Please verify the input parameter - endDate"
        }
    ]
}

Where errors can contain multiple errors that were found in the request.

For Example:

GET  /orders/purchases/customer/5000000?startDate=2021-09-14&limit=600

would return HTTP status code of “400 Bad Request”

accompanied with below error response body:

{
    "errors": [
        {
            "property": "endDate",
            "message": "startDate was entered but endDate is not present in the request",
            "developerMessage": "Please verify the input parameter - endDate"
        },
        {
            "property": "limit",
            "message": "Invalid value for limit. Should be a positive number less than or equal to 500",
            "developerMessage": "Please verify the input parameter - limit"
        }
    ]
}

Example Request (Customer ID, Auction, VIN)

GET https://intgeration5.api.manheim.com/orders/purchases/customer/5000000/auction/SCAA/vin/1HGCR2F36GA055512

API Response

{
    "href": "https://intgeration5.api.manheim.com/orders/purchases/customer/5000000/auction/SCAA/vin/2JGCR2F36GA055512",
    "limit": "25",
    "count": 1,
    "items": [
        {
            "href": "https://intgeration5.api.manheim.com/orders/purchases/id/CC202B2F9E77DA0BE164B436680A45DC",
            "purchaseDate": "2021-09-16T13:27:40Z",
            "purchasePrice": 13500,
            "currency": "USD",
            "vehicleStatus": "Available - Arrange gate release",
            "vehicleStatusTs": "2021-09-16T17:28:09.498Z",
            "purchaseApplication": "Simulcast",
            "purchaseSubApplication": "In-Lane",
            "purchaseMethod": "Simulcast",
            "purchaseOfferExists": true,
            "blockTimestamp": "2021-09-16T13:27:40Z",
            "consignment": {
                "unit": {
                    "modelYear": 2016,
                    "make": "HONDA",
                    "model": "ACCOR LX",
                    "vin": "2JGCR2F36GA055512",
                    "trim": "LX",
                    "body": "4DSN",
                    "engineDescription": "4-cylinder Gas",
                    "transmission": "Automatic Transmission",
                    "interiorColor": "Tan",
                    "exteriorColor": "White",
                    "odometerReading": 87803,
                    "odometerUnits": "MILES",
                    "vehicleType": "Vehicle",
                    "physicalLocation": {
                        "href": "https://intgeration5.api.manheim.com/locations/id/RAA",
                        "offsite": true,
                        "locationName": "Manheim Riverside",
                        "locationCode": "RAA",
                        "address": {
                            "address1": "6446 Fremont St",
                            "city": "Riverside",
                            "stateProvinceRegion": "CA",
                            "country": "USA",
                            "postalCode": "92504-1437"
                        }
                    },
                    "lotLocation": {
                        "lotLocationCode": "988",
                        "lotLocationDescription": "VEND OUT-OFFSITE POSTCARD"
                    }
                },
                "workOrderNumber": 4154785,
                "seller": {
                    "dealerName": "JOHN AUTO LLC"
                }
            },
            "offering": {
                "startDate": "2021-09-16T12:43:35Z",
                "endDate": "2021-09-16T12:43:35Z",
                "operatingLocation": {
                    "href": "https://intgeration5.api.manheim.com/locations/id/SCAA",
                    "locationName": "Manheim Southern California",
                    "locationCode": "SCAA"
                },
                "saleKey": {
                    "saleYear": 2021,
                    "saleNumber": 37,
                    "laneNumber": 1,
                    "runNumber": 125
                },
                "offeringApplication": "Simulcast",
                "offerMethod": "AUCTION",
                "registrationDate": "2021-09-15T00:00:00Z",
                "saleType": "WHOLE",
                "bidRestriction": "Open",
                "offeringStatus": "Sold",
                "offeringStatusReason": "Offer Sold",
                "asIs": false,
                "salvage": false,
                "disclosures": [
                    "GUARANTEE",
                    "CAUTION"
                ]
            },
            "buyer": {
                "dealerNumber": "5000000",
                "dealerName": "JILL MOTORS INC",
                "bidderBadge": "1029",
                "rep": {
                    "repNumber": "100000000",
                    "repName": "JEFFERY STEWART"
                }
            },
            "invoice": {
                "href": "https://intgeration5.api.manheim.com/invoices/id/DD28C985629FBEAEE053B537791AC317"
            }
        }
    ]
}

Example Request (Customer ID with optional query parameters)

GET https://intgeration5.api.manheim.com/orders/purchases/customer/5000000?days=1&limit=10

API Response

{
    "href": "https://integration5.api.manheim.com/orders/purchases/customer/5000000?days=1&limit=10",
    "next": "https://integration5.api.manheim.com/orders/purchases/customer/5000000?days=1&limit=10&start=11",
    "limit": "10",
    "count": 10,
    "items": [
        {
            "href": "https://integration5.api.manheim.com/orders/purchases/id/CC20EBDBD0BEDC5CE053B436680A568E",
            "purchaseDate": "2021-09-16T14:58:11Z",
            "purchasePrice": 19500,
            "currency": "USD",
            "vehicleStatus": "Not Ready for Pickup",
            "vehicleStatusTs": "2021-09-16T20:22:32.032Z",
            "purchaseApplication": "Simulcast",
            "purchaseSubApplication": "In-Lane",
            "purchaseMethod": "Simulcast",
            "purchaseOfferExists": true,
            "blockTimestamp": "2021-09-16T13:15:40Z",
            "consignment": {
                "unit": {
                    "modelYear": 2014,
                    "make": "SUBARU",
                    "model": "BRZ LTD",
                    "vin": "K21ZCAC15E9715705",
                    "trim": "LIMITED",
                    "body": "2DCP",
                    "engineDescription": "4-cylinder Gas",
                    "transmission": "Automatic Transmission",
                    "interiorColor": "Blk",
                    "exteriorColor": "White",
                    "odometerReading": 73288,
                    "odometerUnits": "MILES",
                    "vehicleType": "Vehicle",
                    "drivable": true,
                    "grade": 4.1,
                    "physicalLocation": {
                        "href": "https://integration5.api.manheim.com/locations/id/RAA",
                        "offsite": false,
                        "locationName": "Manheim Riverside",
                        "locationCode": "RAA",
                        "address": {
                            "address1": "6446 Fremont St",
                            "city": "Riverside",
                            "stateProvinceRegion": "CA",
                            "country": "USA",
                            "postalCode": "92504-1437"
                        }
                    },
                    "lotLocation": {
                        "lotLocationCode": "950",
                        "lotLocationDescription": "OFFSITE CONDITION REPORT"
                    }
                },
                "workOrderNumber": 3288929,
                "seller": {
                    "dealerName": "JOHN AUTO LLC"
                }
            },
            "offering": {
                "startDate": "2021-09-16T13:15:36Z",
                "endDate": "2021-09-16T13:15:36Z",
                "operatingLocation": {
                    "href": "https://integration5.api.manheim.com/locations/id/RAA",
                    "locationName": "Manheim Riverside",
                    "locationCode": "RAA"
                },
                "saleKey": {
                    "saleYear": 2021,
                    "saleNumber": 37,
                    "laneNumber": 32,
                    "runNumber": 49
                },
                "offeringApplication": "Simulcast",
                "offerMethod": "AUCTION",
                "registrationDate": "2021-09-14T00:00:00Z",
                "saleType": "WHOLE",
                "bidRestriction": "Open",
                "offeringStatus": "Sold",
                "offeringStatusReason": "Offer Sold",
                "asIs": false,
                "salvage": false,
                "disclosures": [
                    "GUARANTEE"
                ]
            },
            "buyer": {
                "dealerNumber": "5000000",
                "dealerName": "JILL MOTORS INC",
                "bidderBadge": "339",
                "rep": {
                    "repNumber": "100000000",
                    "repName": "JEFFERY STEWART"
                }
            },
            "invoice": {
                "href": "https://integration5.api.manheim.com/invoices/id/CC17C98EEEB3BE9CE053B537791A8BDE"
            }
        },
        {
            "href": "https://integration5.api.manheim.com/orders/purchases/id/CC202B2F9E77DA0BE053B447790A34DC",
            "purchaseDate": "2021-09-16T13:27:40Z",
            "purchasePrice": 13500,
            "currency": "USD",
            "vehicleStatus": "Available - Arrange gate release",
            "vehicleStatusTs": "2021-09-16T17:28:09.498Z",
            "purchaseApplication": "Simulcast",
            "purchaseSubApplication": "In-Lane",
            "purchaseMethod": "Simulcast",
            "purchaseOfferExists": true,
            "blockTimestamp": "2021-09-16T13:27:40Z",
            "consignment": {
                "unit": {
                    "modelYear": 2016,
                    "make": "HONDA",
                    "model": "ACCOR LX",
                    "vin": "2JGCR2F36GA165512",
                    "trim": "LX",
                    "body": "4DSN",
                    "engineDescription": "4-cylinder Gas",
                    "transmission": "Automatic Transmission",
                    "interiorColor": "Tan",
                    "exteriorColor": "White",
                    "odometerReading": 87803,
                    "odometerUnits": "MILES",
                    "vehicleType": "Vehicle",
                    "physicalLocation": {
                        "href": "https://integration5.api.manheim.com/locations/id/RAA",
                        "offsite": true,
                        "locationName": "Manheim Riverside",
                        "locationCode": "RAA",
                        "address": {
                            "address1": "6446 Fremont St",
                            "city": "Riverside",
                            "stateProvinceRegion": "CA",
                            "country": "USA",
                            "postalCode": "92504-1437"
                        }
                    },
                    "lotLocation": {
                        "lotLocationCode": "988",
                        "lotLocationDescription": "VEND OUT-OFFSITE POSTCARD"
                    }
                },
                "workOrderNumber": 4154674,
	    …………………
	    …………………
	    …………………
	    …………………
        },
        {
            "href": "https://integration5.api.manheim.com/orders/purchases/id/CC20E33B62A667A3E053B437792A802C",
            "purchaseDate": "2021-09-16T13:25:48Z",
            "purchasePrice": 17800,
            "currency": "USD",
            "vehicleStatus": "Available - Arrange gate release",
	        …………………
	        …………………
	        …………………
	        …………………
        }    
    ]
}

/purchases ​

Purchases ​

URLs and Environments ​

Authentication & Authorization ​

1. Retrieve Manheim Buyer Customer’s purchases by Customer ID ​

Endpoint ​

Description ​

2. Retrieve Manheim Buyer Customer’s purchases by Customer ID, Auction and VIN ​

Endpoint ​

Description ​

3. Retrieve Manheim Buyer Customer’s purchases by Customer ID, Auction and Sale Key ​

Endpoint ​

Description ​

4. Retrieve Manheim Buyer Customer’s purchases by purchase ID ​

Endpoint ​

Description ​

Common Return Codes ​

Request Parameters ​

Sample Requests ​

More Examples ​

Response Details ​

Paging through the response ​

Items Section Details ​

Error response ​

Example Request (Customer ID, Auction, VIN) ​

Example Request (Customer ID with optional query parameters) ​

/purchases

Purchases

URLs and Environments

Authentication & Authorization

1. Retrieve Manheim Buyer Customer’s purchases by Customer ID

Endpoint

Description

2. Retrieve Manheim Buyer Customer’s purchases by Customer ID, Auction and VIN

Endpoint

Description

3. Retrieve Manheim Buyer Customer’s purchases by Customer ID, Auction and Sale Key

Endpoint

Description

4. Retrieve Manheim Buyer Customer’s purchases by purchase ID

Endpoint

Description

Common Return Codes

Request Parameters

Sample Requests

More Examples

Response Details

Paging through the response

Items Section Details

Error response

Example Request (Customer ID, Auction, VIN)

Example Request (Customer ID with optional query parameters)