Amazon Services
Amazon Marketplace Web Service (Amazon MWS) Documentation
Amazon MWS Documentation

GetAdditionalSellerInputs

Returns a list of additional seller inputs that are required from the seller to purchase the shipping service that you specify.

Description

The GetAdditionalSellerInputs operation returns a list of additional inputs that are required from the seller for purchasing shipping for some shipping services. Calling GetAdditionalSellerInputs is only required for shipment services that require additional seller inputs.

To identify shipping services that require additional seller inputs, examine the ShippingService elements that are returned by the GetEligibleShippingServices operation. When RequiresAdditionalSellerInputs=true is included in a ShippingService element, that shipment service requires additional seller inputs. Call the GetAdditionalSellerInputs operation to find out which additional seller inputs are required. When RequiresAdditionalSellerInputs=false is included in a ShippingService element, that shipment service offer does not require additional seller inputs. You can skip the GetAdditionalSellerInputs operation and call the CreateShipment operation to create your shipment.

The GetAdditionalSellerInputs operation also includes syntax requirements for the additional input that you get from sellers, and returns saved values that you previously provided to Amazon. For definitions, see Merchant Fulfillment API.

Availability

This operation is only available in the Canada, US, Mexico, Spain, UK, France, Germany, Italy, and India marketplaces.

Throttling

This operation has a maximum request quota of 10 and a restore rate of five requests every second. For definitions of throttling terminology and for a complete explanation of throttling, see Throttling: Limits to how often you can submit requests in the Amazon MWS Developer Guide.

Request parameters

Name Description Required Values
OrderId An Amazon-defined order identifier. Use the AmazonOrderId value that you specified in a previous call to the GetEligibleShippingServices operation. Yes Type: xs:string
ShippingServiceId The identifier for the carrier shipping service that the seller chose. This was returned by a previous call to the GetEligibleShippingServices operation.

Example: CHINA_POST_E_COURIER_PRI

Yes Type: xs:string
ShipFromAddress The address from which the shipment ships. Use the ShipFromAddress value that you specified in a previous call to the GetEligibleShippingServices operation. Yes Type: Address

Response elements

Name Description
ShipmentLevelFields A list of additional seller inputs that are required for this shipping service. These inputs are at the shipment level and are shared across multiple items in the same shipment.

Type: List of ShipmentLevelFields

ItemLevelFieldsList A list of additional seller inputs that are required for this shipping service. These inputs are at the item level and are different for each item in the shipment.

Type: List of ItemLevelFieldsList

Examples

Example query request

For information about standard request requirements, see Required request parameters.

Show example code Hide example code

https://mws.amazonservices.com/MerchantFulfillment/2015-06-01
  &Action=GetAdditionalSellerInputs 
  &SellerId=A46VPI2LR4OTS
  &SignatureVersion=2 
  &Timestamp=2019-08-07T18%3A29%3A23Z 
  &Version=2015-06-01 
  &Signature=WMeN1apuR3ahb0ncdqq51gxwmGy4K6HqCIwtf87rquE%3D 
  &SignatureMethod=HmacSHA256 
  &OrderId=922-2942641-9412606 
  &ShippingServiceId=CHINA_POST_E_COURIER_PRI 
  &ShipFromAddress.Name=Shenzhen%20Address 
  &ShipFromAddress.AddressLine1=test%20address 
  &ShipFromAddress.City=Shenzhen 
  &ShipFromAddress.StateOrProvinceCode=Guangdong 
  &ShipFromAddress.PostalCode=510810 
  &ShipFromAddress.CountryCode=CN 
  &ShipFromAddress.Email=example%40email.com 
  &ShipFromAddress.Phone=555-555-5555

↑ Top

Example response

For information about standard response formatting, see Response format.

Show example code Hide example code

For shipping that requires additional seller inputs.

<?xml version="1.0"?>
<GetAdditionalSellerInputsResponse
    xmlns="https://mws.amazonservices.com/MerchantFulfillment/2015-06-01">
    <GetAdditionalSellerInputsResult>
        <ShipmentLevelFields>
            <member>
                <SellerInputDefinition>
                    <IsRequired>true</IsRequired>
                    <RestrictedSetValues>
                        <member>Abandon</member>
                        <member>Return</member>
                    </RestrictedSetValues>
                    <DataType>String</DataType>
                    <InputTarget>SHIPMENT_LEVEL</InputTarget>
                    <StoredValue>
                        <ValueAsString>ABANDON</ValueAsString>
                        <DataType>STRING</DataType>
                        <ValueAsBoolean>false</ValueAsBoolean>
                        <ValueAsInteger>0</ValueAsInteger>
                    </StoredValue>
                    <InputDisplayText>Non-Deliverable Instructions</InputDisplayText>
                    <Constraints/>
                </SellerInputDefinition>
                <AdditionalInputFieldName>NON_DELIVERABLE_INSTRUCTIONS</AdditionalInputFieldName>
            </member>
            <member>
                <SellerInputDefinition>
                    <IsRequired>true</IsRequired>
                    <RestrictedSetValues/>
                    <DataType>Address</DataType>
                    <InputTarget>SHIPMENT_LEVEL</InputTarget>
                    <InputDisplayText>Ship From Address(Chinese)</InputDisplayText>
                    <Constraints>
                        <member>
                            <ValidationRegEx>putjust5digitRegex</ValidationRegEx>
                            <ValidationString>Please enter Ship From Address in
                                Chinese</ValidationString>
                        </member>
                    </Constraints>
                </SellerInputDefinition>
                <AdditionalInputFieldName>SENDER_ADDRESS_TRANSLATED</AdditionalInputFieldName>
            </member>
        </ShipmentLevelFields>
        <ItemLevelFieldsList>
            <member>
                <Asin>B004U9TL66</Asin>
                <AdditionalInputs>
                    <member>
                        <SellerInputDefinition>
                            <IsRequired>true</IsRequired>
                            <RestrictedSetValues/>
                            <DataType>Weight</DataType>
                            <InputTarget>ITEM_LEVEL</InputTarget>
                            <StoredValue>
                                <ValueAsWeight>
                                    <Value>600</Value>
                                    <Unit>G</Unit>
                                </ValueAsWeight>
                                <DataType>WEIGHT</DataType>
                                <ValueAsBoolean>false</ValueAsBoolean>
                                <ValueAsInteger>0</ValueAsInteger>
                            </StoredValue>
                            <InputDisplayText>Item weight</InputDisplayText>
                            <Constraints>
                                <member>
                                    <ValidationRegEx>^[0-9]{1,3}(.[0-9]{1,2})?$</ValidationRegEx>
                                    <ValidationString>Please enter item weight (max 6
                                        digits)</ValidationString>
                                </member>
                            </Constraints>
                        </SellerInputDefinition>
                        <AdditionalInputFieldName>ITEM_WEIGHT</AdditionalInputFieldName>
                    </member>
                    <member>
                        <SellerInputDefinition>
                            <IsRequired>true</IsRequired>
                            <RestrictedSetValues/>
                            <DataType>String</DataType>
                            <InputTarget>ITEM_LEVEL</InputTarget>
                            <StoredValue>
                                <ValueAsString>CN</ValueAsString>
                                <DataType>STRING</DataType>
                                <ValueAsBoolean>false</ValueAsBoolean>
                                <ValueAsInteger>0</ValueAsInteger>
                            </StoredValue>
                            <InputDisplayText>Country of Origin</InputDisplayText>
                            <Constraints>
                                <member>
                                    <ValidationRegEx>^[a-zA-Z]{2}$</ValidationRegEx>
                                    <ValidationString>Please enter country code of the country of
                                        manufacture (e.g. CN)</ValidationString>
                                </member>
                            </Constraints>
                        </SellerInputDefinition>
                        <AdditionalInputFieldName>COUNTRY_OF_ORIGIN</AdditionalInputFieldName>
                    </member>
                    <member>
                        <SellerInputDefinition>
                            <IsRequired>true</IsRequired>
                            <RestrictedSetValues/>
                            <DataType>String</DataType>
                            <InputTarget>ITEM_LEVEL</InputTarget>
                            <StoredValue>
                                <ValueAsString>衣�</ValueAsString>
                                <DataType>STRING</DataType>
                                <ValueAsBoolean>false</ValueAsBoolean>
                                <ValueAsInteger>0</ValueAsInteger>
                            </StoredValue>
                            <InputDisplayText>Item Description(Chinese)</InputDisplayText>
                            <Constraints>
                                <member>
                                    <ValidationRegEx>^[^a-zA-Z]{1,10}$</ValidationRegEx>
                                    <ValidationString>Please enter item description in Chinese up to
                                        10 characters </ValidationString>
                                </member>
                            </Constraints>
                        </SellerInputDefinition>
                        <AdditionalInputFieldName>ITEM_DESCRIPTION_TRANSLATED</AdditionalInputFieldName>
                    </member>
                    <member>
                        <SellerInputDefinition>
                            <IsRequired>true</IsRequired>
                            <RestrictedSetValues/>
                            <DataType>String</DataType>
                            <InputTarget>ITEM_LEVEL</InputTarget>
                            <StoredValue>
                                <ValueAsString>200</ValueAsString>
                                <DataType>CURRENCY</DataType>
                                <ValueAsBoolean>false</ValueAsBoolean>
                                <ValueAsInteger>0</ValueAsInteger>
                            </StoredValue>
                            <InputDisplayText>Item Value(USD)</InputDisplayText>
                            <Constraints>
                                <member>
                                    <ValidationRegEx>^[0-9]{1,3}(.[0-9]{1,2})?$</ValidationRegEx>
                                    <ValidationString>Please enter item value in USD (max 6
                                        digits)</ValidationString>
                                </member>
                            </Constraints>
                        </SellerInputDefinition>
                        <AdditionalInputFieldName>ITEM_VALUE</AdditionalInputFieldName>
                    </member>
                    <member>
                        <SellerInputDefinition>
                            <IsRequired>false</IsRequired>
                            <RestrictedSetValues/>
                            <DataType>String</DataType>
                            <InputTarget>ITEM_LEVEL</InputTarget>
                            <InputDisplayText>HS Code</InputDisplayText>
                            <Constraints>
                                <member>
                                    <ValidationRegEx>^[0-9a-zA-Z -]{1,10}?$</ValidationRegEx>
                                    <ValidationString>Please enter HS Code containing letters and
                                        numbers only up to 10 characters</ValidationString>
                                </member>
                            </Constraints>
                        </SellerInputDefinition>
                        <AdditionalInputFieldName>HS_CODE</AdditionalInputFieldName>
                    </member>
                    <member>
                        <SellerInputDefinition>
                            <IsRequired>true</IsRequired>
                            <RestrictedSetValues/>
                            <DataType>String</DataType>
                            <InputTarget>ITEM_LEVEL</InputTarget>
                            <StoredValue>
                                <ValueAsString>Diapers</ValueAsString>
                                <DataType>STRING</DataType>
                                <ValueAsBoolean>false</ValueAsBoolean>
                                <ValueAsInteger>0</ValueAsInteger>
                            </StoredValue>
                            <InputDisplayText>Item Description</InputDisplayText>
                            <Constraints>
                                <member>
                                    <ValidationRegEx>^[a-zA-Z0-9-._&amp; ]{3,25}$</ValidationRegEx>
                                    <ValidationString>Please enter item description using
                                        alphanumeric characters (max 25
                                        characters)</ValidationString>
                                </member>
                            </Constraints>
                        </SellerInputDefinition>
                        <AdditionalInputFieldName>ITEM_DESCRIPTION</AdditionalInputFieldName>
                    </member>
                </AdditionalInputs>
            </member>
        </ItemLevelFieldsList>
    </GetAdditionalSellerInputsResult>
    <ResponseMetadata>
        <RequestId>c16c3c89-6dcd-11e9-b318-db190c5bb6ad</RequestId>
    </ResponseMetadata>
</GetAdditionalSellerInputsResponse>

For shipping that does not require additional seller inputs.

<?xml version="1.0" encoding="UTF-8"?>
<GetAdditionalSellerInputsResponse xmlns="https://mws.amazonservices.com/MerchantFulfillment/2015-06-01">
    <GetAdditionalSellerInputsResult>
        <ShipmentLevelFields/>
        <ItemLevelFieldsList>
            <member>
                <Asin>B004U9TL66</Asin>
                <AdditionalInputs/>
            </member>
        </ItemLevelFieldsList>
    </GetAdditionalSellerInputsResult>
    <ResponseMetadata>
        <RequestId>308c41e1-6de4-11e9-9856-5df3f6909c79</RequestId>
    </ResponseMetadata>
</GetAdditionalSellerInputsResponse>

↑ Top