Your API key for authorization.
Path Parameters
The ID of the shipping address to update.
Body Parameters
Show Shipping Address Object
First name of the recipient.
Last name of the recipient.
Email address of the recipient.
Phone number of the recipient.
Secondary address line (optional).
Country code (e.g., US, CA).
Response
Indicates whether the operation was successful.
The updated shipping address object containing:Show Shipping address properties
The unique identifier for the shipping address.
First name of the recipient.
Last name of the recipient.
Email address of the recipient.
Phone number of the recipient.
Secondary address line (if provided).
Country code (e.g., US, CA).
The ID of the profile this shipping address is attached to.
Timestamp when the shipping address was created.
Timestamp when the shipping address was last updated.
A code indicating the result of the operation. Possible values:
SHIPPING_UPDATED
: Shipping address updated successfully
SHIPPING_UPDATE_FAILED
: Failed to update shipping address
Error message if the request fails.
When updating a shipping address, you need to provide the complete shipping address object with all fields, even those that haven’t changed.
{
"success": true,
"shipping": {
"id": "ship_12345",
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@example.com",
"phone": "+1234567890",
"address_1": "456 Park Ave",
"address_2": "Suite 789",
"city": "New York",
"country_code": "US",
"province_code": "NY",
"postal_code": "10022",
"profile_id": "prof_67890",
"updated_at": "2023-09-16T10:15:22Z"
},
"id": "ship_12345",
"code": "SHIPPING_UPDATED"
}