Orders

Create a new order

Create a new order entry in the system. The order is associated with a kit ID. The response includes the full order record with timestamps.

post/orders

Request

  • Base URL
    https://api.physikit.com/v2
  • Auth
    HTTP bearer

Request body

panel_idstring required

ID of the panel this order belongs to

kit_idstring nullable

Assigned Physikit kit identifier (if known at order time)

customer_order_idstring nullable

Primary reference in the customer’s system

customer_order_id_2string nullable

Secondary reference in the customer’s system

first_namestring nullable

Patient’s first name

last_namestring nullable

Patient’s last name

emailstring nullable

E-mail for the patient

address_line_1string nullable

Street address (line 1)

address_line_2string nullable

Address complement (line 2)

citystring nullable

City

zip_codestring nullable

Postal / ZIP code

countrystring nullable

ISO country name or code, e.g. “Germany”

consentboolean nullable

Whether the patient has given consent (true / false)

Response

Successful Response

idstring uuid required
panel_idstring required
kit_idstring nullable required
status10 | 11 | 20 | 21 | 22 | 30 | 31 | 40 | 41 | 42 | 98 | 99 required
notestring nullable required
first_namestring nullable
last_namestring nullable
emailstring nullable
address_line_1string nullable
address_line_2string nullable
citystring nullable
zip_codestring nullable
countrystring nullable
consentboolean
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.