Create Customer Order Clearance

CustomerOrderCreateCustomerOrderClearanceResponse CustomerOrders.CreateCustomerOrderClearance(, )

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

CustomerOrderCreateCustomerOrderClearanceParams parameters

required string locationCodeTag

Query param: Tag identifying the locations to clear.

IReadOnlyList<string>? categoryCodes

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

ReturnsExpand Collapse

class CustomerOrderCreateCustomerOrderClearanceResponse:

Standard success response returned by mutation endpoints.

required Boolean Success

Indicates whether the operation completed successfully.

string? Data

Optional data payload returned by the operation.

string? Message

Human-readable message describing the result.

Create Customer Order Clearance

CustomerOrderCreateCustomerOrderClearanceParams parameters = new()
{
    LocationCodeTag = "location_code_tag"
};

var response = await client.CustomerOrders.CreateCustomerOrderClearance(parameters);

Console.WriteLine(response);

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