Skip to main content
PATCH
Update a catalogue item

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional. A unique value you choose for this request, such as a UUID. When sent, a retry with the same key returns the first answer instead of applying the change twice. See Retries and idempotency.

Minimum string length: 1

Path Parameters

clinic_id
string<uuid>
required
item_id
string<uuid>
required

Body

application/json

Absent ≠ null. Idempotency-Key optional — a PATCH is naturally idempotent.

name
string
Minimum string length: 1
generic_name
string | null
brand_name
string | null
strength
string | null
dosage_form
string | null
category
string | null
unit_of_measure
string | null
upc
string | null

A gtin value must be a valid GTIN-8, GTIN-12, GTIN-13 or GTIN-14: digits only, the right length and a correct GS1 check digit. A request that sends any other value is refused with 400 invalid_gtin, naming the field and the value. Values already stored are not changed and are returned as they are. On update, a value equal to the one already stored is accepted even if it is not a valid GTIN; only a changed value is checked (the comparison reads the item with your key, which counts toward your rate limit; if that read is refused you get that refusal, not invalid_gtin). null clears the code.

nafdac_no
string | null
ndc
string | null
default_sale_price
number

Above the clinic's configured percentage threshold is refused (limit_exceeded).

is_active
boolean

Response

OK.

data
object
required