Include additional seller input data
Learn how to use the Merchant Fulfillment API to include additional seller input data.
Learn how to use the Merchant Fulfillment API to include additional seller input data. The getAdditionalSellerInputs
operation returns a list of additional inputs that are required from the seller to purchase shipping for some shipping services. It is only required for shipment services that require additional seller inputs.
Prerequisites
To complete this tutorial, you need:
- Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API applications.
- The Direct-to-Consumer Shipping (Restricted) role assigned to your developer profile.
- The Direct-to-Consumer Shipping (Restricted) role selected in the app registration page for your application.
Step 1. Determine if the shipment service requires additional seller inputs
- Call the
getEligibleShipmentServices
operation. - Retrieve the list of
ShippingServices
returned by the operation. - Check for the
RequiresAdditionalSellerInputs
attribute. - If
RequiresAdditionalSellerInputs
istrue
, it means the shipment service requires additional seller inputs.
Step 2. Call the getAdditionalSellerInputs
operation
getAdditionalSellerInputs
operationIf the shipment service requires additional seller inputs, call the getAdditionalSellerInputs
operation and include all required parameters. The response includes a list of required parameters that a seller must include if they want to purchase shipping services.
Step 3. Review the additional seller inputs required
- Examine the response from the
getAdditionalSellerInputs
operation. - Identify the specific additional seller inputs that are required.
Step 4. Provide the required seller inputs
- Collect the necessary information based on the additional seller inputs identified in the response.
- Ensure the information provided meets the syntax requirements specified in the response.
- Prepare the required seller inputs for the next step.
Step 5. Create the shipment
- If the required seller inputs are collected and prepared, call the
createShipment
operation. - Use the necessary parameters and seller inputs with the
createShipment
operation. - Follow the appropriate syntax requirements for the seller inputs in the
getAdditionalSellerInputs
response.
Step 6: (Optional) Retrieve saved values
The getAdditionalSellerInputs
operation returns saved values previously provided to Amazon. To access these saved values, examine the response from the getAdditionalSellerInputs
operation.
Updated about 10 hours ago