Website logo

Creates a partnership agreement

Creates a depth commitment contract. An agreement between an agency (member) and Trade Me, to upgrade all listings of a matched criteria, to a set level of depth product.

URL: https://api.trademe.co.nz/v1/Property/PartnershipAgreements.{file_format}
HTTP Method: POST
Requires Authentication? Yes
Permission Required: PropertyB2BInternalServicesWrite: Oidc write permission for Customer Broker Api
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

<CommitmentContractRequest>

CrmId String (required) CrmId
MemberId Integer (required) MemberId
StartDate DateTime (optional) StartDate
EndDate DateTime (optional) EndDate
ItemCode String (required) ItemCode
InvoiceLine String (required) InvoiceLine
PaymentType String (required) PaymentType
ListingFee Boolean (optional) ListingFee
FeatureCombo Boolean (optional) FeatureCombo
PackageCode String (optional) PackageCode
CategoryIds Collection of Integer (required) CategoryIds
ListingExtras Collection of <ListingExtras> (optional) ListingExtras
Name String (required) Name
Variant String (required) Variant
AutoApplyPremiumPackage Boolean (optional) AutoApplyPremiumPackage

Returns

<CommitmentContractResponse>

Success Boolean Success
Description String or null Description
CommitmentContractId Integer CommitmentContractId

Example XML Request (switch to JSON) 

<CommitmentContractRequest xmlns="http://api.trademe.co.nz/v1">
  <CrmId>ABC</CrmId>
  <MemberId>123</MemberId>
  <StartDate>2018-01-01T00:00:00Z</StartDate>
  <EndDate>2018-01-01T00:00:00Z</EndDate>
  <ItemCode>ABC</ItemCode>
  <InvoiceLine>ABC</InvoiceLine>
  <PaymentType>ABC</PaymentType>
  <ListingFee>false</ListingFee>
  <FeatureCombo>false</FeatureCombo>
  <PackageCode>ABC</PackageCode>
  <CategoryIds>
    <ListingExtra>123</ListingExtra>
    <ListingExtra>123</ListingExtra>
  </CategoryIds>
  <ListingExtras>
    <ListingExtras>
      <Name>ABC</Name>
      <Variant>ABC</Variant>
    </ListingExtras>
    <ListingExtras>
      <Name>ABC</Name>
      <Variant>ABC</Variant>
    </ListingExtras>
  </ListingExtras>
  <AutoApplyPremiumPackage>false</AutoApplyPremiumPackage>
</CommitmentContractRequest>

Example JSON Request (switch to XML) 

{
  "CrmId": "ABC",
  "MemberId": 123,
  "StartDate": "\/Date(1514764800)\/",
  "EndDate": "\/Date(1514764800)\/",
  "ItemCode": "ABC",
  "InvoiceLine": "ABC",
  "PaymentType": "ABC",
  "ListingFee": false,
  "FeatureCombo": false,
  "PackageCode": "ABC",
  "CategoryIds": [
    123,
    123
  ],
  "ListingExtras": [
    {
      "Name": "ABC",
      "Variant": "ABC"
    },
    {
      "Name": "ABC",
      "Variant": "ABC"
    }
  ],
  "AutoApplyPremiumPackage": false
}

Example XML Response (switch to JSON) 

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

Example JSON Response (switch to XML) 

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