ArticleStockLocations |
Search
Catalog: Robaws
Schema: Articles
This is a read-only table function. The Robaws API may not support changing the data or the Invantive SQL driver for Robaws does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Robaws API.
Select Robaws API URL: /api/v2/articles
Insert Robaws API URL: /api/v2/articles
Update Robaws API URL: /api/v2/articles
Delete Robaws API URL: /api/v2/articles
Field Selection Method: NotRequired
Base Path: items[*].stockLocations[*]
Select Robaws API Operation: get /api/v2/articles
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function ArticleStockLocations. 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 treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `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 |
---|---|---|---|---|
articleNumber |
string |
☐ |
|
|
barcode |
string |
☐ |
|
|
name |
string |
☐ |
|
|
searchText |
string |
☐ |
|
|
sort |
string |
☐ |
|
|
stockArticle |
boolean |
☐ |
|
|
updatedFrom |
datetime |
☐ |
|
|
Table Function Columns
The columns of the table function ArticleStockLocations are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
archivedAt_1 |
datetime |
|
☐ |
|
archivedAt |
datetime |
|
☐ |
|
articleGroupId |
string |
|
☐ |
|
articleId |
string |
|
☐ |
|
articleNumber |
string |
Article Number |
☐ |
|
availableStock |
decimal |
|
☐ |
This property should be used by third parties (for example webshops) that want to know how much stockis available for sale.When reading, only present if requested via 'include' query parameter, otherwise null. |
barcode |
string |
Bar Code |
☐ |
|
brand |
string |
Brand |
☐ |
|
costPrice |
decimal |
Cost Price |
☐ |
|
costPriceStrategy |
string |
|
☐ |
|
createdAt_1 |
datetime |
|
☐ |
|
createdAt |
datetime |
|
☐ |
|
deletedAt_1 |
datetime |
|
☐ |
|
deletedAt |
datetime |
|
☐ |
|
description |
string |
Description |
☐ |
|
group_archivedAt |
datetime |
|
☐ |
|
group_createdAt |
datetime |
|
☐ |
|
group_deletedAt |
datetime |
|
☐ |
|
group_id |
string |
|
☐ |
|
group_image_archivedAt |
datetime |
|
☐ |
|
group_image_contentType |
string |
|
☐ |
|
group_image_createdAt |
datetime |
|
☐ |
|
group_image_deletedAt |
datetime |
|
☐ |
|
group_image_directory |
boolean |
|
☐ |
|
group_image_id |
string |
|
☐ |
|
group_image_name |
string |
|
☐ |
|
group_image_parentId |
string |
|
☐ |
|
group_image_previewUrl |
string |
|
☐ |
|
group_image_size |
int64 |
|
☐ |
|
group_image_updatedAt |
datetime |
|
☐ |
|
group_image_url |
string |
|
☐ |
|
group_name |
string |
|
☐ |
|
group_parentId |
string |
|
☐ |
|
group_updatedAt |
datetime |
|
☐ |
|
id_1 |
string |
|
☐ |
|
id |
string |
ID |
☐ |
|
image_archivedAt |
datetime |
|
☐ |
|
image_contentType |
string |
|
☐ |
|
image_createdAt |
datetime |
|
☐ |
|
image_deletedAt |
datetime |
|
☐ |
|
image_directory |
boolean |
|
☐ |
|
image_id |
string |
|
☐ |
|
image_name |
string |
|
☐ |
|
image_parentId |
string |
|
☐ |
|
image_previewUrl |
string |
|
☐ |
|
image_size |
int64 |
|
☐ |
|
image_updatedAt |
datetime |
|
☐ |
|
image_url |
string |
|
☐ |
|
name |
string |
Name |
☐ |
|
saleName |
string |
|
☐ |
|
salePrice |
decimal |
Sales Price |
☐ |
|
salePriceStrategy |
string |
|
☐ |
|
stock |
decimal |
|
☐ |
|
stockArticle |
boolean |
|
☐ |
|
stockLocation_archivedAt |
datetime |
|
☐ |
|
stockLocation_createdAt |
datetime |
|
☐ |
|
stockLocation_deletedAt |
datetime |
|
☐ |
|
stockLocation_id |
string |
Stock Location ID |
☐ |
|
stockLocation_name |
string |
Stock Location Name |
☐ |
|
stockLocation_updatedAt |
datetime |
|
☐ |
|
stockLocationId |
string |
|
☐ |
|
stockPlace |
string |
|
☐ |
|
timeOperation |
boolean |
Time Operation |
☐ |
|
totalStock |
decimal |
|
☐ |
When reading, only present if requested via 'include' query parameter, otherwise null. |
unitType |
string |
Unit Type |
☐ |
|
updatedAt_1 |
datetime |
|
☐ |
|
updatedAt |
datetime |
|
☐ |
|
vatTariffId |
string |
|
☐ |
|
17-06-2022 11:59 Version 22.1.46-BETA+3385