Skip to main content
API docs by Redocly

Future Ordering API

Download OpenAPI specification:Download

URL: https://developer.futureordering.com

Orders

Get order events

Get order events

header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"

Responses

Register Order

Registers an order in the Future Ordering system that has already been placed in a POS system.

header Parameters
Content-Type
required
string
Default: application/json
Value: "application/json"
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"
Request-Id
string
Request Body schema: application/json
storeId
required
string
orderTypeId
required
string
required
object (Order_SalesChannelExternal)
cultureCode
required
string
currencyIsoCode
required
string
required
object (Order_RegisterOrderItem)
required
object (Order_OrderPosData)
required
object (Order_CollectionDetailsTableService)
userId
required
string
object (Order_Extension)
desiredReadyTime
string <date-time>
Array of objects or null (Order_Discount)

Discounts for this order

isAlreadyPaid
required
string

If set to false then payments must be included in RegisterOrderRequest

merchantId
required
string
Array of objects or null (Order_RegisterOrderPayment)

If isAlreadyPaid = false then this is required

Responses

Request samples

Content type
application/json
{
  • "storeId": "string",
  • "orderTypeId": "string",
  • "salesChannel": {
    },
  • "cultureCode": "string",
  • "currencyIsoCode": "string",
  • "products": {
    },
  • "posData": {
    },
  • "collectionDetails": {
    },
  • "userId": "string",
  • "extensions": {
    },
  • "desiredReadyTime": "2019-08-24T14:15:22Z",
  • "discounts": [
    ],
  • "isAlreadyPaid": "string",
  • "merchantId": "string",
  • "payments": [
    ]
}

Response samples

Content type
application/json
{
  • "orderId": "123"
}

Get order with order-id

Returns the Order identified by passing the order-id in the url.

path Parameters
order-id
required
string

Used to identify which order to fetch.

header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "orderTypeId": "takeAway",
  • "salesChannel": {
    },
  • "collectionDetails": {
    },
  • "userId": "79130413-1862-447b-91ca-3d8e8908d268",
  • "payments": [ ],
  • "items": [
    ],
  • "discounts": [
    ],
  • "currencyIsoCode": "SEK",
  • "currencyDecimalDigits": 2,
  • "mainEventsHistory": [
    ],
  • "storeDetails": {
    },
  • "readyTime": {
    },
  • "versionId": "3",
  • "orderId": "AsAVUEr28xh",
  • "storeId": "335",
  • "createDate": "2024-06-05T07:43:04+00:00",
  • "orderRefsDict": { },
  • "lastModified": "2024-06-05T07:45:02+00:00",
  • "links": { },
  • "cultureCode": "sv-SE",
  • "discountTotal": -100,
  • "total": 8100,
  • "subtotal": 7232
}

Order abort

Order abort

path Parameters
order-id
required
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"
Request Body schema: application/json
code
string
message
string
object
object

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "data": {
    },
  • "innerError": {
    }
}

Response samples

Content type
application/json
{
  • "versionId": "string",
  • "orderId": "string",
  • "storeId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "orderRefsDict": {
    },
  • "lastModified": "string",
  • "desiredReadyTime": "2019-08-24T14:15:22Z",
  • "orderTypeId": "string",
  • "salesChannel": {
    },
  • "collectionDetails": {
    },
  • "cultureCode": "string",
  • "userId": "string",
  • "payments": [
    ],
  • "products": [
    ],
  • "items": [
    ],
  • "posData": {
    },
  • "readyTime": {
    },
  • "storeDetails": {
    },
  • "extensions": {
    },
  • "discounts": [
    ],
  • "currencyIsoCode": "string",
  • "currencyDecimalDigits": 0,
  • "mainEventsHistory": [
    ]
}

Cancel by customer disallow

Set cancel by customer to disallow - i.e. no longer possible for customer to cancel the order

path Parameters
order-id
required
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "versionId": "string",
  • "orderId": "string",
  • "storeId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "orderRefsDict": {
    },
  • "lastModified": "string",
  • "desiredReadyTime": "2019-08-24T14:15:22Z",
  • "orderTypeId": "string",
  • "salesChannel": {
    },
  • "collectionDetails": {
    },
  • "cultureCode": "string",
  • "userId": "string",
  • "payments": [
    ],
  • "products": [
    ],
  • "items": [
    ],
  • "posData": {
    },
  • "readyTime": {
    },
  • "storeDetails": {
    },
  • "extensions": {
    },
  • "discounts": [
    ],
  • "currencyIsoCode": "string",
  • "currencyDecimalDigits": 0,
  • "mainEventsHistory": [
    ]
}

Set Collection Details

Set collection details on order

path Parameters
order-id
required
header Parameters
Content-Type
Value: ""
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"
Request Body schema: application/json
object
type
string
pincode
string

Responses

Request samples

Content type
application/json
{
  • "collectionDetails": {
    }
}

Order failure

Order failure

path Parameters
order-id
required
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"
Request Body schema: application/json
code
string
message
string
object
object

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "data": {
    },
  • "innerError": {
    }
}

Response samples

Content type
application/json
{
  • "versionId": "string",
  • "orderId": "string",
  • "storeId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "orderRefsDict": {
    },
  • "lastModified": "string",
  • "desiredReadyTime": "2019-08-24T14:15:22Z",
  • "orderTypeId": "string",
  • "salesChannel": {
    },
  • "collectionDetails": {
    },
  • "cultureCode": "string",
  • "userId": "string",
  • "payments": [
    ],
  • "products": [
    ],
  • "items": [
    ],
  • "posData": {
    },
  • "readyTime": {
    },
  • "storeDetails": {
    },
  • "extensions": {
    },
  • "discounts": [
    ],
  • "currencyIsoCode": "string",
  • "currencyDecimalDigits": 0,
  • "mainEventsHistory": [
    ]
}

Send order confirmation

path Parameters
order-id
required
header Parameters
Authorization
required
Default:
Value: ""
X-Api-Version
required
Default:
Value: ""
Content-Type
Value: ""
Request Body schema: application/json
any (EmailRequest)

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Abort Payment session

Abort a payment session

path Parameters
order-id
required
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "versionId": "string",
  • "orderId": "string",
  • "storeId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "orderRefsDict": {
    },
  • "lastModified": "string",
  • "desiredReadyTime": "2019-08-24T14:15:22Z",
  • "orderTypeId": "string",
  • "salesChannel": {
    },
  • "collectionDetails": {
    },
  • "cultureCode": "string",
  • "userId": "string",
  • "payments": [
    ],
  • "products": [
    ],
  • "items": [
    ],
  • "posData": {
    },
  • "readyTime": {
    },
  • "storeDetails": {
    },
  • "extensions": {
    },
  • "discounts": [
    ],
  • "currencyIsoCode": "string",
  • "currencyDecimalDigits": 0,
  • "mainEventsHistory": [
    ]
}

Start Payment session

Start a payment session

path Parameters
order-id
required
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"
Request Body schema: application/json
paymentSessionId
string

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "versionId": "string",
  • "orderId": "string",
  • "storeId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "orderRefsDict": {
    },
  • "lastModified": "string",
  • "desiredReadyTime": "2019-08-24T14:15:22Z",
  • "orderTypeId": "string",
  • "salesChannel": {
    },
  • "collectionDetails": {
    },
  • "cultureCode": "string",
  • "userId": "string",
  • "payments": [
    ],
  • "products": [
    ],
  • "items": [
    ],
  • "posData": {
    },
  • "readyTime": {
    },
  • "storeDetails": {
    },
  • "extensions": {
    },
  • "discounts": [
    ],
  • "currencyIsoCode": "string",
  • "currencyDecimalDigits": 0,
  • "mainEventsHistory": [
    ]
}

Start Place Order session

Start a payment session

path Parameters
order-id
required
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"
Request Body schema: application/json
Schema not provided

Responses

Response samples

Content type
application/json
{
  • "versionId": "string",
  • "orderId": "string",
  • "storeId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "orderRefsDict": {
    },
  • "lastModified": "string",
  • "desiredReadyTime": "2019-08-24T14:15:22Z",
  • "orderTypeId": "string",
  • "salesChannel": {
    },
  • "collectionDetails": {
    },
  • "cultureCode": "string",
  • "userId": "string",
  • "payments": [
    ],
  • "products": [
    ],
  • "items": [
    ],
  • "posData": {
    },
  • "readyTime": {
    },
  • "storeDetails": {
    },
  • "extensions": {
    },
  • "discounts": [
    ],
  • "currencyIsoCode": "string",
  • "currencyDecimalDigits": 0,
  • "mainEventsHistory": [
    ]
}

Get pdf for order-id

path Parameters
order-id
required
header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
X-Api-Version
required
string
Default: 0
Value: "0"

Responses

Cancled Order In Pos

Canceled Order In Pos

path Parameters
order-id
required
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "versionId": "string",
  • "orderId": "string",
  • "storeId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "orderRefsDict": {
    },
  • "lastModified": "string",
  • "desiredReadyTime": "2019-08-24T14:15:22Z",
  • "orderTypeId": "string",
  • "salesChannel": {
    },
  • "collectionDetails": {
    },
  • "cultureCode": "string",
  • "userId": "string",
  • "payments": [
    ],
  • "products": [
    ],
  • "items": [
    ],
  • "posData": {
    },
  • "readyTime": {
    },
  • "storeDetails": {
    },
  • "extensions": {
    },
  • "discounts": [
    ],
  • "currencyIsoCode": "string",
  • "currencyDecimalDigits": 0,
  • "mainEventsHistory": [
    ]
}

Canceled Order In Pos Failed

Canceled Order In Pos Failed

path Parameters
order-id
required
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"
Request Body schema: application/json
code
string
message
string
object
object

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "data": {
    },
  • "innerError": {
    }
}

Response samples

Content type
application/json
{
  • "versionId": "string",
  • "orderId": "string",
  • "storeId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "orderRefsDict": {
    },
  • "lastModified": "string",
  • "desiredReadyTime": "2019-08-24T14:15:22Z",
  • "orderTypeId": "string",
  • "salesChannel": {
    },
  • "collectionDetails": {
    },
  • "cultureCode": "string",
  • "userId": "string",
  • "payments": [
    ],
  • "products": [
    ],
  • "items": [
    ],
  • "posData": {
    },
  • "readyTime": {
    },
  • "storeDetails": {
    },
  • "extensions": {
    },
  • "discounts": [
    ],
  • "currencyIsoCode": "string",
  • "currencyDecimalDigits": 0,
  • "mainEventsHistory": [
    ]
}

Update Estimated Ready Time

Update Estimated Ready Time

path Parameters
order-id
required
header Parameters
Content-Type
Value: ""
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"

Responses

Place Order In Pos Failed

Place Order In Pos Failed

path Parameters
order-id
required
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"
Request Body schema: application/json
code
string
message
string
object
object

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "data": {
    },
  • "innerError": {
    }
}

Response samples

Content type
application/json
{
  • "versionId": "string",
  • "orderId": "string",
  • "storeId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "orderRefsDict": {
    },
  • "lastModified": "string",
  • "desiredReadyTime": "2019-08-24T14:15:22Z",
  • "orderTypeId": "string",
  • "salesChannel": {
    },
  • "collectionDetails": {
    },
  • "cultureCode": "string",
  • "userId": "string",
  • "payments": [
    ],
  • "products": [
    ],
  • "items": [
    ],
  • "posData": {
    },
  • "readyTime": {
    },
  • "storeDetails": {
    },
  • "extensions": {
    },
  • "discounts": [
    ],
  • "currencyIsoCode": "string",
  • "currencyDecimalDigits": 0,
  • "mainEventsHistory": [
    ]
}

Place Order In Pos

Place Order In Pos

path Parameters
order-id
required
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"
Request Body schema: application/json
orderName
string
estimatedReadyTime
string
datePlaced
string
cancelableUntil
string
object
object

Responses

Request samples

Content type
application/json
{
  • "orderName": "string",
  • "estimatedReadyTime": "string",
  • "datePlaced": "string",
  • "cancelableUntil": "string",
  • "orderRefsDict": {
    },
  • "extensions": {
    }
}

Response samples

Content type
application/json
{
  • "versionId": "string",
  • "orderId": "string",
  • "storeId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "orderRefsDict": {
    },
  • "lastModified": "string",
  • "desiredReadyTime": "2019-08-24T14:15:22Z",
  • "orderTypeId": "string",
  • "salesChannel": {
    },
  • "collectionDetails": {
    },
  • "cultureCode": "string",
  • "userId": "string",
  • "payments": [
    ],
  • "products": [
    ],
  • "items": [
    ],
  • "posData": {
    },
  • "readyTime": {
    },
  • "storeDetails": {
    },
  • "extensions": {
    },
  • "discounts": [
    ],
  • "currencyIsoCode": "string",
  • "currencyDecimalDigits": 0,
  • "mainEventsHistory": [
    ]
}

Get receipt for order-id

path Parameters
order-id
required
header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
X-Api-Version
required
string
Default: 0
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "orderId": "string",
  • "userId": "string",
  • "payments": [
    ],
  • "lines": [
    ],
  • "itemsTotal": {
    },
  • "discountsTotal": {
    },
  • "total": {
    },
  • "store": {
    },
  • "posData": {
    },
  • "collectionDetails": {
    },
  • "orderTypeId": "string",
  • "currencyDecimalDigits": 0,
  • "currencyIsoCode": "string",
  • "cultureCode": "string",
  • "readyTime": {
    },
  • "deliveryDropOffTime": {
    },
  • "posCancellationData": {
    },
  • "recipientPd": {
    }
}

Set an order priority

Set an order priority of the order

path Parameters
order-id
required
header Parameters
Authorization
required
string
Value: "Bearer"

Token used for authentication.

X-Api-Version
required
string
Value: "0"
Request Body schema: application/json
orderPriority
string

Responses

Request samples

Content type
application/json
{
  • "orderPriority": "string"
}

Response samples

Content type
application/json
{
  • "versionId": "string",
  • "orderId": "string",
  • "storeId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "orderRefsDict": {
    },
  • "lastModified": "string",
  • "desiredReadyTime": "2019-08-24T14:15:22Z",
  • "orderTypeId": "string",
  • "salesChannel": {
    },
  • "collectionDetails": {
    },
  • "cultureCode": "string",
  • "userId": "string",
  • "payments": [
    ],
  • "products": [
    ],
  • "items": [
    ],
  • "posData": {
    },
  • "readyTime": {
    },
  • "storeDetails": {
    },
  • "extensions": {
    },
  • "discounts": [
    ],
  • "currencyIsoCode": "string",
  • "currencyDecimalDigits": 0,
  • "mainEventsHistory": [
    ]
}

Get order with order and version id

Returns the Order identified by passing the order-id and version in the url.

path Parameters
order-id
required
version-id
required
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "orderTypeId": "takeAway",
  • "salesChannel": {
    },
  • "collectionDetails": {
    },
  • "userId": "79130413-1862-447b-91ca-3d8e8908d268",
  • "payments": [ ],
  • "items": [
    ],
  • "discounts": [
    ],
  • "currencyIsoCode": "SEK",
  • "currencyDecimalDigits": 2,
  • "mainEventsHistory": [
    ],
  • "storeDetails": {
    },
  • "readyTime": {
    },
  • "versionId": "3",
  • "orderId": "AsAVUEr28xh",
  • "storeId": "335",
  • "createDate": "2024-06-05T07:43:04+00:00",
  • "orderRefsDict": { },
  • "lastModified": "2024-06-05T07:45:02+00:00",
  • "links": { },
  • "cultureCode": "sv-SE",
  • "discountTotal": -100,
  • "total": 8100,
  • "subtotal": 7232
}

Deals

Creates a deal for order

Creates a deal for order

path Parameters
order-id
required
string
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"
Request Body schema: application/json
visibility
string (Order_DealVisibility)
Enum: "notShown" "showAsOwnLine"

Describes how the deal should be shown in UI

orderVersionId
string

Describes for which version of the order this deal is created for

object (Order_Title)
object (Order_Description)
name
string

Name of the deal

code
string

A discount code that deal is connected to

key
string

Key of the deal that implies who is responsible for the deal

Array of objects (Order_Discount)

All discounts connected to this deal

object or null

Reference to an image of the deal, will be shown in frontend

Responses

Request samples

Content type
application/json
{
  • "visibility": "notShown",
  • "orderVersionId": "string",
  • "title": {
    },
  • "description": {
    },
  • "name": "string",
  • "key": "string",
  • "code": "string",
  • "discounts": [
    ],
  • "images": { }
}

Response samples

Content type
application/json
{
  • "statusCode": "successful",
  • "dealId": "2e91e25e-404f-4881-9d8a-9fffd4799446",
  • "message": "Deal Created!",
  • "innerCode": "2e91e25e-404f-4881-9d8a-9fffd4799446",
  • "successful": true,
  • "outerCode": 200
}

Fetches all reserved deals filtered by query parameters

Fetches all reserved deals filtered by query parameters

path Parameters
order-id
required
string
query Parameters
key
string

Filter deals only for a specific key

header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "deals": [
    ]
}

Update deals for order

Update deals for order

path Parameters
order-id
required
string
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"
Request Body schema: application/merge-patch+json
additional property
object (Order_OrderDealPatchRequest)
code
string or null

A discount code that deal is connected to

Array of objects or null (Order_Discount)

Discounts to apply for this deal

isReserved
boolean or null

Describes that the action reserve will be perfomred

isFulfilled
boolean or null

Describes that the action fulfilled will be performed

isCaptured
boolean or null

Describes that the action capture will be perfomred

isAnnulled
boolean or null

Describes that the action annulled will be perfomred

object (Order_Title)
object (Order_Description)
name
string or null

Internal name

key
string or null

A key that implies who is responsible for the deal

object or null
orderVersionId
string or null

Describes for which version of the order this deal is valid for.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "a99c0700-c88a-4203-a57d-bfe8b77f137f": {
    }
}

Response samples

Content type
application/json
{
  • "statusCode": "successful",
  • "message": "Patched",
  • "innerCode": null,
  • "successful": true,
  • "outerCode": 200
}

Fetch a deal for order

Fetch a deal for order

path Parameters
order-id
required
string
deal-id
required
string
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "dealId": "string",
  • "title": {
    },
  • "description": {
    },
  • "name": "string",
  • "key": "string",
  • "images": { },
  • "orderVersionId": "string",
  • "createDate": "string",
  • "visibility": "notShown",
  • "id": "string",
  • "code": "string",
  • "discounts": [
    ],
  • "orderId": "string",
  • "status": "created",
  • "isReserved": true,
  • "isFulfilled": true,
  • "isCaptured": true,
  • "isAnnulled": true,
  • "isRefunded": true
}

Update deal for order

Update deal for order

path Parameters
order-id
required
string
deal-id
required
string
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"
Request Body schema: application/merge-patch+json
code
string

A discount code that deal is connected to

Array of objects

Discounts to apply for this deal

isReserved
boolean

Describes that the action reserve will be perfomred

isFulfilled
boolean

Describes that the action fulfilled will be performed

isCaptured
boolean

Describes that the action capture will be perfomred

isAnnulled
boolean

Describes that the action annulled will be perfomred

object
object
name
string

Internal name

key
string

A key that implies who is responsible for the deal

images
any
orderVersionId
string

Describes for which version of the order this deal is valid for.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "code": "my-gift-card",
  • "discounts": [
    ],
  • "isReserved": true,
  • "isFulfilled": true,
  • "isCaptured": false,
  • "isAnnulled": false,
  • "title": {
    },
  • "description": {
    },
  • "name": "display name",
  • "key": "key for integrating system",
  • "images": null,
  • "orderVersionId": "13"
}

Response samples

Content type
application/json
{
  • "statusCode": "successful",
  • "message": "Patched",
  • "innerCode": null,
  • "successful": true,
  • "outerCode": 200
}

Annul a deal for order

Annul a deal for order

path Parameters
order-id
required
string
deal-id
required
string
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "data": {
    },
  • "innerError": {
    },
  • "statusCode": "string",
  • "innerCode": "string",
  • "outerCode": 0
}

Capture a deal for order

Capture a deal for order

path Parameters
order-id
required
string
deal-id
required
string
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "data": {
    },
  • "innerError": {
    },
  • "statusCode": "string",
  • "innerCode": "string",
  • "outerCode": 0
}

Refund a deal for order

Refund a deal for order

path Parameters
order-id
required
string
deal-id
required
string
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "data": {
    },
  • "innerError": {
    },
  • "statusCode": "string",
  • "innerCode": "string",
  • "outerCode": 0
}

Reserve a deal for order

Reserve a deal for order

path Parameters
order-id
required
string
deal-id
required
string
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "data": {
    },
  • "innerError": {
    },
  • "statusCode": "string",
  • "innerCode": "string",
  • "outerCode": 0
}

Order Workflows

Order picklist set item checked/unchecked

Used to mark an item/product as prepared on an order. order-id = The Order id. picklist-item-id = The OrderItem id.

path Parameters
order-id
required
string

The Order id

pick-list-item-id
required
string

The picklist item id

query Parameters
prepared
required
bool
Enum: "true" "false"

true = item is prepared false = item is not prepared

header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"

Responses

Set Order status to Ready for pickup

Set an orders status to Ready for pickup.

path Parameters
order-id
required
string

The Order id

header Parameters
Content-Type
string
Value: "application/json"
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"

Responses

Get Workflow

Get Workflow

path Parameters
orderId
required
workflowId
required
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "storeId": "301",
  • "orderId": "asdadsads",
  • "state": {
    },
  • "completedSteps": [
    ],
  • "pendingSteps": [
    ]
}

Get Workflow

Get Workflow

path Parameters
orderId
required
workflowId
required
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "storeId": "301",
  • "orderId": "asdadsads",
  • "state": {
    },
  • "completedSteps": [
    ],
  • "pendingSteps": [
    ]
}

Complete Workflow Step

Complete Workflow Step

path Parameters
orderId
required
workflowId
required
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"
Request Body schema: application/json
steps
Array of strings

Responses

Request samples

Content type
application/json
{
  • "steps": [
    ]
}

Complete Workflow Step

Complete Workflow Step

path Parameters
orderId
required
workflowId
required
header Parameters
Authorization
required
string
Value: "Bearer "

Token used for authentication.

X-Api-Version
required
string
Value: "0"
Request Body schema: application/json
steps
Array of strings

Responses

Request samples

Content type
application/json
{
  • "steps": [
    ]
}

Business Rules

Create Rule

Creates a new rule. For more detailed usage instructions see Docs -> Rules

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "

JWT Bearer token used for authentication and authorization

X-Api-Version
required
string
Default: 0
Value: "0"

API version used to make requests.

Request Body schema: application/json
comment
required
string
object
object
object
object
type
required
string
id
string
executionIndex
required
integer

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "recommendations": {
    },
  • "filter": {
    },
  • "activeDuring": {
    },
  • "lastModified": {
    },
  • "type": "string",
  • "id": "string",
  • "executionIndex": 0
}

Get All Rules

Gets all the rules. For more detailed usage instructions see Docs -> Rules

header Parameters
X-Api-Version
required
string
Default: 0
Value: "0"

Api version

Authorization
required
string
Default: Bearer
Value: "Bearer "

JWT Bearer token used for authentication and authorization

Responses

Response samples

Content type
application/json
{
  • "rules": [
    ]
}

Delete Rule

For more detailed usage instructions see Docs -> Rules

path Parameters
rule-id
required
string
Default: "6925af11-9396-489d-a6f0-7e09733d9731"
Value: "6925af11-9396-489d-a6f0-7e09733d9731"
header Parameters
X-Api-Version
required
string
Default: 0
Value: "0"
Authorization
required
string
Default: Bearer
Value: "Bearer "

Responses

Get Rule

Used to fetch the associated information contained by a rule object. For more detailed usage instructions see Docs -> Rules

path Parameters
rule-id
required
string

The rule id is an autogenerated GUID

header Parameters
X-Api-Version
required
string
Default: 0
Value: "0"
Authorization
required
string
Default: Bearer
Value: "Bearer "

Responses

Response samples

Content type
application/json
{
  • "comment": "string",
  • "created": {
    },
  • "recommendations": {
    },
  • "filter": {
    },
  • "activeDuring": {
    },
  • "lastModified": {
    },
  • "type": "string",
  • "id": "string",
  • "executionIndex": 0
}

Update Rule

Used to update the associated information contained by an existing rule object. For more detailed usage instructions see Docs -> Rules

path Parameters
rule-id
required
string

The rule id is an autogenerated GUID

header Parameters
X-Api-Version
required
string
Default: 0
Value: "0"

API version used to make requests.

Authorization
required
string
Default: Bearer
Value: "Bearer "

JWT Bearer token used for authentication and authorization

Request Body schema: application/json
comment
required
string
object
object
object
object
type
required
string
id
string
executionIndex
required
integer

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "created": {
    },
  • "recommendations": {
    },
  • "filter": {
    },
  • "activeDuring": {
    },
  • "lastModified": {
    },
  • "type": "string",
  • "id": "string",
  • "executionIndex": 0
}

Entities

Create new config item

Create new config item

path Parameters
entity
required
string
Request Body schema: application/json

Config input model. Id and references

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "extensionReferences": [
    ]
}

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "internalVersion": 0,
  • "type": "string",
  • "deleted": true,
  • "extensionReferences": [
    ],
  • "dataExtensions": [
    ],
  • "relatedDataTypes": [
    ],
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

Get config for current tenant

Get config for current tenant

path Parameters
entity
required
string
query Parameters
include_deleted
boolean
Default: false

Whether deleted items should be included or not

Responses

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "internalVersion": 0,
  • "type": "string",
  • "deleted": true,
  • "extensionReferences": [
    ],
  • "dataExtensions": [
    ],
  • "relatedDataTypes": [
    ],
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

Update a config item

Update a config item

path Parameters
entity
required
string
Request Body schema: application/json

Config input model. Id and references

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "extensionReferences": [
    ]
}

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "internalVersion": 0,
  • "type": "string",
  • "deleted": true,
  • "extensionReferences": [
    ],
  • "dataExtensions": [
    ],
  • "relatedDataTypes": [
    ],
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

"WhatIf"-Create new config item. Nothing is saved, just a dry-run

"WhatIf"-Create new config item. Nothing is saved, just a dry-run

path Parameters
entity
required
string
Request Body schema: application/json

Config input model. Id and references

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "extensionReferences": [
    ]
}

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "internalVersion": 0,
  • "type": "string",
  • "deleted": true,
  • "extensionReferences": [
    ],
  • "dataExtensions": [
    ],
  • "relatedDataTypes": [
    ],
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

"WhatIf"-Update a config item. Nothing is saved, just a dry-run

"WhatIf"-Update a config item. Nothing is saved, just a dry-run

path Parameters
entity
required
string
Request Body schema: application/json

Config input model. Id and references

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "extensionReferences": [
    ]
}

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "internalVersion": 0,
  • "type": "string",
  • "deleted": true,
  • "extensionReferences": [
    ],
  • "dataExtensions": [
    ],
  • "relatedDataTypes": [
    ],
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

Get a list of previous versions

Get a list of previous versions

path Parameters
entity
required
string
query Parameters
take
integer <int32>
Default: 1

Format - int32. How many versions to get. Default: 1

include_deleted
boolean
Default: false

Whether deleted items should be included or not

include_datatypes
boolean
Default: false

Whether to include info about DataTypes or not

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get specific version of tenant config

Get specific version of tenant config

path Parameters
entity
required
string
version
required
integer <int32>

Format - int32. What version to get

Responses

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "internalVersion": 0,
  • "type": "string",
  • "deleted": true,
  • "extensionReferences": [
    ],
  • "dataExtensions": [
    ],
  • "relatedDataTypes": [
    ],
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

Create new connections for specified object

Create new connections for specified object

path Parameters
entity
required
string
Request Body schema: application/json

Body with info about how new connection should look like

id
string or null
entityType
string
Enum: "Type" "Extension" "Config" "Schema" "Value" "Reference"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "entityType": "Type"
}

Response samples

Content type
application/json
{
  • "entityType": "Type",
  • "publisher": "string",
  • "id": "string",
  • "lastUpdateDate": { }
}

Get list of `Type`:s (`entity_type`) connected to a certain id (`entity_id`)

Get list of Type:s (entity_type) connected to a certain id (entity_id)

path Parameters
entity
required
string
query Parameters
entity_id
string

Id to look for

entity_type
string
Enum: "Type" "Extension" "Config" "Schema" "Value" "Reference"

Type of connection. Valid values are: Type, Extension, Config, Schema, Value, Reference

created_at_offset
string <date-time>

Format - date-time (as date-time in RFC3339). Pagination parameter

limit
integer <int32>
Default: 20

Format - int32. Amount per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete connection for specified object

Delete connection for specified object

path Parameters
entity
required
string
id
required
string

id of object of interest

query Parameters
entity_type
string
Enum: "Type" "Extension" "Config" "Schema" "Value" "Reference"

Type of connection. Valid values are: Type, Extension, Config, Schema, Value, Reference

Responses

Response samples

Content type
application/json
{
  • "entityType": "Type",
  • "publisher": "string",
  • "id": "string",
  • "lastUpdateDate": { }
}

Get all connections to specified object

Get all connections to specified object

path Parameters
entity
required
string
id
required
string

id of object of interest

query Parameters
entity_type
string
Enum: "Type" "Extension" "Config" "Schema" "Value" "Reference"

Type of connection. Valid values are: Type, Extension, Config, Schema, Value, Reference

include_deleted
boolean
Default: false

Specify if deleted schema should be retrieved

Responses

Response samples

Content type
application/json
{
  • "entityType": "Type",
  • "publisher": "string",
  • "id": "string",
  • "lastUpdateDate": { }
}

Update connections for specified object

Update connections for specified object

path Parameters
entity
required
string
id
required
string

id of object of interest

Request Body schema: application/json

Body with info about how new connection should look like

id
string or null
entityType
string
Enum: "Type" "Extension" "Config" "Schema" "Value" "Reference"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "entityType": "Type"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "data": {
    },
  • "innerError": { }
}

Create new extension

Create new extension

path Parameters
entity
required
string
Request Body schema: application/json

Content of extension to create

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "availability": "Private",
  • "extensionReferences": { }
}

Response samples

Content type
application/json
{
  • "publisher": "string",
  • "id": "string",
  • "version": "string",
  • "internalVersion": 0,
  • "baseType": "Type",
  • "availability": "Private",
  • "deleted": true,
  • "extensionReferences": {
    },
  • "relatedDataTypes": [
    ],
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

List all extensions

List all extensions

path Parameters
entity
required
string
query Parameters
include_deleted
boolean
Default: false

Include deleted extensions

include_private
boolean
Default: false

Whether only published extensions should be included or not

created_at_offset
string <date-time>

Format - date-time (as date-time in RFC3339). Pagination property

complete
boolean
Default: false

Use complete model

limit
integer <int32>
Default: 20

Format - int32. Amount per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get specific extension

Get specific extension

path Parameters
entity
required
string
id
required
string

Id of extension

query Parameters
include_deleted
boolean
Default: false

Include deleted extensions

include_private
boolean
Default: false

Whether only published extensions should be included or not

Responses

Response samples

Content type
application/json
{
  • "publisher": "string",
  • "id": "string",
  • "version": "string",
  • "internalVersion": 0,
  • "baseType": "Type",
  • "availability": "Private",
  • "deleted": true,
  • "extensionReferences": {
    },
  • "relatedDataTypes": [
    ],
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

Mark extension as removed

Mark extension as removed

path Parameters
entity
required
string
id
required
string

Id of extension

Responses

Response samples

Content type
application/json
{
  • "publisher": "string",
  • "id": "string",
  • "version": "string",
  • "internalVersion": 0,
  • "baseType": "Type",
  • "availability": "Private",
  • "deleted": true,
  • "extensionReferences": {
    },
  • "relatedDataTypes": [
    ],
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

Update existing extension

Update existing extension

path Parameters
entity
required
string
id
required
string

Id of extension

query Parameters
include_deleted
boolean
Default: false

Include deleted extensions

Request Body schema: application/json

Content of extension to change to

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "availability": "Private",
  • "extensionReferences": { }
}

Response samples

Content type
application/json
{
  • "publisher": "string",
  • "id": "string",
  • "version": "string",
  • "internalVersion": 0,
  • "baseType": "Type",
  • "availability": "Private",
  • "deleted": true,
  • "extensionReferences": {
    },
  • "relatedDataTypes": [
    ],
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

Get a specific version of an extension where internalVersion is used instead (integer)

Get a specific version of an extension where internalVersion is used instead (integer)

path Parameters
entity
required
string
id
required
string

Id of extension

version
required
integer <int32>

Format - int32. Which particular version expected

query Parameters
include_deleted
boolean
Default: false

Include deleted extensions

include_datatypes
boolean
Default: false

Include relational extensions

include_private
boolean
Default: false

Whether only published extensions should be included or not

Responses

Response samples

Content type
application/json
{
  • "publisher": "string",
  • "id": "string",
  • "version": "string",
  • "internalVersion": 0,
  • "baseType": "Type",
  • "availability": "Private",
  • "deleted": true,
  • "extensionReferences": {
    },
  • "relatedDataTypes": [
    ],
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

GET a list[{take}] of Extensions with {id}

GET a list[{take}] of Extensions with {id}

path Parameters
entity
required
string
id
required
string

Id of extension

query Parameters
take
integer <int32>
Default: 1

Format - int32. Number of versions

include_deleted
boolean
Default: false

Include deleted extensions

include_datatypes
boolean
Default: false

Include relational extensions

include_private
boolean
Default: false

Whether only published extensions should be included or not

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a specific version of an extension

Get a specific version of an extension

path Parameters
entity
required
string
id
required
string

Id of extension

version
required
string

Which particular version expected

query Parameters
include_deleted
boolean
Default: false

Include deleted parameters

include_datatypes
boolean
Default: false

Include relational extensions

include_private
boolean
Default: false

Whether only published extensions should be included or not

Responses

Response samples

Content type
application/json
{
  • "publisher": "string",
  • "id": "string",
  • "version": "string",
  • "internalVersion": 0,
  • "baseType": "Type",
  • "availability": "Private",
  • "deleted": true,
  • "extensionReferences": {
    },
  • "relatedDataTypes": [
    ],
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

/health - GET

/health - GET

path Parameters
entity
required
string

Responses

Response samples

Content type
application/json
{
  • "version": "string",
  • "status": "string",
  • "duration": "string",
  • "entries": { }
}

Create new lock

Create new lock

path Parameters
entity
required
Request Body schema: application/json
id
string
paths
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "paths": [
    ]
}

Response samples

Content type
application/json
{
  • "publisher": "string",
  • "id": "string",
  • "paths": [
    ],
  • "deleted": true,
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

GET locks

GET locks

path Parameters
entity
required
query Parameters
limit
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DELETE a lock by id

DELETE a lock by id

path Parameters
entity
required
id
required
string

Responses

Response samples

Content type
application/json
{
  • "publisher": "string",
  • "id": "string",
  • "paths": [
    ],
  • "deleted": true,
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

GET lock by id

GET lock by id

path Parameters
entity
required
id
required

Responses

Response samples

Content type
application/json
{
  • "publisher": "string",
  • "id": "string",
  • "paths": [
    ],
  • "deleted": true,
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

Update a lock

Update a lock

path Parameters
entity
required
id
required
Request Body schema: application/json
id
string
paths
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "paths": [
    ]
}

Response samples

Content type
application/json
{
  • "publisher": "string",
  • "id": "string",
  • "paths": [
    ],
  • "deleted": true,
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

MultiTenant Config

Update a config item

path Parameters
entity
required
string
id
required
string
Request Body schema: application/json

Config input model. Id and references

objectType
string
tenantId
string
object

Responses

Request samples

Content type
application/json
{
  • "objectType": "store",
  • "tenantId": "tenantId",
  • "changes": [
    ]
}

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "internalVersion": 0,
  • "type": "string",
  • "deleted": true,
  • "extensionReferences": [
    ],
  • "dataExtensions": [
    ],
  • "relatedDataTypes": [
    ],
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

Create new reference

Create new reference

path Parameters
entity
required
string
query Parameters
id
string

reference-id to create custom-id for

customId
string

the custom id to use for this particular item

Responses

Response samples

Content type
application/json
{
  • "objectsId": "string",
  • "referenceId": "string",
  • "publisher": "string",
  • "id": "string",
  • "version": 0,
  • "parent": "string",
  • "deleted": true,
  • "createDate": { },
  • "lastUpdateBy": "string",
  • "lastUpdateDate": { },
  • "deleteDate": { }
}

Get reference from object-id

Get reference from object-id

path Parameters
entity
required
string
query Parameters
objects_id
string

specified object-id

include_deleted
boolean
Default: false

Whether to include deleted references or not

created_at_offset
string <date-time>

Format - date-time (as date-time in RFC3339). Page offset parameter

limit
integer <int32>
Default: 20

Format - int32. Amount per page

Responses

Response samples

Content type
application/json
{
  • "objectsId": "string",
  • "referenceId": "string",
  • "publisher": "string",
  • "id": "string",
  • "version": 0,
  • "parent": "string",
  • "deleted": true,
  • "createDate": { },
  • "lastUpdateBy": "string",
  • "lastUpdateDate": { },
  • "deleteDate": { }
}

Delete existing reference

Delete existing reference

path Parameters
entity
required
string
id
required
string

reference-id to delete custom-id for

query Parameters
customId
string

the custom id to use for this particular item

Responses

Response samples

Content type
application/json
{
  • "objectsId": "string",
  • "referenceId": "string",
  • "publisher": "string",
  • "id": "string",
  • "version": 0,
  • "parent": "string",
  • "deleted": true,
  • "createDate": { },
  • "lastUpdateBy": "string",
  • "lastUpdateDate": { },
  • "deleteDate": { }
}

Get the reference to actual object from specified custom-id

Get the reference to actual object from specified custom-id

path Parameters
entity
required
string
id
required
string

reference-id to find custom-id for

query Parameters
include_deleted
boolean
Default: false

Whether to include deleted references or not

Responses

Response samples

Content type
application/json
{
  • "objectsId": "string",
  • "referenceId": "string",
  • "publisher": "string",
  • "id": "string",
  • "version": 0,
  • "parent": "string",
  • "deleted": true,
  • "createDate": { },
  • "lastUpdateBy": "string",
  • "lastUpdateDate": { },
  • "deleteDate": { }
}

Update existing reference

Update existing reference

path Parameters
entity
required
string
id
required
string

reference-id to update custom-id for

query Parameters
customId
string

the custom id to use for this particular item

include_deleted
boolean
Default: false

Whether to include deleted references or not

Responses

Response samples

Content type
application/json
{
  • "objectsId": "string",
  • "referenceId": "string",
  • "publisher": "string",
  • "id": "string",
  • "version": 0,
  • "parent": "string",
  • "deleted": true,
  • "createDate": { },
  • "lastUpdateBy": "string",
  • "lastUpdateDate": { },
  • "deleteDate": { }
}

Get schema

Get schema

path Parameters
entity
required
string
query Parameters
date
string <date-time>

Format - date-time (as date-time in RFC3339). Specify point in time from which schema should be retrieved

include_deleted
boolean
Default: false

Specify if deleted schema should be retrieved

type
string

Specify type of schema to retrieve

Responses

Response samples

Content type
application/json
{
  • "internalVersion": 0,
  • "type": "string",
  • "deleted": true,
  • "properties": {
    },
  • "relatedDataTypes": [
    ],
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

GET a list of all DataTypes

GET a list of all DataTypes

path Parameters
entity
required
string
query Parameters
include_deleted
boolean
Default: false

Include deleted DataTypes

include_private
boolean
Default: false

Whether unpublished (private) types should be included. Default: false

created_at_offset
string <date-time>

Format - date-time (as date-time in RFC3339). Offset for pagination

complete
boolean
Default: false

Complete datatype model

limit
integer <int32>
Default: 20

Format - int32. Amount per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

POST a DataType

POST a DataType

path Parameters
entity
required
string
Request Body schema: application/json

The DataType to POST

One of
object (Entity_TypeReferenceInputModel)
min
integer or null <int32>
max
integer or null <int32>
id
string or null
version
string or null
availability
string
Enum: "Private" "Published" "Public"
baseType
string
Enum: "String" "Integer" "Boolean" "Float" "Reference" "Dictionary" "Struct" "Array" "Enum" "AnyOf"
(Entity_PropertiesExistsDiscriminator (object or null)) or (Entity_PropertyValueInDiscriminator (object or null)) or (Entity_ValueValidatesDiscriminator (object or null))

Responses

Request samples

Content type
application/json
{
  • "typeReference": {
    },
  • "min": 0,
  • "max": 0,
  • "id": "string",
  • "version": "string",
  • "availability": "Private",
  • "baseType": "String",
  • "discriminator": {
    }
}

Response samples

Content type
application/json
{
  • "publisher": "string",
  • "id": "string",
  • "version": "string",
  • "internalVersion": 0,
  • "baseType": "string",
  • "availability": "Private",
  • "deleted": true,
  • "min": { },
  • "max": { },
  • "regex": "string",
  • "typeReference": {
    },
  • "enums": [
    ],
  • "propertyReferences": {
    },
  • "references": [
    ],
  • "relatedDataTypes": [
    ],
  • "discriminator": {
    },
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

DELETE a DataType with {id}

DELETE a DataType with {id}

path Parameters
entity
required
string
id
required
string

Id of DataType

Responses

Response samples

Content type
application/json
{
  • "publisher": "string",
  • "id": "string",
  • "version": "string",
  • "internalVersion": 0,
  • "baseType": "string",
  • "availability": "Private",
  • "deleted": true,
  • "min": { },
  • "max": { },
  • "regex": "string",
  • "typeReference": {
    },
  • "enums": [
    ],
  • "propertyReferences": {
    },
  • "references": [
    ],
  • "relatedDataTypes": [
    ],
  • "discriminator": {
    },
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

GET DataType with {id}

GET DataType with {id}

path Parameters
entity
required
string
id
required
string

Id of DataType

query Parameters
include_deleted
boolean
Default: false

Include deleted DataTypes

include_datatypes
boolean
Default: false

Include child DataTypes

include_private
boolean
Default: false

Whether unpublished (private) types should be included. Default: false

Responses

Response samples

Content type
application/json
{
  • "publisher": "string",
  • "id": "string",
  • "version": "string",
  • "internalVersion": 0,
  • "baseType": "string",
  • "availability": "Private",
  • "deleted": true,
  • "min": { },
  • "max": { },
  • "regex": "string",
  • "typeReference": {
    },
  • "enums": [
    ],
  • "propertyReferences": {
    },
  • "references": [
    ],
  • "relatedDataTypes": [
    ],
  • "discriminator": {
    },
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

PUT a DataType with {id}

PUT a DataType with {id}

path Parameters
entity
required
string
id
required
string

The Id of the DataType

query Parameters
include_deleted
boolean
Default: false

Include deleted dataTypes

Request Body schema: application/json

The DataType to PUT

One of
object (Entity_TypeReferenceInputModel)
min
integer or null <int32>
max
integer or null <int32>
id
string or null
version
string or null
availability
string
Enum: "Private" "Published" "Public"
baseType
string
Enum: "String" "Integer" "Boolean" "Float" "Reference" "Dictionary" "Struct" "Array" "Enum" "AnyOf"
(Entity_PropertiesExistsDiscriminator (object or null)) or (Entity_PropertyValueInDiscriminator (object or null)) or (Entity_ValueValidatesDiscriminator (object or null))

Responses

Request samples

Content type
application/json
{
  • "typeReference": {
    },
  • "min": 0,
  • "max": 0,
  • "id": "string",
  • "version": "string",
  • "availability": "Private",
  • "baseType": "String",
  • "discriminator": {
    }
}

Response samples

Content type
application/json
{
  • "publisher": "string",
  • "id": "string",
  • "version": "string",
  • "internalVersion": 0,
  • "baseType": "string",
  • "availability": "Private",
  • "deleted": true,
  • "min": { },
  • "max": { },
  • "regex": "string",
  • "typeReference": {
    },
  • "enums": [
    ],
  • "propertyReferences": {
    },
  • "references": [
    ],
  • "relatedDataTypes": [
    ],
  • "discriminator": {
    },
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

GET DataType with {id} and {version}

GET DataType with {id} and {version}

path Parameters
entity
required
string
id
required
string

Id of DataType

version
required
integer <int32>

Format - int32. InternalVersion of DataType

query Parameters
include_deleted
boolean
Default: false

Include deleted DataTypes

include_datatypes
boolean
Default: false

Include child DataTypes

Responses

Response samples

Content type
application/json
{
  • "publisher": "string",
  • "id": "string",
  • "version": "string",
  • "internalVersion": 0,
  • "baseType": "string",
  • "availability": "Private",
  • "deleted": true,
  • "min": { },
  • "max": { },
  • "regex": "string",
  • "typeReference": {
    },
  • "enums": [
    ],
  • "propertyReferences": {
    },
  • "references": [
    ],
  • "relatedDataTypes": [
    ],
  • "discriminator": {
    },
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

GET a list[{take}] of DataType with {id}

GET a list[{take}] of DataType with {id}

path Parameters
entity
required
string
id
required
string

Id of DataType

query Parameters
take
integer <int32>
Default: 1

Format - int32. Number of versions

include_deleted
boolean
Default: false

Include deleted DataTypes

include_datatypes
boolean
Default: false

Include relational datatypes

include_private
boolean
Default: false

Whether unpublished (private) types should be included. Default: false

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GET DataType with {id} and {version}

GET DataType with {id} and {version}

path Parameters
entity
required
string
id
required
string

Id of DataType

version
required
string

SemanticVersion of DataType

query Parameters
include_deleted
boolean
Default: false

Include deleted DataTypes

include_datatypes
boolean
Default: false

Include child DataTypes

include_private
boolean
Default: false

Whether unpublished (private) types should be included. Default: false

Responses

Response samples

Content type
application/json
{
  • "publisher": "string",
  • "id": "string",
  • "version": "string",
  • "internalVersion": 0,
  • "baseType": "string",
  • "availability": "Private",
  • "deleted": true,
  • "min": { },
  • "max": { },
  • "regex": "string",
  • "typeReference": {
    },
  • "enums": [
    ],
  • "propertyReferences": {
    },
  • "references": [
    ],
  • "relatedDataTypes": [
    ],
  • "discriminator": {
    },
  • "createDate": { },
  • "lastUpdateDate": { },
  • "deleteDate": { },
  • "lastUpdateBy": "string"
}

Validate data on a type without saving it.

Validate data on a type without saving it.

path Parameters
entity
required
string
typeRef
required
string

ReferenceId to type. 'publisher:id' or just 'id' if type is located on current tenant

version
required
string

Semantic version of type to validate against

Request Body schema: application/json

Corresponding value to validate

object

A JSON object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

GET a list of all DataValues

GET a list of all DataValues

path Parameters
entity
required
string
query Parameters
include_deleted
boolean
Default: false

Include deleted DataValues

include_data
boolean
Default: false

Include {DATA} in DataValues

include_private
boolean
Default: false

Whether to check for published entities or not

created_at_offset
string <date-time>

Format - date-time (as date-time in RFC3339). Pagination parameter

complete
boolean
Default: false

Complete entity

limit
integer <int32>
Default: 20

Format - int32. Amount per page

render_mode
string
Default: "Advanced"
Enum: "Basic" "Advanced"

Render mode is telling whether certain values should be presented as arrays or not

Responses

Response samples

Content type
application/json
[
  • {
    }
]

POST a DataValue

POST a DataValue

path Parameters
entity
required
query Parameters
strategy
string
Enum: "ValidOnly" "DraftOnly" "DraftIfInvalid"

Tell service how to save values. Should only valid values be saved or is drafts allowed

Request Body schema: application/json

The DataValue to POST

property name*
additional property
object

A JSON object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Dry-Run: POST a DataValue

Dry-Run: POST a DataValue

path Parameters
entity
required
string
Request Body schema: application/json

The DataValue to POST

property name*
additional property
object

A JSON object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

DELETE all Data on Value with {id}

DELETE all Data on Value with {id}

path Parameters
entity
required
string
id
required
string

Id of DataValue

query Parameters
include_data
boolean
Default: false

Whether or not raw data is needed or not

Responses

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

GET DataValue with {id} and optional {date}

GET DataValue with {id} and optional {date}

path Parameters
entity
required
string
id
required
string

Id of DataValue

query Parameters
date
string <date-time>

Format - date-time (as date-time in RFC3339). DataValue at specific date

include_data
boolean
Default: false

Include {DATA} in DataValues

include_deleted
boolean
Default: false

Include deleted DataValues

include_private
boolean
Default: false

Whether to check for published entities or not

render_mode
string
Default: "Advanced"
Enum: "Basic" "Advanced"

Render mode is telling whether certain values should be presented as arrays

overwrite_rendered
boolean
Default: false

Whether to overwrite rendered value or not

Responses

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Patch a DataValue with {id}

Patch a DataValue with {id}

path Parameters
entity
required
string
id
required
string

Id of DataValue

query Parameters
strategy
string
Enum: "ValidOnly" "DraftOnly" "DraftIfInvalid"

Tell service how to save values. Should only valid values be saved or is drafts allowed

include_deleted
boolean
Default: false

Tell objects system to include deleted when updating

Request Body schema: application/json

The DataValue to Patch

property name*
additional property
object

A JSON object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

POST a DataValue

POST a DataValue

path Parameters
entity
required
string
id
required
string

Id of DataValue

query Parameters
strategy
string
Enum: "ValidOnly" "DraftOnly" "DraftIfInvalid"

Tell service how to save values. Should only valid values be saved or is drafts allowed

include_deleted
boolean
Default: false

Tell objects to include deleted stores

Request Body schema: application/json

The DataValue to POST

property name*
additional property
object

A JSON object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Dry-Run: Patch a DataValue with {id}

Dry-Run: Patch a DataValue with {id}

path Parameters
entity
required
string
id
required
string

Id of DataValue

query Parameters
include_deleted
boolean
Default: false

Tell objects system to include deleted when updating

Request Body schema: application/json

The DataValue to Patch

property name*
additional property
object

A JSON object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Dry-Run: POST a DataValue

Dry-Run: POST a DataValue

path Parameters
entity
required
string
id
required
Request Body schema: application/json

The DataValue to POST

property name*
additional property
object

A JSON object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

DELETE a DataValue with {id}

DELETE a DataValue with {id}

path Parameters
entity
required
string
id
required
string

Id of DataValue

part
required
string

jsonPath to part do delete

query Parameters
include_data
boolean
Default: false

include data for properties

Responses

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Dry-Run: DELETE a DataValue with {id}

Dry-Run: DELETE a DataValue with {id}

path Parameters
entity
required
string
id
required
string

Id of DataValue

part
required
string

jsonPath to part do delete

query Parameters
include_data
boolean
Default: false

include data for properties

Responses

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Get a list[{take}] of DataValue with {id}

Get a list[{take}] of DataValue with {id}

path Parameters
entity
required
string
id
required
string

Id of DataValue

query Parameters
take
integer <int32>
Default: 1

Format - int32. Number of versions

include_deleted
boolean
Default: false

Include deleted DataValues

include_private
boolean
Default: false

Whether to check for published entities or not

include_drafts
boolean
Default: false

Whether to include draft-versions or not

Responses

Response samples

Content type
application/json
[
  • { }
]

GET DataValue with {id} and {version}

GET DataValue with {id} and {version}

path Parameters
entity
required
string
id
required
string

Id of DataValue

version
required
integer <int32>

Format - int32. Version of DataValue

query Parameters
include_deleted
boolean
Default: false

Include deleted DataValues

render_mode
string
Default: "Advanced"
Enum: "Basic" "Advanced"

Render mode is telling whether certain values should be presented as arrays

Responses

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Master Data Orchestrations

Create a Flow

This creates a new flow.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"
Request Body schema: application/json

The flow to create

jobs
Array of strings
entityType
string
object (MDOrchestration_startProcedureDto)

Responses

Request samples

Content type
application/json
Example
{
  • "jobs": [
    ],
  • "entityType": "stores",
  • "startProcedure": {
    }
}

Response samples

Content type
application/json
{
  • "id": "id1",
  • "tenantId": "fo",
  • "jobIds": [
    ],
  • "entityType": "stores",
  • "startProcedure": {
    }
}

List flows

This lists flows.

query Parameters
entity_type
string
Default: "stores"
Enum: "stores" "menus"

The entityType for the flow

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete a Flow

This deletes a flow.

path Parameters
id
required
string

The id of the flow

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "id": "id1",
  • "tenantId": "fo",
  • "jobIds": [
    ],
  • "entityType": "stores",
  • "startProcedure": {
    }
}

Get a Flow

This gets a flow.

path Parameters
id
required
string

The id of the flow

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "id": "id1",
  • "tenantId": "fo",
  • "jobIds": [
    ],
  • "entityType": "stores",
  • "startProcedure": {
    }
}

Update a Flow

This updates a flow.

path Parameters
id
required
string

The id of the flow

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"
Request Body schema: application/json

The flow to update

jobs
Array of strings
entityType
string
object (MDOrchestration_startProcedureDto)

Responses

Request samples

Content type
application/json
Example
{
  • "jobs": [
    ],
  • "entityType": "stores",
  • "startProcedure": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "tenantId": "string",
  • "jobIds": [
    ],
  • "entityType": "stores",
  • "startProcedure": {
    }
}

List logs for flow

This provides logs for a specific flow

path Parameters
id
required
string

The id of the Flow

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Create a job

This creates a new job.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"
Request Body schema: application/json

The job to create

url
string
description
string
entityType
string
configuration
object
timeOut
string
failOnTimeOut
boolean or null
object (MDOrchestration_authenticationConfigurationDto)

Responses

Request samples

Content type
application/json
{
  • "url": "https://example.com/get/stores",
  • "description": "Integration with example tenant",
  • "entityType": "stores",
  • "configuration": {
    },
  • "timeOut": "2023-02-14",
  • "failOnTimeOut": true,
  • "authenticationConfiguration": {
    }
}

Response samples

Content type
application/json
{
  • "id": "id1",
  • "tenantId": "fo",
  • "url": "https://example.com/import?type=stores",
  • "description": "Import store from tenant integration",
  • "entityType": "stores",
  • "configuration": {
    },
  • "timeOut": "2023-02-14",
  • "failOnTimeOut": true,
  • "authenticationConfiguration": {
    }
}

List jobs

This lists jobs.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete a job

This deletes a job.

path Parameters
id
required
string

The id of the job

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "id": "id1",
  • "tenantId": "fo",
  • "url": "https://example.com/import?type=stores",
  • "description": "Import store from tenant integration",
  • "entityType": "stores",
  • "configuration": {
    },
  • "timeOut": "2023-02-14",
  • "failOnTimeOut": true,
  • "authenticationConfiguration": {
    }
}

Get a job

This gets a job.

path Parameters
id
required
string

The id of the job

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "id": "id1",
  • "tenantId": "fo",
  • "url": "https://example.com/import?type=stores",
  • "description": "Import store from tenant integration",
  • "entityType": "stores",
  • "configuration": {
    },
  • "timeOut": "2023-02-14",
  • "failOnTimeOut": true,
  • "authenticationConfiguration": {
    }
}

Update a job

This updates a job.

path Parameters
id
required
string

The id of the job

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"
Request Body schema: application/json

The job to update

url
string
description
string
entityType
string
configuration
object
timeOut
string
failOnTimeOut
boolean or null
object (MDOrchestration_authenticationConfigurationDto)

Responses

Request samples

Content type
application/json
{
  • "url": "https://example.com/get/stores",
  • "description": "Integration with example tenant",
  • "entityType": "stores",
  • "configuration": {
    },
  • "timeOut": "2023-02-14",
  • "failOnTimeOut": true,
  • "authenticationConfiguration": {
    }
}

Response samples

Content type
application/json
{
  • "id": "id1",
  • "tenantId": "fo",
  • "url": "https://example.com/import?type=stores",
  • "description": "Import store from tenant integration",
  • "entityType": "stores",
  • "configuration": {
    },
  • "timeOut": "2023-02-14",
  • "failOnTimeOut": true,
  • "authenticationConfiguration": {
    }
}

List logs

This lists logs.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Get a log

This gets a log.

path Parameters
id
required
string

The id of the job

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "id": "logentryid1",
  • "tenantId": "fo",
  • "flowId": "flowid1",
  • "runId": "runid1",
  • "logReport": {
    },
  • "createdAt": "2023-02-14T12:50:20.048409+00:00"
}

Create a complete report

This creates a new complete report.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"
Request Body schema: application/json

The complete report to create

flowId
string
jobId
string
runId
string
object

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Create a error report

This creates a new error report.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"
Request Body schema: application/json

The error report to create

flowId
string
jobId
string
runId
string
object (MDOrchestration_errorInfoDto)

Responses

Request samples

Content type
application/json
{
  • "flowId": "flowid1",
  • "jobId": "jobid1",
  • "runId": "runid1",
  • "error": {
    }
}

Response samples

Content type
application/json
{
  • "flowId": "flowId1",
  • "jobId": "jobid1",
  • "runId": "runid1",
  • "error": {
    }
}

Create a progress report

This creates a new progress report.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"
Request Body schema: application/json

The progress report to create

flowId
string
jobId
string
runId
string
status
string
information
string

Responses

Request samples

Content type
application/json
{
  • "flowId": "flowid1",
  • "jobId": "jobid1",
  • "runId": "runid1",
  • "status": "LOADING",
  • "information": "more information about progress"
}

Response samples

Content type
application/json
{
  • "flowId": "flowid1",
  • "jobId": "jobid1",
  • "runId": "runid1",
  • "status": "LOADING",
  • "information": "more information about progress"
}

Create a run from a flow

This creates a new run.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"
Request Body schema: application/json

The run to create

flowId
string
position
integer or null <int32>
startingIdentifiers
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "flowId": "flowid2",
  • "position": 3
}

Response samples

Content type
application/json
{
  • "id": "runid1",
  • "tenantId": "fo",
  • "flowId": "flowid1",
  • "createdAt": "2023-02-14T12:50:20.0613015+00:00",
  • "status": "Active"
}

Get a list of runs

This returns available runs

query Parameters
flow_id
string

The id of the flow

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Add entity data

This adds entity data that can be used by the next job

path Parameters
id
required
string

The id of the run

jobId
required
string

The id of the job

entityId
required
string

The id of the entity

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"
Request Body schema: application/json

The entity

property name*
additional property
object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
application/json
{
  • "url": "string"
}

Get entity data

This fetches a entity

path Parameters
id
required
string

The id of the run

jobId
required
string

The id of the job

entityId
required
string

The id of the entity

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": { }
}

Add entity data collection

This adds entity data as a batch that can be used by the next job

path Parameters
id
required
string

The id of the run

jobId
required
string

The id of the job

entityId
required
string

The id of the entity

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"
Request Body schema: application/json

The entity

property name*
additional property
object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
application/json
{
  • "url": "string"
}

List logs for job in a specific run

This provides logs for a specific job and run

path Parameters
id
required
string

The id of the Run

jobId
required
string

The id of the Job

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

List logs for run

This provides logs for a specific run

path Parameters
id
required
string

The id of the Run

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Create a Timer

Create a specific timer

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"
Request Body schema: application/json

The flow to create

from
string
to
string
timesOfDay
Array of strings
flowId
string
startingIdentifiers
Array of strings
jobId
string

Responses

Request samples

Content type
application/json
{
  • "from": "string",
  • "to": "string",
  • "timesOfDay": [
    ],
  • "flowId": "string",
  • "startingIdentifiers": [
    ],
  • "jobId": "string"
}

Response samples

Content type
application/json
{
  • "from": "string",
  • "to": "string",
  • "timesOfDay": [
    ],
  • "flowId": "string",
  • "startingIdentifiers": [
    ],
  • "jobId": "string"
}

Delete a timer

Delete a specific timer

path Parameters
id
required
string

The id of the timer

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "from": "string",
  • "to": "string",
  • "timesOfDay": [
    ],
  • "flowId": "string",
  • "startingIdentifiers": [
    ],
  • "jobId": "string"
}

Update a timer

Update a specific timer

path Parameters
id
required
string

The id of the timer

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"
Request Body schema: application/json

The job to update

from
string
to
string
timesOfDay
Array of strings
flowId
string
startingIdentifiers
Array of strings
jobId
string

Responses

Request samples

Content type
application/json
{
  • "url": "https://example.com/get/stores",
  • "description": "Integration with example tenant",
  • "entityType": "stores",
  • "configuration": {
    },
  • "timeOut": "2023-02-14",
  • "failOnTimeOut": true,
  • "authenticationConfiguration": {
    }
}

Response samples

Content type
application/json
{
  • "id": "id1",
  • "tenantId": "fo",
  • "url": "https://example.com/import?type=stores",
  • "description": "Import store from tenant integration",
  • "entityType": "stores",
  • "configuration": {
    },
  • "timeOut": "2023-02-14",
  • "failOnTimeOut": true,
  • "authenticationConfiguration": {
    }
}

List timers

List timers

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a timer

Get a specific timer

path Parameters
id
required
string

The id of the flow from whom you want the configured timers.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
Content-Type
required
string
Default: application/json
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "from": "string",
  • "to": "string",
  • "timesOfDay": [
    ],
  • "flowId": "string",
  • "startingIdentifiers": [
    ],
  • "jobId": "string"
}

Stores

GET DataValues

GET a list of DataValues

query Parameters
include_deleted
boolean

Include deleted DataValues

include_private
boolean

Whether to check for published entities or not

created_at_offset
string

Format - date-time (as date-time in RFC3339). Pagination parameter

limit
integer

Format - int32. Amount per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GET DataValue with {id} and optional {date}

GET DataValue with {id} and optional {date}

path Parameters
id
required
string

Id of DataValue

query Parameters
include_deleted
boolean

Include deleted DataValues

include_private
boolean

Whether to check for published entities or not

date
string

Format - date-time (as date-time in RFC3339). DataValue at specific date

Responses

Response samples

Content type
application/json
{
  • "additionalProp1": { },
  • "additionalProp2": { },
  • "additionalProp3": { }
}

Frontend Plugins

Deletes a plugin

Deletes a plugin with matching name and version

query Parameters
name
required
string >= 3
version
required
string
Example: version=1.0.0

Responses

Lists plugins

Lists plugins for tenant. Global plugins are prefixed with fo/

query Parameters
excludeGlobalPlugins
boolean
Default: false

Exclude global plugins

Responses

Response samples

Content type
application/json
{
  • "plugins": [
    ]
}

Uploads a plugin

Uploads plugin, overwriting any existing plugin with the same name and version

query Parameters
name
required
string
version
required
string <semver>
Example: version=1.0.0

Format - semver.

Request Body schema: text/plain

Plugin code

string

Responses

Request samples

Content type
text/plain
null

Creates plugin config

Creates plugin config. Prefix plugin name with fo/ for global plugins. Setting plugin config activates the plugin.

Request Body schema: application/json

Plugin config

name
string
version
string
config
object or null
channels
Array of any or null
Enum: "kiosk" "foapp"
countryCodes
Array of strings or null
consentLevels
Array of any or null
Enum: "standard" "preferences" "statistics" "marketing"
appTrackingConsent
boolean or null
dependentOn
Array of strings or null
paused
boolean or null
allowedDataUrls
Array of strings or null
removeAt
string or null <date-time>
esm
boolean or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "version": "string",
  • "config": { },
  • "channels": [
    ],
  • "countryCodes": [
    ],
  • "consentLevels": [
    ],
  • "appTrackingConsent": true,
  • "dependentOn": [
    ],
  • "paused": true,
  • "allowedDataUrls": [
    ],
  • "removeAt": "string",
  • "esm": true
}

Response samples

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

Gets plugin config

Gets plugin config for the tenant. Global plugins are prefixed with fo/

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets plugin manifest

Gets plugin manifest for plugin

query Parameters
name
required
string

Plugin name, prefix with fo/ for global plugins

Responses

Response samples

Content type
application/json
{
  • "esm": true,
  • "parameters": [ ]
}

Uploads plugin manifest

Uploads plugin manifest for tenant specific plugin, overwriting any existing plugin manifest

query Parameters
name
required
string
Request Body schema: application/json

Plugin manifest

version
string
description
string or null
esm
boolean or null
parameters
Array of any
hidden
boolean or null
deprecated
boolean or null

Responses

Request samples

Content type
application/json
{
  • "version": "string",
  • "description": "string",
  • "esm": true,
  • "parameters": [
    ],
  • "hidden": true,
  • "deprecated": true
}

Deletes plugin config

Deletes plugin config with id

path Parameters
id
required
string

Plugin id is required to specify which plugin config to delete

Responses

Sets plugin config

Updates plugin config, overwriting existing config with specified id

path Parameters
id
required
string

Plugin id is required to specify which plugin config to update

Request Body schema: application/json

Plugin config

name
string
version
string
config
object or null
channels
Array of any or null
Enum: "kiosk" "foapp"
countryCodes
Array of strings or null
consentLevels
Array of any or null
Enum: "standard" "preferences" "statistics" "marketing"
appTrackingConsent
boolean or null
dependentOn
Array of strings or null
paused
boolean or null
allowedDataUrls
Array of strings or null
removeAt
string or null <date-time>
esm
boolean or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "version": "string",
  • "config": { },
  • "channels": [
    ],
  • "countryCodes": [
    ],
  • "consentLevels": [
    ],
  • "appTrackingConsent": true,
  • "dependentOn": [
    ],
  • "paused": true,
  • "allowedDataUrls": [
    ],
  • "removeAt": "string",
  • "esm": true
}

List Touchpoint Sessions

query Parameters
storeId
required
number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Touchpoint Session

path Parameters
sessionId
required
string

Responses

Response samples

Content type
application/json
{
  • "sessionId": "string",
  • "tenantId": "string",
  • "storeId": "string",
  • "countryCode": "string",
  • "status": "string",
  • "owner": {
    },
  • "observers": [
    ],
  • "device": {
    },
  • "orderId": "string",
  • "createdAt": "string",
  • "alerts": [
    ]
}

Devices

Cancel Batch Job

path Parameters
job-id
required
string

Batch job identifier

Responses

Submit Batch Job

Responses

Get Batch Job Status

path Parameters
job-id
required
string

Batch job identifier

Responses

List Devices

query Parameters
deviceType
string

Filter by device type (e.g. ~kiosk, ~orb, ~foop). Use ~ prefix for substring match.

Label
string

Filter by device label. Use ~ prefix for substring match.

Settings:StoreId
string

Filter by store ID (exact match).

Settings:KioskId
string

Filter by kiosk name. Use ~ prefix for substring match.

deviceInfo:deviceName
string

Filter by reported device name. Use ~ prefix for substring match.

Settings:CultureCode
string

Filter by culture code (exact match).

Settings:CountryCode
string

Filter by country code (exact match).

Responses

Create FOOP Device

Responses

Create Kiosk Device

Responses

Get Device Secrets

path Parameters
device-id
required
string

Device identifier

Responses

Create Device Secret

path Parameters
device-id
required
string

Device identifier

Responses

Revoke Device Secret

path Parameters
device-id
required
string

Device identifier

secret-id
required
string

Secret identifier

Responses

Create ORB Device

Responses

Setup Device

Responses

Device Status

query Parameters
store_ids
string

Used to only query a subset of devices beloning to a list of certain storeIds. comma separated list of strings

device_ids
string

Used to only query a subset of devices beloning to a list of certain deviceIds. comma separated list of strings

minimum_warning_level
string
Enum: "ok" "warning" "error"

Used to only return devices with a certain severity. ok returns devices with all warning severities, warning returns devices with warning and error and error only returns devices with error severity. Deafult is OK.

continuation_token
string

Used to fetch next page of data.

limit
integer

Used to set the page size limit, default is 100.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
X-Api-Version
required
string
Default: 0
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "devices": {
    }
}

Device Status History

query Parameters
after
required
string
Default: "08/01/2021 00:00:00"
Value: "08/01/2021 00:00:00"

timestamp representing the start time of the query.

before
string

timestamp representing the end time of the query.

store_ids
Array of arrays

array of store-ids to fetch history for. Array of strings

device_ids
Array of arrays

array of device-ids to fetch history for. Array of strings

minimum_warning_level
string
Default: "ok"
Enum: "ok" "warning" "error"

the minimum warning level for the telemetry. ok returns everything, warning returns warning and errors and error returns only errors.

limit
integer
Default: 100
Value: 100

page size to fetch

contiuation_token
string

use the continuation token when requesting the next page.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
X-Api-Version
required
string
Default: 0
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "devices": {
    }
}

Get Device

path Parameters
device-id
required
string

Device identifier

Responses

Delete Device

path Parameters
device-id
required
string

Device identifier

Responses

Get Device Primary Certificate SAS Key

path Parameters
device-id
required
string

Device identifier

Responses

Get Device Primary Certificate Thumbprint

path Parameters
device-id
required
string

Device identifier

Responses

Get Device Secondary Certificate Connection String

path Parameters
device-id
required
string

Device identifier

Responses

Get Device Secondary Certificate Connection String Check Secret

path Parameters
device-id
required
string

Device identifier

Responses

Get Device Secondary Certificate Thumbprint

path Parameters
device-id
required
string

Device identifier

Responses

Set Device Module

path Parameters
device-id
required
string

Device identifier

module-name
required
string

Module name

Responses

Remove Device Module

path Parameters
device-id
required
string

Device identifier

module-name
required
string

Module name

Responses

Upload Device Log Filtered

path Parameters
device-id
required
string

Device identifier

Responses

Upload Device Log

path Parameters
device-id
required
string

Device identifier

Responses

Ping Device

path Parameters
device-id
required
string

Device identifier

Responses

Restart Device

path Parameters
device-id
required
string

Device identifier

Responses

Invoke Device Method

path Parameters
device-id
required
string

Device identifier

module
required
string

Module name

method
required
string

Method name

Responses

Get Device Desired Settings

path Parameters
device-id
required
string

Device identifier

Responses

Update Device Desired Settings

path Parameters
device-id
required
string

Device identifier

Responses

Set Individual Desired Setting

path Parameters
device-id
required
string

Device identifier

setting-name
required
string

Setting name

Responses

Delete Individual Desired Setting

path Parameters
device-id
required
string

Device identifier

setting-name
required
string

Setting name

Responses

Get Device Reported Settings

path Parameters
device-id
required
string

Device identifier

Responses

Get Device Tags

path Parameters
device-id
required
string

Device identifier

Responses

Update Device Tags

path Parameters
device-id
required
string

Device identifier

Responses

Set Individual Tag

path Parameters
device-id
required
string

Device identifier

setting-name
required
string

Setting name

Responses

Delete Device Telemetry Status

path Parameters
device-id
required
string

Device identifier

Responses

Get Device Telemetry Event

path Parameters
device-id
required
string

Device identifier

query Parameters
after
string

Timestamp representing the start time of the query.

before
string

Timestamp representing the end time of the query.

limit
integer

Page size.

continuation_token
string

Used to fetch the next page of data.

Responses

List FOOP Module Names

path Parameters
channel
required
string
Enum: "stable" "releasecandidate" "preview" "latest"

Release channel

Responses

Get Foop Module Versions

path Parameters
channel
required
string
Enum: "stable" "releasecandidate" "preview" "latest"

Release channel

module-name
required
string

Module name

query Parameters
top
integer

Limit number of versions returned

version
string

Filter by specific version

Responses

Get Foop Module Download URL

path Parameters
channel
required
string
Enum: "stable" "releasecandidate" "preview" "latest"

Release channel

module-name
required
string

Module name

version
required
string
query Parameters
platform
string
Enum: "windows" "linux" "noarch"

Target platform

cohort
integer

Cohort validation number

Responses

Status

Gets device statuses for all your devices. Paginated responses at 100 devices per call, get the next batch of devices using the continuation token. If needed, one can raise the default limit of 100 devices per response. You can limit the response by filtering by store, deviceIds and minimum warning level. The storeIds and deviceIds query parameters handles multiple values.

query Parameters
store_ids
string

Used to only query a subset of devices beloning to a list of certain storeIds. comma separated list of strings

device_ids
string

Used to only query a subset of devices beloning to a list of certain deviceIds. comma separated list of strings

minimum_warning_level
string
Enum: "ok" "warning" "error"

Used to only return devices with a certain severity. ok returns devices with all warning severities, warning returns devices with warning and error and error only returns devices with error severity. Deafult is OK.

continuation_token
string

Used to fetch next page of data.

limit
integer

Used to set the page size limit, default is 100.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
X-Api-Version
required
string
Default: 0
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "devices": {
    }
}

Status History

Expensive request, use with care. Will be rate limited.

query Parameters
after
required
string
Default: "08/01/2021 00:00:00"
Value: "08/01/2021 00:00:00"

timestamp representing the start time of the query.

before
string

timestamp representing the end time of the query.

store_ids
Array of arrays

array of store-ids to fetch history for. Array of strings

device_ids
Array of arrays

array of device-ids to fetch history for. Array of strings

minimum_warning_level
string
Default: "ok"
Enum: "ok" "warning" "error"

the minimum warning level for the telemetry. ok returns everything, warning returns warning and errors and error returns only errors.

limit
integer
Default: 100
Value: 100

page size to fetch

contiuation_token
string

use the continuation token when requesting the next page.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
X-Api-Version
required
string
Default: 0
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "devices": {
    }
}

Status Overview

Gets a condensed summary of device status for all your devices in one call.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
X-Api-Header
required
string
Default: 0
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "devices": [
    ]
}

List Templates

Responses

Get Template

path Parameters
template-name
required
string

Template name

Responses

Create Template

path Parameters
template-name
required
string

Template name

Responses

Delete Template

path Parameters
template-name
required
string

Template name

Responses

Get Receipt Templates

query Parameters
culture
string

Culture code filter (e.g. en-US)

type
string

Template type filter

Responses

Get Device Connection String

path Parameters
device-id
required
string

device id

Responses

Check Device Connection String Secret

path Parameters
device-id
required
string

device id

Responses

Status for Device

Get device status for a single device-id.

path Parameters
device-id
required
string

device id

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "
X-Api-Version
required
string
Default: 0
Value: "0"

Responses

Response samples

Content type
application/json
{
  • "sourceType": "string",
  • "deviceId": "string",
  • "storeId": "string",
  • "tenantId": "string",
  • "modules": [
    ],
  • "deviceStatuses": [
    ],
  • "warningLevel": 0,
  • "createDate": "2022-11-15T16:41:49.632+00:00",
  • "deviceName": "string"
}

Users

Get Users

Get multiple user entities.

query Parameters
id
string

The user ID to search for.

email
string

The email address to search for.

mobile_phone_number
string

The mobile phone number to search for.

username
string

The username to search for.

authentication_scheme
string

The user authentication scheme to search for. Requires provider_tenant_id and provider_user_id to also be set.

provider_tenant_id
string

The user provider tenant ID to search for. Requires authentication_scheme and provider_user_id to also be set.

provider_user_id
string

The user provider user ID to search for. Requires authentication_scheme and provider_tenant_id to also be set.

header Parameters
X-Api-Version
required
string
Default: 0
Value: "0"
Authorization
required
string
Default: Bearer
Value: "Bearer "

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get User

Get a single user entity.

path Parameters
user-id
required
string

The ID of the user

header Parameters
X-Api-Version
required
Default:
Value: ""
Authorization
required
Default:
Value: ""

Responses

Response samples

Content type
application/json
{
  • "disabled": true,
  • "tenantId": "string",
  • "userId": "string",
  • "username": "string",
  • "legacyAccountType": "string",
  • "name": "string",
  • "friendlyName": "string",
  • "email": "string",
  • "emailVerified": true,
  • "mobilePhoneNumber": "string",
  • "mobilePhoneNumberVerified": true,
  • "userInformation": {
    },
  • "localLogin": {
    },
  • "externalLogins": [ ],
  • "deviceLogins": [ ],
  • "permissionGroups": [
    ],
  • "createdAtUtc": "string",
  • "lastTokenIssuedAtUtc": "string",
  • "lastLoginDateUtc": "string",
  • "deletionRequestedAtUtc": "string",
  • "disabledAtUtc": "string"
}

Mark User for Deletion

Mark a user for deletion.

path Parameters
user-id
required
string

The ID of the user.

header Parameters
X-Api-Version
required
string
Default: 0
Value: "0"
Authorization
required
string
Default: Bearer
Value: "Bearer "

Responses

Update User

Update a user's personal data.

path Parameters
user-id
required
string

The ID of the user.

header Parameters
X-Api-Version
required
Default:
Value: ""
Authorization
required
Default:
Value: ""
Request Body schema: application/json

A JSON object containing the new personal data.

email
string
mobilePhoneNumber
string
name
string
friendlyName
string
emailVerified
boolean
mobilePhoneNumberVerified
boolean

Responses

Request samples

Content type
application/json
{
  • "email": "email@example.com",
  • "mobilePhoneNumber": "+4623123123",
  • "name": "Firstname Lastname",
  • "friendlyName": "Firstname",
  • "emailVerified": true,
  • "mobilePhoneNumberVerified": true
}

Response samples

Content type
application/json
{
  • "disabled": true,
  • "tenantId": "string",
  • "userId": "string",
  • "username": "string",
  • "legacyAccountType": "string",
  • "name": "string",
  • "friendlyName": "string",
  • "email": "string",
  • "emailVerified": true,
  • "mobilePhoneNumber": "string",
  • "mobilePhoneNumberVerified": true,
  • "userInformation": {
    },
  • "localLogin": {
    },
  • "externalLogins": [ ],
  • "deviceLogins": [ ],
  • "permissionGroups": [
    ],
  • "createdAtUtc": "string",
  • "lastTokenIssuedAtUtc": "string",
  • "lastLoginDateUtc": "string",
  • "deletionRequestedAtUtc": "string",
  • "disabledAtUtc": "string"
}

Send notification

Send notification to user

path Parameters
user-id
required
header Parameters
X-Api-Version
required
Default:
Value: ""
Authorization
required
Default:
Value: ""
Request Body schema: application/json-patch+json

A JSON object containing the notification

intent
string
object

Responses

Request samples

Content type
application/json-patch+json
{
  • "intent": "TermsOfServiceUpdate1",
  • "countryCode": "US",
  • "content": {
    },
  • "communicationReason": {
    }
}

Communication Preferences

Get my Communication Preferences

Get user communications preferences

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "

Token used for authentication

X-Api-Version
required
string
Default: 0
Value: "0"

Specify which version of API to make request towards.

Responses

Response samples

Content type
application/json
{
  • "communicationChannels": [
    ],
  • "communicationReasons": [
    ],
  • "userId": "string",
  • "tenantId": "string"
}

Update my Communication Preferences

Update User Customer Preferences

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "

Token used for authentication

X-Api-Version
required
string
Default: 0
Value: "0"

Specify which version of API to make request towards

Request Body schema: application/json-patch+json
Array of objects
Array
key
required
string
required
Array of objects

Responses

Request samples

Content type
application/json-patch+json
{
  • "communicationReasons": [
    ]
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "supportedCommunicationMethods": [
    ]
}

Get User Communication Preferences

Get user communications preferences

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "

Token used for authentication

X-Api-Version
required
string
Default: 0
Value: "0"

Specify which version of API to make request towards.

Responses

Response samples

Content type
application/json
{
  • "communicationChannels": [
    ],
  • "communicationReasons": [
    ],
  • "userId": "string",
  • "tenantId": "string"
}

Update User Communication Preferences

Update User Customer Preferences

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "

Token used for authentication

X-Api-Version
required
string
Default: 0
Value: "0"

Specify which version of API to make request towards

Request Body schema: application/json-patch+json
Array of objects
Array
key
required
string
required
Array of objects

Responses

Request samples

Content type
application/json-patch+json
{
  • "communicationReasons": [
    ]
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "supportedCommunicationMethods": [
    ]
}

Get For All Users Communication Preferences

Get user communications preferences

path Parameters
user-id
required
string

The ID of the user.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "

Token used for authentication

X-Api-Version
required
string
Default: 0
Value: "0"

Specify which version of API to make request towards.

Responses

Response samples

Content type
application/json
{
  • "communicationChannels": [
    ],
  • "communicationReasons": [
    ],
  • "userId": "string",
  • "tenantId": "string"
}

Get Communication Preferences for a specific user

Get user communications preferences

path Parameters
user-id
required
string

The ID of the user.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "

Token used for authentication

X-Api-Version
required
string
Default: 0
Value: "0"

Specify which version of API to make request towards.

Responses

Response samples

Content type
application/json
{
  • "communicationChannels": [
    ],
  • "communicationReasons": [
    ],
  • "userId": "string",
  • "tenantId": "string"
}

Updated Communication Preferences for a specific user, reason and method

Update user communication preference by userId, communication reason and communication method

path Parameters
user-id
required
string

The ID of the user.

communication-preference-reason
required
string

The communication preference reason for the notice.

communication-method-key
required
string

The supported communication method for the notice.

header Parameters
Authorization
required
string
Default: Bearer
Value: "Bearer "

Token used for authentication

X-Api-Version
required
string
Value: "0"

Specify which version of API to make request towards.

Request Body schema: application/json-patch+json

A JSON object containing the method with new value.

isActive
boolean

Responses

Request samples

Content type
application/json-patch+json
{
  • "isActive": true
}

Response samples

Content type
application/json
{
  • "communicationReasons": [
    ],
  • "userId": "abc123"
}

Custom Payment Provider

External Payment Provider Events

This endpoint is called to report the outcome of each operation

path Parameters
id
required
string
Default: "external"
Value: "external"
header Parameters
X-Api-Version
required
string
Default: 0
Value: "0"
Authorization
required
string
Default: Bearer
Value: "Bearer "
Request Body schema:
One of
specversion
required
string
Value: "1.0"
datacontenttype
required
string
Value: "application/json"
type
required
string
Value: "payment.external.transaction.annulment_failed.v1"
id
required
string non-empty
source
required
string <uri>
time
required
string <date-time>
subject
required
string non-empty
required
object (PaymentProvider_PaymentTransactionAnnulmentFailedData)

Responses

Request samples

Content type
{
  • "type": "payment.external.transaction.registration_succeeded.v1",
  • "data": {
    },
  • "specversion": "1.0",
  • "id": "2b53022a-e88e-44b1-acca-72e9af75d0cb",
  • "source": "https://partner.example.com/v1/payments",
  • "time": "2024-01-15T10:30:05+00:00",
  • "subject": "transaction/3cb0a664-b18f-4330-bd38-796f185b8d6e",
  • "datacontenttype": "application/json"
}

Response samples

Content type
Example
{
  "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#validation-error",
  "title": "Request validation failed.",
  "status": 400,
  "detail": "One or more fields failed validation.",
  "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "code": "validation.error",
      "detail": "The Example field is required.",
      "target": "example"
    }
  ]
}