JM Shipping SolutionAddress

Save addresses to your address book

Saves one or more addresses for reuse across shipments. Addresses can be typed as ORIGIN (1) or DESTINATION (2) and referenced by ID in future shipment requests.

Headers

AuthorizationstringRequired

EX: “Basic dXNlcm5hbWU6cGFzc3dvcmQ=”

API_KEYstringRequired

EX: “B30BBEC3-8086-49B6-9893-2FCD31FA2BBF”

Request

List of addresses you would like to save
IdstringOptional
Unique identifier for a saved address. This field is required for an address update
ClientIdintegerOptional
AddressTypeenumOptional

Required to create or update an address. Type should be ORIGIN or DESTINATION. Ignored for all other operations UNSPECIFIED=0; ORIGIN=1; DESTINATION=2;

ReferencestringOptional0-50 characters
The Reference field will be used for address drop downs where available on a UI. This should be a meaningful identifier such as a company name
CompanystringOptional0-50 characters
ContactstringOptional0-50 characters
AddressLine1stringOptional0-50 characters
AddressLine2stringOptional0-50 characters
CitystringOptional0-50 characters
StatestringOptional0-50 characters
ZipstringOptional0-9 characters
CountryCodestringOptional0-2 characters
PhoneNumberstringOptional0-25 characters
EmailAddressstringOptional0-50 characters
SendNotificationEmailbooleanOptional
Used for shipping. If this is set to true, a notification email will be sent to the EmailAddress provided when a shipment is purchased.
ResidentialbooleanOptional
IgnoreBadAddressbooleanOptional
This is a USPS specific implementation. Setting this value to true overrides the default address checking behavior and allows you to purchase a shipment through USPS for an address they consider invalid.

Response

Returned if there are no http error. AddressResponse Error should still be verified as null or empty.
AddressobjectOptional
Standard address object used for Origin address, Destination address and COD Remittance address
Errorlist of objectsOptional
Error will be empty or NULL if no error was encountered

Errors

400
Bad Request Error
404
Not Found Error