pixi Developer & Integration Documentation

pixiAssignBoxesForPicklist

Description

Assigns a set of boxes to a picklist for order fulfillment. The call validates that each supplied box exists at the picklist's warehouse location and that the total number of boxes is sufficient for the number of orders on the picklist. It then replaces any previously assigned boxes with the new set. Returns a status code and message indicating success or the specific reason for failure.


Request Parameters

#

Name

Type

Required

Example

Description

1

PicklistNr

int

1

1001

Picklist number to assign boxes to. Must be a valid, existing picklist identifier.

2

BoxNumbers

string (XML)

1

Check additional information

XML list of box numbers to assign. Each box must exist at the picklist's warehouse location. See Additional Notes for the required XML format.

3

UserName

string

0

API

Name of the user performing the operation. Defaults to API when not provided.


Request body

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
<soapenv:Header/>
<soapenv:Body>
<dem:pixiAssignBoxesForPicklist>
<dem:PicklistNr>1001</dem:PicklistNr>
<dem:BoxNumbers><BoxNumbers><BoxNr>101</BoxNr><BoxNr>102</BoxNr></BoxNumbers></dem:BoxNumbers>
<dem:UserName>API</dem:UserName>
</dem:pixiAssignBoxesForPicklist>
</soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Operation Result

#

Name

Type

Description

1

Status

int

1 = Success (boxes assigned and picklist updated). 0 = Failure (no changes were made).

2

Message

string

On success: "Success". On failure: a description of the error. See Additional Notes for all possible values.


Additional Notes

BoxNumbers XML format:
<BoxNumbers>
<BoxNr>101</BoxNr>
<BoxNr>102</BoxNr>
</BoxNumbers>

Each BoxNr must be a positive integer identifying a box that exists at the warehouse
location of the picklist. Duplicate box numbers in the XML are automatically deduplicated.

On success (Status = 1):
- Message = "Success"
- All supplied boxes are assigned to the picklist.
- Previously assigned boxes not in the new list are removed.
- The picklist box range fields (PLHfromBox, PLHtoBox) are reset to 0.

Possible error responses (Status = 0):
- "Invalid PicklistNr provided."
PicklistNr is null, zero, or does not exist.
- "BoxNumbers parameter is required."
BoxNumbers is null or empty.
- "No boxes provided in XML array."
XML was provided but contains no valid BoxNr elements.
- "Boxes {list} do not exist and could not be added."
One or more box numbers were not found at the picklist's warehouse location.
- "There are not enough boxes (sent {n}) assigned to the picklist (needed {m})."
The number of boxes supplied is less than the number of orders on the picklist.

Only the first validation error encountered is returned.