getOrderAddress

get https://sellingpartnerapi-na.amazon.com/orders/v0/orders/{orderId}/address

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

Response body

object

payload

object

The shipping address for the order.

AmazonOrderId

string

required

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

BuyerCompanyName

string

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

ShippingAddress

object

The shipping address for the order.

DeliveryPreferences

object

Contains all of the delivery instructions provided by the customer for the shipping address.

errors

array of objects

A list of error responses returned when a request is unsuccessful.

errors

object

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

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sellingpartnerapi-na.amazon.com/orders/v0/orders/orderId/address \
3
     --header 'accept: application/json'


xxxxxxxxxx
13
 
1
{
2
  "payload": {
3
    "AmazonOrderId": "902-3159896-1390916",
4
    "ShippingAddress": {
5
      "Name": "Michigan address",
6
      "AddressLine1": "1 cross st",
7
      "City": "Canton",
8
      "StateOrRegion": "MI",
9
      "PostalCode": "48817",
10
      "CountryCode": "US"
11
    }
12
  }
13
}

200Success.

400Request has missing or invalid parameters and cannot be parsed.

403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.