EndPoint List All Products
Name
get_products
Description
Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
[Read more]
Parameters
| Parameter |
Label |
Required |
Options |
Description |
| active |
Active |
NO |
| Option |
Value |
| True |
True |
| False |
False |
|
Only return products that are active or inactive (e.g., pass false to list all inactive products).
|
| created_gt |
Created later than (yyyy-MM-dd) |
NO |
| Option |
Value |
| today |
today |
| yesterday |
yesterday |
| monthstart |
monthstart |
| monthend |
monthend |
| yearstart |
yearstart |
| yearend |
yearend |
| weekstart |
weekstart |
| weekend |
weekend |
| yearstart-1y |
yearstart-1y |
| yearend-1y |
yearend-1y |
| monthstart-1d |
monthstart-1d |
| monthend+1d |
monthend+1d |
| 2022-01-31 |
2022-01-31 |
| 2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Return results where the created field is greater than this value.
|
| created_gte |
Created on or later than (yyyy-MM-dd) |
NO |
| Option |
Value |
| today |
today |
| yesterday |
yesterday |
| monthstart |
monthstart |
| monthend |
monthend |
| yearstart |
yearstart |
| yearend |
yearend |
| weekstart |
weekstart |
| weekend |
weekend |
| yearstart-1y |
yearstart-1y |
| yearend-1y |
yearend-1y |
| monthstart-1d |
monthstart-1d |
| monthend+1d |
monthend+1d |
| 2022-01-31 |
2022-01-31 |
| 2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Return results where the created field is greater than or equal to this value.
|
| created_lt |
Created earlier than (yyyy-MM-dd) |
NO |
| Option |
Value |
| today |
today |
| yesterday |
yesterday |
| monthstart |
monthstart |
| monthend |
monthend |
| yearstart |
yearstart |
| yearend |
yearend |
| weekstart |
weekstart |
| weekend |
weekend |
| yearstart-1y |
yearstart-1y |
| yearend-1y |
yearend-1y |
| monthstart-1d |
monthstart-1d |
| monthend+1d |
monthend+1d |
| 2022-01-31 |
2022-01-31 |
| 2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Return results where the created field is less than this value.
|
| created_lte |
Created on or earlier than (yyyy-MM-dd) |
NO |
| Option |
Value |
| today |
today |
| yesterday |
yesterday |
| monthstart |
monthstart |
| monthend |
monthend |
| yearstart |
yearstart |
| yearend |
yearend |
| weekstart |
weekstart |
| weekend |
weekend |
| yearstart-1y |
yearstart-1y |
| yearend-1y |
yearend-1y |
| monthstart-1d |
monthstart-1d |
| monthend+1d |
monthend+1d |
| 2022-01-31 |
2022-01-31 |
| 2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Return results where the created field is less than or equal to this value.
|
Output Columns
| Name |
DataType |
Length |
Raw |
Description |
| Id |
DT_WSTR |
100 |
False |
|
| Name |
DT_WSTR |
100 |
False |
|
| Caption |
DT_WSTR |
4000 |
False |
|
| Description |
DT_WSTR |
4000 |
False |
|
| Active |
DT_BOOL |
0 |
False |
|
| Created |
DT_DBTIMESTAMP |
0 |
False |
|
| Updated |
DT_DBTIMESTAMP |
0 |
False |
|
| Type |
DT_WSTR |
100 |
False |
|
| Object |
DT_WSTR |
100 |
False |
|
| Attributes |
DT_WSTR |
2000 |
False |
|
| LiveMode |
DT_BOOL |
0 |
False |
|
| StatementDescription |
DT_WSTR |
4000 |
False |
|
| UnitLabel |
DT_WSTR |
4000 |
False |
|
| PackageDimensionsHeight |
DT_WSTR |
4000 |
False |
|
| PackageDimensionsLength |
DT_WSTR |
4000 |
False |
|
| PackageDimensionsWidth |
DT_WSTR |
4000 |
False |
|
| PackageDimensionsWeight |
DT_WSTR |
4000 |
False |
|
| URL |
DT_WSTR |
4000 |
False |
|
| Images |
DT_WSTR |
2000 |
False |
|
| TaxCodeId |
DT_WSTR |
4000 |
False |
|
| TaxCodeName |
DT_WSTR |
4000 |
False |
|
| PriceUnitAmount |
DT_I8 |
0 |
False |
|
| PriceRecurringInterval |
DT_WSTR |
4000 |
False |
|
| PriceRecurringIntervalCount |
DT_I4 |
0 |
False |
|
| PriceRecurringUsageType |
DT_WSTR |
4000 |
False |
|
| Shippable |
DT_WSTR |
4000 |
False |
|
| DeactivatedOn |
DT_DBTIMESTAMP |
0 |
False |
|
Input Columns
| Name |
DataType |
Length |
Raw |
Description |
| There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. |
