Description

This API call retrieves detailed information about various locations based on specified criteria. It aims to provide location-specific data that can be used for operational and reporting purposes.

• The API can be invoked with an optional location identifier (LocID). If no LocID is provided or an empty string is passed, the API will return information for all available locations.

• When a valid LocID is provided, the API will filter and return information only for the specified location.

• The API returns a structured response containing details such as location name, address, city, postal code, country, state, and associated company.

• Additional attributes include whether shipping is allowed from the location, if the location has special stock handling, reservation and transaction location IDs, and reservation expiration days.

• An attribute indicates if the location is utilized by a point-of-sale system, which is represented as a boolean value where '1' means true and '0' means false.

• The API excludes locations that are marked as hidden or inactive.

Request Parameters

#	Name	Type	Required	Example	Description
1	LocID	string	0	001	Location Id

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:pixiGetLocations>
         <dem:LocID>001</dem:LocID>
      </dem:pixiGetLocations>
   </soapenv:Body>
</soapenv:Envelope>

Response

Body 1: Result set

#	Name	Type	Description
1	LocID	string	ID of the Location
2	LocationKey	integer	Internal Key of the Location
3	LocName	string	Locations Name
4	LocAddress	string	Locations address
5	LocCity	string	Locations city
6	LocZIP	string	Locations ZIP
7	LocCountry	string	Locations Country
8	LocState	string	Locations State
9	LocCompany	string	Locations company
10	AllowShipping	string	Is shipping allowed from this location? Y - allowed | N - not allowed
11	SpecialStock	boolean	If it is set to 1 the stock is not exported to the shop from this location. 0 means, the stock of the locations will be exported to the shop.
12	ResLocID	string	Reservation locations id for order to store
13	TranLocID	string	The ID of the location for articles which will be moved from storage to the shop
14	ResExpDays	integer	Days after the reservation is canceled
15	IsPosLocation	string	Returns if the location is used by a pos-system: 1 - true; 0 - false

Additional Notes