API ReferenceOrders

Update Shipment Address

View as Markdown
Updates the shipping address for a specific shipment.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Path parameters

shipmentIdintegerRequired
Unique identifier of the shipment

Request

citystringRequired>=1 character
City of customer address
street_address1stringRequired>=1 character
Street Address 1
company_namestringOptional

Company name (optional)

country_codestringOptional
Country code of customer address
emailstringOptional
Customer's email address
phone_numberstringOptional
Phone number of Recipient address
recipient_namestringOptional
Name of customer
statestringOptional
State of customer address
street_address2stringOptional
Street Address 2
zip_codestringOptional
Zipcode of customer address

Response

OK
errorobject or null
Error details if the update was not successful
idlong
Unique identifier of the shipment
is_successboolean
Indicates whether the update was successful

Errors

400
Bad Request Error