SalesChannelOrders
Replace multiple products in an order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Bodyobject[]
List of order items for product replacement
order_itemintegerOptionalExample:
Order item ID for product replacement
1new_product_skustringOptionalExample:
New product SKU for replacement
NEW_SKU_123Responses
200
Products successfully replaced in the order
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/bulk_replace_product/POST /api/v1/channel/{channel_id}/orders/{id}/bulk_replace_product/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2
[]{
"pk": 1,
"number": "ORDER12345",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"status": "cancellation_waiting",
"date_placed": "2024-11-20T11:22:23.702774Z",
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"shipping_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"billing_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"currency": "try",
"amount": 1000,
"shipping_amount": 20,
"extra_field": {},
"orderitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"attributes": {
"key1": "value1",
"key2": "value2"
},
"attributes_kwargs": {
"key1": "value1",
"key2": "value2"
},
"localized_attributes": {
"name": {
"en": "English",
"es": "Spanish"
}
},
"localized_attributes_kwargs": {
"key": {
"key1": "value1",
"key2": "value2"
}
}
}
],
"discountitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"transaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"payment_option": {
"id": 1,
"name": "text",
"slug": "text",
"payment_type": "credit_card",
"sort_order": 0,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_active": true,
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"translations": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"bank_interest_rate": 1,
"card": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"bank": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/bank-xyz.png",
"integration": {},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_type": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/credit-card.png",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_payment_type": "credit",
"cash_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"three_d_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"is_commerce_card": false,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_count": 1,
"label": "text",
"interest_rate": 1,
"is_active": true,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"translations": {},
"created_date": "2024-01-01T12:00:00Z",
"modified_date": "2024-01-02T12:00:00Z"
},
"installment_count": 6,
"installment_interest_amount": 10,
"cargo_company": {
"pk": 1,
"name": "UPS",
"erp_code": "UPS_001",
"shipping_company": "yurtici",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"discount_amount": 50,
"cancellation_info": {},
"status_display": "waiting",
"tracking_number": "TRACK12345",
"is_send": false,
"cancel_status": "waiting",
"net_shipping_amount": 15,
"remote_addr": "0.0.0.0",
"language_code": "tr-tr",
"fundstransfertransaction_set": [
{
"pk": 1,
"order": 1,
"user_email": "text",
"remote_addr": "text",
"amount": 1,
"chosen_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"date_paid": "2025-12-01T09:39:00.483Z",
"paid_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"user_holder_name": "text",
"user_iban": "text",
"transaction_type": "purchase",
"status": "paid",
"pos": 1,
"raw_request": "text",
"raw_response": "text",
"is_succeeded": true,
"reference_code": "text",
"currency": "try"
}
],
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"tracking_url": "https://tracking.example.com/track/123",
"external_status": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"code": "text"
},
"payondeliverytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"loyaltytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"bextransaction_set": [],
"b2btransaction_set": [
{
"pk": 1,
"order": 1,
"amount": 1,
"transaction_type": "purchase",
"user_email": "text",
"remote_addr": "text",
"created_date": "2025-12-01T09:39:00.483Z"
}
],
"cancellationplan_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"cashregistertransaction_set": [
{
"pk": 1,
"transaction_id": "text",
"order": 1,
"user_email": "text",
"raw_request": "text",
"raw_response": "text",
"amount": 1,
"remote_addr": "text",
"staff_id": 1,
"staff_remote_id": "text",
"staff_email": "text",
"store_id": 1,
"store_remote_id": "text",
"transaction_type": "purchase",
"is_succeeded": true
}
],
"client_type": "android",
"shipping_interest_amount": 10,
"delivery_type": "same_day",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"segment": "premium",
"carrier_shipping_code": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"installment_free": false
}Retrieve order by ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Responses
200
Order found successfully
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
get
/api/v1/channel/{channel_id}/orders/{id}/GET /api/v1/channel/{channel_id}/orders/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"pk": 1,
"number": "ORDER12345",
"channel": 1,
"customer": 1,
"date_placed": "2024-11-20T11:22:23.702774Z",
"extra_field": {
"special_note": "Handle with care"
},
"payment_option": 1,
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": 1,
"installment_count": 6,
"installment_interest_amount": 50,
"cargo_company": 1,
"is_send": false,
"delivery_type": "next_day",
"cancellation_info": {
"reason": "Customer requested cancellation"
},
"cancel_status": "cancelled",
"shipping_interest_amount": 10,
"external_status": 1,
"client_type": "default",
"carrier_shipping_code": "TRACK12345",
"segment": "premium",
"checkout_provider_id": 12345,
"status": 200,
"currency": "try",
"amount": 1000,
"discount_amount": 50,
"shipping_amount": 20,
"shipping_tax_rate": 18,
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"tracking_number": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"shipping_company": "yurtici",
"remote_addr": "192.168.0.1",
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"language_code": "en",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}Updates the order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
pkintegerOptionalExample:
Unique identifier for the order.
1numberstringRequiredExample:
Order number, unique within the context of a channel.
ORDER12345channelintegerRequired
ID of the channel associated with the order.
customerintegerRequiredExample:
ID of the customer who placed the order.
1date_placedstring · date-timeRequiredExample:
Timestamp when the order was placed.
2024-11-20T11:22:23.702774Zpayment_optionintegerOptionalExample:
ID of the payment option used for the order.
1payment_option_slugstring | nullableOptionalExample:
Slug of the payment option.
credit-cardbin_numberstring | nullableOptionalExample:
First 6 digits of the customer's card used in the transaction.
123456installmentintegerOptionalExample:
ID of the installment object used for the order.
1installment_countinteger | nullableOptionalExample:
Number of installments for the payment.
6installment_interest_amountnumber · decimalOptionalExample:
Interest charged on installment payments.
50cargo_companyintegerOptionalExample:
ID of the cargo company used for shipping.
1is_sendbooleanOptionalExample:
Indicates whether the order has been sent.
falsedelivery_typestring · enum | nullableOptionalExample:
Type of delivery selected for the order.
next_dayPossible values: cancellation_infoobjectOptionalExample:
Details regarding the cancellation of the order.
{"reason":"Customer requested cancellation"}cancel_statusstring · enum | nullableOptionalExample:
Status of the order cancellation.
cancelledPossible values: shipping_interest_amountnumber · decimalOptionalExample:
Interest applied to the shipping cost.
10external_statusintegerOptionalExample:
ID of the external status associated with the order.
1client_typestring · enumOptionalExample:
Type of client placing the order.
defaultPossible values: carrier_shipping_codestring | nullableOptionalExample:
Tracking code assigned by the carrier.
TRACK12345segmentstring | nullableOptionalExample:
Customer segment for the order.
premiumcheckout_provider_idinteger | nullableOptionalExample:
ID of the provider used for checkout.
12345statusstring · enumRequiredExample:
Status of the order
200Possible values: currencystring · enumOptionalExample:
Currency type for the order, following ISO 4217 currency codes.
tryPossible values: amountnumber · decimalRequiredExample:
Total amount for the order.
1000discount_amountnumber · decimalOptionalExample:
Discount applied to the order.
50shipping_amountnumber · decimalOptionalExample:
Shipping charge for the order.
20shipping_tax_ratenumber · decimal | nullableOptionalExample:
Tax rate applied to the shipping charge.
18refund_amountnumber · decimalOptionalExample:
Total refund amount for the order. Shipping refund amount included.
100discount_refund_amountnumber · decimalOptionalExample:
Refund amount for the discount.
10shipping_refund_amountnumber · decimalOptionalExample:
Refund amount for the shipping.
5invoice_numberstring | nullableOptionalExample:
Invoice number for the order.
INV123456invoice_datestring · date-time | nullableOptionalExample:
Invoice date for the order.
2024-11-21T11:22:23.702774Ze_archive_urlstring · url | nullableOptionalExample:
URL for the e-archive of the invoice.
https://earchive.example.com/invoice/123tracking_numberstring | nullableOptionalExample:
Tracking number for the order.
TRACK12345defined_tracking_urlstring · url | nullableOptionalExample:
URL for tracking the order.
https://tracking.example.com/track/123shipping_companystring · enumOptionalExample:
Shipping company options
yurticiPossible values: remote_addrstring · ipv4 | nullableOptionalExample:
IP address from where the order was placed.
192.168.0.1has_gift_boxbooleanOptionalExample:
Indicates whether the order has a gift box.
falsegift_box_notestring | nullableOptionalExample:
Message for the gift box.
Happy Birthday!language_codestring | nullableOptionalExample:
Language code for the order.
ennotesstring | nullableOptionalExample:
Customer instructions for the order.
Leave at the front door.shipping_option_slugstring | nullableOptionalExample:
Slug for the shipping option.
standard-shippingcreated_datestring · date-timeOptional
Creation Date
modified_datestring · date-timeOptional
Last Modification Date
Responses
200
Order successfully updated
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
put
/api/v1/channel/{channel_id}/orders/{id}/PUT /api/v1/channel/{channel_id}/orders/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1406
{
"pk": 1,
"number": "ORDER12345",
"channel": 1,
"customer": 1,
"date_placed": "2024-11-20T11:22:23.702774Z",
"extra_field": {
"special_note": "Handle with care"
},
"payment_option": 1,
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": 1,
"installment_count": 6,
"installment_interest_amount": 50,
"cargo_company": 1,
"is_send": false,
"delivery_type": "next_day",
"cancellation_info": {
"reason": "Customer requested cancellation"
},
"cancel_status": "cancelled",
"shipping_interest_amount": 10,
"external_status": 1,
"client_type": "default",
"carrier_shipping_code": "TRACK12345",
"segment": "premium",
"checkout_provider_id": 12345,
"status": 200,
"currency": "try",
"amount": 1000,
"discount_amount": 50,
"shipping_amount": 20,
"shipping_tax_rate": 18,
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"tracking_number": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"shipping_company": "yurtici",
"remote_addr": "192.168.0.1",
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"language_code": "en",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}{
"pk": 1,
"number": "ORDER12345",
"channel": 1,
"customer": 1,
"date_placed": "2024-11-20T11:22:23.702774Z",
"extra_field": {
"special_note": "Handle with care"
},
"payment_option": 1,
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": 1,
"installment_count": 6,
"installment_interest_amount": 50,
"cargo_company": 1,
"is_send": false,
"delivery_type": "next_day",
"cancellation_info": {
"reason": "Customer requested cancellation"
},
"cancel_status": "cancelled",
"shipping_interest_amount": 10,
"external_status": 1,
"client_type": "default",
"carrier_shipping_code": "TRACK12345",
"segment": "premium",
"checkout_provider_id": 12345,
"status": 200,
"currency": "try",
"amount": 1000,
"discount_amount": 50,
"shipping_amount": 20,
"shipping_tax_rate": 18,
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"tracking_number": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"shipping_company": "yurtici",
"remote_addr": "192.168.0.1",
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"language_code": "en",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}Partially updates the order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
pkintegerOptionalExample:
Unique identifier for the order.
1numberstringRequiredExample:
Order number, unique within the context of a channel.
ORDER12345channelintegerRequired
ID of the channel associated with the order.
customerintegerRequiredExample:
ID of the customer who placed the order.
1date_placedstring · date-timeRequiredExample:
Timestamp when the order was placed.
2024-11-20T11:22:23.702774Zpayment_optionintegerOptionalExample:
ID of the payment option used for the order.
1payment_option_slugstring | nullableOptionalExample:
Slug of the payment option.
credit-cardbin_numberstring | nullableOptionalExample:
First 6 digits of the customer's card used in the transaction.
123456installmentintegerOptionalExample:
ID of the installment object used for the order.
1installment_countinteger | nullableOptionalExample:
Number of installments for the payment.
6installment_interest_amountnumber · decimalOptionalExample:
Interest charged on installment payments.
50cargo_companyintegerOptionalExample:
ID of the cargo company used for shipping.
1is_sendbooleanOptionalExample:
Indicates whether the order has been sent.
falsedelivery_typestring · enum | nullableOptionalExample:
Type of delivery selected for the order.
next_dayPossible values: cancellation_infoobjectOptionalExample:
Details regarding the cancellation of the order.
{"reason":"Customer requested cancellation"}cancel_statusstring · enum | nullableOptionalExample:
Status of the order cancellation.
cancelledPossible values: shipping_interest_amountnumber · decimalOptionalExample:
Interest applied to the shipping cost.
10external_statusintegerOptionalExample:
ID of the external status associated with the order.
1client_typestring · enumOptionalExample:
Type of client placing the order.
defaultPossible values: carrier_shipping_codestring | nullableOptionalExample:
Tracking code assigned by the carrier.
TRACK12345segmentstring | nullableOptionalExample:
Customer segment for the order.
premiumcheckout_provider_idinteger | nullableOptionalExample:
ID of the provider used for checkout.
12345statusstring · enumRequiredExample:
Status of the order
200Possible values: currencystring · enumOptionalExample:
Currency type for the order, following ISO 4217 currency codes.
tryPossible values: amountnumber · decimalRequiredExample:
Total amount for the order.
1000discount_amountnumber · decimalOptionalExample:
Discount applied to the order.
50shipping_amountnumber · decimalOptionalExample:
Shipping charge for the order.
20shipping_tax_ratenumber · decimal | nullableOptionalExample:
Tax rate applied to the shipping charge.
18refund_amountnumber · decimalOptionalExample:
Total refund amount for the order. Shipping refund amount included.
100discount_refund_amountnumber · decimalOptionalExample:
Refund amount for the discount.
10shipping_refund_amountnumber · decimalOptionalExample:
Refund amount for the shipping.
5invoice_numberstring | nullableOptionalExample:
Invoice number for the order.
INV123456invoice_datestring · date-time | nullableOptionalExample:
Invoice date for the order.
2024-11-21T11:22:23.702774Ze_archive_urlstring · url | nullableOptionalExample:
URL for the e-archive of the invoice.
https://earchive.example.com/invoice/123tracking_numberstring | nullableOptionalExample:
Tracking number for the order.
TRACK12345defined_tracking_urlstring · url | nullableOptionalExample:
URL for tracking the order.
https://tracking.example.com/track/123shipping_companystring · enumOptionalExample:
Shipping company options
yurticiPossible values: remote_addrstring · ipv4 | nullableOptionalExample:
IP address from where the order was placed.
192.168.0.1has_gift_boxbooleanOptionalExample:
Indicates whether the order has a gift box.
falsegift_box_notestring | nullableOptionalExample:
Message for the gift box.
Happy Birthday!language_codestring | nullableOptionalExample:
Language code for the order.
ennotesstring | nullableOptionalExample:
Customer instructions for the order.
Leave at the front door.shipping_option_slugstring | nullableOptionalExample:
Slug for the shipping option.
standard-shippingcreated_datestring · date-timeOptional
Creation Date
modified_datestring · date-timeOptional
Last Modification Date
Responses
200
Order successfully updated
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
patch
/api/v1/channel/{channel_id}/orders/{id}/PATCH /api/v1/channel/{channel_id}/orders/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1406
{
"pk": 1,
"number": "ORDER12345",
"channel": 1,
"customer": 1,
"date_placed": "2024-11-20T11:22:23.702774Z",
"extra_field": {
"special_note": "Handle with care"
},
"payment_option": 1,
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": 1,
"installment_count": 6,
"installment_interest_amount": 50,
"cargo_company": 1,
"is_send": false,
"delivery_type": "next_day",
"cancellation_info": {
"reason": "Customer requested cancellation"
},
"cancel_status": "cancelled",
"shipping_interest_amount": 10,
"external_status": 1,
"client_type": "default",
"carrier_shipping_code": "TRACK12345",
"segment": "premium",
"checkout_provider_id": 12345,
"status": 200,
"currency": "try",
"amount": 1000,
"discount_amount": 50,
"shipping_amount": 20,
"shipping_tax_rate": 18,
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"tracking_number": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"shipping_company": "yurtici",
"remote_addr": "192.168.0.1",
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"language_code": "en",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}{
"pk": 1,
"number": "ORDER12345",
"channel": 1,
"customer": 1,
"date_placed": "2024-11-20T11:22:23.702774Z",
"extra_field": {
"special_note": "Handle with care"
},
"payment_option": 1,
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": 1,
"installment_count": 6,
"installment_interest_amount": 50,
"cargo_company": 1,
"is_send": false,
"delivery_type": "next_day",
"cancellation_info": {
"reason": "Customer requested cancellation"
},
"cancel_status": "cancelled",
"shipping_interest_amount": 10,
"external_status": 1,
"client_type": "default",
"carrier_shipping_code": "TRACK12345",
"segment": "premium",
"checkout_provider_id": 12345,
"status": 200,
"currency": "try",
"amount": 1000,
"discount_amount": 50,
"shipping_amount": 20,
"shipping_tax_rate": 18,
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"tracking_number": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"shipping_company": "yurtici",
"remote_addr": "192.168.0.1",
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"language_code": "en",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}Update the cancel status of the order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
orderintegerOptionalExample:
ID of the order to be updated.
1order_itemsinteger[]OptionalExample:
List of order item IDs to be updated.
[1,2,3]cancel_statusstring · enumOptionalExample:
Cancellation status of the order item
waitingPossible values: Responses
200
Order cancel status successfully updated
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/update_cancel_status/POST /api/v1/channel/{channel_id}/orders/{id}/update_cancel_status/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 61
{
"order": 1,
"order_items": [
[
1,
2,
3
]
],
"cancel_status": "waiting"
}{
"pk": 1,
"number": "ORDER12345",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"status": "cancellation_waiting",
"date_placed": "2024-11-20T11:22:23.702774Z",
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"shipping_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"billing_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"currency": "try",
"amount": 1000,
"shipping_amount": 20,
"extra_field": {},
"orderitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"attributes": {
"key1": "value1",
"key2": "value2"
},
"attributes_kwargs": {
"key1": "value1",
"key2": "value2"
},
"localized_attributes": {
"name": {
"en": "English",
"es": "Spanish"
}
},
"localized_attributes_kwargs": {
"key": {
"key1": "value1",
"key2": "value2"
}
}
}
],
"discountitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"transaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"payment_option": {
"id": 1,
"name": "text",
"slug": "text",
"payment_type": "credit_card",
"sort_order": 0,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_active": true,
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"translations": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"bank_interest_rate": 1,
"card": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"bank": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/bank-xyz.png",
"integration": {},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_type": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/credit-card.png",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_payment_type": "credit",
"cash_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"three_d_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"is_commerce_card": false,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_count": 1,
"label": "text",
"interest_rate": 1,
"is_active": true,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"translations": {},
"created_date": "2024-01-01T12:00:00Z",
"modified_date": "2024-01-02T12:00:00Z"
},
"installment_count": 6,
"installment_interest_amount": 10,
"cargo_company": {
"pk": 1,
"name": "UPS",
"erp_code": "UPS_001",
"shipping_company": "yurtici",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"discount_amount": 50,
"cancellation_info": {},
"status_display": "waiting",
"tracking_number": "TRACK12345",
"is_send": false,
"cancel_status": "waiting",
"net_shipping_amount": 15,
"remote_addr": "0.0.0.0",
"language_code": "tr-tr",
"fundstransfertransaction_set": [
{
"pk": 1,
"order": 1,
"user_email": "text",
"remote_addr": "text",
"amount": 1,
"chosen_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"date_paid": "2025-12-01T09:39:00.483Z",
"paid_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"user_holder_name": "text",
"user_iban": "text",
"transaction_type": "purchase",
"status": "paid",
"pos": 1,
"raw_request": "text",
"raw_response": "text",
"is_succeeded": true,
"reference_code": "text",
"currency": "try"
}
],
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"tracking_url": "https://tracking.example.com/track/123",
"external_status": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"code": "text"
},
"payondeliverytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"loyaltytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"bextransaction_set": [],
"b2btransaction_set": [
{
"pk": 1,
"order": 1,
"amount": 1,
"transaction_type": "purchase",
"user_email": "text",
"remote_addr": "text",
"created_date": "2025-12-01T09:39:00.483Z"
}
],
"cancellationplan_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"cashregistertransaction_set": [
{
"pk": 1,
"transaction_id": "text",
"order": 1,
"user_email": "text",
"raw_request": "text",
"raw_response": "text",
"amount": 1,
"remote_addr": "text",
"staff_id": 1,
"staff_remote_id": "text",
"staff_email": "text",
"store_id": 1,
"store_remote_id": "text",
"transaction_type": "purchase",
"is_succeeded": true
}
],
"client_type": "android",
"shipping_interest_amount": 10,
"delivery_type": "same_day",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"segment": "premium",
"carrier_shipping_code": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"installment_free": false
}Retrieve the remote ID of an order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Responses
200
Remote ID found successfully
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
get
/api/v1/channel/{channel_id}/orders/{id}/get_remote_id/GET /api/v1/channel/{channel_id}/orders/{id}/get_remote_id/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"order_id": 123456,
"remote_id": "123456789"
}Retrieve order detailed by ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Responses
200
Order found successfully
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
get
/api/v1/channel/{channel_id}/orders/{id}/detailed/GET /api/v1/channel/{channel_id}/orders/{id}/detailed/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"pk": 1,
"number": "ORDER12345",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"status": "cancellation_waiting",
"date_placed": "2024-11-20T11:22:23.702774Z",
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"shipping_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"billing_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"currency": "try",
"amount": 1000,
"shipping_amount": 20,
"extra_field": {},
"orderitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"attributes": {
"key1": "value1",
"key2": "value2"
},
"attributes_kwargs": {
"key1": "value1",
"key2": "value2"
},
"localized_attributes": {
"name": {
"en": "English",
"es": "Spanish"
}
},
"localized_attributes_kwargs": {
"key": {
"key1": "value1",
"key2": "value2"
}
}
}
],
"discountitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"transaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"payment_option": {
"id": 1,
"name": "text",
"slug": "text",
"payment_type": "credit_card",
"sort_order": 0,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_active": true,
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"translations": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"bank_interest_rate": 1,
"card": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"bank": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/bank-xyz.png",
"integration": {},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_type": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/credit-card.png",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_payment_type": "credit",
"cash_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"three_d_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"is_commerce_card": false,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_count": 1,
"label": "text",
"interest_rate": 1,
"is_active": true,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"translations": {},
"created_date": "2024-01-01T12:00:00Z",
"modified_date": "2024-01-02T12:00:00Z"
},
"installment_count": 6,
"installment_interest_amount": 10,
"cargo_company": {
"pk": 1,
"name": "UPS",
"erp_code": "UPS_001",
"shipping_company": "yurtici",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"discount_amount": 50,
"cancellation_info": {},
"status_display": "waiting",
"tracking_number": "TRACK12345",
"is_send": false,
"cancel_status": "waiting",
"net_shipping_amount": 15,
"remote_addr": "0.0.0.0",
"language_code": "tr-tr",
"fundstransfertransaction_set": [
{
"pk": 1,
"order": 1,
"user_email": "text",
"remote_addr": "text",
"amount": 1,
"chosen_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"date_paid": "2025-12-01T09:39:00.483Z",
"paid_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"user_holder_name": "text",
"user_iban": "text",
"transaction_type": "purchase",
"status": "paid",
"pos": 1,
"raw_request": "text",
"raw_response": "text",
"is_succeeded": true,
"reference_code": "text",
"currency": "try"
}
],
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"tracking_url": "https://tracking.example.com/track/123",
"external_status": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"code": "text"
},
"payondeliverytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"loyaltytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"bextransaction_set": [],
"b2btransaction_set": [
{
"pk": 1,
"order": 1,
"amount": 1,
"transaction_type": "purchase",
"user_email": "text",
"remote_addr": "text",
"created_date": "2025-12-01T09:39:00.483Z"
}
],
"cancellationplan_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"cashregistertransaction_set": [
{
"pk": 1,
"transaction_id": "text",
"order": 1,
"user_email": "text",
"raw_request": "text",
"raw_response": "text",
"amount": 1,
"remote_addr": "text",
"staff_id": 1,
"staff_remote_id": "text",
"staff_email": "text",
"store_id": 1,
"store_remote_id": "text",
"transaction_type": "purchase",
"is_succeeded": true
}
],
"client_type": "android",
"shipping_interest_amount": 10,
"delivery_type": "same_day",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"segment": "premium",
"carrier_shipping_code": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"installment_free": false
}Retrieve the gateway pos history for the order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Responses
200
Gateway pos history found successfully
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
get
/api/v1/channel/{channel_id}/orders/{id}/gateway_pos_history/GET /api/v1/channel/{channel_id}/orders/{id}/gateway_pos_history/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"gateway_pos_history": {
"is_success": true,
"message": "text",
"gateway": "text",
"history": "text"
}
}Capture order with given id
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
force_refundbooleanOptionalExample:
trueResponses
200
Order capture done successfully
application/json
Responseobject
An empty dictionary
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/capture_order/POST /api/v1/channel/{channel_id}/orders/{id}/capture_order/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"force_refund": true
}{}Accept when staff took the order in retail store. Update order item statuses to ready_for_pickup.
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
objectOptional
An empty dictionary
Responses
200
Order successfully accepted in store
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/accept_in_store/POST /api/v1/channel/{channel_id}/orders/{id}/accept_in_store/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{
"pk": 1,
"number": "ORDER12345",
"channel": 1,
"customer": 1,
"date_placed": "2024-11-20T11:22:23.702774Z",
"extra_field": {
"special_note": "Handle with care"
},
"payment_option": 1,
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": 1,
"installment_count": 6,
"installment_interest_amount": 50,
"cargo_company": 1,
"is_send": false,
"delivery_type": "next_day",
"cancellation_info": {
"reason": "Customer requested cancellation"
},
"cancel_status": "cancelled",
"shipping_interest_amount": 10,
"external_status": 1,
"client_type": "default",
"carrier_shipping_code": "TRACK12345",
"segment": "premium",
"checkout_provider_id": 12345,
"status": 200,
"currency": "try",
"amount": 1000,
"discount_amount": 50,
"shipping_amount": 20,
"shipping_tax_rate": 18,
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"tracking_number": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"shipping_company": "yurtici",
"remote_addr": "192.168.0.1",
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"language_code": "en",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
filenamestring · binaryOptional
The file containing the tracking numbers to be updated.
Responses
200
Tracking number status successfully updated
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/bulk_tracking_number_update/POST /api/v1/channel/{channel_id}/orders/{id}/bulk_tracking_number_update/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: form-data
Accept: */*
Content-Length: 21
{
"filename": "binary"
}{
"cache": "123e4567-e89b-12d3-a456-426614174000"
}Change the status of the order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
statusstring · enumOptionalPossible values:
Status of the order item
Responses
200
Order status successfully updated
No content
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
patch
/api/v1/channel/{channel_id}/orders/{id}/change_order_status/PATCH /api/v1/channel/{channel_id}/orders/{id}/change_order_status/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"status": "cancellation_waiting"
}No content
Change the shipping address of the order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
pkintegerOptional
Primary key of the address
emailstring · emailOptional
Email address of the contact person
phone_numberstringRequired
Phone number of the contact person
first_namestringOptional
First name of the contact person
last_namestringOptional
Last name of the contact person
linestringOptional
Street address line
titlestringOptional
Title of the contact person
postcodestringOptional
Postal code
notesstringOptional
Additional notes about the address
company_namestringOptional
Company name associated with the address
tax_officestringOptional
Tax office name
tax_nostringOptional
Tax number
e_bill_taxpayerbooleanOptional
Indicates if the address is an e-bill taxpayer
hash_datastringRead-onlyOptional
Hash data for the address
address_typestring · enumOptionalExample:
Type of address
customerPossible values: remote_idstringOptional
Remote ID for the address
identity_numberstring | nullableOptional
Identity number of the contact person
extra_fieldobjectOptional
Extra field for additional data
is_activebooleanOptional
Indicates if the address is active
modified_datestring · date-timeOptional
Date when the address was last modified
Responses
200
Order shipping address successfully updated
No content
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/change_shipping_address/POST /api/v1/channel/{channel_id}/orders/{id}/change_shipping_address/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2521
{
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"name": "Türkiye",
"code": "TR",
"is_active": true
},
"city": {
"name": "Istanbul",
"is_active": true,
"country": 1,
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"postcode": "34000",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"postcode": "34000",
"zipcode": "34000",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"address_type": "customer",
"retail_store": {
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
}No content
Replace multiple products and reduce their weights in an order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Bodyobject[]
List of order items for product replacement and weight reduction
order_itemintegerOptionalExample:
Order item ID for product replacement and weight reduction
1new_product_skustringOptionalExample:
New product SKU for replacement
NEW_SKU_123new_weightnumber · decimalOptionalExample:
New weight for the order item
2.5Responses
200
Products successfully replaced and weights reduced in the order
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/bulk_replace_product_and_reduce_weight/POST /api/v1/channel/{channel_id}/orders/{id}/bulk_replace_product_and_reduce_weight/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2
[]{
"pk": 1,
"number": "ORDER12345",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"status": "cancellation_waiting",
"date_placed": "2024-11-20T11:22:23.702774Z",
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"shipping_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"billing_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"currency": "try",
"amount": 1000,
"shipping_amount": 20,
"extra_field": {},
"orderitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"attributes": {
"key1": "value1",
"key2": "value2"
},
"attributes_kwargs": {
"key1": "value1",
"key2": "value2"
},
"localized_attributes": {
"name": {
"en": "English",
"es": "Spanish"
}
},
"localized_attributes_kwargs": {
"key": {
"key1": "value1",
"key2": "value2"
}
}
}
],
"discountitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"transaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"payment_option": {
"id": 1,
"name": "text",
"slug": "text",
"payment_type": "credit_card",
"sort_order": 0,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_active": true,
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"translations": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"bank_interest_rate": 1,
"card": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"bank": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/bank-xyz.png",
"integration": {},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_type": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/credit-card.png",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_payment_type": "credit",
"cash_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"three_d_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"is_commerce_card": false,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_count": 1,
"label": "text",
"interest_rate": 1,
"is_active": true,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"translations": {},
"created_date": "2024-01-01T12:00:00Z",
"modified_date": "2024-01-02T12:00:00Z"
},
"installment_count": 6,
"installment_interest_amount": 10,
"cargo_company": {
"pk": 1,
"name": "UPS",
"erp_code": "UPS_001",
"shipping_company": "yurtici",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"discount_amount": 50,
"cancellation_info": {},
"status_display": "waiting",
"tracking_number": "TRACK12345",
"is_send": false,
"cancel_status": "waiting",
"net_shipping_amount": 15,
"remote_addr": "0.0.0.0",
"language_code": "tr-tr",
"fundstransfertransaction_set": [
{
"pk": 1,
"order": 1,
"user_email": "text",
"remote_addr": "text",
"amount": 1,
"chosen_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"date_paid": "2025-12-01T09:39:00.483Z",
"paid_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"user_holder_name": "text",
"user_iban": "text",
"transaction_type": "purchase",
"status": "paid",
"pos": 1,
"raw_request": "text",
"raw_response": "text",
"is_succeeded": true,
"reference_code": "text",
"currency": "try"
}
],
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"tracking_url": "https://tracking.example.com/track/123",
"external_status": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"code": "text"
},
"payondeliverytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"loyaltytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"bextransaction_set": [],
"b2btransaction_set": [
{
"pk": 1,
"order": 1,
"amount": 1,
"transaction_type": "purchase",
"user_email": "text",
"remote_addr": "text",
"created_date": "2025-12-01T09:39:00.483Z"
}
],
"cancellationplan_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"cashregistertransaction_set": [
{
"pk": 1,
"transaction_id": "text",
"order": 1,
"user_email": "text",
"raw_request": "text",
"raw_response": "text",
"amount": 1,
"remote_addr": "text",
"staff_id": 1,
"staff_remote_id": "text",
"staff_email": "text",
"store_id": 1,
"store_remote_id": "text",
"transaction_type": "purchase",
"is_succeeded": true
}
],
"client_type": "android",
"shipping_interest_amount": 10,
"delivery_type": "same_day",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"segment": "premium",
"carrier_shipping_code": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"installment_free": false
}Approve cancellation of an order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
objectOptional
An empty dictionary
Responses
200
Order successfully cancelled
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/cancellation_approved_order/POST /api/v1/channel/{channel_id}/orders/{id}/cancellation_approved_order/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{
"pk": 1,
"number": "ORDER12345",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"status": "cancellation_waiting",
"date_placed": "2024-11-20T11:22:23.702774Z",
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"shipping_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"billing_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"currency": "try",
"amount": 1000,
"shipping_amount": 20,
"extra_field": {},
"orderitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"attributes": {
"key1": "value1",
"key2": "value2"
},
"attributes_kwargs": {
"key1": "value1",
"key2": "value2"
},
"localized_attributes": {
"name": {
"en": "English",
"es": "Spanish"
}
},
"localized_attributes_kwargs": {
"key": {
"key1": "value1",
"key2": "value2"
}
}
}
],
"discountitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"transaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"payment_option": {
"id": 1,
"name": "text",
"slug": "text",
"payment_type": "credit_card",
"sort_order": 0,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_active": true,
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"translations": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"bank_interest_rate": 1,
"card": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"bank": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/bank-xyz.png",
"integration": {},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_type": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/credit-card.png",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_payment_type": "credit",
"cash_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"three_d_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"is_commerce_card": false,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_count": 1,
"label": "text",
"interest_rate": 1,
"is_active": true,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"translations": {},
"created_date": "2024-01-01T12:00:00Z",
"modified_date": "2024-01-02T12:00:00Z"
},
"installment_count": 6,
"installment_interest_amount": 10,
"cargo_company": {
"pk": 1,
"name": "UPS",
"erp_code": "UPS_001",
"shipping_company": "yurtici",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"discount_amount": 50,
"cancellation_info": {},
"status_display": "waiting",
"tracking_number": "TRACK12345",
"is_send": false,
"cancel_status": "waiting",
"net_shipping_amount": 15,
"remote_addr": "0.0.0.0",
"language_code": "tr-tr",
"fundstransfertransaction_set": [
{
"pk": 1,
"order": 1,
"user_email": "text",
"remote_addr": "text",
"amount": 1,
"chosen_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"date_paid": "2025-12-01T09:39:00.483Z",
"paid_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"user_holder_name": "text",
"user_iban": "text",
"transaction_type": "purchase",
"status": "paid",
"pos": 1,
"raw_request": "text",
"raw_response": "text",
"is_succeeded": true,
"reference_code": "text",
"currency": "try"
}
],
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"tracking_url": "https://tracking.example.com/track/123",
"external_status": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"code": "text"
},
"payondeliverytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"loyaltytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"bextransaction_set": [],
"b2btransaction_set": [
{
"pk": 1,
"order": 1,
"amount": 1,
"transaction_type": "purchase",
"user_email": "text",
"remote_addr": "text",
"created_date": "2025-12-01T09:39:00.483Z"
}
],
"cancellationplan_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"cashregistertransaction_set": [
{
"pk": 1,
"transaction_id": "text",
"order": 1,
"user_email": "text",
"raw_request": "text",
"raw_response": "text",
"amount": 1,
"remote_addr": "text",
"staff_id": 1,
"staff_remote_id": "text",
"staff_email": "text",
"store_id": 1,
"store_remote_id": "text",
"transaction_type": "purchase",
"is_succeeded": true
}
],
"client_type": "android",
"shipping_interest_amount": 10,
"delivery_type": "same_day",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"segment": "premium",
"carrier_shipping_code": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"installment_free": false
}Retrieve order by ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Query parameters
pageinteger · min: 1OptionalDefault:
Specifies the page number of the current dataset
1limitinteger · min: 1OptionalDefault:
Indicates the number of rows on the current page.
10Responses
200
Order found successfully
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
get
/api/v1/channel/{channel_id}/orders/{id}/data_sources/GET /api/v1/channel/{channel_id}/orders/{id}/data_sources/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"count": 0,
"next": "text",
"previous": "text",
"results": [
{
"pk": 1,
"name": "text"
}
]
}Retrieve a list of orders with optional filtering
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5Query parameters
limitinteger · min: 1OptionalDefault:
Indicates the number of rows on the current page.
10pageinteger · min: 1OptionalDefault:
Specifies the page number of the current dataset
1pk__ininteger[]Optional
Filter by multiple primary key values (comma-separated list of integers)
mappingintegerOptional
Filters by mapping id
statusstring · enumOptionalPossible values:
Status of the order item
is_sendbooleanOptional
Filter by whether the order has been sent
shipping_companystring · enumOptionalPossible values:
Filter by shipping company enum
cancel_statusstring · enumOptionalPossible values:
Filter by cancel status
invoice_numberstringOptional
Filter by invoice number
invoice_number__isnullbooleanOptional
Filter by whether the invoice number is null
customer_idintegerOptionalExample:
Filter by customer ID.
123currencystring · enumOptionalExample:
Currency type for the price list.
tryPossible values: has_gift_boxbooleanOptional
Filter by whether the order has a gift box
has_gift_notebooleanOptional
Filter by whether the order has a gift note
e_archive_url__isnullbooleanOptional
Filter by whether the e-archive URL is null
date_placedstring · date-timeOptional
Order number (case-insensitive)
date_placed__gtestring · date-timeOptional
date_placed__gtstring · date-timeOptional
Order placed after this date
date_placed__ltstring · date-timeOptional
date_placed__ltestring · date-timeOptional
date_placed__date__gtstring · dateOptional
date_placed__date__gtestring · dateOptional
date_placed__date__ltstring · dateOptional
date_placed__date__ltestring · dateOptional
cargo_company__namestringOptional
Filter by cargo company name
payment_optioninteger[]Optional
Filter by payment option IDs
fund_transfer_payment_bankinteger[]Optional
Filter by fund transfer payment bank IDs
delivery_optioninteger[]Optional
Filter by delivery option IDs
skustringOptional
Product SKU (case-insensitive)
base_codestringOptionalExample:
Filter by base code.
BASECODE123amountnumber · decimalOptional
Filter by order amount
discount_amountnumber · decimalOptional
Filter by discount amount
posstringOptional
Filter by point of sale name
external_statusintegerOptional
Filter by order external status ID
number__exactstringOptional
Filter by exact order number
client_typestring · enumOptionalExample:
Type of client
androidPossible values: cancellation_plan_statusstring · enumOptionalExample:
Status of the cancellation plan
waitingPossible values: shipping_amountnumber · decimalOptional
Filter by shipping amount
shipping_amount__gtnumber · decimalOptional
Filter by shipping amount greater than a value
shipping_amount__gtenumber · decimalOptional
Filter by shipping amount greater than or equal to a value
shipping_amount__ltnumber · decimalOptional
Filter by shipping amount less than a value
shipping_amount__ltenumber · decimalOptional
Filter by shipping amount less than or equal to a value
numberstringOptional
Order number (case-insensitive)
tracking_numberstringOptional
Tracking number (case-insensitive)
coupon_codestringOptional
Filter by coupon code
data_sourceinteger[]Optional
Filter by data source IDs.
vendororder__isnullbooleanOptional
Filter by whether the vendor order is null
brand__exactstringOptional
Filter by exact brand name
succeeded_transaction_or_payment_optioninteger[]Optional
Filter by succeeded transaction or payment option ID
waiting_capturebooleanOptional
Filter by whether the order is waiting for capture
checkout_provider_id__ininteger[]Optional
Filter by checkout provider IDs
erp_codestringOptionalExample:
Filter by ERP code (contains)
ERPCODE123Responses
200
Successful response
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
get
/api/v1/channel/{channel_id}/orders/GET /api/v1/channel/{channel_id}/orders/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"count": 0,
"next": "text",
"previous": "text",
"results": [
{
"pk": 1,
"number": "ORDER12345",
"channel": 1,
"customer": 1,
"date_placed": "2024-11-20T11:22:23.702774Z",
"extra_field": {
"special_note": "Handle with care"
},
"payment_option": 1,
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": 1,
"installment_count": 6,
"installment_interest_amount": 50,
"cargo_company": 1,
"is_send": false,
"delivery_type": "next_day",
"cancellation_info": {
"reason": "Customer requested cancellation"
},
"cancel_status": "cancelled",
"shipping_interest_amount": 10,
"external_status": 1,
"client_type": "default",
"carrier_shipping_code": "TRACK12345",
"segment": "premium",
"checkout_provider_id": 12345,
"status": 200,
"currency": "try",
"amount": 1000,
"discount_amount": 50,
"shipping_amount": 20,
"shipping_tax_rate": 18,
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"tracking_number": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"shipping_company": "yurtici",
"remote_addr": "192.168.0.1",
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"language_code": "en",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
]
}Creates a new order in the system for the specified channel
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5Body
pkintegerOptionalExample:
Unique identifier for the order.
1numberstringRequiredExample:
Order number, unique within the context of a channel.
ORDER12345channelintegerRequired
ID of the channel associated with the order.
customerintegerRequiredExample:
ID of the customer who placed the order.
1date_placedstring · date-timeRequiredExample:
Timestamp when the order was placed.
2024-11-20T11:22:23.702774Zpayment_optionintegerOptionalExample:
ID of the payment option used for the order.
1payment_option_slugstring | nullableOptionalExample:
Slug of the payment option.
credit-cardbin_numberstring | nullableOptionalExample:
First 6 digits of the customer's card used in the transaction.
123456installmentintegerOptionalExample:
ID of the installment object used for the order.
1installment_countinteger | nullableOptionalExample:
Number of installments for the payment.
6installment_interest_amountnumber · decimalOptionalExample:
Interest charged on installment payments.
50cargo_companyintegerOptionalExample:
ID of the cargo company used for shipping.
1is_sendbooleanOptionalExample:
Indicates whether the order has been sent.
falsedelivery_typestring · enum | nullableOptionalExample:
Type of delivery selected for the order.
next_dayPossible values: cancellation_infoobjectOptionalExample:
Details regarding the cancellation of the order.
{"reason":"Customer requested cancellation"}cancel_statusstring · enum | nullableOptionalExample:
Status of the order cancellation.
cancelledPossible values: shipping_interest_amountnumber · decimalOptionalExample:
Interest applied to the shipping cost.
10external_statusintegerOptionalExample:
ID of the external status associated with the order.
1client_typestring · enumOptionalExample:
Type of client placing the order.
defaultPossible values: carrier_shipping_codestring | nullableOptionalExample:
Tracking code assigned by the carrier.
TRACK12345segmentstring | nullableOptionalExample:
Customer segment for the order.
premiumcheckout_provider_idinteger | nullableOptionalExample:
ID of the provider used for checkout.
12345statusstring · enumRequiredExample:
Status of the order
200Possible values: currencystring · enumOptionalExample:
Currency type for the order, following ISO 4217 currency codes.
tryPossible values: amountnumber · decimalRequiredExample:
Total amount for the order.
1000discount_amountnumber · decimalOptionalExample:
Discount applied to the order.
50shipping_amountnumber · decimalOptionalExample:
Shipping charge for the order.
20shipping_tax_ratenumber · decimal | nullableOptionalExample:
Tax rate applied to the shipping charge.
18refund_amountnumber · decimalOptionalExample:
Total refund amount for the order. Shipping refund amount included.
100discount_refund_amountnumber · decimalOptionalExample:
Refund amount for the discount.
10shipping_refund_amountnumber · decimalOptionalExample:
Refund amount for the shipping.
5invoice_numberstring | nullableOptionalExample:
Invoice number for the order.
INV123456invoice_datestring · date-time | nullableOptionalExample:
Invoice date for the order.
2024-11-21T11:22:23.702774Ze_archive_urlstring · url | nullableOptionalExample:
URL for the e-archive of the invoice.
https://earchive.example.com/invoice/123tracking_numberstring | nullableOptionalExample:
Tracking number for the order.
TRACK12345defined_tracking_urlstring · url | nullableOptionalExample:
URL for tracking the order.
https://tracking.example.com/track/123shipping_companystring · enumOptionalExample:
Shipping company options
yurticiPossible values: remote_addrstring · ipv4 | nullableOptionalExample:
IP address from where the order was placed.
192.168.0.1has_gift_boxbooleanOptionalExample:
Indicates whether the order has a gift box.
falsegift_box_notestring | nullableOptionalExample:
Message for the gift box.
Happy Birthday!language_codestring | nullableOptionalExample:
Language code for the order.
ennotesstring | nullableOptionalExample:
Customer instructions for the order.
Leave at the front door.shipping_option_slugstring | nullableOptionalExample:
Slug for the shipping option.
standard-shippingcreated_datestring · date-timeOptional
Creation Date
modified_datestring · date-timeOptional
Last Modification Date
Responses
201
Order created successfully
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/POST /api/v1/channel/{channel_id}/orders/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1406
{
"pk": 1,
"number": "ORDER12345",
"channel": 1,
"customer": 1,
"date_placed": "2024-11-20T11:22:23.702774Z",
"extra_field": {
"special_note": "Handle with care"
},
"payment_option": 1,
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": 1,
"installment_count": 6,
"installment_interest_amount": 50,
"cargo_company": 1,
"is_send": false,
"delivery_type": "next_day",
"cancellation_info": {
"reason": "Customer requested cancellation"
},
"cancel_status": "cancelled",
"shipping_interest_amount": 10,
"external_status": 1,
"client_type": "default",
"carrier_shipping_code": "TRACK12345",
"segment": "premium",
"checkout_provider_id": 12345,
"status": 200,
"currency": "try",
"amount": 1000,
"discount_amount": 50,
"shipping_amount": 20,
"shipping_tax_rate": 18,
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"tracking_number": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"shipping_company": "yurtici",
"remote_addr": "192.168.0.1",
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"language_code": "en",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}{
"pk": 1,
"number": "ORDER12345",
"channel": 1,
"customer": 1,
"date_placed": "2024-11-20T11:22:23.702774Z",
"extra_field": {
"special_note": "Handle with care"
},
"payment_option": 1,
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": 1,
"installment_count": 6,
"installment_interest_amount": 50,
"cargo_company": 1,
"is_send": false,
"delivery_type": "next_day",
"cancellation_info": {
"reason": "Customer requested cancellation"
},
"cancel_status": "cancelled",
"shipping_interest_amount": 10,
"external_status": 1,
"client_type": "default",
"carrier_shipping_code": "TRACK12345",
"segment": "premium",
"checkout_provider_id": 12345,
"status": 200,
"currency": "try",
"amount": 1000,
"discount_amount": 50,
"shipping_amount": 20,
"shipping_tax_rate": 18,
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"tracking_number": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"shipping_company": "yurtici",
"remote_addr": "192.168.0.1",
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"language_code": "en",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}Retrieve a list of orders with optional filtering and detailed information
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5Query parameters
limitinteger · min: 1OptionalDefault:
Indicates the number of rows on the current page.
10pageinteger · min: 1OptionalDefault:
Specifies the page number of the current dataset
1pk__ininteger[]Optional
Filter by multiple primary key values (comma-separated list of integers)
mappingintegerOptional
Filters by mapping id
statusstring · enumOptionalPossible values:
Status of the order item
is_sendbooleanOptional
Filter by whether the order has been sent
shipping_companystring · enumOptionalPossible values:
Filter by shipping company enum
cancel_statusstring · enumOptionalPossible values:
Filter by cancel status
invoice_numberstringOptional
Filter by invoice number
invoice_number__isnullbooleanOptional
Filter by whether the invoice number is null
customer_idintegerOptionalExample:
Filter by customer ID.
123currencystring · enumOptionalExample:
Currency type for the price list.
tryPossible values: has_gift_boxbooleanOptional
Filter by whether the order has a gift box
has_gift_notebooleanOptional
Filter by whether the order has a gift note
e_archive_url__isnullbooleanOptional
Filter by whether the e-archive URL is null
date_placedstring · date-timeOptional
Order number (case-insensitive)
date_placed__gtestring · date-timeOptional
date_placed__gtstring · date-timeOptional
Order placed after this date
date_placed__ltstring · date-timeOptional
date_placed__ltestring · date-timeOptional
date_placed__date__gtstring · dateOptional
date_placed__date__gtestring · dateOptional
date_placed__date__ltstring · dateOptional
date_placed__date__ltestring · dateOptional
cargo_company__namestringOptional
Filter by cargo company name
payment_optioninteger[]Optional
Filter by payment option IDs
fund_transfer_payment_bankinteger[]Optional
Filter by fund transfer payment bank IDs
delivery_optioninteger[]Optional
Filter by delivery option IDs
skustringOptional
Product SKU (case-insensitive)
base_codestringOptionalExample:
Filter by base code.
BASECODE123amountnumber · decimalOptional
Filter by order amount
discount_amountnumber · decimalOptional
Filter by discount amount
posstringOptional
Filter by point of sale name
external_statusintegerOptional
Filter by order external status ID
number__exactstringOptional
Filter by exact order number
client_typestring · enumOptionalExample:
Type of client
androidPossible values: cancellation_plan_statusstring · enumOptionalExample:
Status of the cancellation plan
waitingPossible values: shipping_amountnumber · decimalOptional
Filter by shipping amount
shipping_amount__gtnumber · decimalOptional
Filter by shipping amount greater than a value
shipping_amount__gtenumber · decimalOptional
Filter by shipping amount greater than or equal to a value
shipping_amount__ltnumber · decimalOptional
Filter by shipping amount less than a value
shipping_amount__ltenumber · decimalOptional
Filter by shipping amount less than or equal to a value
numberstringOptional
Order number (case-insensitive)
tracking_numberstringOptional
Tracking number (case-insensitive)
coupon_codestringOptional
Filter by coupon code
data_sourceinteger[]Optional
Filter by data source IDs.
vendororder__isnullbooleanOptional
Filter by whether the vendor order is null
brand__exactstringOptional
Filter by exact brand name
succeeded_transaction_or_payment_optioninteger[]Optional
Filter by succeeded transaction or payment option ID
waiting_capturebooleanOptional
Filter by whether the order is waiting for capture
checkout_provider_id__ininteger[]Optional
Filter by checkout provider IDs
erp_codestringOptionalExample:
Filter by ERP code (contains)
ERPCODE123Responses
200
Successful response
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
get
/api/v1/channel/{channel_id}/orders/detailed/GET /api/v1/channel/{channel_id}/orders/detailed/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
[
{
"pk": 1,
"number": "ORDER12345",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"status": "cancellation_waiting",
"date_placed": "2024-11-20T11:22:23.702774Z",
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"shipping_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"billing_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"currency": "try",
"amount": 1000,
"shipping_amount": 20,
"shipping_tax_rate": 18,
"extra_field": {},
"transaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"payment_option": {
"id": 1,
"name": "text",
"slug": "text",
"payment_type": "credit_card",
"sort_order": 0,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_active": true,
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"translations": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"payment_option_slug": "credit-card",
"bin_number": "123456",
"cargo_company": {
"pk": 1,
"name": "UPS",
"erp_code": "UPS_001",
"shipping_company": "yurtici",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"discount_amount": 50,
"cancellation_info": {},
"status_display": "waiting",
"tracking_number": "TRACK12345",
"is_send": false,
"cancel_status": "waiting",
"net_shipping_amount": 15,
"remote_addr": "0.0.0.0",
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"external_status": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"code": "text"
},
"client_type": "android",
"shipping_interest_amount": 10,
"include_unified_order": false,
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"segment": "premium",
"vendororder_set": [
{
"data_source": {
"pk": 1,
"name": "Example Data Source",
"slug": "example-data-source",
"stock_list": 1,
"price_list": 1,
"is_active": true,
"token": "text",
"conf": {},
"commission": 5,
"maturity": 1,
"supplier_code": "text",
"supplier_detail": {},
"easy_return_detail": {},
"extras": {},
"data_source_type": "unified",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
}
],
"defined_tracking_url": "https://tracking.example.com/track/123",
"installment_free": false
}
]Create a mapping object for the order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
codestringOptionalExample:
Unique code for the mapping.
mapping_infointegration_typestring · enumOptionalExample:
Type of integration mapping
webPossible values: content_typeintegerOptionalExample:
Content type of the mapping.
1object_idintegerOptionalExample:
ID of the object associated with the mapping.
12345Responses
200
Order mapping object successfully created
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/create_mapping/POST /api/v1/channel/{channel_id}/orders/{id}/create_mapping/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"code": "mapping_info",
"integration_type": "web",
"content_type": 1,
"object_id": 12345
}{
"pk": 1,
"code": "mapping_info",
"integration_type": "web",
"content_type": 1,
"object_id": 12345,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}Change the billing address of the order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
pkintegerOptional
Primary key of the address
emailstring · emailOptional
Email address of the contact person
phone_numberstringRequired
Phone number of the contact person
first_namestringOptional
First name of the contact person
last_namestringOptional
Last name of the contact person
linestringOptional
Street address line
titlestringOptional
Title of the contact person
postcodestringOptional
Postal code
notesstringOptional
Additional notes about the address
company_namestringOptional
Company name associated with the address
tax_officestringOptional
Tax office name
tax_nostringOptional
Tax number
e_bill_taxpayerbooleanOptional
Indicates if the address is an e-bill taxpayer
hash_datastringRead-onlyOptional
Hash data for the address
address_typestring · enumOptionalExample:
Type of address
customerPossible values: remote_idstringOptional
Remote ID for the address
identity_numberstring | nullableOptional
Identity number of the contact person
extra_fieldobjectOptional
Extra field for additional data
is_activebooleanOptional
Indicates if the address is active
modified_datestring · date-timeOptional
Date when the address was last modified
Responses
200
Order billing address successfully updated
No content
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/change_billing_address/POST /api/v1/channel/{channel_id}/orders/{id}/change_billing_address/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2521
{
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"name": "Türkiye",
"code": "TR",
"is_active": true
},
"city": {
"name": "Istanbul",
"is_active": true,
"country": 1,
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"postcode": "34000",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"postcode": "34000",
"zipcode": "34000",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"address_type": "customer",
"retail_store": {
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
}No content
Refund an order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
is_refund_successbooleanRequiredExample:
Indicates whether the refund was successful.
trueResponses
200
Order successfully refunded
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/refund/POST /api/v1/channel/{channel_id}/orders/{id}/refund/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"is_refund_success": true
}{
"pk": 1,
"number": "ORDER12345",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"status": "cancellation_waiting",
"date_placed": "2024-11-20T11:22:23.702774Z",
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"shipping_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"billing_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"currency": "try",
"amount": 1000,
"shipping_amount": 20,
"extra_field": {},
"orderitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"attributes": {
"key1": "value1",
"key2": "value2"
},
"attributes_kwargs": {
"key1": "value1",
"key2": "value2"
},
"localized_attributes": {
"name": {
"en": "English",
"es": "Spanish"
}
},
"localized_attributes_kwargs": {
"key": {
"key1": "value1",
"key2": "value2"
}
}
}
],
"discountitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"transaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"payment_option": {
"id": 1,
"name": "text",
"slug": "text",
"payment_type": "credit_card",
"sort_order": 0,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_active": true,
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"translations": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"bank_interest_rate": 1,
"card": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"bank": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/bank-xyz.png",
"integration": {},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_type": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/credit-card.png",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_payment_type": "credit",
"cash_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"three_d_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"is_commerce_card": false,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_count": 1,
"label": "text",
"interest_rate": 1,
"is_active": true,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"translations": {},
"created_date": "2024-01-01T12:00:00Z",
"modified_date": "2024-01-02T12:00:00Z"
},
"installment_count": 6,
"installment_interest_amount": 10,
"cargo_company": {
"pk": 1,
"name": "UPS",
"erp_code": "UPS_001",
"shipping_company": "yurtici",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"discount_amount": 50,
"cancellation_info": {},
"status_display": "waiting",
"tracking_number": "TRACK12345",
"is_send": false,
"cancel_status": "waiting",
"net_shipping_amount": 15,
"remote_addr": "0.0.0.0",
"language_code": "tr-tr",
"fundstransfertransaction_set": [
{
"pk": 1,
"order": 1,
"user_email": "text",
"remote_addr": "text",
"amount": 1,
"chosen_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"date_paid": "2025-12-01T09:39:00.483Z",
"paid_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"user_holder_name": "text",
"user_iban": "text",
"transaction_type": "purchase",
"status": "paid",
"pos": 1,
"raw_request": "text",
"raw_response": "text",
"is_succeeded": true,
"reference_code": "text",
"currency": "try"
}
],
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"tracking_url": "https://tracking.example.com/track/123",
"external_status": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"code": "text"
},
"payondeliverytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"loyaltytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"bextransaction_set": [],
"b2btransaction_set": [
{
"pk": 1,
"order": 1,
"amount": 1,
"transaction_type": "purchase",
"user_email": "text",
"remote_addr": "text",
"created_date": "2025-12-01T09:39:00.483Z"
}
],
"cancellationplan_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"cashregistertransaction_set": [
{
"pk": 1,
"transaction_id": "text",
"order": 1,
"user_email": "text",
"raw_request": "text",
"raw_response": "text",
"amount": 1,
"remote_addr": "text",
"staff_id": 1,
"staff_remote_id": "text",
"staff_email": "text",
"store_id": 1,
"store_remote_id": "text",
"transaction_type": "purchase",
"is_succeeded": true
}
],
"client_type": "android",
"shipping_interest_amount": 10,
"delivery_type": "same_day",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"segment": "premium",
"carrier_shipping_code": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"installment_free": false
}Deliver when staff deliver the order to the customer in retail store. Update order item statuses to delivered.
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
objectOptional
An empty dictionary
Responses
200
Order delivered in store successfully
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/deliver_in_store/POST /api/v1/channel/{channel_id}/orders/{id}/deliver_in_store/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{
"pk": 1,
"number": "ORDER12345",
"channel": 1,
"customer": 1,
"date_placed": "2024-11-20T11:22:23.702774Z",
"extra_field": {
"special_note": "Handle with care"
},
"payment_option": 1,
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": 1,
"installment_count": 6,
"installment_interest_amount": 50,
"cargo_company": 1,
"is_send": false,
"delivery_type": "next_day",
"cancellation_info": {
"reason": "Customer requested cancellation"
},
"cancel_status": "cancelled",
"shipping_interest_amount": 10,
"external_status": 1,
"client_type": "default",
"carrier_shipping_code": "TRACK12345",
"segment": "premium",
"checkout_provider_id": 12345,
"status": 200,
"currency": "try",
"amount": 1000,
"discount_amount": 50,
"shipping_amount": 20,
"shipping_tax_rate": 18,
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"tracking_number": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"shipping_company": "yurtici",
"remote_addr": "192.168.0.1",
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"language_code": "en",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}Status of the bulk update tracking number specified with cache key
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
cachestring · uuidOptional
The cache ID for the tracking number update operation.
Responses
200
Tracking number status successfully updated
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/bulk_tracking_number_update_status/POST /api/v1/channel/{channel_id}/orders/{id}/bulk_tracking_number_update_status/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"cache": "123e4567-e89b-12d3-a456-426614174000"
}{
"progress": [
[
1,
2
],
[
3,
4
]
],
"errors": [
"Error 1",
"Error 2"
],
"chunk_count": 5,
"status": "waiting"
}Mark the order with the specified ID as not sent
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
objectOptional
An empty dictionary
Responses
200
Order successfully marked as not sent
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/mark_as_not_sent/POST /api/v1/channel/{channel_id}/orders/{id}/mark_as_not_sent/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{
"pk": 1,
"number": "ORDER12345",
"channel": 1,
"customer": 1,
"date_placed": "2024-11-20T11:22:23.702774Z",
"extra_field": {
"special_note": "Handle with care"
},
"payment_option": 1,
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": 1,
"installment_count": 6,
"installment_interest_amount": 50,
"cargo_company": 1,
"is_send": false,
"delivery_type": "next_day",
"cancellation_info": {
"reason": "Customer requested cancellation"
},
"cancel_status": "cancelled",
"shipping_interest_amount": 10,
"external_status": 1,
"client_type": "default",
"carrier_shipping_code": "TRACK12345",
"segment": "premium",
"checkout_provider_id": 12345,
"status": 200,
"currency": "try",
"amount": 1000,
"discount_amount": 50,
"shipping_amount": 20,
"shipping_tax_rate": 18,
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"tracking_number": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"shipping_company": "yurtici",
"remote_addr": "192.168.0.1",
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"language_code": "en",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}Update order status of the order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Responses
200
Order status successfully updated
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
get
/api/v1/channel/{channel_id}/orders/{id}/update_order_status/GET /api/v1/channel/{channel_id}/orders/{id}/update_order_status/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
[
{
"pk": 1,
"number": "ORDER12345",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"status": "cancellation_waiting",
"date_placed": "2024-11-20T11:22:23.702774Z",
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"shipping_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"billing_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"currency": "try",
"amount": 1000,
"shipping_amount": 20,
"shipping_tax_rate": 18,
"extra_field": {},
"transaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"payment_option": {
"id": 1,
"name": "text",
"slug": "text",
"payment_type": "credit_card",
"sort_order": 0,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_active": true,
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"translations": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"payment_option_slug": "credit-card",
"bin_number": "123456",
"cargo_company": {
"pk": 1,
"name": "UPS",
"erp_code": "UPS_001",
"shipping_company": "yurtici",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"discount_amount": 50,
"cancellation_info": {},
"status_display": "waiting",
"tracking_number": "TRACK12345",
"is_send": false,
"cancel_status": "waiting",
"net_shipping_amount": 15,
"remote_addr": "0.0.0.0",
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"external_status": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"code": "text"
},
"client_type": "android",
"shipping_interest_amount": 10,
"include_unified_order": false,
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"segment": "premium",
"vendororder_set": [
{
"data_source": {
"pk": 1,
"name": "Example Data Source",
"slug": "example-data-source",
"stock_list": 1,
"price_list": 1,
"is_active": true,
"token": "text",
"conf": {},
"commission": 5,
"maturity": 1,
"supplier_code": "text",
"supplier_detail": {},
"easy_return_detail": {},
"extras": {},
"data_source_type": "unified",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
}
],
"defined_tracking_url": "https://tracking.example.com/track/123",
"installment_free": false
}
]Cancel an order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
orderintegerOptionalExample:
ID of the order to be cancelled.
1is_allbooleanOptionalExample:
Indicates whether to cancel all items in the order.
truecancel_itemsinteger[]OptionalExample:
List of order item IDs to be cancelled.
[1,2,3]forced_refund_amountnumber · decimalOptionalExample:
Amount to be refunded.
100reasonsobjectOptionalExample:
Cancellation reasons for each order item.
{"1":"reason_id_1","2":"reason_id_2"}is_cargo_refundbooleanOptionalExample:
Indicates whether to refund the shipping amount.
truerefund_invoice_numberstringOptionalExample:
Invoice number for the refund.
REFUND123456holder_namesobjectOptionalExample:
Holder names for the cancel items.
{"1":"John Doe","2":"Jane Smith"}fully_refund_as_loyalty_moneybooleanOptionalExample:
Indicates whether to fully refund as loyalty money.
falseResponses
200
Order successfully cancelled
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/cancel/POST /api/v1/channel/{channel_id}/orders/{id}/cancel/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 274
{
"order": 1,
"is_all": true,
"cancel_items": [
[
1,
2,
3
]
],
"forced_refund_amount": 100,
"reasons": {
"1": "reason_id_1",
"2": "reason_id_2"
},
"is_cargo_refund": true,
"refund_invoice_number": "REFUND123456",
"holder_names": {
"1": "John Doe",
"2": "Jane Smith"
},
"fully_refund_as_loyalty_money": false
}{
"pk": 1,
"number": "ORDER12345",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"status": "cancellation_waiting",
"date_placed": "2024-11-20T11:22:23.702774Z",
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"shipping_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"billing_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"currency": "try",
"amount": 1000,
"shipping_amount": 20,
"extra_field": {},
"orderitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"attributes": {
"key1": "value1",
"key2": "value2"
},
"attributes_kwargs": {
"key1": "value1",
"key2": "value2"
},
"localized_attributes": {
"name": {
"en": "English",
"es": "Spanish"
}
},
"localized_attributes_kwargs": {
"key": {
"key1": "value1",
"key2": "value2"
}
}
}
],
"discountitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"transaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"payment_option": {
"id": 1,
"name": "text",
"slug": "text",
"payment_type": "credit_card",
"sort_order": 0,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_active": true,
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"translations": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"bank_interest_rate": 1,
"card": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"bank": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/bank-xyz.png",
"integration": {},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_type": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/credit-card.png",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_payment_type": "credit",
"cash_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"three_d_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"is_commerce_card": false,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_count": 1,
"label": "text",
"interest_rate": 1,
"is_active": true,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"translations": {},
"created_date": "2024-01-01T12:00:00Z",
"modified_date": "2024-01-02T12:00:00Z"
},
"installment_count": 6,
"installment_interest_amount": 10,
"cargo_company": {
"pk": 1,
"name": "UPS",
"erp_code": "UPS_001",
"shipping_company": "yurtici",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"discount_amount": 50,
"cancellation_info": {},
"status_display": "waiting",
"tracking_number": "TRACK12345",
"is_send": false,
"cancel_status": "waiting",
"net_shipping_amount": 15,
"remote_addr": "0.0.0.0",
"language_code": "tr-tr",
"fundstransfertransaction_set": [
{
"pk": 1,
"order": 1,
"user_email": "text",
"remote_addr": "text",
"amount": 1,
"chosen_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"date_paid": "2025-12-01T09:39:00.483Z",
"paid_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"user_holder_name": "text",
"user_iban": "text",
"transaction_type": "purchase",
"status": "paid",
"pos": 1,
"raw_request": "text",
"raw_response": "text",
"is_succeeded": true,
"reference_code": "text",
"currency": "try"
}
],
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"tracking_url": "https://tracking.example.com/track/123",
"external_status": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"code": "text"
},
"payondeliverytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"loyaltytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"bextransaction_set": [],
"b2btransaction_set": [
{
"pk": 1,
"order": 1,
"amount": 1,
"transaction_type": "purchase",
"user_email": "text",
"remote_addr": "text",
"created_date": "2025-12-01T09:39:00.483Z"
}
],
"cancellationplan_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"cashregistertransaction_set": [
{
"pk": 1,
"transaction_id": "text",
"order": 1,
"user_email": "text",
"raw_request": "text",
"raw_response": "text",
"amount": 1,
"remote_addr": "text",
"staff_id": 1,
"staff_remote_id": "text",
"staff_email": "text",
"store_id": 1,
"store_remote_id": "text",
"transaction_type": "purchase",
"is_succeeded": true
}
],
"client_type": "android",
"shipping_interest_amount": 10,
"delivery_type": "same_day",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"segment": "premium",
"carrier_shipping_code": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"installment_free": false
}Split the packages of the order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
payloadobjectOptional
Payload containing the split packages.
Responses
200
Order packages successfully split
application/json
ResponseobjectExample:
{"result":"Successfully splitted"}400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/split_packages/POST /api/v1/channel/{channel_id}/orders/{id}/split_packages/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"payload": {}
}{
"result": "Successfully splitted"
}Reduce the weights of multiple products in an order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Bodyobject[]
List of order items for weight reduction
order_itemintegerOptionalExample:
Order item ID for weight reduction
1new_weightnumber · decimalOptionalExample:
New weight for the order item
2.5Responses
200
Weights successfully reduced in the order
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/bulk_reduce_weights/POST /api/v1/channel/{channel_id}/orders/{id}/bulk_reduce_weights/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2
[]{
"pk": 1,
"number": "ORDER12345",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"status": "cancellation_waiting",
"date_placed": "2024-11-20T11:22:23.702774Z",
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"shipping_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"billing_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"currency": "try",
"amount": 1000,
"shipping_amount": 20,
"extra_field": {},
"orderitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"attributes": {
"key1": "value1",
"key2": "value2"
},
"attributes_kwargs": {
"key1": "value1",
"key2": "value2"
},
"localized_attributes": {
"name": {
"en": "English",
"es": "Spanish"
}
},
"localized_attributes_kwargs": {
"key": {
"key1": "value1",
"key2": "value2"
}
}
}
],
"discountitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"transaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"payment_option": {
"id": 1,
"name": "text",
"slug": "text",
"payment_type": "credit_card",
"sort_order": 0,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_active": true,
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"translations": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"bank_interest_rate": 1,
"card": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"bank": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/bank-xyz.png",
"integration": {},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_type": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/credit-card.png",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_payment_type": "credit",
"cash_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"three_d_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"is_commerce_card": false,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_count": 1,
"label": "text",
"interest_rate": 1,
"is_active": true,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"translations": {},
"created_date": "2024-01-01T12:00:00Z",
"modified_date": "2024-01-02T12:00:00Z"
},
"installment_count": 6,
"installment_interest_amount": 10,
"cargo_company": {
"pk": 1,
"name": "UPS",
"erp_code": "UPS_001",
"shipping_company": "yurtici",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"discount_amount": 50,
"cancellation_info": {},
"status_display": "waiting",
"tracking_number": "TRACK12345",
"is_send": false,
"cancel_status": "waiting",
"net_shipping_amount": 15,
"remote_addr": "0.0.0.0",
"language_code": "tr-tr",
"fundstransfertransaction_set": [
{
"pk": 1,
"order": 1,
"user_email": "text",
"remote_addr": "text",
"amount": 1,
"chosen_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"date_paid": "2025-12-01T09:39:00.483Z",
"paid_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"user_holder_name": "text",
"user_iban": "text",
"transaction_type": "purchase",
"status": "paid",
"pos": 1,
"raw_request": "text",
"raw_response": "text",
"is_succeeded": true,
"reference_code": "text",
"currency": "try"
}
],
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"tracking_url": "https://tracking.example.com/track/123",
"external_status": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"code": "text"
},
"payondeliverytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"loyaltytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"bextransaction_set": [],
"b2btransaction_set": [
{
"pk": 1,
"order": 1,
"amount": 1,
"transaction_type": "purchase",
"user_email": "text",
"remote_addr": "text",
"created_date": "2025-12-01T09:39:00.483Z"
}
],
"cancellationplan_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"cashregistertransaction_set": [
{
"pk": 1,
"transaction_id": "text",
"order": 1,
"user_email": "text",
"raw_request": "text",
"raw_response": "text",
"amount": 1,
"remote_addr": "text",
"staff_id": 1,
"staff_remote_id": "text",
"staff_email": "text",
"store_id": 1,
"store_remote_id": "text",
"transaction_type": "purchase",
"is_succeeded": true
}
],
"client_type": "android",
"shipping_interest_amount": 10,
"delivery_type": "same_day",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"segment": "premium",
"carrier_shipping_code": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"installment_free": false
}Reject a cancellation of an order with the specified ID
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequiredExample:
The channel ID of the resource.
5idintegerRequiredExample:
Unique identifier of the resource
1Body
objectOptional
An empty dictionary
Responses
200
Order successfully cancelled
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
406
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
application/json
post
/api/v1/channel/{channel_id}/orders/{id}/cancellation_reject_order/POST /api/v1/channel/{channel_id}/orders/{id}/cancellation_reject_order/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{
"pk": 1,
"number": "ORDER12345",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"status": "cancellation_waiting",
"date_placed": "2024-11-20T11:22:23.702774Z",
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"shipping_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"billing_address": {
"pk": 1,
"email": "[email protected]",
"phone_number": "text",
"first_name": "text",
"last_name": "text",
"country": {
"id": 1,
"name": "Türkiye",
"code": "TR",
"is_active": true,
"created_date": "2021-07-07T14:00:00Z",
"modified_date": "2021-07-07T14:00:00Z",
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"city": {
"id": 1,
"name": "Istanbul",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"is_active": true,
"country": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"priority": 1,
"postcode": "34000"
},
"line": "text",
"title": "text",
"township": {
"pk": 1,
"name": "Esenler",
"is_active": true,
"city": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"postcode": "text",
"notes": "text",
"company_name": "text",
"tax_office": "text",
"tax_no": "text",
"e_bill_taxpayer": true,
"hash_data": "text",
"address_type": "customer",
"retail_store": {
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"related_retail_stores": [
102,
103
],
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"mapping": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"integration": [
{
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"content_type": {
"id": 1,
"app_label": "text",
"model": "text"
},
"object_id": 1,
"remote_id": "text",
"version_date": "2025-12-01T09:39:00.483Z",
"state": {},
"local_batch_id": "text",
"status": "processing",
"content_object": {}
}
]
},
"remote_id": "text",
"identity_number": "text",
"extra_field": {},
"customer": {
"pk": 123,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+123456789",
"is_active": true,
"channel_code": "CH123",
"erp_code": "ERP456",
"attributes": {
"logged_ip": "127.0.0.1",
"register_client_type": "default"
},
"attribute_kwargs": {},
"localized_attributes": {},
"localized_attribute_kwargs": {},
"extra_field": {
"key1": "value1",
"key2": 100
},
"email_allowed": true,
"sms_allowed": false,
"call_allowed": true,
"date_joined": "2023-01-15T10:30:00Z",
"gender": "female",
"user_type": "guest",
"date_of_birth": "1985-08-25",
"channel": 5
},
"is_active": true,
"modified_date": "2025-12-01T09:39:00.483Z"
},
"currency": "try",
"amount": 1000,
"shipping_amount": 20,
"extra_field": {},
"orderitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z",
"attributes": {
"key1": "value1",
"key2": "value2"
},
"attributes_kwargs": {
"key1": "value1",
"key2": "value2"
},
"localized_attributes": {
"name": {
"en": "English",
"es": "Spanish"
}
},
"localized_attributes_kwargs": {
"key": {
"key1": "value1",
"key2": "value2"
}
}
}
],
"discountitem_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"transaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"payment_option": {
"id": 1,
"name": "text",
"slug": "text",
"payment_type": "credit_card",
"sort_order": 0,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_active": true,
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"translations": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"bank_interest_rate": 1,
"card": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"bank": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/bank-xyz.png",
"integration": {},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_type": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"logo": "https://example.com/logos/credit-card.png",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"card_payment_type": "credit",
"cash_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"three_d_payment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"channel": {
"id": 1,
"name": "Commerce Channel",
"catalog": 1,
"channel_type": "web",
"conf": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"category_tree": "text",
"is_active": true,
"schema": {},
"created_date": "2024-11-20T11:22:23.702774Z",
"modified_date": "2024-11-20T11:22:23.702774Z"
},
"name": "text",
"slug": "text",
"gateway": "garanti",
"resource_url": "https://example.com",
"three_d_resource_url": "https://example.com",
"config": {
"currency": "USD",
"retries": 3
},
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"is_commerce_card": false,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"installment_count": 1,
"label": "text",
"interest_rate": 1,
"is_active": true,
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"translations": {},
"created_date": "2024-01-01T12:00:00Z",
"modified_date": "2024-01-02T12:00:00Z"
},
"installment_count": 6,
"installment_interest_amount": 10,
"cargo_company": {
"pk": 1,
"name": "UPS",
"erp_code": "UPS_001",
"shipping_company": "yurtici",
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"discount_amount": 50,
"cancellation_info": {},
"status_display": "waiting",
"tracking_number": "TRACK12345",
"is_send": false,
"cancel_status": "waiting",
"net_shipping_amount": 15,
"remote_addr": "0.0.0.0",
"language_code": "tr-tr",
"fundstransfertransaction_set": [
{
"pk": 1,
"order": 1,
"user_email": "text",
"remote_addr": "text",
"amount": 1,
"chosen_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"date_paid": "2025-12-01T09:39:00.483Z",
"paid_bank_account": {
"pk": 1,
"bank": 1,
"slug": "text",
"holder_name": "text",
"iban": "text",
"is_active": true,
"sort_order": 1,
"description": "text",
"channel": 1,
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
},
"user_holder_name": "text",
"user_iban": "text",
"transaction_type": "purchase",
"status": "paid",
"pos": 1,
"raw_request": "text",
"raw_response": "text",
"is_succeeded": true,
"reference_code": "text",
"currency": "try"
}
],
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"tracking_url": "https://tracking.example.com/track/123",
"external_status": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"code": "text"
},
"payondeliverytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"loyaltytransaction_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"bextransaction_set": [],
"b2btransaction_set": [
{
"pk": 1,
"order": 1,
"amount": 1,
"transaction_type": "purchase",
"user_email": "text",
"remote_addr": "text",
"created_date": "2025-12-01T09:39:00.483Z"
}
],
"cancellationplan_set": [
{
"created_date": "2025-12-01T09:39:00.483Z",
"modified_date": "2025-12-01T09:39:00.483Z"
}
],
"cashregistertransaction_set": [
{
"pk": 1,
"transaction_id": "text",
"order": 1,
"user_email": "text",
"raw_request": "text",
"raw_response": "text",
"amount": 1,
"remote_addr": "text",
"staff_id": 1,
"staff_remote_id": "text",
"staff_email": "text",
"store_id": 1,
"store_remote_id": "text",
"transaction_type": "purchase",
"is_succeeded": true
}
],
"client_type": "android",
"shipping_interest_amount": 10,
"delivery_type": "same_day",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2025-12-01T09:39:00.483Z",
"end": "2025-12-01T09:39:00.483Z"
},
"shipping_option_slug": "standard-shipping",
"segment": "premium",
"carrier_shipping_code": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"installment_free": false
}Was this helpful?