API docs by Redocly

Store Data Resolver API (0.1.0)

Download OpenAPI specification:Download

Initial State

initialstate Deprecated

Request for initial state data for the specified store. It will request initial state from all services and send out the data. The normal flow is to delete all data and then re-add all the data collected from the API:s

Note: some of the subset entities does not do delete before adding data due to deep dependency contrains that would require a delete of many more entities. These subset can be seen as an update when you and update or add but NOT remove entities. The subset that do not do delete: item-categories, tax-groups and plulists

path Parameters
businessUnitGroupId
required
string
Example: store-42

The ID of the store or business unit group

query Parameters
application
string
Enum: "ERPOS" "CHECKOUT_ENGINE" "EDGE_CHECKOUT_ENGINE"
Example: application=/initialstate/{businessUnitGroupId}?application=ERPOS

The application that is requesting the initial state. If only one application is configured for the store, that application will be the default if this parameter is omitted. If several applications are configured for the store and this parameter is omitted, the response will be 400, Bad Request since the application cannot be determined.

subset
string
Enum: "cashier-messages" "currencies" "items" "refresh-items" "item-categories" "massload-start-end" "non-items" "tax-groups" "tenders" "plulists" "promotions" "reason-codes"
Example: subset=/initialstate/{businessUnitGroupId}?subset=currencies

The subset of entities to include in the Initial state, all if left out. You may only provide one subset entity (multiple not allowed) Some subset contain multiple entities due to dependency and those are,

  • currencies - currencies, exchange rates and tenders.
  • items - item categories, items, price specifications, PLU lists
  • refresh-items - items, price specifications (no delete)
  • non-items - receipt layouts, cashier messages, currencies, exchange rates, reason codes, roles, operators, tax groups, tenders, item categories.
header Parameters
Tenant-Id
string
Example: CI47AFC674711

Provide the Tenant-Id if it is not in the JWT (e.g. Workload Identity)

X-Proto-Version
string
Example: 1.0.0

The version of the schema

Responses

Response samples

Content type
application/json
{
  • "Tenant-Id": "CI47AFC674711",
  • "Correlation-Id": "ed9f25a2-d7b1-4d90-a6f0-9e32fc56aa81",
  • "businessUnitGroupId": "store-42",
  • "contributors": [
    ]
}

Delete operator

operator-delete

Request for deletion of an operator.

path Parameters
operatorId
required
string
Example: operator-1

The ID of the operator

query Parameters
businessUnitGroupId
required
string
Example: businessUnitGroupId=store-42

The ID of the store

header Parameters
Tenant-Id
string
Example: CI47AFC674711

Provide the Tenant-Id if it is not in the JWT (e.g. Workload Identity)

X-Proto-Version
string
Example: 1.0.0

The version of the schema

Responses

PubSub Endpoint

storedata-post

Incoming data to the stores

Request Body schema: application/json
required
object
subscription
required
string

Responses

Request samples

Content type
application/json
{
  • "message": {
    },
  • "subscription": "string"
}

Internal

storedata-get

Store Data internal endpoint for fetch all data that is ready for a businessUnitGroup

path Parameters
businessUnitGroupId
required
string
Example: SWE4711

The destination of the messages

query Parameters
application
string
Enum: "ERPOS" "CHECKOUT_ENGINE" "EDGE_CHECKOUT_ENGINE"
Example: application=ERPOS

The application that is requesting the data. If only one application is configured for the store, that application will be the default if this parameter is omitted. If several applications are configured for the store and this parameter is omitted, the response will be 400, Bad Request since the application cannot be determined.

header Parameters
Tenant-Id
required
string
Example: CIR1918IK6755

The customer that owns the data

X-Proto-Version
string
Example: 1.0.0

Version of the protobuf schema

Responses

Response samples

Content type
application/json
[
  • {
    }
]

correlations-post

Acknowledgments for sent messages

query Parameters
application
string
Enum: "ERPOS" "CHECKOUT_ENGINE" "EDGE_CHECKOUT_ENGINE"
Example: application=ERPOS

The application that is requesting the data. If only one application is configured for the store, that application will be the default if this parameter is omitted. If several applications are configured for the store and this parameter is omitted, the response will be 400, Bad Request since the application cannot be determined.

businessUnitGroupId
string
Example: businessUnitGroupId=store-42

The ID of the Business Unit Group

header Parameters
Tenant-Id
required
string

The customer that owns the data

Request Body schema: application/json
Array
action
required
string
Enum: "ok" "retry" "error" "fatal"

The action of the acknowledgemnt

businessUnitGroupId
required
string

The business unit group of the message to acknowledge

Correlation-Id
required
string

The correlation id of the message to acknowledge

Correlation-Sequence
required
string

The correlation sequence of the message to acknowledge

error-message
string

The message describing the error

error-trace
string

The trace information that identifies where the error occurs

Message-Type
string

The type of the message

origin
string
Enum: "CONNECTOR" "APPLICATION" "UNKNOWN"

The origin of the acknowledgemnt

Responses

Request samples

Content type
application/json
[
  • "{\n \"Correlation-Id\": \"ed9f25a2-d7b1-4d90-a6f0-9e32fc56aa81\",\n \"Correlation-Sequence\": \"ff9f25a2-34b1-3490-a6f0-9e32fc567281\",\n \"businessUnitGroupId\": \"001\",\n \"origin\": \"APPLICATION\",\n \"action\": \"error\",\n \"Message-Type\": \"items\",\n \"error-message\": \"Could not persist message\",\n \"error-trace\": \"database.ConnectionException: Unable to connect to database\"\n}\n"
]

missingdependencies-post

Trigger missing dependencies job

header Parameters
Tenant-Id
required
string

The customer that owns the data

Responses

recoverstatus-get

Trigger Recover Status job

Responses

health

Provides health information about the service

Responses

Response samples

Content type
application/json
"{\n \"dependencies\": [\n {\n \"id\": \"Google Datastore\",\n \"status\": \"Up\"\n },\n {\n \"id\": \"Store Data Connector\",\n \"status\": \"Up\"\n }\n ],\n \"outcome\": \"Up\"\n}\n"

Temporary

temp-missingdependencies-get

Fetch missing dependencies for tenant, temporary endpoint

query Parameters
fromDate
string
Example: fromDate=2007-12-03T10:15:30.00Z

The date to start searching dependencies from. The string must represent a valid instant in UTC and is parsed using ISO-8601

Responses

Response samples

Content type
application/json
[
  • {
    }
]

temp-failedmessages-get

Query failed messages for the tenant, temporary endpoint. Max number of results is limited to 1000.

path Parameters
businessUnitGroupId
required
string
Example: SWE4711

The destination of the messages

query Parameters
application
required
string
Enum: "ERPOS" "CHECKOUT_ENGINE" "EDGE_CHECKOUT_ENGINE"
Example: application=ERPOS

The application that is requesting the data. If only one application is configured for the store, that application will be the default if this parameter is omitted. If several applications are configured for the store and this parameter is omitted, the response will be 400, Bad Request since the application cannot be determined.

correlationId
string
Example: correlationId=ed9f25a2-d7b1-4d90-a6f0-9e32fc56aa81

The correlation id of the message

date
string
Example: date=2022-02-23

Search for a specific date. If not provided current date is used

initialState
required
boolean
Example: initialState=true

Search for initial state massages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]