Create a product

POST/v1/sites/{siteId}/products

Adds a product, or a modifier, to a site. It is available to sell straight away unless created retired. The response is the product, with the code to use from then on.

Needs Catalogue: writeChanges live data

Path

• siteIdrequired

  The site, from GET /v1/sites.

  string

Headers

• Authorizationrequired

  An API key from Automation > Access in the Dnero portal, sent as Authorization: Bearer <key>.

  string

• Idempotency-Key

  A value you choose, unique to what this request creates: a UUID, or your own id for it. Sending it again with the same body returns the first response and creates nothing more. Required.

  string · at most 255 characters

Body

• namerequired

  The product's name. Unique among the site's products (a modifier, among its modifiers).

  string · 1–200 characters

• pricerequired

  The price, in the site's currency's minor units: 450 is $4.50.

  integer · ≥ 0

• active

  False to create it retired. Defaults to true.

  boolean

• categoryCode

  The category to put it in, by code. It must be an active category at this site.

  string

• costPrice

  What it costs to buy or make, in minor units. For reporting only.

  integer · ≥ 0

• description

  A description.

  string · at most 2000 characters

• displayName

  The name customers see. Defaults to name.

  string · 1–200 characters

• printName

  The name printed on kitchen dockets and receipts. Defaults to name.

  string · 1–200 characters

• reportGroupCode

  The reporting group to count it in, by code.

  string

• sku

  Your stock-keeping unit for it.

  string · at most 100 characters

• soldIndividually

  Whether it can be ordered on its own. Defaults to true for a product and false for a modifier.

  boolean

• taxCodes

  The taxes to charge it with, by code. They must be active taxes at this site.

  array of string

• type

  product, sold on its own, or modifier, an option for a modifier group. Defaults to product.

  string · one of "product", "modifier" · default "product"

Responses

• 201Created
• 400Bad Requestbad_requestinvalid_cursoridempotency_key_required
• 401Unauthorizedmissing_keyinvalid_keykey_expired+1 more
• 403Forbiddenkey_revokedassistant_keykey_without_access+7 more
• 404Not Foundsite_not_foundnot_found
• 409Conflictidempotency_key_reusedrequest_in_progress
• 422Unprocessable Entityinvalid_requestnot_a_modifier_group
• 429Too Many Requestsrate_limited
• 500Internal Server Errorserver_error
• 502Bad Gatewayupstream_unavailable

201 Created

• activerequired

  False for a retired product, which is listed only with includeInactive.

  boolean

• availablerequired

  False while it is sold out.

  boolean

• barcodesrequired

  Its barcodes.

  array of string

• childrenrequired

  For a product, its modifier groups. For a modifier group, its options. Empty otherwise.

  array of objects

  4 fields in each

  • coderequired

    The child product's code.

    string

  • defaultQty

    How many of this child come by default.

    integer

  • maxQty

    The most of this child that may be chosen.

    integer

  • minQty

    The fewest of this child that may be chosen.

    integer

• coderequired

  The product's code, the same at every site that has it.

  string

• namerequired

  The product's name in the portal and reports.

  string

• pricerequired

  The price, in the site's currency's minor units: 450 is $4.50.

  integer

• soldIndividuallyrequired

  Whether it can be ordered on its own. False for a modifier or an ingredient.

  boolean

• taxCodesrequired

  The taxes it is charged with, by code.

  array of string

• typerequired

  What it is. product is sold on its own. A modifierGroup is a choice on a product, such as Milk; its children are the options. A modifier is one option, such as Oat milk.

  string · one of "product", "modifierGroup", "modifier", "inventory", "combo"

• categoryCode

  The category it is in, by code.

  string

• costPrice

  What it costs to buy or make, in minor units. For reporting; never what a customer pays.

  integer

• courseCode

  The course it goes to the kitchen with, by code.

  string

• description

  The product's description.

  string

• displayName

  The name customers see, when it differs from name.

  string

• imageUrl

  Its picture.

  string · uri

• maxChoices

  For a modifier group: the most options a customer may choose.

  integer

• minChoices

  For a modifier group: the fewest options a customer must choose.

  integer

• printName

  The name printed on kitchen dockets and receipts.

  string

• reportGroupCode

  The reporting group it is counted in, by code.

  string

• sku

  Your stock-keeping unit for it.

  string

• soldOutUntil

  When a sold-out product comes back on its own. Absent when it is not sold out, or is sold out until someone says otherwise.

  string · date-time

• updatedAt

  When the product last changed.

  string · date-time

curlJavaScriptPython

curl -X POST "https://api.dev.dnerohq.com/v1/sites/{siteId}/products" \
  -H "Authorization: Bearer $DNERO_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "categoryCode": "a1f0c5e2-7d3b-4c8e-9f21-6b0d4e7a9c13",
  "costPrice": 120,
  "displayName": "Flat White",
  "name": "Flat white",
  "price": 450,
  "printName": "FW"
}'

const response = await fetch('https://api.dev.dnerohq.com/v1/sites/{siteId}/products', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.DNERO_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "categoryCode": "a1f0c5e2-7d3b-4c8e-9f21-6b0d4e7a9c13",
    "costPrice": 120,
    "displayName": "Flat White",
    "name": "Flat white",
    "price": 450,
    "printName": "FW"
  }),
})
const data = await response.json()

import os, uuid
import requests

response = requests.post(
    "https://api.dev.dnerohq.com/v1/sites/{siteId}/products",
    headers={"Authorization": f"Bearer {os.environ['DNERO_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
    json={
      "categoryCode": "a1f0c5e2-7d3b-4c8e-9f21-6b0d4e7a9c13",
      "costPrice": 120,
      "displayName": "Flat White",
      "name": "Flat white",
      "price": 450,
      "printName": "FW"
    },
)
data = response.json()

201Createdapplication/json

{
  "active": true,
  "available": true,
  "barcodes": [
    "9415007012345"
  ],
  "categoryCode": "a1f0c5e2-7d3b-4c8e-9f21-6b0d4e7a9c13",
  "children": [
    {
      "code": "0f9d3b27-6c1e-4a85-b2d4-8e7a1c5f3b90",
      "defaultQty": 0,
      "maxQty": 1,
      "minQty": 0
    }
  ],
  "code": "7b3e9c14-2a6f-4d08-8b5e-c1f4a7d2e936",
  "costPrice": 120,
  "courseCode": "5c2e8a41-0b7f-4d6a-8e93-1f4c7b2d9a60",
  "description": "Double ristretto with steamed milk.",
  "displayName": "Flat White",
  "imageUrl": "https://ucarecdn.com/2f4e8a1c-5b7d-4e9f-a3c6-1d8b0e2f7a54/",
  "maxChoices": 1,
  "minChoices": 1,
  "name": "Flat white",
  "price": 450,
  "printName": "FW",
  "reportGroupCode": "3e7a1c90-4b2d-4f6e-8a15-9c0d2b7e4f31",
  "sku": "COF-FW-REG",
  "soldIndividually": true,
  "soldOutUntil": "2026-10-21T00:00:00Z",
  "taxCodes": [
    "GST"
  ],
  "type": "product",
  "updatedAt": "2026-10-20T03:15:00Z"
}

400Bad Requestapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#bad_request",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request could not be read, for example malformed JSON.",
  "code": "bad_request"
}

401Unauthorizedapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#missing_key",
  "title": "Unauthorized",
  "status": 401,
  "detail": "No API key was sent.",
  "code": "missing_key"
}

403Forbiddenapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#key_revoked",
  "title": "Forbidden",
  "status": 403,
  "detail": "The key was revoked or switched off in the Dnero portal.",
  "code": "key_revoked"
}

404Not Foundapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#site_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "The key does not reach that site, or there is no such site.",
  "code": "site_not_found"
}

409Conflictapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#idempotency_key_reused",
  "title": "Conflict",
  "status": 409,
  "detail": "This `Idempotency-Key` was already used for a different request.",
  "code": "idempotency_key_reused"
}

422Unprocessable Entityapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#invalid_request",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "The request was read but is not valid.",
  "code": "invalid_request"
}

429Too Many Requestsapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#rate_limited",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The key has used its requests for this minute.",
  "code": "rate_limited"
}

500Internal Server Errorapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#server_error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Something went wrong on Dnero's side. It has been logged.",
  "code": "server_error"
}

502Bad Gatewayapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#upstream_unavailable",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "Something Dnero depends on did not answer in time.",
  "code": "upstream_unavailable"
}

Examples use this site's API host. Keep the key in $DNERO_API_KEY; never paste it into code.