Skip to main content
POST

Authorizations

x-vitarelay-signature
string
header
required

HMAC-SHA256 of the exact raw request body, keyed with your per-pharmacy inbound webhook secret. Hex or base64; optional leading sha256=.

Path Parameters

orgId
string<uuid>
required

Your pharmacy's VitaRelay organization UUID (provided by a VitaRelay admin).

Body

application/json
event
enum<string>
required
Available options:
status_update
order_number
string

VitaRelay order number. A retry suffix like -r2 is tolerated and normalized.

Maximum string length: 100
status
enum<string>
Available options:
accepted,
processing,
ready_to_ship,
shipped,
delivered
tracking_number
string
Maximum string length: 200
tracking_carrier
string
Maximum string length: 80
tracking_url
string<uri>
Maximum string length: 500

Response

Accepted and processed.

ok
boolean
note
string