Modify Location

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/modifyLocation

Use the Modify Location endpoint to update data elements that are related to the location. Pass only the parameters to be modified — leave the rest blank.

Nullifying data elements

You can pass null for the following parameters to set the value in the database to null.


`name`	`address1`
`address2`	`city`
`phone`	`providerSpecifiedId`

Status codes

See Global Response Statuses for status codes that are common across endpoints.

Form Data

apiLogin

string

required

Web service username, as provided by Galileo.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by Galileo.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

int32

required

Galileo-issued provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

A unique provider-generated ID to identify this API call. A UUID is preferred.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

name

string | null

The name of the location.
Pattern: Max 85 alphanumeric characters
Example: "ABC Store #5"

address1

string | null

First address line of the location.
Pattern: 4–40 alphanumeric characters
Example: "33 Maple Street"

address2

string | null

Second address line of the location.
Pattern: Max 30 alphanumeric characters
Example: "#4B"

city

string | null

City for the location.
Pattern: Max 30 characters: letters, spaces, hyphen and period
Example: "Salt Lake City"

state

string | null

State or province for the location.
Pattern: String
Example: "UT"

postalCode

string | null

Postal (ZIP) code for the location.
Pattern: 12345, 12345-1234, K1A-1A1
Example: "84121"

countryCode

string | null

Country for the location. Three-digit UN M49 code, such as 840 for USA, 124 for Canada, 484 for Mexico, 170 for Colombia.
Pattern: Numeric string
Example: "840"

phone

string | null

Phone number of the location.
Pattern: Exactly 10 digits, no hyphens or other characters
Example: "8013656060"

location

string

required

Unique location identifier (location) as returned by the Create Location endpoint. This value is also returned by the Get Locations endpoint depending on the value of locationType when the location was created:

0 or 2 — Returned in the location_id field
1 — Returned in the provider_specified_id field

Pattern: String
Example: "a455-3483"

locationType

string

required

Type of ID in location:

0 — Galileo location ID
1 — Partner location ID
2 — Don't validate

Pattern: Numeric string
Example: "0"

providerSpecifiedId

string | null

The provider-supplied identifier for a location, when parentLocationType: 1.
Pattern: Max 15 alphanumeric characters
Example: "abc-123"

status

string | null

enum

Location status. Default N:

C — Closed
N — Active
S — Suspended
n — New

Pattern: Single character, case-sensitive
Example: "N"

Allowed:

store_type

string | null

enum

The store or location type. Default 5:

1 — Corporate
2 — Chain
3 — Reseller
4 — Region
5 — Store

Pattern: Single digit or null
Example: "5"

Allowed:

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

Status codes

default