SetShippingDiscountProfiles

This call enables a seller to define shipping cost discount profiles for things such as combined payments for shipping and handling costs (known as Combined Invoice orders).

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

Use My eBay in the Sandbox web site to become familiar with shipping discount profiles.
Call GetShippingDiscountProfiles to see what profiles and details have been defined for the seller, if any.
Call SetShippingDiscountProfiles with the sample code to define a WeightOff discount profile for calculated shipping.

For general ideas on testing shipping discount profiles, see GetShippingDiscountProfiles.

See Shipping discount profiles.

See also the reference documentation for this call:

GetShippingDiscountProfiles - This call retrieves all shipping discount profiles currently defined by the user, along with other Combined Invoice-related details such as packaging and handling costs.

Input

See also Samples.

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).

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

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<SetShippingDiscountProfilesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input 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> 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>
  <ModifyActionCode> ModifyActionCodeType </ModifyActionCode>
  <PromotionalShippingDiscountDetails> PromotionalShippingDiscountDetailsType
    <DiscountName> DiscountNameCodeType </DiscountName>
    <ItemCount> int </ItemCount>
    <OrderAmount currencyID="CurrencyCodeType"> AmountType (double) </OrderAmount>
    <ShippingCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingCost>
  </PromotionalShippingDiscountDetails>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</SetShippingDiscountProfilesRequest>

Argument	Type	Occurrence	Meaning

Call-specific Input Fields [Jump to standard fields]

CalculatedHandlingDiscount	CalculatedHandlingDiscountType	Optional	This container allows you to create, update, or delete a calculated handling discount profile.
CalculatedHandlingDiscount .DiscountName	HandlingNameCodeType	Conditional	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: See DiscountName.
CalculatedHandlingDiscount .EachAdditionalAmount	AmountType (double)	Conditional	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 the DiscountName value is `EachAdditionalAmount`.
CalculatedHandlingDiscount .EachAdditionalAmount [ attribute currencyID ]	CurrencyCodeType	Conditional	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 the DiscountName value is `EachAdditionalAmount`. For a list of possible enumeration values, see CurrencyCodeType.
CalculatedHandlingDiscount .EachAdditionalOffAmount	AmountType (double)	Conditional	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 the DiscountName value is `EachAdditionalOffAmount`.
CalculatedHandlingDiscount .EachAdditionalOffAmount [ attribute currencyID ]	CurrencyCodeType	Conditional	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 the DiscountName value is `EachAdditionalOffAmount`. For a list of possible enumeration values, see CurrencyCodeType.
CalculatedHandlingDiscount .EachAdditionalPercentOff	float	Conditional	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 the DiscountName value is `EachAdditionalPercentOff`.
CalculatedHandlingDiscount .OrderHandlingAmount	AmountType (double)	Conditional	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 the specified DiscountName value is `CombinedHandlingFee`.
CalculatedHandlingDiscount .OrderHandlingAmount [ attribute currencyID ]	CurrencyCodeType	Conditional	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 the specified DiscountName value is `CombinedHandlingFee`. For a list of possible enumeration values, see CurrencyCodeType.
CalculatedShippingDiscount	CalculatedShippingDiscountType	Optional	This container allows you to create, update, or delete a calculated shipping discount profile.
CalculatedShippingDiscount .DiscountName	DiscountNameCodeType	Conditional	This enumeration value indicates the type of calculated shipping discount rule that is being applied. Each rule is explained below. 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 https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/shipping-discount-profiles.html.
CalculatedShippingDiscount .DiscountProfile	DiscountProfileType	Conditional, repeatable: [0..*]	This container provides details of this particular calculated shipping discount profile. For SetShippingDiscountProfiles: If the ModifyActionCode value is set to `Update`, all details of the modified version of the profile must be provided. If the ModifyActionCode value is set to `Delete`, the DiscountProfileID is required, the MappingDiscountProfileID is optional, and all other fields of the container are no longer applicable. Restrictions on how many profiles can exist for a given discount rule are discussed in the Features Guide documentation on Shipping Cost Discount Profiles. See https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/shipping-discount-profiles.html.
CalculatedShippingDiscount .DiscountProfile .DiscountProfileID	string	Conditional	The unique eBay-created unique identifier for the shipping discount, assigned when the shipping discount rule is created. In a SetShippingDiscountProfiles call, If the value of ModifyActionCode is set to `Add`, this field is not applicable and is ignored If provided. If the value of Mod IfyActionCode is set to `Update`, all fields of the modified rule must be provided, even if the values are not changing. If the value of ModifyActionCode is set to `Delete`, either the DiscountProfileID value or is DiscountProfileName value is required, the MappingDiscountProfileID is optional, and all other fields of the DiscountProfile container are ignored.
CalculatedShippingDiscount .DiscountProfile .DiscountProfileName	string	Conditional	The seller-provided title for the shipping discount rule. In a SetShippingDiscountProfiles call, If the value of ModifyActionCode is set to `Add`, this field is ignored (if provided) if this is the first shipping discount rule being created, but this field is required if there is more than one existing shipping discount rule of that type (flat rate or calculated) If the value of ModifyActionCode is set to `Update`, all fields of the modified rule must be provided, even if the values are not changing If the value of ModifyActionCode is set to `Delete`, the DiscountProfileID is required, the MappingDiscountProfileID is optional, and all other fields of the DiscountProfile container are ignored If the value of ModifyActionCode is set to `Delete`, either the DiscountProfileID value or is DiscountProfileName value is required, the MappingDiscountProfileID is optional, and all other fields of the DiscountProfile container are ignored
CalculatedShippingDiscount .DiscountProfile .MappedDiscountProfileID	string	Conditional	For SetShippingDiscountProfiles, if MappedDiscountProfileID is omitted when ModifyActionCode is set to `Delete`, any listings currently using the profile identified by DiscountProfileID will have that profile removed.
CalculatedShippingDiscount .DiscountProfile.WeightOff	MeasureType (decimal)	Conditional	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. This field is only applicable for calculated shipping.
CombinedDuration	CombinedPaymentPeriodCodeType	Required	This field is used to specify the number of days after the purchase of an item that the buyer or seller can combine multiple and mutual order line items into one Combined Invoice order. In a Combined Invoice order, the buyer makes one payment for all order line items, hence only unpaid order line items can be combined into a Combined Invoice order. Applicable values: See CombinedDuration.
CurrencyID	CurrencyCodeType	Conditional	The three-digit code of the currency to be used for shipping discounts on Combined Invoice 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. This field is required if the user is adding or updating one or more shipping discount profiles. Note that There is a currencyID attribute on all SetShippingDiscountProfiles elements involving money. To avoid a call error, be sure to use the same currency type in these attributes as what is set for the CurrencyID field. Applicable values: See CurrencyID.
FlatShippingDiscount	FlatShippingDiscountType	Optional	This container allows you to create, update, or delete a flat-rate shipping discount profile.
FlatShippingDiscount .DiscountName	DiscountNameCodeType	Conditional	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. 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 https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/shipping-discount-profiles.html.
FlatShippingDiscount .DiscountProfile	DiscountProfileType	Conditional, repeatable: [0..*]	Details of this particular flat-rate shipping discount profile. If the value of 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. See https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/shipping-discount-profiles.html.
FlatShippingDiscount .DiscountProfile .DiscountProfileID	string	Conditional	The unique eBay-created unique identifier for the shipping discount, assigned when the shipping discount rule is created. In a SetShippingDiscountProfiles call, If the value of ModifyActionCode is set to `Add`, this field is not applicable and is ignored If provided. If the value of Mod IfyActionCode is set to `Update`, all fields of the modified rule must be provided, even if the values are not changing. If the value of ModifyActionCode is set to `Delete`, either the DiscountProfileID value or is DiscountProfileName value is required, the MappingDiscountProfileID is optional, and all other fields of the DiscountProfile container are ignored.
FlatShippingDiscount .DiscountProfile .DiscountProfileName	string	Conditional	The seller-provided title for the shipping discount rule. In a SetShippingDiscountProfiles call, If the value of ModifyActionCode is set to `Add`, this field is ignored (if provided) if this is the first shipping discount rule being created, but this field is required if there is more than one existing shipping discount rule of that type (flat rate or calculated) If the value of ModifyActionCode is set to `Update`, all fields of the modified rule must be provided, even if the values are not changing If the value of ModifyActionCode is set to `Delete`, the DiscountProfileID is required, the MappingDiscountProfileID is optional, and all other fields of the DiscountProfile container are ignored If the value of ModifyActionCode is set to `Delete`, either the DiscountProfileID value or is DiscountProfileName value is required, the MappingDiscountProfileID is optional, and all other fields of the DiscountProfile container are ignored
FlatShippingDiscount .DiscountProfile .EachAdditionalAmount	AmountType (double)	Conditional	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 the 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. This field is only applicable for flat-rate shipping.
FlatShippingDiscount .DiscountProfile .EachAdditionalAmount [ attribute currencyID ]	CurrencyCodeType	Conditional	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 the 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. This field is only applicable for flat-rate shipping. For a list of possible enumeration values, see CurrencyCodeType.
FlatShippingDiscount .DiscountProfile .EachAdditionalAmountOff	AmountType (double)	Conditional	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. This field is only applicable for flat-rate shipping.
FlatShippingDiscount .DiscountProfile .EachAdditionalAmountOff [ attribute currencyID ]	CurrencyCodeType	Conditional	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. This field is only applicable for flat-rate shipping. For a list of possible enumeration values, see CurrencyCodeType.
FlatShippingDiscount .DiscountProfile .EachAdditionalPercentOff	float	Conditional	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. This field is only applicable for flat-rate shipping.
ModifyActionCode	ModifyActionCodeType	Required	This field is used to set which action is being taken (`Add`, `Update`, or `Delete`) in the call. If you are adding a shipping discount rule, you will have to supply a name for that shipping discount profile. If you want to update or delete a shipping discount profile, you'll have to provide the unique identifier of this rule through the corresponding containers. The unique identifiers of these rules can be retrieved with the GetShippingDiscountRules call, or the seller can view these identifiers in My eBay Shipping Preferences. Applicable values: Add (in) This value is used in a SetShippingDiscountProfiles request to create a new shipping discount profile. CustomCode (in) Reserved for future use. Delete (in) This value is used in a SetShippingDiscountProfiles request to delete an existing shipping discount profile. Update (in) This value is used in a SetShippingDiscountProfiles request to modify an existing shipping discount profile.
PromotionalShippingDiscountDetails	PromotionalShippingDiscountDetailsType	Optional	This container allows you to create, update, or delete a promotional shipping discount profile.
PromotionalShippingDiscountDetails .DiscountName	DiscountNameCodeType	Conditional	The type of promotional shipping discount that is detailed in the profile. If the discount type is `MaximumShippingCostPerOrder`, see ShippingCost. If the discount type is `ShippingCostXForAmountY`, see ShippingCost and OrderAmount. If the discount type is `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	Conditional	This is the number of items when DiscountName is set to `ShippingCostXForItemsY`.
PromotionalShippingDiscountDetails .OrderAmount	AmountType (double)	Conditional	This is the cost Y of the order (not including shipping cost) when DiscountName is set to `ShippingCostXForAmountY`.
PromotionalShippingDiscountDetails .OrderAmount [ attribute currencyID ]	CurrencyCodeType	Conditional	This is the cost Y of the order (not including shipping cost) when DiscountName is set to `ShippingCostXForAmountY`. For a list of possible enumeration values, see CurrencyCodeType.
PromotionalShippingDiscountDetails .ShippingCost	AmountType (double)	Conditional	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	Conditional	This is shipping cost X when DiscountName is either `ShippingCostXForAmountY` or `ShippingCostXForItemCountN`, and is the maximum cost when DiscountName is `MaximumShippingCostPerOrder`. For a list of possible enumeration values, see CurrencyCodeType.

Standard Input Fields

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. Below are some examples from different countries.

ID	Country
en_AU	Australia
de_AT	Austria
nl_BE	Belgium (Dutch)
fr_BE	Belgium (French)
en_CA	Canada
fr_CA	Canada (French)
zh_CN	China
fr_FR	France
de_DE	Germany
zh_HK	Hong Kong
en_IN	India
en_IE	Ireland
it_IT	Italy
nl_NL	Netherlands
en_SG	Singapore
es_ES	Spain
de_CH	Switzerland
en_GB	United Kingdom
en_US	United States

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., 1149). 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:
    HTTP headers
    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 performed in the Production environment.

Applicable values:

High

(in) The WarningLevel value is set to High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.

Low

(in) The WarningLevel value is set to Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.

See Warning Level.

Output

See also Samples.

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 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"?>
<SetShippingDiscountProfilesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- (No call-specific Output fields) -->

  <!-- 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>
</SetShippingDiscountProfilesResponse>

Return Value	Type	Occurrence	Meaning

(No call-specific fields)

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 the Ack field. Applicable values: CustomCode (out) Reserved for internal or future use. Failure (out) This value indicates that the call request processing failed. Success (out) This value indicates that the call request was processed successfully without any issues. Warning (out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request. (Not all values in AckCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list.
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.
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. Code so that your app gracefully handles any future changes to this list.
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 Errors By Number.
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	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.Value	string	Conditionally	This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
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) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. If the source of the problem is within the application (such as a missing required element), change the application before you retry the request. If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay. If the source of the problem is on eBay's side, 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. See the Error handling section of the Making a Trading API call guide for more information. Warning (out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Code so that your app gracefully handles any future changes to this list.
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 the Time Values section in the eBay Features 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 the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.

Detail Controls

DetailLevel

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

Samples

New to making API calls? Please see Making a Call.

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

Creates a set of shipping discounts and sets up combined payments for multiple item orders.

Description

This sample creates a calculated shipping discount profile named Calc1, based on the WeightOff rule. It also specifies that packaging/handling cost for combined payment is to be the total of the packaging/handling costs of the individual items.

Input

XML format.

<?xml version="1.0" encoding="utf-8"?>
<SetShippingDiscountProfilesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <CalculatedHandlingDiscount>
    <DiscountName>I*******************e</DiscountName>
  </CalculatedHandlingDiscount>
  <CalculatedShippingDiscount>
    <DiscountName>W*******f</DiscountName>
    <DiscountProfile>
      <DiscountProfileName>C***1</DiscountProfileName>
      <WeightOff>2</WeightOff>
    </DiscountProfile>
  </CalculatedShippingDiscount>
  <CombinedDuration>Days_3</CombinedDuration>
  <CurrencyID>USD</CurrencyID>
  <ModifyActionCode>Add</ModifyActionCode>
</SetShippingDiscountProfilesRequest>

Output

XML format.
<SetShippingDiscountProfilesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
   <Timestamp>2019-11-07T18:09:57.370Z</Timestamp>
   <Ack>Success</Ack>
   <Version>1119</Version>
   <Build>E1119_CORE_APISHIP_19043790_R1</Build>
</SetShippingDiscountProfilesResponse>

Change History

Change Date	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.
505 2007-03-21	PromotionalShippingDiscountDetails (modified): The prior spelling was PromotionalShippingDiscount and it was based on PromotionalShippingDiscountType. It is now based on PromotionalShippingDiscountDetailsType.
503 2007-03-07	(added) New call.