Aurora API: Product Category

Product Category

Using this controller you can add, edit, delete and retrieve all Product Categories.

Add

Deferred: No

Example Request:

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <Product>
        <Category>
          <Add>
            <DisplayCategory>1</DisplayCategory>
            <Name>Test category</Name>
            <Title>Testing</Title>
            <Header>This is the header.</Header>
            <Footer>This is the footer.</Footer>
            <URLName>test-category</URLName>
            <URL>test-category</URL>
            <MetaTitle>Testing</MetaTitle>
            <MetaDescription>This is a description.</MetaDescription>
            <MetaKeywords>very, cool, category</MetaKeywords>
            <MetaRobots>noindex, nofollow</MetaRobots>
            <CanonicalURL></CanonicalURL>
            <Order>10</Order>
            <OrderBy></OrderBy>
            <ItemsPerPage>20</ItemsPerPage>
            <IsLandingPage>1</IsLandingPage>
            <IsMenuItem>1</IsMenuItem>
            <CategoryLevel>0</CategoryLevel>
            <ParentCategoryID>0</ParentCategoryID>
          </Add>
        </Category>
      </Product>
    </Request>
  </Requests>
</AuroraRequestEnvelope>

Example Response:

 <?xml version="1.0" encoding="utf-8"?>
<AuroraResponseEnvelope>
  <Header>
    <Summary>
      <Ack>OK</Ack>
      <RequestsProcessed>1</RequestsProcessed>
      <RequestsSucceeded>1</RequestsSucceeded>
      <RequestErrors>0</RequestErrors>
    </Summary>
  </Header>
  <Responses>
    <Response>
      <RequestID>1</RequestID>
      <Ack>OK</Ack>
      <Data>
        <CategoryID>5950</CategoryID>
      </Data>
    </Response>
  </Responses>
</AuroraResponseEnvelope>

Update

Deferred: No

The 'Update' call is almost identical to the 'Add' call with the only real difference being that most of the fields are now optional. While adding a new item requires that you provide all necessary information at once, when using the 'Update' method, you can just provide the information you wish to change and leave out all of the rest (excluding the relevant ID fields of course which are use to identify the records to be updated).

Example Request:

 <?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <Product>
        <Category>
          <Update>
            <CategoryID>5950</CategoryID>
            <Name>Test category updated</Name>
          </Update>
        </Category>
      </Product>
    </Request>
  </Requests>
</AuroraRequestEnvelope>

Example Response:

 <?xml version="1.0" encoding="utf-8"?>
<AuroraResponseEnvelope>
  <Header>
    <Summary>
      <Ack>OK</Ack>
      <RequestsProcessed>1</RequestsProcessed>
      <RequestsSucceeded>1</RequestsSucceeded>
      <RequestErrors>0</RequestErrors>
    </Summary>
  </Header>
  <Responses>
    <Response>
      <RequestID>1</RequestID>
      <Ack>OK</Ack>
      <Data>
        <CategoryID>5950</CategoryID>
      </Data>
    </Response>
  </Responses>
</AuroraResponseEnvelope>

Delete

Deferred: No

Example Request:

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
		<Product>
          <Category>
            <Delete>
             <CategoryIDs>
              <CategoryID>5950</CategoryID>
            </CategoryIDs>
          </Delete>
        </Category>
      </Product>
    </Request>
  </Requests>
</AuroraRequestEnvelope>

Example Response:

 <?xml version="1.0" encoding="utf-8"?>
<AuroraResponseEnvelope>
  <Header>
    <Summary>
      <Ack>OK</Ack>
      <RequestsProcessed>1</RequestsProcessed>
      <RequestsSucceeded>1</RequestsSucceeded>
      <RequestErrors>0</RequestErrors>
    </Summary>
  </Header>
  <Responses>
    <Response>
      <RequestID>1</RequestID>
      <Ack>OK</Ack>
      <Data/>
    </Response>
  </Responses>
</AuroraResponseEnvelope>

Request Fields

Get

This method allows access to the full list of product categories currently configured in Aurora. It is recommended that the Detail Level element is used to reduce the data overhead when requesting categories.

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>
				<Category>
					<Get>
						<RequestID>1</RequestID>
					</Get>
				</Category>
			</Product>
		</Request>
	</Requests>
</AuroraRequestEnvelope>

Example Request to get minimal data for all categories that belong to the parent category '123':

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<Header>
		<AuthToken>...</AuthToken>
	</Header>
	<Requests>
		<Request>
			<Product>
				<Category>
					<Get>
						<RequestID>1</RequestID>
						<ParentCategoryID>123</ParentCategoryID>
						<DetailLevel>Minimum</DetailLevel>
					</Get>
				</Category>
			</Product>
		</Request>
	</Requests>
</AuroraRequestEnvelope>

🚧

This will only return the first-level categories belonging to the specified parent category, i.e. sub-categories of child categories are not included and must be fetched separately.

Example Response:

<?xml version="1.0" encoding="utf-8"?>
<AuroraResponseEnvelope>
	<Header>
		<Summary>
			<Ack>OK</Ack>
			<RequestsProcessed>1</RequestsProcessed>
			<RequestsSucceeded>1</RequestsSucceeded>
			<RequestErrors>0</RequestErrors>
		</Summary>
	</Header>
	<Responses>
		<Response>
			<RequestID>1</RequestID>
			<Ack>OK</Ack>
			<Data>
				<Product>
					<Category>
            			<CategoryID>5950</CategoryID>
            			<DisplayCategory>1</DisplayCategory>
            			<Name>Test category</Name>
            			<Title>Testing</Title>
            			<Header>This is the header.</Header>
            			<Footer>This is the footer.</Footer>
            			<URLName>test-category</URLName>
            			<URL>test-category</URL>
            			<MetaTitle>Testing</MetaTitle>
            			<MetaDescription>This is a description.</MetaDescription>
            			<MetaKeywords>very, cool, category</MetaKeywords>
            			<MetaRobots/>
            			<CanonicalURL></CanonicalURL>
            			<Order>10</Order>
            			<OrderBy>price ASC</OrderBy>
            			<ItemsPerPage>20</ItemsPerPage>
            			<IsLandingPage>1</IsLandingPage>
            			<IsMenuItem>1</IsMenuItem>
            			<CategoryLevel>0</CategoryLevel>
            			<ParentCategoryID>0</ParentCategoryID>
						<DateCreated>2012-03-21 12:32:58</DateCreated>
						<DateModified>2012-03-21 12:50:00</DateModified>
					</Category>
				</Product>
			</Data>
		</Response>
	</Responses>
</AuroraResponseEnvelope>

Request Fields

Response fields