ProductService Web Service

ProductService

Click here for a complete list of operations.

GetMenuCustomProductData

For suppliers only. Works just like GetCustomProductData, but lets you fetch all products attached to a certain menu item. Use the GetCustomProductDataFieldNames-method to get a list of all valid field names that can be requested. The product data is delivered in a name-value-collection called Data in each ArbitraryProduct-object. langTargetmarketLimit can be used to only request data from products with information in a certain language, thats sold in the requested country. It should be written in ISO 639.1 and ISO 3166. So sv-SE will for instance request Swedish products with information in swedish. If langTargetmarketLimit is null, a product from any country with any language might be returned

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /WS/General/v181/ProductService.asmx HTTP/1.1
Host: api.opv.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.opv.se/GetMenuCustomProductData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetMenuCustomProductData xmlns="http://www.opv.se/">
      <menuItemId>long</menuItemId>
      <requestedDataFields>
        <string>string</string>
        <string>string</string>
      </requestedDataFields>
      <langTargetmarketLimit>string</langTargetmarketLimit>
      <secKey>string</secKey>
    </GetMenuCustomProductData>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetMenuCustomProductDataResponse xmlns="http://www.opv.se/">
      <GetMenuCustomProductDataResult>
        <Data>
          <ArbitraryProduct>
            <GTIN>string</GTIN>
            <MatchFound>boolean</MatchFound>
            <Data xsi:nil="true" />
          </ArbitraryProduct>
          <ArbitraryProduct>
            <GTIN>string</GTIN>
            <MatchFound>boolean</MatchFound>
            <Data xsi:nil="true" />
          </ArbitraryProduct>
        </Data>
      </GetMenuCustomProductDataResult>
    </GetMenuCustomProductDataResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /WS/General/v181/ProductService.asmx HTTP/1.1
Host: api.opv.se
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetMenuCustomProductData xmlns="http://www.opv.se/">
      <menuItemId>long</menuItemId>
      <requestedDataFields>
        <string>string</string>
        <string>string</string>
      </requestedDataFields>
      <langTargetmarketLimit>string</langTargetmarketLimit>
      <secKey>string</secKey>
    </GetMenuCustomProductData>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetMenuCustomProductDataResponse xmlns="http://www.opv.se/">
      <GetMenuCustomProductDataResult>
        <Data>
          <ArbitraryProduct>
            <GTIN>string</GTIN>
            <MatchFound>boolean</MatchFound>
            <Data xsi:nil="true" />
          </ArbitraryProduct>
          <ArbitraryProduct>
            <GTIN>string</GTIN>
            <MatchFound>boolean</MatchFound>
            <Data xsi:nil="true" />
          </ArbitraryProduct>
        </Data>
      </GetMenuCustomProductDataResult>
    </GetMenuCustomProductDataResponse>
  </soap12:Body>
</soap12:Envelope>