Create Location

post

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

Use the Create Location endpoint to create a new store location, associated with a provider-specific ID, and nest it below a parent location (store). The first location you create will be designated location 0, the top-level location.

Status codes

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

The table below contains a status code that applies to this specific endpoint.

Status code	Description
506-01	Invalid location ID

Form Data

apiLogin

string

required

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

apiTransKey

string

required

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

transactionId

string

required

1 to 60

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency.. A UUID is preferred.
Pattern: Maximum 60 characters
Example: "9845dk-39fdk3fj3-4483483478"

name

string

required

The name of the location.
Pattern: Max 85 characters: letters, numbers, spaces, _ (underscore), ' (single quote), - (hyphen), . (period). All other characters will be removed.
Example: "ABC Store 5"

address1

string

required

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

required

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

state

string

required

length between 2 and 2

State or province for the location.
Pattern: 2-character state or province abbreviation
Example: "UT"

postalCode

string

required

length between 5 and 10

^[a-zA-Z0-9\-\ ]*$

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

countryCode

string | null

[0-9]{3}$

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

phone

string | null

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

parentLocation

string

required

^[a-zA-Z0-9]{1,20}$

Identifier for the parent location. The first time you create a location, pass 0.
Pattern: Integer if parentLocationType: 0; max 15 characters if parentLocationType: 1
Example: "5"

parentLocationType

int32

enum

required

The type of location specified in parentLocation. If parentLocation is the top-level value from SoFi Tech Solutions, then pass 0 for this parameter.

0 — SoFi Tech Solutions location ID
1 — Partner location ID
2 — Don't validate

Pattern: 0, 1 or 2
Example: 0

Allowed:

providerSpecifiedId

string | null

^[a-zA-Z0-9]{1,15}$

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