openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 194 kB

JSON

{"openapi":"3.0.0","servers":[{"description":"Production","url":"https://api.ebay.com{basePath}","variables":{"basePath":{"default":"/sell/account/v1"}}}],"info":{"contact":{"name":"eBay Inc,","x-twitter":"ebay"},"description":"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 <a href=\"/api-docs/sell/account/overview.html#requirements\">Account API requirements and restrictions</a>.","license":{"name":"eBay API License Agreement","url":"https://go.developer.ebay.com/api-license-agreement"},"title":"Account API","version":"v1.9.0","x-apisguru-categories":["ecommerce"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://twitter.com/ebay/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://developer.ebay.com/api-docs/master/sell/account/openapi/3/sell_account_v1_oas3.json","version":"3.0"}],"x-providerName":"ebay.com","x-serviceName":"sell-account"},"paths":{"/advertising_eligibility":{"get":{"description":"This method allows developers to check the seller eligibility status for eBay advertising programs.","operationId":"getAdvertisingEligibility","parameters":[{"description":"A comma-separated list of eBay advertising programs. Tip: See the <a href=\"/api-docs/sell/account/types/plser:AdvertisingProgramEnum\"> AdvertisingProgramEnum</a> type for possible values. If no programs are specified, the results will be returned for all programs.","in":"query","name":"program_types","required":false,"schema":{"type":"string"}},{"description":"The unique identifier of the eBay marketplace for which the seller eligibility status shall be checked. Note: This value is case-sensitive.","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerEligibilityMultiProgramResponse"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"50114":{"category":"REQUEST","description":"The HTTP request header 'X-EBAY-C-MARKETPLACE-ID' is required.","domain":"API_ACCOUNT"},"50116":{"category":"REQUEST","description":"Invalid program_type(s) {programTypes}.","domain":"API_ACCOUNT"},"50117":{"category":"REQUEST","description":"Invalid marketplaceId in HTTP request header 'X-EBAY-C-MARKETPLACE-ID' {marketplaceId}.","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"35001":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_ACCOUNT"},"35002":{"category":"APPLICATION","description":"Internal error. Please wait a few minutes and try the call again.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["advertising_eligibility"]}},"/custom_policy/":{"get":{"description":"This method retrieves the list of custom policies specified by the policy_types query parameter for the selected eBay marketplace. Note: The following eBay marketplaces support Custom Policies: <ul><li>Germany (EBAY_DE)</li> <li>Canada (EBAY_CA)</li> <li>Australia (EBAY_AU)</li> <li>United States (EBAY_US)</li> <li>France (EBAY_FR)</li></ul> <div class=\"msgbox_important\">Important! \">Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell. Due to this change, the X-EBAY-C-MARKETPLACE-ID request header is no longer relevant. If this header is passed in after April 3, it will just be ignored in all four methods.</div> For details on header values, see <a href=\"/api-docs/static/rest-request-components.html#HTTP\" target=\"_blank\">HTTP request headers</a>.","operationId":"getCustomPolicies","parameters":[{"description":"This query parameter specifies the type of custom policies to be returned. Multiple policy types may be requested in a single call by providing a comma-delimited set of all policy types to be returned. Note: Omitting this query parameter from a request will also return policies of all policy types. Two Custom Policy types are supported: <ul><li>Product Compliance (PRODUCT_COMPLIANCE)</li> <li>Takeback (TAKE_BACK)</li></ul>","in":"query","name":"policy_types","required":false,"schema":{"type":"string"}},{"description":"This header parameter specifies the eBay marketplace for the custom policy that is being created. Supported values for this header can be found in the <a href=\"/api-docs/sell/account/types/ba:MarketplaceIdEnum\" target=\"_blank\">MarketplaceIdEnum</a> type definition. Note: The following eBay marketplaces support Custom Policies: <ul><li>Germany (EBAY_DE)</li> <li>Canada (EBAY_CA)</li> <li>Australia (EBAY_AU)</li> <li>United States (EBAY_US)</li> <li>France (EBAY_FR)</li></ul><div class=\"msgbox_important\">Important! \">Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell. Due to this change, the X-EBAY-C-MARKETPLACE-ID request header is no longer relevant. If this header is passed in after April 3, it will just be ignored in all four methods.</div>","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPolicyResponse"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20411":{"category":"REQUEST","description":"Invalid/Missing policyTypes {policyType}","domain":"API_ACCOUNT"},"20415":{"category":"REQUEST","description":"Invalid/Missing marketplaceId","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["custom_policy"]},"post":{"description":"This method creates a new custom policy in which a seller specifies their terms for complying with local governmental regulations. Two Custom Policy types are supported: <ul><li>Product Compliance (PRODUCT_COMPLIANCE)</li> <li>Takeback (TAKE_BACK)</li></ul>Each Custom Policy targets a policyType and eBay marketplace combination. Multiple policies may be created as follows: <ul><li>Product Compliance: a maximum of 10 policies per eBay marketplace may be created</li> <li>Takeback: a maximum of 3 policies per eBay marketplace may be created</li></ul>A successful create policy call returns an HTTP status code of 201 Created with the system-generated policy ID included in the Location response header. Product Compliance Policy Product Compliance policies disclose product information as required for regulatory compliance. Note: A maximum of 10 Product Compliance policies per eBay marketplace may be created. Takeback Policy Takeback policies describe the seller's legal obligation to take back a previously purchased item when the buyer purchases a new one. Note: A maximum of 3 Takeback policies per eBay marketplace may be created. <div class=\"msgbox_important\">Important! \">Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell. Due to this change, the X-EBAY-C-MARKETPLACE-ID request header is no longer relevant. If this header is passed in after April 3, it will just be ignored in all four methods.</div>","operationId":"createCustomPolicy","parameters":[{"description":"This header parameter specifies the eBay marketplace for the custom policy that is being created. Supported values for this header can be found in the <a href=\"/api-docs/sell/account/types/ba:MarketplaceIdEnum\" target=\"_blank\">MarketplaceIdEnum</a> type definition. Note: The following eBay marketplaces support Custom Policies: <ul><li>Germany (EBAY_DE)</li> <li>Canada (EBAY_CA)</li> <li>Australia (EBAY_AU)</li> <li>United States (EBAY_US)</li> <li>France (EBAY_FR)</li></ul> <div class=\"msgbox_important\">Important! \">Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell. Due to this change, the X-EBAY-C-MARKETPLACE-ID request header is no longer relevant. If this header is passed in after April 3, it will just be ignored in all four methods.</div>","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPolicyCreateRequest","description":"Request to create a new Custom Policy."}}},"description":"Request to create a new Custom Policy.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Created","headers":{"Location":{"schema":{"description":"The location response header contains the URL to the newly created custom policy. The URL includes the eBay-assigned <code>custom_policy_id</code>, which can be used to reference the policy.","type":"string"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20411":{"category":"REQUEST","description":"Invalid/Missing policyType","domain":"API_ACCOUNT"},"20412":{"category":"REQUEST","description":"Invalid/Missing label","domain":"API_ACCOUNT"},"20413":{"category":"REQUEST","description":"Invalid/Missing name","domain":"API_ACCOUNT"},"20414":{"category":"REQUEST","description":"Invalid/Missing description","domain":"API_ACCOUNT"},"20415":{"category":"REQUEST","description":"Invalid/Missing marketplaceId","domain":"API_ACCOUNT"},"20417":{"category":"REQUEST","description":"Maximum custom policy per site is reached","domain":"API_ACCOUNT"},"20418":{"category":"REQUEST","description":"This policy name is already used","domain":"API_ACCOUNT"}}}},"409":{"description":"Policy Name already used/ Maximum no of policies per site reached"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["custom_policy"]}},"/custom_policy/{custom_policy_id}":{"get":{"description":"This method retrieves the custom policy specified by the custom_policy_id path parameter for the selected eBay marketplace. Note: The following eBay marketplaces support Custom Policies: <ul><li>Germany (EBAY_DE)</li> <li>Canada (EBAY_CA)</li> <li>Australia (EBAY_AU)</li> <li>United States (EBAY_US)</li> <li>France (EBAY_FR)</li></ul> <div class=\"msgbox_important\">Important! \">Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell. Due to this change, the X-EBAY-C-MARKETPLACE-ID request header is no longer relevant. If this header is passed in after April 3, it will just be ignored in all four methods.</div> For details on header values, see <a href=\"/api-docs/static/rest-request-components.html#HTTP\" target=\"_blank\">HTTP request headers</a>.","operationId":"getCustomPolicy","parameters":[{"description":"This path parameter is the unique custom policy identifier for the policy to be returned. Note: This value is automatically assigned by the system when the policy is created.","in":"path","name":"custom_policy_id","required":true,"schema":{"type":"string"}},{"description":"This header parameter specifies the eBay marketplace for the custom policy that is being created. Supported values for this header can be found in the <a href=\"/api-docs/sell/account/types/ba:MarketplaceIdEnum\" target=\"_blank\">MarketplaceIdEnum</a> type definition. Note: The following eBay marketplaces support Custom Policies: <ul><li>Germany (EBAY_DE)</li> <li>Canada (EBAY_CA)</li> <li>Australia (EBAY_AU)</li> <li>United States (EBAY_US)</li> <li>France (EBAY_FR)</li></ul> <div class=\"msgbox_important\">Important! \">Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell. Due to this change, the X-EBAY-C-MARKETPLACE-ID request header is no longer relevant. If this header is passed in after April 3, it will just be ignored in all four methods.</div>","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPolicy"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20415":{"category":"REQUEST","description":"Invalid/Missing marketplaceId","domain":"API_ACCOUNT"},"20416":{"category":"REQUEST","description":"Invalid/Missing customPolicyId","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["custom_policy"]},"put":{"description":"This method updates an existing custom policy specified by the custom_policy_id path parameter for the selected marketplace. This method overwrites the policy's Name, Label, and Description fields. Therefore, the complete, current text of all three policy fields must be included in the request payload even when one or two of these fields will not actually be updated. For example, the value for the Label field is to be updated, but the Name and Description values will remain unchanged. The existing Name and Description values, as they are defined in the current policy, must also be passed in. A successful policy update call returns an HTTP status code of 204 No Content. Note: The following eBay marketplaces support Custom Policies: <ul><li>Germany (EBAY_DE)</li> <li>Canada (EBAY_CA)</li> <li>Australia (EBAY_AU)</li> <li>United States (EBAY_US)</li> <li>France (EBAY_FR)</li></ul> <div class=\"msgbox_important\">Important! \">Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell. Due to this change, the X-EBAY-C-MARKETPLACE-ID request header is no longer relevant. If this header is passed in after April 3, it will just be ignored in all four methods.</div> For details on header values, see <a href=\"/api-docs/static/rest-request-components.html#HTTP\">HTTP request headers</a>.","operationId":"updateCustomPolicy","parameters":[{"description":"This path parameter is the unique custom policy identifier for the policy to be returned. Note: This value is automatically assigned by the system when the policy is created.","in":"path","name":"custom_policy_id","required":true,"schema":{"type":"string"}},{"description":"This header parameter specifies the eBay marketplace for the custom policy that is being created. Supported values for this header can be found in the <a href=\"/api-docs/sell/account/types/ba:MarketplaceIdEnum\" target=\"_blank\">MarketplaceIdEnum</a> type definition. Note: The following eBay marketplaces support Custom Policies: <ul><li>Germany (EBAY_DE)</li> <li>Canada (EBAY_CA)</li> <li>Australia (EBAY_AU)</li> <li>United States (EBAY_US)</li> <li>France (EBAY_FR)</li></ul> <div class=\"msgbox_important\">Important! \">Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell. Due to this change, the X-EBAY-C-MARKETPLACE-ID request header is no longer relevant. If this header is passed in after April 3, it will just be ignored in all four methods.</div>","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPolicyRequest","description":"Request to update a current custom policy."}}},"description":"Request to update a current custom policy.","required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20412":{"category":"REQUEST","description":"Invalid/Missing label","domain":"API_ACCOUNT"},"20413":{"category":"REQUEST","description":"Invalid/Missing name","domain":"API_ACCOUNT"},"20414":{"category":"REQUEST","description":"Invalid/Missing description","domain":"API_ACCOUNT"},"20415":{"category":"REQUEST","description":"Invalid/Missing marketplaceId","domain":"API_ACCOUNT"},"20416":{"category":"REQUEST","description":"Invalid/Missing customPolicyId","domain":"API_ACCOUNT"},"20418":{"category":"REQUEST","description":"This policy name is already used","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"409":{"description":"Policy Name already used/ Maximum no of policies per site reached"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["custom_policy"]}},"/fulfillment_policy":{"get":{"description":"This method retrieves all the fulfillment policies configured for the marketplace you specify using the <code>marketplace_id</code> query parameter. Marketplaces and locales 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>.","operationId":"getFulfillmentPolicies","parameters":[{"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","in":"query","name":"marketplace_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FulfillmentPolicyResponse"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["fulfillment_policy"]}},"/fulfillment_policy/":{"post":{"description":"This method creates a new fulfillment policy where the policy encapsulates seller's terms for fulfilling item purchases. Fulfillment policies include the shipment options that the seller offers to buyers. Each policy targets a specific eBay marketplace and a category group type, and you can create multiple policies for each combination. A successful request returns the getFulfillmentPolicy URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload. Tip: For details on creating and using the business policies supported by the Account API, see <a href=\"/api-docs/sell/static/seller-accounts/business-policies.html\">eBay business policies</a>. Using the eBay standard envelope service (eSE) The eBay standard envelope service (eSE) is a domestic envelope service with tracking through eBay. This service applies to specific Trading Cards categories (not all categories are supported), and to Coins & Paper Money, Postcards, and Stamps. See <a href=\"/api-docs/sell/static/seller-accounts/using-the-ebay-standard-envelope-service.html\" target=\"_blank\">Using the eBay standard envelope (eSE) service</a>.","operationId":"createFulfillmentPolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FulfillmentPolicyRequest","description":"Request to create a seller account fulfillment policy."}}},"description":"Request to create a seller account fulfillment policy.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetFulfillmentPolicyResponse"}}},"description":"Created","headers":{"Location":{"schema":{"description":"The location response header contains the URL to the newly created fulfillment policy. The URL includes the eBay-assigned <code>fulfillmentPolicyId</code>, which you can use to reference the policy.","type":"string"}}},"x-response-codes":{"errors":{"20200":{"category":"BUSINESS","description":"Warning. {additionalInfo}","domain":"API_ACCOUNT"},"20201":{"category":"BUSINESS","description":"{fieldName} (Click and Collect Program) can not be enabled for this seller or marketplace.","domain":"API_ACCOUNT"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20400":{"category":"REQUEST","description":"Invalid request. {additionalInfo}","domain":"API_ACCOUNT"},"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20402":{"category":"REQUEST","description":"Invalid input. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["fulfillment_policy"]}},"/fulfillment_policy/get_by_policy_name":{"get":{"description":"This method retrieves the details for a specific fulfillment policy. In the request, supply both the policy <code>name</code> and its associated <code>marketplace_id</code> as query parameters. Marketplaces and locales 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>.","operationId":"getFulfillmentPolicyByName","parameters":[{"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","in":"query","name":"marketplace_id","required":true,"schema":{"type":"string"}},{"description":"This query parameter specifies the seller-defined name of the fulfillment policy you want to retrieve.","in":"query","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FulfillmentPolicy"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["fulfillment_policy"]}},"/fulfillment_policy/{fulfillmentPolicyId}":{"delete":{"description":"This method deletes a fulfillment policy. Supply the ID of the policy you want to delete in the fulfillmentPolicyId path parameter.","operationId":"deleteFulfillmentPolicy","parameters":[{"description":"This path parameter specifies the ID of the fulfillment policy to delete.","in":"path","name":"fulfillmentPolicyId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20402":{"category":"REQUEST","description":"Invalid input. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"409":{"description":"Conflict","x-response-codes":{"errors":{"20409":{"category":"BUSINESS","description":"Invalid default policy type. {additionalInfo}","domain":"API_ACCOUNT"},"21409":{"category":"BUSINESS","description":"Invalid default for category type. {additionalInfo}","domain":"API_ACCOUNT"},"22409":{"category":"BUSINESS","description":"Invalid target default policy. {additionalInfo}","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["fulfillment_policy"]},"get":{"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":[{"description":"This path parameter specifies the ID of the fulfillment policy you want to retrieve.","in":"path","name":"fulfillmentPolicyId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FulfillmentPolicy"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["fulfillment_policy"]},"put":{"description":"This method updates an existing fulfillment policy. Specify the policy you want to update using the fulfillment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.","operationId":"updateFulfillmentPolicy","parameters":[{"description":"This path parameter specifies the ID of the fulfillment policy you want to update.","in":"path","name":"fulfillmentPolicyId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FulfillmentPolicyRequest","description":"Fulfillment policy request"}}},"description":"Fulfillment policy request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetFulfillmentPolicyResponse"}}},"description":"OK","x-response-codes":{"errors":{"20200":{"category":"BUSINESS","description":"Warning. {additionalInfo}","domain":"API_ACCOUNT"},"20201":{"category":"BUSINESS","description":"{fieldName} (Click and Collect Program) can not be enabled for this seller or marketplace.","domain":"API_ACCOUNT"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20400":{"category":"REQUEST","description":"Invalid request. {additionalInfo}","domain":"API_ACCOUNT"},"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20402":{"category":"REQUEST","description":"Invalid input. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["fulfillment_policy"]}},"/kyc":{"get":{"description":"Note:This method was originally created to see which onboarding requirements were still pending for sellers being onboarded for eBay managed payments, but now that all seller accounts are onboarded globally, this method should now just returne an empty payload with a <code>204 No Content</code> HTTP status code. ","operationId":"getKYC","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KycResponse"}}},"description":"OK"},"204":{"description":"No Content"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"21400":{"category":"REQUEST","description":"This marketplace is not supported. Please refer to documentation.","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["kyc"]}},"/payment_policy":{"get":{"description":"This method retrieves all the payment policies configured for the marketplace you specify using the <code>marketplace_id</code> query parameter. Marketplaces and locales 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>.","operationId":"getPaymentPolicies","parameters":[{"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","in":"query","name":"marketplace_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentPolicyResponse"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["payment_policy"]},"post":{"description":"This method creates a new payment policy where the policy encapsulates seller's terms for order payments. Each policy targets a specific eBay marketplace and category group, and you can create multiple policies for each combination. A successful request returns the getPaymentPolicy URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload. Tip: For details on creating and using the business policies supported by the Account API, see <a href=\"/api-docs/sell/static/seller-accounts/business-policies.html\">eBay business policies</a>.","operationId":"createPaymentPolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentPolicyRequest","description":"Payment policy request"}}},"description":"Payment policy request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPaymentPolicyResponse"}}},"description":"Created","headers":{"Location":{"schema":{"description":"The location response header contains the URL to the newly created payment policy. The URL includes the eBay-assigned <code>paymentPolicyId</code>, which you can use to reference the policy.","type":"string"}}},"x-response-codes":{"errors":{"20200":{"category":"BUSINESS","description":"Warning. {additionalInfo}","domain":"API_ACCOUNT"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20400":{"category":"REQUEST","description":"Invalid request. {additionalInfo}","domain":"API_ACCOUNT"},"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"},"20405":{"category":"REQUEST","description":"Invalid payment method. {fieldName}","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["payment_policy"]}},"/payment_policy/get_by_policy_name":{"get":{"description":"This method retrieves the details of a specific payment policy. Supply both the policy <code>name</code> and its associated <code>marketplace_id</code> in the request query parameters. Marketplaces and locales 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>.","operationId":"getPaymentPolicyByName","parameters":[{"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","in":"query","name":"marketplace_id","required":true,"schema":{"type":"string"}},{"description":"This query parameter specifies the seller-defined name of the payment policy you want to retrieve.","in":"query","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentPolicy"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["payment_policy"]}},"/payment_policy/{payment_policy_id}":{"delete":{"description":"This method deletes a payment policy. Supply the ID of the policy you want to delete in the paymentPolicyId path parameter. ","operationId":"deletePaymentPolicy","parameters":[{"description":"This path parameter specifies the ID of the payment policy you want to delete.","in":"path","name":"payment_policy_id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20402":{"category":"REQUEST","description":"Invalid input. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"409":{"description":"Conflict","x-response-codes":{"errors":{"20409":{"category":"BUSINESS","description":"Invalid default policy type. {additionalInfo}","domain":"API_ACCOUNT"},"21409":{"category":"BUSINESS","description":"Invalid default for category type. {additionalInfo}","domain":"API_ACCOUNT"},"22409":{"category":"BUSINESS","description":"Invalid target default policy. {additionalInfo}","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["payment_policy"]},"get":{"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":[{"description":"This path parameter specifies the ID of the payment policy you want to retrieve.","in":"path","name":"payment_policy_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentPolicy"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["payment_policy"]},"put":{"description":"This method updates an existing payment policy. Specify the policy you want to update using the payment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.","operationId":"updatePaymentPolicy","parameters":[{"description":"This path parameter specifies the ID of the payment policy you want to update.","in":"path","name":"payment_policy_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentPolicyRequest","description":"Payment policy request"}}},"description":"Payment policy request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPaymentPolicyResponse"}}},"description":"OK","x-response-codes":{"errors":{"20200":{"category":"BUSINESS","description":"Warning. {additionalInfo}","domain":"API_ACCOUNT"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20400":{"category":"REQUEST","description":"Invalid request. {additionalInfo}","domain":"API_ACCOUNT"},"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20402":{"category":"REQUEST","description":"Invalid input. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"},"20405":{"category":"REQUEST","description":"Invalid payment method. {fieldName}","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["payment_policy"]}},"/payments_program/{marketplace_id}/{payments_program_type}":{"get":{"description":"Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow. This method returns whether or not the user is opted-in to the specified payments program. Sellers opt-in to payments programs by marketplace and you use the marketplace_id path parameter to specify the marketplace of the status flag you want returned.","operationId":"getPaymentsProgram","parameters":[{"description":"This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status.","in":"path","name":"marketplace_id","required":true,"schema":{"type":"string"}},{"description":"This path parameter specifies the payments program whose status is returned by the call.","in":"path","name":"payments_program_type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsProgramResponse"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20408":{"category":"REQUEST","description":"No payment program available. The user may not be registered to the speci