pixiGetLocations
Returns all invoice lines of the corresponding POS invoice, meaning all sold items for further reporting
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
LocID | string | false | Location Id Type: varchar(3) Default value: NULL Example: 001 Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetLocations>
<LocID>string</LocID>
</pixiGetLocations>
</Body>
</Envelope>
Response
1. Result set
Name | Type | Description |
---|---|---|
LocID | string | ID of the Location Type: varchar Available from: 25.06 (25.6.0.58802) |
LocZIP | string | Locations ZIP Type: varchar Available from: 25.06 (25.6.0.58802) |
LocCity | string | Locations city Type: varchar Available from: 25.06 (25.6.0.58802) |
LocName | string | Locations Name Type: varchar Available from: 25.06 (25.6.0.58802) |
LocState | string | Locations State Type: varchar Available from: 25.06 (25.6.0.58802) |
ResLocID | string | Reservation locations id for order to store Type: varchar Available from: 25.06 (25.6.0.58802) |
TranLocID | string | The ID of the location for articles which will be moved from storage to the shop Type: varchar Available from: 25.06 (25.6.0.58802) |
LocAddress | string | Locations address Type: varchar Available from: 25.06 (25.6.0.58802) |
LocCompany | string | Locations company Type: varchar Available from: 25.06 (25.6.0.58802) |
LocCountry | string | Locations Country Type: varchar Available from: 25.06 (25.6.0.58802) |
ResExpDays | integer | Days after the reservation is canceled Type: int Available from: 25.06 (25.6.0.58802) |
LocationKey | integer | Internal Key of the Location Type: int Available from: 25.06 (25.6.0.58802) |
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. Type: bit Available from: 25.06 (25.6.0.58802) |
AllowShipping | string | Is shipping allowed from this location? Y - allowed | N - not allowed Type: char Available from: 25.06 (25.6.0.58802) |
IsPosLocation | string | Returns if the location is used by a pos-system: 1 - true; 0 - false Type: char Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetLocationsPost200TextXmlResponse>
<LocID>string</LocID>
<LocationKey>0</LocationKey>
<LocName>string</LocName>
<LocAddress>string</LocAddress>
<LocCity>string</LocCity>
<LocZIP>string</LocZIP>
<LocCountry>string</LocCountry>
<LocState>string</LocState>
<LocCompany>string</LocCompany>
<AllowShipping>string</AllowShipping>
<SpecialStock>true</SpecialStock>
<ResLocID>string</ResLocID>
<TranLocID>string</TranLocID>
<ResExpDays>0</ResExpDays>
<IsPosLocation>string</IsPosLocation>
</PixiGetLocationsPost200TextXmlResponse>
HTTP Example
POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://apigateway.descartes.com/tms/pixi/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:pixiGetLocations>
<LocID xsi:type="xsd:string">001</LocID>
</ns1:pixiGetLocations>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetLocations', [
'LocID' => '001', // string
]);
function getPixiSoapClientResponse(string $method, array $arguments = [])
{
$soapArguments = [];
foreach ($arguments as $key => $value) {
$soapArguments[] = new SoapVar($value, null, '', '', $key);
}
$soapClient = new SoapClient(null, [
'login' => '...',
'password' => '...',
'uri' => 'https://apigateway.descartes.com/tms/pixi/',
'location' => 'https://apigateway.descartes.com/tms/pixi/',
]);
return $soapClient->__call($method, $soapArguments);
}