Query Purchase Deals

get

/purchase-deals/

Query purchase deals

Resource Details

Security

Category

Query

Request

Path Parameters

Parameter Type Description Required

Query Parameters

Parameter Type Description Required
firstname string The first name of the customer to filter the results by No
lastname string The last name of the customer to filter the results by No
postalCode string The postal code of the customer to filter the results by No
inventoryVehicleId string The vehicle identification number (VIN). No
customerId string The customer identifier of the customer buying the vehicle to filter the results by No

Header Parameters

Parameter Type Description Required
Accept string Advertises which content types, expressed as MIME types, the client is able to understand No
Accept-Charset string Advertises which character set the client is able to understand. Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice within the Content-Type response header No
Accept-Language string Advertises which languages the client is able to understand, and which locale variant is preferred No
Prefer string Advertises whether the whole entity should be returned or a minimal subset of the entity should be returned, typically entity IDs No
Request-Id string A correlation ID that should be returned back to the caller to indicate the return of the given request No
Subscription-Id string The Fortellis Marketplace subscription identifier between a user entity and the solution. For sample responses use the Subscription-Id 'test'. Yes
Authorization string Provide authorization to access Fortellis APIs. This must be an OAuth 2.0 token for calling a Fortellis Provider but you may call the simulator platform with basic auth using your API key and secret. Yes

Request Body Structure

Expand All
Collapse All

Request Body Example

Response

Response Body Structure

Expand All
Collapse All

Response Body Example

Response Error Details

HTTP Code Description
400 Bad Request
401 Unauthorized
403 Not Found
404 Not Found

Try It Out

  • firstname

    (string) The first name of the customer to filter the results by

  • lastname

    (string) The last name of the customer to filter the results by

  • postalCode

    (string) The postal code of the customer to filter the results by

  • inventoryVehicleId

    (string) The vehicle identification number (VIN).

  • customerId

    (string) The customer identifier of the customer buying the vehicle to filter the results by

  • Accept

    (string) Advertises which content types, expressed as MIME types, the client is able to understand

  • Accept-Charset

    (string) Advertises which character set the client is able to understand. Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice within the Content-Type response header

  • Accept-Language

    (string) Advertises which languages the client is able to understand, and which locale variant is preferred

  • Prefer

    (string) Advertises whether the whole entity should be returned or a minimal subset of the entity should be returned, typically entity IDs

  • Request-Id

    (string) A correlation ID that should be returned back to the caller to indicate the return of the given request

  • Subscription-Id
    (required)

    (string) The Fortellis Marketplace subscription identifier between a user entity and the solution. For sample responses use the Subscription-Id 'test'.

  • Authorization
    (required)

    (string) Provide authorization to access Fortellis APIs. This must be an OAuth 2.0 token for calling a Fortellis Provider but you may call the simulator platform with basic auth using your API key and secret.

Reset

Make a request and see the request.

Make a request and see the response.

Make a request and see the cURL.

Working...

x