setSellerProfile

Sellers use this call to modify existing payment, return policy, and/or shipping Business Policies profiles.

Request Details

These are the steps for modifying a Business Policies profile:

Decide which type(s) of Business Policies profile(s) you are modifying. To modify a payment profile, you will need to include the paymentProfile container and modify all applicable settings/values. To modify a return policy profile, you will need to include the returnPolicyProfile container and modify all applicable settings/values. To modify a shipping policy profile, you will need to include the shippingPolicyProfile container and modify all applicable settings/values. It is possible to modify one of each profile type in one setSellerProfile call.
For each profile type you plan to modify, you must identify these profiles by including and specifying a value for the profileId and/or profileName fields.
For each Business Policies profile type that you are modifying with the setSellerProfile call, include and specify values for the applicable fields in the profile containers.

Another use case for using the setSellerProfile call is to change the default profile for a category group and profile type combination. It would actually require two setSellerProfile calls to perform this action. In the first call, you'd identify the current default profile through the profileId field, identify the category group that the profile belongs to in the categoryGroup.name field, and then pass in a value of 'false' in the categoryGroup.default field. In the second call, you'd identify the profile that you want set as the new default profile through the profileId field, identify the category group that the profile belongs to in the categoryGroup.name field, and then pass in a value of 'true' in the categoryGroup.default field.

Working with the Response

If an setSellerProfile call is successful in modifying all Business Policies profiles (payment, return policy, and/or shipping) specified in the request, an ack value of 'Success' is returned in the response. If the call fails, no Business Policies profiles are modified and an ack value of 'Failure' is returned in the response. For ack values of 'PartialFailure' or 'Warning', be sure to check the errorMessage container for more details on the result of the call.

All containers/fields/values passed in the setSellerProfile request are also returned in the setSellerProfile response.

You can use the profileId value for each Business Policies profile to update the profile (setSellerProfile), delete the profile (removeProfile), or view the profile (getSellerProfiles)

setSellerProfile Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<setSellerProfileRequest xmlns="http://www.ebay.com/marketplace/selling">
  <!-- Call-specific Input Fields -->
  <paymentProfile> PaymentProfile (SellerProfile)
    <categoryGroups> CategoryGroups
      <categoryGroup> CategoryGroup
        <default> boolean </default>
        <name> string </name>
      </categoryGroup>
      <!-- ... more categoryGroup nodes allowed here ... -->
    </categoryGroups>
    <paymentInfo> PaymentInfo
      <acceptedPaymentMethod> token </acceptedPaymentMethod>
      <!-- ... more acceptedPaymentMethod values allowed here ... -->
      <depositDetails> DepositDetails
        <daysToFullPayment> int </daysToFullPayment>
        <depositAmount> Amount (double) </depositAmount>
        <hoursToDeposit> int </hoursToDeposit>
      </depositDetails>
      <immediatePay> boolean </immediatePay>
      <paymentInstructions> string </paymentInstructions>
      <paypalEmailAddress> token </paypalEmailAddress>
    </paymentInfo>
    <profileDesc> string </profileDesc>
    <profileId> long </profileId>
    <profileName> string </profileName>
    <profileType> ProfileType </profileType>
    <siteId> int </siteId>
  </paymentProfile>
  <returnPolicyProfile> ReturnPolicyProfile (SellerProfile)
    <categoryGroups> CategoryGroups
      <categoryGroup> CategoryGroup
        <default> boolean </default>
        <name> string </name>
      </categoryGroup>
      <!-- ... more categoryGroup nodes allowed here ... -->
    </categoryGroups>
    <profileDesc> string </profileDesc>
    <profileId> long </profileId>
    <profileName> string </profileName>
    <profileType> ProfileType </profileType>
    <returnPolicyInfo> ReturnPolicyInfo
      <description> string </description>
      <refundOption> token </refundOption>
      <restockingFeeValue> token </restockingFeeValue>
      <returnsAcceptedOption> token </returnsAcceptedOption>
      <returnsWithinOption> token </returnsWithinOption>
      <shippingCostPaidByOption> token </shippingCostPaidByOption>
      <warrantyDurationOption> token </warrantyDurationOption>
      <warrantyOfferedOption> token </warrantyOfferedOption>
      <warrantyTypeOption> token </warrantyTypeOption>
    </returnPolicyInfo>
    <siteId> int </siteId>
  </returnPolicyProfile>
  <shippingPolicyProfile> ShippingPolicyProfile (SellerProfile)
    <categoryGroups> CategoryGroups
      <categoryGroup> CategoryGroup
        <default> boolean </default>
        <name> string </name>
      </categoryGroup>
      <!-- ... more categoryGroup nodes allowed here ... -->
    </categoryGroups>
    <profileDesc> string </profileDesc>
    <profileId> long </profileId>
    <profileName> string </profileName>
    <profileType> ProfileType </profileType>
    <shippingPolicyInfo> ShippingPolicyInfo
      <dispatchTimeMax> int </dispatchTimeMax>
      <dispatchTimeReason> string </dispatchTimeReason>
      <domesticRateTable> token </domesticRateTable>
      <domesticShippingPolicyInfoService> ShippingPolicyInfoService
        <buyerResponsibleForPickup> boolean </buyerResponsibleForPickup>
        <buyerResponsibleForShipping> boolean </buyerResponsibleForShipping>
        <codFee> Amount (double) </codFee>
        <fastShipping> boolean </fastShipping>
        <freeShipping> boolean </freeShipping>
        <shippingService> string </shippingService>
        <shippingServiceAdditionalCost> Amount (double) </shippingServiceAdditionalCost>
        <shippingServiceCost> Amount (double) </shippingServiceCost>
        <shippingSurcharge> Amount (double) </shippingSurcharge>
        <shipToLocation> token </shipToLocation>
        <!-- ... more shipToLocation values allowed here ... -->
        <sortOrderId> int </sortOrderId>
      </domesticShippingPolicyInfoService>
      <!-- ... more domesticShippingPolicyInfoService nodes allowed here ... -->
      <domesticShippingType> token </domesticShippingType>
      <excludeShipToLocation> token </excludeShipToLocation>
      <!-- ... more excludeShipToLocation values allowed here ... -->
      <freightShipping> FreightShipping
        <commodityType> token </commodityType>
        <destPickupInside> boolean </destPickupInside>
        <destPickupLocationType> token </destPickupLocationType>
        <freightShippingClass> double </freightShippingClass>
        <originPickupInside> boolean </originPickupInside>
        <originPickupLocationType> token </originPickupLocationType>
        <packagingHelpRequired> boolean </packagingHelpRequired>
      </freightShipping>
      <insurance> Insurance
        <domesticInsuranceFee> Amount (double) </domesticInsuranceFee>
        <domesticInsuranceOption> token </domesticInsuranceOption>
        <intlInsuranceFee> Amount (double) </intlInsuranceFee>
        <intlInsuranceOption> token </intlInsuranceOption>
      </insurance>
      <internationalPackagingHandlingCosts> Amount (double) </internationalPackagingHandlingCosts>
      <intlRateTable> token </intlRateTable>
      <intlShippingPolicyInfoService> ShippingPolicyInfoService
        <buyerResponsibleForPickup> boolean </buyerResponsibleForPickup>
        <buyerResponsibleForShipping> boolean </buyerResponsibleForShipping>
        <codFee> Amount (double) </codFee>
        <shippingService> string </shippingService>
        <shippingServiceAdditionalCost> Amount (double) </shippingServiceAdditionalCost>
        <shippingServiceCost> Amount (double) </shippingServiceCost>
        <shippingSurcharge> Amount (double) </shippingSurcharge>
        <shipToLocation> token </shipToLocation>
        <!-- ... more shipToLocation values allowed here ... -->
        <sortOrderId> int </sortOrderId>
      </intlShippingPolicyInfoService>
      <!-- ... more intlShippingPolicyInfoService nodes allowed here ... -->
      <intlShippingType> token </intlShippingType>
      <packagingHandlingCosts> Amount (double) </packagingHandlingCosts>
      <shippingOption> token </shippingOption>
      <shippingPolicyCurrency> IsoCurrencyCode </shippingPolicyCurrency>
      <shippingPolicyName> string </shippingPolicyName>
      <shippingProfileDiscountInfo> ShippingProfileDiscountInfo
        <applyDomesticPromoShippingProfile> boolean </applyDomesticPromoShippingProfile>
        <applyIntlPromoShippingProfile> boolean </applyIntlPromoShippingProfile>
        <domesticFlatCalcDiscountProfileId> long </domesticFlatCalcDiscountProfileId>
        <intlFlatCalcDiscountProfileId> long </intlFlatCalcDiscountProfileId>
      </shippingProfileDiscountInfo>
      <shipToLocations> token </shipToLocations>
      <!-- ... more shipToLocations values allowed here ... -->
    </shippingPolicyInfo>
    <siteId> int </siteId>
  </shippingPolicyProfile>
  <!-- Standard Input Fields -->
  <extension> ExtensionType
  </extension>
  <!-- ... more extension nodes allowed here ... -->
</setSellerProfileRequest>

Argument	Type	Occurrence	Meaning

Call-specific Input Fields [Jump to standard fields]

paymentProfile	PaymentProfile (SellerProfile)	Conditional	Root container for a seller's payment profile. The paymentProfile container consists of payment information, the name and description of the profile, and the site and category group to which the payment profile will be applied. The paymentProfile container is conditionally required if the seller wants to modify an existing payment profile. Sellers only pass in values for the fields they want to change. To delete an optional field, sellers can pass an empty value into the field.
paymentProfile.categoryGroups	CategoryGroups	Required	This container consists of one or more categoryGroup containers. One or more category groups are linked to each Business Policies profile.
paymentProfile.categoryGroups .categoryGroup	CategoryGroup	Required, repeatable: [1..*]	This container indicates the category group to which the payment, return policy, or shipping profile applies to. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive. Each Business Policies profile can be associated with more than one category group.
paymentProfile.categoryGroups .categoryGroup.default	boolean	Required	This flag indicates if the corresponding Business Policies profile defined for the assigned category group is used by default for listings in a category group that does not have a Business Policies profile assigned to it. For example, if a seller has only created a Business Policies profile for motor vehicles (categoryGroup=MOTORS_VEHICLE), and this category group is set as the default, all applicable settings/values in this Business Policies profile will also apply to non-motor vehicle categories. If this field is not included in the call request, by default, the first (or only) category group specified in the request will get assigned as the default category group. Only one category group can be the default, so categoryGroup.default cannot be 'true' for more than one category group.
paymentProfile.categoryGroups .categoryGroup.name	string	Required	This string value indicates the name of the category group to which the corresponding Business Policies profile applies. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive.
paymentProfile.paymentInfo	PaymentInfo	Conditional	This container consists of detailed payment information for a seller's payment profile. This container is conditionally required if the caller is creating a new or modifying an existing payment profile. This container is returned by getSellerProfiles if one or more payment profiles match the input criteria in the call request, and is returned in the response of addSellerProfile or setSellerProfile if a payment profile is being created or modified, respectively.
paymentProfile.paymentInfo .acceptedPaymentMethod	token	Conditional, repeatable: [0..*]	Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. At least one payment method is required to be specified in each payment profile. If you specify multiple acceptablePaymentMethod fields, the repeating fields must be contiguous. Note: Required or allowed payment methods vary by site and category. To retrieve a list of valid payment methods for your site and category, call GetCategoryFeatures, specifying 'PaymentMethods' as a FeatureID value in the call request, and then look for the Category.PaymentMethod values in the call response. For motor vehicle payment profiles (CategoryGroup.name=MOTORS_VEHICLE), 'PayPal' must be one of acceptedPaymentMethod values if a deposit is required (the paymentInfo.depositDetails container exist for the payment profile), and in order for a buyer to make a full payment on an US or CA motor vehicle, at least one of the following acceptedPaymentMethod values must be specified: CashOnPickup LoanCheck MOCC (money order or cashier's check) PaymentSeeDescription (payment instructions are in the paymentInstructions field) PersonalCheck
paymentProfile.paymentInfo .depositDetails	DepositDetails	Conditional	This container is used by the seller to specify amounts and due dates for deposits and full payment on motor vehicle listings on eBay Motors (US and CA). This container is only applicable if the categoryGroup.name field is set to 'MOTORS_VEHICLE'.
paymentProfile.paymentInfo .depositDetails .daysToFullPayment	int	Conditional	This integer value indicates the number of days that a buyer has (after he/she commits to buy) to make full payment to the seller and close the remaining balance on a motor vehicle. Valid values are '3', '7' (default), '10', and '14'. In order for a buyer to make a full payment on an US or CA motor vehicle, at least one of the following acceptedPaymentMethod values must be specified for the corresponding payment profile: CashOnPickup LoanCheck MOCC (money order or cashier's check) PaymentSeeDescription (payment instructions are in the item's description) PersonalCheck Min: 3. Max: 14. Default: 7.
paymentProfile.paymentInfo .depositDetails.depositAmount	Amount (double)	Conditional	This dollar value indicates the amount of the deposit that a buyer must make on a purchased motor vehicle (eBay Motors US and CA). The deposit amount can be as high as $2,000.00. If not specified, this value defaults to 0.0. If this value is specified, the seller must also specify an hoursToDeposit value. Deposits on motor vehicles can only be paid using PayPal, so if depositAmount is specified, then one of the acceptedPaymentMethod values must be 'PayPal' (in addition to the payment methods offered for the full payment). Unlike other listings, PayPal is not automatically added to a Motors listing even if the seller has a PayPal preference set in My eBay. The seller also needs to have a linked PayPal account in order to require a deposit from the buyer. The deposit amount appears in the shipping, payment details and return policy sections of the View Item page. Min: 0.0. Max: 2000.0.
paymentProfile.paymentInfo .depositDetails.hoursToDeposit	int	Conditional	This integer value indicates the number of hours that a buyer has (after he/she commits to buy) to make a deposit to the seller as a down payment on a motor vehicle. Valid values are '24', '48' (default), and '72'. The deposit amount is specified in the depositAmount field. If not specified, the depositAmount value defaults to 0.0, in which case, a deposit on the vehicle is not required. In order for a buyer to make a full payment on an US or CA motor vehicle, one of the acceptedPaymentMethod values must be 'PayPal' (in addition to the payment methods offered for the full payment). Min: 24. Max: 72. Default: 48.
paymentProfile.paymentInfo .immediatePay	boolean	Conditional	To create an immediate payment policy that can be applied to a listing, immediatePay must be included and set to 'true' for the payment profile. If the seller does not want to apply an immediate payment policy for an item, this field is either omitted, or included and set to 'false'. The seller can change this payment policy at any time during the lifecyle of a listing. In the Trading API calls that return the AutoPay field (immediatePay equivalent), be aware that the field's appearance in the output does not necessarily indicate that the listing qualifies for immediate payment, but only that the seller attempted to create (by including and setting immediatePay to 'true' in the payment profile) an immediate payment option. In order for a seller to apply an immediate payment requirement for an item, the following must be true: seller must have a Premier or Business PayPal account; the Buy It Now price (if applicable) cannot be higher than $10,000 USD; the listing site supports PayPal payments; the category supports PayPal payments; the listing type is fixed-price or auction (with Buy It Now option). To successfully enable the immediate payment requirement, the seller must also perform the following actions through the API call: seller must provide a valid paymentProfile.paymentInfo.paypalEmailAddress value; seller must offer PayPal as the only payment method; seller must specify all related costs to the buyer, since the buyer will not be able to use the Buyer Request Total feature in an immediate payment listing; these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges; seller must include and set the shippingProfileDiscountInfo container values if promotional shipping discounts will be used; Default: false.
paymentProfile.paymentInfo .paymentInstructions	string	Conditional	This free-form string field allows the seller to give payment instructions to the buyer. These instructions will appear on eBay's View Item and Checkout page. This field allows 1000 characters. It is recommended that the seller use this field for motor vehicles (eBay Motors US and CA) payment profiles to clarify the specifics on the deposit (if required), pickup/delivery arrangements, and full payment details on the vehicle. Max length: 1000.
paymentProfile.paymentInfo .paypalEmailAddress	token	Conditional	The valid email address linked to the seller's PayPal account. This field is required in the payment profile if 'PayPal' is one of the acceptedPaymentMethod values in the payment profile. eBay uses this email address to identify the correct PayPal account when the buyer pays via PayPal during the checkout process. For digital listings, sellers must use an email address that is associated with a PayPal Premier or Business account.
paymentProfile.profileDesc	string	Optional	This field is used by the seller to provide a description of the Business Policies profile. The profileDesc field is optional in the addSellerProfile and setSellerProfile calls. This field is only returned for a profile if a description exists for that profile. Max length: 250.
paymentProfile.profileId	long	Required	The unique identifier of the Business Policies profile. This value is created by eBay when a Business Policies profile is created (on site or through API). A profileId value is required when using the setSellerProfile and removeSellerProfile calls. It can be used as a filter in a getSellerProfiles to identify a specific Business Policies profile to retrieve. This field is always returned with all Business Policies Management calls. A profileId value returned in the response of an addSellerProfile call indicates that the Business Policies profile was created successfully.
paymentProfile.profileName	string	Required	This string value indicates the name of the Business Policies profile. This profile name must be unique among all of seller's Business Policies profiles. A profileName value is required when using the addSellerProfile and setSellerProfile calls.
paymentProfile.profileType	ProfileType	Required	This field indicates the type of Business Policies profile. A profileType value is required when using the addSellerProfile and setSellerProfile calls. It can be used as a filter in a getSellerProfiles call to identify and retrieve Business Policies profiles of a specific type. Applicable values: • PAYMENT This value indicates the Business Policies profile is a payment profile. • RETURN_POLICY This value indicates the Business policies profile is a return policy profile. • SHIPPING This value indicates the Business Policies profile is a shipping profile.
paymentProfile.siteId	int	Optional	Unique identifier of the eBay site. This value is always returned in the getSellerProfiles call. It is optional in the addSellerProfile and setSellerProfile calls. If it is not used in an addSellerProfile or setSellerProfile call, the siteId value defaults to the seller's eBay registration site. When creating a Business Policies profile for motor vehicle listings on the US eBay Motors site (Site ID=100), the siteId field should be included and set to '0' (US site). By performing this action, the Business Policies Management Service automatically applies the Business Policies profile from the eBay US site (Site ID=0) to the US eBay Motors site (Site ID=100).
returnPolicyProfile	ReturnPolicyProfile (SellerProfile)	Conditional	Root container for a seller's return policy profile. The returnPolicyProfile container consists of return policy information, the name and description of the profile, and the site and category group to which the return policy profile will be applied. The returnPolicyProfile container is conditionally required if the seller wants to modify an existing return policy profile. Sellers only pass in values for the fields that they want to change. To delete an optional field, sellers can pass an empty value into the field.
returnPolicyProfile .categoryGroups	CategoryGroups	Required	This container consists of one or more categoryGroup containers. One or more category groups are linked to each Business Policies profile.
returnPolicyProfile .categoryGroups.categoryGroup	CategoryGroup	Required, repeatable: [1..*]	This container indicates the category group to which the payment, return policy, or shipping profile applies to. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive. Each Business Policies profile can be associated with more than one category group.
returnPolicyProfile .categoryGroups.categoryGroup .default	boolean	Required	This flag indicates if the corresponding Business Policies profile defined for the assigned category group is used by default for listings in a category group that does not have a Business Policies profile assigned to it. For example, if a seller has only created a Business Policies profile for motor vehicles (categoryGroup=MOTORS_VEHICLE), and this category group is set as the default, all applicable settings/values in this Business Policies profile will also apply to non-motor vehicle categories. If this field is not included in the call request, by default, the first (or only) category group specified in the request will get assigned as the default category group. Only one category group can be the default, so categoryGroup.default cannot be 'true' for more than one category group.
returnPolicyProfile .categoryGroups.categoryGroup .name	string	Required	This string value indicates the name of the category group to which the corresponding Business Policies profile applies. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive.
returnPolicyProfile .profileDesc	string	Optional	This field is used by the seller to provide a description of the Business Policies profile. The profileDesc field is optional in the addSellerProfile and setSellerProfile calls. This field is only returned for a profile if a description exists for that profile. Max length: 250.
returnPolicyProfile.profileId	long	Required	The unique identifier of the Business Policies profile. This value is created by eBay when a Business Policies profile is created (on site or through API). A profileId value is required when using the setSellerProfile and removeSellerProfile calls. It can be used as a filter in a getSellerProfiles to identify a specific Business Policies profile to retrieve. This field is always returned with all Business Policies Management calls. A profileId value returned in the response of an addSellerProfile call indicates that the Business Policies profile was created successfully.
returnPolicyProfile .profileName	string	Required	This string value indicates the name of the Business Policies profile. This profile name must be unique among all of seller's Business Policies profiles. A profileName value is required when using the addSellerProfile and setSellerProfile calls.
returnPolicyProfile .profileType	ProfileType	Required	This field indicates the type of Business Policies profile. A profileType value is required when using the addSellerProfile and setSellerProfile calls. It can be used as a filter in a getSellerProfiles call to identify and retrieve Business Policies profiles of a specific type. Applicable values: • PAYMENT This value indicates the Business Policies profile is a payment profile. • RETURN_POLICY This value indicates the Business policies profile is a return policy profile. • SHIPPING This value indicates the Business Policies profile is a shipping profile.
returnPolicyProfile .returnPolicyInfo	ReturnPolicyInfo	Conditional	This container consists of detailed information on a seller's return policy. This container is conditionally required if the caller is creating a new or modifying an existing return policy profile. This container is returned by getSellerProfiles if one or more return policy profiles match the input criteria in the call request.
returnPolicyProfile .returnPolicyInfo.description	string	Optional	This free-form string field allows the seller to provide a detailed explanation of the return policy. The maximum length of this optional field is 5000. eBay uses this text string as-is in the Return Policy section of the View Item page. Avoid HTML, and avoid character entity references. If you include special characters in the return policy description, use the literal UTF-8 or ISO-8559-1 character. Max length: 5000.
returnPolicyProfile .returnPolicyInfo.refundOption	token	Conditional	This value indicates how the seller will compensate the buyer for a returned item. Use the returnPolicyInfo.Description field to explain the policy details (such as how quickly the seller will process the refund, whether the seller must receive the item before processing the refund, and other useful details). Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and look at the ReturnPolicyDetails.Refund.RefundOption values in the response to determine which refund options are supported for your site. For Add/Revise/Relist family of Trading API calls, if the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted), the RefundOption value will be set with a default value (such as 'MoneyBack') on some eBay sites, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set his/her desired value here. As of version 771, the only allowed values for RefundOption on the US site are 'MoneyBack' and 'MoneyBackOrExchange'. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value.
returnPolicyProfile .returnPolicyInfo .restockingFeeValue	token	Optional	Sellers who accept returns should include this field if they charge buyers a restocking fee when items are returned. A restocking fee only comes into play when an item is returned, as this fee will reduce the total amount that the buyer is refunded for the returned item. Possible values are: NoRestockingFee: no restocking fee is charged to the buyer Percent_10: 10 percent of the item price is charged to the buyer as a restocking fee Percent_15: 15 percent of the item price is charged to the buyer as a restocking fee Percent_20: 20 percent of the item price is charged to the buyer as a restocking fee This field is returned in getSellerProfiles if seller has set this value for the corresponding return policy profile.
returnPolicyProfile .returnPolicyInfo .returnsAcceptedOption	token	Conditional	Indicates whether the seller allows the buyer to return the item. This is a required field for a return policy profile. All sites allow the seller to choose between accepting (specify 'ReturnsAccepted') or not accepting (specify 'ReturnsNotAccepted') returns. An exception to this rule is on some eBay European sites (UK, Ireland, DE), where some categories require business sellers to accept returns for fixed-price items and auction items purchased with the Buy It Now option. The GetUser Trading API call can be used by DE/IE/UK sellers to determine a user's current business seller status (look at User.SellerInfo.SellerBusinessType). Note that Top-Rated sellers must accept item returns for a listing in order for that listing to receive a Top Rated Plus badge on the View Item page or search results page. See: (GeteBayDetails) ReturnsAcceptedOption for sites that support this field, and applicable values Returns and the Law (UK)
returnPolicyProfile .returnPolicyInfo .returnsWithinOption	token	Conditional	If the return policy specifies that the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted), then the returnsWithinOption field is required. This field's value determines the number of business days that the buyer has to return the item (after receiving the item). It is good practice to call this value out in the returnPolicy.description field. As of version 771, 3-day, 7-day, and 10-day return policies have been deprecated on the US site, and listings will be blocked if 'Days_3', 'Days_7', or 'Days_10' are used. The three allowed values are 'Days_14', 'Days_30', and 'Days_60'. Some eBay sites may set a default value (such as 'Days_14') if the seller accepts returns but the returnsWithinOption field is omitted. If the listing has bids or sales and/or ends within 12 hours, you can't change this value.
returnPolicyProfile .returnPolicyInfo .shippingCostPaidByOption	token	Conditional	This value is used by the seller to indicate whether the buyer or the seller is responsible for paying return shipping charges. Possible values are 'Buyer' or 'Seller'. This value is required if ReturnsAcceptedOption=ReturnsAccepted. Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and look at the ReturnPolicyDetails.ShippingCostPaidBy values in the response to determine which enumeration values are supported for your site. It is good practice for the seller to indicate the party responsible for return shipping in the returnPolicy.description field. This field is returned in getSellerProfiles if set for a matching return policy profile. If a seller is revising a listing that has bids or sales and/or ends within 12 hours, you can't change this value.
returnPolicyProfile .returnPolicyInfo .warrantyDurationOption	token	Conditional	This value indicates the warranty period for a product. This value is applicable if the seller accepts returns and a warranty is offered (returnPolicyInfo.warrantyOfferedOption=WarrantyOffered). Valid values are 'Months_1', 'Months_3', 'Months_6', 'Years_1', 'Years_2', 'Years_3', and 'Years_MoreThan3'. Currently, only the eBay India site supports warranties on eBay items. Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and look at the ReturnPolicyDetails.WarrantyDuration values in the response to determine which enumeration values are supported. If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See WarrantyDurationOptionsCodeType.
returnPolicyProfile .returnPolicyInfo .warrantyOfferedOption	token	Conditional	This value indicates whether a seller offers a warranty. Valid values are 'None' and 'WarrantyOffered'. Currently, only the eBay India site supports warranties on eBay items.
returnPolicyProfile .returnPolicyInfo .warrantyTypeOption	token	Conditional	This value indicates the type of warranty that is offered with the product. This value is applicable if the seller accepts returns and a warranty is offered (returnPolicyInfo.warrantyOfferedOption=WarrantyOffered). Valid values are 'DealerWarranty', 'ManufacturerWarranty', and 'ReplacementWarranty'. Currently, only the eBay India site supports warranties on eBay items. Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and look at the ReturnPolicyDetails.WarrantyType values in the response to determine which enumeration values are supported. If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See WarrantyTypeOptionsCodeType.
returnPolicyProfile.siteId	int	Optional	Unique identifier of the eBay site. This value is always returned in the getSellerProfiles call. It is optional in the addSellerProfile and setSellerProfile calls. If it is not used in an addSellerProfile or setSellerProfile call, the siteId value defaults to the seller's eBay registration site. When creating a Business Policies profile for motor vehicle listings on the US eBay Motors site (Site ID=100), the siteId field should be included and set to '0' (US site). By performing this action, the Business Policies Management Service automatically applies the Business Policies profile from the eBay US site (Site ID=0) to the US eBay Motors site (Site ID=100).
shippingPolicyProfile	ShippingPolicyProfile (SellerProfile)	Conditional	Root container for a seller's shipping profile. The shippingPolicyProfile container consists of shipping information, the name and description of the profile, and the site and category group to which the shipping profile will be applied. The shippingPolicyProfile container is conditionally required if the seller wants to modify an existing shipping profile. Sellers only pass in values for the fields they want to change. To delete an optional field, sellers can pass an empty value into the field.
shippingPolicyProfile .categoryGroups	CategoryGroups	Required	This container consists of one or more categoryGroup containers. One or more category groups are linked to each Business Policies profile.
shippingPolicyProfile .categoryGroups.categoryGroup	CategoryGroup	Required, repeatable: [1..*]	This container indicates the category group to which the payment, return policy, or shipping profile applies to. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive. Each Business Policies profile can be associated with more than one category group.
shippingPolicyProfile .categoryGroups.categoryGroup .default	boolean	Required	This flag indicates if the corresponding Business Policies profile defined for the assigned category group is used by default for listings in a category group that does not have a Business Policies profile assigned to it. For example, if a seller has only created a Business Policies profile for motor vehicles (categoryGroup=MOTORS_VEHICLE), and this category group is set as the default, all applicable settings/values in this Business Policies profile will also apply to non-motor vehicle categories. If this field is not included in the call request, by default, the first (or only) category group specified in the request will get assigned as the default category group. Only one category group can be the default, so categoryGroup.default cannot be 'true' for more than one category group.
shippingPolicyProfile .categoryGroups.categoryGroup .name	string	Required	This string value indicates the name of the category group to which the corresponding Business Policies profile applies. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive.
shippingPolicyProfile .profileDesc	string	Optional	This field is used by the seller to provide a description of the Business Policies profile. The profileDesc field is optional in the addSellerProfile and setSellerProfile calls. This field is only returned for a profile if a description exists for that profile. Max length: 250.
shippingPolicyProfile .profileId	long	Required	The unique identifier of the Business Policies profile. This value is created by eBay when a Business Policies profile is created (on site or through API). A profileId value is required when using the setSellerProfile and removeSellerProfile calls. It can be used as a filter in a getSellerProfiles to identify a specific Business Policies profile to retrieve. This field is always returned with all Business Policies Management calls. A profileId value returned in the response of an addSellerProfile call indicates that the Business Policies profile was created successfully.
shippingPolicyProfile .profileName	string	Required	This string value indicates the name of the Business Policies profile. This profile name must be unique among all of seller's Business Policies profiles. A profileName value is required when using the addSellerProfile and setSellerProfile calls.
shippingPolicyProfile .profileType	ProfileType	Required	This field indicates the type of Business Policies profile. A profileType value is required when using the addSellerProfile and setSellerProfile calls. It can be used as a filter in a getSellerProfiles call to identify and retrieve Business Policies profiles of a specific type. Applicable values: • PAYMENT This value indicates the Business Policies profile is a payment profile. • RETURN_POLICY This value indicates the Business policies profile is a return policy profile. • SHIPPING This value indicates the Business Policies profile is a shipping profile.
shippingPolicyProfile .shippingPolicyInfo	ShippingPolicyInfo	Conditional	This container consists of detailed shipping information for a seller's shipping profile. This container is conditionally required if the caller is creating a new or modifying an existing shipping profile. This container is returned by getSellerProfiles if one or more shipping profiles match the input criteria in the call request.
shippingPolicyProfile .shippingPolicyInfo .dispatchTimeMax	int	Conditional	Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment for an order. This time does not include the shipping time (the carrier's transit time). Valid values can vary by site and by category. To obtain supported values for a site, call GeteBayDetails, using DispatchTimeMaxDetails as a DetailName value in the request, and then look at the DispatchTimeMaxDetails container in the response for supported values for the site. Note that Top-Rated sellers must offer one-day handling (or zero-day handling once it becomes available in late May 2013) for a listing in order for that listing to receive a Top Rated Plus seal on the View Item page or search results. To offer one-day handling, the seller should include the dispatchTimeMax field in the shipping profile and set the value of this field to '1'. The dispatchTimeMax field must be included in the shipping profile and set to '1' (or '0' once zero-day handling becomes available in late May 2013) if the fastShipping flag is included and set to 'true' in the shipping profile. Note: Traditionally in the Trading API, sellers using an Add/Revise/Relist API call were allowed to pass in a DispatchTimeMax value of '0' to indicate that no handling time is specified for the listing. However, starting in late May, a DispatchTimeMax value of '0' will indicate that the seller is offering same-day shipping. Once same-day shipping is live, sellers that do not want to specify a handling time for their Business Policies shipping profile, should omit the < b>dispatchTimeMax field, or they can include it but set it to null. This field is always returned with all shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Min: 1. Max: 30.
shippingPolicyProfile .shippingPolicyInfo .dispatchTimeReason	string	Optional	This free-form string field is used by the seller to provide more details to the buyer about handling time. If set for the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticRateTable	token	Optional	This value indicates that the seller's domestic shipping rate table should be referenced to determine flat-rate shipping costs based on shipping service level and delivery location. Currently, the only valid value for domesticRateTable is 'Default', which means that the default domestic shipping rate table set up by the seller in My eBay is referenced. Including this field in an addSellerProfile or setSellerProfile call will only have an effect on flat shipping rates if a domestic shipping rate table is set up for the seller's account in My eBay, and it will only affect those domestic regions for which flat shipping rates are defined. If set for the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Max length: 50.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService	ShippingPolicyInfoService	Conditional, repeatable: [0..*]	Container that consists of detailed information for a domestic shipping service, including shipping costs, ship-to locations, and flags to indicate Fast and/or Free shipping. Up to four domestic shipping service options can be specified in one shipping profile. Each specified domestic shipping service is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .buyerResponsibleForPickup	boolean	Conditional	This field is only applicable to vehicle categories on eBay Motors (US and Canada). If this field is included and set to 'true', the buyer is responsible for pickup of the vehicle. If this field is 'false', the seller should specify the vehicle pickup arrangements in the item description. If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag. If set for one or more shipping services within the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Default: true.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .buyerResponsibleForShipping	boolean	Conditional	This field is only applicable to vehicle categories on eBay Motors (US and Canada). If this field is included and set to 'true', the buyer is responsible for the shipment of the vehicle. If this field is 'false', the seller should specify the vehicle shipping arrangements in the item description. If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag. If set for one or more shipping services within the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Default: true.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .codFee	Amount (double)	Conditional	This value indicates the Cash-on-Delivery fee that is due from the buyer upon item delivery. This field is only applicable if the selected payment method is 'COD' and if the selected shipping service option suppports the Cash-on-Delivery option. To see if a domestic shipping service option supports the Cash-on-Delivery option, call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a CODService=true flag for the corresponding shipping service. If a Cash-on-Delivery shipping service is defined for the shipping profile, this field is returned in the shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .fastShipping	boolean	Conditional	This flag indicates whether the seller has opted into the 'Get It Fast' shipping program for the listing. 'Get It Fast' shipping is only available for fixed-price listings and auction listings with an active 'Buy It Now' option. To enable 'Get It Fast' shippping for a listing, the seller must: offer at least one domestic one-day shipping service option, such as USPS Express Mail, UPS Next Day Air, or FedEx Overnight; set the shippingPolicyInfo.dispatchTimeMax value to '1', which means that the seller is committing to ship the item within one business day after receiving payment from the buyer. Starting in May 2013, a DispatchTimeMax value of '0' will indicate that the seller is offering same-day shipping. As soon as same-day shipping becomes available to them, sellers can set the shippingPolicyInfo.dispatchTimeMax value to '0' or '1' to enable 'Get It Fast' shipping. Although it is not required, it is recommended that sellers also offer an immediate payment option to the buyer, so they can get their item even faster. In the payment profile, this option is turned on with the paymentInfo.immediatePay flag. To enable the immediate payment feature on a listing, the seller must: have a Premier or Business PayPal account; provide a valid Item.PayPalEmailAddress value; offer 'PayPal' as the single payment method in the Item.PaymentMethods field. The fastShipping field should only be included and set to 'true' in domesticShippingPolicyInfoService containers where the shipping service option is a one-day shipping service. The fastShipping field is not applicable for internationalShippingPolicyInfoService containers. Not supported for UK Store Inventory format or Half.com items. If 'Get It Fast' shipping is set for a domestic shipping service, this field is returned in the shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .freeShipping	boolean	Conditional	This flag is used by the seller to offer free domestic shipping to the buyer. This field can only be included and set to 'true' for the first specified domestic shipping service option (it is ignored if set for any other shipping service option). The first specified shipping service option either has a sortOrderId value of '1', or, if the sortOrderId field is not used, the shipping service option specified first in the API call. If free shipping is set for a domestic shipping service, this field is returned in the shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .shippingService	string	Conditional	A domestic or international shipping service being offered by the seller to ship an item to a buyer. For a list of valid shippingService values, call GeteBayDetails, including ShippingServiceDetails as a DetailName value, and then look through the ShippingServiceDetails containers returned in the response. International shipping services are marked with an InternationalService flag. All shipping services without this flag are domestic shipping services. The ShippingServiceDetails.ValidForSellingFlow flag must be present for both domestic and international shipping services, otherwise, that specific shipping service option is no longer valid and cannot be offered to buyers through a listing. The seller must specify one shipping service in each domesticShippingPolicyInfoService and internationalShippingPolicyInfoService container in an addSellerProfile or setSellerProfile request. Up to four domestic and five international shipping service may be offered to the buyer per listing. If 'Get It Fast' shipping is being enabled for the shipping profile (fastShipping=true), the first specified domestic shipping service (specified in the first domesticShippingPolicyInfoService.shippingService field) must be a one-day shipping service. To verify that a domestic shipping service is a one-day shipping service (hence, it qualifies for 'Get It Fast' shipping), call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a ShippingCategory value of 'ONE_DAY' for the corresponding shipping service. 'Get It Fast' shipping is not available for international shipping. Each shipping service specified for the shipping profile is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See GeteBayDetails.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .shippingServiceAdditionalCost	Amount (double)	Conditional	This value sets the cost of shipping each additional item if the buyer purchases multiple identical items in a multi-quantity, fixed-price listing. This field is required for all multi-quantity, fixed-price listings where flat-rate shipping is used. This value is at the seller's discretion. Generally, it should be the same price or lower than the shippingServiceCost value. The seller may consider specifying a lower price to ship additional items as an incentive to the buyer to purchase multiple items. The seller may also consider a lower price if he/she is able to ship multiple items in the same box. In this scenario, the seller is able to save on shipping costs and passes these savings down to the buyer. The total shipping costs for an order line item is calculated with the following formula: Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost * quantity purchased) So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 * 3)). This field is not applicable to calculated shipping. If set for one or more shipping services within the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .shippingServiceCost	Amount (double)	Conditional	This value sets the cost of shipping for the item if the buyer selects this shipping service option. This field is required in the input for all listings where flat-rate shipping is used, and is not applicable to calculated shipping. This value is at the seller's discretion but should reflect the approximate cost of the shipping service option plus handling. This value defaults to 0.0 if the freeShipping field is set to 'true'. The total shipping costs for an order line item is calculated with the following formula: Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost * quantity purchased) So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 * 3)). This field is always returned (for each shipping service) with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .shippingSurcharge	Amount (double)	Optional	An additional charge that US sellers can add to the cost of an order line item if that order line item is an eBay Motors Parts and Accessories item that is being shipped to a buyer in Alaska, Hawaii, or Puerto Rico through a UPS or FedEx shipping service that charges a surcharge to ship to those areas. In order for sellers to add a shipping surcharge at the shipping service level, the following must be true: a surcharge is applicable for the shipping service (call GeteBayDetails with DetailName set to ShippingServiceDetails, and then look for ShippingServiceDetails.SurchargeApplicable=true in the response; flat-rate shipping is used If set for one or more shipping services within the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .shipToLocation	token	Conditional, repeatable: [0..*]	An international region (such as Asia or Europe) or a country (represented by two- letter country code) to where the seller will ship an item. To obtain valid 'Ship- To locations' for their site, the seller must call GeteBayDetails, using ShipppingLocationDetails as a DetailName value in the request, and then scanning the ShippingLocationDetails.ShippingLocation values that are returned in the response. The shipping regions and countries that may be specified as shipToLocation values will vary according to eBay site. The seller may include as many valid shipToLocation values as necessary based on where they are willing to ship an item. If no shipToLocation field is included in the domesticShippingPolicyInfoService container when using the addSellerProfile or setSellerProfile calls, eBay will automatically add the seller's listing country as a 'Ship-To Location'. If the seller does want to offer international shipping as part of the shipping profile, at least one shipToLocation field in the internationalShippingPolicyInfoService container is required when using the addSellerProfile and setSellerProfile calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a shipToLocation value. If the seller wants to ship to a specific region, but would like to exclude one or more countries in that region, the seller should include that region as a shipToLocation value, but then exclude one or more countries in that region by including one or more instances of the shippingPolicyInfo.excludeShipToLocation field. Each ship-to location specified for the shipping service is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See GeteBayDetails (ShippingLocationDetails).
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .sortOrderId	int	Conditional	This integer value controls the order (relative to other shipping service options) in which the corresponding shipping service option will appear in the View Item and Checkout pages. Sellers can specify up to four domestic shipping services (in four separate domesticShippingPolicyInfoService containers), so valid values are 1, 2, 3, and 4. A shipping service option with a sortOrderId value of '1' appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a sortOrderId value of '4' appears at the bottom of a list of four shipping service options. Sellers can specify up to five international shipping services (in five separate internationalShippingPolicyInfoService containers), so valid values are 1, 2, 3, 4, and 5. Similarly to domesstic shipping service options, the sortOrderId value of a international shipping service option controls the placement of that shipping service option in the View Item and Checkout pages. If the sortOrderId field is not used, the order of domestic and international shipping service options will be determined by the order they are listed in the API call. This field is always returned (for each shipping service) with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Min: 1. Max: 4 (for domestic shipping service) or 5 (for international shipping service).
shippingPolicyProfile .shippingPolicyInfo .domesticShippingType	token	Optional	The domestic shipping cost model used by the seller. The only three valid values are 'Calculated', 'Flat', or 'FreightFlat'. If this field is not included and specified in an addSellerProfile or setSellerProfile call, it defaults to 'Flat' shipping. If 'FreightFlat' is specified as the domestic shipping type, the freightShipping container and its values must be set in the shipping profile. If 'Calculated' is used as the shipping type, the CalculatedShippingRate container must be used when listing, revising, or relisting an item through the Trading API. This field is always returned with all shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Default: Flat. See Shipping.
shippingPolicyProfile .shippingPolicyInfo .excludeShipToLocation	token	Optional, repeatable: [0..*]	Sellers can use this field to exclude one or more international regions, countries, or special domestic locations (such as 'PO Box' in US or 'Packstation' in Germany) as possible shipping locations. To obtain valid 'exclude Ship-To locations', the seller must call GeteBayDetails, using ExcludeShipppingLocationDetails as a DetailName value in the request, and then scanning the ExcludeShippingLocationDetails.Location values that are returned in the response. The seller may include as many valid excludeShipToLocation values as necessary based on where they are not willing to ship an item. If a buyer's primary ship-to location is a location that the seller has listed as an excluded ship-to location, that buyer will receive an error message if they attempt to buy or place a bid on your item. This field works in conjunction with the shipToLocation values to create a set of international regions, countries, and domestic locations to where the seller will (and will not) ship. You can list a region in the shipToLocation field, then exclude specific countries within that region with this field. For example, you can specify 'Africa' as a shipToLocation value, yet exclude Egypt by including an excludeShipToLocation field with its value set to 'EG', which is Egypt's two-digit country code. and setting it to setting). In addition, if a seller used only one shipToLocation value and set it to 'Worldwide', that seller can use one or more excludeShipToLocation fields to exclude one or more international regions, countries, or special domestic locations as possible shipping destinations. Each excluded ship-to location is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See GeteBayDetails (ExcludeShippingLocationDetails).
shippingPolicyProfile .shippingPolicyInfo .freightShipping	FreightShipping	Conditional	This container consists of details related to freight shipping. This container and its values are required to be set in a shipping profile if the seller offers freight shipping (domesticShippingType and/or intlShippingType is set to 'FreightFlat'). If freight shipping is specified for a shipping profile, this container is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .freightShipping.commodityType	token	Conditional	A string value classifying the freight item to be shipped. Valid values for this field include: MACHINERY_USED MACHINERY_NEW FRAGILE_HOUSEHOLD_USED FRAGILE_HOUSEHOLD_NEW NON_FRAGILE_HOUSEHOLD_USED NON_FRAGILE_HOUSEHOLD_NEW RESTAURANT_EQUIPMENT_USED RESTAURANT_EQUIPMENT_NEW COMPUTER_ELECTRONICS_USED COMPUTER_ELECTRONICS_NEW VENDING_MACHINE_USED VENDING_MACHINE_NEW MOTORCYCLE_USED MOTORCYCLE_NEW This is a required field if freight shipping is included in the shipping profile.
shippingPolicyProfile .shippingPolicyInfo .freightShipping .destPickupInside	boolean	Conditional	Flag indicating if the freight item will be dropped off inside or outside of the delivery location. If this value is 'true', the item will be dropped off inside of the delivery location, and if 'false', the item will be dropped off outside of the delivery location.
shippingPolicyProfile .shippingPolicyInfo .freightShipping .destPickupLocationType	token	Conditional	String value indicating whether the freight item is being delivered to a residence or to a commercial location. Valid values are 'Residential' and 'Commercial'.
shippingPolicyProfile .shippingPolicyInfo .freightShipping .freightShippingClass	double	Conditional	Value indicating the shipping class of the freight item. The shipping class corresponds to the weight of the item (in pounds). Valid values include '50.0', '55.0', '60.0', '65.0', '70.0', '77.5', '85.0', '92.5', '100.0', '110.0', '125.0', '150.0', '175.0', '200.0', '225.0', '250.0', '300.0', '400.0', and '500.0'.
shippingPolicyProfile .shippingPolicyInfo .freightShipping .originPickupInside	boolean	Conditional	Flag indicating if the freight item will be picked up inside or outside of the pickup location. If this value is 'true', the item will be picked up inside of the pickup location, and if 'false', the item will be picked up outside of the pickup location.
shippingPolicyProfile .shippingPolicyInfo .freightShipping .originPickupLocationType	token	Conditional	String value indicating whether the freight item is being picked up from a residence or from a commercial location. Valid values are 'Residential' and 'Commercial'.
shippingPolicyProfile .shippingPolicyInfo .freightShipping .packagingHelpRequired	boolean	Conditional	Flag indicating if help is required to pick up the freight item. If this value is 'true', help picking up the item is required, and if 'false', help picking up the item is not required.
shippingPolicyProfile .shippingPolicyInfo.insurance	Insurance	Conditional	This container consists of the type and cost of domestic and international shipping insurance. The insurance container is required in the shipping profile if the seller offers shipping insurance to domestic and/or international buyers. Only sellers listing on the AU, FR, and IT sites can offer shipping insurance directly to the buyer. If shipping insurance options are specified for a shipping profile, this container is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo.insurance .domesticInsuranceFee	Amount (double)	Conditional	This dollar value indicates the cost to the buyer to purchase domestic shipping insurance for the item. This field is only applicable to AU, FR, or IT sellers. This field is conditionally required if the seller is offering domestic shipping insurance to the buyer, and the domesticInsuranceOption is 'Optional' or 'Required'.
shippingPolicyProfile .shippingPolicyInfo.insurance .domesticInsuranceOption	token	Conditional	This string value indicates the seller's policy on offering domestic shipping insurance to the buyer. Valid values include: IncludedInShippingHandling: the seller is not charging the buyer separately for shipping insurance costs, as the cost of shipping insurance is already included in the base shipping cost for the item NotOffered: the seller does not offer shipping insurance to the buyer Optional: purchasing shipping insurance for the item is at the discretion of the buyer Required: the seller requires that the buyer purchase shipping insurance for the item This field is required if an AU, FR, or IT seller is offering domestic shipping insurance to the buyer.
shippingPolicyProfile .shippingPolicyInfo.insurance .intlInsuranceFee	Amount (double)	Conditional	This dollar value indicates the cost to the buyer to purchase international shipping insurance for the item. This field is only applicable to AU, FR, or IT sellers. This field is conditionally required if the seller is offering international shipping insurance to the buyer, and the internationalInsuranceOption is 'Optional' or 'Required'.
shippingPolicyProfile .shippingPolicyInfo.insurance .intlInsuranceOption	token	Conditional	This string value indicates the seller's policy on offering international shipping insurance to the buyer. Valid values include: IncludedInShippingHandling: the seller is not charging the buyer separately for shipping insurance costs, as the cost of shipping insurance is already included in the base shipping cost for the item NotOffered: the seller does not offer shipping insurance to the buyer Optional: purchasing shipping insurance for the item is at the discretion of the buyer Required: the seller requires that the buyer purchase shipping insurance for the item This field is required if an AU, FR, or IT seller is offering international shipping insurance to the buyer.
shippingPolicyProfile .shippingPolicyInfo .internationalPackagingHandlingCosts	Amount (double)	Optional	This field allows the seller to add package handling costs for shipping an item to an international location. If set for the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .intlRateTable	token	Optional	Note: International shipping rate tables are only available to sellers listing on the Germany and UK eBay sites. This value indicates that the seller's international shipping rate table should be referenced to determine flat-rate shipping costs based on shipping service level and delivery location. Currently, the only valid value for intlRateTable is 'Default', which means that the default international shipping rate table set up by the seller in My eBay is referenced. Including this field in an addSellerProfile or setSellerProfile call will only have an effect on flat shipping rates if an international shipping rate table is set up for the seller's account in My eBay, and it will only affect those international regions and countries for which flat shipping rates are defined. If set for the shipping profile (Germany and UK only), this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Max length: 50.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService	ShippingPolicyInfoService	Conditional, repeatable: [0..*]	Container that consists of detailed information for an international shipping service, including shipping costs and ship-to locations. Up to five international shipping service options can be specified in one shipping profile. Each specified international shipping service is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .buyerResponsibleForPickup	boolean	Conditional	This field is only applicable to vehicle categories on eBay Motors (US and Canada). If this field is included and set to 'true', the buyer is responsible for pickup of the vehicle. If this field is 'false', the seller should specify the vehicle pickup arrangements in the item description. If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag. If set for one or more shipping services within the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Default: true.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .buyerResponsibleForShipping	boolean	Conditional	This field is only applicable to vehicle categories on eBay Motors (US and Canada). If this field is included and set to 'true', the buyer is responsible for the shipment of the vehicle. If this field is 'false', the seller should specify the vehicle shipping arrangements in the item description. If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag. If set for one or more shipping services within the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Default: true.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .codFee	Amount (double)	Conditional	This value indicates the Cash-on-Delivery fee that is due from the buyer upon item delivery. This field is only applicable if the selected payment method is 'COD' and if the selected shipping service option suppports the Cash-on-Delivery option. To see if a domestic shipping service option supports the Cash-on-Delivery option, call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a CODService=true flag for the corresponding shipping service. If a Cash-on-Delivery shipping service is defined for the shipping profile, this field is returned in the shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .shippingService	string	Conditional	A domestic or international shipping service being offered by the seller to ship an item to a buyer. For a list of valid shippingService values, call GeteBayDetails, including ShippingServiceDetails as a DetailName value, and then look through the ShippingServiceDetails containers returned in the response. International shipping services are marked with an InternationalService flag. All shipping services without this flag are domestic shipping services. The ShippingServiceDetails.ValidForSellingFlow flag must be present for both domestic and international shipping services, otherwise, that specific shipping service option is no longer valid and cannot be offered to buyers through a listing. The seller must specify one shipping service in each domesticShippingPolicyInfoService and internationalShippingPolicyInfoService container in an addSellerProfile or setSellerProfile request. Up to four domestic and five international shipping service may be offered to the buyer per listing. If 'Get It Fast' shipping is being enabled for the shipping profile (fastShipping=true), the first specified domestic shipping service (specified in the first domesticShippingPolicyInfoService.shippingService field) must be a one-day shipping service. To verify that a domestic shipping service is a one-day shipping service (hence, it qualifies for 'Get It Fast' shipping), call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a ShippingCategory value of 'ONE_DAY' for the corresponding shipping service. 'Get It Fast' shipping is not available for international shipping. Each shipping service specified for the shipping profile is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See GeteBayDetails.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .shippingServiceAdditionalCost	Amount (double)	Conditional	This value sets the cost of shipping each additional item if the buyer purchases multiple identical items in a multi-quantity, fixed-price listing. This field is required for all multi-quantity, fixed-price listings where flat-rate shipping is used. This value is at the seller's discretion. Generally, it should be the same price or lower than the shippingServiceCost value. The seller may consider specifying a lower price to ship additional items as an incentive to the buyer to purchase multiple items. The seller may also consider a lower price if he/she is able to ship multiple items in the same box. In this scenario, the seller is able to save on shipping costs and passes these savings down to the buyer. The total shipping costs for an order line item is calculated with the following formula: Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost * quantity purchased) So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 * 3)). This field is not applicable to calculated shipping. If set for one or more shipping services within the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .shippingServiceCost	Amount (double)	Conditional	This value sets the cost of shipping for the item if the buyer selects this shipping service option. This field is required in the input for all listings where flat-rate shipping is used, and is not applicable to calculated shipping. This value is at the seller's discretion but should reflect the approximate cost of the shipping service option plus handling. This value defaults to 0.0 if the freeShipping field is set to 'true'. The total shipping costs for an order line item is calculated with the following formula: Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost * quantity purchased) So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 * 3)). This field is always returned (for each shipping service) with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .shippingSurcharge	Amount (double)	Optional	An additional charge that US sellers can add to the cost of an order line item if that order line item is an eBay Motors Parts and Accessories item that is being shipped to a buyer in Alaska, Hawaii, or Puerto Rico through a UPS or FedEx shipping service that charges a surcharge to ship to those areas. In order for sellers to add a shipping surcharge at the shipping service level, the following must be true: a surcharge is applicable for the shipping service (call GeteBayDetails with DetailName set to ShippingServiceDetails, and then look for ShippingServiceDetails.SurchargeApplicable=true in the response; flat-rate shipping is used If set for one or more shipping services within the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .shipToLocation	token	Conditional, repeatable: [0..*]	An international region (such as Asia or Europe) or a country (represented by two- letter country code) to where the seller will ship an item. To obtain valid 'Ship- To locations' for their site, the seller must call GeteBayDetails, using ShipppingLocationDetails as a DetailName value in the request, and then scanning the ShippingLocationDetails.ShippingLocation values that are returned in the response. The shipping regions and countries that may be specified as shipToLocation values will vary according to eBay site. The seller may include as many valid shipToLocation values as necessary based on where they are willing to ship an item. If no shipToLocation field is included in the domesticShippingPolicyInfoService container when using the addSellerProfile or setSellerProfile calls, eBay will automatically add the seller's listing country as a 'Ship-To Location'. If the seller does want to offer international shipping as part of the shipping profile, at least one shipToLocation field in the internationalShippingPolicyInfoService container is required when using the addSellerProfile and setSellerProfile calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a shipToLocation value. If the seller wants to ship to a specific region, but would like to exclude one or more countries in that region, the seller should include that region as a shipToLocation value, but then exclude one or more countries in that region by including one or more instances of the shippingPolicyInfo.excludeShipToLocation field. Each ship-to location specified for the shipping service is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See GeteBayDetails (ShippingLocationDetails).
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .sortOrderId	int	Conditional	This integer value controls the order (relative to other shipping service options) in which the corresponding shipping service option will appear in the View Item and Checkout pages. Sellers can specify up to four domestic shipping services (in four separate domesticShippingPolicyInfoService containers), so valid values are 1, 2, 3, and 4. A shipping service option with a sortOrderId value of '1' appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a sortOrderId value of '4' appears at the bottom of a list of four shipping service options. Sellers can specify up to five international shipping services (in five separate internationalShippingPolicyInfoService containers), so valid values are 1, 2, 3, 4, and 5. Similarly to domesstic shipping service options, the sortOrderId value of a international shipping service option controls the placement of that shipping service option in the View Item and Checkout pages. If the sortOrderId field is not used, the order of domestic and international shipping service options will be determined by the order they are listed in the API call. This field is always returned (for each shipping service) with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Min: 1. Max: 4 (for domestic shipping service) or 5 (for international shipping service).
shippingPolicyProfile .shippingPolicyInfo .intlShippingType	token	Optional	The international shipping cost model used by the seller. Valid values are 'Calculated', 'Flat', or 'FreightFlat'. If 'FreightFlat' is used as the shipping type, the freightShipping container and its values must be in the shipping profile. If 'Calculated' is used as the shipping type, the CalculatedShippingRate container must be used when listing, revising, or relisting an item through the Trading API. The international shipping cost model used by the seller. The only three valid values are 'Calculated', 'Flat', or 'FreightFlat'. If this field is not included and specified in an addSellerProfile or setSellerProfile call, it defaults to 'Flat' shipping. If 'FreightFlat' is specified as the international shipping type, the freightShipping container and its values must be set in the shipping profile. If 'Calculated' is used as the shipping type, the CalculatedShippingRate container must be used when listing, revising, or relisting an item through the Trading API. This field is always returned with all shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Default: Flat. See GeteBayDetails (ShippingServiceDetails.ServiceType).
shippingPolicyProfile .shippingPolicyInfo .packagingHandlingCosts	Amount (double)	Optional	This field allows the seller to add package handling costs for shipping an item to a domestic location. If set for the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .shippingOption	token	Optional	This optional field helps summarize the locations/regions that the seller will ship an item to. The integer value that is used in this field for an addSellerProfile or setSellerProfile call should be in synch with the values that are specified in the shipToLocation and excludeShipToLocation fields used in the same call. The possible values are listed below: 0 ('SiteOnly'): this value indicates that the seller only ships to domestic locations (relative to the listing site). 1 ('SitePlusRegions'): this value indicates that the seller ships to domestic locations plus any international regions or countries specified as ship-to locations through the shipToLocation field. 2 ('WorldWide'): this value indicates that the seller will ship to anywhere in the world except for any international regions or countries excluded with an excludeShipToLocation field. 3 ('WillNotShip'): this value indicates that the seller does not offer shipping. This value is only applicable if 'Local Pickup' is being used, which might be the case if the item is a motor vehicle. 4 ('TermsAndConditionsOnly'): this value is for future use. If set for the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .shippingPolicyCurrency	IsoCurrencyCode	Optional	Three-digit code that indicates the currency used by the listing site. To obtain valid currency codes, the seller can call GeteBayDetails, using CurrencyDetails as a DetailName value in the request, and then scanning the CurrencyDetails.Currency values that are returned in the response. If this field is not included in an addSellerProfile or setSellerProfile call, the currency code will default to the standard currency used by the listing site. This field is always returned with all shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Applicable values: • AUD Australian Dollar; country - Australia; ISO currency code - 036 • CAD Canadian Dollar; country - Canada; ISO currency code - 124 • CHF Swiss Franc; country - Switzerland; ISO currency code - 756 • CNY Chinese Yuan Renminbi; country - China; ISO currency code - 156 • EUR Euro; entity - European Union; ISO currency code - 978 • GBP Pound Sterling; country - United Kingdom; ISO currency code - 826 • HKD Hong Kong Dollar; country - Hong Kong; ISO currency code - 344 • INR Indian Rupee; country - India; ISO currency code - 356 • MYR Malaysian Ringgit; country - Malaysia; ISO currency code - 458 • PHP Philippine Peso; country - Philippines; ISO currency code - 608 • PLN Polish New Zloty; country - Poland; ISO currency code - 985 • SEK Swedish Krona; country - Sweden; ISO currency code - 752 • SGD Singapore Dollar; country - Singapore; ISO currency code - 702 • TWD New Taiwan Dollar; country - Taiwan; ISO currency code - 901 • USD U.S. Dollar; country - United States; ISO currency code - 840
shippingPolicyProfile .shippingPolicyInfo .shippingPolicyName	string	Required	This string value indicates the name of the shipping profile. This profile name must be unique among all of seller's shipping profiles. A shippingPolicyName value is required when using the addSellerProfile and setSellerProfile calls to create or update a shipping profile. This field is always returned with all shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .shippingProfileDiscountInfo	ShippingProfileDiscountInfo	Conditional	Container consisting of flat-rate or calculated shipping discount profile IDs (that identify the shipping discount rules to apply when domestic and/or international buyers purchase multiple items), as well as flags indicating if promotional shipping discounts are offered to domestic and/or international buyers. Shipping discounts can be created by the seller through My eBay, or by using the SetShippingDiscountProfiles call of the Trading API. If shipping discounts are used for a shipping profile, this container is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See: SetShippingDiscountProfiles GetShippingDiscountProfiles
shippingPolicyProfile .shippingPolicyInfo .shippingProfileDiscountInfo .applyDomesticPromoShippingProfile	boolean	Optional	If this field is included and set to 'true', a domestic buyer will be the recipient of the seller's promotional shipping discount (if that buyer satisfies the buying requirements). The seller can create a promotional shipping rule on My eBay, or by using the SetShippingDiscountProfiles call of the Trading API. See: SetShippingDiscountProfiles GetShippingDiscountProfiles
shippingPolicyProfile .shippingPolicyInfo .shippingProfileDiscountInfo .applyIntlPromoShippingProfile	boolean	Optional	If this field is included and set to 'true', an international buyer will be the recipient of the seller's promotional shipping discount (if that buyer satisfies the buying requirements). The seller can create a promotional shipping rule on My eBay, or by using the SetShippingDiscountProfiles call of the Trading API. See: SetShippingDiscountProfiles GetShippingDiscountProfiles
shippingPolicyProfile .shippingPolicyInfo .shippingProfileDiscountInfo .domesticFlatCalcDiscountProfileId	long	Optional	Unique identifier for a flat-rate or calculated shipping rule defined by the seller. If the seller specifies a valid shipping discount profile ID for either of these shipping rules, a domestic buyer may receive a shipping discount from the seller when purchasing multiple items. The seller can create and manage shipping discount profiles on My eBay, or by using the SetShippingDiscountProfiles and GetShippingDiscountProfiles calls of the Trading API. The type of shipping discount profile specified in this field (flat-rate or calculated) should correspond to the domesticShippingType ('Flat' or 'Calculated') value in the shipping profile. Shipping discount profiles are not applicable when Freight shipping is used. See: SetShippingDiscountProfiles GetShippingDiscountProfiles
shippingPolicyProfile .shippingPolicyInfo .shippingProfileDiscountInfo .intlFlatCalcDiscountProfileId	long	Optional	Unique identifier for a flat-rate or calculated shipping rule defined by the seller. If the seller specifies a valid shipping discount profile ID for either of these shipping rules, an international buyer may receive a shipping discount from the seller when purchasing multiple items. The seller can create and manage shipping discount profiles on My eBay, or by using the SetShippingDiscountProfiles and GetShippingDiscountProfiles calls of the Trading API. The type of shipping discount profile specified in this field (flat-rate or calculated) should correspond to the intlShippingType ('Flat' or 'Calculated') value in the shipping profile. Shipping discount profiles are not applicable when Freight shipping is used. See: SetShippingDiscountProfiles GetShippingDiscountProfiles
shippingPolicyProfile .shippingPolicyInfo .shipToLocations	token	Conditional, repeatable: [0..*]	An international region (such as Asia, Europe, or Latin America) or country (represented by two-letter country code) to where the seller will ship an item. It is not necessary to include the shipToLocation field in the domesticShippingPolicyInfoService container when using the addSellerProfile and setSellerProfile calls. However, eBay automatically adds the seller's listing county as a 'Ship-To Location', and the shipToLocation field is always returned for each shipping profile in the addSellerProfile, setSellerProfile, and getSellerProfiles calls. If the seller does want to offer international shipping as part of the shipping profile, at least one shipToLocation field in the internationalShippingPolicyInfoService container is required when using the addSellerProfile and setSellerProfile calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a shipToLocation value. If the seller wants to offer shipping to one or more specific shipping regions, the seller must include that shipping region in a shipToLocation field. If the seller wants to ship to a specific region, but would like to exclude one or more countries in that region, the seller should use one or more instances of the shippingPolicyInfo.excludeShipToLocation field. Applicable shipping region values are defined in ShippingRegionCodeType and applicable country codes are defined in CountryCodeType. However, it is best practice for sellers to call GeteBayDetails, using ShipppingLocationDetails as a DetailName value in the request, and then scanning the ShippingLocationDetails.ShippingLocation values that are returned in the response. Each specified ship-to location is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See: GeteBayDetails ShippingRegionCodeType CountryCodeType
shippingPolicyProfile.siteId	int	Optional	Unique identifier of the eBay site. This value is always returned in the getSellerProfiles call. It is optional in the addSellerProfile and setSellerProfile calls. If it is not used in an addSellerProfile or setSellerProfile call, the siteId value defaults to the seller's eBay registration site. When creating a Business Policies profile for motor vehicle listings on the US eBay Motors site (Site ID=100), the siteId field should be included and set to '0' (US site). By performing this action, the Business Policies Management Service automatically applies the Business Policies profile from the eBay US site (Site ID=0) to the US eBay Motors site (Site ID=100).

Standard Input Fields

extension

ExtensionType

Optional,
repeatable: [0..*]

Reserved for future use.

setSellerProfile Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<setSellerProfileResponse xmlns="http://www.ebay.com/marketplace/selling">
  <!-- Call-specific Output Fields -->
  <paymentProfile> PaymentProfile (SellerProfile)
    <categoryGroups> CategoryGroups
      <categoryGroup> CategoryGroup
        <default> boolean </default>
        <name> string </name>
      </categoryGroup>
      <!-- ... more categoryGroup nodes allowed here ... -->
    </categoryGroups>
    <paymentInfo> PaymentInfo
      <acceptedPaymentMethod> token </acceptedPaymentMethod>
      <!-- ... more acceptedPaymentMethod values allowed here ... -->
      <depositDetails> DepositDetails
        <daysToFullPayment> int </daysToFullPayment>
        <depositAmount> Amount (double) </depositAmount>
        <hoursToDeposit> int </hoursToDeposit>
      </depositDetails>
      <immediatePay> boolean </immediatePay>
      <paymentInstructions> string </paymentInstructions>
      <paypalEmailAddress> token </paypalEmailAddress>
    </paymentInfo>
    <profileDesc> string </profileDesc>
    <profileId> long </profileId>
    <profileName> string </profileName>
    <profileType> ProfileType </profileType>
    <siteId> int </siteId>
  </paymentProfile>
  <returnPolicyProfile> ReturnPolicyProfile (SellerProfile)
    <categoryGroups> CategoryGroups
      <categoryGroup> CategoryGroup
        <default> boolean </default>
        <name> string </name>
      </categoryGroup>
      <!-- ... more categoryGroup nodes allowed here ... -->
    </categoryGroups>
    <profileDesc> string </profileDesc>
    <profileId> long </profileId>
    <profileName> string </profileName>
    <profileType> ProfileType </profileType>
    <returnPolicyInfo> ReturnPolicyInfo
      <description> string </description>
      <refundOption> token </refundOption>
      <restockingFeeValue> token </restockingFeeValue>
      <returnsAcceptedOption> token </returnsAcceptedOption>
      <returnsWithinOption> token </returnsWithinOption>
      <shippingCostPaidByOption> token </shippingCostPaidByOption>
      <warrantyDurationOption> token </warrantyDurationOption>
      <warrantyOfferedOption> token </warrantyOfferedOption>
      <warrantyTypeOption> token </warrantyTypeOption>
    </returnPolicyInfo>
    <siteId> int </siteId>
  </returnPolicyProfile>
  <shippingPolicyProfile> ShippingPolicyProfile (SellerProfile)
    <categoryGroups> CategoryGroups
      <categoryGroup> CategoryGroup
        <default> boolean </default>
        <name> string </name>
      </categoryGroup>
      <!-- ... more categoryGroup nodes allowed here ... -->
    </categoryGroups>
    <profileDesc> string </profileDesc>
    <profileId> long </profileId>
    <profileName> string </profileName>
    <profileType> ProfileType </profileType>
    <shippingPolicyInfo> ShippingPolicyInfo
      <dispatchTimeMax> int </dispatchTimeMax>
      <dispatchTimeReason> string </dispatchTimeReason>
      <domesticRateTable> token </domesticRateTable>
      <domesticShippingPolicyInfoService> ShippingPolicyInfoService
        <buyerResponsibleForPickup> boolean </buyerResponsibleForPickup>
        <buyerResponsibleForShipping> boolean </buyerResponsibleForShipping>
        <codFee> Amount (double) </codFee>
        <fastShipping> boolean </fastShipping>
        <freeShipping> boolean </freeShipping>
        <shippingService> string </shippingService>
        <shippingServiceAdditionalCost> Amount (double) </shippingServiceAdditionalCost>
        <shippingServiceCost> Amount (double) </shippingServiceCost>
        <shippingSurcharge> Amount (double) </shippingSurcharge>
        <shipToLocation> token </shipToLocation>
        <!-- ... more shipToLocation values allowed here ... -->
        <sortOrderId> int </sortOrderId>
      </domesticShippingPolicyInfoService>
      <!-- ... more domesticShippingPolicyInfoService nodes allowed here ... -->
      <domesticShippingType> token </domesticShippingType>
      <excludeShipToLocation> token </excludeShipToLocation>
      <!-- ... more excludeShipToLocation values allowed here ... -->
      <freightShipping> FreightShipping
        <commodityType> token </commodityType>
        <destPickupInside> boolean </destPickupInside>
        <destPickupLocationType> token </destPickupLocationType>
        <freightShippingClass> double </freightShippingClass>
        <originPickupInside> boolean </originPickupInside>
        <originPickupLocationType> token </originPickupLocationType>
        <packagingHelpRequired> boolean </packagingHelpRequired>
      </freightShipping>
      <insurance> Insurance
        <domesticInsuranceFee> Amount (double) </domesticInsuranceFee>
        <domesticInsuranceOption> token </domesticInsuranceOption>
        <intlInsuranceFee> Amount (double) </intlInsuranceFee>
        <intlInsuranceOption> token </intlInsuranceOption>
      </insurance>
      <internationalPackagingHandlingCosts> Amount (double) </internationalPackagingHandlingCosts>
      <intlRateTable> token </intlRateTable>
      <intlShippingPolicyInfoService> ShippingPolicyInfoService
        <buyerResponsibleForPickup> boolean </buyerResponsibleForPickup>
        <buyerResponsibleForShipping> boolean </buyerResponsibleForShipping>
        <codFee> Amount (double) </codFee>
        <shippingService> string </shippingService>
        <shippingServiceAdditionalCost> Amount (double) </shippingServiceAdditionalCost>
        <shippingServiceCost> Amount (double) </shippingServiceCost>
        <shippingSurcharge> Amount (double) </shippingSurcharge>
        <shipToLocation> token </shipToLocation>
        <!-- ... more shipToLocation values allowed here ... -->
        <sortOrderId> int </sortOrderId>
      </intlShippingPolicyInfoService>
      <!-- ... more intlShippingPolicyInfoService nodes allowed here ... -->
      <intlShippingType> token </intlShippingType>
      <packagingHandlingCosts> Amount (double) </packagingHandlingCosts>
      <shippingOption> token </shippingOption>
      <shippingPolicyCurrency> IsoCurrencyCode </shippingPolicyCurrency>
      <shippingPolicyName> string </shippingPolicyName>
      <shippingProfileDiscountInfo> ShippingProfileDiscountInfo
        <applyDomesticPromoShippingProfile> boolean </applyDomesticPromoShippingProfile>
        <applyIntlPromoShippingProfile> boolean </applyIntlPromoShippingProfile>
        <domesticFlatCalcDiscountProfileId> long </domesticFlatCalcDiscountProfileId>
        <intlFlatCalcDiscountProfileId> long </intlFlatCalcDiscountProfileId>
      </shippingProfileDiscountInfo>
      <shipToLocations> token </shipToLocations>
      <!-- ... more shipToLocations values allowed here ... -->
    </shippingPolicyInfo>
    <siteId> int </siteId>
  </shippingPolicyProfile>
  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage
    <error> ErrorData
      <category> ErrorCategory </category>
      <domain> string </domain>
      <errorId> long </errorId>
      <exceptionId> token </exceptionId>
      <message> string </message>
      <parameter name="string"> ErrorParameter (string) </parameter>
      <!-- ... more parameter values allowed here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes allowed here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
</setSellerProfileResponse>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

paymentProfile	PaymentProfile (SellerProfile)	Conditionally	Root container for a seller's payment profile. The paymentProfile container consists of payment information, the name and description of the profile, and the site and category group to which the payment profile will be applied. The paymentProfile container is only returned if the seller modified a payment profile in the setSellerProfile request.
paymentProfile.categoryGroups	CategoryGroups	Always	This container consists of one or more categoryGroup containers. One or more category groups are linked to each Business Policies profile.
paymentProfile.categoryGroups .categoryGroup	CategoryGroup	Always, repeatable: [1..*]	This container indicates the category group to which the payment, return policy, or shipping profile applies to. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive. Each Business Policies profile can be associated with more than one category group.
paymentProfile.categoryGroups .categoryGroup.default	boolean	Always	This flag indicates if the corresponding Business Policies profile defined for the assigned category group is used by default for listings in a category group that does not have a Business Policies profile assigned to it. For example, if a seller has only created a Business Policies profile for motor vehicles (categoryGroup=MOTORS_VEHICLE), and this category group is set as the default, all applicable settings/values in this Business Policies profile will also apply to non-motor vehicle categories. If this field is not included in the call request, by default, the first (or only) category group specified in the request will get assigned as the default category group. Only one category group can be the default, so categoryGroup.default cannot be 'true' for more than one category group.
paymentProfile.categoryGroups .categoryGroup.name	string	Always	This string value indicates the name of the category group to which the corresponding Business Policies profile applies. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive.
paymentProfile.paymentInfo	PaymentInfo	Conditionally	This container consists of detailed payment information for a seller's payment profile. This container is conditionally required if the caller is creating a new or modifying an existing payment profile. This container is returned by getSellerProfiles if one or more payment profiles match the input criteria in the call request, and is returned in the response of addSellerProfile or setSellerProfile if a payment profile is being created or modified, respectively.
paymentProfile.paymentInfo .acceptedPaymentMethod	token	Conditionally, repeatable: [0..*]	Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. At least one payment method is required to be specified in each payment profile. If you specify multiple acceptablePaymentMethod fields, the repeating fields must be contiguous. Note: Required or allowed payment methods vary by site and category. To retrieve a list of valid payment methods for your site and category, call GetCategoryFeatures, specifying 'PaymentMethods' as a FeatureID value in the call request, and then look for the Category.PaymentMethod values in the call response. For motor vehicle payment profiles (CategoryGroup.name=MOTORS_VEHICLE), 'PayPal' must be one of acceptedPaymentMethod values if a deposit is required (the paymentInfo.depositDetails container exist for the payment profile), and in order for a buyer to make a full payment on an US or CA motor vehicle, at least one of the following acceptedPaymentMethod values must be specified: CashOnPickup LoanCheck MOCC (money order or cashier's check) PaymentSeeDescription (payment instructions are in the paymentInstructions field) PersonalCheck
paymentProfile.paymentInfo .depositDetails	DepositDetails	Conditionally	This container is used by the seller to specify amounts and due dates for deposits and full payment on motor vehicle listings on eBay Motors (US and CA). This container is only applicable if the categoryGroup.name field is set to 'MOTORS_VEHICLE'.
paymentProfile.paymentInfo .depositDetails .daysToFullPayment	int	Conditionally	This integer value indicates the number of days that a buyer has (after he/she commits to buy) to make full payment to the seller and close the remaining balance on a motor vehicle. Valid values are '3', '7' (default), '10', and '14'. In order for a buyer to make a full payment on an US or CA motor vehicle, at least one of the following acceptedPaymentMethod values must be specified for the corresponding payment profile: CashOnPickup LoanCheck MOCC (money order or cashier's check) PaymentSeeDescription (payment instructions are in the item's description) PersonalCheck Min: 3. Max: 14. Default: 7.
paymentProfile.paymentInfo .depositDetails.depositAmount	Amount (double)	Conditionally	This dollar value indicates the amount of the deposit that a buyer must make on a purchased motor vehicle (eBay Motors US and CA). The deposit amount can be as high as $2,000.00. If not specified, this value defaults to 0.0. If this value is specified, the seller must also specify an hoursToDeposit value. Deposits on motor vehicles can only be paid using PayPal, so if depositAmount is specified, then one of the acceptedPaymentMethod values must be 'PayPal' (in addition to the payment methods offered for the full payment). Unlike other listings, PayPal is not automatically added to a Motors listing even if the seller has a PayPal preference set in My eBay. The seller also needs to have a linked PayPal account in order to require a deposit from the buyer. The deposit amount appears in the shipping, payment details and return policy sections of the View Item page. Min: 0.0. Max: 2000.0.
paymentProfile.paymentInfo .depositDetails.hoursToDeposit	int	Conditionally	This integer value indicates the number of hours that a buyer has (after he/she commits to buy) to make a deposit to the seller as a down payment on a motor vehicle. Valid values are '24', '48' (default), and '72'. The deposit amount is specified in the depositAmount field. If not specified, the depositAmount value defaults to 0.0, in which case, a deposit on the vehicle is not required. In order for a buyer to make a full payment on an US or CA motor vehicle, one of the acceptedPaymentMethod values must be 'PayPal' (in addition to the payment methods offered for the full payment). Min: 24. Max: 72. Default: 48.
paymentProfile.paymentInfo .immediatePay	boolean	Conditionally	To create an immediate payment policy that can be applied to a listing, immediatePay must be included and set to 'true' for the payment profile. If the seller does not want to apply an immediate payment policy for an item, this field is either omitted, or included and set to 'false'. The seller can change this payment policy at any time during the lifecyle of a listing. In the Trading API calls that return the AutoPay field (immediatePay equivalent), be aware that the field's appearance in the output does not necessarily indicate that the listing qualifies for immediate payment, but only that the seller attempted to create (by including and setting immediatePay to 'true' in the payment profile) an immediate payment option. In order for a seller to apply an immediate payment requirement for an item, the following must be true: seller must have a Premier or Business PayPal account; the Buy It Now price (if applicable) cannot be higher than $10,000 USD; the listing site supports PayPal payments; the category supports PayPal payments; the listing type is fixed-price or auction (with Buy It Now option). To successfully enable the immediate payment requirement, the seller must also perform the following actions through the API call: seller must provide a valid paymentProfile.paymentInfo.paypalEmailAddress value; seller must offer PayPal as the only payment method; seller must specify all related costs to the buyer, since the buyer will not be able to use the Buyer Request Total feature in an immediate payment listing; these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges; seller must include and set the shippingProfileDiscountInfo container values if promotional shipping discounts will be used; Default: false.
paymentProfile.paymentInfo .paymentInstructions	string	Conditionally	This free-form string field allows the seller to give payment instructions to the buyer. These instructions will appear on eBay's View Item and Checkout page. This field allows 1000 characters. It is recommended that the seller use this field for motor vehicles (eBay Motors US and CA) payment profiles to clarify the specifics on the deposit (if required), pickup/delivery arrangements, and full payment details on the vehicle. Max length: 1000.
paymentProfile.paymentInfo .paypalEmailAddress	token	Conditionally	The valid email address linked to the seller's PayPal account. This field is required in the payment profile if 'PayPal' is one of the acceptedPaymentMethod values in the payment profile. eBay uses this email address to identify the correct PayPal account when the buyer pays via PayPal during the checkout process. For digital listings, sellers must use an email address that is associated with a PayPal Premier or Business account.
paymentProfile.profileDesc	string	Conditionally	This field is used by the seller to provide a description of the Business Policies profile. The profileDesc field is optional in the addSellerProfile and setSellerProfile calls. This field is only returned for a profile if a description exists for that profile. Max length: 250.
paymentProfile.profileId	long	Always	The unique identifier of the Business Policies profile. This value is created by eBay when a Business Policies profile is created (on site or through API). A profileId value is required when using the setSellerProfile and removeSellerProfile calls. It can be used as a filter in a getSellerProfiles to identify a specific Business Policies profile to retrieve. This field is always returned with all Business Policies Management calls. A profileId value returned in the response of an addSellerProfile call indicates that the Business Policies profile was created successfully.
paymentProfile.profileName	string	Always	This string value indicates the name of the Business Policies profile. This profile name must be unique among all of seller's Business Policies profiles. A profileName value is required when using the addSellerProfile and setSellerProfile calls.
paymentProfile.profileType	ProfileType	Always	This field indicates the type of Business Policies profile. A profileType value is required when using the addSellerProfile and setSellerProfile calls. It can be used as a filter in a getSellerProfiles call to identify and retrieve Business Policies profiles of a specific type. Applicable values: • PAYMENT This value indicates the Business Policies profile is a payment profile. • RETURN_POLICY This value indicates the Business policies profile is a return policy profile. • SHIPPING This value indicates the Business Policies profile is a shipping profile.
paymentProfile.siteId	int	Always	Unique identifier of the eBay site. This value is always returned in the getSellerProfiles call. It is optional in the addSellerProfile and setSellerProfile calls. If it is not used in an addSellerProfile or setSellerProfile call, the siteId value defaults to the seller's eBay registration site. When creating a Business Policies profile for motor vehicle listings on the US eBay Motors site (Site ID=100), the siteId field should be included and set to '0' (US site). By performing this action, the Business Policies Management Service automatically applies the Business Policies profile from the eBay US site (Site ID=0) to the US eBay Motors site (Site ID=100).
returnPolicyProfile	ReturnPolicyProfile (SellerProfile)	Conditionally	Root container for a seller's return policy profile. The returnPolicyProfile container consists of return policy information, the name and description of the profile, and the site and category group to which the return policy profile will be applied. The returnPolicyProfile container is only returned if the seller modified a return policy profile in the setSellerProfile request.
returnPolicyProfile .categoryGroups	CategoryGroups	Always	This container consists of one or more categoryGroup containers. One or more category groups are linked to each Business Policies profile.
returnPolicyProfile .categoryGroups.categoryGroup	CategoryGroup	Always, repeatable: [1..*]	This container indicates the category group to which the payment, return policy, or shipping profile applies to. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive. Each Business Policies profile can be associated with more than one category group.
returnPolicyProfile .categoryGroups.categoryGroup .default	boolean	Always	This flag indicates if the corresponding Business Policies profile defined for the assigned category group is used by default for listings in a category group that does not have a Business Policies profile assigned to it. For example, if a seller has only created a Business Policies profile for motor vehicles (categoryGroup=MOTORS_VEHICLE), and this category group is set as the default, all applicable settings/values in this Business Policies profile will also apply to non-motor vehicle categories. If this field is not included in the call request, by default, the first (or only) category group specified in the request will get assigned as the default category group. Only one category group can be the default, so categoryGroup.default cannot be 'true' for more than one category group.
returnPolicyProfile .categoryGroups.categoryGroup .name	string	Always	This string value indicates the name of the category group to which the corresponding Business Policies profile applies. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive.
returnPolicyProfile .profileDesc	string	Conditionally	This field is used by the seller to provide a description of the Business Policies profile. The profileDesc field is optional in the addSellerProfile and setSellerProfile calls. This field is only returned for a profile if a description exists for that profile. Max length: 250.
returnPolicyProfile.profileId	long	Always	The unique identifier of the Business Policies profile. This value is created by eBay when a Business Policies profile is created (on site or through API). A profileId value is required when using the setSellerProfile and removeSellerProfile calls. It can be used as a filter in a getSellerProfiles to identify a specific Business Policies profile to retrieve. This field is always returned with all Business Policies Management calls. A profileId value returned in the response of an addSellerProfile call indicates that the Business Policies profile was created successfully.
returnPolicyProfile .profileName	string	Always	This string value indicates the name of the Business Policies profile. This profile name must be unique among all of seller's Business Policies profiles. A profileName value is required when using the addSellerProfile and setSellerProfile calls.
returnPolicyProfile .profileType	ProfileType	Always	This field indicates the type of Business Policies profile. A profileType value is required when using the addSellerProfile and setSellerProfile calls. It can be used as a filter in a getSellerProfiles call to identify and retrieve Business Policies profiles of a specific type. Applicable values: • PAYMENT This value indicates the Business Policies profile is a payment profile. • RETURN_POLICY This value indicates the Business policies profile is a return policy profile. • SHIPPING This value indicates the Business Policies profile is a shipping profile.
returnPolicyProfile .returnPolicyInfo	ReturnPolicyInfo	Conditionally	This container consists of detailed information on a seller's return policy. This container is conditionally required if the caller is creating a new or modifying an existing return policy profile. This container is returned by getSellerProfiles if one or more return policy profiles match the input criteria in the call request.
returnPolicyProfile .returnPolicyInfo.description	string	Conditionally	This free-form string field allows the seller to provide a detailed explanation of the return policy. The maximum length of this optional field is 5000. eBay uses this text string as-is in the Return Policy section of the View Item page. Avoid HTML, and avoid character entity references. If you include special characters in the return policy description, use the literal UTF-8 or ISO-8559-1 character. Max length: 5000.
returnPolicyProfile .returnPolicyInfo.refundOption	token	Conditionally	This value indicates how the seller will compensate the buyer for a returned item. Use the returnPolicyInfo.Description field to explain the policy details (such as how quickly the seller will process the refund, whether the seller must receive the item before processing the refund, and other useful details). Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and look at the ReturnPolicyDetails.Refund.RefundOption values in the response to determine which refund options are supported for your site. For Add/Revise/Relist family of Trading API calls, if the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted), the RefundOption value will be set with a default value (such as 'MoneyBack') on some eBay sites, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set his/her desired value here. As of version 771, the only allowed values for RefundOption on the US site are 'MoneyBack' and 'MoneyBackOrExchange'. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value.
returnPolicyProfile .returnPolicyInfo .restockingFeeValue	token	Conditionally	Sellers who accept returns should include this field if they charge buyers a restocking fee when items are returned. A restocking fee only comes into play when an item is returned, as this fee will reduce the total amount that the buyer is refunded for the returned item. Possible values are: NoRestockingFee: no restocking fee is charged to the buyer Percent_10: 10 percent of the item price is charged to the buyer as a restocking fee Percent_15: 15 percent of the item price is charged to the buyer as a restocking fee Percent_20: 20 percent of the item price is charged to the buyer as a restocking fee This field is returned in getSellerProfiles if seller has set this value for the corresponding return policy profile.
returnPolicyProfile .returnPolicyInfo .returnsAcceptedOption	token	Conditionally	Indicates whether the seller allows the buyer to return the item. This is a required field for a return policy profile. All sites allow the seller to choose between accepting (specify 'ReturnsAccepted') or not accepting (specify 'ReturnsNotAccepted') returns. An exception to this rule is on some eBay European sites (UK, Ireland, DE), where some categories require business sellers to accept returns for fixed-price items and auction items purchased with the Buy It Now option. The GetUser Trading API call can be used by DE/IE/UK sellers to determine a user's current business seller status (look at User.SellerInfo.SellerBusinessType). Note that Top-Rated sellers must accept item returns for a listing in order for that listing to receive a Top Rated Plus badge on the View Item page or search results page. See: (GeteBayDetails) ReturnsAcceptedOption for sites that support this field, and applicable values Returns and the Law (UK)
returnPolicyProfile .returnPolicyInfo .returnsWithinOption	token	Conditionally	If the return policy specifies that the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted), then the returnsWithinOption field is required. This field's value determines the number of business days that the buyer has to return the item (after receiving the item). It is good practice to call this value out in the returnPolicy.description field. As of version 771, 3-day, 7-day, and 10-day return policies have been deprecated on the US site, and listings will be blocked if 'Days_3', 'Days_7', or 'Days_10' are used. The three allowed values are 'Days_14', 'Days_30', and 'Days_60'. Some eBay sites may set a default value (such as 'Days_14') if the seller accepts returns but the returnsWithinOption field is omitted. If the listing has bids or sales and/or ends within 12 hours, you can't change this value.
returnPolicyProfile .returnPolicyInfo .shippingCostPaidByOption	token	Conditionally	This value is used by the seller to indicate whether the buyer or the seller is responsible for paying return shipping charges. Possible values are 'Buyer' or 'Seller'. This value is required if ReturnsAcceptedOption=ReturnsAccepted. Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and look at the ReturnPolicyDetails.ShippingCostPaidBy values in the response to determine which enumeration values are supported for your site. It is good practice for the seller to indicate the party responsible for return shipping in the returnPolicy.description field. This field is returned in getSellerProfiles if set for a matching return policy profile. If a seller is revising a listing that has bids or sales and/or ends within 12 hours, you can't change this value.
returnPolicyProfile .returnPolicyInfo .warrantyDurationOption	token	Conditionally	This value indicates the warranty period for a product. This value is applicable if the seller accepts returns and a warranty is offered (returnPolicyInfo.warrantyOfferedOption=WarrantyOffered). Valid values are 'Months_1', 'Months_3', 'Months_6', 'Years_1', 'Years_2', 'Years_3', and 'Years_MoreThan3'. Currently, only the eBay India site supports warranties on eBay items. Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and look at the ReturnPolicyDetails.WarrantyDuration values in the response to determine which enumeration values are supported. If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See WarrantyDurationOptionsCodeType.
returnPolicyProfile .returnPolicyInfo .warrantyOfferedOption	token	Conditionally	This value indicates whether a seller offers a warranty. Valid values are 'None' and 'WarrantyOffered'. Currently, only the eBay India site supports warranties on eBay items.
returnPolicyProfile .returnPolicyInfo .warrantyTypeOption	token	Conditionally	This value indicates the type of warranty that is offered with the product. This value is applicable if the seller accepts returns and a warranty is offered (returnPolicyInfo.warrantyOfferedOption=WarrantyOffered). Valid values are 'DealerWarranty', 'ManufacturerWarranty', and 'ReplacementWarranty'. Currently, only the eBay India site supports warranties on eBay items. Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and look at the ReturnPolicyDetails.WarrantyType values in the response to determine which enumeration values are supported. If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See WarrantyTypeOptionsCodeType.
returnPolicyProfile.siteId	int	Always	Unique identifier of the eBay site. This value is always returned in the getSellerProfiles call. It is optional in the addSellerProfile and setSellerProfile calls. If it is not used in an addSellerProfile or setSellerProfile call, the siteId value defaults to the seller's eBay registration site. When creating a Business Policies profile for motor vehicle listings on the US eBay Motors site (Site ID=100), the siteId field should be included and set to '0' (US site). By performing this action, the Business Policies Management Service automatically applies the Business Policies profile from the eBay US site (Site ID=0) to the US eBay Motors site (Site ID=100).
shippingPolicyProfile	ShippingPolicyProfile (SellerProfile)	Conditionally	Root container for a seller's shipping profile. The shippingPolicyProfile container consists of shipping information, the name and description of the profile, and the site and category group to which the shipping profile will be applied. The shippingPolicyProfile container is only returned if the seller modified a shipping profile in the setSellerProfile request.
shippingPolicyProfile .categoryGroups	CategoryGroups	Always	This container consists of one or more categoryGroup containers. One or more category groups are linked to each Business Policies profile.
shippingPolicyProfile .categoryGroups.categoryGroup	CategoryGroup	Always, repeatable: [1..*]	This container indicates the category group to which the payment, return policy, or shipping profile applies to. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive. Each Business Policies profile can be associated with more than one category group.
shippingPolicyProfile .categoryGroups.categoryGroup .default	boolean	Always	This flag indicates if the corresponding Business Policies profile defined for the assigned category group is used by default for listings in a category group that does not have a Business Policies profile assigned to it. For example, if a seller has only created a Business Policies profile for motor vehicles (categoryGroup=MOTORS_VEHICLE), and this category group is set as the default, all applicable settings/values in this Business Policies profile will also apply to non-motor vehicle categories. If this field is not included in the call request, by default, the first (or only) category group specified in the request will get assigned as the default category group. Only one category group can be the default, so categoryGroup.default cannot be 'true' for more than one category group.
shippingPolicyProfile .categoryGroups.categoryGroup .name	string	Always	This string value indicates the name of the category group to which the corresponding Business Policies profile applies. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive.
shippingPolicyProfile .profileDesc	string	Conditionally	This field is used by the seller to provide a description of the Business Policies profile. The profileDesc field is optional in the addSellerProfile and setSellerProfile calls. This field is only returned for a profile if a description exists for that profile. Max length: 250.
shippingPolicyProfile .profileId	long	Always	The unique identifier of the Business Policies profile. This value is created by eBay when a Business Policies profile is created (on site or through API). A profileId value is required when using the setSellerProfile and removeSellerProfile calls. It can be used as a filter in a getSellerProfiles to identify a specific Business Policies profile to retrieve. This field is always returned with all Business Policies Management calls. A profileId value returned in the response of an addSellerProfile call indicates that the Business Policies profile was created successfully.
shippingPolicyProfile .profileName	string	Always	This string value indicates the name of the Business Policies profile. This profile name must be unique among all of seller's Business Policies profiles. A profileName value is required when using the addSellerProfile and setSellerProfile calls.
shippingPolicyProfile .profileType	ProfileType	Always	This field indicates the type of Business Policies profile. A profileType value is required when using the addSellerProfile and setSellerProfile calls. It can be used as a filter in a getSellerProfiles call to identify and retrieve Business Policies profiles of a specific type. Applicable values: • PAYMENT This value indicates the Business Policies profile is a payment profile. • RETURN_POLICY This value indicates the Business policies profile is a return policy profile. • SHIPPING This value indicates the Business Policies profile is a shipping profile.
shippingPolicyProfile .shippingPolicyInfo	ShippingPolicyInfo	Conditionally	This container consists of detailed shipping information for a seller's shipping profile. This container is conditionally required if the caller is creating a new or modifying an existing shipping profile. This container is returned by getSellerProfiles if one or more shipping profiles match the input criteria in the call request.
shippingPolicyProfile .shippingPolicyInfo .dispatchTimeMax	int	Always	Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment for an order. This time does not include the shipping time (the carrier's transit time). Valid values can vary by site and by category. To obtain supported values for a site, call GeteBayDetails, using DispatchTimeMaxDetails as a DetailName value in the request, and then look at the DispatchTimeMaxDetails container in the response for supported values for the site. Note that Top-Rated sellers must offer one-day handling (or zero-day handling once it becomes available in late May 2013) for a listing in order for that listing to receive a Top Rated Plus seal on the View Item page or search results. To offer one-day handling, the seller should include the dispatchTimeMax field in the shipping profile and set the value of this field to '1'. The dispatchTimeMax field must be included in the shipping profile and set to '1' (or '0' once zero-day handling becomes available in late May 2013) if the fastShipping flag is included and set to 'true' in the shipping profile. Note: Traditionally in the Trading API, sellers using an Add/Revise/Relist API call were allowed to pass in a DispatchTimeMax value of '0' to indicate that no handling time is specified for the listing. However, starting in late May, a DispatchTimeMax value of '0' will indicate that the seller is offering same-day shipping. Once same-day shipping is live, sellers that do not want to specify a handling time for their Business Policies shipping profile, should omit the < b>dispatchTimeMax field, or they can include it but set it to null. This field is always returned with all shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Min: 1. Max: 30.
shippingPolicyProfile .shippingPolicyInfo .dispatchTimeReason	string	Conditionally	This free-form string field is used by the seller to provide more details to the buyer about handling time. If set for the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticRateTable	token	Conditionally	This value indicates that the seller's domestic shipping rate table should be referenced to determine flat-rate shipping costs based on shipping service level and delivery location. Currently, the only valid value for domesticRateTable is 'Default', which means that the default domestic shipping rate table set up by the seller in My eBay is referenced. Including this field in an addSellerProfile or setSellerProfile call will only have an effect on flat shipping rates if a domestic shipping rate table is set up for the seller's account in My eBay, and it will only affect those domestic regions for which flat shipping rates are defined. If set for the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Max length: 50.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService	ShippingPolicyInfoService	Conditionally, repeatable: [0..*]	Container that consists of detailed information for a domestic shipping service, including shipping costs, ship-to locations, and flags to indicate Fast and/or Free shipping. Up to four domestic shipping service options can be specified in one shipping profile. Each specified domestic shipping service is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .buyerResponsibleForPickup	boolean	Conditionally	This field is only applicable to vehicle categories on eBay Motors (US and Canada). If this field is included and set to 'true', the buyer is responsible for pickup of the vehicle. If this field is 'false', the seller should specify the vehicle pickup arrangements in the item description. If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag. If set for one or more shipping services within the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .buyerResponsibleForShipping	boolean	Conditionally	This field is only applicable to vehicle categories on eBay Motors (US and Canada). If this field is included and set to 'true', the buyer is responsible for the shipment of the vehicle. If this field is 'false', the seller should specify the vehicle shipping arrangements in the item description. If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag. If set for one or more shipping services within the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .codFee	Amount (double)	Conditionally	This value indicates the Cash-on-Delivery fee that is due from the buyer upon item delivery. This field is only applicable if the selected payment method is 'COD' and if the selected shipping service option suppports the Cash-on-Delivery option. To see if a domestic shipping service option supports the Cash-on-Delivery option, call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a CODService=true flag for the corresponding shipping service. If a Cash-on-Delivery shipping service is defined for the shipping profile, this field is returned in the shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .fastShipping	boolean	Conditionally	This flag indicates whether the seller has opted into the 'Get It Fast' shipping program for the listing. 'Get It Fast' shipping is only available for fixed-price listings and auction listings with an active 'Buy It Now' option. To enable 'Get It Fast' shippping for a listing, the seller must: offer at least one domestic one-day shipping service option, such as USPS Express Mail, UPS Next Day Air, or FedEx Overnight; set the shippingPolicyInfo.dispatchTimeMax value to '1', which means that the seller is committing to ship the item within one business day after receiving payment from the buyer. Starting in May 2013, a DispatchTimeMax value of '0' will indicate that the seller is offering same-day shipping. As soon as same-day shipping becomes available to them, sellers can set the shippingPolicyInfo.dispatchTimeMax value to '0' or '1' to enable 'Get It Fast' shipping. Although it is not required, it is recommended that sellers also offer an immediate payment option to the buyer, so they can get their item even faster. In the payment profile, this option is turned on with the paymentInfo.immediatePay flag. To enable the immediate payment feature on a listing, the seller must: have a Premier or Business PayPal account; provide a valid Item.PayPalEmailAddress value; offer 'PayPal' as the single payment method in the Item.PaymentMethods field. The fastShipping field should only be included and set to 'true' in domesticShippingPolicyInfoService containers where the shipping service option is a one-day shipping service. The fastShipping field is not applicable for internationalShippingPolicyInfoService containers. Not supported for UK Store Inventory format or Half.com items. If 'Get It Fast' shipping is set for a domestic shipping service, this field is returned in the shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .freeShipping	boolean	Conditionally	This flag is used by the seller to offer free domestic shipping to the buyer. This field can only be included and set to 'true' for the first specified domestic shipping service option (it is ignored if set for any other shipping service option). The first specified shipping service option either has a sortOrderId value of '1', or, if the sortOrderId field is not used, the shipping service option specified first in the API call. If free shipping is set for a domestic shipping service, this field is returned in the shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .shippingService	string	Conditionally	A domestic or international shipping service being offered by the seller to ship an item to a buyer. For a list of valid shippingService values, call GeteBayDetails, including ShippingServiceDetails as a DetailName value, and then look through the ShippingServiceDetails containers returned in the response. International shipping services are marked with an InternationalService flag. All shipping services without this flag are domestic shipping services. The ShippingServiceDetails.ValidForSellingFlow flag must be present for both domestic and international shipping services, otherwise, that specific shipping service option is no longer valid and cannot be offered to buyers through a listing. The seller must specify one shipping service in each domesticShippingPolicyInfoService and internationalShippingPolicyInfoService container in an addSellerProfile or setSellerProfile request. Up to four domestic and five international shipping service may be offered to the buyer per listing. If 'Get It Fast' shipping is being enabled for the shipping profile (fastShipping=true), the first specified domestic shipping service (specified in the first domesticShippingPolicyInfoService.shippingService field) must be a one-day shipping service. To verify that a domestic shipping service is a one-day shipping service (hence, it qualifies for 'Get It Fast' shipping), call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a ShippingCategory value of 'ONE_DAY' for the corresponding shipping service. 'Get It Fast' shipping is not available for international shipping. Each shipping service specified for the shipping profile is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See GeteBayDetails.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .shippingServiceAdditionalCost	Amount (double)	Conditionally	This value sets the cost of shipping each additional item if the buyer purchases multiple identical items in a multi-quantity, fixed-price listing. This field is required for all multi-quantity, fixed-price listings where flat-rate shipping is used. This value is at the seller's discretion. Generally, it should be the same price or lower than the shippingServiceCost value. The seller may consider specifying a lower price to ship additional items as an incentive to the buyer to purchase multiple items. The seller may also consider a lower price if he/she is able to ship multiple items in the same box. In this scenario, the seller is able to save on shipping costs and passes these savings down to the buyer. The total shipping costs for an order line item is calculated with the following formula: Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost * quantity purchased) So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 * 3)). This field is not applicable to calculated shipping. If set for one or more shipping services within the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .shippingServiceCost	Amount (double)	Conditionally	This value sets the cost of shipping for the item if the buyer selects this shipping service option. This field is required in the input for all listings where flat-rate shipping is used, and is not applicable to calculated shipping. This value is at the seller's discretion but should reflect the approximate cost of the shipping service option plus handling. This value defaults to 0.0 if the freeShipping field is set to 'true'. The total shipping costs for an order line item is calculated with the following formula: Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost * quantity purchased) So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 * 3)). This field is always returned (for each shipping service) with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .shippingSurcharge	Amount (double)	Conditionally	An additional charge that US sellers can add to the cost of an order line item if that order line item is an eBay Motors Parts and Accessories item that is being shipped to a buyer in Alaska, Hawaii, or Puerto Rico through a UPS or FedEx shipping service that charges a surcharge to ship to those areas. In order for sellers to add a shipping surcharge at the shipping service level, the following must be true: a surcharge is applicable for the shipping service (call GeteBayDetails with DetailName set to ShippingServiceDetails, and then look for ShippingServiceDetails.SurchargeApplicable=true in the response; flat-rate shipping is used If set for one or more shipping services within the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .shipToLocation	token	Conditionally, repeatable: [0..*]	An international region (such as Asia or Europe) or a country (represented by two- letter country code) to where the seller will ship an item. To obtain valid 'Ship- To locations' for their site, the seller must call GeteBayDetails, using ShipppingLocationDetails as a DetailName value in the request, and then scanning the ShippingLocationDetails.ShippingLocation values that are returned in the response. The shipping regions and countries that may be specified as shipToLocation values will vary according to eBay site. The seller may include as many valid shipToLocation values as necessary based on where they are willing to ship an item. If no shipToLocation field is included in the domesticShippingPolicyInfoService container when using the addSellerProfile or setSellerProfile calls, eBay will automatically add the seller's listing country as a 'Ship-To Location'. If the seller does want to offer international shipping as part of the shipping profile, at least one shipToLocation field in the internationalShippingPolicyInfoService container is required when using the addSellerProfile and setSellerProfile calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a shipToLocation value. If the seller wants to ship to a specific region, but would like to exclude one or more countries in that region, the seller should include that region as a shipToLocation value, but then exclude one or more countries in that region by including one or more instances of the shippingPolicyInfo.excludeShipToLocation field. Each ship-to location specified for the shipping service is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See GeteBayDetails (ShippingLocationDetails).
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .sortOrderId	int	Conditionally	This integer value controls the order (relative to other shipping service options) in which the corresponding shipping service option will appear in the View Item and Checkout pages. Sellers can specify up to four domestic shipping services (in four separate domesticShippingPolicyInfoService containers), so valid values are 1, 2, 3, and 4. A shipping service option with a sortOrderId value of '1' appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a sortOrderId value of '4' appears at the bottom of a list of four shipping service options. Sellers can specify up to five international shipping services (in five separate internationalShippingPolicyInfoService containers), so valid values are 1, 2, 3, 4, and 5. Similarly to domesstic shipping service options, the sortOrderId value of a international shipping service option controls the placement of that shipping service option in the View Item and Checkout pages. If the sortOrderId field is not used, the order of domestic and international shipping service options will be determined by the order they are listed in the API call. This field is always returned (for each shipping service) with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Min: 1. Max: 4 (for domestic shipping service) or 5 (for international shipping service).
shippingPolicyProfile .shippingPolicyInfo .domesticShippingType	token	Conditionally	The domestic shipping cost model used by the seller. The only three valid values are 'Calculated', 'Flat', or 'FreightFlat'. If this field is not included and specified in an addSellerProfile or setSellerProfile call, it defaults to 'Flat' shipping. If 'FreightFlat' is specified as the domestic shipping type, the freightShipping container and its values must be set in the shipping profile. If 'Calculated' is used as the shipping type, the CalculatedShippingRate container must be used when listing, revising, or relisting an item through the Trading API. This field is always returned with all shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See Shipping.
shippingPolicyProfile .shippingPolicyInfo .excludeShipToLocation	token	Conditionally, repeatable: [0..*]	Sellers can use this field to exclude one or more international regions, countries, or special domestic locations (such as 'PO Box' in US or 'Packstation' in Germany) as possible shipping locations. To obtain valid 'exclude Ship-To locations', the seller must call GeteBayDetails, using ExcludeShipppingLocationDetails as a DetailName value in the request, and then scanning the ExcludeShippingLocationDetails.Location values that are returned in the response. The seller may include as many valid excludeShipToLocation values as necessary based on where they are not willing to ship an item. If a buyer's primary ship-to location is a location that the seller has listed as an excluded ship-to location, that buyer will receive an error message if they attempt to buy or place a bid on your item. This field works in conjunction with the shipToLocation values to create a set of international regions, countries, and domestic locations to where the seller will (and will not) ship. You can list a region in the shipToLocation field, then exclude specific countries within that region with this field. For example, you can specify 'Africa' as a shipToLocation value, yet exclude Egypt by including an excludeShipToLocation field with its value set to 'EG', which is Egypt's two-digit country code. and setting it to setting). In addition, if a seller used only one shipToLocation value and set it to 'Worldwide', that seller can use one or more excludeShipToLocation fields to exclude one or more international regions, countries, or special domestic locations as possible shipping destinations. Each excluded ship-to location is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See GeteBayDetails (ExcludeShippingLocationDetails).
shippingPolicyProfile .shippingPolicyInfo .freightShipping	FreightShipping	Conditionally	This container consists of details related to freight shipping. This container and its values are required to be set in a shipping profile if the seller offers freight shipping (domesticShippingType and/or intlShippingType is set to 'FreightFlat'). If freight shipping is specified for a shipping profile, this container is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .freightShipping.commodityType	token	Conditionally	A string value classifying the freight item to be shipped. Valid values for this field include: MACHINERY_USED MACHINERY_NEW FRAGILE_HOUSEHOLD_USED FRAGILE_HOUSEHOLD_NEW NON_FRAGILE_HOUSEHOLD_USED NON_FRAGILE_HOUSEHOLD_NEW RESTAURANT_EQUIPMENT_USED RESTAURANT_EQUIPMENT_NEW COMPUTER_ELECTRONICS_USED COMPUTER_ELECTRONICS_NEW VENDING_MACHINE_USED VENDING_MACHINE_NEW MOTORCYCLE_USED MOTORCYCLE_NEW This is a required field if freight shipping is included in the shipping profile.
shippingPolicyProfile .shippingPolicyInfo .freightShipping .destPickupInside	boolean	Conditionally	Flag indicating if the freight item will be dropped off inside or outside of the delivery location. If this value is 'true', the item will be dropped off inside of the delivery location, and if 'false', the item will be dropped off outside of the delivery location.
shippingPolicyProfile .shippingPolicyInfo .freightShipping .destPickupLocationType	token	Conditionally	String value indicating whether the freight item is being delivered to a residence or to a commercial location. Valid values are 'Residential' and 'Commercial'.
shippingPolicyProfile .shippingPolicyInfo .freightShipping .freightShippingClass	double	Conditionally	Value indicating the shipping class of the freight item. The shipping class corresponds to the weight of the item (in pounds). Valid values include '50.0', '55.0', '60.0', '65.0', '70.0', '77.5', '85.0', '92.5', '100.0', '110.0', '125.0', '150.0', '175.0', '200.0', '225.0', '250.0', '300.0', '400.0', and '500.0'.
shippingPolicyProfile .shippingPolicyInfo .freightShipping .originPickupInside	boolean	Conditionally	Flag indicating if the freight item will be picked up inside or outside of the pickup location. If this value is 'true', the item will be picked up inside of the pickup location, and if 'false', the item will be picked up outside of the pickup location.
shippingPolicyProfile .shippingPolicyInfo .freightShipping .originPickupLocationType	token	Conditionally	String value indicating whether the freight item is being picked up from a residence or from a commercial location. Valid values are 'Residential' and 'Commercial'.
shippingPolicyProfile .shippingPolicyInfo .freightShipping .packagingHelpRequired	boolean	Conditionally	Flag indicating if help is required to pick up the freight item. If this value is 'true', help picking up the item is required, and if 'false', help picking up the item is not required.
shippingPolicyProfile .shippingPolicyInfo.insurance	Insurance	Conditionally	This container consists of the type and cost of domestic and international shipping insurance. The insurance container is required in the shipping profile if the seller offers shipping insurance to domestic and/or international buyers. Only sellers listing on the AU, FR, and IT sites can offer shipping insurance directly to the buyer. If shipping insurance options are specified for a shipping profile, this container is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo.insurance .domesticInsuranceFee	Amount (double)	Conditionally	This dollar value indicates the cost to the buyer to purchase domestic shipping insurance for the item. This field is only applicable to AU, FR, or IT sellers. This field is conditionally required if the seller is offering domestic shipping insurance to the buyer, and the domesticInsuranceOption is 'Optional' or 'Required'.
shippingPolicyProfile .shippingPolicyInfo.insurance .domesticInsuranceOption	token	Conditionally	This string value indicates the seller's policy on offering domestic shipping insurance to the buyer. Valid values include: IncludedInShippingHandling: the seller is not charging the buyer separately for shipping insurance costs, as the cost of shipping insurance is already included in the base shipping cost for the item NotOffered: the seller does not offer shipping insurance to the buyer Optional: purchasing shipping insurance for the item is at the discretion of the buyer Required: the seller requires that the buyer purchase shipping insurance for the item This field is required if an AU, FR, or IT seller is offering domestic shipping insurance to the buyer.
shippingPolicyProfile .shippingPolicyInfo.insurance .intlInsuranceFee	Amount (double)	Conditionally	This dollar value indicates the cost to the buyer to purchase international shipping insurance for the item. This field is only applicable to AU, FR, or IT sellers. This field is conditionally required if the seller is offering international shipping insurance to the buyer, and the internationalInsuranceOption is 'Optional' or 'Required'.
shippingPolicyProfile .shippingPolicyInfo.insurance .intlInsuranceOption	token	Conditionally	This string value indicates the seller's policy on offering international shipping insurance to the buyer. Valid values include: IncludedInShippingHandling: the seller is not charging the buyer separately for shipping insurance costs, as the cost of shipping insurance is already included in the base shipping cost for the item NotOffered: the seller does not offer shipping insurance to the buyer Optional: purchasing shipping insurance for the item is at the discretion of the buyer Required: the seller requires that the buyer purchase shipping insurance for the item This field is required if an AU, FR, or IT seller is offering international shipping insurance to the buyer.
shippingPolicyProfile .shippingPolicyInfo .internationalPackagingHandlingCosts	Amount (double)	Conditionally	This field allows the seller to add package handling costs for shipping an item to an international location. If set for the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .intlRateTable	token	Conditionally	Note: International shipping rate tables are only available to sellers listing on the Germany and UK eBay sites. This value indicates that the seller's international shipping rate table should be referenced to determine flat-rate shipping costs based on shipping service level and delivery location. Currently, the only valid value for intlRateTable is 'Default', which means that the default international shipping rate table set up by the seller in My eBay is referenced. Including this field in an addSellerProfile or setSellerProfile call will only have an effect on flat shipping rates if an international shipping rate table is set up for the seller's account in My eBay, and it will only affect those international regions and countries for which flat shipping rates are defined. If set for the shipping profile (Germany and UK only), this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Max length: 50.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService	ShippingPolicyInfoService	Conditionally, repeatable: [0..*]	Container that consists of detailed information for an international shipping service, including shipping costs and ship-to locations. Up to five international shipping service options can be specified in one shipping profile. Each specified international shipping service is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .buyerResponsibleForPickup	boolean	Conditionally	This field is only applicable to vehicle categories on eBay Motors (US and Canada). If this field is included and set to 'true', the buyer is responsible for pickup of the vehicle. If this field is 'false', the seller should specify the vehicle pickup arrangements in the item description. If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag. If set for one or more shipping services within the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .buyerResponsibleForShipping	boolean	Conditionally	This field is only applicable to vehicle categories on eBay Motors (US and Canada). If this field is included and set to 'true', the buyer is responsible for the shipment of the vehicle. If this field is 'false', the seller should specify the vehicle shipping arrangements in the item description. If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag. If set for one or more shipping services within the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .codFee	Amount (double)	Conditionally	This value indicates the Cash-on-Delivery fee that is due from the buyer upon item delivery. This field is only applicable if the selected payment method is 'COD' and if the selected shipping service option suppports the Cash-on-Delivery option. To see if a domestic shipping service option supports the Cash-on-Delivery option, call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a CODService=true flag for the corresponding shipping service. If a Cash-on-Delivery shipping service is defined for the shipping profile, this field is returned in the shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .shippingService	string	Conditionally	A domestic or international shipping service being offered by the seller to ship an item to a buyer. For a list of valid shippingService values, call GeteBayDetails, including ShippingServiceDetails as a DetailName value, and then look through the ShippingServiceDetails containers returned in the response. International shipping services are marked with an InternationalService flag. All shipping services without this flag are domestic shipping services. The ShippingServiceDetails.ValidForSellingFlow flag must be present for both domestic and international shipping services, otherwise, that specific shipping service option is no longer valid and cannot be offered to buyers through a listing. The seller must specify one shipping service in each domesticShippingPolicyInfoService and internationalShippingPolicyInfoService container in an addSellerProfile or setSellerProfile request. Up to four domestic and five international shipping service may be offered to the buyer per listing. If 'Get It Fast' shipping is being enabled for the shipping profile (fastShipping=true), the first specified domestic shipping service (specified in the first domesticShippingPolicyInfoService.shippingService field) must be a one-day shipping service. To verify that a domestic shipping service is a one-day shipping service (hence, it qualifies for 'Get It Fast' shipping), call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a ShippingCategory value of 'ONE_DAY' for the corresponding shipping service. 'Get It Fast' shipping is not available for international shipping. Each shipping service specified for the shipping profile is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See GeteBayDetails.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .shippingServiceAdditionalCost	Amount (double)	Conditionally	This value sets the cost of shipping each additional item if the buyer purchases multiple identical items in a multi-quantity, fixed-price listing. This field is required for all multi-quantity, fixed-price listings where flat-rate shipping is used. This value is at the seller's discretion. Generally, it should be the same price or lower than the shippingServiceCost value. The seller may consider specifying a lower price to ship additional items as an incentive to the buyer to purchase multiple items. The seller may also consider a lower price if he/she is able to ship multiple items in the same box. In this scenario, the seller is able to save on shipping costs and passes these savings down to the buyer. The total shipping costs for an order line item is calculated with the following formula: Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost * quantity purchased) So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 * 3)). This field is not applicable to calculated shipping. If set for one or more shipping services within the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .shippingServiceCost	Amount (double)	Conditionally	This value sets the cost of shipping for the item if the buyer selects this shipping service option. This field is required in the input for all listings where flat-rate shipping is used, and is not applicable to calculated shipping. This value is at the seller's discretion but should reflect the approximate cost of the shipping service option plus handling. This value defaults to 0.0 if the freeShipping field is set to 'true'. The total shipping costs for an order line item is calculated with the following formula: Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost * quantity purchased) So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 * 3)). This field is always returned (for each shipping service) with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .shippingSurcharge	Amount (double)	Conditionally	An additional charge that US sellers can add to the cost of an order line item if that order line item is an eBay Motors Parts and Accessories item that is being shipped to a buyer in Alaska, Hawaii, or Puerto Rico through a UPS or FedEx shipping service that charges a surcharge to ship to those areas. In order for sellers to add a shipping surcharge at the shipping service level, the following must be true: a surcharge is applicable for the shipping service (call GeteBayDetails with DetailName set to ShippingServiceDetails, and then look for ShippingServiceDetails.SurchargeApplicable=true in the response; flat-rate shipping is used If set for one or more shipping services within the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .shipToLocation	token	Conditionally, repeatable: [0..*]	An international region (such as Asia or Europe) or a country (represented by two- letter country code) to where the seller will ship an item. To obtain valid 'Ship- To locations' for their site, the seller must call GeteBayDetails, using ShipppingLocationDetails as a DetailName value in the request, and then scanning the ShippingLocationDetails.ShippingLocation values that are returned in the response. The shipping regions and countries that may be specified as shipToLocation values will vary according to eBay site. The seller may include as many valid shipToLocation values as necessary based on where they are willing to ship an item. If no shipToLocation field is included in the domesticShippingPolicyInfoService container when using the addSellerProfile or setSellerProfile calls, eBay will automatically add the seller's listing country as a 'Ship-To Location'. If the seller does want to offer international shipping as part of the shipping profile, at least one shipToLocation field in the internationalShippingPolicyInfoService container is required when using the addSellerProfile and setSellerProfile calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a shipToLocation value. If the seller wants to ship to a specific region, but would like to exclude one or more countries in that region, the seller should include that region as a shipToLocation value, but then exclude one or more countries in that region by including one or more instances of the shippingPolicyInfo.excludeShipToLocation field. Each ship-to location specified for the shipping service is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See GeteBayDetails (ShippingLocationDetails).
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .sortOrderId	int	Conditionally	This integer value controls the order (relative to other shipping service options) in which the corresponding shipping service option will appear in the View Item and Checkout pages. Sellers can specify up to four domestic shipping services (in four separate domesticShippingPolicyInfoService containers), so valid values are 1, 2, 3, and 4. A shipping service option with a sortOrderId value of '1' appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a sortOrderId value of '4' appears at the bottom of a list of four shipping service options. Sellers can specify up to five international shipping services (in five separate internationalShippingPolicyInfoService containers), so valid values are 1, 2, 3, 4, and 5. Similarly to domesstic shipping service options, the sortOrderId value of a international shipping service option controls the placement of that shipping service option in the View Item and Checkout pages. If the sortOrderId field is not used, the order of domestic and international shipping service options will be determined by the order they are listed in the API call. This field is always returned (for each shipping service) with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Min: 1. Max: 4 (for domestic shipping service) or 5 (for international shipping service).
shippingPolicyProfile .shippingPolicyInfo .intlShippingType	token	Conditionally	The international shipping cost model used by the seller. Valid values are 'Calculated', 'Flat', or 'FreightFlat'. If 'FreightFlat' is used as the shipping type, the freightShipping container and its values must be in the shipping profile. If 'Calculated' is used as the shipping type, the CalculatedShippingRate container must be used when listing, revising, or relisting an item through the Trading API. The international shipping cost model used by the seller. The only three valid values are 'Calculated', 'Flat', or 'FreightFlat'. If this field is not included and specified in an addSellerProfile or setSellerProfile call, it defaults to 'Flat' shipping. If 'FreightFlat' is specified as the international shipping type, the freightShipping container and its values must be set in the shipping profile. If 'Calculated' is used as the shipping type, the CalculatedShippingRate container must be used when listing, revising, or relisting an item through the Trading API. This field is always returned with all shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See GeteBayDetails (ShippingServiceDetails.ServiceType).
shippingPolicyProfile .shippingPolicyInfo .packagingHandlingCosts	Amount (double)	Conditionally	This field allows the seller to add package handling costs for shipping an item to a domestic location. If set for the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .shippingOption	token	Conditionally	This optional field helps summarize the locations/regions that the seller will ship an item to. The integer value that is used in this field for an addSellerProfile or setSellerProfile call should be in synch with the values that are specified in the shipToLocation and excludeShipToLocation fields used in the same call. The possible values are listed below: 0 ('SiteOnly'): this value indicates that the seller only ships to domestic locations (relative to the listing site). 1 ('SitePlusRegions'): this value indicates that the seller ships to domestic locations plus any international regions or countries specified as ship-to locations through the shipToLocation field. 2 ('WorldWide'): this value indicates that the seller will ship to anywhere in the world except for any international regions or countries excluded with an excludeShipToLocation field. 3 ('WillNotShip'): this value indicates that the seller does not offer shipping. This value is only applicable if 'Local Pickup' is being used, which might be the case if the item is a motor vehicle. 4 ('TermsAndConditionsOnly'): this value is for future use. If set for the shipping profile, this field is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .shippingPolicyCurrency	IsoCurrencyCode	Always	Three-digit code that indicates the currency used by the listing site. To obtain valid currency codes, the seller can call GeteBayDetails, using CurrencyDetails as a DetailName value in the request, and then scanning the CurrencyDetails.Currency values that are returned in the response. If this field is not included in an addSellerProfile or setSellerProfile call, the currency code will default to the standard currency used by the listing site. This field is always returned with all shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Applicable values: • AUD Australian Dollar; country - Australia; ISO currency code - 036 • CAD Canadian Dollar; country - Canada; ISO currency code - 124 • CHF Swiss Franc; country - Switzerland; ISO currency code - 756 • CNY Chinese Yuan Renminbi; country - China; ISO currency code - 156 • EUR Euro; entity - European Union; ISO currency code - 978 • GBP Pound Sterling; country - United Kingdom; ISO currency code - 826 • HKD Hong Kong Dollar; country - Hong Kong; ISO currency code - 344 • INR Indian Rupee; country - India; ISO currency code - 356 • MYR Malaysian Ringgit; country - Malaysia; ISO currency code - 458 • PHP Philippine Peso; country - Philippines; ISO currency code - 608 • PLN Polish New Zloty; country - Poland; ISO currency code - 985 • SEK Swedish Krona; country - Sweden; ISO currency code - 752 • SGD Singapore Dollar; country - Singapore; ISO currency code - 702 • TWD New Taiwan Dollar; country - Taiwan; ISO currency code - 901 • USD U.S. Dollar; country - United States; ISO currency code - 840
shippingPolicyProfile .shippingPolicyInfo .shippingPolicyName	string	Conditionally	This string value indicates the name of the shipping profile. This profile name must be unique among all of seller's shipping profiles. A shippingPolicyName value is required when using the addSellerProfile and setSellerProfile calls to create or update a shipping profile. This field is always returned with all shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
shippingPolicyProfile .shippingPolicyInfo .shippingProfileDiscountInfo	ShippingProfileDiscountInfo	Conditionally	Container consisting of flat-rate or calculated shipping discount profile IDs (that identify the shipping discount rules to apply when domestic and/or international buyers purchase multiple items), as well as flags indicating if promotional shipping discounts are offered to domestic and/or international buyers. Shipping discounts can be created by the seller through My eBay, or by using the SetShippingDiscountProfiles call of the Trading API. If shipping discounts are used for a shipping profile, this container is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See: SetShippingDiscountProfiles GetShippingDiscountProfiles
shippingPolicyProfile .shippingPolicyInfo .shippingProfileDiscountInfo .applyDomesticPromoShippingProfile	boolean	Conditionally	If this field is included and set to 'true', a domestic buyer will be the recipient of the seller's promotional shipping discount (if that buyer satisfies the buying requirements). The seller can create a promotional shipping rule on My eBay, or by using the SetShippingDiscountProfiles call of the Trading API. See: SetShippingDiscountProfiles GetShippingDiscountProfiles
shippingPolicyProfile .shippingPolicyInfo .shippingProfileDiscountInfo .applyIntlPromoShippingProfile	boolean	Conditionally	If this field is included and set to 'true', an international buyer will be the recipient of the seller's promotional shipping discount (if that buyer satisfies the buying requirements). The seller can create a promotional shipping rule on My eBay, or by using the SetShippingDiscountProfiles call of the Trading API. See: SetShippingDiscountProfiles GetShippingDiscountProfiles
shippingPolicyProfile .shippingPolicyInfo .shippingProfileDiscountInfo .domesticFlatCalcDiscountProfileId	long	Conditionally	Unique identifier for a flat-rate or calculated shipping rule defined by the seller. If the seller specifies a valid shipping discount profile ID for either of these shipping rules, a domestic buyer may receive a shipping discount from the seller when purchasing multiple items. The seller can create and manage shipping discount profiles on My eBay, or by using the SetShippingDiscountProfiles and GetShippingDiscountProfiles calls of the Trading API. The type of shipping discount profile specified in this field (flat-rate or calculated) should correspond to the domesticShippingType ('Flat' or 'Calculated') value in the shipping profile. Shipping discount profiles are not applicable when Freight shipping is used. See: SetShippingDiscountProfiles GetShippingDiscountProfiles
shippingPolicyProfile .shippingPolicyInfo .shippingProfileDiscountInfo .intlFlatCalcDiscountProfileId	long	Conditionally	Unique identifier for a flat-rate or calculated shipping rule defined by the seller. If the seller specifies a valid shipping discount profile ID for either of these shipping rules, an international buyer may receive a shipping discount from the seller when purchasing multiple items. The seller can create and manage shipping discount profiles on My eBay, or by using the SetShippingDiscountProfiles and GetShippingDiscountProfiles calls of the Trading API. The type of shipping discount profile specified in this field (flat-rate or calculated) should correspond to the intlShippingType ('Flat' or 'Calculated') value in the shipping profile. Shipping discount profiles are not applicable when Freight shipping is used. See: SetShippingDiscountProfiles GetShippingDiscountProfiles
shippingPolicyProfile .shippingPolicyInfo .shipToLocations	token	Conditionally, repeatable: [0..*]	An international region (such as Asia, Europe, or Latin America) or country (represented by two-letter country code) to where the seller will ship an item. It is not necessary to include the shipToLocation field in the domesticShippingPolicyInfoService container when using the addSellerProfile and setSellerProfile calls. However, eBay automatically adds the seller's listing county as a 'Ship-To Location', and the shipToLocation field is always returned for each shipping profile in the addSellerProfile, setSellerProfile, and getSellerProfiles calls. If the seller does want to offer international shipping as part of the shipping profile, at least one shipToLocation field in the internationalShippingPolicyInfoService container is required when using the addSellerProfile and setSellerProfile calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a shipToLocation value. If the seller wants to offer shipping to one or more specific shipping regions, the seller must include that shipping region in a shipToLocation field. If the seller wants to ship to a specific region, but would like to exclude one or more countries in that region, the seller should use one or more instances of the shippingPolicyInfo.excludeShipToLocation field. Applicable shipping region values are defined in ShippingRegionCodeType and applicable country codes are defined in CountryCodeType. However, it is best practice for sellers to call GeteBayDetails, using ShipppingLocationDetails as a DetailName value in the request, and then scanning the ShippingLocationDetails.ShippingLocation values that are returned in the response. Each specified ship-to location is returned with shipping profiles returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See: GeteBayDetails ShippingRegionCodeType CountryCodeType
shippingPolicyProfile.siteId	int	Always	Unique identifier of the eBay site. This value is always returned in the getSellerProfiles call. It is optional in the addSellerProfile and setSellerProfile calls. If it is not used in an addSellerProfile or setSellerProfile call, the siteId value defaults to the seller's eBay registration site. When creating a Business Policies profile for motor vehicle listings on the US eBay Motors site (Site ID=100), the siteId field should be included and set to '0' (US site). By performing this action, the Business Policies Management Service automatically applies the Business Policies profile from the eBay US site (Site ID=0) to the US eBay Motors site (Site ID=100).

Standard Output Fields

ack	AckValue	Always	A token representing the application-level acknowledgement code that indicates the response status, such as success. The AckValue list specifies the possible values for ack. Applicable values: • Failure eBay encountered a fatal error during the processing of the request, causing the request to fail. When a serious application-level error occurs, the error is returned instead of the business data. • PartialFailure eBay successfully processed the request, but one or more non-fatal errors occurred during the processing. Inspect the message details and resolve any problems before resubmitting the request. • Success eBay successfully processed the request and the business data is returned in the response. Note that it is possible for a response to return Success, but still not contain the expected data in the result. • Warning The request that triggered the error was processed successfully but with one or more warnings.
errorMessage	ErrorMessage	Conditionally	Information for an error or warning that occurred when eBay processed the request.
errorMessage.error	ErrorData	Conditionally, repeatable: [0..*]	Details about a single error.
errorMessage.error.category	ErrorCategory	Conditionally	There are three categories of errors: request errors, application errors, and system errors. Applicable values: • Application An error occurred due to a problem with the request, with the most likely source being the application sending the request. For example, the request is missing a required data element or it contains an invalid field. The problem must be corrected before the request can be resent. Inspect the error message to find the cause of the problem. If the problem is due to an application error, modify the application and resend the request. If the error is due to invalid data, the source of the data must be corrected before you resend the resend request to eBay. • Request An error occurred due to a problem with the request, with the most likely source being missing or invalid data in the request. The problem must be corrected before the request can be retried. Inspect the error message to find the cause of the problem. If the problem is a result of end-user data, alert the end-user to the problem and provide the means for them to correct the problem. Once the problem is resolved, resend the request to eBay. • System Indicates that an error has occurred on the eBay system side. For example, a database or server could be down. Inspect the error message to find the cause of the problem. If the problem is on the eBay side, an application can retry the request a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
errorMessage.error.domain	string	Conditionally	Name of the domain in which the error occurred.
errorMessage.error.errorId	long	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
errorMessage.error.exceptionId	token	Conditionally	Unique identifier for an exception associated with an error.
errorMessage.error.message	string	Conditionally	A detailed description of the condition that caused the error.
errorMessage.error.parameter	ErrorParameter (string)	Conditionally, repeatable: [0..*]	Various warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.
errorMessage.error.parameter [ attribute name ]	string	Conditionally	The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value.
errorMessage.error.severity	ErrorSeverity	Conditionally	Indicates whether the reported problem is fatal (an error) or is less- severe (a warning). Review the error message details for information on the cause. If the request fails and the application is the source of the error (for example, a required element is missing), update the application before you retry the request. If the problem is due to incorrect user data, alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, re-send the request to eBay. If the source of the problem is on eBay's side, you can retry the request a reasonable number of times (eBay recommends you try the request twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, you can resend the request in its original form. If a warning occurs, warning information is returned in addition to the business data. Normally, you do not need to resend the request (as the original request was successful). However, depending on the cause of the warning, you might need to contact the end user, or eBay, to effect a long term solution to the problem. Applicable values: • Error eBay encountered a fatal error during the processing of the request, causing the request to fail. When eBay encounters an error, it returns error data instead of the requested business data. Inspect the error details and resolve the problem before resubmitting the request. • Warning The request was successfully processed, but eBay encountered a non-fatal error during the processing that could affect the data returned. For example, eBay might have changed the value of an input field. In this Return, eBay returns a successful response, but it also returns a warning. For best results, requests should return without warnings. Inspect the warning details and resolve the problem before resubmitting the request.
errorMessage.error.subdomain	string	Conditionally	Name of the subdomain in which the error occurred.
timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY- MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone.
version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request.

setSellerProfile Samples

New to making API calls? Please see Making an API Call.

Note: Some data in these samples might no longer be active. If necessary, you can substitute current data in your requests.

Sample: Basic Call

Allows a seller to modify existing profiles for their business policies. The types of profiles can be modified are PAYMENT, RETURN_POLICY, and SHIPPING.

Description

A seller wants to modify an existing payment policy and returns policy for their business, the Fruit Folks. The seller wants to add personal checks and the American Express card as acceptable methods of payment and discontinue accepting Visa or Mastercard. PayPal will be kept as an acceptedPaymentMethod. The seller also wants to change the refund option from exchanging the product to returning money back because it's less costly to send a refund check than to have the product exchanged.

Input

To modify the payment policy in this example, the seller would have to include the following request parameters in the paymentInfo container to update the values:

profileId of payment policy that was created with the addSellerProfile call. Use getSellerProfiles to lookup the id of the profiles you wish to change. In this example, the profileId is 5218555011 for this Payment Policy.
acceptedPaymentMethod. Because the example is specifying multiple acceptablePaymentMethod fields, there are three rules you must follow in writing out the XML: 1) the repeating acceptedPaymentMethod fields must be contiguous, 2)If the acceptedPaymentMethod is PayPal, the immediatePay field must be included and set to true, and 3) the paypalEmailAddress field must be included with a valid value and must immediately follow the immediatePay field like this:

acceptedPaymentMethod=PersonalChecks
acceptedPaymentMethod=AmEx
acceptedPaymentMethod=PayPal
immediatePay=true
PayPalEmailAddress=mypaypalemail@ebay.com

To modify the return policy for the refund option in this example, the seller would have to include the following request parameters in the returnPolicyInfo container to update the values:

profileId of return policy that was created with the addSellerProfile call. Use getSellerProfiles to lookup the id of the profile you wish to change. In this example, profileId is 5218554011 for the Return Policy.
refundOption=MoneyBack
returnsAcceptedOption=ReturnsAccepted (this field must be passed in because refundOption has a valid value)
returnsWithinOption=Days_14 (this field must be passed in because refundOption has a valid value)

XML format (HTTP POST). Also available is the .txt version of this XML.

<xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.ebay.com/marketplace/selling/v1/services">
  <setSellerProfileRequest>
     <paymentProfile>
        <profileName>Fruit Folks - Payment Policy Worldwide</profileName>
        <profileId>5218555011</profileId>
           <profileType>PAYMENT</profileType>
           <profileDesc>Lists payment options for fresh fruit purchases</profileDesc>
           <siteId>0</siteId>
          <categoryGroups>
              <categoryGroup>
                 <default>false</default>
                 <name>ALL</name>
              </categoryGroup>
           </categoryGroups>
        <paymentInfo>
           <acceptedPaymentMethod>PersonalCheck</acceptedPaymentMethod>
           <acceptedPaymentMethod>AmEx</acceptedPaymentMethod>
           <acceptedPaymentMethod>PayPal</acceptedPaymentMethod>              
           <immediatePay>true</immediatePay>
           <paypalEmailAddress>sp-us3@unicorn.qa.ebay.com</paypalEmailAddress>
        </paymentInfo>
     </paymentProfile>
     <returnPolicyProfile>
        <profileName>Fruit Folks - Returns Policy Worldwide</profileName>
        <profileId>5218554011</profileId>
        <profileType>RETURN_POLICY</profileType>
        <profileDesc>Lists terms for returned fruit</profileDesc>
        <siteId>0</siteId>
          <categoryGroups>
              <categoryGroup>
                 <default>false</default>
                 <name>ALL</name>
              </categoryGroup>
           </categoryGroups>
        <returnPolicyInfo>
         <returnsAcceptedOption>ReturnsAccepted</returnsAcceptedOption>
         <refundOption>MoneyBack</refundOption>
         <returnsWithinOption>Days_14</returnsWithinOption>            
         <shippingCostPaidByOption>Buyer</shippingCostPaidByOption></returnPolicyInfo>
     </returnPolicyProfile>
  </setSellerProfileRequest>

Output

The response contains the information that has been changed for the payment and return policies of the seller.

XML format. Also available is the .txt version of this XML.

<setSellerProfileResponse xmlns="http://www.ebay.com/marketplace/selling/v1/services">
  <ack>Success</ack>
     <paymentProfile>
        <profileName>Fruit Folks - Payment Policy Worldwide</profileName>
        <profileId>5218555011</profileId>
           <profileType>PAYMENT</profileType>
           <profileDesc>Lists payment options for fresh fruit purchases</profileDesc>
           <siteId>0</siteId>
          <categoryGroups>
              <categoryGroup>
                 <default>false</default>
                 <name>ALL</name>
              </categoryGroup>
           </categoryGroups>
        <paymentInfo>
           <acceptedPaymentMethod>PersonalCheck</acceptedPaymentMethod>
           <acceptedPaymentMethod>AmEx</acceptedPaymentMethod>
           <acceptedPaymentMethod>PayPal</acceptedPaymentMethod>              
           <immediatePay>true</immediatePay>
           <paypalEmailAddress>sp-us3@unicorn.qa.ebay.com</paypalEmailAddress>
        </paymentInfo>
     </paymentProfile>
     <returnPolicyProfile>
        <profileName>Fruit Folks - Returns Policy Worldwide</profileName>
        <profileId>5218554011</profileId>
        <profileType>RETURN_POLICY</profileType>
        <profileDesc>Lists terms for returned fruit</profileDesc>
        <siteId>0</siteId>
          <categoryGroups>
              <categoryGroup>
                 <default>false</default>
                 <name>ALL</name>
              </categoryGroup>
           </categoryGroups>
        <returnPolicyInfo>
         <returnsAcceptedOption>ReturnsAccepted</returnsAcceptedOption>
         <refundOption>MoneyBack</refundOption>
         <returnsWithinOption>Days_14</returnsWithinOption>            
         <shippingCostPaidByOption>Buyer</shippingCostPaidByOption></returnPolicyInfo>
     </returnPolicyProfile>
</setSellerProfileResponse>

setSellerProfile Change History

Version	Description
1.0.0 2012-02-15	(added) New call.

User-Contributed Notes

eBay Business Policies Management API Call Reference Version 1.0.0