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:

1. Use My eBay in the Sandbox web site to become familiar with shipping discount profiles.
2. Call GetShippingDiscountProfiles to see what profiles and details have been defined for the seller, if any.
3. 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>

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>

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.

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月07日T18:09:57.370Z</Timestamp>
 <Ack>Success</Ack>
 <Version>1119</Version>
 <Build>E1119_CORE_APISHIP_19043790_R1</Build>
</SetShippingDiscountProfilesResponse>

Change History