Website logo

Send delivery address info to seller

Selects a delivery address for an auction you've won and sends that information, along with an optional phone number and message, to the seller. Do not use this API if the buyer is planning to pay with Pay Now, since the Pay Now process already includes this step. An address can only be sent once; the buyer must contact the seller directly if there was a mistake.

URL: https://api.trademe.co.nz/v1/Bidding/SendDeliveryAddress.{file_format}
HTTP Method: POST
Requires Authentication? Yes
Permission Required: BiddingAndBuying: Place bids, and complete purchases using Buy Now & Fixed Price Offers.
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

<SendDeliveryAddressRequest>

PurchaseId Integer (required)

The purchase ID of the item that was won. This can be obtained from the Won Items API or from the Buy Now API.
DeliveryAddressId Integer (optional)

The ID of the delivery address to send to the seller (returned by the add address API or via the retrieve delivery addresses API).
ContactPhoneNumber String (optional)

The buyer’s phone number.
MessageToSeller String (optional)

A message to the seller.
ReturnListingDetails Boolean (optional)

Indicates whether full listing details should be returned in the response.

Returns

<SendDeliveryAddressResponse>

Indicates whether or not the operation succeeded.

Success Boolean

Indicates whether the operation was successful.
Description String or null

The description of the error, if the operation failed.

Example XML Request (switch to JSON) 

<SendDeliveryAddressRequest xmlns="http://api.trademe.co.nz/v1">
  <PurchaseId>123</PurchaseId>
  <DeliveryAddressId>123</DeliveryAddressId>
  <ContactPhoneNumber>ABC</ContactPhoneNumber>
  <MessageToSeller>ABC</MessageToSeller>
  <ReturnListingDetails>false</ReturnListingDetails>
</SendDeliveryAddressRequest>

Example JSON Request (switch to XML) 

{
  "PurchaseId": 123,
  "DeliveryAddressId": 123,
  "ContactPhoneNumber": "ABC",
  "MessageToSeller": "ABC",
  "ReturnListingDetails": false
}

Example XML Response (switch to JSON) 

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

Example JSON Response (switch to XML) 

{
  "Success": false,
  "Description": "ABC"
}