GET/combined_shipping_rules
This method can be used to retrieve all existing combined shipping rule configurations defined by the authenticated seller, including calculated, flat, and promotional types.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
This method has no URI parameters.
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
| Header | Type | Description |
|---|---|---|
| X-EBAY-C-MARKETPLACE-ID | string | This header identifies the eBay marketplace identifier for which the API request is being executed (e.g., EBAY_US, EBAY_GB, EBAY_DE). For the full list of eBay marketplace values, see the MarketplaceIdEnum. Occurrence: Required |
OAuth scope
This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.account.readonly
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| calculatedHandlingRule | CalculatedHandlingRuleType | This container will show one or more calculated shipping rules set up for that seller on that ebay marketplace. Occurrence: Conditional |
| calculatedHandlingRule.combinedShippingRuleType | CombinedShippingRuleTypeHandlingEnum | This enumeration value specifies the type of combined-shipping rule applied to handling fees (for example, weight-based, flat-rate, or percentage-based calculation method). Occurrence: Conditional |
| calculatedHandlingRule.eachAdditionalAmount | Amount | This container specifies the additional monetary charge applied for each extra item included in a combined shipment. Occurrence: Conditional |
| calculatedHandlingRule.eachAdditionalAmount.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
| calculatedHandlingRule.eachAdditionalAmount.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
| calculatedHandlingRule.eachAdditionalAmountOffShippingCost | Amount | This container represents the fixed monetary discount deducted from the total shipping cost for each additional item in a combined shipment. Occurrence: Conditional |
| calculatedHandlingRule.eachAdditionalAmountOffShippingCost.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
| calculatedHandlingRule.eachAdditionalAmountOffShippingCost.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
| calculatedHandlingRule.eachAdditionalPercentOffShippingCost | number | This integer specifies the percentage discount applied to the total shipping cost for each additional item in a combined shipment. Occurrence: Conditional |
| calculatedHandlingRule.orderHandlingAmount | Amount | This container represents the handling fee charged for processing a combined order, if applicable. Occurrence: Conditional |
| calculatedHandlingRule.orderHandlingAmount.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
| calculatedHandlingRule.orderHandlingAmount.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
| calculatedShippingRule | CalculatedShippingRuleType | This container specifies the type of combined-shipping rule applied, such as flat-rate, weight-based, or cost-based. Occurrence: Conditional |
| calculatedShippingRule.combinedShippingRules | array of CombinedShippingRule | This array lists the discount rules applied to combined shipments, detailing calculation methods and rule identifiers. Occurrence: Conditional |
| calculatedShippingRule.combinedShippingRules.combinedShippingRuleId | string | This field represents the unique identifier for the combined-shipping discount profile, used to reference or update a specific rule configuration. Occurrence: Conditional |
| calculatedShippingRule.combinedShippingRules.combinedShippingRuleName | string | This field specifies the unique name identifying the combined shipping discount profile within the seller’s account. Occurrence: Conditional |
| calculatedShippingRule.combinedShippingRules.eachAdditionalAmount | Amount | This container defines the additional monetary charge applied for each extra item when multiple items are shipped together. Occurrence: Conditional |
| calculatedShippingRule.combinedShippingRules.eachAdditionalAmount.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
| calculatedShippingRule.combinedShippingRules.eachAdditionalAmount.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
| calculatedShippingRule.combinedShippingRules.eachAdditionalAmountOffShippingCost | Amount | This container defines the fixed discount amount deducted from the total shipping cost for each additional item. Occurrence: Conditional |
| calculatedShippingRule.combinedShippingRules.eachAdditionalAmountOffShippingCost.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
| calculatedShippingRule.combinedShippingRules.eachAdditionalAmountOffShippingCost.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
| calculatedShippingRule.combinedShippingRules.eachAdditionalPercentOffShippingCost | number | This integer specifies the percentage discount applied to the total shipping cost for each additional item in the combined order. Occurrence: Conditional |
| calculatedShippingRule.combinedShippingRules.mappedCombinedShippingRuleId | string | This field specifies the unique ID that links this combined-shipping rule to another related rule in the seller’s account. Occurrence: Conditional |
| calculatedShippingRule.combinedShippingRules.weightOffTotalWeight | MeasureType | This container specifies the total weight reduction applied when combining multiple items into one shipment. Occurrence: Conditional |
| calculatedShippingRule.combinedShippingRules.weightOffTotalWeight.unit | WeightUnitOfMeasureEnum | This field defines the unit of measure (e.g., kilograms, pounds) associated with the value field. Occurrence: Conditional |
| calculatedShippingRule.combinedShippingRules.weightOffTotalWeight.value | string | This field defines the numeric value representing the measurement, weight, in the specified unit. Occurrence: Conditional |
| calculatedShippingRule.combinedShippingRuleType | CombinedShippingRuleTypeEnum | This container defines the type of combined-shipping rule applied to calculate discounts, such as weight-based, percentage-based, or flat-rate models. Occurrence: Conditional |
| combinedDuration | CombinedPaymentPeriodEnum | This field is represented by one of the values in the CombinedPaymentPeriodEnum. Occurrence: Conditional |
| flatShippingRule | FlatShippingRuleType | This container will show one or more flat shipping rules set up for that seller on that eBay marketplace. Occurrence: Conditional |
| flatShippingRule.combinedShippingRules | array of CombinedShippingRule | This array specifies the type of combined-shipping rule applied, such as flat-rate or cost-based. Occurrence: Conditional |
| flatShippingRule.combinedShippingRules.combinedShippingRuleId | string | This field represents the unique identifier for the combined-shipping discount profile, used to reference or update a specific rule configuration. Occurrence: Conditional |
| flatShippingRule.combinedShippingRules.combinedShippingRuleName | string | This field specifies the unique name identifying the combined shipping discount profile within the seller’s account. Occurrence: Conditional |
| flatShippingRule.combinedShippingRules.eachAdditionalAmount | Amount | This container defines the additional monetary charge applied for each extra item when multiple items are shipped together. Occurrence: Conditional |
| flatShippingRule.combinedShippingRules.eachAdditionalAmount.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
| flatShippingRule.combinedShippingRules.eachAdditionalAmount.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
| flatShippingRule.combinedShippingRules.eachAdditionalAmountOffShippingCost | Amount | This container defines the fixed discount amount deducted from the total shipping cost for each additional item. Occurrence: Conditional |
| flatShippingRule.combinedShippingRules.eachAdditionalAmountOffShippingCost.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
| flatShippingRule.combinedShippingRules.eachAdditionalAmountOffShippingCost.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
| flatShippingRule.combinedShippingRules.eachAdditionalPercentOffShippingCost | number | This integer specifies the percentage discount applied to the total shipping cost for each additional item in the combined order. Occurrence: Conditional |
| flatShippingRule.combinedShippingRules.mappedCombinedShippingRuleId | string | This field specifies the unique ID that links this combined-shipping rule to another related rule in the seller’s account. Occurrence: Conditional |
| flatShippingRule.combinedShippingRules.weightOffTotalWeight | MeasureType | This container specifies the total weight reduction applied when combining multiple items into one shipment. Occurrence: Conditional |
| flatShippingRule.combinedShippingRules.weightOffTotalWeight.unit | WeightUnitOfMeasureEnum | This field defines the unit of measure (e.g., kilograms, pounds) associated with the value field. Occurrence: Conditional |
| flatShippingRule.combinedShippingRules.weightOffTotalWeight.value | string | This field defines the numeric value representing the measurement, weight, in the specified unit. Occurrence: Conditional |
| flatShippingRule.combinedShippingRuleType | CombinedShippingRuleTypeEnum | This container defines the type of discount rule applied (e.g., percentage-based, fixed-rate). Occurrence: Conditional |
| promotionalShippingRule | PromotionalShippingRuleType | This container shows the promotional shipping rule that is currently set up on the seller's account for the eBay marketplace. Occurrence: Conditional |
| promotionalShippingRule.combinedShippingRuleType | CombinedShippingRuleTypeEnum | This field specifies the type of combined-shipping rule applied, such as flat-rate or cost-based, as defined in the CombinedShippingRuleTypeEnum. Occurrence: Conditional |
| promotionalShippingRule.itemCount | integer | This integer indicates the quantity of items that must be purchased by the buyer in order for that buyer to qualify for the promotional discount. Occurrence: Conditional |
| promotionalShippingRule.orderAmount | Amount | This container specifies the minimum order amount required to qualify for the associated discount or promotional rule. Occurrence: Conditional |
| promotionalShippingRule.orderAmount.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
| promotionalShippingRule.orderAmount.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
| promotionalShippingRule.shippingCost | Amount | This container represents the total shipping cost or discounted shipping charge for the combined order. Occurrence: Conditional |
| promotionalShippingRule.shippingCost.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
| promotionalShippingRule.shippingCost.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 395000 | API_ACCOUNT | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 396023 | API_ACCOUNT | REQUEST | The specified marketplace ID was not found. |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Retrieve combined shipping rules
This method is used to retrieve combined shipping rules, configured by the seller.
Input
This method does not have a request body. Only the X-EBAY-C-MARKETPLACE-ID header is required.
GEThttps://api.ebay.com/sell/account/v2/combined_shipping_rules
Output
If the call is successful, the combined shipping rules are returned in the response body. These include details such as flat shipping discounts, calculated shipping discounts, and promotional shipping discounts.