Description
This API endpoint retrieves comprehensive shop information from the system. It can return details for all shops or filter results for a specific shop by providing the ShopID parameter. The response includes complete shop profile data including contact information, banking details, and operational data. This endpoint is essential for shop management, reporting, and integration with external systems.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
ShopID |
string |
0 |
ABC |
Shop 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:pixiGetShops>
<dem:ShopID>ABC</dem:ShopID>
</dem:pixiGetShops>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Result set
# |
Name |
Type |
Description |
1 |
ShopID |
string |
ShopID |
2 |
ShopName |
string |
ShopName |
3 |
ShopURL |
string |
ShopURL |
4 |
Address |
string |
Address |
5 |
City |
string |
City |
6 |
State |
string |
State |
7 |
ZIP |
string |
ZIP |
8 |
Country |
string |
Country |
9 |
Contact |
string |
Contact |
10 |
Phone |
string |
Phone |
11 |
Fax |
string |
Fax |
12 |
ShopCompany |
string |
ShopCompany |
13 |
string |
||
14 |
SI_fon |
string |
SI_fon |
15 |
SI_Fax |
string |
SI_Fax |
16 |
BIC |
string |
BIC |
17 |
IBAN |
string |
IBAN |
18 |
KontoBLZ |
string |
KontoBLZ |
19 |
BankName |
string |
BankName |
20 |
CostCenter |
string |
CostCenter |
Additional Notes
Usage Guidelines
Performance: When retrieving all shops (no ShopID specified), consider pagination for large datasets to optimize response times.
Filtering: Use the ShopID parameter to retrieve specific shop information when you know the exact shop identifier.
Integration Scenarios
Shop Directory: Ideal for building shop directories, location finders, and branch management systems.
Contact Management: Provides complete contact details including phone, fax, email, and physical addresses.
Financial Integration: Includes banking information (BIC, IBAN) for payment processing and financial reconciliation.
Best Practices
Caching: Shop information changes infrequently - implement appropriate caching strategies to reduce API calls.
Error Handling: Always validate ShopID exists before processing dependent operations.
Data Validation: Verify banking and contact information before using for critical business processes.