Shipping API v2 model

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

{
  "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",
    "contact": {
      "name": "Amazon Shipping API Support",
      "email": "[email protected]"
    },
    "license": {
      "name": "Amazon Software License",
      "url": "https://aws.amazon.com/asl/"
    }
  },
  "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| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 80 | 100 |\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": "getRates",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/GetRatesRequest"
            }
          },
          {
            "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_UAE",
              "AmazonShipping_SA",
              "AmazonShipping_EG",
              "AmazonShipping_IT"
            ],
            "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_UAE",
                "description": "The United Arab Emirates Amazon shipping business."
              },
              {
                "value": "AmazonShipping_SA",
                "description": "The Saudi Arabia Amazon shipping business."
              },
              {
                "value": "AmazonShipping_EG",
                "description": "The Egypt Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IT",
                "description": "The Italy 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": {
                        "startTime": "2018-08-24T08:22:30.737Z",
                        "endTime": "2018-08-24T20:22:30.737Z"
                      },
                      "pickupWindow": {
                        "startTime": "2018-08-23T08:22:30.737Z",
                        "endTime": "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
                  }
                ],
                "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-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."
              }
            }
          },
          "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/directPurchase": {
      "post": {
        "tags": [
          "shipping"
        ],
        "description": "Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 80 | 100 |\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": "directPurchaseShipment",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/DirectPurchaseRequest"
            }
          },
          {
            "name": "x-amzn-IdempotencyKey",
            "description": "A unique value which the server uses to recognize subsequent retries of the same request.",
            "in": "header",
            "required": false,
            "type": "string"
          },
          {
            "name": "locale",
            "description": "The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA).\nThe secondary language subtag is almost always a regional designation.\nThis does not support additional subtags beyond the primary and secondary language subtags.\n",
            "in": "header",
            "required": false,
            "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_UAE",
              "AmazonShipping_SA",
              "AmazonShipping_EG",
              "AmazonShipping_IT"
            ],
            "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_UAE",
                "description": "The United Arab Emirates Amazon shipping business."
              },
              {
                "value": "AmazonShipping_SA",
                "description": "The Saudi Arabia Amazon shipping business."
              },
              {
                "value": "AmazonShipping_EG",
                "description": "The Egypt Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IT",
                "description": "The Italy Amazon shipping business."
              }
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/DirectPurchaseResponse"
            },
            "examples": {
              "application/json": {
                "shipmentId": "445454-3232-3232",
                "packageDocumentDetailList": [
                  {
                    "packageClientReferenceId": "ASUSDI-45343854",
                    "trackingId": "T1234567",
                    "packageDocuments": [
                      {
                        "type": "LABEL",
                        "format": "PNG",
                        "contents": "iVBORw0KGgoAAAANSUhEUgAAAywAAATCCAMAAABouZLTAAAABlBMVEUAAAD///+l2Z/dAAAACXBIWXMAAB84AAAfOAGTPyf1AAAfLklEQVR42u3dCXajShZAQb2u2v+WX3+XNTBkMgkQoIhz+ndZlsCWucpEA0TcgCn+5y4AsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCiAXEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC1zaX3fBeaW7YCVhZAHTMDANY4vpw6cninGGH9LIAqZhIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIB9vkM/s9nnGPuDTq3KFw0/4doLODt5SGWFft4bI358/85Z8OM/jEEnhflwm28s8xw0C0OEku8Nur0CL6rvDUeqCrXiCmjf94aS8qxha71w0f1Qbd2te4kofOgeLJpmBnPrqnct+0s3uc5XFhh8P1dSmz/mJe1X+aWnd8le9fJ3GMLO90OfoTuxh+Worj1ZdZaiQmL3fR+L/1ozz6j/th7v07scixbB9m7aDJZaCBuy7epjM0Tz0orE0ejjLPHku1f+zGwZ2ucb06YC89aFean2Xr+4HlXx6256NcfIIbm5r3Lvm4va8pmtvs9ku+Vd8ZYor3pxXPrbXSSjT9YtobU3yfSGvPR1u0fs+loXbOxzMfFr60h+3uRvXWcfxJ2rEFjhVaisnufrX2qzX+PA0zD8reO1zZ/n0Q8voqcdNe2rpnN0SeetWR/tJ++DrqbcuMpgE2eLTtaxAfYwY9bc5YWE4fkZw1ZeqIkynd1DAzxeb3nEKb9GvMfkH92xuP3OajmBRG3zP2TXWXmdvod/On7DtVrRm3f9+r7J9O3m/FWMor7eJHd3cYVB+gs78L2Z9F7+nvav/l9cpUxfM1ccbs6VyprbVKjNeXWf/6j7FAePJZ485o54Sn4uGAo03+tCSlk1NvYdKc6F75+stVZYU78ruMo/CEXT+SuI+J3n2va7sOkjT2nb6Dr7+HH3MHr/vtvsP90uFiysA8/eu3lL+DGNU9jOnsLW6uWDeYVnd9l0pxsm1z+95keKr9GzLrjY9lYOzrcZOa31JKxQi1xxLttixnF/z7xSwy+BPjfff74E76eHp48QOTguJH9Vqav44K15L97O++beXlrj8KA3/ni9U6to92J6/48f2LLHzIKL1ZFv/t4Xiua343nFDj6Edyv0B53e2uM5/caT222X0R73fKEO/2x7Psx4/pR/Fb70ojBRcfC3yiKk46Yc4NY53789XfjP2IMzkQL14ry7WPyPRu1lUXt54odRvAzj1FZuCDb7+irvUa83kqnXOkL3u7CAQamoY9+R3Yq+FdLdX5wXWK5liy+p/rNx9xuLb3PYsXmtUT1B8voxL7dS5iO7nLZalacl7R38ncZQSqfvZlZQoiFvTeVmFxJrP7DD84Q62veIOk/9mavlkMUtrDobEIxY6rT/F71A74xtFVPfPdz58qNjwvXm3hdqfB6wPT3E0y7ok+0X2oH5dZ/b1hWRoYYuE372q1Xq6K0nOr70Sa/Syurg0rnk7IxYcI5871hKZZvjWWX3aGYuFGu/ZbGTX7jybHYZ2HJUwcb7D4f398v+ePG+GXj3+L22bcFffiDLX8/cF/v/AuXjtQ6cPRWB3Z962HoykzDmPvYc7u/Y3L/Vj68h32YaVhudXQFNhmpv3G2+nf/u/qNibAJ0nEGly9kGgYfHVnah2VtHFC1fNjWzjFeO0dg7V3t8ejWW1gUDgdbGJkq77Wdfc4lxLLutDZ/9sryVjq88fO9rJ1jvJaOwPo8MGs0N/rszaG7h4PttlI9mOu1juLKyfZZ2sdKzd6hIZqHba3cPCcfXrWx+KHlVg/m6iiufHKfJXpzn+J74IZuHpN37hvXnnwci+LhMeTCp3bw353VrPoaZlQ/5Oxcfnx0GrbqswXbL8uQwvljWfM9qwMH1TOy8OFp2MGGKEVw3Vh2OrxqmIbx8Vg2ezTPlY5/aLjhALHkjE1xcFfidXjVaLyBb/4LiEMHc73qUVxZ0YYHrIj2qYULB7eJxkFUm/vY7SOwNo+VEKWr9xYfrQV0V1I4mGtzNZucHXHD6aOfcrefcKtPCJjd7PKMRRz+JzxBLD6DD2fbwYfL2PAt+t7Bi1iust8JpmEgFhALiAXEAmIBxAJiAbGAWOB0nIAVvEUfTMPgM+OPaRgYWUAsIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIBxAJiAbGAWEAsIBYQCyAWEAuIBcQCYgGxgFgAsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCiAXEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALHA0WJJdyrX9HfrFfy2E+5pTi9i/Tii9WX0LwTTsFKN7mPEUp11ZakYuzKIZXgkMbAglsrAEkYRxAJi2YFnwxBLfxZW2pvXClew+YuSv+FohfNb9UXJjMpIYmjBNGxqkp4hw8jSm3C98jC2YJ9laAB5pJHSwDQMxLLW7r19FMTy7n4MiKU7sPSHFvv3iGXa0KIVLmCtp47br9Pnc3xp/hPEAqZhgFhALCAWEAuIBcQCYgHEAmIBsYBY4Iy2O27Y8/MsUbw8Zi2jyVs/uUIszRDi31evLfvx4bC49Y9mUT+8Re9IZKt99NIhNfhgLPn4BEvec/GZYuyzDLVSmSblwJiQG31UPwe/94mUPXyIpT1nipGtY6cJUB5uy0ytiKWWRbx161vxc5wrfrTTpsvnRpaFG+cndrXt3vPRHfyhEWXvR/F8/Te2Xku0/53l+2Cfn4izxVJ6CH89NdZ9UP85D+WCgyN3t8ns7jcNHX+pss7edl654LWWbDxCZPfCVhnhiFBiGZrbbPfk8eNp6uy8EvO6YMkyW898Fy+4b/TPS5q/4fPfkY2uUiD2WUpzrxx6JB+ai809OHLjaersXjDjB26u85FZVC/4t5K4P8mQU37EcKQpscyvZfVd7fbT1DMnOOV19p757lyQ3TnVyDAVSx4G+IpYHtOgkRFjjeehsrAbscq++npPSRhTxDL+aF965S3rG+C9ndUegKdspOV1RncRYcNns1juW1Xl5cmNX0187+XxCQNLdmZoZlffZu2njv89b7pkpjXz2ePs3XrB807hdH58MJbf7fa1Cfa2x87WuXRjLT9JPS0XgXCQWDq1NPcRSg/kudJWHLfpuaRyOEYsc16KzBWf1XrkEjuuEzv468rbTltn9fkFOEMs3efB6jsw059gql9zwpO85XX2FtlfR+sSb/MSyzvjR04KZ6PBy3DCWUeWWHijXPuak5c0YWgZmWYKViwblrP8mah4bZuZnZ2hGFxtdZ3NRdYv6M3CGiedjU0eQjiMP7F+FdnZSYnivytbT0zb0gq7QVHYlSgcd6m6zuobKFsXPN4uGr3lRfOnaK0nhn8iTmK9tz09t6DuQ2zrqdru07a9D29VP2PY+052Cq1cJXq3qa+z9znG8gW1hQ48IxC1n4hvjMUp7xELsNcOPogFxAKIBcQCYgGxgFhALCAWQCwgFtjXuqec+PnP5Hdmbv6xDp8b4bCxPE5nEiMf+xjtrckGz1Gsez7TeD2gNz6zmFF6qC8fHyWj/c03RgcHYOGo+yyf2zY/d6AIh6gQy9pbVBamVLnWtlY7qEpuvjE7nItY3p7ZPf6bg4/DMXDjVXZZzMFY1xZHd+l/3Ttcyv0kk0Mb9MChJxrnEK4e5qKwgtLRKspftg9B0fzH6+dIUX6bzU/t/TsdireXEf/NeponkLwfkT8m7yvl40hgMf5l/zTdcf89niuesWZMw/ojQQ4OERlvtfLccB9fLRr4ovxlPr8c2g/JCddBLBNryQnxLNnsorTXc5uzXefQ/pO9IHbewS+e2/t332Hd8z3+ri1mLiMaN6t+adhgl1j+bXmTnk999xTFufUKYONY2oNLrHg+uvzRXIcG2N3qZyvO0r5Ddt/pkgsibK9j8KD1aUDh+LFMO1124xWTRacBH30++s0VwPbTsPrOxboP9RE3uyNcKJbXCxntVziydeKTXL7wkd17u/gcNJbcMrrWMwX5/jJqX3pRnn1HlpHNbeEpimdku+IKDEtsF0v5rcXxbn2tE0fmbf7riM+XgLL25a1zqsjRN7WZ4n2ZVU+TF915zGtby+Z54rrvH+62VLg0m5cMvn24voK8Fb5Vud3z/cX3i/tvrCzdBrHMGlRsO4gF7LMAYgGxgFhALCAWEAsgFhALiAXEAifhzF/wgVic+YtLc+Yv2H2fxZm/EMv7W5QzfyGW8szu8V9n/uJSnPmr9KUzf1HgzF/O/MXu0zBn/kIsc2px5i/EMnVbcuYvxDKpFmf+QixLBhdn/uJanPkLPhSLM39hGvbuvrkzfyGW4Yd3Z/5CLAODyAbROfMX1xxZnPkLsczfupz5i+tw5q/y7Zz5iw1jceYvxAJstYMPYgGxAGIBsYBYQCwgFhALIBYQC4gFPmu1A1a0Ptnh3Zlc0AZn/mof8R5Mw4YD3OwjhD6byLX2WTarxZEoudwOvo+nYwd/8cyp8/H59n7N+KfoXx+iz/bCWh+GdyQjTraD39vdbx3I4udf2bukcWbw9lbf/jLbFcXrkMd5PwayWDjZNKwXTWte1jvTUPuIldE76l1UFxytxSqFM8dS2aPpztLeWIwzoXKNfZbXsfBqx7NvHi2vuslHeUdowvXg1CPLgucH4PIjy7t1/Oy0185bpCK+PJbs7PvXT/NlzsVVpmGxzg0jjCJcOpZc8YZO84Ud/O0HKTh8LP2zp1TfiTL8NrLqOye9+4xrxOI9Wohl0g5HNlvpnVOrOEa8TsIVrfN73eqn+eqeDgy23huIVTsp7mP03nVcPoNW732Vjbcax8DC4lY7gxgcMhYwDQPEAmIBsYBYQCwgFhALIBYQC4gFxAJn8/cUP2XrXcnwGRu/RX/4+N9RXVZ0Fh231kdi2h9hERHniqV25q/O4cKbn18pbeWF7xSOCp5xKy8fzrXP0j3zVxauUYu0/51sHtg1q4XCOXfwVzyaROEjylrhQrEUPyu/7uLhIrFsNMyYhHHBWDqnKsp1cnCwMK49smy3jRtYuFwsJmGI5QC7LXCxkWWLWgwsXHMaZmxBLPZYEMsag8mGQ4tWuEosudJErH0rhfAd07BVxxbZcJVYittybLYuOG0sKz7uN8ej7JzDBc4bS+HMX28PLa1TgWmFz9nhY8X1T0oWAsryQnysmAvFsilnwUMsM5NRC2LZ/XkDuHYsDiCGWIwuiAWuw7GOQSwgFhALiAXEAt/jwCcz6r4J8/gLxsjyIZu9BOS1JT47srTeGDzw2P3GK/CNVTTe9uIlfc4WSzS32miem+u2wSq2WQEcdRr2zofntcL1d/BjjVSaragGO/jGFb5oZHns52d/zz8fX70OQVE9B/hQK+0FRnlBOfTMQ/Oi3kLS0MVrErPBqb0b2/PPZRnFA7Nk95AU2TweRdQ27OiOK60Fttf1u8j2gS6il0fvx3supLM0TMP2mDINH43yd4OMziGPah1nTF3Xb37R7Sr6lzR/vOdCJvzkiGWTPfoJV8qp8U1aV94WPZkQnjrgsDv4s85tn2udzLV1ifGDc8Qyd6CyWfMRB3kj5YztP9Izx3xzLHO2frVgGrb2TMyr/Hx9LDNqyZujvvLVscypJbXChWLpbPpTSphWS2b8qN/oeYnX6dk1ltY5utbY9PLNWnLJguF4I0tjc28+wL++HA5u6tjy61ZZ8OMSAwsTNtk1N5J8vle3dYKvKPzj+e3WG12aZ/bqv5WyeePHvwdX0T+NWGHB/Z+i+gMjlnVzOc6mleX3/8MyK78oeaRN8jWuhJ0UTr3PAmI55nTTn5qD7bMcSjqyGGKZudsiFcQC9llALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFxAKIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIBxAJiAbGAWEAsIBZALCAWEAuIBcQCYgGxAGIBsYBYQCwgFgAAgJVEuA/ADj6IBcQCYgGxgFgAsYBYQCwgFhALiAXEAogFxAJiAbGAWEAsgFhALCAWEAuIBcQCYgHEAmKBzf11F7CpvP9/dC6Y+/X0GxhZuFg83a9z5HqzFyAWsM8CYgGxgFgAsYBYOIuofB0j15u9gA1+dGcrZlO5dl1ZiyO3rsbIAmIBsYBYQCwgFhALbCsq/7/agjf4kb3Owqa6r37k2Eaeu238RhYQC4gFxAJiAbEAYuGYTvTahYPs8Vk5tx6fZwHTMBALiAUQC4gFxMLVeZ0FJkbSe51l7PMs1Rtunp2RBcQCYgGxgFhALCAWoMNxw9jW2PlZJn8spfb6y36vtxhZQCwgFhALiAXEAmIBOnyehX2Mnp+lKyd+P7K9AiMLjESTYgH7LGCf5UNjcYzNeCvvNYr6yD727qT2NbK6qrGfZeAgvcsW+sYK21fyzsGrxZJv3Sbrm2FO31qy+9WSG3ZvtnihS1f47r0qlsuF8rhZPP6R/QEiSt8aE42faOINs3O7/s0WLPS9FWrlkvssme+2cn9gze634vGfORtNtKY2uex2udJCF69QK5cdWWLJnzUb20rkyEYy+dH8cb3IJZvu83bt9S1d6OIVbtbK6H7SY0cxpi4gR74WS++vXt+Mxu71QhHtb0V/JjbjL7H0duss9N0VxqfGlly2m7hgAd81Dds0wv1vPjgviu1+z8Jo6mmwK07DNq5m8k5+HDDaN2ZMWhHL0pH9sIPYJivUyvdNw2JGGLHxtr37wPPGCj0RZp9l943ivDMzA4tYuttCPv8Tq2aVW2yquVcbJmH2Wfr77a/t4iBjQG6x0Lkr3KyVqS+PRO2nG13A5pH/uczDSMz4RgxfYcEFvU0wlm7ssepC566w00qs//fJytej6xxdwOab8heMLKV3C0b53bwx/H6p4WWOb9WL3wy5fKEzV2jn/itjab3pqz+3aNQykEbOWWb93fQjP8tQEcsWunSFaef+i3fwI8qvUrfegZmjpzWctMzBJY7fLsemErMXumSFWvneWG7l93RkZ38wi/PizDnL/Nk2n5tn5bYxtGNd3Ed9b6EzV+iJsG+PpbDB3D8DGDFQy7+3/8esWtrPyczesIdWt3ihc1aoFbEM7IlE3AaeUln4XOSiz57kyOrW/UBLcYV27sd8wVPH3WfwW3P16N38sQk1N6UYW+a73xvfs958hTn/jl3095n6/4sXsJ1vfSPlq43+J3bj3c1l8jPQ01tZsNB3V7jZeD78dc5dUPUFGNOw1f9ocYgfKa69Qvssl5+/7TSNzw/EiWnY3jWttenG3q3E6G+Zt5vxx8hy7GmhccXI8vndgHj3djO/N+1nGXoAX7rQxSvk60eWLGw2k97rmgsfnnPRIqf9FnMXahwxsqy455HD2+AWH97tvnUg11hq7L3CN/8eOfz/B9zFvHAsGeVtvnPIlpx6u6nfK40BQ7eb9EvMXejiFe73oFV/uXThGOnDX9MnWeUneAobWeuvVHoDYwxsZjEwI2od7zWm3C7H/+jzF/rmCkdnfQd54N9/yz11LDn5Huxsf5Pfl754Dhax/I8cKy90/gpzw43yxLFcdRrWPAZyDH679zheHaqGlhmDH9PKZX/hpQtdvEJuCx8BYYPhf7UTwuy/5XpREsQCYoGP8EZKdto7HtuHGb3C1H0dn2cB0zAQC4gFxAKIBcQCe/E6C/sYPapX7bwrtcvfPrybkQXEAmIBsYBYQCyAWOBdf3wGn4+K1Y+Z6fMsXNSJji8rFhALiAXEAmIBscD3cKxjMLKAWEAsIBYQC4gFEAuIBcQCYgGxgFhALIBYQCwgFhALiAXEAogFxAJiAbGAWEAsIBZALCAWEAuIBcQCYgGxAGKBFf1dYyHpfuQ4Njvzo5EF9hxZOP6j4tfYcJpjZAGxgFhALCAWuIBTPRtWeKooZ10hhm/k9SIGt781nqvMnXvJ1maes64QpR84Sr9EfCIeTx2/vzFudh/+OdtfJ3pfxrwrRGmT7IYREXGEX48j3Ydnf1Hy53FkcAgoXyHS9sr37eDn2PadMwPIf2waXC+W8T2LNHwglunbfnTjUQvfGMvsocUci2/cwZ+yx96/QsaEW3ydbI/D2bvjWhfXri6WK1JLb6ramqD++zKqF1cvNw274oOo3ZbRXb8Yurh6uVgOvunPfPbYqDJlDy/GL65eLpaLP5AaWpqbf8bIxdXLxWIi9r2PH+Hh5qtHFrWMTMR6I0Xl4urlYrnk3JzyzGr04urlYrHb8kX3SMaUi6uXi8VE7GvumuLGX7m4erlYTMRMxL5zIuYz+IaW4j0SUy+uXi6W844SaSK2wv2Z3zxIXyKWWHwFtajFNMxuyxv3Sfn4A5WLq5eL5VKzMLst5Y2/eI9VLq5eLpaLDi1qKT18eEbsgrHEW1cwESuNFDHx4urlYjlsK/nWFejPqjp3WuXi6uViueYei47m3jXf+ozY+WOJsT/S6BXU0h8ppn20pXr5Nf09fyrvz8HSDr6hZIKzHeu4vTsZ/VFj7ApRfSfHwGIO9GTFxq1E70eJ6sXVy4+wjWyy4DMdRX+tU07cColldSH5LbG0DmaU5Z+scTdVrv7pWlIs38KE8MCxeNcxiAXEAmIBsYBYQCyAWEAsIBYQC4gFxAJiAcQCYgGxgFhALHB5f90Fh+JwBkYWEAuIBRALiAW2tMqzYQ6juALPgxlZQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFEAuIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIBxAJiAbGAWEAsIBZALCAWEAuIBcQCYgEAANhFhPvgGNJdsNY2bQcfjCxwDkYWEAuIBcQCYgGxgFgAsYBYYFN/V1nK7/ua4t8/4nFJVK5w6135ef3n1W69hRRv2Lx+58KBKw//DMM//MRV3Hq/1+gNo3c/3Hq/flQW2F9j/x4buKOmXGHuzzDl1yzet7fSMvt/sv5KjSxgGgZiAbGAWACxgFhALCAWEAuIBRALiAXEAmIBsYBYQCyAWEAsIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIBsQBiAbGAWEAsIBYQCyAWEAuIBcQCYgGxgFgAsYBYQCwgFhALiAXE4i4AsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCiAXEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFEAuIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIBxAJiAbGAWEAsIBZALCAWEAuIBcQCYgGxAGIBsYBYQCwgFhALiMVdAGIBsYBYQCwgFhALIBYQC4gFxAJiAbGAWACxgFhALCAWEAuIBRALiAXEAmIBsYBYQCxASYT7AIwsIBYQC4gFxAJiAcQCYgGxgFhALCAWEAsgFhALiAXEAmf1112wjfz5j4+hiuV7tvafzT1fl8VYDc8b/fe/XLLKGI4tWxdm90cS56Z8Bn9ow71vva//e26bzW+Xb9T/7qS1xtCmn/8WH5WvjGT2WT7XSmfji9cw8/x2NkeU0o26o860AW0gpXits/FVpr+ZWI41Dpc35ilb6uStOce/k/2vwhRBLGecpb653eZgrI2RKzyHsK8/7uzhTbP972hcHJ2xJno3uk+SmtfJ1sWNJwTuF0VnZZXd/+h8dSveorQCjCxbhDLyEJ/37TXiMQ3q3yjvM7DndSJa86iIRmXPL1bc/+ivALFsUksOjzq956u6N8oo7kvk76W5JFPEctBJWM7cvejcKMrX60zm7s9nRXUutc6TEl6FEcu2O/dZzaQcU+FGsXjzRiwX2HHJekxzp1H3NDKGx6y3hxYDi1i2n4qVW6nvjMeGkSKW08jiE8orPPJnjNYSrX/G9J+isALEsmIVudeNirOuGLha5YX8mU9FIJZtZ2LZf4Ir5tyovoqYUEvlpfuY9DsYWMSy6Yyr+3ic3Zfps7UL3b9RtvZvcnGkz8uy8cbk9lfs8MDpvh6auHR2HqI7r+m+P775KZR8vbvldZ1HXtla4H2Hov0ZltJeRvXzLDk8zthjEcuXJDv7yYRlt8I0DIwsYGQBsYBYQCyAWEAsIBYQC4gFxAJiAcQCYgGxgFhALCAWEAsgFhALiAXEAmIBsQBiAbGAWEAsIBYQC4gFEAuIBcQCYgGxgFgAsYBYQCwgFhALiAXEAogFxAJiAbGAWEAsIBZALCAWEAuIBcQCYgHEAmIBsYBYQCwgFhALIBYQC4gFxAJiAbEAYgGxgFhALCAWEAuIBRALiAXEAmIBsYBYQCyAWEAsIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIBsQBiAbGAWEAsIBYQCyAWEAuIBcQCYgGxgFgAsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCYgHEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFxAKIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIByv4PwWms3AV97VoAAAAASUVORK5CYII="
                      }
                    ]
                  }
                ]
              }
            },
            "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-IdempotencyKey": {
                "type": "string",
                "description": "A unique value which the server uses to recognize subsequent retries of the same request."
              }
            }
          },
          "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-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."
              }
            }
          },
          "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": []
    },
    "/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| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 80 | 100 |\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": "purchaseShipment",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/PurchaseShipmentRequest"
            }
          },
          {
            "name": "x-amzn-IdempotencyKey",
            "description": "A unique value which the server uses to recognize subsequent retries of the same request.",
            "in": "header",
            "required": false,
            "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_UAE",
              "AmazonShipping_SA",
              "AmazonShipping_EG",
              "AmazonShipping_IT"
            ],
            "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_UAE",
                "description": "The United Arab Emirates Amazon shipping business."
              },
              {
                "value": "AmazonShipping_SA",
                "description": "The Saudi Arabia Amazon shipping business."
              },
              {
                "value": "AmazonShipping_EG",
                "description": "The Egypt Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IT",
                "description": "The Italy 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": {
                    "startTime": "2019-12-11T07:09:05.513Z",
                    "endTime": "2019-12-11T09:09:05.513Z"
                  },
                  "deliveryWindow": {
                    "startTime": "2019-12-13T07:09:05.513Z",
                    "endTime": "2019-12-13T09:09:05.513Z"
                  }
                }
              }
            },
            "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/tracking": {
      "get": {
        "tags": [
          "shipping"
        ],
        "description": "Returns tracking information for a purchased shipment.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 80 | 100 |\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": "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-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_UAE",
              "AmazonShipping_SA",
              "AmazonShipping_EG",
              "AmazonShipping_IT"
            ],
            "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_UAE",
                "description": "The United Arab Emirates Amazon shipping business."
              },
              {
                "value": "AmazonShipping_SA",
                "description": "The Saudi Arabia Amazon shipping business."
              },
              {
                "value": "AmazonShipping_EG",
                "description": "The Egypt Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IT",
                "description": "The Italy Amazon shipping business."
              }
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "schema": {
              "$ref": "#/definitions/GetTrackingResponse"
            },
            "examples": {
              "application/json": {
                "trackingId": "23AA47DE2B3B6",
                "alternateLegTrackingId": "null",
                "eventHistory": [
                  {
                    "eventCode": "ReadyForReceive",
                    "location": {
                      "postalCode": "4883493",
                      "countryCode": "CC"
                    },
                    "eventTime": "2019-12-11T07:09:05.513Z"
                  }
                ],
                "promisedDeliveryDate": "2019-12-12T13:09:05.513Z",
                "summary": {
                  "status": "PreTransit"
                }
              }
            },
            "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| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 80 | 100 |\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": "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-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_UAE",
              "AmazonShipping_SA",
              "AmazonShipping_EG",
              "AmazonShipping_IT"
            ],
            "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_UAE",
                "description": "The United Arab Emirates Amazon shipping business."
              },
              {
                "value": "AmazonShipping_SA",
                "description": "The Saudi Arabia Amazon shipping business."
              },
              {
                "value": "AmazonShipping_EG",
                "description": "The Egypt Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IT",
                "description": "The Italy 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=="
                    }
                  ]
                }
              }
            },
            "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| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 80 | 100 |\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": "cancelShipment",
        "parameters": [
          {
            "name": "shipmentId",
            "description":"The shipment identifier originally returned by the purchaseShipment operation.",
            "in": "path",
            "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_UAE",
              "AmazonShipping_SA",
              "AmazonShipping_EG",
              "AmazonShipping_IT"
            ],
            "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_UAE",
                "description": "The United Arab Emirates Amazon shipping business."
              },
              {
                "value": "AmazonShipping_SA",
                "description": "The Saudi Arabia Amazon shipping business."
              },
              {
                "value": "AmazonShipping_EG",
                "description": "The Egypt Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IT",
                "description": "The Italy 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/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| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 80 | 100 |\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": "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-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_UAE",
              "AmazonShipping_SA",
              "AmazonShipping_EG",
              "AmazonShipping_IT"
            ],
            "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_UAE",
                "description": "The United Arab Emirates Amazon shipping business."
              },
              {
                "value": "AmazonShipping_SA",
                "description": "The Saudi Arabia Amazon shipping business."
              },
              {
                "value": "AmazonShipping_EG",
                "description": "The Egypt Amazon shipping business."
              },
              {
                "value": "AmazonShipping_IT",
                "description": "The Italy 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": {
                    "$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": "Unqiue identifier for the item."
                      }
                    }
                  }
                }
                }
              ]
            }
          },
          "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": "array",
      "description": "A list of error responses returned when a request is unsuccessful.",
      "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."
        }
      }
    },
    "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."
    },
    "ShipmentId": {
      "type": "string",
      "description": "The unique shipment identifier provided by a shipping service."
    },
    "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."
    },
    "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
        }
      },
      "description": "The address."
    },
    "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."
    },
    "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"
          }
        }
      },
      "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": {
          "type": "string",
          "description": "The product description of the item."
        },
        "itemIdentifier": {
          "type": "string",
          "description": "A unique identifier for an item provided by the client."
        },
        "quantity": {
          "type": "integer",
          "description": "The number of units. This value is required."
        },
        "weight": {
          "$ref": "#/definitions/Weight"
        },
        "isHazmat": {
          "type": "boolean",
          "description": "When true, the item qualifies as hazardous materials (hazmat). Defaults to false."
        },
        "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"
        },
        "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": {
        "startTime": {
          "type": "string",
          "format": "date-time",
          "description": "The start time of the time window."
        },
        "endTime": {
          "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."
    },
    "ValueAddedServiceDetails": {
      "type": "object",
      "properties": {
        "collectOnDelivery": {
          "$ref": "#/definitions/CollectOnDelivery"
        }
      },
      "description": "A collection of supported value-added services."
    },
    "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"
      }
    },
    "EventCode": {
      "type": "string",
      "description": "The tracking event type.",
      "enum": [
        "ReadyForReceive",
        "PickupDone",
        "Delivered",
        "Departed",
        "DeliveryAttempted",
        "Lost",
        "OutForDelivery",
        "ArrivedAtCarrierFacility",
        "Rejected",
        "Undeliverable",
        "PickupCancelled"
      ],
      "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."
        }
      ]
    },
    "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."
        }
      },
      "description": "A tracking event."
    },
    "TrackingSummary": {
      "type": "object",
      "properties": {
        "status": {
          "$ref": "#/definitions/Status"
        }
      },
      "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"
      ],
      "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."
        }
      ]
    },
    "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."
    },
    "ChannelDetails": {
      "type": "object",
      "required": [
        "channelType"
      ],
      "properties": {
        "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."
            }
          ]
        },
        "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."
        }
      },
      "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."
        },
        "packages": {
          "$ref": "#/definitions/PackageList"
        },
        "valueAddedServices": {
          "$ref": "#/definitions/ValueAddedServiceDetails"
        },
        "taxDetails": {
          "$ref": "#/definitions/TaxDetailList"
        },
        "channelDetails": {
          "$ref": "#/definitions/ChannelDetails"
        }
      }
    },
    "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."
    },
    "DirectPurchaseRequest": {
      "description": "The request schema for the directPurchaseShipment operation. When the channel type is Amazon, the shipTo address is not required and will be ignored.",
      "type": "object",
      "required": [
        "channelDetails"
      ],
      "properties": {
        "shipTo": {
          "description": "The address where the shipment will be delivered. For vendor orders, shipTo information is pulled directly from the Amazon order.",
          "$ref": "#/definitions/Address"
        },
        "shipFrom": {
          "description": "The address where the package will be picked up.",
          "$ref": "#/definitions/Address"
        },
        "returnTo": {
          "description": "The address where the package will be returned if it cannot be delivered.",
          "$ref": "#/definitions/Address"
        },
        "packages": {
          "$ref": "#/definitions/PackageList"
        },
        "channelDetails": {
          "$ref": "#/definitions/ChannelDetails"
        },
        "labelSpecifications": {
          "description": "The document (label) specifications requested. The default label returned is PNG DPI 203 4x6 if no label specification is provided. Requesting an invalid file format results in a failure.",
          "$ref": "#/definitions/RequestedDocumentSpecification"
        }
      }
    },
    "DirectPurchaseResult": {
      "type": "object",
      "required": [
        "shipmentId"
      ],
      "properties": {
        "shipmentId": {
          "$ref": "#/definitions/ShipmentId"
        },
        "packageDocumentDetailList": {
          "$ref": "#/definitions/PackageDocumentDetailList"
        }
      },
      "description": "The payload for the directPurchaseShipment operation."
    },
    "DirectPurchaseResponse": {
      "type": "object",
      "properties": {
        "payload": {
          "$ref": "#/definitions/DirectPurchaseResult"
        }
      },
      "description": "The response schema for the directPurchaseShipment operation."
    },
    "GetShipmentDocumentsResult": {
      "type": "object",
      "required": [
        "packageDocumentDetail",
        "shipmentId"
      ],
      "properties": {
        "shipmentId": {
          "$ref": "#/definitions/ShipmentId"
        },
        "packageDocumentDetail": {
          "$ref": "#/definitions/PackageDocumentDetail"
        }
      },
      "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."
    },
    "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"
        }
      },
      "description": "The payload for the purchaseShipment operation."
    },
    "PurchaseShipmentResponse": {
      "type": "object",
      "properties": {
        "payload": {
          "$ref": "#/definitions/PurchaseShipmentResult"
        }
      },
      "description": "The response schema for the purchaseShipment operation."
    },
    "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."
    }
  }
}


Did this page help you?