Configure Port

⚠️

Requires AS Router software.

📘

For further details on configuration settings check here.

Endpoint

TASK_INTERFACE_API_ENDPOINT

Request Parameters

Configurations

Weight Configuration

The weight configuration setting controls whether and when a bin is weighed at a port, as well as whether overload protection is enforced. The behavior varies depending on the port type (especially ports with mechanical lifting such as ConveyorPort™ or VersaPort™) and the current port mode (picking vs. putaway).

Enabled

• The bin is always weighed when closed.
• Overload checking is performed on every bin close operation.
• For ports with mechanical lifting (e.g. ConveyorPort™ or VersaPort™), a small delay is introduced per bin due to the extra movement required to position the bin on the weighing platform.
• Allows reliable use of the getportweight method at any time.

Disabled

• No weight measurement or overload checking is performed on any bin.
• For ports with mechanical lifting, the bin is not placed on the weighing platform → the getportweight method will return invalid or unavailable data.
• Use this setting when weight information is not needed and you want to avoid any mechanical delay.

Goods-in only

• Behavior depends on the current port mode (determined by how the port was opened):
  • Putaway mode (port opened with content codes or specific categories via openport): behaves like Enabled → weighing and overload checking are active.
  • Picking mode (port opened with category/categories): behaves like Disabled → no weighing or overload check.
• Intended for warehouses that only need overload protection during goods-in/replenishment operations.
• Limitation: Advanced WMS logic that dynamically switches between pick and goods-in modes on the same port may behave unexpectedly. In such cases, prefer explicit Enabled or Disabled control instead of relying on this mode detection.

Removed

• Special setting used only on Conveyor Ports that physically lack a weight measurement module.
• Must not be used on ports that have a weight sensor — doing so can lead to undefined behavior.
• Weight-related methods (getportweight, overload checks) are unavailable or return errors.

Silent mode

• Available on ports with mechanical lifting and a weight sensor.
• Weighing is performed (so getportweight works reliably), but no overload checking is enforced.
• Ideal when the WMS needs accurate bin weight information (e.g. for inventory validation or reporting) but wants to disable automatic rejection of overweight bins.

Summary Table

📘

For most modern WMS implementations, Enabled or Silent Mode are the safest and most predictable choices. Use Disabled only when performance is critical and weight data is irrelevant. Avoid Goods-in Only unless your operational flow strictly separates pick and goods-in phases on the same physical port.

Robot Queue Configuration

NextTaskGoup Configuration

Request Example

//Interface installation location(Ip adress)
string ip = "127.0.0.1";
//The URL to the task interface
string url = "http://" + ip + ":44000/api/v2/task";
//XML that will be POST'ed
string xmlData = string.Format(
@"<?xml version=""1.0""?>
<methodcall>
  <name>configureport</name>
  <params>
    <port_id>3</port_id>
    <configname>enableweight</configname>
    <configvalue>true</configvalue>
  </params>
</methodcall>");
//POST to interface
HttpResponseMessage response = await new HttpClient().PostAsync(url, new StringContent(xmlData,
        Encoding.UTF8, "application/xml"));
string responseString = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseString);

# Interface installation location (IP address)
ip = "127.0.0.1"
# The URL to the task interface
url = f"http://{ip}:44000/api/v2/task"
# XML that will be POST'ed
xmlData ="""<?xml version="1.0"?>
<methodcall>
  <name>configureport</name>
  <params>
    <port_id>3</port_id>
    <configname>enableweight</configname>
    <configvalue>True</configvalue>
  </params>
</methodcall>"""
# POST to interface
response = requests.post(url, data=xmlData.encode('utf-8'), headers={"Content-Type": "application/xml"})
print(response.text)

const ip = "127.0.0.1";
const url = `http://${ip}:44000/api/v2/task`;
const xmlData = 
`<?xml version="1.0"?>
<methodcall>
  <name>configureport</name>
  <params>
    <port_id>3</port_id>
    <configname>enableweight</configname>
    <configvalue>True</configvalue>
  </params>
</methodcall>`;

fetch(url, {
    method: 'POST',
    body: xmlData,
    headers: {
        'Content-Type': 'application/xml'
    }
})
    .then(response => response.text())
    .then(responseString => console.log(responseString));

<?xml version="1.0"?>
<methodcall>
  <name>configureport</name>
  <params>
    <port_id>3</port_id>
    <configname>enableweight</configname>
    <configvalue>True</configvalue>
  </params>
</methodcall>

{
    "method": "configureport",
    "params": {
        "port_id": 3,
        "configname": "enableweight",
        "configvalue": "true"
    }
}

Response Parameters

This method has no response parameters.

Response Example

<?xml version="1.0"?>
<response>
  <params/>
</response>

OR

<?xml version="1.0"?>
<response>
  <fault>
    <code>1000</code>
  </fault>
</response>

Error Codes

Software Version Requirement

Software Release October 2022 and newer