Articles: Robaws Articles
insert update delete REST
- Catalog:
Robaws - Schema:
Articles - Primary Keys:
id - Label: Articles
Search
Can retrieve data and change data using insert, update and delete.
API Source
- Endpoint:
/api/v2/articles - Operation:
get /api/v2/articles
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 258 |
| Full scan rows per minute | 9,962 |
| Point query rows per minute | 674 |
| Write rows per minute | 539 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
article |
`` | |||
barcode |
`` | |||
installation |
`` | |||
name |
`` | |||
search |
`` | |||
sort |
`` | |||
updated |
`` | |||
with |
`` |
Table Columns
The columns of the table Articles are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
activity |
varchar2 |
Activity ID | filters on the platform, writable, activity |
||
archived |
datetime |
Archived at | filters on the platform, writable, archived |
||
article |
varchar2 |
Article Group ID | filters on the platform, writable, article |
||
article |
varchar2 |
Article Number | filters on the platform, writable, article |
||
available |
decimal |
Available Stock | filters on the platform, writable, available |
||
backorder |
decimal |
Back-order Stock | filters on the platform, writable, backorder |
||
barcode |
varchar2 |
Bar Code | filters on the platform, writable, barcode |
||
brand |
varchar2 |
Brand | filters on the platform, writable, brand |
||
calculation |
varchar2 |
Calculation Type | filters on the platform, writable, calculation |
||
cost |
decimal |
Cost Price | filters on the platform, writable, cost |
Stored cost price. It is recalculated whenever the article prices are recalculated: from the supplier purchase prices or the composite articles, according to the cost price strategy. Only an article that is not composite and has the FIXED_PRICE strategy keeps a cost price that was set directly. | |
cost |
varchar2 |
Cost Price Strategy | filters on the platform, writable, cost |
||
created |
datetime |
Created at | filters on the platform, writable, created |
||
deleted |
datetime |
Deleted at | filters on the platform, writable, deleted |
||
description |
varchar2 |
Description | filters on the platform, writable, description |
||
description |
varchar2 |
Description Translations | writable | The JSON text of the nested object. | |
extra |
varchar2 |
Extra Fields | writable | The JSON text of the nested object. | |
header |
varchar2 |
Header Level | filters on the platform, writable, header |
||
hour |
varchar2 |
Hour Type ID | filters on the platform, writable, hour |
||
id |
varchar2 |
ID | filters on the platform, writable, id |
||
image |
varchar2 |
Image ID | filters on the platform, writable, image |
||
installation |
char |
Installation | filters on the platform, writable, installation |
||
internal |
char |
Internal Image | filters on the platform, writable, internal |
||
library |
varchar2 |
Library Type | filters on the platform, writable, library |
||
line |
varchar2 |
Line Type | filters on the platform, writable, line |
||
locked |
datetime |
Locked at | filters on the platform, writable, locked |
||
margin |
decimal |
Margin | filters on the platform, writable, margin |
||
minimum |
decimal |
Minimum Sales Amount | filters on the platform, writable, minimum |
||
minimum |
decimal |
Minimum Stock | filters on the platform, writable, minimum |
||
name |
varchar2 |
Name | filters on the platform, writable, name |
||
name |
varchar2 |
Name Translations | writable | The JSON text of the nested object. | |
project |
varchar2 |
Project Supply Route ID | filters on the platform, writable, project |
||
purchase |
varchar2 |
Purchase GL Account ID | filters on the platform, writable, purchase |
||
reserved |
decimal |
Reserved Stock | filters on the platform, writable, reserved |
||
sale |
varchar2 |
Sale Name | filters on the platform, writable, sale |
||
sale |
decimal |
Sales Price | filters on the platform, writable, sale |
||
sale |
varchar2 |
Sales Price Strategy | filters on the platform, writable, sale |
||
sales |
varchar2 |
Sales GL Account ID | filters on the platform, writable, sales |
||
stock |
char |
Stock Article | filters on the platform, writable, stock |
||
stock |
varchar2 |
Stock Place | filters on the platform, writable, stock |
||
target |
decimal |
Target Stock | filters on the platform, writable, target |
||
time |
char |
Time Operation | filters on the platform, writable, time |
||
total |
decimal |
Total Stock | filters on the platform, writable, total |
This property is a sum of available and backorder stock. | |
type |
varchar2 |
Type | filters on the platform, writable, type |
||
unit |
varchar2 |
Unit Type | filters on the platform, writable, unit |
||
updated |
datetime |
Updated at | filters on the platform, writable, updated |
||
vat |
varchar2 |
VAT Tariff ID | filters on the platform, writable, vat |
||
wappy |
char |
Wappy | filters on the platform, writable, wappy |
||
weight |
double |
Weight (kg) | filters on the platform, writable, weight |
Sample Queries
select art.articleNumber
, art.name
, art.availableStock
, art.minimumStock
from Robaws.Articles.Articles art
where art.stockArticle = true
and art.availableStock < art.minimumStock
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: