Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

upsell_id

Required. A unique ID for an upsell.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

<?xml version="1.0" encoding="UTF-8"?>
<getUpsellResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <upsell>
    <name>Sample Upsell 1</name>
    <description>Upsell Description 1</description>
    <label>Upsell label</label>
    <id>101</id>
    <price>1001</price>
    <fairMarketValue>1001</fairMarketValue>
    <moreInfoLink>http://example.com/moreinfo</moreInfoLink>
    <required>false</required>
    <order>1</order>
    <inventoryDepleted>false</inventoryDepleted>
    <option>
      <additionalCharge>0</additionalCharge>
      <text>Size 0</text>
      <id>201</id>
      <order>0</order>
      <display>true</display>
    </option>
    <option>
      <additionalCharge>0</additionalCharge>
      <text>Size 1</text>
      <id>202</id>
      <order>1</order>
      <display>true</display>
    </option>
    <option>
      <additionalCharge>0</additionalCharge>
      <text>Size 2</text>
      <id>203</id>
      <order>2</order>
      <display>true</display>
    </option>
  </upsell>
</getUpsellResponse>

        

{"getUpsellResponse":{"upsell":{"fairMarketValue":"1001","id":"101","price":"1001","order":"1","moreInfoLink":"http://example.com/moreinfo","description":"Upsell Description 1","name":"Sample Upsell 1","label":"Upsell label","required":"false","inventoryDepleted":"false","option":[{"id":"201","text":"Size 0","order":"0","display":"true","additionalCharge":"0"},{"id":"202","text":"Size 1","order":"1","display":"true","additionalCharge":"0"},{"id":"203","text":"Size 2","order":"2","display":"true","additionalCharge":"0"}]}}}