Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.
eBay successfully processed the request and the business data is returned in the response. Note that it is possible for a response to return Success, but still not contain the expected data in the result.
eBay encountered a fatal error during the processing of the request, causing the request to fail. When a serious application-level error occurs, the error is returned instead of the business data.
The request that triggered the error was processed successfully but with one or more warnings.
eBay successfully processed the request, but one or more non-fatal errors occurred during the processing. Inspect the message details and resolve any problems before resubmitting the request.
This is the base class for the request container for all service operations.
Reserved for future use.
No
Base response container for all service operations. Contains error information associated with the request.
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.
Always
Information for an error or warning that occurred when eBay processed the request.
Conditionally
The version of the response payload schema. Indicates the version of the schema that eBay used to process the request.
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).
Always
Reserved for future use.
Returned errors are categorized as either Application, Request, or System errors. Request and application errors are often caused by passing invalid data in the call request. System errors are primarily caused by application failures and cannot be corrected by changing request values.
Indicates that an error has occurred on the eBay system side. For example, a database or server could be down. Inspect the error message to find the cause of the problem. If the problem is on the eBay side, an application can retry the request a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
An error occurred due to a problem with the request, with the most likely source being the application sending the request. For example, the request is missing a required data element or it contains an invalid field. The problem must be corrected before the request can be resent. Inspect the error message to find the cause of the problem. If the problem is due to an application error, modify the application and resend the request. If the error is due to invalid data, the source of the data must be corrected before you resend the resend request to eBay.
An error occurred due to a problem with the request, with the most likely source being missing or invalid data in the request. The problem must be corrected before the request can be retried. Inspect the error message to find the cause of the problem. If the problem is a result of end user data, alert the end-user to the problem and provide the means for them to correct the problem. Once the problem is resolved, resend the request to eBay.
A container for error details.
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.
Conditionally
Name of the domain in which the error occurred.
Conditionally
Name of the subdomain in which the error occurred.
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.
<br><br>
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.
<br><br>
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.
<br><br>
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.
Conditionally
There are three categories of errors: request errors, application errors, and system errors.
Conditionally
A detailed description of the condition that caused the error.
Conditionally
Unique identifier for an exception associated with an error.
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.
Conditionally
Information regarding an error or warning that occurred when eBay processed the request. Not returned when the <b>ack</b> value is <b>Success</b>.
Details about a single error.
Conditionally
Contextual data associated with an error.
The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value.
Conditionally
Indicates whether the error is a fatal error (causing the request to fail) or a less severe error (a warning) that should be communicated to the user.
eBay encountered a fatal error during the processing of the request, causing the request to fail. When eBay encounters an error, it returns error data instead of the requested business data. Inspect the error details and resolve the problem before resubmitting the request.
The request was successfully processed, but eBay encountered a non-fatal error during the processing that could affect the data returned. For example, eBay might have changed the value of an input field. In this response, eBay returns a successful response, but it also returns a warning. For best results, requests should return without warnings. Inspect the warning details and resolve the problem before resubmitting the request.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
The root request container of the <b>getVersion</b> call.
getVersion
Yes
This call is used to return the current version of Business Policies Management API. This call can be used to monitor the service for availability. This call has no input parameters and the response contains only the standard output fields.
Returns the current version of the Business Policies Management API.
The root response container of the <b>getVersion</b> call.
getVersion
Always
Response container for the <b>getVersion</b> API call.
The root request container of the <b>removeProfile</b> call.
removeProfile
Yes
The root response container of the <b>removeProfile</b> call.
removeProfile
Always
This call is used to delete an existing business policy for a seller.
Unique identifier for a business policy. Each payment, shipping, and return business policy has its own unique <b>profileId</b> value. The seller passes in this <b>profileId</b> value to identify the business policy to delete. A <b>profileId</b> value can be obtained through the site or by making a <b>getSellerProfiles</b> call.
removeProfile
Yes
The response container for the <b>removeProfile</b> call.
The root request container of the <b>addSellerProfile</b> call.
addSellerProfile
Yes
The root response container of the <b>addSellerProfile</b> call.
addSellerProfile
Always
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.</p><p class="tablenote"><b>Important!</b> This API is deprecated and will be decommissioned later in 2022, on a date TBD. We recommend that you migrate to the <b>fulfillment_policy</b>, <b>payment_policy</b>, and <b>return_policy</b> resources of the <a href="https://developer.ebay.com/api-docs/sell/account/resources/methods">Account API</a> to set up and manage all of your fulfillment, payment, and return business policies.</p>
Root container for a seller's payment policy. The <b>paymentProfile</b> 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.
<br><br>
The <b>paymentProfile</b> container is conditionally required if the seller wants to create a new payment policy.
addSellerProfile
Yes
getSellerProfiles
Always
Root container for a seller's return policy. The <b>returnPolicyProfile</b> 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.
<br><br>
The <b>returnPolicyProfile</b> container is conditionally required if the seller wants to create a new return policy.
addSellerProfile
Conditionally
getSellerProfiles
Conditionally
Root container for a seller's shipping policy. The <b>shippingPolicyProfile</b> 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.
<br><br>
The <b>shippingPolicyProfile</b> container is conditionally required if the seller wants to create a new shipping policy.
addSellerProfile
Conditionally
getSellerProfiles
Conditionally
Response container for the <b>addSellerProfile</b> call.
Root container for a seller's payment policy. The <b>paymentProfile</b> 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.
<br><br>
The <b>paymentProfile</b> container is only returned if the seller created a payment policy in the <b>addSellerProfile</b> request.
addSellerProfile
Conditionally
Root container for a seller's return policy. The <b>returnPolicyProfile</b> 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.
<br><br>
The <b>returnPolicyProfile</b> container is only returned if the seller created a return policy in the <b>addSellerProfile</b> request.
addSellerProfile
Conditionally
Root container for a seller's shipping policy. The <b>shippingPolicyProfile</b> 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.
<br><br>
The <b>shippingPolicyProfile</b> container is only returned if the seller created a shipping policy in the <b>addSellerProfile</b> request.
addSellerProfile
Conditionally
The root request container of the <b>getSellerProfiles</b> call.
getSellerProfiles
Yes
The root response container of the <b>getSellerProfiles</b> call.
getSellerProfiles
Always
The root request container of the <b>setSellerProfile</b> call.
setSellerProfile
Yes
The root response container of the <b>setSellerProfile</b> call.
setSellerProfile
Always
Sellers use this call to modify one or more business policies. With one call instance, the seller can modify a payment policy, a return policy, a shipping policy, or any combination of the three policy types.
Root container for a seller's payment policy. The <b>paymentProfile</b> 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.
<br><br>
The <b>paymentProfile</b> container is conditionally required if the seller wants to modify an existing payment policy.
<br><br>
Sellers only pass in values for the fields they want to change. To delete an optional field, sellers can pass an empty value into the field.
setSellerProfile
Conditionally
Root container for a seller's return policy. The <b>returnPolicyProfile</b> 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.
<br><br>
The <b>returnPolicyProfile</b> container is conditionally required if the seller wants to modify an existing return policy.
<br><br>
Sellers only pass in values for the fields that they want to change. To delete an optional field, sellers can pass an empty value into the field.
setSellerProfile
Conditionally
Root container for a seller's shipping policy. The <b>shippingPolicyProfile</b> 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.
<br><br>
The <b>shippingPolicyProfile</b> container is conditionally required if the seller wants to modify an existing shipping policy.
<br><br>
Sellers only pass in values for the fields they want to change. To delete an optional field, sellers can pass an empty value into the field.
setSellerProfile
Conditionally
Response container for the <b>setSellerProfile</b> call.
Root container for a seller's payment policy. The <b>paymentProfile</b> 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.
<br><br>
The <b>paymentProfile</b> container is only returned if the seller modified a payment policy in the <b>setSellerProfile</b> request.
setSellerProfile
Conditionally
Root container for a seller's return policy. The <b>returnPolicyProfile</b> 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.
<br><br>
The <b>returnPolicyProfile</b> container is only returned if the seller modified a return policy in the <b>setSellerProfile</b> request.
setSellerProfile
Conditionally
Root container for a seller's shipping policy. The <b>shippingPolicyProfile</b> 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.
<br><br>
The <b>shippingPolicyProfile</b> container is only returned if the seller modified a shipping policy in the <b>setSellerProfile</b> request.
setSellerProfile
Conditionally
Response container for the <b>getSellerProfiles</b> call.
Container consisting of one or more payment policies that match the input criteria in the <b>getSellerProfiles</b> request. This container is not returned if no payment policies match the input criteria.
getSellerProfiles
Conditionally
Container consisting of one or more return policies that match the input criteria in the <b>getSellerProfiles</b> request. This container is not returned if no return policies match the input criteria.
getSellerProfiles
Conditionally
Container consisting of one or more shipping policies that match the input criteria in the <b>getSellerProfiles</b> request. This container is not returned if no shipping policies match the input criteria.
getSellerProfiles
Conditionally
This call is used to retrieve one or more business policies for a seller. Specific business policies can be retrieved by passing in <b>profileId</b> or <b>profileName</b> values, or all policies of a certain type (payment, return, or shipping) can be retrieved.
The seller passes in one or more <b>profileType</b> enumeration values to retrieve all business policies of that type. Valid values for this field are PAYMENT, RETURN_POLICY, and SHIPPING.
<br><br>
Boolean OR logic is applied when using any combination of the <b>profileType</b>, <b>profileID</b>, and <b>profileName</b> filters in a <b>getSellerProfiles</b> request, so all policies that match any of the supplied filters are retrieved in the response.
SHIPPING_RATE, SHIPPING_EXCLUSION, SHIPPING_DISCOUNT
getSellerProfiles
No
Unique identifier for a seller's business policy. Pass a valid value into this field to retrieve a specific business policy. This field can be repeated multiple times to retrieve multiple policies.
<br><br>
Boolean OR logic is applied when using any combination of the <b>profileType</b>, <b>profileID</b>, and <b>profileName</b> filters in a <b>getSellerProfiles</b> request, so all business policies that match any of the supplied filters are retrieved in the response.
getSellerProfiles
No
Unique name for a seller's business policy. Pass a valid value into this field to retrieve a specific business policy. This field can be repeated multiple times to retrieve multiple policies.
<br><br>
Boolean OR logic is applied when using any combination of the <b>profileType</b>, <b>profileID</b>, and <b>profileName</b> filters in a <b>getSellerProfiles</b> request, so all business policies that match any of the supplied filters are retrieved in the response.
getSellerProfiles
Conditionally
This optional flag determines whether or not detailed information is retrieved for each business policy in the response. If included and set to 'true' or not included (since 'true' is the default), all applicable containers and fields for each business policy are returned in the response. If included and set to 'false', the following containers are not returned in the response:
<ul>
<li><b>paymentInfo</b> (for all retrieved payment policies)</li>
<li><b>returnPolicyInfo</b> (for all retrieved return policies)</li>
<li><b>shippingPolicyInfo</b> (for all retrieved shipping policies)</li>
lt;/ul>
true
getSellerProfiles
No
Type that defines the <b>deliveryEstimateMetaInfo</b> container, which consists of the entity and its value on which the item delivery estimates are based.
The entity that item delivery estimates are based on. Valid entities include:
<ul>
<li>ExternalID</li>
<li>ItemID</li>
<li>SellerID</li>
<li>BuyerID</li>
<li>SGuid</li>
<li>PGuid</li>
<li>TransactionID</li>
</ul>
addSellerProfile
setSellerProfile
No
getSellerProfiles
Conditionally
This value corresponds to the value in the <b>key</b> field and identifies the instance of that entity.
addSellerProfile
setSellerProfile
No
getSellerProfiles
Conditionally
Type defining the <b>domesticShippingPolicyInfoService</b> and <b>internationalShippingPolicyInfoService</b> containers, which consists of detailed information on domestic and international shipping service options.
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 <b>GeteBayDetails</b>, using <b>ShipppingLocationDetails</b> as a <b>DetailName</b> value in the request, and then scanning the <b>ShippingLocationDetails.ShippingLocation</b> values that are returned in the response. The shipping regions and countries that may be specified as <b>shipToLocation</b> values will vary according to eBay site. The seller may include as many valid <b>shipToLocation</b> values as necessary based on where they are willing to ship an item.
<br><br>
If no <b>shipToLocation</b> field is included in the <b>domesticShippingPolicyInfoService</b> container when using the <b>addSellerProfile</b> or <b>setSellerProfile</b> calls, eBay will automatically add the seller's listing country as a 'Ship-To Location'.
<br><br>
If the seller does want to offer international shipping as part of the shipping policy, at least one <b>shipToLocation</b> field in the <b>internationalShippingPolicyInfoService</b> container is required when using the <b>addSellerProfile</b> and <b>setSellerProfile</b> calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a <b>shipToLocation</b> 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 <b>shipToLocation</b> value, but then exclude one or more countries in that region by including one or more instances of the <b>shippingPolicyInfo.excludeShipToLocation</b> field.
<br><br>
All <b>shipToLocation</b> fields specified for the shipping policy are always returned in the <b>getSellerProfiles</b> call.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
Always
A domestic or international shipping service being offered by the seller to ship an item to a buyer.
<br><br>
For a list of valid <b>shippingService</b> values, call <b>GeteBayDetails</b>, including <b>ShippingServiceDetails</b> as a <b>DetailName</b> value, and then look through the <b>ShippingServiceDetails</b> containers returned in the response. International shipping services are marked with an <b>InternationalService</b> flag. All shipping services without this flag are domestic shipping services. The <b>ShippingServiceDetails.ValidForSellingFlow</b> flag must be present for both domestic and international shipping services, otherwise, that specific shipping service option is no longer valid and cannot be offered to buyers through a listing.
<br><br>
The seller must specify one shipping service in each <b>domesticShippingPolicyInfoService</b> and <b>internationalShippingPolicyInfoService</b> container in an <b>addSellerProfile</b> or <b>setSellerProfile</b> request. Up to four domestic and five international shipping service may be offered to the buyer per listing.
<br><br>
If 'Get It Fast' shipping is being enabled for the shipping policy (<b>fastShipping=true</b>), the first specified domestic shipping service (specified in the first <b>domesticShippingPolicyInfoService.shippingService</b> 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 <b>GeteBayDetails</b>, including 'ShippingServiceDetails' as a <b>DetailName</b> value, and then look for a <b>ShippingCategory</b> value of 'ONE_DAY' for the corresponding shipping service. 'Get It Fast' shipping is not available for international shipping.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
Conditionally
geteBayDetails (ShippingServiceDetails)
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingServiceDetails
This value indicates the shipping cost model used by the shipping service option. The two applicable values are 'Flat' and 'Calculated'. To verify that the shipping service supports calculated shipping, call <b>geteBayDetails</b>, using <b>ShipppingServiceDetails</b> as a <b>DetailName</b> value in the request, and then look at the <b>ShippingServiceDetails</b> container that corresponds to the specified shipping service option (see <b>ShippingServiceDetails.ShippingService</b>). One of the <b>ShippingServiceDetails.ServiceType</b> values in that same container should be 'Flat'.
<br><br>
This field is optional in an <b>addSellerProfile</b> or <b>setSellerProfile</b> request, and defaults to 'Flat'.
<br><br>
This field is always returned in each <b>domesticShippingPolicyInfoService</b> and <b>internationalShippingPolicyInfoService</b> container in an <b>addSellerProfile</b> <b>setSellerProfile</b>, or <b>getSellerProfiles</b> response.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
Conditionally
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingServiceDetails
geteBayDetails (ShippingServiceDetails)
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/ShippingTypeCodeType.html
ShippingTypeCodeType
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.
<br><br>
Sellers can specify up to four domestic shipping services (in four separate <b>domesticShippingPolicyInfoService</b> containers), so valid values are 1, 2, 3, and 4. A shipping service option with a <b>sortOrderId</b> value of '1' appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a <b>sortOrderId</b> value of '4' appears at the bottom of a list of four shipping service options.
<br><br>
Sellers can specify up to five international shipping services (in five separate <b>internationalShippingPolicyInfoService</b> containers), so valid values are 1, 2, 3, 4, and 5. Similarly to domestic shipping service options, the <b>sortOrderId</b> value of a international shipping service option controls the placement of that shipping service option in the View Item and Checkout pages.
<br><br>
If the <b>sortOrderId</b> 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.
1
4 (for domestic shipping service) or 5 (for international shipping service)
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
Conditionally
This flag is used by the seller to offer free 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 <b>sortOrderId</b> value of '1', or, if the <b>sortOrderId</b> field is not used, the shipping service option specified first in the API call. The <b>freeShipping</b> field is not applicable for <b>internationalShippingPolicyInfoService</b> containers.
addSellerProfile
setSellerProfile
intlShippingPolicyInfoService
Conditionally
getSellerProfiles
intlShippingPolicyInfoService
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 buyer selects the 'COD' payment method and if the selected shipping service option suppports the Cash-on-Delivery option.
<br><br>
To see if a domestic shipping service option supports the Cash-on-Delivery option, call <b>GeteBayDetails</b>, including 'ShippingServiceDetails' as a <b>DetailName</b> value, and then look for a <b>CODService</b>=true flag for the corresponding shipping service.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
Conditionally
This flag indicates whether or not a 'Get It Fast' shipping service option is available for the listing. 'Get It Fast' shipping is only available for fixed-price listings and auction listings with an active 'Buy It Now' option.
<br><br>
To enable 'Get It Fast' shippping for a listing, the seller must:
<ul>
<li>offer at least one domestic one-day shipping service option, such as USPS Express Mail, UPS Next Day Air, or FedEx Overnight;</li>
<li>set the <b>shippingPolicyInfo.dispatchTimeMax</b> value to '0' (same-day shipping) or '1', which means that the seller is committing to ship the item within one business day after receiving payment from the buyer. </li>
</ul>
Although it is not required, it is recommended that sellers also offer an immediate payment option to the buyer, so they can get their item even faster. In the payment business policy, this option is turned on with the <b>paymentInfo.immediatePay</b> flag.<br/>
The <b>fastShipping</b> field should only be included and set to 'true' in <b>domesticShippingPolicyInfoService</b> containers where the shipping service option is a one-day shipping service. The <b>fastShipping</b> field is not applicable for <b>internationalShippingPolicyInfoService</b> containers.
<br><br>
addSellerProfile
setSellerProfile
intlShippingPolicyInfoService
Conditionally
getSellerProfiles
intlShippingPolicyInfoService
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.
<br><br>
This value is at the seller's discretion. Generally, it should be the same price or lower than the <b>shippingServiceCost</b> 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.
<br><br>
The total shipping costs for an order line item is calculated with the following formula:
<br><br>
Total shipping costs = <b>shippingServiceCost</b> + (<b>shippingServiceAdditionalCost</b> * quantity purchased) <br><br>
So, if a buyer purchases four identical items, and the seller has specified <b>shippingServiceCost</b> as $6.00 and <b>shippingServiceAdditionalCost</b> as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 * 3)).
<br><br>
This field is not applicable to calculated shipping.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
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. <br><br>
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 <b>freeShipping</b> field is set to 'true'.
<br><br>
The total shipping costs for an order line item is calculated with the following formula:
<br><br>
Total shipping costs = <b>shippingServiceCost</b> + (<b>shippingServiceAdditionalCost</b> * quantity purchased)
<br><br>
So, if a buyer purchases four identical items, and the seller has specified <b>shippingServiceCost</b> as $6.00 and <b>shippingServiceAdditionalCost</b> as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 * 3)).
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
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.
<br><br>
In order for sellers to add a shipping surcharge at the shipping service level, the following must be true:
<ul>
<li>a surcharge is applicable for the shipping service (call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>ShippingServiceDetails</b>, and then look for <b>ShippingServiceDetails.SurchargeApplicable=true</b> in the response;</li>
<li>flat-rate shipping is used</li>
</ul>
addSellerProfile
setSellerProfile
No
getSellerProfiles
Conditionally
geteBayDetails (ShippingServiceDetails)
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingServiceDetails
The dollar amount in this field represents the actual total price of shipping if the total shipping costs (<b>shippingServiceCost</b> + <b>shippingServiceAdditionalCost</b> + <b>shippingSurcharge</b>) set for the corresponding shipping service in the shipping policy are overridden through a <b>ShippingServiceCostOverride</b> container in an <b>AddItem</b> call (Trading).
addSellerProfile
setSellerProfile
Conditionally
addSellerProfile
setSellerProfile
getSellerProfiles
Conditionally
This field is only applicable to motor vehicle categories on eBay Motors (US and Canada).
<br><br>
If this field is included and set to 'true' (or omitted because the default value is 'true'), the buyer is responsible for the shipment/pickup of the motor vehicle. If this field is included and set to 'false', the seller should specify the vehicle shipping arrangements in the item description for the listing.
<br><br>
If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag.
true
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
Conditionally
Type that defines the <b>depositDetails</b> container, which is used by the seller to specify amounts and due dates for deposits and full payment on eBay Motors (US and CA) vehicle listings. The <b>depositDetails</b> container is conditionally required if the the payment policy is for eBay Motors (US and CA) vehicles listings (<b>categoryGroup.name=MOTORS_VEHICLE</b>).
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'.
<br><br>
In order for a buyer to make a full payment on a US or CA motor vehicle, at least one of the following <b>acceptedPaymentMethod</b> values must be specified for the corresponding payment policy:
<ul>
<li>CashOnPickup</li>
<li>LoanCheck</li>
<li>MOCC (money order or cashier's check)</li>
<li>PersonalCheck</li>
</ul>
7
3
14
addSellerProfile
setSellerProfile
Conditionally
addSellerProfile
setSellerProfile
getSellerProfiles
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'.
<br><br>
The deposit amount is specified in the <b>depositAmount</b> field. If not specified, the <b>depositAmount</b> value defaults to '0.0', in which case, a deposit on the vehicle is not required.
<br>
<span class="tablenote"><b>Note:</b> The <strong>hoursToDeposit</strong> 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.</span>
24
72
48
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
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 <b>categoryGroup.name</b>field is set to 'MOTORS_VEHICLE'. <br><br>If not specified, this value defaults to '0.0'. If this value is specified, the seller must also specify an <b>hoursToDeposit</b> value. <br><br> The deposit amount appears in the shipping, payment details and return policy sections of the View Item page.
0.0
2000.0
0.0
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
Type defining the <b>paymentProfile</b> container, which is the container used to define one payment policy for a seller.
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.
<br><br>
This container is returned by <b>getSellerProfiles</b> if one or more payment policies match the input criteria in the call request, and is returned in the response of <b>addSellerProfile</b> or <b>setSellerProfile</b> if a payment policy is being created or modified, respectively.
addSellerProfile
setSellerProfile
Conditionally
addSellerProfile
setSellerProfile
getSellerProfiles
Conditionally
Container consisting of one or more payment policies that match the input criteria in a <b>getSellerProfiles<
/b> call request.
Container consisting of details for a specific payment policy. A <b>PaymentProfile</b> container is returned in <b>getSellerProfiles</b> for each payment policy that matches the input criteria.
getSellerProfiles
Conditionally
Type defining the <b>returnPolicyInfo</b> container, which consists of detailed information on a seller's return policy.
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):
<ul>
<li>Germany (DE)</li>
<li>Spain (ES)</li>
<li>France (FR)</li>
<li>Italy (IT)</li>
</ul>
Where valid, sellers can use this field to add details about their return policies. eBay uses this text string as-is in the Return Policy section of the View Item page. Avoid HTML and avoid character entity references (such as &pound; or &#163;). If you include special characters in the return policy description, use the literal UTF-8 or ISO-8559-1 character (e.g. £).
5000
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
This field indicates how the seller compensates buyers for <a href="https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/post-order-returns.html#return-reasons" target="_blank">remorse returns</a>. You must set this value to <code>MoneyBack</code> for all eBay marketplaces except for the US marketplace. <br><br> On <code>EBAY_US</code>: You can set this value to either <code>MoneyBack</code> or <code>MoneyBackOrReplacement</code>. If a seller has the depth of inventory to support an exchange for an identical item, you can set <code>MoneyBackOrReplacement</code>. Otherwise, eBay recommends you set this value to its default value, <code>MoneyBack</code>.
addSellerProfile
setSellerProfile
Conditionally
addSellerProfile
setSellerProfile
getSellerProfiles
Conditionally
This option specifies either the buyer or the seller as the party who pays for return shipping charges. Accepted values are <code>Buyer</code> or <code>Seller</code>. eBay sites often set <code>Seller</code> 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 <b>ReturnsAcceptedOption=ReturnsAccepted</b>. <br><br> 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. <br><br> Use <b>GeteBayDetails</b> (with <b>DetailName=ReturnPolicyDetails</b>) and review the returned <b>ReturnPolicyDetails.ShippingCostPaidBy</b> values to see the values supported by a marketplace.
addSellerProfile
setSellerProfile
Conditionally
addSellerProfile
setSellerProfile
getSellerProfiles
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 <b>ReturnsAcceptedOption=ReturnsAccepted</b>.
<br><br>
<b>Applicable values:</b> Retrieve the values supported by a marketplace by calling <b>GeteBayDetails</b> with <b>DetailName</b> set to <code>ReturnPolicyDetails</code>, then review <b>ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption</b> in the response.
<br> <br>
<span class="tablenote"><b>Note:</b> 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 <a href="/devzone/business-policies/releasenotes.html#v1.1.0">Release Notes</a> for details.</span>
addSellerProfile
setSellerProfile
Conditionally
addSellerProfile
setSellerProfile
getSellerProfiles
Conditionally
This required field indicates whether or not the seller accepts returns.
<br><br>
Applicable values are <code>ReturnsAccepted</code> or <code>ReturnsNotAccepted</code>. When set to <code>ReturnsAccepted</code>, this option indicates the seller allows items to be returned. Specify <b>ReturnsNotAccepted</b> for an item if the seller does not accept returns.
<br><br>
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 <b>GetUser</b> to determine the status of an eBay business seller in DE, IE, and UK. Review the <b>User.SellerInfo.SellerBusinessType</b> field in the response.
<br> <br>
<span class="tablenote"><b>Note:</b> In order for Top-Rated sellers to receive a Top-Rated Plus seal for their listings, returns must be accepted for their items (<b>returnsAcceptedOption</b> = <code>ReturnsAccepted</code>) and handling time should be set to zero-day (same-day shipping) or one-day shipping. Set the handling time (in days) using the <b>Item.DispatchTimeMax</b> field.</span>
<br>
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 <a href="http://pages.ebay.com/help/sell/top-rated.html">Becoming a Top Rated Seller and qualifying for Top Rated Plus</a> page.</p>
<br><br>
<span class="tablenote"><b>For setSellerProfile:</b> 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.</span>
addSellerProfile
setSellerProfile
Conditionally
addSellerProfile
setSellerProfile
getSellerProfiles
Conditionally
(GeteBayDetails) ReturnsAcceptedOption
sites that support this field, and applicable values
GeteBayDetails.html#Response.ReturnPolicyDetails.ReturnsAccepted.ReturnsAcceptedOption
Returns and the Law (UK)
http://pages.ebay.co.uk/businesscentre/law-policies/returns.html
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.
1.0.0
NoOp
1139
Conditionally
1.0.0
NoOp
1139
Conditionally
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.
1061
NoOp
1139
Conditionally
1061
NoOp
1139
Conditionally
WarrantyTypeOptionsCodeType
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/WarrantyTypeOptionsCodeType.html
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.
1061
NoOp
1139
Conditionally
1061
NoOp
1139
Conditionally
WarrantyDurationOptionsCodeType
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/WarrantyDurationOptionsCodeType.html
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.
1061
NoOp
1139
Conditionally
1061
NoOp
1139
Conditionally
This field is deprecated as of v1.1.0 and any values supplied in this field are ignored. eBay no longer supports holiday returns.
v1.1.0
NoOp
Conditionally
1061
NoOp
Conditionally
Type defining the <b>returnPolicyProfile</b> container, which is the container used to define one return policy for a seller.
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.
<br><br>
This container is returned by <b>getSellerProfiles</b> if one or more return policies match the input criteria in the call request.
addSellerProfile
setSellerProfile
Conditionally
addSellerProfile
setSellerProfile
getSellerProfiles
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.
<br><br>
This container is returned by <b>getSellerProfiles</b> if one or more return policies match the input criteria in the call request.
addSellerProfile
setSellerProfile
Conditionally
addSellerProfile
setSellerProfile
getSellerProfiles
Conditionally
Type defining the <b>returnPolicyProfileList</b> container, which consists of one or more return policies that match the input criteria in the <b>getSellerProfiles</b> request.
Container consisting of detailed information for a specific return policy that matches the input criteria.
getSellerProfiles
Always
Type defining the <b>categoryGroups</b> container, which contains one or more <b>categoryGroup</b> containers.
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.
addSellerProfile
setSellerProfile
Yes
getSellerProfiles
addSellerProfile
setSellerProfile
Always
Enumerated type that defines the business policy types.
SHIPPING_RATE, SHIPPING_EXCLUSION, SHIPPING_DISCOUNT
This value indicates the business policy is a payment policy.
This value indicates the business policy is a return policy.
This value indicates the business policy is a shipping policy.
This value is for future use.
This value is for future use.
This value is for future use.
This value is for future use.
This type defines the common elements used by all business policies.
This value is for future use.
addSellerProfile
setSellerProfile
Yes
getSellerProfiles
addSellerProfile
setSellerProfile
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 <b>profileName</b> value is required when using the <b>addSellerProfile</b> and <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
Yes
getSellerProfiles
addSellerProfile
setSellerProfile
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 <b>profileId</b> value is required when using the <b>setSellerProfile</b> and <b>removeSellerProfile</b> calls. It can be used as a filter in a <b>getSellerProfiles</b> to identify a specific business policy to retrieve. This field is always returned with all Business Policies Management calls.
<br><br>
A <b>profileId</b> value returned in the response of an <b>addSellerProfile</b> call indicates that the business policy was successfully created.
removeSellerProfile
setSellerProfile
Yes
getSellerProfiles
Conditionally
getSellerProfiles
removeSellerProfile
setSellerProfile
addSellerProfile
Always
This field indicates the type of the business policy. A <b>profileType</b> value is required when using the <b>addSellerProfile</b> and <b>setSellerProfile</b> calls. It can be used as a filter in a <b>getSellerProfiles</b> call to identify and retrieve business policies of a specific type.
SHIPPING_RATE, SHIPPING_EXCLUSION, SHIPPING_DISCOUNT
addSellerProfile
setSellerProfile
Yes
getSellerProfiles
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Always
This field is for internal use only.
This field is used by the seller to provide a description of the business policy. The <b>profileDesc</b> field is optional in the <b>addSellerProfile</b> and <b>setSellerProfile</b> calls. This field is only returned for a business policy if a description exists for that policy.
250
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
This timestamp indicates when a business policy was deleted. This field is only returned in <b>getSellerProfiles</b> for business policies that have been deleted. For business policies that have been deleted by the seller, <b>deletedDate</b> is the only field that will be returned for the matching policy (in addition to the identifying fields like <b>profileId</b> and <b>profileName</b>).
getSellerProfiles
Conditionally
Unique identifier of the eBay site. This value is always returned in the <b>getSellerProfiles</b> call. It is optional in the <b>addSellerProfile</b> and <b>setSellerProfile</b> calls. If it is not used in an <b>addSellerProfile</b> or <b>setSellerProfile</b> call, the <b>siteId</b> value defaults to the seller's eBay registration site.
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Always
This container consists of one or more <b>categoryGroup</b> containers. One or more category groups are linked to each business policy.
addSellerProfile
setSellerProfile
Yes
getSellerProfiles
addSellerProfile
setSellerProfile
Always
Type defining the <b>shippingPolicyProfile</b> container, which is the container used to define one shipping policy for a seller.
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.
<br><br>
This container is returned by <b>getSellerProfiles</b> if one or more shipping policies match the input criteria in the call request.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
Type defining the <b>shipingPolicyProfile</b> container, which consists of one or more shipping policies that match the input criteria in the <b>getSellerProfiles</b> request.
Container consisting of one or more shipping policies that match the input criteria in the <b>getSellerProfiles</b> request. This container is not returned if no shipping policies match the input criteria.
getSellerProfiles
Conditionally
This type defines the <b>additionalServiceShippingOption</b> container, which contains an additional shipping service option available to buyers (in addition to the shipping service option specified in the <b>domesticShippingPolicyInfoService</b> field.
The name of the additional shipping service option available to buyer. For a list of valid shipping service options, call the Trading API's <b>GeteBayDetails</b> call with the <b>DetailName</b> field set to <b>ShippingServiceDetails</b>. The <b>ShippingServiceDetails.ValidForSellingFlow</ b> flag must also be present in the <b>GeteBayDetails</b> response. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
This flag indicates whether the additional shipping service is enabled or disabled.
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
The root response container of the <b>removeSellerProfiles</b> call.
removeSellerProfiles
Always
The root request container of the <b>removeSellerProfiles</b> call.
removeSellerProfiles
Yes
Sellers use this call to delete one or more existing business policies.
Unique identifier for a business policy. Each payment policy, shipping policy, and return policy has its own unique <b>profileId</b>. The seller passes in one or more <b>profileIds</b> values to identify the business policies to delete. The <b>profileId</b> values can be obtained through the site or by making a <b>getSellerProfiles</b> call.
removeSellerProfiles
Yes
The response container for the <b>removeSellerProfiles</b> call.
Container consisting of the <b>profileId</b> values for business policies that were successfully deleted, as well as an <b>ack</b> value to indicate if the call was successful. An <b>errorMessage</b> container will be returned if the call generated any errors or warnings.
addSellerProfile
Conditionally
Type defining the <b>sellerProfileResponseStatus</b> container, which is returned in the <b>removeSellerProfiles</b> response, and indicates whether or not the business policies specified in the call request were successfully deleted.
Unique identifier for a business policy. Each payment policy, shipping policy, and return policy has its own unique <b>profileId</b>. A <b>profileId</b> value is returned for all business policies that were successfully deleted. For business policies that were not successfully deleted, the reason may be found in the <b>errorMessage</b> container.
removeSellerProfiles
Yes
A token representing the application-level acknowledgement code that indicates the success of the call.
Always
Information for an error or warning that occurred when eBay processed the request.
Conditionally
Type defining the <b>PaymentInfo</b> container, which contains payment information related to the corresponding payment policy.
<span class="tablenote"><b>Note:</b>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.</span>
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 <b>acceptedPaymentMethod</b> fields, the repeating fields must be contiguous.
<span class="tablenote"><b>Note:</b>
Required or allowed payment methods vary by site and category. To retrieve a list of valid payment methods for your site and category, call <b>GetCategoryFeatures</b>, specifying 'PaymentMethods' as a <b>FeatureID</b> value in the call request, and then look for the <b>Category.PaymentMethod</b> values in the call response.
</span>
In order for a buyer to make a full payment on an US or CA motor vehicle, at least one of the following <b>acceptedPaymentMethod</b> values must be specified:
<ul>
<li>CashOnPickup</li>
<li>LoanCheck</li>
<li>MOCC (money order or cashier's check)</li>
<li>PersonalCheck</li>
</ul>
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
This field should be included and set to <code>true</code> if the seller wants to require immediate payment from the buyer for: <ul><li>A fixed-price item</li><li>An auction item where the buyer is using the 'Buy it Now' option</li><li>A deposit for a motor vehicle listing</li></ul><p><span class="tablenote"><b>Note:</b>
In the Trading API calls that return the <b>AutoPay</b> field (<b>immediatePay</b> 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 <b>immediatePay</b> to 'true' in the payment policy) an immediate payment requirement.
</span><br>To successfully enable the immediate payment requirement, the seller must also perform the following actions through the API call:<ul>
<li>seller must specify all related costs to the buyer, since the buyer will not be able to use the Buyer Request Total feature in an immediate payment listing; these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges;</li> <li>seller must include and set the <b>shippingProfileDiscountInfo</b> container values if promotional shipping discounts will be used;</li> </ul>
<!-- Immediate payment is not applicable to DE or AT listings -->
false
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
<p class="depr"><span class="tablenote"><b>Important:</b> DO NOT USE THIS FIELD. Payment instructions are no longer supported by payment business policies.</span></p><p>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.</p><p>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.</p>
1000
addSellerProfile
setSellerProfile
v1.1.0
NoOp
No
getSellerProfiles
addSellerProfile
setSellerProfile
v1.1.0
NoOp
Conditionally
<p class="depr"><span class="tablenote"><b>Important:</b> This field is deprecated. Do not use this field.</p>
addSellerProfile
setSellerProfile
v1.1.0
NoOp
No
getSellerProfiles
addSellerProfile
setSellerProfile
v1.1.0
NoOp
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 <b>categoryGroup.name</b>field is set to 'MOTORS_VEHICLE'.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
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'.
<br><br>
In order for a buyer to make a full payment on a US or CA motor vehicle, at least one of the following <b>acceptedPaymentMethod</b> values must be specified for the corresponding payment business policy:
<ul>
<li>CashOnPickup</li>
<li>LoanCheck</li>
<li>MOCC (money order or cashier's check)</li>
<li>PersonalCheck</li> </ul>
7
3
14
addSellerProfile
setSellerProfile
Conditionally
addSellerProfile
setSellerProfile
getSellerProfiles
Conditionally
The root request container of the <b>consolidateShippingProfiles</b> call.
consolidateShippingProfiles
Yes
The root response container of the <b>consolidateShippingProfiles</b> call.
consolidateShippingProfiles
Always
This call can be used to consolidate shipping policies that have identical data with the exception of shipping costs.
The response container for the <b>consolidateShippingProfiles</b> call.
Container consisting of details related to the shipping policies consolidation job, including a unique ID, the status of the job, and the eBay site ID.
consolidateShippingProfiles
Always
The root request container of the <b>getConsolidationJobStatus</b> call.
getConsolidationJobStatus
Yes
The root response container of the <b>getConsolidationJobStatus</b> call.
getConsolidationJobStatus
Always
This call can be used to retrieve the status of a shipping policies consolidation job.
Unique ID assigned to a shipping policies consolidation job. The <b>JobId</b> value passed into this field will retrieve the shipping policies consolidation job identified by this value. If no <b>JobId</b> is passed in, the status of the most recent consolidation job is returned.
getConsolidationJobStatus
No
The response container for the <b>getConsolidationJobStatus</b> call.
Container consisting of details related to the shipping policies consolidation job, including the status of the job and the eBay site ID.
getConsolidationJobStatus
Always
Enumerated type defining the possible status values for a shipping policies consolidation job.
This value indicates that the shipping policies consolidation job is currently in progress.
This value indicates that the shipping policies consolidation job has successfully completed.
This value indicates that the shipping policies consolidation job has failed. If this value is returned, it is possible that the user can find the reason for job failure by looking at the <b>errorMessage</b> container (if any) in the same response.
Type defining the <b>Job</b> container that is returned in the <b>consolidateShippingProfiles</b> and <b>GetConsolidationJobStatus</b> calls. The <b>Job</b> container consists of a unique ID for the job, the status of the job, and the eBay site ID.
Unique identifier for a shipping policies consolidation job. This field will not be returned in the <b>consolidateShippingProfiles</b> response if the call fails to create the job. A <b>JobId</b> value is needed in the <b>GetConsolidationJobStatus</b> request to retrieve a job.
getConsolidationJobStatus
Always
consolidateShippingProfiles
Conditionally
The type of shipping policies consolidation job. Currently, only one value is applicable.
consolidateShippingProfiles
getConsolidationJobStatus
Always
This field indicates the status of the shipping policies consolidation job.
consolidateShippingProfiles
getConsolidationJobStatus
Always
Unique identifier of the eBay listing site.
consolidateShippingProfiles
getConsolidationJobStatus
Always
Enumerated type defining the possible shipping policies consolidation job types.
This value indicates that the job type is a shipping policies consolidation job.
The root response container of the <b>removeOverrides</b> call.
removeOverrides
Always
The root request container of the <b>removeOverrides</b> call.
removeOverrides
Yes
This call is used to remove shipping cost overrides for a specific shipping policy. The only input parameter for this call is the unique identifier of the shipping policy, and the response contains only the standard output fields.
Removes shipping cost overrides for a specific shipping policy.
The unique identifier of the shipping policy. The seller provides the <b>profileId</b> of the shipping policy for which he/she would like to remove shipping cost overrides.
removeOverrides
Yes
Monetary amount. This type is used in several locations in payment policies and return policies.
This attribute identifies the currency in which the monetary amount is specified. For a full list of 3-digit ISO 4217 currency codes, see the Trading API's <a href="https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/CurrencyCodeType.html" target="_blank">CurrencyCodeType</a>.
Type defining the <b>deliveryEstimate</b> container, which provides details on the estimated time of delivery of the item to the buyer.
The maximum number of business days that a buyer may need to wait for delivery of an item after the buyer pays for the order. This value is based on the <b>dispatchTimeMax</b> value and the shipping service option being used to ship the item.
addSellerProfile
setSellerProfile
No
getSellerProfiles
Conditionally
The minimum number of business days that a buyer may need to wait for delivery of an item after the buyer pays for the order. This value is based on the <b>dispatchTimeMax</b> value and the shipping service option being used to ship the item.
addSellerProfile
setSellerProfile
No
getSellerProfiles
Conditionally
The latest date that an item may be delivered to the buyer after the buyer pays for the order. This value is based on the <b>dispatchTimeMax</b> value and the shipping service option being used to ship the item. Non-business days are disregarded when determining this date.
addSellerProfile
setSellerProfile
No
getSellerProfiles
Conditionally
The earliest date that an item may be delivered to the buyer after the buyer pays for the order. This value is based on the <b>dispatchTimeMax</b> value and the shipping service option being used to ship the item. Non-business days are disregarded when determining this date.
addSellerProfile
setSellerProfile
No
getSellerProfiles
Conditionally
This integer value indicates the minimum level of confidence that the item delivery estimates will be met.
addSellerProfile
setSellerProfile
No
getSellerProfiles
Conditionally
This integer value indicates the maximum level of confidence that the item delivery estimates will be met.
addSellerProfile
setSellerProfile
No
getSellerProfiles
Conditionally
This value indicates how item delivery estimates will be treated.
addSellerProfile
setSellerProfile
No
addSellerProfile
setSellerProfile
getSellerProfiles
Conditionally
This value indicates the maximum number of days after payment, including weekends and any holidays, that a buyer may have to wait for the item to be delivered. This value is based on the <b>dispatchTimeMax</b> value, the shipping service option being used to ship the item, plus the number of weekend or holiday days between tha payment date and the <b>maxDeliveryDate</b>.
addSellerProfile
setSellerProfile
No
getSellerProfiles
Conditionally
This value indicates the minimum number of days after payment, including weekends and any holidays, that a buyer may have to wait for the item to be delivered. This value is based on the <b>dispatchTimeMax</b> value, the shipping service option being used to ship the item, plus the number of weekend or holiday days between tha payment date and the <b>minDeliveryDate</b>.
addSellerProfile
setSellerProfile
No
getSellerProfiles
Conditionally
Type defining the <b>freightShipping</b> container, which consists of details related to freight shipping. This container is required to be set in a shipping policy if the seller offers freight shipping.
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'.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
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.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
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.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
A string value classifying the freight item to be shipped. Valid values for this
field include:
<ul>
<li>MACHINERY_USED</li>
<li>MACHINERY_NEW</li>
<li>FRAGILE_HOUSEHOLD_USED</li>
<li>FRAGILE_HOUSEHOLD_NEW</li>
<li>NON_FRAGILE_HOUSEHOLD_USED</li>
<li>NON_FRAGILE_HOUSEHOLD_NEW</li>
<li>RESTAURANT_EQUIPMENT_USED</li>
<li>RESTAURANT_EQUIPMENT_NEW</li>
<li>COMPUTER_ELECTRONICS_USED</li>
<li>COMPUTER_ELECTRONICS_NEW</li>
<li>VENDING_MACHINE_USED</li>
<li>VENDING_MACHINE_NEW</li>
<li>MOTORCYCLE_USED</li>
<li>MOTORCYCLE_NEW</li>
</ul>
This is a required field if freight shipping is included in the shipping policy.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
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'.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
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'.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
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.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
Type defining the <b>insurance</b> container, which contains the type and cost of domestic and international shipping insurance. The <b>insurance</b> 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.
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 <b>domesticInsuranceOption</b> is 'Optional' or 'Required'.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
This string value indicates the seller's policy on offering domestic shipping insurance to the buyer. Valid values include:
<ul>
<li><b>IncludedInShippingHandling</b>: the seller is not charging the buyer separately for shipping insurance costs, as the cost of shipping insurance is already included in the base shipping cost for the item</li>
<li><b>NotOffered</b>: the seller does not offer shipping insurance to the buyer</li>
<li><b>Optional</b>: purchasing shipping insurance for the item is at the discretion of the buyer</li> <li><b>Required</b>: the seller requires that the buyer purchase shipping insurance for the item</li>
</ul>
This field is required if an AU, FR, or IT seller is offering domestic shipping insurance to the buyer.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
This string value indicates the seller's policy on offering international shipping insurance to the buyer. Valid values
include:
<ul>
<li><b>IncludedInShippingHandling</b>: the seller is not charging the buyer separately for shipping
insurance costs, as the cost of shipping insurance is already included in the base shipping cost for the item</li>
<li><b>NotOffered</b>: the seller does not offer shipping insurance to the buyer</li>
<li><b>Optional</b>: purchasing shipping insurance for the item is at the discretion of the buyer</li>
<li><b>Required</b>: the seller requires that the buyer purchase shipping insurance for the item</li>
</ul>
This field is required if an AU, FR, or IT seller is offering international shipping insurance to the buyer.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
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 <b>internationalInsuranceOption</b> is 'Optional' or 'Required'.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
This enumeration type defines the values that can be set as a currencyId attribute for Business Policies Management elements that use <b>Amount</b> type, such as <b>depositDetails.depositAmount</b> in payment policies, or <b>shippingServiceCost</b> in shipping policies.
USD, CAD, GBP, AUD, EUR, CHF, CNY, HKD, PHP, PLN, SEK, SGD, TWD, INR, MYR
U.S. Dollar; country - United States; ISO currency code - 840
Canadian Dollar; country - Canada; ISO currency code - 124
Pound Sterling; country - United Kingdom; ISO currency code - 826
German Mark; country - Germany; ISO currency code - 276 (Not valid in <b>shippingPolicyCurrency</b> field)
Australian Dollar; country - Australia; ISO currency code - 036
Japanese Yen; country - Japan; ISO currency code - 392 (Not valid in <b>shippingPolicyCurrency</b> field)
Euro; entity - European Union; ISO currency code - 978
French Franc; country - France; ISO currency code - 250 (Not valid in <b>shippingPolicyCurrency</b> field)
Austrian Schilling; country - Austria; ISO currency code - 040 (Not valid in <b>shippingPolicyCurrency</b> field)
Belgian Franc; country - Belgium; ISO currency code - 056 (Not valid in <b>shippingPolicyCurrency</b> field)
Swiss Franc; country - Switzerland; ISO currency code - 756
Chinese Yuan Renminbi; country - China; ISO currency code - 156
Czech Koruna; country - Czech Republic; ISO currency code - 203 (Not valid in <b>shippingPolicyCurrency</b> field)
Danish Krone; country - Denmark; ISO currency code - 208 (Not valid in <b>shippingPolicyCurrency</b> field)
Spanish Peseta; country - Spain; ISO currency code - 724 (Not valid in <b>shippingPolicyCurrency</b> field)
Finnish Markka; country - Finland; ISO currency code - 246 (Not valid in <b>shippingPolicyCurrency</b> field)
Greek Drachma; country - Greece; ISO currency code - 300 (Not valid in <b>shippingPolicyCurrency</b> field)
Hong Kong Dollar; country - Hong Kong; ISO currency code - 344
Hungarian Forint; country - Hungary; ISO currency code - 348 (Not valid in <b>shippingPolicyCurrency</b> field)
Indonesian Rupiah; country - Indonesia; ISO currency code - 360 (Not valid in <b>shippingPolicyCurrency</b> field)
Irish Pound; country - Ireland; ISO currency code - 372 (Not valid in <b>shippingPolicyCurrency</b> field)
Israeli New Shekel; country - Israel; ISO currency code - 376 (Not valid in <b>shippingPolicyCurrency</b> field)
Italian Lira; country - Italy; ISO currency code - 380 (Not valid in <b>shippingPolicyCurrency</b> field)
Dutch Guilder; country - Netherlands; ISO currency code - 528 (Not valid in <b>shippingPolicyCurrency</b> field)
Norwegian Krone; country - Norway; ISO currency code - 578 (Not valid in <b>shippingPolicyCurrency</b> field)
New Zealand Dollar; country - New Zealand; ISO currency code - 554 (Not valid in <b>shippingPolicyCurrency</b> field)
Philippine Peso; country - Philippines; ISO currency code - 608
Polish New Zloty; country - Poland; ISO currency code - 985
Portuguese Escudo; country - Portugal; ISO currency code - 620 (Not valid in <b>shippingPolicyCurrency</b> field)
Russian Ruble; country - Russian Federation; ISO currency code - 810 (Not valid in <b>shippingPolicyCurrency</b> field)
Swedish Krona; country - Sweden; ISO currency code - 752
Singapore Dollar; country - Singapore; ISO currency code - 702
Thai Baht; country - Thailand; ISO currency code - 764
(Not valid in <b>shippingPolicyCurrency</b> field)
New Taiwan Dollar; country - Taiwan; ISO currency code - 901
South African Rand; country - South Africa; ISO currency code - 710
(Not valid in <b>shippingPolicyCurrency</b> field)
Indian Rupee; country - India; ISO currency code - 356
Peruvian New Sol; country - Peru; ISO currency code - 604
(Not valid in <b>shippingPolicyCurrency</b> field)
Malaysian Ringgit; country - Malaysia; ISO currency code - 458
Vietnamese New Dong; country - Vietnam; ISO currency code - 704
(Not valid in <b>shippingPolicyCurrency</b> field)
South Korean Won; country - South Korea; ISO currency code - 410
(Not valid in <b>shippingPolicyCurrency</b> field)
New Turkish Lira; country - Turkey; ISO currency code - 949
(Not valid in <b>shippingPolicyCurrency</b> field)
Antillian Guilder; country - Netherlands Antilles; ISO currency code - 532
(Not valid in <b>shippingPolicyCurrency</b> field)
Aruban Guilder; country - Aruba; ISO currency code - 533
(Not valid in <b>shippingPolicyCurrency</b> field)
Bermudan Dollar; country - Bermuda; ISO currency code - 060
(Not valid in <b>shippingPolicyCurrency</b> field)
Costa Rican Colon; country - Costa Rica; ISO currency code - 188
(Not valid in <b>shippingPolicyCurrency</b> field)
Romanian New Leu; country - Romania; ISO currency code - 946
(Not valid in <b>shippingPolicyCurrency</b> field)
Venezuelan Bolivar Fuerte; country - Venezuela; ISO currency code - 937
(Not valid in <b>shippingPolicyCurrency</b> field)
Barbados Dollar; country - Barbados; ISO currency code - 052
(Not valid in <b>shippingPolicyCurrency</b> field)
Bulgarian Lev; country - Bulgaria; ISO currency code - 975
(Not valid in <b>shippingPolicyCurrency</b> field)
Brunei Dollar; country - Brunei; ISO currency code - 096
(Not valid in <b>shippingPolicyCurrency</b> field)
Bahamian Dollar; country - Bahamas; ISO currency code - 044
(Not valid in <b>shippingPolicyCurrency</b> field)
Columbian Peso; country - Columbia; ISO currency code - 170
(Not valid in <b>shippingPolicyCurrency</b> field)
Dominican Peso; country - Dominican Republic; ISO currency code - 214
(Not valid in <b>shippingPolicyCurrency</b> field)
Guatemalan Quetzal; country - Guatemala; ISO currency code - 320
(Not valid in <b>shippingPolicyCurrency</b> field)
Cayman Isles Dollar; country - Cayman Islands; ISO currency code - 136
(Not valid in <b>shippingPolicyCurrency</b> field)
Maldivian Rufiyaa; country - Maldives; ISO currency code - 462
(Not valid in <b>shippingPolicyCurrency</b> field)
Qatari Rial; country - Qatar; ISO currency code - 634
(Not valid in <b>shippingPolicyCurrency</b> field)
Saudi Riyal; country - Saudi Arabia; ISO currency code - 682
(Not valid in <b>shippingPolicyCurrency</b> field)
Trinidadian and Tobagonian Dollar; country - Trinidad and Tobago; ISO currency code - 780
(Not valid in <b>shippingPolicyCurrency</b> field)
Ukrainian Hryvnia; country - Ukraine; ISO currency code - 980
(Not valid in <b>shippingPolicyCurrency</b> field)
Peso Uruguayo; country - Uruguay; ISO currency code - 858
(Not valid in <b>shippingPolicyCurrency</b> field)
East Caribbean Dollar; entity - East Caribbean Currency Area; ISO currency code - 951
(Not valid in <b>shippingPolicyCurrency</b> field)
French Polynesian Franc; country - French Polynesia; ISO currency code - 953
(Not valid in <b>shippingPolicyCurrency</b> field)
Jamaican Dollar; country - Jamaica; ISO currency code - 388
(Not valid in <b>shippingPolicyCurrency</b> field)
Russian ruble; country - Russian Federation; ISO currency code - 643
(Not valid in <b>shippingPolicyCurrency</b> field)
Brazilian real; country - Brazil; ISO currency code - 986
(Not valid in <b>shippingPolicyCurrency</b> field)
Chilean peso; country - Chile; ISO currency code - 152
(Not valid in <b>shippingPolicyCurrency</b> field)
Mexican peso; country - Mexico; ISO currency code - 484
(Not valid in <b>shippingPolicyCurrency</b> field)
Honduran lempira; country - Honduras; ISO currency code - 340
(Not valid in <b>shippingPolicyCurrency</b> field)
Nicaraguan cordoba; country - Nicaragua; ISO currency code - 558
(Not valid in <b>shippingPolicyCurrency</b> field)
Bolivian boliviano; country - Bolivia; ISO currency code - 068
(Not valid in <b>shippingPolicyCurrency</b> field)
Paraguayan guarani; country - Paraguay; ISO currency code - 600
(Not valid in <b>shippingPolicyCurrency</b> field)
Type definining the <b>rateTableInfo</b> container, which identifies the domestic and international shipping rate tables referenced to determine flat-rate shipping costs based on shipping service level (Economy, Standard, Expedited, One-day) and delivery location.
<span class="tablenote"><b>Note:</b>
International shipping rate tables are only available to sellers listing on the Germany and UK eBay sites.
</span>
<br>
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 <b>intlRateTable</b> is 'Default', which means that the default international shipping rate table set up by the seller in My eBay is referenced.
<br><br>
Including this field in an <b>addSellerProfile</b> or <b>setSellerProfile</b> 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.
<br><br>
This field is returned in <b>getSellerProfiles</b> if it is defined for the shipping policy.
50
addSellerProfile
setSellerProfile
No
getSellerProfiles
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 <b>domesticRateTable</b> is 'Default', which means that the default domestic shipping rate table set up by the seller in My eBay is referenced.
<br><br>
Including this field in an <b>addSellerProfile</b> or <b>setSellerProfile</b> 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.
<br><br>
This field is returned in <b>getSellerProfiles</b> if it is defined for the shipping policy.
50
addSellerProfile
setSellerProfile
No
getSellerProfiles
Conditionally
This type is reserved for future use.
This field is reserved for future use.
addSellerProfile
setSellerProfile
No
getSellerProfiles
Conditionally
This field is reserved for future use.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
Conditionally
This field is reserved for future use.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
Conditionally
This field is reserved for future use.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
Conditionally
This type is for internal use.
This field is for future use.
This field is for internal use.
addSellerProfile
setSellerProfile
No
getSellerProfiles
Conditionally
Type defining the <b>shippingPolicyInfo</b> container, which consists of detailed information for a seller's shipping policy.
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 <b>shippingPolicyName</b> value is required when using the <b>addSellerProfile</b> and <b>setSellerProfile</b> calls to create or update a shipping policy.
<br><br>
This field is always returned with all shipping policies returned in the
<b>getSellerProfiles</b>, <b>addSellerProfile</b>, or
<b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
Yes
getSellerProfiles
addSellerProfile
setSellerProfile
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 <b>addSellerProfile</b> or <b>setSellerProfile</b> call, it defaults to 'Flat' shipping.
<br><br>
If 'FreightFlat' is specified as the domestic shipping type, the <b>freightShipping</b> container and its values must be set in the shipping policy. If 'Calculated' is used as the shipping type, the <b>CalculatedShippingRate</b> container must be used when listing, revising, or relisting an item through the Trading API.
<br><br>
This field is always returned with all shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
Flat
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
Shipping
https://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Shipping
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 <b>addSellerProfile</b> or <b>setSellerProfile</b> call, it defaults to 'Flat' shipping.
<br><br>
If 'FreightFlat' is specified as the international shipping type, the <b>freightShipping</b> container and its values must be set in the shipping policy. If 'Calculated' is used as the shipping type, the <b>CalculatedShippingRate</b> container must be used when listing, revising, or relisting an item through the Trading API.
<br><br>
This field is always returned with all shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
Flat
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
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 <b>GeteBayDetails</b>, using <b>DispatchTimeMaxDetails</b> as a <b>DetailName</b> value in the request, and then look at the <b>DispatchTimeMaxDetails</b> container in the response for supported values for the site.
<br><br>
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 <b>dispatchTimeMax</b> field in the shipping business policy and set the value of this field to '0' or '1', respectively.
<br><br>
The <b>dispatchTimeMax</b> field must be included in the shipping policy and set to '0' or '1' if the <b>fastShipping</b> flag is included and set to 'true' in the shipping policy.
<br><br>
<span class="tablenote"><b>Note:</b> Traditionally in the Trading API, sellers using an Add/Revise/Relist API call were allowed to pass in a <b>DispatchTimeMax</b> value of '0' to indicate that no handling time is specified for the listing. However, with the onboarding of same-day shipping, a <b>DispatchTimeMax</b> 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 < b>dispatchTimeMax</b> field, or they can include it but set it to null.
</span>
<br>
This field is always returned with all shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
<br>
1
30
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Always
This free-form string field is used by the seller to provide more details to the buyer about handling time.
<br><br>
If set for the shipping policy, this field is returned with shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
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 <b>addSellerProfile</b> or <b>setSellerProfile</b> call should be in synch with the values that are specified in the <b>shipToLocation</b> and <b>excludeShipToLocation</b> fields used in the same call.
<br><br>
The possible values are listed below:
<ul>
<li>0 ('SiteOnly'): this value indicates that the seller only ships to domestic locations (relative to the listing site). </li>
<li>1 ('SitePlusRegions'): this value indicates that the seller ships to domestic locations plus any international regions or countries specified as ship-to locations through the <b>shipToLocation</b> field. </li>
<li>2 ('WorldWide'): this value indicates that the seller will ship to anywhere in the world except for any international regions or countries excluded with an <b>excludeShipToLocation</b> field.</li>
<li>3 ('WillNotShip'): this value indicates that the seller does not offer shipping. This value is only applicable if 'Local Pickup' is being used, which might be the case if the item is a motor vehicle.</li>
<li>4 ('TermsAndConditionsOnly'): this value is for future use.</li>
</ul>
If set for the shipping policy, this field is returned with shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
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 <b>GeteBayDetails</b>, using <b>ExcludeShipppingLocationDetails</b> as a <b>DetailName</b> value in the request, and then scan the <b>ExcludeShippingLocationDetails.Location</b> values that are returned in the response. The seller may include as many valid <b>excludeShipToLocation</b> values as necessary based on where they are not willing to ship an item.
<br><br>
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.
<br><br>
This field works in conjunction with the <b>shipToLocation</b> 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 <b>shipToLocation</b> field, then exclude specific countries within that region with this field. For example, you can specify 'Africa' as a <b>shipToLocation</b> value, yet exclude Egypt by including an <b>excludeShipToLocation</b> field with its value set to 'EG', which is Egypt's two-digit country code. In addition, if a seller used only one <b>shipToLocation</b> value and set it to 'Worldwide', that seller can use one or more <b>excludeShipToLocation</b> fields to exclude one or more international regions, countries, or special domestic locations as possible shipping destinations.
<br><br>
Each excluded ship-to location is returned with shipping policies returned in the
<b>getSellerProfiles</b>, <b>addSellerProfile</b>, or
<b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
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.
<br><br>
Shipping discounts can be created by the seller through My eBay, or by using the <b>SetShippingDiscountProfiles</b> call of the Trading API.
<br><br>
If shipping discounts are used for a shipping policy, this container is returned with shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetShippingDiscountProfiles.html
SetShippingDiscountProfiles
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetShippingDiscountProfiles.html
GetShippingDiscountProfiles
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 (<b>domesticShippingType</b> and/or <b>intlShippingType</b> is set to 'FreightFlat').
<br><br>
If freight shipping is specified for a shipping policy, this container is returned with shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
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. <br><br>
It is not necessary to include the <b>shipToLocation</b> field in the <b>domesticShippingPolicyInfoService</b> container when using the <b>addSellerProfile</b> and <b>setSellerProfile</b> calls. However, eBay automatically adds the seller's listing county as a 'Ship-To Location', and the <b>shipToLocation</b> field is always returned for each shipping policy in the <b>addSellerProfile</b>, <b>setSellerProfile</b>, and <b>getSellerProfiles</b> calls. <br><br>
If the seller does want to offer international shipping as part of the shipping policy, at least one <b>shipToLocation</b> field in the <b>internationalShippingPolicyInfoService</b> container is required when using the <b>addSellerProfile</b> and <b>setSellerProfile</b> calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a <b>shipToLocation</b> value. If the seller wants to offer shipping to one or more specific shipping regions, the seller must include that shipping region in a <b>shipToLocation</b> 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 <b>shippingPolicyInfo.excludeShipToLocation</b> field.
<br><br>
Applicable shipping region values are defined in <b>ShippingRegionCodeType</b> and applicable country codes are defined in <b>CountryCodeType</b>. However, it is best practice for sellers to call <b>GeteBayDetails</b>, using <b>ShipppingLocationDetails</b> as a <b>DetailName</b> value in the request, and then scanning the <b>ShippingLocationDetails.ShippingLocation</b> values that are returned in the response.
<br><br>
Each specified ship-to location is returned with shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
Conditionally
addSellerProfile
setSellerProfile
getSellerProfiles
Conditionally
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html
GeteBayDetails
https://developer.ebay.com/devzone/xml/docs/reference/ebay/types/ShippingRegionCodeType.html
ShippingRegionCodeType
https://developer.ebay.com/devzone/xml/docs/reference/ebay/types/CountryCodeType.html
CountryCodeType
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.
<br><br>
Each specified domestic shipping service is returned with shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
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.
<br><br>
Each specified international shipping service is returned with shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
This container consists of the type and cost of domestic and international shipping insurance. The <b>insurance</b> 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.
<br><br>
If shipping insurance options are specified for a shipping policy, this container is returned with shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
<span class="tablenote"><b>Note:</b>
International shipping rate tables are only available to sellers listing on the Germany and UK eBay sites.
</span>
<br>
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 <b>intlRateTable</b> is 'Default', which means that the default international shipping rate table set up by the seller in My eBay is referenced.
<br><br>
Including this field in an <b>addSellerProfile</b> or <b>setSellerProfile</b> 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.
<br><br>
If set for the shipping policy (Germany and UK only), this field is returned with shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
50
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
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 <b>domesticRateTable</b> is 'Default', which means that the default domestic shipping rate table set up by the seller in My eBay is referenced.
<br><br>
Including this field in an <b>addSellerProfile</b> or <b>setSellerProfile</b> 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.
<br><br>
If set for the shipping policy, this field is returned with shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
50
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
This field allows the seller to add package handling costs for shipping an item to a domestic location.
<br><br>
If set for the shipping policy, this field is returned with shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
This field allows the seller to add package handling costs for shipping an item to an international location.
<br><br>
If set for the shipping policy, this field is returned with shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
Three-digit code that indicates the currency used by the listing site. To obtain valid currency codes, the seller can call <b>GeteBayDetails</b>, using <b>CurrencyDetails</b> as a <b>DetailName</b> value in the request, and then scanning the <b>CurrencyDetails.Currency</b> values that are returned in the response.
<br><br>
If this field is not included in an <b>addSellerProfile</b> or <b>setSellerProfile</b> call, the currency code will default to the standard currency used by the listing site.
<br><br>
This field is always returned with all shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Always
This container is for future use.
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 <b>globalShipping</b> 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 <b>GlobalShipping</b> is 'false', the seller is responsible for specifying one or more international shipping services for the listing (if the seller wishes to ship internationally).
<br><br>
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.
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
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).
<br><br>
In addition to setting the <b>EligibleForPickupDropOff</b> 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:
<ul>
<li>Have inventory for the product at one or more physical stores tied to the merchant's account</li>
<li>Set an immediate payment requirement on the item. The immediate payment feature requires the seller to include the <b>paymentInfo.immediatePay</b> flag in the payment business policy and set its value to 'true'</li>
</ul>
</li>
</ul>
When a UK merchant is successful at listing an item with the "Click and Collect" feature enabled, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the "Available for Click and Collect" option on the listing, along with information on the closest store that has the item.
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Always
Type defining the <b>shippingPolicyInfoService</b> container, which consists of detailed information for a shipping service option being offered to the buyer.
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 <b>GeteBayDetails</b>, using <b>ShipppingLocationDetails</b> as a <b>DetailName</b> value in the request, and then scanning the <b>ShippingLocationDetails.ShippingLocation</b> values that are returned in the response. The shipping regions and countries that may be specified as <b>shipToLocation</b> values will vary according to eBay site. The seller may include as many valid <b>shipToLocation</b> values as necessary based on where they are willing to ship an item.
<br><br>
If no <b>shipToLocation</b> field is included in the <b>domesticShippingPolicyInfoService</b> container when using the <b>addSellerProfile</b> or <b>setSellerProfile</b> calls, eBay will automatically add the seller's listing country as a 'Ship-To Location'.
<br><br>
If the seller does want to offer international shipping as part of the shipping policy, at least one <b>shipToLocation</b> field in the <b>internationalShippingPolicyInfoService</b> container is required when using the <b>addSellerProfile</b> and <b>setSellerProfile</b> calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a <b>shipToLocation</b> 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 <b>shipToLocation</b> value, but then exclude one or more countries in that region by including one or more instances of the <b>shippingPolicyInfo.excludeShipToLocation</b> field.
<br><br>
Each ship-to location specified for the shipping service is returned with shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingLocationDetails
GeteBayDetails (ShippingLocationDetails)
A domestic or international shipping service being offered by the seller to ship an item to a buyer.
<br><br>
For a list of valid <b>shippingService</b> values, call <b>GeteBayDetails</b>, including <b>ShippingServiceDetails</b> as a <b>DetailName</b> value, and then look through the <b>ShippingServiceDetails</b> containers returned in the response. International shipping services are marked with an <b>InternationalService</b> flag. All shipping services without this flag are domestic shipping services. The <b>ShippingServiceDetails.ValidForSellingFlow</b> 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.
<br><br>
The seller must specify one shipping service in each <b>domesticShippingPolicyInfoService</b> and <b>internationalShippingPolicyInfoService</b> container in an <b>addSellerProfile</b> or <b>setSellerProfile</b> request. Up to four domestic and five international shipping service may be offered to the buyer per listing.
<br><br>
If 'Get It Fast' shipping is being enabled for the shipping policy (<b>fastShipping</b>=true), the first specified domestic shipping service (specified in the first <b>domesticShippingPolicyInfoService.shippingService</b> 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 <b>GeteBayDetails</b>, including 'ShippingServiceDetails' as a <b>DetailName</b> value, and then look for a <b>ShippingCategory</b> value of 'ONE_DAY' for the corresponding shipping service. 'Get It Fast' shipping is not available for international shipping.
<br><br>
Each shipping service specified for the shipping policy is returned with shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GeteBayDetails.html
GeteBayDetails
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.
<br><br>
Sellers can specify up to four domestic shipping services (in four separate <b>domesticShippingPolicyInfoService</b>
containers), so valid values are 1, 2, 3, and 4. A shipping service option with a
<b>sortOrderId</b> value of '1' appears at the top of View Item and Checkout
pages. Conversely, a shipping service option with a <b>sortOrderId</b> value
of '4' appears at the bottom of a list of four shipping service options.
<br><br>
Sellers can specify up to five international shipping services (in five separate
<b>internationalShippingPolicyInfoService</b> containers), so valid values
are 1, 2, 3, 4, and 5. Similarly to domesstic shipping service options, the
<b>sortOrderId</b> value of a international shipping service option controls
the placement of that shipping service option in the View Item and Checkout pages.
<br><br>
If the <b>sortOrderId</b> 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.
<br><br>
This field is always returned (for each shipping service) with shipping policies returned in the
<b>getSellerProfiles</b>, <b>addSellerProfile</b>, or
<b>setSellerProfile</b> calls.
<br><br>
1
4 (for domestic shipping service) or 5 (for international shipping service)
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
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 <b>sortOrderId</b> value of '1', or, if the <b>sortOrderId</b> field is not used, the shipping service option specified first in the API call.
<br><br>
If free shipping is set for a domestic shipping service, this field is returned in the shipping business policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
intlShippingPolicyInfoService
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
intlShippingPolicyInfoService
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.
<br><br>
To see if a domestic shipping service option supports the Cash-on-Delivery option,
call <b>GeteBayDetails</b>, including 'ShippingServiceDetails' as a
<b>DetailName</b> value, and then look for a
<b>CODService=true</b> flag for the corresponding shipping service.
<br><br>
If a Cash-on-Delivery shipping service is defined for the shipping policy, this
field is returned in the shipping policies returned in the
<b>getSellerProfiles</b>, <b>addSellerProfile</b>, or
<b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
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.
<br><br>
To enable 'Get It Fast' shipping for a listing, the seller must:
<ul>
<li>offer at least one domestic one-day shipping service option, such as USPS Express Mail, UPS Next Day Air, or FedEx Overnight;</li>
<li>set the <b>shippingPolicyInfo.dispatchTimeMax</b> value to '0' or '1', which means that the seller is committing to ship the item within one business day after receiving payment from the buyer. A
<b>DispatchTimeMax</b> value of '0' will indicate that the seller is offering same-day shipping.</li>
</ul>
Although it is not required, it is recommended that sellers also offer an immediate payment option to the buyer, so they can get their item even faster. In the payment policy, this option is turned on with the <b>paymentInfo.immediatePay</b> flag.
The <b>fastShipping</b> field should only be included and set to 'true' in <b>domesticShippingPolicyInfoService</b> containers where the shipping service option is a one-day shipping service. The <b>fastShipping</b> field is not applicable for <b>internationalShippingPolicyInfoService</b> containers.
<br><br>
If 'Get It Fast' shipping is set for a domestic shipping service, this field is returned in the shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
intlShippingPolicyInfoService
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
intlShippingPolicyInfoService
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.
<br><br>
This value is at the seller's discretion. Generally, it should be the same price or lower than the <b>shippingServiceCost</b> 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.
<br><br>
The total shipping costs for an order line item is calculated with the following formula:
<br><br>
Total shipping costs = <b>shippingServiceCost</b> + (<b>shippingServiceAdditionalCost</b> * quantity purchased)
<br><br>
So, if a buyer purchases four identical items, and the seller has specified <b>shippingServiceCost</b> as $6.00 and <b>shippingServiceAdditionalCost</b> as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 * 3)).
<br><br>
This field is not applicable to calculated shipping.
<br><br>
If set for one or more shipping services within the shipping policy, this field is returned with shipping policies returned in the <b>getSellerProfiles</b>, <b>addSellerProfile</b>, or <b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
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.
<br><br>
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
<b>freeShipping</b> field is set to 'true'.
<br><br>
The total shipping costs for an order line item is calculated with the following formula:
<br><br>
Total shipping costs = <b>shippingServiceCost</b> + (<b>shippingServiceAdditionalCost</b> * quantity purchased)
<br><br>
So, if a buyer purchases four identical items, and the seller has specified
<b>shippingServiceCost</b> as $6.00 and
<b>shippingServiceAdditionalCost</b> as $2.00, the total shipping cost for the order
line item is $12.00 ($6.00 + ($2.00 * 3)).
<br><br>
This field is always returned (for each shipping service) with shipping policies
returned in the
<b>getSellerProfiles</b>, <b>addSellerProfile</b>, or
<b>setSellerProfile</b> calls.
Determining Shipping Costs for a Listing
https://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingGettingCosts
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
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.
<br><br>
In order for sellers to add a shipping surcharge at the shipping
service level, the following must be true:
<ul>
<li>a surcharge is applicable for the shipping service (call <b>GeteBayDetails</b>
with <b>DetailName</b> set to <b>ShippingServiceDetails</b>, and
then look for <b>ShippingServiceDetails.SurchargeApplicable=true</b> in the
response;</li>
<li>flat-rate shipping is used</li>
</ul>
If set for one or more shipping services within the shipping policy, this field
is returned with shipping policies returned in the
<b>getSellerProfiles</b>, <b>addSellerProfile</b>, or
<b>setSellerProfile</b> calls.
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
This field is only applicable to vehicle categories on eBay Motors (US and Canada).
<br><br>
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.
<br><br>
If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag.
<br><br>
If set for one or more shipping services within the shipping policy, this field
is returned with shipping policies returned in the
<b>getSellerProfiles</b>, <b>addSellerProfile</b>, or
<b>setSellerProfile</b> calls.
true
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
This field is only applicable to vehicle categories on eBay Motors (US and Canada).
<br><br>
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.
<br><br>
If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag.
<br><br>
If set for one or more shipping services within the shipping policy, this field
is returned with shipping policies returned in the
<b>getSellerProfiles</b>, <b>addSellerProfile</b>, or
<b>setSellerProfile</b> calls.
<br><br>
true
addSellerProfile
setSellerProfile
Conditionally
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
Type defining the <b>shippingProfileDiscountInfo</b> container, which consists of details related to flat-rate, calculated, and promotional shipping discounts that are offered to domestic and/or international buyers.
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 <b>SetShippingDiscountProfiles</b> and <b>GetShippingDiscountProfiles</b> calls of the Trading API.
<br><br>
The type of shipping discount profile specified in this field (flat-rate or calculated) should correspond to the <b>domesticShippingType</b> ('Flat' or 'Calculated') value in the shipping policy.
<br><br>
Shipping discount profiles are not applicable when Freight shipping is used.
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetShippingDiscountProfiles.html
SetShippingDiscountProfiles
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetShippingDiscountProfiles.html
GetShippingDiscountProfiles
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 <b>SetShippingDiscountProfiles</b> and <b>GetShippingDiscountProfiles</b> calls of the Trading API.
<br><br>
The type of shipping discount profile specified in this field (flat-rate or calculated) should correspond to the <b>intlShippingType</b> ('Flat' or 'Calculated') value in the shipping policy.
<br><br>
Shipping discount profiles are not applicable when Freight shipping is used.
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetShippingDiscountProfiles.html
SetShippingDiscountProfiles
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetShippingDiscountProfiles.html
GetShippingDiscountProfiles
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 <b>SetShippingDiscountProfiles</b> call of the Trading API.
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetShippingDiscountProfiles.html
SetShippingDiscountProfiles
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetShippingDiscountProfiles.html
GetShippingDiscountProfiles
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 <b>SetShippingDiscountProfiles</b> call of the Trading API.
addSellerProfile
setSellerProfile
No
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/SetShippingDiscountProfiles.html
SetShippingDiscountProfiles
https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/GetShippingDiscountProfiles.html
GetShippingDiscountProfiles
Enumerated type defining the shipping rates that the seller will receive through USPS, UPS, or Federal Express to ship an item. The shipping rate also affects how much the buyer will pay for shipping.
This value indicates that the seller gets On Demand shipping rates through United Parcel Service (UPS).
This value indicates that the seller gets Daily Pickup shipping rates through United Parcel Service (UPS).
This value indicates that the seller gets Standard shipping rates through Federal Express (FedEx).
This value indicates that the seller gets Counter shipping rates through Federal Express (FedEx).
This value indicates that the seller gets Discounted shipping rates through US Postal Service (USPS).
This value indicates that the seller gets Commercial Plus shipping rates through US Postal Service (USPS).
This value indicates that the seller gets discounted shipping rates through Federal Express (FedEx).
This value indicates that the seller gets gold/silver-level shipping rates.
This value indicates that the seller gets platinum/titanium-level shipping rates.
This value indicates that the seller gets standard eBay shipping rates.
This value indicates that the seller gets standard retail shipping rates.
Type defining the <b>categoryGroup</b> container, which indicates the category group to which the payment, return, or shipping business policy applies to. The only two valid category groups are 'MOTORS_VEHICLE' (for motor vehicle listings) and 'ALL' (for non-motor vehicle listings). These enumeration values are case-sensitive. The 'MOTORS_VEHICLE' category group is not valid for return business policies, as return business policies cannot be used with motor vehicle listings.
<p class="depr"><span class="tablenote"><b>Important:</b> 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.</span></p><p>
addSellerProfile
setSellerProfile
v1.1.0
NoOp
No
getSellerProfiles
addSellerProfile
setSellerProfile
v1.1.0
NoOp
No
Conditionally
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.
addSellerProfile
setSellerProfile
Yes
getSellerProfiles
addSellerProfile
setSellerProfile
Always
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 <a href="http://pages.ebay.com/help/sell/top-rated.html" target="_blank">Becoming a Top Rated Seller and qualifying for Top Rated Plus</a> help topic.
getSellerProfiles
addSellerProfile
setSellerProfile
Conditionally
Populate this complex object if your international return policy differs from your domestic return policy (by default, international return policies inherit their settings from the settings in the domestic return policy).
<br><br>
For example, you might want to offer free returns for domestic shipments, but have a return policy where the buyer pays for returns from non-domestic regions.
This optional field indicates whether or not the seller accepts international returns (returns that need to be shipped via an international shipping service).
<br><br>
Applicable values are <code>ReturnsAccepted</code> or <code>ReturnsNotAccepted</code>. When set to <code>ReturnsAccepted</code>, this option indicates the seller allows international returns. If the seller does not accept international returns, they can specify <b>ReturnsNotAccepted</b>.
<br><br>
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 <b>GetUser</b> to determine the status of an eBay business seller in DE, IE, and UK. Review the <b>User.SellerInfo.SellerBusinessType</b> field in the response.
addSellerProfile
setSellerProfile
Conditionally
addSellerProfile
setSellerProfile
getSellerProfiles
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 <b>ReturnsAcceptedOption=ReturnsAccepted</b>.
<br><br>
<b>Applicable values:</b> Retrieve the values supported by a marketplace by calling <b>GeteBayDetails</b> with <b>DetailName</b> set to <code>ReturnPolicyDetails</code>, then review <b>ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption</b> in the response.
addSellerProfile
setSellerProfile
Conditionally
addSellerProfile
setSellerProfile
getSellerProfiles
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 <code>Buyer</code> or <code>Seller</code>. This value is required for international returns when <b>ReturnsAcceptedOption=ReturnsAccepted</b>. <br><br> 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. <br><br> Use <b>GeteBayDetails</b> (with <b>DetailName=ReturnPolicyDetails</b>) and review the returned <b>ReturnPolicyDetails.ShippingCostPaidBy</b> values to see the values supported by a marketplace.
addSellerProfile
setSellerProfile
Conditionally
addSellerProfile
setSellerProfile
getSellerProfiles
Conditionally
This field indicates how the seller compensates buyers for <a href="https://developer.ebay.com/DevZone/guides/features-guide/default.html#development/post-order-returns.html#return-reasons" target="_blank">remorse returns</a>. You must set this value to <code>MoneyBack</code> for all eBay marketplaces except for the US marketplace. This value is required for international returns when <b>ReturnsAcceptedOption=ReturnsAccepted</b>.
<br><br>
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.
<br><br>
On <code>EBAY_US</code>: You can set this value to either <code>MoneyBack</code> or <code>MoneyBackOrReplacement</code>. If a seller has the depth of inventory to support an exchange for an identical item, you can set <code>MoneyBackOrReplacement</code>. Otherwise, eBay recommends you set this value to its default value, <code>MoneyBack</code>.
addSellerProfile
setSellerProfile
Conditionally
addSellerProfile
setSellerProfile
getSellerProfiles
Conditionally
Documentation goes here.
1.0.0