eBay Rate_table API

openapi: 3.2.0
info:
  title: eBay Account Rate Table API
  description: 'The Account API gives sellers the ability to configure their eBay seller accounts, including the seller''s policies (eBay business policies and seller-defined custom policies), opt in and out of eBay seller programs, configure sales tax tables, and get account information.


    For details on the availability of the methods in this API, see Account API requirements and restrictions.'
  contact:
    name: eBay Inc,
  license:
    name: eBay API License Agreement
    url: https://go.developer.ebay.com/api-license-agreement
  version: v1.9.2
servers:
- url: https://api.ebay.com{basePath}
  description: Production
  variables:
    basePath:
      default: /sell/account/v1
tags:
- name: Rate_table
paths:
  /rate_table:
    get:
      tags:
      - Rate_table
      description: '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 of the seller''s shipping rate tables.


        The method''s response includes a rateTableId for each table defined by the seller. This rateTableId value is used in add/revise item call or in create/update fulfillment business policy call to specify the shipping rate table to use for that policy''s domestic or international shipping options.


        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 Shipping rate tables in My eBay to create and update rate tables.'
      operationId: getRateTables
      parameters:
      - name: country_code
        in: query
        description: This query parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> code of country for which you want shipping rate table information. If you do not specify a country code, the request returns all of the seller's defined shipping rate tables for all eBay marketplaces. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum
        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
      summary: Get rate tables
      x-summary-source: derived
components:
  schemas:
    RateTable:
      type: object
      properties:
        countryCode:
          type: string
          description: A two-letter <a href="https://www.iso.org/iso-3166-country-codes.html " title="https://www.iso.org " target="_blank">ISO 3166</a> country code representing the eBay marketplace where the shipping rate table is defined. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum'>eBay API documentation</a>
        locality:
          type: string
          description: This enumeration value returned here indicates whether the shipping rate table is a domestic or international shipping rate table. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ShippingOptionTypeEnum'>eBay API documentation</a>
        name:
          type: string
          description: The seller-defined name for the shipping rate table.
        rateTableId:
          type: string
          description: A unique eBay-assigned ID for a seller's shipping rate table. These <b>rateTableId</b> values are used to associate shipping rate tables to fulfillment business policies or directly to listings through an add/revise/relist call in the Trading API.
      description: This type is used to provide details about each shipping rate table that is returned in the <b>getRateTables</b> response.
    RateTableResponse:
      type: object
      properties:
        rateTables:
          type: array
          description: An array of all shipping rate tables defined for a marketplace (or all marketplaces if no <b>country_code</b> query parameter is used). This array will be returned as empty if the seller has no defined shipping rate tables for the specified marketplace.
          items:
            $ref: '#/components/schemas/RateTable'
      description: This type is the base response of the <b>getRateTables</b> method.
  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