Order Discount Items

Any discounts for an order are held in the Discount Item table in the Omnitron.

In the api/v1/discount_items/detailed_integration/?order={order_id} response, discount_items, that is, the discounted items, are shown in the result list.

If it is desired to return details for a single item in the result list, a request can be sent to /api/v1/discount_items/{discountitem_id}/detailed_integration. The response from this endpoint will show the details of the discount item id instead of {discountitem_id}.

Detailed information about the order discount is shown in the table below.

Parameter	Data Type	In	Description
api_token	string	header	The API key of the customer account
{order_id}	string	query	Order ID

GET Order Discount Items

Path: api/i1/discount_items/detailed_integration/?order={order_id}

Sample HTTP request to retrieve all discount items related to an order.

• content_type header represents the response type.

• Authorization header is a required header for authentication. You can retrieve api_token with login.

Example Request

import requests

url = "https://{customer_api_url}api/v1/discount_items/detailed_integration/?order={order_id}"

api_token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"

headers = {
    'content-type': 'application/json',
    'Authorization': 'Token {}'.format(api_token)
}

response = requests.get(url, headers=headers)
print(response.text)

Example Response

Shows desired discount items. All parameters of a discount item are described in the table below.

Benefit Applicant Set

It is the table that establishes the relationship between the discount item and the order item.

Key	Value	Description
pk	integer	discount item's ID
name	text	discount name
amount	decimal	discount amount
order	integer	order pk
offer_type	enum	discount type
session_offer_type	enum	session offer type
code	text	coupon code (if applicable)
benefitapplicant_set	dict	order items with discount
promotion	dict	implemented campaign
conditionapplicant_set	dict	order_items with discount

Promotion

Related promotion object in the order.

Key	Value	Description
pk	integer	promotion ID
created_date	date	created date
modified_date	date	modified date
name	text	campaign name
slug	text	campaign slug

 {
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "pk": 10,
            "name": "3 al 2 Öde",
            "amount": "199.90",
            "order": 202,
            "offer_type": "basket_offer",
            "session_offer_type": null,
            "code": null,
            "modified_date": "2021-05-11T06:42:55.684412Z",
            "promotion": {
                "id": 1,
                "created_date": "2021-02-23T10:42:04.864679Z",
                "modified_date": "2021-02-23T10:42:04.864699Z",
                "name": "3 al 2 Öde",
                "slug": "3-al-2-ode"
            },
            "created_date": "2021-05-11T06:42:55.684393Z",
            "benefitapplicant_set": [
                {
                    "id": 16,
                    "created_date": "2021-05-11T06:42:55.694486Z",
                    "modified_date": "2021-05-11T06:42:55.721790Z",
                    "discount_share": "66.63",
                    "discount_item": 10,
                    "order_item": 414
                },
                {
                    "id": 17,
                    "created_date": "2021-05-11T06:42:55.700152Z",
                    "modified_date": "2021-05-11T06:42:55.727783Z",
                    "discount_share": "66.63",
                    "discount_item": 10,
                    "order_item": 415
                },
                {
                    "id": 18,
                    "created_date": "2021-05-11T06:42:55.706338Z",
                    "modified_date": "2021-05-11T06:42:55.732994Z",
                    "discount_share": "66.64",
                    "discount_item": 10,
                    "order_item": 416
                }
            ],
            "conditionapplicant_set": []
        }
    ]
}