GetShippingDiscountProfiles

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

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

1. 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.
2. 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:

1. 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.
2. List an item without applying a shipping discount profile.
3. With another ID, buy these items and combine them into an order.
4. Call GetOrders and inspect the AmountSaved element in the response.
5. 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:
    Shipping information
    Combined invoice

See also the reference documentation for this call:

• SetShippingDiscountProfiles - This call enables a seller to create and manage shipping discounts rules.

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

  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetShippingDiscountProfilesRequest>

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"?>
<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>
  <PromotionalShippingDiscount> boolean </PromotionalShippingDiscount>
  <PromotionalShippingDiscountDetails> PromotionalShippingDiscountDetailsType
    <DiscountName> DiscountNameCodeType </DiscountName>
    <ItemCount> int </ItemCount>
    <OrderAmount currencyID="CurrencyCodeType"> AmountType (double) </OrderAmount>
    <ShippingCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingCost>
  </PromotionalShippingDiscountDetails>
  <!-- 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>

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.

Returns the currently set shipping discounts and combined payment settings.

Description

Seller m***************r 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.

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

Output

XML format.
<GetShippingDiscountProfilesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-05T22:23:16.114Z</Timestamp>
  <Ack>Success</Ack>
   <Version>1119</Version>
  <Build>E1119_CORE_APISHIP_19043790_R1</Build>
  <CurrencyID>USD</CurrencyID>
  <CalculatedShippingDiscount>
    <DiscountName>W*******f</DiscountName>
    <DiscountProfile>
      <DiscountProfileID>7*****0</DiscountProfileID>
      <DiscountProfileName>C***1</DiscountProfileName>
      <WeightOff>2</WeightOff>
    </DiscountProfile>
  </CalculatedShippingDiscount>
  <PromotionalShippingDiscount>false</PromotionalShippingDiscount>
  <CalculatedHandlingDiscount>
    <DiscountName>I*******************e</DiscountName>
  </CalculatedHandlingDiscount>
  <CombinedDuration>Days_3</CombinedDuration>
</GetShippingDiscountProfilesResponse>

Change History