Shipping API v2 Model

This document provides the API models that developers can use to ensure their services request and consume data correctly.

Open API Spec 3.0 model for the Shipping v2 APIs

openapi: 3.0.1
info:
  title: Amazon Shipping API
  description: "The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments."
  version: v2
  contact:
    name: API Integrations Support
    url: https://developer-docs.amazon.com/amazon-shipping/docs/api-integrations-support
servers:
  - url: https://sandbox.sellingpartnerapi-eu.amazon.com
  - url: https://sellingpartnerapi-eu.amazon.com
  - url: https://sandbox.sellingpartnerapi-na.amazon.com
  - url: https://sellingpartnerapi-na.amazon.com
tags:
  - name: shipping-rates
  - name: purchase-shipping
  - name: smart-purchase-shipping
  - name: shipping-tracking
  - name: shipping-documents
  - name: cancel-shipping
  - name: shipping-access-points
  - name: submit-ndr-shipping
  - name: additional-inputs-shipping 
paths:
  /shipping/v2/shipments/rates:
    post:
      tags:
      - shipping-rates
      description: |-
        Returns the available shipping service offerings.

        **Usage Plan:**

        | Default Quota | Unit |
        | ---- | ---- |
        | 5 | Requests Per Second |

        The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      operationId: getRates
      parameters:
      - name: x-amz-access-token
        in: header
        description: Amazon shipping request token
        required: true
        schema:
          type: string
      - name: x-amzn-shipping-business-id
        in: header
        description: Amazon shipping business to assume for this request. The default
          is AmazonShipping_UK.
        schema:
          type: string
          enum:
          - AmazonShipping_US
          - AmazonShipping_IN
          - AmazonShipping_UK
          - AmazonShipping_IT
          - AmazonShipping_ES
          - AmazonShipping_FR
          x-docgen-enum-table-extension:
          - value: AmazonShipping_US
            description: The United States Amazon shipping business.
          - value: AmazonShipping_IN
            description: The India Amazon shipping business.
          - value: AmazonShipping_UK
            description: The United Kingdom Amazon shipping business.
          - value: AmazonShipping_IT
            description: The Italy Amazon shipping business.
          - value: AmazonShipping_ES
            description: The Spain Amazon shipping business.
          - value: AmazonShipping_FR
            description: The France Amazon shipping business.
        x-docgen-enum-table-extension:
        - value: AmazonShipping_US
          description: The United States Amazon shipping business.
        - value: AmazonShipping_IN
          description: The India Amazon shipping business.
        - value: AmazonShipping_UK
          description: The United Kingdom Amazon shipping business.
        - value: AmazonShipping_IT
          description: The Italy Amazon shipping business.
        - value: AmazonShipping_ES
          description: The Spain Amazon shipping business.
        - value: AmazonShipping_FR
          description: The France Amazon shipping business.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetRatesRequest'
        required: true
      responses:
        "200":
          description: Success.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRatesResponse'
              example:
                requestToken: 6DCCEDD3FF961C15FEB94F342D41C
                rates:
                - rateId: F4B68849F969E239FF9FCA9C12E35
                  carrierId: FOOSHIPGRD
                  carrierName: FOO SHIP GRD
                  billedWeight:
                    value: 5
                    unit: GRAMS
                  totalCharge:
                    value: 7
                    unit: USD
                  serviceId: FOORSID
                  serviceName: FOO RS ID
                  promise:
                    deliveryWindow:
                      start: 2018-08-24T08:22:30.737Z
                      end: 2018-08-24T20:22:30.737Z
                    pickupWindow:
                      start: 2018-08-23T08:22:30.737Z
                      end: 2018-08-23T20:22:30.737Z
                  supportedDocumentSpecifications:
                  - format: PNG
                    size:
                      length: 6
                      width: 4
                      unit: INCH
                    printOptions:
                    - supportedDPIs:
                      - 300
                      - 203
                      supportedPageLayouts:
                      - LEFT
                      - RIGHT
                      supportedFileJoiningOptions:
                      - true
                      - false
                      supportedDocumentDetails:
                      - name: LABEL
                        isMandatory: true
                  - format: ZPL
                    size:
                      length: 6
                      width: 4
                      unit: INCH
                    printOptions:
                    - supportedDPIs:
                      - 300
                      - 203
                      supportedPageLayouts:
                      - LEFT
                      - RIGHT
                      supportedFileJoiningOptions:
                      - true
                      - false
                      supportedDocumentDetails:
                      - name: LABEL
                        isMandatory: true
                  availableValueAddedServiceGroups:
                  - groupId: SIG_VERIFICATION
                    groupDescription: Signature Verification
                    isRequired: true
                    valueAddedServices:
                    - id: CUST_SIG_VERIFICATION
                      name: Customer Signature Verification
                      cost:
                        unit: USD
                        value: 2
                  requiresAdditionalInputs: false
                  rateItemList:
                  - rateItemCharge:
                      unit: INR
                      value: "2.00000"
                    rateItemID: BASE_RATE
                    rateItemNameLocalization: Base Rate
                    rateItemType: MANDATORY
                  - rateItemCharge:
                      unit: INR
                      value: "1.20000"
                    rateItemID: DELIVERY_CONFIRMATION
                    rateItemNameLocalization: Delivery Confirmation
                    rateItemType: INCLUDED
                  - rateItemCharge:
                      unit: INR
                      value: "2.00"
                    rateItemID: VAT
                    rateItemNameLocalization: VAT
                    rateItemType: MANDATORY
                  paymentType: PAY_THROUGH_AMAZON
                  benefits:
                    includedBenefits: []
                    excludedBenefits:
                    - benefit: CLAIMS_PROTECTED
                      reasonCodes:
                      - LATE_DELIVERY_RISK
                ineligibleRates:
                - carrierId: FOOSTDGRD
                  serviceId: FOO8420430
                  carrierName: FOOSTDGRD
                  serviceName: FOO8420430
                  ineligibilityReasons:
                  - code: NO_COVERAGE
                    message: Required shipping network coverage doesn't exist for
                      the offering
        "400":
          description: Request has missing or invalid parameters and cannot be parsed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: Request is missing or has invalid parameters
                  details: ChannelDetails object cannot be null
        "401":
          description: The request's Authorization header is not formatted correctly
            or does not contain a valid token.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested response or the
                    credentials are invalid.
        "403":
          description: "Indicates that access to the resource is forbidden. Possible\
            \ reasons include Access Denied, Unauthorized, Expired Token, or Invalid\
            \ Signature."
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested response or the
                    credentials are invalid.
        "404":
          description: The resource specified does not exist.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: NotFound
                  message: The requested resource is invalid or doesn't exist
        "413":
          description: The request size exceeded the maximum accepted size.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload size is greater than maximum accepted
                    size.
        "415":
          description: The request payload is in an unsupported format.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload format is not supported.
        "429":
          description: The frequency of requests was greater than allowed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: TooManyRequests
                  message: The total number of requests exceeded your allowed limit.
        "500":
          description: An unexpected condition occurred that prevented the server
            from fulfilling the request.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InternalError
                  message: Something went wrong while processing the request.
        "503":
          description: Temporary overloading or maintenance of the server.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: ServiceUnavailable
                  message: Service temporarily unavailable or down for maintenance.
                    Please try again after sometime.
      x-amzn-api-sandbox:
        dynamic: {}
      x-codegen-request-body-name: body
  /shipping/v2/shipments:
    post:
      tags:
      - purchase-shipping
      description: |-
        Purchases a shipping service and returns purchase related details and documents.

        Note: You must complete the purchase within **10 minutes** of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to "TOKEN_EXPIRED". If you receive this error response, you must get the rates for the shipment again.

        **Usage Plan:**

        | Default Quota | Unit |
        | ---- | ---- |
        | 5 | Requests Per Second |

        The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      operationId: purchaseShipment
      parameters:
      - name: x-amz-access-token
        in: header
        description: Amazon shipping request token
        required: true
        schema:
          type: string
      - name: x-amzn-shipping-business-id
        in: header
        description: Amazon shipping business to assume for this request. The default
          is AmazonShipping_UK.
        schema:
          type: string
          enum:
          - AmazonShipping_US
          - AmazonShipping_IN
          - AmazonShipping_UK
          - AmazonShipping_IT
          - AmazonShipping_ES
          - AmazonShipping_FR
          - AmazonShipping_JP
          x-docgen-enum-table-extension:
          - value: AmazonShipping_US
            description: The United States Amazon shipping business.
          - value: AmazonShipping_IN
            description: The India Amazon shipping business.
          - value: AmazonShipping_UK
            description: The United Kingdom Amazon shipping business.
          - value: AmazonShipping_IT
            description: The Italy Amazon shipping business.
          - value: AmazonShipping_ES
            description: The Spain Amazon shipping business.
          - value: AmazonShipping_FR
            description: The France Amazon shipping business.
          - value: AmazonShipping_JP
            description: The Japan Amazon shipping business.
        x-docgen-enum-table-extension:
        - value: AmazonShipping_US
          description: The United States Amazon shipping business.
        - value: AmazonShipping_IN
          description: The India Amazon shipping business.
        - value: AmazonShipping_UK
          description: The United Kingdom Amazon shipping business.
        - value: AmazonShipping_IT
          description: The Italy Amazon shipping business.
        - value: AmazonShipping_ES
          description: The Spain Amazon shipping business.
        - value: AmazonShipping_FR
          description: The France Amazon shipping business.
        - value: AmazonShipping_JP
          description: The Japan Amazon shipping business.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseShipmentRequest'
        required: true
      responses:
        "200":
          description: Success.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseShipmentResponse'
              example:
                shipmentId: "87852211788104"
                packageDocumentDetails:
                - packageClientReferenceId: abcd
                  packageDocuments:
                  - type: LABEL
                    format: PNG
                    contents: sdioadaiosfhdodsaiufhouafhoudfhdouahfac==
                  trackingId: 1578648261977
                promise:
                  pickupWindow:
                    start: 2019-12-11T07:09:05.513Z
                    end: 2019-12-11T09:09:05.513Z
                  deliveryWindow:
                    start: 2019-12-13T07:09:05.513Z
                    end: 2019-12-13T09:09:05.513Z
                benefits:
                  includedBenefits:
                  - CLAIMS_PROTECTED
                  excludedBenefits: []
        "400":
          description: Request has missing or invalid parameters and cannot be parsed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: Request is missing or has invalid parameters
                  details: RateId cannot be null
        "401":
          description: The request's Authorization header is not formatted correctly
            or does not contain a valid token.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested response or the
                    credentials are invalid.
        "403":
          description: "Indicates that access to the resource is forbidden. Possible\
            \ reasons include Access Denied, Unauthorized, Expired Token, or Invalid\
            \ Signature."
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested response or the
                    credentials are invalid.
        "404":
          description: The resource specified does not exist.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: NotFound
                  message: The requested resource is invalid or doesn't exist
        "413":
          description: The request size exceeded the maximum accepted size.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload size is greater than maximum accepted
                    size.
        "415":
          description: The request payload is in an unsupported format.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload format is not supported.
        "429":
          description: The frequency of requests was greater than allowed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: TooManyRequests
                  message: The total number of requests exceeded your allowed limit.
        "500":
          description: An unexpected condition occurred that prevented the server
            from fulfilling the request.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InternalError
                  message: Something went wrong while processing the request.
        "503":
          description: Temporary overloading or maintenance of the server.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: ServiceUnavailable
                  message: Service temporarily unavailable or down for maintenance.
                    Please try again after sometime.
      x-amzn-api-sandbox:
        dynamic: {}
      x-codegen-request-body-name: body
  /shipping/v2/oneClickShipment:
    post:
      tags:
      - smart-purchase-shipping
      description: |-
        Purchases a shipping service identifier and returns purchase-related details and documents.

        **Usage Plan:**

        | Default Quota | Unit |
        | ---- | ---- |
        | 5 | Requests Per Second |

        The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      operationId: oneClickShipment
      parameters:
      - name: x-amz-access-token
        in: header
        description: Amazon shipping request token
        required: true
        schema:
          type: string
      - name: x-amzn-shipping-business-id
        in: header
        description: Amazon shipping business to assume for this request. The default
          is AmazonShipping_UK.
        schema:
          type: string
          enum:
          - AmazonShipping_US
          - AmazonShipping_IN
          - AmazonShipping_UK
          - AmazonShipping_IT
          - AmazonShipping_ES
          - AmazonShipping_FR
          x-docgen-enum-table-extension:
          - value: AmazonShipping_US
            description: The United States Amazon shipping business.
          - value: AmazonShipping_IN
            description: The India Amazon shipping business.
          - value: AmazonShipping_UK
            description: The United Kingdom Amazon shipping business.
          - value: AmazonShipping_IT
            description: The Italy Amazon shipping business.
          - value: AmazonShipping_ES
            description: The Spain Amazon shipping business.
          - value: AmazonShipping_FR
            description: The France Amazon shipping business.
        x-docgen-enum-table-extension:
        - value: AmazonShipping_US
          description: The United States Amazon shipping business.
        - value: AmazonShipping_IN
          description: The India Amazon shipping business.
        - value: AmazonShipping_UK
          description: The United Kingdom Amazon shipping business.
        - value: AmazonShipping_IT
          description: The Italy Amazon shipping business.
        - value: AmazonShipping_ES
          description: The Spain Amazon shipping business.
        - value: AmazonShipping_FR
          description: The France Amazon shipping business.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OneClickShipmentRequest'
        required: true
      responses:
        "200":
          description: Success.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OneClickShipmentResponse'
              example:
                shipmentId: "87852211788104"
                packageDocumentDetails:
                - packageClientReferenceId: '#abcd'
                  packageDocuments:
                  - type: LABEL
                    format: PNG
                    contents: sdioadaiosfhdodsaiufhouafhoudfhdouahfac==
                  trackingId: 1578648261977
                promise:
                  pickupWindow:
                    start: 2019-12-11T07:09:05.513Z
                    end: 2019-12-11T09:09:05.513Z
                  deliveryWindow:
                    start: 2019-12-13T07:09:05.513Z
                    end: 2019-12-13T09:09:05.513Z
                carrier:
                  id: AMZN_UK
                  name: Amazon Shipping
                service:
                  id: SWA-UK-PREM
                  name: Amazon Shipping One Day
                totalCharge:
                  unit: GBP
                  value: 4.76
        "400":
          description: Request has missing or invalid parameters and cannot be parsed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: Request is missing or has invalid parameters
                  details: ServiceId cannot be null
        "401":
          description: The request's Authorization header is not formatted correctly
            or does not contain a valid token.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested response or the
                    credentials are invalid.
        "403":
          description: "Indicates that access to the resource is forbidden. Possible\
            \ reasons include Access Denied, Unauthorized, Expired Token, or Invalid\
            \ Signature."
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested response or the
                    credentials are invalid.
        "404":
          description: The resource specified does not exist.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: NotFound
                  message: The requested resource is invalid or doesn't exist
        "413":
          description: The request size exceeded the maximum accepted size.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload size is greater than maximum accepted
                    size.
        "415":
          description: The request payload is in an unsupported format.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload format is not supported.
        "429":
          description: The frequency of requests was greater than allowed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: TooManyRequests
                  message: The total number of requests exceeded your allowed limit.
        "500":
          description: An unexpected condition occurred that prevented the server
            from fulfilling the request.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InternalError
                  message: Something went wrong while processing the request.
        "503":
          description: Temporary overloading or maintenance of the server.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: ServiceUnavailable
                  message: Service temporarily unavailable or down for maintenance.
                    Please try again after sometime.
      x-amzn-api-sandbox:
        dynamic: {}
      x-codegen-request-body-name: body
  /shipping/v2/tracking:
    get:
      tags:
      - shipping-tracking
      description: |-
        Returns tracking information for a purchased shipment.

        **Usage Plan:**

        | Default Quota | Unit |
        | ---- | ---- |
        | 5 | Requests Per Second |

        The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      operationId: getTracking
      parameters:
      - name: trackingId
        in: query
        description: A carrier-generated tracking identifier originally returned by
          the purchaseShipment operation.
        required: true
        schema:
          type: string
      - name: carrierId
        in: query
        description: A carrier identifier originally returned by the getRates operation
          for the selected rate.
        required: true
        schema:
          type: string
      - name: x-amz-access-token
        in: header
        description: Amazon shipping request token
        required: true
        schema:
          type: string
      - name: x-amzn-shipping-business-id
        in: header
        description: Amazon shipping business to assume for this request. The default
          is AmazonShipping_UK.
        schema:
          type: string
          enum:
          - AmazonShipping_US
          - AmazonShipping_IN
          - AmazonShipping_UK
          - AmazonShipping_IT
          - AmazonShipping_ES
          - AmazonShipping_FR
          x-docgen-enum-table-extension:
          - value: AmazonShipping_US
            description: The United States Amazon shipping business.
          - value: AmazonShipping_IN
            description: The India Amazon shipping business.
          - value: AmazonShipping_UK
            description: The United Kingdom Amazon shipping business.
          - value: AmazonShipping_IT
            description: The Italy Amazon shipping business.
          - value: AmazonShipping_ES
            description: The Spain Amazon shipping business.
          - value: AmazonShipping_FR
            description: The France Amazon shipping business.
        x-docgen-enum-table-extension:
        - value: AmazonShipping_US
          description: The United States Amazon shipping business.
        - value: AmazonShipping_IN
          description: The India Amazon shipping business.
        - value: AmazonShipping_UK
          description: The United Kingdom Amazon shipping business.
        - value: AmazonShipping_IT
          description: The Italy Amazon shipping business.
        - value: AmazonShipping_ES
          description: The Spain Amazon shipping business.
        - value: AmazonShipping_FR
          description: The France Amazon shipping business.
      responses:
        "200":
          description: Success.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTrackingResponse'
              example:
                trackingId: 23AA47DE2B3B6
                alternateLegTrackingId: "null"
                eventHistory:
                - eventCode: Undeliverable
                  location:
                    postalCode: EX33 2JL
                    countryCode: GB
                  eventTime: 2024-02-11T07:09:05.513Z
                  shipmentType: FORWARD
                - eventCode: ReturnInitiated
                  location:
                    postalCode: EX33 2JL
                    countryCode: GB
                  eventTime: 2024-02-12T09:09:05.513Z
                  shipmentType: RETURNS
                - eventCode: Delivered
                  location:
                    postalCode: EX33 2JL
                    countryCode: GB
                  eventTime: 2024-02-13T04:09:05.513Z
                  shipmentType: RETURNS
                promisedDeliveryDate: 2024-02-12T13:09:05.513Z
                summary:
                  status: Delivered
                  trackingDetailCodes:
                    forward:
                    - Rejected
                    - Damaged
                    returns:
                    - Signed
        "400":
          description: Request has missing or invalid parameters and cannot be parsed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: Request is missing or has invalid parameters
                  details: CarrierId is missing in the request
        "401":
          description: The request's Authorization header is not formatted correctly
            or does not contain a valid token.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested response or the
                    credentials are invalid.
        "403":
          description: "Indicates that access to the resource is forbidden. Possible\
            \ reasons include Access Denied, Unauthorized, Expired Token, or Invalid\
            \ Signature."
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested response or the
                    credentials are invalid.
        "404":
          description: The resource specified does not exist.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: NotFound
                  message: The requested resource is invalid or doesn't exist
        "413":
          description: The request size exceeded the maximum accepted size.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload size is greater than maximum accepted
                    size.
        "415":
          description: The request payload is in an unsupported format.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload format is not supported.
        "429":
          description: The frequency of requests was greater than allowed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: TooManyRequests
                  message: The total number of requests exceeded your allowed limit.
        "500":
          description: An unexpected condition occurred that prevented the server
            from fulfilling the request.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InternalError
                  message: Something went wrong while processing the request.
        "503":
          description: Temporary overloading or maintenance of the server.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: ServiceUnavailable
                  message: Service temporarily unavailable or down for maintenance.
                    Please try again after sometime.
      x-amzn-api-sandbox:
        dynamic: {}
  /shipping/v2/shipments/{shipmentId}/documents:
    get:
      tags:
      - shipping-documents
      description: |-
        Returns the shipping documents associated with a package in a shipment.

        **Usage Plan:**

        | Default Quota | Unit |
        | ---- | ---- |
        | 5 | Requests Per Second |

        The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      operationId: getShipmentDocuments
      parameters:
      - name: shipmentId
        in: path
        description: The shipment identifier originally returned by the purchaseShipment
          operation.
        required: true
        schema:
          type: string
      - name: packageClientReferenceId
        in: query
        description: The package client reference identifier originally provided in
          the request body parameter for the getRates operation.
        required: true
        schema:
          type: string
      - name: format
        in: query
        description: The file format of the document. Must be one of the supported
          formats returned by the getRates operation.
        schema:
          type: string
      - name: dpi
        in: query
        description: "The resolution of the document (for example, 300 means 300 dots\
          \ per inch). Must be one of the supported resolutions returned in the response\
          \ to the getRates operation."
        schema:
          type: number
      - name: x-amz-access-token
        in: header
        description: Amazon shipping request token
        required: true
        schema:
          type: string
      - name: x-amzn-shipping-business-id
        in: header
        description: Amazon shipping business to assume for this request. The default
          is AmazonShipping_UK.
        schema:
          type: string
          enum:
          - AmazonShipping_US
          - AmazonShipping_IN
          - AmazonShipping_UK
          - AmazonShipping_IT
          - AmazonShipping_ES
          - AmazonShipping_FR
          x-docgen-enum-table-extension:
          - value: AmazonShipping_US
            description: The United States Amazon shipping business.
          - value: AmazonShipping_IN
            description: The India Amazon shipping business.
          - value: AmazonShipping_UK
            description: The United Kingdom Amazon shipping business.
          - value: AmazonShipping_IT
            description: The Italy Amazon shipping business.
          - value: AmazonShipping_ES
            description: The Spain Amazon shipping business.
          - value: AmazonShipping_FR
            description: The France Amazon shipping business.
        x-docgen-enum-table-extension:
        - value: AmazonShipping_US
          description: The United States Amazon shipping business.
        - value: AmazonShipping_IN
          description: The India Amazon shipping business.
        - value: AmazonShipping_UK
          description: The United Kingdom Amazon shipping business.
        - value: AmazonShipping_IT
          description: The Italy Amazon shipping business.
        - value: AmazonShipping_ES
          description: The Spain Amazon shipping business.
        - value: AmazonShipping_FR
          description: The France Amazon shipping business.
      responses:
        "200":
          description: Success.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetShipmentDocumentsResponse'
              example:
                shipmentId: 445454-3232-3232
                packageDocumentDetail:
                  packageClientReferenceId: ASUSDI-45343854
                  trackingId: T1234567
                  packageDocuments:
                  - type: LABEL
                    format: PNG
                    contents: sdioadaiosfhdodsaiufhouafhoudfhdouahfac==
                  benefits:
                    includedBenefits:
                    - CLAIMS_PROTECTED
                    excludedBenefits: []
        "400":
          description: Request has missing or invalid parameters and cannot be parsed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: Request is missing or has invalid parameters
                  details: shipmentId is missing in the request
        "401":
          description: The request's Authorization header is not formatted correctly
            or does not contain a valid token.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested response or the
                    credentials are invalid.
        "403":
          description: "Indicates that access to the resource is forbidden. Possible\
            \ reasons include Access Denied, Unauthorized, Expired Token, or Invalid\
            \ Signature."
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested response or the
                    credentials are invalid.
        "404":
          description: The resource specified does not exist.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: NotFound
                  message: The requested resource is invalid or doesn't exist
        "413":
          description: The request size exceeded the maximum accepted size.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload size is greater than maximum accepted
                    size.
        "415":
          description: The request payload is in an unsupported format.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload format is not supported.
        "429":
          description: The frequency of requests was greater than allowed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: TooManyRequests
                  message: The total number of requests exceeded your allowed limit.
        "500":
          description: An unexpected condition occurred that prevented the server
            from fulfilling the request.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InternalError
                  message: Something went wrong while processing the request.
        "503":
          description: Temporary overloading or maintenance of the server.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: ServiceUnavailable
                  message: Service temporarily unavailable or down for maintenance.
                    Please try again after sometime.
      x-amzn-api-sandbox:
        dynamic: {}
  /shipping/v2/shipments/{shipmentId}/cancel:
    put:
      tags:
      - cancel-shipping
      description: |-
        Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled.

        **Usage Plan:**

        | Default Quota | Unit |
        | ---- | ---- |
        | 5 | Requests Per Second |

        The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      operationId: cancelShipment
      parameters:
      - name: shipmentId
        in: path
        description: The shipment identifier originally returned by the purchaseShipment
          operation.
        required: true
        schema:
          type: string
      - name: x-amz-access-token
        in: header
        description: Amazon shipping request token
        required: true
        schema:
          type: string
      - name: x-amzn-shipping-business-id
        in: header
        description: Amazon shipping business to assume for this request. The default
          is AmazonShipping_UK.
        schema:
          type: string
          enum:
          - AmazonShipping_US
          - AmazonShipping_IN
          - AmazonShipping_UK
          - AmazonShipping_IT
          - AmazonShipping_ES
          - AmazonShipping_FR
          x-docgen-enum-table-extension:
          - value: AmazonShipping_US
            description: The United States Amazon shipping business.
          - value: AmazonShipping_IN
            description: The India Amazon shipping business.
          - value: AmazonShipping_UK
            description: The United Kingdom Amazon shipping business.
          - value: AmazonShipping_IT
            description: The Italy Amazon shipping business.
          - value: AmazonShipping_ES
            description: The Spain Amazon shipping business.
          - value: AmazonShipping_FR
            description: The France Amazon shipping business.
        x-docgen-enum-table-extension:
        - value: AmazonShipping_US
          description: The United States Amazon shipping business.
        - value: AmazonShipping_IN
          description: The India Amazon shipping business.
        - value: AmazonShipping_UK
          description: The United Kingdom Amazon shipping business.
        - value: AmazonShipping_IT
          description: The Italy Amazon shipping business.
        - value: AmazonShipping_ES
          description: The Spain Amazon shipping business.
        - value: AmazonShipping_FR
          description: The France Amazon shipping business.
      responses:
        "200":
          description: Success.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelShipmentResponse'
              example: {}
        "400":
          description: Request has missing or invalid parameters and cannot be parsed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: Request is missing or has invalid parameters
                  details: ShipmentId cannot be null
        "401":
          description: The request's Authorization header is not formatted correctly
            or does not contain a valid token.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested response or the
                    credentials are invalid.
        "403":
          description: "Indicates that access to the resource is forbidden. Possible\
            \ reasons include Access Denied, Unauthorized, Expired Token, or Invalid\
            \ Signature."
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested response or the
                    credentials are invalid.
        "404":
          description: The resource specified does not exist.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: NotFound
                  message: The requested resource is invalid or doesn't exist
        "413":
          description: The request size exceeded the maximum accepted size.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload size is greater than maximum accepted
                    size.
        "415":
          description: The request payload is in an unsupported format.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload format is not supported.
        "429":
          description: The frequency of requests was greater than allowed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: TooManyRequests
                  message: The total number of requests exceeded your allowed limit.
        "500":
          description: An unexpected condition occurred that prevented the server
            from fulfilling the request.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InternalError
                  message: Something went wrong while processing the request.
        "503":
          description: Temporary overloading or maintenance of the server.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: ServiceUnavailable
                  message: Service temporarily unavailable or down for maintenance.
                    Please try again after sometime.
      x-amzn-api-sandbox:
        dynamic: {}
  /shipping/v2/accessPoints:
    get:
      tags:
      - shipping-access-points
      description: |-
        Returns a list of access points in proximity of input postal code.

        **Usage Plan:**

        | Default Quota | Unit |
        | ---- | ---- |
        | 5 | Requests Per Second |

        The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      operationId: getAccessPoints
      parameters:
      - name: accessPointTypes
        in: query
        description: Access point types
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - HELIX
            - CAMPUS_LOCKER
            - OMNI_LOCKER
            - ODIN_LOCKER
            - DOBBY_LOCKER
            - CORE_LOCKER
            - 3P
            - CAMPUS_ROOM
          x-docgen-enum-table-extension:
          - value: HELIX
            description: "Counter, aka Helix, is an assisted access point where customers\
              \ interact with a store associate to collect or return packages. Counter\
              \ stores do not have Locker"
          - value: CAMPUS_LOCKER
            description: It denotes a physical Locker present at Locker+ stores
          - value: OMNI_LOCKER
            description: Omni lockers are similar to core lockers installed at apartment
              buildings. Core and Omni will have common base hardware platform
          - value: ODIN_LOCKER
            description: "Odin lockers rely on Bluetooth connection as there is no\
              \ screen or scanner on the locker. Drivers, customers, and even technicians\
              \ can interact with the locker using an app (different depending on\
              \ the user)."
          - value: DOBBY_LOCKER
            description: Dobby lockers are Odin lockers installed at apartment complexes
              and available only to residents.
          - value: CORE_LOCKER
            description: "Core lockers are the traditional and initial style of lockers\
              \ when Hub was launched. Core lockers have a screen, keypad and scanner.\
              \  Customer either enter their pickup code using the Locker screen or\
              \ scan pickup code barcode to pick up their package."
          - value: 3P
            description: "Networks that are owned end-to-end by commercial carriers\
              \ (CC - e.g. DHL, UPS, DPD and Postal organizations), who operate both\
              \ the transportation leg and the access point aspect. These networks\
              \ offer a range of pickup points including: 3P Lockers, legacy Postal\
              \ Offices, 3P Counters (e.g. Gas Stations and Retail Outlets - supermarkets,\
              \ bookstores, news-stands etc)."
          - value: CAMPUS_ROOM
            description: "Locker+, formerly known as Campus, are attended, physical\
              \ stores, where the Locker is used dynamically by the staff to keep\
              \ packages ready for customer pickup. Locker+ store can have multiple\
              \ Lockers installed,"
        x-docgen-enum-table-extension:
        - value: HELIX
          description: "Counter, aka Helix, is an assisted access point where customers\
            \ interact with a store associate to collect or return packages. Counter\
            \ stores do not have Locker"
        - value: CAMPUS_LOCKER
          description: It denotes a physical Locker present at Locker+ stores
        - value: OMNI_LOCKER
          description: Omni lockers are similar to core lockers installed at apartment
            buildings. Core and Omni will have common base hardware platform
        - value: ODIN_LOCKER
          description: "Odin lockers rely on Bluetooth connection as there is no screen\
            \ or scanner on the locker. Drivers, customers, and even technicians can\
            \ interact with the locker using an app (different depending on the user)."
        - value: DOBBY_LOCKER
          description: Dobby lockers are Odin lockers installed at apartment complexes
            and available only to residents.
        - value: CORE_LOCKER
          description: "Core lockers are the traditional and initial style of lockers\
            \ when Hub was launched. Core lockers have a screen, keypad and scanner.\
            \  Customer either enter their pickup code using the Locker screen or\
            \ scan pickup code barcode to pick up their package."
        - value: 3P
          description: "Networks that are owned end-to-end by commercial carriers\
            \ (CC - e.g. DHL, UPS, DPD and Postal organizations), who operate both\
            \ the transportation leg and the access point aspect. These networks offer\
            \ a range of pickup points including: 3P Lockers, legacy Postal Offices,\
            \ 3P Counters (e.g. Gas Stations and Retail Outlets - supermarkets, bookstores,\
            \ news-stands etc)."
        - value: CAMPUS_ROOM
          description: "Locker+, formerly known as Campus, are attended, physical\
            \ stores, where the Locker is used dynamically by the staff to keep packages\
            \ ready for customer pickup. Locker+ store can have multiple Lockers installed,"
      - name: countryCode
        in: query
        description: Country code for access point
        required: true
        schema:
          type: string
        example: US
      - name: postalCode
        in: query
        description: postal code for access point
        required: true
        schema:
          type: string
        example: EX332JL
      - name: x-amz-access-token
        in: header
        description: Amazon shipping request token
        required: true
        schema:
          type: string
      - name: x-amzn-shipping-business-id
        in: header
        description: Amazon shipping business to assume for this request. The default
          is AmazonShipping_UK.
        schema:
          type: string
          enum:
          - AmazonShipping_US
          - AmazonShipping_IN
          - AmazonShipping_UK
          - AmazonShipping_IT
          - AmazonShipping_ES
          - AmazonShipping_FR
          x-docgen-enum-table-extension:
          - value: AmazonShipping_US
            description: The United States Amazon shipping business.
          - value: AmazonShipping_IN
            description: The India Amazon shipping business.
          - value: AmazonShipping_UK
            description: The United Kingdom Amazon shipping business.
          - value: AmazonShipping_IT
            description: The Italy Amazon shipping business.
          - value: AmazonShipping_ES
            description: The Spain Amazon shipping business.
          - value: AmazonShipping_FR
            description: The France Amazon shipping business.
        x-docgen-enum-table-extension:
        - value: AmazonShipping_US
          description: The United States Amazon shipping business.
        - value: AmazonShipping_IN
          description: The India Amazon shipping business.
        - value: AmazonShipping_UK
          description: The United Kingdom Amazon shipping business.
        - value: AmazonShipping_IT
          description: The Italy Amazon shipping business.
        - value: AmazonShipping_ES
          description: The Spain Amazon shipping business.
        - value: AmazonShipping_FR
          description: The France Amazon shipping business.
      responses:
        "200":
          description: Success.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccessPointsResponse'
              example:
                HELIX:
                  accessPointId: 00046c4b-bb0a-4c03-831e-5633e142f16a
                  name: Amazon Hub Counter - Co-op Braunton
                  timezone: Europe/London
                  type: HELIX
                  accessibilityAttributes:
                    distance: "21.200000762939453"
                    driveTime: "0.0"
                  address:
                    addressObject:
                      addressLine1: Exeter Road
                      city: Braunton
                      countryCode: GB
                      zipOrPostalCode: EX33 2JL
                    geocode:
                      latitude: "51.1076671"
                      longitude: "-4.1607301"
                  exceptionOperatingHours:
                  - dateRange:
                      endDate: 1.6932672E9
                      startDate: 1.6931808E9
                    operatingHours:
                      closingTime:
                        hourOfDay: 0
                        minuteOfHour: 0
                        secondOfMinute: 0
                      midDayClosures: []
                      openingTime:
                        hourOfDay: 0
                        minuteOfHour: 0
                        secondOfMinute: 0
                  assistanceType: STAFF_ASSISTED
                  score: "0.6688068509101868"
                  standardOperatingHours:
                    WEDNESDAY:
                      closingTime:
                        hourOfDay: 22
                        minuteOfHour: 0
                        secondOfMinute: 0
                      midDayClosures: []
                      openingTime:
                        hourOfDay: 7
                        minuteOfHour: 0
                        secondOfMinute: 0
                    MONDAY:
                      closingTime:
                        hourOfDay: 22
                        minuteOfHour: 0
                        secondOfMinute: 0
                      midDayClosures: []
                      openingTime:
                        hourOfDay: 7
                        minuteOfHour: 0
                        secondOfMinute: 0
                    THURSDAY:
                      closingTime:
                        hourOfDay: 22
                        minuteOfHour: 0
                        secondOfMinute: 0
                      midDayClosures: []
                      openingTime:
                        hourOfDay: 7
                        minuteOfHour: 0
                        secondOfMinute: 0
                    SUNDAY:
                      closingTime:
                        hourOfDay: 22
                        minuteOfHour: 0
                        secondOfMinute: 0
                      midDayClosures: []
                      openingTime:
                        hourOfDay: 7
                        minuteOfHour: 0
                        secondOfMinute: 0
                    TUESDAY:
                      closingTime:
                        hourOfDay: 22
                        minuteOfHour: 0
                        secondOfMinute: 0
                      midDayClosures: []
                      openingTime:
                        hourOfDay: 7
                        minuteOfHour: 0
                        secondOfMinute: 0
                    FRIDAY:
                      closingTime:
                        hourOfDay: 22
                        minuteOfHour: 0
                        secondOfMinute: 0
                      midDayClosures: []
                      openingTime:
                        hourOfDay: 7
                        minuteOfHour: 0
                        secondOfMinute: 0
                    SATURDAY:
                      closingTime:
                        hourOfDay: 22
                        minuteOfHour: 0
                        secondOfMinute: 0
                      midDayClosures: []
                      openingTime:
                        hourOfDay: 7
                        minuteOfHour: 0
                        secondOfMinute: 0
        "400":
          description: Request has missing or invalid parameters and cannot be parsed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: Request is missing or has invalid parameters
                  details: Access Point types cannot be null
        "401":
          description: The request's Authorization header is not formatted correctly
            or does not contain a valid token.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested response or the
                    credentials are invalid.
        "403":
          description: "Indicates that access to the resource is forbidden. Possible\
            \ reasons include Access Denied, Unauthorized, Expired Token, or Invalid\
            \ Signature."
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested response or the
                    credentials are invalid.
        "404":
          description: The resource specified does not exist.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: NotFound
                  message: The requested resource is invalid or doesn't exist
        "413":
          description: The request size exceeded the maximum accepted size.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload size is greater than maximum accepted
                    size.
        "415":
          description: The request payload is in an unsupported format.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload format is not supported.
        "429":
          description: The frequency of requests was greater than allowed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: TooManyRequests
                  message: The total number of requests exceeded your allowed limit.
        "500":
          description: An unexpected condition occurred that prevented the server
            from fulfilling the request.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InternalError
                  message: Something went wrong while processing the request.
        "503":
          description: Temporary overloading or maintenance of the server.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: ServiceUnavailable
                  message: Service temporarily unavailable or down for maintenance.
                    Please try again after sometime.
      x-amzn-api-sandbox:
        dynamic: {}
  /shipping/v2/ndrFeedback:
    post:
      tags:
      - submit-ndr-shipping
      description: |-
        This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment.

        **Usage Plan:**

        | Default Quota | Unit |
        | ---- | ---- |
        | 5 | Requests Per Second |

        The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).
      operationId: submitNdrFeedback
      parameters:
      - name: x-amz-access-token
        in: header
        description: Amazon shipping request token
        required: true
        schema:
          type: string
      - name: x-amzn-shipping-business-id
        in: header
        description: Amazon shipping business to assume for this request. The default
          is AmazonShipping_UK.
        schema:
          type: string
          enum:
          - AmazonShipping_US
          - AmazonShipping_IN
          - AmazonShipping_UK
          - AmazonShipping_IT
          - AmazonShipping_ES
          - AmazonShipping_FR
          x-docgen-enum-table-extension:
          - value: AmazonShipping_US
            description: The United States Amazon shipping business.
          - value: AmazonShipping_IN
            description: The India Amazon shipping business.
          - value: AmazonShipping_UK
            description: The United Kingdom Amazon shipping business.
          - value: AmazonShipping_IT
            description: The Italy Amazon shipping business.
          - value: AmazonShipping_ES
            description: The Spain Amazon shipping business.
          - value: AmazonShipping_FR
            description: The France Amazon shipping business.
        x-docgen-enum-table-extension:
        - value: AmazonShipping_US
          description: The United States Amazon shipping business.
        - value: AmazonShipping_IN
          description: The India Amazon shipping business.
        - value: AmazonShipping_UK
          description: The United Kingdom Amazon shipping business.
        - value: AmazonShipping_IT
          description: The Italy Amazon shipping business.
        - value: AmazonShipping_ES
          description: The Spain Amazon shipping business.
        - value: AmazonShipping_FR
          description: The France Amazon shipping business.
      requestBody:
        description: Request body for ndrFeedback operation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitNdrFeedbackRequest'
        required: true
      responses:
        "204":
          description: Success
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content: {}
        "400":
          description: Request has missing or invalid parameters and cannot be parsed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: Request is missing or has invalid parameters
                  details: RescheduleDate is missing in the request
        "401":
          description: The request's Authorization header is not formatted correctly
            or does not contain a valid token.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested resource or the
                    credentials are invalid.
        "403":
          description: "Indicates that access to the resource is forbidden. Possible\
            \ reasons include Access Denied, Unauthorized, Expired Token, or Invalid\
            \ Signature."
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested resource or the
                    credentials are invalid.
        "404":
          description: The resource specified does not exist.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: NotFound
                  message: The requested resource is invalid or doesn't exist
        "413":
          description: The request size exceeded the maximum accepted size.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload size is greater than maximum accepted
                    size.
        "415":
          description: The request payload is in an unsupported format.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload format is not supported.
        "429":
          description: The frequency of requests was greater than allowed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: TooManyRequests
                  message: The total number of requests exceeded your allowed limit.
        "500":
          description: An unexpected condition occurred that prevented the server
            from fulfilling the request.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InternalError
                  message: Something went wrong while processing the request.
        "503":
          description: Temporary overloading or maintenance of the server.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: ServiceUnavailable
                  message: Service temporarily unavailable or down for maintenance.
                    Please try again after sometime.
      x-amzn-api-sandbox:
        dynamic: {}
      x-codegen-request-body-name: body
  /shipping/v2/shipments/additionalInputs/schema:
    get:
      tags:
      - additional-inputs-shipping
      description: |-
        Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase.

        **Usage Plan:**

        | Default Quota | Unit |
        | ---- | ---- |
        | 5 | Requests Per Second |

        The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      operationId: getAdditionalInputs
      parameters:
      - name: requestToken
        in: query
        description: The request token returned in the response to the getRates operation.
        required: true
        schema:
          type: string
      - name: rateId
        in: query
        description: The rate identifier for the shipping offering (rate) returned
          in the response to the getRates operation.
        required: true
        schema:
          type: string
      - name: x-amz-access-token
        in: header
        description: Amazon shipping request token
        required: true
        schema:
          type: string
      - name: x-amzn-shipping-business-id
        in: header
        description: Amazon shipping business to assume for this request. The default
          is AmazonShipping_UK.
        schema:
          type: string
          enum:
          - AmazonShipping_US
          - AmazonShipping_IN
          - AmazonShipping_UK
          - AmazonShipping_IT
          - AmazonShipping_ES
          - AmazonShipping_FR
          x-docgen-enum-table-extension:
          - value: AmazonShipping_US
            description: The United States Amazon shipping business.
          - value: AmazonShipping_IN
            description: The India Amazon shipping business.
          - value: AmazonShipping_UK
            description: The United Kingdom Amazon shipping business.
          - value: AmazonShipping_IT
            description: The Italy Amazon shipping business.
          - value: AmazonShipping_ES
            description: The Spain Amazon shipping business.
          - value: AmazonShipping_FR
            description: The France Amazon shipping business.
        x-docgen-enum-table-extension:
        - value: AmazonShipping_US
          description: The United States Amazon shipping business.
        - value: AmazonShipping_IN
          description: The India Amazon shipping business.
        - value: AmazonShipping_UK
          description: The United Kingdom Amazon shipping business.
        - value: AmazonShipping_IT
          description: The Italy Amazon shipping business.
        - value: AmazonShipping_ES
          description: The Spain Amazon shipping business.
        - value: AmazonShipping_FR
          description: The France Amazon shipping business.
      responses:
        "200":
          description: Success.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAdditionalInputsResponse'
              example:
                payload:
                  properties:
                    harmonizedSystemCode:
                      type: string
                      description: Harmonized System's commodity code for an item.
                    packageClientReferenceId:
                      type: string
                      description: Unique identifier for the item.
          x-amzn-api-sandbox:
            static:
            - request:
                parameters:
                  requestToken:
                    value: amzn1.rq.123456789.101
                  rateId:
                    value: "122324234543535321345436534321423423523452345"
              response:
                payload: {}
        "400":
          description: Request has missing or invalid parameters and cannot be parsed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: Request is missing or has invalid parameters
                  details: RequestToken cannot be null
          x-amzn-api-sandbox:
            static:
            - request:
                parameters:
                  requestToken:
                    value: "null"
                  rateId:
                    value: "2314346237423894905834905890346890789075"
              response:
                errors:
                - code: InvalidRequest
                  message: Request is missing or has invalid parameters
                  details: RequestToken cannot be null
        "401":
          description: The request's Authorization header is not formatted correctly
            or does not contain a valid token.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested response or the
                    credentials are invalid.
        "403":
          description: "Indicates that access to the resource is forbidden. Possible\
            \ reasons include Access Denied, Unauthorized, Expired Token, or Invalid\
            \ Signature."
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: Unauthorized
                  message: You don't have access to the requested response or the
                    credentials are invalid.
        "404":
          description: The resource specified does not exist.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: Your rate limit (requests per second) for this operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: NotFound
                  message: The requested resource is invalid or doesn't exist
        "413":
          description: The request size exceeded the maximum accepted size.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload size is greater than maximum accepted
                    size.
        "415":
          description: The request payload is in an unsupported format.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InvalidRequest
                  message: The request payload format is not supported.
        "429":
          description: The frequency of requests was greater than allowed.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: TooManyRequests
                  message: The total number of requests exceeded your allowed limit.
        "500":
          description: An unexpected condition occurred that prevented the server
            from fulfilling the request.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: InternalError
                  message: Something went wrong while processing the request.
        "503":
          description: Temporary overloading or maintenance of the server.
          headers:
            x-amzn-RequestId:
              description: Unique request reference identifier.
              schema:
                type: string
            x-amzn-RateLimit-Limit:
              description: |-
                Your rate limit (requests per second) for this operation.
                _Note:_ For this status code, the rate limit header is deprecated and no longer returned.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - code: ServiceUnavailable
                  message: Service temporarily unavailable or down for maintenance.
                    Please try again after sometime.
components:
  schemas:
    Error:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
          description: An error code that identifies the type of error that occurred.
        message:
          type: string
          description: A message that describes the error condition.
        details:
          type: string
          description: Additional details that can help the caller understand or fix
            the issue.
      description: Error response returned when the request is unsuccessful.
    ErrorList:
      required:
      - errors
      type: object
      properties:
        errors:
          type: array
          description: Array of Errors
          items:
            $ref: '#/components/schemas/Error'
      description: A list of error responses returned when a request is unsuccessful.
    Weight:
      required:
      - unit
      - value
      type: object
      properties:
        unit:
          type: string
          description: The unit of measurement.
          enum:
          - GRAM
          - KILOGRAM
          - OUNCE
          - POUND
          x-docgen-enum-table-extension:
          - value: GRAM
            description: Metric unit of mass equal to one thousandth of a kilogram.
          - value: KILOGRAM
            description: Metric unit of mass.
          - value: OUNCE
            description: The imperial unit of weight that is one sixteenth of a pound.
          - value: POUND
            description: The imperial unit of weight.
        value:
          type: number
          description: The measurement value.
      description: The weight in the units indicated.
    LiquidVolume:
      required:
      - unit
      - value
      type: object
      properties:
        unit:
          type: string
          description: The unit of measurement.
          enum:
          - ML
          - L
          - FL_OZ
          - GAL
          - PT
          - QT
          - C
          x-docgen-enum-table-extension:
          - value: ML
            description: Milliliter - Metric unit of volume.
          - value: L
            description: Liter - Metric unit of volume.
          - value: FL_OZ
            description: Fluid Ounce - Imperial unit of volume.
          - value: GAL
            description: Gallon - Imperial unit of volume.
          - value: PT
            description: Pint - Imperial unit of volume.
          - value: QT
            description: Quart - Imperial unit of volume.
          - value: C
            description: Cup - Imperial unit of volume.
        value:
          type: number
          description: The measurement value.
      description: Liquid Volume.
    InvoiceDetails:
      type: object
      properties:
        invoiceNumber:
          type: string
          description: The invoice number of the item.
        invoiceDate:
          type: string
          description: The invoice date of the item in ISO 8061 format.
          format: date-time
      description: The invoice details for charges associated with the goods in the
        package. Only applies to certain regions.
    ChargeList:
      type: array
      description: A list of charges based on the shipping service charges applied
        on a package.
      items:
        $ref: '#/components/schemas/ChargeComponent'
    ChargeComponent:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/Currency'
        chargeType:
          type: string
          description: The type of charge.
          enum:
          - TAX
          - DISCOUNT
          x-docgen-enum-table-extension:
          - value: TAX
            description: A tax imposed on a package.
          - value: DISCOUNT
            description: A discount deducted from the cost of a package.
      description: The type and amount of a charge applied on a package.
    Currency:
      required:
      - unit
      - value
      type: object
      properties:
        value:
          type: number
          description: The monetary value.
        unit:
          maxLength: 3
          minLength: 3
          type: string
          description: The ISO 4217 format 3-character currency code.
      description: "The monetary value in the currency indicated, in ISO 4217 standard\
        \ format."
    Dimensions:
      required:
      - height
      - length
      - unit
      - width
      type: object
      properties:
        length:
          type: number
          description: The length of the package.
        width:
          type: number
          description: The width of the package.
        height:
          type: number
          description: The height of the package.
        unit:
          type: string
          description: The unit of measurement.
          enum:
          - INCH
          - CENTIMETER
          x-docgen-enum-table-extension:
          - value: INCH
            description: The imperial unit of length equal to one twelfth of a foot.
          - value: CENTIMETER
            description: "A metric unit of length, equal to one hundredth of a meter."
      description: A set of measurements for a three-dimensional object.
    RequestToken:
      type: string
      description: A unique token generated to identify a getRates operation.
    RateId:
      type: string
      description: An identifier for the rate (shipment offering) provided by a shipping
        service provider.
    CarrierId:
      type: string
      description: "The carrier identifier for the offering, provided by the carrier."
    CarrierName:
      type: string
      description: The carrier name for the offering.
    PackageClientReferenceId:
      type: string
      description: A client provided unique identifier for a package being shipped.
        This value should be saved by the client to pass as a parameter to the getShipmentDocuments
        operation.
    AdditionalPackageInfo:
      type: array
      description: Additional information about the package provided by Shipper
      items:
        required:
        - name
        - value
        type: object
        properties:
          name:
            type: string
            description: The name of the information content being sent along with
              the package
            enum:
            - PURCHASE_ORDER_NUMBER
            x-docgen-enum-table-extension:
            - value: PURCHASE_ORDER_NUMBER
              description: Specifies the Purchase Order number.
          value:
            type: string
            description: The value of the information content being sent along with
              the package
    ShipmentId:
      type: string
      description: The unique shipment identifier provided by a shipping service.
    DetailCodes:
      type: string
      description: A list of codes used to provide additional shipment information.
      enum:
      - BusinessClosed
      - CustomerUnavailable
      - PaymentNotReady
      - OtpNotAvailable
      - DeliveryAttempted
      - UnableToAccess
      - UnableToContactRecipient
      - DeliveredToBehindWheelieBin
      - DeliveredToPorch
      - DeliveredToGarage
      - DeliveredToGarden
      - DeliveredToGreenhouse
      - DeliveredToMailSlot
      - DeliveredToMailRoom
      - DeliveredToNeighbor
      - DeliveredToRearDoor
      - DeliveredToReceptionist
      - DeliveredToShed
      - DeliveredWithOTP
      - Signed
      - Damaged
      - IncorrectItems
      - NotRequired
      - Rejected
      - RejectedByRecipientWithVerification
      - CancelledByRecipient
      - AddressNotFound
      - HazmatShipment
      - Undeliverable
      - ArrivedAtLocalFacility
      x-docgen-enum-table-extension:
      - value: BusinessClosed
        description: Attempted delivery but the business was closed.
      - value: CustomerUnavailable
        description: Attempted delivery but the recipient was unavailable.
      - value: PaymentNotReady
        description: Attempted delivery but cash was not available from recipient.
      - value: OtpNotAvailable
        description: Attempted delivery but the recipient did not have the PIN available.
      - value: DeliveryAttempted
        description: Delivery was attempted.
      - value: UnableToAccess
        description: Attempted delivery but could not access the recipient location.
      - value: UnableToContactRecipient
        description: Attempted delivery but unable to contact the recipient to coordinate
          delivery.
      - value: DeliveredToBehindWheelieBin
        description: Shipment delivered behind wheelie bin.
      - value: DeliveredToPorch
        description: Shipment delivered to front porch or front door.
      - value: DeliveredToGarage
        description: Shipment delivered to garage.
      - value: DeliveredToGarden
        description: Shipment delivered to garden.
      - value: DeliveredToGreenhouse
        description: Shipment delivered to greenhouse.
      - value: DeliveredToMailSlot
        description: Shipment delivered to letterbox/mail slot.
      - value: DeliveredToMailRoom
        description: Shipment delivered to mailroom.
      - value: DeliveredToNeighbor
        description: Shipment delivered and signed for by neighbor.
      - value: DeliveredToRearDoor
        description: Shipment delivered to rear porch or rear door.
      - value: DeliveredToReceptionist
        description: Shipment delivered to reception.
      - value: DeliveredToShed
        description: Shipment delivered to shed.
      - value: DeliveredWithOTP
        description: Shipment delivered with onetime passcode.
      - value: Signed
        description: Shipment delivered and signature received.
      - value: Damaged
        description: Shipment was damaged. When paired with Rejected this indicates
          the recipient refused to accept the shipment because the shipment was damaged.
          When paired with UNDELIVERABLE it means the shipment was undeliverable due
          to being damaged and may be returned to the seller.
      - value: IncorrectItems
        description: Recipient refused to accept the shipment because the shipment
          contains incorrect item/s.
      - value: NotRequired
        description: Recipient refused to accept the shipment because the recipient
          did not want the shipment.
      - value: Rejected
        description: Recipient refused to accept the shipment.
      - value: RejectedByRecipientWithVerification
        description: Recipient refused to accept the shipment and provided verification.
      - value: CancelledByRecipient
        description: Shipment was cancelled by the recipient. This tag is paired with
          the rejected shipment status.
      - value: AddressNotFound
        description: Shipment is undeliverable and is returning to seller because
          the address was missing or incorrect.
      - value: HazmatShipment
        description: Shipment is non-compliant Hazmat.
      - value: Undeliverable
        description: Shipment is undeliverable and is returning to the seller.
      - value: ArrivedAtLocalFacility
        description: Package arrived at the local facility.
    TrackingDetailCodes:
      required:
      - forward
      - returns
      type: object
      properties:
        forward:
          type: array
          description: Contains detail codes that provide additional details related
            to the forward leg of the shipment.
          items:
            $ref: '#/components/schemas/DetailCodes'
        returns:
          type: array
          description: Contains detail codes that provide additional details related
            to the return leg of the shipment.
          items:
            $ref: '#/components/schemas/DetailCodes'
      description: Contains detail codes that provide additional details related to
        the forward and return leg of the shipment.
    TrackingId:
      type: string
      description: The carrier generated identifier for a package in a purchased shipment.
    AlternateLegTrackingId:
      type: string
      description: The carrier generated reverse identifier for a returned package
        in a purchased shipment.
    ServiceId:
      type: string
      description: An identifier for the shipping service.
    ServiceName:
      type: string
      description: The name of the shipping service.
    AdditionalAddressNotes:
      maxLength: 256
      type: string
      description: Address notes to re-attempt delivery with.
    ShipperInstruction:
      type: object
      properties:
        deliveryNotes:
          maxLength: 256
          type: string
          description: The delivery notes for the shipment
      description: The shipper instruction.
    Address:
      required:
      - addressLine1
      - city
      - countryCode
      - name
      - postalCode
      - stateOrRegion
      type: object
      properties:
        name:
          maxLength: 50
          minLength: 1
          type: string
          description: "The name of the person, business or institution at the address."
        addressLine1:
          maxLength: 60
          minLength: 1
          type: string
          description: The first line of the address.
        addressLine2:
          maxLength: 60
          minLength: 1
          type: string
          description: "Additional address information, if required."
        addressLine3:
          maxLength: 60
          minLength: 1
          type: string
          description: "Additional address information, if required."
        companyName:
          type: string
          description: The name of the business or institution associated with the
            address.
        stateOrRegion:
          $ref: '#/components/schemas/StateOrRegion'
        city:
          $ref: '#/components/schemas/City'
        countryCode:
          $ref: '#/components/schemas/CountryCode'
        postalCode:
          $ref: '#/components/schemas/PostalCode'
        email:
          maxLength: 64
          type: string
          description: The email address of the contact associated with the address.
        phoneNumber:
          maxLength: 20
          minLength: 1
          type: string
          description: "The phone number of the person, business or institution located\
            \ at that address, including the country calling code."
        geocode:
          $ref: '#/components/schemas/Geocode'
      description: The address.
    Geocode:
      type: object
      properties:
        latitude:
          type: string
          description: The latitude component of the location in ISO6709:2022 Decimal
            Degree format.
        longitude:
          type: string
          description: The longitude component of the location in ISO6709:2022 Decimal
            Degree format.
        elevation:
          type: string
          description: The height or depth component of the location in ISO6709:2022
            Decimal Degree format. This is only present when the data is available.
      description: A representation of the geographical location. Currently only returns
        the geographic coordinate formatted in the ISO6709:2022 Decimal Degrees for
        longitude and latitude.
    StateOrRegion:
      type: string
      description: "The state, county or region where the person, business or institution\
        \ is located."
    City:
      type: string
      description: "The city or town where the person, business or institution is\
        \ located."
    CountryCode:
      type: string
      description: The two digit country code. Follows ISO 3166-1 alpha-2 format.
    PostalCode:
      type: string
      description: "The postal code of that address. It contains a series of letters\
        \ or digits or both, sometimes including spaces or punctuation."
    Location:
      type: object
      properties:
        stateOrRegion:
          $ref: '#/components/schemas/StateOrRegion'
        city:
          $ref: '#/components/schemas/City'
        countryCode:
          $ref: '#/components/schemas/CountryCode'
        postalCode:
          $ref: '#/components/schemas/PostalCode'
      description: "The location where the person, business or institution is located."
    DocumentFormat:
      type: string
      description: The file format of the document.
      enum:
      - PDF
      - PNG
      - ZPL
      x-docgen-enum-table-extension:
      - value: PDF
        description: "The Portable Document Format (PDF) file format. Used to present\
          \ documents, including text formatting and images, in a manner independent\
          \ of application software, hardware, and operating systems."
      - value: PNG
        description: Portable Network Graphics (PNG) is a raster-graphics file format
          that supports lossless data compression.
      - value: ZPL
        description: Zebra Programming Language (ZPL) format is from Zebra Technologies.
          It's used primarily for labeling applications and can only be used with
          ZPL compatible printers.
    DocumentType:
      type: string
      description: The type of shipping document.
      enum:
      - PACKSLIP
      - LABEL
      - RECEIPT
      - CUSTOM_FORM
      x-docgen-enum-table-extension:
      - value: PACKSLIP
        description: A listing of the items packed within the shipment.
      - value: LABEL
        description: The shipping label for the specific shipment.
      - value: RECEIPT
        description: The receipt of the shipment.
      - value: CUSTOM_FORM
        description: The customs documentation for a cross-border shipment.
    Dpi:
      type: integer
      description: The dots per inch (DPI) value used in printing. This value represents
        a measure of the resolution of the document.
    PageLayout:
      type: string
      description: Indicates the position of the label on the paper. Should be the
        same value as returned in getRates response.
    NeedFileJoining:
      type: boolean
      description: "When true, files should be stitched together. Otherwise, files\
        \ should be returned separately. Defaults to false."
    Contents:
      type: string
      description: A Base64 encoded string of the file contents.
    RequestedLabelCustomization:
      type: object
      properties:
        requestAttributes:
          $ref: '#/components/schemas/RequestAttributes'
      description: Object contains customised data requested by a shipper to be printed
        on a shipping label.
    RequestAttributes:
      type: array
      description: Specify the type of attributes to be added on a label.
      items:
        $ref: '#/components/schemas/LabelAttribute'
    LabelAttribute:
      type: string
      description: Enumerates the attributes supported to be printed on a shipping
        label. The values for these attributes are retrieved from GetRates/OneClickShipment
        request
      enum:
      - PACKAGE_CLIENT_REFERENCE_ID
      - SELLER_DISPLAY_NAME
      - COLLECT_ON_DELIVERY_AMOUNT
      x-docgen-enum-table-extension:
      - value: PACKAGE_CLIENT_REFERENCE_ID
        description: Prints client reference ID on the shipping label
      - value: SELLER_DISPLAY_NAME
        description: Prints seller name on the shipping label
      - value: COLLECT_ON_DELIVERY_AMOUNT
        description: Prints Collect On Delivery amount on the shipping label.
    PackageDocumentList:
      type: array
      description: A list of documents related to a package.
      items:
        $ref: '#/components/schemas/PackageDocument'
    PackageDocument:
      required:
      - contents
      - format
      - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/DocumentType'
        format:
          $ref: '#/components/schemas/DocumentFormat'
        contents:
          $ref: '#/components/schemas/Contents'
      description: A document related to a package.
    PrintOptionList:
      type: array
      description: A list of the format options for a label.
      items:
        $ref: '#/components/schemas/PrintOption'
    PrintOption:
      required:
      - supportedDocumentDetails
      - supportedFileJoiningOptions
      - supportedPageLayouts
      type: object
      properties:
        supportedDPIs:
          type: array
          description: A list of the supported DPI options for a document.
          items:
            $ref: '#/components/schemas/Dpi'
        supportedPageLayouts:
          type: array
          description: A list of the supported page layout options for a document.
          items:
            $ref: '#/components/schemas/PageLayout'
        supportedFileJoiningOptions:
          type: array
          description: A list of the supported needFileJoining boolean values for
            a document.
          items:
            $ref: '#/components/schemas/NeedFileJoining'
        supportedDocumentDetails:
          type: array
          description: A list of the supported documented details.
          items:
            $ref: '#/components/schemas/SupportedDocumentDetail'
      description: The format options available for a label.
    DocumentSize:
      required:
      - length
      - unit
      - width
      type: object
      properties:
        width:
          type: number
          description: The width of the document measured in the units specified.
        length:
          type: number
          description: The length of the document measured in the units specified.
        unit:
          type: string
          description: The unit of measurement.
          enum:
          - INCH
          - CENTIMETER
          x-docgen-enum-table-extension:
          - value: INCH
            description: The imperial unit of length equal to one twelfth of a foot.
          - value: CENTIMETER
            description: "A metric unit of length, equal to one hundredth of a meter."
      description: The size dimensions of the label.
    SupportedDocumentDetail:
      required:
      - isMandatory
      - name
      type: object
      properties:
        name:
          $ref: '#/components/schemas/DocumentType'
        isMandatory:
          type: boolean
          description: "When true, the supported document type is required."
      description: The supported document types for a service offering.
    RequestedDocumentSpecification:
      required:
      - format
      - needFileJoining
      - requestedDocumentTypes
      - size
      type: object
      properties:
        format:
          $ref: '#/components/schemas/DocumentFormat'
        size:
          $ref: '#/components/schemas/DocumentSize'
        dpi:
          $ref: '#/components/schemas/Dpi'
        pageLayout:
          $ref: '#/components/schemas/PageLayout'
        needFileJoining:
          $ref: '#/components/schemas/NeedFileJoining'
        requestedDocumentTypes:
          type: array
          description: A list of the document types requested.
          items:
            $ref: '#/components/schemas/DocumentType'
        requestedLabelCustomization:
          $ref: '#/components/schemas/RequestedLabelCustomization'
      description: "The document specifications requested. For calls to the purchaseShipment\
        \ operation, the shipment purchase fails if the specified document specifications\
        \ are not among those returned in the response to the getRates operation."
    SupportedDocumentSpecificationList:
      type: array
      description: A list of the document specifications supported for a shipment
        service offering.
      items:
        $ref: '#/components/schemas/SupportedDocumentSpecification'
    SupportedDocumentSpecification:
      required:
      - format
      - printOptions
      - size
      type: object
      properties:
        format:
          $ref: '#/components/schemas/DocumentFormat'
        size:
          $ref: '#/components/schemas/DocumentSize'
        printOptions:
          $ref: '#/components/schemas/PrintOptionList'
      description: Document specification that is supported for a service offering.
    Item:
      required:
      - quantity
      type: object
      properties:
        itemValue:
          $ref: '#/components/schemas/Currency'
        description:
          type: string
          description: "The product description of the item. Note: It must accurately\
            \ reflect the goods being shipped. For shipments to Northern Ireland,\
            \ this field must also contain a six-digit commodity code (HS code) in\
            \ the following format: HSCODE:XXXXXX (six digits without spaces or special\
            \ characters)."
        itemIdentifier:
          type: string
          description: "A unique identifier for an item provided by the client. Please\
            \ use the Orders SP api and populate this field with the response parameter\
            \ OrderItemId. Note: This is Required field for Amazon Marketplace Orders\
            \ (ON Amazon type of requests)."
        quantity:
          type: integer
          description: The number of units. This value is required.
        weight:
          $ref: '#/components/schemas/Weight'
        liquidVolume:
          $ref: '#/components/schemas/LiquidVolume'
        isHazmat:
          type: boolean
          description: "When true, the item qualifies as hazardous materials (hazmat).\
            \ Defaults to false."
        dangerousGoodsDetails:
          $ref: '#/components/schemas/DangerousGoodsDetails'
        productType:
          type: string
          description: The product type of the item.
        invoiceDetails:
          $ref: '#/components/schemas/InvoiceDetails'
        serialNumbers:
          type: array
          description: A list of unique serial numbers in an Amazon package that can
            be used to guarantee non-fraudulent items. The number of serial numbers
            in the list must be less than or equal to the quantity of items being
            shipped. Only applicable when channel source is Amazon.
          items:
            type: string
        directFulfillmentItemIdentifiers:
          $ref: '#/components/schemas/DirectFulfillmentItemIdentifiers'
      description: An item in a package.
    ItemList:
      type: array
      description: A list of items.
      items:
        $ref: '#/components/schemas/Item'
    Package:
      required:
      - dimensions
      - insuredValue
      - items
      - packageClientReferenceId
      - weight
      type: object
      properties:
        dimensions:
          $ref: '#/components/schemas/Dimensions'
        weight:
          $ref: '#/components/schemas/Weight'
        insuredValue:
          $ref: '#/components/schemas/Currency'
        isHazmat:
          type: boolean
          description: "When true, the package contains hazardous materials. Defaults\
            \ to false."
        sellerDisplayName:
          type: string
          description: The seller name displayed on the label.
        charges:
          $ref: '#/components/schemas/ChargeList'
        packageClientReferenceId:
          $ref: '#/components/schemas/PackageClientReferenceId'
        additionalPackageInfo:
          $ref: '#/components/schemas/AdditionalPackageInfo'
        items:
          $ref: '#/components/schemas/ItemList'
      description: A package to be shipped through a shipping service offering.
    PackageList:
      type: array
      description: A list of packages to be shipped through a shipping service offering.
      items:
        $ref: '#/components/schemas/Package'
    DirectFulfillmentItemIdentifiers:
      required:
      - lineItemID
      type: object
      properties:
        lineItemID:
          type: string
          description: A unique identifier for an item provided by the client for
            a direct fulfillment shipment. This is only populated for direct fulfillment
            multi-piece shipments. It is required if a vendor wants to change the
            configuration of the packages in which the purchase order is shipped.
        pieceNumber:
          type: string
          description: A unique identifier for an item provided by the client for
            a direct fulfillment shipment. This is only populated if a single line
            item has multiple pieces. Defaults to 1.
      description: Item identifiers for an item in a direct fulfillment shipment.
    PackageDocumentDetail:
      required:
      - packageClientReferenceId
      - packageDocuments
      type: object
      properties:
        packageClientReferenceId:
          $ref: '#/components/schemas/PackageClientReferenceId'
        packageDocuments:
          $ref: '#/components/schemas/PackageDocumentList'
        trackingId:
          $ref: '#/components/schemas/TrackingId'
      description: The post-purchase details of a package that will be shipped using
        a shipping service.
    PackageDocumentDetailList:
      type: array
      description: A list of post-purchase details about a package that will be shipped
        using a shipping service.
      items:
        $ref: '#/components/schemas/PackageDocumentDetail'
    TimeWindow:
      type: object
      properties:
        start:
          type: string
          description: The start time of the time window.
          format: date-time
        end:
          type: string
          description: The end time of the time window.
          format: date-time
      description: The start and end time that specifies the time interval of an event.
    Promise:
      type: object
      properties:
        deliveryWindow:
          $ref: '#/components/schemas/TimeWindow'
        pickupWindow:
          $ref: '#/components/schemas/TimeWindow'
      description: The time windows promised for pickup and delivery events.
    RequestedValueAddedServiceList:
      type: array
      description: The value-added services to be added to a shipping service purchase.
      items:
        $ref: '#/components/schemas/RequestedValueAddedService'
    RequestedValueAddedService:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: The identifier of the selected value-added service. Must be
            among those returned in the response to the getRates operation.
      description: A value-added service to be applied to a shipping service purchase.
    AvailableValueAddedServiceGroupList:
      type: array
      description: A list of value-added services available for a shipping service
        offering.
      items:
        $ref: '#/components/schemas/AvailableValueAddedServiceGroup'
    AvailableValueAddedServiceGroup:
      required:
      - groupDescription
      - groupId
      - isRequired
      type: object
      properties:
        groupId:
          type: string
          description: The type of the value-added service group.
        groupDescription:
          type: string
          description: The name of the value-added service group.
        isRequired:
          type: boolean
          description: "When true, one or more of the value-added services listed\
            \ must be specified."
        valueAddedServices:
          type: array
          description: A list of optional value-added services available for purchase
            with a shipping service offering.
          items:
            $ref: '#/components/schemas/ValueAddedService'
      description: The value-added services available for purchase with a shipping
        service offering.
    ValueAddedService:
      required:
      - cost
      - id
      - name
      type: object
      properties:
        id:
          type: string
          description: The identifier for the value-added service.
        name:
          type: string
          description: The name of the value-added service.
        cost:
          $ref: '#/components/schemas/Currency'
      description: A value-added service available for purchase with a shipment service
        offering.
    CollectOnDelivery:
      required:
      - amount
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/Currency'
      description: The amount to collect on delivery.
    SignatureOnDelivery:
      type: object
      description: Setting this structure requests a service to confirm that the package
        has been delivered via signature at the time of delivery.
    OTPOnDelivery:
      type: object
      description: Setting this structure requests a service to confirm that the package
        has been delivered via One Time Passcode at the time of delivery.
    ValueAddedServiceDetails:
      type: object
      properties:
        collectOnDelivery:
          $ref: '#/components/schemas/CollectOnDelivery'
        signatureOnDelivery:
          $ref: '#/components/schemas/SignatureOnDelivery'
        otpOnDelivery:
          $ref: '#/components/schemas/OTPOnDelivery'
      description: A collection of supported value-added services.
    DangerousGoodsDetails:
      type: object
      properties:
        unitedNationsRegulatoryId:
          pattern: "^(UN)[0-9]{4}$"
          type: string
          description: The specific UNID of the item being shipped.
        transportationRegulatoryClass:
          pattern: "^[1-9](\\.[1-9])?$"
          type: string
          description: The specific regulatory class  of the item being shipped.
        packingGroup:
          type: string
          description: The specific packaging group of the item being shipped.
          enum:
          - I
          - II
          - III
          x-docgen-enum-table-extension:
          - value: I
            description: Packing group I indicates great danger.
          - value: II
            description: Packing group II indicates medium danger.
          - value: III
            description: Packing group III indicates minor danger.
        packingInstruction:
          type: string
          description: The specific packing instruction of the item being shipped.
          enum:
          - PI965_SECTION_IA
          - PI965_SECTION_IB
          - PI965_SECTION_II
          - PI966_SECTION_I
          - PI966_SECTION_II
          - PI967_SECTION_I
          - PI967_SECTION_II
          - PI968_SECTION_IA
          - PI968_SECTION_IB
          - PI969_SECTION_I
          - PI969_SECTION_II
          - PI970_SECTION_I
          - PI970_SECTION_II
          x-docgen-enum-table-extension:
          - value: PI965_SECTION_IA
            description: Ion PI965 Section IA (LiBa)
          - value: PI965_SECTION_IB
            description: Ion PI965 Section IB (LiBa)
          - value: PI965_SECTION_II
            description: Ion PI965 Section II (LiBa)
          - value: PI966_SECTION_I
            description: Ion PI966 Section I (LiBa with equipment)
          - value: PI966_SECTION_II
            description: Ion PI966 Section II (LiBa with equipment)
          - value: PI967_SECTION_I
            description: Ion PI967 Section I (LiBa in equipment)
          - value: PI967_SECTION_II
            description: Ion PI967 Section II (LiBa in equipment)
          - value: PI968_SECTION_IA
            description: Metal PI968 Section IA (LiBa)
          - value: PI968_SECTION_IB
            description: Metal PI968 Section IB (LiBa)
          - value: PI969_SECTION_I
            description: Metal PI969 Section I (LiBa with equipment)
          - value: PI969_SECTION_II
            description: Metal PI969 Section II (LiBa with equipment)
          - value: PI970_SECTION_I
            description: Metal PI970 Section I (LiBa in equipment)
          - value: PI970_SECTION_II
            description: Metal PI970 Section II (LiBa in equipment)
      description: Details related to any dangerous goods/items that are being shipped.
    TaxType:
      type: string
      description: Indicates the type of tax.
      enum:
      - GST
      x-docgen-enum-table-extension:
      - value: GST
        description: Goods and Services Tax.
    TaxDetail:
      required:
      - taxRegistrationNumber
      - taxType
      type: object
      properties:
        taxType:
          $ref: '#/components/schemas/TaxType'
        taxRegistrationNumber:
          type: string
          description: The shipper's tax registration number associated with the shipment
            for customs compliance purposes in certain regions.
      description: Indicates the tax specifications associated with the shipment for
        customs compliance purposes in certain regions.
    TaxDetailList:
      type: array
      description: A list of tax detail information.
      items:
        $ref: '#/components/schemas/TaxDetail'
    ShipperNumber:
      type: string
      description: A unique identifier for a shipper’s 'Amazon Shipping' account.
    GoodsOwner:
      required:
      - merchantId
      type: object
      properties:
        merchantId:
          $ref: '#/components/schemas/MerchantId'
      description: The seller owning the goods before handing them over to the carrier
    EventCode:
      type: string
      description: The tracking event type.
      enum:
      - ReadyForReceive
      - PickupDone
      - Delivered
      - Departed
      - DeliveryAttempted
      - Lost
      - OutForDelivery
      - ArrivedAtCarrierFacility
      - Rejected
      - Undeliverable
      - PickupCancelled
      - ReturnInitiated
      - AvailableForPickup
      - RecipientRequestedAlternateDeliveryTiming
      - PackageReceivedByCarrier
      x-docgen-enum-table-extension:
      - value: ReadyForReceive
        description: Package has been created and is ready for pickup at the shippers
          location. This is a pre-transit status event code.
      - value: PickupDone
        description: Package has been picked up by the service provider.
      - value: Delivered
        description: Package has been delivered.
      - value: Departed
        description: Package has departed from a particular location in carrier network.
      - value: DeliveryAttempted
        description: "Delivery was attempted, but was unsuccessful."
      - value: Lost
        description: Package is lost.
      - value: OutForDelivery
        description: Package is out for delivery.
      - value: ArrivedAtCarrierFacility
        description: Package is in transit and has been received at a carrier location.
      - value: Rejected
        description: Package was rejected by the recipient.
      - value: Undeliverable
        description: Package is undeliverable.
      - value: PickupCancelled
        description: Pickup scheduled for the package was cancelled.
      - value: ReturnInitiated
        description: Return label has been generated.
      - value: AvailableForPickup
        description: Package held for recipient pickup.
      - value: RecipientRequestedAlternateDeliveryTiming
        description: Recipient has requested an update to their delivery date.
      - value: PackageReceivedByCarrier
        description: Package has been received at a carrier location.
    Event:
      required:
      - eventCode
      - eventTime
      type: object
      properties:
        eventCode:
          $ref: '#/components/schemas/EventCode'
        location:
          $ref: '#/components/schemas/Location'
        eventTime:
          type: string
          description: The ISO 8601 formatted timestamp of the event.
          format: date-time
        shipmentType:
          $ref: '#/components/schemas/ShipmentType'
      description: A tracking event.
    TrackingSummary:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        trackingDetailCodes:
          $ref: '#/components/schemas/TrackingDetailCodes'
        proofOfDelivery:
          $ref: '#/components/schemas/ProofOfDelivery'
      description: A package status summary.
    Status:
      type: string
      description: The status of the package being shipped.
      enum:
      - PreTransit
      - InTransit
      - Delivered
      - Lost
      - OutForDelivery
      - Rejected
      - Undeliverable
      - DeliveryAttempted
      - PickupCancelled
      - AwaitingCustomerPickup
      x-docgen-enum-table-extension:
      - value: PreTransit
        description: Package has been created but has not been picked up.
      - value: InTransit
        description: Package has been picked up and is in transit.
      - value: Delivered
        description: Package has has been delivered successfully.
      - value: Lost
        description: Package is lost.
      - value: OutForDelivery
        description: Package is out for delivery.
      - value: Rejected
        description: Package has been rejected by the recipient.
      - value: Undeliverable
        description: Package was undeliverable.
      - value: DeliveryAttempted
        description: "Delivery was attempted to the recipient location, but was not\
          \ delivered."
      - value: PickupCancelled
        description: Pickup was cancelled for the package.
      - value: AwaitingCustomerPickup
        description: Package held at facility for the customer pickup.
    ProofOfDelivery:
      type: object
      properties:
        deliveryLocationCoordinates:
          $ref: '#/components/schemas/Geocode'
        deliveryImageURL:
          type: string
          description: "This attribute exists only when available. A temporary URL\
            \ that provides access to the image taken at the time of delivery. This\
            \ URL is dynamically generated with each request, and remains valid for\
            \ 72 hours before expiring. If the delivery image is needed again, another\
            \ getTracking request can be made."
        signatureImageURL:
          type: string
          description: "This attribute exists only when available. A temporary URL\
            \ that provides access to the signature given at the time of delivery.\
            \ This URL is dynamically generated with each request, and remains valid\
            \ for 72 hours before expiring. If the signature image is needed again,\
            \ another getTracking request can be made."
        receivedBy:
          type: string
          description: This attribute exists only when available. The recorded person
            or entity who received the package.
      description: "Contains the proof of delivery information for a package, if available\
        \ and permitted."
    AmazonOrderDetails:
      required:
      - orderId
      type: object
      properties:
        orderId:
          type: string
          description: The Amazon order ID associated with the Amazon order fulfilled
            by this shipment.
      description: Amazon order information. This is required if the shipment source
        channel is Amazon.
    AmazonShipmentDetails:
      required:
      - shipmentId
      type: object
      properties:
        shipmentId:
          type: string
          description: This attribute is required only for a Direct Fulfillment shipment.
            This is the encrypted shipment ID.
      description: Amazon shipment information.
    ChannelType:
      type: string
      description: The shipment source channel type.
      enum:
      - AMAZON
      - EXTERNAL
      x-docgen-enum-table-extension:
      - value: AMAZON
        description: Indicates that the shipment originates from an Amazon order.
      - value: EXTERNAL
        description: Indicates that the shipment originates from a non-Amazon channel.
    ChannelDetails:
      required:
      - channelType
      type: object
      properties:
        channelType:
          $ref: '#/components/schemas/ChannelType'
        amazonOrderDetails:
          $ref: '#/components/schemas/AmazonOrderDetails'
        amazonShipmentDetails:
          $ref: '#/components/schemas/AmazonShipmentDetails'
      description: Shipment source channel related information.
    RateList:
      type: array
      description: A list of eligible shipping service offerings.
      items:
        $ref: '#/components/schemas/Rate'
    Rate:
      required:
      - carrierId
      - carrierName
      - promise
      - rateId
      - requiresAdditionalInputs
      - serviceId
      - serviceName
      - supportedDocumentSpecifications
      - totalCharge
      type: object
      properties:
        rateId:
          $ref: '#/components/schemas/RateId'
        carrierId:
          $ref: '#/components/schemas/CarrierId'
        carrierName:
          $ref: '#/components/schemas/CarrierName'
        serviceId:
          $ref: '#/components/schemas/ServiceId'
        serviceName:
          $ref: '#/components/schemas/ServiceName'
        billedWeight:
          $ref: '#/components/schemas/Weight'
        totalCharge:
          $ref: '#/components/schemas/Currency'
        promise:
          $ref: '#/components/schemas/Promise'
        supportedDocumentSpecifications:
          $ref: '#/components/schemas/SupportedDocumentSpecificationList'
        availableValueAddedServiceGroups:
          $ref: '#/components/schemas/AvailableValueAddedServiceGroupList'
        requiresAdditionalInputs:
          type: boolean
          description: "When true, indicates that additional inputs are required to\
            \ purchase this shipment service. You must then call the getAdditionalInputs\
            \ operation to return the JSON schema to use when providing the additional\
            \ inputs to the purchaseShipment operation."
        rateItemList:
          $ref: '#/components/schemas/RateItemList'
        paymentType:
          $ref: '#/components/schemas/PaymentType'
        benefits:
          $ref: '#/components/schemas/Benefits'
      description: The details of a shipping service offering.
    IneligibilityReasonCode:
      type: string
      description: Reasons that make a shipment service offering ineligible.
      enum:
      - NO_COVERAGE
      - PICKUP_SLOT_RESTRICTION
      - UNSUPPORTED_VAS
      - VAS_COMBINATION_RESTRICTION
      - SIZE_RESTRICTIONS
      - WEIGHT_RESTRICTIONS
      - LATE_DELIVERY
      - PROGRAM_CONSTRAINTS
      - TERMS_AND_CONDITIONS_NOT_ACCEPTED
      - UNKNOWN
      x-docgen-enum-table-extension:
      - value: NO_COVERAGE
        description: The shipment is ineligible because there is no coverage to that
          address.
      - value: PICKUP_SLOT_RESTRICTION
        description: The shipment is ineligible because there is an issue with the
          pickup slot.
      - value: UNSUPPORTED_VAS
        description: The shipment is ineligible because the value-added service is
          invalid for this shipment.
      - value: VAS_COMBINATION_RESTRICTION
        description: The shipment is ineligible because an invalid combination of
          value-added services were chosen.
      - value: SIZE_RESTRICTIONS
        description: The shipment is ineligible because the package dimensions are
          unsupported.
      - value: WEIGHT_RESTRICTIONS
        description: The shipment is ineligible because the weight is unsupported.
      - value: LATE_DELIVERY
        description: The shipment is ineligible because delivery is too late.
      - value: PROGRAM_CONSTRAINTS
        description: The shipment is ineligible because of program constraints.
      - value: TERMS_AND_CONDITIONS_NOT_ACCEPTED
        description: The shipment is ineligible because terms and conditions have
          not been accepted by the carrier.
      - value: UNKNOWN
        description: The ineligibility reason is unknown.
    IneligibilityReason:
      required:
      - code
      - message
      type: object
      properties:
        code:
          $ref: '#/components/schemas/IneligibilityReasonCode'
        message:
          type: string
          description: The ineligibility reason.
      description: The reason why a shipping service offering is ineligible.
    IneligibleRate:
      required:
      - carrierId
      - carrierName
      - ineligibilityReasons
      - serviceId
      - serviceName
      type: object
      properties:
        serviceId:
          $ref: '#/components/schemas/ServiceId'
        serviceName:
          $ref: '#/components/schemas/ServiceName'
        carrierName:
          $ref: '#/components/schemas/CarrierName'
        carrierId:
          $ref: '#/components/schemas/CarrierId'
        ineligibilityReasons:
          type: array
          description: A list of reasons why a shipping service offering is ineligible.
          items:
            $ref: '#/components/schemas/IneligibilityReason'
      description: Detailed information for an ineligible shipping service offering.
    IneligibleRateList:
      type: array
      description: A list of ineligible shipping service offerings.
      items:
        $ref: '#/components/schemas/IneligibleRate'
    CancelShipmentResult:
      type: object
      additionalProperties:
        type: object
      description: The payload for the cancelShipment operation.
    CancelShipmentResponse:
      type: object
      properties:
        payload:
          $ref: '#/components/schemas/CancelShipmentResult'
      description: Response schema for the cancelShipment operation.
    GetRatesRequest:
      required:
      - channelDetails
      - packages
      - shipFrom
      type: object
      properties:
        shipTo:
          $ref: '#/components/schemas/Address'
        shipFrom:
          $ref: '#/components/schemas/Address'
        returnTo:
          $ref: '#/components/schemas/Address'
        shipDate:
          type: string
          description: The ship date and time (the requested pickup). This defaults
            to the current date and time.
          format: date-time
        quoteForShipperNumber:
          $ref: '#/components/schemas/ShipperNumber'
        shipmentForShipperNumber:
          $ref: '#/components/schemas/ShipperNumber'
        shipperInstruction:
          $ref: '#/components/schemas/ShipperInstruction'
        packages:
          $ref: '#/components/schemas/PackageList'
        valueAddedServices:
          $ref: '#/components/schemas/ValueAddedServiceDetails'
        taxDetails:
          $ref: '#/components/schemas/TaxDetailList'
        channelDetails:
          $ref: '#/components/schemas/ChannelDetails'
        clientReferenceDetails:
          $ref: '#/components/schemas/ClientReferenceDetails'
        shipmentType:
          $ref: '#/components/schemas/ShipmentType'
        destinationAccessPointDetails:
          $ref: '#/components/schemas/AccessPointDetails'
      description: "The request schema for the getRates operation. When the channelType\
        \ is Amazon, the shipTo address is not required and will be ignored."
    AccessPointDetails:
      type: object
      properties:
        accessPointId:
          $ref: '#/components/schemas/AccessPointId'
      description: AccessPointDetails object
    NdrAction:
      type: string
      description: The type of NDR action shipper wants to take for a particular shipment.
      enum:
      - RESCHEDULE
      - REATTEMPT
      - RTO
      x-docgen-enum-table-extension:
      - value: RESCHEDULE
        description: Seller wants to reschedule shipment delivery to a specific date.
      - value: REATTEMPT
        description: Seller wants to re-attempt delivery with additional delivery
          notes.
      - value: RTO
        description: Seller wants the shipment to return to the origin.
    NdrRequestData:
      type: object
      properties:
        rescheduleDate:
          type: string
          description: "The date on which the Seller wants to reschedule shipment\
            \ delivery, in ISO-8601 date/time format"
          format: date-time
          example: 2023-12-12T05:24:00Z
        additionalAddressNotes:
          $ref: '#/components/schemas/AdditionalAddressNotes'
      description: "Additional information required for the NDR action that has been\
        \ filed. If the NDR Action is RESCHEDULE, rescheduleDate is a required field.\
        \ Otherwise, if the NDR Action is REATTEMPT, additionalAddressNotes is a required\
        \ field. "
    GetRatesResult:
      required:
      - rates
      - requestToken
      type: object
      properties:
        requestToken:
          $ref: '#/components/schemas/RequestToken'
        rates:
          $ref: '#/components/schemas/RateList'
        ineligibleRates:
          $ref: '#/components/schemas/IneligibleRateList'
      description: The payload for the getRates operation.
    GetRatesResponse:
      type: object
      properties:
        payload:
          $ref: '#/components/schemas/GetRatesResult'
      description: The response schema for the getRates operation.
    GetShipmentDocumentsResult:
      required:
      - packageDocumentDetail
      - shipmentId
      type: object
      properties:
        shipmentId:
          $ref: '#/components/schemas/ShipmentId'
        packageDocumentDetail:
          $ref: '#/components/schemas/PackageDocumentDetail'
        benefits:
          $ref: '#/components/schemas/Benefits'
      description: The payload for the getShipmentDocuments operation.
    GetShipmentDocumentsResponse:
      type: object
      properties:
        payload:
          $ref: '#/components/schemas/GetShipmentDocumentsResult'
      description: The response schema for the the getShipmentDocuments operation.
    GetTrackingResult:
      required:
      - alternateLegTrackingId
      - eventHistory
      - promisedDeliveryDate
      - summary
      - trackingId
      type: object
      properties:
        trackingId:
          $ref: '#/components/schemas/TrackingId'
        alternateLegTrackingId:
          $ref: '#/components/schemas/AlternateLegTrackingId'
        eventHistory:
          type: array
          description: A list of tracking events.
          items:
            $ref: '#/components/schemas/Event'
        promisedDeliveryDate:
          type: string
          description: The date and time by which the shipment is promised to be delivered.
          format: date-time
        summary:
          $ref: '#/components/schemas/TrackingSummary'
      description: The payload for the getTracking operation.
    SubmitNdrFeedbackRequest:
      required:
      - ndrAction
      - trackingId
      type: object
      properties:
        trackingId:
          $ref: '#/components/schemas/TrackingId'
        ndrAction:
          $ref: '#/components/schemas/NdrAction'
        ndrRequestData:
          $ref: '#/components/schemas/NdrRequestData'
      description: The request schema for the NdrFeedback operation
    GetTrackingResponse:
      type: object
      properties:
        payload:
          $ref: '#/components/schemas/GetTrackingResult'
      description: The response schema for the getTracking operation.
    PurchaseShipmentRequest:
      required:
      - rateId
      - requestToken
      - requestedDocumentSpecification
      type: object
      properties:
        requestToken:
          $ref: '#/components/schemas/RequestToken'
        rateId:
          $ref: '#/components/schemas/RateId'
        requestedDocumentSpecification:
          $ref: '#/components/schemas/RequestedDocumentSpecification'
        requestedValueAddedServices:
          $ref: '#/components/schemas/RequestedValueAddedServiceList'
        additionalInputs:
          type: object
          additionalProperties:
            type: object
          description: |-
            The additional inputs required to purchase a shipping offering, in JSON format. The JSON provided here must adhere to the JSON schema that is returned in the response to the getAdditionalInputs operation.

            Additional inputs are only required when indicated by the requiresAdditionalInputs property in the response to the getRates operation.
      description: The request schema for the purchaseShipment operation.
    PurchaseShipmentResult:
      required:
      - packageDocumentDetails
      - promise
      - shipmentId
      type: object
      properties:
        shipmentId:
          $ref: '#/components/schemas/ShipmentId'
        packageDocumentDetails:
          $ref: '#/components/schemas/PackageDocumentDetailList'
        promise:
          $ref: '#/components/schemas/Promise'
        benefits:
          $ref: '#/components/schemas/Benefits'
      description: The payload for the purchaseShipment operation.
    PurchaseShipmentResponse:
      type: object
      properties:
        payload:
          $ref: '#/components/schemas/PurchaseShipmentResult'
      description: The response schema for the purchaseShipment operation.
    OneClickShipmentRequest:
      required:
      - channelDetails
      - labelSpecifications
      - packages
      - serviceSelection
      - shipFrom
      type: object
      properties:
        shipTo:
          $ref: '#/components/schemas/Address'
        shipFrom:
          $ref: '#/components/schemas/Address'
        returnTo:
          $ref: '#/components/schemas/Address'
        shipDate:
          type: string
          description: The ship date and time (the requested pickup). This defaults
            to the current date and time.
          format: date-time
        goodsOwner:
          $ref: '#/components/schemas/GoodsOwner'
        packages:
          $ref: '#/components/schemas/PackageList'
        valueAddedServicesDetails:
          $ref: '#/components/schemas/OneClickShipmentValueAddedServiceDetails'
        valueAddedServices:
          $ref: '#/components/schemas/ValueAddedServiceDetails'
        taxDetails:
          $ref: '#/components/schemas/TaxDetailList'
        channelDetails:
          $ref: '#/components/schemas/ChannelDetails'
        labelSpecifications:
          $ref: '#/components/schemas/RequestedDocumentSpecification'
        serviceSelection:
          $ref: '#/components/schemas/ServiceSelection'
        shipperInstruction:
          $ref: '#/components/schemas/ShipperInstruction'
        destinationAccessPointDetails:
          $ref: '#/components/schemas/AccessPointDetails'
      description: "The request schema for the OneClickShipment operation. When the\
        \ channelType is not Amazon, shipTo is required and when channelType is Amazon\
        \ shipTo is ignored."
    OneClickShipmentResponse:
      type: object
      properties:
        payload:
          $ref: '#/components/schemas/OneClickShipmentResult'
      description: The response schema for the OneClickShipment operation.
    OneClickShipmentResult:
      required:
      - carrier
      - packageDocumentDetails
      - promise
      - service
      - shipmentId
      - totalCharge
      type: object
      properties:
        shipmentId:
          $ref: '#/components/schemas/ShipmentId'
        packageDocumentDetails:
          $ref: '#/components/schemas/PackageDocumentDetailList'
        promise:
          $ref: '#/components/schemas/Promise'
        carrier:
          $ref: '#/components/schemas/Carrier'
        service:
          $ref: '#/components/schemas/Service'
        rateItems:
          $ref: '#/components/schemas/RateItemList'
        totalCharge:
          $ref: '#/components/schemas/Currency'
      description: The payload for the OneClickShipment API.
    GetAccessPointsResponse:
      type: object
      properties:
        payload:
          $ref: '#/components/schemas/GetAccessPointsResult'
      description: The response schema for the GetAccessPoints operation.
    GetAccessPointsResult:
      required:
      - accessPointsMap
      type: object
      properties:
        accessPointsMap:
          $ref: '#/components/schemas/AccessPointsMap'
      description: The payload for the GetAccessPoints API.
    AccessPointType:
      type: string
      description: "The type of access point, like counter (HELIX), lockers, etc."
      enum:
      - HELIX
      - CAMPUS_LOCKER
      - OMNI_LOCKER
      - ODIN_LOCKER
      - DOBBY_LOCKER
      - CORE_LOCKER
      - 3P
      - CAMPUS_ROOM
      x-docgen-enum-table-extension:
      - value: HELIX
        description: "Counter, aka Helix, is an assisted access point where customers\
          \ interact with a store associate to collect or return packages. Counter\
          \ stores do not have Locker"
      - value: CAMPUS_LOCKER
        description: It denotes a physical Locker present at Locker+ stores
      - value: OMNI_LOCKER
        description: Omni lockers are similar to core lockers installed at apartment
          buildings. Core and Omni will have common base hardware platform
      - value: ODIN_LOCKER
        description: "Odin lockers rely on Bluetooth connection as there is no screen\
          \ or scanner on the locker. Drivers, customers, and even technicians can\
          \ interact with the locker using an app (different depending on the user)."
      - value: DOBBY_LOCKER
        description: Dobby lockers are Odin lockers installed at apartment complexes
          and available only to residents.
      - value: CORE_LOCKER
        description: "Core lockers are the traditional and initial style of lockers\
          \ when Hub was launched. Core lockers have a screen, keypad and scanner.\
          \  Customer either enter their pickup code using the Locker screen or scan\
          \ pickup code barcode to pick up their package."
      - value: 3P
        description: "Networks that are owned end-to-end by commercial carriers (CC\
          \ - e.g. DHL, UPS, DPD and Postal organizations), who operate both the transportation\
          \ leg and the access point aspect. These networks offer a range of pickup\
          \ points including: 3P Lockers, legacy Postal Offices, 3P Counters (e.g.\
          \ Gas Stations and Retail Outlets - supermarkets, bookstores, news-stands\
          \ etc)."
      - value: CAMPUS_ROOM
        description: "Locker+, formerly known as Campus, are attended, physical stores,\
          \ where the Locker is used dynamically by the staff to keep packages ready\
          \ for customer pickup. Locker+ store can have multiple Lockers installed,"
    AccessPointsMap:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/AccessPointList'
      description: Map of type of access point to list of access points
    AccessPointList:
      type: array
      description: "List of relevant Access points requested by shipper. These access\
        \ points are sorted by proximity to postal code, and are limited to 40. We\
        \ have internally defined a radius value to render relevant results."
      items:
        $ref: '#/components/schemas/AccessPoint'
    AccessPointId:
      type: string
      description: Unique identifier for the access point
    AccessPoint:
      type: object
      properties:
        accessPointId:
          $ref: '#/components/schemas/AccessPointId'
        name:
          type: string
          description: Name of entity (store/hub etc) where this access point is located
        timezone:
          type: string
          description: Timezone of access point
        type:
          $ref: '#/components/schemas/AccessPointType'
        accessibilityAttributes:
          $ref: '#/components/schemas/AccessibilityAttributes'
        address:
          $ref: '#/components/schemas/Address'
        exceptionOperatingHours:
          type: array
          description: Exception operating hours for Access Point
          items:
            $ref: '#/components/schemas/ExceptionOperatingHours'
        assistanceType:
          type: string
          description: Assistance type enum for Access point i.e. STAFF_ASSISTED or
            SELF_ASSISTED
          enum:
          - STAFF_ASSISTED
          - SELF_ASSISTED
        score:
          type: string
          description: "The score of access point, based on proximity to postal code\
            \ and sorting preference. This can be used to sort access point results\
            \ on shipper's end."
        standardOperatingHours:
          $ref: '#/components/schemas/DayOfWeekTimeMap'
      description: Access point details
    AccessibilityAttributes:
      type: object
      properties:
        distance:
          type: string
          description: The approximate distance of access point from input postalCode's
            centroid.
        driveTime:
          type: integer
          description: The approximate (static) drive time from input postal code's
            centroid.
      description: Defines the accessibility details of the access point.
    OperatingHours:
      type: object
      properties:
        closingTime:
          $ref: '#/components/schemas/TimeOfDay'
        openingTime:
          $ref: '#/components/schemas/TimeOfDay'
        midDayClosures:
          type: array
          description: midDayClosures operating hours array
          items:
            $ref: '#/components/schemas/TimeOfDay'
      description: The hours in which the access point shall remain operational
    TimeOfDay:
      type: object
      properties:
        hourOfDay:
          type: integer
          description: "Denotes hour of the day, used for defining opening or closing\
            \ time of access points"
        minuteOfHour:
          type: integer
          description: "Denotes minute of the hour, used for defining opening or closing\
            \ time of access points"
        secondOfMinute:
          type: integer
          description: "Denotes second of the minute, used for defining opening or\
            \ closing time of access points"
      description: "Denotes time of the day, used for defining opening or closing\
        \ time of access points"
    DayOfWeekTimeMap:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/OperatingHours'
      description: Map of day of the week to operating hours of that day
    ExceptionOperatingHours:
      type: object
      properties:
        dateRange:
          $ref: '#/components/schemas/DateRange'
        operatingHours:
          $ref: '#/components/schemas/OperatingHours'
      description: Defines exceptions to standard operating hours for certain date
        ranges.
    GetAdditionalInputsResult:
      type: object
      additionalProperties:
        type: object
      description: The JSON schema to use to provide additional inputs when required
        to purchase a shipping offering.
    GetAdditionalInputsResponse:
      type: object
      properties:
        payload:
          $ref: '#/components/schemas/GetAdditionalInputsResult'
      description: The response schema for the getAdditionalInputs operation.
    ClientReferenceDetails:
      type: array
      description: "Object to pass additional information about the MCI Integrator\
        \ shipperType: List of ClientReferenceDetail"
      items:
        $ref: '#/components/schemas/ClientReferenceDetail'
    ClientReferenceDetail:
      required:
      - clientReferenceId
      - clientReferenceType
      type: object
      properties:
        clientReferenceType:
          type: string
          description: Client Reference type.
          enum:
          - IntegratorShipperId
          - IntegratorMerchantId
          x-docgen-enum-table-extension:
          - value: IntegratorShipperId
            description: The unique identifier assigned to a 3P seller by the shipping
              integrator.
          - value: IntegratorMerchantId
            description: The unique identifier assigned to a 3P shipping integrator
              by Amazon.
        clientReferenceId:
          type: string
          description: The Client Reference Id.
      description: Client Reference Details
    ShipmentType:
      type: string
      description: Shipment type.
      enum:
      - FORWARD
      - RETURNS
      x-docgen-enum-table-extension:
      - value: FORWARD
        description: Additional information about shipment representing package journey
          from origin address to destination address in the transportation/shipping
          request.
      - value: RETURNS
        description: Additional information about shipment representing package journey
          from destination address to origin/return address in the original transportation/shipping
          request.
    DateRange:
      type: object
      properties:
        startDate:
          type: string
          description: Start Date for query .
          format: dateTime
        endDate:
          type: string
          description: end date for query.
          format: dateTime
      description: Date Range for query the results.
    MerchantId:
      type: string
      description: 'merchant Id of provided merchant '
    PaymentType:
      type: string
      description: Payment type of the purchase.
      enum:
      - PAY_THROUGH_AMAZON
      - PAY_DIRECT_TO_CARRIER
      x-docgen-enum-table-extension:
      - value: PAY_THROUGH_AMAZON
        description: Payment Through Amazon.
      - value: PAY_DIRECT_TO_CARRIER
        description: Payment Direct to Carrier.
    RateItemList:
      type: array
      description: A list of RateItem
      items:
        $ref: '#/components/schemas/RateItem'
    RateItem:
      type: object
      properties:
        rateItemID:
          $ref: '#/components/schemas/RateItemID'
        rateItemType:
          $ref: '#/components/schemas/RateItemType'
        rateItemCharge:
          $ref: '#/components/schemas/Currency'
        rateItemNameLocalization:
          type: string
          description: Used for the localization.
      description: "Rate Item for shipping (base cost, transaction fee, confirmation,\
        \ insurance, etc.) Data source definition: "
    RateItemID:
      type: string
      description: Unique ID for the rateItem.
      enum:
      - BASE_RATE
      - TRANSACTION_FEE
      - ADULT_SIGNATURE_CONFIRMATION
      - SIGNATURE_CONFIRMATION
      - NO_CONFIRMATION
      - WAIVE_SIGNATURE
      - IMPLIED_LIABILITY
      - HIDDEN_POSTAGE
      - DECLARED_VALUE
      - SUNDAY_HOLIDAY_DELIVERY
      - DELIVERY_CONFIRMATION
      - IMPORT_DUTY_CHARGE
      - VAT
      - NO_SATURDAY_DELIVERY
      - INSURANCE
      - COD
      - FUEL_SURCHARGE
      - INSPECTION_CHARGE
      - DELIVERY_AREA_SURCHARGE
      - WAYBILL_CHARGE
      - AMAZON_SPONSORED_DISCOUNT
      - INTEGRATOR_SPONSORED_DISCOUNT
      - OVERSIZE_SURCHARGE
      - CONGESTION_CHARGE
      - RESIDENTIAL_SURCHARGE
      - ADDITIONAL_SURCHARGE
      - SURCHARGE
      - REBATE
      - HIGH_CUBE_SURCHARGE
      - HIGH_LENGTH_SURCHARGE
      - HIGH_WIDTH_SURCHARGE
      - DEMAND_SURCHARGE
      - NONSTANDARD_FEE
      - NON_CONVEYABLE_SURCHARGE
      - OTP_ON_DELIVERY_FEE
      - SIGNATURE_ON_DELIVERY_FEE
      x-docgen-enum-table-extension:
      - value: BASE_RATE
        description: for Base Rate.
      - value: TRANSACTION_FEE
        description: Charge for TransAction Fee.
      - value: ADULT_SIGNATURE_CONFIRMATION
        description: Charge for Adult Signature Confirmation.
      - value: SIGNATURE_CONFIRMATION
        description: Charge for signature confirmation.
      - value: NO_CONFIRMATION
        description: Charge for No Confirmation.
      - value: WAIVE_SIGNATURE
        description: Charge for Waive Signature.
      - value: IMPLIED_LIABILITY
        description: Charge for Implied Liability.
      - value: HIDDEN_POSTAGE
        description: Hidden Postage Charge.
      - value: DECLARED_VALUE
        description: Declared Valure Coverage Charge.
      - value: SUNDAY_HOLIDAY_DELIVERY
        description: Sunday Holiday Delivery Charge.
      - value: DELIVERY_CONFIRMATION
        description: Charge for Delivery Confirmation.
      - value: IMPORT_DUTY_CHARGE
        description: Import Duty Charge.
      - value: VAT
        description: Vat Charge.
      - value: NO_SATURDAY_DELIVERY
        description: Charge for No Satuarday Delivery.
      - value: INSURANCE
        description: Insurance Charge.
      - value: COD
        description: COD Charge.
      - value: AMAZON_SPONSORED_DISCOUNT
        description: Amazon Sponsored Discount.
      - value: INTEGRATOR_SPONSORED_DISCOUNT
        description: Integrator Sponsored Discount.
      - value: FUEL_SURCHARGE
        description: Fuel Surcharge.
      - value: INSPECTION_CHARGE
        description: Inspection Charge.
      - value: DELIVERY_AREA_SURCHARGE
        description: Delivery Area Surcharge.
      - value: WAYBILL_CHARGE
        description: WayBill Charge.
      - value: OVERSIZE_SURCHARGE
        description: OverSize Surcharge.
      - value: CONGESTION_CHARGE
        description: Congestion Charge.
      - value: RESIDENTIAL_SURCHARGE
        description: Residential Surcharge.
      - value: ADDITIONAL_SURCHARGE
        description: Additional Surcharge.
      - value: SURCHARGE
        description: Surcharge.
      - value: REBATE
        description: Rebate.
      - value: HIGH_CUBE_SURCHARGE
        description: High Cube Surcharge.
      - value: HIGH_LENGTH_SURCHARGE
        description: High Length Surcharge.
      - value: HIGH_WIDTH_SURCHARGE
        description: High Width Surcharge.
      - value: DEMAND_SURCHARGE
        description: A fee that is applied during specific periods of increased demand
          on the network as specified in the Amazon Shipping Service guide.
      - value: NONSTANDARD_FEE
        description: A fee that applies for packages that are outside the standard
          size for processing and sorting as specified in the Amazon Shipping Service
          guide.
      - value: NON_CONVEYABLE_SURCHARGE
        description: "A handling surcharge which applies to a package, as defined\
          \ in the Non-Conveyable Surcharge section of the Amazon Shipping Service\
          \ guide."
      - value: OTP_ON_DELIVERY_FEE
        description: A fee for one-time passcode on delivery value added service as
          defined in the Amazon Shipping Service Guide.
      - value: SIGNATURE_ON_DELIVERY_FEE
        description: A fee for signature on delivery value added service as defined
          in the Amazon Shipping Service Guide.
    RateItemType:
      type: string
      description: Type of the rateItem.
      enum:
      - MANDATORY
      - OPTIONAL
      - INCLUDED
      x-docgen-enum-table-extension:
      - value: MANDATORY
        description: Rate Item is mandatory.
      - value: OPTIONAL
        description: Rate Item is Optional.
      - value: INCLUDED
        description: Rate Item is included.
    Benefits:
      required:
      - excludedBenefits
      - includedBenefits
      type: object
      properties:
        includedBenefits:
          $ref: '#/components/schemas/IncludedBenefits'
        excludedBenefits:
          $ref: '#/components/schemas/ExcludedBenefits'
      description: "Benefits that are included and excluded for each shipping offer.\
        \ Benefits represents services provided by Amazon (eg. CLAIMS_PROTECTED, etc.)\
        \ when sellers purchase shipping through Amazon. Benefit details will be made\
        \ available for any shipment placed on or after January 1st 2024 00:00 UTC."
    IncludedBenefits:
      type: array
      description: A list of included benefits.
      items:
        type: string
    ExcludedBenefits:
      type: array
      description: A list of excluded benefit. Refer to the ExcludeBenefit object
        for further documentation
      items:
        $ref: '#/components/schemas/ExcludedBenefit'
    ExcludedBenefit:
      required:
      - benefit
      type: object
      properties:
        benefit:
          type: string
          description: benefit
        reasonCodes:
          $ref: '#/components/schemas/ExcludedBenefitReasonCodes'
      description: Object representing a benefit that is excluded for a shipping offer
        or rate.
    ExcludedBenefitReasonCodes:
      minItems: 1
      type: array
      description: "List of reasons (eg. LATE_DELIVERY_RISK, etc.) indicating why\
        \ a benefit is excluded for a shipping offer."
      items:
        type: string
    ServiceSelection:
      required:
      - serviceId
      type: object
      properties:
        serviceId:
          $ref: '#/components/schemas/ServiceIds'
      description: Service Selection Criteria.
    ServiceIds:
      type: array
      description: A list of ServiceId.
      items:
        type: string
    OneClickShipmentValueAddedServiceDetails:
      type: array
      description: This field is deprecated. This field only supports the Collect
        on Delivery (COD) value added service.
      items:
        $ref: '#/components/schemas/OneClickShipmentValueAddedService'
    OneClickShipmentValueAddedService:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: The identifier of the selected value-added service.
        amount:
          $ref: '#/components/schemas/Currency'
      description: A value-added service to be applied to a shipping service purchase.
    Service:
      required:
      - id
      - name
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ServiceId'
        name:
          $ref: '#/components/schemas/ServiceName'
      description: Service Related Info
    Carrier:
      required:
      - id
      - name
      type: object
      properties:
        id:
          $ref: '#/components/schemas/CarrierId'
        name:
          $ref: '#/components/schemas/CarrierName'
      description: Carrier Related Info

Swagger 2.0 model for the Shipping v2 APIs

{
  "swagger": "2.0",
  "info": {
    "description": "The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.",
    "version": "v2",
    "title": "Amazon Shipping API"
  },
  "host": "sellingpartnerapi-eu.amazon.com",
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/shipping/v2/shipments/rates": {
      "post": {
        "tags": [
          "shipping"
        ],
        "description": "Returns the available shipping service offerings.\n\n**Usage Plan:**\n\n| Default Quota | Unit |\n| ---- | ---- |\n| 5 | Requests Per Second |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
        "operationId": "getRates",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/GetRatesRequest"
            }
          },
          {
            "name": "x-amz-access-token",
            "in": "header",
            "description": "Amazon shipping request token",
            "required": true,
            "type": "string"
          },
          {
            "name": "x-amzn-shipping-business-id",
            "in": "header",
            "description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
            "required": false,
            "type": "string",
            "enum": [
              "AmazonShipping_US",
              "AmazonShipping_IN",
              "AmazonShipping_UK",
              "AmazonShipping_IT",
              "AmazonShipping_ES",
              "AmazonShipping_FR"
            ],
            "x-docgen-enum-table-extension": [
              {
                "value": "AmazonShipping_US",
                "description": "The United States Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IN",
                "description": "The India Amazon shipping business."
              },
              {
                "value": "AmazonShipping_UK",
                "description": "The United Kingdom Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IT",
                "description": "The Italy Amazon shipping business."
              },
              {
                "value": "AmazonShipping_ES",
                "description": "The Spain Amazon shipping business."
              },
              {
                "value": "AmazonShipping_FR",
                "description": "The France Amazon shipping business."
              }
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "schema": {
              "$ref": "#/definitions/GetRatesResponse"
            },
            "examples": {
              "application/json": {
                "requestToken": "6DCCEDD3FF961C15FEB94F342D41C",
                "rates": [
                  {
                    "rateId": "F4B68849F969E239FF9FCA9C12E35",
                    "carrierId": "FOOSHIPGRD",
                    "carrierName": "FOO SHIP GRD",
                    "billedWeight": {
                      "value": 5,
                      "unit": "GRAMS"
                    },
                    "totalCharge": {
                      "value": 7,
                      "unit": "USD"
                    },
                    "serviceId": "FOORSID",
                    "serviceName": "FOO RS ID",
                    "promise": {
                      "deliveryWindow": {
                        "start": "2018-08-24T08:22:30.737Z",
                        "end": "2018-08-24T20:22:30.737Z"
                      },
                      "pickupWindow": {
                        "start": "2018-08-23T08:22:30.737Z",
                        "end": "2018-08-23T20:22:30.737Z"
                      }
                    },
                    "supportedDocumentSpecifications": [
                      {
                        "format": "PNG",
                        "size": {
                          "length": 6,
                          "width": 4,
                          "unit": "INCH"
                        },
                        "printOptions": [
                          {
                            "supportedDPIs": [
                              300,
                              203
                            ],
                            "supportedPageLayouts": [
                              "LEFT",
                              "RIGHT"
                            ],
                            "supportedFileJoiningOptions": [
                              true,
                              false
                            ],
                            "supportedDocumentDetails": [
                              {
                                "name": "LABEL",
                                "isMandatory": true
                              }
                            ]
                          }
                        ]
                      },
                      {
                        "format": "ZPL",
                        "size": {
                          "length": 6,
                          "width": 4,
                          "unit": "INCH"
                        },
                        "printOptions": [
                          {
                            "supportedDPIs": [
                              300,
                              203
                            ],
                            "supportedPageLayouts": [
                              "LEFT",
                              "RIGHT"
                            ],
                            "supportedFileJoiningOptions": [
                              true,
                              false
                            ],
                            "supportedDocumentDetails": [
                              {
                                "name": "LABEL",
                                "isMandatory": true
                              }
                            ]
                          }
                        ]
                      }
                    ],
                    "availableValueAddedServiceGroups": [
                      {
                        "groupId": "SIG_VERIFICATION",
                        "groupDescription": "Signature Verification",
                        "isRequired": true,
                        "valueAddedServices": [
                          {
                            "id": "CUST_SIG_VERIFICATION",
                            "name": "Customer Signature Verification",
                            "cost": {
                              "unit": "USD",
                              "value": 2
                            }
                          }
                        ]
                      }
                    ],
                    "requiresAdditionalInputs": false,
                    "rateItemList": [
                      {
                        "rateItemCharge": {
                          "unit": "INR",
                          "value": "2.00000"
                        },
                        "rateItemID": "BASE_RATE",
                        "rateItemNameLocalization": "Base Rate",
                        "rateItemType": "MANDATORY"
                      },
                      {
                        "rateItemCharge": {
                          "unit": "INR",
                          "value": "1.20000"
                        },
                        "rateItemID": "DELIVERY_CONFIRMATION",
                        "rateItemNameLocalization": "Delivery Confirmation",
                        "rateItemType": "INCLUDED"
                      },
                      {
                        "rateItemCharge": {
                          "unit": "INR",
                          "value": "2.00"
                        },
                        "rateItemID": "VAT",
                        "rateItemNameLocalization": "VAT",
                        "rateItemType": "MANDATORY"
                      }
                    ],
                    "paymentType": "PAY_THROUGH_AMAZON",
                    "benefits": {
                      "includedBenefits": [],
                      "excludedBenefits": [
                        {
                          "benefit": "CLAIMS_PROTECTED",
                          "reasonCodes": [
                            "LATE_DELIVERY_RISK"
                          ]
                        }
                      ]
                    }
                  }
                ],
                "ineligibleRates": [
                  {
                    "carrierId": "FOOSTDGRD",
                    "serviceId": "FOO8420430",
                    "carrierName": "FOOSTDGRD",
                    "serviceName": "FOO8420430",
                    "ineligibilityReasons": [
                      {
                        "code": "NO_COVERAGE",
                        "message": "Required shipping network coverage doesn't exist for the offering"
                      }
                    ]
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "400": {
            "description": "Request has missing or invalid parameters and cannot be parsed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "Request is missing or has invalid parameters",
                    "details": "ChannelDetails object cannot be null"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "401": {
            "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested response or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "403": {
            "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested response or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "404": {
            "description": "The resource specified does not exist.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "NotFound",
                    "message": "The requested resource is invalid or doesn't exist"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "413": {
            "description": "The request size exceeded the maximum accepted size.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload size is greater than maximum accepted size."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "415": {
            "description": "The request payload is in an unsupported format.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload format is not supported."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "429": {
            "description": "The frequency of requests was greater than allowed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "TooManyRequests",
                    "message": "The total number of requests exceeded your allowed limit."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "500": {
            "description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InternalError",
                    "message": "Something went wrong while processing the request."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "503": {
            "description": "Temporary overloading or maintenance of the server.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "ServiceUnavailable",
                    "message": "Service temporarily unavailable or down for maintenance. Please try again after sometime."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          }
        },
        "x-amzn-api-sandbox": {
          "dynamic": {}
        }
      },
      "parameters": []
    },
    "/shipping/v2/shipments": {
      "post": {
        "tags": [
          "shipping"
        ],
        "description": "Purchases a shipping service and returns purchase related details and documents.\n\nNote: You must complete the purchase within **10 minutes** of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to \"TOKEN_EXPIRED\". If you receive this error response, you must get the rates for the shipment again.\n\n**Usage Plan:**\n\n| Default Quota | Unit |\n| ---- | ---- |\n| 5 | Requests Per Second |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
        "operationId": "purchaseShipment",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/PurchaseShipmentRequest"
            }
          },
          {
            "name": "x-amz-access-token",
            "in": "header",
            "description": "Amazon shipping request token",
            "required": true,
            "type": "string"
          },
          {
            "name": "x-amzn-shipping-business-id",
            "in": "header",
            "description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
            "required": false,
            "type": "string",
            "enum": [
              "AmazonShipping_US",
              "AmazonShipping_IN",
              "AmazonShipping_UK",
              "AmazonShipping_IT",
              "AmazonShipping_ES",
              "AmazonShipping_FR",
              "AmazonShipping_JP"
            ],
            "x-docgen-enum-table-extension": [
              {
                "value": "AmazonShipping_US",
                "description": "The United States Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IN",
                "description": "The India Amazon shipping business."
              },
              {
                "value": "AmazonShipping_UK",
                "description": "The United Kingdom Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IT",
                "description": "The Italy Amazon shipping business."
              },
              {
                "value": "AmazonShipping_ES",
                "description": "The Spain Amazon shipping business."
              },
              {
                "value": "AmazonShipping_FR",
                "description": "The France Amazon shipping business."
              },
              {
                "value": "AmazonShipping_JP",
                "description": "The Japan Amazon shipping business."
              }
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "schema": {
              "$ref": "#/definitions/PurchaseShipmentResponse"
            },
            "examples": {
              "application/json": {
                "shipmentId": "87852211788104",
                "packageDocumentDetails": [
                  {
                    "packageClientReferenceId": "abcd",
                    "packageDocuments": [
                      {
                        "type": "LABEL",
                        "format": "PNG",
                        "contents": "sdioadaiosfhdodsaiufhouafhoudfhdouahfac=="
                      }
                    ],
                    "trackingId": 1578648261977
                  }
                ],
                "promise": {
                  "pickupWindow": {
                    "start": "2019-12-11T07:09:05.513Z",
                    "end": "2019-12-11T09:09:05.513Z"
                  },
                  "deliveryWindow": {
                    "start": "2019-12-13T07:09:05.513Z",
                    "end": "2019-12-13T09:09:05.513Z"
                  }
                },
                "benefits": {
                  "includedBenefits": [
                    "CLAIMS_PROTECTED"
                  ],
                  "excludedBenefits": []
                }
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "400": {
            "description": "Request has missing or invalid parameters and cannot be parsed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "Request is missing or has invalid parameters",
                    "details": "RateId cannot be null"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "401": {
            "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested response or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "403": {
            "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested response or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "404": {
            "description": "The resource specified does not exist.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "NotFound",
                    "message": "The requested resource is invalid or doesn't exist"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "413": {
            "description": "The request size exceeded the maximum accepted size.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload size is greater than maximum accepted size."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "415": {
            "description": "The request payload is in an unsupported format.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload format is not supported."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "429": {
            "description": "The frequency of requests was greater than allowed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "TooManyRequests",
                    "message": "The total number of requests exceeded your allowed limit."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "500": {
            "description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InternalError",
                    "message": "Something went wrong while processing the request."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "503": {
            "description": "Temporary overloading or maintenance of the server.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "ServiceUnavailable",
                    "message": "Service temporarily unavailable or down for maintenance. Please try again after sometime."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          }
        },
        "x-amzn-api-sandbox": {
          "dynamic": {}
        }
      },
      "parameters": []
    },
    "/shipping/v2/oneClickShipment": {
      "post": {
        "tags": [
          "shipping"
        ],
        "description": "Purchases a shipping service identifier and returns purchase-related details and documents.\n\n**Usage Plan:**\n\n| Default Quota | Unit |\n| ---- | ---- |\n| 5 | Requests Per Second |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
        "operationId": "oneClickShipment",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/OneClickShipmentRequest"
            }
          },
          {
            "name": "x-amz-access-token",
            "in": "header",
            "description": "Amazon shipping request token",
            "required": true,
            "type": "string"
          },
          {
            "name": "x-amzn-shipping-business-id",
            "in": "header",
            "description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
            "required": false,
            "type": "string",
            "enum": [
              "AmazonShipping_US",
              "AmazonShipping_IN",
              "AmazonShipping_UK",
              "AmazonShipping_IT",
              "AmazonShipping_ES",
              "AmazonShipping_FR"
            ],
            "x-docgen-enum-table-extension": [
              {
                "value": "AmazonShipping_US",
                "description": "The United States Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IN",
                "description": "The India Amazon shipping business."
              },
              {
                "value": "AmazonShipping_UK",
                "description": "The United Kingdom Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IT",
                "description": "The Italy Amazon shipping business."
              },
              {
                "value": "AmazonShipping_ES",
                "description": "The Spain Amazon shipping business."
              },
              {
                "value": "AmazonShipping_FR",
                "description": "The France Amazon shipping business."
              }
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "schema": {
              "$ref": "#/definitions/OneClickShipmentResponse"
            },
            "examples": {
              "application/json": {
                "shipmentId": "87852211788104",
                "packageDocumentDetails": [
                  {
                    "packageClientReferenceId": "#abcd",
                    "packageDocuments": [
                      {
                        "type": "LABEL",
                        "format": "PNG",
                        "contents": "sdioadaiosfhdodsaiufhouafhoudfhdouahfac=="
                      }
                    ],
                    "trackingId": 1578648261977
                  }
                ],
                "promise": {
                  "pickupWindow": {
                    "start": "2019-12-11T07:09:05.513Z",
                    "end": "2019-12-11T09:09:05.513Z"
                  },
                  "deliveryWindow": {
                    "start": "2019-12-13T07:09:05.513Z",
                    "end": "2019-12-13T09:09:05.513Z"
                  }
                },
                "carrier": {
                  "id": "AMZN_UK",
                  "name": "Amazon Shipping"
                },
                "service": {
                  "id": "SWA-UK-PREM",
                  "name": "Amazon Shipping One Day"
                },
                "totalCharge": {
                  "unit": "GBP",
                  "value": 4.76
                }
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "400": {
            "description": "Request has missing or invalid parameters and cannot be parsed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "Request is missing or has invalid parameters",
                    "details": "ServiceId cannot be null"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "401": {
            "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested response or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "403": {
            "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested response or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "404": {
            "description": "The resource specified does not exist.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "NotFound",
                    "message": "The requested resource is invalid or doesn't exist"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "413": {
            "description": "The request size exceeded the maximum accepted size.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload size is greater than maximum accepted size."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "415": {
            "description": "The request payload is in an unsupported format.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload format is not supported."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "429": {
            "description": "The frequency of requests was greater than allowed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "TooManyRequests",
                    "message": "The total number of requests exceeded your allowed limit."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "500": {
            "description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InternalError",
                    "message": "Something went wrong while processing the request."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "503": {
            "description": "Temporary overloading or maintenance of the server.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "ServiceUnavailable",
                    "message": "Service temporarily unavailable or down for maintenance. Please try again after sometime."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          }
        },
        "x-amzn-api-sandbox": {
          "dynamic": {}
        }
      },
      "parameters": []
    },
    "/shipping/v2/tracking": {
      "get": {
        "tags": [
          "shipping"
        ],
        "description": "Returns tracking information for a purchased shipment.\n\n**Usage Plan:**\n\n| Default Quota | Unit |\n| ---- | ---- |\n| 5 | Requests Per Second |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
        "operationId": "getTracking",
        "parameters": [
          {
            "name": "trackingId",
            "in": "query",
            "description": "A carrier-generated tracking identifier originally returned by the purchaseShipment operation.",
            "required": true,
            "type": "string"
          },
          {
            "name": "carrierId",
            "in": "query",
            "description": "A carrier identifier originally returned by the getRates operation for the selected rate.",
            "required": true,
            "type": "string"
          },
          {
            "name": "x-amz-access-token",
            "in": "header",
            "description": "Amazon shipping request token",
            "required": true,
            "type": "string"
          },
          {
            "name": "x-amzn-shipping-business-id",
            "in": "header",
            "description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
            "required": false,
            "type": "string",
            "enum": [
              "AmazonShipping_US",
              "AmazonShipping_IN",
              "AmazonShipping_UK",
              "AmazonShipping_IT",
              "AmazonShipping_ES",
              "AmazonShipping_FR"
            ],
            "x-docgen-enum-table-extension": [
              {
                "value": "AmazonShipping_US",
                "description": "The United States Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IN",
                "description": "The India Amazon shipping business."
              },
              {
                "value": "AmazonShipping_UK",
                "description": "The United Kingdom Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IT",
                "description": "The Italy Amazon shipping business."
              },
              {
                "value": "AmazonShipping_ES",
                "description": "The Spain Amazon shipping business."
              },
              {
                "value": "AmazonShipping_FR",
                "description": "The France Amazon shipping business."
              }
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "schema": {
              "$ref": "#/definitions/GetTrackingResponse"
            },
            "examples": {
              "application/json": {
                "trackingId": "23AA47DE2B3B6",
                "alternateLegTrackingId": "null",
                "eventHistory": [
                  {
                    "eventCode": "Undeliverable",
                    "location": {
                      "postalCode": "EX33 2JL",
                      "countryCode": "GB"
                    },
                    "eventTime": "2024-02-11T07:09:05.513Z",
                    "shipmentType": "FORWARD"
                  },
                  {
                    "eventCode": "ReturnInitiated",
                    "location": {
                      "postalCode": "EX33 2JL",
                      "countryCode": "GB"
                    },
                    "eventTime": "2024-02-12T09:09:05.513Z",
                    "shipmentType": "RETURNS"
                  },
                  {
                    "eventCode": "Delivered",
                    "location": {
                      "postalCode": "EX33 2JL",
                      "countryCode": "GB"
                    },
                    "eventTime": "2024-02-13T04:09:05.513Z",
                    "shipmentType": "RETURNS"
                  }
                ],
                "promisedDeliveryDate": "2024-02-12T13:09:05.513Z",
                "summary": {
                  "status": "Delivered",
                  "trackingDetailCodes": {
                    "forward": [
                      "Rejected",
                      "Damaged"
                    ],
                    "returns": [
                      "Signed"
                    ]
                  }
                }
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "400": {
            "description": "Request has missing or invalid parameters and cannot be parsed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "Request is missing or has invalid parameters",
                    "details": "CarrierId is missing in the request"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "401": {
            "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested response or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "403": {
            "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested response or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "404": {
            "description": "The resource specified does not exist.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "NotFound",
                    "message": "The requested resource is invalid or doesn't exist"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "413": {
            "description": "The request size exceeded the maximum accepted size.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload size is greater than maximum accepted size."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "415": {
            "description": "The request payload is in an unsupported format.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload format is not supported."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "429": {
            "description": "The frequency of requests was greater than allowed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "TooManyRequests",
                    "message": "The total number of requests exceeded your allowed limit."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "500": {
            "description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InternalError",
                    "message": "Something went wrong while processing the request."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "503": {
            "description": "Temporary overloading or maintenance of the server.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "ServiceUnavailable",
                    "message": "Service temporarily unavailable or down for maintenance. Please try again after sometime."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          }
        },
        "x-amzn-api-sandbox": {
          "dynamic": {}
        }
      },
      "parameters": []
    },
    "/shipping/v2/shipments/{shipmentId}/documents": {
      "get": {
        "tags": [
          "shipping"
        ],
        "description": "Returns the shipping documents associated with a package in a shipment.\n\n**Usage Plan:**\n\n| Default Quota | Unit |\n| ---- | ---- |\n| 5 | Requests Per Second |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
        "operationId": "getShipmentDocuments",
        "parameters": [
          {
            "name": "shipmentId",
            "description": "The shipment identifier originally returned by the purchaseShipment operation.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "packageClientReferenceId",
            "in": "query",
            "description": "The package client reference identifier originally provided in the request body parameter for the getRates operation.",
            "required": true,
            "type": "string"
          },
          {
            "name": "format",
            "in": "query",
            "description": "The file format of the document. Must be one of the supported formats returned by the getRates operation.",
            "required": false,
            "type": "string"
          },
          {
            "name": "dpi",
            "in": "query",
            "description": "The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation.",
            "required": false,
            "type": "number"
          },
          {
            "name": "x-amz-access-token",
            "in": "header",
            "description": "Amazon shipping request token",
            "required": true,
            "type": "string"
          },
          {
            "name": "x-amzn-shipping-business-id",
            "in": "header",
            "description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
            "required": false,
            "type": "string",
            "enum": [
              "AmazonShipping_US",
              "AmazonShipping_IN",
              "AmazonShipping_UK",
              "AmazonShipping_IT",
              "AmazonShipping_ES",
              "AmazonShipping_FR"
            ],
            "x-docgen-enum-table-extension": [
              {
                "value": "AmazonShipping_US",
                "description": "The United States Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IN",
                "description": "The India Amazon shipping business."
              },
              {
                "value": "AmazonShipping_UK",
                "description": "The United Kingdom Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IT",
                "description": "The Italy Amazon shipping business."
              },
              {
                "value": "AmazonShipping_ES",
                "description": "The Spain Amazon shipping business."
              },
              {
                "value": "AmazonShipping_FR",
                "description": "The France Amazon shipping business."
              }
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "schema": {
              "$ref": "#/definitions/GetShipmentDocumentsResponse"
            },
            "examples": {
              "application/json": {
                "shipmentId": "445454-3232-3232",
                "packageDocumentDetail": {
                  "packageClientReferenceId": "ASUSDI-45343854",
                  "trackingId": "T1234567",
                  "packageDocuments": [
                    {
                      "type": "LABEL",
                      "format": "PNG",
                      "contents": "sdioadaiosfhdodsaiufhouafhoudfhdouahfac=="
                    }
                  ],
                  "benefits": {
                    "includedBenefits": [
                      "CLAIMS_PROTECTED"
                    ],
                    "excludedBenefits": []
                  }
                }
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "400": {
            "description": "Request has missing or invalid parameters and cannot be parsed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "Request is missing or has invalid parameters",
                    "details": "shipmentId is missing in the request"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "401": {
            "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested response or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "403": {
            "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested response or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "404": {
            "description": "The resource specified does not exist.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "NotFound",
                    "message": "The requested resource is invalid or doesn't exist"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "413": {
            "description": "The request size exceeded the maximum accepted size.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload size is greater than maximum accepted size."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "415": {
            "description": "The request payload is in an unsupported format.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload format is not supported."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "429": {
            "description": "The frequency of requests was greater than allowed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "TooManyRequests",
                    "message": "The total number of requests exceeded your allowed limit."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "500": {
            "description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InternalError",
                    "message": "Something went wrong while processing the request."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "503": {
            "description": "Temporary overloading or maintenance of the server.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "ServiceUnavailable",
                    "message": "Service temporarily unavailable or down for maintenance. Please try again after sometime."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          }
        },
        "x-amzn-api-sandbox": {
          "dynamic": {}
        }
      },
      "parameters": []
    },
    "/shipping/v2/shipments/{shipmentId}/cancel": {
      "put": {
        "tags": [
          "shipping"
        ],
        "description": "Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled.\n\n**Usage Plan:**\n\n| Default Quota | Unit |\n| ---- | ---- |\n| 5 | Requests Per Second |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
        "operationId": "cancelShipment",
        "parameters": [
          {
            "name": "shipmentId",
            "description": "The shipment identifier originally returned by the purchaseShipment operation.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "x-amz-access-token",
            "in": "header",
            "description": "Amazon shipping request token",
            "required": true,
            "type": "string"
          },
          {
            "name": "x-amzn-shipping-business-id",
            "in": "header",
            "description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
            "required": false,
            "type": "string",
            "enum": [
              "AmazonShipping_US",
              "AmazonShipping_IN",
              "AmazonShipping_UK",
              "AmazonShipping_IT",
              "AmazonShipping_ES",
              "AmazonShipping_FR"
            ],
            "x-docgen-enum-table-extension": [
              {
                "value": "AmazonShipping_US",
                "description": "The United States Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IN",
                "description": "The India Amazon shipping business."
              },
              {
                "value": "AmazonShipping_UK",
                "description": "The United Kingdom Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IT",
                "description": "The Italy Amazon shipping business."
              },
              {
                "value": "AmazonShipping_ES",
                "description": "The Spain Amazon shipping business."
              },
              {
                "value": "AmazonShipping_FR",
                "description": "The France Amazon shipping business."
              }
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "schema": {
              "$ref": "#/definitions/CancelShipmentResponse"
            },
            "examples": {
              "application/json": {}
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "400": {
            "description": "Request has missing or invalid parameters and cannot be parsed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "Request is missing or has invalid parameters",
                    "details": "ShipmentId cannot be null"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "401": {
            "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested response or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "403": {
            "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested response or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "404": {
            "description": "The resource specified does not exist.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "NotFound",
                    "message": "The requested resource is invalid or doesn't exist"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "413": {
            "description": "The request size exceeded the maximum accepted size.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload size is greater than maximum accepted size."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "415": {
            "description": "The request payload is in an unsupported format.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload format is not supported."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "429": {
            "description": "The frequency of requests was greater than allowed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "TooManyRequests",
                    "message": "The total number of requests exceeded your allowed limit."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "500": {
            "description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InternalError",
                    "message": "Something went wrong while processing the request."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "503": {
            "description": "Temporary overloading or maintenance of the server.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "ServiceUnavailable",
                    "message": "Service temporarily unavailable or down for maintenance. Please try again after sometime."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          }
        },
        "x-amzn-api-sandbox": {
          "dynamic": {}
        }
      },
      "parameters": []
    },
    "/shipping/v2/accessPoints": {
      "get": {
        "tags": [
          "shipping"
        ],
        "description": "Returns a list of access points in proximity of input postal code.\n\n**Usage Plan:**\n\n| Default Quota | Unit |\n| ---- | ---- |\n| 5 | Requests Per Second |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
        "operationId": "getAccessPoints",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "accessPointTypes",
            "description": "Access point types",
            "required": true,
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "HELIX",
                "CAMPUS_LOCKER",
                "OMNI_LOCKER",
                "ODIN_LOCKER",
                "DOBBY_LOCKER",
                "CORE_LOCKER",
                "3P",
                "CAMPUS_ROOM"
              ]
            },
            "x-docgen-enum-table-extension": [
              {
                "value": "HELIX",
                "description": "Counter, aka Helix, is an assisted access point where customers interact with a store associate to collect or return packages. Counter stores do not have Locker"
              },
              {
                "value": "CAMPUS_LOCKER",
                "description": "It denotes a physical Locker present at Locker+ stores"
              },
              {
                "value": "OMNI_LOCKER",
                "description": "Omni lockers are similar to core lockers installed at apartment buildings. Core and Omni will have common base hardware platform"
              },
              {
                "value": "ODIN_LOCKER",
                "description": "Odin lockers rely on Bluetooth connection as there is no screen or scanner on the locker. Drivers, customers, and even technicians can interact with the locker using an app (different depending on the user)."
              },
              {
                "value": "DOBBY_LOCKER",
                "description": "Dobby lockers are Odin lockers installed at apartment complexes and available only to residents."
              },
              {
                "value": "CORE_LOCKER",
                "description": "Core lockers are the traditional and initial style of lockers when Hub was launched. Core lockers have a screen, keypad and scanner.  Customer either enter their pickup code using the Locker screen or scan pickup code barcode to pick up their package."
              },
              {
                "value": "3P",
                "description": "Networks that are owned end-to-end by commercial carriers (CC - e.g. DHL, UPS, DPD and Postal organizations), who operate both the transportation leg and the access point aspect. These networks offer a range of pickup points including: 3P Lockers, legacy Postal Offices, 3P Counters (e.g. Gas Stations and Retail Outlets - supermarkets, bookstores, news-stands etc)."
              },
              {
                "value": "CAMPUS_ROOM",
                "description": "Locker+, formerly known as Campus, are attended, physical stores, where the Locker is used dynamically by the staff to keep packages ready for customer pickup. Locker+ store can have multiple Lockers installed,"
              }
            ],
            "collectionFormat": "csv"
          },
          {
            "in": "query",
            "name": "countryCode",
            "description": "Country code for access point",
            "required": true,
            "type": "string",
            "collectionFormat": "csv",
            "x-example": "US"
          },
          {
            "in": "query",
            "name": "postalCode",
            "description": "postal code for access point",
            "required": true,
            "type": "string",
            "collectionFormat": "csv",
            "x-example": "EX332JL"
          },
          {
            "name": "x-amz-access-token",
            "in": "header",
            "description": "Amazon shipping request token",
            "required": true,
            "type": "string"
          },
          {
            "name": "x-amzn-shipping-business-id",
            "in": "header",
            "description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
            "required": false,
            "type": "string",
            "enum": [
              "AmazonShipping_US",
              "AmazonShipping_IN",
              "AmazonShipping_UK",
              "AmazonShipping_IT",
              "AmazonShipping_ES",
              "AmazonShipping_FR"
            ],
            "x-docgen-enum-table-extension": [
              {
                "value": "AmazonShipping_US",
                "description": "The United States Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IN",
                "description": "The India Amazon shipping business."
              },
              {
                "value": "AmazonShipping_UK",
                "description": "The United Kingdom Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IT",
                "description": "The Italy Amazon shipping business."
              },
              {
                "value": "AmazonShipping_ES",
                "description": "The Spain Amazon shipping business."
              },
              {
                "value": "AmazonShipping_FR",
                "description": "The France Amazon shipping business."
              }
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "schema": {
              "$ref": "#/definitions/GetAccessPointsResponse"
            },
            "examples": {
              "application/json": {
                "HELIX": {
                  "accessPointId": "00046c4b-bb0a-4c03-831e-5633e142f16a",
                  "name": "Amazon Hub Counter - Co-op Braunton",
                  "timezone": "Europe/London",
                  "type": "HELIX",
                  "accessibilityAttributes": {
                    "distance": "21.200000762939453",
                    "driveTime": "0.0"
                  },
                  "address": {
                    "addressObject": {
                      "addressLine1": "Exeter Road",
                      "city": "Braunton",
                      "countryCode": "GB",
                      "zipOrPostalCode": "EX33 2JL"
                    },
                    "geocode": {
                      "latitude": "51.1076671",
                      "longitude": "-4.1607301"
                    }
                  },
                  "exceptionOperatingHours": [
                    {
                      "dateRange": {
                        "endDate": "1.6932672E9",
                        "startDate": "1.6931808E9"
                      },
                      "operatingHours": {
                        "closingTime": {
                          "hourOfDay": 0,
                          "minuteOfHour": 0,
                          "secondOfMinute": 0
                        },
                        "midDayClosures": [],
                        "openingTime": {
                          "hourOfDay": 0,
                          "minuteOfHour": 0,
                          "secondOfMinute": 0
                        }
                      }
                    }
                  ],
                  "assistanceType": "STAFF_ASSISTED",
                  "score": "0.6688068509101868",
                  "standardOperatingHours": {
                    "WEDNESDAY": {
                      "closingTime": {
                        "hourOfDay": 22,
                        "minuteOfHour": 0,
                        "secondOfMinute": 0
                      },
                      "midDayClosures": [],
                      "openingTime": {
                        "hourOfDay": 7,
                        "minuteOfHour": 0,
                        "secondOfMinute": 0
                      }
                    },
                    "MONDAY": {
                      "closingTime": {
                        "hourOfDay": 22,
                        "minuteOfHour": 0,
                        "secondOfMinute": 0
                      },
                      "midDayClosures": [],
                      "openingTime": {
                        "hourOfDay": 7,
                        "minuteOfHour": 0,
                        "secondOfMinute": 0
                      }
                    },
                    "THURSDAY": {
                      "closingTime": {
                        "hourOfDay": 22,
                        "minuteOfHour": 0,
                        "secondOfMinute": 0
                      },
                      "midDayClosures": [],
                      "openingTime": {
                        "hourOfDay": 7,
                        "minuteOfHour": 0,
                        "secondOfMinute": 0
                      }
                    },
                    "SUNDAY": {
                      "closingTime": {
                        "hourOfDay": 22,
                        "minuteOfHour": 0,
                        "secondOfMinute": 0
                      },
                      "midDayClosures": [],
                      "openingTime": {
                        "hourOfDay": 7,
                        "minuteOfHour": 0,
                        "secondOfMinute": 0
                      }
                    },
                    "TUESDAY": {
                      "closingTime": {
                        "hourOfDay": 22,
                        "minuteOfHour": 0,
                        "secondOfMinute": 0
                      },
                      "midDayClosures": [],
                      "openingTime": {
                        "hourOfDay": 7,
                        "minuteOfHour": 0,
                        "secondOfMinute": 0
                      }
                    },
                    "FRIDAY": {
                      "closingTime": {
                        "hourOfDay": 22,
                        "minuteOfHour": 0,
                        "secondOfMinute": 0
                      },
                      "midDayClosures": [],
                      "openingTime": {
                        "hourOfDay": 7,
                        "minuteOfHour": 0,
                        "secondOfMinute": 0
                      }
                    },
                    "SATURDAY": {
                      "closingTime": {
                        "hourOfDay": 22,
                        "minuteOfHour": 0,
                        "secondOfMinute": 0
                      },
                      "midDayClosures": [],
                      "openingTime": {
                        "hourOfDay": 7,
                        "minuteOfHour": 0,
                        "secondOfMinute": 0
                      }
                    }
                  }
                }
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "400": {
            "description": "Request has missing or invalid parameters and cannot be parsed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "Request is missing or has invalid parameters",
                    "details": "Access Point types cannot be null"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "401": {
            "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested response or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "403": {
            "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested response or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "404": {
            "description": "The resource specified does not exist.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "NotFound",
                    "message": "The requested resource is invalid or doesn't exist"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "413": {
            "description": "The request size exceeded the maximum accepted size.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload size is greater than maximum accepted size."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "415": {
            "description": "The request payload is in an unsupported format.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload format is not supported."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "429": {
            "description": "The frequency of requests was greater than allowed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "TooManyRequests",
                    "message": "The total number of requests exceeded your allowed limit."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "500": {
            "description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InternalError",
                    "message": "Something went wrong while processing the request."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "503": {
            "description": "Temporary overloading or maintenance of the server.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "ServiceUnavailable",
                    "message": "Service temporarily unavailable or down for maintenance. Please try again after sometime."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          }
        },
        "x-amzn-api-sandbox": {
          "dynamic": {}
        }
      },
      "parameters": []
    },
    "/shipping/v2/ndrFeedback": {
      "post": {
        "tags": [
          "shipping"
        ],
        "description": "This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment.\n\n**Usage Plan:**\n\n| Default Quota | Unit |\n| ---- | ---- |\n| 5 | Requests Per Second |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
        "operationId": "submitNdrFeedback",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "Request body for ndrFeedback operation",
            "required": true,
            "schema": {
              "$ref": "#/definitions/SubmitNdrFeedbackRequest"
            }
          },
          {
            "name": "x-amz-access-token",
            "in": "header",
            "description": "Amazon shipping request token",
            "required": true,
            "type": "string"
          },
          {
            "name": "x-amzn-shipping-business-id",
            "in": "header",
            "description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
            "required": false,
            "type": "string",
            "enum": [
              "AmazonShipping_US",
              "AmazonShipping_IN",
              "AmazonShipping_UK",
              "AmazonShipping_IT",
              "AmazonShipping_ES",
              "AmazonShipping_FR"
            ],
            "x-docgen-enum-table-extension": [
              {
                "value": "AmazonShipping_US",
                "description": "The United States Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IN",
                "description": "The India Amazon shipping business."
              },
              {
                "value": "AmazonShipping_UK",
                "description": "The United Kingdom Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IT",
                "description": "The Italy Amazon shipping business."
              },
              {
                "value": "AmazonShipping_ES",
                "description": "The Spain Amazon shipping business."
              },
              {
                "value": "AmazonShipping_FR",
                "description": "The France Amazon shipping business."
              }
            ]
          }
        ],
        "responses": {
          "204": {
            "description": "Success",
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "400": {
            "description": "Request has missing or invalid parameters and cannot be parsed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "Request is missing or has invalid parameters",
                    "details": "RescheduleDate is missing in the request"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "401": {
            "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested resource or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "403": {
            "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested resource or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "404": {
            "description": "The resource specified does not exist.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "NotFound",
                    "message": "The requested resource is invalid or doesn't exist"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "413": {
            "description": "The request size exceeded the maximum accepted size.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload size is greater than maximum accepted size."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "415": {
            "description": "The request payload is in an unsupported format.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload format is not supported."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "429": {
            "description": "The frequency of requests was greater than allowed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "TooManyRequests",
                    "message": "The total number of requests exceeded your allowed limit."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "500": {
            "description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InternalError",
                    "message": "Something went wrong while processing the request."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "503": {
            "description": "Temporary overloading or maintenance of the server.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "ServiceUnavailable",
                    "message": "Service temporarily unavailable or down for maintenance. Please try again after sometime."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          }
        },
        "x-amzn-api-sandbox": {
          "dynamic": {}
        }
      },
      "parameters": []
    },
    "/shipping/v2/shipments/additionalInputs/schema": {
      "get": {
        "tags": [
          "shipping"
        ],
        "description": "Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase.\n\n**Usage Plan:**\n\n| Default Quota | Unit |\n| ---- | ---- |\n| 5 | Requests Per Second |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
        "operationId": "getAdditionalInputs",
        "parameters": [
          {
            "name": "requestToken",
            "in": "query",
            "description": "The request token returned in the response to the getRates operation.",
            "required": true,
            "type": "string"
          },
          {
            "name": "rateId",
            "in": "query",
            "description": "The rate identifier for the shipping offering (rate) returned in the response to the getRates operation.",
            "required": true,
            "type": "string"
          },
          {
            "name": "x-amz-access-token",
            "in": "header",
            "description": "Amazon shipping request token",
            "required": true,
            "type": "string"
          },
          {
            "name": "x-amzn-shipping-business-id",
            "in": "header",
            "description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
            "required": false,
            "type": "string",
            "enum": [
              "AmazonShipping_US",
              "AmazonShipping_IN",
              "AmazonShipping_UK",
              "AmazonShipping_IT",
              "AmazonShipping_ES",
              "AmazonShipping_FR"
            ],
            "x-docgen-enum-table-extension": [
              {
                "value": "AmazonShipping_US",
                "description": "The United States Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IN",
                "description": "The India Amazon shipping business."
              },
              {
                "value": "AmazonShipping_UK",
                "description": "The United Kingdom Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IT",
                "description": "The Italy Amazon shipping business."
              },
              {
                "value": "AmazonShipping_ES",
                "description": "The Spain Amazon shipping business."
              },
              {
                "value": "AmazonShipping_FR",
                "description": "The France Amazon shipping business."
              }
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "schema": {
              "$ref": "#/definitions/GetAdditionalInputsResponse"
            },
            "examples": {
              "application/json": {
                "payload": {
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "title": "Additional inputs for Shipping Offering",
                  "type": "object",
                  "properties": {
                    "harmonizedSystemCode": {
                      "type": "string",
                      "description": "Harmonized System's commodity code for an item."
                    },
                    "packageClientReferenceId": {
                      "type": "string",
                      "description": "Unique identifier for the item."
                    }
                  }
                }
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            },
            "x-amzn-api-sandbox": {
              "static": [
                {
                  "request": {
                    "parameters": {
                      "requestToken": {
                        "value": "amzn1.rq.123456789.101"
                      },
                      "rateId": {
                        "value": "122324234543535321345436534321423423523452345"
                      }
                    }
                  },
                  "response": {
                    "payload": {}
                  }
                }
              ]
            }
          },
          "400": {
            "description": "Request has missing or invalid parameters and cannot be parsed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "Request is missing or has invalid parameters",
                    "details": "RequestToken cannot be null"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            },
            "x-amzn-api-sandbox": {
              "static": [
                {
                  "request": {
                    "parameters": {
                      "requestToken": {
                        "value": "null"
                      },
                      "rateId": {
                        "value": "2314346237423894905834905890346890789075"
                      }
                    }
                  },
                  "response": {
                    "errors": [
                      {
                        "code": "InvalidRequest",
                        "message": "Request is missing or has invalid parameters",
                        "details": "RequestToken cannot be null"
                      }
                    ]
                  }
                }
              ]
            }
          },
          "401": {
            "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested response or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "403": {
            "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "Unauthorized",
                    "message": "You don't have access to the requested response or the credentials are invalid."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "404": {
            "description": "The resource specified does not exist.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "NotFound",
                    "message": "The requested resource is invalid or doesn't exist"
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "413": {
            "description": "The request size exceeded the maximum accepted size.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload size is greater than maximum accepted size."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "415": {
            "description": "The request payload is in an unsupported format.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InvalidRequest",
                    "message": "The request payload format is not supported."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "429": {
            "description": "The frequency of requests was greater than allowed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "TooManyRequests",
                    "message": "The total number of requests exceeded your allowed limit."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "500": {
            "description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "InternalError",
                    "message": "Something went wrong while processing the request."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          },
          "503": {
            "description": "Temporary overloading or maintenance of the server.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "code": "ServiceUnavailable",
                    "message": "Service temporarily unavailable or down for maintenance. Please try again after sometime."
                  }
                ]
              }
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference identifier."
              }
            }
          }
        }
      },
      "parameters": []
    }
  },
  "definitions": {
    "Error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "description": "An error code that identifies the type of error that occurred."
        },
        "message": {
          "type": "string",
          "description": "A message that describes the error condition."
        },
        "details": {
          "type": "string",
          "description": "Additional details that can help the caller understand or fix the issue."
        }
      },
      "description": "Error response returned when the request is unsuccessful."
    },
    "ErrorList": {
      "type": "object",
      "description": "A list of error responses returned when a request is unsuccessful.",
      "required": [
        "errors"
      ],
      "properties": {
        "errors": {
          "type": "array",
          "description": "Array of Errors",
          "items": {
            "$ref": "#/definitions/Error"
          }
        }
      }
    },
    "Weight": {
      "description": "The weight in the units indicated.",
      "type": "object",
      "required": [
        "unit",
        "value"
      ],
      "properties": {
        "unit": {
          "type": "string",
          "description": "The unit of measurement.",
          "enum": [
            "GRAM",
            "KILOGRAM",
            "OUNCE",
            "POUND"
          ],
          "x-docgen-enum-table-extension": [
            {
              "value": "GRAM",
              "description": "Metric unit of mass equal to one thousandth of a kilogram."
            },
            {
              "value": "KILOGRAM",
              "description": "Metric unit of mass."
            },
            {
              "value": "OUNCE",
              "description": "The imperial unit of weight that is one sixteenth of a pound."
            },
            {
              "value": "POUND",
              "description": "The imperial unit of weight."
            }
          ]
        },
        "value": {
          "type": "number",
          "description": "The measurement value."
        }
      }
    },
    "LiquidVolume": {
      "type": "object",
      "required": [
        "unit",
        "value"
      ],
      "properties": {
        "unit": {
          "type": "string",
          "description": "The unit of measurement.",
          "enum": [
            "ML",
            "L",
            "FL_OZ",
            "GAL",
            "PT",
            "QT",
            "C"
          ],
          "x-docgen-enum-table-extension": [
            {
              "value": "ML",
              "description": "Milliliter - Metric unit of volume."
            },
            {
              "value": "L",
              "description": "Liter - Metric unit of volume."
            },
            {
              "value": "FL_OZ",
              "description": "Fluid Ounce - Imperial unit of volume."
            },
            {
              "value": "GAL",
              "description": "Gallon - Imperial unit of volume."
            },
            {
              "value": "PT",
              "description": "Pint - Imperial unit of volume."
            },
            {
              "value": "QT",
              "description": "Quart - Imperial unit of volume."
            },
            {
              "value": "C",
              "description": "Cup - Imperial unit of volume."
            }
          ]
        },
        "value": {
          "type": "number",
          "description": "The measurement value."
        }
      },
      "description": "Liquid Volume."
    },
    "InvoiceDetails": {
      "description": "The invoice details for charges associated with the goods in the package. Only applies to certain regions.",
      "type": "object",
      "properties": {
        "invoiceNumber": {
          "type": "string",
          "description": "The invoice number of the item."
        },
        "invoiceDate": {
          "type": "string",
          "format": "date-time",
          "description": "The invoice date of the item in ISO 8061 format."
        }
      }
    },
    "ChargeList": {
      "type": "array",
      "description": "A list of charges based on the shipping service charges applied on a package.",
      "items": {
        "$ref": "#/definitions/ChargeComponent"
      }
    },
    "ChargeComponent": {
      "type": "object",
      "description": "The type and amount of a charge applied on a package.",
      "properties": {
        "amount": {
          "$ref": "#/definitions/Currency"
        },
        "chargeType": {
          "type": "string",
          "description": "The type of charge.",
          "enum": [
            "TAX",
            "DISCOUNT"
          ],
          "x-docgen-enum-table-extension": [
            {
              "value": "TAX",
              "description": "A tax imposed on a package."
            },
            {
              "value": "DISCOUNT",
              "description": "A discount deducted from the cost of a package."
            }
          ]
        }
      }
    },
    "Currency": {
      "description": "The monetary value in the currency indicated, in ISO 4217 standard format.",
      "type": "object",
      "required": [
        "unit",
        "value"
      ],
      "properties": {
        "value": {
          "type": "number",
          "description": "The monetary value."
        },
        "unit": {
          "type": "string",
          "description": "The ISO 4217 format 3-character currency code.",
          "minLength": 3,
          "maxLength": 3
        }
      }
    },
    "Dimensions": {
      "type": "object",
      "required": [
        "height",
        "length",
        "unit",
        "width"
      ],
      "properties": {
        "length": {
          "type": "number",
          "description": "The length of the package."
        },
        "width": {
          "type": "number",
          "description": "The width of the package."
        },
        "height": {
          "type": "number",
          "description": "The height of the package."
        },
        "unit": {
          "type": "string",
          "description": "The unit of measurement.",
          "enum": [
            "INCH",
            "CENTIMETER"
          ],
          "x-docgen-enum-table-extension": [
            {
              "value": "INCH",
              "description": "The imperial unit of length equal to one twelfth of a foot."
            },
            {
              "value": "CENTIMETER",
              "description": "A metric unit of length, equal to one hundredth of a meter."
            }
          ]
        }
      },
      "description": "A set of measurements for a three-dimensional object."
    },
    "RequestToken": {
      "type": "string",
      "description": "A unique token generated to identify a getRates operation."
    },
    "RateId": {
      "type": "string",
      "description": "An identifier for the rate (shipment offering) provided by a shipping service provider."
    },
    "CarrierId": {
      "type": "string",
      "description": "The carrier identifier for the offering, provided by the carrier."
    },
    "CarrierName": {
      "type": "string",
      "description": "The carrier name for the offering."
    },
    "PackageClientReferenceId": {
      "type": "string",
      "description": "A client provided unique identifier for a package being shipped. This value should be saved by the client to pass as a parameter to the getShipmentDocuments operation."
    },
    "AdditionalPackageInfo": {
      "type": "array",
      "description": "Additional information about the package provided by Shipper",
      "items": {
        "type": "object",
        "required": ["name", "value"],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the information content being sent along with the package",
            "enum": [
              "PURCHASE_ORDER_NUMBER"
            ],
            "x-docgen-enum-table-extension": [
              {
                "value": "PURCHASE_ORDER_NUMBER",
                "description": "Specifies the Purchase Order number."
              }
            ]
          },
          "value": {
            "type": "string",
            "description": "The value of the information content being sent along with the package"
          }
        }
      }
    },
    "ShipmentId": {
      "type": "string",
      "description": "The unique shipment identifier provided by a shipping service."
    },
    "DetailCodes": {
      "type": "string",
      "description": "A list of codes used to provide additional shipment information.",
      "enum": [
        "BusinessClosed",
        "CustomerUnavailable",
        "PaymentNotReady",
        "OtpNotAvailable",
        "DeliveryAttempted",
        "UnableToAccess",
        "UnableToContactRecipient",
        "DeliveredToBehindWheelieBin",
        "DeliveredToPorch",
        "DeliveredToGarage",
        "DeliveredToGarden",
        "DeliveredToGreenhouse",
        "DeliveredToMailSlot",
        "DeliveredToMailRoom",
        "DeliveredToNeighbor",
        "DeliveredToRearDoor",
        "DeliveredToReceptionist",
        "DeliveredToShed",
        "DeliveredWithOTP",
        "Signed",
        "Damaged",
        "IncorrectItems",
        "NotRequired",
        "Rejected",
        "RejectedByRecipientWithVerification",
        "CancelledByRecipient",
        "AddressNotFound",
        "HazmatShipment",
        "Undeliverable",
        "ArrivedAtLocalFacility"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "BusinessClosed",
          "description": "Attempted delivery but the business was closed."
        },
        {
          "value": "CustomerUnavailable",
          "description": "Attempted delivery but the recipient was unavailable."
        },
        {
          "value": "PaymentNotReady",
          "description": "Attempted delivery but cash was not available from recipient."
        },
        {
          "value": "OtpNotAvailable",
          "description": "Attempted delivery but the recipient did not have the PIN available."
        },
        {
          "value": "DeliveryAttempted",
          "description": "Delivery was attempted."
        },
        {
          "value": "UnableToAccess",
          "description": "Attempted delivery but could not access the recipient location."
        },
        {
          "value": "UnableToContactRecipient",
          "description": "Attempted delivery but unable to contact the recipient to coordinate delivery."
        },
        {
          "value": "DeliveredToBehindWheelieBin",
          "description": "Shipment delivered behind wheelie bin."
        },
        {
          "value": "DeliveredToPorch",
          "description": "Shipment delivered to front porch or front door."
        },
        {
          "value": "DeliveredToGarage",
          "description": "Shipment delivered to garage."
        },
        {
          "value": "DeliveredToGarden",
          "description": "Shipment delivered to garden."
        },
        {
          "value": "DeliveredToGreenhouse",
          "description": "Shipment delivered to greenhouse."
        },
        {
          "value": "DeliveredToMailSlot",
          "description": "Shipment delivered to letterbox/mail slot."
        },
        {
          "value": "DeliveredToMailRoom",
          "description": "Shipment delivered to mailroom."
        },
        {
          "value": "DeliveredToNeighbor",
          "description": "Shipment delivered and signed for by neighbor."
        },
        {
          "value": "DeliveredToRearDoor",
          "description": "Shipment delivered to rear porch or rear door."
        },
        {
          "value": "DeliveredToReceptionist",
          "description": "Shipment delivered to reception."
        },
        {
          "value": "DeliveredToShed",
          "description": "Shipment delivered to shed."
        },
        {
          "value": "DeliveredWithOTP",
          "description": "Shipment delivered with onetime passcode."
        },
        {
          "value": "Signed",
          "description": "Shipment delivered and signature received."
        },
        {
          "value": "Damaged",
          "description": "Shipment was damaged. When paired with Rejected this indicates the recipient refused to accept the shipment because the shipment was damaged. When paired with UNDELIVERABLE it means the shipment was undeliverable due to being damaged and may be returned to the seller."
        },
        {
          "value": "IncorrectItems",
          "description": "Recipient refused to accept the shipment because the shipment contains incorrect item/s."
        },
        {
          "value": "NotRequired",
          "description": "Recipient refused to accept the shipment because the recipient did not want the shipment."
        },
        {
          "value": "Rejected",
          "description": "Recipient refused to accept the shipment."
        },
        {
          "value": "RejectedByRecipientWithVerification",
          "description": "Recipient refused to accept the shipment and provided verification."
        },
        {
          "value": "CancelledByRecipient",
          "description": "Shipment was cancelled by the recipient. This tag is paired with the rejected shipment status."
        },
        {
          "value": "AddressNotFound",
          "description": "Shipment is undeliverable and is returning to seller because the address was missing or incorrect."
        },
        {
          "value": "HazmatShipment",
          "description": "Shipment is non-compliant Hazmat."
        },
        {
          "value": "Undeliverable",
          "description": "Shipment is undeliverable and is returning to the seller."
        },
        {
          "value": "ArrivedAtLocalFacility",
          "description": "Package arrived at the local facility."
        }
      ]
    },
    "TrackingDetailCodes": {
      "type": "object",
      "description": "Contains detail codes that provide additional details related to the forward and return leg of the shipment.",
      "required": [
        "forward",
        "returns"
      ],
      "properties": {
        "forward": {
          "type": "array",
          "description": "Contains detail codes that provide additional details related to the forward leg of the shipment.",
          "items": {
            "$ref": "#/definitions/DetailCodes"
          }
        },
        "returns": {
          "type": "array",
          "description": "Contains detail codes that provide additional details related to the return leg of the shipment.",
          "items": {
            "$ref": "#/definitions/DetailCodes"
          }
        }
      }
    },
    "TrackingId": {
      "type": "string",
      "description": "The carrier generated identifier for a package in a purchased shipment."
    },
    "AlternateLegTrackingId": {
      "type": "string",
      "description": "The carrier generated reverse identifier for a returned package in a purchased shipment."
    },
    "ServiceId": {
      "type": "string",
      "description": "An identifier for the shipping service."
    },
    "ServiceName": {
      "type": "string",
      "description": "The name of the shipping service."
    },
    "AdditionalAddressNotes": {
      "type": "string",
      "maxLength": 256,
      "description": "Address notes to re-attempt delivery with."
    },
    "ShipperInstruction": {
      "type": "object",
      "properties": {
        "deliveryNotes": {
          "type": "string",
          "description": "The delivery notes for the shipment",
          "maxLength": 256
        }
      },
      "description": "The shipper instruction."
    },
    "Address": {
      "type": "object",
      "required": [
        "addressLine1",
        "city",
        "countryCode",
        "name",
        "postalCode",
        "stateOrRegion"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the person, business or institution at the address.",
          "minLength": 1,
          "maxLength": 50
        },
        "addressLine1": {
          "type": "string",
          "description": "The first line of the address.",
          "minLength": 1,
          "maxLength": 60
        },
        "addressLine2": {
          "type": "string",
          "description": "Additional address information, if required.",
          "minLength": 1,
          "maxLength": 60
        },
        "addressLine3": {
          "type": "string",
          "description": "Additional address information, if required.",
          "minLength": 1,
          "maxLength": 60
        },
        "companyName": {
          "type": "string",
          "description": "The name of the business or institution associated with the address."
        },
        "stateOrRegion": {
          "$ref": "#/definitions/StateOrRegion"
        },
        "city": {
          "$ref": "#/definitions/City"
        },
        "countryCode": {
          "$ref": "#/definitions/CountryCode"
        },
        "postalCode": {
          "$ref": "#/definitions/PostalCode"
        },
        "email": {
          "type": "string",
          "description": "The email address of the contact associated with the address.",
          "maxLength": 64
        },
        "phoneNumber": {
          "type": "string",
          "description": "The phone number of the person, business or institution located at that address, including the country calling code.",
          "minLength": 1,
          "maxLength": 20
        },
        "geocode": {
          "$ref": "#/definitions/Geocode"
        }
      },
      "description": "The address."
    },
    "Geocode": {
      "type": "object",
      "description": "A representation of the geographical location. Currently only returns the geographic coordinate formatted in the ISO6709:2022 Decimal Degrees for longitude and latitude.",
      "properties": {
        "latitude": {
          "description": "The latitude component of the location in ISO6709:2022 Decimal Degree format.",
          "type": "string"
        },
        "longitude": {
          "description": "The longitude component of the location in ISO6709:2022 Decimal Degree format.",
          "type": "string"
        },
        "elevation": {
          "description": "The height or depth component of the location in ISO6709:2022 Decimal Degree format. This is only present when the data is available.",
          "type": "string"
        }
      }
    },
    "StateOrRegion": {
      "type": "string",
      "description": "The state, county or region where the person, business or institution is located."
    },
    "City": {
      "type": "string",
      "description": "The city or town where the person, business or institution is located."
    },
    "CountryCode": {
      "type": "string",
      "description": "The two digit country code. Follows ISO 3166-1 alpha-2 format."
    },
    "PostalCode": {
      "type": "string",
      "description": "The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation."
    },
    "Location": {
      "type": "object",
      "properties": {
        "stateOrRegion": {
          "$ref": "#/definitions/StateOrRegion"
        },
        "city": {
          "$ref": "#/definitions/City"
        },
        "countryCode": {
          "$ref": "#/definitions/CountryCode"
        },
        "postalCode": {
          "$ref": "#/definitions/PostalCode"
        }
      },
      "description": "The location where the person, business or institution is located."
    },
    "DocumentFormat": {
      "type": "string",
      "description": "The file format of the document.",
      "enum": [
        "PDF",
        "PNG",
        "ZPL"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "PDF",
          "description": "The Portable Document Format (PDF) file format. Used to present documents, including text formatting and images, in a manner independent of application software, hardware, and operating systems."
        },
        {
          "value": "PNG",
          "description": "Portable Network Graphics (PNG) is a raster-graphics file format that supports lossless data compression."
        },
        {
          "value": "ZPL",
          "description": "Zebra Programming Language (ZPL) format is from Zebra Technologies. It's used primarily for labeling applications and can only be used with ZPL compatible printers."
        }
      ]
    },
    "DocumentType": {
      "type": "string",
      "description": "The type of shipping document.",
      "enum": [
        "PACKSLIP",
        "LABEL",
        "RECEIPT",
        "CUSTOM_FORM"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "PACKSLIP",
          "description": "A listing of the items packed within the shipment."
        },
        {
          "value": "LABEL",
          "description": "The shipping label for the specific shipment."
        },
        {
          "value": "RECEIPT",
          "description": "The receipt of the shipment."
        },
        {
          "value": "CUSTOM_FORM",
          "description": "The customs documentation for a cross-border shipment."
        }
      ]
    },
    "Dpi": {
      "type": "integer",
      "description": "The dots per inch (DPI) value used in printing. This value represents a measure of the resolution of the document."
    },
    "PageLayout": {
      "type": "string",
      "description": "Indicates the position of the label on the paper. Should be the same value as returned in getRates response."
    },
    "NeedFileJoining": {
      "type": "boolean",
      "description": "When true, files should be stitched together. Otherwise, files should be returned separately. Defaults to false."
    },
    "Contents": {
      "type": "string",
      "description": "A Base64 encoded string of the file contents."
    },
    "RequestedLabelCustomization": {
      "type": "object",
      "description": "Object contains customised data requested by a shipper to be printed on a shipping label.",
      "properties": {
        "requestAttributes": {
          "$ref": "#/definitions/RequestAttributes"
        }
      }
    },
    "RequestAttributes": {
      "type": "array",
      "description": "Specify the type of attributes to be added on a label.",
      "items": {
        "$ref": "#/definitions/LabelAttribute"
      }
    },
    "LabelAttribute": {
      "type": "string",
      "description": "Enumerates the attributes supported to be printed on a shipping label. The values for these attributes are retrieved from GetRates/OneClickShipment request",
      "enum": [
        "PACKAGE_CLIENT_REFERENCE_ID",
        "SELLER_DISPLAY_NAME",
        "COLLECT_ON_DELIVERY_AMOUNT"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "PACKAGE_CLIENT_REFERENCE_ID",
          "description": "Prints client reference ID on the shipping label"
        },
        {
          "value": "SELLER_DISPLAY_NAME",
          "description": "Prints seller name on the shipping label"
        },
        {
          "value": "COLLECT_ON_DELIVERY_AMOUNT",
          "description": "Prints Collect On Delivery amount on the shipping label."
        }
      ]
    },
    "PackageDocumentList": {
      "type": "array",
      "description": "A list of documents related to a package.",
      "items": {
        "$ref": "#/definitions/PackageDocument"
      }
    },
    "PackageDocument": {
      "type": "object",
      "required": [
        "contents",
        "format",
        "type"
      ],
      "properties": {
        "type": {
          "$ref": "#/definitions/DocumentType"
        },
        "format": {
          "$ref": "#/definitions/DocumentFormat"
        },
        "contents": {
          "$ref": "#/definitions/Contents"
        }
      },
      "description": "A document related to a package."
    },
    "PrintOptionList": {
      "type": "array",
      "description": "A list of the format options for a label.",
      "items": {
        "$ref": "#/definitions/PrintOption"
      }
    },
    "PrintOption": {
      "type": "object",
      "required": [
        "supportedDocumentDetails",
        "supportedFileJoiningOptions",
        "supportedPageLayouts"
      ],
      "properties": {
        "supportedDPIs": {
          "type": "array",
          "description": "A list of the supported DPI options for a document.",
          "items": {
            "$ref": "#/definitions/Dpi"
          }
        },
        "supportedPageLayouts": {
          "type": "array",
          "description": "A list of the supported page layout options for a document.",
          "items": {
            "$ref": "#/definitions/PageLayout"
          }
        },
        "supportedFileJoiningOptions": {
          "type": "array",
          "description": "A list of the supported needFileJoining boolean values for a document.",
          "items": {
            "$ref": "#/definitions/NeedFileJoining"
          }
        },
        "supportedDocumentDetails": {
          "description": "A list of the supported documented details.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/SupportedDocumentDetail"
          }
        }
      },
      "description": "The format options available for a label."
    },
    "DocumentSize": {
      "type": "object",
      "required": [
        "length",
        "unit",
        "width"
      ],
      "properties": {
        "width": {
          "description": "The width of the document measured in the units specified.",
          "type": "number"
        },
        "length": {
          "description": "The length of the document measured in the units specified.",
          "type": "number"
        },
        "unit": {
          "type": "string",
          "description": "The unit of measurement.",
          "enum": [
            "INCH",
            "CENTIMETER"
          ],
          "x-docgen-enum-table-extension": [
            {
              "value": "INCH",
              "description": "The imperial unit of length equal to one twelfth of a foot."
            },
            {
              "value": "CENTIMETER",
              "description": "A metric unit of length, equal to one hundredth of a meter."
            }
          ]
        }
      },
      "description": "The size dimensions of the label."
    },
    "SupportedDocumentDetail": {
      "type": "object",
      "required": [
        "isMandatory",
        "name"
      ],
      "properties": {
        "name": {
          "$ref": "#/definitions/DocumentType"
        },
        "isMandatory": {
          "type": "boolean",
          "description": "When true, the supported document type is required."
        }
      },
      "description": "The supported document types for a service offering."
    },
    "RequestedDocumentSpecification": {
      "type": "object",
      "required": [
        "format",
        "needFileJoining",
        "requestedDocumentTypes",
        "size"
      ],
      "properties": {
        "format": {
          "$ref": "#/definitions/DocumentFormat"
        },
        "size": {
          "$ref": "#/definitions/DocumentSize"
        },
        "dpi": {
          "$ref": "#/definitions/Dpi"
        },
        "pageLayout": {
          "$ref": "#/definitions/PageLayout"
        },
        "needFileJoining": {
          "$ref": "#/definitions/NeedFileJoining"
        },
        "requestedDocumentTypes": {
          "description": "A list of the document types requested.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/DocumentType"
          }
        },
        "requestedLabelCustomization": {
          "$ref": "#/definitions/RequestedLabelCustomization"
        }
      },
      "description": "The document specifications requested. For calls to the purchaseShipment operation, the shipment purchase fails if the specified document specifications are not among those returned in the response to the getRates operation."
    },
    "SupportedDocumentSpecificationList": {
      "type": "array",
      "description": "A list of the document specifications supported for a shipment service offering.",
      "items": {
        "$ref": "#/definitions/SupportedDocumentSpecification"
      }
    },
    "SupportedDocumentSpecification": {
      "type": "object",
      "required": [
        "format",
        "printOptions",
        "size"
      ],
      "properties": {
        "format": {
          "$ref": "#/definitions/DocumentFormat"
        },
        "size": {
          "$ref": "#/definitions/DocumentSize"
        },
        "printOptions": {
          "$ref": "#/definitions/PrintOptionList"
        }
      },
      "description": "Document specification that is supported for a service offering."
    },
    "Item": {
      "type": "object",
      "required": [
        "quantity"
      ],
      "properties": {
        "itemValue": {
          "$ref": "#/definitions/Currency",
          "description": "Note: This is Required field for Amazon Marketplace Orders (ON Amazon type of requests). And For Off Amazon type shipments to Northern Ireland, this field is mandatory and must accurately represent the invoiced amount for the item."
        },
        "description": {
          "type": "string",
          "description": "The product description of the item. Note: It must accurately reflect the goods being shipped. For shipments to Northern Ireland, this field must also contain a six-digit commodity code (HS code) in the following format: HSCODE:XXXXXX (six digits without spaces or special characters)."
        },
        "itemIdentifier": {
          "type": "string",
          "description": "A unique identifier for an item provided by the client. Please use the Orders SP api and populate this field with the response parameter OrderItemId. Note: This is Required field for Amazon Marketplace Orders (ON Amazon type of requests)."
        },
        "quantity": {
          "type": "integer",
          "description": "The number of units. This value is required."
        },
        "weight": {
          "$ref": "#/definitions/Weight"
        },
        "liquidVolume": {
          "$ref": "#/definitions/LiquidVolume"
        },
        "isHazmat": {
          "type": "boolean",
          "description": "When true, the item qualifies as hazardous materials (hazmat). Defaults to false."
        },
        "dangerousGoodsDetails": {
          "$ref": "#/definitions/DangerousGoodsDetails"
        },
        "productType": {
          "type": "string",
          "description": "The product type of the item."
        },
        "invoiceDetails": {
          "$ref": "#/definitions/InvoiceDetails"
        },
        "serialNumbers": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of unique serial numbers in an Amazon package that can be used to guarantee non-fraudulent items. The number of serial numbers in the list must be less than or equal to the quantity of items being shipped. Only applicable when channel source is Amazon."
        },
        "directFulfillmentItemIdentifiers": {
          "$ref": "#/definitions/DirectFulfillmentItemIdentifiers"
        }
      },
      "description": "An item in a package."
    },
    "ItemList": {
      "type": "array",
      "description": "A list of items.",
      "items": {
        "$ref": "#/definitions/Item"
      }
    },
    "Package": {
      "type": "object",
      "required": [
        "dimensions",
        "insuredValue",
        "items",
        "packageClientReferenceId",
        "weight"
      ],
      "properties": {
        "dimensions": {
          "$ref": "#/definitions/Dimensions"
        },
        "weight": {
          "$ref": "#/definitions/Weight"
        },
        "insuredValue": {
          "$ref": "#/definitions/Currency"
        },
        "isHazmat": {
          "type": "boolean",
          "description": "When true, the package contains hazardous materials. Defaults to false."
        },
        "sellerDisplayName": {
          "type": "string",
          "description": "The seller name displayed on the label."
        },
        "charges": {
          "$ref": "#/definitions/ChargeList"
        },
        "packageClientReferenceId": {
          "$ref": "#/definitions/PackageClientReferenceId"
        },
        "additionalPackageInfo": {
          "$ref": "#/definitions/AdditionalPackageInfo"
        },
        "items": {
          "$ref": "#/definitions/ItemList"
        }
      },
      "description": "A package to be shipped through a shipping service offering."
    },
    "PackageList": {
      "type": "array",
      "description": "A list of packages to be shipped through a shipping service offering.",
      "items": {
        "$ref": "#/definitions/Package"
      }
    },
    "DirectFulfillmentItemIdentifiers": {
      "type": "object",
      "required": [
        "lineItemID"
      ],
      "properties": {
        "lineItemID": {
          "type": "string",
          "description": "A unique identifier for an item provided by the client for a direct fulfillment shipment. This is only populated for direct fulfillment multi-piece shipments. It is required if a vendor wants to change the configuration of the packages in which the purchase order is shipped."
        },
        "pieceNumber": {
          "type": "string",
          "description": "A unique identifier for an item provided by the client for a direct fulfillment shipment. This is only populated if a single line item has multiple pieces. Defaults to 1."
        }
      },
      "description": "Item identifiers for an item in a direct fulfillment shipment."
    },
    "PackageDocumentDetail": {
      "type": "object",
      "required": [
        "packageClientReferenceId",
        "packageDocuments"
      ],
      "properties": {
        "packageClientReferenceId": {
          "$ref": "#/definitions/PackageClientReferenceId"
        },
        "packageDocuments": {
          "$ref": "#/definitions/PackageDocumentList"
        },
        "trackingId": {
          "$ref": "#/definitions/TrackingId"
        }
      },
      "description": "The post-purchase details of a package that will be shipped using a shipping service."
    },
    "PackageDocumentDetailList": {
      "type": "array",
      "description": "A list of post-purchase details about a package that will be shipped using a shipping service.",
      "items": {
        "$ref": "#/definitions/PackageDocumentDetail"
      }
    },
    "TimeWindow": {
      "type": "object",
      "properties": {
        "start": {
          "type": "string",
          "format": "date-time",
          "description": "The start time of the time window."
        },
        "end": {
          "type": "string",
          "format": "date-time",
          "description": "The end time of the time window."
        }
      },
      "description": "The start and end time that specifies the time interval of an event."
    },
    "Promise": {
      "type": "object",
      "properties": {
        "deliveryWindow": {
          "$ref": "#/definitions/TimeWindow"
        },
        "pickupWindow": {
          "$ref": "#/definitions/TimeWindow"
        }
      },
      "description": "The time windows promised for pickup and delivery events."
    },
    "RequestedValueAddedServiceList": {
      "type": "array",
      "description": "The value-added services to be added to a shipping service purchase.",
      "items": {
        "$ref": "#/definitions/RequestedValueAddedService"
      }
    },
    "RequestedValueAddedService": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The identifier of the selected value-added service. Must be among those returned in the response to the getRates operation."
        }
      },
      "description": "A value-added service to be applied to a shipping service purchase."
    },
    "AvailableValueAddedServiceGroupList": {
      "type": "array",
      "description": "A list of value-added services available for a shipping service offering.",
      "items": {
        "$ref": "#/definitions/AvailableValueAddedServiceGroup"
      }
    },
    "AvailableValueAddedServiceGroup": {
      "type": "object",
      "required": [
        "groupDescription",
        "groupId",
        "isRequired"
      ],
      "properties": {
        "groupId": {
          "type": "string",
          "description": "The type of the value-added service group."
        },
        "groupDescription": {
          "type": "string",
          "description": "The name of the value-added service group."
        },
        "isRequired": {
          "type": "boolean",
          "description": "When true, one or more of the value-added services listed must be specified."
        },
        "valueAddedServices": {
          "type": "array",
          "description": "A list of optional value-added services available for purchase with a shipping service offering.",
          "items": {
            "$ref": "#/definitions/ValueAddedService"
          }
        }
      },
      "description": "The value-added services available for purchase with a shipping service offering."
    },
    "ValueAddedService": {
      "type": "object",
      "required": [
        "cost",
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The identifier for the value-added service."
        },
        "name": {
          "type": "string",
          "description": "The name of the value-added service."
        },
        "cost": {
          "description": "The cost of the value-added service.",
          "$ref": "#/definitions/Currency"
        }
      },
      "description": "A value-added service available for purchase with a shipment service offering."
    },
    "CollectOnDelivery": {
      "type": "object",
      "required": [
        "amount"
      ],
      "properties": {
        "amount": {
          "$ref": "#/definitions/Currency"
        }
      },
      "description": "The amount to collect on delivery."
    },
    "SignatureOnDelivery": {
      "type": "object",
      "properties": {
      },
      "description": "Setting this structure requests a service to confirm that the package has been delivered via signature at the time of delivery."
    },
    "OTPOnDelivery": {
      "type": "object",
      "properties": {
      },
      "description": "Setting this structure requests a service to confirm that the package has been delivered via One Time Passcode at the time of delivery."
    },
    "ValueAddedServiceDetails": {
      "type": "object",
      "properties": {
        "collectOnDelivery": {
          "$ref": "#/definitions/CollectOnDelivery"
        },
        "signatureOnDelivery": {
          "$ref": "#/definitions/SignatureOnDelivery"
        },
        "otpOnDelivery": {
          "$ref": "#/definitions/OTPOnDelivery"
        }
      },
      "description": "A collection of supported value-added services."
    },
    "DangerousGoodsDetails": {
      "type": "object",
      "properties": {
        "unitedNationsRegulatoryId": {
          "type": "string",
          "description": "The specific UNID of the item being shipped.",
          "pattern": "^(UN)[0-9]{4}$"
        },
        "transportationRegulatoryClass": {
          "type": "string",
          "description": "The specific regulatory class  of the item being shipped.",
          "pattern": "^[1-9](\\.[1-9])?$"
        },
        "packingGroup": {
          "type": "string",
          "description": "The specific packaging group of the item being shipped.",
          "enum": [
            "I",
            "II",
            "III"
          ],
          "x-docgen-enum-table-extension": [
            {
              "value": "I",
              "description": "Packing group I indicates great danger."
            },
            {
              "value": "II",
              "description": "Packing group II indicates medium danger."
            },
            {
              "value": "III",
              "description": "Packing group III indicates minor danger."
            }
          ]
        },
        "packingInstruction": {
          "type": "string",
          "description": "The specific packing instruction of the item being shipped.",
          "enum": [
            "PI965_SECTION_IA",
            "PI965_SECTION_IB",
            "PI965_SECTION_II",
            "PI966_SECTION_I",
            "PI966_SECTION_II",
            "PI967_SECTION_I",
            "PI967_SECTION_II",
            "PI968_SECTION_IA",
            "PI968_SECTION_IB",
            "PI969_SECTION_I",
            "PI969_SECTION_II",
            "PI970_SECTION_I",
            "PI970_SECTION_II"
          ],
          "x-docgen-enum-table-extension": [
            {
              "value": "PI965_SECTION_IA",
              "description": "Ion PI965 Section IA (LiBa)"
            },
            {
              "value": "PI965_SECTION_IB",
              "description": "Ion PI965 Section IB (LiBa)"
            },
            {
              "value": "PI965_SECTION_II",
              "description": "Ion PI965 Section II (LiBa)"
            },
            {
              "value": "PI966_SECTION_I",
              "description": "Ion PI966 Section I (LiBa with equipment)"
            },
            {
              "value": "PI966_SECTION_II",
              "description": "Ion PI966 Section II (LiBa with equipment)"
            },
            {
              "value": "PI967_SECTION_I",
              "description": "Ion PI967 Section I (LiBa in equipment)"
            },
            {
              "value": "PI967_SECTION_II",
              "description": "Ion PI967 Section II (LiBa in equipment)"
            },
            {
              "value": "PI968_SECTION_IA",
              "description": "Metal PI968 Section IA (LiBa)"
            },
            {
              "value": "PI968_SECTION_IB",
              "description": "Metal PI968 Section IB (LiBa)"
            },
            {
              "value": "PI969_SECTION_I",
              "description": "Metal PI969 Section I (LiBa with equipment)"
            },
            {
              "value": "PI969_SECTION_II",
              "description": "Metal PI969 Section II (LiBa with equipment)"
            },
            {
              "value": "PI970_SECTION_I",
              "description": "Metal PI970 Section I (LiBa in equipment)"
            },
            {
              "value": "PI970_SECTION_II",
              "description": "Metal PI970 Section II (LiBa in equipment)"
            }
          ]
        }
      },
      "description": "Details related to any dangerous goods/items that are being shipped."
    },
    "TaxType": {
      "type": "string",
      "description": "Indicates the type of tax.",
      "enum": [
        "GST"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "GST",
          "description": "Goods and Services Tax."
        }
      ]
    },
    "TaxDetail": {
      "description": "Indicates the tax specifications associated with the shipment for customs compliance purposes in certain regions.",
      "type": "object",
      "required": [
        "taxRegistrationNumber",
        "taxType"
      ],
      "properties": {
        "taxType": {
          "$ref": "#/definitions/TaxType"
        },
        "taxRegistrationNumber": {
          "description": "The shipper's tax registration number associated with the shipment for customs compliance purposes in certain regions.",
          "type": "string"
        }
      }
    },
    "TaxDetailList": {
      "type": "array",
      "description": "A list of tax detail information.",
      "items": {
        "$ref": "#/definitions/TaxDetail"
      }
    },
    "ShipperNumber": {
      "type": "string",
      "description": "A unique identifier for a shipper’s 'Amazon Shipping' account."
    },
    "GoodsOwner": {
      "type": "object",
      "description": "The seller owning the goods before handing them over to the carrier",
      "required": [
        "merchantId"
      ],
      "properties": {
        "merchantId": {
          "description": "The Amazon Merchant Identifier (merchantId) of the seller owning the goods before handing them over to the carrier",
          "$ref": "#/definitions/MerchantId"
        }
      }
    },
    "EventCode": {
      "type": "string",
      "description": "The tracking event type.",
      "enum": [
        "ReadyForReceive",
        "PickupDone",
        "Delivered",
        "Departed",
        "DeliveryAttempted",
        "Lost",
        "OutForDelivery",
        "ArrivedAtCarrierFacility",
        "Rejected",
        "Undeliverable",
        "PickupCancelled",
        "ReturnInitiated",
        "AvailableForPickup",
        "RecipientRequestedAlternateDeliveryTiming",
        "PackageReceivedByCarrier"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "ReadyForReceive",
          "description": "Package has been created and is ready for pickup at the shippers location. This is a pre-transit status event code."
        },
        {
          "value": "PickupDone",
          "description": "Package has been picked up by the service provider."
        },
        {
          "value": "Delivered",
          "description": "Package has been delivered."
        },
        {
          "value": "Departed",
          "description": "Package has departed from a particular location in carrier network."
        },
        {
          "value": "DeliveryAttempted",
          "description": "Delivery was attempted, but was unsuccessful."
        },
        {
          "value": "Lost",
          "description": "Package is lost."
        },
        {
          "value": "OutForDelivery",
          "description": "Package is out for delivery."
        },
        {
          "value": "ArrivedAtCarrierFacility",
          "description": "Package is in transit and has been received at a carrier location."
        },
        {
          "value": "Rejected",
          "description": "Package was rejected by the recipient."
        },
        {
          "value": "Undeliverable",
          "description": "Package is undeliverable."
        },
        {
          "value": "PickupCancelled",
          "description": "Pickup scheduled for the package was cancelled."
        },
        {
          "value": "ReturnInitiated",
          "description": "Return label has been generated."
        },
        {
          "value": "AvailableForPickup",
          "description": "Package held for recipient pickup."
        },
        {
          "value": "RecipientRequestedAlternateDeliveryTiming",
          "description": "Recipient has requested an update to their delivery date."
        },
        {
          "value": "PackageReceivedByCarrier",
          "description": "Package has been received at a carrier location."
        }
      ]
    },
    "Event": {
      "type": "object",
      "required": [
        "eventCode",
        "eventTime"
      ],
      "properties": {
        "eventCode": {
          "$ref": "#/definitions/EventCode"
        },
        "location": {
          "$ref": "#/definitions/Location"
        },
        "eventTime": {
          "type": "string",
          "format": "date-time",
          "description": "The ISO 8601 formatted timestamp of the event."
        },
        "shipmentType": {
          "$ref": "#/definitions/ShipmentType"
        }
      },
      "description": "A tracking event."
    },
    "TrackingSummary": {
      "type": "object",
      "properties": {
        "status": {
          "$ref": "#/definitions/Status"
        },
        "trackingDetailCodes": {
          "$ref": "#/definitions/TrackingDetailCodes"
        },
        "proofOfDelivery": {
          "$ref": "#/definitions/ProofOfDelivery"
        }
      },
      "description": "A package status summary."
    },
    "Status": {
      "type": "string",
      "description": "The status of the package being shipped.",
      "enum": [
        "PreTransit",
        "InTransit",
        "Delivered",
        "Lost",
        "OutForDelivery",
        "Rejected",
        "Undeliverable",
        "DeliveryAttempted",
        "PickupCancelled",
        "AwaitingCustomerPickup"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "PreTransit",
          "description": "Package has been created but has not been picked up."
        },
        {
          "value": "InTransit",
          "description": "Package has been picked up and is in transit."
        },
        {
          "value": "Delivered",
          "description": "Package has has been delivered successfully."
        },
        {
          "value": "Lost",
          "description": "Package is lost."
        },
        {
          "value": "OutForDelivery",
          "description": "Package is out for delivery."
        },
        {
          "value": "Rejected",
          "description": "Package has been rejected by the recipient."
        },
        {
          "value": "Undeliverable",
          "description": "Package was undeliverable."
        },
        {
          "value": "DeliveryAttempted",
          "description": "Delivery was attempted to the recipient location, but was not delivered."
        },
        {
          "value": "PickupCancelled",
          "description": "Pickup was cancelled for the package."
        },
        {
          "value": "AwaitingCustomerPickup",
          "description": "Package held at facility for the customer pickup."
        }
      ]
    },
    "ProofOfDelivery": {
      "type": "object",
      "description": "Contains the proof of delivery information for a package, if available and permitted.",
      "properties": {
        "deliveryLocationCoordinates": {
          "description": "This attribute exists only when available. The geographical coordinate of the package delivery location.",
          "$ref": "#/definitions/Geocode"
        },
        "deliveryImageURL": {
          "type": "string",
          "description": "This attribute exists only when available. A temporary URL that provides access to the image taken at the time of delivery. This URL is dynamically generated with each request, and remains valid for 72 hours before expiring. If the delivery image is needed again, another getTracking request can be made."
        },
        "signatureImageURL": {
          "type": "string",
          "description": "This attribute exists only when available. A temporary URL that provides access to the signature given at the time of delivery. This URL is dynamically generated with each request, and remains valid for 72 hours before expiring. If the signature image is needed again, another getTracking request can be made."
        },
        "receivedBy": {
          "type": "string",
          "description": "This attribute exists only when available. The recorded person or entity who received the package."
        }
      }
    },
    "AmazonOrderDetails": {
      "type": "object",
      "required": [
        "orderId"
      ],
      "properties": {
        "orderId": {
          "type": "string",
          "description": "The Amazon order ID associated with the Amazon order fulfilled by this shipment."
        }
      },
      "description": "Amazon order information. This is required if the shipment source channel is Amazon."
    },
    "AmazonShipmentDetails": {
      "type": "object",
      "required": [
        "shipmentId"
      ],
      "properties": {
        "shipmentId": {
          "type": "string",
          "description": "This attribute is required only for a Direct Fulfillment shipment. This is the encrypted shipment ID."
        }
      },
      "description": "Amazon shipment information."
    },
    "ChannelType": {
      "type": "string",
      "description": "The shipment source channel type.",
      "enum": [
        "AMAZON",
        "EXTERNAL"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "AMAZON",
          "description": "Indicates that the shipment originates from an Amazon order."
        },
        {
          "value": "EXTERNAL",
          "description": "Indicates that the shipment originates from a non-Amazon channel."
        }
      ]
    },
    "ChannelDetails": {
      "type": "object",
      "required": [
        "channelType"
      ],
      "properties": {
        "channelType": {
          "$ref": "#/definitions/ChannelType"
        },
        "amazonOrderDetails": {
          "$ref": "#/definitions/AmazonOrderDetails"
        },
        "amazonShipmentDetails": {
          "$ref": "#/definitions/AmazonShipmentDetails"
        }
      },
      "description": "Shipment source channel related information."
    },
    "RateList": {
      "type": "array",
      "description": "A list of eligible shipping service offerings.",
      "items": {
        "$ref": "#/definitions/Rate"
      }
    },
    "Rate": {
      "type": "object",
      "required": [
        "carrierId",
        "carrierName",
        "promise",
        "rateId",
        "requiresAdditionalInputs",
        "serviceId",
        "serviceName",
        "supportedDocumentSpecifications",
        "totalCharge"
      ],
      "properties": {
        "rateId": {
          "$ref": "#/definitions/RateId"
        },
        "carrierId": {
          "$ref": "#/definitions/CarrierId"
        },
        "carrierName": {
          "$ref": "#/definitions/CarrierName"
        },
        "serviceId": {
          "$ref": "#/definitions/ServiceId"
        },
        "serviceName": {
          "$ref": "#/definitions/ServiceName"
        },
        "billedWeight": {
          "$ref": "#/definitions/Weight"
        },
        "totalCharge": {
          "$ref": "#/definitions/Currency"
        },
        "promise": {
          "$ref": "#/definitions/Promise"
        },
        "supportedDocumentSpecifications": {
          "$ref": "#/definitions/SupportedDocumentSpecificationList"
        },
        "availableValueAddedServiceGroups": {
          "$ref": "#/definitions/AvailableValueAddedServiceGroupList"
        },
        "requiresAdditionalInputs": {
          "type": "boolean",
          "description": "When true, indicates that additional inputs are required to purchase this shipment service. You must then call the getAdditionalInputs operation to return the JSON schema to use when providing the additional inputs to the purchaseShipment operation."
        },
        "rateItemList": {
          "$ref": "#/definitions/RateItemList"
        },
        "paymentType": {
          "$ref": "#/definitions/PaymentType"
        },
        "benefits": {
          "$ref": "#/definitions/Benefits"
        }
      },
      "description": "The details of a shipping service offering."
    },
    "IneligibilityReasonCode": {
      "type": "string",
      "description": "Reasons that make a shipment service offering ineligible.",
      "enum": [
        "NO_COVERAGE",
        "PICKUP_SLOT_RESTRICTION",
        "UNSUPPORTED_VAS",
        "VAS_COMBINATION_RESTRICTION",
        "SIZE_RESTRICTIONS",
        "WEIGHT_RESTRICTIONS",
        "LATE_DELIVERY",
        "PROGRAM_CONSTRAINTS",
        "TERMS_AND_CONDITIONS_NOT_ACCEPTED",
        "UNKNOWN"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "NO_COVERAGE",
          "description": "The shipment is ineligible because there is no coverage to that address."
        },
        {
          "value": "PICKUP_SLOT_RESTRICTION",
          "description": "The shipment is ineligible because there is an issue with the pickup slot."
        },
        {
          "value": "UNSUPPORTED_VAS",
          "description": "The shipment is ineligible because the value-added service is invalid for this shipment."
        },
        {
          "value": "VAS_COMBINATION_RESTRICTION",
          "description": "The shipment is ineligible because an invalid combination of value-added services were chosen."
        },
        {
          "value": "SIZE_RESTRICTIONS",
          "description": "The shipment is ineligible because the package dimensions are unsupported."
        },
        {
          "value": "WEIGHT_RESTRICTIONS",
          "description": "The shipment is ineligible because the weight is unsupported."
        },
        {
          "value": "LATE_DELIVERY",
          "description": "The shipment is ineligible because delivery is too late."
        },
        {
          "value": "PROGRAM_CONSTRAINTS",
          "description": "The shipment is ineligible because of program constraints."
        },
        {
          "value": "TERMS_AND_CONDITIONS_NOT_ACCEPTED",
          "description": "The shipment is ineligible because terms and conditions have not been accepted by the carrier."
        },
        {
          "value": "UNKNOWN",
          "description": "The ineligibility reason is unknown."
        }
      ]
    },
    "IneligibilityReason": {
      "description": "The reason why a shipping service offering is ineligible.",
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "$ref": "#/definitions/IneligibilityReasonCode"
        },
        "message": {
          "type": "string",
          "description": "The ineligibility reason."
        }
      }
    },
    "IneligibleRate": {
      "description": "Detailed information for an ineligible shipping service offering.",
      "type": "object",
      "required": [
        "carrierId",
        "carrierName",
        "ineligibilityReasons",
        "serviceId",
        "serviceName"
      ],
      "properties": {
        "serviceId": {
          "$ref": "#/definitions/ServiceId"
        },
        "serviceName": {
          "$ref": "#/definitions/ServiceName"
        },
        "carrierName": {
          "$ref": "#/definitions/CarrierName"
        },
        "carrierId": {
          "$ref": "#/definitions/CarrierId"
        },
        "ineligibilityReasons": {
          "type": "array",
          "description": "A list of reasons why a shipping service offering is ineligible.",
          "items": {
            "$ref": "#/definitions/IneligibilityReason"
          }
        }
      }
    },
    "IneligibleRateList": {
      "type": "array",
      "description": "A list of ineligible shipping service offerings.",
      "items": {
        "$ref": "#/definitions/IneligibleRate"
      }
    },
    "CancelShipmentResult": {
      "type": "object",
      "description": "The payload for the cancelShipment operation.",
      "additionalProperties": {}
    },
    "CancelShipmentResponse": {
      "type": "object",
      "properties": {
        "payload": {
          "$ref": "#/definitions/CancelShipmentResult"
        }
      },
      "description": "Response schema for the cancelShipment operation."
    },
    "GetRatesRequest": {
      "description": "The request schema for the getRates operation. When the channelType is Amazon, the shipTo address is not required and will be ignored.",
      "type": "object",
      "required": [
        "channelDetails",
        "packages",
        "shipFrom"
      ],
      "properties": {
        "shipTo": {
          "description": "The ship to address.",
          "$ref": "#/definitions/Address"
        },
        "shipFrom": {
          "description": "The ship from address.",
          "$ref": "#/definitions/Address"
        },
        "returnTo": {
          "description": "The return to address.",
          "$ref": "#/definitions/Address"
        },
        "shipDate": {
          "type": "string",
          "format": "date-time",
          "description": "The ship date and time (the requested pickup). This defaults to the current date and time."
        },
        "quoteForShipperNumber": {
          "$ref": "#/definitions/ShipperNumber",
          "description": "The shipper's account number used to generate quoted price, which may be different from the requester's account number."
        },
        "shipmentForShipperNumber": {
          "$ref": "#/definitions/ShipperNumber",
          "description": "The Amazon Shipping Account ID responsible for managing and tracking the shipment."
        },
        "shipperInstruction": {
          "$ref": "#/definitions/ShipperInstruction",
          "description": "This field describe shipper instruction."
        },
        "packages": {
          "$ref": "#/definitions/PackageList"
        },
        "valueAddedServices": {
          "$ref": "#/definitions/ValueAddedServiceDetails"
        },
        "taxDetails": {
          "$ref": "#/definitions/TaxDetailList"
        },
        "channelDetails": {
          "$ref": "#/definitions/ChannelDetails"
        },
        "clientReferenceDetails": {
          "$ref": "#/definitions/ClientReferenceDetails"
        },
        "shipmentType": {
          "$ref": "#/definitions/ShipmentType"
        },
        "destinationAccessPointDetails": {
          "$ref": "#/definitions/AccessPointDetails"
        }
      }
    },
    "AccessPointDetails": {
      "type": "object",
      "description": "AccessPointDetails object",
      "properties": {
        "accessPointId": {
          "$ref": "#/definitions/AccessPointId"
        }
      }
    },
    "NdrAction": {
      "type": "string",
      "description": "The type of NDR action shipper wants to take for a particular shipment.",
      "enum": [
        "RESCHEDULE",
        "REATTEMPT",
        "RTO"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "RESCHEDULE",
          "description": "Seller wants to reschedule shipment delivery to a specific date."
        },
        {
          "value": "REATTEMPT",
          "description": "Seller wants to re-attempt delivery with additional delivery notes."
        },
        {
          "value": "RTO",
          "description": "Seller wants the shipment to return to the origin."
        }
      ]
    },
    "NdrRequestData": {
      "type": "object",
      "description": "Additional information required for the NDR action that has been filed. If the NDR Action is RESCHEDULE, rescheduleDate is a required field. Otherwise, if the NDR Action is REATTEMPT, additionalAddressNotes is a required field. ",
      "properties": {
        "rescheduleDate": {
          "type": "string",
          "format": "date-time",
          "description": "The date on which the Seller wants to reschedule shipment delivery, in ISO-8601 date/time format",
          "example": "2023-12-12T05:24:00.00Z"
        },
        "additionalAddressNotes": {
          "$ref": "#/definitions/AdditionalAddressNotes"
        }
      }
    },
    "GetRatesResult": {
      "type": "object",
      "required": [
        "rates",
        "requestToken"
      ],
      "properties": {
        "requestToken": {
          "$ref": "#/definitions/RequestToken"
        },
        "rates": {
          "$ref": "#/definitions/RateList"
        },
        "ineligibleRates": {
          "$ref": "#/definitions/IneligibleRateList"
        }
      },
      "description": "The payload for the getRates operation."
    },
    "GetRatesResponse": {
      "type": "object",
      "properties": {
        "payload": {
          "$ref": "#/definitions/GetRatesResult"
        }
      },
      "description": "The response schema for the getRates operation."
    },
    "GetShipmentDocumentsResult": {
      "type": "object",
      "required": [
        "packageDocumentDetail",
        "shipmentId"
      ],
      "properties": {
        "shipmentId": {
          "$ref": "#/definitions/ShipmentId"
        },
        "packageDocumentDetail": {
          "$ref": "#/definitions/PackageDocumentDetail"
        },
        "benefits": {
          "$ref": "#/definitions/Benefits"
        }
      },
      "description": "The payload for the getShipmentDocuments operation."
    },
    "GetShipmentDocumentsResponse": {
      "type": "object",
      "properties": {
        "payload": {
          "$ref": "#/definitions/GetShipmentDocumentsResult"
        }
      },
      "description": "The response schema for the the getShipmentDocuments operation."
    },
    "GetTrackingResult": {
      "type": "object",
      "required": [
        "eventHistory",
        "promisedDeliveryDate",
        "summary",
        "trackingId",
        "alternateLegTrackingId"
      ],
      "properties": {
        "trackingId": {
          "$ref": "#/definitions/TrackingId"
        },
        "alternateLegTrackingId": {
          "$ref": "#/definitions/AlternateLegTrackingId"
        },
        "eventHistory": {
          "type": "array",
          "description": "A list of tracking events.",
          "items": {
            "$ref": "#/definitions/Event"
          }
        },
        "promisedDeliveryDate": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time by which the shipment is promised to be delivered."
        },
        "summary": {
          "$ref": "#/definitions/TrackingSummary"
        }
      },
      "description": "The payload for the getTracking operation."
    },
    "SubmitNdrFeedbackRequest": {
      "type": "object",
      "description": "The request schema for the NdrFeedback operation",
      "required": [
        "trackingId",
        "ndrAction"
      ],
      "properties": {
        "trackingId": {
          "$ref": "#/definitions/TrackingId"
        },
        "ndrAction": {
          "$ref": "#/definitions/NdrAction"
        },
        "ndrRequestData": {
          "$ref": "#/definitions/NdrRequestData"
        }
      }
    },
    "GetTrackingResponse": {
      "type": "object",
      "properties": {
        "payload": {
          "$ref": "#/definitions/GetTrackingResult"
        }
      },
      "description": "The response schema for the getTracking operation."
    },
    "PurchaseShipmentRequest": {
      "description": "The request schema for the purchaseShipment operation.",
      "type": "object",
      "required": [
        "rateId",
        "requestedDocumentSpecification",
        "requestToken"
      ],
      "properties": {
        "requestToken": {
          "$ref": "#/definitions/RequestToken"
        },
        "rateId": {
          "$ref": "#/definitions/RateId"
        },
        "requestedDocumentSpecification": {
          "$ref": "#/definitions/RequestedDocumentSpecification"
        },
        "requestedValueAddedServices": {
          "$ref": "#/definitions/RequestedValueAddedServiceList"
        },
        "additionalInputs": {
          "type": "object",
          "additionalProperties": {},
          "description": "The additional inputs required to purchase a shipping offering, in JSON format. The JSON provided here must adhere to the JSON schema that is returned in the response to the getAdditionalInputs operation.\n\nAdditional inputs are only required when indicated by the requiresAdditionalInputs property in the response to the getRates operation."
        }
      }
    },
    "PurchaseShipmentResult": {
      "type": "object",
      "required": [
        "packageDocumentDetails",
        "promise",
        "shipmentId"
      ],
      "properties": {
        "shipmentId": {
          "$ref": "#/definitions/ShipmentId"
        },
        "packageDocumentDetails": {
          "$ref": "#/definitions/PackageDocumentDetailList"
        },
        "promise": {
          "$ref": "#/definitions/Promise"
        },
        "benefits": {
          "$ref": "#/definitions/Benefits"
        }
      },
      "description": "The payload for the purchaseShipment operation."
    },
    "PurchaseShipmentResponse": {
      "type": "object",
      "properties": {
        "payload": {
          "$ref": "#/definitions/PurchaseShipmentResult"
        }
      },
      "description": "The response schema for the purchaseShipment operation."
    },
    "OneClickShipmentRequest": {
      "description": "The request schema for the OneClickShipment operation. When the channelType is not Amazon, shipTo is required and when channelType is Amazon shipTo is ignored.",
      "type": "object",
      "required": [
        "channelDetails",
        "packages",
        "shipFrom",
        "labelSpecifications",
        "serviceSelection"
      ],
      "properties": {
        "shipTo": {
          "description": "The ship to address.",
          "$ref": "#/definitions/Address"
        },
        "shipFrom": {
          "description": "The ship from address.",
          "$ref": "#/definitions/Address"
        },
        "returnTo": {
          "description": "The return to address.",
          "$ref": "#/definitions/Address"
        },
        "shipDate": {
          "type": "string",
          "format": "date-time",
          "description": "The ship date and time (the requested pickup). This defaults to the current date and time."
        },
        "goodsOwner": {
          "description": "The seller owning the goods before handing them over to the carrier",
          "$ref": "#/definitions/GoodsOwner"
        },
        "packages": {
          "$ref": "#/definitions/PackageList"
        },
        "valueAddedServicesDetails": {
          "$ref": "#/definitions/OneClickShipmentValueAddedServiceDetails"
        },
        "valueAddedServices": {
          "$ref": "#/definitions/ValueAddedServiceDetails"
        },
        "taxDetails": {
          "$ref": "#/definitions/TaxDetailList"
        },
        "channelDetails": {
          "$ref": "#/definitions/ChannelDetails"
        },
        "labelSpecifications": {
          "$ref": "#/definitions/RequestedDocumentSpecification"
        },
        "serviceSelection": {
          "$ref": "#/definitions/ServiceSelection"
        },
        "shipperInstruction": {
          "$ref": "#/definitions/ShipperInstruction",
          "description": "Optional field for shipper instruction."
        },
        "destinationAccessPointDetails": {
          "$ref": "#/definitions/AccessPointDetails"
        }
      }
    },
    "OneClickShipmentResponse": {
      "type": "object",
      "properties": {
        "payload": {
          "$ref": "#/definitions/OneClickShipmentResult"
        }
      },
      "description": "The response schema for the OneClickShipment operation."
    },
    "OneClickShipmentResult": {
      "type": "object",
      "required": [
        "packageDocumentDetails",
        "promise",
        "shipmentId",
        "service",
        "carrier",
        "totalCharge"
      ],
      "properties": {
        "shipmentId": {
          "$ref": "#/definitions/ShipmentId"
        },
        "packageDocumentDetails": {
          "$ref": "#/definitions/PackageDocumentDetailList"
        },
        "promise": {
          "$ref": "#/definitions/Promise"
        },
        "carrier": {
          "$ref": "#/definitions/Carrier"
        },
        "service": {
          "$ref": "#/definitions/Service"
        },
        "rateItems": {
          "$ref": "#/definitions/RateItemList"
        },
        "totalCharge": {
          "$ref": "#/definitions/Currency"
        }
      },
      "description": "The payload for the OneClickShipment API."
    },
    "GetAccessPointsResponse": {
      "type": "object",
      "properties": {
        "payload": {
          "$ref": "#/definitions/GetAccessPointsResult"
        }
      },
      "description": "The response schema for the GetAccessPoints operation."
    },
    "GetAccessPointsResult": {
      "type": "object",
      "required": [
        "accessPointsMap"
      ],
      "properties": {
        "accessPointsMap": {
          "$ref": "#/definitions/AccessPointsMap"
        }
      },
      "description": "The payload for the GetAccessPoints API."
    },
    "AccessPointType": {
      "description": "The type of access point, like counter (HELIX), lockers, etc.",
      "type": "string",
      "enum": [
        "HELIX",
        "CAMPUS_LOCKER",
        "OMNI_LOCKER",
        "ODIN_LOCKER",
        "DOBBY_LOCKER",
        "CORE_LOCKER",
        "3P",
        "CAMPUS_ROOM"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "HELIX",
          "description": "Counter, aka Helix, is an assisted access point where customers interact with a store associate to collect or return packages. Counter stores do not have Locker"
        },
        {
          "value": "CAMPUS_LOCKER",
          "description": "It denotes a physical Locker present at Locker+ stores"
        },
        {
          "value": "OMNI_LOCKER",
          "description": "Omni lockers are similar to core lockers installed at apartment buildings. Core and Omni will have common base hardware platform"
        },
        {
          "value": "ODIN_LOCKER",
          "description": "Odin lockers rely on Bluetooth connection as there is no screen or scanner on the locker. Drivers, customers, and even technicians can interact with the locker using an app (different depending on the user)."
        },
        {
          "value": "DOBBY_LOCKER",
          "description": "Dobby lockers are Odin lockers installed at apartment complexes and available only to residents."
        },
        {
          "value": "CORE_LOCKER",
          "description": "Core lockers are the traditional and initial style of lockers when Hub was launched. Core lockers have a screen, keypad and scanner.  Customer either enter their pickup code using the Locker screen or scan pickup code barcode to pick up their package."
        },
        {
          "value": "3P",
          "description": "Networks that are owned end-to-end by commercial carriers (CC - e.g. DHL, UPS, DPD and Postal organizations), who operate both the transportation leg and the access point aspect. These networks offer a range of pickup points including: 3P Lockers, legacy Postal Offices, 3P Counters (e.g. Gas Stations and Retail Outlets - supermarkets, bookstores, news-stands etc)."
        },
        {
          "value": "CAMPUS_ROOM",
          "description": "Locker+, formerly known as Campus, are attended, physical stores, where the Locker is used dynamically by the staff to keep packages ready for customer pickup. Locker+ store can have multiple Lockers installed,"
        }
      ]
    },
    "AccessPointsMap": {
      "description": "Map of type of access point to list of access points",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/AccessPointList"
      }
    },
    "AccessPointList": {
      "description": "List of relevant Access points requested by shipper. These access points are sorted by proximity to postal code, and are limited to 40. We have internally defined a radius value to render relevant results.",
      "type": "array",
      "items": {
        "$ref": "#/definitions/AccessPoint"
      }
    },
    "AccessPointId": {
      "description": "Unique identifier for the access point",
      "type": "string"
    },
    "AccessPoint": {
      "type": "object",
      "description": "Access point details",
      "properties": {
        "accessPointId": {
          "$ref": "#/definitions/AccessPointId"
        },
        "name": {
          "description": "Name of entity (store/hub etc) where this access point is located",
          "type": "string"
        },
        "timezone": {
          "description": "Timezone of access point",
          "type": "string"
        },
        "type": {
          "$ref": "#/definitions/AccessPointType"
        },
        "accessibilityAttributes": {
          "$ref": "#/definitions/AccessibilityAttributes"
        },
        "address": {
          "$ref": "#/definitions/Address"
        },
        "exceptionOperatingHours": {
          "type": "array",
          "description": "Exception operating hours for Access Point",
          "items": {
            "$ref": "#/definitions/ExceptionOperatingHours"
          }
        },
        "assistanceType": {
          "type": "string",
          "description": "Assistance type enum for Access point i.e. STAFF_ASSISTED or SELF_ASSISTED",
          "enum": [
            "STAFF_ASSISTED",
            "SELF_ASSISTED"
          ]
        },
        "score": {
          "type": "string",
          "description": "The score of access point, based on proximity to postal code and sorting preference. This can be used to sort access point results on shipper's end."
        },
        "standardOperatingHours": {
          "$ref": "#/definitions/DayOfWeekTimeMap"
        }
      }
    },
    "AccessibilityAttributes": {
      "type": "object",
      "description": "Defines the accessibility details of the access point.",
      "properties": {
        "distance": {
          "description": "The approximate distance of access point from input postalCode's centroid.",
          "type": "string"
        },
        "driveTime": {
          "description": "The approximate (static) drive time from input postal code's centroid.",
          "type": "integer"
        }
      }
    },
    "OperatingHours": {
      "type": "object",
      "description": "The hours in which the access point shall remain operational",
      "properties": {
        "closingTime": {
          "$ref": "#/definitions/TimeOfDay"
        },
        "openingTime": {
          "$ref": "#/definitions/TimeOfDay"
        },
        "midDayClosures": {
          "type": "array",
          "description": "midDayClosures operating hours array",
          "items": {
            "$ref": "#/definitions/TimeOfDay"
          }
        }
      }
    },
    "TimeOfDay": {
      "type": "object",
      "description": "Denotes time of the day, used for defining opening or closing time of access points",
      "properties": {
        "hourOfDay": {
          "type": "integer",
          "description": "Denotes hour of the day, used for defining opening or closing time of access points"
        },
        "minuteOfHour": {
          "type": "integer",
          "description": "Denotes minute of the hour, used for defining opening or closing time of access points"
        },
        "secondOfMinute": {
          "type": "integer",
          "description": "Denotes second of the minute, used for defining opening or closing time of access points"
        }
      }
    },
    "DayOfWeekTimeMap": {
      "description": "Map of day of the week to operating hours of that day",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/OperatingHours"
      }
    },
    "ExceptionOperatingHours": {
      "type": "object",
      "description": "Defines exceptions to standard operating hours for certain date ranges.",
      "properties": {
        "dateRange": {
          "$ref": "#/definitions/DateRange"
        },
        "operatingHours": {
          "$ref": "#/definitions/OperatingHours"
        }
      }
    },
    "GetAdditionalInputsResult": {
      "type": "object",
      "description": "The JSON schema to use to provide additional inputs when required to purchase a shipping offering.",
      "additionalProperties": {}
    },
    "GetAdditionalInputsResponse": {
      "type": "object",
      "properties": {
        "payload": {
          "$ref": "#/definitions/GetAdditionalInputsResult"
        }
      },
      "description": "The response schema for the getAdditionalInputs operation."
    },
    "ClientReferenceDetails": {
      "type": "array",
      "description": "Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail",
      "items": {
        "$ref": "#/definitions/ClientReferenceDetail"
      }
    },
    "ClientReferenceDetail": {
      "type": "object",
      "required": [
        "clientReferenceType",
        "clientReferenceId"
      ],
      "properties": {
        "clientReferenceType": {
          "type": "string",
          "description": "Client Reference type.",
          "enum": [
            "IntegratorShipperId",
            "IntegratorMerchantId"
          ],
          "x-docgen-enum-table-extension": [
            {
              "value": "IntegratorShipperId",
              "description": "The unique identifier assigned to a 3P seller by the shipping integrator."
            },
            {
              "value": "IntegratorMerchantId",
              "description": "The unique identifier assigned to a 3P shipping integrator by Amazon."
            }
          ]
        },
        "clientReferenceId": {
          "type": "string",
          "description": "The Client Reference Id."
        }
      },
      "description": "Client Reference Details"
    },
    "ShipmentType": {
      "type": "string",
      "description": "Shipment type.",
      "enum": [
        "FORWARD",
        "RETURNS"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "FORWARD",
          "description": "Additional information about shipment representing package journey from origin address to destination address in the transportation/shipping request."
        },
        {
          "value": "RETURNS",
          "description": "Additional information about shipment representing package journey from destination address to origin/return address in the original transportation/shipping request."
        }
      ]
    },
    "DateRange": {
      "type": "object",
      "properties": {
        "startDate": {
          "type": "string",
          "format": "dateTime",
          "description": "Start Date for query ."
        },
        "endDate": {
          "type": "string",
          "format": "dateTime",
          "description": "end date for query."
        }
      },
      "description": "Date Range for query the results."
    },
    "MerchantId": {
      "type": "string",
      "description": "merchant Id of provided merchant "
    },
    "PaymentType": {
      "type": "string",
      "description": "Payment type of the purchase.",
      "enum": [
        "PAY_THROUGH_AMAZON",
        "PAY_DIRECT_TO_CARRIER"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "PAY_THROUGH_AMAZON",
          "description": "Payment Through Amazon."
        },
        {
          "value": "PAY_DIRECT_TO_CARRIER",
          "description": "Payment Direct to Carrier."
        }
      ]
    },
    "RateItemList": {
      "type": "array",
      "description": "A list of RateItem",
      "items": {
        "$ref": "#/definitions/RateItem"
      }
    },
    "RateItem": {
      "type": "object",
      "properties": {
        "rateItemID": {
          "$ref": "#/definitions/RateItemID"
        },
        "rateItemType": {
          "$ref": "#/definitions/RateItemType"
        },
        "rateItemCharge": {
          "$ref": "#/definitions/Currency"
        },
        "rateItemNameLocalization": {
          "type": "string",
          "description": "Used for the localization."
        }
      },
      "description": "Rate Item for shipping (base cost, transaction fee, confirmation, insurance, etc.) Data source definition: "
    },
    "RateItemID": {
      "type": "string",
      "description": "Unique ID for the rateItem.",
      "enum": [
        "BASE_RATE",
        "TRANSACTION_FEE",
        "ADULT_SIGNATURE_CONFIRMATION",
        "SIGNATURE_CONFIRMATION",
        "NO_CONFIRMATION",
        "WAIVE_SIGNATURE",
        "IMPLIED_LIABILITY",
        "HIDDEN_POSTAGE",
        "DECLARED_VALUE",
        "SUNDAY_HOLIDAY_DELIVERY",
        "DELIVERY_CONFIRMATION",
        "IMPORT_DUTY_CHARGE",
        "VAT",
        "NO_SATURDAY_DELIVERY",
        "INSURANCE",
        "COD",
        "FUEL_SURCHARGE",
        "INSPECTION_CHARGE",
        "DELIVERY_AREA_SURCHARGE",
        "WAYBILL_CHARGE",
        "AMAZON_SPONSORED_DISCOUNT",
        "INTEGRATOR_SPONSORED_DISCOUNT",
        "OVERSIZE_SURCHARGE",
        "CONGESTION_CHARGE",
        "RESIDENTIAL_SURCHARGE",
        "ADDITIONAL_SURCHARGE",
        "SURCHARGE",
        "REBATE",
        "HIGH_CUBE_SURCHARGE",
        "HIGH_LENGTH_SURCHARGE",
        "HIGH_WIDTH_SURCHARGE",
        "DEMAND_SURCHARGE",
        "NONSTANDARD_FEE",
        "NON_CONVEYABLE_SURCHARGE",
        "OTP_ON_DELIVERY_FEE"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "BASE_RATE",
          "description": "for Base Rate."
        },
        {
          "value": "TRANSACTION_FEE",
          "description": "Charge for TransAction Fee."
        },
        {
          "value": "ADULT_SIGNATURE_CONFIRMATION",
          "description": "Charge for Adult Signature Confirmation."
        },
        {
          "value": "SIGNATURE_CONFIRMATION",
          "description": "Charge for signature confirmation."
        },
        {
          "value": "NO_CONFIRMATION",
          "description": "Charge for No Confirmation."
        },
        {
          "value": "WAIVE_SIGNATURE",
          "description": "Charge for Waive Signature."
        },
        {
          "value": "IMPLIED_LIABILITY",
          "description": "Charge for Implied Liability."
        },
        {
          "value": "HIDDEN_POSTAGE",
          "description": "Hidden Postage Charge."
        },
        {
          "value": "DECLARED_VALUE",
          "description": "Declared Valure Coverage Charge."
        },
        {
          "value": "SUNDAY_HOLIDAY_DELIVERY",
          "description": "Sunday Holiday Delivery Charge."
        },
        {
          "value": "DELIVERY_CONFIRMATION",
          "description": "Charge for Delivery Confirmation."
        },
        {
          "value": "IMPORT_DUTY_CHARGE",
          "description": "Import Duty Charge."
        },
        {
          "value": "VAT",
          "description": "Vat Charge."
        },
        {
          "value": "NO_SATURDAY_DELIVERY",
          "description": "Charge for No Satuarday Delivery."
        },
        {
          "value": "INSURANCE",
          "description": "Insurance Charge."
        },
        {
          "value": "COD",
          "description": "COD Charge."
        },
        {
          "value": "AMAZON_SPONSORED_DISCOUNT",
          "description": "Amazon Sponsored Discount."
        },
        {
          "value": "INTEGRATOR_SPONSORED_DISCOUNT",
          "description": "Integrator Sponsored Discount."
        },
        {
          "value": "FUEL_SURCHARGE",
          "description": "Fuel Surcharge."
        },
        {
          "value": "INSPECTION_CHARGE",
          "description": "Inspection Charge."
        },
        {
          "value": "DELIVERY_AREA_SURCHARGE",
          "description": "Delivery Area Surcharge."
        },
        {
          "value": "WAYBILL_CHARGE",
          "description": "WayBill Charge."
        },
        {
          "value": "OVERSIZE_SURCHARGE",
          "description": "OverSize Surcharge."
        },
        {
          "value": "CONGESTION_CHARGE",
          "description": "Congestion Charge."
        },
        {
          "value": "RESIDENTIAL_SURCHARGE",
          "description": "Residential Surcharge."
        },
        {
          "value": "ADDITIONAL_SURCHARGE",
          "description": "Additional Surcharge."
        },
        {
          "value": "SURCHARGE",
          "description": "Surcharge."
        },
        {
          "value": "REBATE",
          "description": "Rebate."
        },
        {
          "value": "HIGH_CUBE_SURCHARGE",
          "description": "High Cube Surcharge."
        },
        {
          "value": "HIGH_LENGTH_SURCHARGE",
          "description": "High Length Surcharge."
        },
        {
          "value": "HIGH_WIDTH_SURCHARGE",
          "description": "High Width Surcharge."
        },
        {
          "value": "DEMAND_SURCHARGE",
          "description": "A fee that is applied during specific periods of increased demand on the network as specified in the Amazon Shipping Service guide."
        },
        {
          "value": "NONSTANDARD_FEE",
          "description": "A fee that applies for packages that are outside the standard size for processing and sorting as specified in the Amazon Shipping Service guide."
        },
        {
          "value": "NON_CONVEYABLE_SURCHARGE",
          "description": "A handling surcharge which applies to a package, as defined in the Non-Conveyable Surcharge section of the Amazon Shipping Service guide."
        },
        {
          "value": "OTP_ON_DELIVERY_FEE",
          "description": "A fee for one-time passcode on delivery value added service as defined in the Amazon Shipping Service Guide."
        }
      ]
    },
    "RateItemType": {
      "type": "string",
      "description": "Type of the rateItem.",
      "enum": [
        "MANDATORY",
        "OPTIONAL",
        "INCLUDED"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "MANDATORY",
          "description": "Rate Item is mandatory."
        },
        {
          "value": "OPTIONAL",
          "description": "Rate Item is Optional."
        },
        {
          "value": "INCLUDED",
          "description": "Rate Item is included."
        }
      ]
    },
    "Benefits": {
      "type": "object",
      "description": "Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (eg. CLAIMS_PROTECTED, etc.) when sellers purchase shipping through Amazon. Benefit details will be made available for any shipment placed on or after January 1st 2024 00:00 UTC.",
      "required": [
        "includedBenefits",
        "excludedBenefits"
      ],
      "properties": {
        "includedBenefits": {
          "$ref": "#/definitions/IncludedBenefits"
        },
        "excludedBenefits": {
          "$ref": "#/definitions/ExcludedBenefits"
        }
      }
    },
    "IncludedBenefits": {
      "type": "array",
      "description": "A list of included benefits.",
      "items": {
        "type": "string"
      }
    },
    "ExcludedBenefits": {
      "type": "array",
      "description": "A list of excluded benefit. Refer to the ExcludeBenefit object for further documentation",
      "items": {
        "$ref": "#/definitions/ExcludedBenefit"
      }
    },
    "ExcludedBenefit": {
      "type": "object",
      "description": "Object representing a benefit that is excluded for a shipping offer or rate.",
      "required": [
        "benefit"
      ],
      "properties": {
        "benefit": {
          "type": "string",
          "description": "benefit"
        },
        "reasonCodes": {
          "$ref": "#/definitions/ExcludedBenefitReasonCodes"
        }
      }
    },
    "ExcludedBenefitReasonCodes": {
      "type": "array",
      "description": "List of reasons (eg. LATE_DELIVERY_RISK, etc.) indicating why a benefit is excluded for a shipping offer.",
      "minItems": 1,
      "items": {
        "type": "string"
      }
    },
    "ServiceSelection": {
      "description": "Service Selection Criteria.",
      "type": "object",
      "required": [
        "serviceId"
      ],
      "properties": {
        "serviceId": {
          "$ref": "#/definitions/ServiceIds"
        }
      }
    },
    "ServiceIds": {
      "type": "array",
      "description": "A list of ServiceId.",
      "items": {
        "type": "string"
      }
    },
    "OneClickShipmentValueAddedServiceDetails": {
      "type": "array",
      "description": "This field is deprecated. This field only supports the Collect on Delivery (COD) value added service.",
      "items": {
        "$ref": "#/definitions/OneClickShipmentValueAddedService"
      }
    },
    "OneClickShipmentValueAddedService": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The identifier of the selected value-added service."
        },
        "amount": {
          "$ref": "#/definitions/Currency"
        }
      },
      "description": "A value-added service to be applied to a shipping service purchase."
    },
    "Service": {
      "type": "object",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "$ref": "#/definitions/ServiceId"
        },
        "name": {
          "$ref": "#/definitions/ServiceName"
        }
      },
      "description": "Service Related Info"
    },
    "Carrier": {
      "type": "object",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "$ref": "#/definitions/CarrierId"
        },
        "name": {
          "$ref": "#/definitions/CarrierName"
        }
      },
      "description": "Carrier Related Info"
    }
  }
}