Skip to main content

Products

Retrieve a paginated list of products available in a specific shop, filtered by market.

List Products

string
required
Unique identifier for the shop
string
required
Market identifier (e.g. DE for Germany)
Filter products and SKUs by name
integer
default:"0"
Page number (0-indexed)
integer
default:"50"
Products per page (max 150). Products are sorted by display name, and each product appears on exactly one page together with all of its matching SKUs.
Required permission: telemed_product:read
Products with Shopify status DRAFT or ARCHIVED are excluded. Products with status ACTIVE or UNLISTED remain available. The status is evaluated against Shopify at request time, so a product you archive stops appearing immediately.

Example Request

Response

Response Fields

Error Responses

Check Live Stock

Check whether one or more SKUs are currently available in the requested quantities before the checkout starts.
string
required
Unique identifier for the shop
Required permission: telemed_product:read
Live stock is checked against Shopify’s current available inventory for the mapped product variants. This includes inventory already held by Shopify orders and draft-order reservations.

Request Body

Each resolved sku_uid can appear only once per live stock request.
When you send external_id, the API key must be linked to a telemedicine provider. A line whose external_id or sku_uid is not sold in this shop returns 404 with code unknown_sku and names the line — see Public API Reason Codes.

Example Request

Available Response

When all requested quantities are available, the endpoint returns 200 OK.

Unavailable Response

When at least one requested quantity is not available, the endpoint returns 409 Conflict.

Response Fields

Error Responses

Reserve Products

Create a Shopify draft order with a 24-hour inventory reservation before prescriptions are available. Use the returned draft order ID later as reserved_draft_order_id when uploading signed prescriptions.
string
required
Unique identifier for the shop
Required permission: create_prescription_checkout
The reservation request does not include prescriptions or patient data. RxScale adds telemedicine provider attributes from the API key automatically.
The API key must be linked to a telemedicine provider. Requests with a non-telemedicine API key are rejected with 400 Bad Request before any inventory is held, because the resulting draft order could not be matched on the later prescription upload.

Request Body

Each resolved sku_uid can appear only once per reservation request. Duplicate SKU lines are rejected because the later prescription upload must match each reserved draft-order line unambiguously.

Example Request

Response

The draft_order.id is the Shopify legacy DraftOrder ID, not the Shopify GID. Pass this value to POST /v2/public-api/prescriptions/{shop_identifier} as reserved_draft_order_id after the prescriptions are signed.

Repeating a Reservation

A reservation is idempotent on external_reservation_id. If you do not receive the answer — a timeout, a dropped connection — send the same request again with the same id:
  • Same id, same lines: 200 with the draft order that already exists. draft_order.id, invoiceUrl and reserve_inventory_until are those of the first request; nothing new is reserved and the deadline is not extended. The lines count as the same when they reserve the same SKUs in the same quantities, in any order, whether you identify them by sku_uid or by external_id.
  • Same id, other lines: 409 with code duplicate_reservation. An id stands for one reservation; use a new id for a new one.
The id is unique per shop and telemedicine provider. A request that was refused (4xx, 502) reserves nothing and leaves the id free, so you can send it again once the cause is fixed. Omit external_reservation_id and every request creates a new draft order. Sending "" is a validation_error, not the same as omitting the field.

Error Responses

No draft order is created and no inventory is held when the request is refused with a 4xx status.