API OVERVIEW

Pagination

Request IDs

Versioning

Rate Limits

CLINIC

Clinic

Retrieve a clinic

Fulfillment Catalog

Retrieve the curated catalog available to your store.

California Proposition 65 information, including alternative SKUs, may be included with each individual variant record when the feature is enabled for your store.

Access requires the fulfillment partner permission and the fulfillment:catalog:read OAuth scope.

By default, responses are limited to products in the clinic's catalog. Partners with the fulfillment_full_catalog permission can access the broader Fullscript catalog (excluding restricted brands).

List Products

This endpoint is restricted

This endpoint is not available for general use. Access is highly restricted, and most requests will not be granted. If you believe your case is critical, you may submit a request for consideration. We will only respond if your request is relevant.

Retrieve a paginated list of products.

Arguments

No arguments

GET /api/fulfillment/catalog/products
curl "https://api-us-snd.fullscript.io/api/fulfillment/catalog/products" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

Responses

Get Product Details

This endpoint is restricted

This endpoint is not available for general use. Access is highly restricted, and most requests will not be granted. If you believe your case is critical, you may submit a request for consideration. We will only respond if your request is relevant.

Retrieve full details for one product.

Arguments

id

string

Required

Unique identifier for the product.

GET /api/fulfillment/catalog/products/{id}
curl "https://api-us-snd.fullscript.io/api/fulfillment/catalog/products/{id}" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

Responses

Search for products

This endpoint is restricted

This endpoint is not available for general use. Access is highly restricted, and most requests will not be granted. If you believe your case is critical, you may submit a request for consideration. We will only respond if your request is relevant.

Search for products in the fulfillment catalog using Fullscript's OpenSearch implementation. This endpoint respects store-specific product visibility: by default, only products linked to your store are returned. Partners with the fulfillment_full_catalog permission have access to the broader catalog.

Note: Filter arguments that accept an array can be specified in the query string like this: ?allergen_ids[]=id_1&allergen_ids[]=id_2

Note: This endpoint is gated by a feature flipper and may not be available for all partners.

Arguments

query

string

Search for products matching a query string.

brand_id

string

Search for products by brand_id.

allergen_ids

string

Provide an array of allergen ids to filter results.

ingredient_ids

string

Provide an array of ingredient ids to filter results.

supplement_type_ids

string

Provide an array of supplement type ids to filter results.

third_party_certification_ids

string

Provide an array of third party certification ids to filter results.

page[number]

integer

The page number to retrieve.

page[size]

integer

The number of results per page.

GET /api/fulfillment/catalog/search/products
curl "https://api-us-snd.fullscript.io/api/fulfillment/catalog/search/products" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

Responses

Get Variant Details

This endpoint is restricted

This endpoint is not available for general use. Access is highly restricted, and most requests will not be granted. If you believe your case is critical, you may submit a request for consideration. We will only respond if your request is relevant.

Retrieve full variant information.

Error codes

  • 404 – The Variant ID is either missing, not part of your store's catalog, or invalid.

Arguments

id

string

Required

Unique identifier for the variant.

GET /api/fulfillment/catalog/variants/{id}
curl "https://api-us-snd.fullscript.io/api/fulfillment/catalog/variants/{id}" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

Responses