Download OpenAPI specification:Download
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
| businessUnitGroupId required | string Example: store-42 The ID of the store or business unit group |
| application | string Enum: "ERPOS" "CHECKOUT_ENGINE" "EDGE_CHECKOUT_ENGINE" "EXTERNAL_SYSTEM" 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. |
| externalSystemVendor | string [ 1 .. 60 ] characters Example: externalSystemVendor=/initialstate/store-1?application=EXTERNAL_SYSTEM&externalSystemVendor=PRICER The vendor ID for the external system. Currently, these values are supported: PRICER, EWQ, BIZERBA, DIGI, LTG, HDB |
| 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,
|
| Correlation-Id | string [ 1 .. 255 ] characters Example: f6261f22-fbf0-4c1c-88cd-619d2e8abf84 Provide a Correlation-Id to track the request and to be able to query the status endpoint with a known value. |
| 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 |
{- "Tenant-Id": "CI47AFC674711",
- "Correlation-Id": "ed9f25a2-d7b1-4d90-a6f0-9e32fc56aa81",
- "businessUnitGroupId": "store-42",
- "progress": "DONE",
- "contributors": [
- {
- "apiProcessor": "items",
- "status": "OK",
- "missingDependencies": [
- {
- "entityIds": "[\"4711\", \"4712\"]",
- "entityType": "price-specifications"
}
]
}
]
}Returns the status of an initial state run that is finished or in progress.
| correlationId required | string The Id of an Initial state run |
{- "Tenant-Id": "CI47AFC674711",
- "Correlation-Id": "ed9f25a2-d7b1-4d90-a6f0-9e32fc56aa81",
- "businessUnitGroupId": "store-42",
- "progress": "DONE",
- "contributors": [
- {
- "apiProcessor": "items",
- "status": "OK",
- "missingDependencies": [
- {
- "entityIds": "[\"4711\", \"4712\"]",
- "entityType": "price-specifications"
}
]
}
]
}Trigger refresh for a list of Image URL
| businessUnitGroupId required | string Example: SWE4711 The destination of the messages |
An image url
