Create A Location

Create Location

The Create Location API allows developers to create new location entries.

Upon successful creation of a new location entry, the API will return a response with the newly created location's unique identifier and other relevant information.

Parameters

Query Parameters

ParameterRequired/OptionalTypeDescription
user_idRequirednumberCurrent User Id

* Bold Parameters are required fields

Body Parameters

ParameterRequired/OptionalTypeDescription/ Label Of Form
legal_business_nameRequiredstring(64)Legal Business Name
nameRequiredstring(64)Store Name
statusOptionalstring'1', 'Active', 'Active' - DEFAULT
'2', 'Inactive', 'Inactive'
'3', 'Cancelled', 'Cancelled'
'4', 'Closed', 'Closed'
'5', 'Boarding', 'Boarding or Pending Installation'
phoneRequirednumberPhone
cityRequiredstringcity
global_state_idRequirednumberState (API below)
global_country_idRequirednumberCountry (API below)
zipRequiredstringZIP Code
websiteOptionalstringWebsite
emailRequiredstringEmail
eod_timeOptionaltimeBy default ‘11:00:00’ pass (batch out time local to the location in UTC time)
logoOptionalstringProduct thumbnail (customer receipt)
location_id_externalOptionalstringExternal Location ID (this ID in Iris CRM)
Primary_contact_first_nameOptionalstringPrimary Contact First Name
Primary_contact_last_nameOptionalstringPrimary Contact Last Name
Primary_contact_emailOptionalstringPrimary Contact Email. Someone who has connection to the location
Owner_first_nameRequiredstring(45)Owner first name
Owner_last_nameRequiredstring(45)Owner last name
Owner_emailRequiredstring(150)Owner email.
addressRequiredstring(255)Address
posOptionalnumberpos
manufactureOptionalnumbermanufacture
tax_rateOptionalnumbertax rate for the location in hundreds E.G. 100=1.00%
corporate_idOptionalnumbermust be associated to new locations for proper billing association
corporate_category_idOptionalnumbermust be provided to associate correct products and servicess.
eod_timeOptionalstringEOD time for the location, this has to be in the following format: "00:00:00"

* Bold Parameters are required fields

Language
Credentials
Bearer
URL
Click Try It! to start a request and see the response here!