Create a catalogue item
Header Parameters
Path Parameters
Company ID. Must be one of the IDs returned by GET /api/v2/companies/.
Body Parameters
Locale-keyed names, e.g. {"en": "Printer paper", "de": "Druckerpapier"}. en is required. It is the name the list sorts on and the key the bulk upsert falls back to. Two live rows of the same company may not share a name in any locale.
Show child attributes
Barcode number of the item. Unique across all of Hivebuy.
Unit of measure, e.g. pc, kg, l.
Article number of the item.
Ids of the catalogues the item belongs to.
Show child attributes
Supplier the item is bought from. Must belong to this company.
Contract the item is covered by.
Free-text supplier name, for items with no supplier record.
Smallest quantity that can be ordered. Decimal string. A JSON number is accepted on input and comes back as a string.
Quantity increment. Decimal string. A JSON number is accepted on input and comes back as a string.
Article number in your own system.
How often the item is reordered. Written inline with the item. Include the id on update to change the existing row instead of replacing it.
Show child attributes
Show child attributes
Category id. Must belong to this company.
Tag ids.
Show child attributes
The variants of this item. At least one is required. Variants missing from the payload are removed from the item.
Show child attributes
Response
Created. The body is the read shape.
Response Attributes
Locale-keyed names, e.g. {"en": "Printer paper", "de": "Druckerpapier"}. en is required. It is the name the list sorts on and the key the bulk upsert falls back to. Two live rows of the same company may not share a name in any locale.
Show child attributes
Barcode number of the item. Unique across all of Hivebuy.
Unit of measure, e.g. pc, kg, l.
Article number of the item.
Ids of the catalogues the item belongs to.
Show child attributes
Supplier the item is bought from. Must belong to this company.
Contract the item is covered by.
Free-text supplier name, for items with no supplier record.
Smallest quantity that can be ordered. Decimal string. A JSON number is accepted on input and comes back as a string.
Quantity increment. Decimal string. A JSON number is accepted on input and comes back as a string.
Article number in your own system.
How often the item is reordered. Written inline with the item. Include the id on update to change the existing row instead of replacing it.
Show child attributes
Show child attributes
A category, as rendered inside a legal entity.
Show child attributes
Read gives the full tags. Writes take tag ids.
Show child attributes
The variants of this item. There is always at least one.
Show child attributes
Validation failed. attr names the field, in snake_case.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Missing, invalid, or expired API key, or a session credential was used instead of an API key.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Authenticated but not entitled: the key's user is not an active member of this company, the External API feature (or the resource's own feature) is not enabled for it, the key lacks the scope this verb needs, or a browser session was used.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Rate limit exceeded (60 requests per minute per API key). Retry after the number of seconds given in the message.
Response Attributes
validationErrorclientErrorserverError