Skip to main content

Search

api_get_preparation

Retrieves the information about brands and drugs uploaded to the system.

Request

Endpoint

POST https://yourdomain.pharmahrm.com/crm-api/db-function/run

Authentication

Bearer Token (required)

Request Structure

Headers

Key Value
Authorization Bearer <token>
Content-Type application/json

Request Body

{
    "function": "api_get_preparation",
    "format": "csv",
    "arguments": {
        "ids": "1,2,3,4"
    }
}
Field Type Required Description
function string Yes API method name. Use "api_get_preparation".
format string Yes Response format - csv
arguments object Yes Parameters block
ids string No Accepts record identifiers from the Proxima CRM database. Comma separator.

Successful Response

Example Response

preparation_id,preparation_name,brend_id,brend_name,direction
4,"ПОЛІФЕР,® гранули для орального застосування, по 1,5 г у стіку, № 14",9,Поліфер,Rx
14,"ДОЛОКС РЕТАРД табл, вкриті плівк обол, пролонг дії по 100 мг по 10 табл у бл; по 2 бл у кор.",4,Долокс ретард,Rx
Field Description
preparation_id Drug identifier in Proxima CRM
preparation_name Drug name
brend_id Brand identifier in Proxima CRM
brend_name Brand name
direction The product category to which the drug belongs

Error Response

40х/50х

{
  "message": "string"
}
Code Meaning
400 Bad request (e.g., missing required parameters)
401 Unauthorized access (invalid or missing token)
500 Internal server error