Orders ID Detail Integration

Shows the detailed version of the order. The endpoint api/v1/order_item/detailed_integration/?order={order_pk}. can be used for both the order and the order items under the order.

With this endpoint the user can extract every relation information with a given order ID.

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

GET Orders Detail

Path: /api/i1/orders_integration/{order_id}/detailed_integration/

Sample HTTP request for extracting every relation detail for the given order ID.

• 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/orders_integration/{order_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

Shows desired order properties. All parameters of an order are described in the table below.

Order

Key	Value	Description
pk	integer	order's pk
number	text	order's number
channel	dict	channel information the order came from
status	enum	order status
date_placed	date	order creation date
customer	dict	customer info
shipping_address	dict	address info
billing_address	dict	billing address information
currency	enum	currency information
amount	decimal	order amount
shipping_amount	decimal	shipping rate
shipping_tax_rate	decimal	tax rate of shipping
extra_field	dict	optional
transaction_set	dict	transaction information for credit card orders
payment_option	dict	payment option info
payment_option_slug	text	payment option slug info
bin_number	text	bin number for credit card orders
installment	dict	installation info
installment_count	integer	information how many installments the order was taken
installment_interest_amount	decimal	interest amount
cargo_company	dict	The shipping company chosen by the customer for the order
invoice_number	text	invoice info
e_archive_url	text	e archive url info
refund_amount	decimal	refund amount (if any)
discount_refund_amount	decimal	discount refund amount (if any)
shipping_refund_amount	decimal	shipping refund amount (if any)
discount_amount	decimal	discount amount (if any)
cancellation_info	dict	Holds cancellation information. After cancellation proceeds this dict will be cleaned.
status_display	text	status description
tracking_number	text	shipment tracking number
is_send	bool	flag whether the order is reported to erp
cancel_status	enum	(waiting/completed/rejected)
net_shipping_amount	decimal	deducted shipping amount
remote_addr	ip address	ordering ip address
language_code	enum	language of the user who placed the order
fundstransfertransaction_set	dict	transfer order transaction information
has_gift_box	bool	gift wrap (yes/no)
gift_box_note	text	gift note
external_status	text	external status
payondeliverytransaction_set	dict	delivery transaction information
loyaltytransaction_set	dict	loyalty card payment transaction information
bextransaction_set	dict	bex transactions of the order
cashregistertransaction_set	dict	cash register transactions of the order
cancellationplan_set	dict	cancellation/refund (cancellation plan) information
client_type	enum	Shows the client platform. Client types are predefined. Choices are default, ios, android and instore.
shipping_interest_amount	decimal	shipping interest amount of the order
mapping	dict	optional
ordertransaction_set	dict	transaction of the order
ordershippinginfo_set	dict	order delivery detail

Installment

It keeps the information of how many installments the order has and the interest amount. Installment properties are listed below.

Key	Value	Description
pk	integer	ID of the object
card	dict	Related Card object. See the Payment section for more info
installment_count	integer	number of installments
label	text	installment statement
interest_rate	decimal	interest rate

Cargo Company

It keeps the cargo company information. Cargo company properties are listed below.

Key	Value	Description
pk	integer	ID of the object
name	text	name of shipping company
erp_code	text	shipping company code
shipping_company	enum	The shipping company to which the seller sent the order.

Transaction Set

It keeps the related pre_purchase, purchase and refund transactions information. Transaction properties are listed below.

Key	Value	Description
pk	integer	transaction ID
transaction_type	enum	transaction type (purchase/refund)
transaction_id	text	unique transaction identifier
auth_code	text	authentication code for related payment gateway
pos	dict	holds related Pos object properties
main_pos	dict	holds related main Pos object properties
order	dict	keeps related order object properties
user_email	text	email of the user
raw_request	text	request to the bank
raw_response	text	response from bank
is_succeeded	bool	information about successful transaction
amount	decimal	the amount withdrawn in this transaction
remote_addr	ip address	operating IP
created_date	date	created date
pos_slug	text	pos slug in Omnitron

Address Set

Billing or shipping address information. It keeps the related address model properties details.

Key	Value	Description
pk	integer	ID of the address object
email	text	email address for shipping
phone_number	text	phone number
first_name	text	name
last_name	text	surname
country	dict	country info
city	dict	city info
township	dict	town information
district	dict	neighborhood info
line	text	address directions
title	text	address title
postcode	text	postcode
tax_office	text	tax office
tax_no	text	tax/tck no
e_bill_taxpayer	bool	e-invoice payer
company_name	text	company name
address_type	enum	customer/company

Order Shipping Info Set

It keeps the related cargo integration information.

Key	Value	Description
pk	integer	object primary key
order	integer	order primary key
order_number	text	order's number in the Omnitron
shipping_company	enum	the shipping company to which the seller sent the order
send_request	text	in case the Omnitron writes to the cargo, the request is made by the Omnitron
send_response	text/json	response from omnitron
is_send	boolean	states of whether shipping was successful
cargo_label	text	label getting from cargo integration

         {
    "pk": 27,
    "number": "bf7b66149236455",
    "channel": {
        "pk": 1,
        "name": "Shop",
        "channel_type": "web",
        "catalog": 1,
        "modified_date": "2022-06-13T10:47:45.640791Z",
        "created_date": "2017-01-22T23:33:29.178976Z",
        "category_tree": null,
        "is_active": true,
        "conf": {
            "username": "Hasan",
            "feature_flags": {},
            "auth_token": "AILeoZiTaWGHEIHSvfdaaURqFBEWgbhdNrlxShtu",
            "server": "http://localhost:8080/api/v1/",
            "localized_cancel_mail_subject": {},
            "sales_url": "http://www.madamecoco.com",
            "password": "Password123!"
        },
        "schema": {}
    },
    "status": "400",
    "date_placed": "2017-01-30T08:28:26.158165Z",
    "customer": {
        "pk": 1103,
        "channel": 1,
        "email": "[e-mail]",
        "first_name": "TEST",
        "last_name": "TEST",
        "phone_number": null,
        "is_active": true,
        "channel_code": "7",
        "erp_code": "760906",
        "extra_field": {},
        "modified_date": "2017-02-05T19:22:01.340598Z",
        "created_date": "2017-02-02T09:40:28.855012Z",
        "date_joined": "2017-01-30T08:21:20.657225Z",
        "email_allowed": false,
        "sms_allowed": false,
        "call_allowed": false,
        "gender": null,
        "attributes": {},
        "user_type": null,
        "date_of_birth": null
    },
    "shipping_address": {
        "pk": 27,
        "email": "[e-mail]",
        "phone_number": "0 [phone]",
        "first_name": "TEST",
        "last_name": "TEST",
        "country": {
            "pk": 1,
            "is_active": true,
            "name": "Turkey",
            "code": "tr",
            "translations": {
                "tr-tr": {
                    "name": "Türkiye"
                }
            },
            "modified_date": "2022-08-15T07:20:28.680740Z",
            "created_date": "2016-12-22T08:50:55.358000Z",
            "mapping": [
                {
                    "pk": 1,
                    "content_type": 33,
                    "object_id": 1,
                    "integration_type": "external_company",
                    "code": "TR",
                    "modified_date": "2017-01-24T10:58:56.765596Z",
                    "created_date": "2017-01-24T10:58:56.765567Z"
                }
            ]
        },
        "city": {
            "pk": 71,
            "is_active": true,
            "name": "Afyon",
            "country": 1,
            "translations": null,
            "priority": null,
            "postcode": null,
            "modified_date": "2016-12-22T08:50:57.270000Z",
            "created_date": "2016-12-22T08:50:57.270000Z",
            "mapping": [
                {
                    "pk": 25,
                    "content_type": 36,
                    "object_id": 71,
                    "integration_type": "external_company",
                    "code": "TR.03",
                    "modified_date": "2017-01-24T10:58:58.771769Z",
                    "created_date": "2017-01-24T10:58:58.771729Z"
                }
            ]
        },
        "line": "test",
        "title": "TEST",
        "township": {
            "pk": 853,
            "is_active": true,
            "name": "DİNAR",
            "city": 71,
            "postcode": null,
            "modified_date": "2016-12-22T08:51:20.112000Z",
            "created_date": "2016-12-22T08:51:20.111000Z",
            "mapping": [
                {
                    "pk": 28,
                    "content_type": 34,
                    "object_id": 853,
                    "integration_type": "external_company",
                    "code": "TR.00304",
                    "modified_date": "2017-01-24T10:58:59.087915Z",
                    "created_date": "2017-01-24T10:58:59.087889Z"
                }
            ]
        },
        "district": {
            "pk": 3679,
            "is_active": true,
            "name": "İNCESU",
            "city": 71,
            "township": 853,
            "postcode": null,
            "zipcode": null,
            "modified_date": "2016-12-22T08:53:12.031000Z",
            "created_date": "2016-12-22T08:53:12.031000Z",
            "mapping": []
        },
        "postcode": "11111",
        "notes": null,
        "company_name": null,
        "tax_office": null,
        "tax_no": null,
        "e_bill_taxpayer": false,
        "hash_data": "3e0a66ffeeafcc8d5e2f7e200d85b0dc",
        "address_type": "customer",
        "retail_store": null,
        "remote_id": null,
        "identity_number": null,
        "extra_field": {},
        "customer": {
            "pk": 1103,
            "channel": 1,
            "email": "[e-mail]",
            "first_name": "TEST",
            "last_name": "TEST",
            "phone_number": null,
            "is_active": true,
            "channel_code": "7",
            "erp_code": "760906",
            "extra_field": {},
            "modified_date": "2017-02-05T19:22:01.340598Z",
            "created_date": "2017-02-02T09:40:28.855012Z",
            "date_joined": "2017-01-30T08:21:20.657225Z",
            "email_allowed": false,
            "sms_allowed": false,
            "call_allowed": false,
            "gender": null,
            "attributes": {},
            "user_type": null,
            "date_of_birth": null
        },
        "is_active": true,
        "modified_date": "2017-02-05T19:22:01.492578Z",
        "mapping": [
            {
                "pk": 902,
                "content_type": 38,
                "object_id": 27,
                "integration_type": "external_company",
                "code": "bc617d60-6b8f-47af-8dd6-a70e011920b8",
                "modified_date": "2017-02-02T17:03:34.590336Z",
                "created_date": "2017-02-02T17:03:34.590310Z"
            },
            {
                "pk": 903,
                "content_type": 38,
                "object_id": 27,
                "integration_type": "external_company",
                "code": "030a6884-e0f0-4ded-9e96-a70e011920b9",
                "modified_date": "2017-02-02T17:03:34.634239Z",
                "created_date": "2017-02-02T17:03:34.634213Z"
            }
        ]
    },
    "billing_address": {
        "pk": 27,
        "email": "[e-mail]",
        "phone_number": "0 [phone]",
        "first_name": "TEST",
        "last_name": "TEST",
        "country": {
            "pk": 1,
            "is_active": true,
            "name": "Turkey",
            "code": "tr",
            "translations": {
                "tr-tr": {
                    "name": "Türkiye"
                }
            },
            "modified_date": "2022-08-15T07:20:28.680740Z",
            "created_date": "2016-12-22T08:50:55.358000Z",
            "mapping": [
                {
                    "pk": 1,
                    "content_type": 33,
                    "object_id": 1,
                    "integration_type": "external_company",
                    "code": "TR",
                    "modified_date": "2017-01-24T10:58:56.765596Z",
                    "created_date": "2017-01-24T10:58:56.765567Z"
                }
            ]
        },
        "city": {
            "pk": 71,
            "is_active": true,
            "name": "Afyon",
            "country": 1,
            "translations": null,
            "priority": null,
            "postcode": null,
            "modified_date": "2016-12-22T08:50:57.270000Z",
            "created_date": "2016-12-22T08:50:57.270000Z",
            "mapping": [
                {
                    "pk": 25,
                    "content_type": 36,
                    "object_id": 71,
                    "integration_type": "external_company",
                    "code": "TR.03",
                    "modified_date": "2017-01-24T10:58:58.771769Z",
                    "created_date": "2017-01-24T10:58:58.771729Z"
                }
            ]
        },
        "line": "test",
        "title": "TEST",
        "township": {
            "pk": 853,
            "is_active": true,
            "name": "DİNAR",
            "city": 71,
            "postcode": null,
            "modified_date": "2016-12-22T08:51:20.112000Z",
            "created_date": "2016-12-22T08:51:20.111000Z",
            "mapping": [
                {
                    "pk": 28,
                    "content_type": 34,
                    "object_id": 853,
                    "integration_type": "external_company",
                    "code": "TR.00304",
                    "modified_date": "2017-01-24T10:58:59.087915Z",
                    "created_date": "2017-01-24T10:58:59.087889Z"
                }
            ]
        },
        "district": {
            "pk": 3679,
            "is_active": true,
            "name": "İNCESU",
            "city": 71,
            "township": 853,
            "postcode": null,
            "zipcode": null,
            "modified_date": "2016-12-22T08:53:12.031000Z",
            "created_date": "2016-12-22T08:53:12.031000Z",
            "mapping": []
        },
        "postcode": "11111",
        "notes": null,
        "company_name": null,
        "tax_office": null,
        "tax_no": null,
        "e_bill_taxpayer": false,
        "hash_data": "3e0a66ffeeafcc8d5e2f7e200d85b0dc",
        "address_type": "customer",
        "retail_store": null,
        "remote_id": null,
        "identity_number": null,
        "extra_field": {},
        "customer": {
            "pk": 1103,
            "channel": 1,
            "email": "[e-mail]",
            "first_name": "TEST",
            "last_name": "TEST",
            "phone_number": null,
            "is_active": true,
            "channel_code": "7",
            "erp_code": "760906",
            "extra_field": {},
            "modified_date": "2017-02-05T19:22:01.340598Z",
            "created_date": "2017-02-02T09:40:28.855012Z",
            "date_joined": "2017-01-30T08:21:20.657225Z",
            "email_allowed": false,
            "sms_allowed": false,
            "call_allowed": false,
            "gender": null,
            "attributes": {},
            "user_type": null,
            "date_of_birth": null
        },
        "is_active": true,
        "modified_date": "2017-02-05T19:22:01.492578Z",
        "mapping": [
            {
                "pk": 902,
                "content_type": 38,
                "object_id": 27,
                "integration_type": "external_company",
                "code": "bc617d60-6b8f-47af-8dd6-a70e011920b8",
                "modified_date": "2017-02-02T17:03:34.590336Z",
                "created_date": "2017-02-02T17:03:34.590310Z"
            },
            {
                "pk": 903,
                "content_type": 38,
                "object_id": 27,
                "integration_type": "external_company",
                "code": "030a6884-e0f0-4ded-9e96-a70e011920b9",
                "modified_date": "2017-02-02T17:03:34.634239Z",
                "created_date": "2017-02-02T17:03:34.634213Z"
            }
        ]
    },
    "currency": "try",
    "amount": "16.40",
    "shipping_amount": "8.50",
    "shipping_tax_rate": null,
    "extra_field": {
        "cargo_line_id": "325a79ac-e251-4285-8a32-a70e0119237e"
    },
    "transaction_set": [
        {
            "pk": 2,
            "transaction_type": "purchase",
            "transaction_id": "17030LcZH11794",
            "auth_code": null,
            "pos": {
                "pk": 2,
                "name": "NestPay",
                "slug": "HA",
                "gateway": "omnicore.libs.payment_gateways.nestpay.NestpayGateway",
                "config": {
                    "auth": {
                        "username": "ISBANKAPI",
                        "password": "ISBANK07",
                        "client_id": "700655000100"
                    }
                },
                "resource_url": "https://entegrasyon.asseco-see.com.tr/fim/api",
                "three_d_resource_url": null,
                "channel": 1,
                "gateway_display": "Nestpay",
                "modified_date": "2017-02-02T10:38:15.427494Z",
                "created_date": "2017-02-01T14:01:28.829319Z"
            },
            "main_pos": null,
            "order": {
                "pk": 27,
                "number": "bf7b66149236455",
                "channel": 1,
                "status": "400",
                "date_placed": "2017-01-30T08:28:26.158165Z",
                "customer": 1103,
                "shipping_address": 27,
                "billing_address": 27,
                "currency": "try",
                "amount": "16.40",
                "shipping_amount": "8.50",
                "shipping_tax_rate": null,
                "extra_field": {
                    "cargo_line_id": "325a79ac-e251-4285-8a32-a70e0119237e"
                },
                "payment_option": 2,
                "payment_option_slug": "kredi_karti",
                "bin_number": "454360",
                "installment": 22,
                "installment_count": 1,
                "delivery_type": null,
                "installment_interest_amount": "0.00",
                "cargo_company": 1,
                "invoice_number": "",
                "invoice_date": null,
                "e_archive_url": null,
                "refund_amount": "0.00",
                "discount_refund_amount": "0.00",
                "shipping_refund_amount": "0.00",
                "discount_amount": "0.00",
                "is_send": true,
                "net_shipping_amount": "8.50",
                "shipping_interest_amount": "0.00",
                "tracking_number": null,
                "carrier_shipping_code": null,
                "remote_addr": null,
                "fundstransfertransaction_set": [],
                "has_gift_box": false,
                "gift_box_note": null,
                "external_status": null,
                "client_type": "default",
                "language_code": null,
                "notes": null,
                "delivery_range": null,
                "shipping_option_slug": null,
                "segment": null,
                "modified_date": "2017-02-02T17:03:37.189715Z",
                "checkout_provider_id": null,
                "created_date": "2017-02-02T09:40:29.144797Z"
            },
            "currency": null,
            "user_email": "[e-mail]",
            "raw_request": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<CC5Request><OrderId>bf7b661492364559856ff12201f157d9</OrderId><PayerAuthenticationCode>CAVV</PayerAuthenticationCode><Name>ISBANKAPI</Name><Taksit></Taksit><Type>Auth</Type><Expires>**/****</Expires><Number>****************</Number><ClientId>700655000100</ClientId><Cvv2Val>***</Cvv2Val><Currency>949</Currency><GroupId></GroupId><TransId></TransId><Password>ISBANK07</Password><IPAddress>127.0.0.1</IPAddress><Email>[e-mail]</Email><Total>16.40</Total></CC5Request>",
            "raw_response": "<?xml version=\"1.0\" encoding=\"ISO-8859-9\"?>\n<CC5Response>\n  <OrderId>bf7b661492364559856ff12201f157d9</OrderId>\n  <GroupId>bf7b661492364559856ff12201f157d9</GroupId>\n  <Response>Approved</Response>\n  <AuthCode>P31790</AuthCode>\n  <HostRefNum>703000000296</HostRefNum>\n  <ProcReturnCode>00</ProcReturnCode>\n  <TransId>17030LcZH11794</TransId>\n  <ErrMsg></ErrMsg>\n  <Extra>\n    <SETTLEID>385</SETTLEID>\n    <TRXDATE>20170130 11:28:25</TRXDATE>\n    <ERRORCODE></ERRORCODE>\n    <TERMINALID>00556600</TERMINALID>\n    <MERCHANTID>655000100</MERCHANTID>\n    <CARDBRAND>VISA</CARDBRAND>\n    <CARDISSUER>T. IS BANKASI A.S.</CARDISSUER>\n    <HOSTDATE>0130-112825</HOSTDATE>\n    <NUMCODE>00</NUMCODE>\n  </Extra>\n</CC5Response>\n",
            "is_succeeded": true,
            "amount": "16.40",
            "remote_addr": null,
            "created_date": "2017-02-02T09:40:29.245976Z",
            "pos_slug": "HA",
            "modified_date": "2017-02-05T20:03:17.186801Z"
        }
    ],
    "payment_option": {
        "pk": 2,
        "name": "Credit Card",
        "slug": "credit_Card",
        "payment_type": "credit_card",
        "sort_order": 0,
        "is_active": true,
        "config": {},
        "translations": {
            "tr-tr": {
                "name": "Kredi Kartı"
            }
        },
        "channel": 1,
        "modified_date": "2021-11-10T10:06:41.529791Z",
        "created_date": "2017-02-01T14:46:02.110133Z"
    },
    "payment_option_slug": "kredi_karti",
    "bin_number": "454360",
    "installment": {
        "pk": 22,
        "card": {
            "pk": 23,
            "name": "Maximum",
            "bank": {
                "pk": 16,
                "name": "İş Bankası",
                "slug": "is-bankas",
                "logo": null,
                "channel": 1,
                "modified_date": "2017-02-01T14:34:07.916233Z",
                "created_date": "2017-02-01T14:34:07.916213Z"
            },
            "card_type": {
                "pk": 18,
                "name": "Maximum",
                "slug": "maximum",
                "logo": "http://localhost:8000/media/card_types/2017/02/01/d09bb303-ea29-4eba-8c9a-f9bc056d52d7.jpg",
                "channel": 1,
                "modified_date": "2017-02-01T14:34:08.130132Z",
                "created_date": "2017-02-01T14:34:08.130112Z"
            },
            "card_payment_type": "credit",
            "cash_payment": 10,
            "installment_payment": 2,
            "slug": "maximum",
            "three_d_payment": 10,
            "is_commerce_card": false,
            "channel": 1,
            "modified_date": "2017-02-01T14:34:08.139753Z",
            "created_date": "2017-02-01T14:34:08.139728Z"
        },
        "installment_count": 1,
        "label": "Peşin",
        "interest_rate": "0.000000",
        "is_active": true,
        "config": {},
        "translations": null
    },
    "installment_count": 1,
    "installment_interest_amount": "0.00",
    "cargo_company": {
        "pk": 1,
        "name": "Aras",
        "erp_code": "ARAS",
        "shipping_company": "aras",
        "modified_date": "2018-08-15T12:11:54.402253Z",
        "created_date": "2017-01-30T14:02:18.165573Z"
    },
    "invoice_number": "",
    "invoice_date": null,
    "e_archive_url": null,
    "refund_amount": "0.00",
    "discount_refund_amount": "0.00",
    "shipping_refund_amount": "0.00",
    "discount_amount": "0.00",
    "cancellation_info": {},
    "status_display": "approved",
    "tracking_number": null,
    "is_send": true,
    "cancel_status": null,
    "net_shipping_amount": 8.5,
    "remote_addr": null,
    "language_code": null,
    "fundstransfertransaction_set": [],
    "has_gift_box": false,
    "gift_box_note": null,
    "tracking_url": null,
    "external_status": null,
    "payondeliverytransaction_set": [],
    "loyaltytransaction_set": [],
    "bextransaction_set": [],
    "cancellationplan_set": [],
    "cashregistertransaction_set": [],
    "client_type": "default",
    "shipping_interest_amount": "0.00",
    "delivery_type": null,
    "notes": null,
    "delivery_range": null,
    "shipping_option_slug": null,
    "segment": null,
    "carrier_shipping_code": null,
    "mapping": [
        {
            "pk": 905,
            "content_type": 40,
            "object_id": 27,
            "integration_type": "external_company",
            "code": "1-R-2-180466",
            "modified_date": "2017-02-02T17:03:37.179813Z",
            "created_date": "2017-02-02T17:03:37.179786Z"
        }
    ],
    "ordertransaction_set": [],
    "ordershippinginfo_set": [
        {
            "pk": 4,
            "order": 27,
            "order_number": "bf7b66149236455",
            "shipping_company": "aras",
            "send_request": null,
            "send_response": {},
            "is_send": true,
            "cargo_label": null,
            "modified_date": "2018-08-15T12:11:54.425172Z",
            "created_date": "2018-08-15T12:11:54.425124Z"
        }
    ]
}