--- title: Account API v2 description: "Use the Account v2 API to retrieve and manage seller account settings for shipping rate tables, split payouts, combined shipping rules, and seller preferences. The rate\\_table resource lets sellers retrieve shipping rate table details and update shipping costs for specific shipping rate tables. The payout\\_settings resource lets eligible sellers in mainland China retrieve payout instruments and configure split-payout percentages between two payout instruments. The combined\\_shipping\\_rules resource lets sellers create, retrieve, and update combined shipping rules, including calculated, flat-rate, promotional, and combined-payment settings. The user\\_preferences resource lets sellers retrieve and update marketplace-specific preferences, such as combined payment preferences, same-day shipping cutoff time, shipping carrier rate preferences, unpaid item preferences, and out-of-stock control." api_version: 2.2.0 api_name: account_api_v2 api_type: REST api_group: sell/account_api_v2 source_url: html: https://developer.ebay.com/develop/api/sell/account_api_v2 md: https://developer.ebay.com/develop/api/sell/account_api_v2.md --- # Account API v2 API Use the Account v2 API to retrieve and manage seller account settings for shipping rate tables, split payouts, combined shipping rules, and seller preferences. The rate\_table resource lets sellers retrieve shipping rate table details and update shipping costs for specific shipping rate tables. The payout\_settings resource lets eligible sellers in mainland China retrieve payout instruments and configure split-payout percentages between two payout instruments. The combined\_shipping\_rules resource lets sellers create, retrieve, and update combined shipping rules, including calculated, flat-rate, promotional, and combined-payment settings. The user\_preferences resource lets sellers retrieve and update marketplace-specific preferences, such as combined payment preferences, same-day shipping cutoff time, shipping carrier rate preferences, unpaid item preferences, and out-of-stock control. ## API Information **Title:** Account v2 API **Version:** 2.2.0 **Description:** The Account v2 API lets sellers retrieve and manage seller account settings for shipping rate tables, split payouts, combined shipping rules, and seller preferences. **Base Path:** /sell/account/v2 ## API Methods The following API methods are available: ### getRateTable #### GET /rate_table/{rate_table_id} **Description:** This method retrieves an existing rate table identified by the **rate\_table\_id** path parameter. Shipping rate tables are currently supported by the following marketplaces: United States, Canada, United Kingdom, Germany, Australia, France, Italy, and Spain. A successful call returns detailed information for the specified shipping rate table. **Parameters:** - **rate_table_id** (string) *required* - This path parameter is the unique identifier for the shipping rate table to retrieve. Use the [getRateTables](/develop/api/sell/account_api#sell-account_api-rate_table-getratetables) method of the [Account API v1](/develop/api/sell/account_api) to retrieve rate table IDs. **OAuth scope** This request requires an access token created with the **Authorization Code 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): **Required Scopes:** **Authorization Code Grant:** - `https://api.ebay.com/oauth/api_scope/sell.account` - `https://api.ebay.com/oauth/api_scope/sell.account.readonly` ### updateShippingCost #### POST /rate_table/{rate_table_id}/update_shipping_cost **Description:** This method allows sellers to update **shippingCost** and/or **additionalCost** information for an existing shipping rate table identified by the **rate\_table\_id** path parameter. A successful call returns an HTTP status code of **204 No Content**. **Parameters:** - **rate_table_id** (string) *required* - This path parameter is the unique identifier for the shipping rate table for which shipping costs will be updated. Use the [getRateTables](/develop/api/sell/account_api#sell-account_api-rate_table-getratetables) method of the [Account API v1](/develop/api/sell/account_api) to retrieve rate table IDs. - **Content-Type** (string) *required* - This header indicates the format of the request body provided by the client. Its value should be set to **application/json**. For more information, refer to [HTTP request headers](/develop/guides-v2/using-ebay-restful-apis#request-components). **OAuth scope** This request requires an access token created with the **Authorization Code 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): **Required Scopes:** **Authorization Code Grant:** - `https://api.ebay.com/oauth/api_scope/sell.account` ### getPayoutSettings #### GET /payout_settings **Description:** **Important!** Split-payout functionality is **only** available to mainland China sellers, who can split payouts between their Payoneer account and bank account. Card payouts are not currently available for sellers in mainland China. This method returns details on two payment instruments defined on a seller's account, including the ID, type, status, nickname, last four digits of the account number, and payout percentage for the instruments. Using the **instrumentId** returned with this method, sellers can makes changes to the payout split of the instruments with the **updatePayoutPercentage** method. Note that the **instrumentStatus** of a payment instrument, also returned using this method, must be `ACTIVE` in order to do split payouts on that payment instrument. **OAuth scope** This request requires an access token created with the **Authorization Code 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): **Required Scopes:** **Authorization Code Grant:** - `https://api.ebay.com/oauth/api_scope/sell.finances` ### updatePayoutPercentage #### POST /payout_settings/update_percentage **Description:** **Important!** Split-payout functionality is **only** available to mainland China sellers, who can split payouts between their Payoneer account and bank account. Card payouts are not currently available for sellers in mainland China. This method allows sellers in mainland China to configure the split-payout percentage for two payout instruments available for seller payouts. For example, a seller can split payouts to have 70% of the payout go to a bank account and 30% go to a Payoneer account. **Note:** The split-payout percentage **must** always add up to 100%. If the values do not equal 100, the call will fail. Instruments cannot be added/removed using Finance and Account APIs. Users can specify the payout instruments being updated by using the **instrumentId** associated with each payment instrument in the request payload. This value is returned by using the **getPayoutSettings** method. Users can specify the percentage of the payout allocated to each instrument using the **payoutPercentage** request field. This value must be a whole number and cannot exceed 100. For more details on configuring split-payout percentages, see [Mainland China Split Payout Playbook.](/api-docs/split-payout/playbook.html) **Parameters:** - **Content-Type** (string) *required* - This header indicates the format of the request body provided by the client. Its value should be set to **application/json**. For more information, refer to [HTTP request headers](/develop/guides-v2/using-ebay-restful-apis#request-components). **OAuth scope** This request requires an access token created with the **Authorization Code 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): **Required Scopes:** **Authorization Code Grant:** - `https://api.ebay.com/oauth/api_scope/sell.finances` ### createCalculatedShippingRules #### POST /combined_shipping_rules/create_calculated_shipping_rules **Description:** This method creates or registers calculated shipping rules that determine combined shipping costs based on weight, item count, or cost parameters for an authenticated seller. This shipping rule will apply to eBay listings that use the calculated shipping model. **Parameters:** - **X-EBAY-C-MARKETPLACE-ID** (MarketplaceIdEnum) *required* - This required header sets the eBay marketplace where the request is processed. For the full list of eBay marketplace values, see the [MarketplaceIdEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-rate_table-getratetable.ratetabledetails.marketplaceid) type. **OAuth scope** This request requires an access token created with the **Authorization Code 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): **Required Scopes:** **Authorization Code Grant:** - `https://api.ebay.com/oauth/api_scope/sell.account` ### createFlatShippingRules #### POST /combined_shipping_rules/create_flat_shipping_rules **Description:** This method is used to create fixed-rate (flat) shipping rules that apply standard combined shipping costs for a seller’s listings. **Parameters:** - **X-EBAY-C-MARKETPLACE-ID** (MarketplaceIdEnum) *required* - This required header sets the eBay marketplace where the request is processed. For the full list of eBay marketplace values, see the [MarketplaceIdEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-rate_table-getratetable.ratetabledetails.marketplaceid) type. **OAuth scope** This request requires an access token created with the **Authorization Code 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): **Required Scopes:** **Authorization Code Grant:** - `https://api.ebay.com/oauth/api_scope/sell.account` ### createPromotionalShippingRule #### POST /combined_shipping_rules/create_promotional_shipping_rule **Description:** This method defines promotional shipping rules such as discounts or free-shipping thresholds, configurable by marketplace for the seller. **Parameters:** - **X-EBAY-C-MARKETPLACE-ID** (MarketplaceIdEnum) *required* - This required header sets the eBay marketplace where the request is processed. For the full list of eBay marketplace values, see the [MarketplaceIdEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-rate_table-getratetable.ratetabledetails.marketplaceid) type. **OAuth scope** This request requires an access token created with the **Authorization Code 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): **Required Scopes:** **Authorization Code Grant:** - `https://api.ebay.com/oauth/api_scope/sell.account` ### getCombinedShippingRules #### GET /combined_shipping_rules **Description:** This method retrieves all existing combined shipping rule configurations defined by the authenticated seller, including calculated, flat, and promotional types. **Parameters:** - **X-EBAY-C-MARKETPLACE-ID** (MarketplaceIdEnum) *required* - This required header sets the eBay marketplace where the request is processed. For the full list of eBay marketplace values, see the [MarketplaceIdEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-rate_table-getratetable.ratetabledetails.marketplaceid) type. **OAuth scope** This request requires an access token created with the **Authorization Code 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): **Required Scopes:** **Authorization Code Grant:** - `https://api.ebay.com/oauth/api_scope/sell.account.readonly` ### updateCalculatedShippingRules #### POST /combined_shipping_rules/update_calculated_shipping_rules **Description:** This method updates previously defined calculated shipping rules to modify discount percentages, weight offsets, or amount parameters for the seller. **Parameters:** - **X-EBAY-C-MARKETPLACE-ID** (MarketplaceIdEnum) *required* - This required header sets the eBay marketplace where the request is processed. For the full list of eBay marketplace values, see the [MarketplaceIdEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-rate_table-getratetable.ratetabledetails.marketplaceid) type. **OAuth scope** This request requires an access token created with the **Authorization Code 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): **Required Scopes:** **Authorization Code Grant:** - `https://api.ebay.com/oauth/api_scope/sell.account` ### updateCombinedPayments #### POST /combined_shipping_rules/update_combined_payments **Description:** This method configures or modifies combined payment settings that determine how unpaid orders can be merged for a single invoice within a defined duration for the seller. **Parameters:** - **X-EBAY-C-MARKETPLACE-ID** (MarketplaceIdEnum) *required* - This required header sets the eBay marketplace where the request is processed. For the full list of eBay marketplace values, see the [MarketplaceIdEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-rate_table-getratetable.ratetabledetails.marketplaceid) type. **OAuth scope** This request requires an access token created with the **Authorization Code 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): **Required Scopes:** **Authorization Code Grant:** - `https://api.ebay.com/oauth/api_scope/sell.account` ### updateFlatShippingRules #### POST /combined_shipping_rules/update_flat_shipping_rules **Description:** This method updates existing shipping rules. **Parameters:** - **X-EBAY-C-MARKETPLACE-ID** (MarketplaceIdEnum) *required* - This required header sets the eBay marketplace where the request is processed. For the full list of eBay marketplace values, see the [MarketplaceIdEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-rate_table-getratetable.ratetabledetails.marketplaceid) type. **OAuth scope** This request requires an access token created with the **Authorization Code 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): **Required Scopes:** **Authorization Code Grant:** - `https://api.ebay.com/oauth/api_scope/sell.account` ### updatePromotionalShippingRule #### POST /combined_shipping_rules/update_promotional_shipping_rule **Description:** This method updates an existing promotional shipping rule to adjust discount thresholds, eligibility criteria, or duration for the seller. **Parameters:** - **X-EBAY-C-MARKETPLACE-ID** (MarketplaceIdEnum) *required* - This required header sets the eBay marketplace where the request is processed. For the full list of eBay marketplace values, see the [MarketplaceIdEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-rate_table-getratetable.ratetabledetails.marketplaceid) type. **OAuth scope** This request requires an access token created with the **Authorization Code 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): **Required Scopes:** **Authorization Code Grant:** - `https://api.ebay.com/oauth/api_scope/sell.account` ### getUserPreferences #### GET /user_preferences **Description:** This method retrieves the seller's preferences for a specific eBay marketplace, such as combined payment preferences, same-day shipping cutoff time, excluded shipping locations, and opt-in status for Business Policies and Out-of-Stock control. The **fieldgroups** query parameter specifies the type of seller preferences to retrieve. If **fieldgroups** = `ALL` or the parameter is omitted, all the supported seller preferences are returned. To retrieve only specific preferences, include the **fieldgroups** parameter with one or more supported values, delimited by commas. **Parameters:** - **fieldgroups** (string) - The **fieldgroups** query parameter specifies the type of seller preferences to retrieve. If **fieldgroups**\=`ALL` or is omitted, all the supported seller preferences are returned. To retrieve specific seller preferences, include the **fieldgroups** parameter and specify one or more values, with each value delimited by a comma. For example, `fieldgroups = SHIPPING_CARRIER_RATE,COMBINED_PAYMENT`. The value can be `ALL` or any combination of the following (comma-separated): `COMBINED_PAYMENT`, `DISPATCH_CUTOFF_TIME`, `EMAIL_SHIPMENT_TRACKING_NUMBER`, `END_OF_AUCTION_EMAIL`, `GLOBAL_SHIPPING_PROGRAM`, `GLOBAL_SHIPPING_PROGRAM_LISTING`, `ITEMS_AWAITING_PAYMENT`, `OUT_OF_STOCK_CONTROL SELLER_PROFILE`, `OVERRIDE_GSP_SERVICE_WITH_INTL_SERVICE`, `PICKUP_DROPOFF_SELLER`, `PURCHASE_REMINDER_EMAIL`, `REQUIRED_SHIP_PHONE_NUMBER`, `SELLER_EXCLUDE_SHIP_TO_LOCATION`, `SHIPPING_CARRIER_RATE` - **X-EBAY-C-MARKETPLACE-ID** (MarketplaceIdEnum) *required* - This required header sets the eBay marketplace where the request is processed. For the full list of eBay marketplace values, see the [MarketplaceIdEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-rate_table-getratetable.ratetabledetails.marketplaceid) type. **OAuth scope** This request requires an access token created with the **Authorization Code 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): **Required Scopes:** **Authorization Code Grant:** - `https://api.ebay.com/oauth/api_scope/sell.account.readonly` ### setUserPreferences #### PATCH /user_preferences **Description:** This method is used to modify one or more preferences for a seller on a specific marketplace. The preferences that can be modified include combined payment preferences, same-day shipping cutoff time, and opt-in status for Business Policies and Out-of-stock control. This is a PATCH operation, so you only need to include the fields that correspond to the preferences/settings that you are changing. **Parameters:** - **X-EBAY-C-MARKETPLACE-ID** (MarketplaceIdEnum) *required* - This required header sets the eBay marketplace where the request is processed. For the full list of eBay marketplace values, see the [MarketplaceIdEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-rate_table-getratetable.ratetabledetails.marketplaceid) type. - **Content-Type** (string) *required* - This header indicates the format of the request body provided by the client. Its value should be set to **application/json**. For more information, refer to [HTTP request headers](/develop/guides-v2/using-ebay-restful-apis#request-components). **OAuth scope** This request requires an access token created with the **Authorization Code 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): **Required Scopes:** **Authorization Code Grant:** - `https://api.ebay.com/oauth/api_scope/sell.account` ## Error Codes The following error codes may be returned by this API: ### REQUEST Errors #### 394001 - API_ACCOUNT **Description:** The specified rate table ID is invalid. Please input a valid rate table ID. The getRateTables method can be used to retrieve valid rate table IDs #### 394004 - API_ACCOUNT **Description:** Please specify at least one shipping rate entry to add/update through the rates array. #### 394007 - API_ACCOUNT **Description:** Please specify the rateId value for one or more shipping rate entries being updated. #### 394008 - API_ACCOUNT **Description:** The shippingCost containers are missing for one or more shipping rate entries. Please provide the shipping cost values for the shipping rate entries being updated. #### 394009 - API_ACCOUNT **Description:** The specified shipping cost currency does not match the currency used for the marketplace. #### 394011 - API_ACCOUNT **Description:** The additional cost containers are missing for one or more shipping rate entries for the WEIGHT/SURCHARGE rate table. Please provide these values for the additional rate entries being added/updated. #### 394012 - API_ACCOUNT **Description:** The specified additional cost currency does not match the currency used for the marketplace. #### 394015 - API_ACCOUNT **Description:** The number of rate entries must be less than or equal to the existing data. #### 394025 - API_ACCOUNT **Description:** The shipping cost value is invalid. #### 394026 - API_ACCOUNT **Description:** The additional cost value is invalid. #### 394035 - API_ACCOUNT **Description:** The shipping cost is not supported in surcharge calculation type. #### 394036 - API_ACCOUNT **Description:** Additional costs are not applicable for shipping rate tables based on shipping item. Please remove the additional cost container. #### 394041 - API_ACCOUNT **Description:** The rateId of rates is repeated. #### 394100 - API_ACCOUNT **Description:** The seller is not eligible to set split-payout percentage. #### 394101 - API_ACCOUNT **Description:** Missing instrumentId in request. #### 394102 - API_ACCOUNT **Description:** Missing payoutPercentage in request. #### 394103 - API_ACCOUNT **Description:** The 'payoutPercentage' {payoutPercentage} is not valid. The payout percentage should be an integer value. Minimum value: {0}, Maximum value: {100}. #### 394104 - API_ACCOUNT **Description:** Duplicate instrumentId in request. #### 394105 - API_ACCOUNT **Description:** Sum up of 'payoutPercentage' in request must be equal to 100, current value {payoutPercentage}. #### 394106 - API_ACCOUNT **Description:** Instrument 'instrumentId' {instrumentId} not found. #### 394107 - API_ACCOUNT **Description:** Instrument 'instrumentId' {instrumentId} missing in request. #### 396000 - API_ACCOUNT **Description:** Invalid or missing 'currency'. #### 396002 - API_ACCOUNT **Description:** Invalid or missing 'combinedShippingRuleType'. #### 396003 - API_ACCOUNT **Description:** Combined shipping rule names must be unique. Rule names cannot match existing rules in the system or be duplicated within the request. #### 396004 - API_ACCOUNT **Description:** Invalid or missing 'combinedShippingRules' data. Please verify all required fields are provided with valid values. #### 396005 - API_ACCOUNT **Description:** Invalid or missing 'combinedShippingRuleName'. #### 396006 - API_ACCOUNT **Description:** Invalid or missing 'eachAdditionalAmount'. #### 396007 - API_ACCOUNT **Description:** Invalid or missing 'combinedDuration'. #### 396008 - API_ACCOUNT **Description:** Invalid or missing 'eachAdditionalAmountOffShippingCost'. #### 396009 - API_ACCOUNT **Description:** Invalid or missing 'eachAdditionalPercentOffShippingCost'. #### 396010 - API_ACCOUNT **Description:** For create operation, 'combinedShippingRuleId' is not allowed. #### 396012 - API_ACCOUNT **Description:** Invalid or missing 'combinedShippingRuleType' in 'calculatedHandlingRule'. #### 396013 - API_ACCOUNT **Description:** Invalid or missing amount data in 'calculatedHandlingRule'. #### 396019 - API_ACCOUNT **Description:** Invalid or missing 'eachAdditionalPercentOffShippingCost'. #### 396021 - API_ACCOUNT **Description:** Invalid or missing 'weightOffTotalWeight'. #### 396023 - API_ACCOUNT **Description:** The specified marketplace ID was not found. #### 396025 - API_ACCOUNT **Description:** Missing 'calculatedShippingRule'. #### 396024 - API_ACCOUNT **Description:** Missing 'flatShippingRule'. #### 396001 - API_ACCOUNT **Description:** Missing 'promotionalShippingRule'. #### 396014 - API_ACCOUNT **Description:** The specified combined shipping rule data does not match any existing rules or the operation is not supported for this rule type. #### 396017 - API_ACCOUNT **Description:** Invalid or missing 'shippingCost'. #### 396018 - API_ACCOUNT **Description:** Invalid or missing 'orderAmount'. #### 396020 - API_ACCOUNT **Description:** Invalid or missing 'itemCount'. #### 396011 - API_ACCOUNT **Description:** Invalid or missing 'combinedShippingRuleId'. #### 396016 - API_ACCOUNT **Description:** The provided 'combinedShippingRuleName' differs from the existing combined shipping rule name. The existing name will be preserved. #### 396022 - API_ACCOUNT **Description:** Duplicate 'combinedShippingRuleId' found. Each rule id must be unique within the request. #### 396026 - API_ACCOUNT **Description:** Missing 'calculatedShippingRule' or 'calculatedHandlingRule'. #### 396502 - API_ACCOUNT **Description:** The specified field groups are invalid. Error Details - {errorDetails} #### 396510 - API_ACCOUNT **Description:** Dispatch cutoff time format is invalid. Expected format: HH:mm:ss.SSSZ #### 396511 - API_ACCOUNT **Description:** The optInStatus field is included and set to 'false', no other itemsAwaitingPaymentPreferences fields can be used. #### 396512 - API_ACCOUNT **Description:** The removeAllExcludedUsers field is included and set to 'true', the excludedUsers array cannot be used. #### 396513 - API_ACCOUNT **Description:** The delayBeforeCancellingCommitment value is invalid. See the documentation for valid values. #### 396514 - API_ACCOUNT **Description:** The seller's account has reached the maximum number of users ({maxNo}) that can be added to the Excluded Users list. #### 396515 - API_ACCOUNT **Description:** The number of users included in the excludedUsers array exceeds the daily maximum threshold. Please remove one or more users and try again. #### 396516 - API_ACCOUNT **Description:** One or more invalid user IDs included in the excludedUsers array. #### 396517 - API_ACCOUNT **Description:** Invalid value specified for combinedPaymentOption field. See documentation for valid values. #### 396518 - API_ACCOUNT **Description:** Customization of End of Auction email is not supported for this marketplace. #### 396519 - API_ACCOUNT **Description:** The provided text in the templateText field exceeds the maximum allowed number of characters (1000). #### 396520 - API_ACCOUNT **Description:** The provided text in the templateText field contains vulgar language or prohibited HTML content. #### 396521 - API_ACCOUNT **Description:** Logo URL is required but not provided. #### 396522 - API_ACCOUNT **Description:** The format of the logo image in the provided logoUrl field is not supported. See documentation for supported image formats. #### 396523 - API_ACCOUNT **Description:** Logo URL exceeds maximum allowed length of 1024 characters. #### 396524 - API_ACCOUNT **Description:** The marketplace does not support the Global Shipping Program and/or the user is not enrolled in the program. #### 396525 - API_ACCOUNT **Description:** Invalid value specified for upsRateOption field. See documentation for valid values. #### 396526 - API_ACCOUNT **Description:** Invalid value specified for fedexRateOption field. See documentation for valid values. #### 396528 - API_ACCOUNT **Description:** The textCustomized field is set to ‘true’, so the templateText field must also be included. #### 396529 - API_ACCOUNT **Description:** The textCustomized field is set to ‘false’, so the templateText field is not applicable. #### 396530 - API_ACCOUNT **Description:** Invalid value specified for logoType field. See documentation for valid values. #### 396531 - API_ACCOUNT **Description:** The logoType field is not set to CUSTOMIZED, so the logoUrl field is not applicable. ### APPLICATION Errors #### 395000 - API_ACCOUNT **Description:** There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. #### 395100 - API_ACCOUNT **Description:** There was an internal error, please try again after sometime. #### 396500 - API_ACCOUNT **Description:** Internal Server Error. Please try again later or contact Developer Technical Support. ## Types ### Amount **Description:** A complex type that describes the value of a monetary amount as represented by a global currency. **Type:** object **Properties:** - **currency** (CurrencyCodeEnum) - 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`. - **value** (string) - The monetary amount in the specified **currency**. ### CalculatedHandlingRuleType **Description:** This type defines the structure for calculated handling fee discounts applicable when combining multiple orders. **Type:** object **Properties:** - **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). - **eachAdditionalAmount** (Amount) - This container specifies the additional monetary charge applied for each extra item included in a combined shipment. - **eachAdditionalAmountOffShippingCost** (Amount) - This container represents the fixed monetary discount deducted from the total shipping cost for each additional item in a combined shipment. - **eachAdditionalPercentOffShippingCost** (number) - This integer specifies the percentage discount applied to the total shipping cost for each additional item in a combined shipment. - **orderHandlingAmount** (Amount) - This container represents the handling fee charged for processing a combined order, if applicable. ### CalculatedShippingRuleType **Description:** This type describes calculated discount rules determining total shipping cost reductions for combined items. **Type:** object **Properties:** - **combinedShippingRules** (array) - 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. - **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. ### CombinedPaymentPreferencesType **Description:** This container is used to change the combined payment option. Sellers have the option to combine multiple line items from the same buyer into a combined invoice that can be paid for with one payment. See CombinedPaymentOptionEnum for a description of each value. **Type:** object **Properties:** - **combinedPaymentOption** (CombinedPaymentOptionEnum) - This enum type defines the available options for handling combined payments when a seller allows multiple line items from the same buyer to be paid for with a single payment. See `CombinedPaymentOptionEnum` for a description of each value. ### CombinedShippingRule **Description:** This container defines a discount profile schema for combined shipping, including rule IDs, names, and applicable weight or amount reductions. **Note:** This field is not applicable for the create rule use case. **Type:** object **Properties:** - **combinedShippingRuleId** (string) - This field represents the unique identifier for the combined-shipping discount profile, used to reference or update a specific rule configuration. - **combinedShippingRuleName** (string) - 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. - **eachAdditionalAmount** (Amount) - This containter defines the additional monetary charge applied for each extra item when multiple items are shipped together. - **eachAdditionalAmountOffShippingCost** (Amount) - This container defines the fixed discount amount deducted from the total shipping cost for each additional item. - **eachAdditionalPercentOffShippingCost** (number) - This integer specifies the percentage discount applied to the total shipping cost for each additional item in the combined order. - **mappedCombinedShippingRuleId** (string) - This field specifies the unique ID that links this combined-shipping rule to another related rule in the seller’s account. - **weightOffTotalWeight** (MeasureType) - This container specifies the total weight reduction applied when combining multiple items into one shipment. ### CreateCalculatedShippingRulesRequest **Description:** This type defines the structure of a request to create calculated shipping rules, including handling, duration, and rule type details. **Type:** object **Properties:** - **calculatedHandlingRule** (CalculatedHandlingRuleType) - This container defines the calculated handling fee rules applied to combined orders, specifying how handling costs are determined or discounted based on combined-shipping parameters. - **calculatedShippingRule** (CalculatedShippingRuleType) - This container defines the calculated shipping rule applied to combined orders, detailing how shipping discounts or costs are computed based on item count, total weight, or order value. - **combinedDuration** (CombinedPaymentPeriodEnum) - This enumerated value specifies the time window during which multiple unpaid orders can be combined into a single payment or invoice, represented by using one of the values in [CombinedPaymentPeriodEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-combined_shipping_rules-getcombinedshippingrules.getcombinedshippingrulesresponse.combinedduration). ### CreateFlatShippingRulesRequest **Description:** This type represents a request to configure flat-rate combined shipping rules with specified durations and conditions. **Type:** object **Properties:** - **combinedDuration** (CombinedPaymentPeriodEnum) - This enumerated value specifies the time window during which multiple unpaid orders can be combined into a single payment or invoice, represented by using one of the values in [CombinedPaymentPeriodEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-combined_shipping_rules-getcombinedshippingrules.getcombinedshippingrulesresponse.combinedduration). - **flatShippingRule** (FlatShippingRuleType) - This container defines the flat-rate combined-shipping rule, which applies a fixed shipping cost for multiple items shipped together. ### CreatePromotionalShippingRuleRequest **Description:** This type represents the request schema for creating promotional shipping rules with combined payment durations. **Type:** object **Properties:** - **combinedDuration** (CombinedPaymentPeriodEnum) - This container specifies the time window during which multiple unpaid orders can be combined into a single payment or invoice, represented by using one of the values in [CombinedPaymentPeriodEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-combined_shipping_rules-getcombinedshippingrules.getcombinedshippingrulesresponse.combinedduration). - **promotionalShippingRule** (PromotionalShippingRuleType) - This container defines the promotional combined-shipping rule that offers discounts or free shipping based on order value, item count, or other qualifying conditions. ### DispatchCutoffTimePreferencesType **Description:** This container is used to change the order cut-off time for same-day shipping. **Type:** object **Properties:** - **cutoffTime** (string) - This field indicates the dispatch cut-off time in Zulu format (`HH:mm:ss.SSSZ`) - 24-hour format with milliseconds and Z timezone indicator. **Note:** Despite the Z that is returned in the timestamp, the cut-off time is actually based on the default timezone of the eBay marketplace for the seller. **Note:** If an eBay listing supports same-day shipping, and an order is paid for before the cut-off time, the seller is expected to ship the order out that same business day. ### EndOfAuctionEmailPreferencesType **Description:** This container shows the seller's preferences for the end-of-auction email sent to the winning bidder. **Type:** object **Properties:** - **emailCustomized** (boolean) - This boolean field indicates whether or not the seller is using a customized email to send to winning bidders. - **logoCustomized** (boolean) - This boolean field indicates whether or not the seller is using a customized logo in the emails that are sent to winning bidders. - **logoType** (EndOfAuctionLogoTypeEnum) - This enum indicates the type of logo that is used in the email that is sent to winning bidders. See EndOfAuctionLogoTypeEnum type for descriptions of the different logo types. - **logoUrl** (string) - This field shows the URL path to a seller’s custom logo image that is being used in the email sent to winning bidders. This field is only returned if the seller is using a customized logo in emails. - **templateText** (string) - This field shows the body text that is being used if the seller is sending customized emails to winning bidders. The template text has a maximum limit of 1000 characters. - **textCustomized** (boolean) - This boolean field indicates whether or not the seller is using customized text in the emails that are sent to winning bidders. ### FlatShippingRuleType **Description:** This type defines the flat-rate combined-shipping rule, which applies a fixed shipping cost for multiple items shipped together. **Type:** object **Properties:** - **combinedShippingRules** (array) - This array specifies the type of combined-shipping rule applied, such as flat-rate or cost-based. - **combinedShippingRuleType** (CombinedShippingRuleTypeEnum) - This container defines the type of discount rule applied (e.g., percentage-based, fixed-rate). ### GetCombinedShippingRulesPublicApiResponse **Description:** The base response type of the getCombinedShippingRules method. All of a seller's calculated, flat, and promotional shipping discount rules defined for an eBay marketplace will be returned in the response, along with the current combined duration value. **Type:** object **Properties:** - **calculatedHandlingRule** (CalculatedHandlingRuleType) - This container will show one or more calculated shipping rules set up for that seller on that ebay marketplace. **Note:** This will not be returned if a calculated handling rule is not set up for that seller on that eBay marketplace - **calculatedShippingRule** (CalculatedShippingRuleType) - This container specifies the type of combined-shipping rule applied, such as flat-rate, weight-based, or cost-based. - **combinedDuration** (CombinedPaymentPeriodEnum) - This field is represented by one of the values in the [CombinedPaymentPeriodEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-combined_shipping_rules-getcombinedshippingrules.getcombinedshippingrulesresponse.combinedduration). - **flatShippingRule** (FlatShippingRuleType) - This container will show one or more flat shipping rules set up for that seller on that ebay marketplace. - **promotionalShippingRule** (PromotionalShippingRuleType) - This container shows the promotional shipping rule that is currently set up on the seller's account for the eBay marketplace. This container will not be returned if no promotional shipping rule is currently set up on the seller's account for the eBay marketplace. ### GetItemsAwaitingPaymentPreferencesType **Description:** This container represents the seller's preferences for the list of items that are awaiting payment. **Type:** object **Properties:** - **autoRelist** (boolean) - This boolean indicates if the item should be automatically relisted. - **delayBeforeCancellingCommitment** (integer) - This integer indicates the delay in days before cancelling the buyer's commitment. - **excludedUsers** (array) - This string returns the list of sellers excluded from unpaid item assistance. - **optInStatus** (boolean) - This boolean indicates if the unpaid item assistance is opted in. ### GetUserPreferencesResponse **Description:** This type defines the responses for the getUserPreferences method. **Type:** object **Properties:** - **combinedPaymentPreferences** (CombinedPaymentPreferencesType) - This container returns the combined payment preferences when the `COMBINED_PAYMENT` value is included through the **fieldgroups** query parameter or when **fieldgroups**\=`ALL`. It indicates if the seller allows multiple line items from the same buyer to be combined. - **dispatchCutoffTimePreference** (DispatchCutoffTimePreferencesType) - This container is returned when the `DISPATCH_CUTOFF_TIME` value is included through the **fieldgroups** query parameter or when **fieldgroups**\=`ALL`. - **emailShipmentTrackingNumberPreference** (boolean) - This boolean field indicates whether or not the seller’s account is configured to automatically send an email to buyers with the shipment tracking number for an order. - **endOfAuctionEmailPreferences** (EndOfAuctionEmailPreferencesType) - This container allows sellers to customize the email sent to buyers immediately after an auction listing is won. - **globalShippingProgramListingPreference** (boolean) - This boolean field indicates whether or not the seller’s new listings on the eBay marketplace will automatically use the Global Shipping Program for international shipping. This field is returned when the `GLOBAL_SHIPPING_PROGRAM` value is included through the **fieldgroups** query parameter or when **fieldgroups**\=`ALL`. **Note**: The Global Shipping Program is only available for the eBay UK marketplace, and the seller must be opted into the program. - **itemsAwaitingPaymentPreferences** (GetItemsAwaitingPaymentPreferencesType) - This container shows the seller’s preferences for automatically handling unpaid line items. - **offerGlobalShippingProgramPreference** (boolean) - This boolean field indicates whether or not the seller is opted into the Global Shipping Program on the eBay marketplace. **Note**: The Global Shipping Program is only available for the eBay UK marketplace. - **outOfStockControlPreference** (boolean) - This boolean field indicates whether or not the seller is opted into the Out-of-Stock feature. With this feature, a multiple quantity fixed price listing that runs out of stock will be hidden from eBay search but kept alive. Once the sellers add quantity to the listing, the listing will become active and available again. - **overrideGspServiceWithIntlServicePreference** (boolean) - This boolean field indicates whether or not the seller specifies an international shipping service to a particular country for a given listing, the specified service will take precedence and be the listing's default international shipping option for buyers in that country, rather than the Global Shipping Program. **Note**: The Global Shipping Program is only available for the eBay UK marketplace. - **pickupDropoffSellerPreference** (boolean) - This boolean field indicates whether or not the seller is opted into the Click & Collect feature. **Note**: The Click & Collect feature is only available on the eBay UK, Australia, and Germany marketplaces. - **purchaseReminderEmailPreferences** (boolean) - This boolean field indicates whether or not the seller’s account is configured to have eBay send occasional purchase reminder emails for unpaid line items. - **requiredShipPhoneNumberPreference** (boolean) - This boolean field indicates whether or not the buyer is required to provide a shipping phone number during checkout. - **sellerExcludeShipToLocationPreferences** (SellerExcludeShipToLocationPreferencesType) - This container shows the list of locations that the seller does not ship to. This list of shipping locations can only be updated in My eBay through Shipping Preferences and not with the `setUserPreferences` method. - **sellerProfilePreferences** (SellerProfilePreferencesType) - This container is returned when the `SELLER_PROFILE` value is included through the **fieldgroups** query parameter or when **fieldgroups**\=`ALL`. - **shippingCarrierRatePreferences** (ShippingCarrierRatePreferencesType) - This container indicates the FedEx, UPS, and US Post Office shipping rate types that are available to the seller. This container is returned when the `SHIPPING_CARRIER_RATE` value is included through the **fieldgroups** query parameter or when **fieldgroups**\=`ALL`. **Note**: This container is only applicable to the eBay US marketplace. ### MeasureType **Description:** This type displays measurement type with value, unit, and measurement system. **Type:** object **Properties:** - **unit** (WeightUnitOfMeasureEnum) - This field defines the unit of measure (e.g., kilograms, pounds) associated with the value field. - **value** (string) - This field defines the numeric value representing the measurement, weight, in the specified unit. ### PayoutInstrument **Description:** This type is used to provide details about one or two of the seller's accounts that are enabled to receive payouts. **Type:** object **Properties:** - **accountLastFourDigits** (string) - The last four digits of the account that the seller uses to receive payouts. This may be the last four digits of a bank account or a payment processor account such as Payoneer. - **instrumentId** (string) - The unique reference identifier for a payout instrument. The **instrumentId** is needed to change the split-payout percentages through an **updatePayoutPercentage** request. - **instrumentStatus** (InstrumentStatusEnum) - The status of a payout instrument. Valid payout instrument statuses include: * `PENDING:` This status indicates that the account must be verified before it can be used. * `ACTIVE:`This status indicates that payouts are enabled on this account. * `VERIFICATION_FAILED:` This status indicates that verification has failed for this account and payouts are disabled. * `INACTIVE:` This status indicates that this account has become inactive and payouts are disabled. See **InstrumentStatusEnum** for more details on each instrument status value. **Note:** Payment accounts can only receive payouts if the status of a payout instrument is `ACTIVE`. - **instrumentType** (string) - The type of account that received payouts. The value returned in this field may be: * `BANK`: Indicates that the payout was made to a seller's bank account. * `CARD` (**Not Currently Available**): Indicates that the payout went to a seller's debit card. * The name of a digital wallet provider or payment processor (e.g., `PAYONEER`) **Note:** Only Payoneer is currently supported for sellers in mainland China. Card payouts are not currently available for sellers in mainland China. - **nickname** (string) - When **instrumentType** returns `BANK`, this value is the seller-provided nickname that the seller uses to represent the bank account that receives the payout. When **instrumentType** returns `CARD`, this value is the debit card network for the debit card that receives the payout. When **instrumentType** returns a provider of digital wallet or payment processing services, the value returned is the name of the service provider (e.g., `PAYONEER`) **Note:** Only Payoneer is currently supported for sellers in mainland China. Card payouts are not currently available for sellers in mainland China. - **payoutPercentage** (string) - The current payout percentage allocated to an instrument. For example, `50` indicates that 50% of the payout goes to the instrument. ### PayoutSettingsResponse **Description:** The base response type of the **getPayoutSettings** method. **Type:** object **Properties:** - **payoutInstruments** (array) - This array provides details about the seller's accounts defined for the seller's account. Payment accounts can only receive payouts if the status of the payout instrument is `ACTIVE`. ### PromotionalShippingRuleType **Description:** This type is used to represent a promotional shipping rule set up by the seller on an eBay marketplace. **Type:** object **Properties:** - **combinedShippingRuleType** (CombinedShippingRuleTypeEnum) - This field specifies the type of combined-shipping rule applied, such as flat-rate or cost-based, as defined in the [CombinedShippingRuleTypeEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-combined_shipping_rules-getcombinedshippingrules.flatshippingruletype.combinedshippingruletype). - **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. - **orderAmount** (Amount) - This container specifies the minimum order amount required to qualify for the associated discount or promotional rule. - **shippingCost** (Amount) - This container represents the total shipping cost or discounted shipping charge for the combined order. ### Rate **Description:** This container details shipping rate information identified by a unique rate ID. A successful call returns the requested shipping rate information. **Type:** object **Properties:** - **additionalCost** (Amount) - An additional shipping cost added to the base shipping rate (i.e., **shippingCost**). This amount applies only to the following **rateTableBasis** options: * **WEIGHT**: This is a cost per unit weight and is calculated using the weight of the item(s) being shipped. * **SURCHARGE**: This is a flat amount that is added to the base shipping rate. This field is returned only when it is applicable to the specified rate ID. - **rateId** (string) - The unique identifier for rate information. **Note:** This is a string that is automatically assigned by the system when a rate object is created. - **shippingCategory** (ShippingCategoryEnum) - Indicates the level of shipping service to which the shipping rate information applies. Available shipping categories are: * **ONE\_DAY**: _This option is not supported when **shippingOptionType** is INTERNATIONAL._ * **EXPEDITED** * **STANDARD** * **ECONOMY** * **EXPRESS**: _This option is supported only when **MarketplaceId** is `EBAY_DE` (Germany)_ - **shippingCost** (Amount) - Specifies the base shipping rate for an item. This amount applies only to the following **rateTableBasis** options: * **ITEM**: This is a flat rate shipping cost per item being shipped. * **WEIGHT**: This is a cost per unit weight and is calculated using the weight of the item(s) being shipped. - **shippingRegionNames** (array) - An array of Region names to which the shipping rate information applies. Returned values may be: * Geographical Regions (e.g., `Worldwide`, `Europe`, and `Middle East`) * Individual countries identified by a two-letter code such as `US` (United States), `CA` (Canada), and `GB` (United Kingdom) * US states and/or Canadian provinces identified by a two-letter code such as `NY` (New York) or `SK` (Saskatchewan) * Domestic Regions such as `AK/HI` (Alaska/Hawaii) - **shippingServiceCode** (string) - An enum value that indicates the shipping service used for the specified shipping rate. These enum values align with **ShippingService** metadata returned by a **GeteBayDetails** call with **DetailName** set to `shippingServiceDetails`. ### RateTableDetails **Description:** This container includes all information pertaining to a shipping rate table. A successful call returns the requested shipping rate information. **Type:** object **Properties:** - **marketplaceId** (MarketplaceIdEnum) - Identifies the eBay marketplace to which the shipping rate table applies. - **name** (string) - The seller-defined name for the shipping rate table. Names must be unique for each table assigned to the same seller, shippingOptionType, and eBay marketplace. **Max length:** 50 - **rates** (array) - An array of rate objects associated with the specified shipping rate table. Each rate object is identified by a unique system-generated ID and defines specific shipping rate information. - **rateTableBasis** (ShippingRateCalculationEnum) - The rate calculation type provides three methods of calculating the shipping cost based on the seller's selection/input: * **ITEM**: Specifies the flat rate shipping cost that buyers in the specified shipping region will pay. When this option is selected, information specified in the rate table overrides all shipping options/costs that are specified at the listing level. Buyers in the specified regions will only see the services provided in the rate table. Buyers in other regions that are not specified in the rate table will see the shipping services associated with the listing. * **WEIGHT**: Seller can provide minimum shipping cost and an additional shipping cost per pound. The additional cost will be calculated based on the weight the seller provide at the time of listing. Buyers will see the total shipping cost and won’t see these calculations. Buyers in the specified regions will only see the services provided in the rate table. Buyers in other regions that were not specified in the rate table, will see the shipping services associated with the listing. * **SURCHARGE**: Lists surcharges for buyers within specified regions, or indicates a flat amount added to the shipping cost specified within an item's listing. Buyers will see only the total shipping cost as well as shipping services associated with the item's listing. If a SURCHARGE is specified in the rate table for certain regions, buyers in those regions will see the (shipping cost + SURCHARGE) total. - **rateTableId** (string) - A unique, system-generated ID assigned to the shipping rate table when it is initially created. - **shippingOptionType** (ShippingOptionTypeEnum) - The region serviced by the shipping rate table. Valid values are: * **DOMESTIC**: Indicates that the shipping rate table applies to shipping destinations within the country in which an item has been listed (i.e., the _source_ country). * **INTERNATIONAL**: Indicates that the shipping rate table applies to shipping destinations outside of the country in which an item has been listed. ### RateTableUpdate **Description:** This type is used by the request payload of the **updateShippingCost** method to pass updated shipping cost information for a rate table identified by **rateTableId**. **Type:** object **Properties:** - **rates** (array) - An array of rate objects for which **shippingCost** and/or **additionalCost** are to be updated. ### RateUpdate **Description:** This container defines the updated shipping cost information for a rate object identified by **rateId**. To view a list of all rate objects and corresponding **rateID** values, issue **getRateTable** for the rate table identified by **rateTableId**. **Type:** object **Properties:** - **additionalCost** (Amount) - An additional shipping cost added to the base shipping rate (i.e., **shippingCost**). This amount applies only to the following **rateTableBasis** options: * **WEIGHT**: This is a cost per unit weight and is calculated using the weight of the item(s) being shipped. * **SURCHARGE**: This is a flat amount that is added to the base shipping rate. This field is returned only when it is applicable to the specified rate ID. - **rateId** (string) - The identifier for the rate object. **Note:** This is a string automatically assigned by the system when the rate object is created. It cannot be changed or updated. - **shippingCost** (Amount) - This is the base shipping rate for an item. This amount applies only to the following **rateTableBasis** options: * **ITEM**: This is a flat rate shipping cost per item being shipped. * **WEIGHT**: This is a cost per unit weight and is calculated using the weight of the item(s) being shipped. ### SellerExcludeShipToLocationPreferencesType **Description:** This container represents the list of locations that the seller wants to exclude from shipping. **Type:** object **Properties:** - **excludeShipToLocations** (array) - This array shows the list of locations that the seller does not ship to. Excluded locations may include continents and large geographical areas. For example, 'Middle East', individual countries represented by two-letter codes, or special locations within a country such as 'Alaska/Hawaii' or 'PO Box'. ### SellerProfilePreferencesType **Description:** This container indicates whether or not the seller is opted into Business Policies. If a seller is opted into Business Policies, they must use Payment,Return, and Shipping business policies instead of individual payment, return, and shipping fields. **Type:** object **Properties:** - **sellerProfileOptedIn** (boolean) - This boolean indicates whether the seller has opted in to seller profiles. ### ShippingCarrierRatePreferencesType **Description:** This field is included if the seller wishes to add or modify the shipping carrier rate type that is available to the seller. This field is only returned if set. **Note**: This container is only applicable to the eBay US marketplace. **Type:** object **Properties:** - **fedexRateOption** (FedexRateOptionEnum) - This enum is included if the seller wishes to add or modify the FedEx shipping carrier rate. **Note**: This preference is only applicable to the eBay US marketplace. - **upsRateOption** (UPSRateOptionEnum) - This enum is included if the seller wishes to add or modify the UPS shipping carrier rate. **Note**: This preference is only applicable to the eBay US marketplace. ### UpdateCalculatedShippingRulesRequest **Description:** This type is used to update calculated shipping rules. **Type:** object **Properties:** - **calculatedHandlingRule** (CalculatedHandlingRuleType) - 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. - **calculatedShippingRule** (CalculatedShippingRuleType) - 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. - **combinedDuration** (CombinedPaymentPeriodEnum) - This enumerated value specifies the duration within which multiple unpaid orders may be combined into a single invoice, represented by one of the values in [CombinedPaymentPeriodEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-combined_shipping_rules-getcombinedshippingrules.getcombinedshippingrulesresponse.combinedduration). ### UpdateCombinedPaymentsRequest **Description:** This type is used to update the combined payment duration **Type:** object **Properties:** - **combinedDuration** (CombinedPaymentPeriodEnum) - This field specifies the duration within which multiple unpaid orders may be combined into a single invoice. One of the values in [CombinedPaymentPeriodEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-combined_shipping_rules-getcombinedshippingrules.getcombinedshippingrulesresponse.combinedduration) must be used in this field. ### UpdateFlatShippingRulesRequest **Description:** This type defines a request to update flat shipping rules. **Type:** object **Properties:** - **combinedDuration** (CombinedPaymentPeriodEnum) - This field specifies the duration within which multiple unpaid orders may be combined into a single invoice. One of the values in [CombinedPaymentPeriodEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-combined_shipping_rules-getcombinedshippingrules.getcombinedshippingrulesresponse.combinedduration) must be used in this field. - **flatShippingRule** (FlatShippingRuleType) - This container defines the flat-rate combined-shipping rule, which applies a fixed shipping cost for multiple items shipped together. ### UpdatePayoutPercentage **Description:** This type allows the user to change the payout percentages for two active payment instruments. **Type:** object **Properties:** - **instrumentId** (string) - The unique reference identifier for a payout instrument. This value is returned in the [getPayoutSettings](/develop/api/sell/account_api_v2#sell-account_api_v2-payout_settings-getpayoutsettings) response and is needed to change split-payout percentages through an **updatePayoutPercentage** request. - **payoutPercentage** (string) - The user-defined payout percentage allocated to this instrument. For example, `50` indicates that 50% of the payout goes to this instrument. The split-payout percentage **must** be a positive integer value from 0-100. The values of two instruments **must** always add up to 100%. If the values do not equal 100, the call will fail. ### UpdatePayoutPercentageRequest **Description:** This type is used by the request payload of the **updatePayoutPercentage** method to allow a seller to configure the split-payout percentages for two payout instruments. **Type:** object **Properties:** - **payoutInstruments** (array) - This array allows the seller to set the payout split percentages for two accounts enabled to receive payouts. ### UpdatePromotionalShippingRuleRequest **Description:** This type defines a request to update promotional shipping rule. **Type:** object **Properties:** - **combinedDuration** (CombinedPaymentPeriodEnum) - This container specifies the duration within which multiple unpaid orders may be combined into a single invoice. One of the values in [CombinedPaymentPeriodEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-combined_shipping_rules-getcombinedshippingrules.getcombinedshippingrulesresponse.combinedduration) must be used in this field. - **promotionalShippingRule** (PromotionalShippingRuleType) - This container specifies the promotional shipping rule that offers discounts or free-shipping options based on defined order thresholds, item counts, or marketplace conditions. ### CombinedPaymentOptionEnum **Description:** This enum type defines the available options for handling combined payments when a seller allows multiple line items from the same buyer to be paid for with a single payment. See `CombinedPaymentOptionEnum` for a description of each value. | - **NO_COMBINED_PAYMENT**: Indicates that combined payments are not allowed. - **DISCOUNT_SPECIFIED**: Indicates that a combined-payment discount has been specified. - **SPECIFY_DISCOUNT_LATER**: Indicates that the seller will specify the combined-payment discount later. **Type:** string ### CombinedPaymentPeriodEnum **Description:** This enumerated type defines the allowable time durations (e.g., 3, 7, 14 days) within which multiple unpaid items may be merged into a combined invoice. | - **DAYS_14**: Indicates that eligible unpaid line items can be combined into one payment for up to 14 days. - **DAYS_3**: Indicates that eligible unpaid line items can be combined into one payment for up to 3 days. - **DAYS_30**: Indicates that eligible unpaid line items can be combined into one payment for up to 30 days. - **DAYS_5**: Indicates that eligible unpaid line items can be combined into one payment for up to 5 days. - **DAYS_7**: Indicates that eligible unpaid line items can be combined into one payment for up to 7 days. - **INELIGIBLE**: Indicates that the buyer is not eligible to combine unpaid line items into one payment. **Type:** string ### CombinedShippingRuleTypeEnum **Description:** This enumeration type defines the available types of combined-shipping rules, such as weight-based, cost-based, or flat-rate discount models. | - **COMBINED_ITEM_WEIGHT**: Indicates that combined shipping is calculated from the combined weight of the items in the order. - **EACH_ADDITIONAL_AMOUNT**: Indicates that a specified amount is charged for each additional item in the order. - **EACH_ADDITIONAL_AMOUNT_OFF**: Indicates that a specified amount is subtracted from the shipping cost for each additional item in the order. - **EACH_ADDITIONAL_PERCENT_OFF**: Indicates that a specified percentage is subtracted from the shipping cost for each additional item in the order. - **INDIVIDUAL_ITEM_WEIGHT**: Indicates that combined shipping is calculated from the individual item weights. - **MAXIMUM_SHIPPING_COST_PER_ORDER**: Indicates that the combined shipping cost is capped at a maximum amount for the order. - **SHIPPING_COST_X_FOR_AMOUNT_Y**: Indicates that the shipping cost is a specified amount when the order amount meets a configured threshold. - **SHIPPING_COST_X_FOR_ITEM_COUNT_N**: Indicates that the shipping cost is a specified amount when the order item count meets a configured threshold. - **WEIGHT_OFF**: Indicates that a specified weight amount is subtracted from the total order weight. **Type:** string ### CombinedShippingRuleTypeHandlingEnum **Description:** This enumeration type calculates all valid handling discount rule types that govern how combined order handling costs are applied. | - **COMBINED_HANDLING_FEE**: Indicates that handling fees are combined for the order. - **EACH_ADDITIONAL_AMOUNT**: Indicates that a specified handling amount is charged for each additional item. - **EACH_ADDITIONAL_AMOUNT_OFF**: Indicates that a specified amount is subtracted from the handling cost for each additional item. - **EACH_ADDITIONAL_PERCENT_OFF**: Indicates that a specified percentage is subtracted from the handling cost for each additional item. - **INDIVIDUAL_HANDLING_FEE**: Indicates that handling fees are calculated separately for individual items. **Type:** string ### CurrencyCodeEnum **Description:** This enumerated type lists the three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html "https://www.iso.org ") codes representing the supported world currencies. | - **AED**: Indicates the currency is United Arab Emirates dirham. - **AFN**: Indicates the currency is Afghan afghani. - **ALL**: Indicates the currency is Albanian lek. - **AMD**: Indicates the currency is Armenian dram. - **ANG**: Indicates the currency is Netherlands Antillean guilder. - **AOA**: Indicates the currency is Angolan kwanza. - **ARS**: Indicates the currency is Argentine peso. - **AUD**: Indicates the currency is Australian dollar. - **AWG**: Indicates the currency is Aruban florin. - **AZN**: Indicates the currency is Azerbaijani manat. - **BAM**: Indicates the currency is Bosnia and Herzegovina convertible mark. - **BBD**: Indicates the currency is Barbados dollar. - **BDT**: Indicates the currency is Bangladeshi taka. - **BGN**: Indicates the currency is Bulgarian lev. - **BHD**: Indicates the currency is Bahraini dinar. - **BIF**: Indicates the currency is Burundian franc. - **BMD**: Indicates the currency is Bermudian dollar. - **BND**: Indicates the currency is Brunei dollar. - **BOB**: Indicates the currency is Bolivian boliviano. - **BRL**: Indicates the currency is Brazilian real. - **BSD**: Indicates the currency is Bahamian dollar. - **BTN**: Indicates the currency is Bhutanese ngultrum. - **BWP**: Indicates the currency is Botswana pula. - **BYR**: Indicates the currency is Belarusian ruble. - **BZD**: Indicates the currency is Belize dollar. - **CAD**: Indicates the currency is Canadian dollar. - **CDF**: Indicates the currency is Congolese franc. - **CHF**: Indicates the currency is Swiss franc. - **CLP**: Indicates the currency is Chilean peso. - **CNY**: Indicates the currency is Chinese yuan. - **COP**: Indicates the currency is Colombian peso. - **CRC**: Indicates the currency is Costa Rican colon. - **CUP**: Indicates the currency is Cuban peso. - **CVE**: Indicates the currency is Cape Verdean escudo. - **CZK**: Indicates the currency is Czech koruna. - **DJF**: Indicates the currency is Djiboutian franc. - **DKK**: Indicates the currency is Danish krone. - **DOP**: Indicates the currency is Dominican peso. - **DZD**: Indicates the currency is Algerian dinar. - **EGP**: Indicates the currency is Egyptian pound. - **ERN**: Indicates the currency is Eritrean nakfa. - **ETB**: Indicates the currency is Ethiopian birr. - **EUR**: Indicates the currency is Euro. - **FJD**: Indicates the currency is Fiji dollar. - **FKP**: Indicates the currency is Falkland Islands pound. - **GBP**: Indicates the currency is Pound sterling. - **GEL**: Indicates the currency is Georgian lari. - **GHS**: Indicates the currency is Ghanaian cedi. - **GIP**: Indicates the currency is Gibraltar pound. - **GMD**: Indicates the currency is Gambian dalasi. - **GNF**: Indicates the currency is Guinean franc. - **GTQ**: Indicates the currency is Guatemalan quetzal. - **GYD**: Indicates the currency is Guyanese dollar. - **HKD**: Indicates the currency is Hong Kong dollar. - **HNL**: Indicates the currency is Honduran lempira. - **HRK**: Indicates the currency is Croatian kuna. - **HTG**: Indicates the currency is Haitian gourde. - **HUF**: Indicates the currency is Hungarian forint. - **IDR**: Indicates the currency is Indonesian rupiah. - **ILS**: Indicates the currency is Israeli new shekel. - **INR**: Indicates the currency is Indian rupee. - **IQD**: Indicates the currency is Iraqi dinar. - **IRR**: Indicates the currency is Iranian rial. - **ISK**: Indicates the currency is Icelandic krona. - **JMD**: Indicates the currency is Jamaican dollar. - **JOD**: Indicates the currency is Jordanian dinar. - **JPY**: Indicates the currency is Japanese yen. - **KES**: Indicates the currency is Kenyan shilling. - **KGS**: Indicates the currency is Kyrgyzstani som. - **KHR**: Indicates the currency is Cambodian riel. - **KMF**: Indicates the currency is Comorian franc. - **KPW**: Indicates the currency is North Korean won. - **KRW**: Indicates the currency is South Korean won. - **KWD**: Indicates the currency is Kuwaiti dinar. - **KYD**: Indicates the currency is Cayman Islands dollar. - **KZT**: Indicates the currency is Kazakhstani tenge. - **LAK**: Indicates the currency is Lao kip. - **LBP**: Indicates the currency is Lebanese pound. - **LKR**: Indicates the currency is Sri Lankan rupee. - **LRD**: Indicates the currency is Liberian dollar. - **LSL**: Indicates the currency is Lesotho loti. - **LTL**: Indicates the currency is Lithuanian litas. - **LYD**: Indicates the currency is Libyan dinar. - **MAD**: Indicates the currency is Moroccan dirham. - **MDL**: Indicates the currency is Moldovan leu. - **MGA**: Indicates the currency is Malagasy ariary. - **MKD**: Indicates the currency is Macedonian denar. - **MMK**: Indicates the currency is Myanmar kyat. - **MNT**: Indicates the currency is Mongolian tugrik. - **MOP**: Indicates the currency is Macanese pataca. - **MRO**: Indicates the currency is Mauritanian ouguiya. - **MUR**: Indicates the currency is Mauritian rupee. - **MVR**: Indicates the currency is Maldivian rufiyaa. - **MWK**: Indicates the currency is Malawian kwacha. - **MXN**: Indicates the currency is Mexican peso. - **MYR**: Indicates the currency is Malaysian ringgit. - **MZN**: Indicates the currency is Mozambican metical. - **NAD**: Indicates the currency is Namibian dollar. - **NGN**: Indicates the currency is Nigerian naira. - **NIO**: Indicates the currency is Nicaraguan cordoba. - **NOK**: Indicates the currency is Norwegian krone. - **NPR**: Indicates the currency is Nepalese rupee. - **NZD**: Indicates the currency is New Zealand dollar. - **OMR**: Indicates the currency is Omani rial. - **PAB**: Indicates the currency is Panamanian balboa. - **PEN**: Indicates the currency is Peruvian sol. - **PGK**: Indicates the currency is Papua New Guinean kina. - **PHP**: Indicates the currency is Philippine peso. - **PKR**: Indicates the currency is Pakistani rupee. - **PLN**: Indicates the currency is Polish zloty. - **PYG**: Indicates the currency is Paraguayan guarani. - **QAR**: Indicates the currency is Qatari riyal. - **RON**: Indicates the currency is Romanian leu. - **RSD**: Indicates the currency is Serbian dinar. - **RUB**: Indicates the currency is Russian ruble. - **RWF**: Indicates the currency is Rwandan franc. - **SAR**: Indicates the currency is Saudi riyal. - **SBD**: Indicates the currency is Solomon Islands dollar. - **SCR**: Indicates the currency is Seychelles rupee. - **SDG**: Indicates the currency is Sudanese pound. - **SEK**: Indicates the currency is Swedish krona. - **SGD**: Indicates the currency is Singapore dollar. - **SHP**: Indicates the currency is Saint Helena pound. - **SLL**: Indicates the currency is Sierra Leonean leone. - **SOS**: Indicates the currency is Somali shilling. - **SRD**: Indicates the currency is Surinamese dollar. - **STD**: Indicates the currency is Sao Tome and Principe dobra. - **SYP**: Indicates the currency is Syrian pound. - **SZL**: Indicates the currency is Swazi lilangeni. - **THB**: Indicates the currency is Thai baht. - **TJS**: Indicates the currency is Tajikistani somoni. - **TMT**: Indicates the currency is Turkmenistan manat. - **TND**: Indicates the currency is Tunisian dinar. - **TOP**: Indicates the currency is Tongan paanga. - **TRY**: Indicates the currency is Turkish lira. - **TTD**: Indicates the currency is Trinidad and Tobago dollar. - **TWD**: Indicates the currency is New Taiwan dollar. - **TZS**: Indicates the currency is Tanzanian shilling. - **UAH**: Indicates the currency is Ukrainian hryvnia. - **UGX**: Indicates the currency is Ugandan shilling. - **USD**: Indicates the currency is United States dollar. - **UYU**: Indicates the currency is Uruguayan peso. - **UZS**: Indicates the currency is Uzbekistani som. - **VEF**: Indicates the currency is Venezuelan bolivar. - **VND**: Indicates the currency is Vietnamese dong. - **VUV**: Indicates the currency is Vanuatu vatu. - **WST**: Indicates the currency is Samoan tala. - **XAF**: Indicates the currency is Central African CFA franc. - **XCD**: Indicates the currency is East Caribbean dollar. - **XOF**: Indicates the currency is West African CFA franc. - **XPF**: Indicates the currency is CFP franc. - **YER**: Indicates the currency is Yemeni rial. - **ZAR**: Indicates the currency is South African rand. - **ZMW**: Indicates the currency is Zambian kwacha. - **ZWL**: Indicates the currency is Zimbabwean dollar. **Type:** string ### EndOfAuctionLogoTypeEnum **Description:** This enum type defines the supported logo types that can be used in end-of-auction emails sent to winning bidders. | - **WINNING_BIDDER_NOTICE**: Indicates that the winning-bidder notice logo is used. - **STORE**: Indicates that the seller's eBay Store logo is used. - **CUSTOMIZED**: Indicates that the seller uses a customized logo. - **NONE**: Indicates that no logo is used. **Type:** string ### FedexRateOptionEnum **Description:** This enum type defines the FedEx shipping rate options that are available to the seller. | - **FEDEX_STANDARD_LIST**: Indicates that FedEx standard list rates are used. - **FEDEX_COUNTER**: Indicates that FedEx counter rates are used. **Type:** string ### InstrumentStatusEnum **Description:** This enumeration type lists the different possible instrument statuses that can be returned with the **getPayoutSettings** method. **Note:** Payout splits can only be modified for accounts in `ACTIVE` state. | - **PENDING**: This status indicates that the account must be verified before it can be used. - **ACTIVE**: This status indicates that payouts are enabled on this account. - **VERIFICATION_FAILED**: This status indicates that verification has failed for this account and payouts are disabled. - **INACTIVE**: This status indicates that this account has become inactive and payouts are disabled. **Type:** string ### MarketplaceIdEnum **Description:** This enumerated type defines the unique eBay-assigned IDs for each of the eBay marketplaces. | - **EBAY_AT**: Indicates the eBay marketplace for Austria (https://www.ebay.at). - **EBAY_AU**: Indicates the eBay marketplace for Australia (https://www.ebay.com.au). - **EBAY_BE**: Indicates the eBay marketplace for Belgium (https://www.ebay.be/). - **EBAY_CA**: Indicates the eBay marketplace for Canada (https://www.ebay.ca). - **EBAY_CH**: Indicates the eBay marketplace for Switzerland (https://www.ebay.ch). - **EBAY_CN**: Reserved for future use. - **EBAY_CZ**: Reserved for future use. - **EBAY_DE**: Indicates the eBay marketplace for Germany (https://www.ebay.de). - **EBAY_DK**: Reserved for future use. - **EBAY_ES**: Indicates the eBay marketplace for Spain (https://www.ebay.es). - **EBAY_FI**: Reserved for future use. - **EBAY_FR**: Indicates the eBay marketplace for France (https://www.ebay.fr). - **EBAY_GB**: Indicates the eBay marketplace for Great Britain (https://www.ebay.co.uk). - **EBAY_GR**: Reserved for future use. - **EBAY_HK**: Indicates the eBay marketplace for Hong Kong (https://www.ebay.com.hk). - **EBAY_HU**: Reserved for future use. - **EBAY_ID**: Reserved for future use. - **EBAY_IE**: Indicates the eBay marketplace for Ireland (https://www.ebay.ie). - **EBAY_IL**: Reserved for future use. - **EBAY_IN**: Indicates the eBay marketplace for India (https://www.ebay.in). - **EBAY_IT**: Indicates the eBay marketplace for Italy (https://www.ebay.it). - **EBAY_JP**: Reserved for future use. - **EBAY_MY**: Indicates the eBay marketplace for Malaysia (https://www.ebay.com.my). - **EBAY_NL**: Indicates the eBay marketplace for the Netherlands (https://www.ebay.nl). - **EBAY_NO**: Reserved for future use. - **EBAY_NZ**: Reserved for future use. - **EBAY_PE**: Reserved for future use. - **EBAY_PH**: Indicates the eBay marketplace for the Philippines (https://www.ebay.ph). - **EBAY_PL**: Indicates the eBay marketplace for Poland (https://www.ebay.pl). - **EBAY_PR**: Reserved for future use. - **EBAY_PT**: Reserved for future use. - **EBAY_RU**: Reserved for future use. - **EBAY_SE**: Reserved for future use. - **EBAY_SG**: Indicates the eBay marketplace for Singapore (https://www.ebay.com.sg). - **EBAY_TH**: Indicates the eBay marketplace for Thailand (https://info.ebay.co.th). - **EBAY_TW**: Indicates the eBay marketplace for Taiwan (https://www.ebay.com.tw). - **EBAY_US**: Indicates the eBay marketplace for the United States (https://www.ebay.com). - **EBAY_VN**: Indicates the eBay marketplace for Vietnam (https://www.ebay.vn). - **EBAY_ZA**: Reserved for future use. - **EBAY_HALF_US**: No longer used. - **EBAY_MOTORS_US**: Indicates the parent category for Auto Parts and Vehicles on the EBAY\_US marketplace (https://www.ebay.com/motors). **Type:** string ### ShippingCategoryEnum **Description:** An enum that defines the available levels of shipping service. | - **ONE_DAY**: Shipping rate applies to One-Day delivery services. Note: This option is not supported when **shippingOptionType** is `INTERNATIONAL`. - **EXPEDITED**: Shipping rate applies to Expedited delivery services. This generally indicates that a shipment can arrive at the shipping destination within one or two business days. - **STANDARD**: Shipping rate applies to Standard delivery services. - **ECONOMY**: Shipping rate applies to Economy delivery services. This generally indicates that shipping rates are minimized but it will take longer for the shipment to arrive at the shipping destination. - **EXPRESS**: Shipping rate applies to Express delivery services. Note: This option is supported only when [MarketplaceIdEnum](/develop/api/sell/account_api_v2#sell-account_api_v2-rate_table-getratetable.ratetabledetails.marketplaceid) is `EBAY_DE` (Germany). **Type:** string ### ShippingOptionTypeEnum **Description:** An enum defining a region that is either domestic (within the country from where the item is listed or shipped) or international (a country outside the country from where the item is listed or shipped). | - **DOMESTIC**: `DOMESTIC` indicates a region that is within the source country. - **INTERNATIONAL**: `INTERNATIONAL` indicates a region that is external to the source country. **Type:** string ### ShippingRateCalculationEnum **Description:** An enum that specifies the how a shipping rate is calculated. | - **ITEM**: Specifies the flat rate shipping cost that buyers in the specified shipping region will pay. - **WEIGHT**: Specifies that the shipping cost is calculated using the weight of the item or items being shipped. - **SURCHARGE**: Specifies a flat amount that is added to the shipping cost specified within an item's listing. **Type:** string ### UPSRateOptionEnum **Description:** This enum type defines the UPS shipping rate options that are available to the seller. | - **UPS_DAILY_RATES**: Indicates that UPS Daily Rates are used. - **UPS_ON_DEMAND_RATES**: Indicates that UPS On Demand Rates are used. **Type:** string ### WeightUnitOfMeasureEnum **Description:** This enumeration type defines the supported weight measurement units (e.g., kilograms, pounds, ounces) used in shipping calculations and rule configurations. | - **POUND**: Indicates the unit of measure is pounds. - **KILOGRAM**: Indicates the unit of measure is kilograms. - **OUNCE**: Indicates the unit of measure is ounces. - **GRAM**: Indicates the unit of measure is grams. **Type:** string ### SetItemsAwaitingPaymentPreferencesType **Description:** This container represents the seller's preferences for the items that are awaiting payment. **Type:** object **Properties:** - **autoRelist** (boolean) - This boolean field is included if the seller wishes to toggle the setting that controls whether or not the line item should be automatically relisted when cancelled. For this field to be set to `true`, the `optInStatus` field should also be `true`. **Note**: If the line item was part of an auction listing or a single-quantity fixed price listing, a new listing will actually be created. If the line item was part of a multiple-quantity fixed price listing, eBay will only adjust the quantity based on the cancelled line item’s quantity. - **delayBeforeCancellingCommitment** (integer) - This integer field is included if the seller wishes to set or change the number of business days without payment that must elapse before the line item is cancelled. This is a required field if the optInStatus field is `true`. **Note**: The supported integer values (representing business days) varies by eBay marketplace. - **excludedUsers** (array) - This array is used if the seller wishes to exclude one or more eBay users from the unpaid item assistance mechanism. The seller would need to manually cancel any unpaid line items for all users on this list. This array will not be returned if there are no users on the excluded users list. **Note**: The eBay public username is used for each excluded user, and a comma is used to delimit each user in the array. - **optInStatus** (boolean) - This boolean field is included if the seller wishes to toggle the setting that controls whether or not the seller is opted into the unpaid item assistance mechanism. If the seller is not opted in, no other fields under `itemsAwaitingPaymentPreferences` are applicable. - **removeAllExcludedUsers** (boolean) - This boolean field is included and set to `true` if the seller wishes to remove all eBay users from the current excluded users list. If this field is included and set to `true`, the `excludedUsers` array should not be included. ### SetUserPreferencesRequest **Description:** This type defines the request fields for the seller preferences configuration for eBay services. **Type:** object **Properties:** - **combinedPaymentPreferences** (CombinedPaymentPreferencesType) - This container is included if the seller wishes to allow combined invoices if the buyer has multiple unpaid orders from the same seller. - **dispatchCutoffTimePreference** (DispatchCutoffTimePreferencesType) - This container is included if the seller wishes to set or modify the order cut-off time for same-day shipping. - **emailShipmentTrackingNumberPreference** (boolean) - This field is included if the seller wishes to enable or disable the setting that will automatically email the buyer with the tracking number when it becomes available. - **endOfAuctionEmailPreferences** (EndOfAuctionEmailPreferencesType) - This container is included if the seller wishes to change one or more of the end of auction email preferences. - **globalShippingProgramListingPreference** (boolean) - This boolean field is included if the seller wishes to toggle the setting that controls whether or not the seller’s new listings on the eBay UK marketplace will automatically use the Global Shipping Program for international shipping. **Note**: The Global Shipping Program is only available for the eBay UK marketplace, and the seller must be opted into the program, that is `offerGlobalShippingProgramPreference = true` - **itemsAwaitingPaymentPreferences** (SetItemsAwaitingPaymentPreferencesType) - This container is included if the seller wishes to change one or more of the items awaiting payment preferences. - **outOfStockControlPreference** (boolean) - This boolean field is included if the seller wishes to toggle the setting that controls whether or not the seller is opted into the Out-of-Stock feature. With this feature, a multiple quantity fixed price listing that runs out of stock will be hidden from eBay search but kept alive. Once the sellers add quantity to the listing, the listing will become active and available again. - **purchaseReminderEmailPreferences** (boolean) - This boolean field is included if the seller wishes to toggle the setting that controls whether or not the buyer is expected to provide a shipping phone number upon checkout. Some shipping carriers require the receiver's phone number. - **requiredShipPhoneNumberPreference** (boolean) - This boolean indicates whether the seller wishes to require phone numbers for shipping or not. - **shippingCarrierRatePreferences** (ShippingCarrierRatePreferencesType) - This container is included if the seller wishes to add or modify a FedEx, UPS, and/or US Post Office shipping rate type that is available to the seller. **Note**: This container is only applicable to the eBay US marketplace. ## Rate Limits See [API Call Limits](https://developer.ebay.com/develop/get-started/api-call-limits) on the eBay Developer Program. ## Resources ### Documentation - [eBay Developer Program](https://developer.ebay.com/) - [API Documentation](https://developer.ebay.com/develop/api/) - [SDKs and Widgets](https://developer.ebay.com/develop/sdks-and-widgets) - [Developer Community Forum](https://community.ebay.com/t5/Developer-Groups/ct-p/developergroup) ### Tools - [API Explorer](https://developer.ebay.com/my/api_test_tool) - [GraphQL Explorer](https://developer.ebay.com/my/graphql_explorer) ### Support - [Developer Support](https://developer.ebay.com/support/) - [API Status](https://developer.ebay.com/support/api-status) - [Release Notes](https://developer.ebay.com/develop/api/release_notes/) --- *Generated on 2026-06-11T19:56:17.310Z*