API

Update a product

Updates product by ID by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

POST/v1/hq/products/{id}
AuthorizationBearer <token>

The Noona HQ API uses Bearer token for authentication.

Endpoints that return generic information that does not contain sensitive data do not require authentication. Endpoints that require authentication are specifically marked in the documentation.

Authorization: Bearer your-token

In: header

Path Parameters

id*string

Product ID

Query Parameters

unset?array<ProductField>
select?array<string>
expand?array<string>

Request Body

application/json

company?string
Example"7awdXwZoedakjad37a"
title?string
Example"Black Shampoo"
description?string
Example"A shampoo for black hair"
amount?number
Default0
Formatdouble
Example2990
sku?string
Example"ANE123"
stock_level?integer
Formatint32
Example10
cost?integer

The cost of the product from a wholesaler.

In the x100 format.

Formatint32
barcode?string
Example8004608258995
product_groups?array<string>

List of product group ids product belongs to.

image?
vat_id?string

Id of VAT to use for product

Example"FzGMKqFnCX79N3zWk"
tax_exemption_reason?string

VAT exemption reason when having a VAT amount of 0%

Example"M01"
import_reference_id?string

Set during import of products, usually an identifier from an external system.

Example"FzGMKqFnCX79N3zWk"
import_job?string

ID of the import job that created this product.

Example"FzGMKqFnCX79N3zWk"

Response Body

application/json

curl -X POST "https://api.noona.is/v1/hq/products/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "7awdXwZoedakjad37a",
  "company": "7awdXwZoedakjad37a",
  "title": "Black Shampoo",
  "description": "A shampoo for black hair",
  "amount": 2990,
  "sku": "ANE123",
  "stock_level": 10,
  "cost": 0,
  "barcode": 8004608258995,
  "product_groups": [
    "string"
  ],
  "image": {
    "thumb": "<link-to-image>"
  },
  "vat_id": "FzGMKqFnCX79N3zWk",
  "tax_exemption_reason": "M01",
  "import_reference_id": "FzGMKqFnCX79N3zWk",
  "import_job": "FzGMKqFnCX79N3zWk",
  "created_at": 1631558908,
  "updated_at": 1631558908
}
Empty