Update point of interest by code

put

https://saas.quadminds.com/api/v2/pois/{code}

GEOLOCALIZATION

New Pois can be geocoded when being created. There are some considerations to take into account:

If latitude and longitude are present, it won't geocode based on the address, longAddress or geocodeByCep object. BUT will try to fetch an address with that coordinates and if it's a valid one, it will be replace as the Poi address. IE: if latitude:0 and longitude:0, it will not geocode and will try to fetch an address from [0,0] but won't get any result, so the address will not change.
If latitude and longitude are not present, it will prioritize the addresses in this order
1. geocodeByCep: if this objects is present and is valid, address and longAddress will be ignored
2. address: if this objects is present, longAddress will be ignored. IE If you dont't want to use address object, remove it entirely so that longAddress can be used
3. longAddress: if this string is present, it will try to gecode based on this string.

Path Params

code

string

required

Body Params

Poi properties that will be updated

name

string

length ≤ 255

Poi name

address

object

Address componentes, If these properties are not filled we will geocode with longAddress value

longAddress

string

length ≤ 255

Poi address

longitude

number

Poi longitude coordinate

latitude

number

Poi latitude coordinate

geocodeByCep

object

Object to geocode by CEP

enabled

boolean

Poi status

deliveryAreaCode

string

Poi delivery area code

salesAreaCode

string

Poi sale area code

poiType

string

Poi type code from /poi/types

originalAddress

string

Poi first address entered

phoneNumber

string

length between 1 and 200

Poi phone

taxId

string

Poi taxId

radius

integer

50 to 500

Poi radius (meters)

grouping

string

length ≤ 16

Poi grouping

visitingFrequency

string

enum

Poi frequency

Allowed:

deviceId1

string

ERP code - DEPRECATED

visitingDaysDevice1

array of integers

Poi visiting day for deviceId1 "Monday -> 1, Sunday -> 7" - DEPRECATED

visitingDaysDevice1

deviceId2

string

ERP code - DEPRECATED

visitingDaysDevice2

array of integers

Poi visiting day for deviceId2 "Monday -> 1, Sunday -> 7" - DEPRECATED

visitingDaysDevice2

deviceId3

string

ERP code - DEPRECATED

visitingDaysDevice3

array of integers

Poi visiting day for deviceId3 "Monday -> 1, Sunday -> 7" - DEPRECATED

visitingDaysDevice3

deviceId4

string

ERP code - DEPRECATED

visitingDaysDevice4

array of integers

Poi visiting day for deviceId4 "Monday -> 1, Sunday -> 7" - DEPRECATED

visitingDaysDevice4

visitingOrder

integer

Poi visiting order - DEPRECATED

comments

string

comments/observations

string

length ≤ 255

Poi Email (More than one separated by commas)

timeWindow

array of objects

Poi visiting time windows (use User TimeZone)

timeWindow

poiDelay

string

delay time in Poi

poiDeliveryComments

string

Additional Comments when delivering to this Poi

notificationConfig

object

Notifications configuration

Responses

Code	Description	Field
1001	Wrong time window object	timeWindow
2002	Wrong time window values, must be string	timeWindow
2003	Wrong time window, 'from' must be less than 'to'	timeWindow
2004	Wrong time window, times are overlapped	timeWindow
2010	Poi type not found or not allowed for this user	poiType
2020	Poi code already present for this user	code
2021	Poi code not found or not allowed for this user	code
2023	Nothing to update
2024	Visiting frequency invalid	visitingFrequency
2025	Visiting days invalid	visitingDays
5001	Area code not present or not allowed for this user	salesAreaCode, deliveryAreaCode

200updated point of interest

Error codes:

403Not authorized access