Create Customer Order Clearance

customer_orders.create_customer_order_clearance() -> CustomerOrderCreateCustomerOrderClearanceResponse

POST/api/v2/public/customerorders/clearance

Creates movement assignments to clear warehouse stock held for customer orders, so the goods can be moved out to the shop floor. location_code_tag selects which locations are cleared, and category_codes narrows it to specific product categories.

ParametersExpand Collapse

location_code_tag: str

Tag identifying the locations to clear.

category_codes: Optional[Sequence[str]]

Restricts the clearance to these product categories. Leave empty to clear every category.

ReturnsExpand Collapse

class CustomerOrderCreateCustomerOrderClearanceResponse: …

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.

Create Customer Order Clearance

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.create_customer_order_clearance(
    location_code_tag="location_code_tag",
)
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."
}