GetShippingDiscountProfiles

This call returns the shipping discount profiles defined by the user, along with the current settings for packaging and handling costs for combined payments.

You can test this call in the Sandbox, as follows:

Use My eBay in the Sandbox web site to define one or more flat rate shipping profiles, one or more calculated shipping profiles and a promotional discount. (See My eBay > Preferences > Combined Payments and Shipping Discounts.) Note that for flat and calculated shipping profiles, you have to click Advanced to create an additional profile, at which point, you are prompted for a name.
Call GetShippingDiscountProfiles to see what profiles and details have been defined for the seller, if any.

You can also do general testing of shipping discount profiles:

List two or more items that have domestic and international shipping services and that use one or more of the profiles you've set up. See ShippingDetails for these elements: ShippingDiscountProfileID, InternationalShippingDiscountProfileID, PromotionalShippingDiscount, and InternationalPromotionalShippingDiscount.
List an item without applying a shipping discount profile.
With another ID, buy these items and combine them into an order.
Call GetOrders and inspect the AmountSaved element in the response.
Call GetItem for the items in the order and inspect their shipping discount-related elements under ShippingDetails:

ShippingDiscountProfileID
InternationalShippingDiscountProfileID
PromotionalShippingDiscount
InternationalPromotionalShippingDiscount
CalculatedShippingDiscount
InternationalCalculatedShippingDiscount
FlatShippingDiscount
InternationalFlatShippingDiscount
PromotionalShippingDiscountDetails

See Other Shipping Features.

See also the reference documentation for these calls:

AddItem - Defines a single new item and lists it on a specified eBay site. Also for Half.com.
GetItem - Returns item data such as title, description, price information, seller information, and so on, for the specified ItemID.
RelistItem - Enables a seller to take a single item (or a single multi-item listing) and re-list it on a specified eBay site.
SetShippingDiscountProfiles - Enables a seller to define shipping cost discount profiles for things such as combined payments for shipping and handling costs.
VerifyAddItem - Enables a seller to specify the definition of a new item and submit the definition to eBay without creating a listing. Also for Half.com.

GetShippingDiscountProfiles Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

GetShippingDiscountProfiles Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<GetShippingDiscountProfilesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <CalculatedHandlingDiscount> CalculatedHandlingDiscountType
    <DiscountName> HandlingNameCodeType </DiscountName>
    <EachAdditionalAmount currencyID="CurrencyCodeType"> AmountType (double) </EachAdditionalAmount>
    <EachAdditionalOffAmount currencyID="CurrencyCodeType"> AmountType (double) </EachAdditionalOffAmount>
    <EachAdditionalPercentOff> float </EachAdditionalPercentOff>
    <OrderHandlingAmount currencyID="CurrencyCodeType"> AmountType (double) </OrderHandlingAmount>
  </CalculatedHandlingDiscount>
  <CalculatedShippingDiscount> CalculatedShippingDiscountType
    <DiscountName> DiscountNameCodeType </DiscountName>
    <DiscountProfile> DiscountProfileType
      <DiscountProfileID> string </DiscountProfileID>
      <DiscountProfileName> string </DiscountProfileName>
      <MappedDiscountProfileID> string </MappedDiscountProfileID>
      <WeightOff unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </WeightOff>
    </DiscountProfile>
    <!-- ... more DiscountProfile nodes allowed here ... -->
  </CalculatedShippingDiscount>
  <CombinedDuration> CombinedPaymentPeriodCodeType </CombinedDuration>
  <CurrencyID> CurrencyCodeType </CurrencyID>
  <FlatShippingDiscount> FlatShippingDiscountType
    <DiscountName> DiscountNameCodeType </DiscountName>
    <DiscountProfile> DiscountProfileType
      <DiscountProfileID> string </DiscountProfileID>
      <DiscountProfileName> string </DiscountProfileName>
      <EachAdditionalAmount currencyID="CurrencyCodeType"> AmountType (double) </EachAdditionalAmount>
      <EachAdditionalAmountOff currencyID="CurrencyCodeType"> AmountType (double) </EachAdditionalAmountOff>
      <EachAdditionalPercentOff> float </EachAdditionalPercentOff>
    </DiscountProfile>
    <!-- ... more DiscountProfile nodes allowed here ... -->
  </FlatShippingDiscount>
  <InternationalShippingInsurance> ShippingInsuranceType
    <FlatRateInsuranceRangeCost> FlatRateInsuranceRangeCostType
      <FlatRateInsuranceRange> FlatRateInsuranceRangeCodeType </FlatRateInsuranceRange>
      <InsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </InsuranceCost>
    </FlatRateInsuranceRangeCost>
    <!-- ... more FlatRateInsuranceRangeCost nodes allowed here ... -->
    <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
  </InternationalShippingInsurance>
  <PromotionalShippingDiscount> boolean </PromotionalShippingDiscount>
  <PromotionalShippingDiscountDetails> PromotionalShippingDiscountDetailsType
    <DiscountName> DiscountNameCodeType </DiscountName>
    <ItemCount> int </ItemCount>
    <OrderAmount currencyID="CurrencyCodeType"> AmountType (double) </OrderAmount>
    <ShippingCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingCost>
  </PromotionalShippingDiscountDetails>
  <ShippingInsurance> ShippingInsuranceType
    <FlatRateInsuranceRangeCost> FlatRateInsuranceRangeCostType
      <FlatRateInsuranceRange> FlatRateInsuranceRangeCodeType </FlatRateInsuranceRange>
      <InsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </InsuranceCost>
    </FlatRateInsuranceRangeCost>
    <!-- ... more FlatRateInsuranceRangeCost nodes allowed here ... -->
    <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
  </ShippingInsurance>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetShippingDiscountProfilesResponse>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

CalculatedHandlingDiscount	CalculatedHandlingDiscountType	Conditionally	This container is used by the seller to specify/modify packaging and handling discounts that are applied for combined payment orders. This container is only returned if it is set for the Shipping Discount Profile.
CalculatedHandlingDiscount .DiscountName	HandlingNameCodeType	Conditionally	The type of discount that is detailed in the profile. If the selection is EachAdditionalAmount, EachAdditionalAmountOff or EachAdditionalPercentOff, the value is set in the child element of same name in CalculatedHandlingDiscount. If the selection is CombinedHandlingFee, specify the amount in CalculatedHandlingDiscount.OrderHandlingAmount. If the selection is IndividualHandlingFee, the amount is determined by eBay by adding the fees of the individual items. Applicable values: • CombinedHandlingFee (in/out) The packaging/handling cost is to be N for the entire order. • CustomCode (in/out) Reserved for internal or future use. • EachAdditionalAmount (in/out) After eBay assigns the highest packaging/handling cost to the first item, the packaging/handling cost for each additional item is $n. • EachAdditionalAmountOff (in/out) After eBay assigns the highest packaging/handling cost to the first item, the packaging/handling cost for each additional item is to be reduced by amount N. • EachAdditionalPercentOff (in/out) After eBay assigns the highest packaging/handling cost to the first item, the packaging/handling cost for each additional item is to be reduced by N percent. • IndividualHandlingFee (in/out) The total packaging/handling cost is to be the sum of the packaging/handling costs of the individual items.
CalculatedHandlingDiscount .EachAdditionalAmount	AmountType (double)	Conditionally	The packaging/handling cost for each item beyond the first item (where the item with the highest packaging/handling cost is selected by eBay as the first item). Let's say the buyer purchases three items, each assigned a packaging/handling cost of $8, and the seller set EachAdditionalAmount to $6. The packaging/handling cost for three items would normally be $24, but since the seller specified $6, the total packaging/handling cost would be $8 + $6 + $6, or $20. This field is mutually exclusive with the other amount and percentage fields within this type. This field only applies when DiscountName is EachAdditionalAmount.
CalculatedHandlingDiscount .EachAdditionalAmount [ attribute currencyID ]	CurrencyCodeType	Conditionally	Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType.
CalculatedHandlingDiscount .EachAdditionalOffAmount	AmountType (double)	Conditionally	The amount by which to reduce the packaging/handling cost for each item beyond the first item (where the item with the highest packaging/handling cost is selected by eBay as the first item). Let's say the buyer purchases three items, each assigned a packaging/handling cost of $8, and the seller set EachAdditionalAmountOff to $2. The packaging/handling cost for three items would normally be $24, but since the seller specified $2, the total packaging/handling cost would be $24 - (two additional items x $2), or $20. This field is mutually exclusive with the other amount and percentage fields within this type. This field only applies when DiscountName is EachAdditionalOffAmount.
CalculatedHandlingDiscount .EachAdditionalOffAmount [ attribute currencyID ]	CurrencyCodeType	Conditionally	Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType.
CalculatedHandlingDiscount .EachAdditionalPercentOff	float	Conditionally	The percentage by which to reduce the packaging/handling cost for each item beyond the first item (where the item with the highest packaging/handling cost is selected by eBay as the first item). Let's say the buyer purchases three items, each assigned a packaging/handling cost of $8, and the seller set EachAdditionalPercentOff to 0.25. The packaging/handling cost for three items would normally be $24, but since the seller specified 0.25 ($2 out of 8), the total packaging/handling cost would be $24 - (two additional items x $2), or $20. This field is mutually exclusive with the amount fields within this type. This field only applies when DiscountName is EachAdditionalPercentOff.
CalculatedHandlingDiscount .OrderHandlingAmount	AmountType (double)	Conditionally	If specified, this is the fixed shipping cost to charge for an order, regardless of the number of items in the order. This field is mutually exclusive with the other amount and percentage fields within this type. This field only applies when DiscountName is CombinedHandlingFee.
CalculatedHandlingDiscount .OrderHandlingAmount [ attribute currencyID ]	CurrencyCodeType	Conditionally	Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType.
CalculatedShippingDiscount	CalculatedShippingDiscountType	Always	Details of an individual discount profile defined by the user for calculated shipping--one for each profile defined by the user. Empty if no shipping discount profiles were defined.
CalculatedShippingDiscount .DiscountName	DiscountNameCodeType	Conditionally	The type of discount or "rule" that is being used by the profile. Only WeightOff is a "variable" rule, as defined in the documentation on shipping discount profiles. Applicable values: • CombinedItemWeight (in/out) Shipping cost is based on the total weight of all individual items. This is simply a way to define how shipping is to be calculated--there is no discount for the buyer with this selection. For calculated shipping discount profile only. • IndividualItemWeight (in/out) Shipping cost is the total of what it would cost to ship each item individually. This is simply a way to define how shipping is to be calculated--there is no discount for the buyer with this selection. For calculated shipping discount profile only. • WeightOff (in/out) The amount of weight to subtract for each item beyond the first item before shipping costs are calculated. For example, there may be less packing material when the items are combined in one box than if they were shipped individually. Let's say the buyer purchases three items, each 10 oz. in weight, and the seller set WeightOff to 2 oz. The combined weight would be 30 oz., but since the seller specified 2 oz. off, the total weight for shipping cost calculation would be 30 oz. - (two additional items x 2 oz.), or 26 oz. For calculated shipping discount profile only. (Not all values in DiscountNameCodeType apply to this field.) See Other Shipping Features.
CalculatedShippingDiscount .DiscountProfile	DiscountProfileType	Conditionally, repeatable: [0..*]	Details of this particular calculated shipping discount profile. If ModifyActionCode is Modify, all details of the new version of the profile must be provided. If ModifyActionCode is Delete, DiscountProfileID is required, MappingDiscountProfileID is optional, and all other fields of DiscountProfile are ignored. Restrictions of how many profiles you can have for a given discount rule are discussed in the documentation on shipping discount profiles. See Other Shipping Features.
CalculatedShippingDiscount .DiscountProfile .DiscountProfileID	string	Conditionally	The unique eBay-created ID for the shipping discount, assigned when the profile is created. On input, if ModifyActionCode is Add, this is ignored if provided. If ModifyActionCode is Modify, all details of the new version of the profile must be provided. If ModifyActionCode is Delete, DiscountProfileID is required, MappingDiscountProfileID is optional, and all other fields of DiscountProfile are ignored.
CalculatedShippingDiscount .DiscountProfile .DiscountProfileName	string	Conditionally	The user's title for this profile. On input, if ModifyActionCode is Add, this is ignored (if provided) if this is the first profile being created and required if there is more than one profile of that type (flat rate versus calculated) already. To modify the name, set ModifyActionCode to Update and provide all details for the profile. On output, DiscountProfileName is only returned if the user defined more than one profile.
CalculatedShippingDiscount .DiscountProfile .MappedDiscountProfileID	string	Conditionally	For SetShippingDiscountProfiles, if MappedDiscountProfileID is omitted when ModifyActionCode is Delete, any listings currently using the profile identified by DiscountProfileID will have that profile removed. For SetShippingDiscountProfiles and GetItem, this is the intended discount profile mapping.
CalculatedShippingDiscount .DiscountProfile.WeightOff	MeasureType (decimal)	Conditionally	The weight by which to reduce the combined item weight, if the seller specified WeightOff as the type of profile, as noted in CalculatedShippingDiscount.DiscountName. The smallest unit is used (e.g. ounces). Calculated shipping only.
CalculatedShippingDiscount .DiscountProfile.WeightOff [ attribute unit ]	token	Conditionally	Unit of measure. This attribute is shared by various fields, representing units such as lbs, oz, kg, g, in, cm. For weight, English major/minor units are pounds and ounces, and metric major/minor units are kilograms and grams. For length, the English unit is inches, and metric unit is centimeters. To get the full list of package dimension and weight measurement units (and all alternative spellings and abbreviations) supported by your site, call GeteBayDetails.
CalculatedShippingDiscount .DiscountProfile.WeightOff [ attribute measurementSystem ]	MeasurementSystemCodeType	Conditionally	The system of measurement (e.g., English). For a list of possible enumeration values, see MeasurementSystemCodeType.
CombinedDuration	CombinedPaymentPeriodCodeType	Always	This field indicates the number of days after the sale of an item in which the buyer or seller can combine multiple and mutual order line items into one Combined Payment order. In a Combined Payment order, the buyer makes one payment for all order line items, hence only unpaid order line items can be combined into a Combined Payment order. Applicable values: • CustomCode (in/out) This value is reserved for internal or future use. • Days_3 (in/out) This value indicates that an unpaid order can be combined into a Combined Payment order within three days after purchase (creation of order). • Days_5 (in/out) This value indicates that an unpaid order can be combined into a Combined Payment order within five days after purchase (creation of order). • Days_7 (in/out) This value indicates that an unpaid order can be combined into a Combined Payment order within seven days after purchase (creation of order). • Days_14 (in/out) This value indicates that an unpaid order can be combined into a Combined Payment order within 14 days after purchase (creation of order). • Days_30 (in/out) This value indicates that an unpaid order can be combined into a Combined Payment order within 30 days after purchase (creation of order). • Ineligible (in/out) This value indicates that an order is not eligible to be combined into a Combined Payment order.
CurrencyID	CurrencyCodeType	Always	The three-digit code of the currency to be used for shipping cost discounts and insurance for combined payment orders. A discount profile can only be associated with a listing if the CurrencyID value of the profile matches the Item.Currency value specified in a listing. Applicable values: See CurrencyID.
FlatShippingDiscount	FlatShippingDiscountType	Always	Details of an individual discount profile defined by the user for flat rate shipping--one for each profile defined by the user. Empty if no shipping discount profiles were defined.
FlatShippingDiscount .DiscountName	DiscountNameCodeType	Conditionally	The type of discount or "rule" that is being used by the profile. The value corresponding to the selected rule is set in the same-named field of FlatShippingDiscount.DiscountProfile. All are "variable" rules, as defined in the documentation on shipping discount profiles. Applicable values: • EachAdditionalAmount (in/out) The cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalAmount to $6. The cost to ship three items would normally be $24, but since the seller specified $6, the total shipping cost would be $8 + $6 + $6, or $20. For flat shipping discount profile only. • EachAdditionalAmountOff (in/out) The amount by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalAmountOff to $2. The cost to ship three items would normally be $24, but since the seller specified $2, the total shipping cost would be $24 - (two additional items x $2), or $20. For flat shipping discount profile only. • EachAdditionalPercentOff (in/out) The percentage by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalPercentOff to 0.25. The cost to ship three items would normally be $24, but since the seller specified 0.25 ($2 out of 8), the total shipping cost would be $24 - (two additional items x $2), or $20. For flat rate shipping discount profile only. (Not all values in DiscountNameCodeType apply to this field.) See Other Shipping Features.
FlatShippingDiscount .DiscountProfile	DiscountProfileType	Conditionally, repeatable: [0..*]	Details of this particular flat rate shipping discount profile. If ModifyActionCode is Modify, all details of the new version of the profile must be provided. If ModifyActionCode is Delete, DiscountProfileID is required, MappingDiscountProfileID is optional, and all other fields of DiscountProfile are ignored. Restrictions of how many profiles you can have for a given discount rule are discussed in the documentation on shipping discount profiles. See Other Shipping Features.
FlatShippingDiscount .DiscountProfile .DiscountProfileID	string	Conditionally	The unique eBay-created ID for the shipping discount, assigned when the profile is created. On input, if ModifyActionCode is Add, this is ignored if provided. If ModifyActionCode is Modify, all details of the new version of the profile must be provided. If ModifyActionCode is Delete, DiscountProfileID is required, MappingDiscountProfileID is optional, and all other fields of DiscountProfile are ignored.
FlatShippingDiscount .DiscountProfile .DiscountProfileName	string	Conditionally	The user's title for this profile. On input, if ModifyActionCode is Add, this is ignored (if provided) if this is the first profile being created and required if there is more than one profile of that type (flat rate versus calculated) already. To modify the name, set ModifyActionCode to Update and provide all details for the profile. On output, DiscountProfileName is only returned if the user defined more than one profile.
FlatShippingDiscount .DiscountProfile .EachAdditionalAmount	AmountType (double)	Conditionally	The amount, if the seller specified EachAdditionalAmount as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only.
FlatShippingDiscount .DiscountProfile .EachAdditionalAmount [ attribute currencyID ]	CurrencyCodeType	Conditionally	Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType.
FlatShippingDiscount .DiscountProfile .EachAdditionalAmountOff	AmountType (double)	Conditionally	The amount, if the seller specified EachAdditionalAmountOff as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only.
FlatShippingDiscount .DiscountProfile .EachAdditionalAmountOff [ attribute currencyID ]	CurrencyCodeType	Conditionally	Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType.
FlatShippingDiscount .DiscountProfile .EachAdditionalPercentOff	float	Conditionally	The percent (expressed in decimal, as in .5 for 50%), if the seller specified EachAdditionalPercentOff as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only.
InternationalShippingInsurance	ShippingInsuranceType	Conditionally	The data for the international insurance for combined payment. Returned only if it has been defined.
InternationalShippingInsurance .FlatRateInsuranceRangeCost	FlatRateInsuranceRangeCostType	Conditionally, repeatable: [0..*]	A pairing of range of item price total and insurance cost. For SetShippingDiscountProfiles, if InsuranceOption is Optional or Required, you must submit all range pairs. For those ranges that do not apply, set the cost to 0.
InternationalShippingInsurance .FlatRateInsuranceRangeCost .FlatRateInsuranceRange	FlatRateInsuranceRangeCodeType	Conditionally	The price range for the shipment for which the insurance cost is being specified. This field is no longer applicable to SetUserPreferences or GetUserPreferences. Applicable values: • CustomCode (in/out) Reserved for internal or future use • FlatRateInsuranceRange1 (in/out) Range is 0.01 to 9.99 • FlatRateInsuranceRange2 (in/out) Range is 10.00 to 49.99 • FlatRateInsuranceRange3 (in/out) Range is 50.00 to 99.99 • FlatRateInsuranceRange4 (in/out) Range is 100.00 to 199.99 • FlatRateInsuranceRange5 (in/out) Range is 200.00 to 299.99 • FlatRateInsuranceRange6 (in/out) Range is 300.00 or greater
InternationalShippingInsurance .FlatRateInsuranceRangeCost .InsuranceCost	AmountType (double)	Conditionally	The cost of insurance for the specified price range. This field is no longer applicable to SetUserPreferences or GetUserPreferences.
InternationalShippingInsurance .FlatRateInsuranceRangeCost .InsuranceCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType.
InternationalShippingInsurance .InsuranceOption	InsuranceOptionCodeType	Conditionally	Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Flat and calculated shipping. Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • NotOfferedOnSite (out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance.
PromotionalShippingDiscount	boolean	Always	Indicates whether the user defined a promotional discount (the discount is active as soon as it exists).
PromotionalShippingDiscountDetails	PromotionalShippingDiscountDetailsType	Conditionally	The data for the specific promotional shipping discount. Returned only if it has been defined.
PromotionalShippingDiscountDetails .DiscountName	DiscountNameCodeType	Conditionally	The type of promotional shipping discount that is detailed in the profile. If MaximumShippingCostPerOrder, see ShippingCost. If ShippingCostXForAmountY, see ShippingCost and OrderAmount. If ShippingCostXForItemCountN, see ShippingCost and ItemCount. Applicable values: • MaximumShippingCostPerOrder (in/out) The shipping cost will not exceed this. For promotional discount only. • ShippingCostXForAmountY (in/out) Shipping cost X applies if the total cost of items purchased is Y. For promotional discount only. • ShippingCostXForItemCountN (in/out) Shipping cost X applies if the total number of items purchased is N. For promotional discount only. (Not all values in DiscountNameCodeType apply to this field.)
PromotionalShippingDiscountDetails .ItemCount	int	Conditionally	This is the number of items, when DiscountName is set to ShippingCostXForItemsY.
PromotionalShippingDiscountDetails .OrderAmount	AmountType (double)	Conditionally	This is the cost Y of the order (not including shipping cost), when DiscountName is set to ShippingCostXForAmountY.
PromotionalShippingDiscountDetails .OrderAmount [ attribute currencyID ]	CurrencyCodeType	Conditionally	Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType.
PromotionalShippingDiscountDetails .ShippingCost	AmountType (double)	Conditionally	This is shipping cost X, when DiscountName is either ShippingCostXForAmountY or ShippingCostXForItemCountN, and is the maximum cost when DiscountName is MaximumShippingCostPerOrder.
PromotionalShippingDiscountDetails .ShippingCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType.
ShippingInsurance	ShippingInsuranceType	Conditionally	The data for the domestic insurance for combined payment. Returned only if it has been defined.
ShippingInsurance .FlatRateInsuranceRangeCost	FlatRateInsuranceRangeCostType	Conditionally, repeatable: [0..*]	A pairing of range of item price total and insurance cost. For SetShippingDiscountProfiles, if InsuranceOption is Optional or Required, you must submit all range pairs. For those ranges that do not apply, set the cost to 0.
ShippingInsurance .FlatRateInsuranceRangeCost .FlatRateInsuranceRange	FlatRateInsuranceRangeCodeType	Conditionally	The price range for the shipment for which the insurance cost is being specified. This field is no longer applicable to SetUserPreferences or GetUserPreferences. Applicable values: • CustomCode (in/out) Reserved for internal or future use • FlatRateInsuranceRange1 (in/out) Range is 0.01 to 9.99 • FlatRateInsuranceRange2 (in/out) Range is 10.00 to 49.99 • FlatRateInsuranceRange3 (in/out) Range is 50.00 to 99.99 • FlatRateInsuranceRange4 (in/out) Range is 100.00 to 199.99 • FlatRateInsuranceRange5 (in/out) Range is 200.00 to 299.99 • FlatRateInsuranceRange6 (in/out) Range is 300.00 or greater
ShippingInsurance .FlatRateInsuranceRangeCost .InsuranceCost	AmountType (double)	Conditionally	The cost of insurance for the specified price range. This field is no longer applicable to SetUserPreferences or GetUserPreferences.
ShippingInsurance .FlatRateInsuranceRangeCost .InsuranceCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType.
ShippingInsurance .InsuranceOption	InsuranceOptionCodeType	Conditionally	Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Flat and calculated shipping. Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • NotOfferedOnSite (out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance.

Standard Output Fields

Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType	Conditionally, repeatable: [0..*]	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters	ErrorParameterType	Conditionally, repeatable: [0..*]	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.

GetShippingDiscountProfiles Detail Controls

Detail Control: DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

GetShippingDiscountProfiles Samples

New to making API calls? Please see Routing the Request.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Returns the currently set shipping discounts and combined payment settings.

Description

Magical Bookseller wants to ensure she has the correct set of shipping discounts and combined payment settings. This sample retrieves the current settings for the authenticated user.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<GetShippingDiscountProfilesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <WarningLevel>High</WarningLevel>
</GetShippingDiscountProfilesRequest>

Output

XML format. Also available is the .txt version of this XML.

<GetShippingDiscountProfilesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2010-01-26T21:30:11.532Z</Timestamp>
  <Ack>Success</Ack>
  <Version>643</Version>
  <Build>E643_CORE_BUNDLED_10284414_R1</Build>
  <CurrencyID>USD</CurrencyID>
  <CalculatedShippingDiscount>
    <DiscountName>WeightOff</DiscountName>
    <DiscountProfile>
      <DiscountProfileID>7452000</DiscountProfileID>
      <DiscountProfileName>Calc1</DiscountProfileName>
      <WeightOff>2</WeightOff>
    </DiscountProfile>
  </CalculatedShippingDiscount>
  <PromotionalShippingDiscount>false</PromotionalShippingDiscount>
  <CalculatedHandlingDiscount>
    <DiscountName>IndividualHandlingFee</DiscountName>
  </CalculatedHandlingDiscount>
  <CombinedDuration>Days_3</CombinedDuration>
</GetShippingDiscountProfilesResponse>

GetShippingDiscountProfiles Change History

Version	Description
635 2009-09-16	InsuranceDetails, InsuranceFee, InsuranceOption, InternationalInsuranceDetails, InsuranceWanted, ShippingInsuranceCost (modified): Sellers can no longer give buyers the option to purchase shipping insurance for either domestic or international items. The buyer-paid shipping insurance option has been removed from the following sites: `BEFR, BENL, CA, CAFR, HK, IE, IN, MY, Motors, NL, PH, PL, SG, UK, US` Insurance tags are returned only when the associated item has buyer-paid shipping insurance values.
503 2007-03-07	CalculatedHandlingDiscount, PromotionalShippingDiscountDetails, ShippingInsurance, InternationalShippingInsurance (added): These elements round out the new Shipping Discount Profiles feature introduced via preview on 499. See the feature documentation in Selling Items on eBay > Shipping > Miscellaneous Shipping Topics > Shipping Cost Discount Profiles.
499 2007-02-07	(added) New call.

User-Contributed Notes

ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: Routing the Request (Gateway URLs) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.

eBay Trading API Call Reference Version 821