Website logo

Retrieve member commitment contracts

Retrieves list of commitment contracts by member id

URL: https://api.trademe.co.nz/v1/Property/PartnershipAgreements.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: PropertyB2BInternalServicesRead: Oidc read 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.

Query String parameters

memberId String (optional)

Returns

<MemberCommitmentContractsResponse>

The list of commitment contracts

Success Boolean

Indicates whether the operation was successful.
CommitmentContracts Collection of <CommitmentContract> or null

A list of commitment contracts belonging to the member.
CrmId String or null

The external ID of the contract from the source system
MemberId Integer or null

The member ID of the agency for which this contract applies
StartDate DateTime or null

The start date of the contract. If not supplied, this will be defaulted to the current date
EndDate DateTime or null

The end date of the contract. If not supplied, the contract will not expire
ItemCode String or null

The financial item code for the depth product applied to listings as part of this contract. This will be used for invoicing purposes
InvoiceLine String or null

The descriptive invoice line for the depth product applied to listings as part of this contract
PaymentType String or null

The payment type for the depth product applied to listings as part of this contract
ListingFee Boolean

If true, when a listing is created while this contract is in effect, the listing fee (or base fee) will not be charged. If false, the listing fee will continue to be charged
FeatureCombo Boolean

If true, Feature Combo will be applied to listings subject to this contract
PackageCode String or null

The code of any package that are applied to listings subject to this contract
CategoryIds Collection of Integer or null

The listing categories in which this contract will apply
ListingExtras Collection of <ListingExtras> or null

The listing extras that are applied to listings subject to this contract
Name String or null

The name of the extra.
Variant String or null

The variation of the extra. For example this could determine the duration, delay, or configuration of the listing extra.
AutoApplyPremiumPackage Boolean or null

Flag for whether the PA is NOT Flexi or Flexi (true = Not Flexi)

Example XML Response (switch to JSON) 

<MemberCommitmentContractsResponse xmlns="http://api.trademe.co.nz/v1">
  <Success>false</Success>
  <CommitmentContracts>
    <CommitmentContract>
      <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>
    </CommitmentContract>
    <CommitmentContract>
      <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>
    </CommitmentContract>
  </CommitmentContracts>
</MemberCommitmentContractsResponse>

Example JSON Response (switch to XML) 

{
  "Success": false,
  "CommitmentContracts": [
    {
      "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
    },
    {
      "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
    }
  ]
}