getOrderAddress

Returns the shipping address for the order that you specify.

Usage Plan:

Rate (requests per second)	Burst
0.5	30

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to Usage Plans and Rate Limits.

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 `getOrderAddress` operation.

payload

object (OrderAddress)

optional

The shipping address for the order.

AmazonOrderId

string

required

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

BuyerCompanyName

string

optional

The company name of the contact buyer. For IBA orders, the buyer company must be Amazon entities.

ShippingAddress

object (Address)

optional

Shipping address that represents the origin or destination location.

Example:

{"addressLine1":"address_1","addressLine2":"address_2","addressLine3":"address_3","city":"Seattle","countryCode":"US","county":"Washington","district":"District1","name":"address_name","phoneNumber":"+14155552671","postalCode":"123456","stateOrRegion":"Washington"}

DeliveryPreferences

object (DeliveryPreferences)

optional

The delivery preferences applied to the destination address. These preferences are applied when possible and are best effort.
This feature is currently supported only in the JP marketplace and not applicable for other marketplaces.
For eligible orders, the default delivery preference will be to deliver the package unattended at the front door, unless you specify otherwise.

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": {
        "AmazonOrderId": "902-3159896-1390916",
        "ShippingAddress": {
            "Name": "Michigan address",
            "AddressLine1": "1 cross st",
            "City": "Canton",
            "StateOrRegion": "MI",
            "PostalCode": "48817",
            "CountryCode": "US"
        }
    }
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses