Cancellation & Refund Pending Orders
Orders pending cancellation, return confirmation (LIST):
GET Cancel & Refund Pending Orders
Path: /api/i1/orders/?limit=10&page=1&cancel_status=waiting
Sample HTTP request to retrieve only cancellation and refund pending orders.
countshows how many orders exist in the system.nextshows the next page url to retrieve the desired order data.previousshows the previous page url to retrieve the desired order data.resultsshows every order property with detailed field descriptions.
Example Request
import requests
url = "https://{customer_api_url}/api/i1/orders/"
api_token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"
headers = {
'content-type': 'application/json',
'Authorization': 'Token {}'.format(api_token)
}
params = {
'cancel_status: 'waiting',
'limit': 10,
'page': 1,
}
response = requests.get(url, headers=headers , params=params)
print(response.text)
Example Response
Shows desired orders. All parameters of an order are described in the table below.
| Property | Data Type | Description |
| number | integer | Order code |
| status | string | Status of order in the current time. Order statuses are predefined. You can look up for meaning of the status in the Order Status section |
| date_placed | iso date str | Created date of the order |
| customer | dict | Related Customer object. See the Customer section for more details about the fields in the customer dictionary. |
| shipping_address | dict | Related Address object. See the Address section for more details about the fields in the shipping_address dictionary. |
| billing_address | dict | Related Address object. See the Address section for more details about the fields in the billing_address dictionary. |
| currency | string | Currency type of the transaction. Currency types are predefined. Every currency type is a global abbreviation of the currency. |
| amount | string | Amount of the order |
| shipping_amount | string | Shipping amount of the order |
| shipping_tax_rate | string | Shipping tax rate of the order |
| extra_field | dict | Usage of extra information. |
| payment_option | int | Related Payment Option object ID. See the Payments section for more information. |
| payment_option_slug | string | Unique slug information related to the Payment Option object. |
| bin_number | string | Bin Number |
| installment | int | Related Installment object id. See the Payments section for more information |
| installment_count | int | Installment count information related to the Installment object. |
| installment_interest_amount | string | Calculated by (amount of the order * installment interest rate) Installment interest rate is the related Installment object info. |
| cargo_company | int | Related Cargo Company object ID |
| invoice_number | string | Invoice number |
| invoice_date | Iso date str | Invoice date |
| e_archieve_url | Url field str | e archive url info |
| refund_amount | string | Refund amount |
| discount_refund_amount | string | Discount refund amount |
| shipping_refund_amount | string | Shipping refund amount |
| shipping_refund_amount | string | Shipping refund amount |
| discount_amount | string | Discount amount |
| is_send | boolean | True means order sent to ERP. |
| net_shipping _amount | string | Net shipping amount. (Shipping amount + Shipping Interest Amount) |
| shipping_interest_amount | string | 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 | Gift Box is selected or not |
| gift_box_note | string | Note for the gift box |
| external_status | int | Related Order External Status object ID. |
| orderitem_set | list | Each element is the related Order Item object. See the Order Item section for more information. |
| channel | dict | Related Channel object. See the Channel section for more information. |
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 32,
"number": "d4d10357bbf314b0",
"status": "450",
"date_placed": "2017-02-01T14:45:47.033367Z",
"customer": {
"id": 1104,
"email": "samplemail@akinon.com",
"first_name": "John",
"last_name": "Doe",
"phone_number": null
},
"shipping_address": {
"email": "samplemail@akinon.com",
"phone_number": "9999999999",
"first_name": "John",
"last_name": "Doe",
"country": {
"name": "Turkey",
"code": "tr"
},
"city": {
"id": 62,
"name": "İstanbul"
},
"line": "line",
"title": "title",
"township": {
"id": 156,
"name": "SARIYER"
},
"district": null,
"postcode": "31213",
"notes": null,
"company_name": null,
"tax_office": null,
"tax_no": null,
"e_bill_taxpayer": false,
"identity_number": null,
"extra_field": {}
},
"billing_address": {
"email": "samplemail@akinon.com",
"phone_number": "9999999999",
"first_name": "John",
"last_name": "Doe",
"country": {
"name": "Turkey",
"code": "tr"
},
"city": {
"id": 62,
"name": "İstanbul"
},
"line": "line",
"title": "title",
"township": {
"id": 156,
"name": "SARIYER"
},
"district": null,
"postcode": "31213",
"notes": null,
"company_name": null,
"tax_office": null,
"tax_no": null,
"e_bill_taxpayer": false,
"identity_number": null,
"extra_field": {}
},
"currency": "try",
"amount": "11.40",
"shipping_amount": "8.50",
"shipping_tax_rate": null,
"extra_field": {
"cargo_line_id": "a55a2b33-434f-4cb6-b369-a70f00860df1"
},
"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": null,
"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": 118,
"order": 32,
"product_sku": "2672881094195",
"status": "450",
"price_currency": "try",
"price": "2.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/"
}
}
},
{
"id": 33,
"number": "95d4deb15760461",
"status": "50",
"date_placed": "2017-02-02T11:06:57.973468Z",
"customer": {
"id": 1105,
"email": "samplemail@akinon.com",
"first_name": "John",
"last_name": "Doe",
"phone_number": null
},
"shipping_address": {
"email": "samplemail@akinon.com",
"phone_number": "9999999999",
"first_name": "Akinon",
"last_name": "Şirket",
"country": {
"name": "Turkey",
"code": "tr"
},
"city": {
"id": 65,
"name": "Adıyaman"
},
"line": "line",
"title": "Adres Ev",
"township": {
"id": 576,
"name": "ÇELİKHAN"
},
"district": {
"id": 3993,
"name": "MERKEZ"
},
"postcode": "34170",
"notes": null,
"company_name": null,
"tax_office": null,
"tax_no": null,
"e_bill_taxpayer": false,
"identity_number": null,
"extra_field": {}
},
"billing_address": {
"email": "samplemail@akinon.com",
"phone_number": "9999999999",
"first_name": "Akinon",
"last_name": "Şirket",
"country": {
"name": "Turkey",
"code": "tr"
},
"city": {
"id": 65,
"name": "Adıyaman"
},
"line": "line",
"title": "Adres Ev",
"township": {
"id": 576,
"name": "ÇELİKHAN"
},
"district": {
"id": 3993,
"name": "MERKEZ"
},
"postcode": "34170",
"notes": null,
"company_name": null,
"tax_office": null,
"tax_no": null,
"e_bill_taxpayer": false,
"identity_number": null,
"extra_field": {}
},
"currency": "try",
"amount": "33.22",
"shipping_amount": "8.50",
"shipping_tax_rate": null,
"extra_field": {
"cargo_line_id": "33c7d761-0b65-451d-bbbf-a70f00860fdb"
},
"payment_option": 2,
"payment_option_slug": "kredi_karti",
"bin_number": "454359",
"installment": 22,
"installment_count": 1,
"installment_interest_amount": "0.00",
"cargo_company": 1,
"invoice_number": null,
"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": 119,
"order": 33,
"product_sku": "2672880307807",
"status": "50",
"price_currency": "try",
"price": "24.72",
"tax_rate": "18.00",
"extra_field": {},
"price_list": 1,
"stock_list": 1,
"cancel_status": "waiting",
"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/"
}
}
}
]
}