ProductAvailabilitiesByDate: Roller Product Availabilities by Date |
Catalog: Roller
Schema: Data
Label: Product Availabilities by Date
This is a read-only table function. The Roller API may not support changing the data or the Invantive SQL driver for Roller does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Roller API.
Select Roller API URL: product-availability
Insert Roller API URL: product-availability
Update Roller API URL: product-availability
Delete Roller API URL: product-availability
Field Selection Method: NotRequired
Base Path: availabilities[*]
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function ProductAvailabilitiesByDate. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
---|---|---|---|---|
Date |
datetime |
☑ |
|
The date you need availabilty for. |
ProductCategory |
string |
☐ |
|
Finds product/availability for a given product category. |
ProductIds |
string |
☐ |
|
Comma separated product IDs. |
Columns of Table Function
The columns of the table function ProductAvailabilitiesByDate are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
date |
datetime |
|
☑ |
Availability date. |
onlineSalesOpen |
boolean |
|
☑ |
Indicator of whether the product is within it's sale period. |
productavailability_description |
string(150) |
|
☐ |
Brief description of product. |
productavailability_id |
string |
|
☑ |
Product Id. |
productavailability_imageUrl |
string |
|
☐ |
Product image. |
productavailability_name |
string |
|
☑ |
Name. |
productavailability_type |
string |
|
☑ |
Product type. |
22-09-2022 21:51 Version 22.0.355-PROD+3587