Create Customer Order Clearance

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.

Query ParametersExpand Collapse

location_code_tag: string

Tag identifying the locations to clear.

Body ParametersJSONExpand Collapse

category_codes: optional array of string

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

ReturnsExpand Collapse

success: boolean

Indicates whether the operation completed successfully.

data: optional string

Optional data payload returned by the operation.

message: optional string

Human-readable message describing the result.

Create Customer Order Clearance

curl https://api.colleqtive.net/api/v2/public/customerorders/clearance \
    -H 'Content-Type: application/json' \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" \
    -d '{}'

{
  "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."
}