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

PurchaseId	Integer (required)	PurchaseId
DeliveryAddressId	Integer (optional)	DeliveryAddressId
ContactPhoneNumber	String (optional)	ContactPhoneNumber
MessageToSeller	String (optional)	MessageToSeller
ReturnListingDetails	Boolean (optional)	ReturnListingDetails

Returns

Indicates whether or not the operation succeeded.

Success	Boolean	Success
Description	String or null	Description

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"
}