Brand
Medications
Get Medications

Get Medications

Retrieve medications for a product variant with optional filters and ailments.

Overview

  • Method: GET
  • Path: /brand/medications/get-medications/<productVariantId>
  • Tags: brand

Parameters

productVariantId (path)

  • Type: string
  • Required: Yes
  • Description: productVariantId parameter

gender (query)

  • Type: object
  • Required: No
  • Description: gender query parameter

namesOnly (query)

  • Type: object
  • Required: No
  • Description: namesOnly query parameter

includeAilments (query)

  • Type: object
  • Required: No
  • Description: includeAilments query parameter

Request Body

No request body required.

Responses

200

Successful response

Content Type: application/json

{
  "medications": "string",
  "name": "string",
  "displayName": "string",
  "dispenseNum": 123,
  "dispenseUnit": "string",
  "directions": "string",
  "refills": 123,
  "daysOfSupply": 123,
  "ailments": "string",
  "category": "string",
  "displayOrder": 123,
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-01-01T00:00:00.000Z"
}

400

Bad Request

Content Type: application/json

{
  "error": "string",
  "details": [
    {}
  ]
}

401

Unauthorized

404

Not Found

500

Internal Server Error

Example Usage

curl -X GET \
  https://api.pillexa.com/brand/medications/get-medications/<productVariantId> \
  -H "Content-Type: application/json" \
Get CompoundsUpdate Medications