Articles

Articles are the identities of physical goods stored at the warehouse.

Schema: Article

Property	Type	Description
id	ObjectId	Unique identifier
name	String	Article name
sku	String	Stock keeping unit
barcodes	Array	Array of barcodes that identifies the article (EAN etc)
weight	Integer	Articles weight in grams
client	ObjectId	Client identifier
control.expiration	Boolean	True if article uses expiration date markings
control.batch	Boolean	True if article uses batch numbers
control.serial	Boolean	True if article uses serial numbers
control.refrigeration	Boolean	True if article needs to be stored refrigerated numbers
harmonized_system_code	String	The article harmonized system code
customs.value	Integer	Sales value of article (in cents)
customs.currency	String	Currency code (ISO 4217)
united_nations_numbers	Array	UN numbers identifying hazardous materials
manufacturing_country	String	Country of origin (ISO 3166-1 Alpha-3)
created	Date	Time when the article was created
updated	Date	Time when the article was last modified

Get a list of articles

If you want to retrieve a list of articles, use this GET request:

GET https://api.tirix.io/articles

Get an article

If you want to fetch an individual article, use this GET request:

GET https://api.tirix.io/articles/{article_id}

Create a new article

If you want to create a new article, use this POST request:

POST https://api.tirix.io/articles

Modify an article

If you want to modify a specific article, use this PUT request:

PUT https://api.tirix.io/articles/{article_id}

Delete an article

Articles are persistent and can not be irreversibly deleted.

Edges

Stock

If you want to fetch stock information for an individual article, use this GET request:

GET https://api.tirix.io/articles/{article_id}/stock