# PurchasePathRequest

extends [Object](https://d.android.com/reference/java/lang/Object.html)

## Class Overview

A Purchase Path request defines the parameters for a Purchase Path fetch.

##### See Also

- `PurchasePathInterface`

## Summary

| Public Constructors |
| --- |
| [PurchasePathRequest](https://building.usebutton.com/button-android/latest/reference/com/usebutton/sdk/purchasepath/PurchasePathRequest.html#PurchasePathRequest(java.lang.String))( [String](https://d.android.com/reference/java/lang/String.html) url)<br> <br> <br>Creates a new Purchase Path request with the given url. |

| Public Methods |
| --- |
| [String](https://d.android.com/reference/java/lang/String.html) | [getOfferId](https://building.usebutton.com/button-android/latest/reference/com/usebutton/sdk/purchasepath/PurchasePathRequest.html#getOfferId())()<br> <br> <br>The Button-provided identifier for the offer backing this Purchase Path request. |
| [String](https://d.android.com/reference/java/lang/String.html) | [getPlacementId](https://building.usebutton.com/button-android/latest/reference/com/usebutton/sdk/purchasepath/PurchasePathRequest.html#getPlacementId())()<br> <br> <br>An optional description of the instance of a button that triggers this request. |
| [String](https://d.android.com/reference/java/lang/String.html) | [getPubRef](https://building.usebutton.com/button-android/latest/reference/com/usebutton/sdk/purchasepath/PurchasePathRequest.html#getPubRef())()<br> <br> <br>An optional token to be associated with all downstream orders, transactions and webhooks. |
| [String](https://d.android.com/reference/java/lang/String.html) | [getUrl](https://building.usebutton.com/button-android/latest/reference/com/usebutton/sdk/purchasepath/PurchasePathRequest.html#getUrl())()<br> <br> <br>A merchant URL to a product, category or just the homepage. |
| void | [setOfferId](https://building.usebutton.com/button-android/latest/reference/com/usebutton/sdk/purchasepath/PurchasePathRequest.html#setOfferId(java.lang.String))( [String](https://d.android.com/reference/java/lang/String.html) offerId) |
| void | [setPlacementId](https://building.usebutton.com/button-android/latest/reference/com/usebutton/sdk/purchasepath/PurchasePathRequest.html#setPlacementId(java.lang.String))( [String](https://d.android.com/reference/java/lang/String.html) placementId) |
| void | [setPubRef](https://building.usebutton.com/button-android/latest/reference/com/usebutton/sdk/purchasepath/PurchasePathRequest.html#setPubRef(java.lang.String))( [String](https://d.android.com/reference/java/lang/String.html) pubRef) |

| [Expand] | Inherited Methods |
| --- |
| From class
[java.lang.Object](https://d.android.com/reference/java/lang/Object.html)

## Public Constructors

#### public             PurchasePathRequest( [String](https://d.android.com/reference/java/lang/String.html) url)

Creates a new Purchase Path request with the given url.

##### Parameters

| url | the merchant url. |

## Public Methods

#### public           [String](https://d.android.com/reference/java/lang/String.html)getOfferId()

The Button-provided identifier for the offer backing this Purchase Path request.

#### public           [String](https://d.android.com/reference/java/lang/String.html)getPlacementId()

An optional description of the instance of a button that triggers this request.

#### public           [String](https://d.android.com/reference/java/lang/String.html)getPubRef()

An optional token to be associated with all downstream orders, transactions and webhooks.
(Max 100 chars.)

#### public           [String](https://d.android.com/reference/java/lang/String.html)getUrl()

A merchant URL to a product, category or just the homepage.

#### public           void  setOfferId( [String](https://d.android.com/reference/java/lang/String.html) offerId)
#### public           void  setPlacementId( [String](https://d.android.com/reference/java/lang/String.html) placementId)
#### public           void  setPubRef( [String](https://d.android.com/reference/java/lang/String.html) pubRef)
