Products

Manage products for your organisation, including connected SKUs, shop SKUs, shop products, and pharmacy SKUs. Related resources: SKUs, Shop SKUs, Shop products.

List Products

GET /v1/management/products

integer

default:"0"

Page number (0-indexed)

integer

default:"50"

Number of products per page

Required permission: product:read

Example Request

curl -X GET "https://api.rxscale.com/v1/management/products?page=0&limit=25" \
  -H "X-API-Key: your-api-key-here"

Response

{
  "products": [
    {
      "uid": "prod-abc123",
      "display_name": "Medication X",
      "skus": [
        {
          "uid": "sku-456",
          "display_name": "Medication X 100mg",
          "pzn": "12345678",
          "is_template": false,
          "shop_skus": [
            {
              "uid": "ssku-789",
              "shop_uid": "shop-001",
              "external_id": "shopify-variant-123"
            }
          ],
          "pharmacy_skus": [
            {
              "uid": "psku-012",
              "pharmacy_uid": "ph-xyz",
              "price": 1299,
              "stock": 50,
              "external_id": "EXT-001"
            }
          ]
        }
      ],
      "shop_products": [
        {
          "uid": "sp-345",
          "shop_uid": "shop-001",
          "external_id": "shopify-product-456"
        }
      ]
    }
  ],
  "totalRegistries": 42,
  "totalPages": 2
}

Response Fields

Field	Type	Description
`products`	array	List of product objects
`products[].uid`	string	Product UID
`products[].display_name`	string	Product display name
`products[].skus`	array	SKUs belonging to this product
`products[].skus[].pzn`	string	Pharmazentralnummer (German pharmaceutical ID)
`products[].skus[].is_template`	boolean	Whether this SKU is a placeholder anchor rather than a real article
`products[].skus[].pharmacy_skus`	array	Pharmacy-specific SKU data (price, stock)
`totalRegistries`	integer	Total number of products
`totalPages`	integer	Total number of pages for the given limit

The price field on pharmacy SKUs is in euro cents (e.g., 1299 = 12.99 EUR).

Placeholder SKUs (is_template)A patient can order a medicine that is not in your catalogue. Such an order line still needs a SKU to point at, so it points at a placeholder: a single SKU per organisation marked is_template: true. What the line actually says — the medicine, the quantity, the PZN — comes from the prescription the doctor signs, not from the placeholder SKU.is_template is not a stock, pricing or dispatch flag. Almost every SKU you see has is_template: false; if you are listing sellable articles, filter placeholders out.

Get Product Details

GET /v1/management/products/{product_uid}

string

required

The product UID

Required permission: product:read

Example Request

curl -X GET "https://api.rxscale.com/v1/management/products/prod-abc123" \
  -H "X-API-Key: your-api-key-here"

Response

Returns the same product structure as the list endpoint, but for a single product including all connected SKUs, shop SKUs, shop products, and pharmacy SKUs.

{
  "uid": "prod-abc123",
  "display_name": "Medication X",
  "skus": [...],
  "shop_products": [...]
}

Create Product

POST /v1/management/products

Required permission: product:write

Field	Type	Required	Description
`display_name`	string	yes	Product display name
`short_name`	string	yes	Short product name
`prescription_required`	boolean	yes	Whether a prescription is required
`handle`	string	no	Product handle
`image_url`	string	no	Product image URL
`skus`	array	no	Nested SKUs to create with the product

Example Request

curl -X POST "https://api.rxscale.com/v1/management/products" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "Medication X",
    "short_name": "med-x",
    "prescription_required": true,
    "handle": "medication-x",
    "skus": [
      {
        "display_name": "Medication X 100mg",
        "pzn": "12345678",
        "digital": false
      }
    ]
  }'

The response is the created product in the same shape as the detail endpoint (HTTP 201).

Update Product

PATCH /v1/management/products/{product_uid}

string

required

The product UID

Required permission: product:write Updatable fields: display_name, short_name, prescription_required, handle, image_url.

Example Request

curl -X PATCH "https://api.rxscale.com/v1/management/products/prod-abc123" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{"display_name": "Medication X Forte"}'

Delete Product

DELETE /v1/management/products/{product_uid}

string

required

The product UID

Required permission: product:write Returns HTTP 204 with an empty body. The product is soft-deleted.

Getting Started

External Pharmacy API

Management API

Scheduling API

Public API

Patient API

Anamnesis API

Webhooks

Guides

Products

Products

List Products

Example Request

Response

Response Fields

Get Product Details

Example Request

Response

Create Product

Example Request

Update Product

Example Request

Delete Product

​Products

​List Products

​Example Request

​Response

​Response Fields

​Get Product Details

​Example Request

​Response

​Create Product

​Example Request

​Update Product

​Example Request

​Delete Product

Products

List Products

Example Request

Response

Response Fields

Get Product Details

Example Request

Response

Create Product

Example Request

Update Product

Example Request

Delete Product