API ReferenceShipments

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

Request

This endpoint expects an object.
citystringRequired>=1 character
City of customer address
street_address1stringRequired>=1 character
Street Address 1
company_namestring or nullOptional

Company name (optional)

country_codestring or nullOptional
Country code of customer address
emailstring or nullOptional
Customer's email address
phone_numberstring or nullOptional
Phone number of Recipient address
recipient_namestring or nullOptional
Name of customer
statestring or nullOptional
State of customer address
street_address2string or nullOptional
Street Address 2
zip_codestring or nullOptional
Zipcode of customer address

Response

OK
errorobject
idlong
is_successboolean