In this example, we search for all items whose number or description contains the character sub-strings stop, emsschuh and dual. For this purpose, the search is initialized via the following request (URL binding)
https://b2b.beispielserver.com/?BuyersID=127654&Password=secret&RequestName=CreateTextSearchRequest&SearchString=stop%20emsschuh%20dual |
or via a POST of the following, equivalent XML file.
<?xml version="1.0" encoding="utf-8" ?> <CreateTextSearchRequest xmlns="urn:veloconnect:catalog-1.1" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-1.0" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-1.0" xmlns:vct="urn:veloconnect:transaction-1.0"> <vct:BuyersID>B127645</vct:BuyersID> <vct:Credential> <vct:Password>secret</vct:Password> </vct:Credential> <SearchString>stop emsschuh dual</SearchString> </CreateTextSearchRequest> |
The search result then appears as follows, for example, i.e. six articles were found.
<?xml version="1.0" encoding="utf-8" ?> <CreateTextSearchResponse xmlns="urn:veloconnect:catalog-1.1" xmlns:vct="urn:veloconnect:transaction-1.0"> <vct:BuyersID>B127645</vct:BuyersID> <vct:ResponseCode>200</vct:ResponseCode> <vct:TransactionID>2</vct:TransactionID> <vct:StatusCode>2</vct:StatusCode> <vct:IsTest>false</vct:IsTest> <TotalCount>6</TotalCount> </CreateTextSearchResponse> |
Now the search results can be retrieved.
This request
https://b2b.beispielserver.com/?BuyersID=127654&Password=secret&RequestName=SearchResultRequest&TransactionID=2&StartIndex=3&Count=2&ResultFormat=ITEM_TYPE |
is for hits with indices 3 and 4 an (i.e. the 4th and 5th hits), more specifically, in the ITEM_TYPE format. A POST of the following XML file is equivalent.
<?xml version="1.0" encoding="utf-8" ?> <SearchResultRequest xmlns="urn:veloconnect:catalog-1.1" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-1.0" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-1.0" xmlns:vct="urn:veloconnect:transaction-1.0"> <vct:BuyersID>B127645</vct:BuyersID> <vct:Credential> <vct:Password>secret</vct:Password> </vct:Credential> <vct:TransactionID>2</vct:TransactionID> <StartIndex>3</StartIndex> <Count>2</Count> <ResultFormat>ITEM_TYPE</ResultFormat> </SearchResultRequest> |
The hits are supplied as shown in the following XML file.
<?xml version="1.0" encoding="utf-8" ?> <SearchResultResponse xmlns="urn:veloconnect:catalog-1.1" xmlns:vct="urn:veloconnect:transaction-1.0" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-1.0" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-1.0"> <vct:BuyersID>B127645</vct:BuyersID> <vct:ResponseCode>200</vct:ResponseCode> <vct:TransactionID>2</vct:TransactionID> <vct:StatusCode>2</vct:StatusCode> <vct:IsTest>false</vct:IsTest> <StartIndex>3</StartIndex> <Count>2</Count> <TotalCount>6</TotalCount> <ResultFormat>ITEM_TYPE</ResultFormat> <cac:Item> <cbc:Description>KOOL-STOP MTB contoured (Chart Index C1) gebogene Canti-Bremsschuhe, dual compound</cbc:Description> <cac:SellersItemIdentification> <cac:ID>221-98</cac:ID> </cac:SellersItemIdentification> <cac:ManufacturersItemIdentification> <cac:ID>RE 397 KS</cac:ID> <cac:IssuerParty><cac:PartyName><cbc:Name>KOOL STOP</cbc:Name></cac:PartyName></cac:IssuerParty> </cac:ManufacturersItemIdentification> <cac:BasePrice> <cbc:PriceAmount amountCurrencyID="EUR">6.50</cbc:PriceAmount> <cbc:BaseQuantity quantityUnitCode="EA">1</cbc:BaseQuantity> </cac:BasePrice> <cac:BasePrice> <cbc:PriceAmount amountCurrencyID="EUR">6.30</cbc:PriceAmount> <cbc:BaseQuantity quantityUnitCode="EA">1</cbc:BaseQuantity> <cbc:MinimumQuantity quantityUnitCode="EA">25</cbc:MinimumQuantity> </cac:BasePrice> <cac:BasePrice> <cbc:PriceAmount amountCurrencyID="EUR">6.17</cbc:PriceAmount> <cbc:BaseQuantity quantityUnitCode="EA">1</cbc:BaseQuantity> <cbc:MinimumQuantity quantityUnitCode="EA">50</cbc:MinimumQuantity> </cac:BasePrice> <cac:BasePrice> <cbc:PriceAmount amountCurrencyID="EUR">5.98</cbc:PriceAmount> <cbc:BaseQuantity quantityUnitCode="EA">1</cbc:BaseQuantity> <cbc:MinimumQuantity quantityUnitCode="EA">100</cbc:MinimumQuantity> </cac:BasePrice> </cac:Item> <cac:Item> <cbc:Description>KOOL-STOP MTB contoured (Chart Index T1) gebogene Schraub-Bremsschuhe, dual compound</cbc:Description> <cac:SellersItemIdentification> <cac:ID>222-98</cac:ID> </cac:SellersItemIdentification> <cac:ManufacturersItemIdentification> <cac:ID>RE 387 KS</cac:ID> <cac:IssuerParty><cac:PartyName><cbc:Name>KOOL STOP</cbc:Name></cac:PartyName></cac:IssuerParty> </cac:ManufacturersItemIdentification> <cac:BasePrice> <cbc:PriceAmount amountCurrencyID="EUR">7.75</cbc:PriceAmount> <cbc:BaseQuantity quantityUnitCode="EA">1</cbc:BaseQuantity> </cac:BasePrice> <cac:BasePrice> <cbc:PriceAmount amountCurrencyID="EUR">7.52</cbc:PriceAmount> <cbc:BaseQuantity quantityUnitCode="EA">1</cbc:BaseQuantity> <cbc:MinimumQuantity quantityUnitCode="EA">25</cbc:MinimumQuantity> </cac:BasePrice> <cac:BasePrice> <cbc:PriceAmount amountCurrencyID="EUR">7.36</cbc:PriceAmount> <cbc:BaseQuantity quantityUnitCode="EA">1</cbc:BaseQuantity> <cbc:MinimumQuantity quantityUnitCode="EA">50</cbc:MinimumQuantity> </cac:BasePrice> <cac:BasePrice> <cbc:PriceAmount amountCurrencyID="EUR">7.13</cbc:PriceAmount> <cbc:BaseQuantity quantityUnitCode="EA">1</cbc:BaseQuantity> <cbc:MinimumQuantity quantityUnitCode="EA">100</cbc:MinimumQuantity> </cac:BasePrice> </cac:Item> </SearchResultResponse> |
Had the request made use of ResultFormat=ITEM_DETAIL
, the response would have been as follows:
<?xml version="1.0" encoding="utf-8" ?> <SearchResultResponse xmlns="urn:veloconnect:catalog-1.1" xmlns:vct="urn:veloconnect:transaction-1.0" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-1.0" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-1.0" xmlns:vco="urn:veloconnect:order-1.1"> <vct:BuyersID>B127645</vct:BuyersID> <vct:ResponseCode>200</vct:ResponseCode> <vct:TransactionID>2</vct:TransactionID> <vct:StatusCode>2</vct:StatusCode> <vct:IsTest>false</vct:IsTest> <StartIndex>3</StartIndex> <Count>2</Count> <TotalCount>6</TotalCount> <ResultFormat>ITEM_DETAIL</ResultFormat> <vco:ItemDetail> <cac:Item> <cbc:Description>KOOL-STOP MTB contoured (Chart Index C1) gebogene Canti-Bremsschuhe, dual compound</cbc:Description> <cac:SellersItemIdentification> <cac:ID>221-98</cac:ID> </cac:SellersItemIdentification> <cac:ManufacturersItemIdentification> <cac:ID>RE 397 KS</cac:ID> <cac:IssuerParty><cac:PartyName><cbc:Name>KOOL STOP</cbc:Name></cac:PartyName></cac:IssuerParty> </cac:ManufacturersItemIdentification> <cac:BasePrice> <cbc:PriceAmount amountCurrencyID="EUR">6.50</cbc:PriceAmount> <cbc:BaseQuantity quantityUnitCode="EA">1</cbc:BaseQuantity> </cac:BasePrice> <cac:BasePrice> <cbc:PriceAmount amountCurrencyID="EUR">6.30</cbc:PriceAmount> <cbc:BaseQuantity quantityUnitCode="EA">1</cbc:BaseQuantity> <cbc:MinimumQuantity quantityUnitCode="EA">25</cbc:MinimumQuantity> </cac:BasePrice> <cac:BasePrice> <cbc:PriceAmount amountCurrencyID="EUR">6.17</cbc:PriceAmount> <cbc:BaseQuantity quantityUnitCode="EA">1</cbc:BaseQuantity> <cbc:MinimumQuantity quantityUnitCode="EA">50</cbc:MinimumQuantity> </cac:BasePrice> <cac:BasePrice> <cbc:PriceAmount amountCurrencyID="EUR">5.98</cbc:PriceAmount> <cbc:BaseQuantity quantityUnitCode="EA">1</cbc:BaseQuantity> <cbc:MinimumQuantity quantityUnitCode="EA">100</cbc:MinimumQuantity> </cac:BasePrice> </cac:Item> <vco:Availability> <vco:Code>available</vco:Code> </vco:Availability> </vco:ItemDetail> <vco:ItemDetail> <cac:Item> <cbc:Description>KOOL-STOP MTB contoured (Chart Index T1) gebogene Schraub-Bremsschuhe, dual compound</cbc:Description> <cac:SellersItemIdentification> <cac:ID>222-98</cac:ID> </cac:SellersItemIdentification> <cac:ManufacturersItemIdentification> <cac:ID>RE 387 KS</cac:ID> <cac:IssuerParty><cac:PartyName><cbc:Name>KOOL STOP</cbc:Name></cac:PartyName></cac:IssuerParty> </cac:ManufacturersItemIdentification> <cac:BasePrice> <cbc:PriceAmount amountCurrencyID="EUR">7.75</cbc:PriceAmount> <cbc:BaseQuantity quantityUnitCode="EA">1</cbc:BaseQuantity> </cac:BasePrice> <cac:BasePrice> <cbc:PriceAmount amountCurrencyID="EUR">7.52</cbc:PriceAmount> <cbc:BaseQuantity quantityUnitCode="EA">1</cbc:BaseQuantity> <cbc:MinimumQuantity quantityUnitCode="EA">25</cbc:MinimumQuantity> </cac:BasePrice> <cac:BasePrice> <cbc:PriceAmount amountCurrencyID="EUR">7.36</cbc:PriceAmount> <cbc:BaseQuantity quantityUnitCode="EA">1</cbc:BaseQuantity> <cbc:MinimumQuantity quantityUnitCode="EA">50</cbc:MinimumQuantity> </cac:BasePrice> <cac:BasePrice> <cbc:PriceAmount amountCurrencyID="EUR">7.13</cbc:PriceAmount> <cbc:BaseQuantity quantityUnitCode="EA">1</cbc:BaseQuantity> <cbc:MinimumQuantity quantityUnitCode="EA">100</cbc:MinimumQuantity> </cac:BasePrice> </cac:Item> <vco:Availability> <vco:Code>available</vco:Code> </vco:Availability> </vco:ItemDetail> </SearchResultResponse> |
For ResultFormat=ID_ONLY
, the following response would have been issued:
<?xml version="1.0" encoding="utf-8" ?> <SearchResultResponse xmlns="urn:veloconnect:catalog-1.1" xmlns:vct="urn:veloconnect:transaction-1.0" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-1.0" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-1.0" xmlns:vco="urn:veloconnect:order-1.1"> <vct:BuyersID>B127645</vct:BuyersID> <vct:ResponseCode>200</vct:ResponseCode> <vct:TransactionID>2</vct:TransactionID> <vct:StatusCode>2</vct:StatusCode> <vct:IsTest>false</vct:IsTest> <StartIndex>3</StartIndex> <Count>2</Count> <TotalCount>6</TotalCount> <ResultFormat>ID_ONLY</ResultFormat> <cac:SellersItemIdentification> <cac:ID>221-98</cac:ID> </cac:SellersItemIdentification> <cac:SellersItemIdentification> <cac:ID>222-98</cac:ID> </cac:SellersItemIdentification> </SearchResultResponse> |