Enumerations

The API sends and receives enums as integers. The OpenAPI document lists the permitted values but not their names, so this page is the authoritative mapping.

SearchingContextType

Selects the perspective for any search endpoint.

Value	Name	Returns
`1`	Marketplace	Listings or offers available on the marketplace
`2`	BuyingActivity	Items bought by, or offers made by, the pharmacy
`3`	SellingActivity	Items sold by, or offers accepted by, the pharmacy

MarketplaceListingStatus

The lifecycle of a marketplace listing.

Value	Name	Meaning
`0`	Pending	Live and purchasable. The only state in which it can be updated or cancelled
`1`	Purchased	Bought, awaiting shipment
`2`	Cancelled	Withdrawn
`5`	ShippingConfirmed	Seller has confirmed shipment
`6`	ShippingReceivedConfirmed	Buyer has confirmed receipt
`7`	ShippingReceivedNotConfirmed	Buyer reported the item as not received
`10`	Paused	Temporarily suspended

The values are not contiguous — 3, 4, 8 and 9 are unused. Don’t infer order from the numbers.

MarketplaceListingRequestStatus

The lifecycle of a cash offer. The API calls cash offers “marketplace listing requests” internally; both names refer to the same object.

Value	Name	Meaning
`0`	Pending	Open, awaiting a seller
`1`	Declined	A seller declined it
`2`	Cancelled	The buyer withdrew it
`3`	Accepted	A seller accepted it
`4`	Expired	Passed its ship-by date without being accepted
`10`	Paused	Temporarily suspended

ShippingRequestMethod

How a cash offer wants the item shipped.

Value	Name	Notes
`0`	Custom	Not supported when creating a cash offer through this API
`1`	Cheapest	Least expensive option
`2`	Medium	Requires a positive `maxShippingPrice`
`3`	ASAP	Fastest option

For Cheapest and ASAP, maxShippingPrice must be null or 0.

MarketplaceListingCancellationReason

Why a listing was cancelled. Returned on cancelled listings.

Value	Name	Meaning
`1`	SellerCancelled	The seller cancelled the listing
`2`	PharmacyInventoryQuantityAutoTrigger	An inventory change automatically cancelled it
`3`	AutomaticDrugExpired	The drug reached its expiration date
`4`	BuyerCancelled	The buyer cancelled
`5`	ReturnCompleted	Cancelled because a return completed

DeliveryStatus

Carrier tracking state for a shipped listing.

Value	Name
`0`	Unknown
`1`	PreTransit
`2`	InTransit
`3`	OutForDelivery
`4`	Delivered
`5`	AvailableForPickup
`6`	ReturnToSender
`7`	Failure
`8`	Cancelled
`9`	Error

StorageConditionType

Storage requirement for a drug package.

Value	Name
`10`	RoomTemperature
`20`	Cool
`30`	Refrigerated
`40`	Frozen

Treat these as open sets. New values can be added, so handle an unrecognised integer gracefully rather than throwing.

Get started

Guides

Reference

SearchingContextType

MarketplaceListingStatus

MarketplaceListingRequestStatus

ShippingRequestMethod

MarketplaceListingCancellationReason

DeliveryStatus

StorageConditionType

​SearchingContextType

​MarketplaceListingStatus

​MarketplaceListingRequestStatus

​ShippingRequestMethod

​MarketplaceListingCancellationReason

​DeliveryStatus

​StorageConditionType

SearchingContextType

MarketplaceListingStatus

MarketplaceListingRequestStatus

ShippingRequestMethod

MarketplaceListingCancellationReason

DeliveryStatus

StorageConditionType