OrderItem

Get integration mapping types for the order item

get

Get integration mapping types for the order item

Authorizations

AuthorizationstringRequired

Responses

200

Integration mapping types successfully retrieved

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

500

Server Error

get

/api/v1/order_items/get_integration_mapping_types/

GET /api/v1/order_items/get_integration_mapping_types/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  "web"
]

Get mappings for the order item

get

Get mappings for the order item with the specified ID

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Order item mappings successfully retrieved

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

500

Server Error

get

/api/v1/order_items/{id}/get_mappings/

GET /api/v1/order_items/{id}/get_mappings/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "created_date": "2026-01-19T17:28:04.403Z",
    "modified_date": "2026-01-19T17:28:04.403Z"
  }
]

Get remote ID of an order item

get

Retrieve the remote ID of an order item with the specified ID

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

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/order_items/{id}/get_remote_id/

GET /api/v1/order_items/{id}/get_remote_id/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "order_id": 123456,
  "remote_id": "123456789"
}

Retrieve Order Item

get

Retrieve a specific Order Item by ID

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Order Item retrieved successfully

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/order_items/{id}/

GET /api/v1/order_items/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "order": 1,
  "product": 1,
  "price_list": 1,
  "stock_list": 1,
  "status": "waiting",
  "price_currency": "try",
  "price": 100,
  "tax_rate": 18,
  "shipping_company": "yurtici",
  "shipment_code": "text",
  "cancel_status": "waiting",
  "is_tradable": true,
  "installment_interest_amount": 1,
  "datasource": 1,
  "cancellation_reconciliation": 1,
  "reconciliation": 1,
  "forced_refund": true,
  "original_stock": 1,
  "shipping_option_group": 1,
  "extra_field": {},
  "created_date": "2026-01-19T17:28:04.403Z",
  "modified_date": "2026-01-19T17:28:04.403Z",
  "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"
    }
  }
}

Update Order Item

put

Update a specific Order Item by ID.

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

Responses

200

Order Item updated

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

put

/api/v1/order_items/{id}/

PUT /api/v1/order_items/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 660

{
  "order": 1,
  "product": 1,
  "price_list": 1,
  "stock_list": 1,
  "status": "waiting",
  "price_currency": "try",
  "price": 100,
  "tax_rate": 18,
  "shipping_company": "yurtici",
  "shipment_code": "text",
  "cancel_status": "waiting",
  "installment_interest_amount": 1,
  "datasource": 1,
  "cancellation_reconciliation": 1,
  "reconciliation": 1,
  "forced_refund": true,
  "original_stock": 1,
  "shipping_option_group": 1,
  "extra_field": {},
  "modified_date": "2026-01-19T17:28:04.403Z",
  "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"
    }
  }
}

{
  "pk": 1,
  "order": 1,
  "product": 1,
  "price_list": 1,
  "stock_list": 1,
  "status": "waiting",
  "price_currency": "try",
  "price": 100,
  "tax_rate": 18,
  "shipping_company": "yurtici",
  "shipment_code": "text",
  "cancel_status": "waiting",
  "is_tradable": true,
  "installment_interest_amount": 1,
  "datasource": 1,
  "cancellation_reconciliation": 1,
  "reconciliation": 1,
  "forced_refund": true,
  "original_stock": 1,
  "shipping_option_group": 1,
  "extra_field": {},
  "created_date": "2026-01-19T17:28:04.403Z",
  "modified_date": "2026-01-19T17:28:04.403Z",
  "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"
    }
  }
}

Partial Update Order Item

patch

Partial update a specific Order Item by ID

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

Responses

200

Order Item updated

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

patch

/api/v1/order_items/{id}/

PATCH /api/v1/order_items/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 660

{
  "order": 1,
  "product": 1,
  "price_list": 1,
  "stock_list": 1,
  "status": "waiting",
  "price_currency": "try",
  "price": 100,
  "tax_rate": 18,
  "shipping_company": "yurtici",
  "shipment_code": "text",
  "cancel_status": "waiting",
  "installment_interest_amount": 1,
  "datasource": 1,
  "cancellation_reconciliation": 1,
  "reconciliation": 1,
  "forced_refund": true,
  "original_stock": 1,
  "shipping_option_group": 1,
  "extra_field": {},
  "modified_date": "2026-01-19T17:28:04.403Z",
  "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"
    }
  }
}

{
  "pk": 1,
  "order": 1,
  "product": 1,
  "price_list": 1,
  "stock_list": 1,
  "status": "waiting",
  "price_currency": "try",
  "price": 100,
  "tax_rate": 18,
  "shipping_company": "yurtici",
  "shipment_code": "text",
  "cancel_status": "waiting",
  "is_tradable": true,
  "installment_interest_amount": 1,
  "datasource": 1,
  "cancellation_reconciliation": 1,
  "reconciliation": 1,
  "forced_refund": true,
  "original_stock": 1,
  "shipping_option_group": 1,
  "extra_field": {},
  "created_date": "2026-01-19T17:28:04.403Z",
  "modified_date": "2026-01-19T17:28:04.403Z",
  "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"
    }
  }
}

Retrieve Order Item with details

get

Retrieve a specific Order Item by ID with details

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Order Item retrieved successfully with details

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/order_items/{id}/detailed/

GET /api/v1/order_items/{id}/detailed/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "order": {
    "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": "2026-01-19T17:28:04.403Z",
      "end": "2026-01-19T17:28:04.403Z"
    },
    "shipping_option_slug": "standard-shipping",
    "created_date": "2026-01-19T17:28:04.403Z",
    "modified_date": "2026-01-19T17:28:04.403Z"
  },
  "product": {
    "id": 1,
    "name": "text",
    "base_code": "text",
    "sku": "text",
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "description": "text",
    "brand": 1,
    "erp_categories": [
      1
    ],
    "tax_rate": 1,
    "weight": 1,
    "product_type": "pre_product",
    "productization_date": "2026-01-19T17:28:04.403Z",
    "data_source": 1,
    "created_date": "2026-01-19T17:28:04.403Z",
    "modified_date": "2026-01-19T17:28:04.403Z",
    "is_active": true,
    "attribute_set": 1,
    "parent": 1,
    "group_products": [
      1
    ],
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "listing_code": "text",
    "is_seller_product": false,
    "custom_attribute_set": 1
  },
  "price_list": {
    "pk": 1,
    "name": "Standard Price List",
    "code": "shop_price_list",
    "currency": "try",
    "is_auto_sync": true,
    "created_date": "2026-01-19T17:28:04.403Z",
    "modified_date": "2026-01-19T17:28:04.403Z"
  },
  "stock_list": {
    "pk": 1,
    "name": "text",
    "code": "text",
    "is_auto_sync": false,
    "created_date": "2026-01-19T17:28:04.403Z",
    "modified_date": "2026-01-19T17:28:04.403Z"
  },
  "status": "waiting",
  "price_currency": "try",
  "price": 100,
  "tax_rate": 18,
  "shipping_company": "yurtici",
  "shipment_code": "text",
  "cancel_status": "waiting",
  "is_tradable": true,
  "installment_interest_amount": 1,
  "benefitapplicant_set": [
    {
      "created_date": "2026-01-19T17:28:04.403Z",
      "modified_date": "2026-01-19T17:28:04.403Z"
    }
  ],
  "external_status": {
    "pk": 1,
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Shipped",
    "code": "SHIPPED",
    "modified_date": "2021-07-07T14:00:00Z",
    "created_date": "2021-07-07T14:00:00Z"
  },
  "datasource": {
    "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": "2026-01-19T17:28:04.403Z",
    "modified_date": "2026-01-19T17:28:04.403Z"
  },
  "tracking_url": "https://example.com",
  "shipping_option_group": {
    "pk": 1,
    "amount": 0,
    "tax_rate": 18,
    "shipping_option_slug": "text",
    "created_date": "2026-01-19T17:28:04.403Z",
    "modified_date": "2026-01-19T17:28:04.403Z"
  },
  "forced_refund": true,
  "extra_field": {},
  "created_date": "2026-01-19T17:28:04.403Z",
  "modified_date": "2026-01-19T17:28:04.403Z",
  "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"
    }
  }
}

Retrieve Order Item with details and integration mapping data

get

Retrieve a specific Order Item by ID with details and integration mapping data

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Order Item retrieved successfully with details and integration mapping data

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/order_items/{id}/detailed_integration/

GET /api/v1/order_items/{id}/detailed_integration/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "order": {
    "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": "2026-01-19T17:28:04.403Z",
      "end": "2026-01-19T17:28:04.403Z"
    },
    "shipping_option_slug": "standard-shipping",
    "created_date": "2026-01-19T17:28:04.403Z",
    "modified_date": "2026-01-19T17:28:04.403Z"
  },
  "product": {
    "id": 1,
    "name": "text",
    "base_code": "text",
    "sku": "text",
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "description": "text",
    "brand": 1,
    "erp_categories": [
      1
    ],
    "tax_rate": 1,
    "weight": 1,
    "product_type": "pre_product",
    "productization_date": "2026-01-19T17:28:04.403Z",
    "data_source": 1,
    "created_date": "2026-01-19T17:28:04.403Z",
    "modified_date": "2026-01-19T17:28:04.403Z",
    "is_active": true,
    "attribute_set": 1,
    "parent": 1,
    "group_products": [
      1
    ],
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "listing_code": "text",
    "is_seller_product": false,
    "custom_attribute_set": 1
  },
  "price_list": {
    "pk": 1,
    "name": "Standard Price List",
    "code": "shop_price_list",
    "currency": "try",
    "is_auto_sync": true,
    "created_date": "2026-01-19T17:28:04.403Z",
    "modified_date": "2026-01-19T17:28:04.403Z"
  },
  "stock_list": {
    "pk": 1,
    "name": "text",
    "code": "text",
    "is_auto_sync": false,
    "created_date": "2026-01-19T17:28:04.403Z",
    "modified_date": "2026-01-19T17:28:04.403Z"
  },
  "status": "waiting",
  "price_currency": "try",
  "price": 100,
  "tax_rate": 18,
  "shipping_company": "yurtici",
  "shipment_code": "text",
  "cancel_status": "waiting",
  "is_tradable": true,
  "installment_interest_amount": 1,
  "benefitapplicant_set": [
    {
      "created_date": "2026-01-19T17:28:04.403Z",
      "modified_date": "2026-01-19T17:28:04.403Z"
    }
  ],
  "external_status": {
    "pk": 1,
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Shipped",
    "code": "SHIPPED",
    "modified_date": "2021-07-07T14:00:00Z",
    "created_date": "2021-07-07T14:00:00Z"
  },
  "datasource": {
    "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": "2026-01-19T17:28:04.403Z",
    "modified_date": "2026-01-19T17:28:04.403Z"
  },
  "tracking_url": "https://example.com",
  "shipping_option_group": {
    "pk": 1,
    "amount": 0,
    "tax_rate": 18,
    "shipping_option_slug": "text",
    "created_date": "2026-01-19T17:28:04.403Z",
    "modified_date": "2026-01-19T17:28:04.403Z"
  },
  "forced_refund": true,
  "extra_field": {},
  "mapping": [
    {
      "created_date": "2026-01-19T17:28:04.403Z",
      "modified_date": "2026-01-19T17:28:04.403Z"
    }
  ],
  "created_date": "2026-01-19T17:28:04.403Z",
  "modified_date": "2026-01-19T17:28:04.403Z",
  "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"
    }
  }
}

Replace Product of Order Item

post

Replace Product of Order Item

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

new_product_skustringRequired

The sku of the new product to replace the current one.

Responses

200

Replaced Product of Order Item

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/order_items/{id}/replace_product/

POST /api/v1/order_items/{id}/replace_product/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "new_product_sku": "text"
}

{
  "pk": 1,
  "order": 1,
  "product": 1,
  "price_list": 1,
  "stock_list": 1,
  "status": "waiting",
  "price_currency": "try",
  "price": 100,
  "tax_rate": 18,
  "shipping_company": "yurtici",
  "shipment_code": "text",
  "cancel_status": "waiting",
  "is_tradable": true,
  "installment_interest_amount": 1,
  "datasource": 1,
  "cancellation_reconciliation": 1,
  "reconciliation": 1,
  "forced_refund": true,
  "original_stock": 1,
  "shipping_option_group": 1,
  "extra_field": {},
  "created_date": "2026-01-19T17:28:04.403Z",
  "modified_date": "2026-01-19T17:28:04.403Z",
  "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"
    }
  }
}

Update order item send stock

post

Update order item send stock

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Updated order item send stock

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/order_items/{id}/update_order_item_send_stock/

POST /api/v1/order_items/{id}/update_order_item_send_stock/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "order": 1,
  "product": 1,
  "price_list": 1,
  "stock_list": 1,
  "status": "waiting",
  "price_currency": "try",
  "price": 100,
  "tax_rate": 18,
  "shipping_company": "yurtici",
  "shipment_code": "text",
  "cancel_status": "waiting",
  "is_tradable": true,
  "installment_interest_amount": 1,
  "datasource": 1,
  "cancellation_reconciliation": 1,
  "reconciliation": 1,
  "forced_refund": true,
  "original_stock": 1,
  "shipping_option_group": 1,
  "extra_field": {},
  "created_date": "2026-01-19T17:28:04.403Z",
  "modified_date": "2026-01-19T17:28:04.403Z",
  "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"
    }
  }
}

Get tags of an Order Item

get

Retrieve tags associated with a specific Order Item by ID

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Tags retrieved successfully

application/json

Responsestring[]Example: tag1

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/order_items/{id}/get_tags/

GET /api/v1/order_items/{id}/get_tags/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  "tag1"
]

Add tags to an Order Item

post

Add tags to a specific Order Item by ID

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

keystringRequired

Tag key to add to the object.

Responses

200

Tags added successfully

No content

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/order_items/{id}/add_tag/

POST /api/v1/order_items/{id}/add_tag/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "key": "text"
}

No content

Add multiple tags to an Order Item

post

Add multiple tags to a specific Order Item by ID

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

keysstring[]Required

List of tag keys to add to the objects.

Responses

200

Tags added successfully

No content

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/order_items/{id}/bulk_add_tag/

POST /api/v1/order_items/{id}/bulk_add_tag/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "keys": [
    "text"
  ]
}

No content

Remove tags to an Order Item

post

Remove tags to a specific Order Item by ID

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

keystringRequired

Tag key to add to the object.

Responses

200

Tags removed successfully

No content

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/order_items/{id}/remove_tag/

POST /api/v1/order_items/{id}/remove_tag/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "key": "text"
}

No content

Remove multiple tags to an Order Item

post

Remove multiple tags to a specific Order Item by ID

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

keysstring[]Required

List of tag keys to add to the objects.

Responses

200

Tags removed successfully

No content

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/order_items/{id}/bulk_remove_tags/

POST /api/v1/order_items/{id}/bulk_remove_tags/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "keys": [
    "text"
  ]
}

No content

List order items with tag filtering

get

List all order items with the ability to filter by tags and other parameters. 'key' parameter is required in query param or body.

Authorizations

AuthorizationstringRequired

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

idintegerOptional

Filters by id

created_datestring · date-timeOptional

Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: created_date__gt=2024-01-01T00:00:00Z

modified_datestring · date-timeOptional

Filter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: modified_date__lt=2024-01-01T00:00:00Z

attributesstringOptional

Filter by order item attributes

Example: attributes__color=blue

attributes_kwargsstringOptional

Filter by attributes using additional keyword arguments.

Example: attributes_kwargs__color=blue

localized_attributesstringOptional

Filter by localized attributes in JSON format.

Example: localized_attributes__locale=en-US

localized_attributes_kwargsstringOptional

Filter by localized attributes with additional keywords.

Example: localized_attributes_kwargs__locale=en-GB

ordernumberOptional

Filter by order ID.

Example: 123

productinteger · int64Optional

Filter by Product ID.

Example: 123

statusstring · enumOptional

Enum meanings:

50 - Cancellation Waiting
100 - Cancelled
200 - Waiting
300 - Payment Waiting
350 - Confirmation Waiting
400 - Approved
450 - Preparing
500 - Shipped
510 - Shipped and Informed
520 - Ready for Pickup
540 - Attempted to Delivery
544 - Review Started
545 - Review Waiting
546 - Waiting for Payment
547 - Paid
550 - Delivered
600 - Refunded

Possible values:

price_currencystring · enumOptional

Currency type for the price list.

Example: tryPossible values:

pricenumber · decimalOptional

Filter by the product price.

Example: 120

tax_ratenumber · decimalOptional

Filter by Tax Rate.

Example: 18

invoice_numberstringOptional

Invoice number associated with the cancellation plan

Example: INV-123456

invoice_datestring · dateOptional

Date of the invoice associated with the cancellation plan

Example: 2024-01-01T00:00:00Z

e_archive_urlstringOptional

Filter by e-archive URL.

tracking_numberstringOptional

Tracking number (case-insensitive)

defined_tracking_urlstringOptional

Defined tracking URL (case-insensitive)

shipping_companystring · enumOptional

Shipping company options

Example: yurticiPossible values:

defined_shipping_companystringOptional

Filter by defined shipping company (case-insensitive).

retail_pricenumber · decimalOptional

Filter by Retail Price.

Example: 100

imagestringOptional

Filter by image.

parentintegerOptional

Filter by parent order item ID.

delivered_datestringOptional

Filter by delivered date.

Example: 2024-01-01

estimated_delivery_datestringOptional

Filter by estimated delivery date.

Example: 2024-01-01

shipped_datestringOptional

Filter by shipped date.

Example: 2024-01-01

price_listinteger · int64Optional

Filter by Price List ID.

Example: 2

stock_listinteger · int64Optional

Filter by Stock List ID.

Example: 2

external_statusintegerOptional

Filter by order external status ID

shipping_option_groupinteger · int64Optional

Filter by Shipping Option Group ID.

Example: 1

carrier_shipping_codestringOptional

Filter by carrier shipping code.

transactionsintegerOptional

Filter by Transaction ID.

Example: 1

funds_transactionsintegerOptional

Filter by Funds Transaction ID.

Example: 1

payondelivery_transactionsintegerOptional

Filter by Pay On Delivery Transaction ID.

Example: 1

b2b_transactionsintegerOptional

Filter by B2B Transaction ID.

Example: 1

loyalty_transactionsintegerOptional

Filter by Loyalty Transaction ID.

Example: 1

cashregister_transactionsintegerOptional

Filter by Cash Register Transaction ID.

Example: 1

reconciliationintegerOptional

Filter by Reconciliation ID.

Example: 1

cancellation_reconciliationintegerOptional

Filter by Cancellation Reconciliation ID.

Example: 1

cancel_statusstring · enumOptional

Filter by cancel status

Possible values:

forced_refundbooleanOptional

Filter by whether the order item has a forced refund.

Example: true

installment_interest_amountnumber · floatOptional

Filter by installment interest amount.

discount_amountnumber · decimalOptional

Filter by discount amount

datasourceintegerOptional

Filter by data source IDs.

original_stockintegerOptional

Filter by the original stock ID associated with the order item.

Example: 1

pkintegerOptional

Filters by primary key

pk__gtstringOptional

Filter by primary key greater than a specific value.

pk__gteintegerOptional

Filters by primary key greater than or equal to the given value

pk__ltintegerOptional

Filters by primary key less than the given value

pk__lteintegerOptional

Filters by primary key less than or equal to the given value

mappingintegerOptional

Filters by mapping id

transaction_idintegerOptional

Filter(exact) by transaction ID

Example: 0

order_idintegerOptional

Order ID

tagstringOptional

Filter by tag name.

tag__excludestringOptional

Exclude by tag name.

keystringOptional

Filter by key.

Body

keystringOptional

Tag to filter order items by.

Responses

200

Order items successfully listed

application/json

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/order_items/filter_by_tag/

GET /api/v1/order_items/filter_by_tag/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "key": "text"
}

{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "created_date": "2026-01-19T17:28:04.403Z",
      "modified_date": "2026-01-19T17:28:04.403Z",
      "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"
        }
      }
    }
  ]
}

List order items with tag exclusion filtering

get

List all order items with the ability to exclude by tags and other parameters. 'key' parameter is required in query param or body.

Authorizations

AuthorizationstringRequired

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

idintegerOptional

Filters by id

created_datestring · date-timeOptional

Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: created_date__gt=2024-01-01T00:00:00Z

modified_datestring · date-timeOptional

Filter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: modified_date__lt=2024-01-01T00:00:00Z

attributesstringOptional

Filter by order item attributes

Example: attributes__color=blue

attributes_kwargsstringOptional

Filter by attributes using additional keyword arguments.

Example: attributes_kwargs__color=blue

localized_attributesstringOptional

Filter by localized attributes in JSON format.

Example: localized_attributes__locale=en-US

localized_attributes_kwargsstringOptional

Filter by localized attributes with additional keywords.

Example: localized_attributes_kwargs__locale=en-GB

ordernumberOptional

Filter by order ID.

Example: 123

productinteger · int64Optional

Filter by Product ID.

Example: 123

statusstring · enumOptional

Enum meanings:

50 - Cancellation Waiting
100 - Cancelled
200 - Waiting
300 - Payment Waiting
350 - Confirmation Waiting
400 - Approved
450 - Preparing
500 - Shipped
510 - Shipped and Informed
520 - Ready for Pickup
540 - Attempted to Delivery
544 - Review Started
545 - Review Waiting
546 - Waiting for Payment
547 - Paid
550 - Delivered
600 - Refunded

Possible values:

price_currencystring · enumOptional

Currency type for the price list.

Example: tryPossible values:

pricenumber · decimalOptional

Filter by the product price.

Example: 120

tax_ratenumber · decimalOptional

Filter by Tax Rate.

Example: 18

invoice_numberstringOptional

Invoice number associated with the cancellation plan

Example: INV-123456

invoice_datestring · dateOptional

Date of the invoice associated with the cancellation plan

Example: 2024-01-01T00:00:00Z

e_archive_urlstringOptional

Filter by e-archive URL.

tracking_numberstringOptional

Tracking number (case-insensitive)

defined_tracking_urlstringOptional

Defined tracking URL (case-insensitive)

shipping_companystring · enumOptional

Shipping company options

Example: yurticiPossible values:

defined_shipping_companystringOptional

Filter by defined shipping company (case-insensitive).

retail_pricenumber · decimalOptional

Filter by Retail Price.

Example: 100

imagestringOptional

Filter by image.

parentintegerOptional

Filter by parent order item ID.

delivered_datestringOptional

Filter by delivered date.

Example: 2024-01-01

estimated_delivery_datestringOptional

Filter by estimated delivery date.

Example: 2024-01-01

shipped_datestringOptional

Filter by shipped date.

Example: 2024-01-01

price_listinteger · int64Optional

Filter by Price List ID.

Example: 2

stock_listinteger · int64Optional

Filter by Stock List ID.

Example: 2

external_statusintegerOptional

Filter by order external status ID

shipping_option_groupinteger · int64Optional

Filter by Shipping Option Group ID.

Example: 1

carrier_shipping_codestringOptional

Filter by carrier shipping code.

transactionsintegerOptional

Filter by Transaction ID.

Example: 1

funds_transactionsintegerOptional

Filter by Funds Transaction ID.

Example: 1

payondelivery_transactionsintegerOptional

Filter by Pay On Delivery Transaction ID.

Example: 1

b2b_transactionsintegerOptional

Filter by B2B Transaction ID.

Example: 1

loyalty_transactionsintegerOptional

Filter by Loyalty Transaction ID.

Example: 1

cashregister_transactionsintegerOptional

Filter by Cash Register Transaction ID.

Example: 1

reconciliationintegerOptional

Filter by Reconciliation ID.

Example: 1

cancellation_reconciliationintegerOptional

Filter by Cancellation Reconciliation ID.

Example: 1

cancel_statusstring · enumOptional

Filter by cancel status

Possible values:

forced_refundbooleanOptional

Filter by whether the order item has a forced refund.

Example: true

installment_interest_amountnumber · floatOptional

Filter by installment interest amount.

discount_amountnumber · decimalOptional

Filter by discount amount

datasourceintegerOptional

Filter by data source IDs.

original_stockintegerOptional

Filter by the original stock ID associated with the order item.

Example: 1

pkintegerOptional

Filters by primary key

pk__gtstringOptional

Filter by primary key greater than a specific value.

pk__gteintegerOptional

Filters by primary key greater than or equal to the given value

pk__ltintegerOptional

Filters by primary key less than the given value

pk__lteintegerOptional

Filters by primary key less than or equal to the given value

mappingintegerOptional

Filters by mapping id

transaction_idintegerOptional

Filter(exact) by transaction ID

Example: 0

order_idintegerOptional

Order ID

tagstringOptional

Filter by tag name.

tag__excludestringOptional

Exclude by tag name.

keystringOptional

Exclude by key.

Body

keystringOptional

Tag to filter order items by.

Responses

200

Order items successfully listed

application/json

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/order_items/exclude_by_tag/

GET /api/v1/order_items/exclude_by_tag/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "key": "text"
}

{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "created_date": "2026-01-19T17:28:04.403Z",
      "modified_date": "2026-01-19T17:28:04.403Z",
      "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"
        }
      }
    }
  ]
}

Bulk add tags to order items

post

Bulk add tags to order items.

Authorizations

AuthorizationstringRequired

Body

objsinteger[]Required

List of object IDs to which tags will be added.

keysstring[]Required

List of tag keys to add to the objects.

Responses

200

Successfully added tags to order items

No content

401

Unauthorized Access

application/json

500

Server Error

post

/api/v1/order_items/bulk_add_tags/

POST /api/v1/order_items/bulk_add_tags/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "objs": [
    1
  ],
  "keys": [
    "text"
  ]
}

No content

Bulk remove tags from order items

post

Bulk remove tags from order items.

Authorizations

AuthorizationstringRequired

Body

objsinteger[]Required

List of object IDs to which tags will be added.

keysstring[]Required

List of tag keys to add to the objects.

Responses

200

Successfully removed tags from order items

No content

401

Unauthorized Access

application/json

500

Server Error

post

/api/v1/order_items/bulk_remove_tags_with_many_instances/

POST /api/v1/order_items/bulk_remove_tags_with_many_instances/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "objs": [
    1
  ],
  "keys": [
    "text"
  ]
}

No content

Reduce weight of Order Item

post

Reduce weight of Order Item

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

new_weightnumber · decimalRequired

The new weight value for the order item.

Responses

200

Reduced weight of Order Item

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/order_items/{id}/reduce_weight/

POST /api/v1/order_items/{id}/reduce_weight/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "new_weight": 1
}

{
  "pk": 1,
  "order": 1,
  "product": 1,
  "price_list": 1,
  "stock_list": 1,
  "status": "waiting",
  "price_currency": "try",
  "price": 100,
  "tax_rate": 18,
  "shipping_company": "yurtici",
  "shipment_code": "text",
  "cancel_status": "waiting",
  "is_tradable": true,
  "installment_interest_amount": 1,
  "datasource": 1,
  "cancellation_reconciliation": 1,
  "reconciliation": 1,
  "forced_refund": true,
  "original_stock": 1,
  "shipping_option_group": 1,
  "extra_field": {},
  "created_date": "2026-01-19T17:28:04.403Z",
  "modified_date": "2026-01-19T17:28:04.403Z",
  "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"
    }
  }
}

List order items

get

List all order items

Authorizations

AuthorizationstringRequired

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

idintegerOptional

Filters by id

created_datestring · date-timeOptional

Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: created_date__gt=2024-01-01T00:00:00Z

modified_datestring · date-timeOptional

Filter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: modified_date__lt=2024-01-01T00:00:00Z

attributesstringOptional

Filter by order item attributes

Example: attributes__color=blue

attributes_kwargsstringOptional

Filter by attributes using additional keyword arguments.

Example: attributes_kwargs__color=blue

localized_attributesstringOptional

Filter by localized attributes in JSON format.

Example: localized_attributes__locale=en-US

localized_attributes_kwargsstringOptional

Filter by localized attributes with additional keywords.

Example: localized_attributes_kwargs__locale=en-GB

ordernumberOptional

Filter by order ID.

Example: 123

productinteger · int64Optional

Filter by Product ID.

Example: 123

statusstring · enumOptional

Enum meanings:

50 - Cancellation Waiting
100 - Cancelled
200 - Waiting
300 - Payment Waiting
350 - Confirmation Waiting
400 - Approved
450 - Preparing
500 - Shipped
510 - Shipped and Informed
520 - Ready for Pickup
540 - Attempted to Delivery
544 - Review Started
545 - Review Waiting
546 - Waiting for Payment
547 - Paid
550 - Delivered
600 - Refunded

Possible values:

price_currencystring · enumOptional

Currency type for the price list.

Example: tryPossible values:

pricenumber · decimalOptional

Filter by the product price.

Example: 120

tax_ratenumber · decimalOptional

Filter by Tax Rate.

Example: 18

invoice_numberstringOptional

Invoice number associated with the cancellation plan

Example: INV-123456

invoice_datestring · dateOptional

Date of the invoice associated with the cancellation plan

Example: 2024-01-01T00:00:00Z

e_archive_urlstringOptional

Filter by e-archive URL.

tracking_numberstringOptional

Tracking number (case-insensitive)

defined_tracking_urlstringOptional

Defined tracking URL (case-insensitive)

shipping_companystring · enumOptional

Shipping company options

Example: yurticiPossible values:

defined_shipping_companystringOptional

Filter by defined shipping company (case-insensitive).

retail_pricenumber · decimalOptional

Filter by Retail Price.

Example: 100

imagestringOptional

Filter by image.

parentintegerOptional

Filter by parent order item ID.

delivered_datestringOptional

Filter by delivered date.

Example: 2024-01-01

estimated_delivery_datestringOptional

Filter by estimated delivery date.

Example: 2024-01-01

shipped_datestringOptional

Filter by shipped date.

Example: 2024-01-01

price_listinteger · int64Optional

Filter by Price List ID.

Example: 2

stock_listinteger · int64Optional

Filter by Stock List ID.

Example: 2

external_statusintegerOptional

Filter by order external status ID

shipping_option_groupinteger · int64Optional

Filter by Shipping Option Group ID.

Example: 1

carrier_shipping_codestringOptional

Filter by carrier shipping code.

transactionsintegerOptional

Filter by Transaction ID.

Example: 1

funds_transactionsintegerOptional

Filter by Funds Transaction ID.

Example: 1

payondelivery_transactionsintegerOptional

Filter by Pay On Delivery Transaction ID.

Example: 1

b2b_transactionsintegerOptional

Filter by B2B Transaction ID.

Example: 1

loyalty_transactionsintegerOptional

Filter by Loyalty Transaction ID.

Example: 1

cashregister_transactionsintegerOptional

Filter by Cash Register Transaction ID.

Example: 1

reconciliationintegerOptional

Filter by Reconciliation ID.

Example: 1

cancellation_reconciliationintegerOptional

Filter by Cancellation Reconciliation ID.

Example: 1

cancel_statusstring · enumOptional

Filter by cancel status

Possible values:

forced_refundbooleanOptional

Filter by whether the order item has a forced refund.

Example: true

installment_interest_amountnumber · floatOptional

Filter by installment interest amount.

discount_amountnumber · decimalOptional

Filter by discount amount

datasourceintegerOptional

Filter by data source IDs.

original_stockintegerOptional

Filter by the original stock ID associated with the order item.

Example: 1

pkintegerOptional

Filters by primary key

pk__gtstringOptional

Filter by primary key greater than a specific value.

pk__gteintegerOptional

Filters by primary key greater than or equal to the given value

pk__ltintegerOptional

Filters by primary key less than the given value

pk__lteintegerOptional

Filters by primary key less than or equal to the given value

mappingintegerOptional

Filters by mapping id

transaction_idintegerOptional

Filter(exact) by transaction ID

Example: 0

order_idintegerOptional

Order ID

tagstringOptional

Filter by tag name.

tag__excludestringOptional

Exclude by tag name.

Responses

200

Order items successfully listed

application/json

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/order_items/

GET /api/v1/order_items/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "created_date": "2026-01-19T17:28:04.403Z",
      "modified_date": "2026-01-19T17:28:04.403Z",
      "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"
        }
      }
    }
  ]
}

Create Order Item

post

Create Order Item

Authorizations

AuthorizationstringRequired

Body

Responses

201

Order Item Created

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/order_items/

POST /api/v1/order_items/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 660

{
  "order": 1,
  "product": 1,
  "price_list": 1,
  "stock_list": 1,
  "status": "waiting",
  "price_currency": "try",
  "price": 100,
  "tax_rate": 18,
  "shipping_company": "yurtici",
  "shipment_code": "text",
  "cancel_status": "waiting",
  "installment_interest_amount": 1,
  "datasource": 1,
  "cancellation_reconciliation": 1,
  "reconciliation": 1,
  "forced_refund": true,
  "original_stock": 1,
  "shipping_option_group": 1,
  "extra_field": {},
  "modified_date": "2026-01-19T17:28:04.403Z",
  "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"
    }
  }
}

{
  "pk": 1,
  "order": 1,
  "product": 1,
  "price_list": 1,
  "stock_list": 1,
  "status": "waiting",
  "price_currency": "try",
  "price": 100,
  "tax_rate": 18,
  "shipping_company": "yurtici",
  "shipment_code": "text",
  "cancel_status": "waiting",
  "is_tradable": true,
  "installment_interest_amount": 1,
  "datasource": 1,
  "cancellation_reconciliation": 1,
  "reconciliation": 1,
  "forced_refund": true,
  "original_stock": 1,
  "shipping_option_group": 1,
  "extra_field": {},
  "created_date": "2026-01-19T17:28:04.403Z",
  "modified_date": "2026-01-19T17:28:04.403Z",
  "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"
    }
  }
}

List order items with details

get

List all order items with details

Authorizations

AuthorizationstringRequired

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

idintegerOptional

Filters by id

created_datestring · date-timeOptional

Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: created_date__gt=2024-01-01T00:00:00Z

modified_datestring · date-timeOptional

Filter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: modified_date__lt=2024-01-01T00:00:00Z

attributesstringOptional

Filter by order item attributes

Example: attributes__color=blue

attributes_kwargsstringOptional

Filter by attributes using additional keyword arguments.

Example: attributes_kwargs__color=blue

localized_attributesstringOptional

Filter by localized attributes in JSON format.

Example: localized_attributes__locale=en-US

localized_attributes_kwargsstringOptional

Filter by localized attributes with additional keywords.

Example: localized_attributes_kwargs__locale=en-GB

ordernumberOptional

Filter by order ID.

Example: 123

productinteger · int64Optional

Filter by Product ID.

Example: 123

statusstring · enumOptional

Enum meanings:

50 - Cancellation Waiting
100 - Cancelled
200 - Waiting
300 - Payment Waiting
350 - Confirmation Waiting
400 - Approved
450 - Preparing
500 - Shipped
510 - Shipped and Informed
520 - Ready for Pickup
540 - Attempted to Delivery
544 - Review Started
545 - Review Waiting
546 - Waiting for Payment
547 - Paid
550 - Delivered
600 - Refunded

Possible values:

price_currencystring · enumOptional

Currency type for the price list.

Example: tryPossible values:

pricenumber · decimalOptional

Filter by the product price.

Example: 120

tax_ratenumber · decimalOptional

Filter by Tax Rate.

Example: 18

invoice_numberstringOptional

Invoice number associated with the cancellation plan

Example: INV-123456

invoice_datestring · dateOptional

Date of the invoice associated with the cancellation plan

Example: 2024-01-01T00:00:00Z

e_archive_urlstringOptional

Filter by e-archive URL.

tracking_numberstringOptional

Tracking number (case-insensitive)

defined_tracking_urlstringOptional

Defined tracking URL (case-insensitive)

shipping_companystring · enumOptional

Shipping company options

Example: yurticiPossible values:

defined_shipping_companystringOptional

Filter by defined shipping company (case-insensitive).

retail_pricenumber · decimalOptional

Filter by Retail Price.

Example: 100

imagestringOptional

Filter by image.

parentintegerOptional

Filter by parent order item ID.

delivered_datestringOptional

Filter by delivered date.

Example: 2024-01-01

estimated_delivery_datestringOptional

Filter by estimated delivery date.

Example: 2024-01-01

shipped_datestringOptional

Filter by shipped date.

Example: 2024-01-01

price_listinteger · int64Optional

Filter by Price List ID.

Example: 2

stock_listinteger · int64Optional

Filter by Stock List ID.

Example: 2

external_statusintegerOptional

Filter by order external status ID

shipping_option_groupinteger · int64Optional

Filter by Shipping Option Group ID.

Example: 1

carrier_shipping_codestringOptional

Filter by carrier shipping code.

transactionsintegerOptional

Filter by Transaction ID.

Example: 1

funds_transactionsintegerOptional

Filter by Funds Transaction ID.

Example: 1

payondelivery_transactionsintegerOptional

Filter by Pay On Delivery Transaction ID.

Example: 1

b2b_transactionsintegerOptional

Filter by B2B Transaction ID.

Example: 1

loyalty_transactionsintegerOptional

Filter by Loyalty Transaction ID.

Example: 1

cashregister_transactionsintegerOptional

Filter by Cash Register Transaction ID.

Example: 1

reconciliationintegerOptional

Filter by Reconciliation ID.

Example: 1

cancellation_reconciliationintegerOptional

Filter by Cancellation Reconciliation ID.

Example: 1

cancel_statusstring · enumOptional

Filter by cancel status

Possible values:

forced_refundbooleanOptional

Filter by whether the order item has a forced refund.

Example: true

installment_interest_amountnumber · floatOptional

Filter by installment interest amount.

discount_amountnumber · decimalOptional

Filter by discount amount

datasourceintegerOptional

Filter by data source IDs.

original_stockintegerOptional

Filter by the original stock ID associated with the order item.

Example: 1

pkintegerOptional

Filters by primary key

pk__gtstringOptional

Filter by primary key greater than a specific value.

pk__gteintegerOptional

Filters by primary key greater than or equal to the given value

pk__ltintegerOptional

Filters by primary key less than the given value

pk__lteintegerOptional

Filters by primary key less than or equal to the given value

mappingintegerOptional

Filters by mapping id

transaction_idintegerOptional

Filter(exact) by transaction ID

Example: 0

order_idintegerOptional

Order ID

tagstringOptional

Filter by tag name.

tag__excludestringOptional

Exclude by tag name.

Responses

200

Order items successfully listed

application/json

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/order_items/detailed/

GET /api/v1/order_items/detailed/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "created_date": "2026-01-19T17:28:04.403Z",
      "modified_date": "2026-01-19T17:28:04.403Z",
      "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"
        }
      }
    }
  ]
}

List order items with details with integration mapping data

get

List all order items with details with integration mapping data

Authorizations

AuthorizationstringRequired

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

idintegerOptional

Filters by id

created_datestring · date-timeOptional

Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: created_date__gt=2024-01-01T00:00:00Z

modified_datestring · date-timeOptional

Filter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: modified_date__lt=2024-01-01T00:00:00Z

attributesstringOptional

Filter by order item attributes

Example: attributes__color=blue

attributes_kwargsstringOptional

Filter by attributes using additional keyword arguments.

Example: attributes_kwargs__color=blue

localized_attributesstringOptional

Filter by localized attributes in JSON format.

Example: localized_attributes__locale=en-US

localized_attributes_kwargsstringOptional

Filter by localized attributes with additional keywords.

Example: localized_attributes_kwargs__locale=en-GB

ordernumberOptional

Filter by order ID.

Example: 123

productinteger · int64Optional

Filter by Product ID.

Example: 123

statusstring · enumOptional

Enum meanings:

50 - Cancellation Waiting
100 - Cancelled
200 - Waiting
300 - Payment Waiting
350 - Confirmation Waiting
400 - Approved
450 - Preparing
500 - Shipped
510 - Shipped and Informed
520 - Ready for Pickup
540 - Attempted to Delivery
544 - Review Started
545 - Review Waiting
546 - Waiting for Payment
547 - Paid
550 - Delivered
600 - Refunded

Possible values:

price_currencystring · enumOptional

Currency type for the price list.

Example: tryPossible values:

pricenumber · decimalOptional

Filter by the product price.

Example: 120

tax_ratenumber · decimalOptional

Filter by Tax Rate.

Example: 18

invoice_numberstringOptional

Invoice number associated with the cancellation plan

Example: INV-123456

invoice_datestring · dateOptional

Date of the invoice associated with the cancellation plan

Example: 2024-01-01T00:00:00Z

e_archive_urlstringOptional

Filter by e-archive URL.

tracking_numberstringOptional

Tracking number (case-insensitive)

defined_tracking_urlstringOptional

Defined tracking URL (case-insensitive)

shipping_companystring · enumOptional

Shipping company options

Example: yurticiPossible values:

defined_shipping_companystringOptional

Filter by defined shipping company (case-insensitive).

retail_pricenumber · decimalOptional

Filter by Retail Price.

Example: 100

imagestringOptional

Filter by image.

parentintegerOptional

Filter by parent order item ID.

delivered_datestringOptional

Filter by delivered date.

Example: 2024-01-01

estimated_delivery_datestringOptional

Filter by estimated delivery date.

Example: 2024-01-01

shipped_datestringOptional

Filter by shipped date.

Example: 2024-01-01

price_listinteger · int64Optional

Filter by Price List ID.

Example: 2

stock_listinteger · int64Optional

Filter by Stock List ID.

Example: 2

external_statusintegerOptional

Filter by order external status ID

shipping_option_groupinteger · int64Optional

Filter by Shipping Option Group ID.

Example: 1

carrier_shipping_codestringOptional

Filter by carrier shipping code.

transactionsintegerOptional

Filter by Transaction ID.

Example: 1

funds_transactionsintegerOptional

Filter by Funds Transaction ID.

Example: 1

payondelivery_transactionsintegerOptional

Filter by Pay On Delivery Transaction ID.

Example: 1

b2b_transactionsintegerOptional

Filter by B2B Transaction ID.

Example: 1

loyalty_transactionsintegerOptional

Filter by Loyalty Transaction ID.

Example: 1

cashregister_transactionsintegerOptional

Filter by Cash Register Transaction ID.

Example: 1

reconciliationintegerOptional

Filter by Reconciliation ID.

Example: 1

cancellation_reconciliationintegerOptional

Filter by Cancellation Reconciliation ID.

Example: 1

cancel_statusstring · enumOptional

Filter by cancel status

Possible values:

forced_refundbooleanOptional

Filter by whether the order item has a forced refund.

Example: true

installment_interest_amountnumber · floatOptional

Filter by installment interest amount.

discount_amountnumber · decimalOptional

Filter by discount amount

datasourceintegerOptional

Filter by data source IDs.

original_stockintegerOptional

Filter by the original stock ID associated with the order item.

Example: 1

pkintegerOptional

Filters by primary key

pk__gtstringOptional

Filter by primary key greater than a specific value.

pk__gteintegerOptional

Filters by primary key greater than or equal to the given value

pk__ltintegerOptional

Filters by primary key less than the given value

pk__lteintegerOptional

Filters by primary key less than or equal to the given value

mappingintegerOptional

Filters by mapping id

transaction_idintegerOptional

Filter(exact) by transaction ID

Example: 0

order_idintegerOptional

Order ID

tagstringOptional

Filter by tag name.

tag__excludestringOptional

Exclude by tag name.

Responses

200

Order items successfully listed

application/json

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/order_items/detailed_integration/

GET /api/v1/order_items/detailed_integration/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "created_date": "2026-01-19T17:28:04.403Z",
      "modified_date": "2026-01-19T17:28:04.403Z",
      "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"
        }
      }
    }
  ]
}

Create mapping object for the order item

post

Create a mapping object for the order item with the specified ID

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

Responses

200

Order item 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

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/order_items/{id}/create_mapping/

POST /api/v1/order_items/{id}/create_mapping/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "content_type": 1,
  "object_id": 1,
  "content_object": {},
  "integration_type": "hepsiburada",
  "code": "text",
  "modified_date": "2026-01-19T17:28:04.403Z"
}

{
  "pk": 1,
  "content_type": 1,
  "object_id": 1,
  "content_object": {},
  "integration_type": "hepsiburada",
  "code": "text",
  "created_date": "2026-01-19T17:28:04.403Z",
  "modified_date": "2026-01-19T17:28:04.403Z"
}

Update Extra Field of Order Item

patch

Update Extra Field of Order Item

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

extra_fieldobjectRequired

A JSON object containing extra fields for the order item.

Responses

200

Updated Extra Field of Order Item

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

patch

/api/v1/order_items/{id}/update_extra_field/

PATCH /api/v1/order_items/{id}/update_extra_field/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "extra_field": {}
}

{
  "pk": 1,
  "order": 1,
  "product": 1,
  "price_list": 1,
  "stock_list": 1,
  "status": "waiting",
  "price_currency": "try",
  "price": 100,
  "tax_rate": 18,
  "shipping_company": "yurtici",
  "shipment_code": "text",
  "cancel_status": "waiting",
  "is_tradable": true,
  "installment_interest_amount": 1,
  "datasource": 1,
  "cancellation_reconciliation": 1,
  "reconciliation": 1,
  "forced_refund": true,
  "original_stock": 1,
  "shipping_option_group": 1,
  "extra_field": {},
  "created_date": "2026-01-19T17:28:04.403Z",
  "modified_date": "2026-01-19T17:28:04.403Z",
  "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"
    }
  }
}

Split Order Item

post

Split Order Item

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

waiting_quantityinteger · min: 1Required

The quantity of items waiting to be split. Must be at least 1.

Responses

200

Split Order Item

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/order_items/{id}/split/

POST /api/v1/order_items/{id}/split/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "waiting_quantity": 1
}

{
  "pk": 1,
  "order": 1,
  "product": 1,
  "price_list": 1,
  "stock_list": 1,
  "status": "waiting",
  "price_currency": "try",
  "price": 100,
  "tax_rate": 18,
  "shipping_company": "yurtici",
  "shipment_code": "text",
  "cancel_status": "waiting",
  "is_tradable": true,
  "installment_interest_amount": 1,
  "datasource": 1,
  "cancellation_reconciliation": 1,
  "reconciliation": 1,
  "forced_refund": true,
  "original_stock": 1,
  "shipping_option_group": 1,
  "extra_field": {},
  "created_date": "2026-01-19T17:28:04.403Z",
  "modified_date": "2026-01-19T17:28:04.403Z",
  "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"
    }
  }
}

Create Order Item Easy Return Location

post

Create Order Item Easy Return Location

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

sourcestringRequired

The name of the source.

origin_addressstring | nullableOptional

The original address information.

origin_address_idstring | nullableOptional

The ID of the original address.

package_numberstring | nullableOptional

The package number.

Responses

200

Created Order Item Easy Return Location

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/order_items/{id}/easy_return_location/

POST /api/v1/order_items/{id}/easy_return_location/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "source": "text",
  "origin_address": "text",
  "origin_address_id": "text",
  "package_number": "text"
}

{
  "pk": 1,
  "order": 1,
  "product": 1,
  "price_list": 1,
  "stock_list": 1,
  "status": "waiting",
  "price_currency": "try",
  "price": 100,
  "tax_rate": 18,
  "shipping_company": "yurtici",
  "shipment_code": "text",
  "cancel_status": "waiting",
  "is_tradable": true,
  "installment_interest_amount": 1,
  "datasource": 1,
  "cancellation_reconciliation": 1,
  "reconciliation": 1,
  "forced_refund": true,
  "original_stock": 1,
  "shipping_option_group": 1,
  "extra_field": {},
  "created_date": "2026-01-19T17:28:04.403Z",
  "modified_date": "2026-01-19T17:28:04.403Z",
  "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"
    }
  }
}

PreviousApplicationPermissions NextInvoiceItem

Last updated 12 days ago

Was this helpful?

hashtagGet integration mapping types for the order item

hashtagGet mappings for the order item

hashtagGet remote ID of an order item

hashtagRetrieve Order Item

hashtagUpdate Order Item

hashtagPartial Update Order Item

hashtagRetrieve Order Item with details

hashtagRetrieve Order Item with details and integration mapping data

hashtagReplace Product of Order Item

hashtagUpdate order item send stock

hashtagGet tags of an Order Item

hashtagAdd tags to an Order Item

hashtagAdd multiple tags to an Order Item

hashtagRemove tags to an Order Item

hashtagRemove multiple tags to an Order Item

hashtagList order items with tag filtering

hashtagList order items with tag exclusion filtering

hashtagBulk add tags to order items

hashtagBulk remove tags from order items

hashtagReduce weight of Order Item

hashtagList order items

hashtagCreate Order Item

hashtagList order items with details

hashtagList order items with details with integration mapping data

hashtagCreate mapping object for the order item

hashtagUpdate Extra Field of Order Item

hashtagSplit Order Item

hashtagCreate Order Item Easy Return Location

Get integration mapping types for the order item

Get mappings for the order item

Get remote ID of an order item

Retrieve Order Item

Update Order Item

Partial Update Order Item

Retrieve Order Item with details

Retrieve Order Item with details and integration mapping data

Replace Product of Order Item

Update order item send stock

Get tags of an Order Item

Add tags to an Order Item

Add multiple tags to an Order Item

Remove tags to an Order Item

Remove multiple tags to an Order Item

List order items with tag filtering

List order items with tag exclusion filtering

Bulk add tags to order items

Bulk remove tags from order items

Reduce weight of Order Item

List order items

Create Order Item

List order items with details

List order items with details with integration mapping data

Create mapping object for the order item

Update Extra Field of Order Item

Split Order Item

Create Order Item Easy Return Location