Website logo

Get a list of Shipping Carrier Products

Retrieves a list of Carrier Products from the provided Carrier id.

URL: https://api.trademe.co.nz/v1/Shipping/Carriers/{carrierId}/Products.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: None
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

carrierId Integer (required)
file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Returns

Collection of <CarrierProduct>

CarrierProductId Integer

Unique identifier of the Carrier Product
Name String or null

Name of the Carrier Product
MinimumDeliveryTime TimeSpan

Minimum delivery time of the Carrier Product
MaximumDeliveryTime TimeSpan

Maximum delivery time of the Carrier Product
IsRural Boolean

If the product is rural
IsCombined Boolean

If the product is combined shipping
Addons Collection of <CarrierAddon> or null

List of Addons available to the product
CarrierAddonId Integer

Unique identifier of the Carrier Addon
Name String or null

Name of the addon
Type Enumeration

Type of the addon
Signature 0

Addon is Signature

Example XML Response (switch to JSON) 

<CarrierProductCollection xmlns="http://api.trademe.co.nz/v1">
  <CarrierProduct>
    <CarrierProductId>123</CarrierProductId>
    <Name>ABC</Name>
    <MinimumDeliveryTime>PT4H5M</MinimumDeliveryTime>
    <MaximumDeliveryTime>PT4H5M</MaximumDeliveryTime>
    <IsRural>false</IsRural>
    <IsCombined>false</IsCombined>
    <Addons>
      <CarrierAddon>
        <CarrierAddonId>123</CarrierAddonId>
        <Name>ABC</Name>
        <Type>Signature</Type>
      </CarrierAddon>
      <CarrierAddon>
        <CarrierAddonId>123</CarrierAddonId>
        <Name>ABC</Name>
        <Type>Signature</Type>
      </CarrierAddon>
    </Addons>
  </CarrierProduct>
  <CarrierProduct>
    <CarrierProductId>123</CarrierProductId>
    <Name>ABC</Name>
    <MinimumDeliveryTime>PT4H5M</MinimumDeliveryTime>
    <MaximumDeliveryTime>PT4H5M</MaximumDeliveryTime>
    <IsRural>false</IsRural>
    <IsCombined>false</IsCombined>
    <Addons>
      <CarrierAddon>
        <CarrierAddonId>123</CarrierAddonId>
        <Name>ABC</Name>
        <Type>Signature</Type>
      </CarrierAddon>
      <CarrierAddon>
        <CarrierAddonId>123</CarrierAddonId>
        <Name>ABC</Name>
        <Type>Signature</Type>
      </CarrierAddon>
    </Addons>
  </CarrierProduct>
</CarrierProductCollection>

Example JSON Response (switch to XML) 

[
  {
    "CarrierProductId": 123,
    "Name": "ABC",
    "MinimumDeliveryTime": "PT4H5M",
    "MaximumDeliveryTime": "PT4H5M",
    "IsRural": false,
    "IsCombined": false,
    "Addons": [
      {
        "CarrierAddonId": 123,
        "Name": "ABC",
        "Type": 0
      },
      {
        "CarrierAddonId": 123,
        "Name": "ABC",
        "Type": 0
      }
    ]
  },
  {
    "CarrierProductId": 123,
    "Name": "ABC",
    "MinimumDeliveryTime": "PT4H5M",
    "MaximumDeliveryTime": "PT4H5M",
    "IsRural": false,
    "IsCombined": false,
    "Addons": [
      {
        "CarrierAddonId": 123,
        "Name": "ABC",
        "Type": 0
      },
      {
        "CarrierAddonId": 123,
        "Name": "ABC",
        "Type": 0
      }
    ]
  }
]