Cancel order

POST/v1/orders/{orderId}/cancel

Requests cancellation. HTTP 200 means the request was handled; check cancellation.status for confirmed, pending, partial, or failed. Only confirmed means the entire order is cancelled. Shipment possession makes a fulfillment cancellation too late.

Practices API key authenticationVersion 2026-09-28

Request example

Replace example values with your Test data. Check the field rules below before you send a request.

{
  "reason": "<string>"
}

curl -X POST 'https://api.affinityrx.com/v1/orders/{orderId}/cancel' \
  -H "Authorization: Bearer $AFFINITY_API_KEY" \
  -H 'Affinity-Version: 2026-09-28' \
  -H 'Idempotency-Key: <Idempotency-Key>' \
  -H 'Content-Type: application/json' \
  --data @request.json

Response example

These examples show the body structure. Values can differ. Select a status code to see its response.

{
  "revision": "<string>",
  "otcItems": [
    {
      "catalogItemId": "cat_01j2y8m6jcc9tt24af5pw9x1bc",
      "prescriptionId": "rx_01j2y8m6jcc9tt24af5pw9x1bc",
      "name": "<string>",
      "quantity": 0,
      "unitPriceCents": 0,
      "subtotalCents": 0
    }
  ],
  "practiceMedicationTotalCents": 0,
  "externalOrderId": "<string>",
  "metadata": "<string>",
  "createdAt": "<string>",
  "fulfillments": [
    {
      "carrier": "<string>",
      "cancellations": [
        {
          "attempts": 0,
          "confirmedAt": "<string>",
          "createdAt": "<string>",
          "errorCode": "<string>",
          "errorMessage": "<string>",
          "id": "cancl_01j2y8m6jcc9tt24af5pw9x1bc",
          "providerStatus": "<string>",
          "reason": "<string>",
          "requestedAt": "<string>",
          "requestedBy": {
            "id": "<string>",
            "type": "<string>"
          },
          "resolvedAt": "<string>",
          "sentAt": "<string>",
          "source": "provider",
          "status": "requested",
          "updatedAt": "<string>"
        }
      ],
      "pharmacyId": "pharm_01j2y8m6jcc9tt24af5pw9x1bc",
      "createdAt": "<string>",
      "id": "ord_01j2y8m6jcc9tt24af5pw9x1bc",
      "prescriptionId": "rx_01j2y8m6jcc9tt24af5pw9x1bc",
      "status": "<string>",
      "trackingNumber": "<string>",
      "trackingStatus": "<string>",
      "shippedAt": "<string>",
      "deliveredAt": "<string>",
      "estimatedDeliveryAt": "<string>",
      "exceptions": [
        {
          "actionable": false,
          "assignedTo": {
            "id": "<string>",
            "name": "<string>"
          },
          "createdAt": "<string>",
          "dueAt": "<string>",
          "id": "fex_01j2y8m6jcc9tt24af5pw9x1bc",
          "kind": "<string>",
          "resolution": "<string>",
          "resolvedAt": "<string>",
          "retryable": false,
          "severity": "warning",
          "status": "open",
          "summary": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "shipping": {
        "destinationType": "patient",
        "method": "standard",
        "option": {
          "amountCents": "<string>",
          "currency": "USD",
          "label": "<string>",
          "serviceLevel": "<string>",
          "temperature": "ambient"
        }
      },
      "shipments": [
        {
          "carrier": "<string>",
          "createdAt": "<string>",
          "deliveredAt": "<string>",
          "estimatedDeliveryAt": "<string>",
          "id": "ship_01j2y8m6jcc9tt24af5pw9x1bc",
          "isActive": false,
          "providerStatus": "<string>",
          "replacedAt": "<string>",
          "replacesShipmentId": "ship_01j2y8m6jcc9tt24af5pw9x1bc",
          "shippedAt": "<string>",
          "source": "pharmacy_webhook",
          "status": "label_created",
          "trackingNumber": "<string>",
          "trackingUrl": "<string>",
          "updatedAt": "<string>",
          "voidedAt": "<string>"
        }
      ],
      "trackingUrl": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "id": "ord_01j2y8m6jcc9tt24af5pw9x1bc",
  "lifecycleEvents": [
    {
      "createdAt": "<string>",
      "eventType": "<string>",
      "id": "<string>",
      "message": "<string>",
      "source": "cancellation"
    }
  ],
  "livemode": false,
  "object": "order",
  "patientExternalId": "<string>",
  "patientId": "pat_01j2y8m6jcc9tt24af5pw9x1bc",
  "patientName": "<string>",
  "patientState": "<string>",
  "practiceId": "prac_01j2y8m6jcc9tt24af5pw9x1bc",
  "prescriberName": "<string>",
  "prescriberNpi": "<string>",
  "review": {
    "status": "completed",
    "reason": "<string>",
    "requestedAt": "<string>",
    "completedAt": "<string>",
    "canceledAt": "<string>",
    "resolvedAt": "<string>",
    "resolvedBy": {
      "id": "<string>",
      "type": "<string>"
    },
    "providerId": "prov_01j2y8m6jcc9tt24af5pw9x1bc"
  },
  "prescriptions": "<string>",
  "status": "blocked",
  "updatedAt": "<string>",
  "cancellation": {
    "status": "confirmed",
    "outcomes": [
      {
        "cancellationId": "cancl_01j2y8m6jcc9tt24af5pw9x1bc",
        "fulfillmentId": "ord_01j2y8m6jcc9tt24af5pw9x1bc",
        "status": "confirmed"
      }
    ]
  }
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 400,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 401,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 403,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 404,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 409,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 422,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 429,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

Implementation specification

Use these field types and limits to build your integration. Download the OpenAPI document for the complete contract.

Path parameters

orderIdstringrequired

Pattern: ^ord_[0-7][0-9a-hjkmnp-tv-z]{25}$

Headers

Affinity-Versionstring

Selects the HTTP API contract for this request only. When omitted, API-key requests use their service account’s stored version. Does not change the stored default.

Pin requests to 2026-09-28.

Idempotency-Keystringrequired

Affinity-Actor-Idstring

Required for user actors and optional for system actors. Omit both actor headers to use the authenticated service account as a system actor.

Affinity-Actor-Typestring

Use user when a person initiated the action and system for autonomous work. Omit both actor headers to default to system.

Request body specification application/json

reasonstringrequired

Response specifications

200Successful response

application/json

revisionstringrequired

Opaque revision of the complete order prescription set. Send the revision you reviewed as expectedRevision; never replace it automatically after a conflict.

Pattern: ^rev_[a-f0-9]{64}$

otcItemsobject[]required

Show otcItems fields

Array items · object

catalogItemIdanyrequired

Show catalogItemId fields

All of · 1: any

any

Pattern: ^cat_[0-7][0-9a-hjkmnp-tv-z]{25}$

prescriptionIdanyrequired

Show prescriptionId fields

All of · 1: any

any

Pattern: ^rx_[0-7][0-9a-hjkmnp-tv-z]{25}$

namestringrequired

quantityintegerrequired

unitPriceCentsintegerrequired

subtotalCentsintegerrequired

practiceMedicationTotalCentsinteger | nullrequired

Snapshot of the practice-facing medication total. Null until every prescription has recorded submission pricing. Excludes shipping and supplies.

Show practiceMedicationTotalCents fields

Any of · 1: integer

integer

Any of · 2: null

null

externalOrderIdany & any & any & any | nullrequired

Show externalOrderId fields

Any of · 1: any & any & any & any

All of · 1: any

any

Minimum length: 1

All of · 2: any

any

Maximum length: 200

All of · 3: any

any

Pattern: \S

All of · 4: any

any

Pattern: ^[^\p{Cc}\p{Cs}]*$

Any of · 2: null

null

metadataany & anyrequired

Show metadata fields

All of · 1: any

any

All of · 2: any

any

Additional properties

Any of · 1: any & any

All of · 1: any

any

Pattern: ^[^\p{Cs}]*$

All of · 2: any

any

Maximum length: 500

Any of · 2: number

number

Any of · 3: boolean

boolean

Any of · 4: null

null

createdAtstringrequired

fulfillmentsobject[]required

Show fulfillments fields

Array items · object

carrierstring | nullrequired

Show carrier fields

Any of · 1: string

string

Any of · 2: null

null

cancellationsobject[]required

Show cancellations fields

Array items · object

attemptsintegerrequired

confirmedAtstring | nullrequired

Show confirmedAt fields

Any of · 1: string

string

Any of · 2: null

null

createdAtstringrequired

errorCodestring | nullrequired

Show errorCode fields

Any of · 1: string

string

Any of · 2: null

null

errorMessagestring | nullrequired

Show errorMessage fields

Any of · 1: string

string

Any of · 2: null

null

idanyrequired

Show id fields

All of · 1: any

any

Pattern: ^cancl_[0-7][0-9a-hjkmnp-tv-z]{25}$

providerStatusstring | nullrequired

Show providerStatus fields

Any of · 1: string

string

Any of · 2: null

null

reasonstringrequired

requestedAtstringrequired

requestedByobjectrequired

No additional properties

Show requestedBy fields

idstringrequired

typestringrequired

resolvedAtstring | nullrequired

Show resolvedAt fields

Any of · 1: string

string

Any of · 2: null

null

sentAtstring | nullrequired

Show sentAt fields

Any of · 1: string

string

Any of · 2: null

null

sourcestringrequired

Allowed: "provider", "platform", "public_api", "pharmacy", "system"

statusstringrequired

Allowed: "requested", "sent", "confirmed", "rejected", "failed", "too_late"

updatedAtstringrequired

pharmacyIdany | nullrequired

Show pharmacyId fields

Any of · 1: any

All of · 1: any

any

Pattern: ^pharm_[0-7][0-9a-hjkmnp-tv-z]{25}$

Any of · 2: null

null

createdAtstringrequired

idanyrequired

Show id fields

All of · 1: any

any

Pattern: ^ord_[0-7][0-9a-hjkmnp-tv-z]{25}$

prescriptionIdanyrequired

Show prescriptionId fields

All of · 1: any

any

Pattern: ^rx_[0-7][0-9a-hjkmnp-tv-z]{25}$

statusstringrequired

trackingNumberstring | nullrequired

Show trackingNumber fields

Any of · 1: string

string

Any of · 2: null

null

trackingStatusstring | nullrequired

Show trackingStatus fields

Any of · 1: string

string

Any of · 2: null

null

shippedAtstring | nullrequired

Show shippedAt fields

Any of · 1: string

string

Any of · 2: null

null

deliveredAtstring | nullrequired

Show deliveredAt fields

Any of · 1: string

string

Any of · 2: null

null

estimatedDeliveryAtstring | nullrequired

Show estimatedDeliveryAt fields

Any of · 1: string

string

Any of · 2: null

null

exceptionsobject[]required

Show exceptions fields

Array items · object

actionablebooleanrequired

assignedToobject | nullrequired

Show assignedTo fields

Any of · 1: object

idstringrequired

namestringrequired

Any of · 2: null

null

createdAtstringrequired

dueAtstring | nullrequired

Show dueAt fields

Any of · 1: string

string

Any of · 2: null

null

idanyrequired

Show id fields

All of · 1: any

any

Pattern: ^fex_[0-7][0-9a-hjkmnp-tv-z]{25}$

kindstringrequired

resolutionstring | nullrequired

Show resolution fields

Any of · 1: string

string

Any of · 2: null

null

resolvedAtstring | nullrequired

Show resolvedAt fields

Any of · 1: string

string

Any of · 2: null

null

retryablebooleanrequired

severitystringrequired

Allowed: "warning", "critical"

statusstringrequired

Allowed: "open", "acknowledged", "resolved"

summarystringrequired

updatedAtstringrequired

shippingobjectrequired

No additional properties

Show shipping fields

destinationTypestringrequired

Allowed: "patient", "practice"

methodstringrequired

Allowed: "standard", "expedited", "overnight", "pickup", "local_delivery"

optionobject | nullrequired

Show option fields

Any of · 1: object

amountCentsanyrequired

Show amountCents fields

All of · 1: any

any

Minimum: 0

currencystringrequired

Allowed: "USD"

labelstringrequired

serviceLevelstringrequired

temperaturestringrequired

Allowed: "ambient", "refrigerated"

Any of · 2: null

null

shipmentsobject[]required

Show shipments fields

Array items · object

carrierstring | nullrequired

Show carrier fields

Any of · 1: string

string

Any of · 2: null

null

createdAtstringrequired

deliveredAtstring | nullrequired

Show deliveredAt fields

Any of · 1: string

string

Any of · 2: null

null

estimatedDeliveryAtstring | nullrequired

Show estimatedDeliveryAt fields

Any of · 1: string

string

Any of · 2: null

null

idanyrequired

Show id fields

All of · 1: any

any

Pattern: ^ship_[0-7][0-9a-hjkmnp-tv-z]{25}$

isActivebooleanrequired

providerStatusstring | nullrequired

Show providerStatus fields

Any of · 1: string

string

Any of · 2: null

null

replacedAtstring | nullrequired

Show replacedAt fields

Any of · 1: string

string

Any of · 2: null

null

replacesShipmentIdany | nullrequired

Show replacesShipmentId fields

Any of · 1: any

All of · 1: any

any

Pattern: ^ship_[0-7][0-9a-hjkmnp-tv-z]{25}$

Any of · 2: null

null

shippedAtstring | nullrequired

Show shippedAt fields

Any of · 1: string

string

Any of · 2: null

null

sourcestringrequired

Allowed: "pharmacy_webhook", "pharmacy", "system"

statusstringrequired

Allowed: "label_created", "carrier_possession", "in_transit", "out_for_delivery", "delivered", "delayed", "delivery_failed", "returned", "voided", "unknown"

trackingNumberstring | nullrequired

Show trackingNumber fields

Any of · 1: string

string

Any of · 2: null

null

trackingUrlstring | nullrequired

Show trackingUrl fields

Any of · 1: string

string

Any of · 2: null

null

updatedAtstringrequired

voidedAtstring | nullrequired

Show voidedAt fields

Any of · 1: string

string

Any of · 2: null

null

trackingUrlstring | nullrequired

Show trackingUrl fields

Any of · 1: string

string

Any of · 2: null

null

updatedAtstringrequired

idstringrequired

Pattern: ^ord_[0-7][0-9a-hjkmnp-tv-z]{25}$

lifecycleEventsobject[]required

Show lifecycleEvents fields

Array items · object

createdAtstringrequired

eventTypestringrequired

idstringrequired

messagestringrequired

sourcestringrequired

Allowed: "cancellation", "exception", "fulfillment", "integration", "shipment", "webhook"

livemodebooleanrequired

objectstringrequired

Allowed: "order"

patientExternalIdstring | nullrequired

Show patientExternalId fields

Any of · 1: string

string

Any of · 2: null

null

patientIdstringrequired

Pattern: ^pat_[0-7][0-9a-hjkmnp-tv-z]{25}$

patientNamestringrequired

patientStatestringrequired

The patient's current clinical state. This is not the saved delivery state; use each prescription's deliveryAddress for shipping.

practiceIdstringrequired

Pattern: ^prac_[0-7][0-9a-hjkmnp-tv-z]{25}$

prescriberNamestring | nullrequired

Show prescriberName fields

Any of · 1: string

string

Any of · 2: null

null

prescriberNpistring | nullrequired

Show prescriberNpi fields

Any of · 1: string

string

Any of · 2: null

null

reviewobject | nullrequired

Show review fields

Any of · 1: object

statusstringrequired

Allowed: "completed", "rejected"

reasonstring | nullrequired

Show reason fields

Any of · 1: string

string

Any of · 2: null

null

requestedAtstringrequired

completedAtstring | nullrequired

Show completedAt fields

Any of · 1: string

string

Any of · 2: null

null

canceledAtstring | nullrequired

Show canceledAt fields

Any of · 1: string

string

Any of · 2: null

null

resolvedAtstring | nullrequired

Show resolvedAt fields

Any of · 1: string

string

Any of · 2: null

null

resolvedByobject | nullrequired

Show resolvedBy fields

Any of · 1: object

idstringrequired

typestringrequired

Any of · 2: null

null

providerIdany | nullrequired

Show providerId fields

Any of · 1: any

All of · 1: any

any

Pattern: ^prov_[0-7][0-9a-hjkmnp-tv-z]{25}$

Any of · 2: null

null

Any of · 2: null

null

prescriptionsanyrequired

Show prescriptions fields

Array items · object

versionintegerrequired

daysSupplynumber | string | nullrequired

Show daysSupply fields

Any of · 1: number | string

Any of · 1: number

number

Any of · 2: string

string

Allowed: "Infinity", "-Infinity", "NaN"

Any of · 2: null

null

patientSnapshotobjectrequired

No additional properties

Show patientSnapshot fields

addressobject | null

Show address fields

Any of · 1: object

object

Any of · 2: null

null

allergyReviewStatusstring | null

Show allergyReviewStatus fields

Any of · 1: string

string

Allowed: "no_known", "not_reviewed", "recorded"

Any of · 2: null

null

dateOfBirthstringrequired

emailstring | null

Show email fields

Any of · 1: string

string

Any of · 2: null

null

genderstring | null

Show gender fields

Any of · 1: string

string

Allowed: "f", "m", "o", "u"

Any of · 2: null

null

legalNamestringrequired

phonestring | null

Show phone fields

Any of · 1: string

string

Any of · 2: null

null

statestringrequired

deliveryAddressobject | nullrequired

The saved delivery address for this prescription version. Patient profile updates do not replace it. Review this address before signing.

Show deliveryAddress fields

Any of · 1: object

object

Any of · 2: null

null

deliveryAddressDiffersFromPatientbooleanrequired

Whether the saved delivery address differs from the current primary patient address. This can be intentional; confirm the delivery address before signing.

providerSnapshotobject | nullrequired

Show providerSnapshot fields

Any of · 1: object

addressobject | null

Show address fields

Any of · 1: object

object

Any of · 2: null

null

credentialsstring | null

Show credentials fields

Any of · 1: string

string

Any of · 2: null

null

legalNamestringrequired

licenseNumberstring | null

Show licenseNumber fields

Any of · 1: string

string

Any of · 2: null

null

licenseStatestring | null

Show licenseState fields

Any of · 1: string

string

Any of · 2: null

null

licenseExpiresAtstring | null

Show licenseExpiresAt fields

Any of · 1: string

string

Any of · 2: null

null

npistringrequired

phonestring | null

Show phone fields

Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

clinicalobject | nullrequired

Show clinical fields

Any of · 1: object

allergiesobject[] | null

Show allergies fields

Any of · 1: object[]

Array items · object

codestring | null

Show code fields

Any of · 1: string

string

Any of · 2: null

null

codeSystemstring | null

Show codeSystem fields

Any of · 1: string

string

Any of · 2: null

null

displaystringrequired

sourcestring | null

Show source fields

Any of · 1: string

string

Any of · 2: null

null

categorystring | null

Show category fields

Any of · 1: string

string

Any of · 2: null

null

severitystring | null | null

Show severity fields

Any of · 1: string | null

Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

typestring | null | null

Show type fields

Any of · 1: string | null

Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

verificationStatusstring | null | null

Show verificationStatus fields

Any of · 1: string | null

Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

reactionsobject[] | null

Show reactions fields

Any of · 1: object[]

Array items · object

codestring | null

Show code fields

Any of · 1: string

string

Any of · 2: null

null

codeSystemstring | null

Show codeSystem fields

Any of · 1: string

string

Any of · 2: null

null

displaystringrequired

sourcestring | null

Show source fields

Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

Any of · 2: null

null

medicationReviewStatusstring | null

Show medicationReviewStatus fields

Any of · 1: string

string

Allowed: "not_reviewed", "none", "recorded"

Any of · 2: null

null

diagnosisReviewStatusstring | null

Show diagnosisReviewStatus fields

Any of · 1: string

string

Allowed: "not_reviewed", "none", "recorded"

Any of · 2: null

null

conditionsobject[] | null

Show conditions fields

Any of · 1: object[]

Array items · object

codestring | null

Show code fields

Any of · 1: string

string

Any of · 2: null

null

codeSystemstring | null

Show codeSystem fields

Any of · 1: string

string

Any of · 2: null

null

displaystringrequired

sourcestring | null

Show source fields

Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

compoundingReasonobject | null

Show compoundingReason fields

Any of · 1: object

categorystring | null

Show category fields

Any of · 1: string

string

Any of · 2: null

null

contextstringrequired

Any of · 2: null

null

medicationsobject[] | null

Show medications fields

Any of · 1: object[]

Array items · object

displaystringrequired

ndcstring | null

Show ndc fields

Any of · 1: string

string

Any of · 2: null

null

rxNormCuistring | null

Show rxNormCui fields

Any of · 1: string

string

Any of · 2: null

null

sourcestring | null

Show source fields

Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

observationsobject[] | null

Show observations fields

Any of · 1: object[]

Array items · object

codestring | null

Show code fields

Any of · 1: string

string

Any of · 2: null

null

displaystringrequired

valuenumber | stringrequired

Show value fields

Any of · 1: number

number

Any of · 2: string

string

Allowed: "Infinity", "-Infinity", "NaN"

unitstringrequired

Any of · 2: null

null

Any of · 2: null

null

dispensingobject | nullrequired

Show dispensing fields

Any of · 1: object

dispenseUponAcceptancebooleanrequired

substitutionPermittedbooleanrequired

pharmacyNotesstring | null

Show pharmacyNotes fields

Any of · 1: string

string

Any of · 2: null

null

requestedFillDatestring | null

Show requestedFillDate fields

Any of · 1: string

string

Any of · 2: null

null

shippingOptionIdstring | null

Show shippingOptionId fields

Any of · 1: string

string

Any of · 2: null

null

shippingAmountCentsinteger | null

Show shippingAmountCents fields

Any of · 1: integer

integer

Any of · 2: null

null

shippingDestinationTypestring | null

Show shippingDestinationType fields

Any of · 1: string

string

Allowed: "patient", "practice"

Any of · 2: null

null

Any of · 2: null

null

structuredSigobject | nullrequired

Show structuredSig fields

Any of · 1: object

dosestringrequired

doseUnitstringrequired

frequencystringrequired

routestringrequired

prnbooleanrequired

durationstring | null

Show duration fields

Any of · 1: string

string

Any of · 2: null

null

indicationstring | null

Show indication fields

Any of · 1: string

string

Any of · 2: null

null

maxDailyUsestring | null

Show maxDailyUse fields

Any of · 1: string

string

Any of · 2: null

null

titrationSchedulestring | null

Show titrationSchedule fields

Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

externalPrescriptionIdany & any & any & any | nullrequired

Show externalPrescriptionId fields

Any of · 1: any & any & any & any

All of · 1: any

any

Minimum length: 1

All of · 2: any

any

Maximum length: 200

All of · 3: any

any

Pattern: \S

All of · 4: any

any

Pattern: ^[^\p{Cc}\p{Cs}]*$

Any of · 2: null

null

catalogItemIdany | nullrequired

Show catalogItemId fields

Any of · 1: any

All of · 1: any

any

Pattern: ^cat_[0-7][0-9a-hjkmnp-tv-z]{25}$

Any of · 2: null

null

pharmacyIdany | nullrequired

Show pharmacyId fields

Any of · 1: any

All of · 1: any

any

Pattern: ^pharm_[0-7][0-9a-hjkmnp-tv-z]{25}$

Any of · 2: null

null

pharmacyNamestring | nullrequired

Show pharmacyName fields

Any of · 1: string

string

Any of · 2: null

null

directionsstringrequired

dosageFormstring | nullrequired

Show dosageForm fields

Any of · 1: string

string

Any of · 2: null

null

idanyrequired

Show id fields

All of · 1: any

any

Pattern: ^rx_[0-7][0-9a-hjkmnp-tv-z]{25}$

medicationNamestringrequired

quantitynumber | stringrequired

Show quantity fields

Any of · 1: number

number

Any of · 2: string

string

Allowed: "Infinity", "-Infinity", "NaN"

quantityUnitstringrequired

refillsintegerrequired

statusstringrequired

strengthstring | nullrequired

Show strength fields

Any of · 1: string

string

Any of · 2: null

null

All of · 1: any

any

Minimum items: 1

statusstringrequired

Allowed: "blocked", "cancelled", "delivered", "draft", "partially_submitted", "requires_provider_signature", "processing", "ready", "rejected", "shipped", "submitted"

updatedAtstringrequired

cancellationobjectrequired

No additional properties

Show cancellation fields

statusstringrequired

Allowed: "confirmed", "pending", "partial", "failed"

outcomesobject[]required

Show outcomes fields

Array items · object

cancellationIdstringrequired

Pattern: ^cancl_[0-7][0-9a-hjkmnp-tv-z]{25}$

fulfillmentIdstringrequired

Pattern: ^ord_[0-7][0-9a-hjkmnp-tv-z]{25}$

statusstringrequired

Allowed: "confirmed", "failed", "rejected", "requested", "sent", "too_late"

400HTTP 400

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri

401Unauthorized

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri

403Forbidden

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri

404Not found

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri

409Conflict

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri

422Validation error

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri

429Too many requests

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri