Aurora API: Product Review

Product Review

Using this controller you can retrieve all Product Reviews

Get

This method allows access to the full list of product reviews in Aurora.

Deferred: No

Example Request to get all data for all categories:

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Header>
        <AuthToken>...</AuthToken>
    </Header>
    <Requests>
        <Request>
            <Product>
                <Review>
                    <Get>
                        <RequestID>1</RequestID>
                        <ProductIDs>
                            <ProductID>27654</ProductID>
                        </ProductIDs>
                    </Get>
                </Review>
            </Product>
        </Request>
    </Requests>
</AuroraRequestEnvelope>

Example Response:

<?xml version="1.0" encoding="utf-8"?>
<AuroraResponseEnvelope>
    <Header>
        <Version>head</Version>
        <Timestamp>2015-05-21T10:09:06+01:00</Timestamp>
        <RequestDetails></RequestDetails>
        <Summary>
            <Ack>OK</Ack>
            <RequestsProcessed>1</RequestsProcessed>
            <RequestsSucceeded>1</RequestsSucceeded>
            <RequestErrors>0</RequestErrors>
        </Summary>
    </Header>
    <Responses>
        <Response>
            <RequestID>1</RequestID>
            <Ack>OK</Ack>
            <Paging>
                <Token>6dbdc5b62d9058fba8116bf47bcb329f994</Token>
            </Paging>
            <Data>
                <Reviews>
                    <Review>
                        <ReviewId>19833</ReviewId>
						<DateCreated>2017-12-22T10:41:06+00:00</DateCreated>
                        <ProductId>27654</ProductId>
                        <UserId></UserId>
                        <Approved>1</Approved>
                        <ReviewerName>Anonymous</ReviewerName>
                        <ReviewerLocation></ReviewerLocation>
                        <ReviewerEmailAddress></ReviewerEmailAddress>
                        <Rating>4.00</Rating>
                        <ReviewTitle>...a little big big:)</ReviewTitle>
                        <ReviewContent>...a little big big:)</ReviewContent>
                        <ReviewVideoLink></ReviewVideoLink>
                    </Review>
                </Reviews>
            </Data>
        </Response>
    </Responses>
</AuroraResponseEnvelope>

Request Fields

Field	Values	API Version	Description	Required
DetailLevel	Detail Levels	1.4+	This allows the client to request varying volumes of data when receiving data back from the server.	No
Language	"all" or language ISO	1.4+	This allows the client to request specific or all languages to be returned. If not included in the request the default language will be returned.	No
Tracking	Request Tracking	1.4+	If this is set to 'unsent' then any orders previously retrieved via the current API account while 'tracking' was active will be excluded from the results. This allow for unique order exports to be set-up easily to avoid duplicate orders being downloaded.	No
ProductIds	Container	1.4+		No
ProductIds.ProductId	Integer > 0	1.4+	Any number of product IDs can be provided using a separate 'ProductId' tag for each	Only if 'ProductIds' is provided

Response fields

Field	Values	API Version	Description
ReviewId	Integer > 0	1.4+	The Internal ID Aurora uses to identify a Product Review.
DateCreated	String	1.5+	The date the review was created
ProductId	Integer > 0	1.4+	The Internal ID Aurora uses to identify a Product.
UserId	Integer > 0	1.4+	The Internal ID Aurora uses to identify a User/Customer.
Approved	1 or 0	1.4+	1 if the review has been approved by an admin and 0 otherwise.
ReviewerName	String	1.4+	The customer’s Name (If provided).
ReviewerLocation	String	1.4+	The customer’s Location (If provided).
ReviewerEmailAddress	String	1.4+	The customer’s Email Address (If provided).
Rating	Float	1.4+
ReviewTitle	String	1.4+	The title given to the review by the customer.
ReviewContent	String	1.4+	The customer's actual review.
ReviewVideoLink	String	1.4+	The customer’s Review Video Link (If provided).

Add

Deferred: No

Example Request:

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <Product>
        <Review>
          <Add>
            <ProductID>32596</ProductID>
			<DateCreated>2019-12-22T10:41:06+00:00</DateCreated>
            <Approved>1</Approved>
            <ReviewerName>Mr. Name</ReviewerName>
            <ReviewerLocation></ReviewerLocation>
            <ReviewerEmailAddress>[email protected]</ReviewerEmailAddress>
            <Rating>4.50</Rating>
            <ReviewTitle>...a little big big:)</ReviewTitle>
            <ReviewContent>...a little big big:)</ReviewContent>
            <ReviewVideoLink>video link here</ReviewVideoLink>
          </Add>
        </Review>
      </Product>
    </Request>
  </Requests>
</AuroraRequestEnvelope>

Example Response:

<?xml version="1.0" encoding="utf-8"?>
<AuroraResponseEnvelope>
    <Header>
        <Version>head</Version>
        <Timestamp>2019-05-28T21:43:49+01:00</Timestamp>
        <RequestDetails></RequestDetails>
        <Summary>
            <Ack>OK</Ack>
            <RequestsProcessed>1</RequestsProcessed>
            <RequestsSucceeded>1</RequestsSucceeded>
            <RequestErrors>0</RequestErrors>
        </Summary>
    </Header>
    <Responses>
        <Response>
            <RequestID>1</RequestID>
            <Ack>OK</Ack>
            <Data>
                <ReviewID>50</ReviewID>
            </Data>
        </Response>
    </Responses>
</AuroraResponseEnvelope>

Update

Deferred: No

The 'Update' call is almost identical to the 'Add' call with the only real difference being that you must include the ReviewID

Example Request:

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <Product>
        <Review>
          <Update>
            <ReviewID>50</ReviewID>
            <ProductID>32597</ProductID>
            <UserID>5</UserID>
            <Approved>1</Approved>
            <ReviewerName>Anonymous 12</ReviewerName>
            <ReviewerLocation>Cambridge</ReviewerLocation>
            <ReviewerEmailAddress>[email protected]</ReviewerEmailAddress>
            <Rating>4.50</Rating>
            <ReviewTitle>...a little big big:)</ReviewTitle>
            <ReviewContent>...a little big big:)</ReviewContent>
            <ReviewVideoLink>video link here</ReviewVideoLink>
          </Update>
        </Review>
      </Product>
    </Request>
  </Requests>
</AuroraRequestEnvelope>

Example Response:

<?xml version="1.0" encoding="utf-8"?>
<AuroraResponseEnvelope>
    <Header>
        <Version>head</Version>
        <Timestamp>2019-05-28T21:46:02+01:00</Timestamp>
        <RequestDetails></RequestDetails>
        <Summary>
            <Ack>OK</Ack>
            <RequestsProcessed>1</RequestsProcessed>
            <RequestsSucceeded>1</RequestsSucceeded>
            <RequestErrors>0</RequestErrors>
        </Summary>
    </Header>
    <Responses>
        <Response>
            <RequestID>1</RequestID>
            <Ack>OK</Ack>
            <Data>
                <ReviewID>50</ReviewID>
            </Data>
        </Response>
    </Responses>
</AuroraResponseEnvelope>

Updated over 2 years ago