addSellerProfile
Sellers use this call to create one or more business policies. With one call instance, the seller can create a payment policy, a return policy, a shipping policy, or any combination of the three policy types.
Important! This API is deprecated and will be decommissioned later in 2022, on a date TBD. We recommend that you migrate to the fulfillment_policy, payment_policy, and return_policy resources of the Account API to set up and manage all of your fulfillment, payment, and return business policies.
| Output Samples Change History |
Input
See also Samples.
The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.
<?xml version="1.0" encoding="utf-8"?> <addSellerProfileRequest 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> <forceDuplicate> boolean </forceDuplicate> <paymentInfo> PaymentInfo <acceptedPaymentMethod> token </acceptedPaymentMethod> <!-- ... more acceptedPaymentMethod values allowed here ... --> <daysToFullPayment> int </daysToFullPayment> <!-- ... more daysToFullPayment values allowed here ... --> <depositDetails> DepositDetails <daysToFullPayment> int </daysToFullPayment> <!-- ... more daysToFullPayment values allowed here ... --> <depositAmount> Amount (double) </depositAmount> <hoursToDeposit> int </hoursToDeposit> </depositDetails> <immediatePay> boolean </immediatePay> <paymentInstructions> string </paymentInstructions> <paypalEmailAddress> token </paypalEmailAddress> </paymentInfo> <profileDesc> string </profileDesc> <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> <forceDuplicate> boolean </forceDuplicate> <internationalReturnPolicyInfo> InternationalReturnPolicyInfo <refundOption> token </refundOption> <returnsAcceptedOption> token </returnsAcceptedOption> <returnsWithinOption> token </returnsWithinOption> <shippingCostPaidByOption> token </shippingCostPaidByOption> </internationalReturnPolicyInfo> <profileDesc> string </profileDesc> <profileName> string </profileName> <profileType> ProfileType </profileType> <returnPolicyInfo> ReturnPolicyInfo <description> string </description> <holidayReturns> token </holidayReturns> <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> <forceDuplicate> boolean </forceDuplicate> <profileDesc> string </profileDesc> <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> <EligibleForPickupDropOff> boolean </EligibleForPickupDropOff> <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> <GlobalShipping> boolean </GlobalShipping> <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> <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> </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 ... --> </addSellerProfileRequest>
| Argument | Type | Occurrence | Meaning |
|---|
| Call-specific Input Fields [Jump to standard fields] |
| paymentProfile | PaymentProfile (SellerProfile) | Required |
Root container for a seller's payment policy. The paymentProfile container consists of payment information, the name and description of the policy, and the site and category group(s) to which the payment policy will be applied. The paymentProfile container is conditionally required if the seller wants to create a new payment policy. |
| paymentProfile.categoryGroups | CategoryGroups | Required | This container consists of one or more categoryGroup containers. One or more category groups are linked to each business policy. |
|
paymentProfile.categoryGroups .categoryGroup |
CategoryGroup | Required,
repeatable: [1..*] |
This container indicates the category group to which the payment policy, return policy, or shipping policy applies to. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). The 'MOTORS_VEHICLE' category group is not valid for return policies, as return policies cannot be used with motor vehicle listings. These enumeration values are case-sensitive. Each business policy can be associated with more than one category group. |
|
paymentProfile.categoryGroups .categoryGroup.default |
boolean | Optional |
Deprecated as of version v1.1.0. Currently ignored. Important: This field has been deprecated and is no longer used. Do not include this field in any add or set call. This field may be returned within the payload of a get call, but it can be ignored.
|
|
paymentProfile.categoryGroups .categoryGroup.name |
string | Required | This string value indicates the name of the category group to which the corresponding business policy 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. The 'MOTORS_VEHICLE' category group is not valid for return business policies, as return business policies cannot be used with motor vehicle listings. |
| paymentProfile.forceDuplicate | boolean | Required | This value is for future use. |
| paymentProfile.paymentInfo | PaymentInfo | Conditional |
This container consists of detailed payment information for a seller's payment policy. This container is conditionally required if the caller is creating a new payment policy or modifying an existing payment policy. This container is returned by getSellerProfiles if one or more payment policies match the input criteria in the call request, and is returned in the response of addSellerProfile or setSellerProfile if a payment policy is being created or modified, respectively. |
|
paymentProfile.paymentInfo .acceptedPaymentMethod |
token | Conditional,
repeatable: [0..*] |
Note:This field applies only when the seller needs to specify one or more offline payment methods. eBay now manages the electronic payment options available to buyers to pay for the item. This field specifys one or more offline payment methods that will be accepted for payment that occurs off of eBay's platform. If you specify multiple acceptedPaymentMethod 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. 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:
|
|
paymentProfile.paymentInfo .daysToFullPayment |
int | Conditional,
repeatable: [14..3] |
This integer value indicates the number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. This container must be specified for motor vehicles listings. Valid values are '3', '7' (default), '10', and '14'. In order for a buyer to make a full payment on a US or CA motor vehicle, at least one of the following acceptedPaymentMethod values must be specified for the corresponding payment business policy:
Default: 7. |
|
paymentProfile.paymentInfo .depositDetails |
DepositDetails | Conditional | This value indicates the initial deposit amount required from the buyer in order to purchase a motor vehicle. This value can be as high as $2,000.00 if immediate payment is not required, and up to $500.00 if immediate payment is required. This container is only applicable if the categoryGroup.namefield is set to 'MOTORS_VEHICLE'. |
|
paymentProfile.paymentInfo .depositDetails .daysToFullPayment |
int | Conditional,
repeatable: [14..3] |
This integer value indicates the number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. This container must be specified for motor vehicles listings. Valid values are '3', '7' (default), '10', and '14'. In order for a buyer to make a full payment on a US or CA motor vehicle, at least one of the following acceptedPaymentMethod values must be specified for the corresponding payment policy:
Default: 7. |
|
paymentProfile.paymentInfo .depositDetails.depositAmount |
Amount (double) | Conditional |
This value indicates the initial deposit amount required from the buyer in order to purchase a motor vehicle. This value can be as high as $2,000.00 if immediate payment is not required, and up to $500.00 if immediate payment is required. This container is only applicable if the categoryGroup.namefield is set to 'MOTORS_VEHICLE'. If not specified, this value defaults to '0.0'. If this value is specified, the seller must also specify an hoursToDeposit value. The deposit amount appears in the shipping, payment details and return policy sections of the View Item page. Min: 0.0. Max: 2000.0. Default: 0.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 an initial 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. Note: The hoursToDeposit value is overridden if the seller has set the motor vehicle listing to require immediate payment. If the listing requires immediate payment, the buyer must pay the deposit immediately in order to be eligible to purchase the motor vehicle. Min: 24. Max: 72. Default: 48. |
|
paymentProfile.paymentInfo .immediatePay |
boolean | Conditional |
This field should be included and set to true if the seller wants to require immediate payment from the buyer for:
Note: 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 policy) an immediate payment requirement.
Default: false. |
|
paymentProfile.paymentInfo .paymentInstructions |
string | Optional |
Deprecated as of version v1.1.0. Currently ignored. Important: DO NOT USE THIS FIELD. Payment instructions are no longer supported by payment business policies. 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 pages. This field allows 1000 characters. It is recommended that the seller use this field for motor vehicles (eBay Motors US and CA) payment policies to clarify the specifics on the deposit (if required), pickup/delivery arrangements, and full payment details on the vehicle. Max length: 1000. Deprecation version: v1.1.0. See also Deprecated Objects. |
|
paymentProfile.paymentInfo .paypalEmailAddress |
token | Optional |
Deprecated as of version v1.1.0. Currently ignored. Important: This field is deprecated. Do not use this field. Deprecation version: v1.1.0. See also Deprecated Objects. |
| paymentProfile.profileDesc | string | Optional |
This field is used by the seller to provide a description of the business policy. The profileDesc field is optional in the addSellerProfile and setSellerProfile calls. This field is only returned for a business policy if a description exists for that policy. Max length: 250. |
| paymentProfile.profileName | string | Required | This string value indicates the name of the business policy. This policy name must be unique among all of seller's business policies. A profileName value is required when using the addSellerProfile and setSellerProfile calls. |
| paymentProfile.profileType | ProfileType | Required |
This field indicates the type of the business policy. 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 of a specific type.
Applicable values: |
| 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. |
| returnPolicyProfile | ReturnPolicyProfile (SellerProfile) | Conditional |
Root container for a seller's return policy. The returnPolicyProfile container consists of return policy information, the name and description of the policy, and the site and category group(s) to which the return policy will be applied. The returnPolicyProfile container is conditionally required if the seller wants to create a new return policy. |
|
returnPolicyProfile .categoryGroups |
CategoryGroups | Required | This container consists of one or more categoryGroup containers. One or more category groups are linked to each business policy. |
|
returnPolicyProfile .categoryGroups.categoryGroup |
CategoryGroup | Required,
repeatable: [1..*] |
This container indicates the category group to which the payment policy, return policy, or shipping policy applies to. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). The 'MOTORS_VEHICLE' category group is not valid for return policies, as return policies cannot be used with motor vehicle listings. These enumeration values are case-sensitive. Each business policy can be associated with more than one category group. |
|
returnPolicyProfile .categoryGroups.categoryGroup .default |
boolean | Optional |
Deprecated as of version v1.1.0. Currently ignored. Important: This field has been deprecated and is no longer used. Do not include this field in any add or set call. This field may be returned within the payload of a get call, but it can be ignored.
|
|
returnPolicyProfile .categoryGroups.categoryGroup .name |
string | Required | This string value indicates the name of the category group to which the corresponding business policy 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. The 'MOTORS_VEHICLE' category group is not valid for return business policies, as return business policies cannot be used with motor vehicle listings. |
|
returnPolicyProfile .forceDuplicate |
boolean | Required | This value is for future use. |
|
returnPolicyProfile .internationalReturnPolicyInfo |
InternationalReturnPolicyInfo | Conditional |
This container consists of detailed information on a seller's international return policy (returns that require an international shipping service to ship). This container is optional and allows for a seller to establish an international return policy that differs from their domestic return policy. This container is returned by getSellerProfiles if one or more return policies match the input criteria in the call request. |
|
returnPolicyProfile .internationalReturnPolicyInfo .refundOption |
token | Conditional |
This field indicates how the seller compensates buyers for remorse returns. You must set this value to MoneyBack for all eBay marketplaces except for the US marketplace. This value is required for international returns when ReturnsAcceptedOption=ReturnsAccepted. Depending on the Seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. On EBAY_US: You can set this value to either MoneyBack or MoneyBackOrReplacement. If a seller has the depth of inventory to support an exchange for an identical item, you can set MoneyBackOrReplacement. Otherwise, eBay recommends you set this value to its default value, MoneyBack.
|
|
returnPolicyProfile .internationalReturnPolicyInfo .returnsAcceptedOption |
token | Conditional |
This optional field indicates whether or not the seller accepts international returns (returns that need to be shipped via an international shipping service). Applicable values are ReturnsAccepted or ReturnsNotAccepted. When set to ReturnsAccepted, this option indicates the seller allows international returns. If the seller does not accept international returns, they can specify ReturnsNotAccepted. On the eBay DE, IE, and UK, registered business sellers must accept returns for fixed-price items (including auction items with Buy It Now and any other fixed price formats) when the category requires a return policy. On some European sites, such as eBay Germany (DE), registered business sellers are required to accept returns. Use the Trading call GetUser to determine the status of an eBay business seller in DE, IE, and UK. Review the User.SellerInfo.SellerBusinessType field in the response. |
|
returnPolicyProfile .internationalReturnPolicyInfo .returnsWithinOption |
token | Conditional |
Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. Most marketplaces and categories support 30-day and 60-day return periods. eBay sites often set 30-days as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required for international returns when ReturnsAcceptedOption=ReturnsAccepted. Applicable values: Retrieve the values supported by a marketplace by calling GeteBayDetails with DetailName set to ReturnPolicyDetails, then review ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption in the response.
|
|
returnPolicyProfile .internationalReturnPolicyInfo .shippingCostPaidByOption |
token | Conditional |
This option specifies either the buyer or the seller as the party who pays for return shipping charges for international returns. Accepted values are Buyer or Seller. This value is required for international returns when ReturnsAcceptedOption=ReturnsAccepted. Depending on the Seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues. Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and review the returned ReturnPolicyDetails.ShippingCostPaidBy values to see the values supported by a marketplace. |
|
returnPolicyProfile .profileDesc |
string | Optional |
This field is used by the seller to provide a description of the business policy. The profileDesc field is optional in the addSellerProfile and setSellerProfile calls. This field is only returned for a business policy if a description exists for that policy. Max length: 250. |
|
returnPolicyProfile .profileName |
string | Required | This string value indicates the name of the business policy. This policy name must be unique among all of seller's business policies. A profileName value is required when using the addSellerProfile and setSellerProfile calls. |
|
returnPolicyProfile .profileType |
ProfileType | Required |
This field indicates the type of the business policy. 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 of a specific type.
Applicable values: |
|
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 return policy or modifying an existing return policy. This container is returned by getSellerProfiles if one or more return policies match the input criteria in the call request. |
|
returnPolicyProfile .returnPolicyInfo.description |
string | Optional |
This field contains the seller's detailed explanation for their return policy and is displayed in the Return Policy section of the View Item page. This field is valid in only the following marketplaces (the field is otherwise ignored):
Max length: 5000. |
|
returnPolicyProfile .returnPolicyInfo .holidayReturns |
token | Conditional |
Deprecated as of version v1.1.0. Currently ignored. This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports holiday returns. Deprecation version: v1.1.0. See also Deprecated Objects. |
|
returnPolicyProfile .returnPolicyInfo.refundOption |
token | Conditional |
This field indicates how the seller compensates buyers for remorse returns. You must set this value to MoneyBack for all eBay marketplaces except for the US marketplace. On EBAY_US: You can set this value to either MoneyBack or MoneyBackOrReplacement. If a seller has the depth of inventory to support an exchange for an identical item, you can set MoneyBackOrReplacement. Otherwise, eBay recommends you set this value to its default value, MoneyBack.
|
|
returnPolicyProfile .returnPolicyInfo .restockingFeeValue |
token | Conditional |
Deprecated as of version 1061. Currently ignored. This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports restocking fees for returned items. Deprecation version: 1061. See also Deprecated Objects. |
|
returnPolicyProfile .returnPolicyInfo .returnsAcceptedOption |
token | Conditional |
This required field indicates whether or not the seller accepts returns. Applicable values are ReturnsAccepted or ReturnsNotAccepted. When set to ReturnsAccepted, this option indicates the seller allows items to be returned. Specify ReturnsNotAccepted for an item if the seller does not accept returns. On the eBay DE, IE, and UK, registered business sellers must accept returns for fixed-price items (including auction items with Buy It Now and any other fixed price formats) when the category requires a return policy. On some European sites, such as eBay Germany (DE), registered business sellers are required to accept returns. Use the Trading call GetUser to determine the status of an eBay business seller in DE, IE, and UK. Review the User.SellerInfo.SellerBusinessType field in the response. Note: In order for Top-Rated sellers to receive a Top-Rated Plus seal for their listings, returns must be accepted for their items (returnsAcceptedOption = ReturnsAccepted) and handling time should be set to zero-day (same-day shipping) or one-day shipping. Set the handling time (in days) using the Item.DispatchTimeMax field. Top-Rated listings qualify for the greatest average boost in Best Match and for the 20 percent Final Value Fee discount. For more information on eBay's Top-Rated seller program, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus page. For setSellerProfile: Updating the values in a business profile can effect the profiles in currently-listed items. In most cases, the updates made to a business policy can be streamlined into existing listings. However, if you update a business policy and the policy is invalid in the category where an item is listed, no error will be thrown and the policy will carry through the regular life of the listing. Sellers will be unable to re-list an item if it refers an invalid policy. Also note eBay will not update the policy's of a description if the listing has bids or sales, or if the listing ends within 12 hours. See:
|
|
returnPolicyProfile .returnPolicyInfo .returnsWithinOption |
token | Conditional |
Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. Most marketplaces and categories support 30-day and 60-day return periods. eBay sites often set 30-days as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required if ReturnsAcceptedOption=ReturnsAccepted. Applicable values: Retrieve the values supported by a marketplace by calling GeteBayDetails with DetailName set to ReturnPolicyDetails, then review ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption in the response. Note: In version 1.1.0, the options for this field were reduced. An error will be thrown if you attempt to list an item with invalid business policy settings. See the Release Notes for details. |
|
returnPolicyProfile .returnPolicyInfo .shippingCostPaidByOption |
token | Conditional |
This option specifies either the buyer or the seller as the party who pays for return shipping charges. Accepted values are Buyer or Seller. eBay sites often set Seller as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required if ReturnsAcceptedOption=ReturnsAccepted. Depending on the Seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues. Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and review the returned ReturnPolicyDetails.ShippingCostPaidBy values to see the values supported by a marketplace. |
|
returnPolicyProfile .returnPolicyInfo .warrantyDurationOption |
token | Conditional |
Deprecated as of version 1061. Currently ignored. This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns. See WarrantyDurationOptionsCodeType. Deprecation version: 1061. See also Deprecated Objects. |
|
returnPolicyProfile .returnPolicyInfo .warrantyOfferedOption |
token | Conditional |
Deprecated as of version 1.0.0. Currently ignored. This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns. Deprecation version: 1.0.0. See also Deprecated Objects. |
|
returnPolicyProfile .returnPolicyInfo .warrantyTypeOption |
token | Conditional |
Deprecated as of version 1061. Currently ignored. This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns. See WarrantyTypeOptionsCodeType. Deprecation version: 1061. See also Deprecated Objects. |
| 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. |
| shippingPolicyProfile | ShippingPolicyProfile (SellerProfile) | Conditional |
Root container for a seller's shipping policy. The shippingPolicyProfile container consists of shipping information, the name and description of the policy, and the site and category group(s) to which the shipping policy will be applied. The shippingPolicyProfile container is conditionally required if the seller wants to create a new shipping policy. |
|
shippingPolicyProfile .categoryGroups |
CategoryGroups | Required | This container consists of one or more categoryGroup containers. One or more category groups are linked to each business policy. |
|
shippingPolicyProfile .categoryGroups.categoryGroup |
CategoryGroup | Required,
repeatable: [1..*] |
This container indicates the category group to which the payment policy, return policy, or shipping policy applies to. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). The 'MOTORS_VEHICLE' category group is not valid for return policies, as return policies cannot be used with motor vehicle listings. These enumeration values are case-sensitive. Each business policy can be associated with more than one category group. |
|
shippingPolicyProfile .categoryGroups.categoryGroup .default |
boolean | Optional |
Deprecated as of version v1.1.0. Currently ignored. Important: This field has been deprecated and is no longer used. Do not include this field in any add or set call. This field may be returned within the payload of a get call, but it can be ignored.
|
|
shippingPolicyProfile .categoryGroups.categoryGroup .name |
string | Required | This string value indicates the name of the category group to which the corresponding business policy 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. The 'MOTORS_VEHICLE' category group is not valid for return business policies, as return business policies cannot be used with motor vehicle listings. |
|
shippingPolicyProfile .forceDuplicate |
boolean | Required | This value is for future use. |
|
shippingPolicyProfile .profileDesc |
string | Optional |
This field is used by the seller to provide a description of the business policy. The profileDesc field is optional in the addSellerProfile and setSellerProfile calls. This field is only returned for a business policy if a description exists for that policy. Max length: 250. |
|
shippingPolicyProfile .profileName |
string | Required | This string value indicates the name of the business policy. This policy name must be unique among all of seller's business policies. A profileName value is required when using the addSellerProfile and setSellerProfile calls. |
|
shippingPolicyProfile .profileType |
ProfileType | Required |
This field indicates the type of the business policy. 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 of a specific type.
Applicable values: |
|
shippingPolicyProfile .shippingPolicyInfo |
ShippingPolicyInfo | Conditional |
This container consists of detailed shipping information for a seller's shipping policy. This container is conditionally required if the caller is creating a new shipping policy or modifying an existing shipping policy. This container is returned by getSellerProfiles if one or more shipping policies 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 same-day or one-day handling for a listing in order for that listing to receive a Top Rated Plus seal on the View Item or Search Results. To offer zero-day or one-day handling, the seller should include the dispatchTimeMax field in the shipping business policy and set the value of this field to '0' or '1', respectively. The dispatchTimeMax field must be included in the shipping policy and set to '0' or '1' if the fastShipping flag is included and set to 'true' in the shipping policy. 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, with the onboarding of same-day shipping, a DispatchTimeMax value of '0' will indicate that the seller is offering same-day shipping. Now, sellers that do not want to specify a handling time for their shipping policy, should omit the dispatchTimeMax field, or they can include it but set it to null. This field is always returned with all shipping policies 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 policy, this field is returned with shipping policies 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 policy, this field is returned with shipping policies 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 business policy. Each specified domestic shipping service is returned with shipping policies 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 policy, this field is returned with shipping policies 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 policy, this field is returned with shipping policies 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 policy, this field is returned in the shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. |
|
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .fastShipping |
boolean | Conditional |
This flag indicates whether or not the seller is offering 'Get It Fast' shipping 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' shipping for a listing, the seller must:
If 'Get It Fast' shipping is set for a domestic shipping service, this field is returned in the shipping policies 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 business policies 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, thatspecific 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 policy (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 policy is returned with shipping policies 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 policy, this field is returned with shipping policies 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 policies 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:
|
|
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 policy, 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 policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. |
|
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 policies 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 policy. 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 policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Default: Flat. See Shipping. |
|
shippingPolicyProfile .shippingPolicyInfo .EligibleForPickupDropOff |
boolean | Optional |
This field is used in Add/Revise/Relist calls to enable the listing for the "Click and Collect" feature. To enable the listing for the "Click and Collect" feature, the seller includes this boolean field and sets its value to 'true'. A seller must be eligible for the "Click and Collect" feature to list an item that is eligible for "Click and Collect". At this time, the "Click and Collect" feature is only available to large retail merchants on the eBay UK site (site ID 3). In addition to setting the EligibleForPickupDropOff boolean field to 'true', the merchant must also perform the following actions in an Add/Revise/Relist call to enable the "Click and Collect" option on a listing:
|
|
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 scan 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. 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 policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. |
|
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 policy if the seller offers freight shipping (domesticShippingType and/or intlShippingType is set to 'FreightFlat'). If freight shipping is specified for a shipping policy, this container is returned with shipping policies 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:
|
|
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 .GlobalShipping |
boolean | Optional |
Note: On the US marketplace, the Global Shipping Program is scheduled to be replaced by a new intermediated international shipping program called eBay International Shipping. US Sellers opted in to the Global Shipping Program will automatically get opted into eBay International Shipping once it becomes available to them. All US sellers will be migrated by March 31, 2023. eBay International Shipping is an account level setting, and no field will need to be set in a Fulfillment business policy to enable this setting. As long as the US seller's account is opted in to eBay International Shipping, this shipping option will be automatically enabled for all listings where international shipping is available. Even if the US seller is opted into eBay International Shipping, that same seller can still also specify individual international shipping service options for a Fulfillment business policy. This flag should be included and set to 'true' if the seller wants to enable the Global Shipping Program feature in the shipping policy. If the value of globalShipping is 'true', the Global Shipping Program is the default international shipping option for the listing, and eBay sets the international shipping service to International Priority Shipping. If the value of GlobalShipping is 'false', the seller is responsible for specifying one or more international shipping services for the listing (if the seller wishes to ship internationally). To make use of this field and the Global Shipping Program, the seller and the item being listed must be eligible for the Global Shipping Program. |
|
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 policy 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 policy, this container is returned with shipping policies 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:
|
|
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:
|
|
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 policy, this field is returned with shipping policies 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 policy (Germany and UK only), this field is returned with shipping policies 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 policy. Each specified international shipping service is returned with shipping policies 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 policy, this field is returned with shipping policies 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 policy, this field is returned with shipping policies 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 policy, this field is returned in the shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. |
|
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .fastShipping |
boolean | Conditional |
This flag indicates whether or not the seller is offering 'Get It Fast' shipping 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' shipping for a listing, the seller must:
If 'Get It Fast' shipping is set for a domestic shipping service, this field is returned in the shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. |
|
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .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 business policies 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, thatspecific 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 policy (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 policy is returned with shipping policies 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 policy, this field is returned with shipping policies 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 policies 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:
|
|
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 policy, 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 policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. |
|
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 policies 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 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 policy. 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 policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Default: Flat. |
|
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 policy, this field is returned with shipping policies 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:
|
|
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 policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Applicable values: See shippingPolicyCurrency. |
|
shippingPolicyProfile .shippingPolicyInfo .shippingPolicyName |
string | Required |
This string value indicates the name of the shipping policy. This business policy name must be unique among all of seller's shipping policies. A shippingPolicyName value is required when using the addSellerProfile and setSellerProfile calls to create or update a shipping policy. This field is always returned with all shipping policies 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 policy, this container is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See:
|
|
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:
|
|
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:
|
|
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 policy. Shipping discount profiles are not applicable when Freight shipping is used. See:
|
|
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 policy. Shipping discount profiles are not applicable when Freight shipping is used. See:
|
|
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 policy in the addSellerProfile, setSellerProfile, and getSellerProfiles calls. If the seller does want to offer international shipping as part of the shipping policy, 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 policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. |
| 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. |
| Standard Input Fields |
| extension | ExtensionType | Optional,
repeatable: [0..*] |
Reserved for future use. |
| Input Samples Change History |
Output
See also Samples.
The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).
<?xml version="1.0" encoding="utf-8"?> <addSellerProfileResponse xmlns="http://www.ebay.com/marketplace/selling"> <!-- Call-specific Output Fields --> <paymentProfile> PaymentProfile (SellerProfile) <categoryGroups> CategoryGroups <categoryGroup> CategoryGroup <default> boolean </default> <ETRS> boolean </ETRS> <name> string </name> </categoryGroup> <!-- ... more categoryGroup nodes allowed here ... --> </categoryGroups> <forceDuplicate> boolean </forceDuplicate> <paymentInfo> PaymentInfo <acceptedPaymentMethod> token </acceptedPaymentMethod> <!-- ... more acceptedPaymentMethod values allowed here ... --> <daysToFullPayment> int </daysToFullPayment> <!-- ... more daysToFullPayment values allowed here ... --> <depositDetails> DepositDetails <daysToFullPayment> int </daysToFullPayment> <!-- ... more daysToFullPayment values allowed here ... --> <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> <ETRS> boolean </ETRS> <name> string </name> </categoryGroup> <!-- ... more categoryGroup nodes allowed here ... --> </categoryGroups> <forceDuplicate> boolean </forceDuplicate> <internationalReturnPolicyInfo> InternationalReturnPolicyInfo <refundOption> token </refundOption> <returnsAcceptedOption> token </returnsAcceptedOption> <returnsWithinOption> token </returnsWithinOption> <shippingCostPaidByOption> token </shippingCostPaidByOption> </internationalReturnPolicyInfo> <profileDesc> string </profileDesc> <profileId> long </profileId> <profileName> string </profileName> <profileType> ProfileType </profileType> <returnPolicyInfo> ReturnPolicyInfo <description> string </description> <holidayReturns> token </holidayReturns> <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> <ETRS> boolean </ETRS> <name> string </name> </categoryGroup> <!-- ... more categoryGroup nodes allowed here ... --> </categoryGroups> <forceDuplicate> boolean </forceDuplicate> <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> <EligibleForPickupDropOff> boolean </EligibleForPickupDropOff> <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> <GlobalShipping> boolean </GlobalShipping> <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> <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> </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> </addSellerProfileResponse>
| Return Value | Type | Occurrence | Meaning |
|---|
| Call-specific Output Fields [Jump to standard fields] |
| paymentProfile | PaymentProfile (SellerProfile) | Conditionally |
Root container for a seller's payment policy. The paymentProfile container consists of payment information, the name and description of the policy, and the site and category group to which the payment policy will be applied. The paymentProfile container is only returned if the seller created a payment policy in the addSellerProfile request. |
| paymentProfile.categoryGroups | CategoryGroups | Always | This container consists of one or more categoryGroup containers. One or more category groups are linked to each business policy. |
|
paymentProfile.categoryGroups .categoryGroup |
CategoryGroup | Always,
repeatable: [1..*] |
This container indicates the category group to which the payment policy, return policy, or shipping policy applies to. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). The 'MOTORS_VEHICLE' category group is not valid for return policies, as return policies cannot be used with motor vehicle listings. These enumeration values are case-sensitive. Each business policy can be associated with more than one category group. |
|
paymentProfile.categoryGroups .categoryGroup.default |
boolean | Conditionally |
Deprecated as of version v1.1.0. No longer functional. Important: This field has been deprecated and is no longer used. Do not include this field in any add or set call. This field may be returned within the payload of a get call, but it can be ignored.
|
|
paymentProfile.categoryGroups .categoryGroup.ETRS |
boolean | Conditionally | This flag is returned as 'true' if the corresponding business policy meets all eBay Top-Rated Listing requirements for the category group. To qualify as an ETRS business policy, the seller must meet Top-Rated Seller requirements, and the business policy must include a 14-day (or longer) money back return policy and same-day or one-day handling. For more information on Top-Rated Seller and Top-Rated Plus listings, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus help topic. |
|
paymentProfile.categoryGroups .categoryGroup.name |
string | Always | This string value indicates the name of the category group to which the corresponding business policy 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. The 'MOTORS_VEHICLE' category group is not valid for return business policies, as return business policies cannot be used with motor vehicle listings. |
| paymentProfile.forceDuplicate | boolean | Always | This value is for future use. |
| paymentProfile.paymentInfo | PaymentInfo | Conditionally |
This container consists of detailed payment information for a seller's payment policy. This container is conditionally required if the caller is creating a new payment policy or modifying an existing payment policy. This container is returned by getSellerProfiles if one or more payment policies match the input criteria in the call request, and is returned in the response of addSellerProfile or setSellerProfile if a payment policy is being created or modified, respectively. |
|
paymentProfile.paymentInfo .acceptedPaymentMethod |
token | Conditionally,
repeatable: [0..*] |
Note:This field applies only when the seller needs to specify one or more offline payment methods. eBay now manages the electronic payment options available to buyers to pay for the item. This field specifys one or more offline payment methods that will be accepted for payment that occurs off of eBay's platform. If you specify multiple acceptedPaymentMethod 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. 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:
|
|
paymentProfile.paymentInfo .daysToFullPayment |
int | Conditionally,
repeatable: [14..3] |
This integer value indicates the number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. This container must be specified for motor vehicles listings. Valid values are '3', '7' (default), '10', and '14'. In order for a buyer to make a full payment on a US or CA motor vehicle, at least one of the following acceptedPaymentMethod values must be specified for the corresponding payment business policy:
Default: 7. |
|
paymentProfile.paymentInfo .depositDetails |
DepositDetails | Conditionally | This value indicates the initial deposit amount required from the buyer in order to purchase a motor vehicle. This value can be as high as $2,000.00 if immediate payment is not required, and up to $500.00 if immediate payment is required. This container is only applicable if the categoryGroup.namefield is set to 'MOTORS_VEHICLE'. |
|
paymentProfile.paymentInfo .depositDetails .daysToFullPayment |
int | Conditionally,
repeatable: [14..3] |
This integer value indicates the number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. This container must be specified for motor vehicles listings. Valid values are '3', '7' (default), '10', and '14'. In order for a buyer to make a full payment on a US or CA motor vehicle, at least one of the following acceptedPaymentMethod values must be specified for the corresponding payment policy:
Default: 7. |
|
paymentProfile.paymentInfo .depositDetails.depositAmount |
Amount (double) | Conditionally |
This value indicates the initial deposit amount required from the buyer in order to purchase a motor vehicle. This value can be as high as $2,000.00 if immediate payment is not required, and up to $500.00 if immediate payment is required. This container is only applicable if the categoryGroup.namefield is set to 'MOTORS_VEHICLE'. If not specified, this value defaults to '0.0'. If this value is specified, the seller must also specify an hoursToDeposit value. The deposit amount appears in the shipping, payment details and return policy sections of the View Item page. Min: 0.0. Max: 2000.0. Default: 0.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 an initial 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. Note: The hoursToDeposit value is overridden if the seller has set the motor vehicle listing to require immediate payment. If the listing requires immediate payment, the buyer must pay the deposit immediately in order to be eligible to purchase the motor vehicle. Min: 24. Max: 72. Default: 48. |
|
paymentProfile.paymentInfo .immediatePay |
boolean | Conditionally |
This field should be included and set to true if the seller wants to require immediate payment from the buyer for:
Note: 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 policy) an immediate payment requirement.
Default: false. |
|
paymentProfile.paymentInfo .paymentInstructions |
string | Conditionally |
Deprecated as of version v1.1.0. No longer functional. Important: DO NOT USE THIS FIELD. Payment instructions are no longer supported by payment business policies. 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 pages. This field allows 1000 characters. It is recommended that the seller use this field for motor vehicles (eBay Motors US and CA) payment policies to clarify the specifics on the deposit (if required), pickup/delivery arrangements, and full payment details on the vehicle. Max length: 1000. Deprecation version: v1.1.0. See also Deprecated Objects. |
|
paymentProfile.paymentInfo .paypalEmailAddress |
token | Conditionally |
Deprecated as of version v1.1.0. No longer functional. Important: This field is deprecated. Do not use this field. Deprecation version: v1.1.0. See also Deprecated Objects. |
| paymentProfile.profileDesc | string | Conditionally |
This field is used by the seller to provide a description of the business policy. The profileDesc field is optional in the addSellerProfile and setSellerProfile calls. This field is only returned for a business policy if a description exists for that policy. Max length: 250. |
| paymentProfile.profileId | long | Always |
The unique identifier of a business policy. This value is created by eBay when a business policy is created (on the site or through the 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 policy 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 policy was successfully created. |
| paymentProfile.profileName | string | Always | This string value indicates the name of the business policy. This policy name must be unique among all of seller's business policies. A profileName value is required when using the addSellerProfile and setSellerProfile calls. |
| paymentProfile.profileType | ProfileType | Always |
This field indicates the type of the business policy. 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 of a specific type.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
| 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. |
| returnPolicyProfile | ReturnPolicyProfile (SellerProfile) | Conditionally |
Root container for a seller's return policy. The returnPolicyProfile container consists of return policy information, the name and description of the policy, and the site and category group to which the return policy will be applied. The returnPolicyProfile container is only returned if the seller created a return policy in the addSellerProfile request. |
|
returnPolicyProfile .categoryGroups |
CategoryGroups | Always | This container consists of one or more categoryGroup containers. One or more category groups are linked to each business policy. |
|
returnPolicyProfile .categoryGroups.categoryGroup |
CategoryGroup | Always,
repeatable: [1..*] |
This container indicates the category group to which the payment policy, return policy, or shipping policy applies to. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). The 'MOTORS_VEHICLE' category group is not valid for return policies, as return policies cannot be used with motor vehicle listings. These enumeration values are case-sensitive. Each business policy can be associated with more than one category group. |
|
returnPolicyProfile .categoryGroups.categoryGroup .default |
boolean | Conditionally |
Deprecated as of version v1.1.0. No longer functional. Important: This field has been deprecated and is no longer used. Do not include this field in any add or set call. This field may be returned within the payload of a get call, but it can be ignored.
|
|
returnPolicyProfile .categoryGroups.categoryGroup .ETRS |
boolean | Conditionally | This flag is returned as 'true' if the corresponding business policy meets all eBay Top-Rated Listing requirements for the category group. To qualify as an ETRS business policy, the seller must meet Top-Rated Seller requirements, and the business policy must include a 14-day (or longer) money back return policy and same-day or one-day handling. For more information on Top-Rated Seller and Top-Rated Plus listings, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus help topic. |
|
returnPolicyProfile .categoryGroups.categoryGroup .name |
string | Always | This string value indicates the name of the category group to which the corresponding business policy 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. The 'MOTORS_VEHICLE' category group is not valid for return business policies, as return business policies cannot be used with motor vehicle listings. |
|
returnPolicyProfile .forceDuplicate |
boolean | Always | This value is for future use. |
|
returnPolicyProfile .internationalReturnPolicyInfo |
InternationalReturnPolicyInfo | Conditionally |
This container consists of detailed information on a seller's international return policy (returns that require an international shipping service to ship). This container is optional and allows for a seller to establish an international return policy that differs from their domestic return policy. This container is returned by getSellerProfiles if one or more return policies match the input criteria in the call request. |
|
returnPolicyProfile .internationalReturnPolicyInfo .refundOption |
token | Conditionally |
This field indicates how the seller compensates buyers for remorse returns. You must set this value to MoneyBack for all eBay marketplaces except for the US marketplace. This value is required for international returns when ReturnsAcceptedOption=ReturnsAccepted. Depending on the Seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. On EBAY_US: You can set this value to either MoneyBack or MoneyBackOrReplacement. If a seller has the depth of inventory to support an exchange for an identical item, you can set MoneyBackOrReplacement. Otherwise, eBay recommends you set this value to its default value, MoneyBack.
|
|
returnPolicyProfile .internationalReturnPolicyInfo .returnsAcceptedOption |
token | Conditionally |
This optional field indicates whether or not the seller accepts international returns (returns that need to be shipped via an international shipping service). Applicable values are ReturnsAccepted or ReturnsNotAccepted. When set to ReturnsAccepted, this option indicates the seller allows international returns. If the seller does not accept international returns, they can specify ReturnsNotAccepted. On the eBay DE, IE, and UK, registered business sellers must accept returns for fixed-price items (including auction items with Buy It Now and any other fixed price formats) when the category requires a return policy. On some European sites, such as eBay Germany (DE), registered business sellers are required to accept returns. Use the Trading call GetUser to determine the status of an eBay business seller in DE, IE, and UK. Review the User.SellerInfo.SellerBusinessType field in the response. |
|
returnPolicyProfile .internationalReturnPolicyInfo .returnsWithinOption |
token | Conditionally |
Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. Most marketplaces and categories support 30-day and 60-day return periods. eBay sites often set 30-days as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required for international returns when ReturnsAcceptedOption=ReturnsAccepted. Applicable values: Retrieve the values supported by a marketplace by calling GeteBayDetails with DetailName set to ReturnPolicyDetails, then review ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption in the response.
|
|
returnPolicyProfile .internationalReturnPolicyInfo .shippingCostPaidByOption |
token | Conditionally |
This option specifies either the buyer or the seller as the party who pays for return shipping charges for international returns. Accepted values are Buyer or Seller. This value is required for international returns when ReturnsAcceptedOption=ReturnsAccepted. Depending on the Seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues. Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and review the returned ReturnPolicyDetails.ShippingCostPaidBy values to see the values supported by a marketplace. |
|
returnPolicyProfile .profileDesc |
string | Conditionally |
This field is used by the seller to provide a description of the business policy. The profileDesc field is optional in the addSellerProfile and setSellerProfile calls. This field is only returned for a business policy if a description exists for that policy. Max length: 250. |
| returnPolicyProfile.profileId | long | Always |
The unique identifier of a business policy. This value is created by eBay when a business policy is created (on the site or through the 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 policy 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 policy was successfully created. |
|
returnPolicyProfile .profileName |
string | Always | This string value indicates the name of the business policy. This policy name must be unique among all of seller's business policies. A profileName value is required when using the addSellerProfile and setSellerProfile calls. |
|
returnPolicyProfile .profileType |
ProfileType | Always |
This field indicates the type of the business policy. 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 of a specific type.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
|
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 return policy or modifying an existing return policy. This container is returned by getSellerProfiles if one or more return policies match the input criteria in the call request. |
|
returnPolicyProfile .returnPolicyInfo.description |
string | Conditionally |
This field contains the seller's detailed explanation for their return policy and is displayed in the Return Policy section of the View Item page. This field is valid in only the following marketplaces (the field is otherwise ignored):
Max length: 5000. |
|
returnPolicyProfile .returnPolicyInfo .holidayReturns |
token | Conditionally |
Deprecated as of version 1061. No longer functional. This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports holiday returns. Deprecation version: 1061. See also Deprecated Objects. |
|
returnPolicyProfile .returnPolicyInfo.refundOption |
token | Conditionally |
This field indicates how the seller compensates buyers for remorse returns. You must set this value to MoneyBack for all eBay marketplaces except for the US marketplace. On EBAY_US: You can set this value to either MoneyBack or MoneyBackOrReplacement. If a seller has the depth of inventory to support an exchange for an identical item, you can set MoneyBackOrReplacement. Otherwise, eBay recommends you set this value to its default value, MoneyBack.
|
|
returnPolicyProfile .returnPolicyInfo .restockingFeeValue |
token | Conditionally |
Deprecated as of version 1061. No longer functional. This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports restocking fees for returned items. Deprecation version: 1061. See also Deprecated Objects. |
|
returnPolicyProfile .returnPolicyInfo .returnsAcceptedOption |
token | Conditionally |
This required field indicates whether or not the seller accepts returns. Applicable values are ReturnsAccepted or ReturnsNotAccepted. When set to ReturnsAccepted, this option indicates the seller allows items to be returned. Specify ReturnsNotAccepted for an item if the seller does not accept returns. On the eBay DE, IE, and UK, registered business sellers must accept returns for fixed-price items (including auction items with Buy It Now and any other fixed price formats) when the category requires a return policy. On some European sites, such as eBay Germany (DE), registered business sellers are required to accept returns. Use the Trading call GetUser to determine the status of an eBay business seller in DE, IE, and UK. Review the User.SellerInfo.SellerBusinessType field in the response. Note: In order for Top-Rated sellers to receive a Top-Rated Plus seal for their listings, returns must be accepted for their items (returnsAcceptedOption = ReturnsAccepted) and handling time should be set to zero-day (same-day shipping) or one-day shipping. Set the handling time (in days) using the Item.DispatchTimeMax field. Top-Rated listings qualify for the greatest average boost in Best Match and for the 20 percent Final Value Fee discount. For more information on eBay's Top-Rated seller program, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus page. For setSellerProfile: Updating the values in a business profile can effect the profiles in currently-listed items. In most cases, the updates made to a business policy can be streamlined into existing listings. However, if you update a business policy and the policy is invalid in the category where an item is listed, no error will be thrown and the policy will carry through the regular life of the listing. Sellers will be unable to re-list an item if it refers an invalid policy. Also note eBay will not update the policy's of a description if the listing has bids or sales, or if the listing ends within 12 hours. See:
|
|
returnPolicyProfile .returnPolicyInfo .returnsWithinOption |
token | Conditionally |
Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. Most marketplaces and categories support 30-day and 60-day return periods. eBay sites often set 30-days as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required if ReturnsAcceptedOption=ReturnsAccepted. Applicable values: Retrieve the values supported by a marketplace by calling GeteBayDetails with DetailName set to ReturnPolicyDetails, then review ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption in the response. Note: In version 1.1.0, the options for this field were reduced. An error will be thrown if you attempt to list an item with invalid business policy settings. See the Release Notes for details. |
|
returnPolicyProfile .returnPolicyInfo .shippingCostPaidByOption |
token | Conditionally |
This option specifies either the buyer or the seller as the party who pays for return shipping charges. Accepted values are Buyer or Seller. eBay sites often set Seller as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required if ReturnsAcceptedOption=ReturnsAccepted. Depending on the Seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues. Use GeteBayDetails (with DetailName=ReturnPolicyDetails) and review the returned ReturnPolicyDetails.ShippingCostPaidBy values to see the values supported by a marketplace. |
|
returnPolicyProfile .returnPolicyInfo .warrantyDurationOption |
token | Conditionally |
Deprecated as of version 1061. No longer functional. This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns. See WarrantyDurationOptionsCodeType. Deprecation version: 1061. See also Deprecated Objects. |
|
returnPolicyProfile .returnPolicyInfo .warrantyOfferedOption |
token | Conditionally |
Deprecated as of version 1.0.0. No longer functional. This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns. Deprecation version: 1.0.0. See also Deprecated Objects. |
|
returnPolicyProfile .returnPolicyInfo .warrantyTypeOption |
token | Conditionally |
Deprecated as of version 1061. No longer functional. This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports warranty policies for returns. See WarrantyTypeOptionsCodeType. Deprecation version: 1061. See also Deprecated Objects. |
| 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. |
| shippingPolicyProfile | ShippingPolicyProfile (SellerProfile) | Conditionally |
Root container for a seller's shipping policy. The shippingPolicyProfile container consists of shipping information, the name and description of the policy, and the site and category group to which the shipping policy will be applied. The shippingPolicyProfile container is only returned if the seller created a shipping policy in the addSellerProfile request. |
|
shippingPolicyProfile .categoryGroups |
CategoryGroups | Always | This container consists of one or more categoryGroup containers. One or more category groups are linked to each business policy. |
|
shippingPolicyProfile .categoryGroups.categoryGroup |
CategoryGroup | Always,
repeatable: [1..*] |
This container indicates the category group to which the payment policy, return policy, or shipping policy applies to. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). The 'MOTORS_VEHICLE' category group is not valid for return policies, as return policies cannot be used with motor vehicle listings. These enumeration values are case-sensitive. Each business policy can be associated with more than one category group. |
|
shippingPolicyProfile .categoryGroups.categoryGroup .default |
boolean | Conditionally |
Deprecated as of version v1.1.0. No longer functional. Important: This field has been deprecated and is no longer used. Do not include this field in any add or set call. This field may be returned within the payload of a get call, but it can be ignored.
|
|
shippingPolicyProfile .categoryGroups.categoryGroup .ETRS |
boolean | Conditionally | This flag is returned as 'true' if the corresponding business policy meets all eBay Top-Rated Listing requirements for the category group. To qualify as an ETRS business policy, the seller must meet Top-Rated Seller requirements, and the business policy must include a 14-day (or longer) money back return policy and same-day or one-day handling. For more information on Top-Rated Seller and Top-Rated Plus listings, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus help topic. |
|
shippingPolicyProfile .categoryGroups.categoryGroup .name |
string | Always | This string value indicates the name of the category group to which the corresponding business policy 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. The 'MOTORS_VEHICLE' category group is not valid for return business policies, as return business policies cannot be used with motor vehicle listings. |
|
shippingPolicyProfile .forceDuplicate |
boolean | Always | This value is for future use. |
|
shippingPolicyProfile .profileDesc |
string | Conditionally |
This field is used by the seller to provide a description of the business policy. The profileDesc field is optional in the addSellerProfile and setSellerProfile calls. This field is only returned for a business policy if a description exists for that policy. Max length: 250. |
|
shippingPolicyProfile .profileId |
long | Always |
The unique identifier of a business policy. This value is created by eBay when a business policy is created (on the site or through the 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 policy 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 policy was successfully created. |
|
shippingPolicyProfile .profileName |
string | Always | This string value indicates the name of the business policy. This policy name must be unique among all of seller's business policies. A profileName value is required when using the addSellerProfile and setSellerProfile calls. |
|
shippingPolicyProfile .profileType |
ProfileType | Always |
This field indicates the type of the business policy. 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 of a specific type.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
|
shippingPolicyProfile .shippingPolicyInfo |
ShippingPolicyInfo | Conditionally |
This container consists of detailed shipping information for a seller's shipping policy. This container is conditionally required if the caller is creating a new shipping policy or modifying an existing shipping policy. This container is returned by getSellerProfiles if one or more shipping policies 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 same-day or one-day handling for a listing in order for that listing to receive a Top Rated Plus seal on the View Item or Search Results. To offer zero-day or one-day handling, the seller should include the dispatchTimeMax field in the shipping business policy and set the value of this field to '0' or '1', respectively. The dispatchTimeMax field must be included in the shipping policy and set to '0' or '1' if the fastShipping flag is included and set to 'true' in the shipping policy. 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, with the onboarding of same-day shipping, a DispatchTimeMax value of '0' will indicate that the seller is offering same-day shipping. Now, sellers that do not want to specify a handling time for their shipping policy, should omit the dispatchTimeMax field, or they can include it but set it to null. This field is always returned with all shipping policies 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 policy, this field is returned with shipping policies 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 policy, this field is returned with shipping policies 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 business policy. Each specified domestic shipping service is returned with shipping policies 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 policy, this field is returned with shipping policies 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 policy, this field is returned with shipping policies 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 policy, this field is returned in the shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. |
|
shippingPolicyProfile .shippingPolicyInfo .domesticShippingPolicyInfoService .fastShipping |
boolean | Conditionally |
This flag indicates whether or not the seller is offering 'Get It Fast' shipping 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' shipping for a listing, the seller must:
If 'Get It Fast' shipping is set for a domestic shipping service, this field is returned in the shipping policies 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 business policies 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, thatspecific 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 policy (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 policy is returned with shipping policies 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 policy, this field is returned with shipping policies 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 policies 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:
|
|
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 policy, 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 policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. |
|
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 policies 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 policy. 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 policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See Shipping. |
|
shippingPolicyProfile .shippingPolicyInfo .EligibleForPickupDropOff |
boolean | Always |
This field is used in Add/Revise/Relist calls to enable the listing for the "Click and Collect" feature. To enable the listing for the "Click and Collect" feature, the seller includes this boolean field and sets its value to 'true'. A seller must be eligible for the "Click and Collect" feature to list an item that is eligible for "Click and Collect". At this time, the "Click and Collect" feature is only available to large retail merchants on the eBay UK site (site ID 3). In addition to setting the EligibleForPickupDropOff boolean field to 'true', the merchant must also perform the following actions in an Add/Revise/Relist call to enable the "Click and Collect" option on a listing:
|
|
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 scan 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. 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 policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. |
|
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 policy if the seller offers freight shipping (domesticShippingType and/or intlShippingType is set to 'FreightFlat'). If freight shipping is specified for a shipping policy, this container is returned with shipping policies 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:
|
|
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 .GlobalShipping |
boolean | Always |
Note: On the US marketplace, the Global Shipping Program is scheduled to be replaced by a new intermediated international shipping program called eBay International Shipping. US Sellers opted in to the Global Shipping Program will automatically get opted into eBay International Shipping once it becomes available to them. All US sellers will be migrated by March 31, 2023. eBay International Shipping is an account level setting, and no field will need to be set in a Fulfillment business policy to enable this setting. As long as the US seller's account is opted in to eBay International Shipping, this shipping option will be automatically enabled for all listings where international shipping is available. Even if the US seller is opted into eBay International Shipping, that same seller can still also specify individual international shipping service options for a Fulfillment business policy. This flag should be included and set to 'true' if the seller wants to enable the Global Shipping Program feature in the shipping policy. If the value of globalShipping is 'true', the Global Shipping Program is the default international shipping option for the listing, and eBay sets the international shipping service to International Priority Shipping. If the value of GlobalShipping is 'false', the seller is responsible for specifying one or more international shipping services for the listing (if the seller wishes to ship internationally). To make use of this field and the Global Shipping Program, the seller and the item being listed must be eligible for the Global Shipping Program. |
|
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 policy 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 policy, this container is returned with shipping policies 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:
|
|
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:
|
|
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 policy, this field is returned with shipping policies 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 policy (Germany and UK only), this field is returned with shipping policies 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 policy. Each specified international shipping service is returned with shipping policies 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 policy, this field is returned with shipping policies 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 policy, this field is returned with shipping policies 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 policy, this field is returned in the shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. |
|
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .fastShipping |
boolean | Conditionally |
This flag indicates whether or not the seller is offering 'Get It Fast' shipping 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' shipping for a listing, the seller must:
If 'Get It Fast' shipping is set for a domestic shipping service, this field is returned in the shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. |
|
shippingPolicyProfile .shippingPolicyInfo .intlShippingPolicyInfoService .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 business policies 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, thatspecific 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 policy (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 policy is returned with shipping policies 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 policy, this field is returned with shipping policies 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 policies 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:
|
|
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 policy, 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 policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. |
|
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 policies 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 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 policy. 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 policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. |
|
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 policy, this field is returned with shipping policies 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:
|
|
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 policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. Applicable values: See shippingPolicyCurrency. Code so that your app gracefully handles any future changes to this list. |
|
shippingPolicyProfile .shippingPolicyInfo .shippingPolicyName |
string | Conditionally |
This string value indicates the name of the shipping policy. This business policy name must be unique among all of seller's shipping policies. A shippingPolicyName value is required when using the addSellerProfile and setSellerProfile calls to create or update a shipping policy. This field is always returned with all shipping policies 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 policy, this container is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. See:
|
|
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:
|
|
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:
|
|
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 policy. Shipping discount profiles are not applicable when Freight shipping is used. See:
|
|
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 policy. Shipping discount profiles are not applicable when Freight shipping is used. See:
|
|
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 policy in the addSellerProfile, setSellerProfile, and getSellerProfiles calls. If the seller does want to offer international shipping as part of the shipping policy, 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 policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls. |
| 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. |
| Standard Output Fields |
| ack | AckValue | Always |
A token representing the application-level acknowledgment code that indicates the response status, such as success. The AckValue list specifies the possible values for ack.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
| 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: Code so that your app gracefully handles any future changes to this list. |
| 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 | 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.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, resend 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: Code so that your app gracefully handles any future changes to this list. |
| 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). |
| version | string | Always | The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. |
| Input Output Change History |
Samples
New to making API calls? Please see Making a Call.
Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.
Sample: Basic Call
Allows a seller to add profiles for their business policies. The types of profiles can be created are PAYMENT, RETURN_POLICY, and SHIPPING.
Description
A seller wants to add a payment policy and returns policy for their business, the Fruit Folks. The seller will only accept Visa, Mastercard, or PayPal as payment. Also the seller wants to set both of these policies as the default policy to apply when creating a listing for an item.
Input
To create the payment policy in this example, the seller must set the following request parameters:
- This payment policy is the default policy that will apply to a listing when it has not been assigned a payment policy (categoryGroup, default=true, name=ALL).
- The name of the profile for this payment policy is G********** - Payment Policy US (profileName=G********** - Payment Policy US).
- The description of the profile (profileDesc=Lists payment options for fresh fruit purchases).
- An accepted method of payment is Visa or Mastercard(acceptedPaymentMethod=VisaMC).
- An accepted method of payment is PayPal (acceptedPaymentMethod=PayPal).
- For PayPal only, the money owed must be paid immediately by the buyer (immediatePay=true)
- For Visa or Mastercard only, buyer must provide security code from credit card (paymentInstructions=For Visa or Mastercard, pleaes include your security code)
- For PayPal only, buyer must supply a valid email address that PayPal evaluates (paypalEmailAddress=s*****@u******.**.****.com)
- Seller must receive payment within 3 days or the order is cancelled (daysToFullPayment=3).
- The buyer has 5 hours to make sure that enough funds exist in their PayPal account(hoursToDeposit=5).
To create the returns policy in this example, the seller must set the following request parameters:
- This specific company policy is described as a United States only policy(profileName=G********** - Returns Policy US)
- The type of policy created is a returns policy (profileType=RETURN_POLICY)
- The details of the policy are described at a high-level(profileDesc=Lists terms for returned fruit)
- This policy applies to the United States eBay site (siteId=0).
- This return policy is the default policy that will apply to all listings that are non-motor vehicle category, and when a listing has not been assigned a payment policy (categoryGroup,default=true, name=ALL).
- The seller does accept returns(returnsAcceptedOption=ReturnsAccepted.
- The cost of returning the defective product will be borne by the seller(shippingCostPaidByOption=Seller).
- There is no warranty on the product(warrantyOfferedOption=None).
- If the buyer is not satisfied with the product, they must return the product within 3 days(returnsWithinOption=Days_3).
- The seller is willing to exchange the defective product for a new product.(refundOption=Exchange).
- There is no restocking fee involved with this purchase (restockingFeeValue=NoRestockingFee).
XML format.
<xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.ebay.com/marketplace/selling/v1/services">
<addSellerProfileRequest>
<paymentProfile>
<categoryGroups>
<categoryGroup>
<default></default>
<name></name>
</categoryGroup>
<categoryGroup>
<default>true</default>
<name>ALL</name>
</categoryGroup>
</categoryGroups>
<profileName>G********** - Payment Policy US</profileName>
<profileDesc>Lists payment options for fresh fruit purchases</profileDesc>
<paymentInfo>
<acceptedPaymentMethod>VisaMC</acceptedPaymentMethod>
<acceptedPaymentMethod>PayPal</acceptedPaymentMethod>
<immediatePay>true</immediatePay>
<paymentInstructions>For Visa or Mastercard, pleaes include your security code</paymentInstructions>
<paypalEmailAddress>s*****@*******.**.****.com</paypalEmailAddress>
</paymentInfo>
<depositDetails>
<daysToFullPayment>3</daysToFullPayment>
<hoursToDeposit>5</hoursToDeposit>
<depositAmount currencyId="?">?</depositAmount>
</depositDetails>
</paymentProfile>
<returnPolicyProfile>
<profileName>G********** - Returns Policy Worldwide</profileName>
<profileType>RETURN_POLICY</profileType>
<profileDesc>Lists terms for returned fruit</profileDesc>
<siteId>0</siteId>
<categoryGroups>
<categoryGroup>
<default>true</default>
<name>ALL</name>
</categoryGroup>
</categoryGroups>
<returnPolicyInfo>
<refundOption>MoneyBack</refundOption>
<shippingCostPaidByOption>Seller</shippingCostPaidByOption>
<returnsWithinOption>Days_30</returnsWithinOption>
<returnsAcceptedOption>ReturnsAccepted</returnsAcceptedOption>
</returnPolicyInfo>
</returnPolicyProfile>
</addSellerProfileRequest>
Output
The response contains the information that has been created for the payment and returns profiles of the seller.
XML format.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header/>
<soapenv:Body>
<addSellerProfileResponse xmlns="http://www.ebay.com/marketplace/selling/v1/services">
<ack>Success</ack>
<paymentProfile>
<profileName>G********** - Payment Policy US</profileName>
<profileId>5********1</profileId>
<profileType>PAYMENT</profileType>
<profileDesc>Lists payment options for fresh fruit purchases</profileDesc>
<categoryGroups>
<categoryGroup>
<default>false</default>
<name/>
</categoryGroup>
<categoryGroup>
<default>true</default>
<name>ALL</name>
</categoryGroup>
</categoryGroups>
<paymentInfo>
<acceptedPaymentMethod>PayPal</acceptedPaymentMethod>
<acceptedPaymentMethod>VisaMC</acceptedPaymentMethod>
<immediatePay>true</immediatePay>
<paymentInstructions>For Visa or Mastercard, pleaes include your security code</paymentInstructions>
<paypalEmailAddress>s*****@*******.**.****.com</paypalEmailAddress>
</paymentInfo>
</paymentProfile>
<returnPolicyProfile>
<profileName>G********** - Returns Policy US</profileName>
<profileId>5********2</profileId>
<profileType>RETURN_POLICY</profileType>
<profileDesc>Lists terms for returned fruit</profileDesc>
<siteId>0</siteId>
<categoryGroups>
<categoryGroup>
<default>true</default>
<name>ALL</name>
</categoryGroup>
</categoryGroups>
<returnPolicyInfo>
<refundOption>MoneyBack</refundOption>
<shippingCostPaidByOption>Seller</shippingCostPaidByOption>
<returnsWithinOption>Days_30</returnsWithinOption>
<returnsAcceptedOption>ReturnsAccepted</returnsAcceptedOption>
</returnPolicyInfo>
</returnPolicyProfile>
</addSellerProfileResponse>
</soapenv:Body>
</soapenv:Envelope>
| Input Output Samples |
Change History
| Change Date | Description |
|---|---|
| v1.1.0 2018-05-15 |
|
| 1.0.0 2012-02-15 |
|