getAdditionalInputs - Amazon SP API

Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase.

Usage Plan:

Rate (requests per second)	Burst
80	100

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Request

Query Params

requestToken

string

required

The request token returned in the response to the getRates operation.

Example:

amzn1.rq.123456789.101

rateId

string

required

The rate identifier for the shipping offering (rate) returned in the response to the getRates operation.

Example:

122324234543535321345436534321423423523452345

Header Params

x-amzn-shipping-business-id

enum<string>

optional

Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

Allowed values:

AmazonShipping_USAmazonShipping_INAmazonShipping_UKAmazonShipping_UAEAmazonShipping_SAAmazonShipping_EGAmazonShipping_ITAmazonShipping_ESAmazonShipping_FRAmazonShipping_JP

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The response schema for the getAdditionalInputs operation.

payload

object (GetAdditionalInputsResult)

optional

The JSON schema to use to provide additional inputs when required to purchase a shipping offering.

Additional properties

integer | number | string | boolean

optional

Example

{
    "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."
            }
        }
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable