getAdditionalSellerInputs

Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping.

Usage Plan:

Rate (requests per second)	Burst
1	1

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

Request

Body Params application/json

Request schema.

ShippingServiceId

string

required

An Amazon-defined shipping service identifier.

ShipFromAddress

object (Address)

required

Shipping address that represents the origin or destination location.

Example:

{"addressLine1":"address_1","addressLine2":"address_2","addressLine3":"address_3","city":"Seattle","countryCode":"US","county":"Washington","district":"District1","name":"address_name","phoneNumber":"+14155552671","postalCode":"123456","stateOrRegion":"Washington"}

addressLine1

string

required

First line of the address text.

addressLine2

string

optional

Optional second line of the address text.

addressLine3

string

optional

Optional third line of the address text.

city

string

optional

Optional city where this address is located.

countryCode

string

required

Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.

county

string

optional

Optional county where this address is located.

Example:

Washington

district

string

optional

Optional district where this address is located.

name

string

required

Name of the person, business, or institution at this address.

phoneNumber

string

optional

Optional E.164-formatted phone number for an available contact at this address.

Example:

+14155552671

postalCode

string

optional

Optional postal code where this address is located.

stateOrRegion

string

required

State or region where this address is located. Note that this is contextual to the specified country code.

OrderId

string

required

An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.

Example

{
    "ShippingServiceId": "string",
    "ShipFromAddress": {
        "addressLine1": "address_1",
        "addressLine2": "address_2",
        "addressLine3": "address_3",
        "city": "Seattle",
        "countryCode": "US",
        "county": "Washington",
        "district": "District1",
        "name": "address_name",
        "phoneNumber": "+14155552671",
        "postalCode": "123456",
        "stateOrRegion": "Washington"
    },
    "OrderId": "string"
}

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

Response schema.

payload

object (GetAdditionalSellerInputsResult)

optional

The payload for the getAdditionalSellerInputs operation.

ShipmentLevelFields

array[object (AdditionalInputs) {2}]

optional

A list of additional inputs.

ItemLevelFieldsList

array[object (ItemLevelFields) {2}]

optional

A list of item level fields.

errors

array[object (Error) {3}]

optional

A list of error responses that are returned when a request is unsuccessful.

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

optional

Additional details that can help the caller understand or fix the issue.

Example

{
    "payload": {
        "ShipmentLevelFields": [
            {
                "AdditionalInputFieldName": "string",
                "SellerInputDefinition": {
                    "IsRequired": true,
                    "DataType": "string",
                    "Constraints": [
                        {
                            "ValidationRegEx": "string",
                            "ValidationString": "string"
                        }
                    ],
                    "InputDisplayText": "string",
                    "InputTarget": "SHIPMENT_LEVEL",
                    "StoredValue": {
                        "DataType": "string",
                        "ValueAsString": "string",
                        "ValueAsBoolean": true,
                        "ValueAsInteger": 0,
                        "ValueAsTimestamp": "2019-08-24T14:15:22Z",
                        "ValueAsAddress": {
                            "addressLine1": "address_1",
                            "addressLine2": "address_2",
                            "addressLine3": "address_3",
                            "city": "Seattle",
                            "countryCode": "US",
                            "county": "Washington",
                            "district": "District1",
                            "name": "address_name",
                            "phoneNumber": "+14155552671",
                            "postalCode": "123456",
                            "stateOrRegion": "Washington"
                        },
                        "ValueAsWeight": {
                            "value": 11,
                            "unit": "Grams"
                        },
                        "ValueAsDimension": {
                            "value": 0,
                            "unit": "Cm"
                        },
                        "ValueAsCurrency": {
                            "CurrencyCode": "str",
                            "Amount": 0
                        }
                    },
                    "RestrictedSetValues": [
                        "string"
                    ]
                }
            }
        ],
        "ItemLevelFieldsList": [
            {
                "Asin": "string",
                "AdditionalInputs": [
                    {
                        "AdditionalInputFieldName": "string",
                        "SellerInputDefinition": {
                            "IsRequired": true,
                            "DataType": "string",
                            "Constraints": [
                                {
                                    "ValidationRegEx": "string",
                                    "ValidationString": "string"
                                }
                            ],
                            "InputDisplayText": "string",
                            "InputTarget": "SHIPMENT_LEVEL",
                            "StoredValue": {
                                "DataType": "string",
                                "ValueAsString": "string",
                                "ValueAsBoolean": true,
                                "ValueAsInteger": 0,
                                "ValueAsTimestamp": "2019-08-24T14:15:22Z",
                                "ValueAsAddress": {
                                    "addressLine1": "address_1",
                                    "addressLine2": "address_2",
                                    "addressLine3": "address_3",
                                    "city": "Seattle",
                                    "countryCode": "US",
                                    "county": "Washington",
                                    "district": "District1",
                                    "name": "address_name",
                                    "phoneNumber": "+14155552671",
                                    "postalCode": "123456",
                                    "stateOrRegion": "Washington"
                                },
                                "ValueAsWeight": {
                                    "value": 11,
                                    "unit": "Grams"
                                },
                                "ValueAsDimension": {
                                    "value": 0,
                                    "unit": "Cm"
                                },
                                "ValueAsCurrency": {
                                    "CurrencyCode": "str",
                                    "Amount": 0
                                }
                            },
                            "RestrictedSetValues": [
                                "string"
                            ]
                        }
                    }
                ]
            }
        ]
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable