Aurora API: Shipping Type

Suggest Edits

🚧
Coming Soon
MetapackShippingType field is deprecated. Shipping Type Add API will allow it to be present in the request xml, but will completely ignore it. Shipping Type Get API will export it as blank for backwards compatibility.

Shipping Type

Using this controller you can add, edit, delete, and retrieve all Shipping Types and Rules.

Add

Deferred: No

Example Request:

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <Shipping>
        <Type>
          <Add>
            <TypeName>Next Day Shipping Test</TypeName>
            <TypeDescription>Description</TypeDescription>
            <MinShippingDay>1</MinShippingDay>
            <MaxShippingDay>5</MaxShippingDay>
            <ShippingDays>1</ShippingDays>
            <ShippingZone>1</ShippingZone>
            <ServiceGroup>RMND</ServiceGroup>
            <Rules>
              <Rule>
                <ShippingSKU>INDPD</ShippingSKU>
                <ShippingZoneID>1</ShippingZoneID>
                <DefaultCourierID>1</DefaultCourierID>
                <ShippingOption>home_delivery</ShippingOption>
                <ShippingDescription>Description</ShippingDescription>
                <MinimumValue>1</MinimumValue>
                <MaximumValue>2</MaximumValue>
                <MinimumVolume>3</MinimumVolume>
                <MaximumVolume>4</MaximumVolume>
                <MaximumWeight>4</MaximumWeight>
                <MinimumWeight>3</MinimumWeight>
                <Price>12.95</Price>
                <EbayShippingType>UK_OtherCourier</EbayShippingType>
                <AmazonShippingType>Standard</AmazonShippingType>
                <MetapackShippingType>DPD Next Day</MetapackShippingType>
              </Rule>
            </Rules>
          </Add>
        </Type>
      </Shipping>
    </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>
        <TypeID>51</TypeID>
      </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 used to identify the records to be updated).

Example Request:

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <Shipping>
        <Type>
          <Update>
            <TypeID>51</TypeID>
            <Rules>
              <Rule>
                <ShippingSKU>United Kingdom</ShippingSKU>
                <ShippingZoneID>1</ShippingZoneID>
                <Price>20.00</Price>
              </Rule>
            </Rules>
          </Update>
        </Type>
      </Shipping>
    </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>
        <TypeID>51</TypeID>
      </Data>
    </Response>
  </Responses>
</AuroraResponseEnvelope>

Delete

Deferred: No

Example Request:

 <?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <Shipping>
        <Type>
          <Delete>
            <TypeIDs>
              <TypeID>51</TypeID>
            </TypeIDs>
          </Delete>
        </Type>
      </Shipping>
    </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

Field	Values	API Version	Description	Required
TypeIDs	Container	1.4+		No
TypeIDs.TypeID	Integer	1.4+	The ID of the Type to delete.	Only if 'TypeIDs' is provided

Get

Deferred: No

Records returned by this call are currently always ordered by the date they were created. This may change, so you should consider specifying the sort order of your results if this is going to affect your systems performance in the future.

The 'tracking' attribute can be used to denote whether or not tracking should be enabled, please see Request Tracking for more details.

Example Request:

 <?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <Shipping>
        <Type>
          <Get>
            <Paging>
              <Limit>2</Limit>
              <Page>1</Page>
            </Paging>
          </Get>
        </Type>
      </Shipping>
    </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>
      <Paging>
        <Token>140989cafb4cd4280b8f3cad08d166f3931</Token>
      </Paging>
      <Data>
        <Shipping>
          <Type>
            <TypeID>2</TypeID>
            <TypeName language="en-gb">Free Next Working Day With Yodel</TypeName>
            <TypeDescription language="en-gb"/>
            <MinShippingDay>1</MinShippingDay>
            <MaxShippingDay>1</MaxShippingDay>
            <ShippingDays>1,2,3,4,5</ShippingDays>
            <ShippingZone>1</ShippingZone>
            <ServiceGroup/>
          </Type>
          <Type>
            <TypeID>11</TypeID>
            <TypeName language="en-gb">Southern Ireland</TypeName>
            <TypeDescription language="en-gb"/>
            <MinShippingDay>1</MinShippingDay>
            <MaxShippingDay>14</MaxShippingDay>
            <ShippingDays>1,2,3,4,5</ShippingDays>
            <ShippingZone>9</ShippingZone>
            <ServiceGroup/>
            <Rules>
              <Rule>
                <RuleID>9</RuleID>
                <ShippingSKU>INDPD</ShippingSKU>
                <ShippingZoneID>9</ShippingZoneID>
                <DefaultCourierID>0</DefaultCourierID>
                <ShippingOption>home_delivery</ShippingOption>
                <ShippingDescription/>
                <MinimumValue/>
                <MaximumValue/>
                <MinimumWeight/>
                <MaximumWeight/>
                <MinimumVolume/>
                <MaximumVolume/>
                <Price>12.95</Price>
                <EbayShippingType>UK_OtherCourier</EbayShippingType>
                <AmazonShippingType>Standard</AmazonShippingType>
                <MetapackShippingType>DPD Next Day</MetapackShippingType>
              </Rule>
            </Rules>
          </Type>
        </Shipping>
      </Data>
    </Response>
  </Responses>
</AuroraResponseEnvelope>

Request Fields

Field	Values	API Version	Description	Required
TypeIDs	Container	1.4+		No
TypeIDs.TypeID	Integer	1.4+	The ID to restrict the result to.	Only if 'TypeIDs' is provided
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 allows for unique order exports to be set-up easily to avoid duplicate orders being downloaded.	No
Limit	Integer > 0	1.4+	The number of records to return	No
Paging	Container	1.4+	See Paging	No
Paging.Token	String	1.4+	This is the Token string issued from any previous Get call featuring paging. Providing this will have the API collect the data from the previously generated set of data, ensuring accurate and consistent dataset results for every page. You cannot change the request properties previously provided when using a Token, so these are ignored by the API.	No
Paging.Limit	Integer > 0	1.4+	The number of results to return in the page being requested	No
Paging.Page	Integer > 0	1.4+	The page number to return the results for	Only if 'Token' is provided

Updated over 2 years ago

🚧Coming Soon

Shipping Type

Add

Update

Delete

Request Fields

Get

Request Fields

🚧
Coming Soon