deliveryOffers - Amazon SP API

Rate (requests per second)	Burst
5	30

Request

Body Params application/json

The request body schema for the getDeliveryOffers operation.

product

object (GetDeliveryOffersProduct)

required

The product details for the delivery offer.

productIdentifier

object (ProductIdentifier)

required

Product identifier input that locates a product for MCF.

amount

object (Amount)

optional

A quantity based on unit of measure.

terms

object (GetDeliveryOffersTerms)

required

The delivery terms for the delivery offer.

origin

object (Origin)

required

The origin for the delivery offer.

destination

object (Destination)

required

Information about the destination created when you call the createDestination operation.

Example

{
    "product": {
        "productIdentifier": {
            "merchantSku": "string"
        },
        "amount": {
            "unitOfMeasure": "Eaches",
            "value": "string"
        }
    },
    "terms": {
        "origin": {
            "countryCode": "st"
        },
        "destination": {
            "name": "string",
            "destinationId": "string",
            "resource": {
                "sqs": {
                    "arn": "string"
                },
                "eventBridge": {
                    "name": "string",
                    "region": "string",
                    "accountId": "string"
                }
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://sandbox.sellingpartnerapi-na.amazon.com/fba/outbound/2020-07-01/deliveryOffers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "product": {
        "productIdentifier": {
            "merchantSku": "string"
        },
        "amount": {
            "unitOfMeasure": "Eaches",
            "value": "string"
        }
    },
    "terms": {
        "origin": {
            "countryCode": "st"
        },
        "destination": {
            "name": "string",
            "destinationId": "string",
            "resource": {
                "sqs": {
                    "arn": "string"
                },
                "eventBridge": {
                    "name": "string",
                    "region": "string",
                    "accountId": "string"
                }
            }
        }
    }
}'

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

The response schema for the getDeliveryOffers operation.

payload

object (GetDeliveryOffersResult)

optional

A list of delivery offers, including offer expiration, earliest and latest date and time range, and the delivery offer policy.

deliveryOffers

array[object (DeliveryOffer) {3}]

optional

An array of delivery offer information.

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": {
        "deliveryOffers": [
            {
                "expiresAt": "2019-08-24T14:15:22Z",
                "dateRange": {
                    "earliest": "2019-08-24T14:15:22Z",
                    "latest": "2019-08-24T14:15:22Z"
                },
                "policy": {
                    "message": {
                        "text": "string",
                        "locale": "string"
                    }
                }
            }
        ]
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable