A product is an individual purchased item(s). Product also relates to a Shipment thus allowing part shipment.
Property | Description | Required | Data Type |
---|---|---|---|
product_id | A unique identifier of the Product. | True | String |
name | The name/title of the product | False | String |
imageurl | The Image URL of the product | False | String |
quantity | The quantity of this product purchased. | False | Integer |
price | The price of the item before discounts have been applied. | False | Decimal |
tax | The tax applied to the product (must be positive). | False | Decimal |
shipment_id | A reference to the shipment object. | True | String |
color | Color of the Product (Optional). | False | String |
size | Size of the Product (Optional). | False | String |
brand | Brand of the Product (Optional). | False | String |
category | Category in the which the product resides in (Optional). | False | String |
OrderLineReference | Unique identifier to link the InvoiceLine to the ProductLine (if passing an Invoice) | False | String |
Tags | Product Tags. | False | String |
custom_1 | A Custom Field for additional data. | False | String |
custom_2 | A Custom Field for additional data. | False | String |
custom_3 | A Custom Field for additional data. | False | String |
custom_4 | A Custom Field for additional data. | False | String |
custom_5 | A Custom Field for additional data. | False | String |
custom_6 | A Custom Field for additional data. | False | String |
custom_7 | A Custom Field for additional data. | False | String |
custom_8 | A Custom Field for additional data. | False | String |
custom_9 | A Custom Field for additional data. | False | String |
custom_10 | A Custom Field for additional data. | False | String |
custom_11 | A Custom Field for additional data. | False | String |
custom_12 | A Custom Field for additional data. | False | String |
custom_13 | A Custom Field for additional data. | False | String |
custom_14 | A Custom Field for additional data. | False | String |
custom_15 | A Custom Field for additional data. | False | String |
custom_16 | A Custom Field for additional data. | False | String |
custom_17 | A Custom Field for additional data. | False | String |
custom_18 | A Custom Field for additional data. | False | String |
custom_19 | A Custom Field for additional data. | False | String |
custom_20 | A Custom Field for additional data. | False | String |