GAgalileo-ft
Location Management

Create Location

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.

post/createLocation

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/createLocation
  • Auth
    none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

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

apiTransKeystring required

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

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>.. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

namestring 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"

address1string required

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

address2string nullable

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

citystring required

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

statestring required

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

postalCodestring required

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

countryCodestring nullable

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"

phonestring nullable

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

parentLocationstring required

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"

parentLocationType0 | 1 | 2 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

providerSpecifiedIdstring nullable

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

status'C' | 'N' | 'S' | 'n' nullable

Location status. Default N:

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

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

store_type'1' | '2' | '3' | '4' | '5' | 'null' nullable

The store or location type. Default 5:

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

Pattern: Single digit or null Example: "5"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "ABC Store 5",
  "address1": "33 Maple Street",
  "address2": "#4B",
  "city": "Salt Lake City",
  "state": "UT",
  "postalCode": "84121",
  "countryCode": "840",
  "phone": "8013656060",
  "parentLocation": "5",
  "providerSpecifiedId": "abc-123",
  "status": "N",
  "store_type": "5"
}

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

Changes

No recorded changes to this operation across all 2 revisions of this API.