Address
Interact with the account address book. Cannot be used for rate requests through the API.
list [get]
Details
- Method: GET
- URL: https://vsa.savtrans.com/api.php/rest/address
- Response: Returns 200 and the collection of resources, which could be empty.
- Resource Notes: Returns the 250 most recently created addresses.
Fields
- company_name: Company Name
- address: Address Line 1
- address_2: Address Line 2
- city: City
- state: State/Province (US or Canada)
- postal_code: Postal/Zip Code (US or Canada)
retrieve [get]
Details
- Method: GET
- URL: https://vsa.savtrans.com/api.php/rest/address/HASH
- Response: Returns 200 and the resource or 404 if not found.
Fields
- company_name: Company Name
- contact_name: Contact Name
- address: Address Line 1
- address_2: Address Line 2
- city: City
- state: State/Province (US or Canada)
- postal_code: Postal/Zip Code (US or Canada)
- phone: Phone Number
- extension: Phone Number Extension
- fax: Fax Number
- email: Email Address
- is_pickup: 0 for Delivery, 1 for Pickup, 2 for Either
create [post]
Details
- Method: POST
- URL: https://vsa.savtrans.com/api.php/rest/address?company_name=COMPANY_NAME&contact_name=CONTACT_NAME&address=ADDRESS...
- Response: A successful creation returns 201 and redirects to the retrieve action. An unsuccessful creation returns 400 and displays a list of validation errors.
- Action Notes: All fields are supplied in query string format.
Fields
- company_name: Company Name
- contact_name: Contact Name
- address: Address Line 1
- address_2: Address Line 2
- city: City
- state: State/Province (US or Canada)
- postal_code: Postal/Zip Code (US or Canada)
- phone: Phone Number
- extension: Phone Number Extension
- fax: Fax Number
- email: Email Address
- is_pickup: 0 for Delivery, 1 for Pickup, 2 for Either
update [put]
Details
- Method: PUT
- URL: https://vsa.savtrans.com/api.php/rest/address/HASH?company_name=COMPANY_NAME&contact_name=CONTACT_NAME&address=ADDRESS...
- Response: A successful update returns 200 and displays the resource as a retrieve would. An unsuccessful update returns 400 and displays a list of validation errors. Not found returns 404.
- Action Notes: Only supply fields you wish to update. Omitted fields will be ignored. All fields are supplied in query string format.
Fields
- company_name: Company Name
- contact_name: Contact Name
- address: Address Line 1
- address_2: Address Line 2
- city: City
- state: State/Province (US or Canada)
- postal_code: Postal/Zip Code (US or Canada)
- phone: Phone Number
- extension: Phone Number Extension
- fax: Fax Number
- email: Email Address
- is_pickup: 0 for Delivery, 1 for Pickup, 2 for Either
delete [delete]
Details
- Method: DELETE
- URL: https://vsa.savtrans.com/api.php/rest/address/HASH
- Response: A successful delete returns 200 and a blank page. Not found returns 404.