Get Order Item Detail

Unlike the api/i1/orders endpoint, it shows the most detailed version of both the order and the products in the order. In order to extract detailed data, the user needs to know the ID of the order item or the ID of the order.

Parameter

Data Type

In

Description

{orderitem_id}

string

query

Order Item ID. This information can be obtained from the Order Detail service

{order_id}

string

query

Order Item ID. This information can be obtained from the Order Detail service

GET All Order Items within an Order

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

Sample HTTP request to extract every order item information within an order. The user must send order_id in query_param.

  • 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/order_item//detailed_integration/"
api_token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"

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

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

Example Response

Expected response status code is 200-Successful. Every property detail is described in the table below.

Order Item

Key

Value

Description

pk

integer

order item's primary key

primary key of

order

integer

product

dict

full detail of the product

status

enum

order item status (same enum list as order's status)

price_currency

enum

currency information

price

decimal

order item's price

tax_rate

decimal

tax rate

price_list

dict

details of price list

stock_list

dict

stock list detail info

invoice_number

text

invoice number

e_archive_url

text

e-archive invoice url

cancel_status

enum

cancel status (waiting/rejected/completed)

status_display

text

corresponding to the information in the status key

installment_interest_amount

decimal

interest amount

net_amount

decimal

net amount with discounts deducted, interest added

tracking_number

text

shipment tracking number

shipping_company

enum

shipping company info

discount_amount

decimal

discount amount

benefitapplicant_set

dict

discount items applied to order item

external_status

text

optional, external status

retail_price

decimal

store price

tracking_url

text

tracking url

mapping

dict

optional, mapping

Benefit Applicant Set

Represents relevant Benefit Applicant model information. Order Item has multiple relationships. The Benefit Applicant maintains the discounted item models and discount sharing information for the relevant order items.

Key

Value

Description

id

integer

benefits applicant ID

created_date

date

created date

modified_date

date

modified date

discount_share

decimal

discount amount applied to order item

discount_item

integer

discount item ID

order_item

integer

order item ID

{
    "count": 4,
    "next": null,
    "previous": null,
    "results": [
        {
            "pk": 123,
            "order": 37,
            "product": {
                "pk": 845,
                "name": "Quınn 6-Lı Bardak Seti300 Ml",
                "base_code": "1KBARD0243",
                "sku": "2672881093877",
                "product_type": "0",
                "is_active": true,
                "parent": null,
                "attributes": {
                    "erp_ProductAtt06Desc": "300 ML",
                    "integration_ProductAtt12Desc": "%50 + %20 PROMOSYON",
                    "uretim_yeri": "ÇEK CUMHURİYETİ",
                    "renk": "STD",
                    "integration_ProductAtt03Desc": "2011/2012 KIŞ",
                    "erp_ProductAtt07Desc": "50+50 promosyon",
                    "erp_color": "STD",
                    "erp_ProductAtt18Desc": "KRİSTAL",
                    "materyal": "CAM",
                    "erp_ProductHierarchyLevel01": "TEKSTİL DIŞI",
                    "erp_ProductHierarchyLevel02": "Cam",
                    "integration_ProductAtt05Desc": "%50+%20 OUTLET PROMOSYONU",
                    "erp_ProductAtt02Desc": "Su/Meşrubat Bardağı",
                    "integration_ProductAtt15Desc": "%50+%50 PROMOSYON",
                    "integration_ProductAtt18Desc": "KRİSTAL",
                    "erp_ProductAtt20Desc": "CAM",
                    "erp_ProductAtt15Desc": "%50+%50 PROMOSYON",
                    "erp_ProductCode": "1KBARD0243139",
                    "integration_ProductAtt13Desc": "Dekoratif - %50+%50",
                    "integration_ProductAtt01Desc": "DIŞ ALIM",
                    "erp_ProductAtt05Desc": "%50+%20 OUTLET PROMOSYONU",
                    "boyut": "300 ML",
                    "erp_ProductAtt01Desc": "DIŞ ALIM",
                    "erp_ProductAtt13Desc": "Dekoratif - %50+%50",
                    "integration_ProductCode": "1KBARD0243139",
                    "integration_ProductAtt07Desc": "50+50 promosyon",
                    "erp_ProductAtt03Desc": "2011/2012 KIŞ",
                    "erp_ProductAtt12Desc": "%50 + %20 PROMOSYON",
                    "integration_ProductHierarchyLevel01": "TEKSTİL DIŞI",
                    "integration_ProductHierarchyLevel02": "Cam",
                    "erp_ProductAtt25Desc": "ÇEK CUMHURİYETİ",
                    "integration_ProductAtt02Desc": "Su/Meşrubat Bardağı"
                },
                "attributes_kwargs": {
                    "erp_ProductHierarchyLevel01": {
                        "value": "TEKSTİL DIŞI",
                        "data_type": "dropdown",
                        "label": "TEKSTİL DIŞI"
                    },
                    "erp_ProductHierarchyLevel02": {
                        "value": "Cam",
                        "data_type": "dropdown",
                        "label": "Cam"
                    },
                    "renk": {
                        "value": "STD",
                        "data_type": "dropdown",
                        "label": "STD"
                    },
                    "erp_color": {
                        "value": "STD",
                        "data_type": "dropdown",
                        "label": "STD"
                    },
                    "integration_ProductHierarchyLevel01": {
                        "value": "TEKSTİL DIŞI",
                        "data_type": "dropdown",
                        "label": "TEKSTİL DIŞI"
                    },
                    "integration_ProductHierarchyLevel02": {
                        "value": "Cam",
                        "data_type": "dropdown",
                        "label": "Cam"
                    }
                },
                "extra_attributes": {},
                "group_products": [],
                "productimage_set": [
                    {
                        "pk": 15114,
                        "status": "active",
                        "image": "http://localhost:8000/media/products/2017/01/23/845/79d3df28-b32c-4f60-affd-0b2930542ee8.jpg",
                        "order": 0,
                        "created_date": "2017-01-23T15:23:27.051963Z",
                        "specialimage_set": [],
                        "modified_date": "2021-11-03T10:04:57.509172Z"
                    }
                ],
                "attribute_set": 30,
                "custom_attribute_set": null,
                "productization_date": "2017-01-23T17:51:25.285322Z",
                "listing_code": null,
                "data_source": null,
                "modified_date": "2021-02-23T13:46:20.026952Z",
                "uuid": "32cd81fe-71ee-4740-a6b9-63bfaf105dea",
                "created_date": "2017-01-22T21:59:37.223013Z"
            },
            "status": "400",
            "price_currency": "try",
            "price": "63.92",
            "tax_rate": "18.00",
            "extra_field": {},
            "price_list": {
                "pk": 1,
                "name": "default_price_list",
                "code": "default_price_list",
                "is_auto_sync": true,
                "modified_date": "2017-01-22T12:14:44.637000Z",
                "created_date": "2017-01-22T12:14:44.637000Z",
                "currency": "try"
            },
            "stock_list": {
                "pk": 1,
                "name": "default_stock_list",
                "code": "default_stock_list",
                "is_auto_sync": true,
                "modified_date": "2017-01-22T12:14:18.030000Z",
                "created_date": "2017-01-22T12:14:18.030000Z"
            },
            "invoice_number": null,
            "invoice_date": null,
            "e_archive_url": null,
            "cancel_status": null,
            "status_display": "approved",
            "installment_interest_amount": "0.00",
            "net_amount": "63.92",
            "tracking_number": null,
            "shipping_company": null,
            "discount_amount": "0.00",
            "shipment_code": null,
            "benefitapplicant_set": [],
            "external_status": null,
            "retail_price": null,
            "attributes": {},
            "attributes_kwargs": {},
            "tracking_url": null,
            "image": null,
            "parent": null,
            "data_source": null,
            "estimated_delivery_date": null,
            "datasource": null,
            "mapping": [
                {
                    "pk": 965,
                    "content_type": 44,
                    "object_id": 123,
                    "integration_type": "external_company",
                    "code": "6edc7de5-8762-448f-9b36-a71200956cfc",
                    "modified_date": "2017-02-06T09:04:02.347739Z",
                    "created_date": "2017-02-06T09:04:02.347715Z"
                }
            ]
        },
        {
            "pk": 124,
            "order": 37,
            "product": {
                "pk": 845,
                "name": "Quınn 6-Lı Bardak Seti300 Ml",
                "base_code": "1KBARD0243",
                "sku": "2672881093877",
                "product_type": "0",
                "is_active": true,
                "parent": null,
                "attributes": {
                    "erp_ProductAtt06Desc": "300 ML",
                    "integration_ProductAtt12Desc": "%50 + %20 PROMOSYON",
                    "uretim_yeri": "ÇEK CUMHURİYETİ",
                    "renk": "STD",
                    "integration_ProductAtt03Desc": "2011/2012 KIŞ",
                    "erp_ProductAtt07Desc": "50+50 promosyon",
                    "erp_color": "STD",
                    "erp_ProductAtt18Desc": "KRİSTAL",
                    "materyal": "CAM",
                    "erp_ProductHierarchyLevel01": "TEKSTİL DIŞI",
                    "erp_ProductHierarchyLevel02": "Cam",
                    "integration_ProductAtt05Desc": "%50+%20 OUTLET PROMOSYONU",
                    "erp_ProductAtt02Desc": "Su/Meşrubat Bardağı",
                    "integration_ProductAtt15Desc": "%50+%50 PROMOSYON",
                    "integration_ProductAtt18Desc": "KRİSTAL",
                    "erp_ProductAtt20Desc": "CAM",
                    "erp_ProductAtt15Desc": "%50+%50 PROMOSYON",
                    "erp_ProductCode": "1KBARD0243139",
                    "integration_ProductAtt13Desc": "Dekoratif - %50+%50",
                    "integration_ProductAtt01Desc": "DIŞ ALIM",
                    "erp_ProductAtt05Desc": "%50+%20 OUTLET PROMOSYONU",
                    "boyut": "300 ML",
                    "erp_ProductAtt01Desc": "DIŞ ALIM",
                    "erp_ProductAtt13Desc": "Dekoratif - %50+%50",
                    "integration_ProductCode": "1KBARD0243139",
                    "integration_ProductAtt07Desc": "50+50 promosyon",
                    "erp_ProductAtt03Desc": "2011/2012 KIŞ",
                    "erp_ProductAtt12Desc": "%50 + %20 PROMOSYON",
                    "integration_ProductHierarchyLevel01": "TEKSTİL DIŞI",
                    "integration_ProductHierarchyLevel02": "Cam",
                    "erp_ProductAtt25Desc": "ÇEK CUMHURİYETİ",
                    "integration_ProductAtt02Desc": "Su/Meşrubat Bardağı"
                },
                "attributes_kwargs": {
                    "erp_ProductHierarchyLevel01": {
                        "value": "TEKSTİL DIŞI",
                        "data_type": "dropdown",
                        "label": "TEKSTİL DIŞI"
                    },
                    "erp_ProductHierarchyLevel02": {
                        "value": "Cam",
                        "data_type": "dropdown",
                        "label": "Cam"
                    },
                    "renk": {
                        "value": "STD",
                        "data_type": "dropdown",
                        "label": "STD"
                    },
                    "erp_color": {
                        "value": "STD",
                        "data_type": "dropdown",
                        "label": "STD"
                    },
                    "integration_ProductHierarchyLevel01": {
                        "value": "TEKSTİL DIŞI",
                        "data_type": "dropdown",
                        "label": "TEKSTİL DIŞI"
                    },
                    "integration_ProductHierarchyLevel02": {
                        "value": "Cam",
                        "data_type": "dropdown",
                        "label": "Cam"
                    }
                },
                "extra_attributes": {},
                "group_products": [],
                "productimage_set": [
                    {
                        "pk": 15114,
                        "status": "active",
                        "image": "http://localhost:8000/media/products/2017/01/23/845/79d3df28-b32c-4f60-affd-0b2930542ee8.jpg",
                        "order": 0,
                        "created_date": "2017-01-23T15:23:27.051963Z",
                        "specialimage_set": [],
                        "modified_date": "2021-11-03T10:04:57.509172Z"
                    }
                ],
                "attribute_set": 30,
                "custom_attribute_set": null,
                "productization_date": "2017-01-23T17:51:25.285322Z",
                "listing_code": null,
                "data_source": null,
                "modified_date": "2021-02-23T13:46:20.026952Z",
                "uuid": "32cd81fe-71ee-4740-a6b9-63bfaf105dea",
                "created_date": "2017-01-22T21:59:37.223013Z"
            },
            "status": "400",
            "price_currency": "try",
            "price": "63.92",
            "tax_rate": "18.00",
            "extra_field": {},
            "price_list": {
                "pk": 1,
                "name": "default_price_list",
                "code": "default_price_list",
                "is_auto_sync": true,
                "modified_date": "2017-01-22T12:14:44.637000Z",
                "created_date": "2017-01-22T12:14:44.637000Z",
                "currency": "try"
            },
            "stock_list": {
                "pk": 1,
                "name": "default_stock_list",
                "code": "default_stock_list",
                "is_auto_sync": true,
                "modified_date": "2017-01-22T12:14:18.030000Z",
                "created_date": "2017-01-22T12:14:18.030000Z"
            },
            "invoice_number": null,
            "invoice_date": null,
            "e_archive_url": null,
            "cancel_status": null,
            "status_display": "approved",
            "installment_interest_amount": "0.00",
            "net_amount": "63.92",
            "tracking_number": null,
            "shipping_company": null,
            "discount_amount": "0.00",
            "shipment_code": null,
            "benefitapplicant_set": [],
            "external_status": null,
            "retail_price": null,
            "attributes": {},
            "attributes_kwargs": {},
            "tracking_url": null,
            "image": null,
            "parent": null,
            "data_source": null,
            "estimated_delivery_date": null,
            "datasource": null,
            "mapping": [
                {
                    "pk": 966,
                    "content_type": 44,
                    "object_id": 124,
                    "integration_type": "external_company",
                    "code": "6edc7de5-8762-448f-9b36-a71200956cfc",
                    "modified_date": "2017-02-06T09:04:02.408986Z",
                    "created_date": "2017-02-06T09:04:02.408960Z"
                }
            ]
        },
        {
            "pk": 125,
            "order": 37,
            "product": {
                "pk": 8606,
                "name": "Pot N2747003604071910",
                "base_code": "1KSURH0090",
                "sku": "2672880307807",
                "product_type": "0",
                "is_active": true,
                "parent": null,
                "attributes": {
                    "erp_ProductAtt15Desc": "%50+%20 PROMOSYON",
                    "erp_ProductCode": "1KSURH0090139",
                    "integration_ProductAtt12Desc": "%50 + %20 PROMOSYON",
                    "erp_ProductAtt05Desc": "%50+%20 OUTLET PROMOSYONU",
                    "uretim_yeri": "ÇİN",
                    "renk": "STD",
                    "integration_ProductAtt03Desc": "2011/2012 KIŞ",
                    "erp_ProductAtt07Desc": "50+50 promosyon",
                    "erp_color": "STD",
                    "erp_ProductAtt01Desc": "DIŞ ALIM",
                    "integration_ProductAtt01Desc": "DIŞ ALIM",
                    "integration_ProductCode": "1KSURH0090139",
                    "integration_ProductAtt14Desc": "SERAMİK SÜRAHİ 25 CM.",
                    "erp_ProductHierarchyLevel01": "TEKSTİL DIŞI",
                    "erp_ProductAtt14Desc": "SERAMİK SÜRAHİ 25 CM.",
                    "erp_ProductHierarchyLevel02": "Porselen",
                    "integration_ProductAtt05Desc": "%50+%20 OUTLET PROMOSYONU",
                    "erp_ProductAtt03Desc": "2011/2012 KIŞ",
                    "erp_ProductAtt02Desc": "Mutfak - Saklama Kabı",
                    "integration_ProductAtt15Desc": "%50+%20 PROMOSYON",
                    "integration_ProductHierarchyLevel01": "TEKSTİL DIŞI",
                    "integration_ProductHierarchyLevel02": "Porselen",
                    "erp_ProductAtt25Desc": "ÇİN",
                    "erp_ProductAtt12Desc": "%50 + %20 PROMOSYON",
                    "integration_ProductAtt02Desc": "Mutfak - Saklama Kabı",
                    "integration_ProductAtt07Desc": "50+50 promosyon"
                },
                "attributes_kwargs": {
                    "erp_ProductHierarchyLevel01": {
                        "value": "TEKSTİL DIŞI",
                        "data_type": "dropdown",
                        "label": "TEKSTİL DIŞI"
                    },
                    "erp_ProductHierarchyLevel02": {
                        "value": "Porselen",
                        "data_type": "dropdown",
                        "label": "Porselen"
                    },
                    "renk": {
                        "value": "STD",
                        "data_type": "dropdown",
                        "label": "STD"
                    },
                    "erp_color": {
                        "value": "STD",
                        "data_type": "dropdown",
                        "label": "STD"
                    },
                    "integration_ProductHierarchyLevel01": {
                        "value": "TEKSTİL DIŞI",
                        "data_type": "dropdown",
                        "label": "TEKSTİL DIŞI"
                    },
                    "integration_ProductHierarchyLevel02": {
                        "value": "Porselen",
                        "data_type": "dropdown",
                        "label": "Porselen"
                    }
                },
                "extra_attributes": {},
                "group_products": [],
                "productimage_set": [
                    {
                        "pk": 11568,
                        "status": "active",
                        "image": "http://localhost:8000/media/products/2017/01/23/8606/6f8f886b-dbc9-4d06-8539-86a08b16b2fe.jpg",
                        "order": 0,
                        "created_date": "2017-01-23T08:53:11.923793Z",
                        "specialimage_set": [],
                        "modified_date": "2021-11-03T10:04:56.938022Z"
                    },
                    {
                        "pk": 11569,
                        "status": "active",
                        "image": "http://localhost:8000/media/products/2017/01/23/8606/4052ce54-0876-491e-9cf6-7672274f7c14.jpg",
                        "order": 0,
                        "created_date": "2017-01-23T08:53:11.983128Z",
                        "specialimage_set": [],
                        "modified_date": "2021-11-03T10:04:56.938022Z"
                    }
                ],
                "attribute_set": 32,
                "custom_attribute_set": null,
                "productization_date": "2017-01-23T17:10:22.856627Z",
                "listing_code": null,
                "data_source": null,
                "modified_date": "2021-02-23T13:47:04.786012Z",
                "uuid": "ea4e0ef1-7d4c-4ee4-a68d-9e33bea2aa20",
                "created_date": "2017-01-22T22:31:39.053320Z"
            },
            "status": "400",
            "price_currency": "try",
            "price": "24.72",
            "tax_rate": "18.00",
            "extra_field": {},
            "price_list": {
                "pk": 1,
                "name": "default_price_list",
                "code": "default_price_list",
                "is_auto_sync": true,
                "modified_date": "2017-01-22T12:14:44.637000Z",
                "created_date": "2017-01-22T12:14:44.637000Z",
                "currency": "try"
            },
            "stock_list": {
                "pk": 1,
                "name": "default_stock_list",
                "code": "default_stock_list",
                "is_auto_sync": true,
                "modified_date": "2017-01-22T12:14:18.030000Z",
                "created_date": "2017-01-22T12:14:18.030000Z"
            },
            "invoice_number": null,
            "invoice_date": null,
            "e_archive_url": null,
            "cancel_status": null,
            "status_display": "approved",
            "installment_interest_amount": "0.00",
            "net_amount": "24.72",
            "tracking_number": null,
            "shipping_company": null,
            "discount_amount": "0.00",
            "shipment_code": null,
            "benefitapplicant_set": [],
            "external_status": null,
            "retail_price": null,
            "attributes": {},
            "attributes_kwargs": {},
            "tracking_url": null,
            "image": null,
            "parent": null,
            "data_source": null,
            "estimated_delivery_date": null,
            "datasource": null,
            "mapping": [
                {
                    "pk": 963,
                    "content_type": 44,
                    "object_id": 125,
                    "integration_type": "external_company",
                    "code": "e9630cd5-4b0c-44da-8965-a71200956cc5",
                    "modified_date": "2017-02-06T09:04:02.232395Z",
                    "created_date": "2017-02-06T09:04:02.232367Z"
                }
            ]
        },
        {
            "pk": 126,
            "order": 37,
            "product": {
                "pk": 8606,
                "name": "Pot N2747003604071910",
                "base_code": "1KSURH0090",
                "sku": "2672880307807",
                "product_type": "0",
                "is_active": true,
                "parent": null,
                "attributes": {
                    "erp_ProductAtt15Desc": "%50+%20 PROMOSYON",
                    "erp_ProductCode": "1KSURH0090139",
                    "integration_ProductAtt12Desc": "%50 + %20 PROMOSYON",
                    "erp_ProductAtt05Desc": "%50+%20 OUTLET PROMOSYONU",
                    "uretim_yeri": "ÇİN",
                    "renk": "STD",
                    "integration_ProductAtt03Desc": "2011/2012 KIŞ",
                    "erp_ProductAtt07Desc": "50+50 promosyon",
                    "erp_color": "STD",
                    "erp_ProductAtt01Desc": "DIŞ ALIM",
                    "integration_ProductAtt01Desc": "DIŞ ALIM",
                    "integration_ProductCode": "1KSURH0090139",
                    "integration_ProductAtt14Desc": "SERAMİK SÜRAHİ 25 CM.",
                    "erp_ProductHierarchyLevel01": "TEKSTİL DIŞI",
                    "erp_ProductAtt14Desc": "SERAMİK SÜRAHİ 25 CM.",
                    "erp_ProductHierarchyLevel02": "Porselen",
                    "integration_ProductAtt05Desc": "%50+%20 OUTLET PROMOSYONU",
                    "erp_ProductAtt03Desc": "2011/2012 KIŞ",
                    "erp_ProductAtt02Desc": "Mutfak - Saklama Kabı",
                    "integration_ProductAtt15Desc": "%50+%20 PROMOSYON",
                    "integration_ProductHierarchyLevel01": "TEKSTİL DIŞI",
                    "integration_ProductHierarchyLevel02": "Porselen",
                    "erp_ProductAtt25Desc": "ÇİN",
                    "erp_ProductAtt12Desc": "%50 + %20 PROMOSYON",
                    "integration_ProductAtt02Desc": "Mutfak - Saklama Kabı",
                    "integration_ProductAtt07Desc": "50+50 promosyon"
                },
                "attributes_kwargs": {
                    "erp_ProductHierarchyLevel01": {
                        "value": "TEKSTİL DIŞI",
                        "data_type": "dropdown",
                        "label": "TEKSTİL DIŞI"
                    },
                    "erp_ProductHierarchyLevel02": {
                        "value": "Porselen",
                        "data_type": "dropdown",
                        "label": "Porselen"
                    },
                    "renk": {
                        "value": "STD",
                        "data_type": "dropdown",
                        "label": "STD"
                    },
                    "erp_color": {
                        "value": "STD",
                        "data_type": "dropdown",
                        "label": "STD"
                    },
                    "integration_ProductHierarchyLevel01": {
                        "value": "TEKSTİL DIŞI",
                        "data_type": "dropdown",
                        "label": "TEKSTİL DIŞI"
                    },
                    "integration_ProductHierarchyLevel02": {
                        "value": "Porselen",
                        "data_type": "dropdown",
                        "label": "Porselen"
                    }
                },
                "extra_attributes": {},
                "group_products": [],
                "productimage_set": [
                    {
                        "pk": 11568,
                        "status": "active",
                        "image": "http://localhost:8000/media/products/2017/01/23/8606/6f8f886b-dbc9-4d06-8539-86a08b16b2fe.jpg",
                        "order": 0,
                        "created_date": "2017-01-23T08:53:11.923793Z",
                        "specialimage_set": [],
                        "modified_date": "2021-11-03T10:04:56.938022Z"
                    },
                    {
                        "pk": 11569,
                        "status": "active",
                        "image": "http://localhost:8000/media/products/2017/01/23/8606/4052ce54-0876-491e-9cf6-7672274f7c14.jpg",
                        "order": 0,
                        "created_date": "2017-01-23T08:53:11.983128Z",
                        "specialimage_set": [],
                        "modified_date": "2021-11-03T10:04:56.938022Z"
                    }
                ],
                "attribute_set": 32,
                "custom_attribute_set": null,
                "productization_date": "2017-01-23T17:10:22.856627Z",
                "listing_code": null,
                "data_source": null,
                "modified_date": "2021-02-23T13:47:04.786012Z",
                "uuid": "ea4e0ef1-7d4c-4ee4-a68d-9e33bea2aa20",
                "created_date": "2017-01-22T22:31:39.053320Z"
            },
            "status": "400",
            "price_currency": "try",
            "price": "24.72",
            "tax_rate": "18.00",
            "extra_field": {},
            "price_list": {
                "pk": 1,
                "name": "default_price_list",
                "code": "default_price_list",
                "is_auto_sync": true,
                "modified_date": "2017-01-22T12:14:44.637000Z",
                "created_date": "2017-01-22T12:14:44.637000Z",
                "currency": "try"
            },
            "stock_list": {
                "pk": 1,
                "name": "default_stock_list",
                "code": "default_stock_list",
                "is_auto_sync": true,
                "modified_date": "2017-01-22T12:14:18.030000Z",
                "created_date": "2017-01-22T12:14:18.030000Z"
            },
            "invoice_number": null,
            "invoice_date": null,
            "e_archive_url": null,
            "cancel_status": null,
            "status_display": "approved",
            "installment_interest_amount": "0.00",
            "net_amount": "24.72",
            "tracking_number": null,
            "shipping_company": null,
            "discount_amount": "0.00",
            "shipment_code": null,
            "benefitapplicant_set": [],
            "external_status": null,
            "retail_price": null,
            "attributes": {},
            "attributes_kwargs": {},
            "tracking_url": null,
            "image": null,
            "parent": null,
            "data_source": null,
            "estimated_delivery_date": null,
            "datasource": null,
            "mapping": [
                {
                    "pk": 964,
                    "content_type": 44,
                    "object_id": 126,
                    "integration_type": "external_company",
                    "code": "e9630cd5-4b0c-44da-8965-a71200956cc5",
                    "modified_date": "2017-02-06T09:04:02.292737Z",
                    "created_date": "2017-02-06T09:04:02.292711Z"
                }
            ]
        }
    ]
}

GET Order Item - Single

Path: /api/i1/order_item/{orderitem_id}/detailed_integration/

Sample HTTP request to extract single order item information. The user must send order_item_id. in query.

  • 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/order_item/{orderitem_id}/detailed_integration/"
api_token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"

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

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

Example Response

Expected response status code is 200-Successful. Every property detail is described in the table below.

Order Item

Key

Value

Description

pk

integer

order item's primary key

primary key of

order

integer

product

dict

full detail of the product

status

enum

order item status (same enum list as order's status)

price_currency

enum

currency information

price

decimal

order item's price

tax_rate

decimal

tax rate

price_list

dict

details of price list

stock_list

dict

stock list detail info

invoice_number

text

invoice number

e_archive_url

text

e archive invoice url

cancel_status

enum

cancel status (waiting/rejected/completed)

status_display

text

corresponding to the information in the status key

installment_interest_amount

decimal

interest amount

net_amount

decimal

net amount with discounts deducted, interest added

tracking_number

text

shipment tracking number

shipping_company

enum

shipping company info

discount_amount

decimal

discount amount

benefitapplicant_set

dict

discount items applied to order item

external_status

text

optional, external status

retail_price

decimal

store price

tracking_url

text

tracking url

mapping

dict

optional, mapping

Benefit Applicant Set

Represents relevant Benefit Applicant model information. Order Item has multiple relationships. The Benefit Applicant maintains the discounted item models and discount sharing information for the relevant order items.

Key

Value

Description

id

integer

benefits applicant ID

created_date

date

created date

modified_date

date

modified date

discount_share

decimal

discount amount applied to order item

discount_item

integer

discount item ID

order_item

integer

order item ID

{
    "pk": 123,
    "order": 37,
    "product": {
        "pk": 845,
        "name": "Quınn 6-Lı Bardak Seti300 Ml",
        "base_code": "1KBARD0243",
        "sku": "2672881093877",
        "product_type": "0",
        "is_active": true,
        "parent": null,
        "attributes": {
            "erp_ProductAtt06Desc": "300 ML",
            "integration_ProductAtt12Desc": "%50 + %20 PROMOSYON",
            "uretim_yeri": "ÇEK CUMHURİYETİ",
            "renk": "STD",
            "integration_ProductAtt03Desc": "2011/2012 KIŞ",
            "erp_ProductAtt07Desc": "50+50 promosyon",
            "erp_color": "STD",
            "erp_ProductAtt18Desc": "KRİSTAL",
            "materyal": "CAM",
            "erp_ProductHierarchyLevel01": "TEKSTİL DIŞI",
            "erp_ProductHierarchyLevel02": "Cam",
            "integration_ProductAtt05Desc": "%50+%20 OUTLET PROMOSYONU",
            "erp_ProductAtt02Desc": "Su/Meşrubat Bardağı",
            "integration_ProductAtt15Desc": "%50+%50 PROMOSYON",
            "integration_ProductAtt18Desc": "KRİSTAL",
            "erp_ProductAtt20Desc": "CAM",
            "erp_ProductAtt15Desc": "%50+%50 PROMOSYON",
            "erp_ProductCode": "1KBARD0243139",
            "integration_ProductAtt13Desc": "Dekoratif - %50+%50",
            "integration_ProductAtt01Desc": "DIŞ ALIM",
            "erp_ProductAtt05Desc": "%50+%20 OUTLET PROMOSYONU",
            "boyut": "300 ML",
            "erp_ProductAtt01Desc": "DIŞ ALIM",
            "erp_ProductAtt13Desc": "Dekoratif - %50+%50",
            "integration_ProductCode": "1KBARD0243139",
            "integration_ProductAtt07Desc": "50+50 promosyon",
            "erp_ProductAtt03Desc": "2011/2012 KIŞ",
            "erp_ProductAtt12Desc": "%50 + %20 PROMOSYON",
            "integration_ProductHierarchyLevel01": "TEKSTİL DIŞI",
            "integration_ProductHierarchyLevel02": "Cam",
            "erp_ProductAtt25Desc": "ÇEK CUMHURİYETİ",
            "integration_ProductAtt02Desc": "Su/Meşrubat Bardağı"
        },
        "attributes_kwargs": {
            "erp_ProductHierarchyLevel01": {
                "value": "TEKSTİL DIŞI",
                "data_type": "dropdown",
                "label": "TEKSTİL DIŞI"
            },
            "erp_ProductHierarchyLevel02": {
                "value": "Cam",
                "data_type": "dropdown",
                "label": "Cam"
            },
            "renk": {
                "value": "STD",
                "data_type": "dropdown",
                "label": "STD"
            },
            "erp_color": {
                "value": "STD",
                "data_type": "dropdown",
                "label": "STD"
            },
            "integration_ProductHierarchyLevel01": {
                "value": "TEKSTİL DIŞI",
                "data_type": "dropdown",
                "label": "TEKSTİL DIŞI"
            },
            "integration_ProductHierarchyLevel02": {
                "value": "Cam",
                "data_type": "dropdown",
                "label": "Cam"
            }
        },
        "extra_attributes": {},
        "group_products": [],
        "productimage_set": [
            {
                "pk": 15114,
                "status": "active",
                "image": "http://localhost:8000/media/products/2017/01/23/845/79d3df28-b32c-4f60-affd-0b2930542ee8.jpg",
                "order": 0,
                "created_date": "2017-01-23T15:23:27.051963Z",
                "specialimage_set": [],
                "modified_date": "2021-11-03T10:04:57.509172Z"
            }
        ],
        "attribute_set": 30,
        "custom_attribute_set": null,
        "productization_date": "2017-01-23T17:51:25.285322Z",
        "listing_code": null,
        "data_source": null,
        "modified_date": "2021-02-23T13:46:20.026952Z",
        "uuid": "32cd81fe-71ee-4740-a6b9-63bfaf105dea",
        "created_date": "2017-01-22T21:59:37.223013Z"
    },
    "status": "400",
    "price_currency": "try",
    "price": "63.92",
    "tax_rate": "18.00",
    "extra_field": {},
    "price_list": {
        "pk": 1,
        "name": "default_price_list",
        "code": "default_price_list",
        "is_auto_sync": true,
        "modified_date": "2017-01-22T12:14:44.637000Z",
        "created_date": "2017-01-22T12:14:44.637000Z",
        "currency": "try"
    },
    "stock_list": {
        "pk": 1,
        "name": "default_stock_list",
        "code": "default_stock_list",
        "is_auto_sync": true,
        "modified_date": "2017-01-22T12:14:18.030000Z",
        "created_date": "2017-01-22T12:14:18.030000Z"
    },
    "invoice_number": null,
    "invoice_date": null,
    "e_archive_url": null,
    "cancel_status": null,
    "status_display": "approved",
    "installment_interest_amount": "0.00",
    "net_amount": "63.92",
    "tracking_number": null,
    "shipping_company": null,
    "discount_amount": "0.00",
    "shipment_code": null,
    "benefitapplicant_set": [],
    "external_status": null,
    "retail_price": null,
    "attributes": {},
    "attributes_kwargs": {},
    "tracking_url": null,
    "image": null,
    "parent": null,
    "data_source": null,
    "estimated_delivery_date": null,
    "datasource": null,
    "mapping": [
        {
            "pk": 965,
            "content_type": 44,
            "object_id": 123,
            "integration_type": "external_company",
            "code": "6edc7de5-8762-448f-9b36-a71200956cfc",
            "modified_date": "2017-02-06T09:04:02.347739Z",
            "created_date": "2017-02-06T09:04:02.347715Z"
        }
    ]
}

Last updated

Was this helpful?