PHphysikit
Sandbox

Update order (any status allowed)

patch/sandbox/orders/{id}

Request

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

Path parameters

idstring uuid required

Order ID

Request body

statusinteger required

Target order status (sandbox only). In sandbox you may set any status code, including moving backward or skipping stages. No transition validation is applied.

Status Lifecycle (Code → Description):

  • 10 → ORDERED – Order created in the system.
  • 11 → KIT_SHIPPED – Test kit has been shipped to the customer.
  • 20 → PATIENT_KIT_RECEIVED – The patient has received the test kit.
  • 21 → PATIENT_KIT_USED – The kit was used and prepared by the patient for return.
  • 22 → PATIENT_SAMPLES_SHIPPED – Samples were shipped back by the patient.
  • 30 → SAMPLES_RECEIVED – Samples received at the local logistics hub.
  • 31 → SAMPLES_SHIPPED – Samples forwarded to the lab.
  • 40 → LAB_SAMPLES_RECEIVED – Lab has received the samples.
  • 41 → LAB_SAMPLES_ANALYZED – Lab completed the analysis.
  • 42 → CUSTOMER_RESULTS_RETRIEVED – Results have been retrieved by the integration partner.
  • 98 → ARCHIVED – Order archived.
  • 99 → ISSUE – Order has encountered an issue.

Example request

{
  "status": 41
}

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.