Skip to content

Preview an order

POST/v1/order-previews

Requires orders:write and catalog:read. Supply exactly one of patientId, patientExternalId, or inline patient details. External-ID lookup additionally requires patients:read; inline details require patients:write. Resolves defaults and explicit edits for 1–20 prescriptions. Reuses stored patient details when identifiers match; otherwise previews inline details without creating a patient. Complete previews contain an orders.create input. Does not create records, reserve prices, sign, charge or transmit. No idempotency key is required. Creation and signing recheck current requirements.

PracticesAPI key authenticationVersion 2026-09-28

Request example

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

{
  "otcItems": [
    {
      "catalogItemId": "cat_01j2y8m6jcc9tt24af5pw9x1bc",
      "quantity": 1
    }
  ],
  "practiceId": "prac_01j2y8m6jcc9tt24af5pw9x1bc",
  "patientId": "pat_01j2y8m6jcc9tt24af5pw9x1bc",
  "patientExternalId": "<string>",
  "patient": {
    "address": {
      "city": "<string>",
      "line1": "<string>",
      "line2": null,
      "postalCode": "<string>",
      "state": "<string>",
      "country": "US"
    },
    "clinicalProfile": {
      "currentMedications": [
        "<string>"
      ],
      "heightInches": 0,
      "reviewedAt": "<string>",
      "weightPounds": 0
    },
    "dateOfBirth": "<string>",
    "email": "<string>",
    "externalId": "<string>",
    "externalIdentities": [
      {
        "source": "<string>",
        "value": "<string>"
      }
    ],
    "addresses": [
      {
        "id": "addr_01j2y8m6jcc9tt24af5pw9x1bc",
        "address": {
          "city": "<string>",
          "country": "US",
          "line1": "<string>",
          "line2": null,
          "postalCode": "<string>",
          "state": "<string>"
        },
        "label": "<string>",
        "preferredShipping": false,
        "recipientName": "<string>"
      }
    ],
    "encounters": [
      {
        "notes": "<string>",
        "occurredAt": "<string>",
        "providerName": "<string>",
        "type": "<string>"
      }
    ],
    "gender": "f",
    "locationId": "loc_01j2y8m6jcc9tt24af5pw9x1bc",
    "metadata": "<string>",
    "medicalRecordNumber": "<string>",
    "measurements": [
      {
        "heightCentimeters": 0,
        "recordedAt": "<string>",
        "source": "<string>",
        "weightKilograms": 0
      }
    ],
    "name": {
      "first": "<string>",
      "last": "<string>",
      "middle": "<string>",
      "preferred": "<string>"
    },
    "phone": "<string>",
    "programs": [
      {
        "endedAt": "<string>",
        "name": "<string>",
        "startedAt": "<string>",
        "status": "active"
      }
    ]
  },
  "userId": "user_01j2y8m6jcc9tt24af5pw9x1bc",
  "prescriber": {
    "id": "prov_01j2y8m6jcc9tt24af5pw9x1bc",
    "npi": "<string>",
    "externalId": "<string>",
    "profile": {
      "email": "<string>",
      "phone": "<string>"
    }
  },
  "shippingAddressId": "addr_01j2y8m6jcc9tt24af5pw9x1bc",
  "externalOrderId": "<string>",
  "prescriptions": [
    {
      "medicationId": "cat_01j2y8m6jcc9tt24af5pw9x1bc",
      "externalPrescriptionId": "<string>",
      "preset": "<string>",
      "expectedRevision": "<string>",
      "overrides": {
        "sig": {
          "format": "structured",
          "fields": {
            "dose": null,
            "doseUnit": null,
            "frequency": null,
            "route": null,
            "prn": null,
            "duration": null,
            "indication": null,
            "maxDailyUse": null,
            "titrationSchedule": null
          }
        },
        "quantity": {
          "value": 0,
          "unit": "<string>"
        },
        "daysSupply": 0,
        "refills": 0,
        "clinical": {
          "compoundingReason": null,
          "medicationReviewStatus": null,
          "diagnosisReviewStatus": null,
          "currentMedications": null,
          "diagnoses": null,
          "observations": null
        },
        "dispensing": {
          "dispenseUponAcceptance": false,
          "shippingOptionId": "shp_01j2y8m6jcc9tt24af5pw9x1bc",
          "shippingAmountCents": 0,
          "shippingDestinationType": "patient",
          "pharmacyNotes": "<string>",
          "requestedFillDate": "<string>",
          "substitutionPermitted": false
        }
      }
    }
  ],
  "shipping": {
    "selection": "manual"
  }
}
curl -X POST 'https://api.affinityrx.com/v1/order-previews' \
  -H "Authorization: Bearer $AFFINITY_API_KEY" \
  -H 'Affinity-Version: 2026-09-28' \
  -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.

{
  "clinicalRequirementsSatisfied": false,
  "clinicalIssues": [
    {
      "code": "<string>",
      "path": "<string>",
      "message": "<string>"
    }
  ],
  "clinicalRequirements": [
    {
      "field": "<string>",
      "label": "<string>",
      "type": "allergy_review",
      "required": false,
      "status": "missing"
    }
  ],
  "otcItems": [
    {
      "catalogItemId": "cat_01j2y8m6jcc9tt24af5pw9x1bc",
      "name": "<string>",
      "quantity": 0,
      "unitPriceCents": 0,
      "subtotalCents": 0
    }
  ],
  "shippingGroups": [
    {
      "key": "<string>",
      "pharmacy": "<string>",
      "label": "<string>",
      "temperature": "ambient",
      "amountCents": 0,
      "itemCount": 0,
      "prescriptionIndexes": [
        0
      ]
    }
  ],
  "totals": {
    "currency": "USD",
    "medicationSubtotalCents": 0,
    "supplySubtotalCents": 0,
    "shippingTotalCents": 0,
    "estimatedTotalCents": 0
  },
  "object": "order_preview",
  "livemode": false,
  "prescriptions": [
    {
      "medicationId": "cat_01j2y8m6jcc9tt24af5pw9x1bc",
      "revision": "<string>",
      "directions": "<string>",
      "structuredSig": {
        "dose": "<string>",
        "doseUnit": "<string>",
        "frequency": "<string>",
        "route": "<string>",
        "prn": false,
        "duration": "<string>",
        "indication": "<string>",
        "maxDailyUse": "<string>",
        "titrationSchedule": "<string>"
      },
      "format": "structured",
      "quantity": {
        "value": 0,
        "unit": "<string>"
      },
      "daysSupply": 0,
      "daysSupplySource": "manual",
      "refills": 0,
      "shippingOptions": [
        {
          "amountCents": "<string>",
          "carrier": "<string>",
          "currency": "USD",
          "estimatedDaysMax": "<string>",
          "estimatedDaysMin": "<string>",
          "id": "shp_01j2y8m6jcc9tt24af5pw9x1bc",
          "label": "<string>",
          "serviceLevel": "<string>",
          "temperature": "ambient"
        }
      ],
      "shippingOptionId": "shp_01j2y8m6jcc9tt24af5pw9x1bc",
      "medicationSubtotalCents": 0,
      "shippingAmountCents": 0
    }
  ],
  "issues": [
    {
      "code": "<string>",
      "path": "<string>",
      "message": "<string>"
    }
  ],
  "status": "complete",
  "orderInput": {
    "otcItems": "<string>",
    "practiceId": "prac_01j2y8m6jcc9tt24af5pw9x1bc",
    "userId": "user_01j2y8m6jcc9tt24af5pw9x1bc",
    "prescriber": {
      "id": "prov_01j2y8m6jcc9tt24af5pw9x1bc",
      "npi": "<string>",
      "externalId": "<string>",
      "profile": {
        "email": null,
        "phone": "<string>"
      }
    },
    "shippingAddressId": "addr_01j2y8m6jcc9tt24af5pw9x1bc",
    "externalOrderId": "<string>",
    "prescriptions": [
      {
        "externalPrescriptionId": "<string>",
        "clinical": {
          "compoundingReason": {
            "category": null,
            "context": null
          },
          "medicationReviewStatus": "not_reviewed",
          "diagnosisReviewStatus": "not_reviewed",
          "currentMedications": null,
          "diagnoses": null,
          "observations": null
        },
        "pharmacyId": "pharm_01j2y8m6jcc9tt24af5pw9x1bc",
        "daysSupply": 1,
        "dispensing": {
          "dispenseUponAcceptance": false,
          "shippingOptionId": "shp_01j2y8m6jcc9tt24af5pw9x1bc",
          "shippingAmountCents": 0,
          "shippingDestinationType": "patient",
          "pharmacyNotes": "<string>",
          "requestedFillDate": "<string>",
          "substitutionPermitted": false
        },
        "directions": "<string>",
        "medicationId": "cat_01j2y8m6jcc9tt24af5pw9x1bc",
        "quantity": 0,
        "quantityUnit": "<string>",
        "refills": 0,
        "structuredSig": {
          "dose": "<string>",
          "doseUnit": "<string>",
          "duration": "<string>",
          "frequency": "<string>",
          "indication": "<string>",
          "maxDailyUse": "<string>",
          "prn": false,
          "route": "<string>",
          "titrationSchedule": "<string>"
        }
      }
    ],
    "patientId": "pat_01j2y8m6jcc9tt24af5pw9x1bc",
    "patient": {
      "address": {
        "city": null,
        "line1": null,
        "line2": null,
        "postalCode": "<string>",
        "state": "<string>",
        "country": null
      },
      "clinicalProfile": {
        "currentMedications": "<string>",
        "heightInches": null,
        "reviewedAt": null,
        "weightPounds": null
      },
      "dateOfBirth": "<string>",
      "email": "<string>",
      "externalId": "<string>",
      "externalIdentities": "<string>",
      "addresses": "<string>",
      "encounters": [
        {
          "notes": null,
          "occurredAt": "<string>",
          "providerName": null,
          "type": null
        }
      ],
      "gender": "f",
      "locationId": "loc_01j2y8m6jcc9tt24af5pw9x1bc",
      "metadata": "<string>",
      "medicalRecordNumber": "<string>",
      "measurements": [
        {
          "heightCentimeters": null,
          "recordedAt": "<string>",
          "source": null,
          "weightKilograms": null
        }
      ],
      "name": {
        "first": "<string>",
        "last": "<string>",
        "middle": null,
        "preferred": null
      },
      "phone": "<string>",
      "programs": [
        {
          "endedAt": null,
          "name": null,
          "startedAt": "<string>",
          "status": "active"
        }
      ]
    }
  }
}
{
  "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": 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.

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.

Request body specification application/json

otcItemsobject[] | null
Show otcItems fields
Any of · 1: object[]

Array items · object

catalogItemIdstringrequired

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

quantityintegerrequired

Minimum: 1

Maximum: 100

Any of · 2: null

null

practiceIdstringrequired

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

patientIdstring | null
Show patientId fields
Any of · 1: string

string

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

Any of · 2: null

null

patientExternalIdstring | null
Show patientExternalId fields
Any of · 1: string

string

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

Any of · 2: null

null

patientobject | null
Show patient fields
Any of · 1: object
addressobject | null | null
Show address fields
Any of · 1: object | null
Any of · 1: object
cityanyrequired

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

Show city fields
All of · 1: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

line1anyrequired

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

Show line1 fields
All of · 1: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

line2any | null | null
Show line2 fields
Any of · 1: any | null
Any of · 1: any
All of · 1: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

Any of · 2: null

null

Any of · 2: null

null

postalCodestringrequired
statestringrequired
countrystring | null
Show country fields
Any of · 1: string

string

Allowed: "US"

Any of · 2: null

null

Any of · 2: null

null

Any of · 2: null

null

clinicalProfileobject | null
Show clinicalProfile fields
Any of · 1: object
currentMedicationsstring[]required

Maximum items: 100

Show currentMedications fields

Array items · string

string

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

heightInchesnumber | string | null | null
Show heightInches fields
Any of · 1: number | string | null
Any of · 1: number | string
Any of · 1: number

number

Greater than: 0

Any of · 2: string

string

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

Any of · 2: null

null

Any of · 2: null

null

reviewedAtstring | null | null
Show reviewedAt fields
Any of · 1: string | null
Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

weightPoundsnumber | string | null | null
Show weightPounds fields
Any of · 1: number | string | null
Any of · 1: number | string
Any of · 1: number

number

Greater than: 0

Any of · 2: string

string

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

Any of · 2: null

null

Any of · 2: null

null

Any of · 2: null

null

dateOfBirthstringrequired

Pattern: ^\d{4}-\d{2}-\d{2}$

emailstring | null | null
Show email fields
Any of · 1: string | null
Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

externalIdstring | null
Show externalId fields
Any of · 1: string

string

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

Any of · 2: null

null

externalIdentitiesobject[] | null
Show externalIdentities fields
Any of · 1: object[]

Array items · object

sourcestringrequired

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

valuestringrequired

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

Any of · 2: null

null

addressesobject[] | null
Show addresses fields
Any of · 1: object[]

Array items · object

idstring | null
Show id fields
Any of · 1: string

string

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

Any of · 2: null

null

addressobjectrequired

No additional properties

Show address fields
cityanyrequired

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

Show city fields
All of · 1: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

countrystring | null
Show country fields
Any of · 1: string

string

Allowed: "US"

Any of · 2: null

null

line1anyrequired

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

Show line1 fields
All of · 1: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

line2any | null | null
Show line2 fields
Any of · 1: any | null
Any of · 1: any
All of · 1: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

Any of · 2: null

null

Any of · 2: null

null

postalCodestringrequired
statestringrequired
labelstringrequired

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

preferredShippingbooleanrequired
recipientNameany | nullrequired
Show recipientName fields
Any of · 1: any
All of · 1: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

Any of · 2: null

null

Any of · 2: null

null

encountersobject[] | null
Show encounters fields
Any of · 1: object[]

Array items · object

notesstring | nullrequired
Show notes fields
Any of · 1: string

string

Maximum length: 5000

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

Any of · 2: null

null

occurredAtstringrequired
providerNamestring | nullrequired
Show providerName fields
Any of · 1: string

string

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

Any of · 2: null

null

typestringrequired

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

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

locationIdstring | null
Show locationId fields
Any of · 1: string

string

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

Any of · 2: null

null

metadataobject | null
Show metadata fields
Any of · 1: object

object

Any of · 2: null

null

medicalRecordNumberstring | null | null
Show medicalRecordNumber fields
Any of · 1: string | null
Any of · 1: string

string

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

Any of · 2: null

null

Any of · 2: null

null

measurementsobject[] | null
Show measurements fields
Any of · 1: object[]

Array items · object

heightCentimetersnumber | string | nullrequired
Show heightCentimeters fields
Any of · 1: number | string
Any of · 1: number

number

Greater than: 0

Any of · 2: string

string

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

Any of · 2: null

null

recordedAtstringrequired
sourcestringrequired

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

weightKilogramsnumber | string | nullrequired
Show weightKilograms fields
Any of · 1: number | string
Any of · 1: number

number

Greater than: 0

Any of · 2: string

string

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

Any of · 2: null

null

Any of · 2: null

null

nameobjectrequired

No additional properties

Show name fields
firstanyrequired

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

Show first fields
All of · 1: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

lastanyrequired

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

Show last fields
All of · 1: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

middleany | null | null
Show middle fields
Any of · 1: any | null
Any of · 1: any
All of · 1: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

Any of · 2: null

null

Any of · 2: null

null

preferredany | null | null
Show preferred fields
Any of · 1: any | null
Any of · 1: any
All of · 1: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

Any of · 2: null

null

Any of · 2: null

null

phonestring | null | null
Show phone fields
Any of · 1: string | null
Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

programsobject[] | null
Show programs fields
Any of · 1: object[]

Array items · object

endedAtstring | nullrequired
Show endedAt fields
Any of · 1: string

string

Any of · 2: null

null

namestringrequired

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

startedAtstringrequired
statusstringrequired

Allowed: "active", "completed", "paused"

Any of · 2: null

null

Any of · 2: null

null

userIdstring | null
Show userId fields
Any of · 1: string

string

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

Any of · 2: null

null

prescriberobject | null
Show prescriber fields
Any of · 1: object
idstring | null
Show id fields
Any of · 1: string

string

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

Any of · 2: null

null

npistring | null
Show npi fields
Any of · 1: string

string

Any of · 2: null

null

externalIdstring | null
Show externalId fields
Any of · 1: string

string

Any of · 2: null

null

profileobject | null
Show profile fields
Any of · 1: object
emailstring | null
Show email fields
Any of · 1: string

string

Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$

Any of · 2: null

null

phonestring | null
Show phone fields
Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

Any of · 2: null

null

shippingAddressIdstring | null
Show shippingAddressId fields
Any of · 1: string

string

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

Any of · 2: null

null

externalOrderIdstring | null
Show externalOrderId fields
Any of · 1: string

string

Maximum length: 200

Any of · 2: null

null

prescriptionsobject[]required

Minimum items: 1

Maximum items: 20

Show prescriptions fields

Array items · object

medicationIdstringrequired

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

externalPrescriptionIdany | null
Show externalPrescriptionId fields
Any of · 1: any
All of · 1: any

any

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

Any of · 2: null

null

presetstring | null
Show preset fields
Any of · 1: string

string

Maximum length: 100

Any of · 2: null

null

expectedRevisionstring | null
Show expectedRevision fields
Any of · 1: string

string

Maximum length: 100

Any of · 2: null

null

overridesobject | null
Show overrides fields
Any of · 1: object
sigobject | null
Show sig fields
Any of · 1: object
Any of · 1: object
formatstringrequired

Allowed: "structured"

fieldsobjectrequired

No additional properties

Show fields fields
dosestringrequired
doseUnitstringrequired
frequencystringrequired
routestringrequired
prnboolean | null
Show prn fields
Any of · 1: boolean

boolean

Any of · 2: null

null

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: object
formatstringrequired

Allowed: "free_text"

textstringrequired
Any of · 3: object
formatstringrequired

Allowed: "template"

templateIdstringrequired

Maximum length: 100

templateRevisionstringrequired

Maximum length: 100

valuesobjectrequired
Any of · 2: null

null

quantityobject | null | null
Show quantity fields
Any of · 1: object | null
Any of · 1: object
valuenumberrequired
unitstringrequired
Any of · 2: null

null

Any of · 2: null

null

daysSupplyinteger | null | null
Show daysSupply fields
Any of · 1: integer | null
Any of · 1: integer

integer

Any of · 2: null

null

Any of · 2: null

null

refillsinteger | null
Show refills fields
Any of · 1: integer

integer

Minimum: 0

Maximum: 99

Any of · 2: null

null

clinicalobject | null | null
Show clinical fields
Any of · 1: object | null
Any of · 1: object
compoundingReasonobject | null
Show compoundingReason fields
Any of · 1: object
categorystring | null
Show category fields
Any of · 1: string

string

Allowed: "alcohol_free", "drug_shortage", "commercial_product_discontinued", "modified_release", "inactive_ingredient_sensitivity", "inactive_ingredient_toxicity", "concentration_adjustment", "alternate_route", "dosage_form_unavailable", "flavor_adjustment", "tablet_burden", "patient_cannot_use_commercial_product", "no_approved_product_available", "no_rationale_required", "other_patient_specific_need"

Any of · 2: null

null

contextstring | null
Show context fields
Any of · 1: string

string

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

currentMedicationsstring[] | null
Show currentMedications fields
Any of · 1: string[]

Array items · string

string

Any of · 2: null

null

diagnosesobject[] | null
Show diagnoses fields
Any of · 1: object[]

Array items · object

codestringrequired
displaystringrequired
Any of · 2: null

null

observationsobject[] | null
Show observations fields
Any of · 1: object[]

Array items · object

displaystringrequired
unitstringrequired
valuenumber | stringrequired
Show value fields
Any of · 1: number

number

Greater than: 0

Any of · 2: string

string

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

Any of · 2: null

null

Any of · 2: null

null

Any of · 2: null

null

dispensingobject | null
Show dispensing fields
Any of · 1: object
dispenseUponAcceptanceboolean | null
Show dispenseUponAcceptance fields
Any of · 1: boolean

boolean

Any of · 2: null

null

shippingOptionIdstring | null
Show shippingOptionId fields
Any of · 1: string

string

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

Any of · 2: null

null

shippingAmountCentsinteger | null

Reviewed customer shipping rate for the selected service. Preview supplies this value. Shared group rates must not be summed per prescription.

Show shippingAmountCents fields
Any of · 1: integer

integer

Minimum: 0

Any of · 2: null

null

shippingDestinationTypestring | null
Show shippingDestinationType fields
Any of · 1: string

string

Allowed: "patient"

Any of · 2: null

null

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

Pattern: ^\d{4}-\d{2}-\d{2}$

Any of · 2: null

null

substitutionPermittedboolean | null
Show substitutionPermitted fields
Any of · 1: boolean

boolean

Any of · 2: null

null

Any of · 2: null

null

Any of · 2: null

null

shippingobject | null
Show shipping fields
Any of · 1: object
selectionstring | null
Show selection fields
Any of · 1: string

string

Allowed: "manual", "lowest_cost", "fastest"

Any of · 2: null

null

Any of · 2: null

null

Response specifications

200Successful response

application/json

clinicalRequirementsSatisfiedbooleanrequired
clinicalIssuesobject[]required
Show clinicalIssues fields

Array items · object

codestringrequired
pathstringrequired
messagestringrequired
clinicalRequirementsobject[]required
Show clinicalRequirements fields

Array items · object

fieldstringrequired
labelstringrequired
typestringrequired

Allowed: "allergy_review", "medication_review", "diagnosis_review", "diagnosis"

requiredbooleanrequired
statusstringrequired

Allowed: "missing", "satisfied"

otcItemsobject[]required

Maximum items: 20

Show otcItems fields

Array items · object

catalogItemIdstringrequired

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

namestringrequired
quantityintegerrequired
unitPriceCentsintegerrequired
subtotalCentsintegerrequired
shippingGroupsobject[]required

Maximum items: 20

Show shippingGroups fields

Array items · object

keystringrequired
pharmacystringrequired
labelstringrequired
temperaturestringrequired

Allowed: "ambient", "refrigerated"

amountCentsintegerrequired
itemCountintegerrequired
prescriptionIndexesinteger[]required

Zero-based indexes into the preview prescriptions array. This is an estimated shipping charge group, not a guarantee of one physical package.

Show prescriptionIndexes fields

Array items · integer

integer

totalsobjectrequired

No additional properties

Show totals fields
currencystringrequired

Allowed: "USD"

medicationSubtotalCentsinteger | nullrequired
Show medicationSubtotalCents fields
Any of · 1: integer

integer

Any of · 2: null

null

supplySubtotalCentsinteger | nullrequired
Show supplySubtotalCents fields
Any of · 1: integer

integer

Any of · 2: null

null

shippingTotalCentsinteger | nullrequired
Show shippingTotalCents fields
Any of · 1: integer

integer

Any of · 2: null

null

estimatedTotalCentsinteger | nullrequired
Show estimatedTotalCents fields
Any of · 1: integer

integer

Any of · 2: null

null

objectstringrequired

Allowed: "order_preview"

livemodebooleanrequired
prescriptionsobject[]required
Show prescriptions fields

Array items · object

medicationIdstringrequired

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

revisionstringrequired

Maximum length: 100

directionsstringrequired
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

formatstringrequired

Allowed: "structured", "free_text"

quantityobject | nullrequired
Show quantity fields
Any of · 1: object
valuenumberrequired
unitstringrequired
Any of · 2: null

null

daysSupplyinteger | nullrequired
Show daysSupply fields
Any of · 1: integer

integer

Any of · 2: null

null

daysSupplySourcestringrequired

Allowed: "manual", "calculated", "preset", "missing"

refillsintegerrequired
shippingOptionsobject[]required

Maximum items: 50

Show shippingOptions fields

Array items · object

amountCentsanyrequired
Show amountCents fields
All of · 1: any

any

Minimum: 0

carrierstring | nullrequired
Show carrier fields
Any of · 1: string

string

Any of · 2: null

null

currencystringrequired

Allowed: "USD"

estimatedDaysMaxany | nullrequired
Show estimatedDaysMax fields
Any of · 1: any
All of · 1: any

any

Minimum: 0

Any of · 2: null

null

estimatedDaysMinany | nullrequired
Show estimatedDaysMin fields
Any of · 1: any
All of · 1: any

any

Minimum: 0

Any of · 2: null

null

idanyrequired
Show id fields
All of · 1: any

any

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

labelstringrequired
serviceLevelstringrequired
temperaturestringrequired

Allowed: "ambient", "refrigerated"

shippingOptionIdstring | nullrequired
Show shippingOptionId fields
Any of · 1: string

string

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

Any of · 2: null

null

medicationSubtotalCentsinteger | nullrequired
Show medicationSubtotalCents fields
Any of · 1: integer

integer

Any of · 2: null

null

shippingAmountCentsinteger | nullrequired
Show shippingAmountCents fields
Any of · 1: integer

integer

Any of · 2: null

null

issuesobject[]required
Show issues fields

Array items · object

codestringrequired
pathstringrequired
messagestringrequired
statusstringrequired

Allowed: "complete", "incomplete"

orderInputobject | nullrequired
Show orderInput fields
Any of · 1: object
otcItemsany | null
Show otcItems fields
Any of · 1: any

Array items · object

catalogItemIdanyrequired
Show catalogItemId fields
All of · 1: any

any

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

quantityanyrequired
Show quantity fields
All of · 1: any

any

Minimum: 1

Maximum: 100

All of · 1: any

any

Maximum items: 20

Any of · 2: null

null

practiceIdstringrequired

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

userIdany | null
Show userId fields
Any of · 1: any
All of · 1: any

any

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

Any of · 2: null

null

prescriberobject | null
Show prescriber fields
Any of · 1: object
idany | null
Show id 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

npistring | null
Show npi fields
Any of · 1: string

string

Any of · 2: null

null

externalIdstring | null
Show externalId fields
Any of · 1: string

string

Any of · 2: null

null

profileobject | null
Show profile fields
Any of · 1: object
emailany | null
Show email fields
Any of · 1: any
All of · 1: any

any

Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$

Any of · 2: null

null

phonestring | null
Show phone fields
Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

Any of · 2: null

null

shippingAddressIdany | null
Show shippingAddressId fields
Any of · 1: any
All of · 1: any

any

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

Any of · 2: null

null

externalOrderIdany & any & any & any | null
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

prescriptionsobject[]required
Show prescriptions fields

Array items · object

externalPrescriptionIdany & any & any & any | null
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

clinicalobject | null
Show clinical fields
Any of · 1: object
compoundingReasonobject | null
Show compoundingReason fields
Any of · 1: object
categorystring | null
Show category fields
Any of · 1: string

string

Allowed: "alcohol_free", "drug_shortage", "commercial_product_discontinued", "modified_release", "inactive_ingredient_sensitivity", "inactive_ingredient_toxicity", "concentration_adjustment", "alternate_route", "dosage_form_unavailable", "flavor_adjustment", "tablet_burden", "patient_cannot_use_commercial_product", "no_approved_product_available", "no_rationale_required", "other_patient_specific_need"

Any of · 2: null

null

contextstring | null
Show context fields
Any of · 1: string

string

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

currentMedicationsany | null
Show currentMedications fields
Any of · 1: any

Array items · string

string

All of · 1: any

any

Maximum items: 100

Any of · 2: null

null

diagnosesany | null
Show diagnoses fields
Any of · 1: any

Array items · object

codestringrequired
displaystringrequired
All of · 1: any

any

Maximum items: 20

Any of · 2: null

null

observationsany | null
Show observations fields
Any of · 1: any

Array items · object

displaystringrequired
unitstringrequired
valueany | stringrequired
Show value fields
Any of · 1: any
All of · 1: any

any

Greater than: 0

Any of · 2: string

string

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

All of · 1: any

any

Maximum items: 20

Any of · 2: null

null

Any of · 2: null

null

pharmacyIdany | null
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

daysSupplyintegerrequired

Minimum: 1

Maximum: 365

dispensingobjectrequired

No additional properties

Show dispensing fields
dispenseUponAcceptanceboolean | null
Show dispenseUponAcceptance fields
Any of · 1: boolean

boolean

Any of · 2: null

null

shippingOptionIdstring | null
Show shippingOptionId fields
Any of · 1: string

string

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

Any of · 2: null

null

shippingAmountCentsinteger | null

Reviewed customer shipping rate for the selected service. Preview supplies this value. Shared group rates must not be summed per prescription.

Show shippingAmountCents fields
Any of · 1: integer

integer

Minimum: 0

Any of · 2: null

null

shippingDestinationTypestring | null
Show shippingDestinationType fields
Any of · 1: string

string

Allowed: "patient"

Any of · 2: null

null

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

Pattern: ^\d{4}-\d{2}-\d{2}$

Any of · 2: null

null

substitutionPermittedboolean | null
Show substitutionPermitted fields
Any of · 1: boolean

boolean

Any of · 2: null

null

directionsstringrequired
medicationIdstringrequired

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

quantitynumberrequired
quantityUnitstringrequired
refillsintegerrequired

Minimum: 0

Maximum: 99

structuredSigobject | null
Show structuredSig fields
Any of · 1: object
dosestringrequired
doseUnitstringrequired
durationstring | null
Show duration fields
Any of · 1: string

string

Any of · 2: null

null

frequencystringrequired
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

prnboolean | null
Show prn fields
Any of · 1: boolean

boolean

Any of · 2: null

null

routestringrequired
titrationSchedulestring | null
Show titrationSchedule fields
Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

patientIdstring | null
Show patientId fields
Any of · 1: string

string

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

Any of · 2: null

null

patientobject | null
Show patient fields
Any of · 1: object
addressobject | null | null
Show address fields
Any of · 1: object | null
Any of · 1: object
cityany & anyrequired
Show city fields
All of · 1: any

any

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

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

line1any & anyrequired
Show line1 fields
All of · 1: any

any

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

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

line2any & any | null | null
Show line2 fields
Any of · 1: any & any | null
Any of · 1: any & any
All of · 1: any

any

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

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

Any of · 2: null

null

Any of · 2: null

null

postalCodestringrequired
statestringrequired
countrystring | null
Show country fields
Any of · 1: string

string

Allowed: "US"

Any of · 2: null

null

Any of · 2: null

null

Any of · 2: null

null

clinicalProfileobject | null
Show clinicalProfile fields
Any of · 1: object
currentMedicationsanyrequired
Show currentMedications fields

Array items · any

All of · 1: any

any

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

All of · 1: any

any

Maximum items: 100

heightInchesany | string | null | null
Show heightInches fields
Any of · 1: any | string | null
Any of · 1: any | string
Any of · 1: any
All of · 1: any

any

Greater than: 0

Any of · 2: string

string

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

Any of · 2: null

null

Any of · 2: null

null

reviewedAtstring | null | null
Show reviewedAt fields
Any of · 1: string | null
Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

weightPoundsany | string | null | null
Show weightPounds fields
Any of · 1: any | string | null
Any of · 1: any | string
Any of · 1: any
All of · 1: any

any

Greater than: 0

Any of · 2: string

string

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

Any of · 2: null

null

Any of · 2: null

null

Any of · 2: null

null

dateOfBirthanyrequired
Show dateOfBirth fields
All of · 1: any

any

Pattern: ^\d{4}-\d{2}-\d{2}$

emailstring | null | null
Show email fields
Any of · 1: string | null
Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

externalIdany | null
Show externalId fields
Any of · 1: any
All of · 1: any

any

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

Any of · 2: null

null

externalIdentitiesany | null
Show externalIdentities fields
Any of · 1: any

Array items · object

sourceanyrequired
Show source fields
All of · 1: any

any

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

valueanyrequired
Show value fields
All of · 1: any

any

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

All of · 1: any

any

Maximum items: 50

Any of · 2: null

null

addressesany | null
Show addresses fields
Any of · 1: any

Array items · object

idany | null
Show id fields
Any of · 1: any
All of · 1: any

any

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

Any of · 2: null

null

addressobjectrequired

No additional properties

Show address fields
cityany & anyrequired
Show city fields
All of · 1: any

any

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

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

countrystring | null
Show country fields
Any of · 1: string

string

Allowed: "US"

Any of · 2: null

null

line1any & anyrequired
Show line1 fields
All of · 1: any

any

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

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

line2any & any | null | null
Show line2 fields
Any of · 1: any & any | null
Any of · 1: any & any
All of · 1: any

any

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

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

Any of · 2: null

null

Any of · 2: null

null

postalCodestringrequired
statestringrequired
labelanyrequired
Show label fields
All of · 1: any

any

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

preferredShippingbooleanrequired
recipientNameany & any | nullrequired
Show recipientName fields
Any of · 1: any & any
All of · 1: any

any

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

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

Any of · 2: null

null

All of · 1: any

any

Maximum items: 50

Any of · 2: null

null

encountersobject[] | null
Show encounters fields
Any of · 1: object[]

Array items · object

notesany & any | nullrequired
Show notes fields
Any of · 1: any & any
All of · 1: any

any

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

All of · 2: any

any

Maximum length: 5000

Any of · 2: null

null

occurredAtstringrequired
providerNameany | nullrequired
Show providerName fields
Any of · 1: any
All of · 1: any

any

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

Any of · 2: null

null

typeanyrequired
Show type fields
All of · 1: any

any

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

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

locationIdany | null
Show locationId fields
Any of · 1: any
All of · 1: any

any

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

Any of · 2: null

null

metadataobject | null
Show metadata fields
Any of · 1: object

object

Any of · 2: null

null

medicalRecordNumberany | null | null
Show medicalRecordNumber fields
Any of · 1: any | null
Any of · 1: any
All of · 1: any

any

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

Any of · 2: null

null

Any of · 2: null

null

measurementsobject[] | null
Show measurements fields
Any of · 1: object[]

Array items · object

heightCentimetersany | string | nullrequired
Show heightCentimeters fields
Any of · 1: any | string
Any of · 1: any
All of · 1: any

any

Greater than: 0

Any of · 2: string

string

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

Any of · 2: null

null

recordedAtstringrequired
sourceanyrequired
Show source fields
All of · 1: any

any

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

weightKilogramsany | string | nullrequired
Show weightKilograms fields
Any of · 1: any | string
Any of · 1: any
All of · 1: any

any

Greater than: 0

Any of · 2: string

string

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

Any of · 2: null

null

Any of · 2: null

null

nameobjectrequired

No additional properties

Show name fields
firstany & anyrequired
Show first fields
All of · 1: any

any

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

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

lastany & anyrequired
Show last fields
All of · 1: any

any

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

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

middleany & any | null | null
Show middle fields
Any of · 1: any & any | null
Any of · 1: any & any
All of · 1: any

any

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

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

Any of · 2: null

null

Any of · 2: null

null

preferredany & any | null | null
Show preferred fields
Any of · 1: any & any | null
Any of · 1: any & any
All of · 1: any

any

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

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

Any of · 2: null

null

Any of · 2: null

null

phonestring | null | null
Show phone fields
Any of · 1: string | null
Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

programsobject[] | null
Show programs fields
Any of · 1: object[]

Array items · object

endedAtstring | nullrequired
Show endedAt fields
Any of · 1: string

string

Any of · 2: null

null

nameanyrequired
Show name fields
All of · 1: any

any

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

startedAtstringrequired
statusstringrequired

Allowed: "active", "completed", "paused"

Any of · 2: null

null

Any of · 2: null

null

Any of · 2: null

null

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

429Too many requests

application/json

codestringrequired
dataobject
detailstringrequired
instancestringrequired
requestIdstringrequired
statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired
traceIdstring
typestringrequired

Format: uri

Type to search…

↑↓ navigate↵ selectEsc close