Skip to content
Colleqtive Developer
Get started
API Reference
Customer Orders

Update Customer Order

customer_orders.update_customer_order(strstore_number, CustomerOrderUpdateCustomerOrderParams**kwargs) -> CustomerOrderUpdateCustomerOrderResponse
PUT/api/v2/public/stores/{store_number}/orders/customerorder

Updates an existing customer order and its lines in one store. Use it to change quantities or status after the order was created, rather than deleting and recreating it.

ParametersExpand Collapse
store_number: str
orders: Optional[Orders]
order_number: str
minLength1
is_active: Optional[bool]
is_claimed: Optional[bool]
is_picked: Optional[bool]
is_rejected: Optional[bool]
order_lines: Optional[Iterable[OrdersOrderLine]]
line_number: int
formatint64
product_number: str
minLength1
barcode: Optional[str]
delivery_date: Optional[Union[str, datetime, null]]
formatdate-time
description: Optional[str]
is_picked: Optional[bool]
is_picked_from_warehouse: Optional[bool]
ordering_datetime: Optional[Union[str, datetime, null]]
formatdate-time
picked_quantity: Optional[float]
formatdouble
pickup_date: Optional[Union[str, datetime, null]]
formatdate-time
preferred_location_code: Optional[str]
price: Optional[float]
formatdouble
quantity: Optional[float]
formatdouble
stock_pool: Optional[int]
formatint32
rejection_reason_code: Optional[str]
rejection_reason_code_description: Optional[str]
ReturnsExpand Collapse
class CustomerOrderUpdateCustomerOrderResponse: …

Standard success response returned by mutation endpoints.

success: bool

Indicates whether the operation completed successfully.

data: Optional[str]

Optional data payload returned by the operation.

message: Optional[str]

Human-readable message describing the result.

Update Customer Order

import os
from colleqtive_sdk import Colleqtive

client = Colleqtive(
    bearer_token=os.environ.get("COLLEQTIVE_BEARER_TOKEN"),  # This is the default and can be omitted
)
response = client.customer_orders.update_customer_order(
    store_number="store_number",
)
print(response.success)
{
  "success": true,
  "data": "data",
  "message": "message"
}
{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}
{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}
Returns Examples
{
  "success": true,
  "data": "data",
  "message": "message"
}
{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}
{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}