Fix label order parameters

Author: goncalossilva

CHANGELOG.md

@@ -25,6 +25,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **Breaking**: Authentication helpers now accept optional `httpx.Client` / `httpx.AsyncClient` instances instead of `session: requests.Session`.
 - **Breaking**: `update_section` now accepts only keyword arguments after `section_id`; any one of `name`, `order`, or `collapsed` can be updated in the same call.
 
+### Fixed
+
+- Label order arguments for `add_label` and `update_label` now use the `order` field. (#247)
+
 ## [3.2.1] - 2026-01-22
 
 ### Fixed

tests/test_api_labels.py

@@ -169,7 +169,7 @@ async def test_add_label_full(
     label_name = "A Label"
     args: dict[str, Any] = {
         "color": "red",
-        "item_order": 3,
+        "order": 3,
         "is_favorite": True,
     }
 
@@ -203,6 +203,7 @@ async def test_update_label(
 ) -> None:
     args: dict[str, Any] = {
         "name": "An updated label",
+        "order": 3,
     }
     updated_label_dict = default_label.to_dict() | args
 

todoist_api_python/api.py

@@ -1333,15 +1333,15 @@ def add_label(
         name: Annotated[str, MinLen(1), MaxLen(60)],
         *,
         color: ColorString | None = None,
-        item_order: int | None = None,
+        order: int | None = None,
         is_favorite: bool | None = None,
     ) -> Label:
         """
         Create a new personal label.
 
         :param name: The name of the label.
         :param color: The color of the label icon.
-        :param item_order: Label's order in the label list.
+        :param order: Label's order in the label list.
         :param is_favorite: Whether the label is a favorite.
         :return: The newly created label.
         :raises httpx.HTTPStatusError: If the API request fails.
@@ -1352,7 +1352,7 @@ def add_label(
         data = kwargs_without_none(
             name=name,
             color=color,
-            item_order=item_order,
+            order=order,
             is_favorite=is_favorite,
         )
 
@@ -1372,7 +1372,7 @@ def update_label(
         *,
         name: Annotated[str, MinLen(1), MaxLen(60)] | None = None,
         color: ColorString | None = None,
-        item_order: int | None = None,
+        order: int | None = None,
         is_favorite: bool | None = None,
     ) -> Label:
         """
@@ -1383,7 +1383,7 @@ def update_label(
         :param label_id: The ID of the label.
         :param name: The name of the label.
         :param color: The color of the label icon.
-        :param item_order: Label's order in the label list.
+        :param order: Label's order in the label list.
         :param is_favorite: Whether the label is a favorite.
         :return: the updated Label.
         :raises httpx.HTTPStatusError: If the API request fails.
@@ -1393,7 +1393,7 @@ def update_label(
         data = kwargs_without_none(
             name=name,
             color=color,
-            item_order=item_order,
+            order=order,
             is_favorite=is_favorite,
         )
 

todoist_api_python/api_async.py

@@ -1353,15 +1353,15 @@ async def add_label(
         name: Annotated[str, MinLen(1), MaxLen(60)],
         *,
         color: ColorString | None = None,
-        item_order: int | None = None,
+        order: int | None = None,
         is_favorite: bool | None = None,
     ) -> Label:
         """
         Create a new personal label.
 
         :param name: The name of the label.
         :param color: The color of the label icon.
-        :param item_order: Label's order in the label list.
+        :param order: Label's order in the label list.
         :param is_favorite: Whether the label is a favorite.
         :return: The newly created label.
         :raises httpx.HTTPStatusError: If the API request fails.
@@ -1372,7 +1372,7 @@ async def add_label(
         data = kwargs_without_none(
             name=name,
             color=color,
-            item_order=item_order,
+            order=order,
             is_favorite=is_favorite,
         )
 
@@ -1392,7 +1392,7 @@ async def update_label(
         *,
         name: Annotated[str, MinLen(1), MaxLen(60)] | None = None,
         color: ColorString | None = None,
-        item_order: int | None = None,
+        order: int | None = None,
         is_favorite: bool | None = None,
     ) -> Label:
         """
@@ -1403,7 +1403,7 @@ async def update_label(
         :param label_id: The ID of the label.
         :param name: The name of the label.
         :param color: The color of the label icon.
-        :param item_order: Label's order in the label list.
+        :param order: Label's order in the label list.
         :param is_favorite: Whether the label is a favorite.
         :return: the updated Label.
         :raises httpx.HTTPStatusError: If the API request fails.
@@ -1413,7 +1413,7 @@ async def update_label(
         data = kwargs_without_none(
             name=name,
             color=color,
-            item_order=item_order,
+            order=order,
             is_favorite=is_favorite,
         )