Get Order Detail by Order Number

In order to extract specific order details, the user must know the number field of the order.

Parameter	Data Type	Required	In	Description
api_token	string	YES	header	The API key of the customer’s account
{order_number}	string	YES	query	Order No.

GET Order Detail by Order Number

Path: /api/i1/orders/

GET request is used for retrieving order details.

• 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/i1/orders/{order_number}"
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 with a given number. All parameters of an order are described in the table below. Resource properties are in Python format.

Parameter	Data Type	Description
number	integer	Order code
status	string	Order status code
date_placed	string	Order date
customer	dict	Customer information
email	string	Customer e-mail
first_name	string	Customer name
last_name	string	Customer surname
phone_number	string	Customer phone
shipping_address	dict	Shipping destination address information
email	string	Ship-to party email
first_name	string	Ship-to party name
last_name	string	Ship-to party surname
phone_number	string	Ship-to party phone number
country	dict	Destination country code
name	string	Destination country name
code	string	Destination country code
city	dict	Order's city details
id	string	City ID
name	string	City name
line	string	Address
title	string	Address title
township	dict	Order's township details
id	string	Township ID
name	string	Township name
district	dict	Order's district details
id	string	District ID
postcode	string	District postcode
notes	string	Address notes
company_name	string	Company name
tax_office	string	Tax office
tax_no	string	Tax no
e_bill_taxpayer	boolean	Is E-bill tax payer or not
billing_address	dict	Billing address
currency	string	Unit of currency
amount	float	Amount
shipping_amount	float	Shipping amount
shipping_tax_rate	float	Shipping tax rate
extra_field	dict	Additional informations about order
payment_option	string	Related Payment Option object id. Check for Payment section for more information.
payment_option_slug	string	Related Payment Option object slug property.
bin_number	string	Bin number
installment	string	Related Installment object id. See the Installment section for more information.
installment_count	integer	Installment count
installment_interest_amount	string	Late charges
cargo_company	string	Cargo company
invoice_number	string	Invoice number
invoice_date	iso date str	Invoice date
e_archive_url	string	E-archive url
refund_amount	string	Refund amount
discount_refund_amount	string	Discount refund amount
shipping_refund_amount	string	Shipping refund amount
discount_amount	float	Total discount amount for the order
is_send	boolean	Shows if the order has been sent to ERP
net_shipping_amount	float	Net shipping amount. (Shipping amount + Shipping Interest Amount)
shipping_interest_amount	float	Shipping Interest amount
tracking_number	string	Tracking number for cargo integration
carrier_shipping_code	string	Shipping code for cargo integration
remote_addr	string	Generic IP address for the orders created.
has_gift_box	boolean	Shows whether it has a gift box
gift_box_note	string	Gift Note
external_status	id	Related Order External Status object id.
orderitem_set	array	List of order items
id	string	Order item ID
order	string	The order of the order item
product_sku	string	Product SKU of order item
status	string	Order status code
price_currency	string	Price currency of the order item
price	float	Price of the order item
tax_rate	float	Tax rate of the order item
extra_field	float	Additional information about the order item
price_list	id	The price list containing the order item
stock_list	id	The stock list containing the order item
cancel_status	string	waiting, confirmation_waiting, confirmed, approved, rejected, waiting_for_payment, manuel_refund_need, completed
invoice_number	string	Invoice number
invoice_date	iso date str	Invoice date
e_archive_url	string	E-archive url
installment_interest_amount	float	Delay interest of installment
tracking_number	string	Shipping tracking number
carrier_shipping_code	string	Shipping code for cargo integration
shipping_company	string	Shipping company
shipment_code	string	Shipment code
external_status	id	Related Order External Status object ID.
discount_amount	string	Total discount applied of order
retail_price	float	Retail price
attributes	dict	Attribute list
attributes_kwargs	dict	Details of the attributes attached to the product
image	str(url)	Product image

{
    "id": 27,
    "number": "bf7b66149236455",
    "status": "400",
    "date_placed": "2017-01-30T08:28:26.158165Z",
    "customer": {
        "id": 1103,
        "email": "[e-mail]",
        "first_name": "TEST",
        "last_name": "TEST",
        "phone_number": null
    },
    "shipping_address": {
        "email": "[e-mail]",
        "phone_number": "0 [phone]",
        "first_name": "TEST",
        "last_name": "TEST",
        "country": {
            "name": "Turkey",
            "code": "tr"
        },
        "city": {
            "id": 71,
            "name": "Afyon"
        },
        "line": "test",
        "title": "TEST",
        "township": {
            "id": 853,
            "name": "DİNAR"
        },
        "district": {
            "id": 3679,
            "name": "İNCESU"
        },
        "postcode": "11111",
        "notes": null,
        "company_name": null,
        "tax_office": null,
        "tax_no": null,
        "e_bill_taxpayer": false,
        "identity_number": null,
        "extra_field": {}
    },
    "billing_address": {
        "email": "[e-mail]",
        "phone_number": "0 [phone]",
        "first_name": "TEST",
        "last_name": "TEST",
        "country": {
            "name": "Turkey",
            "code": "tr"
        },
        "city": {
            "id": 71,
            "name": "Afyon"
        },
        "line": "test",
        "title": "TEST",
        "township": {
            "id": 853,
            "name": "DİNAR"
        },
        "district": {
            "id": 3679,
            "name": "İNCESU"
        },
        "postcode": "11111",
        "notes": null,
        "company_name": null,
        "tax_office": null,
        "tax_no": null,
        "e_bill_taxpayer": false,
        "identity_number": null,
        "extra_field": {}
    },
    "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,
    "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,
    "has_gift_box": false,
    "gift_box_note": null,
    "external_status": null,
    "orderitem_set": [
        {
            "id": 113,
            "order": 27,
            "product_sku": "2672881047887",
            "status": "400",
            "price_currency": "try",
            "price": "7.90",
            "tax_rate": "18.00",
            "extra_field": {},
            "price_list": 1,
            "stock_list": 1,
            "cancel_status": null,
            "invoice_number": null,
            "invoice_date": null,
            "e_archive_url": null,
            "installment_interest_amount": "0.00",
            "tracking_number": null,
            "carrier_shipping_code": null,
            "shipping_company": null,
            "shipment_code": null,
            "external_status": null,
            "discount_amount": "0.00",
            "retail_price": null,
            "attributes": {},
            "attributes_kwargs": {},
            "image": null
        }
    ],
    "channel": {
        "name": "Shop",
        "conf": {
            "server": "http://localhost:8080/api/v1/"
        }
    }
}