openapi: 3.0.0
info:
  x-ballerina-display:
    label: eBay Account
    iconPath: "icon.png"
  title: Account API
  description: >-
    This is a generated connector for [eBay Account API v1.6.3](https://developer.ebay.com/api-docs/sell/account/overview.html)  
    OpenAPI Specification.
    The Account API provide capability to access configure their eBay seller accounts, including the seller''s policies 
    (the Fulfillment Policy, Payment Policy, and Return Policy), opt in and out of eBay seller programs, configure sales tax tables, 
    and get account information. 
  contact:
    name: 'eBay Inc,'
  license:
    name: eBay API License Agreement
    url: 'https://go.developer.ebay.com/api-license-agreement'
  version: v1.6.3
  x-ballerina-init-description: >-
    The connector initialization requires setting the API credentials.
    Create a [developer account](https://developer.ebay.com/api-docs/static/creating-edp-account.html) 
    and obtain tokens following [this guide](https://developer.ebay.com/api-docs/static/oauth-tokens.html).

servers:
  - url: 'https://api.ebay.com{basePath}'
    description: Production
    variables:
      basePath:
        default: /sell/account/v1
paths:
  /fulfillment_policy:
    get:
      tags:
        - fulfillment_policy
      summary: 'This method retrieves all the fulfillment policies configured for the marketplace you specify using the marketplace_id query parameter. Marketplaces and locales 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.'
      operationId: getFulfillmentPolicies
      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
      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'
    post:
      tags:
        - fulfillment_policy
      summary: '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 marketplaceId and categoryTypes.name combination and you can create multiple policies for each combination. Be aware that some marketplaces require a specific fulfillment policy for vehicle listings. A successful request returns the 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 eBay business policies. Marketplaces and locales Policy instructions can be localized by providing a locale in the Accept-Language HTTP request header. For example, the following setting displays field values from the request body in German: Accept-Language: de-DE. Target the specific locale of a marketplace that supports multiple locales using the Content-Language request header. For example, target the French locale of the Canadian marketplace by specifying the fr-CA locale for Content-Language. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. Tip: For details on headers, see HTTP request headers.'
      operationId: createFulfillmentPolicy
      requestBody:
        description: Request to create a seller account fulfillment policy.
        content:
          application/json:
            schema:
              description: Request to create a seller account fulfillment policy.
              $ref: '#/components/schemas/FulfillmentPolicyRequest'
        required: true
      responses:
        '201':
          description: Created
          headers:
            Location:
              schema:
                type: string
                description: 'The <b>location</b> 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.'
          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
      summary: 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.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FulfillmentPolicy'
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '20403':
                domain: API_ACCOUNT
                category: REQUEST
                description: 'Invalid {fieldName}. {additionalInfo}'
              '20404':
                domain: API_ACCOUNT
                category: REQUEST
                description: '{fieldName} not found.'
        '404':
          description: 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'
    put:
      tags:
        - fulfillment_policy
      summary: 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:
        - name: fulfillmentPolicyId
          in: path
          description: This path parameter specifies the ID of the fulfillment policy you want to update.
          required: true
          schema:
            type: string
      requestBody:
        description: Fulfillment policy request
        content:
          application/json:
            schema:
              description: Fulfillment policy request
              $ref: '#/components/schemas/FulfillmentPolicyRequest'
        required: true
      responses:
        '200':
          description: OK
          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}'
              '20404':
                domain: API_ACCOUNT
                category: REQUEST
                description: '{fieldName} not found.'
        '404':
          description: 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'
    delete:
      tags:
        - fulfillment_policy
      summary: This method deletes a fulfillment policy. Supply the ID of the policy you want to delete in the fulfillmentPolicyId path parameter. Note that you cannot delete the default fulfillment policy.
      operationId: deleteFulfillmentPolicy
      parameters:
        - name: fulfillmentPolicyId
          in: path
          description: This path parameter specifies the ID of the fulfillment policy to delete.
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '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}'
              '20404':
                domain: API_ACCOUNT
                category: REQUEST
                description: '{fieldName} not found.'
        '404':
          description: Not Found
        '409':
          description: Conflict
          x-response-codes:
            errors:
              '20409':
                domain: API_ACCOUNT
                category: BUSINESS
                description: 'Invalid default policy type. {additionalInfo}'
              '21409':
                domain: API_ACCOUNT
                category: BUSINESS
                description: 'Invalid default for category type. {additionalInfo}'
              '22409':
                domain: API_ACCOUNT
                category: BUSINESS
                description: 'Invalid target default policy. {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/get_by_policy_name:
    get:
      tags:
        - fulfillment_policy
      summary: 'This method retrieves the complete details for a single fulfillment policy. In the request, supply both the policy name and its associated marketplace_id as query parameters. Marketplaces and locales 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.'
      operationId: getFulfillmentPolicyByName
      parameters:
        - 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 user-defined name of the fulfillment policy you want to retrieve.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FulfillmentPolicy'
        '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'
  /payment_policy:
    get:
      tags:
        - payment_policy
      summary: 'This method retrieves all the payment policies configured for the marketplace you specify using the marketplace_id query parameter. Marketplaces and locales 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.'
      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
      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
      summary: 'This method creates a new payment policy where the policy encapsulates seller''s terms for purchase payments. Each policy targets a marketplaceId and categoryTypes.name combination and you can create multiple policies for each combination. Be aware that some marketplaces require a specific payment policy for vehicle listings. A successful request returns the 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 eBay business policies. Marketplaces and locales Policy instructions can be localized by providing a locale in the Accept-Language HTTP request header. For example, the following setting displays field values from the request body in German: Accept-Language: de-DE. Target the specific locale of a marketplace that supports multiple locales using the Content-Language request header. For example, target the French locale of the Canadian marketplace by specifying the fr-CA locale for Content-Language. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. Tip: For details on headers, see HTTP request headers.'
      operationId: createPaymentPolicy
      requestBody:
        description: Payment policy request
        content:
          application/json:
            schema:
              description: Payment policy request
              $ref: '#/components/schemas/PaymentPolicyRequest'
        required: true
      responses:
        '201':
          description: Created
          headers:
            Location:
              schema:
                type: string
                description: 'The <b>location</b> 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.'
          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
      summary: 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.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentPolicy'
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '20403':
                domain: API_ACCOUNT
                category: REQUEST
                description: 'Invalid {fieldName}. {additionalInfo}'
              '20404':
                domain: API_ACCOUNT
                category: REQUEST
                description: '{fieldName} not found.'
        '404':
          description: 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'
    put:
      tags:
        - payment_policy
      summary: 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:
        - name: payment_policy_id
          in: path
          description: This path parameter specifies the ID of the payment policy you want to update.
          required: true
          schema:
            type: string
      requestBody:
        description: Payment policy request
        content:
          application/json:
            schema:
              description: Payment policy request
              $ref: '#/components/schemas/PaymentPolicyRequest'
        required: true
      responses:
        '200':
          description: OK
          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}'
              '20402':
                domain: API_ACCOUNT
                category: REQUEST
                description: 'Invalid input. {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}'
        '404':
          description: 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'
    delete:
      tags:
        - payment_policy
      summary: This method deletes a payment policy. Supply the ID of the policy you want to delete in the paymentPolicyId path parameter. Note that you cannot delete the default payment policy.
      operationId: deletePaymentPolicy
      parameters:
        - name: payment_policy_id
          in: path
          description: This path parameter specifies the ID of the payment policy you want to delete.
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '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}'
              '20404':
                domain: API_ACCOUNT
                category: REQUEST
                description: '{fieldName} not found.'
        '404':
          description: Not Found
        '409':
          description: Conflict
          x-response-codes:
            errors:
              '20409':
                domain: API_ACCOUNT
                category: BUSINESS
                description: 'Invalid default policy type. {additionalInfo}'
              '21409':
                domain: API_ACCOUNT
                category: BUSINESS
                description: 'Invalid default for category type. {additionalInfo}'
              '22409':
                domain: API_ACCOUNT
                category: BUSINESS
                description: 'Invalid target default policy. {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'
  /payment_policy/get_by_policy_name:
    get:
      tags:
        - payment_policy
      summary: 'This method retrieves the complete details of a single payment policy. Supply both the policy name and its associated marketplace_id in the request query parameters. Marketplaces and locales 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.'
      operationId: getPaymentPolicyByName
      parameters:
        - 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 user-defined name of the payment policy you want to retrieve.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentPolicy'
        '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'
  '/payments_program/{marketplace_id}/{payments_program_type}':
    get:
      tags:
        - payments_program
      summary: '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. Note: Currently, the only supported payments program is eBay Payments. For details, see: Managed Payments on eBay Payments Terms of Use'
      operationId: getPaymentsProgram
      parameters:
        - name: marketplace_id
          in: path
          description: This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status.
          required: true
          schema:
            type: string
        - name: payments_program_type
          in: path
          description: 'This path parameter specifies the payments program whose status is returned by the call. Currently the only supported payments program is EBAY_PAYMENTS. For details on the program, see Payments Terms of Use.'
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentsProgramResponse'
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '20408':
                domain: API_ACCOUNT
                category: REQUEST
                description: No payment program available. The user may not be registered to the specified site or the site may not be supported by the payments program.
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '20500':
                domain: API_ACCOUNT
                category: APPLICATION
                description: Application error
      security:
        - api_auth:
            - 'https://api.ebay.com/oauth/api_scope/sell.account'
            - 'https://api.ebay.com/oauth/api_scope/sell.account.readonly'
  '/payments_program/{marketplace_id}/{payments_program_type}/onboarding':
    get:
      tags:
        - onboarding
      summary: 'This method retrieves a seller''s onboarding status of eBay managed payments for a specified marketplace. The overall onboarding status of the seller and the status of each onboarding step is returned. Presently, the only supported payments program type is EBAY_PAYMENTS. See Managed Payments on eBay and Payments Terms of Use. Note: Managed payments availability: eBay managed payments is presently available in the US and Germany, and will roll out to Canada, UK, and Australia in July 2020.'
      operationId: getPaymentsProgramOnboarding
      parameters:
        - name: marketplace_id
          in: path
          description: The eBay marketplace ID associated with the onboarding status to retrieve. Only enums for marketplaces that support or will soon support eBay managed payments are allowed. Error 20408 is returned for any other eBay marketplace. No response payload is returned with this error.
          required: true
          schema:
            type: string
        - name: payments_program_type
          in: path
          description: 'The type of payments program whose status is returned by the call. Presently, the only supported payments program is EBAY_PAYMENTS. For details on the program, see Payments Terms of Use.'
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentsProgramOnboardingResponse'
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '20408':
                domain: API_ACCOUNT
                category: REQUEST
                description: No payments program available. The user may not be registered to the specified site or the site may not be supported by the payments program.
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '20500':
                domain: API_ACCOUNT
                category: APPLICATION
                description: Application error
      security:
        - api_auth:
            - 'https://api.ebay.com/oauth/api_scope/sell.account'
            - 'https://api.ebay.com/oauth/api_scope/sell.account.readonly'
  /privilege:
    get:
      tags:
        - privilege
      summary: 'This method retrieves the seller''s current set of privileges. The call returns whether or not the seller''s eBay registration has been completed, as well as the details of their site-wide sellingLimt (the amount and quantity they can sell on a given day).'
      operationId: getPrivileges
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SellingPrivileges'
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '20500':
                domain: API_ACCOUNT
                category: APPLICATION
                description: System error.
      security:
        - api_auth:
            - 'https://api.ebay.com/oauth/api_scope/sell.account'
            - 'https://api.ebay.com/oauth/api_scope/sell.account.readonly'
  /program/get_opted_in_programs:
    get:
      tags:
        - program
      summary: This method gets a list of the seller programs that the seller has opted-in to.
      operationId: getOptedInPrograms
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Programs'
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '20404':
                domain: API_ACCOUNT
                category: REQUEST
                description: '{fieldName} not found.'
        '404':
          description: 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'
  /program/opt_in:
    post:
      tags:
        - program
      summary: 'This method opts the seller in to an eBay seller program. Refer to the Account API overview for information about available eBay seller programs. Note: It can take up to 24-hours for eBay to process your request to opt-in to a Seller Program. Use the getOptedInPrograms call to check the status of your request after the processing period has passed.'
      operationId: optInToProgram
      requestBody:
        description: Program being opted-in to.
        content:
          application/json:
            schema:
              description: Program being opted-in to.
              $ref: '#/components/schemas/Program'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '20401':
                domain: API_ACCOUNT
                category: REQUEST
                description: 'Missing field {fieldName}. {additionalInfo}'
        '404':
          description: 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'
  /program/opt_out:
    post:
      tags:
        - program
      summary: This method opts the seller out of a seller program to which you have previously opted-in to. Get a list of the seller programs you have opted-in to using the getOptedInPrograms call.
      operationId: optOutOfProgram
      requestBody:
        description: Program being opted-out of.
        content:
          application/json:
            schema:
              description: Program being opted-out of.
              $ref: '#/components/schemas/Program'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '20401':
                domain: API_ACCOUNT
                category: REQUEST
                description: 'Missing field {fieldName}. {additionalInfo}'
        '404':
          description: 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'
  /rate_table:
    get:
      tags:
        - rate_table
      summary: 'This method retrieves a seller''s shipping rate tables for the country specified in the country_code query parameter. If you call this method without specifying a country code, the call returns all the seller''s shipping rate tables. The method''s response includes a rateTableId for each table defined by the seller. Use a table''s ID value in a fulfillment policy to specify the shipping rate table to use for that policy''s DOMESTIC or INTERNATIONAL shipping option (make sure the locality of the rate table matches the optionType of the shipping option). This call currently supports getting rate tables related to the following marketplaces: EBAY_AU EBAY_CA EBAY_DE EBAY_ES EBAY_FR EBAY_GB EBAY_IT EBAY_US Note: Rate tables created with the Trading API might not have been assigned a rateTableId at the time of their creation. This method can assign and return rateTableId values for rate tables with missing IDs if you make a request using the country_code where the seller has defined rate tables. Sellers can define up to 40 shipping rate tables for their account, which lets them set up different rate tables for each of the marketplaces they sell into. Go to My eBay &gt; Account &gt; Site Preferences to create and maintain the rate tables. For more, see Using shipping rate tables. If you''re using the Trading API, use the rate table ID values in the RateTableDetails container of the Add/Revise/Relist calls. If the locality for a rate table is set to DOMESTIC, pass the ID value in the RateTableDetails.DomesticRateTableId field. Otherwise, if locality is INTERNATIONAL, pass the ID value in RateTableDetails.InternationalRateTableId.'
      operationId: getRateTables
      parameters:
        - name: country_code
          in: query
          description: 'This query parameter specifies the two-letter ISO 3166 code of country for which you want shipping-rate table information. If you do not specify a county code, the request returns all the seller-defined rate tables. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum'
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateTableResponse'
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '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.
      security:
        - api_auth:
            - 'https://api.ebay.com/oauth/api_scope/sell.account'
            - 'https://api.ebay.com/oauth/api_scope/sell.account.readonly'
  /return_policy:
    get:
      tags:
        - return_policy
      summary: 'This method retrieves all the return policies configured for the marketplace you specify using the marketplace_id query parameter. Marketplaces and locales 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.'
      operationId: getReturnPolicies
      parameters:
        - 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
      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
      summary: 'This method creates a new return policy where the policy encapsulates seller''s terms for returning items. Use the Metadata API method getReturnPolicies to determine which categories require you to supply a return policy for the marketplace(s) into which you list. Each policy targets a marketplaceId and categoryTypes.name combination and you can create multiple policies for each combination. A successful request returns the 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 eBay business policies. Marketplaces and locales Policy instructions can be localized by providing a locale in the Accept-Language HTTP request header. For example, the following setting displays field values from the request body in German: Accept-Language: de-DE. Target the specific locale of a marketplace that supports multiple locales using the Content-Language request header. For example, target the French locale of the Canadian marketplace by specifying the fr-CA locale for Content-Language. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. Tip: For details on headers, see HTTP request headers.'
      operationId: createReturnPolicy
      requestBody:
        description: Return policy request
        content:
          application/json:
            schema:
              description: Return policy request
              $ref: '#/components/schemas/ReturnPolicyRequest'
        required: true
      responses:
        '201':
          description: Created
          headers:
            Location:
              schema:
                type: string
                description: 'The <b>location</b> response header contains the URL to the newly created return policy. The URL includes the eBay-assigned <code>returnPolicyId</code>, 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
      summary: 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 of the return policy you want to retrieve.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnPolicy'
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '20403':
                domain: API_ACCOUNT
                category: REQUEST
                description: 'Invalid {fieldName}. {additionalInfo}'
              '20404':
                domain: API_ACCOUNT
                category: REQUEST
                description: '{fieldName} not found.'
        '404':
          description: 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'
    put:
      tags:
        - return_policy
      summary: This method updates an existing return policy. Specify the policy you want to update using the return_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: updateReturnPolicy
      parameters:
        - name: return_policy_id
          in: path
          description: This path parameter specifies the ID of the return policy you want to update.
          required: true
          schema:
            type: string
      requestBody:
        description: Container for a return policy request.
        content:
          application/json:
            schema:
              description: Container for a return policy request.
              $ref: '#/components/schemas/ReturnPolicyRequest'
        required: true
      responses:
        '200':
          description: OK
          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 {fieldName}.'
              '20402':
                domain: API_ACCOUNT
                category: REQUEST
                description: 'Invalid input. {additionalInfo}'
              '20404':
                domain: API_ACCOUNT
                category: REQUEST
                description: '{fieldName} not found.'
              '20406':
                domain: API_ACCOUNT
                category: REQUEST
                description: 'Invalid return option. {fieldName}'
        '404':
          description: 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'
    delete:
      tags:
        - return_policy
      summary: This method deletes a return policy. Supply the ID of the policy you want to delete in the returnPolicyId path parameter. Note that you cannot delete the default return policy.
      operationId: deleteReturnPolicy
      parameters:
        - name: return_policy_id
          in: path
          description: This path parameter specifies the ID of the return policy you want to delete.
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '20401':
                domain: API_ACCOUNT
                category: REQUEST
                description: 'Missing field {fieldName}. {additionalInfo}'
              '20402':
                domain: API_ACCOUNT
                category: REQUEST
                description: 'Invalid input. {additionalInfo}'
              '20404':
                domain: API_ACCOUNT
                category: REQUEST
                description: '{fieldName} not found.'
        '404':
          description: Not Found
        '409':
          description: Conflict
          x-response-codes:
            errors:
              '20409':
                domain: API_ACCOUNT
                category: BUSINESS
                description: 'Invalid default policy type. {additionalInfo}'
              '21409':
                domain: API_ACCOUNT
                category: BUSINESS
                description: 'Invalid default for category type. {additionalInfo}'
              '22409':
                domain: API_ACCOUNT
                category: BUSINESS
                description: 'Invalid target default policy. {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'
  /return_policy/get_by_policy_name:
    get:
      tags:
        - return_policy
      summary: 'This method retrieves the complete details of a single return policy. Supply both the policy name and its associated marketplace_id in the request query parameters. Marketplaces and locales 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.'
      operationId: getReturnPolicyByName
      parameters:
        - 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 user-defined name of the return policy you want to retrieve.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnPolicy'
        '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'
  '/sales_tax/{countryCode}/{jurisdictionId}':
    get:
      tags:
        - sales_tax
      summary: This call gets the current tax table entry for a specific tax jurisdiction. Specify the jurisdiction to retrieve using the countryCode and jurisdictionId path parameters.
      operationId: getSalesTax
      parameters:
        - name: countryCode
          in: path
          description: This path parameter specifies the two-letter ISO 3166 code for the country whose tax table you want to retrieve.
          required: true
          schema:
            type: string
        - name: jurisdictionId
          in: path
          description: This path parameter specifies the ID of the sales tax jurisdiction for the tax table entry you want to retrieve.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SalesTax'
        '204':
          description: No content
        '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}'
              '20407':
                domain: API_ACCOUNT
                category: REQUEST
                description: 'Tax table not supported for {fieldName}.'
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '20500':
                domain: API_ACCOUNT
                category: APPLICATION
                description: System error.
      security:
        - api_auth:
            - 'https://api.ebay.com/oauth/api_scope/sell.account'
            - 'https://api.ebay.com/oauth/api_scope/sell.account.readonly'
    put:
      tags:
        - sales_tax
      summary: 'This method creates or updates a sales tax table entry for a jurisdiction. Specify the tax table entry you want to configure using the two path parameters: countryCode and jurisdictionId. A tax table entry for a jurisdiction is comprised of two fields: one for the jurisdiction''s sales-tax rate and another that''s a boolean value indicating whether or not shipping and handling are taxed in the jurisdiction. You can set up tax tables for countries that support different tax jurisdictions. Currently, only Canada, India, and the US support separate tax jurisdictions. If you sell into any of these countries, you can set up tax tables for any of the country''s jurisdictions. Retrieve valid jurisdiction IDs using getSalesTaxJurisdictions in the Metadata API. For details on using this call, see Establishing sales-tax tables. Important! Starting in January 2019, eBay will begin to calculate, collect, and remit sales tax on behalf of sellers for items shipped to customers. This feature is rolling out on specific dates to specific US states as defined on the following page: eBay sales tax collection. Once eBay starts to collect sales tax for a state, no action is required on the seller''s part and there will be no charges or fees for eBay automatically calculating, collecting and remitting sales tax. The sales-tax collection process will apply to all the sales in the states that support this feature, whether the seller is located in or outside of the United States. When a buyer purchases an item on eBay, and the ship-to address is one of the states where eBay collects the sales tax, eBay will calculate and add the applicable sales tax at checkout. The buyer will pay both the cost of the item along with the sales tax. eBay will collect and remit the tax.'
      operationId: createOrReplaceSalesTax
      parameters:
        - name: countryCode
          in: path
          description: This path parameter specifies the two-letter ISO 3166 code for the country for which you want to create tax table entry.
          required: true
          schema:
            type: string
        - name: jurisdictionId
          in: path
          description: This path parameter specifies the ID of the sales-tax jurisdiction for the table entry you want to create.
          required: true
          schema:
            type: string
      requestBody:
        description: A container that describes the how the sales tax is calculated.
        content:
          application/json:
            schema:
              description: A container that describes the how the sales tax is calculated.
              $ref: '#/components/schemas/SalesTaxBase'
        required: true
      responses:
        '204':
          description: No Content
        '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.'
              '20407':
                domain: API_ACCOUNT
                category: REQUEST
                description: 'Tax table not supported for {fieldName}.'
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '20500':
                domain: API_ACCOUNT
                category: APPLICATION
                description: System error.
      security:
        - api_auth:
            - 'https://api.ebay.com/oauth/api_scope/sell.account'
    delete:
      tags:
        - sales_tax
      summary: This call deletes a tax table entry for a jurisdiction. Specify the jurisdiction to delete using the countryCode and jurisdictionId path parameters.
      operationId: deleteSalesTax
      parameters:
        - name: countryCode
          in: path
          description: This path parameter specifies the two-letter ISO 3166 code for the country whose tax table entry you want to delete.
          required: true
          schema:
            type: string
        - name: jurisdictionId
          in: path
          description: This path parameter specifies the ID of the sales tax jurisdiction whose table entry you want to delete.
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Success
        '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}'
              '20407':
                domain: API_ACCOUNT
                category: REQUEST
                description: 'Tax table not supported for {fieldName}.'
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '20500':
                domain: API_ACCOUNT
                category: APPLICATION
                description: System error.
      security:
        - api_auth:
            - 'https://api.ebay.com/oauth/api_scope/sell.account'
  /sales_tax:
    get:
      tags:
        - sales_tax
      summary: Use this call to retrieve a sales tax table that the seller established for a specific country. Specify the tax table to retrieve using the country_code query parameter.
      operationId: getSalesTaxes
      parameters:
        - name: country_code
          in: query
          description: 'This path parameter specifies the two-letter ISO 3166 code for the country whose tax table you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum'
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SalesTaxes'
        '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}'
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '20500':
                domain: API_ACCOUNT
                category: APPLICATION
                description: System error.
      security:
        - api_auth:
            - 'https://api.ebay.com/oauth/api_scope/sell.account'
            - 'https://api.ebay.com/oauth/api_scope/sell.account.readonly'
  /kyc:
    get:
      tags:
        - kyc
      summary: 'This method is used by sellers onboarded for eBay managed payments, or sellers who are currently going through, or who are eligible for onboarding for eBay managed payments. With this method, a seller can discover if there are any action items in regards to providing more documentation and/or information about themselves, their company, or the bank account they are or will be using for seller payouts. These ''action items'' are also know as ''Know Your Customer'' (or KYC) checks. This method does not require any parameters other than the OAuth user token associated with the seller''s account. If the managed payments seller does not currently have any pending ''KYC'' action items, only a 204 No Content HTTP status code is returned, and no response payload. Note: This method is not applicable for sellers who are not eligible for eBay managed payments. For sellers who sell on one or more eBay marketplaces that currently support managed payments, they can check on their managed payments onboarding status by using the getPaymentsProgramOnboarding method.'
      operationId: getKYC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycResponse'
        '204':
          description: No Content
        '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.
      security:
        - api_auth:
            - 'https://api.ebay.com/oauth/api_scope/sell.account'
            - 'https://api.ebay.com/oauth/api_scope/sell.account.readonly'
components:
  schemas:
    Amount:
      type: object
      properties:
        currency:
          type: string
          description: 'The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD. Default: The default currency of the eBay marketplace that hosts the listing. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/ba:CurrencyCodeEnum''>eBay API documentation</a>'
        value:
          type: string
          description: The monetary amount in the specified currency. Required in the amount type.
      description: A complex type that describes the value of a monetary amount as represented by a global currency.
    CategoryType:
      type: object
      properties:
        default:
          type: boolean
          description: 'Specifies the default policy for a marketplaceId and categoryTypes.name pair. Sellers can create multiple policies for any marketplaceId and categoryTypes.name combination. For example, you can create multiple fulfillment policies for one marketplace, where they all target the same category type name. However, only one policy can be the default for any marketplaceId and name combination, and eBay designates the first policy created for a combination as the default. If set to true, this policy is the default policy for the associated categoryTypes.name and marketplaceId pair. Note: eBay considers the status of this field only when you create listings through the Web flow. If you create listings using the APIs, you must specifically set the policies you want applied to a listing in the payload of the call you use to create the listing. If you use the Web flow to create item listings, eBay uses the default policy for the marketplace and category type specified, unless you override the default. For more on default policies, see Changing the default policy for a category type.'
        name:
          type: string
          description: 'The category type to which the policy applies (motor vehicles or non-motor vehicles). Restrictions: The MOTORS_VEHICLES category type is not valid for return policies. eBay flows do not support the return of motor vehicles. Only the ALL_EXCLUDING_MOTORS_VEHICLES category type is supported for sellers who opt-in to the managed payments program. Managed payments does not currently support the sale of motor vehicles. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:CategoryTypeEnum''>eBay API documentation</a>'
      description: 'The category type discerns whether the policy covers the sale of motor vehicles (via eBay Motors), or the sale of everything except motor vehicles. Each business policy can be associated with either or both categories (''MOTORS_VEHICLES'' and ''ALL_EXCLUDING_MOTORS_VEHICLES''); however,the ''MOTORS_VEHICLES'' category type is not valid for return policies&ndash;return policies cannot be used with motor vehicle listings.'
    Deposit:
      type: object
      properties:
        amount:
          description: 'Deposits are used only with Motors listings and the amount value indicates the initial deposit that a buyer must make to purchase a motor vehicle. The deposit amount can be as high as $2,000.00 and if an amount is not specified, this value defaults to ''0.0''. If the seller specifies a deposit amount, they must also specify an hoursToDeposit value. Deposits on motor vehicles can only be paid using PayPal, so if you specify a deposit amount, then you must also set the paymentMethodType value to ''PayPal''. Unlike other listings, PayPal is not automatically added to a Motors listing even if the seller has a PayPal preference set in My eBay. Because of these requirements, the seller must have a linked PayPal account in order to require a deposit. The deposit amount appears in the shipping, payment details and return policy section of the View Item page. Min: 0.0, Max: 2000.0, Default: 0.0'
          $ref: '#/components/schemas/Amount'
        dueIn:
          description: 'This value indicates the number of hours the buyer has (after they commit to buy) to make an initial deposit to the seller as a down payment on a motor vehicle. Valid values are ''24 HOUR'', ''48 HOUR'' (default), and ''72 HOUR''. The deposit amount is specified in the deposit.amount field. If not specified, the deposit amount value defaults to ''0.0'', in which case, a deposit on the vehicle is not required. In order for a buyer to make an initial deposit on a US or CA motor vehicle, you must set a paymentMethodType value to ''PayPal'' (in addition to the payment methods offered for the full payment).Min=24 (hours), Max=72 (hours), Default=48 (hours)'
          $ref: '#/components/schemas/TimeDuration'
        paymentMethods:
          type: array
          description: 'For deposits (which are applicable to only motor listings), the paymentMethodType must be set to ''PAYPAL'' and you must also populate the fields in the recipientAccountReference object. Required if your motor vehicles listing requires a deposit.'
          items:
            $ref: '#/components/schemas/PaymentMethod'
      description: A container that describes the details of a deposit. Used only with motor listings.
    Error:
      type: object
      properties:
        category:
          type: string
          description: 'The category type for this error or warning. It is a string that can have one of three values: 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 &quot;Seller does not ship item to Antarctica&quot; or &quot;Buyer ineligible to purchase an alcoholic item&quot;. 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.'
        domain:
          type: string
          description: 'Name of the domain ,or primary system, of the service or application where the error occurred.'
        errorId:
          type: integer
          description: A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
          format: int32
        inputRefIds:
          type: array
          description: 'Identifies specific request elements associated with the error, if any. inputRefId''s response is format specific. For JSON, use JSONPath notation.'
          items:
            type: string
        longMessage:
          type: string
          description: A more detailed explanation of the error than given in the 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: 'The CategoryTypeEnum value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don''t. (Currently, each policy can be set to only one categoryTypes value at a time.)'
          items:
            $ref: '#/components/schemas/CategoryType'
        description:
          type: string
          description: 'An optional seller-defined description of the fulfillment policy for internal use (this value is not displayed to end users). Max length: 250'
        freightShipping:
          type: boolean
          description: 'If set to true, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs. Default: false'
        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: 'If set to true, the seller has opted-in to the eBay Global Shipping Program and that they use that service for their international shipments. Setting this value automatically sets the international shipping service for the policy to International Priority Shipping and the buyer does not need to set any other shipping services for their INTERNATIONAL shipping options (unless they sell items not covered by the Global Shipping Program). If this value is set to false, the seller is responsible for manually specifying the international shipping services, as described in Setting up worldwide shipping. To opt-in to the Global Shipping Program, log in to eBay and navigate to My Account &gt; Site Preferences &gt; Shipping preferences. Default: false'
        handlingTime:
          description: 'Specifies 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. Valid values can vary by site and by category. To obtain the supported values for a site, call GeteBayDetails in the Trading API with DetailName set to 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 required when the seller uses a flat or calculated shipping service, and it does not apply when there is no shipping service specified (for example, if the policy specifies only localPickup or freightShipping). In these cases, this field is not used and you can set it to 0. Note that Top-Rated sellers must offer same-day or one-day handling for a listing in order for that listing to receive a Top Rated Plus seal on the View Item or Search Results pages. To offer zero-day or one-day handling, set field to ''0'' or ''1'', respectively.Min: 0 Max: 30'
          $ref: '#/components/schemas/TimeDuration'
        localPickup:
          type: boolean
          description: 'If set to true, no shipping is offered by this policy and the seller offers only local pickup of the item (normally from a non-business location). This option is most often used for customer-to-customer sales and if set, costType should be set to NOT_SPECIFIED. Default: false'
        marketplaceId:
          type: string
          description: 'The ID of the eBay marketplace to which this fulfillment policy applies. If this value is not specified, value defaults to the seller''s eBay registration site. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum''>eBay API documentation</a>'
        name:
          type: string
          description: 'A user-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. Max length: 64'
        pickupDropOff:
          type: boolean
          description: 'If set to true, the seller offers the &quot;Click and Collect&quot; feature. Click and Collect is supported by the Inventory API, and it can be used with Add/Revise/Relist calls. To enable &quot;Click and Collect&quot;, a seller (1) must be eligible for Click and Collect and (2) must set this boolean field to ''true''. Currently, Click and Collect is available to only large retail merchants selling in the eBay AU and UK marketplaces. In addition to setting this field, the merchant must also do the following to enable the &quot;Click and Collect&quot; option on a listing: Have inventory for the product at one or more physical stores tied to the merchant''s account. Sellers can use the createInventoryLocaion method in the Inventory API to associate physical stores to their account and they can then can add inventory to specific store locations. Set an immediate payment requirement on the item. The immediate payment feature requires the seller to: Set the immediatePay flag in the payment policy to ''true''. Include only one paymentMethods field in the payment policy and set its value to PAYPAL. Include a valid PayPal contact in the recipientAccountReference.referenceId field of the payment policy. Have a valid store location with a complete street address. When a UK 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 &quot;Available for Click and Collect&quot; option on the listing, along with information on the closest store that has the item.Default: false'
        shippingOptions:
          type: array
          description: 'A list that defines the seller''s shipping configurations for DOMESTIC and INTERNATIONAL order shipments. shippingOptions is a list with a single element if the seller ships to only domestic locations. If the seller also ships internationally, the list contains a second element that defines their international shipping options. Shipping options configure the high-level shipping settings that apply to orders, such as flat-rate or calculated shipping, any rate tables the seller wants to associate with the shipping services, plus other details (such as the shippingServices offered for domestic or international shipments).'
          items:
            $ref: '#/components/schemas/ShippingOption'
        shipToLocations:
          description: 'This object contains the regionIncluded and regionExcluded fields, which defines the areas where the seller does and doesn''t ship to with this fulfillment policy. shipToLocations appears at both the top-level of the fulfillment policy as well as within the individual shippingOptions.shippingService containers. Here at the top level, this field returns the list of regionExclude areas that have been defined at this level, plus a complete list of regionIncluded fields that have been defined in all the policy''s shippingOptions.shippingServices.shipToLocations containers. For details on configuring this field, see The shipToLocations container.'
          $ref: '#/components/schemas/RegionSet'
      description: 'This root response container defines a seller''s fulfillment policy for a specific marketplace and category type. fulfillmentPolicy encapsulates a seller''s terms for fulfilling an order and includes the shipping carriers and services used for shipment and time the seller takes to ship an order. While each seller must define at least one fulfillment policy for every marketplace into which they sell, sellers can define multiple fulfillment policies for a single marketplace by specifying different configurations for the unique policies.'
    FulfillmentPolicyRequest:
      type: object
      properties:
        categoryTypes:
          type: array
          description: 'The CategoryTypeEnum value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don''t. (Currently, each policy can be set to only one categoryTypes value at a time.)'
          items:
            $ref: '#/components/schemas/CategoryType'
        description:
          type: string
          description: 'An optional seller-defined description of the fulfillment policy for internal use (this value is not displayed to end users). Max length: 250'
        freightShipping:
          type: boolean
          description: 'If set to true, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs. Default: false'
        globalShipping:
          type: boolean
          description: 'If set to true, the seller has opted-in to the eBay Global Shipping Program and that they use that service for their international shipments. Setting this value automatically sets the international shipping service for the policy to International Priority Shipping and the buyer does not need to set any other shipping services for their INTERNATIONAL shipping options (unless they sell items not covered by the Global Shipping Program). If this value is set to false, the seller is responsible for manually specifying the international shipping services, as described in Setting up worldwide shipping. To opt-in to the Global Shipping Program, log in to eBay and navigate to My Account &gt; Site Preferences &gt; Shipping preferences. Default: false'
        handlingTime:
          description: 'Specifies 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. Valid values can vary by site and by category. To obtain the supported values for a site, call GeteBayDetails in the Trading API with DetailName set to 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 required when the seller uses a flat or calculated shipping service, and it does not apply when there is no shipping service specified (for example, if the policy specifies only localPickup or freightShipping). In these cases, this field is not used and you can set it to 0. Note that Top-Rated sellers must offer same-day or one-day handling for a listing in order for that listing to receive a Top Rated Plus seal on the View Item or Search Results pages. To offer zero-day or one-day handling, set field to ''0'' or ''1'', respectively.Min: 0 Max: 30'
          $ref: '#/components/schemas/TimeDuration'
        localPickup:
          type: boolean
          description: 'If set to true, no shipping is offered by this policy and the seller offers only local pickup of the item (normally from a non-business location). This option is most often used for customer-to-customer sales and if set, costType should be set to NOT_SPECIFIED. Default: false'
        marketplaceId:
          type: string
          description: 'The ID of the eBay marketplace to which this fulfillment policy applies. If this value is not specified, value defaults to the seller''s eBay registration site. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum''>eBay API documentation</a>'
        name:
          type: string
          description: 'A user-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. Max length: 64'
        pickupDropOff:
          type: boolean
          description: 'If set to true, the seller offers the &quot;Click and Collect&quot; feature. Click and Collect is supported by the Inventory API, and it can be used with Add/Revise/Relist calls. To enable &quot;Click and Collect&quot;, a seller (1) must be eligible for Click and Collect and (2) must set this boolean field to ''true''. Currently, Click and Collect is available to only large retail merchants selling in the eBay AU and UK marketplaces. In addition to setting this field, the merchant must also do the following to enable the &quot;Click and Collect&quot; option on a listing: Have inventory for the product at one or more physical stores tied to the merchant''s account. Sellers can use the createInventoryLocaion method in the Inventory API to associate physical stores to their account and they can then can add inventory to specific store locations. Set an immediate payment requirement on the item. The immediate payment feature requires the seller to: Set the immediatePay flag in the payment policy to ''true''. Include only one paymentMethods field in the payment policy and set its value to PAYPAL. Include a valid PayPal contact in the recipientAccountReference.referenceId field of the payment policy. Have a valid store location with a complete street address. When a UK 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 &quot;Available for Click and Collect&quot; option on the listing, along with information on the closest store that has the item.Default: false'
        shippingOptions:
          type: array
          description: 'A list that defines the seller''s shipping configurations for DOMESTIC and INTERNATIONAL order shipments. shippingOptions is a list with a single element if the seller ships to only domestic locations. If the seller also ships internationally, the list contains a second element that defines their international shipping options. Shipping options configure the high-level shipping settings that apply to orders, such as flat-rate or calculated shipping, any rate tables the seller wants to associate with the shipping services, plus other details (such as the shippingServices offered for domestic or international shipments).'
          items:
            $ref: '#/components/schemas/ShippingOption'
        shipToLocations:
          description: 'This object contains the regionIncluded and regionExcluded fields, which define the geographical regions that a seller does and does not cover by the associated fulfillment policy. shipToLocations appears at both the top-level of the fulfillment policy as well as within the shippingOptions.shippingServices container. Here at the top level, use the regionExcluded field to specify a list of regions that a seller does not ship to with this particular fulfillment policy. Note that you don''t populate the regionIncluded field at this level. Instead, specify the regions that are covered by this fulfillment policy in each of the shippingServices.shipToLocations.regionIncluded containers you configure. Every eBay marketplace supports its own set of regions that you can use in the regionExcluded field. To determine the valid values for a marketplace, call GeteBayDetails with DetailName set to ShippingLocationDetails, then review the ShippingLocation fields in the response for the strings you use in regionExcluded.regionName fields. Configuring shipToLocations can be tricky because the regionIncluded and regionExcluded fields are valid in different parts of the schema, and their allowable settings vary upon the context. For details on configuring these fields, see The shipToLocations container.'
          $ref: '#/components/schemas/RegionSet'
      description: 'This root container defines a seller''s fulfillment policy for a specific marketplace and category type. Used when creating or updating a fulfillment policy, fulfillmentPolicyRequest encapsulates a seller''s terms for fulfilling an order and includes the shipping carriers and services used for shipment and time the seller takes to ship an order. While each seller must define at least one fulfillment policy for every marketplace into which they sell, sellers can define multiple fulfillment policies for a single marketplace by specifying different configurations for the unique policies. A successful call returns a fulfillmentPolicyId, plus the Location response header contains the URI to the resource. Policy instructions can be localized by providing a locale in the Content-Language HTTP request header. For example: Content-Language: de-DE. Tip: For more on using business policies, see eBay business policies.'
    FulfillmentPolicyResponse:
      type: object
      properties:
        fulfillmentPolicies:
          type: array
          description: A list of the seller's fulfillment policies.
          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 items retrieved in the result set. If no items are found, this field is returned with a value of 0.'
          format: int32
      description: The response payload for requests that return a list of fulfillment policies.
    InternationalReturnOverrideType:
      type: object
      properties:
        returnMethod:
          type: string
          description: 'Valid in the US marketplace only, this optional field indicates additional services (other than money-back) that sellers can offer buyers for remorse returns. As of version 1.2.0, the only accepted value for this field is REPLACEMENT. This field is valid in only the US marketplace, any supplied value is ignored in other marketplaces. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum''>eBay API documentation</a>'
        returnPeriod:
          description: 'Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked &quot;delivered&quot; at the buyer''s specified ship-to location. You must set the value to one that''s accepted by the marketplace and category where the item is listed. Most categories support 30-day and 60-day return periods. For a definitive list of category return periods, call GeteBayDetails in the Trading API with DetailName set to ReturnPolicyDetails. In the response review the ReturnPolicyDetails.ReturnsWithin field to see the values supported in the different marketplace categories. Note: In version 1.2.0, the options for this field were reduced. See the Release Notes for details. Set this field using the TimeDuration complex type, where you set unit to DAY and value to either 30 or 60 (or other value, as appropriate). Note that this value cannot be modified if the listing has bids or sales, or if the listing ends within 12 hours. Required if the internationalOverride.returnsAccepted field is set to true.'
          $ref: '#/components/schemas/TimeDuration'
        returnsAccepted:
          type: boolean
          description: 'If set to true, the seller allows international returns. If set to false, the seller does not accept international returns. Required if the seller wants to set an international return policy that differs from their domestic return policy.'
        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. Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues. Required if the internationalOverride.returnsAccepted field is set to true. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum''>eBay API documentation</a>'
      description: 'This type defines the fields for a seller''s international return policy. If a seller does not populate the fields in this complex type, the international return policy defaults to the return policy set for domestic returns.'
    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 <a href=''https://developer.ebay.com/api-docs/sell/account/types/kyc:DetailsType''>eBay API documentation</a>'
        dueDate:
          type: string
          description: 'The timestamp in this field indicates the date by which the seller should resolve the KYC requirement. The timestamp in this field uses the UTC date and time format described in the ISO 8601 Standard. See below for this format and an example: MM-DD-YYYY HH:MM:SS 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. If no KYC checks are currently required from the seller, this array is not returned, and the seller only receives a 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: 'It''s important to note that the credit card brands Visa and MasterCard must both be listed if either one is listed, as is shown in the following code fragment: &quot;paymentMethods&quot;: [{ &quot;brands&quot;: [VISA, MASTERCARD] }] ... Note: Different eBay marketplaces may or may not support this field. Use the Trading API GetCategoryFeatures call with FeatureID set to PaymentMethods and DetailLevel set to ReturnAll to see what credit card brands different marketplaces support. If the GetCategoryFeatures call returns details on credit card brands for the categories in which you sell, then you can use this field to list the credit card brands the seller accepts. If, on the other hand, GetCategoryFeatures does not enumerate credit card brands for your target site (for example, if it returns PaymentMethod set to CCAccepted), then you cannot enumerate specific credit card brands with this field for that marketplace. Required if paymentMethodType is set to CREDIT_CARD. A list of credit card brands accepted by the seller.'
          items:
            type: string
            description: ' For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:PaymentInstrumentBrandEnum''>eBay API documentation</a>'
        paymentMethodType:
          type: string
          description: 'The payment method, selected from the supported payment method types. Use GetCategoryFeatures in the Trading API to retrieve the payment methods allowed for a category on a specific marketplace, as well as the default payment method for that marketplace (review the SiteDefaults.PaymentMethod field). For example, the response from GetCategoryFeatures shows that on the US marketplace, most categories allow only electronic payments via credit cards, PayPal, and the like. Also, note that GeteBayDetails does not return payment method information. Note: If you create item listings using the Inventory API, you must set this field to PAYPAL (currently, the Inventory API supports only fixed-prince GTC items where the only supported paymentMethod is PayPal). For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:PaymentMethodTypeEnum''>eBay API documentation</a>'
        recipientAccountReference:
          description: 'This field contains information that eBay uses to identify the recipient''s account to which electronic funds are sent and must contain the email address associated with the PayPal account selected by the seller. eBay uses this information to identify the correct PayPal account when the buyer pays for an order using PayPal. (Because it''s possible to have more than a single PayPal account, eBay cannot rely on account data returned by GetUser for determining the correct PayPal eddress.) Required if the payment method is set to PAYPAL.'
          $ref: '#/components/schemas/RecipientAccountReference'
      description: 'Container specifying a payment method that is accepted by the seller. Specify multiple payment methods by repeating this container. For more on payment methods, see Accepted payments policy. Note that payment methods are not applicable to classified ad listings &ndash; all classified ad payments are handled off of the eBay platform.'
    PaymentPolicy:
      type: object
      properties:
        categoryTypes:
          type: array
          description: 'The CategoryTypeEnum value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don''t. (Currently, each policy can be set to only one categoryTypes value at a time.)'
          items:
            $ref: '#/components/schemas/CategoryType'
        deposit:
          description: 'This container is applicable only if the categoryTypes.name field is set to MOTORS_VEHICLES. In this case, sellers can use this field to specify amounts and due dates for deposits on motor vehicle listings on eBay Motors. The deposit amount appears in the shipping, payment details, and return policy sections of the View Item page. Note: Deposits on motor vehicles can only be paid using PayPal, so if you specify a deposit amount, then you must set the paymentMethodType value to ''PayPal'' (and you must not set the deposit.paymentMethods.brands field). Because of this, the seller needs to have a linked PayPal account in order to require a deposit from the buyer. Also note that paymentMethodType is not automatically set to PayPal for deposits, even if the seller has PayPal set in their My eBay preferences. In addition to setting the paymentMethods for deposits, be sure to also set paymentMethods for the final payment amount.'
          $ref: '#/components/schemas/Deposit'
        description:
          type: string
          description: 'An optional seller-defined description of the payment policy for internal use (this value is not displayed to end users). Max length: 250'
        fullPaymentDueIn:
          description: 'This field applies to motor vehicles listings only and indicates when a final payment for the vehicle is due. This value is always returned if categoryTypes is set to MOTORS_VEHICLES. This seller-specified value indicates the number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. The period starts when the buyer commits to buy. The valid values, as specified with TimeDuration, are: 3 DAYS 7 DAYS (the default) 10 DAYS 14 DAYSFor motor vehicles sales (where categoryTypes.name is set to MOTORS_VEHICLES), the payment policy must specify at least one of the following paymentMethods values for the final payment: CASH_ON_PICKUP CASHIER_CHECK LOAN_CHECK MONEY_ORDER PAYPAL PERSONAL_CHECK Default: 7 DAYS (Note that this value is supported by a compound type.)'
          $ref: '#/components/schemas/TimeDuration'
        immediatePay:
          type: boolean
          description: 'If set to true, payment is due upon receipt (eBay generates a receipt when the buyer agrees to purchase an item). This boolean must be set in the payment policy if the seller wants to create a listing that has an &quot;immediate payment&quot; requirement. The seller can change the immediate payment requirement at any time during the life cycle of a listing. The following must be true before a seller can apply an immediate payment requirement to an item: The seller must have a PayPal Business account. The Buy It Now price cannot be higher than $60,000 USD. The eBay marketplace on which the item is listed must support PayPal payments. The listing type must be fixed-price, or an auction with a Buy It Now option.To enable the immediate payment requirement, the seller must also perform the following actions via API calls: Provide a valid paymentMethods.recipientAccountReference.referenceId value. Offer PayPal as the only payment method for the item(s). Specify all related costs to the buyer (because the buyer is not be able to use the Buyer Request Total feature in an immediate payment listing); these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges. Include and set the shippingProfileDiscountInfo container values if you are going to use promotional shipping discounts.For more information, see the Understanding immediate payment Help page. Note: Listings created with the Inventory API must reference a payment policy that has immediatePay is set to true. Items listed with the Inventory API must also be fixed-price good-till-canceled (GTC) listings where PayPal is the only supported payment method (paymentMethod must be set to PAYPAL). Default: false'
        marketplaceId:
          type: string
          description: 'The ID of the eBay marketplace to which the payment policy applies. If this value is not specified, value defaults to the seller''s eBay registration site. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum''>eBay API documentation</a>'
        name:
          type: string
          description: 'A user-defined name for this payment policy. Names must be unique for policies assigned to the same marketplace. Max length: 64'
        paymentInstructions:
          type: string
          description: 'This free-form string field gives sellers the ability add detailed payment instructions to their listings. The payment instructions appear on eBay''s View Item and Checkout pages. eBay recommends sellers use this field to clarify payment policies for motor vehicle listings on eBay Motors. For example, sellers can include the specifics on the deposit (if required), pickup/delivery arrangements, and full payment details on the vehicle. The field allows only 500 characters as input, but due to the way the eBay web site UI treats characters, this field can return more than 500 characters in the response. For example, characters like &amp; and '' (ampersand and single quote) count as 5 characters each. Max length: 1000.'
        paymentMethods:
          type: array
          description: 'If the seller is not opted-in to managed payments, this container returns a list of the payment methods accepted by the seller. When not opted-in to managed payments, each payment policy must specify at least one payment method. Note: The paymentMethods container is not returned if the seller is opted-in to the managed payments program.'
          items:
            $ref: '#/components/schemas/PaymentMethod'
        paymentPolicyId:
          type: string
          description: A unique eBay-assigned ID for a payment policy. This ID is generated when the policy is created.
      description: 'Root container that defines the fields for a seller''s payment policy. The paymentPolicy encapsulates a seller''s payment terms and consists of payment details for the seller, the name and description of the policy, and the marketplace and category group(s) covered by the payment policy. While each seller must define at least one payment policy for every marketplace into which they sell, sellers can define multiple payment policies for a single marketplace by specifying different configurations for the unique policies.'
    PaymentPolicyRequest:
      type: object
      properties:
        categoryTypes:
          type: array
          description: 'The CategoryTypeEnum value to which this policy applies. This container is used to discern accounts that sell motor vehicles from those that do not. Restriction: Currently, each policy can be set to only one categoryTypes value at a time.'
          items:
            $ref: '#/components/schemas/CategoryType'
        deposit:
          description: 'The specified amounts and due dates for motor vehicle deposits on eBay Motors listings. The deposit amount appears in the shipping, payment details, and return policy sections of the View Item page. Deposits on motor vehicles can only be paid using PayPal. If you specify a deposit amount, then you must set the paymentMethodType value to PayPal, and you must not set the deposit.paymentMethods.brands field. The seller must have a linked PayPal account in order to require a deposit from the buyer. Note: The paymentMethodType is not automatically set to PayPal for deposits, even if the seller has PayPal set in their My eBay preferences.In addition to setting the paymentMethods for deposits, you must also set the paymentMethods for the final payment amount. Restrictions: This container is applicable only if the categoryTypes.name field is set to MOTORS_VEHICLES. This container is not supported for sellers who opt-in to the managed payments program. Managed payments does not currently support the sale of motor vehicles.'
          $ref: '#/components/schemas/Deposit'
        description:
          type: string
          description: 'An optional seller-defined description of the payment policy for internal use (this value is not displayed to end users). Max length: 250'
        fullPaymentDueIn:
          description: 'The number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. This container applies to motor vehicles listings only and indicates when a final payment for the vehicle is due. Note: This value is always returned if categoryTypes is set to MOTORS_VEHICLES.The period starts when the buyer commits to buy. The valid values, as specified with TimeDuration, are: 3 DAYS 7 DAYS (the default) 10 DAYS 14 DAYSIn order for a buyer to make a full payment on a US or CA motor vehicle, at least one of the following paymentMethods values must be specified for the corresponding payment policy: CASH_ON_PICKUP CASHIER_CHECK LOAN_CHECK MONEY_ORDER PAYPAL PERSONAL_CHECKRestriction: This container is not supported for sellers who opt-in to the managed payments program. Managed payments does not currently support the sale of motor vehicles. Default: 7 DAYS (this value is supported by a compound type)'
          $ref: '#/components/schemas/TimeDuration'
        immediatePay:
          type: boolean
          description: 'If set to true, payment is due upon receipt (eBay generates a receipt when the buyer agrees to purchase an item). This boolean must be set in the payment policy if the seller wants to create a listing that has an immediate payment requirement. The seller can change the immediate payment requirement at any time during the life cycle of a listing. The following must be true before a seller can apply an immediate payment requirement to an item: The seller must have a PayPal Business account. The Buy It Now price cannot be higher than $60,000 USD. The eBay marketplace on which the item is listed must support PayPal payments. The listing type must be fixed-price, or an auction with a Buy It Now option. Note: This container can be used for sellers who opt-in to the managed payments program, but some requirements do not apply.To enable the immediate payment requirement, the seller must also perform the following actions via API calls: Provide a valid paymentMethods.recipientAccountReference.referenceId value. Offer PayPal as the only payment method for the item(s). Specify all related costs to the buyer (because the buyer is not able to use the Buyer Request Total feature in an immediate payment listing); these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges. Include and set the shippingProfileDiscountInfo container values if you are going to use promotional shipping discounts.For more information, see the Understanding immediate payment Help page. Note: Listings created with the Inventory API must reference a payment policy that has immediatePay set to true. Items listed with the Inventory API must also be fixed-price, good-till-canceled (GTC) listings where PayPal is the only supported payment method (paymentMethod must be set to PAYPAL).Default: False'
        marketplaceId:
          type: string
          description: 'The ID of the eBay marketplace to which this payment policy applies. If this value is not specified, the value defaults to the seller''s eBay registration site. Note: A limited number of sellers, on a limited number of eBay marketplaces, are currently opted-in to the eBay managed payments program. To view the eBay marketplaces where managed payments are currently supported, see the managed payments landing page. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum''>eBay API documentation</a>'
        name:
          type: string
          description: 'A user-defined name for this payment policy. Names must be unique for policies assigned to the same marketplace. Note: eBay will create a new payment policy for sellers who opt-in to the managed payments program.Max length: 64'
        paymentInstructions:
          type: string
          description: 'A free-form string field that allows sellers to add detailed payment instructions to their listings. The payment instructions appear on eBay''s View Item and Checkout pages. eBay recommends sellers use this field to clarify payment policies for motor vehicle listings on eBay Motors. For example, sellers can include the specifics on the deposit (if required), pickup/delivery arrangements, and full payment details on the vehicle. The field allows only 500 characters as input, but due to the way the eBay web site UI treats characters, this field can return more than 500 characters in the response. For example, characters like &amp; and '' (ampersand and single quote) count as 5 characters each. Restriction: This container is not supported for sellers who opt-in to the managed payments program. Max length: 1000'
        paymentMethods:
          type: array
          description: 'A list of the payment methods accepted by the seller. Important: Do not populate this container if you are opted-in to managed payments. To verify whether or not you are opted-in to the managed payments program, call getPaymentsProgram. If you are not opted-in to the managed payments program, each payment policy you create must specify at least one payment method. In addition, if you are not opted-in to managed payments, the listings you create with the Inventory API must reference a payment policy that has this value set to PAYPAL (currently, the Inventory API supports only fixed-prince GTC items with immediate pay (which required payments to be made via PayPal). In order for a buyer to make a full payment on a US or CA motor vehicle, the payment policy must specify at least one of the following as a payment method: CashOnPickup LoanCheck MOCC (money order or cashier''s check) PaymentSeeDescription (payment instructions are in the paymentInstructions field) PersonalCheck Note: Each eBay marketplace supports and requires its own set of payment methods and not all marketplaces support the same set of payment methods. Check the specifics of the marketplaces where you list items to ensure your payment policies meet the payment method requirements needed for any specific listing.'
          items:
            $ref: '#/components/schemas/PaymentMethod'
      description: 'This root container defines a seller''s payment policy for a specific marketplace and category type. Used when creating or updating a payment policy, paymentPolicyRequest encapsulates a seller''s terms for how buyers can pay for the items they buy. While each seller must define at least one payment policy for every marketplace into which they sell, sellers can define multiple payment policies for a single marketplace by specifying different configurations for the unique policies. A successful call returns a paymentPolicyId, plus the Location response header contains the URI to the resource. Policy instructions can be localized by providing a locale in the Content-Language HTTP request header. For example: Content-Language: de-DE. Tip: For more on using business policies, see eBay business policies.'
    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
        prev:
          type: string
          description: This field is for future use.
        total:
          type: integer
          description: 'The total number of items retrieved in the result set. If no items are found, this field is returned with a value of 0.'
          format: int32
        paymentPolicies:
          type: array
          description: A list of the seller's payment policies.
          items:
            $ref: '#/components/schemas/PaymentPolicy'
      description: The response payload for payment policy requests.
    PaymentsProgramOnboardingResponse:
      type: object
      properties:
        onboardingStatus:
          type: string
          description: 'This enumeration value indicates the eligibility of payment onboarding for the registered site. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramOnboardingStatus''>eBay API documentation</a>'
        steps:
          type: array
          description: 'An array of the active process steps for payment onboarding and the status of each step. This array includes the step name, step status, and a webUrl to the IN_PROGRESS step. The step names are returned in sequential order.'
          items:
            $ref: '#/components/schemas/PaymentsProgramOnboardingSteps'
      description: Contains 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. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramOnboardingStepStatus''>eBay API documentation</a>'
        webUrl:
          type: string
          description: This URL provides access to the 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 policy applies. If this value is not specified in the request, the value defaults to the seller''s eBay registration site. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum''>eBay API documentation</a>'
        paymentsProgramType:
          type: string
          description: 'This path parameter specifies the payment program whose status is returned by the call. Currently the only supported payments program is EBAY_PAYMENTS. For details on the program, see Payments Terms of Use. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramType''>eBay API documentation</a>'
        status:
          type: string
          description: ' For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramStatus''>eBay API documentation</a>'
        wasPreviouslyOptedIn:
          type: boolean
          description: 'If set to 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. It''s important to note that the setting of this field does not indicate the seller''s current status regarding the payment program. It is possible for this field to return 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: 'A seller program in to which a seller can opt-in. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:ProgramTypeEnum''>eBay API documentation</a>'
      description: A seller program in to which a seller can opt-in.
    Programs:
      type: object
      properties:
        programs:
          type: array
          description: A list of seller programs.
          items:
            $ref: '#/components/schemas/Program'
      description: A list of the supported seller programs.
    RateTable:
      type: object
      properties:
        countryCode:
          type: string
          description: 'A two-letter ISO 3166 country code representing the eBay marketplace where an item is listed. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum''>eBay API documentation</a>'
        locality:
          type: string
          description: 'The region covered by the shipping rate table, either DOMESTIC or INTERNATIONAL. DOMESTIC indicates that the shipping rate table applies to regions within the country where an item is listed (the source country) while INTERNATIONAL indicates that the shipping rate table applies to regions outside of the country where an item is listed. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:ShippingOptionTypeEnum''>eBay API documentation</a>'
        name:
          type: string
          description: The user-defined name for the shipping rate table. Sellers can access Seller Hub (or My eBay &gt; Account &gt; Site Preferences &gt; Shipping preferences) to create and assign names to their shipping rate tables.
        rateTableId:
          type: string
          description: A unique eBay-assigned ID for a seller's shipping rate table. Call getRateTables to retrieve the seller's current rate table IDs.
      description: A complex type that contains information pertaining to a shipping rate table.
    RateTableResponse:
      type: object
      properties:
        rateTables:
          type: array
          description: A list of elements that provide information on the seller-defined shipping rate tables.
          items:
            $ref: '#/components/schemas/RateTable'
      description: The response container for with information on a seller's shipping rate tables.
    RecipientAccountReference:
      type: object
      properties:
        referenceId:
          type: string
          description: Contains the PayPal email address of the recipient (buyer) if referenceType is set to PAYPAL_EMAIL.
        referenceType:
          type: string
          description: 'A reference a recipient''s account. Currently only PAYPAL_EMAIL is valid. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:RecipientAccountReferenceTypeEnum''>eBay API documentation</a>'
      description: 'Recipient account information, like PayPal email. If the payment method is PayPal, this structure contains the recipient''s PayPal email address.'
    Region:
      type: object
      properties:
        regionName:
          type: string
          description: 'A string that indicates the name of a region, as defined by eBay. A &quot;region&quot; can be either a ''world region'' (e.g., the &quot;Middle East&quot; or &quot;Southeast Asia&quot;) or a country, as represented with a two-letter country code. Use GeteBayDetails to get the values accepted by this field. The values that you''re allowed to use for a specific regionName field depend on the context in which you are setting the value. For details on how to set the values for this field, see The shipToLocations container.'
        regionType:
          type: string
          description: 'Reserved for future use. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/ba:RegionTypeEnum''>eBay API documentation</a>'
      description: This type defines information for a region.
    RegionSet:
      type: object
      properties:
        regionExcluded:
          type: array
          description: 'A list of one or more regionsName fields that specify the areas to where a seller does not ship. Populate regionExcluded in only the top-level shipToLocations container (do not populate this field within the shippingOptions container). Normally a seller ships to as many areas as possible using both DOMESTIC and INTERNATIONAL shipping options and they don''t have a need to exclude any regions from their ship-to locations. With this, there''s no reason to set regionExclude fields. However, it makes sense to set the regionExcluded field when a seller wants to exclude a small area that''s located within a larger area they service. For example, suppose a seller indicates they ship ''Worldwide'', but for some reason must exclude a specific country, or world region, from the larger world area they ship to. To retrieve the regions you can specify in the associated regionName field, call GeteBayDetails with DetailName set to ExcludeShippingLocationDetails, then review the Location fields in the response for the strings that you can specify regionExcluded.regionName. Note that if a buyer''s primary ship-to location is a region that a seller has excluded in their fulfillment policy (or if the buyer does not have a primary ship-to location), they will receive an error message if they attempt to buy or place a bid on an item that uses that fulfillment policy. For details on setting this field, see Excluding specific regions from included shipping areas.'
          items:
            $ref: '#/components/schemas/Region'
        regionIncluded:
          type: array
          description: 'A list of one or more regionsName fields that specify the areas to where a seller ships. Important: Populate this field only when the parent shipToLocations object is located within a shippingOptions container (that is, the parent shipTolocations object must not be the one at the top-level of the policy). Also, this field needs to be populated only when the associated shippingOptions container has optionType set to INTERNATIONAL. Withing an international shipping option, set this value to Worldwide to indicate the seller ships to all world regions. If needed, use the regionExcluded field to exclude any regions in the world to where the seller does not ship. Each eBay marketplace supports its own set of allowable shipping locations. Obtain the valid ''Ship-To Locations'' for a marketplace by calling GeteBayDetails with DetailName set to ShippingLocationDetails, then review the ShippingLocation fields in the response for the strings that you can specify in the regionIncluded.regionName field. For DOMESTIC shipping options, eBay automatically uses the seller''s listing country as the default regionIncluded country. For details on setting this field, see How to set up worldwide shipping. This field is always returned in the shipping policy response. Required if optionType set to INTERNATIONAL.'
          items:
            $ref: '#/components/schemas/Region'
      description: 'This complex type contains the regionIncluded and regionExcluded fields, which indicate the areas to where the seller does and doesn''t ship. Normally a seller ships to as many areas as possible using both DOMESTIC and INTERNATIONAL shipping options, and they don''t have a need to exclude any regions from their ship-to locations. Here, there''s no reason to set regionExcluded fields. However, it makes sense to set the regionExcluded field when a seller wants to exclude a small area that''s within a larger area they service. For example, suppose a seller indicates they ship ''Worldwide'', but for some reason must exclude a specific country, or world region. Note: Configuring the shipToLocations is tricky because the regionIncluded and regionExcluded fields are valid in different parts of the schema and their allowable settings vary upon the context. For details on setting these fields, see .'
    ReturnPolicy:
      type: object
      properties:
        categoryTypes:
          type: array
          description: 'For return policies, this field can be set to only ALL_EXCLUDING_MOTORS_VEHICLES (returns on motor vehicles are not processed through eBay flows) Default: ALL_EXCLUDING_MOTORS_VEHICLES (for return policies only)'
          items:
            $ref: '#/components/schemas/CategoryType'
        description:
          type: string
          description: 'An optional seller-defined description of the return policy for internal use (this value is not displayed to end users). Max length: 250'
        extendedHolidayReturnsOffered:
          type: boolean
          description: 'Important! This field has been deprecated as of version 1.2.0, released on May 31, 2018. Any value supplied in this field is neither read nor returned. If set to true, the seller offers an Extended Holiday Returns policy for their listings. IMPORTANT: Extended Holiday Returns is a seasonally available feature that is offered on some eBay marketplaces. To see if the feature is enabled in any given year, check the Returns on eBay page before the holiday season begins. If the feature is not enabled for the season, this field is ignored. The extended holiday returns period is defined by three dates: The start date = start of November. The purchase cutoff date = end of the year. The end date = end of January. The above dates may vary by a few days each year. Sellers are notified of the current dates on their eBay marketplace before the holiday period starts. Sellers can specify Extended Holiday Returns (as well as their regular non-holiday returns period) for chosen listings at any time during the year. The Extended Holiday Returns offer is not visible in listings until the start date of current year''s holiday returns period, at which point it overrides the non-holiday returns policy. Buyers can see the Extended Holiday Returns offer in listings displayed through the purchase cutoff date and are able to return those purchases until the end date of the period. After the purchase cutoff date, the Extended Holiday Returns offer automatically disappears from the listings and the seller''s non-holiday returns period reappears. Purchases made from that point on are subject to the non-holiday returns period, while purchases made before the cutoff date still have until the end of the period to return under the program. If the value of holidayReturns is false for an item, the return period specified by the returnsWithinOption field applies, regardless of the purchase date. If the item is listed with a policy of no returns, holidayReturns is automatically reset to false.'
        internationalOverride:
          description: 'This container, if populated, specifies the seller''s policies for international returns (items that require postage via an international shipping service). Buy default, the policies for international returns are inherited from the domestic return policy. This container allows the seller to customize their return policy for international returns.'
          $ref: '#/components/schemas/InternationalReturnOverrideType'
        marketplaceId:
          type: string
          description: 'The ID of the eBay marketplace to which this return policy applies. If this value is not specified, value defaults to the seller''s eBay registration site. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum''>eBay API documentation</a>'
        name:
          type: string
          description: 'A user-defined name for this return policy. Names must be unique for policies assigned to the same marketplace. Max length: 64'
        refundMethod:
          type: string
          description: 'Important! this field has been deprecated as of version 1.2.0, released on May 31, 2018. Any value other than MONEY_BACK will be treated as MONEY_BACK (although for a period of time, eBay will store and return the legacy values to preserve backwards compatibility). Indicates the method the seller uses to compensate the buyer for returned items. The return method specified applies only to remorse returns. Each eBay marketplace may support different sets of refund methods and marketplaces can also have differing default values for this field. Sellers are obligated to honor the refund method displayed in their listings. Call GeteBayDetails in the Trading API to see the refund methods supported by the marketplaces you sell into. We recommend you set this field to the value of your preferred refund method and that you use the description field to detail the seller''s return policy (such as indicating how quickly the seller will process a refund, whether the seller must receive the item before processing a refund, and other similar useful details). You cannot modify this value in a Revise item call if (1) the listing has bids or (2) the listing ends within 12 hours. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:RefundMethodEnum''>eBay API documentation</a>'
        restockingFeePercentage:
          type: string
          description: 'Important! This field has been deprecated as of version 1.2.0, released on May 31, 2018. Any value supplied in this field is ignored, it is neither read nor returned. Sellers who accept returns should include this field if they charge buyers a restocking fee when items are returned. A restocking fee comes into play only when an item is returned due to buyer remorse and/or a purchasing mistake, but sellers cannot charge a restocking fee for SNAD-related returns. The total amount returned to the buyer is reduced by the cost of the item multiplied by the percentage indicated by this field. Allowable restocking fee values are: 0.0: No restocking fee is charged to the buyer 10.0: 10 percent of the item price is charged to the buyer 15.0: 15 percent of the item price is charged to the buyer 20.0: Up to 20 percent of the item price is charged to the buyer'
        returnInstructions:
          type: string
          description: 'Important! This field is being deprecated on many marketplaces. Once deprecated, this field will be ignored on marketplaces where it is not supported and it will neither be read nor returned. This optional field contains the seller''s detailed explanation for their return policy and is displayed in the Return Policy section of the View Item page. This field is valid in only the following marketplaces (the field is otherwise ignored): Germany (DE) Spain (ES) France (FR) Italy (IT) Where valid, sellers can use this field to add details about their return policies. eBay uses this text string as-is in the Return Policy section of the View Item page. Avoid HTML and avoid character entity references (such as &amp;amp;pound; or &amp;amp;#163;). To include special characters in the return policy description, use the literal UTF-8 or ISO-8559-1 character (e.g. &amp;#163;). Max length: 5000 (8000 for DE)'
        returnMethod:
          type: string
          description: 'Valid in the US marketplace only, this optional field indicates additional services (other than money-back) that sellers can offer buyers for remorse returns. As of version 1.2.0, the only accepted value for this field is REPLACEMENT. This field is valid in only the US marketplace, any supplied value is ignored in other marketplaces. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum''>eBay API documentation</a>'
        returnPeriod:
          description: 'Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked &quot;delivered&quot; at the buyer''s specified ship-to location. You must set the value to one that''s accepted by the marketplace and category where the item is listed. Most categories support 30-day and 60-day return periods; be sure the value you set in this field is applicable to the marketplace category where you use the return policy. For a definitive list of category return periods, call GeteBayDetails in the Trading API with DetailName set to ReturnPolicyDetails. In the response review the ReturnPolicyDetails.ReturnsWithin field to see the values supported in the different marketplace categories. Note: In version 1.2.0, the options for this field were reduced. See the Release Notes for details. Set this field using the TimeDuration complex type, where you set unit to DAY and value to either 30 or 60 (or other value, as appropriate). Note that this value cannot be modified if the listing has bids or sales, or if the listing ends within 12 hours.'
          $ref: '#/components/schemas/TimeDuration'
        returnPolicyId:
          type: string
          description: A unique eBay-assigned ID for this policy. This ID value is appended to the end of the Location URI that is returned as a response header when you call createReturnPolicy).
        returnsAccepted:
          type: boolean
          description: 'If set to true, the seller accepts returns. Call the getReturnPolicies in the Metadata API to see what categories require returns to be offered for listings in each category. Also, note that some European marketplaces (for example, UK, IE, and DE) require sellers to accept returns for fixed-price items and auctions listed with Buy It Now. For details, see Returns and the Law (UK). Note:Top-Rated sellers must accept item returns and the handlingTime should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay''s Top-Rated seller program, see Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits.'
        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. Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum''>eBay API documentation</a>'
      description: 'Root container that defines the fields for a seller''s return policy. The returnPolicy encapsulates a seller''s terms for how they handle item returns, the name and description of the policy, and the marketplace and category group(s) to which the return policy is applied. While each seller must define at least one return policy for every marketplace into which they sell, sellers can define multiple return policies for a single marketplace by specifying different configurations for the unique policies.'
    ReturnPolicyRequest:
      type: object
      properties:
        categoryTypes:
          type: array
          description: 'For return policies, this field can be set to only ALL_EXCLUDING_MOTORS_VEHICLES (returns on motor vehicles are not processed through eBay flows.) Default: ALL_EXCLUDING_MOTORS_VEHICLES (for return policies only)'
          items:
            $ref: '#/components/schemas/CategoryType'
        description:
          type: string
          description: 'An optional seller-defined description of the return policy for internal use (this value is not displayed to end users). Max length: 250'
        extendedHolidayReturnsOffered:
          type: boolean
          description: 'Important! This field has been deprecated as of version 1.2.0, released on May 31, 2018. Any value supplied in this field is ignored, it is neither read nor returned. If set to true, the seller offers an Extended Holiday Returns policy for their listings. IMPORTANT: Extended Holiday Returns is a seasonally available feature that is offered on some eBay marketplaces. To see if the feature is enabled in any given year, check the Returns on eBay page before the holiday season begins. If the feature is not enabled for the season, this field is ignored. The extended holiday returns period is defined by three dates: The start date = start of November. The purchase cutoff date = end of the year. The end date = end of January. The above dates may vary by a few days each year. Sellers are notified of the current dates on their eBay marketplace before the holiday period starts. Sellers can specify Extended Holiday Returns (as well as their regular non-holiday returns period) for chosen listings at any time during the year. The Extended Holiday Returns offer is not visible in listings until the start date of current year''s holiday returns period, at which point it overrides the non-holiday returns policy. Buyers can see the Extended Holiday Returns offer in listings displayed through the purchase cutoff date and are able to return those purchases until the end date of the period. After the purchase cutoff date, the Extended Holiday Returns offer automatically disappears from the listings and the seller''s non-holiday returns period reappears. Purchases made from that point on are subject to the non-holiday returns period, while purchases made before the cutoff date still have until the end of the period to return under the program. If the value of holidayReturns is false for an item, the return period specified by the returnsWithinOption field applies, regardless of the purchase date. If the item is listed with a policy of no returns, holidayReturns is automatically reset to false.'
        internationalOverride:
          description: 'This container, if populated, specifies the seller''s policies for international returns (items that require postage via an international shipping service). Buy default, the policies for international returns are inherited from the domestic return policy. This container allows the seller to customize the return policy for international returns.'
          $ref: '#/components/schemas/InternationalReturnOverrideType'
        marketplaceId:
          type: string
          description: 'The ID of the eBay marketplace to which this return policy applies. If this value is not specified, value defaults to the seller''s eBay registration site. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum''>eBay API documentation</a>'
        name:
          type: string
          description: 'A user-defined name for this return policy. Names must be unique for policies assigned to the same marketplace. Max length: 64'
        refundMethod:
          type: string
          description: 'Important! this field has been deprecated as of version 1.2.0, released on May 31, 2018. Any value other than MONEY_BACK will be treated as MONEY_BACK (although for a period of time, eBay will store and return the legacy values to preserve backwards compatibility). Indicates the method the seller uses to compensate the buyer for returned items. The return method specified applies only to remorse returns. Note that each eBay marketplace can support different sets of refund methods. Also, each eBay marketplace has a default setting for this value and if you do not specifically set this value, sellers are obligated to honor the setting that displays in their listings. Call GeteBayDetails in the Trading API to see what refund methods the marketplaces you sell into support. We recommend you set this field to the value of your preferred refund method and that you use the description field to detail the seller''s return policy (such as indicating how quickly the seller will process a refund, whether the seller must receive the item before processing a refund, and other similar useful details). You cannot modify this value in a Revise item call if (1) the listing has bids or (2) the listing ends within 12 hours. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:RefundMethodEnum''>eBay API documentation</a>'
        restockingFeePercentage:
          type: string
          description: 'Important! This field has been deprecated as of version 1.2.0, released on May 31, 2018. Any value supplied in this field is ignored, it is neither read nor returned. Sellers who accept returns should include this field if they charge buyers a restocking fee when items are returned. A restocking fee comes into play only when an item is returned due to buyer remorse and/or a purchasing mistake, but sellers cannot charge a restocking fee for SNAD-related returns. The total amount returned to the buyer is reduced by the cost of the item multiplied by the percentage indicated by this field. Allowable restocking fee values are: 0.0: No restocking fee is charged to the buyer 10.0: 10 percent of the item price is charged to the buyer 15.0: 15 percent of the item price is charged to the buyer 20.0: Up to 20 percent of the item price is charged to the buyer'
        returnInstructions:
          type: string
          description: 'Important! This field is being deprecated on many marketplaces. Once deprecated, this field will be ignored on marketplaces where it is not supported and it will neither be read nor returned. This optional field contains the seller''s detailed explanation for their return policy and is displayed in the Return Policy section of the View Item page. This field is valid in only the following marketplaces (the field is otherwise ignored): Germany (DE) Spain (ES) France (FR) Italy (IT) Where valid, sellers can use this field to add details about their return policies. eBay uses this text string as-is in the Return Policy section of the View Item page. Avoid HTML and avoid character entity references (such as &amp;amp;pound; or &amp;amp;#163;). To include special characters in the return policy description, use the literal UTF-8 or ISO-8559-1 character (e.g. &amp;#163;). Max length: 5000 (8000 for DE)'
        returnMethod:
          type: string
          description: 'Valid in the US marketplace only, this optional field indicates additional services (other than money-back) that sellers can offer buyers for remorse returns. As of version 1.2.0, the only accepted value for this field is REPLACEMENT. This field is valid in only the US marketplace, any supplied value is ignored in other marketplaces. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum''>eBay API documentation</a>'
        returnPeriod:
          description: 'Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked &quot;delivered&quot; at the buyer''s specified ship-to location. You must set the value to one that''s accepted by the marketplace and category where the item is listed. Most categories support 30-day and 60-day return periods. For a definitive list of category return periods, call GeteBayDetails in the Trading API with DetailName set to ReturnPolicyDetails. In the response review the ReturnPolicyDetails.ReturnsWithin field to see the values supported in the different marketplace categories. Note: In version 1.2.0, the options for this field were reduced. See the Release Notes for details. Set this field using the TimeDuration complex type, where you set unit to DAY and value to either 30 or 60 (or other value, as appropriate). Note that this value cannot be modified if the listing has bids or sales, or if the listing ends within 12 hours. Required if returnsAccepted is set to true.'
          $ref: '#/components/schemas/TimeDuration'
        returnsAccepted:
          type: boolean
          description: 'If set to true, the seller accepts returns. Call the getReturnPolicies in the Metadata API to see what categories require returns to be offered for listings in each category. Also, note that some European marketplaces (for example, UK, IE, and DE) require sellers to accept returns for fixed-price items and auctions listed with Buy It Now. For details, see Returns and the Law (UK). Note:Top-Rated sellers must accept item returns and the handlingTime should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay''s Top-Rated seller program, see Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits.'
        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. Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues. Required if returnsAccepted is set to true. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum''>eBay API documentation</a>'
      description: 'This root container defines a seller''s return policy for a specific marketplace and category type. Used when creating or updating a return policy, returnPolicyRequest encapsulates a seller''s terms for how buyers can return items. While each seller must define at least one payment policy for every marketplace into which they sell, sellers can define multiple payment policies for a single marketplace by specifying different configurations for the unique policies. A successful call returns a paymentPolicyId, plus the Location response header contains the URI to the resource. Use the Metadata API method to determine which categories in the marketplace(s) require you to provide a return policy. Also note that some marketplaces require you to provide a specific return policy for vehicle listings. Policy instructions can be localized by providing a locale in the Content-Language HTTP request header. For example: Content-Language: de-DE. Tip: For more on using business policies, see eBay business policies.'
    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.
        total:
          type: integer
          description: 'The total number of items retrieved in the result set. If no items are found, this field is returned with a value of 0.'
          format: int32
        returnPolicies:
          type: array
          description: A list of the seller's return policies.
          items:
            $ref: '#/components/schemas/ReturnPolicy'
      description: The response payload for return policy requests.
    SalesTax:
      type: object
      properties:
        countryCode:
          type: string
          description: 'The country code identifying the country to which this tax rate applies. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum''>eBay API documentation</a>'
        salesTaxJurisdictionId:
          type: string
          description: A unique ID that identifies the sales tax jurisdiction to which the tax rate applies (for example a state within the United States).
        salesTaxPercentage:
          type: string
          description: The sales tax rate (as a percentage of the sale) applied to sales transactions made in this country and sales tax jurisdiction.
        shippingAndHandlingTaxed:
          type: boolean
          description: 'If set to true, shipping and handling charges are taxed.'
      description: 'The applicable sales tax rate, as a percentage of the sale amount, for a given country and sales tax jurisdiction within that country.'
    SalesTaxBase:
      type: object
      properties:
        salesTaxPercentage:
          type: string
          description: 'The sales tax rate, as a percentage of the sale.'
        shippingAndHandlingTaxed:
          type: boolean
          description: 'If set to true, shipping and handling charges are taxed.'
      description: A container that describes the how the sales tax rate is calculated.
    SalesTaxes:
      type: object
      properties:
        salesTaxes:
          type: array
          description: A list of sales tax tables that have been set up by a seller.
          items:
            $ref: '#/components/schemas/SalesTax'
      description: A list of sales tax tables.
    SellingLimit:
      type: object
      properties:
        amount:
          description: The maximum merchandise amount (value and quantity) that a seller can list per calendar month.
          $ref: '#/components/schemas/Amount'
        quantity:
          type: integer
          description: 'The maximum quantity of items that can be listed by the seller per calendar month. Note that for a listing with variations, all of the items listed in the variation count as individual items.'
          format: int32
      description: Defines the selling limit applied to an eBay seller's account.
    SellingPrivileges:
      type: object
      properties:
        sellerRegistrationCompleted:
          type: boolean
          description: 'If set to true, the seller''s registration is completed.'
        sellingLimit:
          description: Complex type defining the selling limits for the associated seller account.
          $ref: '#/components/schemas/SellingLimit'
      description: 'A merchant''s selling limit, and the status of their account registration.'
    SetFulfillmentPolicyResponse:
      type: object
      properties:
        categoryTypes:
          type: array
          description: 'The CategoryTypeEnum value to which this policy applies. This container is used to discern accounts that sell motor vehicles from those that do not. Restriction: Currently, each policy can be set to only one categoryTypes value at a time.'
          items:
            $ref: '#/components/schemas/CategoryType'
        description:
          type: string
          description: 'An optional seller-defined description of the fulfillment policy for internal use (this value is not displayed to end users). Max length: 250'
        freightShipping:
          type: boolean
          description: 'If set to 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 policy. This ID is generated when the policy is created.
        globalShipping:
          type: boolean
          description: 'If set to true, the seller has opted-in to the Global Shipping Program and eBay automatically sets the international shipping service options to International Priority Shipping. If the value of globalShipping is false, the seller is responsible for specifying one or more international shipping service options if they want to ship internationally.'
        handlingTime:
          description: 'Specifies 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. Note that Top-Rated sellers must offer same-day or one-day handling for a listing in order for that listing to receive a Top Rated Plus seal on the View Item or Search Results pages. This field is required when the seller uses a flat or calculated shipping service, and it does not apply when there is no shipping service specified (for example, if the policy specifies only localPickup or freightShipping). In these cases, this field is not used and you can set it to 0. Min: 0 Max: 30'
          $ref: '#/components/schemas/TimeDuration'
        localPickup:
          type: boolean
          description: 'If set to true, no shipping is offered by this policy and the seller offers only local pickup of the item (normally from a non-business location). This option is most often used for customer-to-customer sales and if set, costType should be set to NOT_SPECIFIED.'
        marketplaceId:
          type: string
          description: 'The ID of the eBay marketplace to which this fulfillment policy applies. If this value is not specified, value defaults to the seller''s eBay registration site. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum''>eBay API documentation</a>'
        name:
          type: string
          description: 'A user-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. Max length: 64'
        pickupDropOff:
          type: boolean
          description: 'If set to true, the seller offers the &quot;Click and Collect&quot; option. Currently, &quot;Click and Collect&quot; is available only to large retail merchants the eBay AU and UK marketplaces.'
        shippingOptions:
          type: array
          description: 'A list that defines the seller''s shipping configurations for DOMESTIC and INTERNATIONAL order shipments. The list has a single element if the seller ships to only domestic locations. If the seller also ships internationally, a second element defines their international shipping options. Shipping options configure the high-level shipping settings that apply to orders, such as flat-rate or calculated shipping, and any rate tables the seller wants to associate with the shipping services. Each shippingOption element has a shippingServices container that defines the list of shipping services (domestic or international) offered with this fulfillment policy.'
          items:
            $ref: '#/components/schemas/ShippingOption'
        shipToLocations:
          description: 'This object contains the regionIncluded and regionExcluded fields, which defines the areas where the seller does and doesn''t ship to with this fulfillment policy. shipToLocations appears at both the top-level of the fulfillment policy as well as within the individual shippingOptions.shippingService containers. Here at the top level, this field returns the list of regionExclude areas that have been defined at this level, plus a complete list of regionIncluded fields that have been defined in all the policy''s shippingOptions.shippingServices.shipToLocations containers. For details on configuring this field, see The shipToLocations container.'
          $ref: '#/components/schemas/RegionSet'
        warnings:
          type: array
          description: 'A list of warnings that were generated during the processing of the request. This field normally returns empty, which indicates the request did not generate any warnings.'
          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: 'The CategoryTypeEnum value to which this policy applies. This container is used to discern accounts that sell motor vehicles from those that do not. Restriction: Currently, each policy can be set to only one categoryTypes value at a time.'
          items:
            $ref: '#/components/schemas/CategoryType'
        deposit:
          description: 'The specified amounts and due dates for motor vehicle deposits on eBay Motors listings. The deposit amount appears in the shipping, payment details, and return policy sections of the View Item page. Restrictions: This container is applicable only if the categoryTypes.name field is set to MOTORS_VEHICLES. This container is not supported for sellers who opt-in to the managed payments program. Managed payments does not currently support the sale of motor vehicles.'
          $ref: '#/components/schemas/Deposit'
        description:
          type: string
          description: An optional seller-defined description of the payment policy for internal use (this value is not displayed to end users).
        fullPaymentDueIn:
          description: 'The number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. This container applies to motor vehicles listings only and indicates when a final payment for the vehicle is due. Note: This value is always returned if categoryTypes is set to MOTORS_VEHICLES. Restriction: This container is not supported for sellers who opt-in to the managed payments program. Managed payments does not currently support the sale of motor vehicles.'
          $ref: '#/components/schemas/TimeDuration'
        immediatePay:
          type: boolean
          description: 'If set to true, payment is due upon receipt (eBay generates a receipt when the buyer agrees to purchase an item). The items will be available for other buyers until the payment is complete. This boolean must be set in the payment policy if the seller wants to create a listing that has an immediate payment requirement. Note: This container can be used for sellers who opt-in to the managed payments program, but some requirements do not apply.Default: False'
        marketplaceId:
          type: string
          description: 'The ID of the eBay marketplace to which this payment policy applies. If this value is not specified, the value defaults to the seller''s eBay registration site. Note: A limited number of sellers, on a limited number of eBay marketplaces, are currently opted-in to the eBay managed payments program. To view the eBay marketplaces where managed payments are currently supported, see the managed payments landing page. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum''>eBay API documentation</a>'
        name:
          type: string
          description: 'A user-defined name for this payment policy. Names must be unique for policies assigned to the same marketplace. Note: eBay will create a new payment policy for sellers who opt-in to the managed payments program.Max length: 64'
        paymentInstructions:
          type: string
          description: 'A free-form string field that allows sellers to add detailed payment instructions to their listings. The payment instructions appear on eBay''s View Item and Checkout pages. eBay recommends sellers use this field to clarify payment policies for motor vehicle listings on eBay Motors. For example, sellers can include the specifics on the deposit (if required), pickup/delivery arrangements, and full payment details on the vehicle. The field allows only 500 characters as input, but due to the way the eBay web site UI treats characters, this field can return more than 500 characters in the response. For example, characters like &amp; and '' (ampersand and single quote) count as 5 characters each. Restriction: This container is not supported for sellers who opt-in to the managed payments program. Max length: 1000'
        paymentMethods:
          type: array
          description: 'If the seller is not opted-in to managed payments, this container returns a list of the payment methods accepted by the seller. When not opted-in to managed payments, each payment policy must specify at least one payment method. Note: The paymentMethods container is not returned if the seller is opted-in to the managed payments program.'
          items:
            $ref: '#/components/schemas/PaymentMethod'
        paymentPolicyId:
          type: string
          description: A unique eBay-assigned ID for a payment policy. This ID is generated when the policy is created.
        warnings:
          type: array
          description: 'A list of warnings related to request. This field normally returns empty, which indicates the request did not generate any warnings.'
          items:
            $ref: '#/components/schemas/Error'
      description: Complex type that that gets populated with a response containing a payment policy.
    SetReturnPolicyResponse:
      type: object
      properties:
        categoryTypes:
          type: array
          description: 'For return policies, this field always returns ALL_EXCLUDING_MOTORS_VEHICLES (returns on motor vehicles are not processed through eBay flows.) Default: ALL_EXCLUDING_MOTORS_VEHICLES (for return policies only)'
          items:
            $ref: '#/components/schemas/CategoryType'
        description:
          type: string
          description: An optional seller-defined description of the return policy for internal use (this value is not displayed to end users).
        extendedHolidayReturnsOffered:
          type: boolean
          description: 'Important! This field has been deprecated as of version 1.2.0, released on May 31, 2018. Any value supplied in this field is ignored, it is neither read nor returned. If set to true, the seller offers an Extended Holiday Returns policy for their listings. IMPORTANT: Extended Holiday Returns is a seasonally available feature that is offered on some eBay marketplaces. To see if the feature is enabled in any given year, check the eBay Seller Center Returns on eBay page of before the holiday season begins.'
        internationalOverride:
          description: 'This container, if populated, specifies the seller''s policies for international returns (items that require postage via an international shipping service). Buy default, the policies for international returns are inherited from the domestic return policy. This container allows the seller to customize the return policy for international returns.'
          $ref: '#/components/schemas/InternationalReturnOverrideType'
        marketplaceId:
          type: string
          description: 'The ID of the eBay marketplace to which this return policy applies. If this value is not specified, value defaults to the seller''s eBay registration site. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum''>eBay API documentation</a>'
        name:
          type: string
          description: 'A user-defined name for this return policy. Names must be unique for policies assigned to the same marketplace. Max length: 64'
        refundMethod:
          type: string
          description: 'Important! This field has been deprecated as of version 1.2.0, released on May 31, 2018. Any value other than MONEY_BACK will be treated as MONEY_BACK (although for a period of time, eBay will store and return the legacy values to preserve backwards compatibility). Indicates the method the seller uses to compensate the buyer for returned items. The return method specified applies only to remorse returns. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:RefundMethodEnum''>eBay API documentation</a>'
        restockingFeePercentage:
          type: string
          description: 'Important! This field has been deprecated as of version 1.2.0, released on May 31, 2018. Any value supplied in this field is ignored, it is neither read nor returned. Optionally set by the seller, the percentage charged if the seller charges buyers a a restocking fee when items are returned due to buyer remorse and/or a purchasing mistake. The total amount charged to the buyer is the cost of the item multiplied by the percentage indicated in this field.'
        returnInstructions:
          type: string
          description: 'This field contains the seller''s detailed explanation for their return policy and is displayed in the Return Policy section of the View Item page. This field is valid in only the following marketplaces (the field is otherwise ignored): Germany (DE) Spain (ES) France (FR) Italy (IT)'
        returnMethod:
          type: string
          description: 'This field indicates the method in which the seller handles non-money back return requests for remorse returns. This field is valid in only the US marketplace and the only valid value is REPLACEMENT. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum''>eBay API documentation</a>'
        returnPeriod:
          description: Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked &quot;delivered&quot; at the buyer's specified ship-to location.
          $ref: '#/components/schemas/TimeDuration'
        returnPolicyId:
          type: string
          description: A unique eBay-assigned ID for a return policy. This ID is generated when the policy is created.
        returnsAccepted:
          type: boolean
          description: 'If set to true, 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. Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum''>eBay API documentation</a>'
        warnings:
          type: array
          description: 'A list of warnings related to request. This field normally returns empty, which indicates the request did not generate any warnings.'
          items:
            $ref: '#/components/schemas/Error'
      description: Complex type that that gets populated with a response containing a return policy.
    ShippingOption:
      type: object
      properties:
        costType:
          type: string
          description: 'Defines whether the shipping cost is FLAT_RATE (the same rate for all buyers), CALCULATED (the shipping rate varies by the ship-to location and size and weight of the package, as defined by the item), or NOT_SPECIFIED (for use with local pickup). Required if the policy offers shipping options using a shippingOptions container. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:ShippingCostTypeEnum''>eBay API documentation</a>'
        insuranceFee:
          description: This field has been deprecated. Shipping insurance is offered only via a shipping carrier's shipping services and is no longer available via eBay shipping policies.
          $ref: '#/components/schemas/Amount'
        insuranceOffered:
          type: boolean
          description: This field has been deprecated. Shipping insurance is offered only via a shipping carrier's shipping services and is no longer available via eBay shipping policies.
        optionType:
          type: string
          description: 'Use this field to set the ShippingOption element to either DOMESTIC or INTERNATIONAL. Required if the policy offers shipping options using a shippingOptions container. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/api:ShippingOptionTypeEnum''>eBay API documentation</a>'
        packageHandlingCost:
          description: 'Applicable to only CALCULATED shipping, an amount a seller can add to cover packaging, handling costs. This cost is an addition to the selected shipping service cost and is included in the sum of the final shipping service costs in the output. This field must specify a zero value if freeShipping is set to true. If the seller offers domestic and international calculated shipping but sets this field for only domestic shipping, eBay also applies the cost to all international shipments. To specify a fee for only international shipments, set the a domestic packagingHandlingCost to 0.'
          $ref: '#/components/schemas/Amount'
        rateTableId:
          type: string
          description: 'A unique eBay-assigned ID associated with a user-created shipping rate table. The locality of a shipping rate table can be either DOMESTIC or INTERNATIONAL and you must ensure the value specified in this field references a shipping rate table that matches the type specified in the shippingOptions.optionType field. If you mismatch the types, eBay responds with a 20403 error. Call getRateTable to retrieve information (including rateTableId values) on the rate tables configured by a seller. For information on creating rate tables, see Using shipping rate tables.'
        shippingServices:
          type: array
          description: 'Contains a list of shipping services offered for either DOMESTIC or INTERNATIONAL shipments. Sellers can specify up to four domestic shipping services and up to five international shipping services by using separate shippingService containers for each. Note that if the seller is opted in to the Global Shipping Program, they can specify only four other international shipping services, regardless of whether or not Global Shipping is offered as one of the services. Required if the policy offers shipping options using a shippingOptions container.'
          items:
            $ref: '#/components/schemas/ShippingService'
      description: 'This complex type defines a seller''s shipping configuration for either a DOMESTIC or INTERNATIONAL shipping option. Shipping options configure the high-level settings for shipments, such as flat-rate or calculated shipping, and any rate tables the seller wants to associate with the policy. Each shippingOption element has a shippingServices container that defines the list of shipping carriers and services that are available for the parent shipping option (that is, for either DOMESTIC or INTERNATIONAL shipping). If a seller offers an international shipping option, they must also offer a domestic shipping option. Note that costType (FLAT_RATE or CALCULATED) is set in shippingOptions and that all associated shipping services must be able to support this cost type.'
    ShippingService:
      type: object
      properties:
        additionalShippingCost:
          description: 'The cost of shipping each additional item if the same buyer purchases a multiple quantity of the same line item. This field is applicable for policies that cover multiple-quantity, fixed-price listings and is not applicable for policies that apply to single-quantity listings. Sellers can encourage buyers to purchase multiple items and by offering a shipping discount on added items. The value for this field should be lower than the value set for shippingCost and you can set this value to 0 to offer free shipping on added items. If this value is not set, it defaults to the value set for shippingCost.'
          $ref: '#/components/schemas/Amount'
        buyerResponsibleForPickup:
          type: boolean
          description: 'This field is only applicable to vehicle categories on eBay Motors (US and Canada). If set to true, the buyer is responsible for picking up the vehicle. Otherwise, the seller should specify the vehicle pickup arrangements in the item description. The seller cannot modify this flag if the vehicle has bids or if the listing ends within 12 hours. Default: false'
        buyerResponsibleForShipping:
          type: boolean
          description: 'This field is applicable for only items listed in vehicle categories on eBay Motors (US and Canada). If set to true, the buyer is responsible for the shipment of the vehicle. Otherwise, the seller should specify the vehicle shipping arrangements in the item description. The seller cannot modify this flag if the vehicle has bids or if the listing ends within 12 hours. Default: false'
        cashOnDeliveryFee:
          description: 'The value indicates the Cash on Delivery (COD) fee that the seller charges if the buyer uses the CASH_ON_DELIVERY payment method. This fee is added to the total cost of the item, and the total cost is due from the buyer upon the delivery of the item. This field is applicable only if the buyer-selected payment method is ''COD'' and the selected shipping service option supports a Cash on Delivery option. To see if a domestic shipping service supports the Cash on Delivery option, call GeteBayDetails with DetailName set to ShippingServiceDetails, then review the response to see if CODService is set to true for the targeted shipping service.'
          $ref: '#/components/schemas/Amount'
        freeShipping:
          type: boolean
          description: 'If set to true, the seller offers free shipping to the buyer. This field can only be included and set to ''true'' for the first domestic shipping service option specified in the shippingServices container (it is ignored if set for subsequent shipping services). The first specified shipping service option has a sortOrder value of 1 or (if the sortOrderId field is not used) it is the shipping service option that''s specified first in the shippingServices container.'
        shippingCarrierCode:
          type: string
          description: 'The shipping carrier, such as ''USPS'', ''FedEx'', ''UPS'', and so on.'
        shippingCost:
          description: 'For FLAT_RATE shipping options, the amount specified in this field is the shipping cost for the selected shipping carrier and service. The amount supplied must exclude any additional shipping charges (such as the seller''s handling charges). This field is not applicable in CALCULATED shipping services (the cost for a calculated shipping service cannot be determined until the listing has ended and the buyer has specified a postal code). This value is automatically set to ''0.0'' if freeShipping is set to true. Required if the shipping option uses a FLAT_RATE cost type and freeShipping is false.'
          $ref: '#/components/schemas/Amount'
        shippingServiceCode:
          type: string
          description: 'The shipping service that the shipping carrier uses to ship an item. For example, an overnight, two-day delivery, or other type of service. For details on configuring shipping services, see Setting the shipping carrier and shipping service values.'
        shipToLocations:
          description: 'This object contains the regionIncluded and regionExcluded fields, which define the geographical regions that a seller does and does not cover by the associated shipping policy. shipToLocations appears at both the top-level of the fulfillment policy as well as here, within the shippingOptions.shippingServices container. Within individual shippingServices containers, use the regionIncluded container to specify the list of regions to where a seller ships using that particular shipping service (you can use different shipping services to cover different regions). Note: Do not populate the regionExcluded field at this level. Instead, define the regions to where a seller does not ship using the shipToLocations container found at the top level of the FulfillmentPolicyRequest container. Every eBay marketplace supports its own set of regions that you can use in the regionIncluded field. To determine the valid ''Ship-To'' values for a marketplace, call GeteBayDetails with DetailName set to ShippingLocationDetails, then review the ShippingLocation fields in the response for the strings that you use in the regionIncluded.regionName field. When returned at this level, this container lists only the regionIncluded areas defined for the associated shippingService container. For more details, see The shipToLocations container.'
          $ref: '#/components/schemas/RegionSet'
        sortOrder:
          type: integer
          description: 'This integer value controls the order that this shipping service option appears in the View Item and Checkout pages, as related to the other specified shipping service options. Sellers can specify up to four domestic shipping services (in four separate shippingService containers), so valid values are 1, 2, 3, and 4. A shipping service option with a sortOrder value of ''1'' appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a sortOrder value of ''4'' appears at the bottom of the list. Sellers can specify up to five international shipping services (in five separate shippingService containers, so valid values for international shipping services are 1, 2, 3, 4, and 5. Similarly to domestic shipping service options, the sortOrder value of a international shipping service option controls the placement of that shipping service option in the View Item and Checkout pages. Set up different domestic and international services by configuring two shippingOptions containers, where you set shippingOptions.optionType to either DOMESTIC or INTERNATIONAL to indicate the area supported by the listed shipping services. If the sortOrder field is not supplied, the order of domestic and international shipping service options is determined by the order in which they are listed in the API call. Min: 1. Max: 4 (for domestic shipping service) or 5 (for international shipping service).'
          format: int32
        surcharge:
          description: 'Note: DO NOT USE THIS FIELD. Shipping surcharges for shipping service options can no longer be set with fulfillment business policies. To set a shipping surcharge for a shipping service option, only the Shipping rate tables tool in My eBay can be used. The shipping surcharge applicable to the domestic shipping service.'
          $ref: '#/components/schemas/Amount'
      description: 'A complex type that defines the available shipping services offered in the parent shippingOptions container. The shipping services specified here must be able to accommodate the optionType defined in the parent shippingOption container (either DOMESTIC or INTERNATIONAL). Tip: For more on setting up shipping services, see Setting the shipping carrier and shipping service values.'
    TimeDuration:
      type: object
      properties:
        unit:
          type: string
          description: 'A time-measurement unit that specifies a singular period of time. A span of time is defined when you apply the value specified in the value field to the value specified for unit. Time-measurement units can be YEAR, MONTH, DAY, and so on. See TimeDurationUnitEnum for a complete list of possible time-measurement units. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/sell/account/types/ba:TimeDurationUnitEnum''>eBay API documentation</a>'
        value:
          type: integer
          description: 'An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.'
          format: int32
      description: A complex type that specifies a period of time using a specified time-measurement unit.
  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
