Website logo

Add a photo to a listing

Adds a photo to an auction. The currently authenticated user must be the seller.

This API can currently only add a single photo to an auction without any photos. It is recommended that photos are instead specified when creating a listing or when using the edit listing API (both APIs can handle multiple photos).

URL: https://api.trademe.co.nz/v1/Photos/{photoId}/Add/{listingId}.{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

photoId Integer (required)

The ID of the photo to add.

listingId Integer (required)

The ID of the listing to add the photo to.

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

Returns

<PhotoResponse>

The ID of the added photo.

Status Enumeration

The status of the photo operation.

Failure 0

The photo action was a failure.

Success 1

The photo action was a success.

NotMemberPhoto 2

The photo is not owned by the member.

NotMemberAuction 3

The auction is not owned by the member.

NotFound 4

The auction was not found.

PhotoId Integer

The ID of the photo.

Description String or null

A description of the error message, if an error occurred.

Example XML Response (switch to JSON)

<PhotoResponse xmlns="http://api.trademe.co.nz/v1">
  <Status>Failure</Status>
  <PhotoId>123</PhotoId>
  <Description>ABC</Description>
</PhotoResponse>

Example JSON Response (switch to XML)

{
  "Status": 0,
  "PhotoId": 123,
  "Description": "ABC"
}