custom_policy_id, which can be used to reference\
\ the policy."
content:
application/json:
schema:
type: "object"
"400":
description: "Bad Request"
x-response-codes:
errors:
20417:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Maximum custom policy per site is reached"
20418:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "This policy name is already used"
20411:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Invalid/Missing policyType {policyType}"
20412:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Invalid/Missing label"
20413:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Invalid/Missing name"
20414:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Invalid/Missing description"
20415:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Invalid/Missing marketplaceId"
"500":
description: "Internal Server Error"
x-response-codes:
errors:
20500:
domain: "API_ACCOUNT"
category: "APPLICATION"
description: "System error."
"409":
description: "Policy Name already used/ Maximum no of policies per site\
\ reached"
security:
- api_auth:
- "https://api.ebay.com/oauth/api_scope/sell.account"
/custom_policy/{custom_policy_id}:
get:
tags:
- "custom_policy"
description: "This method retrieves the custom policy specified by the custom_policy_id\
\ path parameter."
operationId: "getCustomPolicy"
parameters:
- name: "custom_policy_id"
in: "path"
description: "This path parameter is the unique identifier of the custom policy\
\ to retrieve.Tip: For details on creating and using the business policies supported\ \ by the Account API, see eBay business policies.
" operationId: "createFulfillmentPolicy" parameters: - name: "Content-Type" in: "header" description: "This header indicates the format of the request body provided\ \ by the client. Its value should be set to application/json.fulfillmentPolicyId, which you can\
\ use to reference the policy."
content:
application/json:
schema:
$ref: "#/components/schemas/SetFulfillmentPolicyResponse"
x-response-codes:
errors:
20200:
domain: "API_ACCOUNT"
category: "BUSINESS"
description: "Warning. {additionalInfo}"
20201:
domain: "API_ACCOUNT"
category: "BUSINESS"
description: "{fieldName} (Click and Collect Program) can not be enabled\
\ for this seller or marketplace."
"400":
description: "Bad Request"
x-response-codes:
errors:
20400:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Invalid request. {additionalInfo}"
20401:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Missing field {fieldName}. {additionalInfo}"
20402:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Invalid input. {additionalInfo}"
20403:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Invalid {fieldName}. {additionalInfo}"
"500":
description: "Internal Server Error"
x-response-codes:
errors:
20500:
domain: "API_ACCOUNT"
category: "APPLICATION"
description: "System error."
20501:
domain: "API_ACCOUNT"
category: "APPLICATION"
description: "Service unavailable. Please try again in next 24 hours."
security:
- api_auth:
- "https://api.ebay.com/oauth/api_scope/sell.account"
/fulfillment_policy/{fulfillmentPolicyId}:
get:
tags:
- "fulfillment_policy"
description: "This method retrieves the complete details of a fulfillment policy.\
\ Supply the ID of the policy you want to retrieve using the fulfillmentPolicyId\
\ path parameter."
operationId: "getFulfillmentPolicy"
parameters:
- name: "fulfillmentPolicyId"
in: "path"
description: "This path parameter specifies the ID of the fulfillment policy\
\ you want to retrieve.marketplace_id query\
\ parameter."
operationId: "getFulfillmentPolicies"
parameters:
- name: "Content-Language"
in: "header"
description: "Get the correct policies for a marketplace that supports multiple\
\ locales using the Content-Language request header. For example,\
\ get the policies for the French locale of the Canadian marketplace by\
\ specifying fr-CA for the Content-Language header.\
\ Likewise, target the Dutch locale of the Belgium marketplace by setting\
\ Content-Language: nl-BE. For details on header values, see\
\ HTTP request headers."
required: false
schema:
type: "string"
- name: "marketplace_id"
in: "query"
description: "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"
required: true
schema:
type: "string"
responses:
"200":
description: "Success"
content:
application/json:
schema:
$ref: "#/components/schemas/FulfillmentPolicyResponse"
"400":
description: "Bad Request"
x-response-codes:
errors:
20401:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Missing field {fieldName}. {additionalInfo}"
20403:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Invalid {fieldName}. {additionalInfo}"
20404:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "{fieldName} not found."
"500":
description: "Internal Server Error"
x-response-codes:
errors:
20500:
domain: "API_ACCOUNT"
category: "APPLICATION"
description: "System error."
20501:
domain: "API_ACCOUNT"
category: "APPLICATION"
description: "Service unavailable. Please try again in next 24 hours."
security:
- api_auth:
- "https://api.ebay.com/oauth/api_scope/sell.account"
- "https://api.ebay.com/oauth/api_scope/sell.account.readonly"
/fulfillment_policy/get_by_policy_name:
get:
tags:
- "fulfillment_policy"
description: "This method retrieves the details for a specific fulfillment policy.\
\ In the request, supply both the policy name and its associated\
\ marketplace_id as query parameters."
operationId: "getFulfillmentPolicyByName"
parameters:
- name: "Content-Language"
in: "header"
description: "Get the correct policies for a marketplace that supports multiple\
\ locales using the Content-Language request header. For example,\
\ get the policies for the French locale of the Canadian marketplace by\
\ specifying fr-CA for the Content-Language header.\
\ Likewise, target the Dutch locale of the Belgium marketplace by setting\
\ Content-Language: nl-BE. For details on header values, see\
\ HTTP request headers."
required: false
schema:
type: "string"
- name: "marketplace_id"
in: "query"
description: "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"
required: true
schema:
type: "string"
- name: "name"
in: "query"
description: "This query parameter specifies the seller-defined name of the\
\ fulfillment policy you want to retrieve.marketplace_id query\
\ parameter."
operationId: "getPaymentPolicies"
parameters:
- name: "marketplace_id"
in: "query"
description: "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"
required: true
schema:
type: "string"
- name: "Content-Language"
in: "header"
description: "Get the correct policies for a marketplace that supports multiple\
\ locales using the Content-Language request header. For example,\
\ get the policies for the French locale of the Canadian marketplace by\
\ specifying fr-CA for the Content-Language header.\
\ Likewise, target the Dutch locale of the Belgium marketplace by setting\
\ Content-Language: nl-BE. For details on header values, see\
\ HTTP request headers."
required: false
schema:
type: "string"
responses:
"200":
description: "Success"
content:
application/json:
schema:
$ref: "#/components/schemas/PaymentPolicyResponse"
"400":
description: "Bad Request"
x-response-codes:
errors:
20401:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Missing field {fieldName}. {additionalInfo}"
20403:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Invalid {fieldName}. {additionalInfo}"
"500":
description: "Internal Server Error"
x-response-codes:
errors:
20500:
domain: "API_ACCOUNT"
category: "APPLICATION"
description: "System error."
20501:
domain: "API_ACCOUNT"
category: "APPLICATION"
description: "Service unavailable. Please try again in next 24 hours."
security:
- api_auth:
- "https://api.ebay.com/oauth/api_scope/sell.account"
- "https://api.ebay.com/oauth/api_scope/sell.account.readonly"
post:
tags:
- "payment_policy"
description: "This method creates a new payment policy where the policy encapsulates\
\ seller's terms for order payments. Tip: For details on creating and\ \ using the business policies supported by the Account API, see eBay business\ \ policies.
" operationId: "createPaymentPolicy" parameters: - name: "Content-Type" in: "header" description: "This header indicates the format of the request body provided\ \ by the client. Its value should be set to application/json.paymentPolicyId, which you can use to reference the\
\ policy."
content:
application/json:
schema:
$ref: "#/components/schemas/SetPaymentPolicyResponse"
x-response-codes:
errors:
20200:
domain: "API_ACCOUNT"
category: "BUSINESS"
description: "Warning. {additionalInfo}"
"400":
description: "Bad Request"
x-response-codes:
errors:
20400:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Invalid request. {additionalInfo}"
20401:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Missing field {fieldName}. {additionalInfo}"
20403:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Invalid {fieldName}. {additionalInfo}"
20404:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "{fieldName} not found."
20405:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Invalid payment method. {fieldName}"
"500":
description: "Internal Server Error"
x-response-codes:
errors:
20500:
domain: "API_ACCOUNT"
category: "APPLICATION"
description: "System error."
20501:
domain: "API_ACCOUNT"
category: "APPLICATION"
description: "Service unavailable. Please try again in next 24 hours."
security:
- api_auth:
- "https://api.ebay.com/oauth/api_scope/sell.account"
/payment_policy/{payment_policy_id}:
get:
tags:
- "payment_policy"
description: "This method retrieves the complete details of a payment policy.\
\ Supply the ID of the policy you want to retrieve using the paymentPolicyId\
\ path parameter."
operationId: "getPaymentPolicy"
parameters:
- name: "payment_policy_id"
in: "path"
description: "This path parameter specifies the ID of the payment policy you\
\ want to retrieve. name and its associated marketplace_id\
\ in the request query parameters."
operationId: "getPaymentPolicyByName"
parameters:
- name: "Content-Language"
in: "header"
description: "Get the correct policy for a marketplace that supports multiple\
\ locales using the Content-Language request header. For example,\
\ get a policy for the French locale of the Canadian marketplace by specifying\
\ fr-CA for the Content-Language header. Likewise,\
\ target the Dutch locale of the Belgium marketplace by setting Content-Language:\
\ nl-BE. For details on header values, see HTTP request headers."
required: false
schema:
type: "string"
- name: "marketplace_id"
in: "query"
description: "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"
required: true
schema:
type: "string"
- name: "name"
in: "query"
description: "This query parameter specifies the seller-defined name of the\
\ payment policy you want to retrieve.marketplace_id query parameter."
operationId: "getReturnPolicies"
parameters:
- name: "Content-Language"
in: "header"
description: "Get the correct policies for a marketplace that supports multiple\
\ locales using the Content-Language request header. For example,\
\ get the policies for the French locale of the Canadian marketplace by\
\ specifying fr-CA for the Content-Language header.\
\ Likewise, target the Dutch locale of the Belgium marketplace by setting\
\ Content-Language: nl-BE. For details on header values, see\
\ HTTP request headers."
required: false
schema:
type: "string"
- name: "marketplace_id"
in: "query"
description: "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"
required: true
schema:
type: "string"
responses:
"200":
description: "Success"
content:
application/json:
schema:
$ref: "#/components/schemas/ReturnPolicyResponse"
"400":
description: "Bad Request"
x-response-codes:
errors:
20401:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Missing field {fieldName}. {additionalInfo}"
20403:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Invalid {fieldName}. {additionalInfo}"
20404:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "{fieldName} not found."
"500":
description: "Internal Server Error"
x-response-codes:
errors:
20500:
domain: "API_ACCOUNT"
category: "APPLICATION"
description: "System error."
20501:
domain: "API_ACCOUNT"
category: "APPLICATION"
description: "Service unavailable. Please try again in next 24 hours."
security:
- api_auth:
- "https://api.ebay.com/oauth/api_scope/sell.account"
- "https://api.ebay.com/oauth/api_scope/sell.account.readonly"
post:
tags:
- "return_policy"
description: "This method creates a new return policy where the policy encapsulates\
\ seller's terms for returning items. Tip: For details\ \ on creating and using the business policies supported by the Account API,\ \ see eBay business policies.
" operationId: "createReturnPolicy" parameters: - name: "Content-Type" in: "header" description: "This header indicates the format of the request body provided\ \ by the client. Its value should be set to application/json.returnPolicyId, which you can use to reference the\
\ policy."
content:
application/json:
schema:
$ref: "#/components/schemas/SetReturnPolicyResponse"
x-response-codes:
errors:
20200:
domain: "API_ACCOUNT"
category: "BUSINESS"
description: "Warning. {additionalInfo}"
"400":
description: "Bad Request"
x-response-codes:
errors:
20400:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Invalid request. {additionalInfo}"
20401:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Missing field ."
20406:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "Invalid return option"
"500":
description: "Internal Server Error"
x-response-codes:
errors:
20500:
domain: "API_ACCOUNT"
category: "APPLICATION"
description: "System error."
20501:
domain: "API_ACCOUNT"
category: "APPLICATION"
description: "Service unavailable. Please try again in next 24 hours."
security:
- api_auth:
- "https://api.ebay.com/oauth/api_scope/sell.account"
/return_policy/{return_policy_id}:
get:
tags:
- "return_policy"
description: "This method retrieves the complete details of the return policy\
\ specified by the returnPolicyId path parameter."
operationId: "getReturnPolicy"
parameters:
- name: "return_policy_id"
in: "path"
description: "This path parameter specifies the unique identifier of the return\
\ policy you want to retrieve. name and its associated marketplace_id\
\ in the request query parameters."
operationId: "getReturnPolicyByName"
parameters:
- name: "Content-Language"
in: "header"
description: "Get the correct policy for a marketplace that supports multiple\
\ locales using the Content-Language request header. For example,\
\ get a policy for the French locale of the Canadian marketplace by specifying\
\ fr-CA for the Content-Language header. Likewise,\
\ target the Dutch locale of the Belgium marketplace by setting Content-Language:\
\ nl-BE. For details on header values, see HTTP request headers."
required: false
schema:
type: "string"
- name: "marketplace_id"
in: "query"
description: "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"
required: true
schema:
type: "string"
- name: "name"
in: "query"
description: "This query parameter specifies the seller-defined name of the\
\ return policy you want to retrieve.countryCodejurisdictionIdsalesTaxPercentageshippingAndHandlingTaxedImportant! In the US, eBay now calculates,\
\ collects, and remits sales tax to the proper taxing authorities in all 50\
\ states and Washington, DC. Sellers can no longer specify sales-tax rates\
\ for these jurisdictions using a tax table.
However, sellers may continue\
\ to use a sales-tax table to set rates for the following US territories:
Important! In the US, eBay now calculates,\
\ collects, and remits sales tax to the proper taxing authorities in all 50\
\ states and Washington, DC. Sellers can no longer specify sales-tax rates\
\ for these jurisdictions using a tax table.
However, sellers may continue\
\ to use a sales-tax table to set rates for the following US territories:
USCAcountryCode\
\ is set to US, the only supported values for jurisdictionId\
\ are:AS (American Samoa)GU (GuamMP\
\ Northern Mariana IslandsPW (Palau)VI\
\ (US Virgin Islands)Important! In the US, eBay now calculates,\
\ collects, and remits sales tax to the proper taxing authorities in all 50\
\ states and Washington, DC. Sellers can no longer specify sales-tax rates\
\ for these jurisdictions using a tax table.
However, sellers may continue\
\ to use a sales-tax table to set rates for the following US territories:
USCAcountryCode\
\ is set to US, the only supported values for jurisdictionId\
\ are:AS (American Samoa)GU (Guam)MP\
\ (Northern Mariana Islands)PW (Palau)VI\
\ (US Virgin Islands)USCAcountryCode\
\ is set to US, the only supported values for jurisdictionId\
\ are:AS (American Samoa)GU (Guam)MP\
\ (Northern Mariana Islands)PW (Palau)VI\
\ (US Virgin Islands)204 No Content\
\ status code is returned with no response payload.Important! In the US, eBay now calculates,\
\ collects, and remits sales tax to the proper taxing authorities in all 50\
\ states and Washington, DC. Sellers can no longer specify sales-tax rates\
\ for these jurisdictions using a tax table.
However, sellers may continue\
\ to use a sales-tax table to set rates for the following US territories:
USCA204 No Content HTTP status code. "
operationId: "getKYC"
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/KycResponse"
"400":
description: "Bad Request"
x-response-codes:
errors:
21400:
domain: "API_ACCOUNT"
category: "REQUEST"
description: "This marketplace is not supported. Please refer to documentation."
"500":
description: "Internal Server Error"
x-response-codes:
errors:
20500:
domain: "API_ACCOUNT"
category: "APPLICATION"
description: "There was a problem with an eBay internal system or\
\ process. Contact eBay developer support for assistance."
"204":
description: "No Content"
security:
- api_auth:
- "https://api.ebay.com/oauth/api_scope/sell.account"
- "https://api.ebay.com/oauth/api_scope/sell.account.readonly"
/advertising_eligibility:
get:
tags:
- "advertising_eligibility"
description: "This method allows developers to check the seller eligibility\
\ status for eBay advertising programs."
operationId: "getAdvertisingEligibility"
parameters:
- name: "program_types"
in: "query"
description: "A comma-separated list of eBay advertising programs for which\
\ eligibility status will be returned.CAD.MOTORS_VEHICLES category type is not valid for return\
\ policies. eBay flows do not support the return of motor vehicles.\
\ For implementation help, refer to eBay\
\ API documentation"
description: "The category type discerns whether the policy applies to motor\
\ vehicle listings, or to any other items except motor vehicle listings. 2000.0"
$ref: "#/components/schemas/Amount"
dueIn:
description: "This value indicates the number of hours that the buyer has\
\ (after they commit to buy) to pay the initial deposit on a motor vehicle.\
\ Valid dueIn times are 24, 48, and 72 hours. HOUR\
\ is set as the unit value, and 24, 48\
\ or 72 are set in the value field.Application:\
\ 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.Business:\
\ 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.Request:\
\ 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.message error field."
message:
type: "string"
description: "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."
outputRefIds:
type: "array"
description: "Identifies specific response elements associated with the\
\ error, if any. Path format is the same as inputRefId."
items:
type: "string"
parameters:
type: "array"
description: "This optional list of name/value pairs that contain context-specific\
\ ErrorParameter objects, with each item in the list being\
\ a parameter (or input field name) that caused an error condition. Each\
\ ErrorParameter object consists of two fields, a name\
\ and a value."
items:
$ref: "#/components/schemas/ErrorParameter"
subdomain:
type: "string"
description: "If present, indicates the subsystem in which the error occurred."
description: "A container that defines the elements of error and warning messages."
ErrorParameter:
type: "object"
properties:
name:
type: "string"
description: "Name of the parameter that caused the error."
value:
type: "string"
description: "The value of the parameter that caused the error."
description: "A complex type that indicates a parameter that caused an error\
\ and the value of the parameter which caused the error."
FulfillmentPolicy:
type: "object"
properties:
categoryTypes:
type: "array"
description: "This container indicates whether the fulfillment policy applies\
\ to motor vehicle listings, or if it applies to non-motor vehicle listings."
items:
$ref: "#/components/schemas/CategoryType"
description:
type: "string"
description: "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. true, the seller offers freight\
\ shipping. Freight shipping can be used for large items over 150 lbs."
fulfillmentPolicyId:
type: "string"
description: "A unique eBay-assigned ID for the fulfillment policy. This\
\ ID is generated when the policy is created."
globalShipping:
type: "boolean"
description: "Note: This field is only\
\ applicable for the eBay United Kingdom marketplace (EBAY_GB).true, eBay's Global Shipping Program will be\
\ used by the seller to ship items to international locations.If only local pickup or\ \ freight shipping is available for the item, this container may not get\ \ returned.
" $ref: "#/components/schemas/TimeDuration" localPickup: type: "boolean" description: "If returned astrue, local pickup is available\
\ for this policy."
marketplaceId:
type: "string"
description: "The ID of the eBay marketplace to which this fulfillment policy\
\ applies. For implementation help, refer to eBay\
\ API documentation"
name:
type: "string"
description: "A seller-defined name for this fulfillment policy. Names must\
\ be unique for policies assigned to the same marketplace. true, the seller offers the \"\
Click and Collect\" option. A separate ShippingServices\ \ object is used to specify cost and other details for every available\ \ domestic and international shipping service option.
" items: $ref: "#/components/schemas/ShippingOption" shipToLocations: description: "This container consists of the regionIncluded and regionExcluded\ \ containers, which define the geographical regions/countries/states or\ \ provinces/domestic regions where the seller does and doesn't ship to\ \ with this fulfillment policy." $ref: "#/components/schemas/RegionSet" description: "This type is used by the fulfillmentPolicy response container,\ \ a container which defines a seller's fulfillment policy for a specific marketplace." FulfillmentPolicyRequest: type: "object" properties: categoryTypes: type: "array" description: "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." items: $ref: "#/components/schemas/CategoryType" description: type: "string" description: "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.true if freight\
\ shipping is available for the item. Freight shipping can be used for\
\ large items over 150 lbs.EBAY_GB).true if the seller wants to\
\ use the Global Shipping Program for international shipments. See the\
\ Global Shipping Program help topic for more details and requirements\
\ on the Global Shipping Program.false or if the field is omitted, the\
\ seller has to manually specifying individual international shipping\
\ services (if the seller ships internationally), as described in Setting up worldwide shipping. Default:\ \ false
" handlingTime: description: "This container is used to specify the maximum number of business\ \ days the seller commits to for preparing and shipping an order after\ \ receiving a cleared payment for the order. This time does not include\ \ the transit time it takes the shipping carrier to deliver the order.DispatchTimeMaxDetails,\
\ then inspect the DispatchTimeMaxDetails container in the response\
\ for the time values supported by the site (typical handling times are\
\ 0, 1, 2, 3, 4,\
\ 5, 10, 15, and 20,\
\ but these can vary by site and may change over time.) This field\
\ is conditionally required when the seller is offering one or more domestic\
\ or international shipping options, but it is not applicable when the\
\ item is only available through local pickup (\"localPickup\":\
\ \"true\"), or if it will be shipped through a freight shipping\
\ service (\"freightShipping\": \"true\").
true\
\ 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.false"
marketplaceId:
type: "string"
description: "The ID of the eBay marketplace to which this fulfillment policy\
\ applies. For implementation help, refer to eBay\
\ API documentation"
name:
type: "string"
description: "A seller-defined name for this fulfillment policy. Names must\
\ be unique for policies assigned to the same marketplace. true\
\ if the seller offers the \"Click and Collect\" feature for an item.\
\ 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.
In addition to setting this field to true,\
\ the merchant must also do the following to enable the \"Click and Collect\"\
\ option on a listing:
Sellers can\ \ use the createInventoryLocation method in the Inventory API to\ \ associate physical stores to their account and they can then add inventory\ \ to specific store locations.
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.
Default: false" shippingOptions: type: "array" description: "This array is used to provide detailed information on the\ \ domestic and international shipping options available for the policy.\ \A separate ShippingServices object will be used to specify\ \ cost and other details for every available domestic and international\ \ shipping service option.
" items: $ref: "#/components/schemas/ShippingOption" shipToLocations: description: "This container consists of the regionIncluded and regionExcluded\ \ arrays, which are used to define the geographical regions/countries/states\ \ or provinces/domestic regions that a seller does and does not ship to\ \ for the associated fulfillment policy. Note that this container can\ \ be considered the master list of where the seller ships and does not\ \ ship, but there is also a shipToLocations container that can\ \ be set at the shipping service option level.ExcludeShippingLocationDetails,\
\ then review the ExcludeShippingLocationDetails containers in\
\ the response for the strings you use in both the regionIncluded.regionName\
\ and in the regionExcluded.regionName fields. ExcludeShippingLocationDetails\
\ containers in the GeteBayDetails response where the Region\
\ value is Worldwide, and the valid values will be shown\
\ in the corresponding Location fields. ExcludeShippingLocationDetails\
\ in the GeteBayDetails response where the Region value\
\ is one of the defined geographical regions, and the valid values will\
\ be shown in the corresponding Location fields. Alternatively,\
\ you can find the two-digit country code values in the CountryCodeEnum type definition. For valid domestic region values,\
\ look for ExcludeShippingLocationDetails in the GeteBayDetails\
\ response where the Region value is either Domestic Location\
\ or Additional Locations, and the valid values will be shown\
\ in the corresponding Location fields. STATE_OR_PROVINCE\
\ region type is only applicable to the US and Canada, and valid values\
\ for US states are the same two-digit abbreviations used by the United States Postal Service,\
\ and valid values for Canadian provinces and territories are the same\
\ two-digit abbreviations used by the Canada Post."
$ref: "#/components/schemas/RegionSet"
description: "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."
FulfillmentPolicyResponse:
type: "object"
properties:
fulfillmentPolicies:
type: "array"
description: "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."
items:
$ref: "#/components/schemas/FulfillmentPolicy"
href:
type: "string"
description: "This field is for future use."
limit:
type: "integer"
description: "This field is for future use."
format: "int32"
next:
type: "string"
description: "This field is for future use."
offset:
type: "integer"
description: "This field is for future use."
format: "int32"
prev:
type: "string"
description: "This field is for future use."
total:
type: "integer"
description: "The total number of fulfillment policies retrieved in the\
\ result set. 0."
format: "int32"
description: "The response payload for the getFulfillmentPolicies method.DAY and the value\
\ field to either 30 or 60 (or other value,\
\ as appropriate). true."
$ref: "#/components/schemas/TimeDuration"
returnsAccepted:
type: "boolean"
description: "If set to true, the seller accepts international\
\ returns. If set to false, the seller does not accept international\
\ returns. BUYER or SELLER. true. For implementation help, refer to eBay\
\ API documentation"
description: "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. "
KycCheck:
type: "object"
properties:
dataRequired:
type: "string"
description: "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 detailMessage and other applicable, corresponding\
\ fields. For implementation help, refer to eBay\
\ API documentation"
dueDate:
type: "string"
description: "The timestamp in this field indicates the date by which the\
\ seller should resolve the KYC requirement.06-05-2020 10:34:18"
remedyUrl:
type: "string"
description: "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:
type: "string"
description: "This field gives a short summary of what is required from\
\ the seller. An example might be, 'Upload bank document now.'.\
\ The detailMessage field will often provide more details on what\
\ is required of the seller."
detailMessage:
type: "string"
description: "This field gives a detailed message about what is required\
\ from the seller. An example might be, 'Please upload a bank document\
\ by 2020-08-01 to get your account back in good standing.'."
description: "This type is used to provide details about any KYC check that\
\ is applicable to the managed payments seller."
KycResponse:
type: "object"
properties:
kycChecks:
type: "array"
description: "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.204 No Content HTTP status code."
items:
$ref: "#/components/schemas/KycCheck"
description: "This is the base response type of the getKYC method."
PaymentMethod:
type: "object"
properties:
brands:
type: "array"
description: "Note: 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. "
items:
type: "string"
description: " For implementation help, refer to eBay\
\ API documentation"
paymentMethodType:
type: "string"
description: "This array is only applicable for listings supporting offline\
\ payment methods. See the PaymentMethodTypeEnum type for supported\
\ offline payment method enum values. If offline payments are enabled\
\ for the policy, provide at least one offline payment method. For\
\ implementation help, refer to eBay\
\ API documentation"
recipientAccountReference:
description: "Note: This container 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 PayPal. "
$ref: "#/components/schemas/RecipientAccountReference"
description: "This type is used by the paymentMethods container, which\
\ is used by the seller to specify one or more offline payment methods. MOTORS_VEHICLES, and is only returned if\
\ the seller requires an initial deposit on motor vehicles.Note: The due date that is specified\ \ in the deposit container will be overridden if the payment business\ \ policy requires immediate payment (in this case, for the deposit), and\ \ the buyer commits to purchasing the motor vehicle through a fixed-price\ \ listing or through the 'Buy it Now' option of an auction listing.
" $ref: "#/components/schemas/Deposit" description: type: "string" description: "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.\ \MOTORS_VEHICLES.\
\ MOTORS_VEHICLES) payment business policy must specify at\
\ least one of the following paymentMethods values for the final\
\ payment: true, immediate\
\ payment is required from the buyer for: true 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."
marketplaceId:
type: "string"
description: "The ID of the eBay marketplace to which the payment business\
\ policy applies. For implementation help, refer to eBay\
\ API documentation"
name:
type: "string"
description: "A seller-defined name for this payment policy. Names must\
\ be unique for policies assigned to the same marketplace. Note: The 'due date' specified\ \ in the deposit container will be overridden if the payment business\ \ policy requires immediate payment (in this case, for the deposit), and\ \ the buyer commits to purchase the motor vehicle through a fixed-price\ \ listing or through the 'Buy it Now' option of an auction listing. See\ \ immediatePay.
" $ref: "#/components/schemas/Deposit" description: type: "string" description: "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.3 DAYS7 DAYS (the default)10\
\ DAYS14 DAYSCASH_ON_PICKUPCASHIER_CHECKMONEY_ORDERPERSONAL_CHECK7 DAYS"
$ref: "#/components/schemas/TimeDuration"
immediatePay:
type: "boolean"
description: "This field should be included and set to true\
\ if the seller wants to require immediate payment from the buyer for:\
\ Note: DO NOT USE THIS FIELD.\ \ Payment instructions are no longer supported by payment business policies.
A\ \ free-form string field that allows sellers to add detailed payment instructions\ \ to their listings." paymentMethods: type: "array" description: "Note: This field applies only\ \ when the seller needs to specify one or more offline payment methods.\ \ eBay now manages the electronic payment options available to buyers\ \ to pay for the item.
This array is used to specify one or more offline\ \ payment methods that will be accepted for payment that occurs off of\ \ eBay's platform." items: $ref: "#/components/schemas/PaymentMethod" description: "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." PaymentPolicyResponse: type: "object" properties: href: type: "string" description: "This field is for future use." limit: type: "integer" description: "This field is for future use." format: "int32" next: type: "string" description: "This field is for future use." offset: type: "integer" description: "This field is for future use." format: "int32" paymentPolicies: type: "array" description: "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." items: $ref: "#/components/schemas/PaymentPolicy" prev: type: "string" description: "This field is for future use." total: type: "integer" description: "The total number of payment business policies retrieved in\ \ the result set.0."
format: "int32"
description: "The response payload for the getPaymentPolicies method.\
\ IN_PROGRESS\
\ step. The step names are returned in sequential order. "
items:
$ref: "#/components/schemas/PaymentsProgramOnboardingSteps"
description: "Type used by the payments program onboarding response"
PaymentsProgramOnboardingSteps:
type: "object"
properties:
name:
type: "string"
description: "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:
type: "string"
description: "This enumeration value indicates the status of the associated\
\ step. Note: Only one\
\ step can be IN_PROGRESS at a time.
IN_PROGRESS step."
description: "The payments program onboarding steps, status, and link."
PaymentsProgramResponse:
type: "object"
properties:
marketplaceId:
type: "string"
description: "The ID of the eBay marketplace to which the payment program\
\ applies. For implementation help, refer to eBay\
\ API documentation"
paymentsProgramType:
type: "string"
description: "This parameter specifies the payment program whose status\
\ is returned by the call. EBAY_PAYMENTS. For implementation help, refer\
\ to eBay\
\ API documentation"
status:
type: "string"
description: "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 eBay\
\ API documentation"
wasPreviouslyOptedIn:
type: "boolean"
description: "If returned as true, the seller was at one point\
\ opted-in to the associated payment program, but they later opted out\
\ of the program. A value of false indicates the seller never\
\ opted-in to the program or if they did opt-in to the program, they never\
\ opted-out of it. true\
\ while the status field returns OPTED_IN."
description: "The response object containing the sellers status with regards\
\ to the specified payment program."
Program:
type: "object"
properties:
programType:
type: "string"
description: "The seller program to opt in to when part of an optInToProgram\
\ request, or out of when part of an optOutOfProgram request.\
\ When returned in an getOptedInPrograms response, a separate programType\
\ field is returned for each seller program that the seller is opted in\
\ to. For implementation help, refer to eBay\
\ API documentation"
description: "The seller program to opt in to when part of an optInToProgram\
\ request, or out of when part of an optOutOfProgram request."
Programs:
type: "object"
properties:
programs:
type: "array"
description: "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."
items:
$ref: "#/components/schemas/Program"
description: "The base response type of the getOptedInPrograms method."
RateTable:
type: "object"
properties:
countryCode:
type: "string"
description: "A two-letter ISO 3166 country\
\ code representing the eBay marketplace where the shipping rate table\
\ is defined. For implementation help, refer to eBay\
\ API documentation"
locality:
type: "string"
description: "This enumeration value returned here indicates whether the\
\ shipping rate table is a domestic or international shipping rate table.\
\ For implementation help, refer to eBay\
\ API documentation"
name:
type: "string"
description: "The seller-defined name for the shipping rate table."
rateTableId:
type: "string"
description: "A unique eBay-assigned ID for a seller's shipping rate table.\
\ These rateTableId 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."
description: "This type is used to provide details about each shipping rate\
\ table that is returned in the getRateTables response."
RateTableResponse:
type: "object"
properties:
rateTables:
type: "array"
description: "An array of all shipping rate tables defined for a marketplace\
\ (or all marketplaces if no country_code query parameter is used).\
\ This array will be returned as empty if the seller has no defined shipping\
\ rate tables for the specified marketplace."
items:
$ref: "#/components/schemas/RateTable"
description: "This type is the base response of the getRateTables method."
RecipientAccountReference:
type: "object"
properties:
referenceId:
type: "string"
description: "Note: 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."
referenceType:
type: "string"
description: "Note: 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.\
\ For implementation help, refer to eBay\
\ API documentation"
description: "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."
Region:
type: "object"
properties:
regionName:
type: "string"
description: "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. 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.
This\
\ array will be returned as empty if no shipping regions are excluded\
\ with the fulfillment business policy.
Note: The regionExcluded array is not applicable for motor\
\ vehicle business policies on the US, CA, or UK marketplaces. If this\
\ array is used in a createFulfillmentPolicy or updateFulfillmentPolicy\
\ request, it will be ignored."
items:
$ref: "#/components/schemas/Region"
regionIncluded:
type: "array"
description: "An array of one or more regionName fields that specify\
\ the areas to where a seller ships.
Each eBay marketplace supports\
\ its own set of allowable shipping locations.
Note: The regionIncluded array is not applicable\
\ for motor vehicle business policies on the US, CA, or UK marketplaces.\
\ If this array is used in a createFulfillmentPolicy or updateFulfillmentPolicy\
\ request, it will be ignored."
items:
$ref: "#/components/schemas/Region"
description: "This type consists of the regionIncluded and regionExcluded\
\ arrays, which indicate the areas to where the seller does and doesn't ship."
ReturnPolicy:
type: "object"
properties:
categoryTypes:
type: "array"
description: "This container indicates which category group that the return\
\ policy applies to.
Note: Return\
\ business policies are not applicable to motor vehicle listings, so the\
\ categoryTypes.name value will always be ALL_EXCLUDING_MOTORS_VEHICLES\
\ for return business policies."
items:
$ref: "#/components/schemas/CategoryType"
description:
type: "string"
description: "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.
Max length: 250"
extendedHolidayReturnsOffered:
type: "boolean"
description: "
Important!\ \ This field is deprecated, since eBay no longer supports extended holiday\ \ returns. Any value supplied in this field is neither read nor returned.
" internationalOverride: description: "This container shows the seller's international return policy\ \ settings. This container is only returned if the seller has set a separate\ \ international return policy for the business policy. International return\ \ policies are optional, even if the seller ships to international locations.\ \ If a separate international return policy is not set, all of the domestic\ \ return policy settings also apply to international orders." $ref: "#/components/schemas/InternationalReturnOverrideType" marketplaceId: type: "string" description: "The ID of the eBay marketplace to which this return business\ \ policy applies. For implementation help, refer to eBay\ \ API documentation" name: type: "string" description: "A seller-defined name for this return business policy. Names\ \ must be unique for policies assigned to the same marketplace.MONEY_BACK unless the seller is enabled\
\ for Buy online, Pickup in Store or Click and Collect,\
\ and then it might be MERCHANDISE_CREDIT. 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 eBay\
\ API documentation"
restockingFeePercentage:
type: "string"
description: "Important!\ \ 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.
" returnInstructions: type: "string" description: "This text-based field provides more details on seller-specified\ \ return instructions. This field is only returned if set for the return\ \ business policy.Important! This field is no longer supported on many eBay\
\ marketplaces. To see if a marketplace and eBay category does support\
\ this field, call getReturnPolicies method of the Metadata API. Then you will\
\ look for the policyDescriptionEnabled field with a value of true\
\ for the eBay category.
true, the seller\
\ accepts returns. If set to false, the seller does not accept\
\ returns.BUYER or SELLER. ALL_EXCLUDING_MOTORS_VEHICLES\
\ for return business policies."
items:
$ref: "#/components/schemas/CategoryType"
description:
type: "string"
description: "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. Important!\ \ This field is deprecated, since eBay no longer supports extended holiday\ \ returns. Any value supplied in this field is neither read nor returned.
" internationalOverride: description: "This container is used by the seller to specify a separate\ \ international return policy. If a separate international return policy\ \ is not defined by a seller, all of the domestic return policy settings\ \ will also apply to international orders." $ref: "#/components/schemas/InternationalReturnOverrideType" marketplaceId: type: "string" description: "The ID of the eBay marketplace to which this return business\ \ policy applies. For implementation help, refer to eBay\ \ API documentation" name: type: "string" description: "A seller-defined name for this return business policy. Names\ \ must be unique for policies assigned to the same marketplace.MONEY_BACK if omitted, so this field\
\ is only needed for Buy online, Pickup in Store or Click and\
\ Collect 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.Important! If this field is not included in\
\ a return business policy, it will default to MONEY_BACK.
Important!\ \ 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.
" returnInstructions: type: "string" description: "This text-based field provides more details on seller-specified\ \ return instructions.Important! This field is no longer supported\
\ on many eBay marketplaces. To see if a marketplace and eBay category\
\ does support this field, call getReturnPolicies method of the Metadata API. Then you will\
\ look for the policyDescriptionEnabled field with a value of true\
\ for the eBay category.
Note: Eligible Parts & Accessories (P&A)\ \ listings require sellers to offer buyers free returns with a minimum\ \ return period of 30 days. See Support for easy returns in Parts and Accessories\ \ for details.
DAY and value to either 30 or 60\
\ (or other value, as appropriate). true."
$ref: "#/components/schemas/TimeDuration"
returnsAccepted:
type: "boolean"
description: "If set to true, the seller accepts returns. If\
\ set to false, the seller does not accept returns.BUYER or SELLER. Note: Eligible Parts &\ \ Accessories (P&A) listings require sellers to offer buyers free returns\ \ with a minimum return period of 30 days. See Support for easy returns in Parts and Accessories\ \ for details.
true.\
\ For implementation help, refer to eBay\
\ API documentation"
description: "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."
ReturnPolicyResponse:
type: "object"
properties:
href:
type: "string"
description: "This field is for future use."
limit:
type: "integer"
description: "This field is for future use."
format: "int32"
next:
type: "string"
description: "This field is for future use."
offset:
type: "integer"
description: "This field is for future use."
format: "int32"
prev:
type: "string"
description: "This field is for future use."
returnPolicies:
type: "array"
description: "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."
items:
$ref: "#/components/schemas/ReturnPolicy"
total:
type: "integer"
description: "The total number of return business policies retrieved in\
\ the result set. 0."
format: "int32"
description: "The response payload for the getReturnPolicies method.\
\ USCAcountryCode is US, the only\
\ supported return values for salesTaxJurisdictionId are:AS\
\ (American Samoa)GU (GuamMP\
\ Northern Mariana IslandsPW (Palau)VI\
\ (US Virgin Islands)7.75"
shippingAndHandlingTaxed:
type: "boolean"
description: "If returned as true, sales tax is also applied\
\ to shipping and handling charges, and not just the total sales price\
\ of the order."
description: "This type is used to provide sales tax settings for a specific\
\ tax jurisdiction."
SalesTaxBase:
type: "object"
properties:
salesTaxPercentage:
type: "string"
description: "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 shippingAndHandlingTaxed\
\ value will indicate whether or not sales tax is also applied to shipping\
\ and handling charges7.75."
shippingAndHandlingTaxed:
type: "boolean"
description: "This field is set to true 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 false."
description: "This type is used by the base request of the createOrReplaceSalesTax. "
SalesTaxInput:
type: "object"
properties:
countryCode:
type: "string"
description: "This parameter specifies the two-letter ISO 3166 code\
\ of the country for which a sales-tax table entry is to be created or\
\ updated.USCAcountryCode\
\ is set to US, the only supported values for jurisdictionId\
\ are:AS (American Samoa)GU\
\ (Guam)MP (Northern Mariana Islands)PW\
\ (Palau)VI (US Virgin Islands)7.75."
shippingAndHandlingTaxed:
type: "boolean"
description: "This parameter is set to true 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 false."
SalesTaxes:
type: "object"
properties:
salesTaxes:
type: "array"
description: "An array of one or more sales-tax rate entries for a specified\
\ country.204 No Content\
\ is returned."
items:
$ref: "#/components/schemas/SalesTax"
description: "This type is used by the root response of the getSalesTaxes\
\ method."
SellerEligibilityMultiProgramResponse:
type: "object"
properties:
advertisingEligibility:
type: "array"
description: "An array of response fields that define the seller eligibility\
\ for eBay advertising programs."
items:
$ref: "#/components/schemas/SellerEligibilityResponse"
description: "The base response of the getAdvertisingEligibility method\
\ that contains the seller eligibility information for one or more advertising\
\ programs."
SellerEligibilityResponse:
type: "object"
properties:
programType:
type: "string"
description: "The eBay advertising program for which a seller may be eligible.\
\ For implementation help, refer to eBay\
\ API documentation"
reason:
type: "string"
description: "The reason why a seller is ineligible for the specified eBay\
\ advertising program.true, the seller's\
\ registration is completed. If this field is returned as false,\
\ the registration process is not complete."
sellingLimit:
description: "This container lists the monthly cap for the quantity of items\
\ sold and total sales amount allowed for the seller's account. This container\
\ may not be returned if a seller does not have a monthly cap for total\
\ quantity sold and total sales amount. true, the seller offers freight\
\ shipping. Freight shipping can be used for large items over 150 lbs."
fulfillmentPolicyId:
type: "string"
description: "A unique eBay-assigned ID for a fulfillment business policy.\
\ This ID is generated when the policy is created."
globalShipping:
type: "boolean"
description: "Note: This field is only\
\ applicable for the eBay United Kingdom marketplace (EBAY_GB).true if the seller wants to\
\ use the Global Shipping Program for international shipments. See the\
\ Global Shipping Program help topic for more details and requirements\
\ on the Global Shipping Program.false or if the field is omitted, the\
\ seller has to manually specifying individual international shipping\
\ services (if the seller ships internationally), as described in Setting up worldwide shipping. If only local pickup or\ \ freight shipping is available for the item, this container may not get\ \ returned.
" $ref: "#/components/schemas/TimeDuration" localPickup: type: "boolean" description: "If returned astrue, local pickup is available\
\ for items using this policy."
marketplaceId:
type: "string"
description: "The ID of the eBay marketplace to which this fulfillment business\
\ policy applies. For implementation help, refer to eBay\
\ API documentation"
name:
type: "string"
description: "A seller-defined name for this fulfillment business policy.\
\ true, the seller offers the \"\
Click and Collect\" option. A separate ShippingServices\ \ object is used to specify cost and other details for every available\ \ domestic and international shipping service option.
" items: $ref: "#/components/schemas/ShippingOption" shipToLocations: description: "This container consists of the regionIncluded and regionExcluded\ \ containers, which define the geographical regions/countries/states or\ \ provinces/domestic regions where the seller does and doesn't ship to\ \ with this fulfillment policy." $ref: "#/components/schemas/RegionSet" warnings: type: "array" description: "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." items: $ref: "#/components/schemas/Error" description: "Complex type that that gets populated with a response containing\ \ a fulfillment policy." SetPaymentPolicyResponse: type: "object" properties: categoryTypes: type: "array" description: "This container indicates whether the payment business policy\ \ applies to motor vehicle listings, or if it applies to non-motor vehicle\ \ listings." items: $ref: "#/components/schemas/CategoryType" deposit: description: "This container is only returned if the seller just created\ \ or updated a motor vehicles payment business policy and requires buyers\ \ to pay an initial deposit after they commit to buying a motor vehicle." $ref: "#/components/schemas/Deposit" description: type: "string" description: "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.Note: This value is always returned if categoryTypes is\
\ set to MOTORS_VEHICLES.
true\
\ indicates that immediate payment is required from the buyer for: true 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."
marketplaceId:
type: "string"
description: "The ID of the eBay marketplace to which this payment business\
\ policy applies. For implementation help, refer to eBay\
\ API documentation"
name:
type: "string"
description: "A seller-defined name for this payment business policy. Names\
\ must be unique for policies assigned to the same marketplace.Note: 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.
A free-form string field that allows sellers to add detailed\ \ payment instructions to their listings." paymentMethods: type: "array" description: "This array shows the available payment methods that the seller\ \ has set for the payment business policy.ALL_EXCLUDING_MOTORS_VEHICLES\
\ for return business policies, since return business policies are not\
\ applicable to motor vehicle listings."
items:
$ref: "#/components/schemas/CategoryType"
description:
type: "string"
description: "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. Important!\ \ This field is deprecated, since eBay no longer supports extended holiday\ \ returns. This field should no longer be returned.
" internationalOverride: description: "This container is used by the seller to specify a separate\ \ international return policy, and will only be returned if the seller\ \ has set a separate return policy for international orders. If a separate\ \ international return policy is not defined by a seller, all of the domestic\ \ return policy settings will also apply to international orders." $ref: "#/components/schemas/InternationalReturnOverrideType" marketplaceId: type: "string" description: "The ID of the eBay marketplace to which this return business\ \ policy applies. For implementation help, refer to eBay\ \ API documentation" name: type: "string" description: "A seller-defined name for this return business policy. Names\ \ must be unique for policies assigned to the same marketplace.MONEY_BACK. For implementation help,\
\ refer to eBay\
\ API documentation"
restockingFeePercentage:
type: "string"
description: "Important!\ \ This field is deprecated, since eBay no longer allows sellers to charge\ \ a restocking fee for buyer remorse returns.
" returnInstructions: type: "string" description: "This text-based field provides more details on seller-specified\ \ return instructions.Important! This field is no longer supported\
\ on many eBay marketplaces. To see if a marketplace and eBay category\
\ does support this field, call getReturnPolicies method of the Metadata API. Then you will\
\ look for the policyDescriptionEnabled field with a value of true\
\ for the eBay category.
Note: Eligible\ \ Parts & Accessories (P&A) listings require sellers to offer buyers free\ \ returns with a minimum return period of 30 days. See Support for easy returns in Parts and Accessories\ \ for details.
" $ref: "#/components/schemas/TimeDuration" returnPolicyId: type: "string" description: "A unique eBay-assigned ID for a return business policy. This\ \ ID is generated when the policy is created." returnsAccepted: type: "boolean" description: "If set totrue, the seller accepts returns. If\
\ set to false, this field indicates that the seller does\
\ not accept returns."
returnShippingCostPayer:
type: "string"
description: "This field indicates who is responsible for paying for the\
\ shipping charges for returned items. The field can be set to either\
\ BUYER or SELLER. Note: Eligible Parts &\ \ Accessories (P&A) listings require sellers to offer buyers free returns\ \ with a minimum return period of 30 days. See Support for easy returns in Parts and Accessories\ \ for details.
FLAT_RATE\
\ (the same rate for all buyers, or buyers within a region if shipping\
\ rate tables are used) or CALCULATED (the shipping rate\
\ varies by the ship-to location and size and weight of the package).\
\ true\
\ 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. true\
\ for a motor vehicle listing if it will be the buyer's responsibility\
\ to arrange for shipment of a motor vehicle. true if the\
\ seller offers a free domestic shipping option to the buyer. true for the first\
\ domestic shipping service option specified in the shippingServices\
\ array (it is ignored if set for subsequent shipping services or for\
\ any international shipping service option). 1\
\ or if the sortOrderId field is not used, it is the shipping service\
\ option that's specified first in the shippingServices array.USPS,\
\ FedEx, or UPS. Although this field uses the\
\ string type, the seller must pass in a pre-defined enumeration\
\ value here. ShippingCarrierDetails.\
\ The enum values for each shipping carriers can be found in each ShippingCarrierDetails.ShippingCarrier\
\ field in the response payload.0.0 for the first specified domestic\
\ shipping service option and if the corresponding freeShipping\
\ field is set to true. USPSPriority, FedEx2Day,\
\ or UPS3rdDay. Although this field uses the string\
\ type, the seller must pass in a pre-defined enumeration value here.\
\ ShippingServiceDetails.\
\ true value in the\
\ corresponding ValidForSellingFlow boolean field. International\
\ shipping service options are typically returned at the top of the response\
\ payload, and are indicated by an InternationalService boolean\
\ field that reads true. ExcludeShippingLocationDetails,\
\ then review the ExcludeShippingLocationDetails containers in\
\ the response for the strings you use in the regionIncluded.regionName\
\ field. ExcludeShippingLocationDetails\
\ containers in the GeteBayDetails response where the Region\
\ value is Worldwide, and the valid values will be shown\
\ in the corresponding Location fields.ExcludeShippingLocationDetails\
\ in the GeteBayDetails response where the Region value\
\ is one of the defined geographical regions, and the valid values will\
\ be shown in the corresponding Location fields. Alternatively,\
\ you can find the two-digit country code values in the CountryCodeEnum type definition.ExcludeShippingLocationDetails in the\
\ GeteBayDetails response where the Region value is either\
\ Domestic Location or Additional Locations,\
\ and the valid values will be shown in the corresponding Location\
\ fields.STATE_OR_PROVINCE region type is\
\ only applicable to the US and Canada, and valid values for US states\
\ are the same two-digit abbreviations used by the United States Postal Service,\
\ and valid values for Canadian provinces and territories are the same\
\ two-digit abbreviations used by the Canada Post."
$ref: "#/components/schemas/RegionSet"
sortOrder:
type: "integer"
description: "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. DAY. A span of time is defined when you apply the value\
\ specified in the value field to the value specified for unit.\
\ statusCode will be listed for all sales-tax table entries\
\ returned in the payload."
format: "int32"
description: "This container stores the array of sales-tax table entries that\
\ have been created or updated."
UpdatedSalesTaxResponse:
type: "object"
properties:
updatedSalesTaxEntries:
type: "array"
description: "The array of new and updated sales-tax table entries."
items:
$ref: "#/components/schemas/UpdatedSalesTaxEntry"
description: "This type is used to return the list of new and updated sales-tax\
\ table entries."
securitySchemes:
api_auth:
type: "oauth2"
description: "The security definitions for this API. Please check individual\
\ operations for applicable scopes."
flows:
authorizationCode:
authorizationUrl: "https://auth.ebay.com/oauth2/authorize"
tokenUrl: "https://api.ebay.com/identity/v1/oauth2/token"
scopes:
https://api.ebay.com/oauth/api_scope/sell.account.readonly: "View your\
\ account settings"
https://api.ebay.com/oauth/api_scope/sell.account: "View and manage your\
\ account settings"