updateShipmentSourceAddress

Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address.

Usage Plan:

Rate (requests per second)	Burst
2	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 have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Request

Path Params

inboundPlanId

string

required

Identifier of an inbound plan.

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

shipmentId

string

required

Identifier of a shipment. A shipment contains the boxes and units being inbounded.

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

Body Params application/json

The `UpdateShipmentSourceAddress` request.

address

object (AddressInput)

required

Specific details to identify a place.

Example:

{"addressLine1":"123 example street","addressLine2":"Floor 19","city":"Toronto","companyName":"Acme","countryCode":"CA","email":"email@email.com","name":"name","phoneNumber":"1234567890","postalCode":"M1M1M1","stateOrProvinceCode":"ON"}

addressLine1

string

required

Street address information.

>= 1 characters<= 180 characters

addressLine2

string

optional

Additional street address information.

>= 1 characters<= 60 characters

city

string

required

The city.

>= 1 characters<= 30 characters

companyName

string

optional

The name of the business.

>= 1 characters<= 50 characters

countryCode

string

required

The country code in two-character ISO 3166-1 alpha-2 format.

>= 2 characters<= 2 characters

Match pattern:

^[A-Z]{2}$

string

optional

The email address.

>= 1 characters<= 1024 characters

name

string

required

The name of the individual who is the primary contact.

>= 1 characters<= 50 characters

phoneNumber

string

required

The phone number.

>= 1 characters<= 20 characters

postalCode

string

required

The postal code.

>= 1 characters<= 32 characters

stateOrProvinceCode

string

optional

The state or province code.

>= 1 characters<= 64 characters

Example

{
    "address": {
        "addressLine1": "123 example street",
        "addressLine2": "Floor 19",
        "city": "Toronto",
        "companyName": "Acme",
        "countryCode": "CA",
        "email": "email@email.com",
        "name": "name",
        "phoneNumber": "1234567890",
        "postalCode": "M1M1M1",
        "stateOrProvinceCode": "ON"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢202Accepted

application/json

UpdateShipmentSourceAddress 202 response

Headers

x-amzn-RequestId

string

optional

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

optional

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

Body

The `UpdateShipmentSourceAddress` response.

operationId

string

required

UUID for the given operation.

>= 36 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

Example

{
    "operationId": "stringstringstringstringstringstring"
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable