--- title: "getAdditionalSellerInputs" method: POST path: "/mfn/v0/additionalSellerInputs" tags: ["Merchant Fulfillment v0"] --- # getAdditionalSellerInputs `POST /mfn/v0/additionalSellerInputs` 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). ## Request body - GetAdditionalSellerInputsRequest — Request schema. - `ShippingServiceId` string, required — An Amazon-defined shipping service identifier. - `ShipFromAddress` Address, required — Address of the party. - `name` string, required — The name of the person, business or institution at that address. - `addressLine1` string, required — First line of the address. - `addressLine2` string — Additional street address information, if required. - `addressLine3` string — Additional street address information, if required. - `city` string — The city where the person, business or institution is located. - `county` string — The county where person, business or institution is located. - `district` string — The district where person, business or institution is located. - `stateOrRegion` string — The state or region where person, business or institution is located. - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format. - `phone` string — The phone number of the person, business or institution located at that address. - `OrderId` string, required — An Amazon-defined order identifier, in 3-7-7 format. ## Response `200` Success. - GetAdditionalSellerInputsResponse — Response schema. - `payload` GetAdditionalSellerInputsResult — The payload for the `getAdditionalSellerInputs` operation. - `ShipmentLevelFields` AdditionalInputs[] — A list of additional inputs. - `AdditionalInputFieldName` string — The field name. - `SellerInputDefinition` SellerInputDefinition — Specifies characteristics that apply to a seller input. - `IsRequired` boolean, required — When true, the additional input field is required. - `DataType` string, required — The data type of the additional input field. - `Constraints` Constraint[], required — List of constraints. - `ValidationRegEx` string — A regular expression. - `ValidationString` string, required — A validation string. - `InputDisplayText` string, required — The display text for the additional input field. - `InputTarget` 'SHIPMENT_LEVEL' | 'ITEM_LEVEL' — Indicates whether the additional seller input is at the item or shipment level. - `StoredValue` AdditionalSellerInput, required — Additional information required to purchase shipping. - `DataType` string — The data type of the additional information. - `ValueAsString` string — The value when the data type is string. - `ValueAsBoolean` boolean — The value when the data type is boolean. - `ValueAsInteger` integer — The value when the data type is integer. - `ValueAsTimestamp` string, date-time — Date-time formatted timestamp. - `ValueAsAddress` Address — Address of the party. - `name` string, required — The name of the person, business or institution at that address. - `addressLine1` string, required — First line of the address. - `addressLine2` string — Additional street address information, if required. - `addressLine3` string — Additional street address information, if required. - `city` string — The city where the person, business or institution is located. - `county` string — The county where person, business or institution is located. - `district` string — The district where person, business or institution is located. - `stateOrRegion` string — The state or region where person, business or institution is located. - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format. - `phone` string — The phone number of the person, business or institution located at that address. - `ValueAsWeight` Weight — The weight of the shipment. - `unitOfMeasure` 'G' | 'Kg' | 'Oz' | 'Lb', required — The unit of measurement. - `value` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`. - `ValueAsDimension` Length — The length. - `value` number — The value in units. - `unit` 'inches' | 'centimeters' — The unit of length. - `ValueAsCurrency` CurrencyAmount — Currency type and amount. - `CurrencyCode` string, required — Three-digit currency code in ISO 4217 format. - `Amount` number, double, required — The currency amount. - `RestrictedSetValues` string[] — The set of fixed values in an additional seller input. - `ItemLevelFieldsList` ItemLevelFields[] — A list of item level fields. - `Asin` string, required — The Amazon Standard Identification Number (ASIN) of the item. - `AdditionalInputs` AdditionalInputs[], required — A list of additional inputs. - `AdditionalInputFieldName` string — The field name. - `SellerInputDefinition` SellerInputDefinition — Specifies characteristics that apply to a seller input. - `IsRequired` boolean, required — When true, the additional input field is required. - `DataType` string, required — The data type of the additional input field. - `Constraints` Constraint[], required — List of constraints. - `ValidationRegEx` string — A regular expression. - `ValidationString` string, required — A validation string. - `InputDisplayText` string, required — The display text for the additional input field. - `InputTarget` 'SHIPMENT_LEVEL' | 'ITEM_LEVEL' — Indicates whether the additional seller input is at the item or shipment level. - `StoredValue` AdditionalSellerInput, required — Additional information required to purchase shipping. - `DataType` string — The data type of the additional information. - `ValueAsString` string — The value when the data type is string. - `ValueAsBoolean` boolean — The value when the data type is boolean. - `ValueAsInteger` integer — The value when the data type is integer. - `ValueAsTimestamp` string, date-time — Date-time formatted timestamp. - `ValueAsAddress` Address — Address of the party. - … - `ValueAsWeight` Weight — The weight of the shipment. - … - `ValueAsDimension` Length — The length. - … - `ValueAsCurrency` CurrencyAmount — Currency type and amount. - … - `RestrictedSetValues` string[] — The set of fixed values in an additional seller input. - `errors` Error[] — A list of error responses 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 — Additional details that can help the caller understand or fix the issue. ## Other responses - `400` — Request has missing or invalid parameters and cannot be parsed. - `401` — The request's authorization header is not formatted correctly or does not contain a valid token. - `403` — Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. - `404` — The specified resource does not exist. - `429` — The frequency of requests was greater than allowed. - `500` — An unexpected condition occurred that prevented the server from fulfilling the request. - `503` — Temporary overloading or maintenance of the server. --- [API](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01.md) · [All operations](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws-samples/a-content-management-v2020-11-01/versions/815a5b6dbaa6/schema)