Website logo

Tracking the listing process

Tracking the listing process

URL: https://api.trademe.co.nz/v1/Jobs/Positions/Track.{file_format}
HTTP Method: POST
Requires Authentication? Yes
Permission Required: MyTradeMeWrite: Maintain your watchlist, answer questions and post comments.
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.

POST Data

<JobsListingProcessTrackingBody>

DraftId String (required) DraftId
ListingStep Enumeration (required) ListingStep
Unknown 0 Unknown
Basics 1 Basics
Details 2 Details
Branding 3 Branding
Confirm 4 Confirm
Completed 5 Completed
Questions 6 Questions
EventType Enumeration (required) EventType
Unknown 0 Unknown
ListingStepViewed 1 ListingStepViewed
ListingStepCompleted 2 ListingStepCompleted
ListingStepCreated 3 ListingStepCreated
CategorySelected 4 CategorySelected
Category Integer (optional) Category
UtmMedium String (optional) UtmMedium
UtmSource String (optional) UtmSource
UtmCampaign String (optional) UtmCampaign

Returns

<ListingTrackingProcessResponse>

Information about the update of the position

Success Boolean Success

Example XML Request (switch to JSON)

<JobsListingProcessTrackingBody xmlns="http://api.trademe.co.nz/v1">
  <DraftId>ABC</DraftId>
  <ListingStep>Unknown</ListingStep>
  <EventType>Unknown</EventType>
  <Category>123</Category>
  <UtmMedium>ABC</UtmMedium>
  <UtmSource>ABC</UtmSource>
  <UtmCampaign>ABC</UtmCampaign>
</JobsListingProcessTrackingBody>

Example JSON Request (switch to XML)

{
  "DraftId": "ABC",
  "ListingStep": 0,
  "EventType": 0,
  "Category": 123,
  "UtmMedium": "ABC",
  "UtmSource": "ABC",
  "UtmCampaign": "ABC"
}

Example XML Response (switch to JSON)

<ListingTrackingProcessResponse xmlns="http://api.trademe.co.nz/v1">
  <Success>false</Success>
</ListingTrackingProcessResponse>

Example JSON Response (switch to XML)

{
  "Success": false
}