Schemas

Download schema

CutOffTimeSummary

Routine pickup cutoff times and same-day allowance for a location.

routineStartTime

string

Routine pickup window start time.

routineCutOffTime

string

Routine pickup cutoff time.

routinePickUpAllowedToday

boolean

Whether a routine pickup is allowed for this specific calendar day at this location. The schedule cutoff gate requires this to be true in addition to the same-day time window.

TimeZoneResponse

Time zone metadata for the location, passed through when present. The schedule cutoff gate uses `utcOffset` only (not zone labels).

zipCode

string

timeZone

string

Display/label timezone.

utcOffset

string

UTC offset for the location. Prefer integer seconds as a string (for example -14400). Assumed to already reflect DST when applicable.

isDST

boolean

Whether daylight saving time is in effect.

SpecimenPickUpLocation

A single specimen pickup location. Missing optional scalars/objects are omitted; missing `specialInstructions` is returned as an empty array.

locationId

string · required

Pickup location identifier. Use this value as locationId on schedule requests when scheduling against this location.

specialInstructions

string[] · required

Special pickup instructions. Empty array when omitted.

description

string

address

string

locationType

string

regionId

string

standardInstructions

string

CutOffTimeSummary

Routine pickup cutoff times and same-day allowance for a location.

TimeZoneResponse

Time zone metadata for the location, passed through when present. The schedule cutoff gate uses utcOffset only (not zone labels).

SpecimenPickUpLocationsResponse

Response body containing pickup locations for an account.

SpecimenPickUpLocation[] · required

List of pickup locations for the account.

ValidationIssue

id

string · required

Machine-readable error identifier for programmatic handling.

path

string · required

JSONPath-relative expression identifying the field that caused the issue. An empty string indicates a request-level error not attributable to a specific field.

message

string · required

Human-readable description of the issue.

ScheduleSubmitter

Partner-facing submitter identity for schedule requests. Unknown nested properties are ignored.

firstName

string · required

Submitter given name. Trimmed; blank values are rejected.

lastName

string · required

Submitter family name. Trimmed; blank values are rejected.

SchedulePickUpRequest

Schedule request body. This service validates the documented fields: `accountNumber`, `locationId`, `pickUpType` (`REGULAR` only in v1, case-insensitive), nested `submitter.firstName` / `submitter.lastName`, `sendingFacility`, and `sendingApplication`. Other body properties are forwarded upstream unchanged and are unsupported. `accountNumber` and `locationId` are separate properties.

accountNumber

string · pattern: ^\d+$ · required

Partner account number for the pickup.

sendingFacility

string · required

The sending facility identifier. Must match the partner's active service subscription configuration.

sendingApplication

string · required

The sending application identifier (mnemonic). Must match the partner's active service subscription configuration.

locationId

string · required

Pickup location identifier from the locations response (locationId). Distinct from the accountNumber path parameter on GET /locations/{accountNumber}.

pickUpType

string · required

Pickup type. v1 accepts only REGULAR (Routine), matched case-insensitively (for example Regular, regular). STAT and other values are rejected.

ScheduleSubmitter · required

Partner-facing submitter identity for schedule requests. Unknown nested properties are ignored.

specialInstructions

string

Optional free-text instructions for the courier at pickup.

callerName

string

Optional name of the person placing the schedule request.

UserInfo

id

string

name

string

location

string

SchedulePickUpResponse

Response returned on a successful schedule request.

confirmationOrderNumber

string

accountNumber

string

accountName

string

sessionId

string

regionId

string

routeDate

string · date

locationType

string

requestedDateTime

string · date-time

specialInstructions

string

standardInstructions

string

pickUpType

string

Pickup type for the scheduled request. STAT orders are not supported.

firstCallDate

string · date-time

finalCallDate

string · date-time

callerName

string

UserInfo

isSelfService

boolean

trackingId

string

isAssigned

boolean

assignedToFirstName

string

assignedToLastName

string

assignedTo

string

assignedDateTime

string · date-time

tatHours

number · double

courierName

string

dispatcherUser

string

lastUpdatedTimestamp

string

closedTimestamp

string · date-time