pixi Developer & Integration Documentation

pixiBinCreate

Description

This API call creates one or multiple Bins in a database, based on the input parameters provided in XML format.
The API call is used to create one or multiple bins in a database. It is used in scenarios where new bins need to be added to the database. The API call validates the input parameters and checks for potential duplicates based on the settings of the FilterStockOperationsWithLocation. If the validation is successful, the bin(s) are created. If the validation fails, the bin creation process is aborted and an error message is returned.


Request Parameters

#

Name

Type

Required

Example

Description

1

BinsXML

string

1

Check additional information

Data for Bin(s) in XML format.

2

CreateEmp

string

0

API

User who requested the change.


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:pixiBinCreate>
         <dem:BinsXML>Check additional information</dem:BinsXML>
         <dem:CreateEmp>API</dem:CreateEmp>
      </dem:pixiBinCreate>
   </soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Result

#

Name

Type

Description

1

Row

integer

Row number of resultset

2

BinKey

integer

Id from table InvBin

3

BinName

string

Bin Name

4

LocId

string

Location Id from table Location

5

BinGroup

string

Bin Group

6

SortNr

integer

Bin Sort Number

7

MaxItems

integer

Maximum number of items in one Bin

8

Status

string

Response status (CREATED/INFO/ERROR)

9

Message

string

Response detail message

10

TransportBin

boolean

Boolean indicating if bin is a transport bin


Body 2: Status output

#

Name

Type

Description

1

Status

string

Execution status (CREATED/INFO/ERROR)

2

Message

string

Description of the status


Additional Notes

Using parameter @BinsXML we allow to create new Bin(s).

**Important**
Input XML is parsed to values and validated:
 - Name **mandatory**: max 50 characters, should be unique on Database or on Location (setting FilterStockOperationsWithLocation)
 - LocId **mandatory**: LocId should exist in pixi
 - Group **optional**: can be empty - default is [empty string]
 - SortNr **mandatory**: numeric value, positive
 - MaxItems **mandatory**: numeric value, positive
 - TransportBin **optional**: bit value, default 0 [false]

We do not allow to create new bin if new record will introduce duplicates on Database or on Location.
This is controlled with setting FilterStockOperationsWithLocation.
 - Value = 0: Bin Names are unique on Database
 - Value = 1: same Bin Names can exist in different Locations
We check for duplicated also in input XML

For transport bins we do not allow duplicates on database.

**XML example:**
<Bins>
<Bin>
<Name>A26-16-A-2</Name>
<LocId>001</LocId>
<Group>Lager A</Group>
<SortNr>456312</SortNr>
<MaxItems>100</MaxItems>
                <TransportBin>1</TransportBin>
</Bin>
<Bin>
<Name>A26-16-A-3</Name>
<LocId>001</LocId>
<SortNr>456312</SortNr>
<MaxItems>1</MaxItems>
                <TransportBin>0</TransportBin>
</Bin>
</Bins>

**Return result**
On success we return a list of values parsed from XML with status and message per each row.
If XML cannot be parsed we return error with status message.

**Possible return error messages**
XML contains no data.
Cannot parse XML
Bin not created (Duplicated).
Bin not created. Name is empty.
Bin not created. Location is empty.
Bin not created. Datatype error (SortNr).
Bin not created. SortNr is empty.
Bin not created. SortNr should be positive.
Bin not created. Datatype error (MaxItems).
Bin not created. MaxItems is empty.
Bin not created. MaxItems should be positive.
Bin not created (Location does not exist).