Aurora API: Basket Item

The Basket Item API method allows you to add items to a users basket.

This article provides an example request, along with a response to get you started.

Basket Item

This API allows a users basket to be manipulated based on a given User Reference which can then be used when sending page requests to the Aurora front-end in the form of a user shopping cookie. Aurora will then use the shopping cookie value to retrieve the users basket respectively. For further information regarding the user shopping cookie, please contact Aurora Commerce support.

Add

Deferred: No

Example Request:

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <Basket>
        <Item>
          <Add>
            <UserReference>cb6bf744313126d0743fe443d7be6adb9446a1f5</UserReference>
            <ProductReference>PROD12345</ProductReference>
            <Quantity>2</Quantity>
          </Add>
        </Item>
      </Basket>
    </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>
        <BasketItemID>12356</BasketItemID>
        <BasketReference>3105-200-372</ BasketReference >
      </Data>
    </Response>
  </Responses>
</AuroraResponseEnvelope>

Example Response (unsuccessful):

<AuroraResponseEnvolope>
     <Header>
         <Summary>
             <Ack>OK</Ack>
             <RequestsProcessed>1</RequestsProcessed>
             <RequestsSucceeded>0</RequestsSucceeded>
             <RequestErrors>1</RequestErrors>
         </Summary>
     </Header>
     <Responses>
        <Response>
             <RequestID>1</RequestID>
             <Ack>FATAL</Ack>
             <Errors>
                 <Error>
                     <Code>-9</Code>
                     <Message>Record not found: Product Reference: PROD1234</Message>
                     <Severity>FATAL</Severity>
                 </Error>
             </Errors>
         </Response>
     </Responses>
</AuroraResponseEnvolope>

Add Method - Request Fields

FieldValuesAPI VersionDescriptionRequired
UserReferenceString1.5+A unique User Reference.Yes
ProductReferenceString1.5+The product or variation reference of the item to be added to the users basket.Yes
QuantityInteger1.5+The quantity of the specified product or variation to be added to the users basket.No