SalesChannelOrderItem

Updates a specific field for given order item id

patch

Updates a specific field for given order item id

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

pkinteger · int64Read-onlyRequired

Order Item ID

orderintegerRequired

Related order ID

Example: 1

productintegerRequired

Related product ID

Example: 1

price_listintegerOptional

Related price list ID

Example: 1

stock_listintegerOptional

Related stock list ID

Example: 1

statusstring · enumRequired

Status of the order item

Example: waitingPossible values:

price_currencystring · enumRequired

Currency type for the price list.

Example: tryPossible values:

pricenumber · decimalRequired

Price of the item

Example: 100

tax_ratenumber · decimalRequired

Tax rate of the item

Example: 18

shipping_companystring · enum | nullableOptional

Shipping company options

Example: yurticiPossible values:

shipment_codestring | nullableOptional

Shipment code for the item

cancel_statusstring · enum | nullableOptional

Cancellation status of the order item

Example: waitingPossible values:

is_tradablebooleanRead-onlyOptional

Indicates if the item is tradable

installment_interest_amountnumber · decimal | nullableOptional

Installment interest amount

datasourceinteger | nullableOptional

Related data source ID

cancellation_reconciliationinteger | nullableOptional

Related cancellation reconciliation ID

reconciliationinteger | nullableOptional

Related reconciliation ID

forced_refundboolean | nullableOptional

Indicates if refund is forced

original_stockinteger | nullableOptional

Original stock ID

shipping_option_groupinteger | nullableOptional

Related shipping option group ID

extra_fieldobject | nullableOptional

Extra field for additional data

Responses

200

OK

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

404

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

500

Server Error

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/channel/{channel_id}/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": "2025-05-22T10:22:41.833Z",
  "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": "2025-05-22T10:22:41.833Z",
  "modified_date": "2025-05-22T10:22:41.833Z",
  "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 channel related order item data

get

Returns all of order item data by channel relation

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

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

mapping__integration_typestring · enumOptional

Filter by integration mapping object's integration type

Possible values:

mapping__code__exactstringOptional

Filter by integration mapping object's code

transaction_idintegerOptional

Filter(exact) by transaction ID

Example: 0

order_idintegerOptional

Order ID

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:

product__skustringOptional

Filter by SKU.

Example: SKU123

Responses

200

OK

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

500

Server Error

get

HTTPcURLJavaScriptPython

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

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2025-05-22T10:22:41.833Z",
      "modified_date": "2025-05-22T10:22:41.833Z",
      "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 channel related order item data via all details

get

Returns all of order item data via all details by channel relation

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

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

mapping__integration_typestring · enumOptional

Filter by integration mapping object's integration type

Possible values:

mapping__code__exactstringOptional

Filter by integration mapping object's code

transaction_idintegerOptional

Filter(exact) by transaction ID

Example: 0

order_idintegerOptional

Order ID

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:

product__skustringOptional

Filter by SKU.

Example: SKU123

Responses

200

OK

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

500

Server Error

get

HTTPcURLJavaScriptPython

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

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2025-05-22T10:22:41.833Z",
      "modified_date": "2025-05-22T10:22:41.833Z",
      "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 channel related order item data with integration mapping data via all details

get

Returns all of order item data with integration mapping data by channel relation

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

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

mapping__integration_typestring · enumOptional

Filter by integration mapping object's integration type

Possible values:

mapping__code__exactstringOptional

Filter by integration mapping object's code

transaction_idintegerOptional

Filter(exact) by transaction ID

Example: 0

order_idintegerOptional

Order ID

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:

product__skustringOptional

Filter by SKU.

Example: SKU123

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

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

200

OK

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2025-05-22T10:22:41.833Z",
      "modified_date": "2025-05-22T10:22:41.833Z",
      "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"
        }
      }
    }
  ]
}