---
openapi: "3.0.0"
info:
  title: "EDIS public shipping API"
  description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
    \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
    \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
    color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
    \ This method is only available for Greater-China based sellers with an active\
    \ eDIS account.</p></div><br>This API allows 3rd party developers in the Greater-China\
    \ area to process package shipping details."
  contact:
    name: "eBay Inc,"
  license:
    name: "eBay API License Agreement"
    url: "https://developer.ebay.com/join/api-license-agreement"
  version: "1.1.0"
servers:
- url: "https://api.ebay.com{basePath}"
  description: "Production"
  variables:
    basePath:
      default: "/sell/edelivery_international_shipping/v1"
paths:
  /actual_costs:
    get:
      tags:
      - "actual_costs"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method is used to retrieve the actual weight\
        \ and cost for one or more packages based on the provided input criteria.<br><br>Responses\
        \ can be filtered by the <b>tracking_numbers</b> query parameter. If this\
        \ parameter is used, actual costs for each package associated with the provided\
        \ tracking numbers are returned.<br><br>Alternatively, responses can be filtered\
        \ by the <b>trans_begin_time</b> and <b>trans_end_time</b> query parameters.\
        \ If these parameters are used, the actual costs of all packages created within\
        \ this date range are returned.<br><br>Only one filtering method can be used\
        \ per call."
      operationId: "getActualCosts"
      parameters:
      - name: "tracking_numbers"
        in: "query"
        description: "This query parameter specifies the tracking number(s) of the\
          \ package(s) for which to retrieve the actual weight and cost. Tracking\
          \ numbers are returned when creating packages through the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage\"\
          \ target=\"_blank\">createPackage</a> method.<br><br>Up to 200 tracking\
          \ numbers can be provided.<br><br><span class=\"tablenote\"><b>Note:</b>\
          \ This query parameter is required if <b>trans_begin_time</b> and <b>trans_end_time</b>\
          \ is not provided.</span>"
        required: false
        schema:
          type: "string"
      - name: "trans_begin_time"
        in: "query"
        description: "This query parameter specifies the start time of a transaction\
          \ in UTC format.<br><br>If the the </b>trans_begin_time</b> and <b>trans_end_time</b>\
          \ query parameters are used, the actual costs of all packages created within\
          \ this date range are returned.<br><br><span class=\"tablenote\"><b>Note:</b>\
          \ This query parameter and <b>trans_end_time</b> are required if <b>tracking_numbers</b>\
          \ is not provided.</span><br><b>Format</b>: <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>"
        required: false
        schema:
          type: "string"
      - name: "trans_end_time"
        in: "query"
        description: "This query parameter specifies ending time of a transaction\
          \ in UTC format.<br><br>If the the </b>trans_begin_time</b> and <b>trans_end_time</b>\
          \ query parameters are used, the actual costs of all packages created within\
          \ this date range are returned.<br><br><span class=\"tablenote\"><b>Note:</b>\
          \ This query parameter and <b>trans_start_time</b> are required if <b>tracking_numbers</b>\
          \ is not provided.</span><br><b>Format</b>: <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>"
        required: false
        schema:
          type: "string"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetActualCostResponses"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355069:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The date format of the trans_begin_time field is incorrect."
              355071:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The specified tracking number {tracking_number} does\
                  \ not belong to the seller, so cannot be retrieved."
              355070:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The date format of the trans_end_time field is incorrect."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "404":
          description: "Not found"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /address_preference:
    get:
      tags:
      - "address_preference"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to retrieve information\
        \ about all the ship-from and/or return addresses associated with a seller's\
        \ eDIS account."
      operationId: "getAddressPreferences"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetAddressPreferenceListResponses"
        "400":
          description: "Bad Request"
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                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/scope/sell.edelivery"
    post:
      tags:
      - "address_preference"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to create an address\
        \ on your eDIS account.<br><br>The following types of addresses can be created\
        \ through this method:<ul><li><code>SHIP_FROM_ADDRESS</code></li><li><code>RETURN_ADDRESS</code></li></ul>The\
        \ address information for the address, including location details, contact\
        \ information, and address type, must be provided in the <b>shipFromAddress</b>\
        \ container. If the call is successful, the <b>addressId</b> for the newly\
        \ created address will be returned. This identifier can then be used when\
        \ creating a package to specify the address to use for the shipment."
      operationId: "createAddressPreference"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateAddressPreferenceRequest"
        required: false
      responses:
        "201":
          description: "Created"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateAddressPreferenceResponses"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355073:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Invalid input value for province. Please revise it."
              355072:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Invalid input value for countrycode. Please revise it."
              355075:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Invalid input value for district. Please revise it."
              355074:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Invalid input value for city. Please revise it."
              355002:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Length of street can not be greater than 50. Please\
                  \ revise it."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355049:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "Connection failed with logistic service provider system.\
                  \ Please wait and retry."
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
        "404":
          description: "Not found"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /agents:
    get:
      tags:
      - "agents"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to retrieve information\
        \ about the EU Authorized Representative (AR) agent(s) associated with a seller's\
        \ eDIS account.<br><br>An EU AR agent acts as a liaison between non-EU manufacturers\
        \ and European regulatory authorities to ensure compliance with EU regulations.\
        \ This method returns contact information about each agent, as well as their\
        \ eBay ID and the countries that they support."
      operationId: "getAgents"
      parameters:
      - name: "limit"
        in: "query"
        description: "This query parameter sets the maximum number of agents to return\
          \ on each page of the paginated response.<br><br>Use this parameter in conjunction\
          \ with the <b>offset</b> parameter to control the pagination of the output.\
          \ For example, if <b>offset</b> is set to <code>10</code> and <b>limit</b>\
          \ is set to <code>10</code>, the call retrieves orders 11 through 20 from\
          \ the result set.<br><br><b>Max</b>: <code>200</code><br><br><b>Default</b>:\
          \ <code>50</code>"
        required: false
        schema:
          type: "string"
      - name: "offset"
        in: "query"
        description: "This query parameter specifies the number of agents to skip\
          \ in the result set before returning the first agent in the paginated response.<br><br>Combine\
          \ <b>offset</b> with the <b>limit</b> query parameter to control the items\
          \ returned in the response. For example, if you supply an <b>offset</b>\
          \ of <code>0</code> and a <b>limit</b> of <code>10</code>, the first page\
          \ of the response contains the first 10 items from the complete list of\
          \ items retrieved by the call.<br><br><b>Default</b>: <code>0</code>"
        required: false
        schema:
          type: "string"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetAgentListResponses"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355076:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Invalid input value of pagination parameters. Please\
                  \ revise them."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                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/scope/sell.edelivery"
  /battery_qualifications:
    get:
      tags:
      - "battery_qualifications"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method is used to retrieve all battery qualifications\
        \ associated with your eDIS account. This includes the type, electronic qualification\
        \ ID and name, and expiration date for each battery."
      operationId: "getBatteryQualifications"
      parameters:
      - name: "limit"
        in: "query"
        description: "This query parameter sets the maximum number of qualifications\
          \ to return on each page of the paginated response.<br><br>Use this parameter\
          \ in conjunction with the <b>offset</b> parameter to control the pagination\
          \ of the output. For example, if <b>offset</b> is set to <code>10</code>\
          \ and <b>limit</b> is set to <code>10</code>, the call retrieves orders\
          \ 11 through 20 from the result set.<br><br><b>Max</b>: <code>200</code><br><br><b>Default</b>:\
          \ <code>50</code>"
        required: false
        schema:
          type: "string"
      - name: "offset"
        in: "query"
        description: "This query parameter specifies the number of qualifications\
          \ to skip in the result set before returning the first qualification in\
          \ the paginated response.<br><br>Combine <b>offset</b> with the <b>limit</b>\
          \ query parameter to control the items returned in the response. For example,\
          \ if you supply an <b>offset</b> of <code>0</code> and a <b>limit</b> of\
          \ <code>10</code>, the first page of the response contains the first 10\
          \ items from the complete list of items retrieved by the call.<br><br><b>Default</b>:\
          \ <code>0</code>"
        required: false
        schema:
          type: "string"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetBatteryQualListResponses"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355076:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Invalid input value of pagination parameters. Please\
                  \ revise them."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                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/scope/sell.edelivery"
  /bundle/{bundle_id}/cancel:
    post:
      tags:
      - "bundle"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method is used to cancel a bundle.<br><br>The\
        \ <b>bundleId</b> value of the bundle to be canceled must be input as a path\
        \ parameter in the request. <br><br><span class=\"tablenote\"><b>Note:</b>\
        \ Bundles cannot be canceled if they are currently being processed.</span>"
      operationId: "cancelBundle"
      parameters:
      - name: "bundle_id"
        in: "path"
        description: "This path parameter specifies the unique identifier of the bundle\
          \ being canceled.<br><br>This ID value is returned when creating a bundle\
          \ through the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/bundle/methods/createBundle\"\
          \ target=\"_blank\">createBundle</a> method."
        required: true
        schema:
          type: "string"
      responses:
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355083:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Missing or invalid bundle_id value."
              355082:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "No permission to access requested data."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "204":
          description: "No Content"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /bundle:
    post:
      tags:
      - "bundle"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method is used to create a bundle for multiple\
        \ packages in an order.<br><br>To create a bundle, the consign address to\
        \ be associated with the bundle and the tracking numbers of the packages to\
        \ be used in the bundle must be specified in the request. <br><br>If the call\
        \ is successful, the <b>bundleId</b> for the newly created bundle will be\
        \ returned.<br><br><span class=\"tablenote\"><b>Note:</b> Sellers should keep\
        \ track of the returned <b>bundleId</b>, as there is no programmatic way to\
        \ retrieve this value at this time.</span>"
      operationId: "createBundle"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateBundleRequest"
        required: false
      responses:
        "201":
          description: "Created"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateBundleResponse"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355079:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Missing tracking numbers. Please check."
              355078:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Missing consign preference ID. Please check."
              355081:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Total weight exceeded. Please check."
              355080:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Please choose packages with same consign preference\
                  \ option."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                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/scope/sell.edelivery"
  /bundle/{bundle_id}:
    get:
      tags:
      - "bundle"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method is used to retrieved information\
        \ about a specific bundle based on the provided bundle ID value.<br><br>The\
        \ <b>bundle_id</b> value of the bundle to be retrieved must be input as a\
        \ path parameter in the request. If the call is successful, information about\
        \ the bundle is returned, such as its associated consign preference ID and\
        \ the tracking numbers of each package in the bundle."
      operationId: "getBundle"
      parameters:
      - name: "bundle_id"
        in: "path"
        description: "This path parameter specifies the unique identifier of the bundle\
          \ being retrieved.<br><br>This ID value is returned when creating a bundle\
          \ through the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/bundle/methods/createBundle\"\
          \ target=\"_blank\">createBundle</a> method."
        required: true
        schema:
          type: "string"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BundleDetailResponse"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355083:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Missing or invalid bundle_id value."
              355082:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "No permission to access requested data."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /bundle/{bundle_id}/label:
    get:
      tags:
      - "bundle"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to retrieve the bundle\
        \ label for a bundle of packages.<br><br>The bundle for which to retrieve\
        \ a bundle label is specified through the <b>bundleId</b> path parameter.<br><br>Bundle\
        \ labels will be returned as base64 string values which can be converted to\
        \ PDF files."
      operationId: "getBundleLabel"
      parameters:
      - name: "bundle_id"
        in: "path"
        description: "This path parameter specifies the unique identifier of the bundle\
          \ for which to retrieve a label.<br><br>This ID value is returned when creating\
          \ a bundle through the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/bundle/methods/createBundle\"\
          \ target=\"_blank\">createBundle</a> method."
        required: true
        schema:
          type: "string"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BundleLabelResponse"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355083:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Missing or invalid bundle_id value."
              355082:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "No permission to access requested data."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /complaint:
    post:
      tags:
      - "complaint"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to create a complaint\
        \ about a shipment order. Complaints can be filed if there is a pickup delay\
        \ on an order or if an item has been lost in transit.<br><br>The complaint\
        \ reason, complaint type, and the date the issue occurred must be specified\
        \ in the request. If the complaint is being filed for a missing package, the\
        \ affected <b>packageId</b> values must also be specified in the <b>affectedPackages</b>\
        \ array.<br><br>If the call was successful, HTTP status code <b>201 Created</b>\
        \ will be returned, and the complaint will be created."
      operationId: "createComplaint"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AddComplaintRequest"
        required: false
      responses:
        "201":
          description: "Created"
          content:
            application/json:
              schema:
                type: "object"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355060:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Complaint submission is declined on logistic service\
                  \ provider side. Please contact customer service for help."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /consign_preference:
    get:
      tags:
      - "consign_preference"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to retrieve information\
        \ about all the pickup, drop-off, and/or forward deployment consign addresses\
        \ associated with a seller's eDIS account."
      operationId: "getConsignPreferences"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetConsignPreferenceListResponses"
        "400":
          description: "Bad Request"
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
    post:
      tags:
      - "consign_preference"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to create a consign address.<br><br>The\
        \ following types of address preferences can be created via this method:<ul><li><code>PICK_UP</code></li><li><code>DROP_OFF</code></li><li><code>FORWARD_DEPLOYMENT</code></li><li><code>RDC</code></li><li><code>CN_POST_DROP_OFF</code></li><li><code>CN_POST_PICK_UP</code></li><li><code>HK_POST_DROP_OFF</code></ul>The\
        \ address information for the consign address must be provided in the <b>consignAddress</b>\
        \ container. If the call is successful, the <b>addressId</b> for the newly\
        \ created address will be returned. This ID can then be used when creating\
        \ a package to specify the consign address to use for the shipment."
      operationId: "createConsignPreference"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateConsignPreferenceRequest"
        required: false
      responses:
        "201":
          description: "Created"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateConsignPreferenceResponses"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355057:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Missing address ID of dropoff site. Please check."
              355056:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Missing request period. Please check."
              355058:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Shipping preference name already exists. Please add\
                  \ a new name."
              355053:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Connection failed with backend service. Please wait\
                  \ and retry."
              355055:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Missing package address. Please check."
              355051:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "pickupTime is missing. Please check."
              355050:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Invalid value for type. Please check the document."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /dropoff_sites:
    get:
      tags:
      - "dropoff_sites"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to retrieve metadata\
        \ for one or more drop-off sites associated with a seller's eDIS account.<br><br>Pagination\
        \ query parameters are provided that allow users to control how many drop-off\
        \ site locations are returned in the response."
      operationId: "getDropoffSites"
      parameters:
      - name: "limit"
        in: "query"
        description: "This query parameter sets the maximum number of drop-off site\
          \ locations to return on each page of the paginated response.<br><br>Use\
          \ this parameter in conjunction with the <b>offset</b> parameter to control\
          \ the pagination of the output. For example, if <b>offset</b> is set to\
          \ <code>10</code> and <b>limit</b> is set to <code>10</code>, the call retrieves\
          \ orders 11 through 20 from the result set.<br><br><b>Max</b>: <code>200</code><br><br><b>Default</b>:\
          \ <code>50</code>"
        required: false
        schema:
          type: "string"
      - name: "offset"
        in: "query"
        description: "This query parameter specifies the number of drop-off site locations\
          \ to skip in the result set before returning the first location in the paginated\
          \ response.<br><br>Combine <b>offset</b> with the <b>limit</b> query parameter\
          \ to control the items returned in the response. For example, if you supply\
          \ an <b>offset</b> of <code>0</code> and a <b>limit</b> of <code>10</code>,\
          \ the first page of the response contains the first 10 items from the complete\
          \ list of items retrieved by the call.<br><br><b>Default</b>: <code>0</code>"
        required: false
        schema:
          type: "string"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetDropoffSiteListResponses"
        "400":
          description: "Bad Request"
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /handover_sheet:
    get:
      tags:
      - "handover_sheet"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to retrieve the handover\
        \ sheet for one or more packages in a pickup request.<br><br>The tracking\
        \ numbers for the packages for which to retrieve handover sheets are specified\
        \ through the <b>tracking_numbers</b> query parameter.<br><br>The retrieved\
        \ handover sheet will be returned as a base64 string value, and can be used\
        \ for confirmation with a pickup contact. Only one handover sheet will be\
        \ returned for the specified packages."
      operationId: "getHandoverSheet"
      parameters:
      - name: "tracking_numbers"
        in: "query"
        description: "This query parameter specifies an array of tracking numbers\
          \ for the packages for which to retrieve a handover sheet.<br><br>Tracking\
          \ numbers are returned when creating packages through the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage\"\
          \ target=\"_blank\">createPackage</a> method.<br><br>Up to 200 tracking\
          \ numbers can be provided. Multiple tracking numbers can be input as individual\
          \ query parameters. For example,<br><br><code>tracking_numbers=E***********************N&tracking_numbers=E***********************Q</code>"
        required: true
        schema:
          type: "string"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetHandoverSheetResponses"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355068:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The specified tracking number {tracking_number} is not\
                  \ recognized. Please check and try again."
              355067:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The field tracking_numbers is required."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "404":
          description: "Not found"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /labels:
    get:
      tags:
      - "labels"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to retrieve shipping\
        \ labels for the one or more specified packages.<br><br>The packages for which\
        \ to retrieve shipping labels can be specified through the <b>tracking_numbers</b>\
        \ query parameter. The page size and print preference settings for the shipping\
        \ label(s) can also be specified through the query parameters.<br><br>Shipping\
        \ labels are returned as base64 string values which can be converted to PDF\
        \ files. A separate file will be returned for each tracking number specified\
        \ in the request."
      operationId: "getLabels"
      parameters:
      - name: "page_size"
        in: "query"
        description: "This query parameter specifies the page size of the retrieved\
          \ shipping labels.<br><br><b>Valid values</b>:<ul><li><code>A4</code></li><li><code>THERMAL_PAPER</code></li></ul>"
        required: false
        schema:
          type: "string"
      - name: "print_preference"
        in: "query"
        description: "This query parameter specifies one or more printing preferences\
          \ to be set when retrieving shipping labels. Multiple values can be delimited\
          \ by a comma.<br><br><b>Valid values</b>:<ul><li><code>nameZh</code></li><li><code>nameEn</code></li><li><code>remark</code></li><li><code>skuPrice</code></li><li><code>skuNo</code></li><li><code>quantity</code></li><li><code>listingId</code></li><li><code>sellerId</code></li><li><code>buyerId</code></li></ul>"
        required: false
        schema:
          type: "string"
      - name: "tracking_numbers"
        in: "query"
        description: "This query parameter specifies an array of tracking numbers\
          \ of the packages for which to retrieve shipping labels.<br><br>Tracking\
          \ numbers are returned when creating packages through the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage\"\
          \ target=\"_blank\">createPackage</a> method.<br><br>Up to 200 tracking\
          \ numbers can be provided. Multiple tracking numbers can be input as individual\
          \ query parameters.For example,<br><br><code>tracking_numbers=E***********************N&tracking_numbers=E***********************Q</code>"
        required: true
        schema:
          type: "string"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetLabelListResponses"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355077:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Invalid input value for page setting parameters. Please\
                  \ revise it."
              355004:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The specified tracking number {tracking_number} is not\
                  \ recognized. Please check and try again."
              355071:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The specified tracking number {tracking_number} does\
                  \ not belong to the seller, so cannot be retrieved."
              355067:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The field tracking_numbers is required."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "401":
          description: "Unauthorized"
        "404":
          description: "Not found"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /package/bulk_cancel_packages:
    post:
      tags:
      - "package"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to cancel multiple packages\
        \ and their associated tracking numbers.<br><br>The package ID values for\
        \ the packages to be canceled must be input in the <b>packageIds</b> array\
        \ of the request.<br><br><span class=\"tablenote\"><b>Note:</b> Packages cannot\
        \ be cancelled if they are currently being processed.</span> "
      operationId: "bulkCancelPackages"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CancelPackagesRequest"
        required: false
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CancelPackagesResponses"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355044:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Cancel failed on logistic service provider side. Please\
                  \ contact logistic customer service for help."
              355042:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The package cannot be cancelled due to its current status.\
                  \ Please check status and try again."
              355037:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Invalid packageId {packageId}. Please verify and try\
                  \ again."
              355004:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The specified packageId {packageId} is not recognized.\
                  \ Please check and try again."
              355036:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Package processing. Please try again later."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "401":
          description: "Unauthorized"
        "404":
          description: "Not found"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /package/bulk_confirm_packages:
    post:
      tags:
      - "package"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to confirm the shipping\
        \ order for multiple packages.<br><br>The package ID values for the packages\
        \ to be confirmed must be input in the <b>packageIds</b> array of the request.<br><br>After\
        \ a package is confirmed, the estimated cost will be frozen in your wallet\
        \ and the pickup request will be submitted."
      operationId: "bulkConfirmPackages"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ConfirmPackagesRequest"
        required: false
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConfirmPackagesResponses"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355040:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The package cannot be confirmed due to missing or invalid\
                  \ tracking number. Please add tracking number for package and try\
                  \ again."
              355037:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Unrecognized packageId. Please check."
              355004:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The specified packageId {packageId} is not recognized.\
                  \ Please check and try again."
              355036:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Package processing. Please try again later."
              355039:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The package cannot be confirmed due to missing or invalid\
                  \ battery qualification. Please update battery qualification and\
                  \ try again."
              355038:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The package cannot be confirmed due to its current status.\
                  \ Please check the status and try again."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
        "404":
          description: "Not found"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /package/bulk_delete_packages:
    post:
      tags:
      - "package"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to delete multiple packages.<br><br>The\
        \ package ID values for the packages to be deleted must be input in the <b>packageIds</b>\
        \ array of the request.<br><br><span class=\"tablenote\"><b>Note:</b> Packages\
        \ can only be deleted once they have been cancelled through the <b>cancelPackage</b>\
        \ or <b>bulkCancelPackages</b> methods and no longer have a tracking number\
        \ associated with them.</span>"
      operationId: "bulkDeletePackages"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeletePackagesRequest"
        required: false
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DeletePackagesResponses"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355004:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The specified packageId {packageId} is not recognized.\
                  \ Please check and try again."
              355064:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The package cannot be deleted due to its current status.\
                  \ Please check the status and try again."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
        "404":
          description: "Not found"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /package/{package_id}/cancel:
    post:
      tags:
      - "package"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to cancel a package and\
        \ its associated tracking number.<br><br>The <b>packageId</b> value of the\
        \ package to be canceled must be input as a path parameter in the request.<br><br><span\
        \ class=\"tablenote\"><b>Note:</b> Packages cannot be canceled if they are\
        \ currently being processed.</span>"
      operationId: "cancelPackage"
      parameters:
      - name: "package_id"
        in: "path"
        description: "This path parameter specifies the unique identifier of the package\
          \ being canceled.<br><br>This ID value is returned when creating a package\
          \ through the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage\"\
          \ target=\"_blank\">createPackage</a> method."
        required: true
        schema:
          type: "string"
      responses:
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355044:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Cancel failed on logistic service provider side. Please\
                  \ contact logistic customer service for help."
              355042:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The package cannot be cancelled due to its current status.\
                  \ Please check status and try again."
              355037:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Invalid packageId {packageId}. Please verify and try\
                  \ again."
              355004:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The specified packageId {packageId} is not recognized.\
                  \ Please check and try again."
              355036:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Package processing. Please try again later."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "401":
          description: "Unauthorized"
        "204":
          description: "No Content"
        "404":
          description: "Not found"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /package/{package_id}/clone:
    post:
      tags:
      - "package"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to clone a package for\
        \ redelivery, resending the package with the same information input during\
        \ the <b>createPackage</b> call.<br><br>The <b>packageId</b> value of the\
        \ package to be cloned must be input as a path parameter in the request."
      operationId: "clonePackage"
      parameters:
      - name: "package_id"
        in: "path"
        description: "This path parameter specifies the <b>packageId</b> value of\
          \ the package to be cloned.<br><br>This ID value is returned when creating\
          \ a package through the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage\"\
          \ target=\"_blank\">createPackage</a> method."
        required: true
        schema:
          type: "string"
      responses:
        "201":
          description: "Created"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ClonePackageResponses"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355045:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Current package status does not support re-ship function.\
                  \ Please check."
              355046:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "This package have exceeded the limit of re-ship times."
              355004:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The specified packageId {packageId} is not recognized.\
                  \ Please check and try again."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "401":
          description: "Unauthorized"
        "404":
          description: "Not found"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /package/{package_id}/confirm:
    post:
      tags:
      - "package"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to confirm the shipping\
        \ order for a package.<br><br>The <b>packageId</b> value of the package to\
        \ be confirmed must be input as a path parameter in the request.<br><br>After\
        \ confirmation the estimated cost will be frozen in your wallet and the pickup\
        \ request will be submitted."
      operationId: "confirmPackage"
      parameters:
      - name: "package_id"
        in: "path"
        description: "This path parameter specifies the unique identifier of the package\
          \ you wish to be confirmed.<br><br>This ID value is returned when creating\
          \ a package through the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage\"\
          \ target=\"_blank\">createPackage</a> method."
        required: true
        schema:
          type: "string"
      responses:
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355041:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Package processing. Please try again later."
              355040:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The package cannot be confirmed due to missing or invalid\
                  \ tracking number. Please add tracking number for package and try\
                  \ again."
              355037:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Unrecognized packageId. Please check."
              355004:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The specified packageId {packageId} is not recognized.\
                  \ Please check and try again."
              355036:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Package processing. Please try again later."
              355039:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The package cannot be confirmed due to missing or invalid\
                  \ battery qualification. Please update battery qualification and\
                  \ try again."
              355038:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The package cannot be confirmed due to its current status.\
                  \ Please check the status and try again."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "204":
          description: "No Content"
        "404":
          description: "Not found"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /package:
    post:
      tags:
      - "package"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to create a package for\
        \ an order.<br><br>To create a package, the package's shipping information,\
        \ such as the dimensions, weight, ship from, and ship to address, as well\
        \ as information about the item(s) it contains must be specified in the request.<br><br>If\
        \ the call is successful, the <b>packageId</b> and tracking number for the\
        \ newly created package will be returned.<br><br><span class=\"tablenote\"\
        ><b>Note:</b> Sellers should keep track of the returned <b>packageId</b>,\
        \ as there is no programmatic way to retrieve this value at this time.</span>"
      operationId: "createPackage"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AddPackageRequest"
        required: false
      responses:
        "201":
          description: "Created"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AddPackageResponses"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355013:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The fdcSkus array cannot be empty. Please include this\
                  \ array and add at least one sku and associated quantity for that\
                  \ sku."
              355012:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "ServiceId does not exist. Please check the document."
              355015:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Each sku under fdcSkus array requires skuId and quantity.\
                  \ Please revise them."
              355014:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "You have exceeded the maximum amount of skus allowed\
                  \ under the fdcSkus array."
              355009:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Order not synced to system yet. Please wait and retry."
              355008:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "OrderLineItem is not matched to your ebayID. Please\
                  \ check."
              355011:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Order has not been paid. Please check."
              355021:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The status of elecQualificationId is not avaliable.\
                  \ Please check."
              355020:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Your elecQualificationId does not exist. Please check\
                  \ your qualification list.\t"
              355023:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "LiBatteryType is not matched to battery qualification."
              355022:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Your elecQualificationId is expired. Please update a\
                  \ new one."
              355017:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Length of skuId can not be greater than 50. Please revise\
                  \ it."
              355016:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The skus array has one or more duplicate skuId values.\
                  \ Please remove duplicate skus."
              355019:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "User T&C update. Please sign the updated version of\
                  \ the Letter of Commitment for Lithium Battery items."
              355018:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The SPECIAL_GOODS_WITH_NO_BATTERY enum value is only\
                  \ allowed when miniPackage is specified as the packagingType value."
              355063:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "AgentName or agentAddress is missing. Please revise\
                  \ them."
              355031:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Account balance is not enough to pay for the package.\
                  \ Please add sufficient funds to balance and try again."
              355030:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The seller's balance could not be accessed to to pay\
                  \ for the package. Please contact logistics customer service for\
                  \ help."
              355025:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "ServiceId not available. Please revise it and retry."
              355024:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "No available shipping service found. Please revise package\
                  \ information and retry."
              355026:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Package is now under processing. Please retry later."
              355005:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "OrderLineItem {orderLineItemId} has already been assigned\
                  \ to another package, so cannot be added to this one."
              355003:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Our current system setting is not allowing you to add\
                  \ packages via API. Please change your settings to ‘ship via API’\
                  \ and try again."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
              355066:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "Concurrent actions on same orderLineItem. Please wait\
                  \ and retry."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /package/{package_id}:
    get:
      tags:
      - "package"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to retrieve a package\
        \ based on the provided package ID value.<br><br>The <b>packageId</b> value\
        \ of the package to be retrieved must be input as a path parameter in the\
        \ request. If the call is successful, information about the package is returned,\
        \ such as the package's shipping information (its dimensions, weight, ship\
        \ from, and ship to address) and information about the item(s) it contains."
      operationId: "getPackage"
      parameters:
      - name: "package_id"
        in: "path"
        description: "This path parameter specifies the unique identifier of the package\
          \ being retrieved.<br><br>This ID value is returned when creating a package\
          \ through the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage\"\
          \ target=\"_blank\">createPackage</a> method."
        required: true
        schema:
          type: "string"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetPackageDetailResponses"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355004:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The specified packageId {packageId} is not recognized.\
                  \ Please check and try again."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
        "404":
          description: "Not found"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
    delete:
      tags:
      - "package"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to delete a package.<br><br>The\
        \ <b>packageId</b> value of the package to be deleted must be input as a path\
        \ parameter in the request. If the call is successful, HTTP status code <b>204\
        \ No Content</b> will be returned, and the package will be deleted.<br><br><span\
        \ class=\"tablenote\"><b>Note:</b> Packages can only be deleted once they\
        \ have been cancelled through the <b>cancelPackage</b> or <b>bulkCancelPackages</b>\
        \ methods and no longer have a tracking number associated with them.</span>"
      operationId: "deletePackage"
      parameters:
      - name: "package_id"
        in: "path"
        description: "This path parameter specifies the unique identifier of the package\
          \ being deleted. This package must already be cancelled and have no tracking\
          \ number associated with it.<br><br>This ID value is returned when creating\
          \ a package through the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage\"\
          \ target=\"_blank\">createPackage</a> method."
        required: true
        schema:
          type: "string"
      responses:
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355004:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The specified packageId {packageId} is not recognized.\
                  \ Please check and try again."
              355064:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The package cannot be deleted due to its current status.\
                  \ Please check the status and try again."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
        "204":
          description: "No Content"
        "404":
          description: "Not found"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /package/{order_line_item_id}/item:
    get:
      tags:
      - "package"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to retrieve one or more\
        \ packages based on the provided order line item ID.<br><br>This method can\
        \ be followed up with <a href=\"/api-docs/sell/edelivery_international_shipping/resources/package/methods/getPackage\"\
        \ target=\"_blank\">getPackage</a> call to retrieve more detailed information\
        \ about a specific package."
      operationId: "getPackagesByLineItemID"
      parameters:
      - name: "order_line_item_id"
        in: "path"
        description: "This path parameter can be used to specify the unique identifier\
          \ of the line item that is part of the package being retrieved.<br><br>This\
          \ value is returned in the <b>lineItemId</b> field of the <a href=\"/api-docs/sell/fulfillment/resources/order/methods/getOrders\"\
          \ target=\"_blank\">getOrders</a> method of the <b>Fulfillment API</b> or\
          \ the <a href=\"/devzone/xml/docs/reference/ebay/GetOrders.html\" target=\"\
          _blank\">GetOrders</a> method of the <b>Trading API</b>."
        required: true
        schema:
          type: "string"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetItemPackageIdResponses"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355062:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Invalid orderLineItemId {orderLineitemId}. Please verify\
                  \ and try again."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
        "404":
          description: "Not found"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /services:
    get:
      tags:
      - "services"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to retrieve metadata\
        \ on available shipping services, such as the name, description, and directions."
      operationId: "getServices"
      parameters:
      - name: "limit"
        in: "query"
        description: "This query parameter sets the maximum number of shipping services\
          \ to return on each page of the paginated response.<br><br>Use this parameter\
          \ in conjunction with the <b>offset</b> parameter to control the pagination\
          \ of the output. For example, if <b>offset</b> is set to <code>10</code>\
          \ and <b>limit</b> is set to <code>10</code>, the call retrieves orders\
          \ 11 through 20 from the result set.<br><br><b>Max</b>: <code>200</code><br><br><b>Default</b>:\
          \ <code>50</code>"
        required: false
        schema:
          type: "string"
      - name: "offset"
        in: "query"
        description: "This query parameter specifies the number of shipping services\
          \ to skip in the result set before returning the first shipping service\
          \ in the paginated response.<br><br>Combine <b>offset</b> with the <b>limit</b>\
          \ query parameter to control the items returned in the response. For example,\
          \ if you supply an <b>offset</b> of <code>0</code> and a <b>limit</b> of\
          \ <code>10</code>, the first page of the response contains the first 10\
          \ items from the complete list of items retrieved by the call.<br><br><b>Default</b>:\
          \ <code>0</code>"
        required: false
        schema:
          type: "string"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetServiceListResponses"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355076:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "Invalid input value of pagination parameters. Please\
                  \ revise them."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "404":
          description: "Not found"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
  /tracking:
    get:
      tags:
      - "tracking"
      description: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
        \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
        \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
        color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
        \ This method is only available for Greater-China based sellers with an active\
        \ eDIS account.</p></div><br>This method can be used to retrieve tracking\
        \ event details for a package associated with the provided tracking number.<br><br>Each\
        \ tracking event is returned in the <b>trackingDetails</b> array and includes\
        \ the description, location, time, and status of the event."
      operationId: "getTracking"
      parameters:
      - name: "tracking_number"
        in: "query"
        description: "This query parameter specifies the tracking number for which\
          \ to retrieve current tracking event details.<br><br>This value is returned\
          \ when creating a package through the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage\"\
          \ target=\"_blank\">createPackage</a> method."
        required: true
        schema:
          type: "string"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetTrackingDetailResponses"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              355004:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The specified tracking number {tracking_number} is not\
                  \ recognized. Please check and try again."
        "401":
          description: "Unauthorized"
          x-response-codes:
            errors:
              355400:
                domain: "API_EDIS"
                category: "REQUEST"
                description: "The access token provided in the Authorization header\
                  \ is not for an eBay user account that is currently allowed to call\
                  \ this API. Please go to account settings to add to your account\
                  \ list."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              355000:
                domain: "API_EDIS"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "404":
          description: "Not found"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/scope/sell.edelivery"
components:
  schemas:
    AddComplaintRequest:
      type: "object"
      properties:
        complaintRequest:
          description: "This container is used to specify the information included\
            \ in a complaint request, such as the complaint reason, date, and type."
          $ref: "#/components/schemas/AddComplaintRequestData"
      description: "This type is used to define the request container of the <b>createComplaint</b>\
        \ method."
    AddComplaintRequestData:
      type: "object"
      properties:
        affectedPackages:
          type: "array"
          description: "This array specifies a list of packages, specified by their\
            \ <b>packageId</b>, affected by the issue causing the complaint.<br><br>Package\
            \ ID values are returned when creating a package through the <a href=\"\
            /api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage\"\
            \ target=\"_blank\">createPackage</a> method<br><br>This array is required\
            \ if the complaint being filed is for a missing package."
          items:
            type: "string"
        complaintDate:
          type: "string"
          description: "The date in which the issue associated with the complaint\
            \ occurred.<br><br><b>Format:</b> <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code> "
        complaintReason:
          type: "string"
          description: "This string specifies the reason the complaint was filed.<br><br><b>Max\
            \ length</b>: 200 characters"
        complaintType:
          type: "string"
          description: "The type of complaint being filed.<br><br><b>Valid values</b>:<ul><li><code>ABNORMAL_COLLECTION_COMPLAINT</code></li><li><code>LOST_PACKAGE_COMPLAINT</code></li></ul>\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:ComplaintTypeEnum'>eBay\
            \ API documentation</a>"
        preferenceId:
          type: "integer"
          description: "The unique identifier of the address associated with the complaint.<br><br>This\
            \ field is required if the complain being filed is associated with a specific\
            \ address."
          format: "int32"
        remark:
          type: "string"
          description: "A remark to the seller themselves."
      description: "This type specifies the information included in a complaint request."
    AddPackageRequest:
      type: "object"
      properties:
        packageInfo:
          description: "This container is used to specify the information needed to\
            \ create a package."
          $ref: "#/components/schemas/PackageInfoRequest"
      description: "This type defines the request container used in the <b>createPackage</b>\
        \ method."
    AddPackageResponses:
      type: "object"
      properties:
        createPackageResult:
          description: "This container returns information about the newly created\
            \ package, including its tracking number and <b>packageId</b> value."
          $ref: "#/components/schemas/AddPackageResponsesData"
      description: "This type defines the response container used in the <b>createPackage</b>\
        \ method."
    AddPackageResponsesData:
      type: "object"
      properties:
        estimateCost:
          description: "The estimated shipping cost of the package."
          $ref: "#/components/schemas/Amount"
        lastMileTrackingNumber:
          type: "string"
          description: "The last-mile tracking number of the package.<br><br>This\
            \ field is only returned if the last-mile tracking number is provided\
            \ by the carrier."
        packageId:
          type: "string"
          description: "The unique identifier of the created package.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> Sellers should keep track of the returned\
            \ <b>packageId</b>, as there is no programmatic way to retrieve this value\
            \ at this time.</span>"
        paymentCost:
          description: "The actual payment cost of the package."
          $ref: "#/components/schemas/Amount"
        trackingNumber:
          type: "string"
          description: "The tracking number of the created package."
      description: "This type specifies information about the newly created package,\
        \ such as its estimated costs, tracking number, and package ID value."
    AgentInfoData:
      type: "object"
      properties:
        agentAddress:
          type: "string"
          description: "The address of the EU AR agent."
        agentName:
          type: "string"
          description: "The name of the EU AR agent."
        agentPhone:
          type: "string"
          description: "The phone number of the EU AR agent."
      description: "This type defines information about an EU AR agent, such as their\
        \ address, name, and phone number."
    AgentModelResponses:
      type: "object"
      properties:
        agentAddress:
          type: "string"
          description: "The address of the EU AR agent."
        agentName:
          type: "string"
          description: "The name of the EU AR agent."
        agentPhone:
          type: "string"
          description: "The phone number of the EU AR agent."
        agentPreferences:
          type: "array"
          description: "This array returns the supported shipping countries and eBay\
            \ user IDs associated with the EU AR agent."
          items:
            $ref: "#/components/schemas/AgentPreferenceListResponse"
        arName:
          type: "string"
          description: "The seller-defined setting name of the AR agent."
      description: "This type defines the fields that describe an EU AR agent."
    AgentPreferenceListResponse:
      type: "object"
      properties:
        ebayId:
          type: "string"
          description: "The eBay ID of the EU AR agent."
        shippingCountry:
          type: "string"
          description: "The two-letter ISO 3166 code of the shipping country that\
            \ an EU AR agent supports."
      description: "This type defines the fields that describe a EU AR agents preferences."
    Amount:
      type: "object"
      properties:
        currency:
          type: "string"
          description: "This enum value represents the type of currency being used.\
            \ Both the <b>value</b> and <b>currency fields</b> are required/always\
            \ returned when expressing cost.<br><br> See the <a href=\"/api-docs/sell/edelivery_international_shipping/types/bas:CurrencyCodeEnum\"\
            \ target=\"_blank\">CurrencyCodeEnum</a> type for the full list of supported\
            \ values.<br><br>Both the <b>value</b> and <b>currency</b> fields are\
            \ required/always returned when expressing cost. For implementation help,\
            \ refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/bas:CurrencyCodeEnum'>eBay\
            \ API documentation</a>"
        value:
          type: "string"
          description: "The monetary amount, in the currency specified by the <b>currency</b>\
            \ field.<br><br>Both the <b>value</b> and <b>currency</b> fields are required/always\
            \ returned when expressing cost."
      description: "This type defines the monetary value of an amount. "
    BatteryQualResponses:
      type: "object"
      properties:
        batteryType:
          type: "string"
          description: "The type of the battery. For implementation help, refer to\
            \ <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:LiBatteryTypeEnum'>eBay\
            \ API documentation</a>"
        elecQualificationId:
          type: "string"
          description: "The unique identifier of the battery's electric qualification,\
            \ which indicates that the battery has a certificate of approval for global\
            \ shipping."
        elecQualificationName:
          type: "string"
          description: "The name of the battery's electric qualification."
        expireDate:
          type: "string"
          description: "The expiration date of the battery qualification."
        remark:
          type: "string"
          description: "A remark to the seller themselves.<br><br><span class=\"tablenote\"\
            ><b>Note:</b> This field is always returned, but will show as null or\
            \ have an empty value if not defined/applicable.</span>"
      description: "This type defines the fields to describe a battery's qualifications."
    BundleDetailResponse:
      type: "object"
      properties:
        bundleDetail:
          description: "This container returns information about the retrieved bundle,\
            \ such as its tracking numbers and consign preference ID."
          $ref: "#/components/schemas/BundleDetailResponseData"
      description: "This type defines the response payload of the <b>getBundle</b>\
        \ method."
    BundleDetailResponseData:
      type: "object"
      properties:
        consignPreferenceId:
          type: "string"
          description: "The unique identifier of the consign address associated with\
            \ the retrieved bundle."
        trackingNumbers:
          type: "array"
          description: "This array specifies the tracking numbers of the packages\
            \ included in the bundle."
          items:
            type: "string"
      description: "This type is used to specify information, such as the tracking\
        \ numbers and consign preference ID, of a bundle."
    BundleLabelResponse:
      type: "object"
      properties:
        label:
          description: "This container returns the bundle label information, such\
            \ as the base64 string value, for the specified bundle."
          $ref: "#/components/schemas/BundleLabelResponseData"
      description: "This type defines the response container of the <b>getBundleLabel</b>\
        \ method."
    BundleLabelResponseData:
      type: "object"
      properties:
        base64Str:
          type: "string"
          description: "The base 64 string value for the bundle label.<br><br>This\
            \ string value can be converted into a PDF file."
      description: "This type defines the base64 string value used to download a bundle\
        \ label PDF file."
    CancelPackagesRequest:
      type: "object"
      properties:
        requests:
          description: "This container is used to specify the package ID values for\
            \ the packages being canceled."
          $ref: "#/components/schemas/CancelPackagesRequestData"
      description: "This type defines the request container for the <b>bulkCancelPackages</b>\
        \ method."
    CancelPackagesRequestData:
      type: "object"
      properties:
        packageIds:
          type: "array"
          description: "This comma-delimited array lists the unique identifiers of\
            \ the packages being canceled.<br><br>Up to 200 package IDs can be specified."
          items:
            type: "string"
      description: "This type indicates the IDs of the packages being canceled."
    CancelPackagesResponses:
      type: "object"
      properties:
        responses:
          type: "array"
          description: "This array returns the result code and message for each cancelled\
            \ package. Each package is denoted by its package ID value."
          items:
            $ref: "#/components/schemas/CancelPackagesResponsesData"
      description: "This type defines the response container of the <b>bulkCancelPackages</b>\
        \ method."
    CancelPackagesResponsesData:
      type: "object"
      properties:
        message:
          type: "string"
          description: "This string returns any additional information about the cancelation\
            \ of the package."
        packageId:
          type: "string"
          description: "The unique identifier of the canceled package."
        resultCode:
          type: "string"
          description: "The result code detailing the results cancelation process.<br><br>For\
            \ example, a result code of <code>200</code> indicates that the call was\
            \ a success and the package and tracking number were canceled."
      description: "This type indicates the response data returned after canceling\
        \ multiple packages."
    ClonePackageResponses:
      type: "object"
      properties:
        clonePackageResult:
          description: "This container returns the package ID, payment cost, and tracking\
            \ number for the cloned package."
          $ref: "#/components/schemas/ClonePackageResponsesData"
      description: "This type defines the response container used in the <b>clonePackage</b>\
        \ method."
    ClonePackageResponsesData:
      type: "object"
      properties:
        lastMileTrackingNumber:
          type: "string"
          description: "The last-mile tracking number of the package.<br><br>This\
            \ field is only returned if the last-mile tracking number is provided\
            \ by the carrier."
        packageId:
          type: "string"
          description: "The unique identifier of the package. A new <b>packageId</b>\
            \ value is generated when a package is cloned."
        paymentCost:
          description: "The payment cost for the package."
          $ref: "#/components/schemas/Amount"
        trackingNumber:
          type: "string"
          description: "The tracking number for the cloned package."
      description: "This type specifies the package ID, payment cost, tracking number,\
        \ and last-mile tracking number (if applicable) for the cloned package."
    ConfirmPackagesRequest:
      type: "object"
      properties:
        requests:
          description: "This container is used to specify the package ID values of\
            \ the packages being confirmed."
          $ref: "#/components/schemas/ConfirmPackagesRequestData"
      description: "This type defines the request container of the <b>bulkConfirmPackages</b>\
        \ method."
    ConfirmPackagesRequestData:
      type: "object"
      properties:
        packageIds:
          type: "array"
          description: "This comma-delimited array lists the unique identifiers of\
            \ the packages being confirmed.<br><br>Up to 200 packages can be specified."
          items:
            type: "string"
      description: "This type specifies the IDs of the packages being confirmed."
    ConfirmPackagesResponses:
      type: "object"
      properties:
        responses:
          type: "array"
          description: "This array returns the result code and message for each confirmed\
            \ package. Each package is denoted by its package ID value."
          items:
            $ref: "#/components/schemas/ConfirmPackagesResponsesData"
      description: "This type defines the response container of the <b>bulkConfirmPackages</b>\
        \ method."
    ConfirmPackagesResponsesData:
      type: "object"
      properties:
        message:
          type: "string"
          description: "This string returns any additional information about the confirmation\
            \ of the package."
        packageId:
          type: "string"
          description: "The unique identifier of the confirmed package."
        resultCode:
          type: "string"
          description: "The result code relating to the confirmation of the package.<br><br>For\
            \ example, a result code of <code>200</code> indicates that the call was\
            \ a success and the package was confirmed."
      description: "This type indicates the response data after confirming multiple\
        \ packages."
    ConsignPreferenceInfoResponses:
      type: "object"
      properties:
        consignPreferenceId:
          type: "string"
          description: "The unique identifier of the consign address."
        consignPreferenceName:
          type: "string"
          description: "The name of the consign address."
        dropoffSiteId:
          type: "string"
          description: "The unique identifier of the drop-off site.<br><br>This field\
            \ is only returned if the consign address is a drop-off location."
        pickupAddress:
          description: "This container returns the address and contact information\
            \ for a pickup address.<br><br><span class=\"tablenote\"><b>Note:</b>\
            \ This container is always returned, but will show as null or have an\
            \ empty value if not defined/applicable.</span>"
          $ref: "#/components/schemas/PickupAddressResponsesData"
        pickupTime:
          type: "string"
          description: "The supported pickup window that the pickup location supports.<br><br>This\
            \ field is only returned if the consign address is a pickup-from location\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:PickUpTimeTypeEnum'>eBay\
            \ API documentation</a>"
        type:
          type: "string"
          description: "The address type of the consign address.<br><br><b>Valid values</b>:<ul><li><code>PICK_UP</code></li><li><code>DROP_OFF</code></li><li><code>FORWARD_DEPLOYMENT</code></ul>\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:ConsignTypeEnum'>eBay\
            \ API documentation</a>"
      description: "This type specifies the fields used to create a consign address."
    CreateAddressPreferenceRequest:
      type: "object"
      properties:
        shipFromAddress:
          description: "This container is used to specify the address details used\
            \ to create an address."
          $ref: "#/components/schemas/CreateAddressPreferenceRequestData"
      description: "This type is used to define the request container used in the\
        \ <b>createAddressPreference</b> method."
    CreateAddressPreferenceRequestData:
      type: "object"
      properties:
        city:
          type: "string"
          description: "The city code of the address.<br><br>See <a href=\"https://www.edisebay.com/open/development-guide-detail?id=36\"\
            \ target=\"_blank\">商户API地址编码主数据</a> for valid city codes."
        company:
          type: "string"
          description: "The company name associated with the address.<br><br><b>Max\
            \ length</b>: 50 characters"
        contact:
          type: "string"
          description: "The name of the contact person associated with the address.<br><br><b>Max\
            \ length</b>: 50 characters"
        countryCode:
          type: "string"
          description: "The two-letter country code of the address.<br><br><b>Valid\
            \ values</b>:<ul><li>CN</li><li>HK</li></ul>"
        district:
          type: "string"
          description: "The district code of the address.<br><br>See <a href=\"https://www.edisebay.com/open/development-guide-detail?id=36\"\
            \ target=\"_blank\">商户API地址编码主数据</a> for valid district codes."
        name:
          type: "string"
          description: "The name of the address.<br><br><b>Max length</b>: 50 characters"
        phone:
          type: "string"
          description: "The phone number associated with the address."
        postcode:
          type: "string"
          description: "The postal code of the address."
        province:
          type: "string"
          description: "The province code of the address.<br><br>See <a href=\"https://www.edisebay.com/open/development-guide-detail?id=36\"\
            \ target=\"_blank\">商户API地址编码主数据</a> for valid province codes."
        street1:
          type: "string"
          description: "The first line of the street address of the address.<br><br><b>Max\
            \ length</b>: 50 characters"
        street2:
          type: "string"
          description: "The second line, if applicable, of the street address of the\
            \ address.<br><br><b>Max length</b>: 50 characters"
        street3:
          type: "string"
          description: "The third line, if applicable, of the street address of the\
            \ address.<br><br><b>Max length</b>: 50 characters"
        type:
          type: "string"
          description: "The address type of the address being created.<br><br><b>Valid\
            \ values</b>:<ul><li><code>SHIP_FROM_ADDRESS</code></li><li><code>RETURN_ADRESS</code></li></ul>\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:AddressTypeEnum'>eBay\
            \ API documentation</a>"
      description: "This type is used to specify the address details used to create\
        \ an address."
    CreateAddressPreferenceResponses:
      type: "object"
      properties:
        shipFromAddressId:
          description: "This container specifies the unique identifier of the newly\
            \ created address."
          $ref: "#/components/schemas/CreateAddressPreferenceResponsesData"
      description: "This type is used to define the response container of the <b>createAddressPreference</b>\
        \ method."
    CreateAddressPreferenceResponsesData:
      type: "object"
      properties:
        addressId:
          type: "string"
          description: "The unique identifier of the newly-created address.<br><br>This\
            \ ID value can be used when creating a package through the <a href=\"\
            /api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage\"\
            \ target=\"_blank\">createPackage</a> method to specify the ship-from\
            \ or return address associated with the package."
      description: "This type defines the unique identifier of a newly created address."
    CreateBundleRequest:
      type: "object"
      properties:
        bundle:
          description: "This container is used to specify the information needed to\
            \ create a bundle, such as the consign address associated with the bundle\
            \ and the tracking numbers of the packages to be included in the bundle."
          $ref: "#/components/schemas/CreateBundleRequestData"
      description: "This type defines the request container of the <b>createBundle</b>\
        \ method."
    CreateBundleRequestData:
      type: "object"
      properties:
        consignPreferenceId:
          type: "string"
          description: "The unique identifier of the consign address to be associated\
            \ with the bundle.<br><br>This ID can be retrieved using the <a href=\"\
            /api-docs/sell/edelivery_international_shipping/resources/consign_preference/methods/getConsignPreferences\"\
            \ target=\"_blank\">getConsignPreferences</a> method."
        trackingNumbers:
          type: "array"
          description: "This array specifies the tracking numbers of the packages\
            \ to be included in the bundle.<br><br>Tracking numbers are returned when\
            \ creating a package through the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage\"\
            \ target=\"_blank\">createPackage</a> method."
          items:
            type: "string"
      description: "This type defines the information used to create a bundle."
    CreateBundleResponse:
      type: "object"
      properties:
        bundle:
          description: "This container returns information about the newly created\
            \ bundle, such as its <b>bundleId</b> value."
          $ref: "#/components/schemas/CreateBundleResponseData"
      description: "This type defines the response container of the <b>createBundle</b>\
        \ method"
    CreateBundleResponseData:
      type: "object"
      properties:
        bundleId:
          type: "string"
          description: "The unique identifier of the newly created bundle."
      description: "This type defines the unique identifier of the newly-created bundle."
    CreateConsignPreferenceRequest:
      type: "object"
      properties:
        consignAddress:
          description: "This container is used to specify the address details used\
            \ to create a consign address."
          $ref: "#/components/schemas/CreateConsignPreferenceRequestData"
      description: "This type is used to define the request container of the <b>createConsignPreference</b>\
        \ method."
    CreateConsignPreferenceRequestData:
      type: "object"
      properties:
        consignPreferenceName:
          type: "string"
          description: "The name of the consign address."
        dropoffSiteId:
          type: "string"
          description: "The unique identifier of a drop-off site location. This value\
            \ can be retrieved using the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/dropoff_sites/methods/getDropoffSites\"\
            \ target=\"_blank\">getDropoffSites</a> method.<br><br>This field is required\
            \ if the <code>DROPOFF</code> address type is specified."
        pickupAddress:
          description: "This container is used to specify the address details used\
            \ to create a pickup-from address.<br><br>This container is required if\
            \ the <code>PICK_UP</code> address type is specified."
          $ref: "#/components/schemas/PickupAddressRequestData"
        pickupTime:
          type: "string"
          description: "The pickup time that the pickup location supports.<br><br>This\
            \ field is required if the <code>PICK_UP</code> address type is specified.\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:PickUpTimeTypeEnum'>eBay\
            \ API documentation</a>"
        type:
          type: "string"
          description: "The address type of the consign address.<br><br><b>Valid values</b>:<ul><li><code>PICK_UP</code></li><li><code>DROP_OFF</code></li><li><code>FORWARD_DEPLOYMENT</code></li><li><code>RDC</code></li><li><code>CN_POST_DROP_OFF</code></li><li><code>CN_POST_PICK_UP</code></li><li><code>HK_POST_DROP_OFF</code></li></ul>\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:ConsignTypeEnum'>eBay\
            \ API documentation</a>"
      description: "This type is used to specify the address details used to create\
        \ a consign address."
    CreateConsignPreferenceResponses:
      type: "object"
      properties:
        consignAddressId:
          description: "This container specifies the unique identifier of the newly\
            \ created consign address."
          $ref: "#/components/schemas/CreateConsignPreferenceResponsesData"
      description: "This type defines the response container for the <b>createConsignPreference</b>\
        \ method."
    CreateConsignPreferenceResponsesData:
      type: "object"
      properties:
        consignPreferenceId:
          type: "string"
          description: "The unique identifier of the newly-created consign address.<br><br>This\
            \ ID can be used when creating a package through the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage\"\
            \ target=\"_blank\">createPackage</a> method to specify the pickup, drop-off,\
            \ or forward deployment address associated with the package."
      description: "This type defines the unique identifier of the newly created consign\
        \ address."
    DeletePackagesRequest:
      type: "object"
      properties:
        requests:
          description: "This container is used to specify the package ID values for\
            \ the packages being deleted."
          $ref: "#/components/schemas/DeletePackagesRequestData"
      description: "This type defines the request container for the <b>bulkDeletePackages</b>\
        \ method."
    DeletePackagesRequestData:
      type: "object"
      properties:
        packageIds:
          type: "array"
          description: "This comma-delimited array lists the unique identifiers of\
            \ the packages being deleted. These values must be for packages that have\
            \ been cancelled and do not have tracking numbers associated with them.<br><br>Package\
            \ ID values are returned when creating a package through the <a href=\"\
            /api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage\"\
            \ target=\"_blank\">createPackage</a> method."
          items:
            type: "string"
      description: "DeletePackagesRequestData"
    DeletePackagesResponses:
      type: "object"
      properties:
        responses:
          type: "array"
          description: "This array returns the result code and message for each deleted\
            \ package. Each package is denoted by its package ID value."
          items:
            $ref: "#/components/schemas/DeletePackagesResponsesData"
      description: "This type defines the response container of the <b>bulkDeletePackages</b>\
        \ method."
    DeletePackagesResponsesData:
      type: "object"
      properties:
        message:
          type: "string"
          description: "This string returns any additional information about the deletion\
            \ of the package."
        packageId:
          type: "string"
          description: "The unique identifier of the deleted package."
        resultCode:
          type: "string"
          description: "The result code detailing the result of the deletion process.<br><br>For\
            \ example, a result code of <code>200</code> indicates that the call was\
            \ a success and the package was deleted."
      description: "This type defines the response data after deleting multiple packages."
    DirectionsResponses:
      type: "object"
      properties:
        batteryType:
          type: "string"
          description: "The supported battery type for the shipping service."
        from:
          type: "string"
          description: "The two-letter ISO 3166 ship-from country code."
        to:
          type: "string"
          description: "The two-letter ISO 3166 destination country code."
      description: "This container specifies direction information for a shipping\
        \ service."
    Error:
      type: "object"
      properties:
        category:
          type: "string"
          description: "Identifies the type of erro."
        domain:
          type: "string"
          description: "Name for the primary system where the error occurred. This\
            \ is relevant for application errors."
        errorId:
          type: "integer"
          description: "A unique number to identify the error."
          format: "int32"
        inputRefIds:
          type: "array"
          description: "An array of request elements most closely associated to the\
            \ error."
          items:
            type: "string"
        longMessage:
          type: "string"
          description: "A more detailed explanation of the error."
        message:
          type: "string"
          description: "Information on how to correct the problem, in the end user's\
            \ terms and language where applicable."
        outputRefIds:
          type: "array"
          description: "An array of request elements most closely associated to the\
            \ error."
          items:
            type: "string"
        parameters:
          type: "array"
          description: "An array of name/value pairs that describe details the error\
            \ condition. These are useful when multiple errors are returned."
          items:
            $ref: "#/components/schemas/ErrorParameter"
        subdomain:
          type: "string"
          description: "Further helps indicate which subsystem the error is coming\
            \ from. System subcategories include: Initialization, Serialization, Security,\
            \ Monitoring, Rate Limiting, etc."
      description: "This type defines the fields that can be returned in an error."
    ErrorParameter:
      type: "object"
      properties:
        name:
          type: "string"
          description: "The object of the error."
        value:
          type: "string"
          description: "The value of the object."
    FDCSkuRequest:
      type: "object"
      properties:
        quantity:
          type: "integer"
          description: "The quantity of the FDC SKU."
          format: "int32"
        skuId:
          type: "string"
          description: "The unique identifier of the FDC SKU."
      description: "This type specifies FDC SKU information."
    GetActualCostResponses:
      type: "object"
      properties:
        actualCosts:
          type: "array"
          description: "This array returns a list of actual costs associated with\
            \ the packages matching the input criteria."
          items:
            $ref: "#/components/schemas/GetActualCostResponsesData"
      description: "This type defines the response containers of the <b>getActualCost</b>\
        \ method."
    GetActualCostResponsesData:
      type: "object"
      properties:
        actualWeight:
          type: "number"
          description: "The actual weight of the package in grams."
        amount:
          description: "This container specifies the total monetary amount of the\
            \ actual cost of the package. "
          $ref: "#/components/schemas/Amount"
        billingTime:
          type: "string"
          description: "The time the seller was charged for the actual cost of the\
            \ package in UTC format."
        chargeMode:
          type: "string"
          description: "The two-digit charge mode for the package.<br><br><b>Valid\
            \ values</b>:<ul><li><code>01</code>: Actual weight</li><li><code>02</code>:\
            \ Additional dimension weight</li><li><code>03</code>: Charged by lite\
            \ mode</li></ul>"
        chargeWeight:
          type: "number"
          description: "The weight, in grams, charged for when shipping the package."
        costType:
          type: "string"
          description: "The two-digit cost type of the package. This field indicates\
            \ any fees associated with the package.<br><br>The following values are\
            \ the typical cost types returned through this field. If an undocumented\
            \ cost type is returned, check the logistic provider's website for the\
            \ latest values:<br><ul><li><code>01</code>: Shipping fee</li><li><code>02</code>:\
            \ Domestic</li><li><code>03</code>: Return fee</li><li><code>04</code>:\
            \ Domestic burning fee</li><li><code>05</code>: Custom collected fee</li><li><code>06</code>:\
            \ Weight gap fee</li><li><code>07</code>: Duplication compensation</li></ul>"
        message:
          type: "string"
          description: "A seller-defined message to the buyer regarding the transaction.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> This field is always returned, but\
            \ will show as null or have an empty value if not defined/applicable.</span>"
        remark:
          type: "string"
          description: "A remark to the seller themselves.<br><br><span class=\"tablenote\"\
            ><b>Note:</b> This field is always returned, but will show as null or\
            \ have an empty value if not defined/applicable.</span>"
        resultCode:
          type: "string"
          description: "The result code associated with the call.<br><br>For example,\
            \ a result code of <code>200</code> indicates that the call was a success."
        size:
          type: "string"
          description: "The size of the package in centimeters. This value is returned\
            \ in Length*Width*Height format."
        trackingNumber:
          type: "string"
          description: "The tracking number associated with the package."
      description: "This type defines the actual weight, cost, and additional information\
        \ of a specified package or packages."
    GetAddressPreferenceListResponses:
      type: "object"
      properties:
        addressPreferenceList:
          description: "This container returns all ship-from and/or return addresses\
            \ associated with a seller's eDIS account."
          $ref: "#/components/schemas/GetAddressPreferenceListResponsesData"
      description: "This type defines the response container associated with the <b>getAddressPreferences</b>\
        \ method."
    GetAddressPreferenceListResponsesData:
      type: "object"
      properties:
        addresses:
          type: "array"
          description: "This array returns a list of address, contact, and identifier\
            \ information for each of a seller's ship-from and/or return addresses\
            \ associated with their eDIS account."
          items:
            $ref: "#/components/schemas/GetAddressPreferencesResponses"
      description: "This type defines the list of addresses associated with a eDIS\
        \ account."
    GetAddressPreferencesResponses:
      type: "object"
      properties:
        addressId:
          type: "string"
          description: "The unique identifier of the address."
        city:
          type: "string"
          description: "The city code of the address.<br><br>See <a href=\"https://www.edisebay.com/open/development-guide-detail?id=36\"\
            \ target=\"_blank\">商户API地址编码主数据</a> for valid city codes."
        cityName:
          type: "string"
          description: "The city name of the address."
        company:
          type: "string"
          description: "The company name associated with the address."
        contact:
          type: "string"
          description: "The name of the contact person associated with the address."
        countryCode:
          type: "string"
          description: "The two-letter country code of the address."
        countryName:
          type: "string"
          description: "The country name of the address."
        district:
          type: "string"
          description: "The district code of the address.<br><br>See <a href=\"https://www.edisebay.com/open/development-guide-detail?id=36\"\
            \ target=\"_blank\">商户API地址编码主数据</a> for valid district codes."
        districtName:
          type: "string"
          description: "The district name of the address."
        name:
          type: "string"
          description: "The name of the address."
        phone:
          type: "string"
          description: "The phone number associated with the address."
        postcode:
          type: "string"
          description: "The postal code of the address."
        province:
          type: "string"
          description: "The province code of the address.<br><br>See <a href=\"https://www.edisebay.com/open/development-guide-detail?id=36\"\
            \ target=\"_blank\">商户API地址编码主数据</a> for valid province codes."
        provinceName:
          type: "string"
          description: "The province name of the address."
        street1:
          type: "string"
          description: "The first line of the street address of the address."
        street2:
          type: "string"
          description: "The second line of the street address of the address.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> This field is always returned, but\
            \ will show as null or have an empty value if not defined/applicable.</span>"
        street3:
          type: "string"
          description: "The third line of the street address of address.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> This field is always returned, but\
            \ will show as null or have an empty value if not defined/applicable.</span>"
        type:
          type: "string"
          description: "The address type of the address. For implementation help,\
            \ refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:AddressTypeEnum'>eBay\
            \ API documentation</a>"
      description: "This type defines the fields associated with a seller's ship-from\
        \ address, including the location and contact details of the addresses, as\
        \ well as its unique identifier."
    GetAgentListResponses:
      type: "object"
      properties:
        agentList:
          description: "This container returns a list of all EU AR agents associated\
            \ with your eDIS account and their information."
          $ref: "#/components/schemas/GetAgentListResponsesData"
      description: "This type defines the response container of the <b>getAgents</b>\
        \ method."
    GetAgentListResponsesData:
      type: "object"
      properties:
        agents:
          type: "array"
          description: "This array returns information about each EU AR agent associated\
            \ with a seller's eDIS account, including their contact information, eBay\
            \ ID, and supported shipping countries."
          items:
            $ref: "#/components/schemas/AgentModelResponses"
        href:
          type: "string"
          description: "The URL to the current page of the result set."
        limit:
          type: "integer"
          description: "The value of the <b>limit</b> parameter submitted in the request."
          format: "int32"
        next:
          type: "string"
          description: "The URI for the next page of results. This value is returned\
            \ if there is an additional page of results to return from the result\
            \ set."
        offset:
          type: "integer"
          description: "The value of the <b>offset</b> parameter submitted in the\
            \ request."
          format: "int32"
        prev:
          type: "string"
          description: "The URI for the previous page of results. This is returned\
            \ if there is a previous page of results from the result set."
        total:
          type: "integer"
          description: "The total number of results that match the input criteria."
          format: "int32"
      description: "This type defines the fields in a paginated result set of agents\
        \ associated with a seller's eDIS account. The response consists of 0 or more\
        \ sequenced pages that are returned from the complete result set, where each\
        \ page consists of 0 or more items."
    GetBatteryQualListResponses:
      type: "object"
      properties:
        batteryQualificationList:
          description: "This container returns a list of all battery qualifications\
            \ associated with an eDIS account."
          $ref: "#/components/schemas/GetBatteryQualListResponsesData"
      description: "This type defines the response container of the <b>getbatteryQualifications</b>\
        \ method."
    GetBatteryQualListResponsesData:
      type: "object"
      properties:
        href:
          type: "string"
          description: "The URL to the current page of the result set."
        limit:
          type: "integer"
          description: "The value of the <b>limit</b> parameter submitted in the request."
          format: "int32"
        next:
          type: "string"
          description: "The URI for the next page of results. This value is returned\
            \ if there is an additional page of results to return from the result\
            \ set."
        offset:
          type: "integer"
          description: "The value of the <b>offset</b> parameter submitted in the\
            \ request."
          format: "int32"
        prev:
          type: "string"
          description: "The URI for the previous page of results. This is returned\
            \ if there is a previous page of results from the result set."
        qualifications:
          type: "array"
          description: "This array returns information about each battery qualification\
            \ associated with an eDIS account, such as the battery type, qualification\
            \ name, and expiration date."
          items:
            $ref: "#/components/schemas/BatteryQualResponses"
        total:
          type: "integer"
          description: "The total number of results that match the input criteria."
          format: "int32"
      description: "This type defines the fields in a paginated result set of battery\
        \ qualifications associated with a seller's eDIS account. The response consists\
        \ of 0 or more sequenced pages that are returned from the complete result\
        \ set, where each page consists of 0 or more items."
    GetConsignPreferenceListResponses:
      type: "object"
      properties:
        consignPreferenceList:
          description: "This container returns a list of all consign addresses associated\
            \ with a seller's eDIS account."
          $ref: "#/components/schemas/GetConsignPreferenceListResponsesData"
      description: "This type defines the response container of the <b>getConsignPreferences</b>\
        \ method."
    GetConsignPreferenceListResponsesData:
      type: "object"
      properties:
        consignPreferences:
          type: "array"
          description: "This array returns information about each of a seller's consign\
            \ addresses associated with their eDIS account."
          items:
            $ref: "#/components/schemas/ConsignPreferenceInfoResponses"
      description: "This type defines the fields associated with a seller's consign\
        \ addresses, including the location and contact details of the address, as\
        \ well as its unique identifiers."
    GetDropoffSiteListResponses:
      type: "object"
      properties:
        dropoffSiteList:
          description: "This container returns a list of all of the drop-off site\
            \ locations associated with an eDIS account."
          $ref: "#/components/schemas/GetDropoffSitesResponsesData"
      description: "This type defines the response container associated with the <b>getDropoffSites</b>\
        \ method."
    GetDropoffSitesResponses:
      type: "object"
      properties:
        city:
          type: "string"
          description: "The city code of the drop-off site location.<br><br>See <a\
            \ href=\"https://www.edisebay.com/open/development-guide-detail?id=36\"\
            \ target=\"_blank\">商户API地址编码主数据</a> for valid city codes."
        contact:
          type: "string"
          description: "The name of the contact person associated with the drop-off\
            \ site location."
        country:
          type: "string"
          description: "The two-letter country code associated with the drop-off site\
            \ location."
        district:
          type: "string"
          description: "The district code of the drop-off site location.<br><br>See\
            \ <a href=\"https://www.edisebay.com/open/development-guide-detail?id=36\"\
            \ target=\"_blank\">商户API地址编码主数据</a> for valid district codes."
        dropoffSiteId:
          type: "string"
          description: "The unique identifier of the drop-off site location."
        name:
          type: "string"
          description: "The name of the drop-off site location."
        phone:
          type: "string"
          description: "The phone number associated with the drop-off site location."
        province:
          type: "string"
          description: "The province code of the drop-off site location.<br><br>See\
            \ <a href=\"https://www.edisebay.com/open/development-guide-detail?id=36\"\
            \ target=\"_blank\">商户API地址编码主数据</a> for valid province codes."
        street1:
          type: "string"
          description: "The first line of the street address of the drop-off site\
            \ location."
        street2:
          type: "string"
          description: "The second line, if applicable, of the street address of the\
            \ drop-off site location.<br><br><span class=\"tablenote\"><b>Note:</b>\
            \ This field is always returned, but will show as null or have an empty\
            \ value if not defined/applicable.</span>"
        street3:
          type: "string"
          description: "The third line, if applicable, of the street address of the\
            \ drop-off site location.<br><br><span class=\"tablenote\"><b>Note:</b>\
            \ This field is always returned, but will show as null or have an empty\
            \ value if not defined/applicable.</span>"
        type:
          type: "string"
          description: "The type of the drop-off site location.<br><br>Currently,\
            \ the only valid response is <code>DROP_OFF</code>."
      description: "This type defines the fields associated with one or more drop-off\
        \ sites associated with a seller's eDIS account."
    GetDropoffSitesResponsesData:
      type: "object"
      properties:
        dropoffSites:
          type: "array"
          description: "This array returns address, contact, and identifier information\
            \ for each of a seller's drop-off locations associated with their eDIS\
            \ account."
          items:
            $ref: "#/components/schemas/GetDropoffSitesResponses"
        href:
          type: "string"
          description: "The URL to the current page of the result set."
        limit:
          type: "integer"
          description: "The value of the <b>limit</b> parameter submitted in the request."
          format: "int32"
        next:
          type: "string"
          description: "The URI for the next page of results. This value is returned\
            \ if there is an additional page of results to return from the result\
            \ set."
        offset:
          type: "integer"
          description: "The value of the <b>offset</b> parameter submitted in the\
            \ request."
          format: "int32"
        prev:
          type: "string"
          description: "The URI for the previous page of results. This is returned\
            \ if there is a previous page of results from the result set."
        total:
          type: "integer"
          description: "The total number of results that match the input criteria."
          format: "int32"
      description: "This type defines the list of drop-off site locations associated\
        \ with an eDIS account."
    GetHandoverSheetResponses:
      type: "object"
      properties:
        handoverSheet:
          description: "This container returns the base64 string value for a handover\
            \ sheet."
          $ref: "#/components/schemas/GetHandoverSheetResponsesData"
      description: "This type is used to define the response container for the <b>getHandoverSheet</b>\
        \ method."
    GetHandoverSheetResponsesData:
      type: "object"
      properties:
        base64Str:
          type: "string"
          description: "The base 64 string value for a handover sheet. This string\
            \ can be converted to a PDF file once it has been retrieved."
      description: "This type specifies the base64 string value for a handover sheet."
    GetItemPackageIdResponses:
      type: "object"
      properties:
        itemPackages:
          type: "array"
          description: "This array returns a list of packages associated with the\
            \ specified line item ID."
          items:
            $ref: "#/components/schemas/GetItemPackageIdResponsesData"
      description: "This type defines the response container of the <b>getPackageByLineItemID</b>\
        \ method."
    GetItemPackageIdResponsesData:
      type: "object"
      properties:
        packageId:
          type: "string"
          description: "The unique identifier of the package."
        packageStatus:
          type: "string"
          description: "The current status of the package. For implementation help,\
            \ refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:PackageStatusEnum'>eBay\
            \ API documentation</a>"
        trackingNumber:
          type: "string"
          description: "The tracking number of the package."
      description: "This type returns information on the packages being retrieved\
        \ based on the specified line item ID. "
    GetLabelListResponses:
      type: "object"
      properties:
        labels:
          type: "array"
          description: "This array returns the shipping label information, such as\
            \ the base64 string value and result code for each specified tracking\
            \ number."
          items:
            $ref: "#/components/schemas/GetLabelListResponsesData"
      description: "This type defines the response container of the <b>getLabels</b>\
        \ method."
    GetLabelListResponsesData:
      type: "object"
      properties:
        base64Str:
          type: "string"
          description: "The base 64 string value for a shipping label.<br><br>This\
            \ string value can be converted to a PDF file."
        message:
          type: "string"
          description: "A message relating to the status of the shipping label retrieval\
            \ process."
        resultCode:
          type: "string"
          description: "The result code detailing the results of the shipping label\
            \ retrieval process.<br><br>For example, a result code of <code>200</code>\
            \ indicates that at least one shipping label was successfully retrieved."
        trackingNumber:
          type: "string"
          description: "The tracking number for which the shipping label is being\
            \ retrieved."
      description: "GetLabelListResponsesData"
    GetPackageDetailResponses:
      type: "object"
      properties:
        packageDetail:
          description: "This container returns the details for the specified package."
          $ref: "#/components/schemas/GetPackageDetailResponsesData"
      description: "This type defines the response container of the <b>getPackage</b>\
        \ method."
    GetPackageDetailResponsesData:
      type: "object"
      properties:
        agentInfoResponse:
          description: "This container returns EU AR agent information associated\
            \ with the package."
          $ref: "#/components/schemas/AgentInfoData"
        consignPreferenceId:
          type: "string"
          description: "The unique identifier of the consign address associated with\
            \ the package."
        incoterm:
          type: "string"
          description: "The incoterm information associated with the package.<br><br><b>Supported\
            \ values</b>:<ul><li><code>DDP</code></li><li><code>DDU</code></li></ul>\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:IncotermEnum'>eBay\
            \ API documentation</a>"
        items:
          type: "array"
          description: "This array returns information about the eBay line item(s)\
            \ that are included in the package."
          items:
            $ref: "#/components/schemas/ItemResponses"
        lastMileTrackingNumber:
          type: "string"
          description: "The last-mile tracking number of the package.<br><br>This\
            \ field is only returned if the last-mile tracking number is provided\
            \ by the carrier."
        packageComment:
          type: "string"
          description: "The seller-defined remark to the buyer associated with the\
            \ package."
        packageHeight:
          type: "number"
          description: "The height of the package in centimeters."
        packageId:
          type: "string"
          description: "The unique identifier of the package."
        packageLength:
          type: "number"
          description: "The length of the package in centimeters."
        packageStatus:
          type: "string"
          description: "The current status of the package. For implementation help,\
            \ refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:PackageStatusEnum'>eBay\
            \ API documentation</a>"
        packageWeight:
          type: "number"
          description: "The weight of the package in grams."
        packageWidth:
          type: "number"
          description: "The width of the package in centimeters."
        paymentCost:
          description: "The actual payment cost of the package."
          $ref: "#/components/schemas/Amount"
        shipFromAddressId:
          type: "string"
          description: "The unique identifier of the ship-from address associated\
            \ with the package."
        shippingServiceId:
          type: "string"
          description: "The unique identifier of the shipping service used for the\
            \ package."
        shipToAddress:
          description: "This container returns information about the address the package\
            \ is being shipped to."
          $ref: "#/components/schemas/ShipToAddressResponsesData"
        specialServiceDetail:
          description: "This container returns any special services associated with\
            \ this package.<br><br><span class=\"tablenote\"><b>Note:</b> This field\
            \ is always returned, but will show as null or have an empty value if\
            \ not defined/applicable.</span>"
          $ref: "#/components/schemas/SpecialServiceDetail"
        valueForCarriage:
          type: "string"
          description: "The declared value of the package."
      description: "This type specifies the details returned for the specified package."
    GetServiceListResponses:
      type: "object"
      properties:
        serviceList:
          description: "This container returns shipping service metadata associated\
            \ with a seller's eDIS account."
          $ref: "#/components/schemas/GetServiceListResponsesData"
      description: "This type defines the response container of the </b>getService</b>\
        \ method."
    GetServiceListResponsesData:
      type: "object"
      properties:
        href:
          type: "string"
          description: "The URL to the current page of the result set."
        limit:
          type: "integer"
          description: "The value of the <b>limit</b> parameter submitted in the request."
          format: "int32"
        next:
          type: "string"
          description: "The URI for the next page of results. This value is returned\
            \ if there is an additional page of results to return from the result\
            \ set."
        offset:
          type: "integer"
          description: "The value of the <b>offset</b> parameter submitted in the\
            \ request."
          format: "int32"
        prev:
          type: "string"
          description: "The URI for the previous page of results. This is returned\
            \ if there is a previous page of results from the result set."
        services:
          type: "array"
          description: "This array returns a list of available shipping services,\
            \ as well as the descriptions, directions, and identifiers of each service."
          items:
            $ref: "#/components/schemas/ServiceInfoResponses"
        total:
          type: "integer"
          description: "The total number of shipping services being displayed on the\
            \ current results page."
          format: "int32"
      description: "This type defines the details returned for the retrieved shipping\
        \ service(s)."
    GetTrackingDetailResponses:
      type: "object"
      properties:
        trackingDetails:
          type: "array"
          description: "This array returns a list of tracking event details for the\
            \ specified tracking number."
          items:
            $ref: "#/components/schemas/GetTrackingDetailResponsesData"
      description: "This container defines the response container for the <b>getTracking</b>\
        \ method."
    GetTrackingDetailResponsesData:
      type: "object"
      properties:
        city:
          type: "string"
          description: "The city code in which the tracking event occurred.<br><br>See\
            \ <a href=\"https://www.edisebay.com/open/development-guide-detail?id=36\"\
            \ target=\"_blank\">商户API地址编码主数据</a> for valid city codes.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> This field is always returned, but\
            \ will show as null or have an empty value if not defined/applicable.</span>"
        country:
          type: "string"
          description: "The two-letter ISO 3166 country code where the tracking event\
            \ occurred."
        descriptionEn:
          type: "string"
          description: "The English description of the tracking event."
        descriptionZh:
          type: "string"
          description: "The Chinese description of the tracking event."
        district:
          type: "string"
          description: "The district code where the tracking event occurred.<br><br>See\
            \ <a href=\"https://www.edisebay.com/open/development-guide-detail?id=36\"\
            \ target=\"_blank\">商户API地址编码主数据</a> for valid district codes.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> This field is always returned, but\
            \ will show as null or have an empty value if not defined/applicable.</span>"
        eventPostalCode:
          type: "string"
          description: "The postal code of where the tracking event occurred.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> This field is always returned, but\
            \ will show as null or have an empty value if not defined/applicable.</span>"
        eventTime:
          type: "string"
          description: "This timestamp the time and date the tracking event occurred."
        province:
          type: "string"
          description: "The province code where the tracking event occurred.<br><br>See\
            \ <a href=\"https://www.edisebay.com/open/development-guide-detail?id=36\"\
            \ target=\"_blank\">商户API地址编码主数据</a> for province district codes.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> This field is always returned, but\
            \ will show as null or have an empty value if not defined/applicable.</span>"
        status:
          type: "string"
          description: "The status of the shipment."
        trackingNumber:
          type: "string"
          description: "The tracking number specified in the request."
      description: "This type specifies the tracking event details for the specified\
        \ tracking number."
    ItemRequest:
      type: "object"
      properties:
        buyerId:
          type: "string"
          description: "The buyer's eBay user ID."
        buyerTaxId:
          type: "string"
          description: "The tax ID for the buyer. The type of Tax ID is specified\
            \ in the <b>buyerTaxIdType</b> field."
        buyerTaxType:
          type: "string"
          description: "The type of tax ID that was supplied by the buyer during the\
            \ checkout process."
        ebayCollectAndRemitTax:
          type: "boolean"
          description: "This boolean indicates if the corresponding line item is subject\
            \ to a 'Collect and Remit' tax that eBay will collect and remit to the\
            \ proper taxing authority on the buyer's behalf."
        ebayCollectAndRemitTaxesValue:
          type: "string"
          description: "The value of the 'Collect and Remit' tax for the order that\
            \ the line item belongs to."
        email:
          type: "string"
          description: "The buyer's email address."
        itemTitle:
          type: "string"
          description: "The title of the listing."
        listingId:
          type: "string"
          description: "The unique identifier of the eBay listing.<br><br><span class=\"\
            tablenote\"><b>Note:</b> Either a <b>listingId</b> and <b>transactionId</b>\
            \ pair, or an <b>orderLineItem</b> field is required to identify an order\
            \ line item.</span>"
        message:
          type: "string"
          description: "A message from the seller to the buyer."
        orderId:
          type: "string"
          description: "The unique identifier of the eBay order that the line item\
            \ belongs to."
        orderLineItem:
          type: "string"
          description: "The unique identifier of the line item.<br><br><span class=\"\
            tablenote\"><b>Note:</b> Either a <b>listingId</b> and <b>transactionId</b>\
            \ pair, or an <b>orderLineItem</b> field is required to identify an order\
            \ line item.<span>"
        paymentDate:
          type: "string"
          description: "The date and time the buyer pays for the order.<br><br><b>Format:</b>\
            \ <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>"
        payPalEmail:
          type: "string"
          description: "The buyer's PayPal email address."
        payPalMessage:
          type: "string"
          description: "The buyer's PayPal message."
        postedQuantity:
          type: "integer"
          description: "The quantity of the line item that will be shipped with the\
            \ package. This value can differ from the order quantity in the case of\
            \ a combined or split shipment.<br><br><b>Min</b>: 1<br><br><b>Max</b>:\
            \ 999"
          format: "int32"
        siteId:
          type: "integer"
          description: "The unique identifier of the eBay site in which the order\
            \ occurred."
          format: "int32"
        sku:
          description: "This container specifies information relating to the item\
            \ being shipped in the package."
          $ref: "#/components/schemas/SkuRequest"
        soldDate:
          type: "string"
          description: "The date the item was sold.<br><br><b>Format</b>: <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>"
        soldPrice:
          description: "The price for which the item was sold."
          $ref: "#/components/schemas/Amount"
        soldQuantity:
          type: "integer"
          description: "The quantity of the line item that was sold."
          format: "int32"
        transactionId:
          type: "string"
          description: "The unique identifier of the monetary transaction.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> Either a <b>listingId</b> and <b>transactionId</b>\
            \ pair, or an <b>orderLineItem</b> field is required to identify an order\
            \ line item.</span>"
      description: "This container specifies information about the items being included\
        \ in a package."
    ItemResponses:
      type: "object"
      properties:
        buyerId:
          type: "string"
          description: "The buyer's eBay ID."
        buyerTaxId:
          type: "string"
          description: "The buyer's tax ID."
        buyerTaxType:
          type: "string"
          description: "The buyer's tax type."
        ebayCollectAndRemitTax:
          type: "boolean"
          description: "If returned as <code>true</code>, this boolean indicates that\
            \ eBay will collect tax for the corresponding line item, and remit the\
            \ tax to the taxing authority of the buyer's residence. "
        ebayCollectAndRemitTaxesValue:
          type: "string"
          description: "The value of the collect and remit tax for the corresponding\
            \ line item. This field is only returned if collect and remit tax is applied\
            \ to the line item. "
        email:
          type: "string"
          description: "The buyer's eBay email address."
        itemTitle:
          type: "string"
          description: "The seller created title of the item."
        listingId:
          type: "string"
          description: "The unique identifier of the eBay listing associated with\
            \ the item."
        message:
          type: "string"
          description: "The buyer's eBay message."
        orderId:
          type: "string"
          description: "The unique identifier of the eBay order that the line item\
            \ belongs to."
        orderLineItem:
          type: "string"
          description: "The unique identifier of an eBay order line item."
        paymentDate:
          type: "string"
          description: "The date and time that the payment was received by the seller.\
            \ This timestamp is returned in ISO 8601 format, which uses the 24-hour\
            \ Universal Coordinated Time (UTC) clock."
        payPalEmail:
          type: "string"
          description: "The buyer's PayPal email address."
        payPalMessage:
          type: "string"
          description: "The buyer's PayPal message"
        postedQuantity:
          type: "integer"
          description: "The quantity of the line item shipped with the package."
          format: "int32"
        siteId:
          type: "integer"
          description: "The unique identifier of the eBay site in which the order\
            \ occurred."
          format: "int32"
        sku:
          description: "This container returns SKU-related information relating to\
            \ the item being shipped in the package."
          $ref: "#/components/schemas/SkuRequest"
        soldDate:
          type: "string"
          description: "The date the item was sold."
        soldPrice:
          description: "The price for which the item was sold."
          $ref: "#/components/schemas/Amount"
        soldQuantity:
          type: "integer"
          description: "The quantity of the line item that was sold."
          format: "int32"
        transactionId:
          type: "string"
          description: "The unique identifier of the eBay transaction."
      description: "This type defines item information for items in a package."
    PackageInfoRequest:
      type: "object"
      properties:
        agentInfoRequest:
          description: "This container specifies the EU AR agent information associated\
            \ with the package.<br><br>This information can be retrieved using the\
            \ <a href=\"/api-docs/sell/edelivery_international_shipping/resources/agents/methods/getAgents\"\
            \ target=\"_blank\">getAgents</a>  method."
          $ref: "#/components/schemas/AgentInfoData"
        consignPreferenceId:
          type: "string"
          description: "The unique identifier of the consign address to be associated\
            \ with the package.<br><br>This ID can be retrieved using the <a href=\"\
            /api-docs/sell/edelivery_international_shipping/resources/consign_preference/methods/getConsignPreferences\"\
            \ target=\"_blank\">getConsignPreferences</a> method."
        incoterm:
          type: "string"
          description: "The incoterm information associated with the package.<br><br><b>Supported\
            \ values</b>:<ul><li><code>DDP</code></li><li><code>DDU</code></li></ul>\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:IncotermEnum'>eBay\
            \ API documentation</a>"
        items:
          type: "array"
          description: "This array is used to specify applicable information about\
            \ the eBay line item(s) that will be included in the package."
          items:
            $ref: "#/components/schemas/ItemRequest"
        maxQuantityLimit:
          type: "integer"
          description: "This field is used to limit the maximum number of parcels\
            \ used in a single order. If the order has more than one parcel, revise\
            \ this value to increase the limit."
          format: "int32"
        packageComment:
          type: "string"
          description: "A seller-defined comment about the package."
        packageHeight:
          type: "number"
          description: "The height of the package in centimeters."
        packageLength:
          type: "number"
          description: "The length of the package in centimeters."
        packageWeight:
          type: "number"
          description: "The weight of the package in grams."
        packageWidth:
          type: "number"
          description: "The width of the package in centimeters."
        shipFromAddressId:
          type: "string"
          description: "The unique identifier of the ship-from address used for the\
            \ package.<br><br>Use the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/address_preference/methods/getAddressPreferences\"\
            \ target=\"_blank\">getAddressPreferences</a> method to retrieve valid\
            \ ship-from <b>addressId</b> values associated with your account."
        shippingServiceId:
          type: "string"
          description: "The unique identifier of the shipping service being used for\
            \ the package.<br><br>This value can be retrieved using the <a href=\"\
            /api-docs/sell/edelivery_international_shipping/resources/services/methods/getServices\"\
            \ target=\"_blank\">getServices</a> method."
        shipToAddress:
          description: "This container specifies the address details of the address\
            \ ship-to address."
          $ref: "#/components/schemas/ShipToAddressRequestData"
        specialServiceDetail:
          description: "This container specifies any special service details about\
            \ the package, such as any insurance fee, required signatures, or delivery\
            \ exceptions."
          $ref: "#/components/schemas/SpecialServiceDetail"
        valueForCarriage:
          type: "string"
          description: "The declared value of a large carriage (a combination of several\
            \ orders together)."
      description: "This type is used to specify the package information needed to\
        \ create a package."
    PickupAddressRequestData:
      type: "object"
      properties:
        city:
          type: "string"
          description: "The city code of the pickup address.<br><br>See <a href=\"\
            https://www.edisebay.com/open/development-guide-detail?id=36\" target=\"\
            _blank\">商户API地址编码主数据</a> for valid city codes."
        company:
          type: "string"
          description: "The company name associated with the pickup address.<br><br><b>Max\
            \ length</b>: 50 characters"
        contact:
          type: "string"
          description: "The name of the contact person associated with the pickup\
            \ address.<br><br><b>Max length</b>: 50 characters"
        countryCode:
          type: "string"
          description: "The two-letter country code of the pickup address.<br><br><b>Valid\
            \ values</b>:<ul><li>CN</li><li>HK</li></ul>"
        district:
          type: "string"
          description: "The district code of the pickup address. <br><br>See <a href=\"\
            https://www.edisebay.com/open/development-guide-detail?id=36\" target=\"\
            _blank\">商户API地址编码主数据</a> for valid district codes."
        name:
          type: "string"
          description: "The name of the pickup address.<br><br><b>Max length</b>:\
            \ 50 characters"
        phone:
          type: "string"
          description: "The phone number associated with the pickup address."
        postcode:
          type: "string"
          description: "The postal code of the pickup address."
        province:
          type: "string"
          description: "The province code of the the pickup address.<br><br>See <a\
            \ href=\"https://www.edisebay.com/open/development-guide-detail?id=36\"\
            \ target=\"_blank\">商户API地址编码主数据</a> for valid province codes."
        street1:
          type: "string"
          description: "The first line of the street address of the pickup address.<br><br><b>Max\
            \ length</b>: 50 characters"
        street2:
          type: "string"
          description: "The second line, if applicable, of the street address of the\
            \ pickup address.<br><br><b>Max length</b>: 50 characters"
        street3:
          type: "string"
          description: "The third line, if applicable, of the street address of the\
            \ pickup address.<br><br><b>Max length</b>: 50 characters"
      description: "This type defines the field used to create a pickup address."
    PickupAddressResponsesData:
      type: "object"
      properties:
        city:
          type: "string"
          description: "The city code of the pickup address.<br><br>See <a href=\"\
            https://www.edisebay.com/open/development-guide-detail?id=36\" target=\"\
            _blank\">商户API地址编码主数据</a> for valid city codes."
        cityName:
          type: "string"
          description: "The city name of the pickup address."
        company:
          type: "string"
          description: "The name of the company associated with the pickup address."
        contact:
          type: "string"
          description: "The name of the contact person associated with the pickup\
            \ address."
        countryCode:
          type: "string"
          description: "The two-letter country code of the pickup address."
        countryName:
          type: "string"
          description: "The name of the country of the pickup address."
        district:
          type: "string"
          description: "The district code of the pickup address.<br><br>See <a href=\"\
            https://www.edisebay.com/open/development-guide-detail?id=36\" target=\"\
            _blank\">商户API地址编码主数据</a> for valid district codes."
        districtName:
          type: "string"
          description: "The district name of the pickup address."
        name:
          type: "string"
          description: "The name of the pickup address."
        phone:
          type: "string"
          description: "The phone number associated with the pickup address."
        postcode:
          type: "string"
          description: "The postal code of the pickup address."
        province:
          type: "string"
          description: "The province code of the pickup address.<br><br>See <a href=\"\
            https://www.edisebay.com/open/development-guide-detail?id=36\" target=\"\
            _blank\">商户API地址编码主数据</a> for valid province codes."
        provinceName:
          type: "string"
          description: "The name of the province of the pickup address."
        street1:
          type: "string"
          description: "The first line of the street address of the pickup address."
        street2:
          type: "string"
          description: "The second line, if applicable, of the street address of the\
            \ pickup address."
        street3:
          type: "string"
          description: "The third line, if applicable, of the street address of the\
            \ pickup address."
      description: "This type defines the fields used to specify location and contact\
        \ information for a pickup-from consign address associated with a seller's\
        \ eDIS account."
    ServiceInfoResponses:
      type: "object"
      properties:
        descriptionEn:
          type: "string"
          description: "Basic shipping service information in English."
        descriptionHk:
          type: "string"
          description: "Basic shipping service information in traditional Chinese."
        descriptionJp:
          type: "string"
          description: "Basic shipping service information in Japanese."
        descriptionZh:
          type: "string"
          description: "Basic shipping service information in simplified Chinese."
        directions:
          type: "array"
          description: "This array lists includes all Ship From/Ship To combinations\
            \ that the service supports. It also includes the type of batteries that\
            \ may be shipping using the shipping service."
          items:
            $ref: "#/components/schemas/DirectionsResponses"
        incoterm:
          type: "string"
          description: "The incoterm information associated with the the shipping\
            \ service.<br><br><b>Supported values</b>:<ul><li><code>DDP</code></li><li><code>DDU</code></li></ul>\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:IncotermEnum'>eBay\
            \ API documentation</a>"
        maxLength:
          type: "number"
          description: "This value indicates the maximum length (in centimeters) of\
            \ the shipping package that the shipping service allows.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> This field is always returned, but\
            \ will show as null or have an empty value if not defined/applicable.</span>"
        maxTotalLength:
          type: "number"
          description: "This value indicates the total maximum value of the length,\
            \ width, and height of the package.<br><br><span class=\"tablenote\"><b>Note:</b>\
            \ This field is always returned, but will show as null or have an empty\
            \ value if not defined/applicable.</span>"
        maxWeight:
          type: "number"
          description: "This value indicates the maximum weight (in grams) of the\
            \ shipping package that the shipping service allows.<br><br><span class=\"\
            tablenote\"><b>Note:</b> This field is always returned, but will show\
            \ as null or have an empty value if not defined/applicable.</span>"
        nameEn:
          type: "string"
          description: "The shipping service name in English"
        nameHk:
          type: "string"
          description: "The shipping service name in traditional Chinese"
        nameJp:
          type: "string"
          description: "The shipping service name in Japanese."
        nameZh:
          type: "string"
          description: "The shipping service name in simplified Chinese"
        shippingServiceId:
          type: "string"
          description: "The unique identifier of the shipping service being retrieved.<br><br>This\
            \ value can be input in the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/package/methods/createPackage#request.packageInfo.shippingServiceId\"\
            \ target=\"_blank\">shippingServiceId</a> field when creating a package\
            \ through the the <b>createPackage</b> method."
      description: "This type specifies the shipping service information."
    ShipToAddressRequestData:
      type: "object"
      properties:
        city:
          type: "string"
          description: "The city code of the ship-to address.<br><br>See <a href=\"\
            https://www.edisebay.com/open/development-guide-detail?id=36\" target=\"\
            _blank\">商户API地址编码主数据</a> for valid city codes."
        company:
          type: "string"
          description: "The name of the company associated with the ship-to address."
        contact:
          type: "string"
          description: "The name of the contact person associated with the the ship-to\
            \ address."
        countryCode:
          type: "string"
          description: "The two-letter country code of the ship-to address."
        countryName:
          type: "string"
          description: "The country name of the ship-to address."
        district:
          type: "string"
          description: "The district code of the ship-to address.<br><br>See <a href=\"\
            https://www.edisebay.com/open/development-guide-detail?id=36\" target=\"\
            _blank\">商户API地址编码主数据</a> for valid district codes."
        phone:
          type: "string"
          description: "The phone number associated with the ship-to address."
        postcode:
          type: "string"
          description: "The postal code of the ship-to address."
        province:
          type: "string"
          description: "The province code of the ship-to address.<br><br>See <a href=\"\
            https://www.edisebay.com/open/development-guide-detail?id=36\" target=\"\
            _blank\">商户API地址编码主数据</a> for valid province codes."
        street1:
          type: "string"
          description: "The first line of the street address of the ship-to address.<br><br><b>Max\
            \ length</b>: 50 characters"
        street2:
          type: "string"
          description: "The second line, if applicable, of the street address of the\
            \ ship-to address.<br><br><b>Max length</b>: 50 characters"
        street3:
          type: "string"
          description: "The third line, if applicable, of the street address of the\
            \ ship-to address.<br><br><b>Max length</b>: 50 characters"
      description: "This type is used to specify the address fields of the ship-to\
        \ address location."
    ShipToAddressResponsesData:
      type: "object"
      properties:
        city:
          type: "string"
          description: "The city code of the ship-to address.<br><br>See <a href=\"\
            https://www.edisebay.com/open/development-guide-detail?id=36\" target=\"\
            _blank\">商户API地址编码主数据</a> for valid city codes."
        company:
          type: "string"
          description: "The name of the company associated with the ship-to address."
        contact:
          type: "string"
          description: "The name of the contact person associated with the ship-to\
            \ address."
        countryCode:
          type: "string"
          description: "The two-letter country code of the ship-to address."
        countryName:
          type: "string"
          description: "The country name of the ship-to address."
        district:
          type: "string"
          description: "The district code of the ship-to address.<br><br>See <a href=\"\
            https://www.edisebay.com/open/development-guide-detail?id=36\" target=\"\
            _blank\">商户API地址编码主数据</a> for valid district codes."
        phone:
          type: "string"
          description: "The phone number associated with the ship-to address."
        postcode:
          type: "string"
          description: "The postal code of the ship-to address."
        province:
          type: "string"
          description: "The province code of the ship-to address.<br><br>See <a href=\"\
            https://www.edisebay.com/open/development-guide-detail?id=36\" target=\"\
            _blank\">商户API地址编码主数据</a> for valid province codes."
        street1:
          type: "string"
          description: "The first line of the street address of the ship-to address."
        street2:
          type: "string"
          description: "The second line of the street address of the ship-to address."
        street3:
          type: "string"
          description: "The third line of the street address of the ship-to address."
      description: "This type specifies the ship-to address information for a retrieved\
        \ package."
    SkuRequest:
      type: "object"
      properties:
        elecQualificationId:
          type: "string"
          description: "The unique identifier of the battery's electric qualification,\
            \ which indicates that the battery has a certificate of approval for global\
            \ shipping.<br><br>This value is returned in the <a href=\"/api-docs/sell/edelivery_international_shipping/resources/battery_qualifications/methods/getBatteryQualifications\"\
            \ target=\"_blank\">getBatteryQualifications</a> method."
        fdcSkus:
          type: "array"
          description: "This array lists the FDC SKUs associated with the item. An\
            \ FDC SKU is the SKU label in a forward deployment center.<div class=\"\
            msgbox_important\"><p class=\"msgbox_importantInDiv\" data-mc-autonum=\"\
            &lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
            \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span\
            \ style=\"color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
            \ Please contact customer service before using these fields.</p></div>"
          items:
            $ref: "#/components/schemas/FDCSkuRequest"
        height:
          type: "number"
          description: "The height of the item in centimeters."
        isLiBattery:
          type: "boolean"
          description: "This boolean indicates if the item contains a battery."
        length:
          type: "number"
          description: "The length of the item in centimeters."
        liBatteryType:
          type: "string"
          description: "If the item contains a battery, this field indicates the type\
            \ of battery the item contains. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/edelivery_international_shipping/types/api:LiBatteryTypeEnum'>eBay\
            \ API documentation</a>"
        nameEn:
          type: "string"
          description: "The English name of the item."
        nameZh:
          type: "string"
          description: "The Chinese name of the item."
        origin:
          type: "string"
          description: "The country of origin of the item."
        price:
          description: "The declared price of the item."
          $ref: "#/components/schemas/Amount"
        remark:
          type: "string"
          description: "A remark to the seller themselves."
        skuNumber:
          type: "string"
          description: "The stock keeping unit (SKU) identifier of the item."
        tariffCode:
          type: "string"
          description: "The Harmonized System code for custom declaration. This value\
            \ declares the category of the item.."
        weight:
          type: "number"
          description: "The weight of the item in grams."
        width:
          type: "number"
          description: "The width of the item in centimeters."
      description: "This type specifies information relating to the SKU item in a\
        \ package."
    SpecialServiceDetail:
      type: "object"
      properties:
        insuranceFee:
          type: "string"
          description: "The insurance fee, if applicable, on the package.<br><br>The\
            \ insurance amount and currency are consistent with the currency of the\
            \ destination country"
        packagingType:
          type: "string"
          description: "The package type.<br><br><b>Valid values</b>:<ul><li><code>PAK</code>\
            \ (limited weight ≤ 2.5KG)</li><li><code>PACKAGE</code> (limited weight\
            \ 68KG)</li></ul>"
        signatureType:
          type: "string"
          description: "The signature type, if applicable, for the package.<br><br><b>Valid\
            \ values</b>:<ul><li><code>ISR</code> (Indirect Signature Required)</li><li><code>DSR</code>\
            \ (Direct Signature Required)</li><li><code>ASR</code> (Adult Signature\
            \ Required)</li></ul>"
        specialServiceTypes:
          type: "array"
          description: "Any special service types supported for the package.<br><br>\
            \ For example, <code>SATURDAY_DELIVERY</code> indicates that the item\
            \ is eligible for Saturday delivery."
          items:
            type: "string"
      description: "This type defines the special service details available for a\
        \ package."
  securitySchemes:
    api_auth:
      type: "oauth2"
      description: "The security definitions for this API. Please check individual\
        \ operations for applicable scopes."
      flows: {}