Skip to main content
POST
Report a status

Authorizations

Authorization
string
header
required

Send your key in the Authorization header: Bearer gj_live_… in production, Bearer gj_test_… in the sandbox.

Headers

Idempotency-Key
string

A unique string that identifies this request. Use a new value for each new request, and the same value when you retry a request.

  • Within 24 hours, a retry with the same key returns the stored response with the header Idempotent-Replayed: true. GO JOE does not process the request again.
  • If the first request is still being processed, the retry returns 409 idempotency_in_progress. Retry after Retry-After seconds.
  • GO JOE does not store failed requests (4xx, 5xx). A retry is processed again.
  • The same key with a different body returns 422 idempotency_key_reused.
Maximum string length: 255

Path Parameters

id
string<uuid>
required

Body

application/json
status
enum<string>
required
Available options:
packed,
ready_for_pickup,
out_for_delivery,
completed,
returned
tracking
object

Response

The updated order

id
string<uuid>
required
order_number
string
required
Example:

"GO-XCAFTF"

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

The usual sequence is new → accepted → packed → ready_for_pickup or out_for_delivery → completed.

  • returning, returned: the courier could not deliver the order.
  • rejected: you have reported that you cannot fill the order (POST /orders/{id}/reject).
  • cancelled: the order is cancelled. Do not dispense it.

See Order lifecycle.

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

The time the order became available to your pharmacy.

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

The patient data required to dispense and deliver the order. The API does not return the e-mail address or the billing address.

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

The time you rejected the order.