ebay.account
Module ebay.account
API
Definitions
ballerinax/ebay.account Ballerina library
Overview
eBay is a global online marketplace where businesses and individuals buy and sell goods. The eBay Account API lets sellers configure their eBay seller accounts: manage business policies and custom policies, opt in to and out of seller programs, maintain sales tax tables, and read account information such as privileges, subscriptions and KYC status.
The eBay Account connector lets Ballerina applications call these operations with typed requests and responses. It supports version 1 of the eBay Account API.
Key features
- Create, read, update and delete fulfillment, payment and return business policies
- Manage seller-defined custom policies
- Opt in to and out of seller programs and list the programs a seller has joined
- Maintain per-jurisdiction sales tax tables, including bulk updates
- Read seller privileges, subscriptions, shipping rate tables, KYC status and advertising eligibility
Setup guide
To use the eBay Account connector, you need an eBay developer account and an application keyset. If you do not have a developer account, you can sign up for one.
Step 1: Create an application keyset
-
Sign in to the eBay Developer Program and open Application Keys.
-
Create a keyset for the Production environment and note down the App ID (Client ID) and Cert ID (Client Secret).
Step 2: Configure the OAuth settings
-
In the keyset's User Tokens section, create an eBay Redirect URL (RuName) for your application and set its accept and decline URLs.
-
Make sure the application is granted the following scopes:
https://api.ebay.com/oauth/api_scope/sell.accounthttps://api.ebay.com/oauth/api_scope/sell.account.readonly
Step 3: Get the user authorization
-
Open the Get a User Token Here link for your keyset and sign in as the seller. The consent flow redirects to your accept URL with an authorization code.
-
Exchange the authorization code for tokens:
curl -X POST https://api.ebay.com/identity/v1/oauth2/token \ -H "Content-Type: application/x-www-form-urlencoded" \ -H "Authorization: Basic $(echo -n 'CLIENT_ID:CLIENT_SECRET' | base64)" \ -d "grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=YOUR_RUNAME"
This returns an access_token and a refresh_token. Use the refresh token to configure the connector so that it can renew the access token automatically.
Replace:
CLIENT_IDwith your App IDCLIENT_SECRETwith your Cert IDAUTHORIZATION_CODEwith the URL-decoded code received on the redirectYOUR_RUNAMEwith your eBay Redirect URL name
Quickstart
To use the eBay Account connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
Import the ebay.account module.
import ballerinax/ebay.account;
Step 2: Instantiate a new connector
- Create a
Config.tomlfile and configure the credentials obtained in the steps above:
clientId = "<Client ID>" clientSecret = "<Client Secret>" refreshToken = "<Refresh Token>" refreshUrl = "https://api.ebay.com/identity/v1/oauth2/token"
- Create an
account:ConnectionConfigwith the OAuth 2.0 refresh-token credentials and initialize the connector with it.
configurable string clientId = ?; configurable string clientSecret = ?; configurable string refreshToken = ?; configurable string refreshUrl = ?; final account:Client ebay = check new ({ auth: { clientId, clientSecret, refreshToken, refreshUrl } });
Step 3: Invoke the connector operation
Now, utilize the available connector operations.
List the seller's fulfillment policies
public function main() returns error? { account:FulfillmentPolicyResponse _ = check ebay->getFulfillmentPolicies(marketplaceId = "EBAY_US"); }
Step 4: Run the Ballerina application
bal run
Examples
The eBay Account connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
-
Seller policy setup - List the fulfillment, payment and return policies of a marketplace and create any that are missing.
-
Sales tax table update - Review the sales tax table of a country, set the rate of one jurisdiction and read it back.
Clients
ebay.account: Client
The Account API gives sellers the ability to configure their eBay seller accounts, including the seller's policies (eBay business policies and seller-defined custom policies), opt in and out of eBay seller programs, configure sales tax tables, and get account information.
For details on the availability of the methods in this API, see Account API requirements and restrictions.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.ebay.com/sell/account/v1" - URL of the target service
getCustomPolicies
function getCustomPolicies(map<string|string[]> headers, *GetCustomPoliciesQueries queries) returns CustomPolicyResponse|errorList custom policies
Parameters
- queries *GetCustomPoliciesQueries - Queries to be sent with the request
Return Type
- CustomPolicyResponse|error - The retrieved custom policies
createCustomPolicy
function createCustomPolicy(CreateCustomPolicyHeaders headers, CustomPolicyCreateRequest payload) returns record {}|errorCreate a custom policy
Parameters
- headers CreateCustomPolicyHeaders - Headers to be sent with the request
- payload CustomPolicyCreateRequest - Request to create a new Custom Policy
Return Type
- record {}|error - Created
getCustomPolicy
function getCustomPolicy(string customPolicyId, map<string|string[]> headers) returns CustomPolicy|errorGet a custom policy
Parameters
- customPolicyId string - This path parameter is the unique identifier of the custom policy to retrieve.<br><br> This ID can be retrieved for a custom policy by using the <a href="/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicies" target="_blank ">getCustomPolicies</a> method
Return Type
- CustomPolicy|error - The retrieved custom policy
updateCustomPolicy
function updateCustomPolicy(string customPolicyId, UpdateCustomPolicyHeaders headers, CustomPolicyRequest payload) returns error?Update a custom policy
Parameters
- customPolicyId string - This path parameter is the unique identifier of the custom policy to update.<br><br><span class="tablenote"><b>Note:</b> A list of custom policies defined for a seller's account that includes this ID can be retrieved by calling the <a href="/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicies" target="_blank ">getCustomPolicies</a> method.</span>
- headers UpdateCustomPolicyHeaders - Headers to be sent with the request
- payload CustomPolicyRequest - Request to update a current custom policy
Return Type
- error? - No Content
createFulfillmentPolicy
function createFulfillmentPolicy(CreateFulfillmentPolicyHeaders headers, FulfillmentPolicyRequest payload) returns SetFulfillmentPolicyResponse|errorCreate a fulfillment policy
Parameters
- headers CreateFulfillmentPolicyHeaders - Headers to be sent with the request
- payload FulfillmentPolicyRequest - Request to create a seller account fulfillment policy
Return Type
- SetFulfillmentPolicyResponse|error - Created
getFulfillmentPolicy
function getFulfillmentPolicy(string fulfillmentPolicyId, map<string|string[]> headers) returns FulfillmentPolicy|errorGet a fulfillment policy
Parameters
- fulfillmentPolicyId string - This path parameter specifies the ID of the fulfillment policy you want to retrieve.<br><br> This ID can be retrieved for a fulfillment policy by using the <a href="/api-docs/sell/account/resources/fulfillment_policy/methods/getFulfillmentPolicies" target="_blank ">getFulfillmentPolicies</a> method
Return Type
- FulfillmentPolicy|error - The retrieved fulfillment policy
updateFulfillmentPolicy
function updateFulfillmentPolicy(string fulfillmentPolicyId, UpdateFulfillmentPolicyHeaders headers, FulfillmentPolicyRequest payload) returns SetFulfillmentPolicyResponse|errorUpdate a fulfillment policy
Parameters
- fulfillmentPolicyId string - This path parameter specifies the ID of the fulfillment policy you want to update.<br><br>This ID can be retrieved for a specific fulfillment policy by using the <a href="/api-docs/sell/account/resources/fulfillment_policy/methods/getFulfillmentPolicies" target="_blank ">getFulfillmentPolicies</a> method
- headers UpdateFulfillmentPolicyHeaders - Headers to be sent with the request
- payload FulfillmentPolicyRequest - Fulfillment policy request
Return Type
deleteFulfillmentPolicy
function deleteFulfillmentPolicy(string fulfillmentPolicyId, map<string|string[]> headers) returns error?Delete a fulfillment policy
Parameters
- fulfillmentPolicyId string - This path parameter specifies the ID of the fulfillment policy to delete.<br><br> This ID can be retrieved for a fulfillment policy by using the <a href="/api-docs/sell/account/resources/fulfillment_policy/methods/getFulfillmentPolicies" target="_blank ">getFulfillmentPolicies</a> method
Return Type
- error? - No Content
getFulfillmentPolicies
function getFulfillmentPolicies(GetFulfillmentPoliciesHeaders headers, *GetFulfillmentPoliciesQueries queries) returns FulfillmentPolicyResponse|errorList fulfillment policies
Parameters
- headers GetFulfillmentPoliciesHeaders (default {}) - Headers to be sent with the request
- queries *GetFulfillmentPoliciesQueries - Queries to be sent with the request
Return Type
- FulfillmentPolicyResponse|error - The retrieved fulfillment policies
getFulfillmentPolicyByName
function getFulfillmentPolicyByName(GetFulfillmentPolicyByNameHeaders headers, *GetFulfillmentPolicyByNameQueries queries) returns FulfillmentPolicy|errorGet a fulfillment policy by name
Parameters
- headers GetFulfillmentPolicyByNameHeaders (default {}) - Headers to be sent with the request
- queries *GetFulfillmentPolicyByNameQueries - Queries to be sent with the request
Return Type
- FulfillmentPolicy|error - The retrieved fulfillment policy by name
getPaymentPolicies
function getPaymentPolicies(GetPaymentPoliciesHeaders headers, *GetPaymentPoliciesQueries queries) returns PaymentPolicyResponse|errorList payment policies
Parameters
- headers GetPaymentPoliciesHeaders (default {}) - Headers to be sent with the request
- queries *GetPaymentPoliciesQueries - Queries to be sent with the request
Return Type
- PaymentPolicyResponse|error - The retrieved payment policies
createPaymentPolicy
function createPaymentPolicy(CreatePaymentPolicyHeaders headers, PaymentPolicyRequest payload) returns SetPaymentPolicyResponse|errorCreate a payment policy
Parameters
- headers CreatePaymentPolicyHeaders - Headers to be sent with the request
- payload PaymentPolicyRequest - Payment policy request
Return Type
- SetPaymentPolicyResponse|error - Created
getPaymentPolicy
function getPaymentPolicy(string paymentPolicyId, map<string|string[]> headers) returns PaymentPolicy|errorGet a payment policy
Parameters
- paymentPolicyId string - This path parameter specifies the ID of the payment policy you want to retrieve. <br><br> This ID can be retrieved for a payment policy by using the <a href="/api-docs/sell/account/resources/payment_policy/methods/getPaymentPolicies" target="_blank ">getPaymentPolices</a> method
Return Type
- PaymentPolicy|error - The retrieved payment policy
updatePaymentPolicy
function updatePaymentPolicy(string paymentPolicyId, UpdatePaymentPolicyHeaders headers, PaymentPolicyRequest payload) returns SetPaymentPolicyResponse|errorUpdate a payment policy
Parameters
- paymentPolicyId string - This path parameter specifies the ID of the payment policy you want to update. <br><br> This ID can be retrieved for a payment policy by using the <a href="/api-docs/sell/account/resources/payment_policy/methods/getPaymentPolicies" target="_blank ">getPaymentPolices</a> method
- headers UpdatePaymentPolicyHeaders - Headers to be sent with the request
- payload PaymentPolicyRequest - Payment policy request
Return Type
deletePaymentPolicy
Delete a payment policy
Parameters
- paymentPolicyId string - This path parameter specifies the unique identifier of the payment policy you want to delete.<br><br> This ID can be retrieved for a payment policy by using the <a href="/api-docs/sell/account/resources/payment_policy/methods/getPaymentPolicies" target="_blank ">getPaymentPolices</a> method
Return Type
- error? - No Content
getPaymentPolicyByName
function getPaymentPolicyByName(GetPaymentPolicyByNameHeaders headers, *GetPaymentPolicyByNameQueries queries) returns PaymentPolicy|errorGet a payment policy by name
Parameters
- headers GetPaymentPolicyByNameHeaders (default {}) - Headers to be sent with the request
- queries *GetPaymentPolicyByNameQueries - Queries to be sent with the request
Return Type
- PaymentPolicy|error - The retrieved payment policy by name
getPaymentsProgram
function getPaymentsProgram(string marketplaceId, string paymentsProgramType, map<string|string[]> headers) returns PaymentsProgramResponse|errorGet payments program status
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status
- paymentsProgramType string - This path parameter specifies the payments program whose status is returned by the call
Return Type
- PaymentsProgramResponse|error - The retrieved payments program
getPaymentsProgramOnboarding
function getPaymentsProgramOnboarding(string marketplaceId, string paymentsProgramType, map<string|string[]> headers) returns PaymentsProgramOnboardingResponse|errorGet payments program onboarding status
Parameters
- marketplaceId string - The eBay marketplace ID associated with the onboarding status to retrieve
- paymentsProgramType string - The type of payments program whose status is returned by the method
Return Type
- PaymentsProgramOnboardingResponse|error - The retrieved payments program onboarding
getPrivileges
function getPrivileges(map<string|string[]> headers) returns SellingPrivileges|errorGet seller privileges
Return Type
- SellingPrivileges|error - The retrieved privileges
getOptedInPrograms
List opted-in programs
optInToProgram
function optInToProgram(OptInToProgramHeaders headers, Program payload) returns record {}|errorOpt in to a program
Parameters
- headers OptInToProgramHeaders - Headers to be sent with the request
- payload Program - Program being opted-in to
Return Type
- record {}|error - The seller was opted in to the program
optOutOfProgram
function optOutOfProgram(OptOutOfProgramHeaders headers, Program payload) returns record {}|errorOpt out of a program
Parameters
- headers OptOutOfProgramHeaders - Headers to be sent with the request
- payload Program - Program being opted-out of
Return Type
- record {}|error - The seller was opted out of the program
getRateTables
function getRateTables(map<string|string[]> headers, *GetRateTablesQueries queries) returns RateTableResponse|errorList shipping rate tables
Parameters
- queries *GetRateTablesQueries - Queries to be sent with the request
Return Type
- RateTableResponse|error - The retrieved rate tables
getReturnPolicies
function getReturnPolicies(GetReturnPoliciesHeaders headers, *GetReturnPoliciesQueries queries) returns ReturnPolicyResponse|errorList return policies
Parameters
- headers GetReturnPoliciesHeaders (default {}) - Headers to be sent with the request
- queries *GetReturnPoliciesQueries - Queries to be sent with the request
Return Type
- ReturnPolicyResponse|error - The retrieved return policies
createReturnPolicy
function createReturnPolicy(CreateReturnPolicyHeaders headers, ReturnPolicyRequest payload) returns SetReturnPolicyResponse|errorCreate a return policy
Parameters
- headers CreateReturnPolicyHeaders - Headers to be sent with the request
- payload ReturnPolicyRequest - Return policy request
Return Type
- SetReturnPolicyResponse|error - Created
getReturnPolicy
function getReturnPolicy(string returnPolicyId, map<string|string[]> headers) returns ReturnPolicy|errorGet a return policy
Parameters
- returnPolicyId string - This path parameter specifies the unique identifier of the return policy you want to retrieve. <br><br> This ID can be retrieved for a return policy by using the <a href="/api-docs/sell/account/resources/return_policy/methods/getReturnPolicies" target="_blank ">getReturnPolicies</a> method
Return Type
- ReturnPolicy|error - The retrieved return policy
updateReturnPolicy
function updateReturnPolicy(string returnPolicyId, UpdateReturnPolicyHeaders headers, ReturnPolicyRequest payload) returns SetReturnPolicyResponse|errorUpdate a return policy
Parameters
- returnPolicyId string - This path parameter specifies the ID of the return policy you want to update. <br><br> This ID can be retrieved for a return policy by using the <a href="/api-docs/sell/account/resources/return_policy/methods/getReturnPolicies" target="_blank ">getReturnPolicies</a> method
- headers UpdateReturnPolicyHeaders - Headers to be sent with the request
- payload ReturnPolicyRequest - Container for a return policy request
Return Type
deleteReturnPolicy
Delete a return policy
Parameters
- returnPolicyId string - This path parameter specifies the unique identifier of the return policy you want to delete.<br><br> This ID can be retrieved for a return policy by using the <a href="/api-docs/sell/account/resources/return_policy/methods/getReturnPolicies" target="_blank ">getReturnPolicies</a> method
Return Type
- error? - No Content
getReturnPolicyByName
function getReturnPolicyByName(GetReturnPolicyByNameHeaders headers, *GetReturnPolicyByNameQueries queries) returns ReturnPolicy|errorGet a return policy by name
Parameters
- headers GetReturnPolicyByNameHeaders (default {}) - Headers to be sent with the request
- queries *GetReturnPolicyByNameQueries - Queries to be sent with the request
Return Type
- ReturnPolicy|error - The retrieved return policy by name
bulkCreateOrReplaceSalesTax
function bulkCreateOrReplaceSalesTax(BulkSalesTaxInput payload, map<string|string[]> headers) returns UpdatedSalesTaxResponse|error?Bulk create or replace sales tax entries
Parameters
- payload BulkSalesTaxInput - List of sales taxes to be updated
Return Type
- UpdatedSalesTaxResponse|error? - The result of each sales tax entry in the bulk request
getSalesTax
function getSalesTax(string countryCode, string jurisdictionId, map<string|string[]> headers) returns SalesTax|error?Get a sales tax entry
Parameters
- countryCode string - This path parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> code for the country whose sales tax table you want to retrieve.<br><br><span class="tablenote"><b>Note:</b> Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:<ul><li><code>US</code></li><li><code>CA</code></li></ul></span>
- jurisdictionId string - This path parameter specifies the ID of the sales tax jurisdiction for the tax table entry to be retrieved.<br><br>Valid jurisdiction IDs can be retrieved using the <a href="/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions" target="_blank ">getSalesTaxJurisdiction</a> method of the Metadata API.<br><br><span class="tablenote"><b>Note:</b> When <code>countryCode</code> is set to <code>US</code>, the only supported values for <code>jurisdictionId</code> are:<ul><li><code>AS</code> (American Samoa)</li><li><code>GU</code> (Guam</li><li><code>MP</code> Northern Mariana Islands</li><li><code>PW (Palau)</li><li><code>VI</code> (US Virgin Islands)</li></ul></span>
createOrReplaceSalesTax
function createOrReplaceSalesTax(string countryCode, string jurisdictionId, CreateOrReplaceSalesTaxHeaders headers, SalesTaxBase payload) returns error?Create or replace a sales tax entry
Parameters
- countryCode string - This path parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> code for the country for which you want to create a sales tax table entry.<br><br><span class="tablenote"><b>Note:</b> Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:<ul><li><code>US</code></li><li><code>CA</code></li></ul></span>
- jurisdictionId string - This path parameter specifies the ID of the tax jurisdiction for the table entry to be created.<br><br>Valid jurisdiction IDs can be retrieved using the <a href="/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions" target="_blank ">getSalesTaxJurisdiction</a> method of the Metadata API.<br><br><span class="tablenote"><b>Note:</b> When <code>countryCode</code> is set to <code>US</code>, the only supported values for <code>jurisdictionId</code> are:<ul><li><code>AS</code> (American Samoa)</li><li><code>GU</code> (Guam)</li><li><code>MP</code> (Northern Mariana Islands)</li><li><code>PW</code> (Palau)</li><li><code>VI</code> (US Virgin Islands)</li></ul></span>
- headers CreateOrReplaceSalesTaxHeaders - Headers to be sent with the request
- payload SalesTaxBase - A container that describes the how the sales tax is calculated
Return Type
- error? - No Content
deleteSalesTax
function deleteSalesTax(string countryCode, string jurisdictionId, map<string|string[]> headers) returns error?Delete a sales tax entry
Parameters
- countryCode string - This path parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> code for the country whose sales tax table entry you want to delete.<br><br><span class="tablenote"><b>Note:</b> Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:<ul><li><code>US</code></li><li><code>CA</code></li></ul></span>
- jurisdictionId string - This path parameter specifies the ID of the sales tax jurisdiction whose table entry you want to delete.<br><br>Valid jurisdiction IDs can be retrieved using the <a href="/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions" target="_blank ">getSalesTaxJurisdiction</a> method of the Metadata API.<br><br><span class="tablenote"><b>Note:</b> When <code>countryCode</code> is set to <code>US</code>, the only supported values for <code>jurisdictionId</code> are:<ul><li><code>AS</code> (American Samoa)</li><li><code>GU</code> (Guam)</li><li><code>MP</code> (Northern Mariana Islands)</li><li><code>PW</code> (Palau)</li><li><code>VI</code> (US Virgin Islands)</li></ul></span>
Return Type
- error? - Success
getSalesTaxes
function getSalesTaxes(map<string|string[]> headers, *GetSalesTaxesQueries queries) returns SalesTaxes|errorList sales tax entries
Parameters
- queries *GetSalesTaxesQueries - Queries to be sent with the request
Return Type
- SalesTaxes|error - The retrieved sales taxes
getSubscription
function getSubscription(map<string|string[]> headers, *GetSubscriptionQueries queries) returns SubscriptionResponse|errorList seller subscriptions
Parameters
- queries *GetSubscriptionQueries - Queries to be sent with the request
Return Type
- SubscriptionResponse|error - The retrieved subscription
getKYC
function getKYC(map<string|string[]> headers) returns KycResponse|error?Get seller KYC status
Return Type
- KycResponse|error? - OK
getAdvertisingEligibility
function getAdvertisingEligibility(GetAdvertisingEligibilityHeaders headers, *GetAdvertisingEligibilityQueries queries) returns SellerEligibilityMultiProgramResponse|errorGet advertising eligibility
Parameters
- headers GetAdvertisingEligibilityHeaders - Headers to be sent with the request
- queries *GetAdvertisingEligibilityQueries - Queries to be sent with the request
Return Type
- SellerEligibilityMultiProgramResponse|error - The retrieved advertising eligibility
Records
ebay.account: Amount
A complex type that describes the value of a monetary amount as represented by a global currency. When passing in an amount in a request payload, both currency and value fields are required, and both fields are also always returned for an amount in a response field
Fields
- currency? string - The base currency applied to the <b>value</b> field to establish a monetary amount. <br><br>The currency is represented as a 3-letter <a href="https://www.iso.org/iso-4217-currency-codes.html " title="https://www.iso.org " target="_blank">ISO 4217</a> currency code. For example, the code for the Canadian Dollar is <code>CAD</code>.<br><br><b>Default:</b> The default currency of the eBay marketplace that hosts the listing. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:CurrencyCodeEnum'>eBay API documentation</a>
- value? string - The monetary amount in the specified <b>currency</b>
ebay.account: BulkSalesTaxInput
Fields
- salesTaxInputList? SalesTaxInput[] - The array of sales-tax table entries to be created or updated
ebay.account: CategoryType
The category type discerns whether the policy applies to motor vehicle listings, or to any other items except motor vehicle listings.
Each business policy can be associated with either or both categories ('MOTORS_VEHICLES' and 'ALL_EXCLUDING_MOTORS_VEHICLES'); however, return business policies are not applicable for motor vehicle listings
Fields
- default? boolean - <span class="tablenote"><strong>Note:</strong> This field has been deprecated and is no longer used.<ul><li>Do not include this field in any <b>create</b> or <b>update</b> method.</li><li>This field may be returned within the payload of a <b>get</b> method, but it can be ignored.</li></ul></span>
- name? string - The category type to which the policy applies (motor vehicles or non-motor vehicles). <br><br><span class="tablenote"><strong>Note:</strong> The <code>MOTORS_VEHICLES</code> category type is not valid for return policies. eBay flows do not support the return of motor vehicles.</span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:CategoryTypeEnum'>eBay API documentation</a>
ebay.account: CompactCustomPolicyResponse
The response payload for requests that return a list of custom policies
Fields
- policyType? string - Specifies the type of Custom Policy being returned. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:CustomPolicyTypeEnum'>eBay API documentation</a>
- name? string - The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type.<br><br><span class="tablenote"><strong>Note:</strong> This field is visible only to the seller. </span><br><b>Max length:</b> 65
- customPolicyId? string - The unique custom policy identifier for the policy being returned.<br><br><span class="tablenote"><strong>Note:</strong> This value is automatically assigned by the system when the policy is created.</span>
- label? string - Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to the seller's policy information.<br><br><b>Max length:</b> 65
ebay.account: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
ebay.account: CreateCustomPolicyHeaders
Represents the Headers record for the operation: createCustomPolicy
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>
ebay.account: CreateFulfillmentPolicyHeaders
Represents the Headers record for the operation: createFulfillmentPolicy
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>
ebay.account: CreateOrReplaceSalesTaxHeaders
Represents the Headers record for the operation: createOrReplaceSalesTax
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>.<br><br>For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>
ebay.account: CreatePaymentPolicyHeaders
Represents the Headers record for the operation: createPaymentPolicy
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>
ebay.account: CreateReturnPolicyHeaders
Represents the Headers record for the operation: createReturnPolicy
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>
ebay.account: CustomPolicy
This container defines a seller's custom policy identified by policy ID for the selected eBay marketplace. A successful call returns the requested policy information
Fields
- policyType? string - Specifies the type of Custom Policy being returned. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:CustomPolicyTypeEnum'>eBay API documentation</a>
- name? string - The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type.<br><br><span class="tablenote"><strong>Note:</strong> This field is visible only to the seller. </span><br><b>Max length:</b> 65
- description? string - Contains the seller's policy and policy terms. Buyers access this information from the View Item page for items to which the policy has been applied.<br><br><b>Max length:</b> 15,000
- customPolicyId? string - The unique custom policy identifier for a policy
- label? string - Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to the seller's policy information.<br><br><b>Max length:</b> 65
ebay.account: CustomPolicyCreateRequest
This type is used by the request payload of the createCustomPolicy method to define a new custom policy for a specific marketplace
Fields
- policyType? string - Specifies the type of custom policy being created. <br><br>Two Custom Policy types are supported: <ul><li>Product Compliance (PRODUCT_COMPLIANCE)</li> <li>Takeback (TAKE_BACK)</li></ul> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:CustomPolicyTypeEnum'>eBay API documentation</a>
- name? string - The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type.<br><br><span class="tablenote"><strong>Note:</strong> This field is visible only to the seller. </span><br><b>Max length:</b> 65
- description? string - Contains the seller's policy and policy terms.<br><br><b>Max length:</b> 15,000
- label? string - Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to the seller's policy information.<br><br><b>Max length:</b> 65
ebay.account: CustomPolicyRequest
Fields
- name? string - The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type.<br><br><span class="tablenote"><strong>Note:</strong> This field is visible only to the seller. </span><br><br><span class="tablenote"><strong>Note:</strong> Always supply this field. If this field is not specified, any previous value is removed. Call the <a href="/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicy">getCustomPolicy</a> method to return the present field value for this policy.</span><br><b>Max length:</b> 65
- description? string - Contains the seller specified policy and policy terms.<br><br><span class="tablenote"><strong>Note:</strong> Always supply this field. If this field is not specified, any previous value is removed. Call the <a href="/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicy">getCustomPolicy</a> method to return the present field value for this policy.</span><br><b>Max length:</b> 15,000
- label? string - Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to seller specified policy information.<br><br><span class="tablenote"><strong>Note:</strong> Always supply this field. If this field is not specified, any previous value is removed. Call the <a href="/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicy">getCustomPolicy</a> method to return the present field value for this policy.</span><br><b>Max length:</b> 65
ebay.account: CustomPolicyResponse
Fields
- next? string - <i>This field is for future use.</i>
- customPolicies? CompactCustomPolicyResponse[] - This array contains the custom policies that match the input criteria
- total? Signed32 - <i>This field is for future use.</i>
- offset? Signed32 - <i>This field is for future use.</i>
- prev? string - <i>This field is for future use.</i>
- 'limit? Signed32 - <i>This field is for future use.</i>
- href? string - <i>This field is for future use.</i>
ebay.account: Deposit
This type is used to specify/indicate that an initial deposit is required for a motor vehicle listing
Fields
- amount? Amount - A complex type that describes the value of a monetary amount as represented by a global currency. When passing in an amount in a request payload, both <b>currency</b> and <b>value</b> fields are required, and both fields are also always returned for an amount in a response field
- paymentMethods? PaymentMethod[] - This array is no longer applicable and should not be used since eBay now manages the electronic payment options available to buyers to pay the deposit
- dueIn? TimeDuration - A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.<br><br>Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned
ebay.account: Error
A container that defines the elements of error and warning messages
Fields
- domain? string - Name of the domain ,or primary system, of the service or application where the error occurred
- subdomain? string - If present, indicates the subsystem in which the error occurred
- outputRefIds? string[] - Identifies specific response elements associated with the error, if any. Path format is the same as <code>inputRefId</code>
- errorId? Signed32 - A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms
- inputRefIds? string[] - Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use <i>JSONPath</i> notation
- category? string - The category type for this error or warning. It is a string that can have one of three values:<ul><li><code>Application</code>: Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency.</li><li><code>Business</code>: Used when your service or a dependent service refused to continue processing on the resource because of a business rule violation such as "Seller does not ship item to Antarctica" or "Buyer ineligible to purchase an alcoholic item". Business errors are not syntactical input errors.</li><li><code>Request</code>: Used when there is anything wrong with the request, such as authentication, syntactical errors, rate limiting or missing headers, bad HTTP header values, and so on.</li></ul>
- longMessage? string - A more detailed explanation of the error than given in the <code>message</code> error field
- message? string - Information on how to correct the problem, in the end user's terms and language where applicable. Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale
- parameters? ErrorParameter[] - This optional list of name/value pairs that contain context-specific <code>ErrorParameter</code> objects, with each item in the list being a parameter (or input field name) that caused an error condition. Each <code>ErrorParameter</code> object consists of two fields, a <code>name</code> and a <code>value</code>
ebay.account: ErrorParameter
A complex type that indicates a parameter that caused an error and the value of the parameter which caused the error
Fields
- name? string - Name of the parameter that caused the error
- value? string - The value of the parameter that caused the error
ebay.account: FulfillmentPolicy
This type is used by the fulfillmentPolicy response container, a container which defines a seller's fulfillment policy for a specific marketplace
Fields
- handlingTime? TimeDuration - A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.<br><br>Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned
- localPickup? boolean - If returned as <code>true</code>, local pickup is available for this policy
- marketplaceId? string - The ID of the eBay marketplace to which this fulfillment policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a>
- categoryTypes? CategoryType[] - This container indicates whether the fulfillment policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings
- name? string - A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. <br><br><b>Max length</b>: 64
- description? string - A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy. <br><br><b>Max length</b>: 250
- pickupDropOff? boolean - If returned as <code>true</code>, the seller offers the "Click and Collect" option. <br><br>Currently, "Click and Collect" is available only to large retail merchants the eBay AU, UK, DE, FR, and IT marketplaces
- fulfillmentPolicyId? string - A unique eBay-assigned ID for the fulfillment policy. This ID is generated when the policy is created
- globalShipping? boolean - <span class="tablenote"><b>Note</b>: This field is only applicable for the eBay United Kingdom marketplace (<code>EBAY_GB</code>).</span><br>If returned as <code>true</code>, eBay's Global Shipping Program will be used by the seller to ship items to international locations.<br><br>eBay International Shipping is an account level setting; no field needs to be set in a Fulfillment business policy to enable eBay International Shipping. If a US seller's account is opted in to eBay International Shipping, this shipping option will be enabled automatically for all listings where international shipping is available. A US seller who is opted in to eBay International Shipping can also specify individual international shipping service options for a Fulfillment business policy
- freightShipping? boolean - If returned as <code>true</code>, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs
- shippingOptions? ShippingOption[] - This array is used to provide detailed information on the domestic and international shipping options available for the policy. A separate <b>ShippingOption</b> object covers domestic shipping service options and international shipping service options (if the seller ships to international locations). <br><br>The <b>optionType</b> field indicates whether the <b>ShippingOption</b> object applies to domestic or international shipping, and the <b>costType</b> field indicates whether flat-rate shipping or calculated shipping will be used. <p>A separate <b>ShippingServices</b> object is used to specify cost and other details for every available domestic and international shipping service option. </p>
- shipToLocations? RegionSet - This type consists of the <b>regionIncluded</b> and <b>regionExcluded</b> arrays, which indicate the areas to where the seller does and doesn't ship
ebay.account: FulfillmentPolicyRequest
This root container defines a seller's fulfillment policy for a specific marketplace and category group. This type is used when creating or updating a fulfillment business policy
Fields
- handlingTime? TimeDuration - A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.<br><br>Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned
- localPickup? boolean - This field should be included and set to <code>true</code> if local pickup is one of the fulfillment options available to the buyer. It is possible for the seller to make local pickup and some shipping service options available to the buyer.<br><br>With local pickup, the buyer and seller make arrangements for pickup time and location.<br><br><b>Default</b>: <code>false</code>
- marketplaceId? string - The ID of the eBay marketplace to which this fulfillment policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a>
- categoryTypes? CategoryType[] - This container is used to specify whether the fulfillment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings
- name? string - A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. <br><br><b>Max length</b>: 64
- description? string - A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages. <br><br><b>Max length</b>: 250
- pickupDropOff? boolean - This field should be included and set to <code>true</code> if the seller offers the "Click and Collect" feature for an item. <p>To enable "Click and Collect" on a listing, a seller must be eligible for Click and Collect. Currently, Click and Collect is available to only large retail merchants selling in the eBay AU, UK, DE, FR, and IT marketplaces.</p> <p>In addition to setting this field to <code>true</code>, the merchant must also do the following 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. <p>Sellers can use the <b>createInventoryLocation</b> method in the Inventory API to associate physical stores to their account and they can then add inventory to specific store locations.</p></li><li>Set an immediate payment requirement on the item. The immediate payment feature requires the seller to: <ul><li>Set the <b>immediatePay</b> flag in the payment policy to 'true'.</li><li>Have a valid store location with a complete street address.</li></ul></li></ul><p>When a merchant successfully lists an item with Click and Collect, 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.</p><b>Default</b>: false
- globalShipping? boolean - <span class="tablenote"><b>Note</b>: This field is only applicable for the eBay United Kingdom marketplace (<code>EBAY_GB</code>).</span><br>This field is included and set to <code>true</code> if the seller wants to use the Global Shipping Program for international shipments. See the <a href="https://pages.ebay.com/help/sell/shipping-globally.html ">Global Shipping Program</a> help topic for more details and requirements on the Global Shipping Program.<br><br>A seller can use a combination of the Global Shipping Program and other international shipping services. <br><br>If set to <code>false</code> or if the field is omitted, the seller has to manually specifying individual international shipping services (if the seller ships internationally), as described in <a href="https://developer.ebay.com/api-docs/sell/static/seller-accounts/ht_shipping-worldwide.html ">Setting up worldwide shipping</a>. <br><br>Sellers opt in or out of the Global Shipping Program through the Shipping preferences in My eBay.<br><br>eBay International Shipping is an account level setting; no field needs to be set in a Fulfillment business policy to enable eBay International Shipping. If a US seller's account is opted in to eBay International Shipping, this shipping option will be enabled automatically for all listings where international shipping is available. A US seller who is opted in to eBay International Shipping can also specify individual international shipping service options for a Fulfillment business policy.<p><b>Default</b>: false</p>
- freightShipping? boolean - This field is included and set to <code>true</code> if freight shipping is available for the item. Freight shipping can be used for large items over 150 lbs.<br><br><b>Default</b>: false
- shippingOptions? ShippingOption[] - This array is used to provide detailed information on the domestic and international shipping options available for the policy. <br><br>A separate <b>ShippingOption</b> object is required for domestic shipping service options and for international shipping service options (if the seller ships to international locations). <ul><li>The <b>optionType</b> field is used to indicate whether the <b>ShippingOption</b> object applies to domestic or international shipping, and the <b>costType</b> field is used to indicate whether flat-rate shipping or calculated shipping will be used.</li> <li>The <b>rateTableId</b> field can be used to associate a defined shipping rate table to the policy, and the <b>packageHandlingCost</b> container can be used to set a handling charge for the policy.</li></ul> <p>A separate <b>ShippingServices</b> object will be used to specify cost and other details for every available domestic and international shipping service option. </p>
- shipToLocations? RegionSet - This type consists of the <b>regionIncluded</b> and <b>regionExcluded</b> arrays, which indicate the areas to where the seller does and doesn't ship
ebay.account: FulfillmentPolicyResponse
The response payload for the getFulfillmentPolicies method.
Note: Pagination has not yet been enabled for getFulfillmentPolicies, so all of the pagination-related fields are for future use.
Fields
- next? string - This field is for future use
- fulfillmentPolicies? FulfillmentPolicy[] - A list of all of the seller's fulfillment policies defined for the specified marketplace. This array will be returned as empty if no fulfillment policies are defined for the specified marketplace
- total? Signed32 - The total number of fulfillment policies retrieved in the result set. <br><br>If no fulfillment policies are defined for the specified marketplace, this field is returned with a value of <code>0</code>
- offset? Signed32 - This field is for future use
- prev? string - This field is for future use
- 'limit? Signed32 - This field is for future use
- href? string - This field is for future use
ebay.account: GetAdvertisingEligibilityHeaders
Represents the Headers record for the operation: getAdvertisingEligibility
Fields
- xEBAYCMARKETPLACEID string - The unique identifier of the eBay marketplace for which the seller eligibility status shall be checked. This header is required or the call will fail.<br><br>See the <a href="/api-docs/sell/account/types/ba:MarketplaceIdEnum " target="_blank ">MarketplaceIdEnum</a> type for the supported marketplace ID values
ebay.account: GetAdvertisingEligibilityQueries
Represents the Queries record for the operation: getAdvertisingEligibility
Fields
- programTypes? string - A comma-separated list of eBay advertising programs for which eligibility status will be returned.<br><br> See the <a href="/api-docs/sell/account/types/plser:AdvertisingProgramEnum" target="_blank"> AdvertisingProgramEnum</a> type for a list of supported values.<br><br>If no programs are specified, the results will be returned for all programs
ebay.account: GetCustomPoliciesQueries
Represents the Queries record for the operation: getCustomPolicies
Fields
- policyTypes? string - This query parameter specifies the type of custom policies to be returned.<br><br>Multiple policy types may be requested in a single call by providing a comma-delimited set of all policy types to be returned.<br><br><span class="tablenote"><strong>Note:</strong> Omitting this query parameter from a request will also return policies of all policy types.</span><br> See the <a href="/api-docs/sell/account/types/api:CustomPolicyTypeEnum" target="_blank ">CustomPolicyTypeEnum</a> type for a list of supported values
ebay.account: GetFulfillmentPoliciesHeaders
Represents the Headers record for the operation: getFulfillmentPolicies
Fields
- contentLanguage? string - Get the correct policies for a marketplace that supports multiple locales using the <code>Content-Language</code> request header. For example, get the policies for the French locale of the Canadian marketplace by specifying <code>fr-CA</code> for the <code>Content-Language</code> header. Likewise, target the Dutch locale of the Belgium marketplace by setting <code>Content-Language: nl-BE</code>. For details on header values, see <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank">HTTP request headers</a>
ebay.account: GetFulfillmentPoliciesQueries
Represents the Queries record for the operation: getFulfillmentPolicies
Fields
- marketplaceId string - This query parameter specifies the eBay marketplace of the policies you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum
ebay.account: GetFulfillmentPolicyByNameHeaders
Represents the Headers record for the operation: getFulfillmentPolicyByName
Fields
- contentLanguage? string - Get the correct policies for a marketplace that supports multiple locales using the <code>Content-Language</code> request header. For example, get the policies for the French locale of the Canadian marketplace by specifying <code>fr-CA</code> for the <code>Content-Language</code> header. Likewise, target the Dutch locale of the Belgium marketplace by setting <code>Content-Language: nl-BE</code>. For details on header values, see <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank">HTTP request headers</a>
ebay.account: GetFulfillmentPolicyByNameQueries
Represents the Queries record for the operation: getFulfillmentPolicyByName
Fields
- marketplaceId string - This query parameter specifies the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum
- name string - This query parameter specifies the seller-defined name of the fulfillment policy you want to retrieve.<br><br>This value can be retrieved for a fulfillment policy by using the <a href="/api-docs/sell/account/resources/fulfillment_policy/methods/getFulfillmentPolicies" target="_blank ">getFulfillmentPolicies</a> method
ebay.account: GetPaymentPoliciesHeaders
Represents the Headers record for the operation: getPaymentPolicies
Fields
- contentLanguage? string - Get the correct policies for a marketplace that supports multiple locales using the <code>Content-Language</code> request header. For example, get the policies for the French locale of the Canadian marketplace by specifying <code>fr-CA</code> for the <code>Content-Language</code> header. Likewise, target the Dutch locale of the Belgium marketplace by setting <code>Content-Language: nl-BE</code>. For details on header values, see <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank">HTTP request headers</a>
ebay.account: GetPaymentPoliciesQueries
Represents the Queries record for the operation: getPaymentPolicies
Fields
- marketplaceId string - This query parameter specifies the eBay marketplace of the policies you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum
ebay.account: GetPaymentPolicyByNameHeaders
Represents the Headers record for the operation: getPaymentPolicyByName
Fields
- contentLanguage? string - Get the correct policy for a marketplace that supports multiple locales using the <code>Content-Language</code> request header. For example, get a policy for the French locale of the Canadian marketplace by specifying <code>fr-CA</code> for the <code>Content-Language</code> header. Likewise, target the Dutch locale of the Belgium marketplace by setting <code>Content-Language: nl-BE</code>. For details on header values, see <a href="/api-docs/static/rest-request-components.html#HTTP">HTTP request headers</a>
ebay.account: GetPaymentPolicyByNameQueries
Represents the Queries record for the operation: getPaymentPolicyByName
Fields
- marketplaceId string - This query parameter specifies the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum
- name string - This query parameter specifies the seller-defined name of the payment policy you want to retrieve.<br><br> This value can be retrieved for a payment policy by using the <a href="/api-docs/sell/account/resources/payment_policy/methods/getPaymentPolicies" target="_blank ">getPaymentPolicies</a> method
ebay.account: GetRateTablesQueries
Represents the Queries record for the operation: getRateTables
Fields
- countryCode? string - This query parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> code of country for which you want shipping rate table information. If you do not specify a country code, the request returns all of the seller's defined shipping rate tables for all eBay marketplaces. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum
ebay.account: GetReturnPoliciesHeaders
Represents the Headers record for the operation: getReturnPolicies
Fields
- contentLanguage? string - Get the correct policies for a marketplace that supports multiple locales using the <code>Content-Language</code> request header. For example, get the policies for the French locale of the Canadian marketplace by specifying <code>fr-CA</code> for the <code>Content-Language</code> header. Likewise, target the Dutch locale of the Belgium marketplace by setting <code>Content-Language: nl-BE</code>. For details on header values, see <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank">HTTP request headers</a>
ebay.account: GetReturnPoliciesQueries
Represents the Queries record for the operation: getReturnPolicies
Fields
- marketplaceId string - This query parameter specifies the ID of the eBay marketplace of the policies you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum
ebay.account: GetReturnPolicyByNameHeaders
Represents the Headers record for the operation: getReturnPolicyByName
Fields
- contentLanguage? string - Get the correct policy for a marketplace that supports multiple locales using the <code>Content-Language</code> request header. For example, get a policy for the French locale of the Canadian marketplace by specifying <code>fr-CA</code> for the <code>Content-Language</code> header. Likewise, target the Dutch locale of the Belgium marketplace by setting <code>Content-Language: nl-BE</code>. For details on header values, see <a href="/api-docs/static/rest-request-components.html#HTTP">HTTP request headers</a>
ebay.account: GetReturnPolicyByNameQueries
Represents the Queries record for the operation: getReturnPolicyByName
Fields
- marketplaceId string - This query parameter specifies the ID of the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum
- name string - This query parameter specifies the seller-defined name of the return policy you want to retrieve.<br><br> This value can be retrieved for a return policy by using the <a href="/api-docs/sell/account/resources/return_policy/methods/getReturnPolicies" target="_blank ">getReturnPolicies</a> method
ebay.account: GetSalesTaxesQueries
Represents the Queries record for the operation: getSalesTaxes
Fields
- countryCode string - This path parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> code for the country whose tax table you want to retrieve.<br><br><span class="tablenote"><b>Note:</b> Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:<ul><li><code>US</code></li><li><code>CA</code></li></ul></span> For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum
ebay.account: GetSubscriptionQueries
Represents the Queries record for the operation: getSubscription
Fields
- continuationToken? string - This field is for future use
- 'limit? string - This field is for future use
ebay.account: InternationalReturnOverrideType
This type defines the fields for a seller's international return policy. Sellers have the ability to set separate domestic and international return policies, but if an international return policy is not set, the same return policy settings specified for the domestic return policy are also used for returns for international buyers.
Fields
- returnShippingCostPayer? string - This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either <code>BUYER</code> or <code>SELLER</code>. <br><br>Depending on the return policy and specifics of the 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 'significantly not as described' (SNAD) issues. <br><br>This field is conditionally required if the <b>internationalOverride.returnsAccepted</b> field is set to <code>true</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum'>eBay API documentation</a>
- returnMethod? string - This field sets/indicates if the seller offers replacement items to the buyer in the case of an international return. The buyer must be willing to accept a replacement item; otherwise, the seller will need to issue a refund for a return. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum'>eBay API documentation</a>
- returnsAccepted? boolean - If set to <code>true</code>, the seller accepts international returns. If set to <code>false</code>, the seller does not accept international returns. <br><br>This field is conditionally required if the seller chooses to have a separate international return policy
- returnPeriod? TimeDuration - A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.<br><br>Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned
ebay.account: KycCheck
This type is used to provide details about any KYC check that is applicable to the managed payments seller
Fields
- dataRequired? string - The enumeration value returned in this field categorizes the type of details needed for the KYC check. More information about the check is shown in the <b>detailMessage</b> and other applicable, corresponding fields. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/kyc:DetailsType'>eBay API documentation</a>
- remedyUrl? string - If applicable and available, a URL will be returned in this field, and the link will take the seller to an eBay page where they can provide the requested information
- alert? string - This field gives a short summary of what is required from the seller. An example might be, '<code>Upload bank document now.</code>'. The <b>detailMessage</b> field will often provide more details on what is required of the seller
- dueDate? string - The timestamp in this field indicates the date by which the seller should resolve the KYC requirement.<br><br>The timestamp in this field uses the UTC date and time format described in the <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601 Standard</a>. See below for this format and an example: <br><br><i>MM-DD-YYYY HH:MM:SS</i><br/><code>06-05-2020 10:34:18</code>
- detailMessage? string - This field gives a detailed message about what is required from the seller. An example might be, '<code>Please upload a bank document by 2020-08-01 to get your account back in good standing.</code>'
ebay.account: KycResponse
This is the base response type of the getKYC method
Fields
- kycChecks? KycCheck[] - This array contains one or more KYC checks required from a managed payments seller. The seller may need to provide more documentation and/or information about themselves, their company, or the bank account they are using for seller payouts.<br/><br/>If no KYC checks are currently required from the seller, this array is not returned, and the seller only receives a <code>204 No Content</code> HTTP status code
ebay.account: OAuth2RefreshTokenGrantConfig
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://api.ebay.com/identity/v1/oauth2/token") - Refresh URL
ebay.account: OptInToProgramHeaders
Represents the Headers record for the operation: optInToProgram
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>
ebay.account: OptOutOfProgramHeaders
Represents the Headers record for the operation: optOutOfProgram
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>
ebay.account: PaymentMethod
This type is used by the paymentMethods container, which is used by the seller to specify one or more offline payment methods.
Note: eBay now controls all electronic payment methods available for a marketplace, so a seller will no longer use this type to specify any electronic payment methods.
Fields
- recipientAccountReference? RecipientAccountReference - <span class="tablenote"><b>Note</b>: This type is no longer applicable. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods.</span>
- brands? string[] - <span class="tablenote"><b>Note</b>: This array is no longer applicable and should not be used. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods, including any credit card brands accepted. </span>
- paymentMethodType? string - This array is only applicable for listings supporting offline payment methods. See the <b>PaymentMethodTypeEnum</b> type for supported offline payment method enum values. If offline payments are enabled for the policy, provide at least one offline payment method.</p> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentMethodTypeEnum'>eBay API documentation</a>
ebay.account: PaymentPolicy
This type is used by the paymentPolicy response container, a container which defines a seller's payment business policy for a specific marketplace
Fields
- marketplaceId? string - The ID of the eBay marketplace to which the payment business policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a>
- categoryTypes? CategoryType[] - This container indicates whether the payment policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings
- paymentMethods? PaymentMethod[] - This container is returned to show the payment methods that are accepted for the payment business policy. <br><br>Sellers do not have to specify any electronic payment methods for listings, so this array will often be returned empty unless the payment business policy is intended for motor vehicle listings or other items in categories where offline payments are required or supported.
- name? string - A seller-defined name for this payment policy. Names must be unique for policies assigned to the same marketplace. <br><br><b>Max length</b>: 64
- paymentInstructions? string - Although this field may be returned for some older payment business policies, payment instructions are no longer supported by payment business policies. If this field is returned, it can be ignored and these payment instructions will not appear in any listings that use the corresponding business policy. <br><br><b>Max length</b>: 1000
- deposit? Deposit - This type is used to specify/indicate that an initial deposit is required for a motor vehicle listing
- description? string - A seller-defined description of the payment policy. This description is only for the seller's use, and is not exposed on any eBay pages. <br><br><b>Max length</b>: 250
- immediatePay? boolean - If this field is returned as <code>true</code>, immediate payment is required from the buyer for: <ul><li>A fixed-price item</li><li>An auction item where the buyer uses the 'Buy it Now' option</li><li>A deposit for a motor vehicle listing</li></ul><br>It is possible for the seller to set this field as <code>true</code> in the payment business policy, but it will not apply in some scenarios. For example, immediate payment is not applicable for auction listings that have a winning bidder, for buyer purchases that involve the Best Offer feature, or for transactions that happen offline between the buyer and seller
- paymentPolicyId? string - A unique eBay-assigned ID for a payment business policy. This ID is generated when the policy is created
- fullPaymentDueIn? TimeDuration - A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.<br><br>Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned
ebay.account: PaymentPolicyRequest
This root container defines a seller's payment business policy for a specific marketplace and category group. This type is used when creating or updating a payment business policy
Fields
- marketplaceId? string - The ID of the eBay marketplace to which this payment business policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a>
- categoryTypes? CategoryType[] - This container is used to specify whether the payment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings
- paymentMethods? PaymentMethod[] - <p 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.</p>This array is used to specify one or more offline payment methods that will be accepted for payment that occurs off of eBay's platform
- name? string - A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.<br><br><b>Max length:</b> 64
- paymentInstructions? string - <p class="tablenote"><b>Note:</b> DO NOT USE THIS FIELD. Payment instructions are no longer supported by payment business policies.</p>A free-form string field that allows sellers to add detailed payment instructions to their listings
- deposit? Deposit - This type is used to specify/indicate that an initial deposit is required for a motor vehicle listing
- description? string - A seller-defined description of the payment business policy. This description is only for the seller's use, and is not exposed on any eBay pages. <br><br><b>Max length</b>: 250
- immediatePay? boolean - 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><br><b>Default:</b> False
- fullPaymentDueIn? TimeDuration - A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.<br><br>Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned
ebay.account: PaymentPolicyResponse
The response payload for the getPaymentPolicies method.
Note: Pagination has not yet been enabled for getPaymentPolicies, so all of the pagination-related fields are for future use.
Fields
- next? string - This field is for future use
- total? Signed32 - The total number of payment business policies retrieved in the result set. <br><br>If no payment business policies are defined for the specified marketplace, this field is returned with a value of <code>0</code>
- offset? Signed32 - This field is for future use
- prev? string - This field is for future use
- 'limit? Signed32 - This field is for future use
- href? string - This field is for future use
- paymentPolicies? PaymentPolicy[] - A list of all of the seller's payment business policies defined for the specified marketplace. This array will be returned as empty if no payment business policies are defined for the specified marketplace
ebay.account: PaymentsProgramOnboardingResponse
Type used by the payments program onboarding response
Fields
- onboardingStatus? string - This enumeration value indicates the eligibility of payment onboarding for the registered site. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramOnboardingStatus'>eBay API documentation</a>
- steps? PaymentsProgramOnboardingSteps[] - An array of the active process steps for payment onboarding and the status of each step. This array includes the step <strong>name</strong>, step <strong>status</strong>, and a <strong>webUrl</strong> to the <code>IN_PROGRESS</code> step. The step names are returned in sequential order.
ebay.account: PaymentsProgramOnboardingSteps
The payments program onboarding steps, status, and link
Fields
- webUrl? string - This URL provides access to the <code>IN_PROGRESS</code> step
- name? string - The name of the step in the steps array. Over time, these names are subject to change as processes change. The output sample contains example step names. Review an actual call response for updated step names.
- status? string - This enumeration value indicates the status of the associated step. <p> <span class="tablenote"><strong>Note:</strong> Only one step can be <code>IN_PROGRESS</code> at a time.</span></p> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramOnboardingStepStatus'>eBay API documentation</a>
ebay.account: PaymentsProgramResponse
The response object containing the sellers status with regards to the specified payment program
Fields
- marketplaceId? string - The ID of the eBay marketplace to which the payment program applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a>
- wasPreviouslyOptedIn? boolean - If returned as <code>true</code>, the seller was at one point opted-in to the associated payment program, but they later opted out of the program. A value of <code>false</code> indicates the seller never opted-in to the program or if they did opt-in to the program, they never opted-out of it. <br><br>It's important to note that the setting of this field does not indicate the seller's current status regarding the payment program. It is possible for this field to return <code>true</code> while the <b>status</b> field returns <code>OPTED_IN</code>
- paymentsProgramType? string - This parameter specifies the payment program whose status is returned by the call. <br><br>Currently the only supported payments program is <code>EBAY_PAYMENTS</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramType'>eBay API documentation</a>
- status? string - The enumeration value returned in this field indicates whether or not the seller's account is enabled for the payments program. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramStatus'>eBay API documentation</a>
ebay.account: Program
The seller program to opt in to when part of an optInToProgram request, or out of when part of an optOutOfProgram request
Fields
- programType? string - The seller program to opt in to when part of an <b>optInToProgram</b> request, or out of when part of an <b>optOutOfProgram</b> request. When returned in an <b>getOptedInPrograms</b> response, a separate <b>programType</b> field is returned for each seller program that the seller is opted in to. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ProgramTypeEnum'>eBay API documentation</a>
ebay.account: Programs
The base response type of the getOptedInPrograms method
Fields
- programs? Program[] - An array of seller programs that the seller's account is opted in to. An empty array is returned if the seller is not opted in to any of the seller programs
ebay.account: RateTable
This type is used to provide details about each shipping rate table that is returned in the getRateTables response
Fields
- rateTableId? string - A unique eBay-assigned ID for a seller's shipping rate table. These <b>rateTableId</b> values are used to associate shipping rate tables to fulfillment business policies or directly to listings through an add/revise/relist call in the Trading API
- countryCode? string - A two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> country code representing the eBay marketplace where the shipping rate table is defined. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum'>eBay API documentation</a>
- locality? string - This enumeration value returned here indicates whether the shipping rate table is a domestic or international shipping rate table. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ShippingOptionTypeEnum'>eBay API documentation</a>
- name? string - The seller-defined name for the shipping rate table
ebay.account: RateTableResponse
This type is the base response of the getRateTables method
Fields
- rateTables? RateTable[] - An array of all shipping rate tables defined for a marketplace (or all marketplaces if no <b>country_code</b> query parameter is used). This array will be returned as empty if the seller has no defined shipping rate tables for the specified marketplace
ebay.account: RecipientAccountReference
Note: This type is no longer applicable. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods.
Fields
- referenceType? string - <span class="tablenote"><b>Note</b>: DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods.</span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:RecipientAccountReferenceTypeEnum'>eBay API documentation</a>
- referenceId? string - <span class="tablenote"><b>Note</b>: DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods.</span>
ebay.account: Region
This type is used to define specific shipping regions. There are four 'levels' of shipping regions, including large geographical regions (like 'Asia', 'Europe', or 'Middle East'), individual countries, US states or Canadian provinces, and special locations/domestic regions within a country (like 'Alaska/Hawaii' or 'PO Box')
Fields
- regionType? string - Reserved for future use. <!--The region's type, which can be one of the following: 'COUNTRY', 'COUNTRY_REGION', 'STATE_OR_PROVINCE', 'WORLD_REGION', or 'WORLDWIDE'.--> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:RegionTypeEnum'>eBay API documentation</a>
- regionName? string - A string that indicates the name of a region, as defined by eBay. A "region" can be either a 'world region' (e.g., the "Middle East" or "Southeast Asia"), a country (represented with a two-letter country code), a state or province (represented with a two-letter code), or a special domestic region within a country. <br><br>The <a href="/devzone/xml/docs/reference/ebay/GeteBayDetails.html">GeteBayDetails</a> call in the Trading API can be used to retrieve the world regions and special domestic regions within a specific country. To get these enumeration values, call <b>GeteBayDetails</b> with the <b>DetailName</b> value set to <b>ExcludeShippingLocationDetails</b>
ebay.account: RegionSet
This type consists of the regionIncluded and regionExcluded arrays, which indicate the areas to where the seller does and doesn't ship
Fields
- regionIncluded? Region[] - An array of one or more <b>regionName</b> fields that specify the areas to where a seller ships. <br>Each eBay marketplace supports its own set of allowable shipping locations.<br> <br><span class="tablenote"><b>Note: </b> The <b>regionIncluded</b> array is not applicable for motor vehicle business policies on the US, CA, or UK marketplaces. If this array is used in a <b>createFulfillmentPolicy</b> or <b>updateFulfillmentPolicy</b> request, it will be ignored.</span>
- regionExcluded? Region[] - An array of one or more <b>regionName</b> values that specify the areas to where a seller does not ship. A <b>regionExcluded</b> list should only be set in the top-level <b>shipToLocations</b> container and not within the <b>shippingServices.shipToLocations</b> container used to specify which shipping regions are serviced by each available shipping service option. <p>Many sellers are willing to ship to many international locations, but they may want to exclude some world regions or some countries as places they are willing to ship to.<br><br>This array will be returned as empty if no shipping regions are excluded with the fulfillment business policy.<br> <br><span class="tablenote"><b>Note: </b> The <b>regionExcluded</b> array is not applicable for motor vehicle business policies on the US, CA, or UK marketplaces. If this array is used in a <b>createFulfillmentPolicy</b> or <b>updateFulfillmentPolicy</b> request, it will be ignored.</span>
ebay.account: ReturnPolicy
This type is used by the returnPolicy response container, a container which defines a seller's return business policy for a specific marketplace
Fields
- returnShippingCostPayer? string - This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either <code>BUYER</code> or <code>SELLER</code>. <br><br>Depending on the return policy and specifics of the 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. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum'>eBay API documentation</a>
- categoryTypes? CategoryType[] - This container indicates which category group that the return policy applies to.<br><br><span class="tablenote"><b>Note</b>: Return business policies are not applicable to motor vehicle listings, so the <b>categoryTypes.name</b> value will always be <code>ALL_EXCLUDING_MOTORS_VEHICLES</code> for return business policies.</span>
- refundMethod? string - This field indicates the refund method offered by the seller. Its value will be <code>MONEY_BACK</code> unless the seller is enabled for <b>Buy online, Pickup in Store</b> or <b>Click and Collect</b>, and then it might be <code>MERCHANDISE_CREDIT</code>. Getting their money back for returned items is always an option for buyers, regardless of what the seller sets in this field. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:RefundMethodEnum'>eBay API documentation</a>
- description? string - A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages. <br><br><b>Max length</b>: 250
- restockingFeePercentage? string - <p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored and it is no longer returned.</p>
- returnInstructions? string - This text-based field provides more details on seller-specified return instructions. This field is only returned if set for the return business policy.<br><p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call <a href="/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies">getReturnPolicies</a> method of the <b>Metadata API</b>. Then you will look for the <b>policyDescriptionEnabled</b> field with a value of <code>true</code> for the eBay category.</span></p><br><b>Max length</b>: 5000 (8000 for DE)
- returnPeriod? TimeDuration - A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.<br><br>Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned
- marketplaceId? string - The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a>
- internationalOverride? InternationalReturnOverrideType - This type defines the fields for a seller's international return policy. Sellers have the ability to set separate domestic and international return policies, but if an international return policy is not set, the same return policy settings specified for the domestic return policy are also used for returns for international buyers.
- returnMethod? string - This field is only returned if the seller is willing to offer a replacement item as an alternative to 'Money Back'. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum'>eBay API documentation</a>
- returnPolicyId? string - A unique eBay-assigned ID for a return business policy. This ID is generated when the policy is created
- name? string - A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace.<br><br><b>Max length:</b> 64
- returnsAccepted? boolean - If this field is returned as <code>true</code>, the seller accepts returns. If set to <code>false</code>, the seller does not accept returns.<br><br><span class="tablenote"><strong>Note:</strong> Top-Rated sellers must accept item returns and the <b>handlingTime</b> should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay's Top-Rated seller program, see <a href="https://pages.ebay.com/help/sell/top-rated.html ">Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits</a>.</span>
- extendedHolidayReturnsOffered? boolean - <p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.</p>
ebay.account: ReturnPolicyRequest
This root container defines a seller's return business policy for a specific marketplace and category group. This type is used when creating or updating a return business policy
Fields
- returnShippingCostPayer? string - This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either <code>BUYER</code> or <code>SELLER</code>. <p><span class="tablenote"><span style="color:#004680"><strong>Note: </strong>Eligible Parts & Accessories (P&A) listings require sellers to offer buyers free returns with a minimum return period of 30 days. See <a href="/api-docs/user-guides/static/trading-user-guide/ebay-motors-parts-accessories-easy-returns.html" target="_blank">Support for easy returns in Parts and Accessories</a> for details.</span></p> <br>Depending on the return policy and specifics of the 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>This field is conditionally required if <b>returnsAccepted</b> is set to <code>true</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum'>eBay API documentation</a>
- categoryTypes? CategoryType[] - This container indicates which category group that the return policy applies to.<br><br><span class="tablenote"><b>Note</b>: Return business policies are not applicable to motor vehicle listings, so the <b>categoryTypes.name</b> value must be set to <code>ALL_EXCLUDING_MOTORS_VEHICLES</code> for return business policies.</span>
- refundMethod? string - This field sets the refund method to use for returned items. Its value defaults to <code>MONEY_BACK</code> if omitted, so this field is only needed for <b>Buy online, Pickup in Store</b> or <b>Click and Collect</b> items where the seller is willing to offer merchandise credit as an additional refund method to buyers. Getting their money back for returned items is always an option for buyers, regardless of what the seller sets in this field.<p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> If this field is not included in a return business policy, it will default to <code>MONEY_BACK</code>.</p> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:RefundMethodEnum'>eBay API documentation</a>
- description? string - A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages. <br><br><b>Max length</b>: 250
- restockingFeePercentage? string - <p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored.</p>
- returnInstructions? string - This text-based field provides more details on seller-specified return instructions. <br><p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call <a href="/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies">getReturnPolicies</a> method of the <b>Metadata API</b>. Then you will look for the <b>policyDescriptionEnabled</b> field with a value of <code>true</code> for the eBay category.</span></p><br><b>Max length</b>: 5000 (8000 for DE)
- returnPeriod? TimeDuration - A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.<br><br>Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned
- marketplaceId? string - The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a>
- internationalOverride? InternationalReturnOverrideType - This type defines the fields for a seller's international return policy. Sellers have the ability to set separate domestic and international return policies, but if an international return policy is not set, the same return policy settings specified for the domestic return policy are also used for returns for international buyers.
- returnMethod? string - This field can be used if the seller is willing and able to offer a replacement item as an alternative to 'Money Back'. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum'>eBay API documentation</a>
- name? string - A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace. <br><br><b>Max length</b>: 64
- returnsAccepted? boolean - If set to <code>true</code>, the seller accepts returns. If set to <code>false</code>, the seller does not accept returns.<br><p><span class="tablenote"><strong>Note:</strong>Top-Rated sellers must accept item returns and the <b>handlingTime</b> should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay's Top-Rated seller program, see <a href="http://pages.ebay.com/help/sell/top-rated.html ">Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits</a>.</span></p>
- extendedHolidayReturnsOffered? boolean - <p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.</p>
ebay.account: ReturnPolicyResponse
The response payload for the getReturnPolicies method.
Note: Pagination has not yet been enabled for getReturnPolicies, so all of the pagination-related fields are for future use.
Fields
- next? string - This field is for future use
- total? Signed32 - The total number of return business policies retrieved in the result set. <br><br>If no return business policies are defined for the specified marketplace, this field is returned with a value of <code>0</code>
- offset? Signed32 - This field is for future use
- prev? string - This field is for future use
- 'limit? Signed32 - This field is for future use
- returnPolicies? ReturnPolicy[] - A list of all of the seller's return business policies defined for the specified marketplace. This array will be returned as empty if no return business policies are defined for the specified marketplace
- href? string - This field is for future use
ebay.account: SalesTax
This type is used to provide sales tax settings for a specific tax jurisdiction
Fields
- countryCode? string - The country code enumeration value identifies the country to which this sales tax rate applies.<br><br><span class="tablenote"><b>Note:</b> Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:<ul><li><code>US</code></li><li><code>CA</code></li></ul></span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum'>eBay API documentation</a>
- salesTaxJurisdictionId? string - A unique ID that identifies the sales tax jurisdiction to which the sales tax rate applies.<br><br><span class="tablenote"><b>Note:</b> When the returned <code>countryCode</code> is <code>US</code>, the only supported return values for <code>salesTaxJurisdictionId</code> are:<ul><li><code>AS</code> (American Samoa)</li><li><code>GU</code> (Guam</li><li><code>MP</code> Northern Mariana Islands</li><li><code>PW (Palau)</li><li><code>VI</code> (US Virgin Islands)</li></ul></span>
- salesTaxPercentage? string - The sales tax rate that will be applied to sales price. The <b>shippingAndHandlingTaxed</b> value will indicate whether or not sales tax is also applied to shipping and handling charges<br><br>Although it is a string, a percentage value is returned here, such as <code>7.75</code>
- shippingAndHandlingTaxed? boolean - If returned as <code>true</code>, sales tax is also applied to shipping and handling charges, and not just the total sales price of the order
ebay.account: SalesTaxBase
This type is used by the base request of the createOrReplaceSalesTax.
Fields
- salesTaxPercentage? string - This field is used to set the sales tax rate for the tax jurisdiction set in the call URI. When applicable to an order, this sales tax rate will be applied to sales price. The <b>shippingAndHandlingTaxed</b> value will indicate whether or not sales tax is also applied to shipping and handling charges<br><br>Although it is a string, a percentage value is set here, such as <code>7.75</code>
- shippingAndHandlingTaxed? boolean - This field is set to <code>true</code> if the seller wishes to apply sales tax to shipping and handling charges, and not just the total sales price of the order. Otherwise, this field's value should be set to <code>false</code>
ebay.account: SalesTaxes
This type is used by the root response of the getSalesTaxes method
Fields
- salesTaxes? SalesTax[] - An array of one or more sales-tax rate entries for a specified country.<br><br>If no sales-tax rate entries are set up, no response payload is returned, but an HTTP status code of <code>204 No Content</code> is returned
ebay.account: SalesTaxInput
Fields
- countryCode? string - This parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> code of the country for which a sales-tax table entry is to be created or updated.<br><br><span class="tablenote"><b>Note:</b> Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:<ul><li><code>US</code></li><li><code>CA</code></li></ul></span>
- salesTaxJurisdictionId? string - This parameter specifies the ID of the tax jurisdiction for which a sales-tax table entry is to be created or updated.<br><br>Valid jurisdiction IDs can be retrieved using the <a href="/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions" target="_blank ">getSalesTaxJurisdiction</a> method of the Metadata API.<br><br><span class="tablenote"><b>Note:</b> When <code>countryCode</code> is set to <code>US</code>, the only supported values for <code>jurisdictionId</code> are:<ul><li><code>AS</code> (American Samoa)</li><li><code>GU</code> (Guam)</li><li><code>MP</code> (Northern Mariana Islands)</li><li><code>PW</code> (Palau)</li><li><code>VI</code> (US Virgin Islands)</li></ul></span>
- salesTaxPercentage? string - This parameter specifies the sales tax rate for the specified <b>salesTaxJurisdictionId</b>. When applicable to an order, this sales tax rate will be applied to the sales price. The <b>shippingAndHandlingTaxed</b> value indicates whether or not sales tax is also applied to shipping and handling charges<br><br>Although it is a string, a percentage value is set here, such as <code>7.75</code>
- shippingAndHandlingTaxed? boolean - This parameter is set to <code>true</code> if the seller wishes to apply sales tax to shipping and handling charges and not just the total sales price of an order. Otherwise, this parameter's value should be set to <code>false</code>
ebay.account: SellerEligibilityMultiProgramResponse
The base response of the getAdvertisingEligibility method that contains the seller eligibility information for one or more advertising programs
Fields
- advertisingEligibility? SellerEligibilityResponse[] - An array of response fields that define the seller eligibility for eBay advertising programs
ebay.account: SellerEligibilityResponse
A type that is used to provide the seller's eligibility status for an eBay advertising program
Fields
- reason? string - The reason why a seller is ineligible for the specified eBay advertising program.<br /><br />This field is only returned if the seller is ineligible for the eBay advertising program. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/plser:SellerIneligibleReasonEnum'>eBay API documentation</a>
- programType? string - The eBay advertising program for which a seller may be eligible. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/plser:AdvertisingProgramEnum'>eBay API documentation</a>
- status? string - The seller eligibility status for the specified eBay advertising program. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/cmlib:SellerEligibilityEnum'>eBay API documentation</a>
ebay.account: SellingLimit
Type used by the sellingLimit container, a container that lists the monthly cap for the quantity of items sold and total sales amount allowed for the seller's account
Fields
- amount? Amount - A complex type that describes the value of a monetary amount as represented by a global currency. When passing in an amount in a request payload, both <b>currency</b> and <b>value</b> fields are required, and both fields are also always returned for an amount in a response field
- quantity? Signed32 - This field shows the monthly cap for total quantity sold allowed for the seller's account. This field may not be returned if a seller does not have a monthly cap for total quantity sold
ebay.account: SellingPrivileges
This type is used by the base response of the getPrivileges method
Fields
- sellerRegistrationCompleted? boolean - If this field is returned as <code>true</code>, the seller's registration is completed. If this field is returned as <code>false</code>, the registration process is not complete
- sellingLimit? SellingLimit - Type used by the <b>sellingLimit</b> container, a container that lists the monthly cap for the quantity of items sold and total sales amount allowed for the seller's account
ebay.account: SetFulfillmentPolicyResponse
Complex type that that gets populated with a response containing a fulfillment policy
Fields
- handlingTime? TimeDuration - A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.<br><br>Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned
- categoryTypes? CategoryType[] - This container indicates whether the fulfillment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings
- warnings? Error[] - An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty
- description? string - A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy. <br><br><b>Max length</b>: 250
- globalShipping? boolean - <span class="tablenote"><b>Note</b>: This field is only applicable for the eBay United Kingdom marketplace (<code>EBAY_GB</code>).</span><br>This field is included and set to <code>true</code> if the seller wants to use the Global Shipping Program for international shipments. See the <a href="https://pages.ebay.com/help/sell/shipping-globally.html ">Global Shipping Program</a> help topic for more details and requirements on the Global Shipping Program.<br><br>A seller can use a combination of the Global Shipping Program and other international shipping services. <br><br>If set to <code>false</code> or if the field is omitted, the seller has to manually specifying individual international shipping services (if the seller ships internationally), as described in <a href="https://developer.ebay.com/api-docs/sell/static/seller-accounts/ht_shipping-worldwide.html ">Setting up worldwide shipping</a>. <br><br>Sellers opt in or out of the Global Shipping Program through the Shipping preferences in My eBay.<br><br>eBay International Shipping is an account level setting; no field needs to be set in a Fulfillment business policy to enable eBay International Shipping. If a US seller's account is opted in to eBay International Shipping, this shipping option will be enabled automatically for all listings where international shipping is available. A US seller who is opted in to eBay International Shipping can also specify individual international shipping service options for a Fulfillment business policy.</span>
- localPickup? boolean - If returned as <code>true</code>, local pickup is available for items using this policy
- marketplaceId? string - The ID of the eBay marketplace to which this fulfillment business policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a>
- name? string - A seller-defined name for this fulfillment business policy. <br><br><b>Max length</b>: 64
- pickupDropOff? boolean - If returned as <code>true</code>, the seller offers the "Click and Collect" option. <br><br>Currently, "Click and Collect" is available only to large retail merchants the eBay AU, UK, DE, FR, and IT marketplaces
- fulfillmentPolicyId? string - A unique eBay-assigned ID for a fulfillment business policy. This ID is generated when the policy is created
- freightShipping? boolean - If returned as <code>true</code>, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs
- shippingOptions? ShippingOption[] - This array is used to provide detailed information on the domestic and international shipping options available for the policy. A separate <b>ShippingOption</b> object covers domestic shipping service options and international shipping service options (if the seller ships to international locations). <br><br>The <b>optionType</b> field indicates whether the <b>ShippingOption</b> object applies to domestic or international shipping, and the <b>costType</b> field indicates whether flat-rate shipping or calculated shipping will be used. <p>A separate <b>ShippingServices</b> object is used to specify cost and other details for every available domestic and international shipping service option. </p>
- shipToLocations? RegionSet - This type consists of the <b>regionIncluded</b> and <b>regionExcluded</b> arrays, which indicate the areas to where the seller does and doesn't ship
ebay.account: SetPaymentPolicyResponse
Complex type that that gets populated with a response containing a payment policy
Fields
- marketplaceId? string - The ID of the eBay marketplace to which this payment business policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a>
- categoryTypes? CategoryType[] - This container indicates whether the payment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings
- paymentMethods? PaymentMethod[] - This array shows the available payment methods that the seller has set for the payment business policy.<br><br>Sellers do not have to specify any electronic payment methods for listings, so this array will often be returned empty unless the payment business policy is intended for motor vehicle listings or other items in categories where offline payments are required or supported
- warnings? Error[] - An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty
- name? string - A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.<br><br><b>Max length:</b> 64
- paymentInstructions? string - <p class="tablenote"><b>Note:</b> NO LONGER SUPPORTED. Although this field may be returned for some older payment business policies, payment instructions are no longer supported by payment business policies. If this field is returned, it can be ignored and these payment instructions will not appear in any listings that use the corresponding business policy.</p>A free-form string field that allows sellers to add detailed payment instructions to their listings
- deposit? Deposit - This type is used to specify/indicate that an initial deposit is required for a motor vehicle listing
- description? string - A seller-defined description of the payment business policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy. <br><br><b>Max length</b>: 250
- immediatePay? boolean - The value returned in this field will reflect the value set by the seller in the <b>immediatePay</b> request field. A value of <code>true</code> indicates that immediate payment is required 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><br>It is possible for the seller to set this field as <code>true</code> in the payment business policy, but it will not apply in some scenarios. For example, immediate payment is not applicable for auction listings that have a winning bidder, for buyer purchases that involve the Best Offer feature, or for transactions that happen offline between the buyer and seller
- paymentPolicyId? string - A unique eBay-assigned ID for a payment business policy. This ID is generated when the policy is created
- fullPaymentDueIn? TimeDuration - A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.<br><br>Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned
ebay.account: SetReturnPolicyResponse
A complex type that is populated with a response containing a return policies
Fields
- returnShippingCostPayer? string - This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either <code>BUYER</code> or <code>SELLER</code>. <p><span class="tablenote"><span style="color:#004680"><strong>Note: </strong>Eligible Parts & Accessories (P&A) listings require sellers to offer buyers free returns with a minimum return period of 30 days. See <a href="/api-docs/user-guides/static/trading-user-guide/ebay-motors-parts-accessories-easy-returns.html" target="_blank">Support for easy returns in Parts and Accessories</a> for details.</span></p> <br>Note that the seller is always responsible for return shipping costs for SNAD-related issues. <br><br>This container will be returned unless the business policy states that the seller does not accept returns. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum'>eBay API documentation</a>
- categoryTypes? CategoryType[] - This field always returns <code>ALL_EXCLUDING_MOTORS_VEHICLES</code> for return business policies, since return business policies are not applicable to motor vehicle listings
- refundMethod? string - If a seller indicates that they will accept buyer returns, this value will be <code>MONEY_BACK</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:RefundMethodEnum'>eBay API documentation</a>
- warnings? Error[] - An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty
- description? string - A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy. <br><br><b>Max length</b>: 250
- restockingFeePercentage? string - <p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns.</p>
- returnInstructions? string - This text-based field provides more details on seller-specified return instructions. <br><p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call <a href="/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies">getReturnPolicies</a> method of the <b>Metadata API</b>. Then you will look for the <b>policyDescriptionEnabled</b> field with a value of <code>true</code> for the eBay category.</span></p><br><b>Max length</b>: 5000 (8000 for DE)
- returnPeriod? TimeDuration - A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.<br><br>Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned
- marketplaceId? string - The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a>
- internationalOverride? InternationalReturnOverrideType - This type defines the fields for a seller's international return policy. Sellers have the ability to set separate domestic and international return policies, but if an international return policy is not set, the same return policy settings specified for the domestic return policy are also used for returns for international buyers.
- returnMethod? string - This field will be returned if the seller is willing and able to offer a replacement item as an alternative to 'Money Back'. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum'>eBay API documentation</a>
- returnPolicyId? string - A unique eBay-assigned ID for a return business policy. This ID is generated when the policy is created
- name? string - A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace.<br><br><b>Max length:</b> 64
- returnsAccepted? boolean - If set to <code>true</code>, the seller accepts returns. If set to <code>false</code>, this field indicates that the seller does not accept returns
- extendedHolidayReturnsOffered? boolean - <p class="tablenote"><span style="color: #dd1e31;"><b>Important!</b></span> This field is deprecated, since eBay no longer supports extended holiday returns. This field should no longer be returned.</p>
ebay.account: ShippingOption
This type is used by the shippingOptions array, which is used to provide detailed information on the domestic and international shipping options available for the policy. A separate ShippingOption object covers domestic shipping service options and international shipping service options (if the seller ships to international locations)
Fields
- optionType? string - This field is used to indicate if the corresponding shipping service options (under <b>shippingServices</b> array) are domestic or international shipping service options. This field is conditionally required if any shipping service options are specified (domestic and/or international). For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ShippingOptionTypeEnum'>eBay API documentation</a>
- insuranceFee? Amount - A complex type that describes the value of a monetary amount as represented by a global currency. When passing in an amount in a request payload, both <b>currency</b> and <b>value</b> fields are required, and both fields are also always returned for an amount in a response field
- rateTableId? string - This field is used if the seller wants to associate a domestic or international shipping rate table to the fulfillment business policy. The <a href="/api-docs/sell/account/resources/rate_table/methods/getRateTables">getRateTables</a> method can be used to retrieve shipping rate table IDs.<br><br>With domestic and international shipping rate tables, the seller can set different shipping costs based on shipping regions and shipping speed/level of service (one-day, expedited, standard, economy). There are also options to add additional per-weight and handling charges.<br><br>Sellers need to be careful that shipping rate tables match the corresponding shipping service options. In other words, a domestic shipping rate table must not be specified in the same container where international shipping service options are being specified, and vice versa, and the shipping speed/level of service of the provided shipping service options should match the shipping speed/level of service options that are defined in the shipping rate tables. <br><br>For example, if the corresponding shipping rate table defines costs for one-day shipping services, there should be at least one one-day shipping service option specified under the <b>shippingServices</b> array.<br><br>This field is returned if set
- shippingPromotionOffered? boolean - This boolean indicates whether or not the seller has set up a promotional shipping discount that will be available to buyers who satisfy the requirements of the shipping discount rule. <br><br>The seller can create and manage shipping promotional discounts using (Get/Set) <b>ShippingDiscountProfiles</b> calls in the <b>Trading API</b> or through the <b>Shipping Preferences</b> in <b>My eBay</b>
- costType? string - This field defines whether the shipping cost model is <code>FLAT_RATE</code> (the same rate for all buyers, or buyers within a region if shipping rate tables are used) or <code>CALCULATED</code> (the shipping rate varies by the ship-to location and size and weight of the package). <br><br>This field is conditionally required if any shipping service options are specified (domestic and/or international). For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ShippingCostTypeEnum'>eBay API documentation</a>
- insuranceOffered? boolean - This field has been deprecated. <br><br>Shipping insurance is offered only via a shipping carrier's shipping services and is no longer available via eBay shipping policies
- packageHandlingCost? Amount - A complex type that describes the value of a monetary amount as represented by a global currency. When passing in an amount in a request payload, both <b>currency</b> and <b>value</b> fields are required, and both fields are also always returned for an amount in a response field
- shippingDiscountProfileId? string - This field is the unique identifier of a seller's domestic or international shipping discount profile. If a buyer satisfies the requirements of the discount rule, this buyer will receive a shipping discount for the order. <br><br>The seller can create and manage shipping discount profiles using (Get/Set) <b>ShippingDiscountProfiles</b> calls in the <b>Trading API</b> or through the <b>Shipping Preferences</b> in <b>My eBay</b>
- shippingServices? ShippingService[] - This array consists of the domestic or international shipping services options that are defined for the policy. The shipping service options defined under this array should match what is set in the corresponding <b>shippingOptions.optionType</b> field (which controls whether domestic or international shipping service options are being defined). If a shipping rate table is being used, the specified shipping service options should also match the shipping rate table settings (domestic or international, shipping speed/level of service, etc.) <br><br>Sellers can specify up to four domestic shipping services and up to five international shipping service options by using separate <b>shippingService</b> containers for each. If the seller is using the Global Shipping Program as an international option, only a total of four international shipping service options (including GSP) can be offered. <br><br> See <a href="/api-docs/sell/static/seller-accounts/ht_shipping-setting-shipping-carrier-and-service-values.html" target="_blank">How to set up shipping carrier and shipping service values</a>. <br><br>To use the eBay standard envelope service (eSE), see <a href="/api-docs/sell/static/seller-accounts/using-the-ebay-standard-envelope-service.html" target="_blank">Using eBay standard envelope (eSE) service</a>.<br><br>This array is conditionally required if the seller is offering one or more domestic and/or international shipping service options
ebay.account: ShippingService
This type is used by the shippingServices array, an array that provides details about every domestic and international shipping service option that is defined for the policy
Fields
- surcharge? Amount - A complex type that describes the value of a monetary amount as represented by a global currency. When passing in an amount in a request payload, both <b>currency</b> and <b>value</b> fields are required, and both fields are also always returned for an amount in a response field
- buyerResponsibleForPickup? boolean - This field should be included and set to <code>true</code> for a motor vehicle listing if it will be the buyer's responsibility to pick up the purchased motor vehicle after full payment is made. <br><br>This field is only applicable to motor vehicle listings. In the majority of motor vehicle listings, the seller does make the buyer responsible for pickup or shipment of the vehicle. <br><br>This field is returned if set.<br><br><b>Default</b>: false
- buyerResponsibleForShipping? boolean - This field should be included and set to <code>true</code> for a motor vehicle listing if it will be the buyer's responsibility to arrange for shipment of a motor vehicle. <br><br>This field is only applicable to motor vehicle listings. In the majority of motor vehicle listings, the seller does make the buyer responsible for pickup or shipment of the vehicle. <br><br>This field is returned if set.<br><br><b>Default</b>: false
- shippingCost? Amount - A complex type that describes the value of a monetary amount as represented by a global currency. When passing in an amount in a request payload, both <b>currency</b> and <b>value</b> fields are required, and both fields are also always returned for an amount in a response field
- additionalShippingCost? Amount - A complex type that describes the value of a monetary amount as represented by a global currency. When passing in an amount in a request payload, both <b>currency</b> and <b>value</b> fields are required, and both fields are also always returned for an amount in a response field
- freeShipping? boolean - This field is included and set to <code>true</code> if the seller offers a free domestic shipping option to the buyer. <br><br>This field can only be included and set to <code>true</code> for the first domestic shipping service option specified in the <b>shippingServices</b> array (it is ignored if set for subsequent shipping services or for any international shipping service option). <br><br>The first specified shipping service option has a <b>sortOrder</b> value of <code>1</code> or if the <b>sortOrderId</b> field is not used, it is the shipping service option that's specified first in the <b>shippingServices</b> array.<br><br>This container is returned if set
- shippingCarrierCode? string - This field sets/indicates the shipping carrier, such as <code>USPS</code>, <code>FedEx</code>, or <code>UPS</code>. Although this field uses the <b>string</b> type, the seller must pass in a pre-defined enumeration value here. <br><br>For a full list of shipping carrier enum values for a specified eBay marketplace, the <a href="/devzone/xml/docs/reference/ebay/GeteBayDetails.html">GeteBayDetails</a> call of the <b>Trading API</b> can be used, and the <b>DetailName</b> field's value should be set to <code>ShippingCarrierDetails</code>. The enum values for each shipping carriers can be found in each <b>ShippingCarrierDetails.ShippingCarrier</b> field in the response payload.<br><br> This field is actually optional, as the shipping carrier is also tied into the <b>shippingServiceCode</b> enum value, and that field is required for every specified shipping service option.<br><br>This field is returned if set
- sortOrder? Signed32 - The integer value set in this field controls the order of the corresponding domestic or international shipping service option in the View Item and Checkout pages. <br><br>If the <b>sortOrder</b> field is not supplied, the order of domestic and international shipping service options is determined by the order in which they are listed in the API call. <br><br><b>Min</b>: 1. <b>Max</b>: 4 (for domestic shipping service) or 5 (for international shipping service)
- shippingServiceCode? string - This field sets/indicates the domestic or international shipping service option, such as <code>USPSPriority</code>, <code>FedEx2Day</code>, or <code>UPS3rdDay</code>. Although this field uses the <b>string</b> type, the seller must pass in a pre-defined enumeration value here. <br><br>For a full list of shipping service option enum values for a specified eBay marketplace, the <a href="/devzone/xml/docs/reference/ebay/GeteBayDetails.html">GeteBayDetails</a> call of the <b>Trading API</b> can be used, and the <b>DetailName</b> field's value should be set to <code>ShippingServiceDetails</code>. <br><br>The enum values for each shipping service option can be found in each <b>ShippingServiceDetails.ShippingService</b> field in the response payload. The seller must make sure that the shipping service option is still valid, which is indicated by a <code>true</code> value in the corresponding <b>ValidForSellingFlow</b> boolean field. International shipping service options are typically returned at the top of the response payload, and are indicated by an <b>InternationalService</b> boolean field that reads <code>true</code>. <br><br>The <b>InternationalService</b> boolean field is not returned at all for domestic shipping service options. <br><br> This field is required for every specified shipping service option
- shipToLocations? RegionSet - This type consists of the <b>regionIncluded</b> and <b>regionExcluded</b> arrays, which indicate the areas to where the seller does and doesn't ship
ebay.account: Subscription
This type is used by the getSubscription response container, which defines the subscription types and levels for the seller account
Fields
- marketplaceId? string - The marketplace with which the subscription is associated. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a>
- subscriptionLevel? string - The subscription level. For example, subscription levels for an eBay store include Starter, Basic, Featured, Anchor, and Enterprise levels
- subscriptionType? string - The kind of entity with which the subscription is associated, such as an eBay store. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:SubscriptionTypeEnum'>eBay API documentation</a>
- term? TimeDuration - A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.<br><br>Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned
- subscriptionId? string - The subscription ID
ebay.account: SubscriptionResponse
This type is used by the response payload for the getSubscription method.
Note: Pagination has not yet been enabled for getSubscription, so all of the pagination-related fields are for future use.
Fields
- next? string - This field is for future use
- subscriptions? Subscription[] - An array of subscriptions associated with the seller account
- total? Signed32 - The total number of subscriptions displayed on the current page of results
- 'limit? Signed32 - This field is for future use
- href? string - This field is for future use
ebay.account: TimeDuration
A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.
Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned
Fields
- unit? string - These enum values represent the time measurement unit, such as <code>DAY</code>. A span of time is defined when you apply the value specified in the <b>value</b> field to the value specified for <b>unit</b>. <br><br>See <b>TimeDurationUnitEnum</b> for a complete list of possible time-measurement units. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:TimeDurationUnitEnum'>eBay API documentation</a>
- value? Signed32 - An integer that represents an amount of time, as measured by the time-measurement unit specified in the <b>unit</b> field
ebay.account: UpdateCustomPolicyHeaders
Represents the Headers record for the operation: updateCustomPolicy
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>
ebay.account: UpdatedSalesTaxEntry
This container stores the array of sales-tax table entries that have been created or updated
Fields
- countryCode? string - The two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> code of the country associated with the sales-tax table entry
- jurisdictionId? string - The ID of the tax jurisdiction associated with the sales-tax table entry
- statusCode? Signed32 - The HTTP status code for the call.<br><br><span class="tablenote"><b>Note:</b> The system returns one HTTP status code regardless of the number of sales-tax table entries provided. Therefore, the same HTTP <code>statusCode</code> will be listed for all sales-tax table entries returned in the payload.</span>
ebay.account: UpdatedSalesTaxResponse
This type is used to return the list of new and updated sales-tax table entries
Fields
- updatedSalesTaxEntries? UpdatedSalesTaxEntry[] - The array of new and updated sales-tax table entries
ebay.account: UpdateFulfillmentPolicyHeaders
Represents the Headers record for the operation: updateFulfillmentPolicy
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>
ebay.account: UpdatePaymentPolicyHeaders
Represents the Headers record for the operation: updatePaymentPolicy
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>
ebay.account: UpdateReturnPolicyHeaders
Represents the Headers record for the operation: updateReturnPolicy
Fields
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>
Import
import ballerinax/ebay.account;Metadata
Released date: about 20 hours ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-20 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 52
Current verison: 1
Weekly downloads
Keywords
Vendor/eBay
Area/E-Commerce
Type/Connector
Contributors