Truepill Fulfillment API

openapi: 3.2.0
info:
  title: Truepill & Orders Fulfillment API
  description: 'Order placement and fulfillment operations: orders, fill requests and scheduled fill requests, cancel/update requests, same-day delivery and pickup locations, specialty pharmacies, availability, scheduling, and prescriber records.


    Harvested verbatim from the live Truepill (FuzeRx) Swagger 2.0 contract published at https://rxapi.fuzehealth.com/swagger.json and split by resource domain. Operation summaries, descriptions, parameters, schemas and response codes are the provider''s own; only the Swagger 2.0 -> OpenAPI 3.0.3 conversion and the domain split are ours.'
  version: 0.0.1
  contact:
    name: FuzeRx Support
    url: https://rxdocs.fuzehealth.com
servers:
- url: https://rxapi.fuzehealth.com
  description: Production
security:
- apiKey: []
tags:
- name: fulfillment
  description: 'Order placement and fulfillment operations: orders, fill requests and scheduled fill requests, cancel/update requests, same-day delivery and pickup locations, specialty pharmacies, availability, scheduling, and prescriber records.'
paths:
  /api/v1/availability:
    get:
      summary: Get NDC availability
      operationId: getApiV1Availability
      tags:
      - fulfillment
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
  /api/v1/cancel_request:
    post:
      summary: Cancel Fill Request
      description: Cancel a Fill Request whose `request_id` field matches the respective user provided text parameter
      operationId: postApiV1Cancel_request
      tags:
      - fulfillment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model118'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model124'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model125'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model126'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model127'
  /api/v1/fill_request:
    post:
      summary: Create Fill Request
      description: Generate a Fill Request to fill/refill prescriptions and order Over-the-Counter (OTC) products<br/><br/>The prescriptions and products requested can be shipped to your patient with various shipping methods.<br/><br/>When making a Fill Request, the patient will be referenced with a `patient_token` being passed into the request body. If you do not have a `patient_token` for your Patient, one can be created using the Patient Create endpoint.<br/><br/>On a successful submission of the Fill Request, a fill request token will be provided that is used to reference the Fill Request (similar to `prescription_token` and `patient_token`).<br/><br/>This attribute is returned under the field `request_id`.<br/><br/>Many fields for the Fill Request may or may not be required depending on what values are passed in. Please reference the field information carefully.<br/><br/>The `metadata` field acts as a link between the Fill Request in the Truepill and the customer systems. It will be provided in all subsequent Fill Request notifications as the order is processed.
      operationId: postApiV1Fill_request
      tags:
      - fulfillment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model147'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model149'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model152'
  /api/v1/fill_request/{url_token}:
    get:
      summary: Get Fill Request by token
      description: Once a Fill Request has been submitted, you can look up the request payload that was submitted at any time for reference with an API request<br/><br/>This endpoint requires a `request_token`. You will receive a `request_token` upon a successful Fill Request API submission response in the `request_id` field.
      operationId: getApiV1Fill_requestUrl_token
      tags:
      - fulfillment
      parameters:
      - name: url_token
        in: path
        required: true
        description: URL token
        schema:
          type: string
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model21'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model50'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model51'
  /api/v1/fill_request/{url_token}/stripe_payment:
    put:
      summary: Update a Fill Request's stripe payment
      operationId: putApiV1Fill_requestUrl_tokenStripe_payment
      tags:
      - fulfillment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model235'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model237'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model238'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model239'
  /api/v1/fill_requests:
    get:
      summary: Get a list of fill requests
      description: Returns a list of fill requests and allows for the use of query parameters to scope the results of the request
      operationId: getApiV1Fill_requests
      tags:
      - fulfillment
      parameters:
      - name: created_at
        in: query
        schema:
          type: string
      - name: limit
        in: query
        schema:
          type: number
          maximum: 100
      - name: next
        in: query
        schema:
          type: string
      - name: metadata
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model22'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model9'
  /api/v1/fuzion_test:
    post:
      summary: Fuzion test endpoint
      operationId: postApiV1Fuzion_test
      tags:
      - fulfillment
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
  /api/v1/nearby_same_day_pickup_locations:
    get:
      summary: Search for nearby same day pickup locations using address details
      operationId: getApiV1Nearby_same_day_pickup_locations
      tags:
      - fulfillment
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
  /api/v1/open-api/api.yml:
    get:
      summary: Get current OpenAPI spec for Truepill APIs
      operationId: getApiV1OpenapiApiyml
      tags:
      - fulfillment
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
  /api/v1/order:
    post:
      summary: Create Order
      description: Generate an order to fill/refill prescriptions and order Over-the-Counter (OTC) products, allowing multiple patient's prescriptions to be filled as part of the same order<br/><br/>The prescriptions and products requested can be shipped to your patient with various shipping methods.<br/><br/>When making an order, the patients will be referenced with a `patient_token` being passed into the request body, inside the items array. If you do not have a `patient_token` for your patients, they can be created using the Patient Create endpoint.<br/><br/>On a successful submission of the order, an order token will be provided that is used to reference the Order (similar to `prescription_token` and `patient_token`).<br/><br/>This attribute is returned under the field `order_id`.<br/><br/>Many fields for the Order may or may not be required depending on what values are passed in. Please reference the field information carefully.<br/><br/>The `metadata` field acts as a link between the Order in the Truepill and the customer systems. It will be provided in all subsequent Order notifications as the order is processed.
      operationId: postApiV1Order
      tags:
      - fulfillment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/icd_codes'
      responses:
        '202':
          description: '202'
        '400':
          description: '400'
        '401':
          description: '401'
        '404':
          description: '404'
  /api/v1/order/{token}:
    get:
      summary: Get Order
      description: Get the details of an order<br/><br/>This endpoints needs the url_token to retrieve the right data
      operationId: getApiV1OrderToken
      tags:
      - fulfillment
      responses:
        '400':
          description: '400'
        '401':
          description: '401'
        '404':
          description: '404'
  /api/v1/prescriber:
    post:
      summary: Create Prescriber
      description: Create a prescriber in the Truepill ecosystem that is assigned to you as a customer
      operationId: postApiV1Prescriber
      tags:
      - fulfillment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model163'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model164'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model167'
  /api/v1/prescriber/{prescriber_token}:
    get:
      summary: Get Prescriber
      description: Get the prescriber information at any time using the `prescriber_token` that was provided in the Create Prescriber response
      operationId: getApiV1PrescriberPrescriber_token
      tags:
      - fulfillment
      parameters:
      - name: prescriber_token
        in: path
        required: true
        description: Prescriber token
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model60'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model61'
  /api/v1/same_day_delivery:
    get:
      summary: Get same day delivery orders
      description: Get same day delivery orders
      operationId: getApiV1Same_day_delivery
      tags:
      - fulfillment
      parameters:
      - name: next_page_token
        in: query
        schema:
          type: string
          minLength: 0
      - name: status
        in: query
        schema:
          type: string
          enum:
          - PENDING
          - FAILED
          - AWAITING_PICKUP
          - IN_TRANSIT
          - DELIVERED
          - CANCELED
          - INCOMPLETE
      - name: limit
        in: query
        schema:
          type: number
          default: 20
          minimum: 1
          maximum: 1000
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
    post:
      summary: Create a same day delivery order
      description: Create a same day delivery order
      operationId: postApiV1Same_day_delivery
      tags:
      - fulfillment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model173'
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
  /api/v1/same_day_delivery/{id}:
    get:
      summary: Get a specific same day delivery order by ID
      description: Get a specific same day delivery order by ID
      operationId: getApiV1Same_day_deliveryId
      tags:
      - fulfillment
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
  /api/v1/specialty_pharmacies:
    get:
      summary: Fetch specialty pharmacies based on Rx token (for prescriber NPI) and insurance token (for bin, pcn, group)
      operationId: getApiV1Specialty_pharmacies
      tags:
      - fulfillment
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
  /api/v1/update_request:
    post:
      summary: Update Fill Request
      description: Amend the fields of an existing Fill Request, such as for correcting an address or changing the shipping method to expedite your order.<br/><br/>When using this endpoint, all the Fill Request fields must be provided with their appropriate values even if they are not to be updated.
      operationId: postApiV1Update_request
      tags:
      - fulfillment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model182'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model184'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model187'
  /scheduled-actions:
    get:
      summary: Get scheduled actions list with any action type by current customer
      operationId: getScheduledactions
      tags:
      - fulfillment
      parameters:
      - name: limit
        in: query
        description: The quantity of scheduled actions items per query/page
        schema:
          type: integer
          default: 20
          minimum: 1
          maximum: 100
      - name: nextPageToken
        in: query
        description: Next page token is the base64 encoded cursor (created action date) from which to start paginated list
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getScheduledActions.data'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model3'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model2'
  /scheduled-fill-requests:
    get:
      summary: Retrieve details for a scheduled fill request by id.
      description: Include either original_fill_request_token or id in the query parameters.
      operationId: getScheduledfillrequests
      tags:
      - fulfillment
      parameters:
      - name: id
        in: query
        schema:
          type: string
      - name: original_fill_request_token
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model4'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model3'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model2'
    post:
      summary: Reschedule a fill request that was submitted too soon.
      operationId: postScheduledfillrequests
      tags:
      - fulfillment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POST%20ScheduledFill%20Request%20Payload'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model113'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model3'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model2'
  /scheduled-fill-requests/{id}:
    put:
      summary: Update details for on scheduled fill request.
      operationId: putScheduledfillrequestsId
      tags:
      - fulfillment
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUT%20ScheduledFill%20Request%20Payload'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model113'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model3'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model2'
    delete:
      summary: Delete a scheduled fill request.
      operationId: deleteScheduledfillrequestsId
      tags:
      - fulfillment
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model240'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model2'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model3'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model2'
  /v0/schedule:
    get:
      summary: Return available open slots for any provider that can be used to create consults and schedule appointments on these slots.
      description: Returns schedule availability of providers based on given parameters
      operationId: getV0Schedule
      tags:
      - fulfillment
      parameters:
      - name: start
        in: query
        required: true
        description: The time starting from which free slots will be returned. Should be greater than the current time.
        schema:
          type: string
          format: date-time
      - name: end
        in: query
        required: true
        description: The end time up to which free slots will be returned.
        schema:
          type: string
          format: date-time
      - name: questionnaire
        in: query
        required: true
        description: Unique identifier for the questionnaire that providers have enabled scheduling for.
        schema:
          type: string
      - name: state
        in: query
        required: true
        description: Two letter abbreviation of provider’s licensed state used as a filter.
        schema:
          type: string
          pattern: ^[A-Z]{2}$
      - name: duration
        in: query
        description: The duration of each returned slot in minutes.
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model11'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model13'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model8'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model14'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model9'
  /v1/availability:
    get:
      summary: Get NDC availability
      operationId: getV1Availability
      tags:
      - fulfillment
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
  /v1/cancel_request:
    post:
      summary: Cancel Fill Request
      description: Cancel a Fill Request whose `request_id` field matches the respective user provided text parameter
      operationId: postV1Cancel_request
      tags:
      - fulfillment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model118'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model124'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model125'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model126'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model127'
  /v1/fill_request:
    post:
      summary: Create Fill Request
      description: Generate a Fill Request to fill/refill prescriptions and order Over-the-Counter (OTC) products<br/><br/>The prescriptions and products requested can be shipped to your patient with various shipping methods.<br/><br/>When making a Fill Request, the patient will be referenced with a `patient_token` being passed into the request body. If you do not have a `patient_token` for your Patient, one can be created using the Patient Create endpoint.<br/><br/>On a successful submission of the Fill Request, a fill request token will be provided that is used to reference the Fill Request (similar to `prescription_token` and `patient_token`).<br/><br/>This attribute is returned under the field `request_id`.<br/><br/>Many fields for the Fill Request may or may not be required depending on what values are passed in. Please reference the field information carefully.<br/><br/>The `metadata` field acts as a link between the Fill Request in the Truepill and the customer systems. It will be provided in all subsequent Fill Request notifications as the order is processed.
      operationId: postV1Fill_request
      tags:
      - fulfillment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model147'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model149'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model152'
  /v1/fill_request/{url_token}:
    get:
      summary: Get Fill Request by token
      description: Once a Fill Request has been submitted, you can look up the request payload that was submitted at any time for reference with an API request<br/><br/>This endpoint requires a `request_token`. You will receive a `request_token` upon a successful Fill Request API submission response in the `request_id` field.
      operationId: getV1Fill_requestUrl_token
      tags:
      - fulfillment
      parameters:
      - name: url_token
        in: path
        required: true
        description: URL token
        schema:
          type: string
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model21'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model50'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model51'
  /v1/fill_request/{url_token}/stripe_payment:
    put:
      summary: Update a Fill Request's stripe payment
      operationId: putV1Fill_requestUrl_tokenStripe_payment
      tags:
      - fulfillment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model235'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model237'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model238'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model239'
  /v1/fill_requests:
    get:
      summary: Get a list of fill requests
      description: Returns a list of fill requests and allows for the use of query parameters to scope the results of the request
      operationId: getV1Fill_requests
      tags:
      - fulfillment
      parameters:
      - name: created_at
        in: query
        schema:
          type: string
      - name: limit
        in: query
        schema:
          type: number
          maximum: 100
      - name: next
        in: query
        schema:
          type: string
      - name: metadata
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model22'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model9'
  /v1/fuzion_test:
    post:
      summary: Fuzion test endpoint
      operationId: postV1Fuzion_test
      tags:
      - fulfillment
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
  /v1/nearby_same_day_pickup_locations:
    get:
      summary: Search for nearby same day pickup locations using address details
      operationId: getV1Nearby_same_day_pickup_locations
      tags:
      - fulfillment
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
  /v1/open-api/api.yml:
    get:
      summary: Get current OpenAPI spec for Truepill APIs
      operationId: getV1OpenapiApiyml
      tags:
      - fulfillment
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
  /v1/order:
    post:
      summary: Create Order
      description: Generate an order to fill/refill prescriptions and order Over-the-Counter (OTC) products, allowing multiple patient's prescriptions to be filled as part of the same order<br/><br/>The prescriptions and products requested can be shipped to your patient with various shipping methods.<br/><br/>When making an order, the patients will be referenced with a `patient_token` being passed into the request body, inside the items array. If you do not have a `patient_token` for your patients, they can be created using the Patient Create endpoint.<br/><br/>On a successful submission of the order, an order token will be provided that is used to reference the Order (similar to `prescription_token` and `patient_token`).<br/><br/>This attribute is returned under the field `order_id`.<br/><br/>Many fields for the Order may or may not be required depending on what values are passed in. Please reference the field information carefully.<br/><br/>The `metadata` field acts as a link between the Order in the Truepill and the customer systems. It will be provided in all subsequent Order notifications as the order is processed.
      operationId: postV1Order
      tags:
      - fulfillment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/icd_codes'
      responses:
        '202':
          description: '202'
        '400':
          description: '400'
        '401':
          description: '401'
        '404':
          description: '404'
  /v1/order/{token}:
    get:
      summary: Get Order
      description: Get the details of an order<br/><br/>This endpoints needs the url_token to retrieve the right data
      operationId: getV1OrderToken
      tags:
      - fulfillment
      responses:
        '400':
          description: '400'
        '401':
          description: '401'
        '404':
          description: '404'
  /v1/prescriber:
    post:
      summary: Create Prescriber
      description: Create a prescriber in the Truepill ecosystem that is assigned to you as a customer
      operationId: postV1Prescriber
      tags:
      - fulfillment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model163'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model164'
    

# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/truepill/refs/heads/main/openapi/truepill-fulfillment-api-openapi.yml