ProductService Web Service

ProductService

Click here for a complete list of operations.

GetAttributesByClassification

Retrieves Atributes XML for a specific classification.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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 /productservice.asmx HTTP/1.1
Host: api-jako.aptos.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.shopvisible.com/GetAttributesByClassification"

<?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>
    <GetAttributesByClassification xmlns="http://api.shopvisible.com/">
      <ClientName>string</ClientName>
      <Guid>string</Guid>
      <ClassificationId>int</ClassificationId>
    </GetAttributesByClassification>
  </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>
    <GetAttributesByClassificationResponse xmlns="http://api.shopvisible.com/">
      <ClassificationAttributes>
        <ClassificationAttribute>
          <ClassificationAttributeID>int</ClassificationAttributeID>
          <ClassificationAttributeName>string</ClassificationAttributeName>
          <ClassificationAttributeDisplayName>string</ClassificationAttributeDisplayName>
          <ClassificationAttributeDescription>string</ClassificationAttributeDescription>
          <ClassificationAttributeImage>string</ClassificationAttributeImage>
          <ClassificationAttributeOrder>int</ClassificationAttributeOrder>
        </ClassificationAttribute>
        <ClassificationAttribute>
          <ClassificationAttributeID>int</ClassificationAttributeID>
          <ClassificationAttributeName>string</ClassificationAttributeName>
          <ClassificationAttributeDisplayName>string</ClassificationAttributeDisplayName>
          <ClassificationAttributeDescription>string</ClassificationAttributeDescription>
          <ClassificationAttributeImage>string</ClassificationAttributeImage>
          <ClassificationAttributeOrder>int</ClassificationAttributeOrder>
        </ClassificationAttribute>
        <Response>
          <ResponseHasErrors>boolean</ResponseHasErrors>
          <ResponseCode>string</ResponseCode>
          <ResponseDescription>string</ResponseDescription>
          <ResponseCustomReturn1>string</ResponseCustomReturn1>
          <ResponseCustomReturn2>string</ResponseCustomReturn2>
          <ResponseCustomReturn3>string</ResponseCustomReturn3>
          <ResponseCustomReturn4>string</ResponseCustomReturn4>
          <ResponseCustomReturn5>string</ResponseCustomReturn5>
          <ResponseDebugging>string</ResponseDebugging>
          <ResponseOrderSuccess>
            <ResponseOrderSuccess xsi:nil="true" />
            <ResponseOrderSuccess xsi:nil="true" />
          </ResponseOrderSuccess>
          <ResponseOrderErrors>
            <ResponseOrderError xsi:nil="true" />
            <ResponseOrderError xsi:nil="true" />
          </ResponseOrderErrors>
          <ResponseOrderMessages>
            <ResponseOrderMessage xsi:nil="true" />
            <ResponseOrderMessage xsi:nil="true" />
          </ResponseOrderMessages>
        </Response>
      </ClassificationAttributes>
    </GetAttributesByClassificationResponse>
  </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 /productservice.asmx HTTP/1.1
Host: api-jako.aptos.io
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>
    <GetAttributesByClassification xmlns="http://api.shopvisible.com/">
      <ClientName>string</ClientName>
      <Guid>string</Guid>
      <ClassificationId>int</ClassificationId>
    </GetAttributesByClassification>
  </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>
    <GetAttributesByClassificationResponse xmlns="http://api.shopvisible.com/">
      <ClassificationAttributes>
        <ClassificationAttribute>
          <ClassificationAttributeID>int</ClassificationAttributeID>
          <ClassificationAttributeName>string</ClassificationAttributeName>
          <ClassificationAttributeDisplayName>string</ClassificationAttributeDisplayName>
          <ClassificationAttributeDescription>string</ClassificationAttributeDescription>
          <ClassificationAttributeImage>string</ClassificationAttributeImage>
          <ClassificationAttributeOrder>int</ClassificationAttributeOrder>
        </ClassificationAttribute>
        <ClassificationAttribute>
          <ClassificationAttributeID>int</ClassificationAttributeID>
          <ClassificationAttributeName>string</ClassificationAttributeName>
          <ClassificationAttributeDisplayName>string</ClassificationAttributeDisplayName>
          <ClassificationAttributeDescription>string</ClassificationAttributeDescription>
          <ClassificationAttributeImage>string</ClassificationAttributeImage>
          <ClassificationAttributeOrder>int</ClassificationAttributeOrder>
        </ClassificationAttribute>
        <Response>
          <ResponseHasErrors>boolean</ResponseHasErrors>
          <ResponseCode>string</ResponseCode>
          <ResponseDescription>string</ResponseDescription>
          <ResponseCustomReturn1>string</ResponseCustomReturn1>
          <ResponseCustomReturn2>string</ResponseCustomReturn2>
          <ResponseCustomReturn3>string</ResponseCustomReturn3>
          <ResponseCustomReturn4>string</ResponseCustomReturn4>
          <ResponseCustomReturn5>string</ResponseCustomReturn5>
          <ResponseDebugging>string</ResponseDebugging>
          <ResponseOrderSuccess>
            <ResponseOrderSuccess xsi:nil="true" />
            <ResponseOrderSuccess xsi:nil="true" />
          </ResponseOrderSuccess>
          <ResponseOrderErrors>
            <ResponseOrderError xsi:nil="true" />
            <ResponseOrderError xsi:nil="true" />
          </ResponseOrderErrors>
          <ResponseOrderMessages>
            <ResponseOrderMessage xsi:nil="true" />
            <ResponseOrderMessage xsi:nil="true" />
          </ResponseOrderMessages>
        </Response>
      </ClassificationAttributes>
    </GetAttributesByClassificationResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /productservice.asmx/GetAttributesByClassification?ClientName=string&Guid=string&ClassificationId=string HTTP/1.1
Host: api-jako.aptos.io

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

<?xml version="1.0" encoding="utf-8"?>
<ClassificationAttributes xmlns="http://api.shopvisible.com/">
  <ClassificationAttribute>
    <ClassificationAttributeID>int</ClassificationAttributeID>
    <ClassificationAttributeName>string</ClassificationAttributeName>
    <ClassificationAttributeDisplayName>string</ClassificationAttributeDisplayName>
    <ClassificationAttributeDescription>string</ClassificationAttributeDescription>
    <ClassificationAttributeImage>string</ClassificationAttributeImage>
    <ClassificationAttributeOrder>int</ClassificationAttributeOrder>
  </ClassificationAttribute>
  <ClassificationAttribute>
    <ClassificationAttributeID>int</ClassificationAttributeID>
    <ClassificationAttributeName>string</ClassificationAttributeName>
    <ClassificationAttributeDisplayName>string</ClassificationAttributeDisplayName>
    <ClassificationAttributeDescription>string</ClassificationAttributeDescription>
    <ClassificationAttributeImage>string</ClassificationAttributeImage>
    <ClassificationAttributeOrder>int</ClassificationAttributeOrder>
  </ClassificationAttribute>
  <Response>
    <ResponseHasErrors>boolean</ResponseHasErrors>
    <ResponseCode>string</ResponseCode>
    <ResponseDescription>string</ResponseDescription>
    <ResponseCustomReturn1>string</ResponseCustomReturn1>
    <ResponseCustomReturn2>string</ResponseCustomReturn2>
    <ResponseCustomReturn3>string</ResponseCustomReturn3>
    <ResponseCustomReturn4>string</ResponseCustomReturn4>
    <ResponseCustomReturn5>string</ResponseCustomReturn5>
    <ResponseDebugging>string</ResponseDebugging>
    <ResponseOrderSuccess>
      <ResponseOrderSuccess>
        <OrderID>string</OrderID>
        <OrderStatusID>string</OrderStatusID>
        <OrderCustomerID>string</OrderCustomerID>
        <OrderInfo>string</OrderInfo>
      </ResponseOrderSuccess>
      <ResponseOrderSuccess>
        <OrderID>string</OrderID>
        <OrderStatusID>string</OrderStatusID>
        <OrderCustomerID>string</OrderCustomerID>
        <OrderInfo>string</OrderInfo>
      </ResponseOrderSuccess>
    </ResponseOrderSuccess>
    <ResponseOrderErrors>
      <ResponseOrderError>
        <OrderInfo>string</OrderInfo>
        <OrderErrors d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ResponseOrderError>
      <ResponseOrderError>
        <OrderInfo>string</OrderInfo>
        <OrderErrors d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ResponseOrderError>
    </ResponseOrderErrors>
    <ResponseOrderMessages>
      <ResponseOrderMessage>
        <OrderInfo>string</OrderInfo>
        <OrderMessages d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ResponseOrderMessage>
      <ResponseOrderMessage>
        <OrderInfo>string</OrderInfo>
        <OrderMessages d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ResponseOrderMessage>
    </ResponseOrderMessages>
  </Response>
</ClassificationAttributes>

HTTP POST

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

POST /productservice.asmx/GetAttributesByClassification HTTP/1.1
Host: api-jako.aptos.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ClientName=string&Guid=string&ClassificationId=string

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

<?xml version="1.0" encoding="utf-8"?>
<ClassificationAttributes xmlns="http://api.shopvisible.com/">
  <ClassificationAttribute>
    <ClassificationAttributeID>int</ClassificationAttributeID>
    <ClassificationAttributeName>string</ClassificationAttributeName>
    <ClassificationAttributeDisplayName>string</ClassificationAttributeDisplayName>
    <ClassificationAttributeDescription>string</ClassificationAttributeDescription>
    <ClassificationAttributeImage>string</ClassificationAttributeImage>
    <ClassificationAttributeOrder>int</ClassificationAttributeOrder>
  </ClassificationAttribute>
  <ClassificationAttribute>
    <ClassificationAttributeID>int</ClassificationAttributeID>
    <ClassificationAttributeName>string</ClassificationAttributeName>
    <ClassificationAttributeDisplayName>string</ClassificationAttributeDisplayName>
    <ClassificationAttributeDescription>string</ClassificationAttributeDescription>
    <ClassificationAttributeImage>string</ClassificationAttributeImage>
    <ClassificationAttributeOrder>int</ClassificationAttributeOrder>
  </ClassificationAttribute>
  <Response>
    <ResponseHasErrors>boolean</ResponseHasErrors>
    <ResponseCode>string</ResponseCode>
    <ResponseDescription>string</ResponseDescription>
    <ResponseCustomReturn1>string</ResponseCustomReturn1>
    <ResponseCustomReturn2>string</ResponseCustomReturn2>
    <ResponseCustomReturn3>string</ResponseCustomReturn3>
    <ResponseCustomReturn4>string</ResponseCustomReturn4>
    <ResponseCustomReturn5>string</ResponseCustomReturn5>
    <ResponseDebugging>string</ResponseDebugging>
    <ResponseOrderSuccess>
      <ResponseOrderSuccess>
        <OrderID>string</OrderID>
        <OrderStatusID>string</OrderStatusID>
        <OrderCustomerID>string</OrderCustomerID>
        <OrderInfo>string</OrderInfo>
      </ResponseOrderSuccess>
      <ResponseOrderSuccess>
        <OrderID>string</OrderID>
        <OrderStatusID>string</OrderStatusID>
        <OrderCustomerID>string</OrderCustomerID>
        <OrderInfo>string</OrderInfo>
      </ResponseOrderSuccess>
    </ResponseOrderSuccess>
    <ResponseOrderErrors>
      <ResponseOrderError>
        <OrderInfo>string</OrderInfo>
        <OrderErrors d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ResponseOrderError>
      <ResponseOrderError>
        <OrderInfo>string</OrderInfo>
        <OrderErrors d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ResponseOrderError>
    </ResponseOrderErrors>
    <ResponseOrderMessages>
      <ResponseOrderMessage>
        <OrderInfo>string</OrderInfo>
        <OrderMessages d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ResponseOrderMessage>
      <ResponseOrderMessage>
        <OrderInfo>string</OrderInfo>
        <OrderMessages d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ResponseOrderMessage>
    </ResponseOrderMessages>
  </Response>
</ClassificationAttributes>

Parameter	Value
ClientName:
Guid:
ClassificationId: