Outlet

Create a new outlet

Creates a new outlet record.

post/v1/outlet

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/outlet
  • Auth: API key in header x-api-key

Request body

namestring required

Name of the Outlet.

addressstring required

Primary address of the Outlet.

citystring required

City where the Outlet is located.

statestring required

State or province where the Outlet is located.

countrystring required

Country where the Outlet is located.

postCodestring required

Post code or ZIP code of the Outlet.

phonestring

Phone number of the Outlet.

address2string

Secondary address line of the Outlet.

timeZonestring

IANA timezone of the outlet. Falls back to Company.timeZone when absent.

stationsstring[]

List of station IDs associated with the Outlet.

stripeAccountIdstring

Stripe Connect account ID associated with the Outlet.

stripeobject

Stripe Terminal configuration for the Outlet.

externalIdstring

External provider id for the Outlet (the source location id). Integration correlation key.

sourcestring

Origin of the Outlet — the integration provider that created it, or "standalone".

taxIdstring

Tax ID associated with the Outlet.

Example request

{
  "name": "Main Store",
  "address": "26 Federal Plaza, New York, NY 10278, USA",
  "city": "New York",
  "state": "NY",
  "country": "US",
  "postCode": "10278",
  "phone": "+12323232323",
  "address2": "Suite 100",
  "timeZone": "America/St_Johns",
  "stations": [
    "o1p2q3r4s5t6u7v8w9x0y1z2"
  ],
  "stripeAccountId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "stripe": {
    "locationId": "tml_XXXXXXXXXX"
  },
  "externalId": "L1234567890",
  "source": "square",
  "taxId": "23"
}

Response

The outlet has been successfully created.

idstring

Unique identifier for the Outlet.

createdAtstring date-time

Timestamp when the Outlet was created.

updatedAtstring date-time

Timestamp when the Outlet was last updated.

companyIdstring

Company ID associated with the Outlet.

namestring

Name of the Outlet.

addressstring

Primary address of the Outlet.

citystring

City where the Outlet is located.

statestring

State or province where the Outlet is located.

countrystring

Country where the Outlet is located.

postCodestring

Post code or ZIP code of the Outlet.

phonestring

Phone number of the Outlet.

address2string

Secondary address line of the Outlet.

aliasstring

Alias or alternate name for the Outlet used for Metorik Extension.

timeZonestring

IANA timezone of the outlet. Falls back to Company.timeZone when absent.

sequenceNumbernumber

Sequence number for the Outlet (auto-generated).

stationsstring[]

List of station IDs associated with the Outlet.

stripeAccountIdstring

Stripe Connect account ID associated with the Outlet.

stripeobject

Stripe Terminal configuration for the Outlet.

externalIdstring

External provider id for the Outlet (the source location id). Integration correlation key.

sourcestring

Origin of the Outlet — the integration provider that created it, or "standalone".

taxIdstring

Tax ID associated with the Outlet.

Example response

{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "name": "Main Store",
  "address": "26 Federal Plaza, New York, NY 10278, USA",
  "city": "New York",
  "state": "NY",
  "country": "US",
  "postCode": "10278",
  "phone": "+12323232323",
  "address2": "Suite 100",
  "alias": "HQ",
  "timeZone": "America/St_Johns",
  "sequenceNumber": 45,
  "stations": [
    "o1p2q3r4s5t6u7v8w9x0y1z2"
  ],
  "stripeAccountId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "stripe": {
    "locationId": "tml_XXXXXXXXXX"
  },
  "externalId": "L1234567890",
  "source": "square",
  "taxId": "23"
}

Changes

No recorded changes to this operation across all 1 revision of this API.