HomeInterfacesRecipesChangelogFAQ
Log In
Interfaces

Show Pick-To-Light

🚧

Requires AS Router software

WARNING: This feature requires router software!

📘

For more info about PTL integration, check here.

Endpoint

BIN_INTERFACE_API_ENDPOINT

Request parameters

ParameterMandatory?Data typeDescription
source_port_idTrueInt
(1-2000)
Identifies the source port.
target_port_idFalseInt
(1-2000)
Identifies the target port.
source_bin_idTrueInt
(1-4000000)
Identifies the source bin.
target_bin_idFalseInt
(1-4000000)
Identifies the target bin.
source_compartmentTrueInt
(Calculated)
Identifies the source compartment. See PTL Compartment Calculation.
target_compartmentFalseInt
(Calculated)
Identifies the target compartment. See PTL Compartment Calculation.
quantityTrueInt
(0-1000)
Number of items to pick.

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/bin";
//XML that will be POST'ed
string xmlData = string.Format(
@"<?xml version=""1.0""?>
<methodcall>
  <name>showpicktolight</name>
  <params>
    <source_port_id>3</source_port_id>
    <target_port_id>4</target_port_id>
    <source_bin_id>15575</source_bin_id>
    <target_bin_id>20501</target_bin_id>
    <source_compartment>83</source_compartment>
    <target_compartment>11</target_compartment>
    <quantity>1</quantity>
  </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/bin"
# XML that will be POST'ed
xmlData ="""<?xml version="1.0"?>
<methodcall>
  <name>showpicktolight</name>
  <params>
    <source_port_id>3</source_port_id>
    <target_port_id>4</target_port_id>
    <source_bin_id>15575</source_bin_id>
    <target_bin_id>20501</target_bin_id>
    <source_compartment>83</source_compartment>
    <target_compartment>11</target_compartment>
    <quantity>1</quantity>
  </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/bin`;
const xmlData = 
`<?xml version="1.0"?>
<methodcall>
  <name>showpicktolight</name>
  <params>
    <source_port_id>3</source_port_id>
    <target_port_id>4</target_port_id>
    <source_bin_id>15575</source_bin_id>
    <target_bin_id>20501</target_bin_id>
    <source_compartment>83</source_compartment>
    <target_compartment>11</target_compartment>
    <quantity>1</quantity>
  </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>showpicktolight</name>
  <params>
    <source_port_id>3</source_port_id>
    <target_port_id>4</target_port_id>
    <source_bin_id>15575</source_bin_id>
    <target_bin_id>20501</target_bin_id>
    <source_compartment>83</source_compartment>
    <target_compartment>11</target_compartment>
    <quantity>1</quantity>
  </params>
</methodcall>
{
    "method": "showpicktolight",
    "params": {
        "source_port_id": 3,
        "target_port_id": 4,
        "source_bin_id": 15575,
        "target_bin_id": 20501,
        "source_compartment": 83,
        "target_compartment": 11,
        "quantity": 1
    }
}

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

Error CodeDescription
1002The specified Port is already open.
1003Mandatory parameter port_id is missing.
1004Parameter port_id is not valid (invalid format or out of range).
1105Parameter target_port_id is not valid (invalid format or out of range), the target port is not open, is not a supported port type or does not belong to the same workstation.
1006Parameter content is not valid (invalid format or out of range).
1007Parameter category is not valid (invalid format or out of range).
1008Parameter req_time is not valid (invalid format or out of range).
1009The specified Port is not open.
1010Parameter bin_id is not valid (invalid format or out of range).
1011The specified Bin does not exist.
1012Parameter task_id is not valid (invalid format or out of range).
1013Parameter taskgroup_id is not valid (invalid format or out of range).
1014Parameter shipment is not valid (invalid format or out of range).
1015There are no tasks or Bins that fulfill the Port select requirements.
1016There are no Bins ready that fulfill the Port select requirements.
1017The specified task does not exist.
1018The specified task group does not exist.
1019The specified task group is selected by another Port.
1103The source port is not open or is not a supported port type.
1111The compartment id is invalid or not supported by the source port.
1113The compartment id is invalid or not supported by the target port.

Software version requirement

Software Release April 2023