Store
A Store is a point of sale of a Merchant, with its own address, POS connection and payment configuration.
Unique identifier for the Store.
sto_01kg2gestgepdbmsn7hs6bsrwpThe ID of the Concept Store this Store belongs to.
conce_01kg2gestgepdbmsn7hs6bsrwpThe name of the Concept Store this Store belongs to. Returned only when conceptStore is requested through the include parameter. Retrieve the Concept Store from /v1/concept_stores/{conceptStoreId} to read its other fields.
The ID of the Store Area this Store belongs to.
starea_01kg2gestgepdbmsn7hs6bsrwpThe name of the Store Area this Store belongs to. Returned only when storeArea is requested through the include parameter. Retrieve the Store Area from /v1/store_areas/{storeAreaId} to read its other fields.
The display name of the Store.
A URL-safe identifier for the Store, unique across the Merchant.
pos objectnullable
The connection to the POS system that serves the Store. Setting it makes externalId1 required.
The identifier of the Store inside the POS system.
Possible values: <= 10 characters
The base URL of the POS system. A trailing slash is added when missing.
Possible values: <= 200 characters
Your own identifier for the Store, unique across the Merchant.
A second identifier of your own for the Store, unique across the Merchant.
address objectnullable
The postal address of the Store.
The street name.
Possible values: <= 100 characters
The street number.
Possible values: <= 20 characters
The city.
Possible values: <= 100 characters
The two-letter province code.
Possible values: >= 2 characters and <= 2 characters
The postal code.
Possible values: >= 5 characters and <= 20 characters
The country.
Possible values: <= 100 characters
Whether the Store is operational.
The ID of the PaymentGatewayConfiguration used by this Store. When null, the Merchant default configuration applies.
pgc_01kg2gestgepdbmsn7hs6bsrwpWhether the Store accepts e-commerce orders.
Whether the Store accepts e-commerce orders for delivery.
Whether the Store accepts e-commerce orders for pickup.
Whether the Store accepts e-commerce reservations.
status objectnullable
The current health of the Store POS connection. Returned only when status is requested through the include parameter, and only for active Stores that have pos configured.
The current health of the Store.
Possible values: [Up, Degraded, Down]
The UTC timestamp when the Store entered the current status.
The UTC timestamp of the most recent health check.
The UTC timestamp of the most recent successful health check.
The number of consecutive failed health checks.
The number of consecutive successful health checks.
The response time of the most recent health check, in milliseconds.
The UTC timestamp when the Store was created.
{
"id": "sto_01kg2gestgepdbmsn7hs6bsrwp",
"conceptStoreId": "conce_01kg2gestgepdbmsn7hs6bsrwp",
"conceptStoreName": "string",
"storeAreaId": "starea_01kg2gestgepdbmsn7hs6bsrwp",
"storeAreaName": "string",
"name": "string",
"slug": "string",
"pos": {
"posId": "string",
"posEndpoint": "string"
},
"externalId1": "string",
"externalId2": "string",
"address": {
"streetName": "string",
"streetNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string",
"country": "string"
},
"isActive": true,
"paymentGatewayConfigurationId": "pgc_01kg2gestgepdbmsn7hs6bsrwp",
"ecommerceIsActive": true,
"ecommerceDeliveryIsActive": true,
"ecommercePickupIsActive": true,
"ecommerceReservationIsActive": true,
"status": {
"status": "Up",
"currentStatusFromUtc": "2024-07-29T15:51:28.071Z",
"lastCheckedAtUtc": "2024-07-29T15:51:28.071Z",
"lastSuccessAtUtc": "2024-07-29T15:51:28.071Z",
"consecutiveKos": 0,
"consecutiveOks": 0,
"lastResponseTimeMs": 0
},
"createdOnUtc": "2024-07-29T15:51:28.071Z"
}