MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Order History

POST api/history-order

requires authentication

Example request:
curl --request POST \
    "https://iqvia.advisable.com/api/history-order" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"orderCode\": \"totam\",
    \"postalCode\": \"12503\",
    \"orderType\": \"C\",
    \"deliveryType\": \"C\",
    \"placedAt\": \"2023-12-15 16:45:26\",
    \"items\": [
        {
            \"id\": \"175\",
            \"code\": \"S567446\",
            \"name\": \"Product name\",
            \"barcode\": \"1234567890123\",
            \"brand\": \"BRAND\",
            \"price\": 44.9,
            \"paidPrice\": 35.95,
            \"vatRate\": 24,
            \"quantity\": 2
        }
    ]
}"
const url = new URL(
    "https://iqvia.advisable.com/api/history-order"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "orderCode": "totam",
    "postalCode": "12503",
    "orderType": "C",
    "deliveryType": "C",
    "placedAt": "2023-12-15 16:45:26",
    "items": [
        {
            "id": "175",
            "code": "S567446",
            "name": "Product name",
            "barcode": "1234567890123",
            "brand": "BRAND",
            "price": 44.9,
            "paidPrice": 35.95,
            "vatRate": 24,
            "quantity": 2
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://iqvia.advisable.com/api/history-order';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'orderCode' => 'totam',
            'postalCode' => '12503',
            'orderType' => 'C',
            'deliveryType' => 'C',
            'placedAt' => '2023-12-15 16:45:26',
            'items' => [
                [
                    'id' => '175',
                    'code' => 'S567446',
                    'name' => 'Product name',
                    'barcode' => '1234567890123',
                    'brand' => 'BRAND',
                    'price' => 44.9,
                    'paidPrice' => 35.95,
                    'vatRate' => 24,
                    'quantity' => 2,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://iqvia.advisable.com/api/history-order'
payload = {
    "orderCode": "totam",
    "postalCode": "12503",
    "orderType": "C",
    "deliveryType": "C",
    "placedAt": "2023-12-15 16:45:26",
    "items": [
        {
            "id": "175",
            "code": "S567446",
            "name": "Product name",
            "barcode": "1234567890123",
            "brand": "BRAND",
            "price": 44.9,
            "paidPrice": 35.95,
            "vatRate": 24,
            "quantity": 2
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 57
access-control-allow-origin: *
 

{
    "status": "success"
}
 

Example response (422):


{
    "message": "Το πεδίο order code είναι υποχρεωτικό. (and 1 more error)",
    "errors": {
        "orderCode": [
            "Το πεδίο order code είναι υποχρεωτικό."
        ],
        "orderType": [
            "Το πεδίο order type είναι υποχρεωτικό."
        ]
    }
}
 

Request   

POST api/history-order

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

orderCode   string   

The order identifier Example: totam

postalCode   string   

Postal code Example: 12503

orderType   string   

C for customer order, W for reseller / warehouse order, P for other pharmacy Example: C

deliveryType   string   

C for delivery to customer, P for order from store Example: C

placedAt   date   

The order creation date Example: 2023-12-15 16:45:26

items   object[]   

Array of order items

id   string   

The item id Example: 175

code   string  optional  

The item product / vendor code Example: S567446

name   string   

The item name Example: Product name

barcode   string   

The item barcode Example: 1234567890123

brand   string   

The item's brand Example: BRAND

price   number   

The item original price Example: 44.9

paidPrice   number   

The item order price Example: 35.95

vatRate   number   

The item vat percent Example: 24

quantity   integer   

The quantity bought Example: 2

couponDiscount   number  optional  

Coupon discount value if applied

promoDiscount   number  optional  

promo discount value if applied

addedAt   date  optional  

Datetime the item was added to cart

POST api/history-orders

requires authentication

Example request:
curl --request POST \
    "https://iqvia.advisable.com/api/history-orders" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"orders\": [
        {
            \"orderCode\": \"quam\",
            \"postalCode\": \"12503\",
            \"orderType\": \"C\",
            \"deliveryType\": \"C\",
            \"placedAt\": \"2023-12-15 16:45:26\",
            \"items\": [
                {
                    \"id\": \"enim\",
                    \"code\": \"distinctio\",
                    \"name\": \"alias\",
                    \"barcode\": \"1234567890123\",
                    \"brand\": \"BRAND\",
                    \"price\": 44.9,
                    \"paidPrice\": 35.95,
                    \"vatRate\": 24,
                    \"quantity\": 2
                }
            ]
        }
    ]
}"
const url = new URL(
    "https://iqvia.advisable.com/api/history-orders"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "orders": [
        {
            "orderCode": "quam",
            "postalCode": "12503",
            "orderType": "C",
            "deliveryType": "C",
            "placedAt": "2023-12-15 16:45:26",
            "items": [
                {
                    "id": "enim",
                    "code": "distinctio",
                    "name": "alias",
                    "barcode": "1234567890123",
                    "brand": "BRAND",
                    "price": 44.9,
                    "paidPrice": 35.95,
                    "vatRate": 24,
                    "quantity": 2
                }
            ]
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://iqvia.advisable.com/api/history-orders';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'orders' => [
                [
                    'orderCode' => 'quam',
                    'postalCode' => '12503',
                    'orderType' => 'C',
                    'deliveryType' => 'C',
                    'placedAt' => '2023-12-15 16:45:26',
                    'items' => [
                        [
                            'id' => 'enim',
                            'code' => 'distinctio',
                            'name' => 'alias',
                            'barcode' => '1234567890123',
                            'brand' => 'BRAND',
                            'price' => 44.9,
                            'paidPrice' => 35.95,
                            'vatRate' => 24,
                            'quantity' => 2,
                        ],
                    ],
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://iqvia.advisable.com/api/history-orders'
payload = {
    "orders": [
        {
            "orderCode": "quam",
            "postalCode": "12503",
            "orderType": "C",
            "deliveryType": "C",
            "placedAt": "2023-12-15 16:45:26",
            "items": [
                {
                    "id": "enim",
                    "code": "distinctio",
                    "name": "alias",
                    "barcode": "1234567890123",
                    "brand": "BRAND",
                    "price": 44.9,
                    "paidPrice": 35.95,
                    "vatRate": 24,
                    "quantity": 2
                }
            ]
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 56
access-control-allow-origin: *
 

{
    "status": "success"
}
 

Example response (422):


{
    "message": "Το πεδίο orders.0.orderCode είναι υποχρεωτικό. (and 1 more error)",
    "errors": {
        "orders.0.orderCode": [
            "Το πεδίο orders.0.orderCode είναι υποχρεωτικό."
        ],
        "orders.1.postalCode": [
            "Το πεδίο orders.1.postalCode είναι υποχρεωτικό."
        ]
    }
}
 

Request   

POST api/history-orders

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

orders   object[]   

The orders

orderCode   string   

The order identifier Example: quam

postalCode   string   

Postal code Example: 12503

orderType   string   

C for customer order, W for reseller / warehouse order, P for other pharmacy Example: C

deliveryType   string   

C for delivery to customer, P for order from store Example: C

placedAt   date   

The order creation date Example: 2023-12-15 16:45:26

items   object[]   

Array of order items

id   string   

The item id Example: enim

code   string  optional  

The item product / vendor code Example: distinctio

name   string   

The item name Example: alias

barcode   string   

The item barcode Example: 1234567890123

brand   string   

The item's brand Example: BRAND

price   number   

The item original price Example: 44.9

paidPrice   number   

The item order price Example: 35.95

vatRate   number   

The item vat percent Example: 24

quantity   integer   

The quantity bought Example: 2

couponDiscount   number  optional  

Coupon discount value if applied

promoDiscount   number  optional  

promo discount value if applied

addedAt   date  optional  

Datetime the item was added to cart

POST api/history-completed

requires authentication

Example request:
curl --request POST \
    "https://iqvia.advisable.com/api/history-completed" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://iqvia.advisable.com/api/history-completed"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://iqvia.advisable.com/api/history-completed';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://iqvia.advisable.com/api/history-completed'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 55
access-control-allow-origin: *
 

{
    "status": "success"
}
 

Example response (422):


{
    "message": "Έχετε ήδη ζητήσει ολοκλήρωση ιστορικού.",
    "errors": {
        "history": [
            "Έχετε ήδη ζητήσει ολοκλήρωση ιστορικού."
        ]
    }
}
 

Request   

POST api/history-completed

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Orders

POST api/order

requires authentication

Example request:
curl --request POST \
    "https://iqvia.advisable.com/api/order" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"orderCode\": \"voluptas\",
    \"postalCode\": \"12503\",
    \"orderType\": \"C\",
    \"deliveryType\": \"C\",
    \"placedAt\": \"2023-12-15 16:45:26\",
    \"items\": [
        {
            \"id\": \"175\",
            \"code\": \"S567446\",
            \"name\": \"Product name\",
            \"barcode\": \"1234567890123\",
            \"brand\": \"BRAND\",
            \"price\": 44.9,
            \"paidPrice\": 35.95,
            \"vatRate\": 24,
            \"quantity\": 2
        }
    ]
}"
const url = new URL(
    "https://iqvia.advisable.com/api/order"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "orderCode": "voluptas",
    "postalCode": "12503",
    "orderType": "C",
    "deliveryType": "C",
    "placedAt": "2023-12-15 16:45:26",
    "items": [
        {
            "id": "175",
            "code": "S567446",
            "name": "Product name",
            "barcode": "1234567890123",
            "brand": "BRAND",
            "price": 44.9,
            "paidPrice": 35.95,
            "vatRate": 24,
            "quantity": 2
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://iqvia.advisable.com/api/order';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'orderCode' => 'voluptas',
            'postalCode' => '12503',
            'orderType' => 'C',
            'deliveryType' => 'C',
            'placedAt' => '2023-12-15 16:45:26',
            'items' => [
                [
                    'id' => '175',
                    'code' => 'S567446',
                    'name' => 'Product name',
                    'barcode' => '1234567890123',
                    'brand' => 'BRAND',
                    'price' => 44.9,
                    'paidPrice' => 35.95,
                    'vatRate' => 24,
                    'quantity' => 2,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://iqvia.advisable.com/api/order'
payload = {
    "orderCode": "voluptas",
    "postalCode": "12503",
    "orderType": "C",
    "deliveryType": "C",
    "placedAt": "2023-12-15 16:45:26",
    "items": [
        {
            "id": "175",
            "code": "S567446",
            "name": "Product name",
            "barcode": "1234567890123",
            "brand": "BRAND",
            "price": 44.9,
            "paidPrice": 35.95,
            "vatRate": 24,
            "quantity": 2
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
access-control-allow-origin: *
 

{
    "status": "success"
}
 

Example response (422):


{
    "message": "Το πεδίο order code είναι υποχρεωτικό. (and 1 more error)",
    "errors": {
        "orderCode": [
            "Το πεδίο order code είναι υποχρεωτικό."
        ],
        "orderType": [
            "Το πεδίο order type είναι υποχρεωτικό."
        ]
    }
}
 

Request   

POST api/order

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

orderCode   string   

The order identifier Example: voluptas

postalCode   string   

Postal code Example: 12503

orderType   string   

C for customer order, W for reseller / warehouse order, P for other pharmacy Example: C

deliveryType   string   

C for delivery to customer, P for order from store Example: C

placedAt   date   

The order creation date Example: 2023-12-15 16:45:26

items   object[]   

Array of order items

id   string   

The item id Example: 175

code   string  optional  

The item product / vendor code Example: S567446

name   string   

The item name Example: Product name

barcode   string   

The item barcode Example: 1234567890123

brand   string   

The item's brand Example: BRAND

price   number   

The item original price Example: 44.9

paidPrice   number   

The item order price Example: 35.95

vatRate   number   

The item vat percent Example: 24

quantity   integer   

The quantity bought Example: 2

couponDiscount   number  optional  

Coupon discount value if applied

promoDiscount   number  optional  

promo discount value if applied

addedAt   date  optional  

Datetime the item was added to cart

POST api/orders

requires authentication

Example request:
curl --request POST \
    "https://iqvia.advisable.com/api/orders" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"orders\": [
        {
            \"orderCode\": \"rerum\",
            \"postalCode\": \"12503\",
            \"orderType\": \"C\",
            \"deliveryType\": \"C\",
            \"placedAt\": \"2023-12-15 16:45:26\",
            \"items\": [
                {
                    \"id\": \"optio\",
                    \"code\": \"corporis\",
                    \"name\": \"cum\",
                    \"barcode\": \"1234567890123\",
                    \"brand\": \"BRAND\",
                    \"price\": 44.9,
                    \"paidPrice\": 35.95,
                    \"vatRate\": 24,
                    \"quantity\": 2
                }
            ]
        }
    ]
}"
const url = new URL(
    "https://iqvia.advisable.com/api/orders"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "orders": [
        {
            "orderCode": "rerum",
            "postalCode": "12503",
            "orderType": "C",
            "deliveryType": "C",
            "placedAt": "2023-12-15 16:45:26",
            "items": [
                {
                    "id": "optio",
                    "code": "corporis",
                    "name": "cum",
                    "barcode": "1234567890123",
                    "brand": "BRAND",
                    "price": 44.9,
                    "paidPrice": 35.95,
                    "vatRate": 24,
                    "quantity": 2
                }
            ]
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://iqvia.advisable.com/api/orders';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'orders' => [
                [
                    'orderCode' => 'rerum',
                    'postalCode' => '12503',
                    'orderType' => 'C',
                    'deliveryType' => 'C',
                    'placedAt' => '2023-12-15 16:45:26',
                    'items' => [
                        [
                            'id' => 'optio',
                            'code' => 'corporis',
                            'name' => 'cum',
                            'barcode' => '1234567890123',
                            'brand' => 'BRAND',
                            'price' => 44.9,
                            'paidPrice' => 35.95,
                            'vatRate' => 24,
                            'quantity' => 2,
                        ],
                    ],
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://iqvia.advisable.com/api/orders'
payload = {
    "orders": [
        {
            "orderCode": "rerum",
            "postalCode": "12503",
            "orderType": "C",
            "deliveryType": "C",
            "placedAt": "2023-12-15 16:45:26",
            "items": [
                {
                    "id": "optio",
                    "code": "corporis",
                    "name": "cum",
                    "barcode": "1234567890123",
                    "brand": "BRAND",
                    "price": 44.9,
                    "paidPrice": 35.95,
                    "vatRate": 24,
                    "quantity": 2
                }
            ]
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 58
access-control-allow-origin: *
 

{
    "status": "success"
}
 

Example response (422):


{
    "message": "Το πεδίο orders.0.orderCode είναι υποχρεωτικό. (and 1 more error)",
    "errors": {
        "orders.0.orderCode": [
            "Το πεδίο orders.0.orderCode είναι υποχρεωτικό."
        ],
        "orders.1.postalCode": [
            "Το πεδίο orders.1.postalCode είναι υποχρεωτικό."
        ]
    }
}
 

Request   

POST api/orders

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

orders   object[]   

The orders

orderCode   string   

The order identifier Example: rerum

postalCode   string   

Postal code Example: 12503

orderType   string   

C for customer order, W for reseller / warehouse order, P for other pharmacy Example: C

deliveryType   string   

C for delivery to customer, P for order from store Example: C

placedAt   date   

The order creation date Example: 2023-12-15 16:45:26

items   object[]   

Array of order items

id   string   

The item id Example: optio

code   string  optional  

The item product / vendor code Example: corporis

name   string   

The item name Example: cum

barcode   string   

The item barcode Example: 1234567890123

brand   string   

The item's brand Example: BRAND

price   number   

The item original price Example: 44.9

paidPrice   number   

The item order price Example: 35.95

vatRate   number   

The item vat percent Example: 24

quantity   integer   

The quantity bought Example: 2

couponDiscount   number  optional  

Coupon discount value if applied

promoDiscount   number  optional  

promo discount value if applied

addedAt   date  optional  

Datetime the item was added to cart