invantive documentation
Invantive Support ForumsLog In / Sign Up

ArticleSuppliers: Robaws Article Suppliers

read only REST

  • Catalog: Robaws
  • Schema: ArticleSuppliers
  • Label: Article Suppliers

Search

Can only retrieve data.

API Source

  • Endpoint: /api/v2/article-suppliers
  • Operation: get /api/v2/article-suppliers

Performance Characteristics

Characteristic Value
Average access latency (ms) 447
Full scan rows per minute 12,026
Point query rows per minute 1,324
Write rows per minute 539

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
articleId ``
searchText ``
sort ``
supplierId ``
updatedFrom ``
withArchived ``

Table Columns

The columns of the table ArticleSuppliers 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
amountPerUnit decimal Amount per Unit filters on the platform, writable, amountPerUnit
archivedAt datetime Archived at filters on the platform, writable, archivedAt
articleId varchar2 Article ID filters on the platform, writable, articleId The article the supplier belongs to. Read-only: a supplier moves with its article
createdAt datetime Created at filters on the platform, writable, createdAt
date datetime Date filters on the platform, writable, date
deletedAt datetime Deleted at filters on the platform, writable, deletedAt
extraField1 varchar2 Extra Field 1 filters on the platform, writable, extraField1
extraField2 varchar2 Extra Field 2 filters on the platform, writable, extraField2
extraField3 varchar2 Extra Field 3 filters on the platform, writable, extraField3
extraFields varchar2 Extra Fields writable The JSON text of the nested object.
grossPrice decimal Gross Price filters on the platform, writable, grossPrice
id varchar2 ID filters on the platform, writable, id
lockedAt datetime Locked at filters on the platform, writable, lockedAt
minimumPurchaseAmount decimal Minimum Purchase Amount filters on the platform, writable, minimumPurchaseAmount
price decimal Price filters on the platform, writable, price
reference varchar2 Reference filters on the platform, writable, reference
supplierId varchar2 Supplier ID filters on the platform, writable, supplierId
unitType varchar2 Unit Type filters on the platform, writable, unitType
updatedAt datetime Updated at filters on the platform, writable, updatedAt

Keys

Key Column Refers to Kind Description
ArticleSuppliers_supplierId_txt supplierId Suppliers.id Textual The referenced row, for as long as Robaws still lists it: a deleted or purged row is no longer listed, and a document may keep referring to it.

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: