Website logo

Get position packages

Returns a set of position package tiers

URL: https://api.trademe.co.nz/v1/Jobs/Catalogue/PositionPackages.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: None
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.

Query String parameters

category_id Integer (optional)

Used to determine pricing based on category if applicable
position_id Integer (optional)

Used when editing a position to ensure you get the version of package data included when the position was created
return_metadata Boolean (optional)

Should be provided if we want to return metadata about the PackageSetVersion
skip_current_agent Boolean (optional)

Used when want to get all packages tiers as an anonymous member

Returns

<PositionPackageResponse>

PackageSetVersionMetadata <PackageSetVersionMetadata> or null

Metadata about the package set, only returned if requested
PackageSetVersionId Integer

The package set version ID
PackageData Collection of <PackageData> or null

List of position packages
Tier Enumeration

The type of package tier
None 0

None
Bronze 1

Bronze
Silver 2

Silver
Gold 3

Gold
Platinum 4

Platinum
Fifth 5

Fifth
Sixth 6

Sixth
DisplayName String or null

The display name for the package tier
PriceGstExcluded Number

The price of the package tier excluding GST
PriceGstIncluded Number

The price of the package tier including GST
HighlightFlagValue String or null

The highlight flag for the package tier
Featured Boolean

Whether the package tier is featured
AllowsBranding Boolean

Whether the package tier allows branding
AllowsPhotos Boolean

Whether the package tier allows photos
AllowsVideo Boolean

Whether the package tier allows video
AllowsPromotedListing Boolean

Whether the package tier allows promoted listing
DurationDays Integer

Duration of listings for the package tier
CandidateSearchQuotaAdded Integer

Candidate search quota for listings in the package tier
ProvidingSource <FeeItemProvidingSource> or null

Listing fee providing source for the package tier
Name String or null

The name of the providing source.
Remaining Integer

The number of items remaining in this source, or 0 if the source is unlimited.
IsUnlimited Boolean

True if it is possible to create unlimited listings at the provided rate
GroupName String or null

The group name for the package tier

Example XML Response (switch to JSON) 

<PositionPackageResponse xmlns="http://api.trademe.co.nz/v1">
  <PackageSetVersionMetadata>
    <PackageSetVersionId>123</PackageSetVersionId>
  </PackageSetVersionMetadata>
  <PackageData>
    <PackageData>
      <Tier>None</Tier>
      <DisplayName>ABC</DisplayName>
      <PriceGstExcluded>123.0</PriceGstExcluded>
      <PriceGstIncluded>123.0</PriceGstIncluded>
      <HighlightFlagValue>ABC</HighlightFlagValue>
      <Featured>false</Featured>
      <AllowsBranding>false</AllowsBranding>
      <AllowsPhotos>false</AllowsPhotos>
      <AllowsVideo>false</AllowsVideo>
      <AllowsPromotedListing>false</AllowsPromotedListing>
      <DurationDays>123</DurationDays>
      <CandidateSearchQuotaAdded>123</CandidateSearchQuotaAdded>
      <ProvidingSource>
        <Name>ABC</Name>
        <Remaining>123</Remaining>
        <IsUnlimited>false</IsUnlimited>
      </ProvidingSource>
      <GroupName>ABC</GroupName>
    </PackageData>
    <PackageData>
      <Tier>None</Tier>
      <DisplayName>ABC</DisplayName>
      <PriceGstExcluded>123.0</PriceGstExcluded>
      <PriceGstIncluded>123.0</PriceGstIncluded>
      <HighlightFlagValue>ABC</HighlightFlagValue>
      <Featured>false</Featured>
      <AllowsBranding>false</AllowsBranding>
      <AllowsPhotos>false</AllowsPhotos>
      <AllowsVideo>false</AllowsVideo>
      <AllowsPromotedListing>false</AllowsPromotedListing>
      <DurationDays>123</DurationDays>
      <CandidateSearchQuotaAdded>123</CandidateSearchQuotaAdded>
      <ProvidingSource>
        <Name>ABC</Name>
        <Remaining>123</Remaining>
        <IsUnlimited>false</IsUnlimited>
      </ProvidingSource>
      <GroupName>ABC</GroupName>
    </PackageData>
  </PackageData>
</PositionPackageResponse>

Example JSON Response (switch to XML) 

{
  "PackageSetVersionMetadata": {
    "PackageSetVersionId": 123
  },
  "PackageData": [
    {
      "Tier": 0,
      "DisplayName": "ABC",
      "PriceGstExcluded": 123.0,
      "PriceGstIncluded": 123.0,
      "HighlightFlagValue": "ABC",
      "Featured": false,
      "AllowsBranding": false,
      "AllowsPhotos": false,
      "AllowsVideo": false,
      "AllowsPromotedListing": false,
      "DurationDays": 123,
      "CandidateSearchQuotaAdded": 123,
      "ProvidingSource": {
        "Name": "ABC",
        "Remaining": 123,
        "IsUnlimited": false
      },
      "GroupName": "ABC"
    },
    {
      "Tier": 0,
      "DisplayName": "ABC",
      "PriceGstExcluded": 123.0,
      "PriceGstIncluded": 123.0,
      "HighlightFlagValue": "ABC",
      "Featured": false,
      "AllowsBranding": false,
      "AllowsPhotos": false,
      "AllowsVideo": false,
      "AllowsPromotedListing": false,
      "DurationDays": 123,
      "CandidateSearchQuotaAdded": 123,
      "ProvidingSource": {
        "Name": "ABC",
        "Remaining": 123,
        "IsUnlimited": false
      },
      "GroupName": "ABC"
    }
  ]
}