invantive documentation
Invantive Support ForumsLog In / Sign Up

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
articleNumber ``
barcode ``
installation ``
name ``
searchText ``
sort ``
updatedFrom ``
withArchived ``

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
activityId varchar2 Activity ID filters on the platform, writable, activityId
archivedAt datetime Archived at filters on the platform, writable, archivedAt
articleGroupId varchar2 Article Group ID filters on the platform, writable, articleGroupId
articleNumber varchar2 Article Number filters on the platform, writable, articleNumber
availableStock decimal Available Stock filters on the platform, writable, availableStock
backorderStock decimal Back-order Stock filters on the platform, writable, backorderStock
barcode varchar2 Bar Code filters on the platform, writable, barcode
brand varchar2 Brand filters on the platform, writable, brand
calculationType varchar2 Calculation Type filters on the platform, writable, calculationType
costPrice decimal Cost Price filters on the platform, writable, costPrice 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.
costPriceStrategy varchar2 Cost Price Strategy filters on the platform, writable, costPriceStrategy
createdAt datetime Created at filters on the platform, writable, createdAt
deletedAt datetime Deleted at filters on the platform, writable, deletedAt
description varchar2 Description filters on the platform, writable, description
descriptionTranslations varchar2 Description Translations writable The JSON text of the nested object.
extraFields varchar2 Extra Fields writable The JSON text of the nested object.
headerLevel varchar2 Header Level filters on the platform, writable, headerLevel
hourTypeId varchar2 Hour Type ID filters on the platform, writable, hourTypeId
id varchar2 ID filters on the platform, writable, id
imageId varchar2 Image ID filters on the platform, writable, imageId
installation char Installation filters on the platform, writable, installation
internalImage char Internal Image filters on the platform, writable, internalImage
libraryType varchar2 Library Type filters on the platform, writable, libraryType
lineType varchar2 Line Type filters on the platform, writable, lineType
lockedAt datetime Locked at filters on the platform, writable, lockedAt
margin decimal Margin filters on the platform, writable, margin
minimumSaleAmount decimal Minimum Sales Amount filters on the platform, writable, minimumSaleAmount
minimumStock decimal Minimum Stock filters on the platform, writable, minimumStock
name varchar2 Name filters on the platform, writable, name
nameTranslations varchar2 Name Translations writable The JSON text of the nested object.
projectSupplyRouteId varchar2 Project Supply Route ID filters on the platform, writable, projectSupplyRouteId
purchaseGLAccountId varchar2 Purchase GL Account ID filters on the platform, writable, purchaseGLAccountId
reservedStock decimal Reserved Stock filters on the platform, writable, reservedStock
saleName varchar2 Sale Name filters on the platform, writable, saleName
salePrice decimal Sales Price filters on the platform, writable, salePrice
salePriceStrategy varchar2 Sales Price Strategy filters on the platform, writable, salePriceStrategy
salesGLAccountId varchar2 Sales GL Account ID filters on the platform, writable, salesGLAccountId
stockArticle char Stock Article filters on the platform, writable, stockArticle
stockPlace varchar2 Stock Place filters on the platform, writable, stockPlace
targetStock decimal Target Stock filters on the platform, writable, targetStock
timeOperation char Time Operation filters on the platform, writable, timeOperation
totalStock decimal Total Stock filters on the platform, writable, totalStock This property is a sum of available and backorder stock.
type varchar2 Type filters on the platform, writable, type
unitType varchar2 Unit Type filters on the platform, writable, unitType
updatedAt datetime Updated at filters on the platform, writable, updatedAt
vatTariffId varchar2 VAT Tariff ID filters on the platform, writable, vatTariffId
wappy char Wappy filters on the platform, writable, wappy
weightKg double Weight (kg) filters on the platform, writable, weightKg

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: