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)

GUID for the listing process draft

ListingStep Enumeration (required)

The listing step

Unknown 0

Unknown

Basics 1

listing step in the basic page

Details 2

listing step in details page

Branding 3

listing step in branding page

Confirm 4

listing step in the comfirm page

Completed 5

listing process completed

Questions 6

listing process completed

EventType Enumeration (required)

type of event

Unknown 0

listing step unknown

ListingStepViewed 1

listing step viewed

ListingStepCompleted 2

listing step completed

ListingStepCreated 3

listing step created

CategorySelected 4

Category selected in basics page

Category Integer (optional)

The category id if present

UtmMedium String (optional)

Medium UTM parameter if present

UtmSource String (optional)

Source UTM parameter if present

UtmCampaign String (optional)

Campaign UTM parameter if present

Returns

<ListingTrackingProcessResponse>

Information about the update of the position

Success Boolean

Indicates whether the operation was successful.

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
}