Skip to main content

POST/combined_shipping_rules/update_calculated_shipping_rules

This method updates previously defined calculated shipping rules to modify discount percentages, weight offsets, or amount parameters for the seller.

Input

Resource URI

POST https://api.ebay.com/sell/account/v2/combined_shipping_rules/update_calculated_shipping_rules

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.

HeaderTypeDescription
X-EBAY-C-MARKETPLACE-IDstringThis field header specifies the eBay marketplace identifier for this request, ensuring the operation targets the correct regional site

(e.g., EBAY_US, EBAY_GB, EBAY_DE).

For the full list of eBay marketplace values, see the https://developer.ebay.com/api-docs/sell/account/v2/types/ba:MarketplaceIdEnum type.

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

See OAuth access tokens for more information.

Request payload

Copy complete valid JSON to clipboard
{ /* UpdateCalculatedShippingRulesRequest */
"calculatedHandlingRule" :
{ /* CalculatedHandlingRuleType */
"combinedShippingRuleType" : "CombinedShippingRuleTypeHandlingEnum : [COMBINED_HANDLING_FEE,EACH_ADDITIONAL_AMOUNT,EACH_ADDITIONAL_AMOUNT_OFF...]",
"eachAdditionalAmount" :
{ /* Amount */
"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",
"value" : "string"
},
"eachAdditionalAmountOffShippingCost" :
{ /* Amount */
"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",
"value" : "string"
},
"eachAdditionalPercentOffShippingCost" : "number",
"orderHandlingAmount" :
{ /* Amount */
"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",
"value" : "string"
}
},
"calculatedShippingRule" :
{ /* CalculatedShippingRuleType */
"combinedShippingRules" : [
{ /* CombinedShippingRule */
"combinedShippingRuleId" : "string",
"combinedShippingRuleName" : "string",
"eachAdditionalAmount" :
{ /* Amount */
"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",
"value" : "string"
},
"eachAdditionalAmountOffShippingCost" :
{ /* Amount */
"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",
"value" : "string"
},
"eachAdditionalPercentOffShippingCost" : "number",
"mappedCombinedShippingRuleId" : "string",
"weightOffTotalWeight" :
{ /* MeasureType */
"unit" : "WeightUnitOfMeasureEnum : [POUND,KILOGRAM,OUNCE...]",
"value" : "string"
}
}
],
"combinedShippingRuleType" : "CombinedShippingRuleTypeEnum : [COMBINED_ITEM_WEIGHT,EACH_ADDITIONAL_AMOUNT,EACH_ADDITIONAL_AMOUNT_OFF...]"
},
"combinedDuration" : "CombinedPaymentPeriodEnum : [DAYS_14,DAYS_3,DAYS_30...]"
}

Request fields

Input container/fieldTypeDescription
calculatedHandlingRuleCalculatedHandlingRuleType

This container specifies the calculated handling rule that determines how handling fees are automatically computed based on order weight, quantity, or value in a combined shipment.

Occurrence: Optional

calculatedHandlingRule.combinedShippingRuleTypeCombinedShippingRuleTypeHandlingEnum

This enumeration type specifies the type of combined-shipping rule applied to handling fees

(for example, weight-based, flat-rate, or percentage-based calculation method).

Occurrence: Optional

calculatedHandlingRule.eachAdditionalAmountAmount

This container specifies the additional monetary charge applied for each extra item included in a combined shipment.

Occurrence: Optional

calculatedHandlingRule.eachAdditionalAmount.currencyCurrencyCodeEnum

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Occurrence: Optional

calculatedHandlingRule.eachAdditionalAmount.valuestring

The monetary amount in the specified currency.

Occurrence: Optional

calculatedHandlingRule.eachAdditionalAmountOffShippingCostAmount

This container represents the fixed monetary discount deducted from the total shipping cost for each additional item in a combined shipment.

Occurrence: Optional

calculatedHandlingRule.eachAdditionalAmountOffShippingCost.currencyCurrencyCodeEnum

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Occurrence: Optional

calculatedHandlingRule.eachAdditionalAmountOffShippingCost.valuestring

The monetary amount in the specified currency.

Occurrence: Optional

calculatedHandlingRule.eachAdditionalPercentOffShippingCostnumber

This integer specifies the percentage discount applied to the total shipping cost for each additional item in a combined shipment.

Occurrence: Optional

calculatedHandlingRule.orderHandlingAmountAmount

This container represents the handling fee charged for processing a combined order, if applicable.

Occurrence: Optional

calculatedHandlingRule.orderHandlingAmount.currencyCurrencyCodeEnum

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Occurrence: Optional

calculatedHandlingRule.orderHandlingAmount.valuestring

The monetary amount in the specified currency.

Occurrence: Optional

calculatedShippingRuleCalculatedShippingRuleType

This container defines the calculated shipping rule that determines shipping costs or discounts based on factors such as total weight, price, or item count in a combined order.

Occurrence: Optional

calculatedShippingRule.combinedShippingRulesarray of CombinedShippingRule

This array lists the discount rules applied to combined shipments, detailing calculation methods and rule identifiers.

When used by a create call, there won't be any rule ID.

Occurrence: Optional

calculatedShippingRule.combinedShippingRules.combinedShippingRuleIdstring

This field represents the unique identifier for the combined-shipping discount profile,

used to reference or update a specific rule configuration.

Occurrence: Optional

calculatedShippingRule.combinedShippingRules.combinedShippingRuleNamestring

This field specifies the unique name identifying the combined shipping discount profile within the seller’s account. This name is configured by the seller and can have a maximum of XX characters.

Occurrence: Optional

calculatedShippingRule.combinedShippingRules.eachAdditionalAmountAmount

This containter defines the additional monetary charge applied for each extra item when multiple items are shipped together.

Occurrence: Optional

calculatedShippingRule.combinedShippingRules.eachAdditionalAmount.currencyCurrencyCodeEnum

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Occurrence: Optional

calculatedShippingRule.combinedShippingRules.eachAdditionalAmount.valuestring

The monetary amount in the specified currency.

Occurrence: Optional

calculatedShippingRule.combinedShippingRules.eachAdditionalAmountOffShippingCostAmount

This container defines the fixed discount amount deducted from the total shipping cost for each additional item.

Occurrence: Optional

calculatedShippingRule.combinedShippingRules.eachAdditionalAmountOffShippingCost.currencyCurrencyCodeEnum

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Occurrence: Optional

calculatedShippingRule.combinedShippingRules.eachAdditionalAmountOffShippingCost.valuestring

The monetary amount in the specified currency.

Occurrence: Optional

calculatedShippingRule.combinedShippingRules.eachAdditionalPercentOffShippingCostnumber

This integer specifies the percentage discount applied to the total shipping cost for each additional item in the combined order.

Occurrence: Optional

calculatedShippingRule.combinedShippingRules.mappedCombinedShippingRuleIdstring

This field specifies the unique ID that links this combined-shipping rule to another related rule in the seller’s account.

Occurrence: Optional

calculatedShippingRule.combinedShippingRules.weightOffTotalWeightMeasureType

This container specifies the total weight reduction applied when combining multiple items into one shipment.

Occurrence: Optional

calculatedShippingRule.combinedShippingRules.weightOffTotalWeight.unitWeightUnitOfMeasureEnum

This field defines the unit of measure (e.g., kilograms, pounds) associated with the value field.

Occurrence: Optional

calculatedShippingRule.combinedShippingRules.weightOffTotalWeight.valuestring

This field defines the numeric value representing the measurement, weight, in the specified unit.

Occurrence: Optional

calculatedShippingRule.combinedShippingRuleTypeCombinedShippingRuleTypeEnum

This container defines the type of combined-shipping rule applied to calculate discounts, such as weight-based, percentage-based, or flat-rate models.

Occurrence: Optional

combinedDurationCombinedPaymentPeriodEnum

This container specifies the duration within which multiple unpaid orders may be combined into a single invoice, represented by one of the values in the CombinedPaymentPeriodEnum type.

Occurrence: Optional

Output

HTTP response headers

This call has no response headers.

Response payload

This call has no payload.

Response fields

This call has no field definitions.

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.

StatusMeaning
204No Content
400Bad Request
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
395000API_ACCOUNTAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
396000API_ACCOUNTREQUESTInvalid or missing 'currency'.
396002API_ACCOUNTREQUESTInvalid or missing 'combinedShippingRuleType'.
396004API_ACCOUNTREQUESTInvalid or missing 'combinedShippingRules' data. Please verify all required fields are provided with valid values.
396005API_ACCOUNTREQUESTInvalid or missing 'combinedShippingRuleName'.
396006API_ACCOUNTREQUESTInvalid or missing 'eachAdditionalAmount'.
396007API_ACCOUNTREQUESTInvalid or missing 'combinedDuration'.
396008API_ACCOUNTREQUESTInvalid or missing 'eachAdditionalAmountOffShippingCost'.
396009API_ACCOUNTREQUESTInvalid or missing 'eachAdditionalPercentOffShippingCost'.
396011API_ACCOUNTREQUESTInvalid or missing 'combinedShippingRuleId'.
396012API_ACCOUNTREQUESTInvalid or missing 'combinedShippingRuleType' in 'calculatedHandlingRule'.
396013API_ACCOUNTREQUESTInvalid or missing amount data in 'calculatedHandlingRule'.
396014API_ACCOUNTREQUESTThe specified combined shipping rule data does not match any existing rules or the operation is not supported for this rule type.
396016API_ACCOUNTREQUESTThe provided 'combinedShippingRuleName' differs from the existing combined shipping rule name. The existing name will be preserved.
396019API_ACCOUNTREQUESTInvalid or missing 'eachAdditionalPercentOffShippingCost'.
396021API_ACCOUNTREQUESTInvalid or missing 'weightOffTotalWeight'.
396022API_ACCOUNTREQUESTDuplicate 'combinedShippingRuleId' found. Each rule id must be unique within the request.
396023API_ACCOUNTREQUESTThe specified marketplace ID was not found.
396026API_ACCOUNTREQUESTMissing 'calculatedShippingRule' or 'calculatedHandlingRule'.

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: Update combined shipping rules

This method is used to update the combined rules for a seller's account.

Input

This method requires a request body containing the updated combined shipping rules. Additionally, the X-EBAY-C-MARKETPLACE-ID header is required.

POSThttps://api.ebay.com/sell/account/v2/combined_shipping_rules/calculated/{shippingCostRuleProfileId}

Output

If the call is successful, a 204 success message is returned