Add a new Address

post

https://qa2.revelup.com/resources/Address/

Add a new Address

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Address object that needs to be added.

active

boolean

Defaults to false

Flag. If set to False, the address can not be used as an external shipping address.

alias

string

length ≤ 80

Address alias. Used as a reference when choosing external shipping addresses.

building_number

string

length ≤ 12

Custom field used only in Fuel Retail mode.

city_name

string

required

length ≤ 100

City name, used in geolocation.

country

string

required

length ≤ 2

Address country code. Values are expected to follow the ISO 3166-2 standard.

county

string

length ≤ 120

Address county stored in an arbitrary format - can be a FIPS code or the full county name. Used only in Fuel Retail mode.

created_by

uri

required

URI of the User that created this resource.

created_date

date-time

ISO8601 timestamp of the time the resource was created.

district

string

length ≤ 120

Custom field used only in Fuel Retail mode.

door

string

length ≤ 12

Custom field used only in Fuel Retail mode.

is_external

boolean

Defaults to false

Flag. If set to True, this address will be used by default for all invoices.

latitude

float

-90 to 90

Exact geographic latitude of the address.

line_1

string

required

length ≤ 280

First line of the address. Used in geolocation, so it should be searchable by most map providers.

line_2

string

length ≤ 280

Second line of the address. Not used in geolocation, so any additional address info can go here.

longitude

float

-180 to 180

Exact geographic longitude of the address.

province

string

length ≤ 120

Address province stored in an arbitrary format.

state

string

Address state stored in a the FIPS state code format. Non-US addresses should use a "--" value.

updated_date

date-time

ISO8601 timestamp of the time the resource was updated.

updated_by

uri

required

URI of the User that last updated this resource.

uuid

Resource UUID. Must be unique for all resources.

zipcode

string

required

length ≤ 10

Address postal code. Used in geolocation, so should match the standard of the address country.

Responses

400

Bad request. Usually caused by invalid request body.

401

Authentication error - make sure the API key & secret is valid, active and provided in the "API-AUTHENTICATION" header.

201Resource successfully created.