Selling Partner API for Merchant Fulfillment (v0)

Download OpenAPI specification:Download

The Selling Partner API for Merchant Fulfillment helps you build applications that let sellers purchase shipping for non-Prime and Prime orders using Amazon’s Buy Shipping Services.

merchantFulfillment

getEligibleShipmentServicesOld

Returns a list of shipping service offers that satisfy the specified shipment request details.

Usage Plan:

Rate (requests per second) Burst
1 1

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Request Body schema: application/json
required
object (ShipmentRequestDetails)

Shipment information required for requesting shipping service offers or for creating a shipment.

object (ShippingOfferingFilter)

Filter for use when requesting eligible shipping services.

Responses

Request samples

Content type
application/json
{
  • "ShipmentRequestDetails": {
    },
  • "ShippingOfferingFilter": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

getEligibleShipmentServices

Returns a list of shipping service offers that satisfy the specified shipment request details.

Usage Plan:

Rate (requests per second) Burst
5 10

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Request Body schema: application/json
required
object (ShipmentRequestDetails)

Shipment information required for requesting shipping service offers or for creating a shipment.

object (ShippingOfferingFilter)

Filter for use when requesting eligible shipping services.

Responses

Request samples

Content type
application/json
{
  • "ShipmentRequestDetails": {
    },
  • "ShippingOfferingFilter": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

getShipment

Returns the shipment information for an existing shipment.

Usage Plan:

Rate (requests per second) Burst
1 1

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

path Parameters
shipmentId
required
string[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-...

The Amazon-defined shipment identifier for the shipment.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

cancelShipment

Cancel the shipment indicated by the specified shipment identifier.

Usage Plan:

Rate (requests per second) Burst
1 1

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

path Parameters
shipmentId
required
string[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-...

The Amazon-defined shipment identifier for the shipment to cancel.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

cancelShipmentOld

Cancel the shipment indicated by the specified shipment identifer.

Usage Plan:

Rate (requests per second) Burst
1 1

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

path Parameters
shipmentId
required
string[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-...

The Amazon-defined shipment identifier for the shipment to cancel.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

createShipment

Create a shipment with the information provided.

Usage Plan:

Rate (requests per second) Burst
1 1

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Request Body schema: application/json
required
object (ShipmentRequestDetails)

Shipment information required for requesting shipping service offers or for creating a shipment.

ShippingServiceId
required
string

An Amazon-defined shipping service identifier.

ShippingServiceOfferId
string

Identifies a shipping service order made by a carrier.

HazmatType
string (HazmatType)
Enum: "None" "LQHazmat"

Hazardous materials options for a package. Consult the terms and conditions for each carrier for more information on hazardous materials.

object (LabelFormatOptionRequest)

Whether to include a packing slip.

Array of objects (AdditionalSellerInputs)

A list of additional seller input pairs required to purchase shipping.

Responses

Request samples

Content type
application/json
{
  • "ShipmentRequestDetails": {
    },
  • "ShippingServiceId": "string",
  • "ShippingServiceOfferId": "string",
  • "HazmatType": "None",
  • "LabelFormatOption": {
    },
  • "ShipmentLevelSellerInputsList": [
    ]
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

getAdditionalSellerInputsOld

Get 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

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Request Body schema: application/json
ShippingServiceId
required
string

An Amazon-defined shipping service identifier.

required
object (Address)

The postal address information.

OrderId
required
string

An Amazon-defined order identifier, in 3-7-7 format.

Responses

Request samples

Content type
application/json
{
  • "ShippingServiceId": "string",
  • "ShipFromAddress": {
    },
  • "OrderId": "string"
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

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

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Request Body schema: application/json
ShippingServiceId
required
string

An Amazon-defined shipping service identifier.

required
object (Address)

The postal address information.

OrderId
required
string

An Amazon-defined order identifier, in 3-7-7 format.

Responses

Request samples

Content type
application/json
{
  • "ShippingServiceId": "string",
  • "ShipFromAddress": {
    },
  • "OrderId": "string"
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}