Inkress DevelopersProducts · Create a product
API reference / Products
Create a product
POST/api/v1/productsproducts:write
Adds a product to the merchant's catalogue.
Body
titlestringrequired
Product name, up to 96 characters.
pricenumberrequired
Price in the major unit.
permalinkstringrequired
URL name, up to 128 characters.
statusintegerrequired
1 draft, 2 published, 3 archived.
currency_codestring
JMD or USD.
teaserstring
A short description, up to 512 characters.
imagestring
Image URL.
publicboolean
Shown on the store. Defaults to false.
unlimitedboolean
Never runs out. Defaults to false.
units_remaininginteger
Stock, when not unlimited.
category_idinteger
Its category.
Headers
Authorizationheaderrequired
Bearer with your secret key, or the merchant's OAuth token.
Returns
The product.
| status | Meaning |
|---|---|
1 | Draft. |
2 | Published. |
3 | Archived. |
Errors
401 | The key or token is missing, wrong or revoked, is for the other environment, or doesn't have the scope this endpoint needs. |
422 | A required field is missing or too long. |