Service Methods
Method |
Function |
The method provides additional cost definitions currently configured in the backoffice. |
|
The method is parameter-free and delivers the address types (statically) defined in the backend in a… |
|
The method provides a certain set of item data and, if applicable, an iterator on the total amount o… |
|
The method provides Article data for the given Artikel::Ean::Oid primary key. Produces a… |
|
The method provides Article data for the given Artikel::Ean::Oid primary key. Produces a… |
|
The method provides Article data for the given Artikel::Ean::Oid primary key. Produces a… |
|
The method provides Article data for the given Artikel::Ean::Oid primary key. Produces a… |
|
The method provides a number of branch data and an iterator on the total amount of data determined b… |
|
The method provides all brands known in the system or the brand identified by its ID. |
|
The method provides a number of item characteristics and an iterator on the total amount of data, de… |
|
The method provides all characteristic types known in the system or the characteristic type identifi… |
|
The method provides all countries known in the system or the country identified by its ISO code (Cou… |
|
The method provides all currencies known in the system or the currency identified by its ISO code (C… |
|
The method provides a limited number of customer data and an iterator on the total amount of data, w… |
|
The method provides customer data identified by its ID. Produces an empty result or a re… |
|
The method provides a limited set of information about the customer purchase history (turnover & ret… |
|
The method provides all discount reasons known in the system or a discount reason identified by its … |
|
The method provides a limited number of delivery note data and an iterator on the total amount of da… |
|
The method provides a limited number of invoicei> data and an iterator on the total amount of data, … |
|
The method allows the transfer of new delivery note data to the Futura4Retail ERP backend. … |
|
The method provides all manufacturer colours known in the system or the manufacturer colour identifi… |
|
The method provides a number of manufacturer or supplier data and an iterator on the total amount of… |
|
The method provides a limited number of order data and an iterator on the total amount of data, whic… |
|
The method provides a set of inventory information on open orders and an iterator on the total amoun… |
|
The method provides all languages known in the system or the language identified by its ISO code (La… |
|
The method provides all payment types known in the system or the payment type identified by its ID. |
|
The method provides a number of product groups (list & hierarchy) and an iterator on the total amoun… |
|
The method provides all salutations known in the system or the salutation identified by its descript… |
|
The method provides all shops known in the system and the connected tills (BookingPlaces) or the sho… |
|
The method provides all sizes known in the system or the size identified by its ID. |
|
The method provides all size runs known in the system or the size run identified by its ID. |
|
Inventory data are read only, inventory changes are exclusively performed via backend business proce… |
|
The method provides inventory data for the given Artikel::Oid primary key. Produces an e… |
|
The method provides inventory data for the given Artikel::Ean::Oid primary key. Produces… |
|
The method provides all system colours known in the system or the system colour identified by its ID… |
|
The method provides all VAT data known in the system or the VAT data record identified by its ID. |
|
The method provides a limited number of voucher data and an iterator on the total amount of data tha… |
|
The method provides a number of deleted objects and an iterator on the total amount of data determin… |
|
The method searches for the deleted object by the given ExternalRecordId and RecordId. |
|
The method allows the transfer of a new or updated customer record to the Futura4Retail ERP backend…. |
|
The method allows the transfer of new delivery note data to the Futura4Retail ERP backend. … |
|
The method allows the transfer of new invoice data to the Futura4Retail ERP backend. The… |
|
The method allows the transfer of order data to the Futura4Retail ERP. The structure of … |
|
The method allows the transfer of new voucher details to the Futura4Retail ERP backend. … |
|
The method allows the transfer of new turnover & return data in the form of a sales receipt to the F… |
|
The method is parameter-free and provides basic information about the current WebService and the add… |
|
The method searches for the inter branch transfer (ibt) with the given DocumentNo and updates the gi… |
|
The method searches for the inter branch transfer (ibt) with the given DocumentNo and updates the st… |
|
The method creates a new inter branch transfer (ibt) with the given SenderNo, ReceiverNo and IBT-Pos… |
|
The method provides a limited number of ibts data. |
|
|
Note
|
The method provides additional cost definitions currently configured in the backoffice. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetAdditionalCostDefinitions>
<ns:request>
<ns:ID>string-value</ns:ID>
</ns:request>
</ns:GetAdditionalCostDefinitions>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<AdditionalCostDefinitionResponse>
<AdditionalCostDefinitions>
<!--Zero or more repetitions-->
<AdditionalCostDefinition>
<Description>string-value</Description>
<DefaultValue>0</DefaultValue>
<CurrencyISO>string-value</CurrencyISO>
<ID>string-value</ID>
</AdditionalCostDefinition>
</AdditionalCostDefinitions>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</AdditionalCostDefinitionResponse>
</soapenv:Envelope>|
Note
|
The method is parameter-free and delivers the address types (statically) defined in the backend in a normalised form (upperCase enumeration). In Futura4Retail environments, the following address types are known: BUSINESS, PRIVATE, DELIVERY, BILLING, ADDITIONAL, VARIOUS, UNDEFINED. These values are to be used for address type information in the corresponding requests, both for fields with enumerator type definition and string fields (Examples: order, customer). |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
old ECS equals 4POS |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetAddressTypes>
<ns:request />
</ns:GetAddressTypes>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<AddressTypeResponse>
<AddressTypes>
<!--Zero or more repetitions-->
<AddressType>
<TypeName>string-value</TypeName>
</AddressType>
</AddressTypes>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</AddressTypeResponse>
</soapenv:Envelope>|
Note
|
The method provides a certain set of item data and, if applicable, an iterator on the total amount of data, determined by corresponding parametrisations. This method represents a special case in terms of RequestPriority and ResponseDetails. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetArticles>
<ns:request>
<ns:RequestPriority />
<ns:ArticleId>string-value</ns:ArticleId>
<!--Optional-->
<ns:EAN>string-value</ns:EAN>
<!--Optional-->
<ns:PriceBranchId>string-value</ns:PriceBranchId>
<!--Optional-->
<ns:ResponseDetails />
<!--Optional-->
<ns:ChangedSinceDate>01.01.0001 00:00:00</ns:ChangedSinceDate>
<ns:IterationConstraints>
<ns:BlockSize>0</ns:BlockSize>
<ns:BlockIndex>0</ns:BlockIndex>
<ns:IterationId>string-value</ns:IterationId>
</ns:IterationConstraints>
</ns:request>
</ns:GetArticles>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<ArticleResponse>
<Articles>
<!--Zero or more repetitions-->
<Article>
<Description>string-value</Description>
<LongDescription>string-value</LongDescription>
<InternalNumberI>string-value</InternalNumberI>
<InternalNumberII>string-value</InternalNumberII>
<InternalShortDescI>string-value</InternalShortDescI>
<InternalShortDescII>string-value</InternalShortDescII>
<MemoI>string-value</MemoI>
<MemoII>string-value</MemoII>
<LastMove>01.01.0001 00:00:00</LastMove>
<SizeRange>string-value</SizeRange>
<BasePrice>0</BasePrice>
<Season>string-value</Season>
<PictureURI>string-value</PictureURI>
<Brand>string-value</Brand>
<ProductGroup>
<Description>string-value</Description>
<ShortDescription>string-value</ShortDescription>
<Number>0</Number>
<VatTypeId>0</VatTypeId>
<ParentID>string-value</ParentID>
<IsLeaf>False</IsLeaf>
<IsSelectionPermitted>False</IsSelectionPermitted>
<ParentProductGroup />
<ChildProductGroups />
<ID>string-value</ID>
<Oid>string-value</Oid>
</ProductGroup>
<Manufacturer>
<Description>string-value</Description>
<TaxID>string-value</TaxID>
<Contact>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<LanguageISO>string-value</LanguageISO>
<Company>string-value</Company>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<Addresses>
<!--Zero or more repetitions-->
<Address>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Address>
</Addresses>
<AddressType>string-value</AddressType>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Contact>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Manufacturer>
<Appearances>
<!--Zero or more repetitions-->
<Branch>
<Description>string-value</Description>
<Contact>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<LanguageISO>string-value</LanguageISO>
<Company>string-value</Company>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<Addresses>
<!--Zero or more repetitions-->
<Address>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Address>
</Addresses>
<AddressType>string-value</AddressType>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Contact>
<VatConfigurationId>0</VatConfigurationId>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Branch>
</Appearances>
<ColorEanPrices>
<!--Zero or more repetitions-->
<ColorEanPrices>
<EanPrices>
<!--Zero or more repetitions-->
<EanBranchPrices>
<BranchPrices>
<!--Zero or more repetitions-->
<BranchPrice>
<BranchId>string-value</BranchId>
<Price>0</Price>
<UnrealisticPrice>0</UnrealisticPrice>
</BranchPrice>
</BranchPrices>
<ScanCodes>
<!--Zero or more repetitions-->
<ScanCode>
<ID>string-value</ID>
</ScanCode>
</ScanCodes>
<EAN>string-value</EAN>
<Oid>string-value</Oid>
<Size>string-value</Size>
<Color>string-value</Color>
<ColorID>string-value</ColorID>
<ColorOid>string-value</ColorOid>
<SystemColor>string-value</SystemColor>
<SystemColorId>string-value</SystemColorId>
<SystemColorOid>string-value</SystemColorOid>
<SuggestedPrice>0</SuggestedPrice>
<UnrealisticPrice>0</UnrealisticPrice>
<IsNOS>False</IsNOS>
<EanCharacteristics>
<!--Zero or more repetitions-->
<Characteristic>
<ID>0</ID>
<Description>string-value</Description>
<Fraction>0</Fraction>
<Type>
<ID>0</ID>
<Description>string-value</Description>
<Oid>string-value</Oid>
</Type>
<ExpiryDate>01.01.0001 00:00:00</ExpiryDate>
<DaysLeft>
<System.Int32 />
</DaysLeft>
<Oid>string-value</Oid>
</Characteristic>
</EanCharacteristics>
</EanBranchPrices>
</EanPrices>
<ManufacturerId>string-value</ManufacturerId>
<ManufacturerOid>string-value</ManufacturerOid>
<ManufacturerDescription>string-value</ManufacturerDescription>
<SystemColorId>0</SystemColorId>
<SystemColorOid>string-value</SystemColorOid>
<SystemColorDescription>string-value</SystemColorDescription>
</ColorEanPrices>
</ColorEanPrices>
<Characteristics>
<!--Zero or more repetitions-->
<Characteristic>
<ID>0</ID>
<Description>string-value</Description>
<Fraction>0</Fraction>
<Type>
<ID>0</ID>
<Description>string-value</Description>
<Oid>string-value</Oid>
</Type>
<ExpiryDate>01.01.0001 00:00:00</ExpiryDate>
<DaysLeft>
<System.Int32 />
</DaysLeft>
<Oid>string-value</Oid>
</Characteristic>
</Characteristics>
<UnrealisticPrice>0</UnrealisticPrice>
<IsNOS>False</IsNOS>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Article>
</Articles>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</ArticleResponse>
</soapenv:Envelope>|
Note
|
The method provides Article data for the given Artikel::Ean::Oid primary key. Produces an empty result or a reduced response (Ean list filtered for given Ean::Oid) with the same domain object (Article) as used in GetArticles. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:FindArticleByOid>
<ns:request>
<!--Optional-->
<ns:ArticleOid>string-value</ns:ArticleOid>
</ns:request>
</ns:FindArticleByOid>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<FindArticleResponse>
<Article>
<Description>string-value</Description>
<LongDescription>string-value</LongDescription>
<InternalNumberI>string-value</InternalNumberI>
<InternalNumberII>string-value</InternalNumberII>
<InternalShortDescI>string-value</InternalShortDescI>
<InternalShortDescII>string-value</InternalShortDescII>
<MemoI>string-value</MemoI>
<MemoII>string-value</MemoII>
<LastMove>01.01.0001 00:00:00</LastMove>
<SizeRange>string-value</SizeRange>
<BasePrice>0</BasePrice>
<Season>string-value</Season>
<PictureURI>string-value</PictureURI>
<Brand>string-value</Brand>
<ProductGroup>
<Description>string-value</Description>
<ShortDescription>string-value</ShortDescription>
<Number>0</Number>
<VatTypeId>0</VatTypeId>
<ParentID>string-value</ParentID>
<IsLeaf>False</IsLeaf>
<IsSelectionPermitted>False</IsSelectionPermitted>
<ParentProductGroup />
<ChildProductGroups />
<ID>string-value</ID>
<Oid>string-value</Oid>
</ProductGroup>
<Manufacturer>
<Description>string-value</Description>
<TaxID>string-value</TaxID>
<Contact>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<LanguageISO>string-value</LanguageISO>
<Company>string-value</Company>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<Addresses>
<!--Zero or more repetitions-->
<Address>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Address>
</Addresses>
<AddressType>string-value</AddressType>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Contact>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Manufacturer>
<Appearances>
<!--Zero or more repetitions-->
<Branch>
<Description>string-value</Description>
<Contact>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<LanguageISO>string-value</LanguageISO>
<Company>string-value</Company>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<Addresses>
<!--Zero or more repetitions-->
<Address>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Address>
</Addresses>
<AddressType>string-value</AddressType>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Contact>
<VatConfigurationId>0</VatConfigurationId>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Branch>
</Appearances>
<ColorEanPrices>
<!--Zero or more repetitions-->
<ColorEanPrices>
<EanPrices>
<!--Zero or more repetitions-->
<EanBranchPrices>
<BranchPrices>
<!--Zero or more repetitions-->
<BranchPrice>
<BranchId>string-value</BranchId>
<Price>0</Price>
<UnrealisticPrice>0</UnrealisticPrice>
</BranchPrice>
</BranchPrices>
<ScanCodes>
<!--Zero or more repetitions-->
<ScanCode>
<ID>string-value</ID>
</ScanCode>
</ScanCodes>
<EAN>string-value</EAN>
<Oid>string-value</Oid>
<Size>string-value</Size>
<Color>string-value</Color>
<ColorID>string-value</ColorID>
<ColorOid>string-value</ColorOid>
<SystemColor>string-value</SystemColor>
<SystemColorId>string-value</SystemColorId>
<SystemColorOid>string-value</SystemColorOid>
<SuggestedPrice>0</SuggestedPrice>
<UnrealisticPrice>0</UnrealisticPrice>
<IsNOS>False</IsNOS>
<EanCharacteristics>
<!--Zero or more repetitions-->
<Characteristic>
<ID>0</ID>
<Description>string-value</Description>
<Fraction>0</Fraction>
<Type>
<ID>0</ID>
<Description>string-value</Description>
<Oid>string-value</Oid>
</Type>
<ExpiryDate>01.01.0001 00:00:00</ExpiryDate>
<DaysLeft>
<System.Int32 />
</DaysLeft>
<Oid>string-value</Oid>
</Characteristic>
</EanCharacteristics>
</EanBranchPrices>
</EanPrices>
<ManufacturerId>string-value</ManufacturerId>
<ManufacturerOid>string-value</ManufacturerOid>
<ManufacturerDescription>string-value</ManufacturerDescription>
<SystemColorId>0</SystemColorId>
<SystemColorOid>string-value</SystemColorOid>
<SystemColorDescription>string-value</SystemColorDescription>
</ColorEanPrices>
</ColorEanPrices>
<Characteristics>
<!--Zero or more repetitions-->
<Characteristic>
<ID>0</ID>
<Description>string-value</Description>
<Fraction>0</Fraction>
<Type>
<ID>0</ID>
<Description>string-value</Description>
<Oid>string-value</Oid>
</Type>
<ExpiryDate>01.01.0001 00:00:00</ExpiryDate>
<DaysLeft>
<System.Int32 />
</DaysLeft>
<Oid>string-value</Oid>
</Characteristic>
</Characteristics>
<UnrealisticPrice>0</UnrealisticPrice>
<IsNOS>False</IsNOS>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Article>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</FindArticleResponse>
</soapenv:Envelope>|
Note
|
The method provides Article data for the given Artikel::Ean::Oid primary key. Produces an empty result or a reduced response (Ean list filtered for given Ean::Oid) with the same domain object (Article) as used in GetArticles. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:FindArticleByOidWithCharcteristics>
<ns:request>
<!--Optional-->
<ns:ArticleOid>string-value</ns:ArticleOid>
</ns:request>
</ns:FindArticleByOidWithCharcteristics>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<FindArticleResponse>
<Article>
<Description>string-value</Description>
<LongDescription>string-value</LongDescription>
<InternalNumberI>string-value</InternalNumberI>
<InternalNumberII>string-value</InternalNumberII>
<InternalShortDescI>string-value</InternalShortDescI>
<InternalShortDescII>string-value</InternalShortDescII>
<MemoI>string-value</MemoI>
<MemoII>string-value</MemoII>
<LastMove>01.01.0001 00:00:00</LastMove>
<SizeRange>string-value</SizeRange>
<BasePrice>0</BasePrice>
<Season>string-value</Season>
<PictureURI>string-value</PictureURI>
<Brand>string-value</Brand>
<ProductGroup>
<Description>string-value</Description>
<ShortDescription>string-value</ShortDescription>
<Number>0</Number>
<VatTypeId>0</VatTypeId>
<ParentID>string-value</ParentID>
<IsLeaf>False</IsLeaf>
<IsSelectionPermitted>False</IsSelectionPermitted>
<ParentProductGroup />
<ChildProductGroups />
<ID>string-value</ID>
<Oid>string-value</Oid>
</ProductGroup>
<Manufacturer>
<Description>string-value</Description>
<TaxID>string-value</TaxID>
<Contact>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<LanguageISO>string-value</LanguageISO>
<Company>string-value</Company>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<Addresses>
<!--Zero or more repetitions-->
<Address>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Address>
</Addresses>
<AddressType>string-value</AddressType>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Contact>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Manufacturer>
<Appearances>
<!--Zero or more repetitions-->
<Branch>
<Description>string-value</Description>
<Contact>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<LanguageISO>string-value</LanguageISO>
<Company>string-value</Company>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<Addresses>
<!--Zero or more repetitions-->
<Address>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Address>
</Addresses>
<AddressType>string-value</AddressType>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Contact>
<VatConfigurationId>0</VatConfigurationId>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Branch>
</Appearances>
<ColorEanPrices>
<!--Zero or more repetitions-->
<ColorEanPrices>
<EanPrices>
<!--Zero or more repetitions-->
<EanBranchPrices>
<BranchPrices>
<!--Zero or more repetitions-->
<BranchPrice>
<BranchId>string-value</BranchId>
<Price>0</Price>
<UnrealisticPrice>0</UnrealisticPrice>
</BranchPrice>
</BranchPrices>
<ScanCodes>
<!--Zero or more repetitions-->
<ScanCode>
<ID>string-value</ID>
</ScanCode>
</ScanCodes>
<EAN>string-value</EAN>
<Oid>string-value</Oid>
<Size>string-value</Size>
<Color>string-value</Color>
<ColorID>string-value</ColorID>
<ColorOid>string-value</ColorOid>
<SystemColor>string-value</SystemColor>
<SystemColorId>string-value</SystemColorId>
<SystemColorOid>string-value</SystemColorOid>
<SuggestedPrice>0</SuggestedPrice>
<UnrealisticPrice>0</UnrealisticPrice>
<IsNOS>False</IsNOS>
<EanCharacteristics>
<!--Zero or more repetitions-->
<Characteristic>
<ID>0</ID>
<Description>string-value</Description>
<Fraction>0</Fraction>
<Type>
<ID>0</ID>
<Description>string-value</Description>
<Oid>string-value</Oid>
</Type>
<ExpiryDate>01.01.0001 00:00:00</ExpiryDate>
<DaysLeft>
<System.Int32 />
</DaysLeft>
<Oid>string-value</Oid>
</Characteristic>
</EanCharacteristics>
</EanBranchPrices>
</EanPrices>
<ManufacturerId>string-value</ManufacturerId>
<ManufacturerOid>string-value</ManufacturerOid>
<ManufacturerDescription>string-value</ManufacturerDescription>
<SystemColorId>0</SystemColorId>
<SystemColorOid>string-value</SystemColorOid>
<SystemColorDescription>string-value</SystemColorDescription>
</ColorEanPrices>
</ColorEanPrices>
<Characteristics>
<!--Zero or more repetitions-->
<Characteristic>
<ID>0</ID>
<Description>string-value</Description>
<Fraction>0</Fraction>
<Type>
<ID>0</ID>
<Description>string-value</Description>
<Oid>string-value</Oid>
</Type>
<ExpiryDate>01.01.0001 00:00:00</ExpiryDate>
<DaysLeft>
<System.Int32 />
</DaysLeft>
<Oid>string-value</Oid>
</Characteristic>
</Characteristics>
<UnrealisticPrice>0</UnrealisticPrice>
<IsNOS>False</IsNOS>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Article>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</FindArticleResponse>
</soapenv:Envelope>|
Note
|
The method provides Article data for the given Artikel::Ean::Oid primary key. Produces an empty result or a response with the same domain object (Article) as used in GetArticles. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:FindArticleByEanOid>
<ns:request>
<!--Optional-->
<ns:EANOid>string-value</ns:EANOid>
</ns:request>
</ns:FindArticleByEanOid>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<FindArticleResponse>
<Article>
<Description>string-value</Description>
<LongDescription>string-value</LongDescription>
<InternalNumberI>string-value</InternalNumberI>
<InternalNumberII>string-value</InternalNumberII>
<InternalShortDescI>string-value</InternalShortDescI>
<InternalShortDescII>string-value</InternalShortDescII>
<MemoI>string-value</MemoI>
<MemoII>string-value</MemoII>
<LastMove>01.01.0001 00:00:00</LastMove>
<SizeRange>string-value</SizeRange>
<BasePrice>0</BasePrice>
<Season>string-value</Season>
<PictureURI>string-value</PictureURI>
<Brand>string-value</Brand>
<ProductGroup>
<Description>string-value</Description>
<ShortDescription>string-value</ShortDescription>
<Number>0</Number>
<VatTypeId>0</VatTypeId>
<ParentID>string-value</ParentID>
<IsLeaf>False</IsLeaf>
<IsSelectionPermitted>False</IsSelectionPermitted>
<ParentProductGroup />
<ChildProductGroups />
<ID>string-value</ID>
<Oid>string-value</Oid>
</ProductGroup>
<Manufacturer>
<Description>string-value</Description>
<TaxID>string-value</TaxID>
<Contact>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<LanguageISO>string-value</LanguageISO>
<Company>string-value</Company>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<Addresses>
<!--Zero or more repetitions-->
<Address>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Address>
</Addresses>
<AddressType>string-value</AddressType>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Contact>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Manufacturer>
<Appearances>
<!--Zero or more repetitions-->
<Branch>
<Description>string-value</Description>
<Contact>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<LanguageISO>string-value</LanguageISO>
<Company>string-value</Company>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<Addresses>
<!--Zero or more repetitions-->
<Address>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Address>
</Addresses>
<AddressType>string-value</AddressType>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Contact>
<VatConfigurationId>0</VatConfigurationId>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Branch>
</Appearances>
<ColorEanPrices>
<!--Zero or more repetitions-->
<ColorEanPrices>
<EanPrices>
<!--Zero or more repetitions-->
<EanBranchPrices>
<BranchPrices>
<!--Zero or more repetitions-->
<BranchPrice>
<BranchId>string-value</BranchId>
<Price>0</Price>
<UnrealisticPrice>0</UnrealisticPrice>
</BranchPrice>
</BranchPrices>
<ScanCodes>
<!--Zero or more repetitions-->
<ScanCode>
<ID>string-value</ID>
</ScanCode>
</ScanCodes>
<EAN>string-value</EAN>
<Oid>string-value</Oid>
<Size>string-value</Size>
<Color>string-value</Color>
<ColorID>string-value</ColorID>
<ColorOid>string-value</ColorOid>
<SystemColor>string-value</SystemColor>
<SystemColorId>string-value</SystemColorId>
<SystemColorOid>string-value</SystemColorOid>
<SuggestedPrice>0</SuggestedPrice>
<UnrealisticPrice>0</UnrealisticPrice>
<IsNOS>False</IsNOS>
<EanCharacteristics>
<!--Zero or more repetitions-->
<Characteristic>
<ID>0</ID>
<Description>string-value</Description>
<Fraction>0</Fraction>
<Type>
<ID>0</ID>
<Description>string-value</Description>
<Oid>string-value</Oid>
</Type>
<ExpiryDate>01.01.0001 00:00:00</ExpiryDate>
<DaysLeft>
<System.Int32 />
</DaysLeft>
<Oid>string-value</Oid>
</Characteristic>
</EanCharacteristics>
</EanBranchPrices>
</EanPrices>
<ManufacturerId>string-value</ManufacturerId>
<ManufacturerOid>string-value</ManufacturerOid>
<ManufacturerDescription>string-value</ManufacturerDescription>
<SystemColorId>0</SystemColorId>
<SystemColorOid>string-value</SystemColorOid>
<SystemColorDescription>string-value</SystemColorDescription>
</ColorEanPrices>
</ColorEanPrices>
<Characteristics>
<!--Zero or more repetitions-->
<Characteristic>
<ID>0</ID>
<Description>string-value</Description>
<Fraction>0</Fraction>
<Type>
<ID>0</ID>
<Description>string-value</Description>
<Oid>string-value</Oid>
</Type>
<ExpiryDate>01.01.0001 00:00:00</ExpiryDate>
<DaysLeft>
<System.Int32 />
</DaysLeft>
<Oid>string-value</Oid>
</Characteristic>
</Characteristics>
<UnrealisticPrice>0</UnrealisticPrice>
<IsNOS>False</IsNOS>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Article>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</FindArticleResponse>
</soapenv:Envelope>|
Note
|
The method provides Article data for the given Artikel::Ean::Oid primary key. Produces an empty result or a response with the same domain object (Article) as used in GetArticles. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:FindArticleByEanOidWithCharcteristics>
<ns:request>
<!--Optional-->
<ns:EANOid>string-value</ns:EANOid>
</ns:request>
</ns:FindArticleByEanOidWithCharcteristics>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<FindArticleResponse>
<Article>
<Description>string-value</Description>
<LongDescription>string-value</LongDescription>
<InternalNumberI>string-value</InternalNumberI>
<InternalNumberII>string-value</InternalNumberII>
<InternalShortDescI>string-value</InternalShortDescI>
<InternalShortDescII>string-value</InternalShortDescII>
<MemoI>string-value</MemoI>
<MemoII>string-value</MemoII>
<LastMove>01.01.0001 00:00:00</LastMove>
<SizeRange>string-value</SizeRange>
<BasePrice>0</BasePrice>
<Season>string-value</Season>
<PictureURI>string-value</PictureURI>
<Brand>string-value</Brand>
<ProductGroup>
<Description>string-value</Description>
<ShortDescription>string-value</ShortDescription>
<Number>0</Number>
<VatTypeId>0</VatTypeId>
<ParentID>string-value</ParentID>
<IsLeaf>False</IsLeaf>
<IsSelectionPermitted>False</IsSelectionPermitted>
<ParentProductGroup />
<ChildProductGroups />
<ID>string-value</ID>
<Oid>string-value</Oid>
</ProductGroup>
<Manufacturer>
<Description>string-value</Description>
<TaxID>string-value</TaxID>
<Contact>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<LanguageISO>string-value</LanguageISO>
<Company>string-value</Company>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<Addresses>
<!--Zero or more repetitions-->
<Address>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Address>
</Addresses>
<AddressType>string-value</AddressType>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Contact>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Manufacturer>
<Appearances>
<!--Zero or more repetitions-->
<Branch>
<Description>string-value</Description>
<Contact>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<LanguageISO>string-value</LanguageISO>
<Company>string-value</Company>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<Addresses>
<!--Zero or more repetitions-->
<Address>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Address>
</Addresses>
<AddressType>string-value</AddressType>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Contact>
<VatConfigurationId>0</VatConfigurationId>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Branch>
</Appearances>
<ColorEanPrices>
<!--Zero or more repetitions-->
<ColorEanPrices>
<EanPrices>
<!--Zero or more repetitions-->
<EanBranchPrices>
<BranchPrices>
<!--Zero or more repetitions-->
<BranchPrice>
<BranchId>string-value</BranchId>
<Price>0</Price>
<UnrealisticPrice>0</UnrealisticPrice>
</BranchPrice>
</BranchPrices>
<ScanCodes>
<!--Zero or more repetitions-->
<ScanCode>
<ID>string-value</ID>
</ScanCode>
</ScanCodes>
<EAN>string-value</EAN>
<Oid>string-value</Oid>
<Size>string-value</Size>
<Color>string-value</Color>
<ColorID>string-value</ColorID>
<ColorOid>string-value</ColorOid>
<SystemColor>string-value</SystemColor>
<SystemColorId>string-value</SystemColorId>
<SystemColorOid>string-value</SystemColorOid>
<SuggestedPrice>0</SuggestedPrice>
<UnrealisticPrice>0</UnrealisticPrice>
<IsNOS>False</IsNOS>
<EanCharacteristics>
<!--Zero or more repetitions-->
<Characteristic>
<ID>0</ID>
<Description>string-value</Description>
<Fraction>0</Fraction>
<Type>
<ID>0</ID>
<Description>string-value</Description>
<Oid>string-value</Oid>
</Type>
<ExpiryDate>01.01.0001 00:00:00</ExpiryDate>
<DaysLeft>
<System.Int32 />
</DaysLeft>
<Oid>string-value</Oid>
</Characteristic>
</EanCharacteristics>
</EanBranchPrices>
</EanPrices>
<ManufacturerId>string-value</ManufacturerId>
<ManufacturerOid>string-value</ManufacturerOid>
<ManufacturerDescription>string-value</ManufacturerDescription>
<SystemColorId>0</SystemColorId>
<SystemColorOid>string-value</SystemColorOid>
<SystemColorDescription>string-value</SystemColorDescription>
</ColorEanPrices>
</ColorEanPrices>
<Characteristics>
<!--Zero or more repetitions-->
<Characteristic>
<ID>0</ID>
<Description>string-value</Description>
<Fraction>0</Fraction>
<Type>
<ID>0</ID>
<Description>string-value</Description>
<Oid>string-value</Oid>
</Type>
<ExpiryDate>01.01.0001 00:00:00</ExpiryDate>
<DaysLeft>
<System.Int32 />
</DaysLeft>
<Oid>string-value</Oid>
</Characteristic>
</Characteristics>
<UnrealisticPrice>0</UnrealisticPrice>
<IsNOS>False</IsNOS>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Article>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</FindArticleResponse>
</soapenv:Envelope>|
Note
|
The method provides a number of branch data and an iterator on the total amount of data determined by corresponding parametrisations. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetBranches>
<ns:request>
<ns:ID>string-value</ns:ID>
<ns:IterationConstraints>
<ns:BlockSize>0</ns:BlockSize>
<ns:BlockIndex>0</ns:BlockIndex>
<ns:IterationId>string-value</ns:IterationId>
</ns:IterationConstraints>
</ns:request>
</ns:GetBranches>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<BranchResponse>
<Branches>
<!--Zero or more repetitions-->
<Branch>
<Description>string-value</Description>
<Contact>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<LanguageISO>string-value</LanguageISO>
<Company>string-value</Company>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<Addresses>
<!--Zero or more repetitions-->
<Address>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Address>
</Addresses>
<AddressType>string-value</AddressType>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Contact>
<VatConfigurationId>0</VatConfigurationId>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Branch>
</Branches>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</BranchResponse>
</soapenv:Envelope>|
Note
|
The method provides all brands known in the system or the brand identified by its ID. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetBrands>
<ns:request>
<ns:ID>string-value</ns:ID>
</ns:request>
</ns:GetBrands>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<BrandResponse>
<Brands>
<!--Zero or more repetitions-->
<Brand>
<Description>string-value</Description>
<StoreBrand>False</StoreBrand>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Brand>
</Brands>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</BrandResponse>
</soapenv:Envelope>|
Note
|
The method provides a number of item characteristics and an iterator on the total amount of data, determined by corresponding parametrisations. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetCharacteristics>
<ns:request>
<ns:ID>0</ns:ID>
<ns:IterationConstraints>
<ns:BlockSize>0</ns:BlockSize>
<ns:BlockIndex>0</ns:BlockIndex>
<ns:IterationId>string-value</ns:IterationId>
</ns:IterationConstraints>
</ns:request>
</ns:GetCharacteristics>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<CharacteristicResponse>
<Characteristics>
<!--Zero or more repetitions-->
<Characteristic>
<ID>0</ID>
<Description>string-value</Description>
<Fraction>0</Fraction>
<Type>
<ID>0</ID>
<Description>string-value</Description>
<Oid>string-value</Oid>
</Type>
<ExpiryDate>01.01.0001 00:00:00</ExpiryDate>
<DaysLeft>
<System.Int32 />
</DaysLeft>
<Oid>string-value</Oid>
</Characteristic>
</Characteristics>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</CharacteristicResponse>
</soapenv:Envelope>|
Note
|
The method provides all characteristic types known in the system or the characteristic type identified by its ID. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetCharacteristicTypes>
<ns:request>
<ns:ID>0</ns:ID>
</ns:request>
</ns:GetCharacteristicTypes>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<CharacteristicTypeResponse>
<CharacteristicTypes>
<!--Zero or more repetitions-->
<CharacteristicType>
<ID>0</ID>
<Description>string-value</Description>
<Oid>string-value</Oid>
</CharacteristicType>
</CharacteristicTypes>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</CharacteristicTypeResponse>
</soapenv:Envelope>|
Note
|
The method provides all countries known in the system or the country identified by its ISO code (CountryISO), provided it is available in the backend. If it is possible to gather any and especially non-ISO compliant short codes in the backend, the parameter CountryISO is to be construed accordingly. In an ideal situation all countries with their unique ISO code were captured in the backend. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetCountries>
<ns:request>
<ns:CountryISO>string-value</ns:CountryISO>
</ns:request>
</ns:GetCountries>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<CountryResponse>
<Countries>
<!--Zero or more repetitions-->
<Country>
<Description>string-value</Description>
<CountryISO>string-value</CountryISO>
<Oid>string-value</Oid>
</Country>
</Countries>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</CountryResponse>
</soapenv:Envelope>|
Note
|
The method provides all currencies known in the system or the currency identified by its ISO code (CurrencyISO), provided it is available in the backend. If it is possible to gather any and especially non-ISO compliant short codes in the backend, the parameter CurrencyISO is to be construed accordingly. In an ideal situation all currencies with their unique ISO code were captured in the backend. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetCurrencies>
<ns:request>
<ns:CurrencyISO>string-value</ns:CurrencyISO>
</ns:request>
</ns:GetCurrencies>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<CurrencyResponse>
<Currency>
<!--Zero or more repetitions-->
<Currency>
<CurrencyISO>string-value</CurrencyISO>
<Description>string-value</Description>
<RoundingMode />
<RoundingValue>0</RoundingValue>
<PrintingSymbol>string-value</PrintingSymbol>
<Oid>string-value</Oid>
</Currency>
</Currency>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</CurrencyResponse>
</soapenv:Envelope>|
Note
|
The method provides a limited number of customer data and an iterator on the total amount of data, which is determined by a particular parametrisation. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetCustomers>
<ns:request>
<ns:ShopId>string-value</ns:ShopId>
<ns:ShopCustomerId>string-value</ns:ShopCustomerId>
<ns:CustomerId>string-value</ns:CustomerId>
<!--Optional-->
<ns:FilterLockedCustomers>False</ns:FilterLockedCustomers>
<!--Optional-->
<ns:ChangedSinceDate>01.01.0001 00:00:00</ns:ChangedSinceDate>
<ns:WithCharacteristics>
<ns:System.Boolean />
</ns:WithCharacteristics>
<ns:IterationConstraints>
<ns:BlockSize>0</ns:BlockSize>
<ns:BlockIndex>0</ns:BlockIndex>
<ns:IterationId>string-value</ns:IterationId>
</ns:IterationConstraints>
</ns:request>
</ns:GetCustomers>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<CustomerResponse>
<Customers>
<!--Zero or more repetitions-->
<Customer>
<ShopId>string-value</ShopId>
<ShopCustomerId>string-value</ShopCustomerId>
<Description>string-value</Description>
<CreationDate>01.01.0001 00:00:00</CreationDate>
<ChangedAt>01.01.0001 00:00:00</ChangedAt>
<DefaultCurrencyISO>string-value</DefaultCurrencyISO>
<DefaultPaymentTypeId>string-value</DefaultPaymentTypeId>
<Person>
<LanguageISO>string-value</LanguageISO>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<!--Optional-->
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Title>string-value</Title>
<Position>string-value</Position>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Person>
<CommunicationData>
<!--Zero or more repetitions-->
<CommunicationMechanism>
<CommunicationType />
<CommunicationValue>string-value</CommunicationValue>
<AdvertisingAllowed>False</AdvertisingAllowed>
<!--Optional-->
<ValidFrom>01.01.0001 00:00:00</ValidFrom>
<!--Optional-->
<ValidTo>01.01.0001 00:00:00</ValidTo>
</CommunicationMechanism>
</CommunicationData>
<PostalAddresses>
<!--Zero or more repetitions-->
<PostalAddress>
<AddressType />
<!--Optional-->
<Description>string-value</Description>
<Street>string-value</Street>
<StreetNumber>string-value</StreetNumber>
<BuildingNumber>string-value</BuildingNumber>
<BuildingName>string-value</BuildingName>
<Block>string-value</Block>
<FlatNumber>string-value</FlatNumber>
<Floor>string-value</Floor>
<PostalDistrict>string-value</PostalDistrict>
<Quarter>string-value</Quarter>
<Latitude>0</Latitude>
<TimeZoneDesignator>string-value</TimeZoneDesignator>
<Longitude>0</Longitude>
<!--Optional-->
<PostBoxNumber>string-value</PostBoxNumber>
<!--Optional-->
<PostBoxZipCode>string-value</PostBoxZipCode>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<County>string-value</County>
<CountryISO>string-value</CountryISO>
<!--Optional-->
<AdditionalRow1>string-value</AdditionalRow1>
<!--Optional-->
<AdditionalRow2>string-value</AdditionalRow2>
<!--Optional-->
<Tag>string-value</Tag>
<!--Optional-->
<IsCorrespondenceAddress>False</IsCorrespondenceAddress>
<Oid>string-value</Oid>
</PostalAddress>
</PostalAddresses>
<BankAccounts>
<!--Zero or more repetitions-->
<BankAccount>
<AccountNumber>string-value</AccountNumber>
<BankCode>string-value</BankCode>
<BankName>string-value</BankName>
<IBAN>string-value</IBAN>
<BIC>string-value</BIC>
</BankAccount>
</BankAccounts>
<CustomerCards>
<!--Zero or more repetitions-->
<CustomerCard>
<Blocked>False</Blocked>
<!--Optional-->
<IssueDate>01.01.0001 00:00:00</IssueDate>
<ExpirationDate>01.01.0001 00:00:00</ExpirationDate>
<CustomerId>string-value</CustomerId>
<CustomerCardType />
<!--Optional-->
<CardVerificationCode>string-value</CardVerificationCode>
<ID>string-value</ID>
<Oid>string-value</Oid>
</CustomerCard>
</CustomerCards>
<StandardDiscount>0</StandardDiscount>
<IsReseller>False</IsReseller>
<WithoutVAT>False</WithoutVAT>
<AdvertisingAllowed>False</AdvertisingAllowed>
<Blocked>False</Blocked>
<BlockedSinceDate>01.01.0001 00:00:00</BlockedSinceDate>
<HomeBranchId>string-value</HomeBranchId>
<CreatedByEmployee>string-value</CreatedByEmployee>
<CreatedAtPos>string-value</CreatedAtPos>
<BonusPoints>0</BonusPoints>
<BonusSaleReduced>0</BonusSaleReduced>
<BonusSaleRegular>0</BonusSaleRegular>
<ParentId>string-value</ParentId>
<Characteristics>
<!--Zero or more repetitions-->
<Characteristic>
<ID>0</ID>
<Description>string-value</Description>
<Fraction>0</Fraction>
<Type>
<ID>0</ID>
<Description>string-value</Description>
<Oid>string-value</Oid>
</Type>
<ExpiryDate>01.01.0001 00:00:00</ExpiryDate>
<DaysLeft>
<System.Int32 />
</DaysLeft>
<Oid>string-value</Oid>
</Characteristic>
</Characteristics>
<PreferredCommunication>string-value</PreferredCommunication>
<VATId>string-value</VATId>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Customer>
</Customers>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</CustomerResponse>
</soapenv:Envelope>|
Note
|
The method provides customer data identified by its ID. Produces an empty result or a response with the same domain object (Customer) as used in GetCustomers. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:FindCustomerByOid>
<ns:request>
<!--Optional-->
<ns:CustomerOid>string-value</ns:CustomerOid>
</ns:request>
</ns:FindCustomerByOid>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<FindCustomerResponse>
<Customer>
<ShopId>string-value</ShopId>
<ShopCustomerId>string-value</ShopCustomerId>
<Description>string-value</Description>
<CreationDate>01.01.0001 00:00:00</CreationDate>
<ChangedAt>01.01.0001 00:00:00</ChangedAt>
<DefaultCurrencyISO>string-value</DefaultCurrencyISO>
<DefaultPaymentTypeId>string-value</DefaultPaymentTypeId>
<Person>
<LanguageISO>string-value</LanguageISO>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<!--Optional-->
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Title>string-value</Title>
<Position>string-value</Position>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Person>
<CommunicationData>
<!--Zero or more repetitions-->
<CommunicationMechanism>
<CommunicationType />
<CommunicationValue>string-value</CommunicationValue>
<AdvertisingAllowed>False</AdvertisingAllowed>
<!--Optional-->
<ValidFrom>01.01.0001 00:00:00</ValidFrom>
<!--Optional-->
<ValidTo>01.01.0001 00:00:00</ValidTo>
</CommunicationMechanism>
</CommunicationData>
<PostalAddresses>
<!--Zero or more repetitions-->
<PostalAddress>
<AddressType />
<!--Optional-->
<Description>string-value</Description>
<Street>string-value</Street>
<StreetNumber>string-value</StreetNumber>
<BuildingNumber>string-value</BuildingNumber>
<BuildingName>string-value</BuildingName>
<Block>string-value</Block>
<FlatNumber>string-value</FlatNumber>
<Floor>string-value</Floor>
<PostalDistrict>string-value</PostalDistrict>
<Quarter>string-value</Quarter>
<Latitude>0</Latitude>
<TimeZoneDesignator>string-value</TimeZoneDesignator>
<Longitude>0</Longitude>
<!--Optional-->
<PostBoxNumber>string-value</PostBoxNumber>
<!--Optional-->
<PostBoxZipCode>string-value</PostBoxZipCode>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<County>string-value</County>
<CountryISO>string-value</CountryISO>
<!--Optional-->
<AdditionalRow1>string-value</AdditionalRow1>
<!--Optional-->
<AdditionalRow2>string-value</AdditionalRow2>
<!--Optional-->
<Tag>string-value</Tag>
<!--Optional-->
<IsCorrespondenceAddress>False</IsCorrespondenceAddress>
<Oid>string-value</Oid>
</PostalAddress>
</PostalAddresses>
<BankAccounts>
<!--Zero or more repetitions-->
<BankAccount>
<AccountNumber>string-value</AccountNumber>
<BankCode>string-value</BankCode>
<BankName>string-value</BankName>
<IBAN>string-value</IBAN>
<BIC>string-value</BIC>
</BankAccount>
</BankAccounts>
<CustomerCards>
<!--Zero or more repetitions-->
<CustomerCard>
<Blocked>False</Blocked>
<!--Optional-->
<IssueDate>01.01.0001 00:00:00</IssueDate>
<ExpirationDate>01.01.0001 00:00:00</ExpirationDate>
<CustomerId>string-value</CustomerId>
<CustomerCardType />
<!--Optional-->
<CardVerificationCode>string-value</CardVerificationCode>
<ID>string-value</ID>
<Oid>string-value</Oid>
</CustomerCard>
</CustomerCards>
<StandardDiscount>0</StandardDiscount>
<IsReseller>False</IsReseller>
<WithoutVAT>False</WithoutVAT>
<AdvertisingAllowed>False</AdvertisingAllowed>
<Blocked>False</Blocked>
<BlockedSinceDate>01.01.0001 00:00:00</BlockedSinceDate>
<HomeBranchId>string-value</HomeBranchId>
<CreatedByEmployee>string-value</CreatedByEmployee>
<CreatedAtPos>string-value</CreatedAtPos>
<BonusPoints>0</BonusPoints>
<BonusSaleReduced>0</BonusSaleReduced>
<BonusSaleRegular>0</BonusSaleRegular>
<ParentId>string-value</ParentId>
<Characteristics>
<!--Zero or more repetitions-->
<Characteristic>
<ID>0</ID>
<Description>string-value</Description>
<Fraction>0</Fraction>
<Type>
<ID>0</ID>
<Description>string-value</Description>
<Oid>string-value</Oid>
</Type>
<ExpiryDate>01.01.0001 00:00:00</ExpiryDate>
<DaysLeft>
<System.Int32 />
</DaysLeft>
<Oid>string-value</Oid>
</Characteristic>
</Characteristics>
<PreferredCommunication>string-value</PreferredCommunication>
<VATId>string-value</VATId>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Customer>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</FindCustomerResponse>
</soapenv:Envelope>|
Note
|
The method provides a limited set of information about the customer purchase history (turnover & returns) of a particular customer and an iterator on the total amount of data, which is determined by a particular parametrisation. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetCustomerPurchaseHistory>
<ns:request>
<ns:CustomerId>string-value</ns:CustomerId>
<ns:DateFrom>01.01.0001 00:00:00</ns:DateFrom>
<ns:DateTo>01.01.0001 00:00:00</ns:DateTo>
<ns:IterationConstraints>
<ns:BlockSize>0</ns:BlockSize>
<ns:BlockIndex>0</ns:BlockIndex>
<ns:IterationId>string-value</ns:IterationId>
</ns:IterationConstraints>
</ns:request>
</ns:GetCustomerPurchaseHistory>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<CustomerPurchaseHistoryResponse>
<CustomerPurchaseHistoryEntries>
<!--Zero or more repetitions-->
<CustomerPurchaseHistory>
<CustomerId>string-value</CustomerId>
<TransactionTimestamp>01.01.0001 00:00:00</TransactionTimestamp>
<ReceiptText>string-value</ReceiptText>
<BranchId>string-value</BranchId>
<ProductGroupId>string-value</ProductGroupId>
<EAN>string-value</EAN>
<SerialNo>string-value</SerialNo>
<Price>0</Price>
<Quantity>0</Quantity>
<HistoryReceiptType />
<LineType />
<ReceiptNo>0</ReceiptNo>
<PositionNo>0</PositionNo>
<DocumentId>string-value</DocumentId>
<SalesPersonId>string-value</SalesPersonId>
<CashId>string-value</CashId>
<ArticleId>string-value</ArticleId>
<ZNumber>0</ZNumber>
<PriceAlteration>0</PriceAlteration>
<TotalDiscount>0</TotalDiscount>
<BonusDiscount>0</BonusDiscount>
<Discounts>
<!--Zero or more repetitions-->
<Discount>
<Line>string-value</Line>
<Percent>0</Percent>
<Value>0</Value>
<CurrencyISO>string-value</CurrencyISO>
<DiscountReasonId>string-value</DiscountReasonId>
</Discount>
</Discounts>
</CustomerPurchaseHistory>
</CustomerPurchaseHistoryEntries>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</CustomerPurchaseHistoryResponse>
</soapenv:Envelope>Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetEmployees>
<ns:request>
<ns:ID>string-value</ns:ID>
<!--Optional-->
<ns:ChangedSinceDate>01.01.0001 00:00:00</ns:ChangedSinceDate>
<ns:IterationConstraints>
<ns:BlockSize>0</ns:BlockSize>
<ns:BlockIndex>0</ns:BlockIndex>
<ns:IterationId>string-value</ns:IterationId>
</ns:IterationConstraints>
</ns:request>
</ns:GetEmployees>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<EmployeeResponse>
<Employees>
<!--Zero or more repetitions-->
<Employee>
<Description>string-value</Description>
<Password>string-value</Password>
<IsSalesPerson>False</IsSalesPerson>
<IsFormerEmployee>False</IsFormerEmployee>
<Person>
<LanguageISO>string-value</LanguageISO>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<!--Optional-->
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Title>string-value</Title>
<Position>string-value</Position>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Person>
<CommunicationData>
<!--Zero or more repetitions-->
<CommunicationMechanism>
<CommunicationType />
<CommunicationValue>string-value</CommunicationValue>
<AdvertisingAllowed>False</AdvertisingAllowed>
<!--Optional-->
<ValidFrom>01.01.0001 00:00:00</ValidFrom>
<!--Optional-->
<ValidTo>01.01.0001 00:00:00</ValidTo>
</CommunicationMechanism>
</CommunicationData>
<PostalAddresses>
<!--Zero or more repetitions-->
<PostalAddress>
<AddressType />
<!--Optional-->
<Description>string-value</Description>
<Street>string-value</Street>
<StreetNumber>string-value</StreetNumber>
<BuildingNumber>string-value</BuildingNumber>
<BuildingName>string-value</BuildingName>
<Block>string-value</Block>
<FlatNumber>string-value</FlatNumber>
<Floor>string-value</Floor>
<PostalDistrict>string-value</PostalDistrict>
<Quarter>string-value</Quarter>
<Latitude>0</Latitude>
<TimeZoneDesignator>string-value</TimeZoneDesignator>
<Longitude>0</Longitude>
<!--Optional-->
<PostBoxNumber>string-value</PostBoxNumber>
<!--Optional-->
<PostBoxZipCode>string-value</PostBoxZipCode>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<County>string-value</County>
<CountryISO>string-value</CountryISO>
<!--Optional-->
<AdditionalRow1>string-value</AdditionalRow1>
<!--Optional-->
<AdditionalRow2>string-value</AdditionalRow2>
<!--Optional-->
<Tag>string-value</Tag>
<!--Optional-->
<IsCorrespondenceAddress>False</IsCorrespondenceAddress>
<Oid>string-value</Oid>
</PostalAddress>
</PostalAddresses>
<BankAccount>
<AccountNumber>string-value</AccountNumber>
<BankCode>string-value</BankCode>
<BankName>string-value</BankName>
<IBAN>string-value</IBAN>
<BIC>string-value</BIC>
</BankAccount>
<ChangedAt>01.01.0001 00:00:00</ChangedAt>
<CustomerReference>
<ID>string-value</ID>
<Oid>string-value</Oid>
</CustomerReference>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Employee>
</Employees>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</EmployeeResponse>
</soapenv:Envelope>|
Note
|
The method provides all discount reasons known in the system or a discount reason identified by its ID, provided it is available in the backend. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetDiscountReasons>
<ns:request>
<ns:ID>string-value</ns:ID>
</ns:request>
</ns:GetDiscountReasons>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<DiscountReasonResponse>
<DiscountReasons>
<!--Zero or more repetitions-->
<DiscountReason>
<Description>string-value</Description>
<ID>string-value</ID>
<Oid>string-value</Oid>
</DiscountReason>
</DiscountReasons>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</DiscountReasonResponse>
</soapenv:Envelope>|
Note
|
The method provides a limited number of delivery note data and an iterator on the total amount of data, which is determined by a particular parametrisation. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetDeliveryNotes>
<ns:request>
<ns:DeliveryNoteId>string-value</ns:DeliveryNoteId>
<ns:OrderId>string-value</ns:OrderId>
<ns:BranchId>string-value</ns:BranchId>
<ns:ShopId>string-value</ns:ShopId>
<ns:ShopCustomerId>string-value</ns:ShopCustomerId>
<ns:CustomerId>string-value</ns:CustomerId>
<ns:ChangedSinceDate>01.01.0001 00:00:00</ns:ChangedSinceDate>
<ns:IterationConstraints>
<ns:BlockSize>0</ns:BlockSize>
<ns:BlockIndex>0</ns:BlockIndex>
<ns:IterationId>string-value</ns:IterationId>
</ns:IterationConstraints>
</ns:request>
</ns:GetDeliveryNotes>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<DeliveryNoteResponse>
<DeliveryNotes>
<!--Zero or more repetitions-->
<DeliveryNote>
<OrderId>string-value</OrderId>
<LastChange>01.01.0001 00:00:00</LastChange>
<BranchId>string-value</BranchId>
<ShopId>string-value</ShopId>
<CustomerId>string-value</CustomerId>
<ShopCustomerId>string-value</ShopCustomerId>
<DeliveryNoteType />
<Originator>string-value</Originator>
<Recipient>string-value</Recipient>
<DeliveryNoteTimestamp>01.01.0001 00:00:00</DeliveryNoteTimestamp>
<DeliveryNotePositions>
<!--Zero or more repetitions-->
<DeliveryNotePosition>
<PositionNo>string-value</PositionNo>
<EAN>string-value</EAN>
<Quantity>0</Quantity>
<BranchId>string-value</BranchId>
<Price>0</Price>
</DeliveryNotePosition>
</DeliveryNotePositions>
<ID>string-value</ID>
<Oid>string-value</Oid>
</DeliveryNote>
</DeliveryNotes>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</DeliveryNoteResponse>
</soapenv:Envelope>|
Note
|
The method provides a limited number of invoicei> data and an iterator on the total amount of data, which is determined by a particular parametrisation. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetInvoices>
<ns:request>
<ns:InvoiceId>string-value</ns:InvoiceId>
<ns:ShopId>string-value</ns:ShopId>
<ns:ShopCustomerId>string-value</ns:ShopCustomerId>
<ns:CustomerId>string-value</ns:CustomerId>
<ns:ChangedSinceDate>01.01.0001 00:00:00</ns:ChangedSinceDate>
<ns:IterationConstraints>
<ns:BlockSize>0</ns:BlockSize>
<ns:BlockIndex>0</ns:BlockIndex>
<ns:IterationId>string-value</ns:IterationId>
</ns:IterationConstraints>
</ns:request>
</ns:GetInvoices>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<InvoiceResponse>
<Invoices>
<!--Zero or more repetitions-->
<Invoice>
<DeliveryNoteId>string-value</DeliveryNoteId>
<LastChange>01.01.0001 00:00:00</LastChange>
<ShopId>string-value</ShopId>
<CustomerId>string-value</CustomerId>
<ShopCustomerId>string-value</ShopCustomerId>
<InvoiceTimestamp>01.01.0001 00:00:00</InvoiceTimestamp>
<InvoicePositions>
<!--Zero or more repetitions-->
<InvoicePosition>
<PositionNo>string-value</PositionNo>
<EAN>string-value</EAN>
<Quantity>0</Quantity>
<BranchId>string-value</BranchId>
<Price>0</Price>
</InvoicePosition>
</InvoicePositions>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Invoice>
</Invoices>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</InvoiceResponse>
</soapenv:Envelope>|
Note
|
The method allows the transfer of new delivery note data to the Futura4Retail ERP backend. Prerequisite for the successful saving of a delivery note is a customer order that has a minimum status of Accepted, i.e. an explicit order release in the backend is required. The structure of the data for a request is derived from the schema definitions of the ECS WSDL. The SOAP response contains, apart from the TaskStatus, a mapping of the saved delivery note data as payload or no payload in case of failure. (Semantic) description beyond schema definition of individual request items that must take into account client implementations: |
Parameter
Name |
Description |
Type |
request |
Futura4ECS.Contracts.GoodsInAdvice.GetGoodsInAdvices.GetGoodsInAdvicesRequest |
|
<returns> |
Futura4ECS.Contracts.GoodsInAdvice.GetGoodsInAdvices.GetGoodsInAdviceResponse |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetGoodsInAdvices>
<ns:request>
<!--Optional-->
<ns:DocumentId>string-value</ns:DocumentId>
<!--Optional-->
<ns:BranchId>0</ns:BranchId>
<!--Optional-->
<ns:SupplierId>0</ns:SupplierId>
<!--Optional-->
<ns:ChangedSinceDate>01.01.0001 00:00:00</ns:ChangedSinceDate>
<ns:IterationConstraints>
<ns:BlockSize>0</ns:BlockSize>
<ns:BlockIndex>0</ns:BlockIndex>
<ns:IterationId>string-value</ns:IterationId>
</ns:IterationConstraints>
</ns:request>
</ns:GetGoodsInAdvices>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<GetGoodsInAdviceResponse>
<GoodsInAdvices>
<!--Zero or more repetitions-->
<GoodsInAdvice>
<ID>string-value</ID>
<DeliveryNoteId>string-value</DeliveryNoteId>
<DocumentId>string-value</DocumentId>
<Originator>string-value</Originator>
<Recipient>string-value</Recipient>
<DeliveryNoteTimestamp>01.01.0001 00:00:00</DeliveryNoteTimestamp>
<AdviceDetails>
<!--Zero or more repetitions-->
<GoodsInAdviceDetail>
<Position>0</Position>
<EAN>string-value</EAN>
<CheckedQuantity>0</CheckedQuantity>
<ExpectedQuantity>0</ExpectedQuantity>
</GoodsInAdviceDetail>
</AdviceDetails>
<Description>string-value</Description>
<!--Optional-->
<Status>string-value</Status>
<CheckedQuantity>0</CheckedQuantity>
<ExpectedQuantity>0</ExpectedQuantity>
</GoodsInAdvice>
</GoodsInAdvices>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</GetGoodsInAdviceResponse>
</soapenv:Envelope>Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:SendGoodsInAdviceConfirmation>
<ns:request>
<ns:DeliveryNoteId>string-value</ns:DeliveryNoteId>
<ns:DocumentId>string-value</ns:DocumentId>
<ns:Originator>string-value</ns:Originator>
<ns:Recipient>string-value</ns:Recipient>
<ns:DeliveryNoteTimestamp>01.01.0001 00:00:00</ns:DeliveryNoteTimestamp>
<ns:Description>string-value</ns:Description>
<ns:AdviceDetails>
<!--Zero or more repetitions-->
<ns:GoodsInAdviceDetailRequest>
<ns:Position>0</ns:Position>
<ns:EAN>string-value</ns:EAN>
<ns:CheckedQuantity>0</ns:CheckedQuantity>
</ns:GoodsInAdviceDetailRequest>
</ns:AdviceDetails>
</ns:request>
</ns:SendGoodsInAdviceConfirmation>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<SendGoodsInAdviceConfirmationResponse>
<GoodsInAdvices>
<!--Zero or more repetitions-->
<GoodsInAdvice>
<ID>string-value</ID>
<DeliveryNoteId>string-value</DeliveryNoteId>
<DocumentId>string-value</DocumentId>
<Originator>string-value</Originator>
<Recipient>string-value</Recipient>
<DeliveryNoteTimestamp>01.01.0001 00:00:00</DeliveryNoteTimestamp>
<AdviceDetails>
<!--Zero or more repetitions-->
<GoodsInAdviceDetail>
<Position>0</Position>
<EAN>string-value</EAN>
<CheckedQuantity>0</CheckedQuantity>
<ExpectedQuantity>0</ExpectedQuantity>
</GoodsInAdviceDetail>
</AdviceDetails>
<Description>string-value</Description>
<!--Optional-->
<Status>string-value</Status>
<CheckedQuantity>0</CheckedQuantity>
<ExpectedQuantity>0</ExpectedQuantity>
</GoodsInAdvice>
</GoodsInAdvices>
<CreationActionSuccess>False</CreationActionSuccess>
<!--Optional-->
<CreationErrorMessages />
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</SendGoodsInAdviceConfirmationResponse>
</soapenv:Envelope>|
Note
|
The method provides all manufacturer colours known in the system or the manufacturer colour identified by its ID. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetManufacturerColours>
<ns:request>
<ns:ManufacturerID>string-value</ns:ManufacturerID>
<ns:ID>string-value</ns:ID>
</ns:request>
</ns:GetManufacturerColours>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<ManufacturerColourResponse>
<ManufacturerColours>
<!--Zero or more repetitions-->
<ManufacturerColour>
<Description>string-value</Description>
<Manufacturer>
<Description>string-value</Description>
<TaxID>string-value</TaxID>
<Contact>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<LanguageISO>string-value</LanguageISO>
<Company>string-value</Company>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<Addresses>
<!--Zero or more repetitions-->
<Address>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Address>
</Addresses>
<AddressType>string-value</AddressType>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Contact>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Manufacturer>
<SystemColour>
<Description>string-value</Description>
<ID>string-value</ID>
<Oid>string-value</Oid>
</SystemColour>
<ID>string-value</ID>
<Oid>string-value</Oid>
</ManufacturerColour>
</ManufacturerColours>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</ManufacturerColourResponse>
</soapenv:Envelope>|
Note
|
The method provides a number of manufacturer or supplier data and an iterator on the total amount of data, determined by corresponding parametrisations. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetManufacturers>
<ns:request>
<ns:ID>string-value</ns:ID>
<ns:IterationConstraints>
<ns:BlockSize>0</ns:BlockSize>
<ns:BlockIndex>0</ns:BlockIndex>
<ns:IterationId>string-value</ns:IterationId>
</ns:IterationConstraints>
</ns:request>
</ns:GetManufacturers>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<ManufacturerResponse>
<Manufacturers>
<!--Zero or more repetitions-->
<Manufacturer>
<Description>string-value</Description>
<TaxID>string-value</TaxID>
<Contact>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<LanguageISO>string-value</LanguageISO>
<Company>string-value</Company>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<Addresses>
<!--Zero or more repetitions-->
<Address>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Address>
</Addresses>
<AddressType>string-value</AddressType>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Contact>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Manufacturer>
</Manufacturers>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</ManufacturerResponse>
</soapenv:Envelope>|
Note
|
The method provides a limited number of order data and an iterator on the total amount of data, which is determined by a particular parametrisation. For the parameters CustomerId, ShopId and ShopCustomerId the following applies: Using the GetOrders method, a link to a shop and therefore a till is established via the ShopId. The tuple of ShopId and ShopCustomerId is used internally foridentifying a CustomerId. An already specified CustomerId in the request filters orders to the appropriate customer. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetOrders>
<ns:request>
<ns:OrderId>string-value</ns:OrderId>
<ns:ShopId>string-value</ns:ShopId>
<ns:ShopCustomerId>string-value</ns:ShopCustomerId>
<ns:CustomerId>string-value</ns:CustomerId>
<!--Optional-->
<ns:ChangedSinceDate>01.01.0001 00:00:00</ns:ChangedSinceDate>
<ns:ResponseDetails />
<ns:IterationConstraints>
<ns:BlockSize>0</ns:BlockSize>
<ns:BlockIndex>0</ns:BlockIndex>
<ns:IterationId>string-value</ns:IterationId>
</ns:IterationConstraints>
</ns:request>
</ns:GetOrders>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<OrderResponse>
<Orders>
<!--Zero or more repetitions-->
<Order>
<OrderStatus />
<DeliveryStatus />
<LastChange>01.01.0001 00:00:00</LastChange>
<BranchId>string-value</BranchId>
<ShopId>string-value</ShopId>
<CustomerId>string-value</CustomerId>
<ShopCustomerId>string-value</ShopCustomerId>
<Comment>string-value</Comment>
<DeliveryAddress>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</DeliveryAddress>
<InvoiceAddress>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</InvoiceAddress>
<OrderPositions>
<!--Zero or more repetitions-->
<OrderPosition>
<EAN>string-value</EAN>
<Quantity>0</Quantity>
<Price>0</Price>
<Discount>0</Discount>
<IsPercentDiscount>False</IsPercentDiscount>
<ArticleId>string-value</ArticleId>
<Size>string-value</Size>
<Color>string-value</Color>
<Oid>string-value</Oid>
</OrderPosition>
</OrderPositions>
<AdditionalCosts>
<!--Zero or more repetitions-->
<AdditionalCost>
<Description>string-value</Description>
<Value>0</Value>
<CurrencyISO>string-value</CurrencyISO>
<AdditionalCostDefinitionId>string-value</AdditionalCostDefinitionId>
<ID>string-value</ID>
<Oid>string-value</Oid>
</AdditionalCost>
</AdditionalCosts>
<OrderStockPositions>
<!--Zero or more repetitions-->
<OrderStockPosition>
<EAN>string-value</EAN>
<LastMove>01.01.0001 00:00:00</LastMove>
<OrderedQuantity>0</OrderedQuantity>
<ReservedQuantity>0</ReservedQuantity>
<QuantityWithoutDeliveryNotes>0</QuantityWithoutDeliveryNotes>
<DeliveryStatus />
</OrderStockPosition>
</OrderStockPositions>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Order>
</Orders>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</OrderResponse>
</soapenv:Envelope>|
Note
|
The method provides a set of inventory information on open orders and an iterator on the total amount of data, which is determined by a particular parametrisation. |
The available parameters are processed analogous to the example below by applying a combination of such parameters, for which an intersection is formed as a result.
Other constraints:
The only order balances that will be delivered are those with at least one entry and those that do not have a CLOSED, CANCELLED or MANUALLY_CLOSED status. Furthermore, order balances that have been delivered in full will be hidden.
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetOpenOrderStock>
<ns:request>
<ns:OrderId>string-value</ns:OrderId>
<ns:ArticleId>string-value</ns:ArticleId>
<ns:EAN>string-value</ns:EAN>
<ns:BranchId>string-value</ns:BranchId>
<!--Optional-->
<ns:ChangedSinceDate>01.01.0001 00:00:00</ns:ChangedSinceDate>
<ns:IterationConstraints>
<ns:BlockSize>0</ns:BlockSize>
<ns:BlockIndex>0</ns:BlockIndex>
<ns:IterationId>string-value</ns:IterationId>
</ns:IterationConstraints>
</ns:request>
</ns:GetOpenOrderStock>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<OrderStockResponse>
<OrderStocks>
<!--Zero or more repetitions-->
<OrderStock>
<OrderId>string-value</OrderId>
<BranchId>string-value</BranchId>
<OrderStatus />
<DeliveryStatus />
<OrderedQuantity>0</OrderedQuantity>
<OrderStockPositions>
<!--Zero or more repetitions-->
<OrderStockPosition>
<EAN>string-value</EAN>
<LastMove>01.01.0001 00:00:00</LastMove>
<OrderedQuantity>0</OrderedQuantity>
<ReservedQuantity>0</ReservedQuantity>
<QuantityWithoutDeliveryNotes>0</QuantityWithoutDeliveryNotes>
<DeliveryStatus />
</OrderStockPosition>
</OrderStockPositions>
</OrderStock>
</OrderStocks>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</OrderStockResponse>
</soapenv:Envelope>|
Note
|
The method provides all languages known in the system or the language identified by its ISO code (LanguageISO), provided it is available in the backend. If it is possible to gather any and especially non-ISO compliant short codes in the backend, the parameter LanguageISO is to be construed accordingly. In an ideal situation all languages with their unique ISO code were captured in the backend. In the Futura4Retail default case it can be expected that country codes without ISO conformity can be single-letter types similar to postal abbreviations. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetLanguages>
<ns:request>
<ns:LanguageISO>string-value</ns:LanguageISO>
</ns:request>
</ns:GetLanguages>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<LanguageResponse>
<Languages>
<!--Zero or more repetitions-->
<Language>
<Description>string-value</Description>
<LanguageISO>string-value</LanguageISO>
<Oid>string-value</Oid>
</Language>
</Languages>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</LanguageResponse>
</soapenv:Envelope>|
Note
|
The method provides all payment types known in the system or the payment type identified by its ID. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetPaymentTypes>
<ns:request>
<ns:CurrencyISO>string-value</ns:CurrencyISO>
<ns:ID>string-value</ns:ID>
</ns:request>
</ns:GetPaymentTypes>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<PaymentTypeResponse>
<PaymentTypes>
<!--Zero or more repetitions-->
<PaymentType>
<CurrencyISO>string-value</CurrencyISO>
<Description>string-value</Description>
<IncomingDirection>string-value</IncomingDirection>
<NoBonus>False</NoBonus>
<NoDrawer>False</NoDrawer>
<NoStandardPayment>False</NoStandardPayment>
<ShowOnReport>False</ShowOnReport>
<PrintOnReport>False</PrintOnReport>
<OnlineMethod>string-value</OnlineMethod>
<OnlinePayment>False</OnlinePayment>
<OnlineType>string-value</OnlineType>
<AccountId>string-value</AccountId>
<SpecialPayment />
<WarningText>string-value</WarningText>
<WarningLimit>0</WarningLimit>
<WarningAction />
<MaximumLimit>0</MaximumLimit>
<MaximumText>string-value</MaximumText>
<GiftVoucherDiscountAccount>string-value</GiftVoucherDiscountAccount>
<DiffAccount>string-value</DiffAccount>
<GiftVoucherDiscVatKey>0</GiftVoucherDiscVatKey>
<OverPaymentMode />
<ReportMode />
<RoundingMode />
<RoundingValue>0</RoundingValue>
<CustomerRequired>False</CustomerRequired>
<SerialNoMode />
<ID>string-value</ID>
<Oid>string-value</Oid>
</PaymentType>
</PaymentTypes>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</PaymentTypeResponse>
</soapenv:Envelope>|
Note
|
The method provides a number of product groups (list & hierarchy) and an iterator on the total amount of data determined by corresponding parametrisations. |
Constraints regarding the handling of product groups:
Product groups can be hierarchically managed in the backend; a particular product group is then identified by the combination of the product group numbers within the hierarchy; the product group 01 for example, has on the first level underneath the main product group 03, the so-called LongNumber 0301. GetProductGroups can map product groups hierarchically or flat using the parameter ReturnHierarchy. For iterations on product groups it is recommended to submit a request for a flat list.
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetProductGroups>
<ns:request>
<ns:ReturnHierarchy>False</ns:ReturnHierarchy>
<ns:LongNumber>string-value</ns:LongNumber>
<ns:IterationConstraints>
<ns:BlockSize>0</ns:BlockSize>
<ns:BlockIndex>0</ns:BlockIndex>
<ns:IterationId>string-value</ns:IterationId>
</ns:IterationConstraints>
</ns:request>
</ns:GetProductGroups>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<ProductGroupResponse>
<ProductGroups>
<!--Zero or more repetitions-->
<ProductGroup>
<Description>string-value</Description>
<ShortDescription>string-value</ShortDescription>
<Number>0</Number>
<VatTypeId>0</VatTypeId>
<ParentID>string-value</ParentID>
<IsLeaf>False</IsLeaf>
<IsSelectionPermitted>False</IsSelectionPermitted>
<ParentProductGroup />
<ChildProductGroups />
<ID>string-value</ID>
<Oid>string-value</Oid>
</ProductGroup>
</ProductGroups>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</ProductGroupResponse>
</soapenv:Envelope>|
Note
|
The method provides all salutations known in the system or the salutation identified by its description. The description text is the only semantic key known in the backend, so that the use of salutations is limited to the use of this description text. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetSalutations>
<ns:request>
<ns:Description>string-value</ns:Description>
</ns:request>
</ns:GetSalutations>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<SalutationResponse>
<Salutations>
<!--Zero or more repetitions-->
<Salutation>
<CompleteSalutation>string-value</CompleteSalutation>
<Description>string-value</Description>
<Sex>string-value</Sex>
<Oid>string-value</Oid>
</Salutation>
</Salutations>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</SalutationResponse>
</soapenv:Envelope>|
Note
|
The method provides all shops known in the system and the connected tills (BookingPlaces) or the shop identified by its ID. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetShops>
<ns:request>
<ns:ID>string-value</ns:ID>
</ns:request>
</ns:GetShops>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<ShopResponse>
<Shops>
<!--Zero or more repetitions-->
<Shop>
<ShopName>string-value</ShopName>
<ShopBookingPlace>
<Name>string-value</Name>
<ID>string-value</ID>
<Oid>string-value</Oid>
</ShopBookingPlace>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Shop>
</Shops>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</ShopResponse>
</soapenv:Envelope>|
Note
|
The method provides all sizes known in the system or the size identified by its ID. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetSizes>
<ns:request>
<ns:ID>string-value</ns:ID>
</ns:request>
</ns:GetSizes>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<SizeResponse>
<Sizes>
<!--Zero or more repetitions-->
<Size>
<Description>string-value</Description>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Size>
</Sizes>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</SizeResponse>
</soapenv:Envelope>|
Note
|
The method provides all size runs known in the system or the size run identified by its ID. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetSizeRanges>
<ns:request>
<ns:ID>string-value</ns:ID>
</ns:request>
</ns:GetSizeRanges>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<SizeRangeResponse>
<SizeRanges>
<!--Zero or more repetitions-->
<SizeRange>
<Description>string-value</Description>
<Sizes>
<!--Zero or more repetitions-->
<Size>
<Description>string-value</Description>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Size>
</Sizes>
<ID>string-value</ID>
<Oid>string-value</Oid>
</SizeRange>
</SizeRanges>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</SizeRangeResponse>
</soapenv:Envelope>|
Note
|
Inventory data are read only, inventory changes are exclusively performed via backend business processes. The method provides a limited number of inventory information on an item or an iterator on the total amount of data that is determined by a particular parametrisation. Constraints for the request variations: |
Requests for which the service may identify a small amount of data (item ID and/or EAN filter) will always provide synchronic live inventories. Requests for which the service is not able to make any assumptions about the cardinality of the amount of data, must pass through an iteration; here a live image of the key values? of the requested inventory data is generated at first, and then offered to the client for a paged request. While the key values ?from the image are enhanced by the actual inventory data, the values valid at that time are determined in turn. This procedure is based on the internally used mechanism for dealing with mass data.
Attention: A request with the smallest possible payload (EAN stock) is relatively fast (if one neglects the offset for the internally generated persistence context), and will on the client side probably entice to generous concurrency settings, which under a sufficiently high load on the service will currently lead to reaching the limits of the internally used framework for accessing Futura4Retail data; client implementations should therefore observe these system limits and respond to performance issues accordingly (dynamically).
Thanks to the parametrisability of requests and Futura4Retail Services, some borderline situations may be bypassed if necessary: For example, the need for rapid replication of the inventory data to a large amount of EANs can have the consequence that a lot of queries on the client code are sent to the service, possibly even massively parallel. In this case it would be possible to reduce the number of requests significantly by compressing the item ID to the respective EANs; the corresponding routines on the client may probably save computing time by this, too.
Further improvements will be made in the evolution of ECS with a more message-based approach via message broker, the description of which is not a part of this specification.
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetStocks>
<ns:request>
<ns:ArticleId>string-value</ns:ArticleId>
<ns:EAN>string-value</ns:EAN>
<ns:BranchId>string-value</ns:BranchId>
<ns:ChangedSinceDate>01.01.0001 00:00:00</ns:ChangedSinceDate>
<ns:IterationConstraints>
<ns:BlockSize>0</ns:BlockSize>
<ns:BlockIndex>0</ns:BlockIndex>
<ns:IterationId>string-value</ns:IterationId>
</ns:IterationConstraints>
</ns:request>
</ns:GetStocks>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<StockResponse>
<Stocks>
<!--Zero or more repetitions-->
<StockInfo>
<BranchId>string-value</BranchId>
<ArticleId>string-value</ArticleId>
<EAN>string-value</EAN>
<Price>0</Price>
<Stock>0</Stock>
<ReservedStock>0</ReservedStock>
<LastMove>01.01.0001 00:00:00</LastMove>
</StockInfo>
</Stocks>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</StockResponse>
</soapenv:Envelope>|
Note
|
The method provides inventory data for the given Artikel::Oid primary key. Produces an empty result or a response with the same domain object (StockInfo) as used in GetStocks. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:FindStockByArticleOid>
<ns:request>
<!--Optional-->
<ns:ArticleOid>string-value</ns:ArticleOid>
</ns:request>
</ns:FindStockByArticleOid>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<FindStockResponse>
<Stocks>
<!--Zero or more repetitions-->
<StockInfo>
<BranchId>string-value</BranchId>
<ArticleId>string-value</ArticleId>
<EAN>string-value</EAN>
<Price>0</Price>
<Stock>0</Stock>
<ReservedStock>0</ReservedStock>
<LastMove>01.01.0001 00:00:00</LastMove>
</StockInfo>
</Stocks>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</FindStockResponse>
</soapenv:Envelope>|
Note
|
The method provides inventory data for the given Artikel::Ean::Oid primary key. Produces an empty result or a reduced response (filtered for given Ean::Oid) with the same domain object (StockInfo) as used in GetStocks. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:FindStockByEanOid>
<ns:request>
<!--Optional-->
<ns:EANOid>string-value</ns:EANOid>
</ns:request>
</ns:FindStockByEanOid>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<FindStockResponse>
<Stocks>
<!--Zero or more repetitions-->
<StockInfo>
<BranchId>string-value</BranchId>
<ArticleId>string-value</ArticleId>
<EAN>string-value</EAN>
<Price>0</Price>
<Stock>0</Stock>
<ReservedStock>0</ReservedStock>
<LastMove>01.01.0001 00:00:00</LastMove>
</StockInfo>
</Stocks>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</FindStockResponse>
</soapenv:Envelope>Parameter
Name |
Description |
Type |
request |
Futura4ECS.Contracts.StockCorrection.SendStockCorrectionRequest |
|
<returns> |
Futura4ECS.Contracts.StockCorrection.SendStockCorrectionResponse |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:SendStockCorrection>
<ns:request>
<ns:Date>01.01.0001 00:00:00</ns:Date>
<ns:BranchId>string-value</ns:BranchId>
<ns:IsAbsQty>False</ns:IsAbsQty>
<!--Optional-->
<ns:ReasonText>string-value</ns:ReasonText>
<ns:Corrections>
<!--Zero or more repetitions-->
<ns:SendStockCorrectionDetailRequest>
<ns:ScanCodeId>string-value</ns:ScanCodeId>
<ns:Qty>0</ns:Qty>
<!--Optional-->
<ns:IsAbsQty>False</ns:IsAbsQty>
<!--Optional-->
<ns:ReasonText>string-value</ns:ReasonText>
</ns:SendStockCorrectionDetailRequest>
</ns:Corrections>
</ns:request>
</ns:SendStockCorrection>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<SendStockCorrectionResponse>
<CreationActionSuccess>False</CreationActionSuccess>
<!--Optional-->
<CreationErrorMessages />
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</SendStockCorrectionResponse>
</soapenv:Envelope>|
Note
|
The method provides all system colours known in the system or the system colour identified by its ID. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetSystemColours>
<ns:request>
<ns:ID>string-value</ns:ID>
</ns:request>
</ns:GetSystemColours>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<SystemColourResponse>
<SystemColours>
<!--Zero or more repetitions-->
<SystemColour>
<Description>string-value</Description>
<ID>string-value</ID>
<Oid>string-value</Oid>
</SystemColour>
</SystemColours>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</SystemColourResponse>
</soapenv:Envelope>|
Note
|
The method provides all VAT data known in the system or the VAT data record identified by its ID. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetVats>
<ns:request>
<ns:ID>string-value</ns:ID>
</ns:request>
</ns:GetVats>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<VatResponse>
<Vats>
<!--Zero or more repetitions-->
<Vat>
<Description>string-value</Description>
<vatTypeId>0</vatTypeId>
<VatConfigurationId>0</VatConfigurationId>
<VatPercent>0</VatPercent>
<ValidFrom>01.01.0001 00:00:00</ValidFrom>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Vat>
</Vats>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</VatResponse>
</soapenv:Envelope>|
Note
|
The method provides a limited number of voucher data and an iterator on the total amount of data that is determined by a particular parametrisation. |
For the parameters CustomerId, ShopId and ShopCustomerId the following applies:
A voucher does not have any shop reference internally, but requires a Till und einen Customer. The ShopID is used internally to identify a CashId (till). The tuple of ShopId and ShopCustomerId is used internally to identify a CustomerId (customer). A CustomerId already specified in the request, filters vouchers to the appropriate customer.
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetVouchers>
<ns:request>
<ns:ID>string-value</ns:ID>
<ns:BranchId>string-value</ns:BranchId>
<ns:ShopId>string-value</ns:ShopId>
<ns:ShopCustomerId>string-value</ns:ShopCustomerId>
<ns:CustomerId>string-value</ns:CustomerId>
<ns:ScanCode>string-value</ns:ScanCode>
<ns:Redeemed>False</ns:Redeemed>
<ns:ChangedSinceDate>01.01.0001 00:00:00</ns:ChangedSinceDate>
<ns:IterationConstraints>
<ns:BlockSize>0</ns:BlockSize>
<ns:BlockIndex>0</ns:BlockIndex>
<ns:IterationId>string-value</ns:IterationId>
</ns:IterationConstraints>
</ns:request>
</ns:GetVouchers>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<VoucherResponse>
<Vouchers>
<!--Zero or more repetitions-->
<Voucher>
<VoucherType />
<ScanCode>string-value</ScanCode>
<Amount>0</Amount>
<Remainder>0</Remainder>
<CurrencyISO>string-value</CurrencyISO>
<ValidFrom>01.01.0001 00:00:00</ValidFrom>
<ExpirationDate>01.01.0001 00:00:00</ExpirationDate>
<RedeemDate>01.01.0001 00:00:00</RedeemDate>
<SalesDate>01.01.0001 00:00:00</SalesDate>
<LastChange>01.01.0001 00:00:00</LastChange>
<BranchId>string-value</BranchId>
<ShopId>string-value</ShopId>
<CustomerId>string-value</CustomerId>
<ShopCustomerId>string-value</ShopCustomerId>
<Info>string-value</Info>
<IsRedeemed>False</IsRedeemed>
<IsDeleted>False</IsDeleted>
<IsPrinted>False</IsPrinted>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Voucher>
</Vouchers>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</VoucherResponse>
</soapenv:Envelope>|
Note
|
The method provides a number of deleted objects and an iterator on the total amount of data determined by corresponding parametrisations. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Represents the response, which containes a collection of requested DeletedObjectReferences and also a StatusMessage. |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetDeletedObjectsIterated>
<ns:request>
<ns:ChangedSinceDate>01.01.0001 00:00:00</ns:ChangedSinceDate>
<!--Optional-->
<ns:RecordId>string-value</ns:RecordId>
<ns:IterationConstraints>
<ns:BlockSize>0</ns:BlockSize>
<ns:BlockIndex>0</ns:BlockIndex>
<ns:IterationId>string-value</ns:IterationId>
</ns:IterationConstraints>
</ns:request>
</ns:GetDeletedObjectsIterated>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<DeletedObjectsIterationResponse>
<StatusMessage>string-value</StatusMessage>
<!--Optional-->
<DeletedObjectReferences>
<!--Zero or more repetitions-->
<DeletedObjectReference>
<!--Optional-->
<BusinessKey>string-value</BusinessKey>
<ObjectType>string-value</ObjectType>
<DeleteType>string-value</DeleteType>
<ExternalRecordId>string-value</ExternalRecordId>
<DeleteDate>01.01.0001 00:00:00</DeleteDate>
<NewId>string-value</NewId>
<OldId>string-value</OldId>
<ID>string-value</ID>
<Oid>string-value</Oid>
</DeletedObjectReference>
</DeletedObjectReferences>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</DeletedObjectsIterationResponse>
</soapenv:Envelope>|
Note
|
The method searches for the deleted object by the given ExternalRecordId and RecordId. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:CheckDeletedObject>
<ns:request>
<ns:ExternalRecordId>string-value</ns:ExternalRecordId>
<ns:RecordId>string-value</ns:RecordId>
<ns:FLTPAToken>string-value</ns:FLTPAToken>
</ns:request>
</ns:CheckDeletedObject>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<CheckDeletedObjectResponse>
<IsDeleted>
<System.Boolean />
</IsDeleted>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</CheckDeletedObjectResponse>
</soapenv:Envelope>|
Note
|
The method allows the transfer of a new or updated customer record to the Futura4Retail ERP backend. The structure of the data for a request is derived from the schema definitions of the ECS WSDL. The SOAP response contains, apart from the TaskStatus, a mapping of the saved customer record as payload or no payload in case of failure. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:SendCustomer>
<ns:request>
<ns:ShopId>string-value</ns:ShopId>
<ns:ShopCustomerId>string-value</ns:ShopCustomerId>
<ns:CustomerId>string-value</ns:CustomerId>
<!--Optional-->
<ns:CreationDate>01.01.0001 00:00:00</ns:CreationDate>
<ns:Description>string-value</ns:Description>
<ns:DefaultCurrencyISO>string-value</ns:DefaultCurrencyISO>
<!--Optional-->
<ns:DefaultPaymentTypeId>string-value</ns:DefaultPaymentTypeId>
<ns:Person>
<ns:LanguageISO>string-value</ns:LanguageISO>
<ns:SalutationDescription>string-value</ns:SalutationDescription>
<ns:LastName>string-value</ns:LastName>
<ns:FirstName>string-value</ns:FirstName>
<!--Optional-->
<ns:MiddleName>string-value</ns:MiddleName>
<ns:Company>string-value</ns:Company>
<ns:Title>string-value</ns:Title>
<ns:Position>string-value</ns:Position>
<ns:DateOfBirth>01.01.0001 00:00:00</ns:DateOfBirth>
<ns:Comment>string-value</ns:Comment>
<ns:Gender />
<ns:ID>string-value</ns:ID>
<ns:Oid>string-value</ns:Oid>
</ns:Person>
<!--Optional-->
<ns:CommunicationData>
<!--Zero or more repetitions-->
<ns:CommunicationMechanism>
<ns:CommunicationType />
<ns:CommunicationValue>string-value</ns:CommunicationValue>
<ns:AdvertisingAllowed>False</ns:AdvertisingAllowed>
<!--Optional-->
<ns:ValidFrom>01.01.0001 00:00:00</ns:ValidFrom>
<!--Optional-->
<ns:ValidTo>01.01.0001 00:00:00</ns:ValidTo>
</ns:CommunicationMechanism>
</ns:CommunicationData>
<ns:PostalAddresses>
<!--Zero or more repetitions-->
<ns:PostalAddress>
<ns:AddressType />
<!--Optional-->
<ns:Description>string-value</ns:Description>
<ns:Street>string-value</ns:Street>
<ns:StreetNumber>string-value</ns:StreetNumber>
<ns:BuildingNumber>string-value</ns:BuildingNumber>
<ns:BuildingName>string-value</ns:BuildingName>
<ns:Block>string-value</ns:Block>
<ns:FlatNumber>string-value</ns:FlatNumber>
<ns:Floor>string-value</ns:Floor>
<ns:PostalDistrict>string-value</ns:PostalDistrict>
<ns:Quarter>string-value</ns:Quarter>
<ns:Latitude>0</ns:Latitude>
<ns:TimeZoneDesignator>string-value</ns:TimeZoneDesignator>
<ns:Longitude>0</ns:Longitude>
<!--Optional-->
<ns:PostBoxNumber>string-value</ns:PostBoxNumber>
<!--Optional-->
<ns:PostBoxZipCode>string-value</ns:PostBoxZipCode>
<ns:ZipCode>string-value</ns:ZipCode>
<ns:City>string-value</ns:City>
<!--Optional-->
<ns:Region>string-value</ns:Region>
<ns:County>string-value</ns:County>
<ns:CountryISO>string-value</ns:CountryISO>
<!--Optional-->
<ns:AdditionalRow1>string-value</ns:AdditionalRow1>
<!--Optional-->
<ns:AdditionalRow2>string-value</ns:AdditionalRow2>
<!--Optional-->
<ns:Tag>string-value</ns:Tag>
<!--Optional-->
<ns:IsCorrespondenceAddress>False</ns:IsCorrespondenceAddress>
<ns:Oid>string-value</ns:Oid>
</ns:PostalAddress>
</ns:PostalAddresses>
<!--Optional-->
<ns:BankAccounts>
<!--Zero or more repetitions-->
<ns:BankAccount>
<ns:AccountNumber>string-value</ns:AccountNumber>
<ns:BankCode>string-value</ns:BankCode>
<ns:BankName>string-value</ns:BankName>
<ns:IBAN>string-value</ns:IBAN>
<ns:BIC>string-value</ns:BIC>
</ns:BankAccount>
</ns:BankAccounts>
<!--Optional-->
<ns:CustomerCards>
<!--Zero or more repetitions-->
<ns:CustomerCard>
<ns:Blocked>False</ns:Blocked>
<!--Optional-->
<ns:IssueDate>01.01.0001 00:00:00</ns:IssueDate>
<ns:ExpirationDate>01.01.0001 00:00:00</ns:ExpirationDate>
<ns:CustomerId>string-value</ns:CustomerId>
<ns:CustomerCardType />
<!--Optional-->
<ns:CardVerificationCode>string-value</ns:CardVerificationCode>
<ns:ID>string-value</ns:ID>
<ns:Oid>string-value</ns:Oid>
</ns:CustomerCard>
</ns:CustomerCards>
<ns:StandardDiscount>0</ns:StandardDiscount>
<ns:IsReseller>
<ns:System.Boolean />
</ns:IsReseller>
<ns:WithoutVAT>
<ns:System.Boolean />
</ns:WithoutVAT>
<ns:AdvertisingAllowed>
<ns:System.Boolean />
</ns:AdvertisingAllowed>
<ns:Blocked>
<ns:System.Boolean />
</ns:Blocked>
<ns:BlockedSinceDate>01.01.0001 00:00:00</ns:BlockedSinceDate>
<ns:HomeBranchId>string-value</ns:HomeBranchId>
<ns:CreatedByEmployee>string-value</ns:CreatedByEmployee>
<ns:CreatedAtPos>string-value</ns:CreatedAtPos>
<ns:BonusPoints>
<ns:System.Int32 />
</ns:BonusPoints>
<ns:BonusSaleReduced>
<ns:System.Decimal />
</ns:BonusSaleReduced>
<ns:BonusSaleRegular>
<ns:System.Decimal />
</ns:BonusSaleRegular>
<ns:ParentId>string-value</ns:ParentId>
<ns:Characteristics>
<!--Zero or more repetitions-->
<ns:SendCustomerCharacteristic>
<ns:ID>0</ns:ID>
<ns:Fraction>
<ns:System.Decimal />
</ns:Fraction>
</ns:SendCustomerCharacteristic>
</ns:Characteristics>
<ns:PreferredCommunication>string-value</ns:PreferredCommunication>
<ns:VATId>string-value</ns:VATId>
</ns:request>
</ns:SendCustomer>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<SendCustomerResponse>
<Customer>
<ShopId>string-value</ShopId>
<ShopCustomerId>string-value</ShopCustomerId>
<Description>string-value</Description>
<CreationDate>01.01.0001 00:00:00</CreationDate>
<ChangedAt>01.01.0001 00:00:00</ChangedAt>
<DefaultCurrencyISO>string-value</DefaultCurrencyISO>
<DefaultPaymentTypeId>string-value</DefaultPaymentTypeId>
<Person>
<LanguageISO>string-value</LanguageISO>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<!--Optional-->
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Title>string-value</Title>
<Position>string-value</Position>
<DateOfBirth>01.01.0001 00:00:00</DateOfBirth>
<Comment>string-value</Comment>
<Gender />
<ID>string-value</ID>
<Oid>string-value</Oid>
</Person>
<CommunicationData>
<!--Zero or more repetitions-->
<CommunicationMechanism>
<CommunicationType />
<CommunicationValue>string-value</CommunicationValue>
<AdvertisingAllowed>False</AdvertisingAllowed>
<!--Optional-->
<ValidFrom>01.01.0001 00:00:00</ValidFrom>
<!--Optional-->
<ValidTo>01.01.0001 00:00:00</ValidTo>
</CommunicationMechanism>
</CommunicationData>
<PostalAddresses>
<!--Zero or more repetitions-->
<PostalAddress>
<AddressType />
<!--Optional-->
<Description>string-value</Description>
<Street>string-value</Street>
<StreetNumber>string-value</StreetNumber>
<BuildingNumber>string-value</BuildingNumber>
<BuildingName>string-value</BuildingName>
<Block>string-value</Block>
<FlatNumber>string-value</FlatNumber>
<Floor>string-value</Floor>
<PostalDistrict>string-value</PostalDistrict>
<Quarter>string-value</Quarter>
<Latitude>0</Latitude>
<TimeZoneDesignator>string-value</TimeZoneDesignator>
<Longitude>0</Longitude>
<!--Optional-->
<PostBoxNumber>string-value</PostBoxNumber>
<!--Optional-->
<PostBoxZipCode>string-value</PostBoxZipCode>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<County>string-value</County>
<CountryISO>string-value</CountryISO>
<!--Optional-->
<AdditionalRow1>string-value</AdditionalRow1>
<!--Optional-->
<AdditionalRow2>string-value</AdditionalRow2>
<!--Optional-->
<Tag>string-value</Tag>
<!--Optional-->
<IsCorrespondenceAddress>False</IsCorrespondenceAddress>
<Oid>string-value</Oid>
</PostalAddress>
</PostalAddresses>
<BankAccounts>
<!--Zero or more repetitions-->
<BankAccount>
<AccountNumber>string-value</AccountNumber>
<BankCode>string-value</BankCode>
<BankName>string-value</BankName>
<IBAN>string-value</IBAN>
<BIC>string-value</BIC>
</BankAccount>
</BankAccounts>
<CustomerCards>
<!--Zero or more repetitions-->
<CustomerCard>
<Blocked>False</Blocked>
<!--Optional-->
<IssueDate>01.01.0001 00:00:00</IssueDate>
<ExpirationDate>01.01.0001 00:00:00</ExpirationDate>
<CustomerId>string-value</CustomerId>
<CustomerCardType />
<!--Optional-->
<CardVerificationCode>string-value</CardVerificationCode>
<ID>string-value</ID>
<Oid>string-value</Oid>
</CustomerCard>
</CustomerCards>
<StandardDiscount>0</StandardDiscount>
<IsReseller>False</IsReseller>
<WithoutVAT>False</WithoutVAT>
<AdvertisingAllowed>False</AdvertisingAllowed>
<Blocked>False</Blocked>
<BlockedSinceDate>01.01.0001 00:00:00</BlockedSinceDate>
<HomeBranchId>string-value</HomeBranchId>
<CreatedByEmployee>string-value</CreatedByEmployee>
<CreatedAtPos>string-value</CreatedAtPos>
<BonusPoints>0</BonusPoints>
<BonusSaleReduced>0</BonusSaleReduced>
<BonusSaleRegular>0</BonusSaleRegular>
<ParentId>string-value</ParentId>
<Characteristics>
<!--Zero or more repetitions-->
<Characteristic>
<ID>0</ID>
<Description>string-value</Description>
<Fraction>0</Fraction>
<Type>
<ID>0</ID>
<Description>string-value</Description>
<Oid>string-value</Oid>
</Type>
<ExpiryDate>01.01.0001 00:00:00</ExpiryDate>
<DaysLeft>
<System.Int32 />
</DaysLeft>
<Oid>string-value</Oid>
</Characteristic>
</Characteristics>
<PreferredCommunication>string-value</PreferredCommunication>
<VATId>string-value</VATId>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Customer>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</SendCustomerResponse>
</soapenv:Envelope>|
Note
|
The method allows the transfer of new delivery note data to the Futura4Retail ERP backend. Prerequisite for the successful saving of a delivery note is a customer order that has a minimum status of Accepted, i.e. an explicit order release in the backend is required. The structure of the data for a request is derived from the schema definitions of the ECS WSDL. The SOAP response contains, apart from the TaskStatus, a mapping of the saved delivery note data as payload or no payload in case of failure. (Semantic) description beyond schema definition of individual request items that must take into account client implementations. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:SendDeliveryNotes>
<ns:request>
<ns:DeliveryNoteId>string-value</ns:DeliveryNoteId>
<ns:OrderId>string-value</ns:OrderId>
<ns:ShopId>string-value</ns:ShopId>
<ns:ShopCustomerId>string-value</ns:ShopCustomerId>
<ns:CustomerId>string-value</ns:CustomerId>
<ns:DeliveryNoteTimestamp>01.01.0001 00:00:00</ns:DeliveryNoteTimestamp>
<ns:DeliveryNotePositions>
<!--Zero or more repetitions-->
<ns:DeliveryNotePosition>
<ns:PositionNo>string-value</ns:PositionNo>
<ns:EAN>string-value</ns:EAN>
<ns:Quantity>0</ns:Quantity>
<ns:BranchId>string-value</ns:BranchId>
<ns:Price>0</ns:Price>
</ns:DeliveryNotePosition>
</ns:DeliveryNotePositions>
</ns:request>
</ns:SendDeliveryNotes>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<SendDeliveryNoteResponse>
<Deliverynote>
<OrderId>string-value</OrderId>
<LastChange>01.01.0001 00:00:00</LastChange>
<BranchId>string-value</BranchId>
<ShopId>string-value</ShopId>
<CustomerId>string-value</CustomerId>
<ShopCustomerId>string-value</ShopCustomerId>
<DeliveryNoteType />
<Originator>string-value</Originator>
<Recipient>string-value</Recipient>
<DeliveryNoteTimestamp>01.01.0001 00:00:00</DeliveryNoteTimestamp>
<DeliveryNotePositions>
<!--Zero or more repetitions-->
<DeliveryNotePosition>
<PositionNo>string-value</PositionNo>
<EAN>string-value</EAN>
<Quantity>0</Quantity>
<BranchId>string-value</BranchId>
<Price>0</Price>
</DeliveryNotePosition>
</DeliveryNotePositions>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Deliverynote>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</SendDeliveryNoteResponse>
</soapenv:Envelope>|
Note
|
The method allows the transfer of new invoice data to the Futura4Retail ERP backend. The structure of the data for a request is derived from the schema definitions of the ECS WSDL. The SOAP response contains, apart from the TaskStatus, a mapping of the saved invoice data as payload or no payload in case of failure. (Semantic) description beyond schema definition of individual request items that must take into account client implementations. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:SendInvoices>
<ns:request>
<ns:InvoiceId>string-value</ns:InvoiceId>
<ns:DeliveryNoteId>string-value</ns:DeliveryNoteId>
<ns:OrderId>string-value</ns:OrderId>
<ns:ShopId>string-value</ns:ShopId>
<ns:ShopCustomerId>string-value</ns:ShopCustomerId>
<ns:CustomerId>string-value</ns:CustomerId>
<ns:InvoiceTimestamp>01.01.0001 00:00:00</ns:InvoiceTimestamp>
<ns:InvoicePositions>
<!--Zero or more repetitions-->
<ns:InvoicePosition>
<ns:PositionNo>string-value</ns:PositionNo>
<ns:EAN>string-value</ns:EAN>
<ns:Quantity>0</ns:Quantity>
<ns:BranchId>string-value</ns:BranchId>
<ns:Price>0</ns:Price>
</ns:InvoicePosition>
</ns:InvoicePositions>
</ns:request>
</ns:SendInvoices>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<SendInvoiceResponse>
<Invoice>
<DeliveryNoteId>string-value</DeliveryNoteId>
<LastChange>01.01.0001 00:00:00</LastChange>
<ShopId>string-value</ShopId>
<CustomerId>string-value</CustomerId>
<ShopCustomerId>string-value</ShopCustomerId>
<InvoiceTimestamp>01.01.0001 00:00:00</InvoiceTimestamp>
<InvoicePositions>
<!--Zero or more repetitions-->
<InvoicePosition>
<PositionNo>string-value</PositionNo>
<EAN>string-value</EAN>
<Quantity>0</Quantity>
<BranchId>string-value</BranchId>
<Price>0</Price>
</InvoicePosition>
</InvoicePositions>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Invoice>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</SendInvoiceResponse>
</soapenv:Envelope>|
Note
|
The method allows the transfer of order data to the Futura4Retail ERP. The structure of the data for a request is derived from the schema definitions of the ECS WSDL. The SOAP response contains, apart from the TaskStatus, a mapping of the saved turnover & return data as payload or no payload in case of failure. (Semantic) description beyond schema definition of individual request items that must take into account client implementations. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:SendOrders>
<ns:request>
<ns:OrderId>string-value</ns:OrderId>
<ns:ShopId>string-value</ns:ShopId>
<ns:ShopCustomerId>string-value</ns:ShopCustomerId>
<ns:CustomerId>string-value</ns:CustomerId>
<ns:DeliveryAddress>
<ns:AddressType>string-value</ns:AddressType>
<ns:Description>string-value</ns:Description>
<ns:AddressText>string-value</ns:AddressText>
<ns:SalutationDescription>string-value</ns:SalutationDescription>
<ns:LastName>string-value</ns:LastName>
<ns:FirstName>string-value</ns:FirstName>
<ns:MiddleName>string-value</ns:MiddleName>
<ns:Company>string-value</ns:Company>
<ns:Street>string-value</ns:Street>
<ns:StreetNo>string-value</ns:StreetNo>
<ns:ZipCode>string-value</ns:ZipCode>
<ns:City>string-value</ns:City>
<!--Optional-->
<ns:Region>string-value</ns:Region>
<ns:Country>string-value</ns:Country>
<ns:Fax>string-value</ns:Fax>
<ns:Phone>string-value</ns:Phone>
<ns:Mobile>string-value</ns:Mobile>
<ns:EMail>string-value</ns:EMail>
<ns:HomePage>string-value</ns:HomePage>
<ns:Position>string-value</ns:Position>
<ns:Title>string-value</ns:Title>
<ns:LanguageISO>string-value</ns:LanguageISO>
<ns:AdditionalRow1>string-value</ns:AdditionalRow1>
<ns:AdditionalRow2>string-value</ns:AdditionalRow2>
<ns:ID>string-value</ns:ID>
<ns:Oid>string-value</ns:Oid>
</ns:DeliveryAddress>
<ns:InvoiceAddress>
<ns:AddressType>string-value</ns:AddressType>
<ns:Description>string-value</ns:Description>
<ns:AddressText>string-value</ns:AddressText>
<ns:SalutationDescription>string-value</ns:SalutationDescription>
<ns:LastName>string-value</ns:LastName>
<ns:FirstName>string-value</ns:FirstName>
<ns:MiddleName>string-value</ns:MiddleName>
<ns:Company>string-value</ns:Company>
<ns:Street>string-value</ns:Street>
<ns:StreetNo>string-value</ns:StreetNo>
<ns:ZipCode>string-value</ns:ZipCode>
<ns:City>string-value</ns:City>
<!--Optional-->
<ns:Region>string-value</ns:Region>
<ns:Country>string-value</ns:Country>
<ns:Fax>string-value</ns:Fax>
<ns:Phone>string-value</ns:Phone>
<ns:Mobile>string-value</ns:Mobile>
<ns:EMail>string-value</ns:EMail>
<ns:HomePage>string-value</ns:HomePage>
<ns:Position>string-value</ns:Position>
<ns:Title>string-value</ns:Title>
<ns:LanguageISO>string-value</ns:LanguageISO>
<ns:AdditionalRow1>string-value</ns:AdditionalRow1>
<ns:AdditionalRow2>string-value</ns:AdditionalRow2>
<ns:ID>string-value</ns:ID>
<ns:Oid>string-value</ns:Oid>
</ns:InvoiceAddress>
<ns:OrderPositions>
<!--Zero or more repetitions-->
<ns:OrderPosition>
<ns:EAN>string-value</ns:EAN>
<ns:Quantity>0</ns:Quantity>
<ns:Price>0</ns:Price>
<ns:Discount>0</ns:Discount>
<ns:IsPercentDiscount>False</ns:IsPercentDiscount>
<ns:ArticleId>string-value</ns:ArticleId>
<ns:Size>string-value</ns:Size>
<ns:Color>string-value</ns:Color>
<ns:Oid>string-value</ns:Oid>
</ns:OrderPosition>
</ns:OrderPositions>
<ns:AdditionalCosts>
<!--Zero or more repetitions-->
<ns:AdditionalCost>
<ns:Description>string-value</ns:Description>
<ns:Value>0</ns:Value>
<ns:CurrencyISO>string-value</ns:CurrencyISO>
<ns:AdditionalCostDefinitionId>string-value</ns:AdditionalCostDefinitionId>
<ns:ID>string-value</ns:ID>
<ns:Oid>string-value</ns:Oid>
</ns:AdditionalCost>
</ns:AdditionalCosts>
<ns:PaymentTypeID>string-value</ns:PaymentTypeID>
<ns:Comment>string-value</ns:Comment>
<ns:MCardId>string-value</ns:MCardId>
</ns:request>
</ns:SendOrders>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<SendOrderResponse>
<Order>
<OrderStatus />
<DeliveryStatus />
<LastChange>01.01.0001 00:00:00</LastChange>
<BranchId>string-value</BranchId>
<ShopId>string-value</ShopId>
<CustomerId>string-value</CustomerId>
<ShopCustomerId>string-value</ShopCustomerId>
<Comment>string-value</Comment>
<DeliveryAddress>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</DeliveryAddress>
<InvoiceAddress>
<AddressType>string-value</AddressType>
<Description>string-value</Description>
<AddressText>string-value</AddressText>
<SalutationDescription>string-value</SalutationDescription>
<LastName>string-value</LastName>
<FirstName>string-value</FirstName>
<MiddleName>string-value</MiddleName>
<Company>string-value</Company>
<Street>string-value</Street>
<StreetNo>string-value</StreetNo>
<ZipCode>string-value</ZipCode>
<City>string-value</City>
<!--Optional-->
<Region>string-value</Region>
<Country>string-value</Country>
<Fax>string-value</Fax>
<Phone>string-value</Phone>
<Mobile>string-value</Mobile>
<EMail>string-value</EMail>
<HomePage>string-value</HomePage>
<Position>string-value</Position>
<Title>string-value</Title>
<LanguageISO>string-value</LanguageISO>
<AdditionalRow1>string-value</AdditionalRow1>
<AdditionalRow2>string-value</AdditionalRow2>
<ID>string-value</ID>
<Oid>string-value</Oid>
</InvoiceAddress>
<OrderPositions>
<!--Zero or more repetitions-->
<OrderPosition>
<EAN>string-value</EAN>
<Quantity>0</Quantity>
<Price>0</Price>
<Discount>0</Discount>
<IsPercentDiscount>False</IsPercentDiscount>
<ArticleId>string-value</ArticleId>
<Size>string-value</Size>
<Color>string-value</Color>
<Oid>string-value</Oid>
</OrderPosition>
</OrderPositions>
<AdditionalCosts>
<!--Zero or more repetitions-->
<AdditionalCost>
<Description>string-value</Description>
<Value>0</Value>
<CurrencyISO>string-value</CurrencyISO>
<AdditionalCostDefinitionId>string-value</AdditionalCostDefinitionId>
<ID>string-value</ID>
<Oid>string-value</Oid>
</AdditionalCost>
</AdditionalCosts>
<OrderStockPositions>
<!--Zero or more repetitions-->
<OrderStockPosition>
<EAN>string-value</EAN>
<LastMove>01.01.0001 00:00:00</LastMove>
<OrderedQuantity>0</OrderedQuantity>
<ReservedQuantity>0</ReservedQuantity>
<QuantityWithoutDeliveryNotes>0</QuantityWithoutDeliveryNotes>
<DeliveryStatus />
</OrderStockPosition>
</OrderStockPositions>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Order>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</SendOrderResponse>
</soapenv:Envelope>|
Note
|
The method allows the transfer of new voucher details to the Futura4Retail ERP backend. By parametrising the request, it is distinguished between creation, redemption, and partial redemption when sending the vouchers. The structure of the data for a request is derived from the schema definitions of the ECS WSDL. The SOAP response contains, apart from the TaskStatus, a mapping of the saved voucher data as payload or no payload in case of failure. |
The basic mandatory fields for each request result from the table below; the following applies in particular:
The fields RedeemDate and Redeemed are required when - also partial - redemptions are made. If the Redeemed field is missing in the request, false will be automatically assumed. If the CurrencyISO field is missing in the request, the system currency will be automatically assumed. The fields ExpirationDate, ValidFrom and SalesDate are always required in the request due to internal processing rules.
For the parameters CustomerId, ShopId and ShopCustomerId the following applies:
A voucher does not have any shop reference internally, but requires a till and a customer. The ShopID is used internally to identify a CashId (till). The tuple of ShopId and ShopCustomerId is used internally to identify a CustomerId (customer). A CustomerId already specified in the request, filters vouchers to the appropriate customer.
The following processing rules apply to the sale, redemption and partial redemption of vouchers:
A SendVoucher-request saves a voucher with ScanCode as key. If a voucher has already been saved under this number, it will not be possible to save it again. A voucher with a unique ScanCode may be sold and redeemed at the same time. An already sold voucher can be redeemed fully or partially in a further SendVoucher request via its ScanCode. If it is redeemed in full, the sales amount will be set as the Amount, Redeemed will be set to true, and a RedeemDate will be used a time stamp for the redemption. If a voucher is only partially redeemed, the utilised partial amount will be set as the Amount instead. Any number of redemptions can be made towards a voucher, until the full amount has been used; if the remaining amount (Remainder) specified in the response is lower than the redemption amount, the SendVoucher request will be rejected.
The following applies to voucher data in relation to the field ReceiptNo:
The receipt number of a voucher has no key character, but serves merely as information in the voucher history. The voucher history can neither be part of a filtering nor part of the response to a voucher. The individual posting processes can be managed using the 4Retail backend.
(Semantic) description beyond schema definition of individual request items that must take into account client implementations.
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:SendVouchers>
<ns:request>
<ns:ReceiptNo>string-value</ns:ReceiptNo>
<ns:ScanCode>string-value</ns:ScanCode>
<ns:VoucherType />
<ns:ShopId>string-value</ns:ShopId>
<ns:ShopCustomerId>string-value</ns:ShopCustomerId>
<ns:CustomerId>string-value</ns:CustomerId>
<ns:Amount>0</ns:Amount>
<ns:CurrencyISO>string-value</ns:CurrencyISO>
<ns:ValidFrom>01.01.0001 00:00:00</ns:ValidFrom>
<ns:ExpirationDate>01.01.0001 00:00:00</ns:ExpirationDate>
<ns:SalesDate>01.01.0001 00:00:00</ns:SalesDate>
<ns:RedeemDate>01.01.0001 00:00:00</ns:RedeemDate>
<ns:Redeemed>False</ns:Redeemed>
<ns:Info>string-value</ns:Info>
</ns:request>
</ns:SendVouchers>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<SendVoucherResponse>
<Voucher>
<VoucherType />
<ScanCode>string-value</ScanCode>
<Amount>0</Amount>
<Remainder>0</Remainder>
<CurrencyISO>string-value</CurrencyISO>
<ValidFrom>01.01.0001 00:00:00</ValidFrom>
<ExpirationDate>01.01.0001 00:00:00</ExpirationDate>
<RedeemDate>01.01.0001 00:00:00</RedeemDate>
<SalesDate>01.01.0001 00:00:00</SalesDate>
<LastChange>01.01.0001 00:00:00</LastChange>
<BranchId>string-value</BranchId>
<ShopId>string-value</ShopId>
<CustomerId>string-value</CustomerId>
<ShopCustomerId>string-value</ShopCustomerId>
<Info>string-value</Info>
<IsRedeemed>False</IsRedeemed>
<IsDeleted>False</IsDeleted>
<IsPrinted>False</IsPrinted>
<ID>string-value</ID>
<Oid>string-value</Oid>
</Voucher>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</SendVoucherResponse>
</soapenv:Envelope>|
Note
|
The method allows the transfer of new turnover & return data in the form of a sales receipt to the Futura4Retail ERP backend. The structure of the data for a request is derived from the schema definitions of the ECS WSDL. The SOAP response contains, apart from the TaskStatus, a mapping of the saved turnover & return data as payload or no payload in case of failure. |
The functional operation is based on the approach to transfer at once several sales entries in the form of a customer receipt or a shopping cart to the backend. This method corresponds to the connection realised for the Futura4 POS in HeadOffice concentrator to the Futura4Retail ERP.
Assigning document numbers and consecutive entry numbers rests on the client system that must provide for uniqueness, as the backend for this application provides no number ranges, and the service must operate in stateless mode. The individual turnovers are processed separately in the target system and are stored by entry; a turnover only becomes unique by combining CashID (and BranchId), receipt number and entry number. Appropriate integrity checks report back a constraint violation in the event of conflict, which the service currently reports back in an unfiltered but categorised way within the TaskStatus.
Other constraints:
For simple sales it is sufficient to use the SalesMode NORMAL. Item, product group and voucher sales are distinguished using LineType. Many entries can be captured with any choice of LineType. Unlimited discounts can be captured for each entry; the description of the discount reason from the set of DiscountReasons is expected in the field DiscountReasonId. The details given in the percent field of a discount are for information purposes only, the discount amount must imperatively be transferred using the absolute value (Value). Any bonus vouchers must be assigned to the entries as discounts with the corresponding DiscountReason. Currently only gift vouchers can be considered for voucher sales (VOUCHER_SALE); they must also exist in the backend. Vouchers can only be sold with this turnover posting, but not created or redeemed. The client must use SendVouchers to transfer redemptions to the backend. For product group sales the product group ID is expected in the ProductGroupId field, otherwise in the EAN field. To display manual price changes, the field PriceAlteration must be set accordingly. Voucher sales must internally be transactionally processed separately from turnovers & returns; thus turnovers & returns will be processed if problems with a voucher sale occur, and the problem will be indexed on the TaskStatus (refer example below). Transferred turnovers are always complete and must not be changed later. Every process initiated by SendSalesReceipt generally produces new turnovers and/or returns, so as to regain a receipt or shopping cart correctly at any time.
Attention: The service is unable to verify the correctness of the information, such as the manual price change (for example, it is impossible to assess whether a price detail of an item is actually correct, intended on the part of the salesperson - or wrong at the time, because general price adjustments might have happened in the meantime, which were not available to the client at the time of the sales posting); it is automatically assumed that the turnover data submitted by the client are correct in content and are based on the data set cached on the client. The client is responsible for ensuring that the correct or desired prices were set. The booking system in the backend will receive the turnovers & returns 'as is' and process them accordingly. The service does not interpret the data content in principle and therefore does not reject any request, provided that the interface contracts were syntactically met.
Parameter
Name |
Description |
Type |
request |
||
<returns> |
@TODO review: former 4POS-WS response format uses array of DeliveryResponseType. DeliveryResponseType has the following content: private int deliveryNoteIdField; private string statusTextField; private ResponseStatus statusField; (public enum ResponseStatus { SUCCESS, ERROR }). |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:SendSalesReceipt>
<ns:request>
<ns:CashId>string-value</ns:CashId>
<ns:CustomerId>string-value</ns:CustomerId>
<ns:ReceiptNumber>0</ns:ReceiptNumber>
<ns:SalesReceiptTimestamp>01.01.0001 00:00:00</ns:SalesReceiptTimestamp>
<ns:ZNumber>0</ns:ZNumber>
<ns:SalesReceiptPositions>
<!--Zero or more repetitions-->
<ns:SalesReceiptPosition>
<ns:Position>0</ns:Position>
<ns:ProductGroupId>string-value</ns:ProductGroupId>
<ns:EAN>string-value</ns:EAN>
<ns:Quantity>0</ns:Quantity>
<ns:Value>0</ns:Value>
<ns:PriceAlteration>0</ns:PriceAlteration>
<ns:CurrencyISO>string-value</ns:CurrencyISO>
<ns:SellerId>string-value</ns:SellerId>
<ns:SerialNumber>string-value</ns:SerialNumber>
<ns:SalesMode />
<ns:LineType />
<ns:Discounts>
<!--Zero or more repetitions-->
<ns:Discount>
<ns:Line>string-value</ns:Line>
<ns:Percent>0</ns:Percent>
<ns:Value>0</ns:Value>
<ns:CurrencyISO>string-value</ns:CurrencyISO>
<ns:DiscountReasonId>string-value</ns:DiscountReasonId>
</ns:Discount>
</ns:Discounts>
<ns:TextInfos>
<!--Zero or more repetitions-->
<ns:TextInfo>
<ns:Key />
<ns:Value>string-value</ns:Value>
</ns:TextInfo>
</ns:TextInfos>
</ns:SalesReceiptPosition>
</ns:SalesReceiptPositions>
</ns:request>
</ns:SendSalesReceipt>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<SalesReceiptResponse>
<SalesReceipts>
<!--Zero or more repetitions-->
<SalesReceipt>
<CashId>string-value</CashId>
<CustomerId>string-value</CustomerId>
<ReceiptNumber>0</ReceiptNumber>
<SalesReceiptTimestamp>01.01.0001 00:00:00</SalesReceiptTimestamp>
<ZNumber>0</ZNumber>
<SalesReceiptPositions>
<!--Zero or more repetitions-->
<SalesReceiptPosition>
<Position>0</Position>
<ProductGroupId>string-value</ProductGroupId>
<EAN>string-value</EAN>
<Quantity>0</Quantity>
<Value>0</Value>
<PriceAlteration>0</PriceAlteration>
<CurrencyISO>string-value</CurrencyISO>
<SellerId>string-value</SellerId>
<SerialNumber>string-value</SerialNumber>
<SalesMode />
<LineType />
<Discounts>
<!--Zero or more repetitions-->
<Discount>
<Line>string-value</Line>
<Percent>0</Percent>
<Value>0</Value>
<CurrencyISO>string-value</CurrencyISO>
<DiscountReasonId>string-value</DiscountReasonId>
</Discount>
</Discounts>
<TextInfos>
<!--Zero or more repetitions-->
<TextInfo>
<Key />
<Value>string-value</Value>
</TextInfo>
</TextInfos>
</SalesReceiptPosition>
</SalesReceiptPositions>
</SalesReceipt>
</SalesReceipts>
<IterationStatus>
<IterationId>string-value</IterationId>
<MaxCount>0</MaxCount>
<Count>0</Count>
<RequestedBlockIndex>0</RequestedBlockIndex>
<RequestedBlockSize>0</RequestedBlockSize>
<IterationInfo>string-value</IterationInfo>
</IterationStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</SalesReceiptResponse>
</soapenv:Envelope>|
Note
|
The method is parameter-free and provides basic information about the current WebService and the addressed internal WCF services (F4R, F4R_Order). In addition to version number, name and storage location, also configuration values may be viewed, such as the refresh interval for inventory data or discontinued service endpoints. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetStatus>
<ns:request />
</ns:GetStatus>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<StatusResponse>
<ServiceStatus>
<ServiceID>string-value</ServiceID>
<ServiceVersion>string-value</ServiceVersion>
<Status />
<Configuration>
<ConfigurationEntries>
<!--Zero or more repetitions-->
<ConfigurationEntry>
<Key>string-value</Key>
<Value>string-value</Value>
</ConfigurationEntry>
</ConfigurationEntries>
</Configuration>
<References>
<!--Zero or more repetitions-->
<ServiceReference>
<ReferenceID>string-value</ReferenceID>
<ReferenceVersion>string-value</ReferenceVersion>
<Status />
<Configuration>
<ConfigurationEntries>
<!--Zero or more repetitions-->
<ConfigurationEntry>
<Key>string-value</Key>
<Value>string-value</Value>
</ConfigurationEntry>
</ConfigurationEntries>
</Configuration>
</ServiceReference>
</References>
<SystemDate>01.01.0001 00:00:00</SystemDate>
<MemoryUsage>0</MemoryUsage>
<ProcessName>string-value</ProcessName>
</ServiceStatus>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</StatusResponse>
</soapenv:Envelope>|
Note
|
The method searches for the inter branch transfer (ibt) with the given DocumentNo and updates the given EAN positions with the actual quantity. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:UpdateIbt>
<ns:request>
<ns:DocumentNo>string-value</ns:DocumentNo>
<ns:IbtDetails>
<!--Zero or more repetitions-->
<ns:UpdateIbtDetailRequest>
<ns:Ean>string-value</ns:Ean>
<ns:ActualQuantity>0</ns:ActualQuantity>
<ns:FLTPAToken>string-value</ns:FLTPAToken>
</ns:UpdateIbtDetailRequest>
</ns:IbtDetails>
<!--Optional-->
<ns:Memo>string-value</ns:Memo>
<ns:FLTPAToken>string-value</ns:FLTPAToken>
</ns:request>
</ns:UpdateIbt>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<UpdateIbtResponse>
<Status />
<StatusMessage>string-value</StatusMessage>
<Ibt>
<Oid>00000000-0000-0000-0000-000000000000</Oid>
<ChangedAt>01.01.0001 00:00:00</ChangedAt>
<CreatedAt>01.01.0001 00:00:00</CreatedAt>
<!--Optional-->
<Description>string-value</Description>
<!--Optional-->
<Memo>string-value</Memo>
<Number>string-value</Number>
<State>string-value</State>
<IsAdvicePossible>False</IsAdvicePossible>
<IsDone>False</IsDone>
<IsOpen>False</IsOpen>
<IsPrinted>False</IsPrinted>
<IsReceiveAdviceRequired>False</IsReceiveAdviceRequired>
<IsReceived>False</IsReceived>
<IsReceivedWithDifference>False</IsReceivedWithDifference>
<IsSent>False</IsSent>
<BranchNoReceiving>0</BranchNoReceiving>
<BranchNoSending>0</BranchNoSending>
<!--Optional-->
<Items>
<!--Zero or more repetitions-->
<InterBranchTransferDetail>
<Oid>00000000-0000-0000-0000-000000000000</Oid>
<DateReceived>01.01.0001 00:00:00</DateReceived>
<DateSent>01.01.0001 00:00:00</DateSent>
<ArticleDesc>string-value</ArticleDesc>
<ArticleNo>string-value</ArticleNo>
<ArticleOid>string-value</ArticleOid>
<Color>string-value</Color>
<Size>string-value</Size>
<State>string-value</State>
<SupplierColor>string-value</SupplierColor>
<SupplierDesc>string-value</SupplierDesc>
<UnitOfMeasure>string-value</UnitOfMeasure>
<EanNo>string-value</EanNo>
<EanOid>string-value</EanOid>
<!--Optional-->
<Memo>string-value</Memo>
<PositionNo>0</PositionNo>
<PosPpSending>0</PosPpSending>
<PosPpReceiving>0</PosPpReceiving>
<PosSpSending>0</PosSpSending>
<PosSpReceiving>0</PosSpReceiving>
<PpReceiving>0</PpReceiving>
<PpSending>0</PpSending>
<SpReceiving>0</SpReceiving>
<SpSending>0</SpSending>
<Quantity>0</Quantity>
<QtyReceived>0</QtyReceived>
<QtySent>0</QtySent>
<BranchNoSending>0</BranchNoSending>
<BranchNoReceiving>0</BranchNoReceiving>
</InterBranchTransferDetail>
</Items>
</Ibt>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</UpdateIbtResponse>
</soapenv:Envelope>|
Note
|
The method searches for the inter branch transfer (ibt) with the given DocumentNo and updates the status of the ibt to received and updates the given EAN positions with the actual quantity. Check method UpdateIbt for request example. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:ReceiveIbt>
<ns:request>
<ns:DocumentNo>string-value</ns:DocumentNo>
<ns:IbtDetails>
<!--Zero or more repetitions-->
<ns:UpdateIbtDetailRequest>
<ns:Ean>string-value</ns:Ean>
<ns:ActualQuantity>0</ns:ActualQuantity>
<ns:FLTPAToken>string-value</ns:FLTPAToken>
</ns:UpdateIbtDetailRequest>
</ns:IbtDetails>
<!--Optional-->
<ns:Memo>string-value</ns:Memo>
<ns:FLTPAToken>string-value</ns:FLTPAToken>
</ns:request>
</ns:ReceiveIbt>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<UpdateIbtResponse>
<Status />
<StatusMessage>string-value</StatusMessage>
<Ibt>
<Oid>00000000-0000-0000-0000-000000000000</Oid>
<ChangedAt>01.01.0001 00:00:00</ChangedAt>
<CreatedAt>01.01.0001 00:00:00</CreatedAt>
<!--Optional-->
<Description>string-value</Description>
<!--Optional-->
<Memo>string-value</Memo>
<Number>string-value</Number>
<State>string-value</State>
<IsAdvicePossible>False</IsAdvicePossible>
<IsDone>False</IsDone>
<IsOpen>False</IsOpen>
<IsPrinted>False</IsPrinted>
<IsReceiveAdviceRequired>False</IsReceiveAdviceRequired>
<IsReceived>False</IsReceived>
<IsReceivedWithDifference>False</IsReceivedWithDifference>
<IsSent>False</IsSent>
<BranchNoReceiving>0</BranchNoReceiving>
<BranchNoSending>0</BranchNoSending>
<!--Optional-->
<Items>
<!--Zero or more repetitions-->
<InterBranchTransferDetail>
<Oid>00000000-0000-0000-0000-000000000000</Oid>
<DateReceived>01.01.0001 00:00:00</DateReceived>
<DateSent>01.01.0001 00:00:00</DateSent>
<ArticleDesc>string-value</ArticleDesc>
<ArticleNo>string-value</ArticleNo>
<ArticleOid>string-value</ArticleOid>
<Color>string-value</Color>
<Size>string-value</Size>
<State>string-value</State>
<SupplierColor>string-value</SupplierColor>
<SupplierDesc>string-value</SupplierDesc>
<UnitOfMeasure>string-value</UnitOfMeasure>
<EanNo>string-value</EanNo>
<EanOid>string-value</EanOid>
<!--Optional-->
<Memo>string-value</Memo>
<PositionNo>0</PositionNo>
<PosPpSending>0</PosPpSending>
<PosPpReceiving>0</PosPpReceiving>
<PosSpSending>0</PosSpSending>
<PosSpReceiving>0</PosSpReceiving>
<PpReceiving>0</PpReceiving>
<PpSending>0</PpSending>
<SpReceiving>0</SpReceiving>
<SpSending>0</SpSending>
<Quantity>0</Quantity>
<QtyReceived>0</QtyReceived>
<QtySent>0</QtySent>
<BranchNoSending>0</BranchNoSending>
<BranchNoReceiving>0</BranchNoReceiving>
</InterBranchTransferDetail>
</Items>
</Ibt>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</UpdateIbtResponse>
</soapenv:Envelope>|
Note
|
The method creates a new inter branch transfer (ibt) with the given SenderNo, ReceiverNo and IBT-Positions (EAN and quantity). |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:CreateIbt>
<ns:request>
<ns:IbtCreationMode />
<!--Optional-->
<ns:IbtAdviceData>
<ns:IbtNo>string-value</ns:IbtNo>
</ns:IbtAdviceData>
<!--Optional-->
<ns:PostCreationAction>
<ns:OnIbtAction />
</ns:PostCreationAction>
<!--Optional-->
<ns:NewIbtNo>string-value</ns:NewIbtNo>
<ns:SenderNo>0</ns:SenderNo>
<ns:ReceiverNo>0</ns:ReceiverNo>
<!--Optional-->
<ns:Memo>string-value</ns:Memo>
<ns:DiscardZeroQuantityDetails>False</ns:DiscardZeroQuantityDetails>
<!--Optional-->
<ns:PositionCreators>
<!--Zero or more repetitions-->
<ns:IbtDetailRequest>
<ns:Qty>0</ns:Qty>
<ns:Ean>string-value</ns:Ean>
<!--Optional-->
<ns:Memo>string-value</ns:Memo>
<ns:FLTPAToken>string-value</ns:FLTPAToken>
</ns:IbtDetailRequest>
</ns:PositionCreators>
<ns:FLTPAToken>string-value</ns:FLTPAToken>
</ns:request>
</ns:CreateIbt>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<IbtCreatorResponse>
<Ibt>
<Oid>00000000-0000-0000-0000-000000000000</Oid>
<ChangedAt>01.01.0001 00:00:00</ChangedAt>
<CreatedAt>01.01.0001 00:00:00</CreatedAt>
<!--Optional-->
<Description>string-value</Description>
<!--Optional-->
<Memo>string-value</Memo>
<Number>string-value</Number>
<State>string-value</State>
<IsAdvicePossible>False</IsAdvicePossible>
<IsDone>False</IsDone>
<IsOpen>False</IsOpen>
<IsPrinted>False</IsPrinted>
<IsReceiveAdviceRequired>False</IsReceiveAdviceRequired>
<IsReceived>False</IsReceived>
<IsReceivedWithDifference>False</IsReceivedWithDifference>
<IsSent>False</IsSent>
<BranchNoReceiving>0</BranchNoReceiving>
<BranchNoSending>0</BranchNoSending>
<!--Optional-->
<Items>
<!--Zero or more repetitions-->
<InterBranchTransferDetail>
<Oid>00000000-0000-0000-0000-000000000000</Oid>
<DateReceived>01.01.0001 00:00:00</DateReceived>
<DateSent>01.01.0001 00:00:00</DateSent>
<ArticleDesc>string-value</ArticleDesc>
<ArticleNo>string-value</ArticleNo>
<ArticleOid>string-value</ArticleOid>
<Color>string-value</Color>
<Size>string-value</Size>
<State>string-value</State>
<SupplierColor>string-value</SupplierColor>
<SupplierDesc>string-value</SupplierDesc>
<UnitOfMeasure>string-value</UnitOfMeasure>
<EanNo>string-value</EanNo>
<EanOid>string-value</EanOid>
<!--Optional-->
<Memo>string-value</Memo>
<PositionNo>0</PositionNo>
<PosPpSending>0</PosPpSending>
<PosPpReceiving>0</PosPpReceiving>
<PosSpSending>0</PosSpSending>
<PosSpReceiving>0</PosSpReceiving>
<PpReceiving>0</PpReceiving>
<PpSending>0</PpSending>
<SpReceiving>0</SpReceiving>
<SpSending>0</SpSending>
<Quantity>0</Quantity>
<QtyReceived>0</QtyReceived>
<QtySent>0</QtySent>
<BranchNoSending>0</BranchNoSending>
<BranchNoReceiving>0</BranchNoReceiving>
</InterBranchTransferDetail>
</Items>
</Ibt>
<PostCreationActionPerformed />
<PostCreationActionSuccess>False</PostCreationActionSuccess>
<!--Optional-->
<PostCreationActionMessage>string-value</PostCreationActionMessage>
<Status />
<StatusMessage>string-value</StatusMessage>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</IbtCreatorResponse>
</soapenv:Envelope>|
Note
|
The method provides a limited number of ibts data. |
Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetIbts>
<ns:request>
<!--Optional-->
<ns:SenderNo>0</ns:SenderNo>
<!--Optional-->
<ns:ReceiverNo>0</ns:ReceiverNo>
<!--Optional-->
<ns:IbtNo>string-value</ns:IbtNo>
<!--Optional-->
<ns:ChangedAt>01.01.0001 00:00:00</ns:ChangedAt>
<ns:IbtStatusesToSelect />
<!--Optional-->
<ns:FLTPAToken>string-value</ns:FLTPAToken>
</ns:request>
</ns:GetIbts>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<GetIbtsResponse>
<StatusMessage>string-value</StatusMessage>
<!--Optional-->
<Ibts>
<!--Zero or more repetitions-->
<InterBranchTransferHead>
<Oid>00000000-0000-0000-0000-000000000000</Oid>
<ChangedAt>01.01.0001 00:00:00</ChangedAt>
<CreatedAt>01.01.0001 00:00:00</CreatedAt>
<!--Optional-->
<Description>string-value</Description>
<!--Optional-->
<Memo>string-value</Memo>
<Number>string-value</Number>
<State>string-value</State>
<IsAdvicePossible>False</IsAdvicePossible>
<IsDone>False</IsDone>
<IsOpen>False</IsOpen>
<IsPrinted>False</IsPrinted>
<IsReceiveAdviceRequired>False</IsReceiveAdviceRequired>
<IsReceived>False</IsReceived>
<IsReceivedWithDifference>False</IsReceivedWithDifference>
<IsSent>False</IsSent>
<BranchNoReceiving>0</BranchNoReceiving>
<BranchNoSending>0</BranchNoSending>
<!--Optional-->
<Items>
<!--Zero or more repetitions-->
<InterBranchTransferDetail>
<Oid>00000000-0000-0000-0000-000000000000</Oid>
<DateReceived>01.01.0001 00:00:00</DateReceived>
<DateSent>01.01.0001 00:00:00</DateSent>
<ArticleDesc>string-value</ArticleDesc>
<ArticleNo>string-value</ArticleNo>
<ArticleOid>string-value</ArticleOid>
<Color>string-value</Color>
<Size>string-value</Size>
<State>string-value</State>
<SupplierColor>string-value</SupplierColor>
<SupplierDesc>string-value</SupplierDesc>
<UnitOfMeasure>string-value</UnitOfMeasure>
<EanNo>string-value</EanNo>
<EanOid>string-value</EanOid>
<!--Optional-->
<Memo>string-value</Memo>
<PositionNo>0</PositionNo>
<PosPpSending>0</PosPpSending>
<PosPpReceiving>0</PosPpReceiving>
<PosSpSending>0</PosSpSending>
<PosSpReceiving>0</PosSpReceiving>
<PpReceiving>0</PpReceiving>
<PpSending>0</PpSending>
<SpReceiving>0</SpReceiving>
<SpSending>0</SpSending>
<Quantity>0</Quantity>
<QtyReceived>0</QtyReceived>
<QtySent>0</QtySent>
<BranchNoSending>0</BranchNoSending>
<BranchNoReceiving>0</BranchNoReceiving>
</InterBranchTransferDetail>
</Items>
</InterBranchTransferHead>
</Ibts>
</GetIbtsResponse>
</soapenv:Envelope>Parameter
Name |
Description |
Type |
request |
||
<returns> |
Request sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns:GetReturnReasons>
<ns:request>
<ns:ID>string-value</ns:ID>
</ns:request>
</ns:GetReturnReasons>
</soapenv:Body>
</soapenv:Envelope>Response sample
<soapenv:Envelope xmlns:ns="http://ws.futura4retail.com/Futura4ECS/2018/02" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<ReturnReasonResponse>
<ReturnReasons>
<!--Zero or more repetitions-->
<ReturnReason>
<Description>string-value</Description>
<BranchID>string-value</BranchID>
<LastReceiptNumber>0</LastReceiptNumber>
<IsActive>False</IsActive>
<ID>string-value</ID>
<Oid>string-value</Oid>
</ReturnReason>
</ReturnReasons>
<TaskStatus>
<ProcessingStatus />
<TaskDuration>0</TaskDuration>
<TaskInfo>string-value</TaskInfo>
<TaskMessages>
<!--Zero or more repetitions-->
<TaskMessage>
<TaskMessageLevel />
<ErrorCode />
<EventKey>string-value</EventKey>
<EventTimestamp>01.01.0001 00:00:00</EventTimestamp>
<RelatedComponent>string-value</RelatedComponent>
<RelatedBehaviour>string-value</RelatedBehaviour>
<Description>string-value</Description>
<ExceptionMessages>
<!--Zero or more repetitions-->
<System.String />
</ExceptionMessages>
</TaskMessage>
</TaskMessages>
<WorkerRecommendation />
<WorkerRecommendationDelaySeconds>0</WorkerRecommendationDelaySeconds>
</TaskStatus>
</ReturnReasonResponse>
</soapenv:Envelope>Custom types
AdditionalCost
Properties
Name |
Description |
Type |
Description |
String |
|
Value |
Decimal |
|
CurrencyISO |
String |
|
AdditionalCostDefinitionId |
String |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
AdditionalCostDefinition
Properties
Name |
Description |
Type |
Description |
String |
|
DefaultValue |
Decimal |
|
CurrencyISO |
String |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
AdditionalCostDefinitionRequest
Properties
Name |
Description |
Type |
ID |
String |
AdditionalCostDefinitionResponse
Properties
Name |
Description |
Type |
AdditionalCostDefinitions |
||
TaskStatus |
Address
Properties
Name |
Description |
Type |
AddressType |
String |
|
Description |
String |
|
AddressText |
String |
|
SalutationDescription |
String |
|
LastName |
String |
|
FirstName |
String |
|
MiddleName |
String |
|
Company |
String |
|
Street |
String |
|
StreetNo |
String |
|
ZipCode |
String |
|
City |
String |
|
Region |
String |
|
Country |
String |
|
Fax |
String |
|
Phone |
String |
|
Mobile |
String |
|
String |
||
HomePage |
String |
|
Position |
String |
|
Title |
String |
|
LanguageISO |
String |
|
AdditionalRow1 |
String |
|
AdditionalRow2 |
String |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
AddressType
Properties
Name |
Description |
Type |
TypeName |
String |
AddressTypeEnum (Enumeration)
Properties
Name |
Value |
Type |
BUSINESS |
0 |
Int32 |
PRIVATE |
1 |
Int32 |
ADDITIONAL |
2 |
Int32 |
VARIOUS |
3 |
Int32 |
BILLING |
4 |
Int32 |
DELIVERY |
5 |
Int32 |
UNDEFINED |
6 |
Int32 |
AddressTypeRequest
Properties
Name |
Description |
Type |
AddressTypeResponse
Properties
Name |
Description |
Type |
AddressTypes |
List [Futura4ECS.AddressType] |
|
TaskStatus |
Article
Properties
Name |
Description |
Type |
Description |
String |
|
LongDescription |
String |
|
InternalNumberI |
String |
|
InternalNumberII |
String |
|
InternalShortDescI |
String |
|
InternalShortDescII |
String |
|
MemoI |
String |
|
MemoII |
String |
|
LastMove |
DateTime |
|
SizeRange |
String |
|
BasePrice |
Decimal |
|
Season |
String |
|
PictureURI |
String |
|
Brand |
String |
|
ProductGroup |
||
Manufacturer |
||
Appearances |
List [Futura4ECS.Branch] |
|
ColorEanPrices |
List [Futura4ECS.ColorEanPrices] |
|
Characteristics |
List [Futura4ECS.Characteristic] |
|
UnrealisticPrice |
Decimal |
|
IsNOS |
Boolean |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
ArticleRequest
Properties
Name |
Description |
Type |
RequestPriority |
Futura4ECS.ArticleRequestPriority (Enumeration) |
|
ArticleId |
String |
|
EAN |
String |
|
PriceBranchId |
String |
|
ResponseDetails |
Futura4ECS.ArticleResponseDetails (Enumeration) |
|
ChangedSinceDate |
DateTime |
|
IterationConstraints |
Represents the set of constraints the required backend iteration and expected number of objects in the reponse. If not set or one constraint parameter is not set, default values will be set. |
ArticleRequestPriority (Enumeration)
Properties
Name |
Value |
Type |
PRIORITY_ID_FILTER |
0 |
Int32 |
PRIORITY_CHANGED_SINCE_DATE |
1 |
Int32 |
ArticleResponse
Properties
Name |
Description |
Type |
Articles |
List [Futura4ECS.Article] |
|
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
ArticleResponseDetails (Enumeration)
Properties
Name |
Value |
Type |
ARTICLE_BASE |
0 |
Int32 |
INCLUDE_BRANCH_INFO |
1 |
Int32 |
PRICES_ONLY |
2 |
Int32 |
CHARACTERISTICS |
3 |
Int32 |
BankAccount
Properties
Name |
Description |
Type |
AccountNumber |
String |
|
BankCode |
String |
|
BankName |
String |
|
IBAN |
String |
|
BIC |
String |
BookingPlace
Properties
Name |
Description |
Type |
Name |
String |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
Branch
Properties
Name |
Description |
Type |
Description |
String |
|
Contact |
||
VatConfigurationId |
Int32 |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
BranchPrice
Properties
Name |
Description |
Type |
BranchId |
String |
|
Price |
Decimal |
|
UnrealisticPrice |
Decimal |
BranchRequest
Properties
Name |
Description |
Type |
ID |
String |
|
IterationConstraints |
Represents the set of constraints the required backend iteration and expected number of objects in the reponse. If not set or one constraint parameter is not set, default values will be set. |
BranchResponse
Properties
Name |
Description |
Type |
Branches |
List [Futura4ECS.Branch] |
|
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
Brand
Properties
Name |
Description |
Type |
Description |
String |
|
StoreBrand |
Boolean |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
BrandRequest
Properties
Name |
Description |
Type |
ID |
String |
BrandResponse
Properties
Name |
Description |
Type |
Brands |
List [Futura4ECS.Brand] |
|
TaskStatus |
CardType (Enumeration)
Properties
Name |
Value |
Type |
OTHER |
1 |
Int32 |
MASTERCARD |
2 |
Int32 |
VISA |
4 |
Int32 |
AMERICANEXPRESS |
8 |
Int32 |
DINERSCLUB |
16 |
Int32 |
DISCOVER |
32 |
Int32 |
INHOUSE |
64 |
Int32 |
MAESTRODE |
128 |
Int32 |
LOYALTY |
256 |
Int32 |
Characteristic
Properties
Name |
Description |
Type |
ID |
Int32 |
|
Description |
String |
|
Fraction |
Decimal |
|
Type |
||
ExpiryDate |
Gets or sets the expiry date. |
DateTime |
DaysLeft |
Gets or sets the days left. |
Nullable [Int32] |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
CharacteristicKind (Enumeration)
Properties
Name |
Value |
Type |
Article |
0 |
Int32 |
Customer |
1 |
Int32 |
CharacteristicRequest
Properties
Name |
Description |
Type |
ID |
Int32 |
|
IterationConstraints |
Represents the set of constraints the required backend iteration and expected number of objects in the reponse. If not set or one constraint parameter is not set, default values will be set. |
CharacteristicResponse
Properties
Name |
Description |
Type |
Characteristics |
List [Futura4ECS.Characteristic] |
|
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
CharacteristicType
Properties
Name |
Description |
Type |
ID |
Int32 |
|
Description |
String |
|
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
CharacteristicTypeRequest
Properties
Name |
Description |
Type |
ID |
Int32 |
|
Kind |
Futura4ECS.CharacteristicKind (Enumeration) |
CharacteristicTypeResponse
Properties
Name |
Description |
Type |
CharacteristicTypes |
||
TaskStatus |
CheckDeletedObjectRequest
Properties
Name |
Description |
Type |
ExternalRecordId |
The entity’s oid |
String |
RecordId |
As defined in OSD, e.g. BRN, ITM |
String |
ExtensionData |
ExtensionDataObject |
|
FLTPAToken |
String |
CheckDeletedObjectResponse
Properties
Name |
Description |
Type |
IsDeleted |
Nullable [Boolean] |
|
TaskStatus |
ColorEanPrices
Properties
Name |
Description |
Type |
EanPrices |
List [Futura4ECS.EanBranchPrices] |
|
ManufacturerId |
The manufacturer color number |
String |
ManufacturerOid |
The manufacturer color database identifier |
String |
ManufacturerDescription |
String |
|
SystemColorId |
The system color number |
Int32 |
SystemColorOid |
The system color database id |
String |
SystemColorDescription |
String |
CommunicationMechanism
Properties
Name |
Description |
Type |
CommunicationType |
Futura4ECS.CommunicationMechanismType (Enumeration) |
|
CommunicationValue |
String |
|
AdvertisingAllowed |
Boolean |
|
ValidFrom |
DateTime |
|
ValidTo |
DateTime |
CommunicationMechanismType (Enumeration)
Properties
Name |
Value |
Type |
PHONE |
0 |
Int32 |
MOBILE |
1 |
Int32 |
FAX |
2 |
Int32 |
HOMEPAGE |
3 |
Int32 |
4 |
Int32 |
ComponentConfiguration
Properties
Name |
Description |
Type |
ConfigurationEntries |
ComponentStatus (Enumeration)
Properties
Name |
Value |
Type |
DOWN |
0 |
Int32 |
STARTING_UP |
1 |
Int32 |
RUNNING |
2 |
Int32 |
SHUTTING_DOWN |
3 |
Int32 |
ERROR |
4 |
Int32 |
NONE |
5 |
Int32 |
ConfigurationEntry
Properties
Name |
Description |
Type |
Key |
String |
|
Value |
String |
Country
Properties
Name |
Description |
Type |
Description |
String |
|
CountryISO |
String |
|
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
CountryRequest
Properties
Name |
Description |
Type |
CountryISO |
String |
CountryResponse
Properties
Name |
Description |
Type |
Countries |
List [Futura4ECS.Country] |
|
TaskStatus |
CreationStatus (Enumeration)
Properties
Name |
Value |
Type |
Success |
0 |
Int32 |
Error |
1 |
Int32 |
None |
2 |
Int32 |
PartlyError |
3 |
Int32 |
Currency
Properties
Name |
Description |
Type |
CurrencyISO |
String |
|
Description |
String |
|
RoundingMode |
Futura4ECS.RoundingMode (Enumeration) |
|
RoundingValue |
Double |
|
PrintingSymbol |
String |
|
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
CurrencyRequest
Properties
Name |
Description |
Type |
CurrencyISO |
String |
CurrencyResponse
Properties
Name |
Description |
Type |
Currency |
List [Futura4ECS.Currency] |
|
TaskStatus |
Customer
Properties
Name |
Description |
Type |
ShopId |
ECS-specific |
String |
ShopCustomerId |
ECS-specific |
String |
Description |
ECS-V13 specific |
String |
CreationDate |
ECS-V13: only commented: //private DateTime creationDateField; |
DateTime |
ChangedAt |
ECS-V13: only commented: //private DateTime changedAtField; |
DateTime |
DefaultCurrencyISO |
String |
|
DefaultPaymentTypeId |
ECS-V13: concrete type: public PaymentType DefaultPaymentType { get; set; } |
String |
Person |
ECS-V13: person-elements in top-level customer contract; person object only commented: //private Person field_personField; Covers ECS-V13 Customer fields: public string Language { get; set; } public DateTime DateOfBirth { get; set; } public string Salutation { get; set; } public string LastName { get; set; } public string FirstName { get; set; } public string MiddleName { get; set; } public string Title { get; set; } public string Company { get; set; } 4POS ContractConverter GetPerson: Comment = serviceItem.Notice, // alternate: serviceItem.Info public string Note { get; set; } public string Info { get; set; } |
|
CommunicationData |
Covers ECS-V13 Customer fields: public string Phone { get; set; } public string Fax { get; set; } public string Mobile { get; set; } public string EMail { get; set; } public string Homepage { get; set; } |
|
PostalAddresses |
Covers ECS-V13 Customer fields: public string Street { get; set; } public string StreetNo { get; set; } public string PostBoxNumber { get; set; } public string PostBoxZipCode { get; set; } public string ZipCode { get; set; } public string City { get; set; } public string Country { get; set; } public string AdditionalAddressLine1 { get; set; } public string AdditionalAddressLine2 { get; set; } |
List [Futura4ECS.PostalAddress] |
BankAccounts |
ECS-V13: only commented: //private BankAccount field_bankAccountField; |
List [Futura4ECS.BankAccount] |
CustomerCards |
List [Futura4ECS.CustomerCard] |
|
StandardDiscount |
ECS-V13: only commented: //private double standardDiscountField; |
Decimal |
IsReseller |
Boolean |
|
WithoutVAT |
Boolean |
|
AdvertisingAllowed |
ECS-V13: !NoAdvertising |
Boolean |
Blocked |
Boolean |
|
BlockedSinceDate |
DateTime |
|
HomeBranchId |
String |
|
CreatedByEmployee |
String |
|
CreatedAtPos |
String |
|
BonusPoints |
Int32 |
|
BonusSaleReduced |
Decimal |
|
BonusSaleRegular |
Decimal |
|
ParentId |
String |
|
Characteristics |
List [Futura4ECS.Characteristic] |
|
PreferredCommunication |
String |
|
VATId |
String |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
CustomerCard
Properties
Name |
Description |
Type |
Blocked |
Boolean |
|
IssueDate |
DateTime |
|
ExpirationDate |
DateTime |
|
CustomerId |
String |
|
CustomerCardType |
Futura4ECS.CardType (Enumeration) |
|
CardVerificationCode |
String |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
CustomerPurchaseHistory
Properties
Name |
Description |
Type |
CustomerId |
String |
|
TransactionTimestamp |
DateTime |
|
ReceiptText |
String |
|
BranchId |
String |
|
ProductGroupId |
String |
|
EAN |
String |
|
SerialNo |
String |
|
Price |
Decimal |
|
Quantity |
Decimal |
|
HistoryReceiptType |
Futura4ECS.HistoryReceiptType (Enumeration) |
|
LineType |
Futura4ECS.LineType (Enumeration) |
|
ReceiptNo |
Int32 |
|
PositionNo |
Int32 |
|
DocumentId |
maps Umsatz.UmsatzId or Retoure.RetoureId |
String |
SalesPersonId |
String |
|
CashId |
String |
|
ArticleId |
String |
|
ZNumber |
Int32 |
|
PriceAlteration |
Decimal |
|
TotalDiscount |
Decimal |
|
BonusDiscount |
Decimal |
|
Discounts |
List [Futura4ECS.Discount] |
CustomerPurchaseHistoryRequest
Properties
Name |
Description |
Type |
CustomerId |
String |
|
DateFrom |
DateTime |
|
DateTo |
DateTime |
|
IterationConstraints |
Represents the set of constraints the required backend iteration and expected number of objects in the reponse. If not set or one constraint parameter is not set, default values will be set. |
CustomerPurchaseHistoryResponse
Properties
Name |
Description |
Type |
CustomerPurchaseHistoryEntries |
||
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
CustomerReference
Properties
Name |
Description |
Type |
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
CustomerRequest
Properties
Name |
Description |
Type |
ShopId |
String |
|
ShopCustomerId |
String |
|
CustomerId |
4POS:WS: ID |
String |
FilterLockedCustomers |
Boolean |
|
ChangedSinceDate |
DateTime |
|
WithCharacteristics |
Gets or sets a value indicating whether the customer response contains characteristics. |
Nullable [Boolean] |
IterationConstraints |
Represents the set of constraints the required backend iteration and expected number of objects in the reponse. If not set or one constraint parameter is not set, default values will be set. |
CustomerResponse
Properties
Name |
Description |
Type |
Customers |
List [Futura4ECS.Customer] |
|
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
DeletedObjectReference
Properties
Name |
Description |
Type |
BusinessKey |
e.g CustomerNo, EAN |
String |
ObjectType |
As defined in OSD, e.g. BRN, ITM |
String |
DeleteType |
DELETE or INACTIVE |
String |
ExternalRecordId |
The entity’s oid |
String |
DeleteDate |
DateTime |
|
NewId |
String |
|
OldId |
String |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
DeletedObjectsIterationRequest
Properties
Name |
Description |
Type |
ChangedSinceDate |
DateTime |
|
RecordId |
As defined in OSD, e.g. BRN, ITM |
String |
IterationConstraints |
Represents the set of constraints the required backend iteration and expected number of objects in the reponse. If not set or one constraint parameter is not set, default values will be set. |
DeletedObjectsIterationResponse
Properties
Name |
Description |
Type |
StatusMessage |
String |
|
DeletedObjectReferences |
||
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
DeliveryNote
Properties
Name |
Description |
Type |
OrderId |
String |
|
LastChange |
DateTime |
|
BranchId |
String |
|
ShopId |
String |
|
CustomerId |
String |
|
ShopCustomerId |
String |
|
DeliveryNoteType |
Futura4ECS.DeliveryNoteType (Enumeration) |
|
Originator |
String |
|
Recipient |
String |
|
DeliveryNoteTimestamp |
DateTime |
|
DeliveryNotePositions |
||
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
DeliveryNotePosition
Properties
Name |
Description |
Type |
PositionNo |
String |
|
EAN |
String |
|
Quantity |
Decimal |
|
BranchId |
String |
|
Price |
Decimal |
DeliveryNoteRequest
Properties
Name |
Description |
Type |
DeliveryNoteId |
String |
|
OrderId |
String |
|
BranchId |
String |
|
ShopId |
String |
|
ShopCustomerId |
String |
|
CustomerId |
String |
|
ChangedSinceDate |
DateTime |
|
IterationConstraints |
Represents the set of constraints the required backend iteration and expected number of objects in the reponse. If not set or one constraint parameter is not set, default values will be set. |
DeliveryNoteResponse
Properties
Name |
Description |
Type |
DeliveryNotes |
List [Futura4ECS.DeliveryNote] |
|
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
DeliveryNoteType (Enumeration)
Properties
Name |
Value |
Type |
SUPPLIER_GOODS_IN |
0 |
Int32 |
DeliveryStatus (Enumeration)
Properties
Name |
Value |
Type |
Normal |
0 |
Int32 |
Open |
1 |
Int32 |
Delivered |
2 |
Int32 |
PartlyDelivered |
3 |
Int32 |
Discount
Properties
Name |
Description |
Type |
Line |
String |
|
Percent |
Decimal |
|
Value |
Decimal |
|
CurrencyISO |
@TODO review: new field (currency for Value). |
String |
DiscountReasonId |
String |
DiscountReason
Properties
Name |
Description |
Type |
Description |
String |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
DiscountReasonRequest
Properties
Name |
Description |
Type |
ID |
String |
DiscountReasonResponse
Properties
Name |
Description |
Type |
DiscountReasons |
List [Futura4ECS.DiscountReason] |
|
TaskStatus |
EanBranchPrices
Properties
Name |
Description |
Type |
BranchPrices |
List [Futura4ECS.BranchPrice] |
|
ScanCodes |
List [Futura4ECS.ScanCode] |
|
EAN |
String |
|
Oid |
MED-9580/REQ-214 |
String |
Size |
String |
|
Color |
The manufacturer color description |
String |
ColorID |
The manufacturer color number |
String |
ColorOid |
The manufacturer color database identifier |
String |
SystemColor |
The system color description |
String |
SystemColorId |
The system color number |
String |
SystemColorOid |
The system color database identifier |
String |
SuggestedPrice |
Decimal |
|
UnrealisticPrice |
Decimal |
|
IsNOS |
Boolean |
|
EanCharacteristics |
Ean Ausprägung |
List [Futura4ECS.Characteristic] |
Employee
Properties
Name |
Description |
Type |
Description |
String |
|
Password |
String |
|
IsSalesPerson |
Boolean |
|
IsFormerEmployee |
Boolean |
|
Person |
||
CommunicationData |
||
PostalAddresses |
List [Futura4ECS.PostalAddress] |
|
BankAccount |
||
ChangedAt |
DateTime |
|
CustomerReference |
FAS-706 Customer reference (Oid/ID). |
|
OrgMemberId |
String |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
EmployeeRequest
Properties
Name |
Description |
Type |
ID |
String |
|
ChangedSinceDate |
DateTime |
|
IterationConstraints |
Represents the set of constraints the required backend iteration and expected number of objects in the reponse. If not set or one constraint parameter is not set, default values will be set. |
EmployeeResponse
Properties
Name |
Description |
Type |
Employees |
List [Futura4ECS.Employee] |
|
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
FindArticleByEanRequest
Properties
Name |
Description |
Type |
EANOid |
String |
FindArticleRequest
Properties
Name |
Description |
Type |
ArticleOid |
String |
FindArticleResponse
Properties
Name |
Description |
Type |
Article |
||
TaskStatus |
FindCustomerRequest
Properties
Name |
Description |
Type |
CustomerOid |
String |
FindCustomerResponse
Properties
Name |
Description |
Type |
Customer |
||
TaskStatus |
FindStockByArticleOidRequest
Properties
Name |
Description |
Type |
ArticleOid |
String |
FindStockByEanOidRequest
Properties
Name |
Description |
Type |
EANOid |
String |
FindStockResponse
Properties
Name |
Description |
Type |
Stocks |
List [Futura4ECS.StockInfo] |
|
TaskStatus |
Gender (Enumeration)
Properties
Name |
Value |
Type |
Undefined |
0 |
Int32 |
Female |
1 |
Int32 |
Male |
2 |
Int32 |
Company |
3 |
Int32 |
Family |
4 |
Int32 |
GenderType (Enumeration)
Properties
Name |
Value |
Type |
UNKNOWN |
0 |
Int32 |
FEMALE |
1 |
Int32 |
MALE |
2 |
Int32 |
COMPANY |
3 |
Int32 |
FAMILY |
4 |
Int32 |
GetGoodsInAdviceResponse
Properties
Name |
Description |
Type |
GoodsInAdvices |
||
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
GetGoodsInAdvicesRequest
Properties
Name |
Description |
Type |
DocumentId |
String |
|
BranchId |
Int32 |
|
SupplierId |
Int32 |
|
ChangedSinceDate |
DateTime |
|
IterationConstraints |
Represents the set of constraints the required backend iteration and expected number of objects in the reponse. If not set or one constraint parameter is not set, default values will be set. |
GetIbtsRequest
Properties
Name |
Description |
Type |
SenderNo |
Int32 |
|
ReceiverNo |
Int32 |
|
IbtNo |
String |
|
ChangedAt |
DateTime |
|
IbtStatusesToSelect |
Futura4ECS.Contracts.Ibt.Enums+IbtStatusesToSelect (Enumeration) |
|
FLTPAToken |
String |
GetIbtsResponse
Properties
Name |
Description |
Type |
StatusMessage |
String |
|
Ibts |
GoodsInAdvice
Properties
Name |
Description |
Type |
ID |
String |
|
DeliveryNoteId |
String |
|
DocumentId |
The document id of rweavisierungskopf, Avisierungskopf |
String |
Originator |
String |
|
Recipient |
String |
|
DeliveryNoteTimestamp |
DateTime |
|
AdviceDetails |
List [Futura4ECS.Contracts.GoodsInAdvice.GoodsInAdviceDetail] |
|
Description |
String |
|
Status |
String |
|
CheckedQuantity |
Decimal |
|
ExpectedQuantity |
Decimal |
GoodsInAdviceDetail
Properties
Name |
Description |
Type |
Position |
Int32 |
|
EAN |
String |
|
CheckedQuantity |
Represents the counted quantity of a delivery note position. Supplier said via EDI or another pre-process 'pants' in color 'blue' size 'L' will be delivered 10 times. On delivery validation, employee or system counts 5 instead of 10. The 5 goes into this field. |
Decimal |
ExpectedQuantity |
Represents the expected quantity of a delivery note position. Supplier said via EDI or another pre-process 'pants' in color 'blue' size 'L' will be delivered 10 times. The 10 goes into this field. |
Decimal |
GoodsInAdviceDetailRequest
Properties
Name |
Description |
Type |
Position |
Int32 |
|
EAN |
String |
|
CheckedQuantity |
Represents the counted quantity of a delivery note position. Supplier said via EDI or another pre-process 'pants' in color 'blue' size 'L' will be delivered 10 times. On delivery validation, employee or system counts 5 instead of 10. The 5 goes into this field. |
Decimal |
HistoryReceiptType (Enumeration)
Properties
Name |
Value |
Type |
UNKNOWN |
0 |
Int32 |
DELIVERYNOTE |
1 |
Int32 |
POS |
2 |
Int32 |
SELECTION |
3 |
Int32 |
LAYAWAY |
4 |
Int32 |
VOUCHER |
5 |
Int32 |
IbtAdviceData
Properties
Name |
Description |
Type |
IbtNo |
String |
IbtCreationMode (Enumeration)
Properties
Name |
Value |
Type |
NoAdviceReference |
0 |
Int32 |
UseAdviceDetails |
1 |
Int32 |
IbtCreatorRequest
Properties
Name |
Description |
Type |
IbtCreationMode |
Futura4ECS.Contracts.Ibt.Enums+IbtCreationMode (Enumeration) |
|
IbtAdviceData |
||
PostCreationAction |
||
NewIbtNo |
String |
|
SenderNo |
Int32 |
|
ReceiverNo |
Int32 |
|
Memo |
String |
|
DiscardZeroQuantityDetails |
Boolean |
|
PositionCreators |
||
FLTPAToken |
String |
IbtCreatorResponse
Properties
Name |
Description |
Type |
Ibt |
||
PostCreationActionPerformed |
Futura4ECS.Contracts.Ibt.Enums+OnIbtAction (Enumeration) |
|
PostCreationActionSuccess |
Boolean |
|
PostCreationActionMessage |
String |
|
Status |
Represent a value, describing the status of corresponding process. It has the values Success, Error, None. |
Futura4ECS.Contracts.Enums+CreationStatus (Enumeration) |
StatusMessage |
Represent a string, reporting the error, if the process fails. Also some information will be returned, if some changes or automatic steps are in effect. Example: Some operation needs a customer. If the customer is not provided or could not be found, the default customer will be used and reported in the message. |
String |
TaskStatus |
IbtDetailRequest
Properties
Name |
Description |
Type |
Qty |
Decimal |
|
Ean |
String |
|
Memo |
String |
|
FLTPAToken |
String |
IbtStatusesToSelect (Enumeration)
Properties
Name |
Value |
Type |
Any |
0 |
Int32 |
Closed |
1 |
Int32 |
Open |
2 |
Int32 |
InterBranchTransferDetail
Properties
Name |
Description |
Type |
Oid |
Guid |
|
DateReceived |
DateTime |
|
DateSent |
DateTime |
|
ArticleDesc |
String |
|
ArticleNo |
String |
|
ArticleOid |
String |
|
Color |
String |
|
Size |
String |
|
State |
String |
|
SupplierColor |
String |
|
SupplierDesc |
String |
|
UnitOfMeasure |
String |
|
EanNo |
String |
|
EanOid |
String |
|
Memo |
String |
|
PositionNo |
Int32 |
|
PosPpSending |
Decimal |
|
PosPpReceiving |
Decimal |
|
PosSpSending |
Decimal |
|
PosSpReceiving |
Decimal |
|
PpReceiving |
Decimal |
|
PpSending |
Decimal |
|
SpReceiving |
Decimal |
|
SpSending |
Decimal |
|
Quantity |
Decimal |
|
QtyReceived |
Decimal |
|
QtySent |
Decimal |
|
BranchNoSending |
Int32 |
|
BranchNoReceiving |
Int32 |
InterBranchTransferHead
Properties
Name |
Description |
Type |
Oid |
Guid |
|
ChangedAt |
DateTime |
|
CreatedAt |
DateTime |
|
Description |
String |
|
Memo |
String |
|
Number |
String |
|
State |
String |
|
IsAdvicePossible |
Boolean |
|
IsDone |
Boolean |
|
IsOpen |
Boolean |
|
IsPrinted |
Boolean |
|
IsReceiveAdviceRequired |
Boolean |
|
IsReceived |
Boolean |
|
IsReceivedWithDifference |
Boolean |
|
IsSent |
Boolean |
|
BranchNoReceiving |
Int32 |
|
BranchNoSending |
Int32 |
|
Items |
Invoice
Properties
Name |
Description |
Type |
DeliveryNoteId |
String |
|
LastChange |
DateTime |
|
ShopId |
String |
|
CustomerId |
String |
|
ShopCustomerId |
String |
|
InvoiceTimestamp |
DateTime |
|
InvoicePositions |
List [Futura4ECS.InvoicePosition] |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
InvoicePosition
Properties
Name |
Description |
Type |
PositionNo |
String |
|
EAN |
String |
|
Quantity |
Decimal |
|
BranchId |
String |
|
Price |
Decimal |
InvoiceRequest
Properties
Name |
Description |
Type |
InvoiceId |
String |
|
ShopId |
String |
|
ShopCustomerId |
String |
|
CustomerId |
String |
|
ChangedSinceDate |
DateTime |
|
IterationConstraints |
Represents the set of constraints the required backend iteration and expected number of objects in the reponse. If not set or one constraint parameter is not set, default values will be set. |
InvoiceResponse
Properties
Name |
Description |
Type |
Invoices |
List [Futura4ECS.Invoice] |
|
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
IterationConstraints
Properties
Name |
Description |
Type |
BlockSize |
This property sets the index of required block (its zero based). |
Int32 |
BlockIndex |
This property sets the size of a block. |
Int32 |
IterationId |
This property sets the value of iteration id, which is to use, wenn iterating through the data. By the first call, if no iteration id is provided, the system generates one and returns it in the corresponding response object. |
String |
IterationStatus
Properties
Name |
Description |
Type |
IterationId |
Represents the iterationId to be used in all subsequent requests. |
String |
MaxCount |
Represents the actual (maximum) number of available objects concerning the request. This value can be used to calculate the block index for subsequent requests. |
Int32 |
Count |
Represents the number of objects in the current response concerning the request. This value can be used to make an inference on parameters for subsequent iteration requests. |
Int32 |
RequestedBlockIndex |
Represents the index number of the current processed page of objects. This value can be used to make an inference on parameters for subsequent iteration requests. |
Int32 |
RequestedBlockSize |
Represents the requested number of objects. This value can be used to make an inference on parameters for subsequent iteration requests. |
Int32 |
IterationInfo |
Represents additional info for this response. |
String |
Language
Properties
Name |
Description |
Type |
Description |
String |
|
LanguageISO |
String |
|
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
LanguageRequest
Properties
Name |
Description |
Type |
LanguageISO |
String |
LanguageResponse
Properties
Name |
Description |
Type |
Languages |
List [Futura4ECS.Language] |
|
TaskStatus |
LineType (Enumeration)
Properties
Name |
Value |
Type |
ITEM_SALE |
0 |
Int32 |
PGR_SALE |
1 |
Int32 |
VOUCHER_SALE |
2 |
Int32 |
UNDEFINED |
3 |
Int32 |
Manufacturer
Properties
Name |
Description |
Type |
Description |
String |
|
TaxID |
String |
|
Contact |
||
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
ManufacturerColour
Properties
Name |
Description |
Type |
Description |
String |
|
Manufacturer |
||
SystemColour |
||
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
ManufacturerColourRequest
Properties
Name |
Description |
Type |
ManufacturerID |
String |
|
ID |
String |
ManufacturerColourResponse
Properties
Name |
Description |
Type |
ManufacturerColours |
||
TaskStatus |
ManufacturerRequest
Properties
Name |
Description |
Type |
ID |
String |
|
IterationConstraints |
Represents the set of constraints the required backend iteration and expected number of objects in the reponse. If not set or one constraint parameter is not set, default values will be set. |
ManufacturerResponse
Properties
Name |
Description |
Type |
Manufacturers |
List [Futura4ECS.Manufacturer] |
|
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
MessageErrorCode (Enumeration)
Properties
Name |
Value |
Type |
OK |
0 |
Int32 |
VALIDATION_ERROR |
1 |
Int32 |
DATA_READ_ERROR |
2 |
Int32 |
DATA_READ_INVALID_CHARACTER |
3 |
Int32 |
DATA_WRITE_ERROR |
4 |
Int32 |
DATA_WRITE_UQ_VIOLATION |
5 |
Int32 |
DATA_WRITE_TX_FAILURE |
6 |
Int32 |
MessageLevel (Enumeration)
Properties
Name |
Value |
Type |
INFO |
0 |
Int32 |
WARN |
1 |
Int32 |
ERROR |
2 |
Int32 |
FATAL |
3 |
Int32 |
OnIbtAction (Enumeration)
Properties
Name |
Value |
Type |
None |
0 |
Int32 |
UpdateIbtCompletelySendingAndReceiving |
1 |
Int32 |
UpdateIbtCompletelySending |
2 |
Int32 |
Order
Properties
Name |
Description |
Type |
OrderStatus |
Futura4ECS.OrderStatus (Enumeration) |
|
DeliveryStatus |
Futura4ECS.DeliveryStatus (Enumeration) |
|
LastChange |
DateTime |
|
BranchId |
String |
|
ShopId |
String |
|
CustomerId |
String |
|
ShopCustomerId |
String |
|
Comment |
String |
|
DeliveryAddress |
||
InvoiceAddress |
||
OrderPositions |
List [Futura4ECS.OrderPosition] |
|
AdditionalCosts |
List [Futura4ECS.AdditionalCost] |
|
OrderStockPositions |
||
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
OrderPosition
Properties
Name |
Description |
Type |
EAN |
String |
|
Quantity |
Decimal |
|
Price |
Decimal |
|
Discount |
Decimal |
|
IsPercentDiscount |
Boolean |
|
ArticleId |
String |
|
Size |
String |
|
Color |
String |
|
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
OrderRequest
Properties
Name |
Description |
Type |
OrderId |
String |
|
ShopId |
String |
|
ShopCustomerId |
String |
|
CustomerId |
String |
|
ChangedSinceDate |
DateTime |
|
ResponseDetails |
Futura4ECS.OrderResponseDetails (Enumeration) |
|
IterationConstraints |
Represents the set of constraints the required backend iteration and expected number of objects in the reponse. If not set or one constraint parameter is not set, default values will be set. |
OrderResponse
Properties
Name |
Description |
Type |
Orders |
List [Futura4ECS.Order] |
|
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
OrderResponseDetails (Enumeration)
Properties
Name |
Value |
Type |
ORDER_BASE |
0 |
Int32 |
INCLUDE_ORDER_STOCKS |
1 |
Int32 |
ORDER_STOCKS_ONLY |
2 |
Int32 |
OrderStatus (Enumeration)
Properties
Name |
Value |
Type |
None |
0 |
Int32 |
Entered |
1 |
Int32 |
Offered |
2 |
Int32 |
Accepted |
3 |
Int32 |
Canceled |
4 |
Int32 |
Closed |
5 |
Int32 |
ManuallyClosed |
6 |
Int32 |
OrderStock
Properties
Name |
Description |
Type |
OrderId |
String |
|
BranchId |
String |
|
OrderStatus |
Futura4ECS.OrderStatus (Enumeration) |
|
DeliveryStatus |
Futura4ECS.DeliveryStatus (Enumeration) |
|
OrderedQuantity |
Decimal |
|
OrderStockPositions |
OrderStockPosition
Properties
Name |
Description |
Type |
EAN |
String |
|
LastMove |
DateTime |
|
OrderedQuantity |
Decimal |
|
ReservedQuantity |
Decimal |
|
QuantityWithoutDeliveryNotes |
Decimal |
|
DeliveryStatus |
Futura4ECS.DeliveryStatus (Enumeration) |
OrderStockRequest
Properties
Name |
Description |
Type |
OrderId |
String |
|
ArticleId |
String |
|
EAN |
String |
|
BranchId |
String |
|
ChangedSinceDate |
DateTime |
|
IterationConstraints |
Represents the set of constraints the required backend iteration and expected number of objects in the reponse. If not set or one constraint parameter is not set, default values will be set. |
OrderStockResponse
Properties
Name |
Description |
Type |
OrderStocks |
List [Futura4ECS.OrderStock] |
|
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
OverPaymentMode (Enumeration)
Properties
Name |
Value |
Type |
NONE |
0 |
Int32 |
WARN |
1 |
Int32 |
PREVENT |
2 |
Int32 |
PaymentType
Properties
Name |
Description |
Type |
CurrencyISO |
String |
|
Description |
String |
|
IncomingDirection |
String |
|
NoBonus |
Boolean |
|
NoDrawer |
Boolean |
|
NoStandardPayment |
Boolean |
|
ShowOnReport |
Boolean |
|
PrintOnReport |
Boolean |
|
OnlineMethod |
String |
|
OnlinePayment |
Boolean |
|
OnlineType |
String |
|
AccountId |
String |
|
SpecialPayment |
Futura4ECS.SpecialPayment (Enumeration) |
|
WarningText |
String |
|
WarningLimit |
Double |
|
WarningAction |
Futura4ECS.WarningAction (Enumeration) |
|
MaximumLimit |
Double |
|
MaximumText |
String |
|
GiftVoucherDiscountAccount |
String |
|
DiffAccount |
String |
|
GiftVoucherDiscVatKey |
Int32 |
|
OverPaymentMode |
Futura4ECS.OverPaymentMode (Enumeration) |
|
ReportMode |
Futura4ECS.ReportMode (Enumeration) |
|
RoundingMode |
Futura4ECS.RoundingMode (Enumeration) |
|
RoundingValue |
Double |
|
CustomerRequired |
Boolean |
|
SerialNoMode |
Futura4ECS.SerialNoMode (Enumeration) |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
PaymentTypeRequest
Properties
Name |
Description |
Type |
CurrencyISO |
String |
|
ID |
String |
PaymentTypeResponse
Properties
Name |
Description |
Type |
PaymentTypes |
List [Futura4ECS.PaymentType] |
|
TaskStatus |
Person
Properties
Name |
Description |
Type |
LanguageISO |
String |
|
SalutationDescription |
String |
|
LastName |
String |
|
FirstName |
String |
|
MiddleName |
String |
|
Company |
String |
|
Title |
String |
|
Position |
String |
|
DateOfBirth |
DateTime |
|
Comment |
POS ContractConverter GetPerson: Comment = serviceItem.Notice, // alternate: serviceItem.Info public string Note { get; set; } public string Info { get; set; } |
String |
Gender |
ECS-V13: Gender (same enum with lower case names) |
Futura4ECS.GenderType (Enumeration) |
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
PersonV13
Properties
Name |
Description |
Type |
SalutationDescription |
String |
|
LastName |
String |
|
FirstName |
String |
|
MiddleName |
String |
|
LanguageISO |
String |
|
Company |
String |
|
Fax |
String |
|
Phone |
String |
|
Mobile |
String |
|
String |
||
HomePage |
String |
|
Position |
String |
|
Title |
String |
|
Addresses |
List [Futura4ECS.Address] |
|
AddressType |
String |
|
DateOfBirth |
DateTime |
|
Comment |
String |
|
Gender |
Futura4ECS.Gender (Enumeration) |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
PostalAddress
Properties
Name |
Description |
Type |
AddressType |
ECS: simple string field (but should be equals to the POS enum) |
Futura4ECS.AddressTypeEnum (Enumeration) |
Description |
String |
|
Street |
String |
|
StreetNumber |
ECS-V13: streetNo |
String |
BuildingNumber |
4POS |
String |
BuildingName |
String |
|
Block |
4POS |
String |
FlatNumber |
4POS |
String |
Floor |
new |
String |
PostalDistrict |
4POS |
String |
Quarter |
4POS |
String |
Latitude |
4POS |
Decimal |
TimeZoneDesignator |
4POS |
String |
Longitude |
4POS |
Decimal |
PostBoxNumber |
4POS |
String |
PostBoxZipCode |
4POS |
String |
ZipCode |
String |
|
City |
String |
|
Region |
String |
|
County |
4POS |
String |
CountryISO |
ECS-V13: Country |
String |
AdditionalRow1 |
String |
|
AdditionalRow2 |
String |
|
Tag |
Gets or sets an arbitrary string value that can be used to store custom information about this element. The tag information is send back in the response without any modification. Useful to identify objects later on. |
String |
IsCorrespondenceAddress |
Boolean |
|
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
PostCreationAction
Properties
Name |
Description |
Type |
OnIbtAction |
Futura4ECS.Contracts.Ibt.Enums+OnIbtAction (Enumeration) |
ProcessingStatus (Enumeration)
Properties
Name |
Value |
Type |
FINISHED |
0 |
Int32 |
RUNNING |
1 |
Int32 |
PENDING |
2 |
Int32 |
REJECTED |
3 |
Int32 |
ABORTED |
4 |
Int32 |
STARTED |
5 |
Int32 |
ProductGroup
Properties
Name |
Description |
Type |
Description |
String |
|
ShortDescription |
String |
|
Number |
Int32 |
|
VatTypeId |
Int32 |
|
ParentID |
String |
|
IsLeaf |
Boolean |
|
IsSelectionPermitted |
Boolean |
|
ParentProductGroup |
||
ChildProductGroups |
List [Futura4ECS.ProductGroup] |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
ProductGroupRequest
Properties
Name |
Description |
Type |
ReturnHierarchy |
Boolean |
|
LongNumber |
String |
|
IterationConstraints |
Represents the set of constraints the required backend iteration and expected number of objects in the reponse. If not set or one constraint parameter is not set, default values will be set. |
ProductGroupResponse
Properties
Name |
Description |
Type |
ProductGroups |
List [Futura4ECS.ProductGroup] |
|
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
ReportMode (Enumeration)
Properties
Name |
Value |
Type |
PICKUP_REPORT |
0 |
Int32 |
PICKUP_REPORT_ZERO |
1 |
Int32 |
AUTOMATIC_PICKUP |
2 |
Int32 |
NO_PICKUP_REPORT |
3 |
Int32 |
ReturnReason
Properties
Name |
Description |
Type |
Description |
String |
|
BranchID |
String |
|
LastReceiptNumber |
Int32 |
|
IsActive |
Boolean |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
ReturnReasonRequest
Properties
Name |
Description |
Type |
ID |
String |
ReturnReasonResponse
Properties
Name |
Description |
Type |
ReturnReasons |
||
TaskStatus |
RoundingMode (Enumeration)
Properties
Name |
Value |
Type |
NONE |
0 |
Int32 |
DOWN |
1 |
Int32 |
HALF_DOWN |
2 |
Int32 |
UP |
3 |
Int32 |
HALF_UP |
4 |
Int32 |
SalesMode (Enumeration)
Properties
Name |
Value |
Type |
NORMAL |
0 |
Int32 |
SELECTION |
1 |
Int32 |
SELECTION_RETOUR |
2 |
Int32 |
SELECTION_SALE |
3 |
Int32 |
RETURN |
4 |
Int32 |
SalesReceipt
Properties
Name |
Description |
Type |
CashId |
String |
|
CustomerId |
String |
|
ReceiptNumber |
Int32 |
|
SalesReceiptTimestamp |
@TODO review: old 4POS-WS "salesDate". |
DateTime |
ZNumber |
represents the posReportId. |
Int32 |
SalesReceiptPositions |
@TODO review: aka ReceiptLines |
SalesReceiptPosition
Properties
Name |
Description |
Type |
Position |
Int32 |
|
ProductGroupId |
String |
|
EAN |
String |
|
Quantity |
Decimal |
|
Value |
Decimal |
|
PriceAlteration |
Decimal |
|
CurrencyISO |
@TODO review: new field (currency for Value). |
String |
SellerId |
String |
|
SerialNumber |
String |
|
SalesMode |
Futura4ECS.SalesMode (Enumeration) |
|
LineType |
Futura4ECS.LineType (Enumeration) |
|
Discounts |
List [Futura4ECS.Discount] |
|
TextInfos |
List [Futura4ECS.TextInfo] |
SalesReceiptResponse
Properties
Name |
Description |
Type |
SalesReceipts |
List [Futura4ECS.SalesReceipt] |
|
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
Salutation
Properties
Name |
Description |
Type |
CompleteSalutation |
String |
|
Description |
String |
|
Sex |
String |
|
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
SalutationRequest
Properties
Name |
Description |
Type |
Description |
String |
SalutationResponse
Properties
Name |
Description |
Type |
Salutations |
List [Futura4ECS.Salutation] |
|
TaskStatus |
ScanCode
Properties
Name |
Description |
Type |
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
SendCustomerCharacteristic
Properties
Name |
Description |
Type |
ID |
Int64 |
|
Fraction |
This property reflects the value of perObject.Bez. |
Nullable [Decimal] |
SendCustomerRequest
Properties
Name |
Description |
Type |
ShopId |
ECS-specific |
String |
ShopCustomerId |
ECS-specific |
String |
CustomerId |
matches 4POS Customer Number. |
String |
CreationDate |
DateTime |
|
Description |
4POS |
String |
DefaultCurrencyISO |
String |
|
DefaultPaymentTypeId |
4POS (formerly just a commented ECS-field public PaymentType DefaultPaymentType { get; set; }) |
String |
Person |
4POS Person |
|
CommunicationData |
4POS |
|
PostalAddresses |
4POS |
List [Futura4ECS.PostalAddress] |
BankAccounts |
4POS |
List [Futura4ECS.BankAccount] |
CustomerCards |
4POS |
List [Futura4ECS.CustomerCard] |
StandardDiscount |
4POS |
Decimal |
IsReseller |
Nullable [Boolean] |
|
WithoutVAT |
Nullable [Boolean] |
|
AdvertisingAllowed |
4POS |
Nullable [Boolean] |
Blocked |
4POS |
Nullable [Boolean] |
BlockedSinceDate |
4POS |
DateTime |
HomeBranchId |
String |
|
CreatedByEmployee |
String |
|
CreatedAtPos |
String |
|
BonusPoints |
Nullable [Int32] |
|
BonusSaleReduced |
Nullable [Decimal] |
|
BonusSaleRegular |
Nullable [Decimal] |
|
ParentId |
String |
|
Characteristics |
||
PreferredCommunication |
String |
|
VATId |
String |
SendCustomerResponse
Properties
Name |
Description |
Type |
Customer |
||
TaskStatus |
SendDeliveryNoteRequest
Properties
Name |
Description |
Type |
DeliveryNoteId |
String |
|
OrderId |
String |
|
ShopId |
String |
|
ShopCustomerId |
String |
|
CustomerId |
String |
|
DeliveryNoteTimestamp |
DateTime |
|
DeliveryNotePositions |
SendDeliveryNoteResponse
Properties
Name |
Description |
Type |
Deliverynote |
||
TaskStatus |
SendGoodsInAdviceConfirmationRequest
Properties
Name |
Description |
Type |
DeliveryNoteId |
String |
|
DocumentId |
The document id of rweavisierungskopf, Avisierungskopf |
String |
Originator |
String |
|
Recipient |
String |
|
DeliveryNoteTimestamp |
DateTime |
|
Description |
String |
|
AdviceDetails |
List [Futura4ECS.Contracts.GoodsInAdvice.SendGoodsInAdviceConfirmation.GoodsInAdviceDetailRequest] |
SendGoodsInAdviceConfirmationResponse
Properties
Name |
Description |
Type |
GoodsInAdvices |
||
CreationActionSuccess |
Boolean |
|
CreationErrorMessages |
Array [String] |
|
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
SendInvoiceRequest
Properties
Name |
Description |
Type |
InvoiceId |
String |
|
DeliveryNoteId |
String |
|
OrderId |
String |
|
ShopId |
String |
|
ShopCustomerId |
String |
|
CustomerId |
String |
|
InvoiceTimestamp |
DateTime |
|
InvoicePositions |
List [Futura4ECS.InvoicePosition] |
SendInvoiceResponse
Properties
Name |
Description |
Type |
Invoice |
||
TaskStatus |
SendOrderRequest
Properties
Name |
Description |
Type |
OrderId |
String |
|
ShopId |
String |
|
ShopCustomerId |
String |
|
CustomerId |
String |
|
DeliveryAddress |
||
InvoiceAddress |
||
OrderPositions |
List [Futura4ECS.OrderPosition] |
|
AdditionalCosts |
List [Futura4ECS.AdditionalCost] |
|
PaymentTypeID |
String |
|
Comment |
String |
|
MCardId |
String |
SendOrderResponse
Properties
Name |
Description |
Type |
Order |
||
TaskStatus |
SendSalesReceiptRequest
Properties
Name |
Description |
Type |
CashId |
String |
|
CustomerId |
String |
|
ReceiptNumber |
Int32 |
|
SalesReceiptTimestamp |
@TODO review: old 4POS-WS "salesDate". |
DateTime |
ZNumber |
Int32 |
|
SalesReceiptPositions |
@TODO review: aka ReceiptLines |
SendStockCorrectionDetailRequest
Properties
Name |
Description |
Type |
ScanCodeId |
String |
|
Qty |
Decimal |
|
IsAbsQty |
Boolean |
|
ReasonText |
String |
SendStockCorrectionRequest
Properties
Name |
Description |
Type |
Date |
DateTime |
|
BranchId |
String |
|
IsAbsQty |
Boolean |
|
ReasonText |
String |
|
Corrections |
List [Futura4ECS.Contracts.StockCorrection.SendStockCorrectionDetailRequest] |
SendStockCorrectionResponse
Properties
Name |
Description |
Type |
CreationActionSuccess |
Boolean |
|
CreationErrorMessages |
Array [String] |
|
TaskStatus |
SendVoucherRequest
Properties
Name |
Description |
Type |
ReceiptNo |
String |
|
ScanCode |
String |
|
VoucherType |
Futura4ECS.VoucherType (Enumeration) |
|
ShopId |
String |
|
ShopCustomerId |
String |
|
CustomerId |
String |
|
Amount |
Decimal |
|
CurrencyISO |
String |
|
ValidFrom |
DateTime |
|
ExpirationDate |
DateTime |
|
SalesDate |
DateTime |
|
RedeemDate |
DateTime |
|
Redeemed |
Boolean |
|
Info |
String |
SendVoucherResponse
Properties
Name |
Description |
Type |
Voucher |
||
TaskStatus |
SerialNoMode (Enumeration)
Properties
Name |
Value |
Type |
NONE |
0 |
Int32 |
AUTOMATIC |
1 |
Int32 |
MANUAL |
2 |
Int32 |
ServiceReference
Properties
Name |
Description |
Type |
ReferenceID |
String |
|
ReferenceVersion |
String |
|
Status |
Futura4ECS.ComponentStatus (Enumeration) |
|
Configuration |
ServiceStatus
Properties
Name |
Description |
Type |
ServiceID |
String |
|
ServiceVersion |
String |
|
Status |
Futura4ECS.ComponentStatus (Enumeration) |
|
Configuration |
||
References |
List [Futura4ECS.ServiceReference] |
|
SystemDate |
DateTime |
|
MemoryUsage |
Int64 |
|
ProcessName |
String |
Shop
Properties
Name |
Description |
Type |
ShopName |
String |
|
ShopBookingPlace |
||
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
ShopRequest
Properties
Name |
Description |
Type |
ID |
String |
ShopResponse
Properties
Name |
Description |
Type |
Shops |
List [Futura4ECS.Shop] |
|
TaskStatus |
Size
Properties
Name |
Description |
Type |
Description |
String |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
SizeRange
Properties
Name |
Description |
Type |
Description |
String |
|
Sizes |
List [Futura4ECS.Size] |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
SizeRangeRequest
Properties
Name |
Description |
Type |
ID |
String |
SizeRangeResponse
Properties
Name |
Description |
Type |
SizeRanges |
List [Futura4ECS.SizeRange] |
|
TaskStatus |
SizeRequest
Properties
Name |
Description |
Type |
ID |
String |
SizeResponse
Properties
Name |
Description |
Type |
Sizes |
List [Futura4ECS.Size] |
|
TaskStatus |
SpecialPayment (Enumeration)
Properties
Name |
Value |
Type |
NO |
0 |
Int32 |
GIFT_VOUCHER |
1 |
Int32 |
ADVANCE |
2 |
Int32 |
SALE_ON_CREDIT |
3 |
Int32 |
CREDIT_ADVICE |
4 |
Int32 |
EC_DEBIT_ADVICE |
5 |
Int32 |
INTER_BRANCH_TRANSFER |
6 |
Int32 |
INVOICE |
7 |
Int32 |
SUPPLIER_RETURN |
8 |
Int32 |
SELECTION |
9 |
Int32 |
INPAYMENT_EXPENSE |
10 |
Int32 |
CREDIT_CARD_AUTOMATIC |
11 |
Int32 |
EC_DEBIT_ADVICE_SP_I |
12 |
Int32 |
CUSTOMER_CARD |
13 |
Int32 |
EC_CARD_SP_II |
14 |
Int32 |
RECEIPT_REPEAT_SP_II |
15 |
Int32 |
RESERVE_SUM_AMOUNT |
16 |
Int32 |
RESERVE_REMAIN_AMOUNT |
17 |
Int32 |
ADVANCE_RESERVE |
18 |
Int32 |
RECEIPT_REPEAT_TCS |
19 |
Int32 |
StatusRequest
Properties
Name |
Description |
Type |
StatusResponse
Properties
Name |
Description |
Type |
ServiceStatus |
||
TaskStatus |
StockInfo
Properties
Name |
Description |
Type |
BranchId |
String |
|
ArticleId |
String |
|
EAN |
String |
|
Price |
Decimal |
|
Stock |
Decimal |
|
ReservedStock |
Decimal |
|
LastMove |
DateTime |
StockRequest
Properties
Name |
Description |
Type |
ArticleId |
String |
|
EAN |
String |
|
BranchId |
String |
|
ChangedSinceDate |
DateTime |
|
IterationConstraints |
Represents the set of constraints the required backend iteration and expected number of objects in the reponse. If not set or one constraint parameter is not set, default values will be set. |
StockResponse
Properties
Name |
Description |
Type |
Stocks |
List [Futura4ECS.StockInfo] |
|
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
SystemColour
Properties
Name |
Description |
Type |
Description |
String |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
SystemColourRequest
Properties
Name |
Description |
Type |
ID |
String |
SystemColourResponse
Properties
Name |
Description |
Type |
SystemColours |
List [Futura4ECS.SystemColour] |
|
TaskStatus |
TaskMessage
Properties
Name |
Description |
Type |
TaskMessageLevel |
Futura4ECS.MessageLevel (Enumeration) |
|
ErrorCode |
Futura4ECS.MessageErrorCode (Enumeration) |
|
EventKey |
String |
|
EventTimestamp |
DateTime |
|
RelatedComponent |
String |
|
RelatedBehaviour |
String |
|
Description |
String |
|
ExceptionMessages |
List [String] |
TaskStatus
Properties
Name |
Description |
Type |
ProcessingStatus |
Futura4ECS.ProcessingStatus (Enumeration) |
|
TaskDuration |
Int64 |
|
TaskInfo |
String |
|
TaskMessages |
List [Futura4ECS.TaskMessage] |
|
WorkerRecommendation |
Futura4ECS.WorkerRecommendation (Enumeration) |
|
WorkerRecommendationDelaySeconds |
Int32 |
TextInfo
Properties
Name |
Description |
Type |
Key |
Futura4ECS.TextInfoType (Enumeration) |
|
Value |
String |
TextInfoType (Enumeration)
Properties
Name |
Value |
Type |
UNDEFINED |
0 |
Int32 |
PRICE_DELTA_VALUE |
1 |
Int32 |
SERIAL_NO |
2 |
Int32 |
RETURN_REASON |
3 |
Int32 |
BANK_CODE_KEY |
4 |
Int32 |
BANK_ACCOUNT_KEY |
5 |
Int32 |
EXPIRY_DATE |
6 |
Int32 |
VALID_TO_MONTH |
7 |
Int32 |
VALID_TO_YEAR |
8 |
Int32 |
MD5_HASH_VALUE |
9 |
Int32 |
CVV_VALUE |
10 |
Int32 |
ENTRY_MODE |
11 |
Int32 |
ROUNDING_DELTA |
12 |
Int32 |
AUTH_NUMBER |
13 |
Int32 |
CUSTOMER_RECEIPT |
14 |
Int32 |
CARD_BRAND |
15 |
Int32 |
CARD_PAN |
16 |
Int32 |
TERMINAL_ID |
17 |
Int32 |
TRANSACTION_ID |
18 |
Int32 |
TERM_TIMESTAMP |
19 |
Int32 |
ORDER_ID |
20 |
Int32 |
T_DATE |
21 |
Int32 |
SCAN_CODE |
22 |
Int32 |
ADDITIONAL_INFO |
23 |
Int32 |
TRADER_RCPT_HINT |
24 |
Int32 |
GIFT_CARD_STATE |
25 |
Int32 |
GIFT_CARD_CURRENCY |
26 |
Int32 |
GIFT_CARD_BALANCE |
27 |
Int32 |
GIFT_CARD_EXPIRATION |
28 |
Int32 |
META_DATA |
29 |
Int32 |
CONTRACT_NO |
30 |
Int32 |
DATE_OF_INVOICE |
31 |
Int32 |
CUSTOMER_NAME |
32 |
Int32 |
UpdateIbtDetailRequest
Properties
Name |
Description |
Type |
Ean |
String |
|
ActualQuantity |
Decimal |
|
ExtensionData |
ExtensionDataObject |
|
FLTPAToken |
String |
UpdateIbtRequest
Properties
Name |
Description |
Type |
DocumentNo |
String |
|
IbtDetails |
||
Memo |
String |
|
ExtensionData |
ExtensionDataObject |
|
FLTPAToken |
String |
UpdateIbtResponse
Properties
Name |
Description |
Type |
Status |
Futura4ECS.Contracts.Ibt.UpdateIbtStatus (Enumeration) |
|
StatusMessage |
String |
|
Ibt |
||
TaskStatus |
UpdateIbtStatus (Enumeration)
Properties
Name |
Value |
Type |
UpdateSuccessful |
0 |
Int32 |
Warning |
1 |
Int32 |
Error |
2 |
Int32 |
Vat
Properties
Name |
Description |
Type |
Description |
String |
|
vatTypeId |
Int32 |
|
VatConfigurationId |
Int32 |
|
VatPercent |
Decimal |
|
ValidFrom |
DateTime |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
VatRequest
Properties
Name |
Description |
Type |
ID |
String |
VatResponse
Properties
Name |
Description |
Type |
Vats |
List [Futura4ECS.Vat] |
|
TaskStatus |
Voucher
Properties
Name |
Description |
Type |
VoucherType |
Futura4ECS.VoucherType (Enumeration) |
|
ScanCode |
String |
|
Amount |
Decimal |
|
Remainder |
Decimal |
|
CurrencyISO |
String |
|
ValidFrom |
DateTime |
|
ExpirationDate |
DateTime |
|
RedeemDate |
DateTime |
|
SalesDate |
DateTime |
|
LastChange |
DateTime |
|
BranchId |
String |
|
ShopId |
String |
|
CustomerId |
String |
|
ShopCustomerId |
String |
|
Info |
String |
|
IsRedeemed |
Boolean |
|
IsDeleted |
Boolean |
|
IsPrinted |
Boolean |
|
ID |
This property reflects the value of the Id-Field for the relevant object. |
String |
Oid |
This property reflects the value of perObject.Oid for the relevant object. We use string instead of System.Guid for interoperability reasons. |
String |
VoucherRequest
Properties
Name |
Description |
Type |
ID |
String |
|
BranchId |
String |
|
ShopId |
String |
|
ShopCustomerId |
String |
|
CustomerId |
String |
|
ScanCode |
String |
|
Redeemed |
Boolean |
|
ChangedSinceDate |
DateTime |
|
IterationConstraints |
Represents the set of constraints the required backend iteration and expected number of objects in the reponse. If not set or one constraint parameter is not set, default values will be set. |
VoucherResponse
Properties
Name |
Description |
Type |
Vouchers |
List [Futura4ECS.Voucher] |
|
IterationStatus |
Represents a value, giving the whole number of objects available. This value should be used to calculate the block index for der next request. |
|
TaskStatus |
VoucherType (Enumeration)
Properties
Name |
Value |
Type |
Bonus |
0 |
Int32 |
Gift |
1 |
Int32 |
Exchange |
2 |
Int32 |
Promotion |
3 |
Int32 |
CashBonus |
4 |
Int32 |
WarningAction (Enumeration)
Properties
Name |
Value |
Type |
NONE |
0 |
Int32 |
AUTHORIZE |
1 |
Int32 |
CUSTOMER_ID_CARD |
2 |
Int32 |
DOCUMENT_ID |
3 |
Int32 |
WorkerRecommendation (Enumeration)
Properties
Name |
Value |
Type |
CONTINUE |
0 |
Int32 |
REPEAT |
1 |
Int32 |
WAIT |
2 |
Int32 |
STOP |
3 |
Int32 |