Website logo

Retrieve details about volume plans and job packs

Retrieves fee information for job products including Job Packs and Volume Plans Specifically information that does not relate to purchasing a specfic listing

URL: https://api.trademe.co.nz/v1/Jobs/Payments/FeeApiJobsAccessInformationProviders.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: MyTradeMeRead: Read your membership & listing data.
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

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

Returns

<JobsFees>

A JobsFees containing details about Job Packs and Volume Plans

JobPacks Collection of <JobPack> or null

A collection of all available job packs
Id Integer

The id of the product
Size Integer

The number of listings provided by the product
Price Number

The cost of the product excluding GST
Duration String or null

A description of the duration of the product
AddOns Collection of <AddOn> or null

A collection of add-ons available for this product
Name String or null

The name of the add-on
Price Number or null

The price of an add-on
RequiresExtendedStatus Boolean

Requires the purchaser to be a agent with extended job pack status enabled
VolumePlans Collection of <VolumePlan> or null

A collection of all available volume plans
Id Integer

The id of the product
Size Integer

The number of listings provided by the product
Price Number

The cost of the product excluding GST
Duration String or null

A description of the duration of the product
AddOns Collection of <AddOn> or null

A collection of add-ons available for this product
Name String or null

The name of the add-on
Price Number or null

The price of an add-on
FreeListings Integer

The number of free listings provided on top of the number of listings provided in the plan per month

Example XML Response (switch to JSON) 

<JobsFees xmlns="http://api.trademe.co.nz/v1">
  <JobPacks>
    <JobPack>
      <Id>123</Id>
      <Size>123</Size>
      <Price>123.0</Price>
      <Duration>ABC</Duration>
      <AddOns>
        <AddOn>
          <Name>ABC</Name>
          <Price>123.0</Price>
        </AddOn>
        <AddOn>
          <Name>ABC</Name>
          <Price>123.0</Price>
        </AddOn>
      </AddOns>
      <RequiresExtendedStatus>false</RequiresExtendedStatus>
    </JobPack>
    <JobPack>
      <Id>123</Id>
      <Size>123</Size>
      <Price>123.0</Price>
      <Duration>ABC</Duration>
      <AddOns>
        <AddOn>
          <Name>ABC</Name>
          <Price>123.0</Price>
        </AddOn>
        <AddOn>
          <Name>ABC</Name>
          <Price>123.0</Price>
        </AddOn>
      </AddOns>
      <RequiresExtendedStatus>false</RequiresExtendedStatus>
    </JobPack>
  </JobPacks>
  <VolumePlans>
    <VolumePlan>
      <Id>123</Id>
      <Size>123</Size>
      <Price>123.0</Price>
      <Duration>ABC</Duration>
      <AddOns>
        <AddOn>
          <Name>ABC</Name>
          <Price>123.0</Price>
        </AddOn>
        <AddOn>
          <Name>ABC</Name>
          <Price>123.0</Price>
        </AddOn>
      </AddOns>
      <FreeListings>123</FreeListings>
    </VolumePlan>
    <VolumePlan>
      <Id>123</Id>
      <Size>123</Size>
      <Price>123.0</Price>
      <Duration>ABC</Duration>
      <AddOns>
        <AddOn>
          <Name>ABC</Name>
          <Price>123.0</Price>
        </AddOn>
        <AddOn>
          <Name>ABC</Name>
          <Price>123.0</Price>
        </AddOn>
      </AddOns>
      <FreeListings>123</FreeListings>
    </VolumePlan>
  </VolumePlans>
</JobsFees>

Example JSON Response (switch to XML) 

{
  "JobPacks": [
    {
      "Id": 123,
      "Size": 123,
      "Price": 123.0,
      "Duration": "ABC",
      "AddOns": [
        {
          "Name": "ABC",
          "Price": 123.0
        },
        {
          "Name": "ABC",
          "Price": 123.0
        }
      ],
      "RequiresExtendedStatus": false
    },
    {
      "Id": 123,
      "Size": 123,
      "Price": 123.0,
      "Duration": "ABC",
      "AddOns": [
        {
          "Name": "ABC",
          "Price": 123.0
        },
        {
          "Name": "ABC",
          "Price": 123.0
        }
      ],
      "RequiresExtendedStatus": false
    }
  ],
  "VolumePlans": [
    {
      "Id": 123,
      "Size": 123,
      "Price": 123.0,
      "Duration": "ABC",
      "AddOns": [
        {
          "Name": "ABC",
          "Price": 123.0
        },
        {
          "Name": "ABC",
          "Price": 123.0
        }
      ],
      "FreeListings": 123
    },
    {
      "Id": 123,
      "Size": 123,
      "Price": 123.0,
      "Duration": "ABC",
      "AddOns": [
        {
          "Name": "ABC",
          "Price": 123.0
        },
        {
          "Name": "ABC",
          "Price": 123.0
        }
      ],
      "FreeListings": 123
    }
  ]
}