Skip to main content
POST
Create a test order

Authorizations

Authorization
string
header
required

Authorization: Bearer gj_live_… (production) or gj_test_… (sandbox).

Headers

Idempotency-Key
string

Any unique string. Retrying with the same key within 24 h returns the first response without running the request again.

Maximum string length: 255

Body

application/json
pharmacy_id
string<uuid>
required

One of your pharmacies (see GET /me).

fulfilment
enum<string>
default:express

express = GO JOE's courier collects from you; shipping = you ship; pickup = the patient collects.

Available options:
express,
shipping,
pickup
prescription_stage
enum<string>
default:vorab

Start with the Vorab-Rezept (then play sign_prescription) or with the signed prescription.

Available options:
vorab,
signed
items
object[]
Required array length: 1 - 10 elements

Response

Created; order.created is on its way

id
string<uuid>
required
order_number
string
required
Example:

"GO-XCAFTF"

pharmacy_id
string<uuid>
required
status
enum<string>
required

new → accepted → packed → ready_for_pickup | out_for_delivery → completed. returning/returned when a courier could not deliver. cancelled: do not dispense.

Available options:
new,
accepted,
packed,
ready_for_pickup,
out_for_delivery,
completed,
returning,
returned,
cancelled
created_at
string<date-time>
required

When the order reached your pharmacy

updated_at
string<date-time>
required
fulfilment
object
required
patient
object
required

Only what is needed to dispense and deliver. No e-mail, no billing address.

items
object[]
required
totals
object
required
prescription
object
required
erp_reference
string | null
accepted_at
string<date-time> | null