Description
The ProductApproval object contains information about any approvals an Account has to purchase restricted Products.
ℹ️ Note
This object supports custom data via the data attribute.
Attributes
| Attribute | Type | Description |
|---|---|---|
account |
Account | Returns the Account that this approval belongs to |
approval_status |
String | Returns the approval status of the current customer for this Product. One of: approved, completed, expired, pending, or none. |
approved_from |
Timestamp | Returns the timestamp that the approval starts |
approved_quantity |
Number | Returns the maximum quantity that can be purchased using this approval |
approved_until |
Timestamp | Returns the timestamp that the approval ends |
id |
String | Returns the unique id for this ProductApproval |
order_items |
List[OrderItem] | Returns a list of OrderItems that were purchased with this approval |
path |
String | Returns the url path for this approval |
pending_quantity |
Number | Returns the quantity that has already been purchased via a submitted Order |
product |
Product | Returns the product that this approval is for |
product_category |
ProductCategory | Returns the product category that this approval is for |
purchased_quantity |
Number | Returns the quantity that has already been purchased with a completed Order |
remaining_quantity |
Number | Returns the unused quantity that can still be purchased |
unlimited? |
Boolean | Returns true if the quantity is unlimited for this ProductApproval |
url |
String | Returns the complete url for this ProductApproval |