{
"swagger": "2.0",
"info": {
"version": "v2",
"title": "MoreFlo.Public.Api"
},
"host": "api.moreflo.com",
"schemes": [
"https"
],
"paths": {
"/v2/accountcodes": {
"get": {
"tags": [
"AccountCodes"
],
"summary": "Get all account codes.",
"operationId": "AccountCodes_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountCodesResult"
}
}
}
},
"put": {
"tags": [
"AccountCodes"
],
"summary": "Update account codes.",
"operationId": "AccountCodes_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "accountCodes",
"in": "body",
"description": "List of account codes to update.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountCode"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountCodeResult"
}
}
}
},
"post": {
"tags": [
"AccountCodes"
],
"summary": "Create account codes.",
"operationId": "AccountCodes_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "accountCodes",
"in": "body",
"description": "List of account codes.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountCodeCreate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "Id to update if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountCodesResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/accountcodes": {
"get": {
"tags": [
"AccountCodes"
],
"summary": "Get all account codes.",
"operationId": "AccountCodes_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountCodesResult"
}
}
}
},
"put": {
"tags": [
"AccountCodes"
],
"summary": "Update account codes.",
"operationId": "AccountCodes_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "accountCodes",
"in": "body",
"description": "List of account codes to update.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountCode"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountCodeResult"
}
}
}
},
"post": {
"tags": [
"AccountCodes"
],
"summary": "Create account codes.",
"operationId": "AccountCodes_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "accountCodes",
"in": "body",
"description": "List of account codes.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountCodeCreate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "Id to update if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountCodesResult"
}
}
}
}
},
"/v2/accountcodes/{Id}": {
"get": {
"tags": [
"AccountCodes"
],
"summary": "Get a specific account code",
"operationId": "AccountCodes_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of account code.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountCodeResult"
}
}
}
},
"delete": {
"tags": [
"AccountCodes"
],
"summary": "Delete an account code.",
"operationId": "AccountCodes_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Name of account code to be deleted.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountCodeResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/accountcodes/{Id}": {
"get": {
"tags": [
"AccountCodes"
],
"summary": "Get a specific account code",
"operationId": "AccountCodes_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of account code.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountCodeResult"
}
}
}
},
"delete": {
"tags": [
"AccountCodes"
],
"summary": "Delete an account code.",
"operationId": "AccountCodes_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Name of account code to be deleted.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountCodeResult"
}
}
}
}
},
"/v2/settings/accounting/vat": {
"get": {
"tags": [
"AccountingSettings"
],
"summary": "Get all vat account settings.",
"operationId": "AccountingSettings_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountingSettings.VatAccountSettingsResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/settings/accounting/vat": {
"get": {
"tags": [
"AccountingSettings"
],
"summary": "Get all vat account settings.",
"operationId": "AccountingSettings_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountingSettings.VatAccountSettingsResult"
}
}
}
}
},
"/v2/settings/accounting/income": {
"get": {
"tags": [
"AccountingSettings"
],
"summary": "Get income account settings.",
"operationId": "AccountingSettings_GetIncomeAccounts",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/xFlo.Models.External.Api.Models.AccountingSettings.IncomeAccountSettingsResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/settings/accounting/income": {
"get": {
"tags": [
"AccountingSettings"
],
"summary": "Get income account settings.",
"operationId": "AccountingSettings_GetIncomeAccounts",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/xFlo.Models.External.Api.Models.AccountingSettings.IncomeAccountSettingsResult"
}
}
}
}
},
"/v2/settings/accounting/other": {
"get": {
"tags": [
"AccountingSettings"
],
"summary": "Get other account settings.",
"operationId": "AccountingSettings_GetOtherAccounts",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/xFlo.Models.External.Api.Models.AccountingSettings.OtherAccountSettingsResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/settings/accounting/other": {
"get": {
"tags": [
"AccountingSettings"
],
"summary": "Get other account settings.",
"operationId": "AccountingSettings_GetOtherAccounts",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/xFlo.Models.External.Api.Models.AccountingSettings.OtherAccountSettingsResult"
}
}
}
}
},
"/v2/articles": {
"get": {
"tags": [
"Articles"
],
"summary": "Get all articles.",
"operationId": "Articles_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "ArticleInfoUpdatedSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "QuantityUpdatedSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "ArticleType",
"in": "query",
"description": "",
"required": false,
"type": "string"
},
{
"name": "ArticleGroup",
"in": "query",
"description": "",
"required": false,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticlesGetResult"
}
}
}
},
"put": {
"tags": [
"Articles"
],
"summary": "Update articles.",
"operationId": "Articles_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "articles",
"in": "body",
"description": "List of articles to update.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Article"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticlesResult"
}
}
}
},
"post": {
"tags": [
"Articles"
],
"summary": "Create articles.",
"operationId": "Articles_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "articles",
"in": "body",
"description": "List of articles to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleCreate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticlesResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/articles": {
"get": {
"tags": [
"Articles"
],
"summary": "Get all articles.",
"operationId": "Articles_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "ArticleInfoUpdatedSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "QuantityUpdatedSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "ArticleType",
"in": "query",
"description": "",
"required": false,
"type": "string"
},
{
"name": "ArticleGroup",
"in": "query",
"description": "",
"required": false,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticlesGetResult"
}
}
}
},
"put": {
"tags": [
"Articles"
],
"summary": "Update articles.",
"operationId": "Articles_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "articles",
"in": "body",
"description": "List of articles to update.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Article"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticlesResult"
}
}
}
},
"post": {
"tags": [
"Articles"
],
"summary": "Create articles.",
"operationId": "Articles_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "articles",
"in": "body",
"description": "List of articles to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleCreate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticlesResult"
}
}
}
}
},
"/v2/articles/increasestock": {
"put": {
"tags": [
"Articles"
],
"summary": "Update stock - increase stock.",
"operationId": "Articles_IncreaseStock",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "articleQuantityInfos",
"in": "body",
"description": "List of articleQuantityInfos that is to be relatively increased with current stock value.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleQuantityInfo"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/articles/increasestock": {
"put": {
"tags": [
"Articles"
],
"summary": "Update stock - increase stock.",
"operationId": "Articles_IncreaseStock",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "articleQuantityInfos",
"in": "body",
"description": "List of articleQuantityInfos that is to be relatively increased with current stock value.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleQuantityInfo"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleResult"
}
}
}
}
},
"/v2/articles/decreasestock": {
"put": {
"tags": [
"Articles"
],
"summary": "Update stock - decrease stock.",
"operationId": "Articles_DecreaseStock",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "articleQuantityInfos",
"in": "body",
"description": "List of articleQuantityInfos that is to be relatively decreased with current stock value.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleQuantityInfo"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/articles/decreasestock": {
"put": {
"tags": [
"Articles"
],
"summary": "Update stock - decrease stock.",
"operationId": "Articles_DecreaseStock",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "articleQuantityInfos",
"in": "body",
"description": "List of articleQuantityInfos that is to be relatively decreased with current stock value.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleQuantityInfo"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleResult"
}
}
}
}
},
"/v2/articles/{ArticleNumber}": {
"get": {
"tags": [
"Articles"
],
"summary": "Hämta en artikel - se flagga.",
"operationId": "Articles_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "ArticleNumber",
"in": "path",
"description": "Artikelnummer på artikeln som skall hämtas.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleGetResult"
}
}
}
}
},
"/v3/articles/article": {
"get": {
"tags": [
"Articles"
],
"summary": "Hämta en artikel - se flagga.",
"operationId": "Articles_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "ArticleNumber",
"in": "query",
"description": "Artikelnummer på artikeln som skall hämtas.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleGetResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/articles/{ArticleNumber}": {
"get": {
"tags": [
"Articles"
],
"summary": "Hämta en artikel - se flagga.",
"operationId": "Articles_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "ArticleNumber",
"in": "path",
"description": "Artikelnummer på artikeln som skall hämtas.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleGetResult"
}
}
}
}
},
"/v3/stores/{externalStoreId}/articles/article": {
"get": {
"tags": [
"Articles"
],
"summary": "Hämta en artikel - se flagga.",
"operationId": "Articles_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "ArticleNumber",
"in": "query",
"description": "Artikelnummer på artikeln som skall hämtas.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleGetResult"
}
}
}
}
},
"/v3/articles-availabilities": {
"get": {
"tags": [
"ArticlesAvailability"
],
"operationId": "ArticlesAvailability_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "updatedSince",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.ArticlesAvailabilitiesResult"
}
}
}
}
},
"/v3/stores/{externalStoreId}/articles-availabilities": {
"get": {
"tags": [
"ArticlesAvailability"
],
"operationId": "ArticlesAvailability_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "updatedSince",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.ArticlesAvailabilitiesResult"
}
}
}
}
},
"/v2/articlesets": {
"get": {
"tags": [
"ArticleSets"
],
"summary": "Get all artcile sets.",
"operationId": "ArticleSets_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "UpdatedSince",
"in": "query",
"description": "Get sets updated since.",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSetsResult"
}
}
}
},
"put": {
"tags": [
"ArticleSets"
],
"summary": "Update article sets.",
"operationId": "ArticleSets_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "articleSets",
"in": "body",
"description": "List of article sets to update.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSet"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "Id of store if multi store admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSetsResult"
}
}
}
},
"post": {
"tags": [
"ArticleSets"
],
"summary": "Create article sets.",
"operationId": "ArticleSets_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "articleSets",
"in": "body",
"description": "List of article sets to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSetCreate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSetsResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/articlesets": {
"get": {
"tags": [
"ArticleSets"
],
"summary": "Get all artcile sets.",
"operationId": "ArticleSets_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "UpdatedSince",
"in": "query",
"description": "Get sets updated since.",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSetsResult"
}
}
}
},
"put": {
"tags": [
"ArticleSets"
],
"summary": "Update article sets.",
"operationId": "ArticleSets_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "articleSets",
"in": "body",
"description": "List of article sets to update.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSet"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "Id of store if multi store admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSetsResult"
}
}
}
},
"post": {
"tags": [
"ArticleSets"
],
"summary": "Create article sets.",
"operationId": "ArticleSets_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "articleSets",
"in": "body",
"description": "List of article sets to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSetCreate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSetsResult"
}
}
}
}
},
"/v2/articlesets/{ArticleNumber}": {
"get": {
"tags": [
"ArticleSets"
],
"summary": "Get an artcile set.",
"operationId": "ArticleSets_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "ArticleNumber",
"in": "path",
"description": "Article number",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSetResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/articlesets/{ArticleNumber}": {
"get": {
"tags": [
"ArticleSets"
],
"summary": "Get an artcile set.",
"operationId": "ArticleSets_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "ArticleNumber",
"in": "path",
"description": "Article number",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSetResult"
}
}
}
}
},
"/v2/bookings/resourceeventinsances": {
"get": {
"tags": [
"BookableResourceEventInstances"
],
"summary": "Get all bookable resource event instances.",
"operationId": "BookableResourceEventInstances_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "updatedSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookableResourceEventInstancesResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/bookings/resourceeventinsances": {
"get": {
"tags": [
"BookableResourceEventInstances"
],
"summary": "Get all bookable resource event instances.",
"operationId": "BookableResourceEventInstances_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "updatedSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookableResourceEventInstancesResult"
}
}
}
}
},
"/v2/bookings/resources": {
"get": {
"tags": [
"BookableResources"
],
"summary": "Get all bookable resources.",
"operationId": "BookableResources_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "updatedSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookableResourcesResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/bookings/resources": {
"get": {
"tags": [
"BookableResources"
],
"summary": "Get all bookable resources.",
"operationId": "BookableResources_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "updatedSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookableResourcesResult"
}
}
}
}
},
"/v2/bookingorders": {
"get": {
"tags": [
"BookingOrders"
],
"summary": "Get all bookinging orders.",
"operationId": "BookingOrders_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "updatedSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "startTimeSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookingOrdersResult"
}
}
}
},
"put": {
"tags": [
"BookingOrders"
],
"summary": "Update list of bookingorders.",
"operationId": "BookingOrders_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bookingorders",
"in": "body",
"description": "List of bookingorders to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookingOrder"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrdersResult"
}
}
}
},
"post": {
"tags": [
"BookingOrders"
],
"summary": "Create bookingorders.",
"operationId": "BookingOrders_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bookingorders",
"in": "body",
"description": "List of BookingOrder to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookingOrderCreate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookingOrdersResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/bookingorders": {
"get": {
"tags": [
"BookingOrders"
],
"summary": "Get all bookinging orders.",
"operationId": "BookingOrders_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "updatedSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "startTimeSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookingOrdersResult"
}
}
}
},
"put": {
"tags": [
"BookingOrders"
],
"summary": "Update list of bookingorders.",
"operationId": "BookingOrders_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bookingorders",
"in": "body",
"description": "List of bookingorders to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookingOrder"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrdersResult"
}
}
}
},
"post": {
"tags": [
"BookingOrders"
],
"summary": "Create bookingorders.",
"operationId": "BookingOrders_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bookingorders",
"in": "body",
"description": "List of BookingOrder to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookingOrderCreate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookingOrdersResult"
}
}
}
}
},
"/v2/bookingorders/byExternalReference/{externalReference}": {
"get": {
"tags": [
"BookingOrders"
],
"summary": "Get a order.",
"operationId": "BookingOrders_GetByExternalReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalReference",
"in": "path",
"description": "External reference of the service order.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/bookingorders/byExternalReference/{externalReference}": {
"get": {
"tags": [
"BookingOrders"
],
"summary": "Get a order.",
"operationId": "BookingOrders_GetByExternalReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalReference",
"in": "path",
"description": "External reference of the service order.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleResult"
}
}
}
}
},
"/v2/bookingorders/byId/{Id}": {
"get": {
"tags": [
"BookingOrders"
],
"summary": "Get a order.",
"operationId": "BookingOrders_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "External reference",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrderResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/bookingorders/byId/{Id}": {
"get": {
"tags": [
"BookingOrders"
],
"summary": "Get a order.",
"operationId": "BookingOrders_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "External reference",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrderResult"
}
}
}
}
},
"/v2/brands": {
"get": {
"tags": [
"Brands"
],
"summary": "Get all brands.",
"operationId": "Brands_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BrandsResult"
}
}
}
},
"put": {
"tags": [
"Brands"
],
"summary": "Update list of brands.",
"operationId": "Brands_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "brands",
"in": "body",
"description": "List of brands to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Brand"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BrandsResult"
}
}
}
},
"post": {
"tags": [
"Brands"
],
"summary": "Create brands.",
"operationId": "Brands_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "brands",
"in": "body",
"description": "List of articles to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BrandCreate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BrandsResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/brands": {
"get": {
"tags": [
"Brands"
],
"summary": "Get all brands.",
"operationId": "Brands_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BrandsResult"
}
}
}
},
"put": {
"tags": [
"Brands"
],
"summary": "Update list of brands.",
"operationId": "Brands_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "brands",
"in": "body",
"description": "List of brands to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Brand"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BrandsResult"
}
}
}
},
"post": {
"tags": [
"Brands"
],
"summary": "Create brands.",
"operationId": "Brands_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "brands",
"in": "body",
"description": "List of articles to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BrandCreate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BrandsResult"
}
}
}
}
},
"/v2/brands/{Id}": {
"delete": {
"tags": [
"Brands"
],
"summary": "Delete a brand.",
"operationId": "Brands_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of brand to be deleted.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BrandResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/brands/{Id}": {
"delete": {
"tags": [
"Brands"
],
"summary": "Delete a brand.",
"operationId": "Brands_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of brand to be deleted.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BrandResult"
}
}
}
}
},
"/v2/campaigns": {
"get": {
"tags": [
"Campaigns"
],
"summary": "Get all campaigns.",
"operationId": "Campaigns_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSetsResult"
}
}
}
},
"put": {
"tags": [
"Campaigns"
],
"summary": "Update article sets.",
"operationId": "Campaigns_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "campaigns",
"in": "body",
"description": "List of campaigns sets to update.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Campaign"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CampaignsResult"
}
}
}
},
"post": {
"tags": [
"Campaigns"
],
"summary": "Create campaigns.",
"operationId": "Campaigns_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "campaigns",
"in": "body",
"description": "List of campaigns to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CampaignCreate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CampaignsResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/campaigns": {
"get": {
"tags": [
"Campaigns"
],
"summary": "Get all campaigns.",
"operationId": "Campaigns_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSetsResult"
}
}
}
},
"put": {
"tags": [
"Campaigns"
],
"summary": "Update article sets.",
"operationId": "Campaigns_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "campaigns",
"in": "body",
"description": "List of campaigns sets to update.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Campaign"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CampaignsResult"
}
}
}
},
"post": {
"tags": [
"Campaigns"
],
"summary": "Create campaigns.",
"operationId": "Campaigns_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "campaigns",
"in": "body",
"description": "List of campaigns to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CampaignCreate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CampaignsResult"
}
}
}
}
},
"/v2/campaigns/{Id}": {
"get": {
"tags": [
"Campaigns"
],
"summary": "Get a campaign.",
"operationId": "Campaigns_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of campaign.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CampaignResult"
}
}
}
},
"delete": {
"tags": [
"Campaigns"
],
"summary": "Delete a campaign.",
"operationId": "Campaigns_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of campaign to be deleted.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CampaignResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/campaigns/{Id}": {
"get": {
"tags": [
"Campaigns"
],
"summary": "Get a campaign.",
"operationId": "Campaigns_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of campaign.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CampaignResult"
}
}
}
},
"delete": {
"tags": [
"Campaigns"
],
"summary": "Delete a campaign.",
"operationId": "Campaigns_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of campaign to be deleted.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CampaignResult"
}
}
}
}
},
"/v2/cashcards/balance": {
"get": {
"tags": [
"CashCards"
],
"summary": "Fetech balance on cash cards.",
"operationId": "CashCards_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CashCardsBalanceResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/cashcards/balance": {
"get": {
"tags": [
"CashCards"
],
"summary": "Fetech balance on cash cards.",
"operationId": "CashCards_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CashCardsBalanceResult"
}
}
}
}
},
"/v2/cashierusers": {
"get": {
"tags": [
"CashierUsers"
],
"summary": "Get all cashier users.",
"operationId": "CashierUsers_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CashierUsersResult"
}
}
}
},
"put": {
"tags": [
"CashierUsers"
],
"summary": "Update cashier users.",
"operationId": "CashierUsers_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "cashierUsers",
"in": "body",
"description": "List of cashier users to update.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CashierUser"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CashierUsersResult"
}
}
}
},
"post": {
"tags": [
"CashierUsers"
],
"summary": "Create cashier users.",
"operationId": "CashierUsers_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "cashierUsers",
"in": "body",
"description": "List of cashier users to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CashierUserCreate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CashierUsersResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/cashierusers": {
"get": {
"tags": [
"CashierUsers"
],
"summary": "Get all cashier users.",
"operationId": "CashierUsers_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CashierUsersResult"
}
}
}
},
"put": {
"tags": [
"CashierUsers"
],
"summary": "Update cashier users.",
"operationId": "CashierUsers_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "cashierUsers",
"in": "body",
"description": "List of cashier users to update.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CashierUser"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CashierUsersResult"
}
}
}
},
"post": {
"tags": [
"CashierUsers"
],
"summary": "Create cashier users.",
"operationId": "CashierUsers_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "cashierUsers",
"in": "body",
"description": "List of cashier users to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CashierUserCreate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CashierUsersResult"
}
}
}
}
},
"/v2/customers": {
"put": {
"tags": [
"Customers"
],
"summary": "Update customers.",
"operationId": "Customers_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "customers",
"in": "body",
"description": "List of cashier users to update.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomerUpdate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "Id to update if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomersResult"
}
}
}
},
"post": {
"tags": [
"Customers"
],
"summary": "Create customers.",
"operationId": "Customers_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "customers",
"in": "body",
"description": "List of customers to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomerCreate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "Id to update if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomersResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/customers": {
"put": {
"tags": [
"Customers"
],
"summary": "Update customers.",
"operationId": "Customers_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "customers",
"in": "body",
"description": "List of cashier users to update.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomerUpdate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "Id to update if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomersResult"
}
}
}
},
"post": {
"tags": [
"Customers"
],
"summary": "Create customers.",
"operationId": "Customers_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "customers",
"in": "body",
"description": "List of customers to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomerCreate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "Id to update if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomersResult"
}
}
}
}
},
"/v2/customers/find": {
"post": {
"tags": [
"Customers"
],
"summary": "Find customer",
"operationId": "Customers_Find",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "query",
"in": "body",
"description": "Search information.",
"required": true,
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomerSearchQuery"
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "Id to update if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomersResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/customers/find": {
"post": {
"tags": [
"Customers"
],
"summary": "Find customer",
"operationId": "Customers_Find",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "query",
"in": "body",
"description": "Search information.",
"required": true,
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomerSearchQuery"
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "Id to update if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomersResult"
}
}
}
}
},
"/v2/customers/get/{customerNumber}": {
"get": {
"tags": [
"Customers"
],
"summary": "Get customer",
"operationId": "Customers_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "customerNumber",
"in": "path",
"description": "Customer number.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "Id to update if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomersResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/customers/get/{customerNumber}": {
"get": {
"tags": [
"Customers"
],
"summary": "Get customer",
"operationId": "Customers_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "customerNumber",
"in": "path",
"description": "Customer number.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "Id to update if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomersResult"
}
}
}
}
},
"/v2/customers/nextcustomernumber": {
"get": {
"tags": [
"Customers"
],
"summary": "Get Next Available Customer Number\r\n Id to update if multistore admin.",
"operationId": "Customers_GetNextAvailableCustomerNumber",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
}
}
}
},
"/v2/stores/{externalStoreId}/customers/nextcustomernumber": {
"get": {
"tags": [
"Customers"
],
"summary": "Get Next Available Customer Number\r\n Id to update if multistore admin.",
"operationId": "Customers_GetNextAvailableCustomerNumber",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
}
}
}
},
"/v2/groups": {
"get": {
"tags": [
"Groups"
],
"summary": "Get all groups.",
"operationId": "Groups_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.GroupsResult"
}
}
}
},
"put": {
"tags": [
"Groups"
],
"summary": "Update list of groups.",
"operationId": "Groups_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "groups",
"in": "body",
"description": "List of groups to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Group"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.GroupsResult"
}
}
}
},
"post": {
"tags": [
"Groups"
],
"summary": "Create groups.\r\n Id to update if multistore admin. List of groups.",
"operationId": "Groups_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "groups",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.GroupCreate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.GroupsResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/groups": {
"get": {
"tags": [
"Groups"
],
"summary": "Get all groups.",
"operationId": "Groups_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.GroupsResult"
}
}
}
},
"put": {
"tags": [
"Groups"
],
"summary": "Update list of groups.",
"operationId": "Groups_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "groups",
"in": "body",
"description": "List of groups to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Group"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.GroupsResult"
}
}
}
},
"post": {
"tags": [
"Groups"
],
"summary": "Create groups.\r\n Id to update if multistore admin. List of groups.",
"operationId": "Groups_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "groups",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.GroupCreate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.GroupsResult"
}
}
}
}
},
"/v2/groups/{Id}": {
"get": {
"tags": [
"Groups"
],
"summary": "Get a specific group",
"operationId": "Groups_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of group.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.GroupResult"
}
}
}
},
"delete": {
"tags": [
"Groups"
],
"summary": "Delete a group.",
"operationId": "Groups_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of group to be deleted.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.GroupResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/groups/{Id}": {
"get": {
"tags": [
"Groups"
],
"summary": "Get a specific group",
"operationId": "Groups_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of group.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.GroupResult"
}
}
}
},
"delete": {
"tags": [
"Groups"
],
"summary": "Delete a group.",
"operationId": "Groups_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of group to be deleted.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.GroupResult"
}
}
}
}
},
"/health": {
"get": {
"tags": [
"Health"
],
"operationId": "Health_Health",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/v2/locations": {
"get": {
"tags": [
"Locations"
],
"summary": "Get all locations.",
"operationId": "Locations_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.LocationsResult"
}
}
}
},
"put": {
"tags": [
"Locations"
],
"summary": "Update list of locations.",
"operationId": "Locations_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "locations",
"in": "body",
"description": "List of locations to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Location"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.LocationsResult"
}
}
}
},
"post": {
"tags": [
"Locations"
],
"summary": "Create locations.",
"operationId": "Locations_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "locations",
"in": "body",
"description": "List of articles to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.LocationCreate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.LocationsResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/locations": {
"get": {
"tags": [
"Locations"
],
"summary": "Get all locations.",
"operationId": "Locations_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.LocationsResult"
}
}
}
},
"put": {
"tags": [
"Locations"
],
"summary": "Update list of locations.",
"operationId": "Locations_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "locations",
"in": "body",
"description": "List of locations to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Location"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.LocationsResult"
}
}
}
},
"post": {
"tags": [
"Locations"
],
"summary": "Create locations.",
"operationId": "Locations_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "locations",
"in": "body",
"description": "List of articles to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.LocationCreate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.LocationsResult"
}
}
}
}
},
"/v2/locations/{Id}": {
"delete": {
"tags": [
"Locations"
],
"summary": "Delete a location.",
"operationId": "Locations_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of location to be deleted.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.LocationResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/locations/{Id}": {
"delete": {
"tags": [
"Locations"
],
"summary": "Delete a location.",
"operationId": "Locations_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of location to be deleted.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.LocationResult"
}
}
}
}
},
"/v2/online/paymentmethods": {
"get": {
"tags": [
"OnlineSolutions"
],
"summary": "Get all online payment methods.",
"operationId": "OnlineSolutions_GetOnlinePaymentMethods",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "updatedSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlinePaymentMethodsResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/online/paymentmethods": {
"get": {
"tags": [
"OnlineSolutions"
],
"summary": "Get all online payment methods.",
"operationId": "OnlineSolutions_GetOnlinePaymentMethods",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "updatedSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlinePaymentMethodsResult"
}
}
}
}
},
"/v2/online/catering/settings": {
"get": {
"tags": [
"OnlineSolutions"
],
"summary": "Get catering settings.",
"operationId": "OnlineSolutions_GetCateringSettings",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberCateringSettingResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/online/catering/settings": {
"get": {
"tags": [
"OnlineSolutions"
],
"summary": "Get catering settings.",
"operationId": "OnlineSolutions_GetCateringSettings",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberCateringSettingResult"
}
}
}
}
},
"/v2/online/expressorder/settings": {
"get": {
"tags": [
"OnlineSolutions"
],
"summary": "Get express order settings.",
"operationId": "OnlineSolutions_GetExpressOrderSettings",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineExpressOrderSettingResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/online/expressorder/settings": {
"get": {
"tags": [
"OnlineSolutions"
],
"summary": "Get express order settings.",
"operationId": "OnlineSolutions_GetExpressOrderSettings",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineExpressOrderSettingResult"
}
}
}
}
},
"/v2/online/selfscan/settings": {
"get": {
"tags": [
"OnlineSolutions"
],
"summary": "Get selfscan settings.",
"operationId": "OnlineSolutions_GetSelfscanSettings",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberSelfscanSettingResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/online/selfscan/settings": {
"get": {
"tags": [
"OnlineSolutions"
],
"summary": "Get selfscan settings.",
"operationId": "OnlineSolutions_GetSelfscanSettings",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberSelfscanSettingResult"
}
}
}
}
},
"/v2/online/webshop/settings": {
"get": {
"tags": [
"OnlineSolutions"
],
"summary": "Get webshop settings.",
"operationId": "OnlineSolutions_GetWebshopSettings",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberWebshopSettingResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/online/webshop/settings": {
"get": {
"tags": [
"OnlineSolutions"
],
"summary": "Get webshop settings.",
"operationId": "OnlineSolutions_GetWebshopSettings",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberWebshopSettingResult"
}
}
}
}
},
"/v2/orders": {
"put": {
"tags": [
"Orders"
],
"summary": "Update list of orders.",
"operationId": "Orders_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "orders",
"in": "body",
"description": "List of orders to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Order"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrdersResult"
}
}
}
},
"post": {
"tags": [
"Orders"
],
"summary": "Create orders.",
"operationId": "Orders_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "orders",
"in": "body",
"description": "List of orders to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrderCreate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrdersResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/orders": {
"put": {
"tags": [
"Orders"
],
"summary": "Update list of orders.",
"operationId": "Orders_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "orders",
"in": "body",
"description": "List of orders to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Order"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrdersResult"
}
}
}
},
"post": {
"tags": [
"Orders"
],
"summary": "Create orders.",
"operationId": "Orders_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "orders",
"in": "body",
"description": "List of orders to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrderCreate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrdersResult"
}
}
}
}
},
"/v2/orders/byExternalReference/{externalReference}": {
"get": {
"tags": [
"Orders"
],
"summary": "Get a order.",
"operationId": "Orders_GetByExternalReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalReference",
"in": "path",
"description": "External reference of the service order.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/orders/byExternalReference/{externalReference}": {
"get": {
"tags": [
"Orders"
],
"summary": "Get a order.",
"operationId": "Orders_GetByExternalReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalReference",
"in": "path",
"description": "External reference of the service order.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleResult"
}
}
}
}
},
"/v2/orders/byId/{Id}": {
"get": {
"tags": [
"Orders"
],
"summary": "Get a order.",
"operationId": "Orders_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "External reference",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrderResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/orders/byId/{Id}": {
"get": {
"tags": [
"Orders"
],
"summary": "Get a order.",
"operationId": "Orders_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "External reference",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrderResult"
}
}
}
}
},
"/v3/orders": {
"get": {
"tags": [
"OrdersV3"
],
"summary": "Get list of orders.",
"operationId": "OrdersV3_List",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "modifiedSince",
"in": "query",
"description": "",
"required": true,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.OrderResult"
}
}
}
},
"put": {
"tags": [
"OrdersV3"
],
"summary": "Update list of orders.",
"operationId": "OrdersV3_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "orders",
"in": "body",
"description": "List of orders to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.Order"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.OrdersResult"
}
}
}
},
"post": {
"tags": [
"OrdersV3"
],
"summary": "Create orders.",
"operationId": "OrdersV3_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "orders",
"in": "body",
"description": "List of orders to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.OrderCreate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.OrdersResult"
}
}
}
}
},
"/v3/stores/{externalStoreId}/orders": {
"get": {
"tags": [
"OrdersV3"
],
"summary": "Get list of orders.",
"operationId": "OrdersV3_List",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "modifiedSince",
"in": "query",
"description": "",
"required": true,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.OrderResult"
}
}
}
},
"put": {
"tags": [
"OrdersV3"
],
"summary": "Update list of orders.",
"operationId": "OrdersV3_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "orders",
"in": "body",
"description": "List of orders to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.Order"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.OrdersResult"
}
}
}
},
"post": {
"tags": [
"OrdersV3"
],
"summary": "Create orders.",
"operationId": "OrdersV3_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "orders",
"in": "body",
"description": "List of orders to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.OrderCreate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.OrdersResult"
}
}
}
}
},
"/v3/orders/byExternalReference/{externalReference}": {
"get": {
"tags": [
"OrdersV3"
],
"summary": "Get a order.",
"operationId": "OrdersV3_GetByExternalReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalReference",
"in": "path",
"description": "External reference of the order.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.OrderResult"
}
}
}
}
},
"/v3/stores/{externalStoreId}/orders/byExternalReference/{externalReference}": {
"get": {
"tags": [
"OrdersV3"
],
"summary": "Get a order.",
"operationId": "OrdersV3_GetByExternalReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalReference",
"in": "path",
"description": "External reference of the order.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.OrderResult"
}
}
}
}
},
"/v3/orders/byId/{Id}": {
"get": {
"tags": [
"OrdersV3"
],
"summary": "Get a order.",
"operationId": "OrdersV3_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "External reference",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.OrderResult"
}
}
}
}
},
"/v3/stores/{externalStoreId}/orders/byId/{Id}": {
"get": {
"tags": [
"OrdersV3"
],
"summary": "Get a order.",
"operationId": "OrdersV3_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "External reference",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.OrderResult"
}
}
}
}
},
"/v2/receipts/{id}": {
"get": {
"tags": [
"Receipts"
],
"summary": "Get a receipt",
"operationId": "Receipts_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the receipt to get",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ReceiptResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/receipts/{id}": {
"get": {
"tags": [
"Receipts"
],
"summary": "Get a receipt",
"operationId": "Receipts_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the receipt to get",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ReceiptResult"
}
}
}
}
},
"/v2/receipts": {
"get": {
"tags": [
"Receipts"
],
"summary": "Get a list of receipts",
"operationId": "Receipts_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Which page to get. The default value is 0, the first page.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "How many receipt to get. Default value is 100, max value is 1000",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "createdAfterUTC",
"in": "query",
"description": "Only get receipts created in MoreFlo after this date, UTC time. This is NOT the date of the receipt transaction, but when it was created in MoreFlo.",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ReceiptsResult"
}
}
}
},
"post": {
"tags": [
"Receipts"
],
"summary": "Create a receipt",
"operationId": "Receipts_CreateReceipt",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "receipt",
"in": "body",
"description": "The receipt to create in MoreFlo",
"required": true,
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.Receipt"
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ReceiptResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/receipts": {
"get": {
"tags": [
"Receipts"
],
"summary": "Get a list of receipts",
"operationId": "Receipts_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Which page to get. The default value is 0, the first page.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "How many receipt to get. Default value is 100, max value is 1000",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "createdAfterUTC",
"in": "query",
"description": "Only get receipts created in MoreFlo after this date, UTC time. This is NOT the date of the receipt transaction, but when it was created in MoreFlo.",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ReceiptsResult"
}
}
}
},
"post": {
"tags": [
"Receipts"
],
"summary": "Create a receipt",
"operationId": "Receipts_CreateReceipt",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "receipt",
"in": "body",
"description": "The receipt to create in MoreFlo",
"required": true,
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.Receipt"
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ReceiptResult"
}
}
}
}
},
"/v2/sales/articles": {
"get": {
"tags": [
"Sales"
],
"summary": "Get all article sale events.",
"operationId": "Sales_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "from",
"in": "query",
"description": "From time created, could differ from sales time if syncronization was delayed.",
"required": true,
"type": "string",
"format": "date-time"
},
{
"name": "to",
"in": "query",
"description": "To time, defualt to today 23:59:59.",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100 and max 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSaleEventsResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/sales/articles": {
"get": {
"tags": [
"Sales"
],
"summary": "Get all article sale events.",
"operationId": "Sales_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "from",
"in": "query",
"description": "From time created, could differ from sales time if syncronization was delayed.",
"required": true,
"type": "string",
"format": "date-time"
},
{
"name": "to",
"in": "query",
"description": "To time, defualt to today 23:59:59.",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100 and max 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSaleEventsResult"
}
}
}
}
},
"/v2/serviceorders": {
"get": {
"tags": [
"ServiceOrders"
],
"summary": "Get all service orders.",
"operationId": "ServiceOrders_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "updatedSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrdersResult"
}
}
}
},
"put": {
"tags": [
"ServiceOrders"
],
"summary": "Update list of serviceOrders.",
"operationId": "ServiceOrders_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "serviceOrders",
"in": "body",
"description": "List of serviceOrders to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrder"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrdersResult"
}
}
}
},
"post": {
"tags": [
"ServiceOrders"
],
"summary": "Create service orders.",
"operationId": "ServiceOrders_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "serviceOrders",
"in": "body",
"description": "List of service orders to create, e.g. bookings of haircut or service of bicycles or phones.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrderCreate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrdersResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/serviceorders": {
"get": {
"tags": [
"ServiceOrders"
],
"summary": "Get all service orders.",
"operationId": "ServiceOrders_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "updatedSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrdersResult"
}
}
}
},
"put": {
"tags": [
"ServiceOrders"
],
"summary": "Update list of serviceOrders.",
"operationId": "ServiceOrders_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "serviceOrders",
"in": "body",
"description": "List of serviceOrders to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrder"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrdersResult"
}
}
}
},
"post": {
"tags": [
"ServiceOrders"
],
"summary": "Create service orders.",
"operationId": "ServiceOrders_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "serviceOrders",
"in": "body",
"description": "List of service orders to create, e.g. bookings of haircut or service of bicycles or phones.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrderCreate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrdersResult"
}
}
}
}
},
"/v2/serviceorders/{Id}": {
"get": {
"tags": [
"ServiceOrders"
],
"summary": "Get a service order.",
"operationId": "ServiceOrders_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "External reference of the service order.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrderResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/serviceorders/{Id}": {
"get": {
"tags": [
"ServiceOrders"
],
"summary": "Get a service order.",
"operationId": "ServiceOrders_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "External reference of the service order.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrderResult"
}
}
}
}
},
"/v2/settings": {
"get": {
"tags": [
"Settings"
],
"summary": "Fetch settings.",
"operationId": "Settings_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SettingsResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/settings": {
"get": {
"tags": [
"Settings"
],
"summary": "Fetch settings.",
"operationId": "Settings_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SettingsResult"
}
}
}
}
},
"/v2/bookings/settings": {
"get": {
"tags": [
"Settings"
],
"summary": "Fetch booking settings.",
"operationId": "Settings_GetBookingSettings",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookingSettingsResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/bookings/settings": {
"get": {
"tags": [
"Settings"
],
"summary": "Fetch booking settings.",
"operationId": "Settings_GetBookingSettings",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookingSettingsResult"
}
}
}
}
},
"/v2/sms/single": {
"post": {
"tags": [
"Sms"
],
"summary": "Send a single SMS, if format errors response will be 400, if sending was started but failed the response will be 409.",
"operationId": "Sms_SendSms",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "smsMessage",
"in": "body",
"description": "Sms content and receiver, receiver must be in internationalized fomat starting with '+'.",
"required": true,
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SmsMessage"
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SmsSendResult"
}
}
}
}
},
"/v2/sms/{externalStoreId}/single": {
"post": {
"tags": [
"Sms"
],
"summary": "Send a single SMS, if format errors response will be 400, if sending was started but failed the response will be 409.",
"operationId": "Sms_SendSms",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "smsMessage",
"in": "body",
"description": "Sms content and receiver, receiver must be in internationalized fomat starting with '+'.",
"required": true,
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SmsMessage"
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SmsSendResult"
}
}
}
}
},
"/v2/stores": {
"get": {
"tags": [
"Stores"
],
"summary": "Hämta en butik - se flagga.",
"operationId": "Stores_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.StoresResult"
}
}
}
},
"post": {
"tags": [
"Stores"
],
"summary": "Create a store.",
"operationId": "Stores_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "store",
"in": "body",
"description": "Store data.",
"required": true,
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.StoreCreate"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.StoreResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}": {
"get": {
"tags": [
"Stores"
],
"summary": "Hämta en butik - se flagga.",
"operationId": "Stores_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "path",
"description": "Extern referens på butiken som skall hämtas.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.StoreResult"
}
}
}
},
"put": {
"tags": [
"Stores"
],
"summary": "Uppdatera en butik.",
"operationId": "Stores_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalStoreId",
"in": "path",
"description": "Id to update.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "store",
"in": "body",
"description": "Information om butiken som skall updateras.",
"required": true,
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Store"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.StoreResult"
}
}
}
}
},
"/v2/suppliers": {
"get": {
"tags": [
"Suppliers"
],
"summary": "Get all suppliers.",
"operationId": "Suppliers_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SuppliersResult"
}
}
}
},
"put": {
"tags": [
"Suppliers"
],
"summary": "Update list of suppliers.",
"operationId": "Suppliers_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "suppliers",
"in": "body",
"description": "List of suppliers to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Supplier"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SuppliersResult"
}
}
}
},
"post": {
"tags": [
"Suppliers"
],
"summary": "Create suppliers.",
"operationId": "Suppliers_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "suppliers",
"in": "body",
"description": "List of articles to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SupplierCreate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SuppliersResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/suppliers": {
"get": {
"tags": [
"Suppliers"
],
"summary": "Get all suppliers.",
"operationId": "Suppliers_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SuppliersResult"
}
}
}
},
"put": {
"tags": [
"Suppliers"
],
"summary": "Update list of suppliers.",
"operationId": "Suppliers_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "suppliers",
"in": "body",
"description": "List of suppliers to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Supplier"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SuppliersResult"
}
}
}
},
"post": {
"tags": [
"Suppliers"
],
"summary": "Create suppliers.",
"operationId": "Suppliers_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "suppliers",
"in": "body",
"description": "List of articles to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SupplierCreate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SuppliersResult"
}
}
}
}
},
"/v2/suppliers/{Id}": {
"delete": {
"tags": [
"Suppliers"
],
"summary": "Delete a supplier.",
"operationId": "Suppliers_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of supplier to be deleted.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SupplierResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/suppliers/{Id}": {
"delete": {
"tags": [
"Suppliers"
],
"summary": "Delete a supplier.",
"operationId": "Suppliers_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of supplier to be deleted.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SupplierResult"
}
}
}
}
},
"/v2/ticketorders": {
"put": {
"tags": [
"TicketOrders"
],
"summary": "Update list of ticketorders.",
"operationId": "TicketOrders_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "ticketorders",
"in": "body",
"description": "List of ticketorders to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.TicketOrder"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrdersResult"
}
}
}
},
"post": {
"tags": [
"TicketOrders"
],
"summary": "Create ticketorders.",
"operationId": "TicketOrders_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "ticketorders",
"in": "body",
"description": "List of TicketOrder to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.TicketOrderCreate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.TicketOrdersResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/ticketorders": {
"put": {
"tags": [
"TicketOrders"
],
"summary": "Update list of ticketorders.",
"operationId": "TicketOrders_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "ticketorders",
"in": "body",
"description": "List of ticketorders to update data.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.TicketOrder"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrdersResult"
}
}
}
},
"post": {
"tags": [
"TicketOrders"
],
"summary": "Create ticketorders.",
"operationId": "TicketOrders_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "ticketorders",
"in": "body",
"description": "List of TicketOrder to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.TicketOrderCreate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.TicketOrdersResult"
}
}
}
}
},
"/v2/ticketorders/byExternalReference/{externalReference}": {
"get": {
"tags": [
"TicketOrders"
],
"summary": "Get a order.",
"operationId": "TicketOrders_GetByExternalReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalReference",
"in": "path",
"description": "External reference of the service order.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/ticketorders/byExternalReference/{externalReference}": {
"get": {
"tags": [
"TicketOrders"
],
"summary": "Get a order.",
"operationId": "TicketOrders_GetByExternalReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "externalReference",
"in": "path",
"description": "External reference of the service order.",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleResult"
}
}
}
}
},
"/v2/ticketorders/byId/{Id}": {
"get": {
"tags": [
"TicketOrders"
],
"summary": "Get a order.",
"operationId": "TicketOrders_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "External reference",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrderResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/ticketorders/byId/{Id}": {
"get": {
"tags": [
"TicketOrders"
],
"summary": "Get a order.",
"operationId": "TicketOrders_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "External reference",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrderResult"
}
}
}
}
},
"/v2/vouchers": {
"get": {
"tags": [
"Vouchers"
],
"summary": "Get list of vouchers.",
"operationId": "Vouchers_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "createdSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "voucherDateFrom",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "voucherDateTo",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "stateFilter",
"in": "query",
"description": "",
"required": false,
"type": "string",
"enum": [
"Pending",
"ActionRequried",
"Locked",
"Done"
]
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.VouchersResult"
}
}
}
},
"put": {
"tags": [
"Vouchers"
],
"summary": "Update vouchers.",
"operationId": "Vouchers_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "vouchers",
"in": "body",
"description": "List of vouchers to update.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Voucher"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrdersResult"
}
}
}
},
"post": {
"tags": [
"Vouchers"
],
"summary": "Create vouchers.",
"operationId": "Vouchers_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "vouchers",
"in": "body",
"description": "List of supporting vouchers to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Voucher"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.VouchersResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/vouchers": {
"get": {
"tags": [
"Vouchers"
],
"summary": "Get list of vouchers.",
"operationId": "Vouchers_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "createdSince",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "voucherDateFrom",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "voucherDateTo",
"in": "query",
"description": "",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "stateFilter",
"in": "query",
"description": "",
"required": false,
"type": "string",
"enum": [
"Pending",
"ActionRequried",
"Locked",
"Done"
]
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.VouchersResult"
}
}
}
},
"put": {
"tags": [
"Vouchers"
],
"summary": "Update vouchers.",
"operationId": "Vouchers_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "vouchers",
"in": "body",
"description": "List of vouchers to update.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Voucher"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrdersResult"
}
}
}
},
"post": {
"tags": [
"Vouchers"
],
"summary": "Create vouchers.",
"operationId": "Vouchers_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "vouchers",
"in": "body",
"description": "List of supporting vouchers to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Voucher"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.VouchersResult"
}
}
}
}
},
"/v2/vouchers/byId/{Id}": {
"get": {
"tags": [
"Vouchers"
],
"summary": "Get a voucher.",
"operationId": "Vouchers_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of voucher",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.VoucherResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/vouchers/byId/{Id}": {
"get": {
"tags": [
"Vouchers"
],
"summary": "Get a voucher.",
"operationId": "Vouchers_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of voucher",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.VoucherResult"
}
}
}
}
},
"/v2/webhookcategories": {
"get": {
"tags": [
"WebHookCategories"
],
"summary": "Get all web hook categories.",
"operationId": "WebHookCategories_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHookCategoriesResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/webhookcategories": {
"get": {
"tags": [
"WebHookCategories"
],
"summary": "Get all web hook categories.",
"operationId": "WebHookCategories_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHookCategoriesResult"
}
}
}
}
},
"/v2/webhooks": {
"get": {
"tags": [
"WebHooks"
],
"summary": "Get all web hooks.",
"operationId": "WebHooks_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "query",
"description": "externalStoreId of the store, if multistore admin.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHooksResult"
}
}
}
},
"put": {
"tags": [
"WebHooks"
],
"summary": "Update webhooks. User remote ip address must be in list of IPs resolved from host part in URL of webhook.",
"operationId": "WebHooks_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "webHooks",
"in": "body",
"description": "List of webhooks to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHook"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHooksResult"
}
}
}
},
"post": {
"tags": [
"WebHooks"
],
"summary": "Create webhooks. User remote ip address must be in list of IPs resolved from host part in URL of webhook.",
"operationId": "WebHooks_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "webHooks",
"in": "body",
"description": "List of webhooks to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHookCreate"
}
}
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHooksResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/webhooks": {
"get": {
"tags": [
"WebHooks"
],
"summary": "Get all web hooks.",
"operationId": "WebHooks_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page starts from 0 , default 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "PageSize, default 100.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "externalStoreId",
"in": "path",
"description": "externalStoreId of the store, if multistore admin.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHooksResult"
}
}
}
},
"put": {
"tags": [
"WebHooks"
],
"summary": "Update webhooks. User remote ip address must be in list of IPs resolved from host part in URL of webhook.",
"operationId": "WebHooks_Update",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "webHooks",
"in": "body",
"description": "List of webhooks to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHook"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHooksResult"
}
}
}
},
"post": {
"tags": [
"WebHooks"
],
"summary": "Create webhooks. User remote ip address must be in list of IPs resolved from host part in URL of webhook.",
"operationId": "WebHooks_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "webHooks",
"in": "body",
"description": "List of webhooks to create.",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHookCreate"
}
}
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHooksResult"
}
}
}
}
},
"/v2/webhooks/{Id}": {
"get": {
"tags": [
"WebHooks"
],
"summary": "Get a web hook.",
"operationId": "WebHooks_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of webhook",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHookResult"
}
}
}
},
"delete": {
"tags": [
"WebHooks"
],
"summary": "Delete a web hook.",
"operationId": "WebHooks_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of webhook",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHookResult"
}
}
}
}
},
"/v2/stores/{externalStoreId}/webhooks/{Id}": {
"get": {
"tags": [
"WebHooks"
],
"summary": "Get a web hook.",
"operationId": "WebHooks_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of webhook",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHookResult"
}
}
}
},
"delete": {
"tags": [
"WebHooks"
],
"summary": "Delete a web hook.",
"operationId": "WebHooks_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Id",
"in": "path",
"description": "Id of webhook",
"required": true,
"type": "string"
},
{
"name": "externalStoreId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHookResult"
}
}
}
}
}
},
"definitions": {
"MoreFlo.Models.InterfaceModels.AccountCodeCreate": {
"description": "Represents the data required to create a new account code.",
"required": [
"Name",
"VatRate",
"Description",
"Account",
"Id"
],
"type": "object",
"properties": {
"Name": {
"description": "The name of the account code (unique). Required for creation.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"VatRate": {
"format": "double",
"description": "The VAT rate associated with the account code. Required for creation.",
"type": "number"
},
"Description": {
"description": "A description of the account code. Required for creation.",
"type": "string"
},
"Account": {
"format": "int32",
"description": "The account number associated with the account code. Required for creation.",
"type": "integer"
},
"UpdateOnExisting": {
"description": "Indicates whether to update an existing account code if one with the same ID already exists.",
"type": "boolean"
},
"Id": {
"description": "The unique identifier of the account code.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"CostCenter": {
"description": "The cost center associated with the account code.",
"type": "string"
},
"Project": {
"description": "The project associated with the account code.",
"type": "string"
},
"TakeAwayAccount": {
"format": "int32",
"description": "Represents the account associated with takeaway-related transactions.",
"type": "integer"
},
"TakeAwayVatRate": {
"format": "double",
"description": "The VAT rate applicable to takeaway accounts.\r\nRepresents the VAT rate specific to transactions involving takeaway items.",
"type": "number"
},
"KeepRetailPriceForTakeAway": {
"description": "Indicates whether the retail price should be kept for takeaway transactions.",
"type": "boolean"
}
}
},
"MoreFlo.Models.InterfaceModels.AccountCodesResult": {
"description": "",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountCodeResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.AccountCodeResult": {
"description": "Represents the result of an operation involving an AccountCode entity.",
"type": "object",
"properties": {
"AccountCode": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountCode",
"description": "The AccountCode entity resulting from the operation."
},
"Id": {
"description": "The unique identifier of the AccountCode.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.AccountCode": {
"description": "Represents an account code with various properties.",
"required": [
"Id"
],
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the account code.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"Name": {
"description": "The name of the account code (unique).",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"VatRate": {
"format": "double",
"description": "The VAT rate associated with the account code.",
"type": "number"
},
"Description": {
"description": "A description of the account code.",
"type": "string"
},
"Account": {
"format": "int32",
"description": "The account number associated with the account code.",
"type": "integer"
},
"CostCenter": {
"description": "The cost center associated with the account code.",
"type": "string"
},
"Project": {
"description": "The project associated with the account code.",
"type": "string"
},
"TakeAwayAccount": {
"format": "int32",
"description": "Represents the account associated with takeaway-related transactions.",
"type": "integer"
},
"TakeAwayVatRate": {
"format": "double",
"description": "The VAT rate applicable to takeaway accounts.\r\nRepresents the VAT rate specific to transactions involving takeaway items.",
"type": "number"
},
"KeepRetailPriceForTakeAway": {
"description": "Indicates whether the retail price should be kept for takeaway transactions.",
"type": "boolean"
}
}
},
"MoreFlo.Models.InterfaceModels.AccountingSettings.VatAccountSettingsResult": {
"description": "Represents a paged result containing a list of VatAccountSettingResult objects.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountingSettings.VatAccountSettingResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.AccountingSettings.VatAccountSettingResult": {
"description": "Represents the result of an operation involving a VatAccountSetting entity.",
"type": "object",
"properties": {
"VatAccountSetting": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AccountingSettings.VatAccountSetting",
"description": "The VatAccountSetting entity resulting from the operation."
},
"Id": {
"description": "The unique identifier of the VatAccountSetting.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.AccountingSettings.VatAccountSetting": {
"description": "Represents a VAT account setting, associating a VAT rate with an account number.",
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the VAT account setting.",
"type": "string"
},
"AccountNumber": {
"format": "int32",
"description": "The account number associated with the VAT setting.",
"type": "integer"
},
"VatRate": {
"format": "double",
"description": "The VAT rate associated with the account.",
"type": "number"
}
}
},
"xFlo.Models.External.Api.Models.AccountingSettings.IncomeAccountSettingsResult": {
"description": "Represents a paginated result containing a list of income account setting results.\r\nThis class is used to return a collection of income account settings, along with pagination information and extra information, in API responses.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/xFlo.Models.External.Api.Models.AccountingSettings.IncomeAccountSettingResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"xFlo.Models.External.Api.Models.AccountingSettings.IncomeAccountSettingResult": {
"description": "Represents the result of an operation that returns an income account setting.\r\nThis class encapsulates an IncomeAccountSetting object and its unique identifier, typically used in API responses related to retrieving or managing income account settings.",
"type": "object",
"properties": {
"IncomeAccountSetting": {
"$ref": "#/definitions/xFlo.Models.External.Api.Models.AccountingSettings.IncomeAccountSetting",
"description": "The IncomeAccountSetting object containing the income account setting data."
},
"Id": {
"description": "The unique identifier of the income account setting.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"xFlo.Models.External.Api.Models.AccountingSettings.IncomeAccountSetting": {
"description": "Setting for income accounts for a specific payment type and source",
"type": "object",
"properties": {
"Id": {
"description": "Unique ID",
"type": "string"
},
"PaymentType": {
"description": "Payment type for the account number",
"enum": [
"NamedPayment",
"CashPayment",
"BankCardPayment",
"AppsCardPayment",
"AppsDebitCardPayment",
"Invoice",
"ExternalPayment",
"Change",
"Swish",
"ResursBank",
"NorthmillBNPL",
"NorthmillPayout",
"Klarna",
"Paypal",
"Stripe",
"SveaWebPay",
"WooPayments"
],
"type": "string"
},
"PaymentSource": {
"description": "Where this account should be used",
"enum": [
"Cashier",
"MoreFloOnlineSolution",
"MoreFloBooking",
"MoreFloEvent",
"MoreFloPay",
"General"
],
"type": "string"
},
"PaymentSourceArg1": {
"description": "If a PaymentSource has multiple devices, such as a MoreFlo Online Solution, this will differentiate between them",
"type": "string"
},
"PaymentSourceAlias": {
"description": "Custom alias for payment source if available",
"type": "string"
},
"AccountNumber": {
"format": "int32",
"description": "Income account number for payment type and source",
"type": "integer"
}
}
},
"xFlo.Models.External.Api.Models.AccountingSettings.OtherAccountSettingsResult": {
"description": "Represents a paginated result containing a list of other account setting results.\r\nThis class is used to return a collection of other account settings, along with pagination information and extra information, in API responses.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/xFlo.Models.External.Api.Models.AccountingSettings.OtherAccountSettingResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"xFlo.Models.External.Api.Models.AccountingSettings.OtherAccountSettingResult": {
"description": "Represents the result of an operation that returns an other account setting.\r\nThis class encapsulates an OtherAccountSetting object and its unique identifier, typically used in API responses related to retrieving or managing other account settings.",
"type": "object",
"properties": {
"OtherAccountSetting": {
"$ref": "#/definitions/xFlo.Models.External.Api.Models.AccountingSettings.OtherAccountSetting",
"description": "The OtherAccountSetting object containing the other account setting data."
},
"Id": {
"description": "The unique identifier of the other account setting.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"xFlo.Models.External.Api.Models.AccountingSettings.OtherAccountSetting": {
"description": "Represents settings for an other (non-standard) bookkeeping account.",
"type": "object",
"properties": {
"Id": {
"format": "int64",
"description": "The unique identifier of the other account setting.",
"type": "integer"
},
"Guid": {
"description": "A globally unique identifier for the other account setting.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"AccountType": {
"description": "The type of the other bookkeeping account.",
"enum": [
"Rounding",
"NortmillBankTransaction",
"NortmillBNPLFee",
"Shipping",
"FeeDebtBalance",
"FeeCost",
"PrePaidBalance",
"PrePaidDebtBalance",
"PrePaidVatBalance"
],
"type": "string"
},
"PaymentSource": {
"description": "Specifies where this account should be used (e.g., for a specific payment method).",
"enum": [
"Cashier",
"MoreFloOnlineSolution",
"MoreFloBooking",
"MoreFloEvent",
"MoreFloPay",
"General"
],
"type": "string"
},
"PaymentSourceArg1": {
"description": "If a PaymentSource has multiple devices or instances (e.g., a MoreFlo Online Solution), this will differentiate between them.",
"type": "string"
},
"AccountNumber": {
"format": "int32",
"description": "The income account number associated with the payment type and source.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.ArticleCreate": {
"description": "Represents the data required to create a new article.",
"required": [
"ArticleName",
"Unit",
"RetailPrice",
"IsActive",
"ArticleNumber"
],
"type": "object",
"properties": {
"ArticleName": {
"description": "The name of the article. Required for creation.",
"maxLength": 60,
"minLength": 0,
"type": "string"
},
"Unit": {
"description": "The unit of measurement for the article. Required for creation.",
"maxLength": 30,
"minLength": 0,
"type": "string"
},
"RetailPrice": {
"format": "double",
"description": "The retail price of the article including VAT. Required for creation.",
"type": "number"
},
"IsActive": {
"description": "Indicates whether the article is active or inactive. Required for creation.\r\nDefaults to true.",
"type": "boolean"
},
"UpdateOnExisting": {
"description": "Indicates whether to update an existing article if one with the same article number already exists.",
"type": "boolean"
},
"ArticleNumber": {
"description": "The unique article number.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"Quantity": {
"format": "double",
"description": "The quantity of the article.",
"type": "number"
},
"SupplierArticleNumber": {
"description": "The supplier's article number.",
"type": "string"
},
"SerialNumber": {
"description": "The serial number of the article.",
"type": "string"
},
"BrandId": {
"description": "The brand identifier of the article.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"GroupId": {
"description": "The group identifier of the article.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"Location": {
"description": "Specifies the storage location or warehouse where the stock item is kept.",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"ArticleDescription": {
"description": "The description or extra receipt text for the article.",
"maxLength": 60,
"minLength": 0,
"type": "string"
},
"ArticleGoodsType": {
"description": "Type of goods article, for example Tobacco",
"enum": [
"NotSet",
"Other",
"Alcohol",
"Tobacco",
"Gambling",
"Hazardous"
],
"type": "string"
},
"Barcode": {
"description": "Primary barcode for this article",
"maxLength": 20,
"minLength": 0,
"type": "string"
},
"BarcodeAlternatives": {
"description": "Alternative barcodes for this article",
"type": "array",
"items": {
"$ref": "#/definitions/xFlo.Models.Common.Models.Article.ArticleBarcode"
}
},
"LocationId": {
"description": "The location identifier of the article.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"SupplierId": {
"description": "The supplier identifier of the article.",
"type": "string"
},
"ProductModelReference": {
"description": "The product model reference for the article.",
"type": "string"
},
"AccountCodeId": {
"description": "The account code identifier of the article.",
"type": "string"
},
"InputPrice": {
"format": "double",
"description": "The input price of the article excluding VAT.",
"type": "number"
},
"RecommendedPrice": {
"format": "double",
"description": "The recommended price of the article including VAT.",
"type": "number"
},
"ArticleType": {
"description": "The type of the article, see enumeration.",
"enum": [
"Goods",
"Service",
"GiftCard",
"Prepay",
"ValueCard",
"GoodsMarginProfit",
"BuyGoodsMarginProfit",
"CommissionSale",
"CashRefundSlip"
],
"type": "string"
},
"SubArticles": {
"description": "Sub-articles related to this article.",
"type": "string"
},
"UseScale": {
"description": "Indicates whether the article uses a scale.",
"type": "boolean"
},
"AskForSerial": {
"description": "Indicates whether to ask for the serial number of the article.",
"type": "boolean"
},
"Ackumulative": {
"description": "Indicates whether the article is accumulative.",
"type": "boolean"
},
"IsWebshopArticle": {
"description": "Indicates whether the article is a webshop article.",
"type": "boolean"
},
"IsStockItem": {
"description": "Must be set to true in order to have a quantity set.",
"type": "boolean"
},
"CommissionValue": {
"format": "double",
"description": "The commission value of the article.",
"type": "number"
},
"ConnectedCompany": {
"description": "The company the article belongs to (for multi-company setups).",
"type": "string"
},
"BongPrinter": {
"format": "int32",
"description": "The bong printer associated with the article.",
"type": "integer"
},
"BongNumberOfCopies": {
"format": "int32",
"description": "Number of bong (kitchen ticket) copies to print.",
"type": "integer"
},
"BongText": {
"description": "The bong text for the article.",
"type": "string"
},
"BongType": {
"format": "int32",
"description": "The bong type for the article.",
"type": "integer"
},
"BongShowDialouge": {
"description": "Indicates whether to show the bong dialog.",
"type": "boolean"
},
"IsOpenArticle": {
"description": "Indicates whether the article is an open article.",
"type": "boolean"
},
"IsBookable": {
"description": "If article type is service, then the service can be bookable.",
"type": "boolean"
},
"DisplayOrder": {
"format": "int32",
"description": "The display order of the article.",
"type": "integer"
},
"ArticleBookingSettings": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleBookingSettings",
"description": "If article is bookable, then settings for booking defines default time and customer booking settings"
},
"IsQuickButton": {
"description": "Determines if article should be shown as quick button in cashier.",
"type": "boolean"
},
"QuickButtonColor": {
"description": "Color of quickbutton if no picture of article uploaded in MoreFlo",
"type": "string"
},
"TicketType": {
"description": "The ticket type of the article.",
"enum": [
"None",
"NonReservation",
"ReservationRequired"
],
"type": "string"
},
"ArticleInfoUpdateTime": {
"format": "date-time",
"description": "The time when the article information was last updated.",
"type": "string"
},
"QuantityUpdatedTime": {
"format": "date-time",
"description": "The time when the quantity of the article was last updated.",
"type": "string"
},
"RequiresPreparation": {
"description": "If article type is service, indicates whether the service requires preparation.",
"type": "boolean"
},
"MinimumPreparationTime": {
"format": "int32",
"description": "The minimum preparation time for the service.",
"type": "integer"
},
"ArticleTextHtml": {
"description": "HTML formatted text for the article description.",
"maxLength": 65535,
"minLength": 0,
"type": "string"
},
"RequiresIDCard": {
"description": "Indicates whether the article requires ID card verification.",
"type": "boolean"
},
"AgeLimit": {
"format": "int32",
"description": "The age limit for purchasing the article.",
"type": "integer"
},
"Weight": {
"format": "double",
"description": "The weight of the article.",
"type": "number"
},
"WeightUnit": {
"description": "The unit of weight for the article.",
"enum": [
"Gram",
"Kilo"
],
"type": "string"
},
"Volume": {
"format": "double",
"description": "The volume of the article.",
"type": "number"
},
"VolumeUnit": {
"description": "The unit of volume for the article.",
"enum": [
"ml",
"cl",
"l"
],
"type": "string"
},
"ComparsionPriceUnit": {
"description": "Defines if weight or volume should be used as comparison price, i.e., price per kilogram or price per liter.",
"enum": [
"Weight",
"Volume"
],
"type": "string"
},
"OrderThresholdQuantity": {
"format": "double",
"description": "Represents the minimum quantity of stock that triggers an order for more.\r\nThis is used to maintain inventory levels and prevent stockouts.",
"type": "number"
}
}
},
"xFlo.Models.Common.Models.Article.ArticleBarcode": {
"description": "Article barcode",
"required": [
"Barcode"
],
"type": "object",
"properties": {
"Barcode": {
"description": "Article barcode",
"maxLength": 20,
"minLength": 0,
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.ArticleBookingSettings": {
"description": "Represents the booking settings for an article.",
"type": "object",
"properties": {
"DefaultDuration": {
"format": "int32",
"description": "Default duration of the event in seconds, used in MoreFlo backoffice and customer booking.",
"type": "integer"
},
"PaddingTime": {
"format": "int32",
"description": "Padding time in seconds, used in customer booking.",
"type": "integer"
},
"LeadTime": {
"format": "int32",
"description": "Lead time in seconds, used in customer booking.",
"type": "integer"
},
"IntervalTime": {
"format": "int32",
"description": "Interval time in seconds, used in customer booking.",
"type": "integer"
},
"SchedulingWindow": {
"format": "int32",
"description": "Scheduling window in seconds, used in customer booking.",
"type": "integer"
},
"RequiresStoreConfirmation": {
"description": "Indicates whether store confirmation is required before the booking is confirmed.",
"type": "boolean"
},
"CustomerBookingEnabled": {
"description": "Indicates whether customer booking is enabled for this service.\r\nDefaults to true.",
"type": "boolean"
},
"ArticleBookableType": {
"description": "Determines if the booking should be a service order booking or a booking order booking.",
"enum": [
"Booking",
"ServiceRepair"
],
"type": "string"
},
"DetailedDescriptionHtml": {
"description": "Detailed description of the service for use in customer booking.\r\nLeave empty if no customer booking should be done.",
"maxLength": 65535,
"minLength": 0,
"type": "string"
},
"ClientCancellationPossible": {
"description": "Determines if a cancellation option should be presented for the customer or if only the store can cancel.",
"type": "boolean"
},
"CancellationMinimumTimeInAdvance": {
"format": "int32",
"description": "Minimum time in seconds required to make a cancellation, if allowed (see ClientCancellationPossible).",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.ArticlesResult": {
"description": "Represents a paged result containing a list of ArticleResult objects.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.ArticleResult": {
"description": "Represents the result of an operation involving an Article entity.",
"type": "object",
"properties": {
"Article": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Article",
"description": "The Article entity resulting from the operation."
},
"ArticleNumber": {
"description": "The unique article number.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.Article": {
"description": "Represents an article with various properties.",
"required": [
"ArticleNumber"
],
"type": "object",
"properties": {
"ArticleNumber": {
"description": "The unique article number.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"Quantity": {
"format": "double",
"description": "The quantity of the article.",
"type": "number"
},
"SupplierArticleNumber": {
"description": "The supplier's article number.",
"type": "string"
},
"SerialNumber": {
"description": "The serial number of the article.",
"type": "string"
},
"BrandId": {
"description": "The brand identifier of the article.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"GroupId": {
"description": "The group identifier of the article.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"Location": {
"description": "Specifies the storage location or warehouse where the stock item is kept.",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"ArticleName": {
"description": "The name of the article.",
"maxLength": 60,
"minLength": 0,
"type": "string"
},
"ArticleDescription": {
"description": "The description or extra receipt text for the article.",
"maxLength": 60,
"minLength": 0,
"type": "string"
},
"Unit": {
"description": "The unit of measurement for the article.",
"maxLength": 30,
"minLength": 0,
"type": "string"
},
"ArticleGoodsType": {
"description": "Type of goods article, for example Tobacco",
"enum": [
"NotSet",
"Other",
"Alcohol",
"Tobacco",
"Gambling",
"Hazardous"
],
"type": "string"
},
"Barcode": {
"description": "Primary barcode for this article",
"maxLength": 20,
"minLength": 0,
"type": "string"
},
"BarcodeAlternatives": {
"description": "Alternative barcodes for this article",
"type": "array",
"items": {
"$ref": "#/definitions/xFlo.Models.Common.Models.Article.ArticleBarcode"
}
},
"LocationId": {
"description": "The location identifier of the article.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"SupplierId": {
"description": "The supplier identifier of the article.",
"type": "string"
},
"ProductModelReference": {
"description": "The product model reference for the article.",
"type": "string"
},
"AccountCodeId": {
"description": "The account code identifier of the article.",
"type": "string"
},
"InputPrice": {
"format": "double",
"description": "The input price of the article excluding VAT.",
"type": "number"
},
"RecommendedPrice": {
"format": "double",
"description": "The recommended price of the article including VAT.",
"type": "number"
},
"RetailPrice": {
"format": "double",
"description": "The retail price of the article including VAT.",
"type": "number"
},
"ArticleType": {
"description": "The type of the article, see enumeration.",
"enum": [
"Goods",
"Service",
"GiftCard",
"Prepay",
"ValueCard",
"GoodsMarginProfit",
"BuyGoodsMarginProfit",
"CommissionSale",
"CashRefundSlip"
],
"type": "string"
},
"SubArticles": {
"description": "Sub-articles related to this article.",
"type": "string"
},
"IsActive": {
"description": "Indicates whether the article is active or inactive.",
"type": "boolean"
},
"UseScale": {
"description": "Indicates whether the article uses a scale.",
"type": "boolean"
},
"AskForSerial": {
"description": "Indicates whether to ask for the serial number of the article.",
"type": "boolean"
},
"Ackumulative": {
"description": "Indicates whether the article is accumulative.",
"type": "boolean"
},
"IsWebshopArticle": {
"description": "Indicates whether the article is a webshop article.",
"type": "boolean"
},
"IsStockItem": {
"description": "Must be set to true in order to have a quantity set.",
"type": "boolean"
},
"CommissionValue": {
"format": "double",
"description": "The commission value of the article.",
"type": "number"
},
"ConnectedCompany": {
"description": "The company the article belongs to (for multi-company setups).",
"type": "string"
},
"BongPrinter": {
"format": "int32",
"description": "The bong printer associated with the article.",
"type": "integer"
},
"BongNumberOfCopies": {
"format": "int32",
"description": "Number of bong (kitchen ticket) copies to print.",
"type": "integer"
},
"BongText": {
"description": "The bong text for the article.",
"type": "string"
},
"BongType": {
"format": "int32",
"description": "The bong type for the article.",
"type": "integer"
},
"BongShowDialouge": {
"description": "Indicates whether to show the bong dialog.",
"type": "boolean"
},
"IsOpenArticle": {
"description": "Indicates whether the article is an open article.",
"type": "boolean"
},
"IsBookable": {
"description": "If article type is service, then the service can be bookable.",
"type": "boolean"
},
"DisplayOrder": {
"format": "int32",
"description": "The display order of the article.",
"type": "integer"
},
"ArticleBookingSettings": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleBookingSettings",
"description": "If article is bookable, then settings for booking defines default time and customer booking settings"
},
"IsQuickButton": {
"description": "Determines if article should be shown as quick button in cashier.",
"type": "boolean"
},
"QuickButtonColor": {
"description": "Color of quickbutton if no picture of article uploaded in MoreFlo",
"type": "string"
},
"TicketType": {
"description": "The ticket type of the article.",
"enum": [
"None",
"NonReservation",
"ReservationRequired"
],
"type": "string"
},
"ArticleInfoUpdateTime": {
"format": "date-time",
"description": "The time when the article information was last updated.",
"type": "string"
},
"QuantityUpdatedTime": {
"format": "date-time",
"description": "The time when the quantity of the article was last updated.",
"type": "string"
},
"RequiresPreparation": {
"description": "If article type is service, indicates whether the service requires preparation.",
"type": "boolean"
},
"MinimumPreparationTime": {
"format": "int32",
"description": "The minimum preparation time for the service.",
"type": "integer"
},
"ArticleTextHtml": {
"description": "HTML formatted text for the article description.",
"maxLength": 65535,
"minLength": 0,
"type": "string"
},
"RequiresIDCard": {
"description": "Indicates whether the article requires ID card verification.",
"type": "boolean"
},
"AgeLimit": {
"format": "int32",
"description": "The age limit for purchasing the article.",
"type": "integer"
},
"Weight": {
"format": "double",
"description": "The weight of the article.",
"type": "number"
},
"WeightUnit": {
"description": "The unit of weight for the article.",
"enum": [
"Gram",
"Kilo"
],
"type": "string"
},
"Volume": {
"format": "double",
"description": "The volume of the article.",
"type": "number"
},
"VolumeUnit": {
"description": "The unit of volume for the article.",
"enum": [
"ml",
"cl",
"l"
],
"type": "string"
},
"ComparsionPriceUnit": {
"description": "Defines if weight or volume should be used as comparison price, i.e., price per kilogram or price per liter.",
"enum": [
"Weight",
"Volume"
],
"type": "string"
},
"OrderThresholdQuantity": {
"format": "double",
"description": "Represents the minimum quantity of stock that triggers an order for more.\r\nThis is used to maintain inventory levels and prevent stockouts.",
"type": "number"
}
}
},
"MoreFlo.Models.InterfaceModels.ArticlesGetResult": {
"description": "Represents a paged result containing a list of ArticleGetResult objects.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleGetResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.ArticleGetResult": {
"description": "Represents the result of an operation involving an ArticleGet entity.",
"type": "object",
"properties": {
"Article": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleGet",
"description": "The ArticleGet entity resulting from the operation."
},
"ArticleNumber": {
"description": "The unique article number.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.ArticleGet": {
"description": "Represents an article with associated product files.",
"required": [
"ArticleNumber"
],
"type": "object",
"properties": {
"Files": {
"description": "A list of product files associated with the article.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ProductFile"
}
},
"ArticleNumber": {
"description": "The unique article number.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"Quantity": {
"format": "double",
"description": "The quantity of the article.",
"type": "number"
},
"SupplierArticleNumber": {
"description": "The supplier's article number.",
"type": "string"
},
"SerialNumber": {
"description": "The serial number of the article.",
"type": "string"
},
"BrandId": {
"description": "The brand identifier of the article.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"GroupId": {
"description": "The group identifier of the article.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"Location": {
"description": "Specifies the storage location or warehouse where the stock item is kept.",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"ArticleName": {
"description": "The name of the article.",
"maxLength": 60,
"minLength": 0,
"type": "string"
},
"ArticleDescription": {
"description": "The description or extra receipt text for the article.",
"maxLength": 60,
"minLength": 0,
"type": "string"
},
"Unit": {
"description": "The unit of measurement for the article.",
"maxLength": 30,
"minLength": 0,
"type": "string"
},
"ArticleGoodsType": {
"description": "Type of goods article, for example Tobacco",
"enum": [
"NotSet",
"Other",
"Alcohol",
"Tobacco",
"Gambling",
"Hazardous"
],
"type": "string"
},
"Barcode": {
"description": "Primary barcode for this article",
"maxLength": 20,
"minLength": 0,
"type": "string"
},
"BarcodeAlternatives": {
"description": "Alternative barcodes for this article",
"type": "array",
"items": {
"$ref": "#/definitions/xFlo.Models.Common.Models.Article.ArticleBarcode"
}
},
"LocationId": {
"description": "The location identifier of the article.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"SupplierId": {
"description": "The supplier identifier of the article.",
"type": "string"
},
"ProductModelReference": {
"description": "The product model reference for the article.",
"type": "string"
},
"AccountCodeId": {
"description": "The account code identifier of the article.",
"type": "string"
},
"InputPrice": {
"format": "double",
"description": "The input price of the article excluding VAT.",
"type": "number"
},
"RecommendedPrice": {
"format": "double",
"description": "The recommended price of the article including VAT.",
"type": "number"
},
"RetailPrice": {
"format": "double",
"description": "The retail price of the article including VAT.",
"type": "number"
},
"ArticleType": {
"description": "The type of the article, see enumeration.",
"enum": [
"Goods",
"Service",
"GiftCard",
"Prepay",
"ValueCard",
"GoodsMarginProfit",
"BuyGoodsMarginProfit",
"CommissionSale",
"CashRefundSlip"
],
"type": "string"
},
"SubArticles": {
"description": "Sub-articles related to this article.",
"type": "string"
},
"IsActive": {
"description": "Indicates whether the article is active or inactive.",
"type": "boolean"
},
"UseScale": {
"description": "Indicates whether the article uses a scale.",
"type": "boolean"
},
"AskForSerial": {
"description": "Indicates whether to ask for the serial number of the article.",
"type": "boolean"
},
"Ackumulative": {
"description": "Indicates whether the article is accumulative.",
"type": "boolean"
},
"IsWebshopArticle": {
"description": "Indicates whether the article is a webshop article.",
"type": "boolean"
},
"IsStockItem": {
"description": "Must be set to true in order to have a quantity set.",
"type": "boolean"
},
"CommissionValue": {
"format": "double",
"description": "The commission value of the article.",
"type": "number"
},
"ConnectedCompany": {
"description": "The company the article belongs to (for multi-company setups).",
"type": "string"
},
"BongPrinter": {
"format": "int32",
"description": "The bong printer associated with the article.",
"type": "integer"
},
"BongNumberOfCopies": {
"format": "int32",
"description": "Number of bong (kitchen ticket) copies to print.",
"type": "integer"
},
"BongText": {
"description": "The bong text for the article.",
"type": "string"
},
"BongType": {
"format": "int32",
"description": "The bong type for the article.",
"type": "integer"
},
"BongShowDialouge": {
"description": "Indicates whether to show the bong dialog.",
"type": "boolean"
},
"IsOpenArticle": {
"description": "Indicates whether the article is an open article.",
"type": "boolean"
},
"IsBookable": {
"description": "If article type is service, then the service can be bookable.",
"type": "boolean"
},
"DisplayOrder": {
"format": "int32",
"description": "The display order of the article.",
"type": "integer"
},
"ArticleBookingSettings": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleBookingSettings",
"description": "If article is bookable, then settings for booking defines default time and customer booking settings"
},
"IsQuickButton": {
"description": "Determines if article should be shown as quick button in cashier.",
"type": "boolean"
},
"QuickButtonColor": {
"description": "Color of quickbutton if no picture of article uploaded in MoreFlo",
"type": "string"
},
"TicketType": {
"description": "The ticket type of the article.",
"enum": [
"None",
"NonReservation",
"ReservationRequired"
],
"type": "string"
},
"ArticleInfoUpdateTime": {
"format": "date-time",
"description": "The time when the article information was last updated.",
"type": "string"
},
"QuantityUpdatedTime": {
"format": "date-time",
"description": "The time when the quantity of the article was last updated.",
"type": "string"
},
"RequiresPreparation": {
"description": "If article type is service, indicates whether the service requires preparation.",
"type": "boolean"
},
"MinimumPreparationTime": {
"format": "int32",
"description": "The minimum preparation time for the service.",
"type": "integer"
},
"ArticleTextHtml": {
"description": "HTML formatted text for the article description.",
"maxLength": 65535,
"minLength": 0,
"type": "string"
},
"RequiresIDCard": {
"description": "Indicates whether the article requires ID card verification.",
"type": "boolean"
},
"AgeLimit": {
"format": "int32",
"description": "The age limit for purchasing the article.",
"type": "integer"
},
"Weight": {
"format": "double",
"description": "The weight of the article.",
"type": "number"
},
"WeightUnit": {
"description": "The unit of weight for the article.",
"enum": [
"Gram",
"Kilo"
],
"type": "string"
},
"Volume": {
"format": "double",
"description": "The volume of the article.",
"type": "number"
},
"VolumeUnit": {
"description": "The unit of volume for the article.",
"enum": [
"ml",
"cl",
"l"
],
"type": "string"
},
"ComparsionPriceUnit": {
"description": "Defines if weight or volume should be used as comparison price, i.e., price per kilogram or price per liter.",
"enum": [
"Weight",
"Volume"
],
"type": "string"
},
"OrderThresholdQuantity": {
"format": "double",
"description": "Represents the minimum quantity of stock that triggers an order for more.\r\nThis is used to maintain inventory levels and prevent stockouts.",
"type": "number"
}
}
},
"MoreFlo.Models.InterfaceModels.ProductFile": {
"type": "object",
"properties": {
"Id": {
"type": "string"
},
"Guid": {
"type": "string"
},
"Name": {
"type": "string"
},
"Description": {
"type": "string"
},
"CreatedTime": {
"format": "date-time",
"type": "string"
},
"ContentType": {
"type": "string"
},
"IsMainFile": {
"type": "boolean"
},
"URL": {
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.ArticleQuantityInfo": {
"description": "Represents article quantity information.",
"required": [
"ArticleNumber",
"Quantity"
],
"type": "object",
"properties": {
"ArticleNumber": {
"description": "The unique article number.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"Quantity": {
"format": "double",
"description": "The quantity of the article.",
"type": "number"
}
}
},
"MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.ArticlesAvailabilitiesResult": {
"description": "Represents a paginated result containing a list of article availability results.\r\nThis class is used to return a collection of article availability information, along with pagination and extra information, in API responses.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.ArticlesAvailability"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.ArticlesAvailability": {
"description": "Represents the availability of articles, including details about when and which articles are available.",
"type": "object",
"properties": {
"Id": {
"format": "int64",
"description": "The unique identifier for this availability setting.",
"type": "integer"
},
"Name": {
"description": "The name associated with this availability setting.",
"type": "string"
},
"Enabled": {
"description": "Indicates whether this availability setting is enabled.",
"type": "boolean"
},
"AvailabilityTime": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.ArticlesAvailabilityTime",
"description": "Information about the time-related aspects of article availability."
},
"AvailableArticles": {
"description": "A list of articles that are available according to this setting.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.AvailableArticlesItem"
}
}
}
},
"MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.ArticlesAvailabilityTime": {
"description": "Represents time-based availability settings for articles.\r\nThis class enables the definition of complex availability schedules using month, day-of-week, and specific date rules.",
"type": "object",
"properties": {
"MonthAvailabilities": {
"description": "Defines availability based on months and days within those months.\r\nExample: January 1-3,5-8; June 15-18",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.MonthAvailability"
}
},
"DayOfWeekAvailabilities": {
"description": "Defines availability based on days of the week and time ranges.\r\nExample: Monday 08:00-15:00, 20:00-23:00; Friday 10:00-15:00, 19:00-20:00;",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.DayOfWeekTimeAvailability"
}
},
"SpecificDatesAvailabilities": {
"description": "Defines availability based on specific dates and time ranges.\r\nExample: 2024-01-01 08:00-15:00, 20:00-23:00; 2025-01-01 10:00-15:00;",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.DateAvailability"
}
}
}
},
"MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.AvailableArticlesItem": {
"description": "Represents an available article item, which can be either a specific article or an article group.",
"type": "object",
"properties": {
"AvailablePer": {
"description": "Indicates whether the item is an \"Article\" or an \"ArticleGroup\".\r\nIf it is \"Article\", then the article is defined by the ArticleNumber property.\r\nIf it is \"ArticleGroup\", then the article group is defined by the ArticleGroupId property.",
"enum": [
"Article",
"ArticleGroup"
],
"type": "string"
},
"ArticleGroupId": {
"description": "The unique identifier of the article group.\r\nThe group can be fetched using the v2/groups/{Id} endpoint.",
"type": "string"
},
"ArticleNumber": {
"description": "The unique identifier of the article.\r\nThe article can be fetched using the v3/articles/article endpoint.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.MonthAvailability": {
"description": "Represents availability settings for a specific month, including the month and ranges of available days.",
"type": "object",
"properties": {
"Month": {
"format": "int32",
"description": "The month of the year.\r\nAllowed values: 1-12 (1 for January, 2 for February, ..., 12 for December).",
"type": "integer"
},
"AvailabilityDays": {
"description": "A list of ranges of days within the month when items are available.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.MonthDayRange"
}
}
}
},
"MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.DayOfWeekTimeAvailability": {
"description": "Represents availability settings for a specific day of the week, including the day and a list of available time periods.",
"type": "object",
"properties": {
"Day": {
"description": "The day of the week for which the availability is defined.\r\nIt can be one of the following values:\r\n0-Sunday, 1-Monday, 2-Tuesday, 3-Wednesday, 4-Thursday, 5-Friday, 6-Saturday.",
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string"
},
"AvailabilityTimes": {
"description": "A list of time periods during which items are available on the specified day of the week.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.DayTimePeriod"
}
}
}
},
"MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.DateAvailability": {
"description": "Represents availability settings for a specific date, including a date and a list of available time periods.",
"type": "object",
"properties": {
"Date": {
"description": "The date for which the availability is defined, in YYYY-MM-DD format (e.g., 2024-12-30).",
"type": "string"
},
"AvailabilityTimes": {
"description": "A list of time periods during which items are available on the specified date.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.DayTimePeriod"
}
}
}
},
"MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.MonthDayRange": {
"description": "Represents a range of days within a month, defined by a start and end day.",
"type": "object",
"properties": {
"StartDay": {
"format": "int32",
"description": "The starting day of the range.\r\nAllowed values: 1-31.",
"type": "integer"
},
"EndDay": {
"format": "int32",
"description": "The ending day of the range.\r\nAllowed values: 1-31.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.DayTimePeriod": {
"description": "Represents a time period within a day, defined by a start and end time.",
"type": "object",
"properties": {
"StartTime": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.TimeOfDay",
"description": "The start time of the period, in HH:mm format (e.g., 01:34)."
},
"EndTime": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.TimeOfDay",
"description": "The end time of the period, in HH:mm format (e.g., 13:43)."
}
}
},
"MoreFlo.Models.InterfaceModels.v3.ArticlesAvailabilities.TimeOfDay": {
"description": "Represents a time of day, specifying hours and minutes.",
"type": "object",
"properties": {
"Hour": {
"format": "int32",
"description": "The hour, in 24-hour time format.\r\nAllowed values: 0 - 23 (24 is not allowed).",
"type": "integer"
},
"Minute": {
"format": "int32",
"description": "The minute.\r\nAllowed values: 0 - 59.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.ArticleSetCreate": {
"description": "Represents the data required to create a new article set.\r\nInherits from ArticleSet and adds specific creation-related properties.",
"required": [
"ArticleName",
"IsActive",
"PricePrintOption",
"articleSetParts",
"ArticleNumber"
],
"type": "object",
"properties": {
"ArticleName": {
"description": "The name of the article set. Required for creation.",
"type": "string"
},
"IsActive": {
"description": "Indicates whether the article set is active. Required for creation.",
"type": "boolean"
},
"PricePrintOption": {
"description": "The option for how the price of the article set should be printed on a receipt. Required for creation.",
"enum": [
"PrintSetPrice",
"PrintWithDiscount"
],
"type": "string"
},
"articleSetParts": {
"description": "A list of parts (articles) that make up the article set. Required for creation.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSetPart"
}
},
"UpdateOnExisting": {
"description": "Indicates whether to update an existing article set if one with the same ID already exists.",
"type": "boolean"
},
"ArticleNumber": {
"description": "The unique article number for the article set.",
"type": "string"
},
"Barcode": {
"description": "The barcode for the article set.",
"maxLength": 20,
"minLength": 0,
"type": "string"
},
"Group": {
"description": "The group the article set belongs to.",
"maxLength": 200,
"minLength": 0,
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.ArticleSetPart": {
"description": "Represents a part of an article set.",
"required": [
"Quantity",
"ArticleReference",
"PartType",
"PartPricePerUnit"
],
"type": "object",
"properties": {
"Quantity": {
"format": "double",
"description": "The quantity of the part in the set.",
"type": "number"
},
"ArticleReference": {
"description": "The article number or product model identifier of the part.",
"type": "string"
},
"PartType": {
"description": "The type of the part (article or product model).",
"enum": [
"Article",
"ArticleProductModel"
],
"type": "string"
},
"PartPricePerUnit": {
"format": "double",
"description": "The price per unit of the part, including VAT.",
"type": "number"
}
}
},
"MoreFlo.Models.InterfaceModels.ArticleSetsResult": {
"description": "Represents a paged result containing a list of ArticleSetResult objects.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSetResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.ArticleSetResult": {
"description": "Represents the result of an operation involving an ArticleSet entity.",
"type": "object",
"properties": {
"ArticleSet": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSet",
"description": "The ArticleSet entity resulting from the operation."
},
"ArticleNumber": {
"description": "The unique article number of the article set.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.ArticleSet": {
"description": "Represents a set of articles, often sold together as a bundle.",
"required": [
"ArticleNumber"
],
"type": "object",
"properties": {
"ArticleNumber": {
"description": "The unique article number for the article set.",
"type": "string"
},
"ArticleName": {
"description": "The name of the article set.",
"type": "string"
},
"Barcode": {
"description": "The barcode for the article set.",
"maxLength": 20,
"minLength": 0,
"type": "string"
},
"Group": {
"description": "The group the article set belongs to.",
"maxLength": 200,
"minLength": 0,
"type": "string"
},
"IsActive": {
"description": "Indicates whether the article set is active.",
"type": "boolean"
},
"PricePrintOption": {
"description": "The option for how the price of the article set should be printed on a receipt.",
"enum": [
"PrintSetPrice",
"PrintWithDiscount"
],
"type": "string"
},
"articleSetParts": {
"description": "A list of parts (articles) that make up the article set.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSetPart"
}
}
}
},
"MoreFlo.Models.InterfaceModels.BookableResourceEventInstancesResult": {
"description": "Represents a paged result containing a list of BookableResourceEventInstanceResult objects.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookableResourceEventInstanceResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.BookableResourceEventInstanceResult": {
"description": "Represents the result of an operation involving a BookableResourceEventInstance entity.",
"type": "object",
"properties": {
"Entity": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookableResourceEventInstance",
"description": "The BookableResourceEventInstance entity resulting from the operation."
},
"Id": {
"description": "The unique identifier of the BookableResourceEventInstance.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.BookableResourceEventInstance": {
"description": "Represents an instance of a bookable resource event.",
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the event instance.",
"type": "string"
},
"BookableResourceId": {
"description": "The identifier of the bookable resource associated with the event.",
"type": "string"
},
"StartDateAndTime": {
"format": "date-time",
"description": "The start date and time of the event.",
"type": "string"
},
"StopDateAndTime": {
"format": "date-time",
"description": "The end date and time of the event.",
"type": "string"
},
"Description": {
"description": "A description of the event.",
"maxLength": 512,
"minLength": 0,
"type": "string"
},
"IsDeleted": {
"description": "Indicates whether the event instance has been deleted.",
"type": "boolean"
},
"BookableResourceEventType": {
"description": "The type of the bookable resource event (e.g., bookable time, non-bookable time).",
"enum": [
"BookableTime",
"NonBookableTime"
],
"type": "string"
},
"LastUpdatedTime": {
"format": "date-time",
"description": "The time when the event instance was last updated.",
"type": "string"
},
"CreatedTime": {
"format": "date-time",
"description": "The time when the event instance was created.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.BookableResourcesResult": {
"description": "Represents a paged result containing a list of BookableResourceResult objects.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookableResourceResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.BookableResourceResult": {
"description": "Represents the result of an operation involving a BookableResource entity.",
"type": "object",
"properties": {
"Entity": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookableResource",
"description": "The BookableResource entity resulting from the operation."
},
"Id": {
"description": "The unique identifier of the BookableResource.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.BookableResource": {
"description": "Represents a resource that can be booked.",
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the bookable resource.",
"type": "string"
},
"Name": {
"description": "The name of the bookable resource.",
"type": "string"
},
"BookableResourceType": {
"description": "The type of the bookable resource (e.g., personnel, other).",
"enum": [
"Personnell",
"Other"
],
"type": "string"
},
"BookableArticleType": {
"description": "The type of articles that can be booked with this resource (e.g., all, services, goods).",
"enum": [
"All",
"Services",
"Goods"
],
"type": "string"
},
"BookableResourceState": {
"description": "The current state of the bookable resource (e.g., active, deleted, not bookable).",
"enum": [
"Active",
"Deleted",
"NotBookable"
],
"type": "string"
},
"ArticlesExempt": {
"description": "Specifies how articles are exempted or included when booking this resource.",
"enum": [
"None",
"EcxludeArticles",
"IncludeOnlyArticles"
],
"type": "string"
},
"DisplayOrder": {
"format": "int32",
"description": "The display order of the bookable resource.",
"type": "integer"
},
"BookableResourceExcludedArticles": {
"description": "A collection of articles that are excluded when booking this resource.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookableResourceExcludedArticle"
}
},
"BookableResourceIncludeOnlyArticles": {
"description": "A collection of articles that are exclusively included when booking this resource.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookableResourceIncludeOnlyArticle"
}
},
"Files": {
"description": "A list of files attached to the bookable resource.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AttachedFile"
}
},
"CreatedTime": {
"format": "date-time",
"description": "The time when the bookable resource was created.",
"type": "string"
},
"LastUpdatedTime": {
"format": "date-time",
"description": "The time when the bookable resource was last updated.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.BookableResourceExcludedArticle": {
"description": "Represents an article that is excluded from being booked with a specific bookable resource.",
"type": "object",
"properties": {
"ArticleNumber": {
"description": "The article number of the excluded article.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.BookableResourceIncludeOnlyArticle": {
"description": "Represents an article that is exclusively included for booking with a specific bookable resource, along with its maximum parallel booking limit.",
"type": "object",
"properties": {
"ArticleNumber": {
"description": "The article number of the included article.",
"type": "string"
},
"MaxNumberOfBookingsInParallel": {
"format": "int32",
"description": "The maximum number of parallel bookings allowed for this article with the associated bookable resource.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.AttachedFile": {
"type": "object",
"properties": {
"Id": {
"type": "string"
},
"Name": {
"type": "string"
},
"Description": {
"type": "string"
},
"CreatedTime": {
"format": "date-time",
"type": "string"
},
"ContentType": {
"type": "string"
},
"IsMainFile": {
"type": "boolean"
},
"URL": {
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.BookingOrderCreate": {
"description": "Represents the data required to create a new booking order.",
"required": [
"ExternalReference",
"Customer"
],
"type": "object",
"properties": {
"ExternalReference": {
"description": "The external reference or order number from another system.\r\nThis is a required field.",
"type": "string"
},
"UpdateOnExisting": {
"description": "Indicates whether to update an existing booking order if one with the same number already exists.",
"type": "boolean"
},
"Id": {
"description": "The unique identifier of the booking order, set by MoreFlo.",
"type": "string"
},
"Customer": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Customer",
"description": "The customer associated with the booking order, either by MoreFlo's CustomerNumber or the system's ReferenceNumber."
},
"BookableResourceId": {
"description": "The identifier of the bookable resource associated with the order.",
"type": "string"
},
"OrderNumber": {
"format": "int32",
"description": "The order number, set by MoreFlo.",
"type": "integer"
},
"CreatedTime": {
"format": "date-time",
"description": "The time when the booking order was created, set by MoreFlo.",
"type": "string"
},
"UpdatedTime": {
"format": "date-time",
"description": "The time when the booking order was last updated, set by MoreFlo.",
"type": "string"
},
"ReadyDate": {
"format": "date-time",
"description": "The date when the order is expected to be ready.",
"type": "string"
},
"CancellationLatestTime": {
"format": "date-time",
"description": "The latest time for cancellation of the booking order.",
"type": "string"
},
"ConfirmationExpireTime": {
"format": "date-time",
"description": "The time when the confirmation for the booking order expires.",
"type": "string"
},
"StartTime": {
"format": "date-time",
"description": "The start time of the booking.",
"type": "string"
},
"StopTime": {
"format": "date-time",
"description": "The end time of the booking.",
"type": "string"
},
"CustomerNote": {
"description": "A note from the customer regarding the booking order.",
"maxLength": 4096,
"minLength": 0,
"type": "string"
},
"OurReference": {
"description": "The reference used by the ordering system.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"YourReference": {
"description": "The reference used by your system.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"Note": {
"description": "A general note regarding the booking order.",
"maxLength": 4096,
"minLength": 0,
"type": "string"
},
"OrderDiscountPercent": {
"format": "double",
"description": "The discount percentage applied to the entire order.",
"type": "number"
},
"State": {
"description": "The current state of the booking order.",
"enum": [
"New",
"WaitingConfirmation",
"Confirmed",
"Completed",
"Cancelled"
],
"type": "string"
},
"Rows": {
"description": "A list of rows containing details about the articles in the booking order.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookingOrderRow"
}
},
"BillingAddress": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BillingAddress",
"description": "The billing address for the booking order."
},
"ShippingAddress": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ShippingAddress",
"description": "The shipping address for the booking order."
},
"PaymentReference": {
"description": "A reference for the payment associated with the booking order.",
"maxLength": 512,
"minLength": 0,
"type": "string"
},
"PaymentOption": {
"description": "The payment option used for the booking order.",
"enum": [
"NotSet",
"Web",
"Invoice",
"Cashier"
],
"type": "string"
},
"PaymentOrigin": {
"description": "The origin of the payment.",
"maxLength": 512,
"minLength": 0,
"type": "string"
},
"PaymentStatus": {
"description": "The status of the payment.",
"enum": [
"NotSet",
"NotPaid",
"FullyPaid",
"Refunded"
],
"type": "string"
},
"CancellationSource": {
"description": "The source that cancelled the booking order (e.g. \"Staff\", \"ExternalApi\").\r\nSet automatically if not provided when state changes to Cancelled.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"CancellationLink": {
"description": "A link for cancelling the booking order.",
"type": "string"
},
"CancellationLinkBaseURL": {
"description": "The base URL for the cancellation link.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.Customer": {
"required": [
"Name"
],
"type": "object",
"properties": {
"CustomerNumber": {
"description": "MoreFlo customer number.",
"type": "string"
},
"Reference": {
"type": "string"
},
"Name": {
"type": "string"
},
"Address1": {
"type": "string"
},
"Address2": {
"type": "string"
},
"PostCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Country": {
"type": "string"
},
"IdentityNo": {
"type": "string"
},
"ReferenceNumber": {
"format": "int64",
"description": "The other systems customer number or id.",
"type": "integer"
},
"Email": {
"type": "string"
},
"Telephone1": {
"type": "string"
},
"Telephone2": {
"type": "string"
},
"VatNumber": {
"type": "string"
},
"IsExportCustomer": {
"type": "boolean"
},
"Mobile": {
"type": "string"
},
"Fax": {
"type": "string"
},
"Note": {
"type": "string"
},
"DateAdded": {
"format": "date-time",
"type": "string"
},
"DateUpdated": {
"format": "date-time",
"type": "string"
},
"ModifiedTime": {
"format": "date-time",
"type": "string"
},
"MemberGroupId": {
"format": "int32",
"type": "integer"
},
"MemberGroup": {
"type": "string"
},
"PermitsCommercial": {
"type": "boolean"
},
"IsCompany": {
"type": "boolean"
},
"IsInternalCustomer": {
"type": "boolean"
},
"IsActive": {
"type": "boolean"
},
"Blocked": {
"description": "Blocked because of an issue with Credit or something else",
"type": "boolean"
},
"Id": {
"format": "int32",
"description": "Member Id",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.BookingOrderRow": {
"description": "Represents a row in a booking order, detailing information about a specific article.",
"type": "object",
"properties": {
"ArticleNumber": {
"description": "The article number.",
"type": "string"
},
"ArticleName": {
"description": "The name of the article.",
"type": "string"
},
"Quantity": {
"format": "double",
"description": "The quantity of the article.",
"type": "number"
},
"UnitAmountInclVatInclDiscount": {
"format": "double",
"description": "The unit amount including VAT and discount.",
"type": "number"
},
"UnitAmountInclVatExclDiscount": {
"format": "double",
"description": "The unit amount including VAT but excluding discount.",
"type": "number"
},
"VatRate": {
"format": "double",
"description": "The VAT rate applied to the article.",
"type": "number"
},
"TotalDiscountAmount": {
"format": "double",
"description": "The total discount amount applied to the article.",
"type": "number"
},
"TotalAmountInclVatInclDiscount": {
"format": "double",
"description": "The total amount including VAT and discount for the specified quantity.",
"type": "number"
},
"ReceiptNote": {
"description": "A note related to the receipt of the article.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.BillingAddress": {
"type": "object",
"properties": {
"IsCompany": {
"type": "boolean"
},
"IdentificationNumber": {
"maxLength": 24,
"minLength": 0,
"type": "string"
},
"Name": {
"type": "string"
},
"Address1": {
"type": "string"
},
"Address2": {
"type": "string"
},
"PostCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Country": {
"type": "string"
},
"Email": {
"type": "string"
},
"Telephone1": {
"type": "string"
},
"Telephone2": {
"type": "string"
},
"Mobile": {
"type": "string"
},
"Fax": {
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.ShippingAddress": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Address1": {
"type": "string"
},
"Address2": {
"type": "string"
},
"PostCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Country": {
"type": "string"
},
"Email": {
"type": "string"
},
"Telephone1": {
"type": "string"
},
"Telephone2": {
"type": "string"
},
"Mobile": {
"type": "string"
},
"Fax": {
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.BookingOrdersResult": {
"description": "Represents a paged result containing a list of BookingOrderResult objects.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookingOrderResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.BookingOrderResult": {
"description": "Represents the result of an operation involving a BookingOrder entity.",
"type": "object",
"properties": {
"BookingOrder": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookingOrder",
"description": "The BookingOrder entity resulting from the operation."
},
"Id": {
"description": "The unique identifier of the BookingOrder.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.BookingOrder": {
"description": "Represents a booking order, containing information about a customer's reservation.",
"required": [
"Customer"
],
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the booking order, set by MoreFlo.",
"type": "string"
},
"ExternalReference": {
"description": "The external reference or order identifier from the ordering system.\r\nMust be set during creation.",
"type": "string"
},
"Customer": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Customer",
"description": "The customer associated with the booking order, either by MoreFlo's CustomerNumber or the system's ReferenceNumber."
},
"BookableResourceId": {
"description": "The identifier of the bookable resource associated with the order.",
"type": "string"
},
"OrderNumber": {
"format": "int32",
"description": "The order number, set by MoreFlo.",
"type": "integer"
},
"CreatedTime": {
"format": "date-time",
"description": "The time when the booking order was created, set by MoreFlo.",
"type": "string"
},
"UpdatedTime": {
"format": "date-time",
"description": "The time when the booking order was last updated, set by MoreFlo.",
"type": "string"
},
"ReadyDate": {
"format": "date-time",
"description": "The date when the order is expected to be ready.",
"type": "string"
},
"CancellationLatestTime": {
"format": "date-time",
"description": "The latest time for cancellation of the booking order.",
"type": "string"
},
"ConfirmationExpireTime": {
"format": "date-time",
"description": "The time when the confirmation for the booking order expires.",
"type": "string"
},
"StartTime": {
"format": "date-time",
"description": "The start time of the booking.",
"type": "string"
},
"StopTime": {
"format": "date-time",
"description": "The end time of the booking.",
"type": "string"
},
"CustomerNote": {
"description": "A note from the customer regarding the booking order.",
"maxLength": 4096,
"minLength": 0,
"type": "string"
},
"OurReference": {
"description": "The reference used by the ordering system.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"YourReference": {
"description": "The reference used by your system.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"Note": {
"description": "A general note regarding the booking order.",
"maxLength": 4096,
"minLength": 0,
"type": "string"
},
"OrderDiscountPercent": {
"format": "double",
"description": "The discount percentage applied to the entire order.",
"type": "number"
},
"State": {
"description": "The current state of the booking order.",
"enum": [
"New",
"WaitingConfirmation",
"Confirmed",
"Completed",
"Cancelled"
],
"type": "string"
},
"Rows": {
"description": "A list of rows containing details about the articles in the booking order.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BookingOrderRow"
}
},
"BillingAddress": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BillingAddress",
"description": "The billing address for the booking order."
},
"ShippingAddress": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ShippingAddress",
"description": "The shipping address for the booking order."
},
"PaymentReference": {
"description": "A reference for the payment associated with the booking order.",
"maxLength": 512,
"minLength": 0,
"type": "string"
},
"PaymentOption": {
"description": "The payment option used for the booking order.",
"enum": [
"NotSet",
"Web",
"Invoice",
"Cashier"
],
"type": "string"
},
"PaymentOrigin": {
"description": "The origin of the payment.",
"maxLength": 512,
"minLength": 0,
"type": "string"
},
"PaymentStatus": {
"description": "The status of the payment.",
"enum": [
"NotSet",
"NotPaid",
"FullyPaid",
"Refunded"
],
"type": "string"
},
"CancellationSource": {
"description": "The source that cancelled the booking order (e.g. \"Staff\", \"ExternalApi\").\r\nSet automatically if not provided when state changes to Cancelled.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"CancellationLink": {
"description": "A link for cancelling the booking order.",
"type": "string"
},
"CancellationLinkBaseURL": {
"description": "The base URL for the cancellation link.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.OrdersResult": {
"description": "Represents a paginated result containing a list of order results.\r\nThis class is used to return a collection of orders, along with pagination information, in API responses.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrderResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.OrderResult": {
"description": "Represents the result of an operation that returns a single order.\r\nThis class encapsulates an Order object and its unique identifier, typically used in API responses for single order operations.",
"type": "object",
"properties": {
"Order": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Order",
"description": "The Order object containing the order data."
},
"Id": {
"description": "The unique identifier of the order.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.Order": {
"description": "Represents an order, containing customer details, dates, references, financial information, and order rows.",
"required": [
"Customer"
],
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the order, automatically generated by the system.",
"type": "string"
},
"Customer": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Customer",
"description": "Information about the customer associated with the order.\r\nEither a customer number within the system or an external customer reference. This is a required field."
},
"BillingAddress": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Address",
"description": "The billing address for the order, if different from the customer's default address."
},
"ShippingAddress": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Address",
"description": "The shipping address for the order, if different from the customer's default address."
},
"Number": {
"format": "int32",
"description": "The order number.",
"type": "integer"
},
"IncomingDate": {
"format": "date-time",
"description": "The date when the order was received.",
"type": "string"
},
"StartDate": {
"format": "date-time",
"description": "The start date for the order (e.g., for a service).",
"type": "string"
},
"ReadyDate": {
"format": "date-time",
"description": "The date when the order is expected to be ready.",
"type": "string"
},
"ExpireDate": {
"format": "date-time",
"description": "The date when the order expires (if applicable).",
"type": "string"
},
"DeliveryDate": {
"format": "date-time",
"description": "The date when the order is scheduled for delivery.",
"type": "string"
},
"OurReference": {
"description": "The reference used by the ordering system.",
"type": "string"
},
"YourReference": {
"description": "The reference provided by the customer or the customer's system.",
"type": "string"
},
"DeliveryTerm": {
"description": "The delivery terms for the order.",
"type": "string"
},
"YourOrderNo": {
"description": "The customer's order number or other identifier.",
"type": "string"
},
"ExternalReference": {
"description": "An external identification for the order, which must be prefixed. For example: SYS-52351.",
"type": "string"
},
"Note": {
"description": "A note or comment associated with the order.",
"type": "string"
},
"Discount": {
"format": "double",
"description": "The discount applied to the order, expressed as a percentage.",
"type": "number"
},
"TotalExclVat": {
"format": "double",
"description": "The total amount of the order, excluding VAT.",
"type": "number"
},
"TotalInclVat": {
"format": "double",
"description": "The total amount of the order, including VAT.",
"type": "number"
},
"TotalVat": {
"format": "double",
"description": "The total VAT amount for the order.",
"type": "number"
},
"Rows": {
"description": "A list of rows containing details about the items in the order.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrderRow"
}
},
"State": {
"description": "The current state of the order.",
"enum": [
"Created",
"Saved",
"Started",
"WaitingCustomerResp",
"ReadyForHandOut",
"Closed",
"Waiting",
"Cancelled",
"Delivered",
"Invoiced",
"PayedFromCashier",
"PayedFromExternal"
],
"type": "string"
},
"PaymentOption": {
"description": "The payment option selected for the order.",
"enum": [
"NotSet",
"Web",
"Invoice",
"Cashier"
],
"type": "string"
},
"PaymentReference": {
"description": "A reference related to the payment for the order.",
"type": "string"
},
"PaymentOrigin": {
"description": "The origin of the payment.",
"type": "string"
},
"PaymentStatus": {
"description": "The status of the payment for the order.",
"enum": [
"NotSet",
"NotPaid",
"FullyPaid",
"Refunded"
],
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.Address": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Address1": {
"type": "string"
},
"Address2": {
"type": "string"
},
"PostCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Country": {
"type": "string"
},
"Email": {
"type": "string"
},
"Telephone1": {
"type": "string"
},
"Telephone2": {
"type": "string"
},
"Mobile": {
"type": "string"
},
"Fax": {
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.OrderRow": {
"description": "Represents a row within an order, detailing information about a specific item included in the order.",
"type": "object",
"properties": {
"ArticleNumber": {
"description": "The article number of the item.",
"type": "string"
},
"ArticleName": {
"description": "The name of the item.",
"type": "string"
},
"UnitAmountInclVatExclDiscount": {
"format": "double",
"description": "The unit amount of the item, including VAT but excluding discount.",
"type": "number"
},
"Discount": {
"format": "double",
"description": "The discount applied to the item.",
"type": "number"
},
"VatRate": {
"format": "double",
"description": "The VAT rate applied to the item.",
"type": "number"
},
"Quantity": {
"format": "double",
"description": "The quantity of the item.",
"type": "number"
},
"SerialNumber": {
"description": "The serial number of the item.",
"type": "string"
},
"RowSum": {
"format": "double",
"description": "The sum of the row.",
"type": "number"
},
"ReceiptNote": {
"description": "A note or text associated with the item, typically a text row.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.BrandCreate": {
"description": "Represents the data required to create a new brand.",
"required": [
"Name",
"Id"
],
"type": "object",
"properties": {
"Name": {
"description": "The name of the brand. Required for creation.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"UpdateOnExisting": {
"description": "Indicates whether to update an existing brand if one with the same ID already exists.",
"type": "boolean"
},
"Id": {
"description": "The unique identifier of the brand.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"CreatedUtc": {
"format": "date-time",
"description": "The UTC timestamp when the brand was created.",
"type": "string"
},
"ModifiedUtc": {
"format": "date-time",
"description": "The UTC timestamp when the brand was last modified.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.BrandsResult": {
"description": "Represents a paged result containing a list of BrandResult objects.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BrandResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.BrandResult": {
"description": "Represents the result of an operation involving a Brand entity.",
"type": "object",
"properties": {
"Brand": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Brand",
"description": "The Brand entity resulting from the operation."
},
"Id": {
"description": "The unique identifier of the Brand.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.Brand": {
"description": "Represents a brand with an identifier and a name.",
"required": [
"Id"
],
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the brand.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"Name": {
"description": "The name of the brand.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"CreatedUtc": {
"format": "date-time",
"description": "The UTC timestamp when the brand was created.",
"type": "string"
},
"ModifiedUtc": {
"format": "date-time",
"description": "The UTC timestamp when the brand was last modified.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.CampaignCreate": {
"description": "Represents the data required to create a new campaign.",
"required": [
"Name",
"ReceiptText",
"Type",
"StartTime",
"EndTime",
"ValueIsGlobal",
"Priority",
"Enabled",
"Id",
"MemberOnly"
],
"type": "object",
"properties": {
"UpdateOnExisting": {
"description": "Indicates whether to update an existing campaign if one with the same ID already exists.",
"type": "boolean"
},
"Name": {
"description": "The name of the campaign. Required for creation.",
"type": "string"
},
"ReceiptText": {
"description": "The text to be displayed on the receipt for this campaign. Required for creation.",
"type": "string"
},
"Type": {
"description": "The type of campaign. Required for creation.",
"enum": [
"ByXgetYNumber",
"ByXNumberGetYValueAmountDiscount",
"ByXNumberPayYValue",
"Percent",
"SpecialPrice",
"AmountWithDrawn"
],
"type": "string"
},
"StartTime": {
"format": "date-time",
"description": "The start time of the campaign. Required for creation.",
"type": "string"
},
"EndTime": {
"format": "date-time",
"description": "The end time of the campaign. Required for creation.",
"type": "string"
},
"ValueIsGlobal": {
"description": "Indicates whether the Value is the same for all campaign content. Required for creation.",
"type": "boolean"
},
"Priority": {
"format": "int32",
"description": "Defines the priority of the campaign if multiple campaigns apply to a receipt item. Required for creation.",
"type": "integer"
},
"Enabled": {
"description": "Indicates whether the campaign is enabled. Required for creation.",
"type": "boolean"
},
"Id": {
"description": "The unique identifier of the campaign.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"MemberOnly": {
"description": "Indicates whether the campaign is only applicable to members.",
"type": "boolean"
},
"MemberGroupName": {
"description": "The name of the member group entitled to this campaign.",
"type": "string"
},
"MemberNumbers": {
"description": "A list of customer numbers that are entitled to this campaign, applicable if MemberOnly is true.",
"type": "array",
"items": {
"type": "string"
}
},
"ValueX": {
"format": "double",
"description": "The first value used in two-value campaigns (e.g., Buy X get Y).",
"type": "number"
},
"ValueY": {
"format": "double",
"description": "The second value used in two-value campaigns (e.g., Buy X get Y).",
"type": "number"
},
"Value": {
"format": "double",
"description": "The single global value used in the campaign.",
"type": "number"
},
"ThresholdTotal": {
"format": "double",
"description": "The threshold amount required on the receipt for the campaign to apply.",
"type": "number"
},
"ThresholdTotalIncludeThis": {
"description": "Indicates whether the purchase of this campaign is included in the total threshold calculation.",
"type": "boolean"
},
"parts": {
"description": "A list of campaign items (parts) that are included in the campaign.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CampaignPart"
}
}
}
},
"MoreFlo.Models.InterfaceModels.CampaignPart": {
"description": "Represents a part of a campaign, specifying the reference, type, and value associated with it.",
"required": [
"Reference",
"PartType"
],
"type": "object",
"properties": {
"Reference": {
"description": "The reference to the campaign part, which can be an article number or a product model.",
"type": "string"
},
"PartType": {
"description": "The type of the campaign part, indicating whether it's an article, product model, or group.",
"enum": [
"Article",
"ProductModel",
"Group"
],
"type": "string"
},
"Value": {
"format": "double",
"description": "An optional value associated with the campaign part.",
"type": "number"
}
}
},
"MoreFlo.Models.InterfaceModels.CampaignsResult": {
"description": "Represents a paged result containing a list of CampaignResult objects.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CampaignResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.CampaignResult": {
"description": "Represents the result of an operation involving a Campaign entity.",
"type": "object",
"properties": {
"Campaign": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Campaign",
"description": "The Campaign entity resulting from the operation."
},
"Id": {
"description": "The unique identifier of the Campaign.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.Campaign": {
"description": "Represents a campaign with various properties and settings.",
"required": [
"Id",
"MemberOnly"
],
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the campaign.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"Name": {
"description": "The name of the campaign.",
"type": "string"
},
"ReceiptText": {
"description": "The text to be displayed on the receipt for this campaign.",
"type": "string"
},
"Type": {
"description": "The type of campaign.",
"enum": [
"ByXgetYNumber",
"ByXNumberGetYValueAmountDiscount",
"ByXNumberPayYValue",
"Percent",
"SpecialPrice",
"AmountWithDrawn"
],
"type": "string"
},
"MemberOnly": {
"description": "Indicates whether the campaign is only applicable to members.",
"type": "boolean"
},
"MemberGroupName": {
"description": "The name of the member group entitled to this campaign.",
"type": "string"
},
"MemberNumbers": {
"description": "A list of customer numbers that are entitled to this campaign, applicable if MemberOnly is true.",
"type": "array",
"items": {
"type": "string"
}
},
"StartTime": {
"format": "date-time",
"description": "The start time of the campaign.",
"type": "string"
},
"EndTime": {
"format": "date-time",
"description": "The end time of the campaign.",
"type": "string"
},
"ValueX": {
"format": "double",
"description": "The first value used in two-value campaigns (e.g., Buy X get Y).",
"type": "number"
},
"ValueY": {
"format": "double",
"description": "The second value used in two-value campaigns (e.g., Buy X get Y).",
"type": "number"
},
"Value": {
"format": "double",
"description": "The single global value used in the campaign.",
"type": "number"
},
"ValueIsGlobal": {
"description": "Indicates whether the Value is the same for all campaign content. Applies to Percent, SpecialPrice, and AmountWithDrawn campaigns.",
"type": "boolean"
},
"Priority": {
"format": "int32",
"description": "Defines the priority of the campaign if multiple campaigns apply to a receipt item.",
"type": "integer"
},
"ThresholdTotal": {
"format": "double",
"description": "The threshold amount required on the receipt for the campaign to apply.",
"type": "number"
},
"ThresholdTotalIncludeThis": {
"description": "Indicates whether the purchase of this campaign is included in the total threshold calculation.",
"type": "boolean"
},
"Enabled": {
"description": "Indicates whether the campaign is enabled.",
"type": "boolean"
},
"parts": {
"description": "A list of campaign items (parts) that are included in the campaign.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CampaignPart"
}
}
}
},
"MoreFlo.Models.InterfaceModels.CashCardsBalanceResult": {
"description": "Represents the result of a cash card balance inquiry, providing balances for different card types.",
"type": "object",
"properties": {
"PrepaidBalance": {
"format": "double",
"description": "The balance of prepaid cards.",
"type": "number"
},
"ValueCardBalance": {
"format": "double",
"description": "The balance of value cards.",
"type": "number"
},
"GiftCardBalance": {
"format": "double",
"description": "The balance of gift cards.",
"type": "number"
},
"CashRefundSlipBalance": {
"format": "double",
"description": "The balance of cash refund slips.",
"type": "number"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.CashierUserCreate": {
"description": "Represents the data required to create a new cashier user.",
"required": [
"Id"
],
"type": "object",
"properties": {
"UpdateOnExisting": {
"description": "Indicates whether to update an existing cashier user if one with the same ID already exists.",
"type": "boolean"
},
"Id": {
"description": "The unique identifier of the cashier user.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"UserName": {
"description": "The username of the cashier user.",
"type": "string"
},
"Password": {
"description": "The password of the cashier user.",
"type": "string"
},
"FirstName": {
"description": "The first name of the cashier user.",
"type": "string"
},
"LastName": {
"description": "The last name of the cashier user.",
"type": "string"
},
"AccessRight": {
"description": "The access rights of the cashier user.",
"enum": [
"User",
"Administrator",
"SelfService"
],
"type": "string"
},
"IsActive": {
"description": "Indicates whether the cashier user is active.",
"type": "boolean"
},
"LogoutOnCloseReceipt": {
"description": "Indicates whether the cashier user should be logged out when a receipt is closed.",
"type": "boolean"
},
"HideOnAutomaticLogout": {
"description": "Indicates whether the cashier user should be hidden on automatic logout.",
"type": "boolean"
}
}
},
"MoreFlo.Models.InterfaceModels.CashierUsersResult": {
"description": "Represents a paginated result containing a list of cashier user results.\r\nThis class is used to return a collection of cashier user data, along with pagination information, in API responses.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CashierUserResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.CashierUserResult": {
"description": "Represents the result of an operation involving a CashierUser entity.",
"type": "object",
"properties": {
"CashierUser": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CashierUser",
"description": "The CashierUser entity resulting from the operation."
},
"Id": {
"description": "The unique identifier of the CashierUser.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.CashierUser": {
"description": "Represents a cashier user with their credentials, personal information, access rights, and settings.",
"required": [
"Id"
],
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the cashier user.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"UserName": {
"description": "The username of the cashier user.",
"type": "string"
},
"Password": {
"description": "The password of the cashier user.",
"type": "string"
},
"FirstName": {
"description": "The first name of the cashier user.",
"type": "string"
},
"LastName": {
"description": "The last name of the cashier user.",
"type": "string"
},
"AccessRight": {
"description": "The access rights of the cashier user.",
"enum": [
"User",
"Administrator",
"SelfService"
],
"type": "string"
},
"IsActive": {
"description": "Indicates whether the cashier user is active.",
"type": "boolean"
},
"LogoutOnCloseReceipt": {
"description": "Indicates whether the cashier user should be logged out when a receipt is closed.",
"type": "boolean"
},
"HideOnAutomaticLogout": {
"description": "Indicates whether the cashier user should be hidden on automatic logout.",
"type": "boolean"
}
}
},
"MoreFlo.Models.InterfaceModels.CustomerCreate": {
"required": [
"Name"
],
"type": "object",
"properties": {
"UpdateOnExisting": {
"type": "boolean"
},
"Website": {
"type": "string"
},
"AdditionalData": {
"type": "string"
},
"Contacts": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomerContact"
}
},
"Addresses": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomerAddress"
}
},
"ParentId": {
"format": "int32",
"type": "integer"
},
"ResponsiblePersonnelId": {
"format": "int32",
"type": "integer"
},
"Origin": {
"type": "string"
},
"CustomerNumber": {
"description": "MoreFlo customer number.",
"type": "string"
},
"Reference": {
"type": "string"
},
"Name": {
"type": "string"
},
"Address1": {
"type": "string"
},
"Address2": {
"type": "string"
},
"PostCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Country": {
"type": "string"
},
"IdentityNo": {
"type": "string"
},
"ReferenceNumber": {
"format": "int64",
"description": "The other systems customer number or id.",
"type": "integer"
},
"Email": {
"type": "string"
},
"Telephone1": {
"type": "string"
},
"Telephone2": {
"type": "string"
},
"VatNumber": {
"type": "string"
},
"IsExportCustomer": {
"type": "boolean"
},
"Mobile": {
"type": "string"
},
"Fax": {
"type": "string"
},
"Note": {
"type": "string"
},
"DateAdded": {
"format": "date-time",
"type": "string"
},
"DateUpdated": {
"format": "date-time",
"type": "string"
},
"ModifiedTime": {
"format": "date-time",
"type": "string"
},
"MemberGroupId": {
"format": "int32",
"type": "integer"
},
"MemberGroup": {
"type": "string"
},
"PermitsCommercial": {
"type": "boolean"
},
"IsCompany": {
"type": "boolean"
},
"IsInternalCustomer": {
"type": "boolean"
},
"IsActive": {
"type": "boolean"
},
"Blocked": {
"description": "Blocked because of an issue with Credit or something else",
"type": "boolean"
},
"Id": {
"format": "int32",
"description": "Member Id",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.CustomerContact": {
"type": "object",
"properties": {
"FirstName": {
"type": "string"
},
"LastName": {
"type": "string"
},
"Email": {
"type": "string"
},
"Phone": {
"type": "string"
},
"Id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"MoreFlo.Models.InterfaceModels.CustomerAddress": {
"type": "object",
"properties": {
"Type": {
"enum": [
"Billing",
"Shipping"
],
"type": "string"
},
"Name": {
"type": "string"
},
"Address1": {
"type": "string"
},
"Address2": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Country": {
"type": "string"
},
"Email": {
"type": "string"
},
"Phone1": {
"type": "string"
},
"Phone2": {
"type": "string"
},
"Mobile": {
"type": "string"
},
"Fax": {
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.CustomersResult": {
"description": "Represents a paged result containing a list of CustomerResult objects.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomerResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.CustomerResult": {
"description": "Represents the result of an operation involving a Customer entity.",
"type": "object",
"properties": {
"Customer": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Customer",
"description": "The Customer entity resulting from the operation."
},
"CustomerNumber": {
"description": "The unique customer number.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.CustomerUpdate": {
"required": [
"Name"
],
"type": "object",
"properties": {
"Website": {
"type": "string"
},
"AdditionalData": {
"type": "string"
},
"Contacts": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomerContact"
}
},
"Addresses": {
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.CustomerAddress"
}
},
"ParentId": {
"format": "int32",
"type": "integer"
},
"ResponsiblePersonnelId": {
"format": "int32",
"type": "integer"
},
"Origin": {
"type": "string"
},
"CustomerNumber": {
"description": "MoreFlo customer number.",
"type": "string"
},
"Reference": {
"type": "string"
},
"Name": {
"type": "string"
},
"Address1": {
"type": "string"
},
"Address2": {
"type": "string"
},
"PostCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Country": {
"type": "string"
},
"IdentityNo": {
"type": "string"
},
"ReferenceNumber": {
"format": "int64",
"description": "The other systems customer number or id.",
"type": "integer"
},
"Email": {
"type": "string"
},
"Telephone1": {
"type": "string"
},
"Telephone2": {
"type": "string"
},
"VatNumber": {
"type": "string"
},
"IsExportCustomer": {
"type": "boolean"
},
"Mobile": {
"type": "string"
},
"Fax": {
"type": "string"
},
"Note": {
"type": "string"
},
"DateAdded": {
"format": "date-time",
"type": "string"
},
"DateUpdated": {
"format": "date-time",
"type": "string"
},
"ModifiedTime": {
"format": "date-time",
"type": "string"
},
"MemberGroupId": {
"format": "int32",
"type": "integer"
},
"MemberGroup": {
"type": "string"
},
"PermitsCommercial": {
"type": "boolean"
},
"IsCompany": {
"type": "boolean"
},
"IsInternalCustomer": {
"type": "boolean"
},
"IsActive": {
"type": "boolean"
},
"Blocked": {
"description": "Blocked because of an issue with Credit or something else",
"type": "boolean"
},
"Id": {
"format": "int32",
"description": "Member Id",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.CustomerSearchQuery": {
"type": "object",
"properties": {
"SearchPhrase": {
"type": "string"
},
"SearchType": {
"enum": [
"AllFields",
"CustomerNumber",
"Name",
"IdentityNumber",
"Email",
"Mobile"
],
"type": "string"
},
"PageSize": {
"format": "int32",
"type": "integer"
},
"ExactMatch": {
"type": "boolean"
},
"OnlyInternalCustomer": {
"type": "boolean"
},
"OnlyExternalCustomer": {
"type": "boolean"
}
}
},
"MoreFlo.Models.InterfaceModels.GroupCreate": {
"description": "Represents the data structure used to create a new group. \r\nThis class specifies the required information for group creation within the system.",
"required": [
"Name",
"Id"
],
"type": "object",
"properties": {
"Name": {
"description": "The name of the group to be created. This is a required field.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"DefaultAccountCodeId": {
"description": "The default account code identifier associated with the group to be created. This is a required field.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"UpdateOnExisting": {
"description": "Indicates whether an existing group with the same identifier should be updated instead of creating a new one.",
"type": "boolean"
},
"Id": {
"description": "The unique identifier of the group.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"ParentId": {
"description": "The identifier of the parent group, if this group is a sub-group.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"ExternalReference": {
"description": "An external reference identifier for the group, potentially used by other systems.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"ModifiedTime": {
"format": "date-time",
"description": "The time when the group was last modified.",
"type": "string"
},
"DisplayOrder": {
"format": "int32",
"description": "The display order of the group, used for sorting or presentation purposes.",
"type": "integer"
},
"ArticleGoodsType": {
"description": "The default article goods type for articles within this group.",
"enum": [
"NotSet",
"Other",
"Alcohol",
"Tobacco",
"Gambling",
"Hazardous"
],
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.GroupsResult": {
"description": "Represents a paginated result containing a list of group results.\r\nThis class is used to return a collection of groups, along with pagination information, in API responses.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.GroupResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.GroupResult": {
"description": "Represents the result of an operation that returns a single group.\r\nThis class encapsulates a group and its unique identifier, typically used in API responses for single group operations.",
"type": "object",
"properties": {
"Group": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Group",
"description": "The Group object containing the group's data."
},
"Id": {
"description": "The unique identifier of the group.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.Group": {
"description": "Represents a group, which can be used to categorize or organize articles or other data within the system.",
"required": [
"Id"
],
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the group.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"ParentId": {
"description": "The identifier of the parent group, if this group is a sub-group.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"Name": {
"description": "The name of the group.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"ExternalReference": {
"description": "An external reference identifier for the group, potentially used by other systems.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"ModifiedTime": {
"format": "date-time",
"description": "The time when the group was last modified.",
"type": "string"
},
"DefaultAccountCodeId": {
"description": "The identifier of the default account code associated with this group.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"DisplayOrder": {
"format": "int32",
"description": "The display order of the group, used for sorting or presentation purposes.",
"type": "integer"
},
"ArticleGoodsType": {
"description": "The default article goods type for articles within this group.",
"enum": [
"NotSet",
"Other",
"Alcohol",
"Tobacco",
"Gambling",
"Hazardous"
],
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.LocationCreate": {
"description": "Represents the data structure used to create a new location.\r\nThis class specifies the required information for creating a location within the system.",
"required": [
"Name",
"Id"
],
"type": "object",
"properties": {
"Name": {
"description": "The name of the location to be created. This is a required field.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"UpdateOnExisting": {
"description": "Indicates whether an existing location with the same identifier should be updated instead of creating a new one.",
"type": "boolean"
},
"Id": {
"description": "The unique identifier of the location.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"CreatedUtc": {
"format": "date-time",
"description": "The UTC timestamp when the location was created.",
"type": "string"
},
"ModifiedUtc": {
"format": "date-time",
"description": "The UTC timestamp when the location was last modified.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.LocationsResult": {
"description": "Represents a paginated result containing a list of location results.\r\nThis class is used to return a collection of locations, along with pagination information, in API responses.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.LocationResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.LocationResult": {
"description": "Represents the result of an operation that returns a single location.\r\nThis class encapsulates a location and its unique identifier.",
"type": "object",
"properties": {
"Location": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Location",
"description": "The Location object containing the location's data."
},
"Id": {
"description": "The unique identifier of the location.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.Location": {
"description": "Represents a location, such as a store, warehouse, or other physical place.",
"required": [
"Id"
],
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the location.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"Name": {
"description": "The name of the location.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"CreatedUtc": {
"format": "date-time",
"description": "The UTC timestamp when the location was created.",
"type": "string"
},
"ModifiedUtc": {
"format": "date-time",
"description": "The UTC timestamp when the location was last modified.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlinePaymentMethodsResult": {
"description": "Paged Result for Subscriber Online Payment Methods",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlinePaymentMethodResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlinePaymentMethodResult": {
"description": "Represents the result of an operation that returns an online payment method entry.\r\nThis class encapsulates a SubscriberOnlinePaymentMethodEntry object and its unique identifier, typically used in API responses related to retrieving or managing online payment methods.",
"type": "object",
"properties": {
"Entry": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlinePaymentMethodEntry",
"description": "The SubscriberOnlinePaymentMethodEntry object containing the online payment method entry data."
},
"Id": {
"description": "The unique identifier of the payment method entry.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlinePaymentMethodEntry": {
"description": "Represents an entry for an online payment method.\r\nThis class defines the properties of a payment method used in online systems, including its enablement status, type, details, and settings.",
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the payment method entry.",
"type": "string"
},
"IsEnabled": {
"description": "Indicates whether the payment method is enabled.",
"type": "boolean"
},
"Type": {
"description": "The type of online payment method.",
"enum": [
"None",
"Nmi",
"ResursBank",
"Swish",
"CashOnDelivery",
"Invoice",
"NBNPL"
],
"type": "string"
},
"Name": {
"description": "The name of the payment method.",
"type": "string"
},
"Description": {
"description": "A description of the payment method.",
"type": "string"
},
"SettingsTitle": {
"description": "The title for the settings related to this payment method.",
"type": "string"
},
"SettingsDescription": {
"description": "A description of the settings related to this payment method.",
"type": "string"
},
"SettingsUsername": {
"description": "The username for the settings related to this payment method (if applicable).",
"type": "string"
},
"SettingsPassword": {
"description": "The password for the settings related to this payment method (if applicable).",
"type": "string"
},
"SettingsKey": {
"description": "The key for the settings related to this payment method (if applicable).",
"type": "string"
},
"CreatedTime": {
"format": "date-time",
"description": "The time when the payment method entry was created.",
"type": "string"
},
"LastUpdatedTime": {
"format": "date-time",
"description": "The time when the payment method entry was last updated.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberCateringSettingResult": {
"description": "Represents the result of an operation that returns subscriber catering settings.\r\nThis class encapsulates the SubscriberCateringSetting object, typically used in API responses related to retrieving or managing catering settings.",
"type": "object",
"properties": {
"Settings": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberCateringSetting",
"description": "The SubscriberCateringSetting object containing the subscriber catering settings."
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberCateringSetting": {
"description": "Represents the settings for subscriber catering, including company information, site settings, checkout options, design customization, content, and payment methods.",
"type": "object",
"properties": {
"CompanyName": {
"description": "The name of the company providing the catering service.",
"type": "string"
},
"Address1": {
"description": "The first line of the company's address.",
"type": "string"
},
"Address2": {
"description": "The second line of the company's address (optional).",
"type": "string"
},
"PostCode": {
"description": "The postal code of the company's address.",
"type": "string"
},
"City": {
"description": "The city of the company's address.",
"type": "string"
},
"Country": {
"description": "The country of the company's address.",
"type": "string"
},
"Telephone": {
"description": "The telephone number of the company.",
"type": "string"
},
"Email": {
"description": "The email address of the company.",
"type": "string"
},
"SitePublic": {
"description": "Indicates whether the site is public.",
"type": "boolean"
},
"SiteLogotypes": {
"description": "A list of files representing the site's logotypes.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AttachedFile"
}
},
"SiteFavicons": {
"description": "A list of files representing the site's favicons.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AttachedFile"
}
},
"EnableAccountCreation": {
"description": "Indicates whether account creation is enabled on the site.",
"type": "boolean"
},
"ForceLogin": {
"description": "Indicates whether users are forced to log in to access the site.",
"type": "boolean"
},
"CanChangeBeforeDeadline": {
"description": "Indicates whether changes can be made before the deadline.",
"type": "boolean"
},
"CanCancelBeforeDeadline": {
"description": "Indicates whether cancellations can be made before the deadline.",
"type": "boolean"
},
"DeliveryTimeEditOption": {
"description": "The option for editing delivery time.",
"type": "string"
},
"DeadlineHours": {
"format": "int32",
"description": "The deadline in hours.",
"type": "integer"
},
"ArticlePopupDescription": {
"description": "Description for the article popup.",
"type": "string"
},
"CheckoutRepresentation": {
"description": "Indicates whether checkout representation is enabled.",
"type": "boolean"
},
"CheckoutOtherContact": {
"description": "Indicates whether checkout for other contacts is enabled.",
"type": "boolean"
},
"CheckoutDeliveryOptions": {
"description": "Indicates whether checkout delivery options are enabled.",
"type": "boolean"
},
"CheckoutDeliveryOptionPickupName": {
"description": "The name for the pickup delivery option.",
"type": "string"
},
"CheckoutDeliveryOptionSendName": {
"description": "The name for the send delivery option.",
"type": "string"
},
"CheckoutRoom": {
"description": "Indicates whether checkout for room selection is enabled.",
"type": "boolean"
},
"CheckoutRoomName": {
"description": "The name for the room selection checkout.",
"type": "string"
},
"CheckoutDeliveryASAP": {
"description": "Indicates whether checkout for delivery as soon as possible (ASAP) is enabled.",
"type": "boolean"
},
"CheckoutSMS": {
"description": "Indicates whether checkout using SMS is enabled.",
"type": "boolean"
},
"CheckoutDateTitle": {
"description": "The title for the checkout date field.",
"type": "string"
},
"CheckoutTimeTitle": {
"description": "The title for the checkout time field.",
"type": "string"
},
"CheckoutMiscTitle": {
"description": "The title for miscellaneous checkout fields.",
"type": "string"
},
"CheckoutBillingTitle": {
"description": "The title for the billing checkout fields.",
"type": "string"
},
"CheckoutFields": {
"description": "A collection of checkout field entries.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineCateringCheckoutFieldEntry"
}
},
"Rooms": {
"description": "A collection of room entries.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineRoomEntry"
}
},
"ColorGeneralBackground": {
"description": "The general background color.",
"type": "string"
},
"ColorHeaderBackground": {
"description": "The header background color.",
"type": "string"
},
"ColorHeaderText": {
"description": "The header text color.",
"type": "string"
},
"ColorHeaderLink": {
"description": "The header link color.",
"type": "string"
},
"ColorFooterBackground": {
"description": "The footer background color.",
"type": "string"
},
"ColorFooterHeading": {
"description": "The footer heading color.",
"type": "string"
},
"ColorFooterText": {
"description": "The footer text color.",
"type": "string"
},
"ColorFooterLink": {
"description": "The footer link color.",
"type": "string"
},
"ColorTypographyHeading": {
"description": "The typography heading color.",
"type": "string"
},
"ColorTypographyText": {
"description": "The typography text color.",
"type": "string"
},
"ColorTypographyLink": {
"description": "The typography link color.",
"type": "string"
},
"ColorButtonBackground": {
"description": "The button background color.",
"type": "string"
},
"ColorButtonText": {
"description": "The button text color.",
"type": "string"
},
"FeaturedGroups": {
"description": "A collection of featured groups.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineFeaturedGroupResult"
}
},
"ContentHomePage": {
"description": "The content for the home page.",
"type": "string"
},
"ContentAboutUs": {
"description": "The content for the about us page.",
"type": "string"
},
"ContentContactUs": {
"description": "The content for the contact us page.",
"type": "string"
},
"ContentTermsOfPurchase": {
"description": "The content for the terms of purchase page.",
"type": "string"
},
"ContentPrivacyPolicy": {
"description": "The content for the privacy policy page.",
"type": "string"
},
"ContentFooterText": {
"description": "The content for the footer text.",
"type": "string"
},
"LastUpdatedTime": {
"format": "date-time",
"description": "The last updated time.",
"type": "string"
},
"PaymentMethods": {
"description": "A collection of payment methods.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlinePaymentMethodEntry"
}
}
}
},
"MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineCateringCheckoutFieldEntry": {
"description": "Represents an entry for a checkout field used in online catering.\r\nThis class defines the properties of a field displayed during the online catering checkout process.",
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the checkout field entry.",
"type": "string"
},
"Title": {
"description": "The title or label of the checkout field.",
"type": "string"
},
"Type": {
"description": "The type of input field (e.g., text, dropdown, etc.).",
"type": "string"
},
"Required": {
"description": "Indicates whether the field is required for checkout completion.",
"type": "boolean"
},
"PostOrderEdit": {
"description": "Indicates whether the field can be edited after the order is placed.",
"type": "boolean"
},
"Priority": {
"format": "int32",
"description": "The priority of the field, used for display ordering.",
"type": "integer"
},
"CreatedTime": {
"format": "date-time",
"description": "The time when the checkout field entry was created.",
"type": "string"
},
"LastUpdatedTime": {
"format": "date-time",
"description": "The time when the checkout field entry was last updated.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineRoomEntry": {
"description": "Represents an entry for a room used in online ordering systems.\r\nThis class defines the properties of a room, such as its name and whether it's available for pickup or delivery, used in online ordering processes.",
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the room entry.",
"type": "string"
},
"Name": {
"description": "The name of the room.",
"type": "string"
},
"AllowForPickup": {
"description": "Indicates whether orders can be picked up from this room.",
"type": "boolean"
},
"AllowForDelivery": {
"description": "Indicates whether orders can be delivered to this room.",
"type": "boolean"
}
}
},
"MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineFeaturedGroupResult": {
"description": "Represents the result of an operation that returns a featured group entry.\r\nThis class encapsulates a SubscriberOnlineFeaturedGroupEntry object and its unique identifier, typically used in API responses related to retrieving or managing featured groups.",
"type": "object",
"properties": {
"FeaturedGroup": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineFeaturedGroupEntry",
"description": "The SubscriberOnlineFeaturedGroupEntry object containing the featured group entry data."
},
"Id": {
"description": "The unique identifier of the featured group.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineFeaturedGroupEntry": {
"description": "Represents an entry for a featured group displayed online.\r\nThis class defines the properties of a group featured on an online platform, including its identifier, group details, and associated images.",
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the featured group entry.",
"type": "string"
},
"GroupId": {
"description": "The identifier of the group being featured.",
"type": "string"
},
"GroupName": {
"description": "The name of the group being featured.",
"type": "string"
},
"GroupImages": {
"description": "A list of files representing images associated with the featured group.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AttachedFile"
}
}
}
},
"MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineExpressOrderSettingResult": {
"description": "Represents the result of an operation that returns subscriber online express order settings.\r\nThis class encapsulates the SubscriberOnlineExpressOrderSetting object, typically used in API responses related to retrieving or managing express order settings.",
"type": "object",
"properties": {
"Settings": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineExpressOrderSetting",
"description": "The SubscriberOnlineExpressOrderSetting object containing the subscriber online express order settings."
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineExpressOrderSetting": {
"description": "Represents the settings for subscriber online express ordering, including company information, site settings, display options, content, payment methods, and table settings.",
"type": "object",
"properties": {
"CompanyName": {
"description": "The name of the company providing the express order service.",
"type": "string"
},
"Address1": {
"description": "The first line of the company's address.",
"type": "string"
},
"Address2": {
"description": "The second line of the company's address (optional).",
"type": "string"
},
"PostCode": {
"description": "The postal code of the company's address.",
"type": "string"
},
"City": {
"description": "The city of the company's address.",
"type": "string"
},
"Country": {
"description": "The country of the company's address.",
"type": "string"
},
"Telephone": {
"description": "The telephone number of the company.",
"type": "string"
},
"Email": {
"description": "The email address of the company.",
"type": "string"
},
"CustomerPageEnabled": {
"description": "Indicates whether the customer page is enabled.",
"type": "boolean"
},
"TableEnabled": {
"description": "Indicates whether table ordering is enabled.",
"type": "boolean"
},
"SiteLogotypes": {
"description": "A list of files representing the site's logotypes.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AttachedFile"
}
},
"SiteFavicons": {
"description": "A list of files representing the site's favicons.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AttachedFile"
}
},
"ColorGeneralIcon": {
"description": "This property is deprecated and should not be used.",
"type": "string"
},
"ColorHomePageBackground": {
"description": "This property is deprecated and should not be used.",
"type": "string"
},
"ColorHomePageHeadline": {
"description": "This property is deprecated and should not be used.",
"type": "string"
},
"ColorHomePageText": {
"description": "This property is deprecated and should not be used.",
"type": "string"
},
"ColorContentsBackground": {
"description": "This property is deprecated and should not be used.",
"type": "string"
},
"ColorContentsHeadline": {
"description": "This property is deprecated and should not be used.",
"type": "string"
},
"ColorContentsText": {
"description": "This property is deprecated and should not be used.",
"type": "string"
},
"ColorHeaderBackground": {
"description": "This property is deprecated and should not be used.",
"type": "string"
},
"ColorFooterBackground": {
"description": "This property is deprecated and should not be used.",
"type": "string"
},
"ColorFooterText": {
"description": "This property is deprecated and should not be used.",
"type": "string"
},
"ColorButtonBackground": {
"description": "This property is deprecated and should not be used.",
"type": "string"
},
"ColorButtonText": {
"description": "This property is deprecated and should not be used.",
"type": "string"
},
"ContentHomePagePreamble": {
"description": "This property is deprecated and should not be used.",
"type": "string"
},
"FeaturedGroups": {
"description": "A collection of featured groups.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineFeaturedGroupResult"
}
},
"ContentHomePageTitle": {
"description": "The title for the home page.",
"type": "string"
},
"ContentHomePageTableText": {
"description": "The text for the home page table.",
"type": "string"
},
"ContentThankYouMessage": {
"description": "The message displayed after a successful order.",
"type": "string"
},
"ContentTermsOfPurchase": {
"description": "The content for the terms of purchase page.",
"type": "string"
},
"ContentPrivacyPolicy": {
"description": "The content for the privacy policy page.",
"type": "string"
},
"ContentCheckoutOtherInfo": {
"description": "Indicates whether checkout for other information is enabled.",
"type": "boolean"
},
"ContentCheckoutOtherInfoTitle": {
"description": "The title for the checkout other information section.",
"type": "string"
},
"LastUpdatedTime": {
"format": "date-time",
"description": "The last updated time.",
"type": "string"
},
"PaymentMethods": {
"description": "A collection of payment methods.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlinePaymentMethodEntry"
}
},
"Tables": {
"description": "A collection of table entries.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineTableEntry"
}
},
"PublicUrlOrHostPart": {
"description": "The public URL or host part for the express order service.",
"type": "string"
},
"BrandColor": {
"description": "The brand color for the express order service.",
"type": "string"
},
"BrandTextColor": {
"description": "The brand text color for the express order service.",
"type": "string"
},
"ButtonColor": {
"description": "The button color for the express order service.",
"type": "string"
},
"ButtonTextColor": {
"description": "The button text color for the express order service.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineTableEntry": {
"description": "Represents an entry for a table used in online ordering systems.\r\nThis class defines the properties of a table, such as its name, used in online ordering processes.",
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the table entry.",
"type": "string"
},
"Name": {
"description": "The name of the table.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberSelfscanSettingResult": {
"description": "Represents the result of an operation that returns subscriber self-scan settings.\r\nThis class encapsulates the SubscriberSelfscanSetting object, typically used in API responses related to retrieving or managing self-scan settings.",
"type": "object",
"properties": {
"Settings": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberSelfscanSetting",
"description": "The SubscriberSelfscanSetting object containing the subscriber self-scan settings."
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberSelfscanSetting": {
"description": "Represents the settings for subscriber self-scanning systems, including company information, site settings, design customization, content, and payment methods.",
"type": "object",
"properties": {
"CompanyName": {
"description": "The name of the company providing the self-scanning service.",
"type": "string"
},
"Address1": {
"description": "The first line of the company's address.",
"type": "string"
},
"Address2": {
"description": "The second line of the company's address (optional).",
"type": "string"
},
"PostCode": {
"description": "The postal code of the company's address.",
"type": "string"
},
"City": {
"description": "The city of the company's address.",
"type": "string"
},
"Country": {
"description": "The country of the company's address.",
"type": "string"
},
"Telephone": {
"description": "The telephone number of the company.",
"type": "string"
},
"Email": {
"description": "The email address of the company.",
"type": "string"
},
"CustomerPageEnabled": {
"description": "Indicates whether the customer page is enabled.",
"type": "boolean"
},
"SiteLogotypes": {
"description": "A list of files representing the site's logotypes.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AttachedFile"
}
},
"SiteFavicons": {
"description": "A list of files representing the site's favicons.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AttachedFile"
}
},
"EnableAccountCreation": {
"description": "Indicates whether account creation is enabled on the site.",
"type": "boolean"
},
"ForceLogin": {
"description": "Indicates whether users are forced to log in to access the site.",
"type": "boolean"
},
"ColorGeneralBackground": {
"description": "The general background color for the self-scanning interface.",
"type": "string"
},
"ColorGeneralText": {
"description": "The general text color for the self-scanning interface.",
"type": "string"
},
"ColorGeneralButtonBackground": {
"description": "The general button background color for the self-scanning interface.",
"type": "string"
},
"ColorGeneralButtonText": {
"description": "The general button text color for the self-scanning interface.",
"type": "string"
},
"ColorHeaderBackground": {
"description": "The header background color for the self-scanning interface.",
"type": "string"
},
"ColorHeaderText": {
"description": "The header text color for the self-scanning interface.",
"type": "string"
},
"ColorHomePageButtonBackground": {
"description": "The button background color for the home page of the self-scanning interface.",
"type": "string"
},
"ColorHomePageButtonText": {
"description": "The button text color for the home page of the self-scanning interface.",
"type": "string"
},
"ColorHomePageCartCount": {
"description": "The color for the cart count display on the home page of the self-scanning interface.",
"type": "string"
},
"ContentScanPageHeadline": {
"description": "The headline text for the scan page of the self-scanning interface.",
"type": "string"
},
"ContentSearchHeadline": {
"description": "The headline text for the search functionality of the self-scanning interface.",
"type": "string"
},
"ContentThankYouText": {
"description": "The text displayed on the thank you page of the self-scanning interface.",
"type": "string"
},
"ContentThankYouPaymentInStoreText": {
"description": "The text displayed on the thank you page when payment is made in store for the self-scanning interface.",
"type": "string"
},
"ContentTermsOfPurchase": {
"description": "The content for the terms of purchase page of the self-scanning interface.",
"type": "string"
},
"ContentPrivacyPolicy": {
"description": "The content for the privacy policy page of the self-scanning interface.",
"type": "string"
},
"LastUpdatedTime": {
"format": "date-time",
"description": "The last updated time for the self-scanning settings.",
"type": "string"
},
"PaymentMethods": {
"description": "A collection of payment methods available for the self-scanning system.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlinePaymentMethodEntry"
}
}
}
},
"MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberWebshopSettingResult": {
"description": "Represents the result of an operation that returns subscriber webshop settings.\r\nThis class encapsulates the SubscriberWebshopSetting object, typically used in API responses related to retrieving or managing webshop settings.",
"type": "object",
"properties": {
"Settings": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberWebshopSetting",
"description": "The SubscriberWebshopSetting object containing the subscriber webshop settings."
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberWebshopSetting": {
"description": "Represents the settings for a subscriber's webshop, including company information, shipping details, site settings, design customization, content, and payment methods.",
"type": "object",
"properties": {
"CompanyName": {
"description": "The name of the company operating the webshop.",
"type": "string"
},
"Address1": {
"description": "The first line of the company's address.",
"type": "string"
},
"Address2": {
"description": "The second line of the company's address (optional).",
"type": "string"
},
"PostCode": {
"description": "The postal code of the company's address.",
"type": "string"
},
"City": {
"description": "The city of the company's address.",
"type": "string"
},
"Country": {
"description": "The country of the company's address.",
"type": "string"
},
"Telephone": {
"description": "The telephone number of the company.",
"type": "string"
},
"Email": {
"description": "The email address of the company.",
"type": "string"
},
"ShippingArticleNumber": {
"description": "The article number for shipping costs.",
"type": "string"
},
"ShippingArticleAccountCode": {
"description": "The account code for shipping costs.",
"type": "string"
},
"ShippingCost": {
"format": "double",
"description": "The cost of shipping.",
"type": "number"
},
"ShippingStorePickup": {
"description": "Indicates whether store pickup for shipping is available.",
"type": "boolean"
},
"SitePublic": {
"description": "Indicates whether the webshop site is public.",
"type": "boolean"
},
"SiteLogotypes": {
"description": "A list of files representing the site's logotypes.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AttachedFile"
}
},
"SiteFavicons": {
"description": "A list of files representing the site's favicons.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AttachedFile"
}
},
"EnableAccountCreation": {
"description": "Indicates whether account creation is enabled on the webshop.",
"type": "boolean"
},
"ColorGeneralBackground": {
"description": "The general background color for the webshop.",
"type": "string"
},
"ColorHeaderBackground": {
"description": "The header background color for the webshop.",
"type": "string"
},
"ColorHeaderText": {
"description": "The header text color for the webshop.",
"type": "string"
},
"ColorHeaderLink": {
"description": "The header link color for the webshop.",
"type": "string"
},
"ColorFooterBackground": {
"description": "The footer background color for the webshop.",
"type": "string"
},
"ColorFooterHeading": {
"description": "The footer heading color for the webshop.",
"type": "string"
},
"ColorFooterText": {
"description": "The footer text color for the webshop.",
"type": "string"
},
"ColorFooterLink": {
"description": "The footer link color for the webshop.",
"type": "string"
},
"ColorTypographyHeading": {
"description": "The typography heading color for the webshop.",
"type": "string"
},
"ColorTypographyText": {
"description": "The typography text color for the webshop.",
"type": "string"
},
"ColorTypographyLink": {
"description": "The typography link color for the webshop.",
"type": "string"
},
"ColorButtonBackground": {
"description": "The button background color for the webshop.",
"type": "string"
},
"ColorButtonText": {
"description": "The button text color for the webshop.",
"type": "string"
},
"ColorButtonAltBackground": {
"description": "The alternative button background color for the webshop.",
"type": "string"
},
"ColorButtonAltText": {
"description": "The alternative button text color for the webshop.",
"type": "string"
},
"ContentHomePageHeaderTitle": {
"description": "The header title for the webshop's home page.",
"type": "string"
},
"ContentHomePageHeaderText": {
"description": "The header text for the webshop's home page.",
"type": "string"
},
"ContentHomePageHeaderImage": {
"description": "A list of files representing header images for the webshop's home page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AttachedFile"
}
},
"FeaturedGroups": {
"description": "A collection of featured groups displayed on the webshop.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlineFeaturedGroupResult"
}
},
"ContentHomePage": {
"description": "The content for the webshop's home page.",
"type": "string"
},
"ContentHomePageImage": {
"description": "A list of files representing images displayed on the webshop's home page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AttachedFile"
}
},
"ContentHomePageSEOTitle": {
"description": "The SEO title for the webshop's home page.",
"type": "string"
},
"ContentHomePageSEODescription": {
"description": "The SEO description for the webshop's home page.",
"type": "string"
},
"ContentAboutUs": {
"description": "The content for the webshop's about us page.",
"type": "string"
},
"ContentContactUs": {
"description": "The content for the webshop's contact us page.",
"type": "string"
},
"ContentTermsOfPurchase": {
"description": "The content for the webshop's terms of purchase page.",
"type": "string"
},
"ContentPrivacyPolicy": {
"description": "The content for the webshop's privacy policy page.",
"type": "string"
},
"ContentFooterText": {
"description": "The content for the webshop's footer text.",
"type": "string"
},
"LastUpdatedTime": {
"format": "date-time",
"description": "The last updated time for the webshop settings.",
"type": "string"
},
"PaymentMethods": {
"description": "A collection of payment methods available for the webshop.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OnlineSolutions.SubscriberOnlinePaymentMethodEntry"
}
}
}
},
"MoreFlo.Models.InterfaceModels.OrderCreate": {
"description": "Represents the data structure used to create a new order.\r\nThis class specifies the required information for creating an order within the system.",
"required": [
"ExternalReference",
"Customer"
],
"type": "object",
"properties": {
"ExternalReference": {
"description": "The external reference or order number from another system.\r\nThis is a required field.",
"type": "string"
},
"UpdateOnExisting": {
"description": "Indicates whether to update an existing order if one with the same number already exists.",
"type": "boolean"
},
"Id": {
"description": "The unique identifier of the order, automatically generated by the system.",
"type": "string"
},
"Customer": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Customer",
"description": "Information about the customer associated with the order.\r\nEither a customer number within the system or an external customer reference. This is a required field."
},
"BillingAddress": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Address",
"description": "The billing address for the order, if different from the customer's default address."
},
"ShippingAddress": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Address",
"description": "The shipping address for the order, if different from the customer's default address."
},
"Number": {
"format": "int32",
"description": "The order number.",
"type": "integer"
},
"IncomingDate": {
"format": "date-time",
"description": "The date when the order was received.",
"type": "string"
},
"StartDate": {
"format": "date-time",
"description": "The start date for the order (e.g., for a service).",
"type": "string"
},
"ReadyDate": {
"format": "date-time",
"description": "The date when the order is expected to be ready.",
"type": "string"
},
"ExpireDate": {
"format": "date-time",
"description": "The date when the order expires (if applicable).",
"type": "string"
},
"DeliveryDate": {
"format": "date-time",
"description": "The date when the order is scheduled for delivery.",
"type": "string"
},
"OurReference": {
"description": "The reference used by the ordering system.",
"type": "string"
},
"YourReference": {
"description": "The reference provided by the customer or the customer's system.",
"type": "string"
},
"DeliveryTerm": {
"description": "The delivery terms for the order.",
"type": "string"
},
"YourOrderNo": {
"description": "The customer's order number or other identifier.",
"type": "string"
},
"Note": {
"description": "A note or comment associated with the order.",
"type": "string"
},
"Discount": {
"format": "double",
"description": "The discount applied to the order, expressed as a percentage.",
"type": "number"
},
"TotalExclVat": {
"format": "double",
"description": "The total amount of the order, excluding VAT.",
"type": "number"
},
"TotalInclVat": {
"format": "double",
"description": "The total amount of the order, including VAT.",
"type": "number"
},
"TotalVat": {
"format": "double",
"description": "The total VAT amount for the order.",
"type": "number"
},
"Rows": {
"description": "A list of rows containing details about the items in the order.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.OrderRow"
}
},
"State": {
"description": "The current state of the order.",
"enum": [
"Created",
"Saved",
"Started",
"WaitingCustomerResp",
"ReadyForHandOut",
"Closed",
"Waiting",
"Cancelled",
"Delivered",
"Invoiced",
"PayedFromCashier",
"PayedFromExternal"
],
"type": "string"
},
"PaymentOption": {
"description": "The payment option selected for the order.",
"enum": [
"NotSet",
"Web",
"Invoice",
"Cashier"
],
"type": "string"
},
"PaymentReference": {
"description": "A reference related to the payment for the order.",
"type": "string"
},
"PaymentOrigin": {
"description": "The origin of the payment.",
"type": "string"
},
"PaymentStatus": {
"description": "The status of the payment for the order.",
"enum": [
"NotSet",
"NotPaid",
"FullyPaid",
"Refunded"
],
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.v3.OrderCreate": {
"description": "Represents the data required to create a new order.\r\nThis class extends the Order class and specifies the required information for creating an order within the system.",
"required": [
"ExternalReference",
"Customer"
],
"type": "object",
"properties": {
"ExternalReference": {
"description": "The external reference or order number from another system.\r\nThis is a required field for creating a new order.",
"type": "string"
},
"UpdateOnExisting": {
"description": "Indicates whether an existing order with the same number should be updated instead of creating a new one.",
"type": "boolean"
},
"Id": {
"description": "The unique identifier of the order, automatically generated by the system.\r\nThis is a read-only property.",
"type": "string"
},
"Customer": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Customer",
"description": "Information about the customer associated with the order.\r\nThis can be either a customer number within the system or an external customer reference."
},
"AdjustStockIfOpenState": {
"description": "Indicates whether stock levels should be adjusted directly when the order is in an open state.\r\nIf false, stock will be adjusted when the order is paid.",
"type": "boolean"
},
"BillingAddress": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Address",
"description": "The billing address for the order, if different from the customer's default address."
},
"ShippingAddress": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Address",
"description": "The shipping address for the order, if different from the customer's default address."
},
"Number": {
"format": "int32",
"description": "The order number.",
"type": "integer"
},
"IncomingDate": {
"format": "date-time",
"description": "The date when the order was received.",
"type": "string"
},
"StartDate": {
"format": "date-time",
"description": "The date when the order process is scheduled to start.",
"type": "string"
},
"ReadyDate": {
"format": "date-time",
"description": "The date when the order is expected to be ready for pickup or delivery.",
"type": "string"
},
"ExpireDate": {
"format": "date-time",
"description": "The date when the order expires (if applicable).",
"type": "string"
},
"DeliveryDate": {
"format": "date-time",
"description": "The date when the order is scheduled for delivery.",
"type": "string"
},
"OurReference": {
"description": "The reference used by the system for the order.",
"type": "string"
},
"YourReference": {
"description": "The reference provided by the customer or an external system for the order.",
"type": "string"
},
"DeliveryTerm": {
"description": "The delivery terms for the order.",
"type": "string"
},
"YourOrderNo": {
"description": "The customer's order number or identifier.",
"type": "string"
},
"Note": {
"description": "A general note or comment associated with the order.",
"type": "string"
},
"Discount": {
"format": "double",
"description": "The discount applied to the entire order, expressed as a percentage.",
"type": "number"
},
"TotalExclVat": {
"format": "double",
"description": "The total amount of the order, excluding VAT.",
"type": "number"
},
"TotalInclVat": {
"format": "double",
"description": "The total amount of the order, including VAT.",
"type": "number"
},
"TotalVat": {
"format": "double",
"description": "The total VAT amount for the order.",
"type": "number"
},
"Rows": {
"description": "A list of rows containing details about the items included in the order.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.OrderRow"
}
},
"State": {
"description": "The current state of the order.",
"enum": [
"Created",
"Saved",
"Started",
"WaitingCustomerResp",
"ReadyForHandOut",
"Waiting",
"Cancelled",
"Delivered"
],
"type": "string"
},
"PaymentOption": {
"description": "The payment option selected for the order.",
"enum": [
"NotSet",
"Web",
"Invoice",
"Cashier"
],
"type": "string"
},
"PaymentReference": {
"description": "A reference related to the payment for the order.",
"type": "string"
},
"PaymentOrigin": {
"description": "The origin or source of the payment.",
"type": "string"
},
"PaymentStatus": {
"description": "The payment status of the order.",
"enum": [
"NotSet",
"NotPaid",
"FullyPaid",
"Refunded"
],
"type": "string"
},
"DeliveryOption": {
"description": "The delivery option selected for the order.",
"enum": [
"NotSet",
"Pickup",
"Send"
],
"type": "string"
},
"BookableResourceId": {
"description": "The identifier of the bookable resource associated with the order.",
"type": "string"
},
"ModifiedTime": {
"format": "date-time",
"description": "The last time the order was modified.",
"type": "string"
},
"AttestantName": {
"description": "The name of the person who attested or approved the order.",
"type": "string"
},
"AttestantEmail": {
"description": "The email address of the person who attested or approved the order.",
"type": "string"
},
"AttestantState": {
"description": "The attestation state of the order.",
"enum": [
"NotSet",
"WaitingAttest",
"AttestOK",
"ActionRequired"
],
"type": "string"
},
"ExtraAccountingInfo": {
"description": "Extra accounting information related to the order.",
"type": "string"
},
"AttestantShortCode": {
"description": "A short code or identifier for the attestant.",
"type": "string"
},
"AttestantTemplate": {
"description": "A template or format used for attestation (e.g., a circulation template).",
"type": "string"
},
"AttachedFiles": {
"description": "Files attached to the order.\r\nThese are typically uploaded via the static.moreflo.com/file/upload endpoint.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AttachedFile"
}
},
"OriginType": {
"description": "The type of origin of the order (e.g., web, phone, in-store).",
"enum": [
"Unknown",
"Apps",
"CashRegister",
"Fortnox"
],
"type": "string"
},
"Origin": {
"description": "The origin of the order, based on the OriginType.\r\nFor example, if OriginType is CashRegister, this value should contain the serial number of the cash register.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.v3.OrderRow": {
"description": "Represents a row within an order, detailing information about a specific item.",
"type": "object",
"properties": {
"ArticleNumber": {
"description": "The article number of the item.",
"type": "string"
},
"ArticleName": {
"description": "The name of the item.",
"type": "string"
},
"UnitAmountInclVatExclDiscount": {
"format": "double",
"description": "The unit amount of the item, including VAT but excluding any discounts.",
"type": "number"
},
"Discount": {
"format": "double",
"description": "The discount applied to the item.",
"type": "number"
},
"VatRate": {
"format": "double",
"description": "The VAT rate applied to the item.",
"type": "number"
},
"Quantity": {
"format": "double",
"description": "The quantity of the item.",
"type": "number"
},
"SerialNumber": {
"description": "The serial number of the item.",
"type": "string"
},
"RowSum": {
"format": "double",
"description": "The total sum or price of the row (quantity multiplied by unit price, after discount).",
"type": "number"
},
"ReceiptNote": {
"description": "A note or text associated with the row, typically used for text-only rows.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.v3.OrdersResult": {
"description": "Represents a paginated result containing a list of order results.\r\nThis class is used to return a collection of orders, along with pagination information, in API responses.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.OrderResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.v3.OrderResult": {
"description": "Represents the result of an operation that returns a single order.\r\nThis class encapsulates an Order object and its unique identifier, typically used in API responses for single order operations.",
"type": "object",
"properties": {
"Order": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.Order",
"description": "The Order object containing the order data."
},
"Id": {
"description": "The unique identifier of the order.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.v3.Order": {
"description": "Represents an order, encompassing details about a purchase or transaction.\r\nThis class encapsulates information about an order, including customer details, dates, addresses, financial information, and related data.",
"required": [
"Customer"
],
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the order, automatically generated by the system.\r\nThis is a read-only property.",
"type": "string"
},
"Customer": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Customer",
"description": "Information about the customer associated with the order.\r\nThis can be either a customer number within the system or an external customer reference."
},
"AdjustStockIfOpenState": {
"description": "Indicates whether stock levels should be adjusted directly when the order is in an open state.\r\nIf false, stock will be adjusted when the order is paid.",
"type": "boolean"
},
"BillingAddress": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Address",
"description": "The billing address for the order, if different from the customer's default address."
},
"ShippingAddress": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Address",
"description": "The shipping address for the order, if different from the customer's default address."
},
"Number": {
"format": "int32",
"description": "The order number.",
"type": "integer"
},
"IncomingDate": {
"format": "date-time",
"description": "The date when the order was received.",
"type": "string"
},
"StartDate": {
"format": "date-time",
"description": "The date when the order process is scheduled to start.",
"type": "string"
},
"ReadyDate": {
"format": "date-time",
"description": "The date when the order is expected to be ready for pickup or delivery.",
"type": "string"
},
"ExpireDate": {
"format": "date-time",
"description": "The date when the order expires (if applicable).",
"type": "string"
},
"DeliveryDate": {
"format": "date-time",
"description": "The date when the order is scheduled for delivery.",
"type": "string"
},
"OurReference": {
"description": "The reference used by the system for the order.",
"type": "string"
},
"YourReference": {
"description": "The reference provided by the customer or an external system for the order.",
"type": "string"
},
"DeliveryTerm": {
"description": "The delivery terms for the order.",
"type": "string"
},
"YourOrderNo": {
"description": "The customer's order number or identifier.",
"type": "string"
},
"ExternalReference": {
"description": "An external identification for the order.\r\nThis must be prefixed (e.g., SYS-52351).",
"type": "string"
},
"Note": {
"description": "A general note or comment associated with the order.",
"type": "string"
},
"Discount": {
"format": "double",
"description": "The discount applied to the entire order, expressed as a percentage.",
"type": "number"
},
"TotalExclVat": {
"format": "double",
"description": "The total amount of the order, excluding VAT.",
"type": "number"
},
"TotalInclVat": {
"format": "double",
"description": "The total amount of the order, including VAT.",
"type": "number"
},
"TotalVat": {
"format": "double",
"description": "The total VAT amount for the order.",
"type": "number"
},
"Rows": {
"description": "A list of rows containing details about the items included in the order.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.v3.OrderRow"
}
},
"State": {
"description": "The current state of the order.",
"enum": [
"Created",
"Saved",
"Started",
"WaitingCustomerResp",
"ReadyForHandOut",
"Waiting",
"Cancelled",
"Delivered"
],
"type": "string"
},
"PaymentOption": {
"description": "The payment option selected for the order.",
"enum": [
"NotSet",
"Web",
"Invoice",
"Cashier"
],
"type": "string"
},
"PaymentReference": {
"description": "A reference related to the payment for the order.",
"type": "string"
},
"PaymentOrigin": {
"description": "The origin or source of the payment.",
"type": "string"
},
"PaymentStatus": {
"description": "The payment status of the order.",
"enum": [
"NotSet",
"NotPaid",
"FullyPaid",
"Refunded"
],
"type": "string"
},
"DeliveryOption": {
"description": "The delivery option selected for the order.",
"enum": [
"NotSet",
"Pickup",
"Send"
],
"type": "string"
},
"BookableResourceId": {
"description": "The identifier of the bookable resource associated with the order.",
"type": "string"
},
"ModifiedTime": {
"format": "date-time",
"description": "The last time the order was modified.",
"type": "string"
},
"AttestantName": {
"description": "The name of the person who attested or approved the order.",
"type": "string"
},
"AttestantEmail": {
"description": "The email address of the person who attested or approved the order.",
"type": "string"
},
"AttestantState": {
"description": "The attestation state of the order.",
"enum": [
"NotSet",
"WaitingAttest",
"AttestOK",
"ActionRequired"
],
"type": "string"
},
"ExtraAccountingInfo": {
"description": "Extra accounting information related to the order.",
"type": "string"
},
"AttestantShortCode": {
"description": "A short code or identifier for the attestant.",
"type": "string"
},
"AttestantTemplate": {
"description": "A template or format used for attestation (e.g., a circulation template).",
"type": "string"
},
"AttachedFiles": {
"description": "Files attached to the order.\r\nThese are typically uploaded via the static.moreflo.com/file/upload endpoint.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AttachedFile"
}
},
"OriginType": {
"description": "The type of origin of the order (e.g., web, phone, in-store).",
"enum": [
"Unknown",
"Apps",
"CashRegister",
"Fortnox"
],
"type": "string"
},
"Origin": {
"description": "The origin of the order, based on the OriginType.\r\nFor example, if OriginType is CashRegister, this value should contain the serial number of the cash register.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.ReceiptResult": {
"description": "Represents the result of an operation that returns a receipt.\r\nThis encapsulates a ReceiptGet object and its unique identifier, typically used in API responses related to retrieving or managing receipt data.",
"type": "object",
"properties": {
"Receipt": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ReceiptGet",
"description": "The ReceiptGet object containing the receipt data."
},
"Id": {
"description": "The unique identifier of the receipt.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.ReceiptGet": {
"description": "Represents a receipt, extending the base Receipt class with the UTC creation timestamp.\r\nThis class is used to return receipt data, including all standard receipt information and the time when the receipt was created in UTC.",
"required": [
"ReceiptNumber",
"Origin",
"ReceiptType",
"TransactionDate",
"TotalPriceIncVat",
"TotalPriceExVat",
"TotalVat",
"DoStockMgmt",
"Merchant",
"Articles",
"Payments",
"Vat"
],
"type": "object",
"properties": {
"CreatedTimeUTC": {
"format": "date-time",
"description": "The UTC timestamp when the receipt was created.",
"type": "string"
},
"ReceiptNumber": {
"format": "int32",
"description": "The unique receipt number.",
"type": "integer"
},
"Origin": {
"description": "The origin of the receipt.\r\nThis should identify the source of the receipt, such as the serial number of a cashier or a descriptive name like \"Cashier 1\".",
"type": "string"
},
"Id": {
"description": "The unique identifier of the receipt.\r\nThis cannot be set externally and is generated by the system.",
"type": "string"
},
"ReceiptType": {
"description": "The type of receipt.",
"enum": [
"CashierReceipt",
"Invoice",
"External",
"Online",
"ExpressOrder"
],
"type": "string"
},
"InternalNote": {
"description": "An internal note associated with the receipt.\r\nThis note is not printed on the receipt.",
"maxLength": 1024,
"minLength": 0,
"type": "string"
},
"TransactionDate": {
"format": "date-time",
"description": "The date and time when the receipt transaction was made.",
"type": "string"
},
"CashierName": {
"description": "The name of the cashier who completed the receipt.\r\nThis represents the sales person on the receipt.",
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"TotalPriceIncVat": {
"format": "double",
"description": "The total price of the receipt, including VAT and all discounts.",
"type": "number"
},
"TotalPriceExVat": {
"format": "double",
"description": "The total price of the receipt, excluding VAT but including all discounts.",
"type": "number"
},
"TotalVat": {
"format": "double",
"description": "The total VAT amount for the receipt, including all discounts.",
"type": "number"
},
"DoStockMgmt": {
"description": "Defines if stock management should be performed for articles on the receipt.\r\nIf this is a normal sale and DoStockMgmt is TRUE, then the stock quantity of all articles on the receipt will be decreased according to their quantity.",
"type": "boolean"
},
"Merchant": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.Merchant",
"description": "Information about the merchant."
},
"Rounding": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.Rounding",
"description": "Information about any rounding applied to the receipt total.\r\nFor example, if 10.50 SEK is rounded to 11.00 SEK, then the rounding is 0.5 SEK."
},
"ControlUnit": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ControlUnit",
"description": "Information about the control unit used in the receipt transaction.\r\nThis is legally required in some regions for ordinary cashiers."
},
"Customers": {
"description": "A list of customers associated with the receipt.\r\nNormally, there should only be one customer, but sometimes a ContractCustomer is also relevant.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.Customer"
}
},
"Articles": {
"description": "A list of all articles included in the receipt.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.Article"
}
},
"Payments": {
"description": "A list of all payment methods used in the receipt.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.Payment"
}
},
"Vat": {
"description": "A list of all VAT types applied in the receipt.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.Vat"
}
},
"Orders": {
"description": "A list of order references from which articles may originate.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.OrderReference"
}
},
"Discounts": {
"description": "A list of all discounts applied to the receipt.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ReceiptDiscount"
}
},
"Recipients": {
"description": "A list of recipients if the receipt is to be sent to an end customer via email or SMS.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.Recipient"
}
},
"TextRows": {
"description": "A list of any additional text rows to be printed on the receipt.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ReceiptTextRow"
}
},
"ClientDetails": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ClientDetails",
"description": "Client details, required for receipts originating from a Cashier when ReceiptType is set to CashierReceipt."
},
"Voucher": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Voucher",
"description": "Accounting details.\r\nIf this receipt should be bookkept, this section contains voucher information for creating the voucher."
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.Merchant": {
"description": "Represents merchant information, including identification, contact details, and address.",
"required": [
"CorporateIdentityNumber",
"Name"
],
"type": "object",
"properties": {
"CorporateIdentityNumber": {
"description": "The corporate identity number of the merchant (e.g., SSN, Organization number).",
"type": "string"
},
"Name": {
"description": "The name of the company or merchant.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"AddressLine1": {
"description": "The first line of the merchant's address.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"AddressLine2": {
"description": "The second line of the merchant's address (optional).",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"ZipCode": {
"description": "The postal code of the merchant's address.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"City": {
"description": "The city of the merchant's address.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"Country": {
"description": "The country of the merchant's address.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"Phone": {
"description": "The merchant's landline or cell phone number.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"HomePage": {
"description": "The merchant's home page address (URL).",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"Email": {
"description": "The merchant's email address.",
"maxLength": 128,
"minLength": 0,
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.Rounding": {
"description": "Represents the rounding applied to the total amount of a receipt.\r\nThis class encapsulates information about the adjustment made to the receipt total due to rounding to a specific denomination.",
"required": [
"Amount"
],
"type": "object",
"properties": {
"Amount": {
"format": "double",
"description": "The total rounding amount applied to the receipt.",
"type": "number"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.ControlUnit": {
"description": "Represents a tax control unit and its associated control code.\r\nThis class encapsulates information about a tax control unit, including its unique identifier and the control code it provides.",
"required": [
"UnitId"
],
"type": "object",
"properties": {
"UnitId": {
"description": "The unit identifier of the tax control unit.",
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"ControlCode": {
"description": "The control code received from the tax control unit.",
"maxLength": 100,
"minLength": 0,
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.Customer": {
"description": "Represents customer information.\r\nThis class encapsulates data related to a customer, including their customer number, name, and customer type.",
"required": [
"CustomerNumber"
],
"type": "object",
"properties": {
"CustomerNumber": {
"description": "The unique customer number.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"CompanyName": {
"description": "The company name, if the customer is a company.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"Fullname": {
"description": "The full name of the customer.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"CustomerType": {
"description": "The type of customer.",
"enum": [
"Private",
"Company"
],
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.Article": {
"description": "Represents an article within a receipt or order, containing details about the item purchased or sold.",
"required": [
"ArticleType",
"ArticleNumber",
"Name",
"Quantity",
"UnitPrice",
"VatRate",
"TotalPriceIncVat",
"TotalPriceExVat",
"TotalVat"
],
"type": "object",
"properties": {
"OrderIndex": {
"format": "int32",
"description": "The index of this article within the order specified in the Receipt.Order.",
"type": "integer"
},
"ArticleType": {
"description": "The type of article.",
"enum": [
"Goods",
"Service",
"GiftCard",
"Prepay",
"ValueCard",
"GoodsMarginProfit",
"BuyGoodsMarginProfit",
"CommissionSale",
"CashRefundSlip"
],
"type": "string"
},
"ArticleNumber": {
"description": "The article number, which may not necessarily be numeric.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"Name": {
"description": "The name of the article, suitable for display and printing.",
"maxLength": 160,
"minLength": 0,
"type": "string"
},
"Quantity": {
"format": "double",
"description": "The quantity of the article.\r\nQuantity is always positive, even in the case of a refund purchase.",
"type": "number"
},
"UnitPrice": {
"format": "double",
"description": "The price of a single unit of this article, including VAT.\r\nMust be negative in the case of a refund purchase.",
"type": "number"
},
"VatRate": {
"format": "double",
"description": "The VAT rate applied to the article.",
"type": "number"
},
"TotalPriceIncVat": {
"format": "double",
"description": "The total price of the article, including VAT and all applicable discounts.\r\nMust be negative in the case of a refund purchase.",
"type": "number"
},
"TotalPriceExVat": {
"format": "double",
"description": "The total price of the article, excluding VAT and including all applicable discounts.\r\nMust be negative in the case of a refund purchase.",
"type": "number"
},
"TotalVat": {
"format": "double",
"description": "The total VAT amount for the article, including all applicable discounts.\r\nMust be negative in the case of a refund purchase.",
"type": "number"
},
"Discounts": {
"description": "A list of discounts applied to the article.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ArticleDiscount"
}
},
"Attributes": {
"description": "A list of attributes associated with the article.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ReceiptArticleAttribute"
}
},
"TextRows": {
"description": "A list of text rows associated with the article.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ArticleTextRow"
}
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.Payment": {
"description": "Represents a payment within a transaction.\r\nThis class encapsulates information about a payment, including its name, amount, type, and transaction details.",
"required": [
"Name",
"Amount",
"PaymentType"
],
"type": "object",
"properties": {
"Name": {
"description": "The name of the payment method, intended for display on a receipt.\r\nThis is not a technical name.",
"type": "string"
},
"Amount": {
"format": "double",
"description": "The amount paid.",
"type": "number"
},
"PaymentType": {
"description": "The type of payment.",
"enum": [
"NamedPayment",
"CashPayment",
"BankCardPayment",
"AppsCardPayment",
"AppsDebitCardPayment",
"Invoice",
"ExternalPayment",
"Change",
"Swish",
"ResursBank",
"NorthmillBNPL",
"NorthmillPayout",
"Klarna",
"Paypal",
"Stripe",
"SveaWebPay",
"WooPayments"
],
"type": "string"
},
"TransactionId": {
"description": "The transaction identifier, if the payment is integrated and generates a transaction ID.",
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"TransactionOrigin": {
"description": "The technical name of a payment integration.",
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"AppsTransaction": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.AppsTransaction",
"description": "Details for an AppsCardPayment, if PaymentType is set to AppsCardPayment."
},
"BankCardTransaction": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.BankCardTransaction",
"description": "Details for a BankCardPayment, if PaymentType is set to BankCardPayment."
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.Vat": {
"description": "Represents VAT (Value Added Tax) information within a receipt.\r\nThis class encapsulates details about a specific VAT rate applied in the transaction, including the rate, total VAT amount, and total purchase amount.",
"required": [
"VatRate",
"TotalVat",
"TotalAmount"
],
"type": "object",
"properties": {
"VatRate": {
"format": "double",
"description": "The VAT rate.",
"type": "number"
},
"TotalVat": {
"format": "double",
"description": "The total VAT amount on the receipt for the given VatRate.",
"type": "number"
},
"TotalAmount": {
"format": "double",
"description": "The total purchase amount for the given VatRate on the receipt.\r\n\r\nExample:\r\nA receipt contains one article priced 5 SEK, with 25% VAT.\r\nIn this case:\r\nVatRate = 25.0\r\nTotalVat = 1.0\r\nTotalAmount = 5.0",
"type": "number"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.OrderReference": {
"description": "Represents a reference to an order within a receipt.\r\nThis class encapsulates information about an order reference, including its index, order number, origin, and state change.",
"required": [
"Index",
"OrderNumber",
"Origin"
],
"type": "object",
"properties": {
"Index": {
"format": "int32",
"description": "The unique index (0-based) of the order reference within the OrderReference list in a receipt.\r\nArticles on the receipt may refer to an order using this index number. This is a required field.",
"type": "integer"
},
"OrderNumber": {
"description": "The order number. This is a required field.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"Origin": {
"description": "The type of origin or source, if the article originates from an order handout. This is a required field.",
"enum": [
"VismaAdministration",
"AppsOrder",
"ServiceOrder",
"BookingOrder",
"TicketOrder",
"ServeIT",
"Fortnox",
"ServeITRefund"
],
"type": "string"
},
"OrderChangeState": {
"description": "Specifies if the order state should be changed.",
"enum": [
"Paid",
"Cancelled"
],
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.ReceiptDiscount": {
"description": "Represents a discount applied to a receipt.\r\nThis class encapsulates information about a discount that affects the overall transaction, including its type, amount, and description.",
"required": [
"DiscountType",
"Amount",
"Description"
],
"type": "object",
"properties": {
"DiscountType": {
"description": "The type of discount.",
"enum": [
"None",
"Percent",
"Amount"
],
"type": "string"
},
"Amount": {
"format": "double",
"description": "The total amount of the receipt discount.\r\nThis value must be calculated from the percentage discount value and should represent the actual monetary reduction.\r\nRemember that this discount must be distributed across all articles on the receipt, affecting their TotalPriceIncVat, TotalPriceExVat, and VatRate attributes.",
"type": "number"
},
"Description": {
"description": "A descriptive text of the discount, intended for printing on the receipt.",
"type": "string"
},
"Percentage": {
"format": "double",
"description": "The percentage value of this receipt discount, if applicable.",
"type": "number"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.Recipient": {
"description": "Represents a recipient of a receipt, specifying the delivery method and contact information.\r\nThis class encapsulates information about how a receipt should be sent to a customer, either by email or SMS.",
"type": "object",
"properties": {
"Carrier": {
"description": "Specifies the carrier used to send the receipt, either Email or SMS.",
"enum": [
"Email",
"SMS"
],
"type": "string"
},
"EmailAddress": {
"description": "The email address of the recipient, if the Carrier is Email.",
"type": "string"
},
"MobilePhone": {
"description": "The mobile phone number of the recipient, if the Carrier is SMS.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.ReceiptTextRow": {
"description": "Represents a text row to be printed on a receipt, either in the header or footer.\r\nThis class encapsulates information about a single line of text that should appear on a receipt, including its type (header/footer), position, and content.",
"required": [
"RowType",
"RowNum"
],
"type": "object",
"properties": {
"RowType": {
"description": "Specifies whether the text row is part of the header or footer.\r\nValid values are defined by the TextRowType enum.",
"enum": [
"Header",
"Footer"
],
"type": "string"
},
"RowNum": {
"format": "int32",
"description": "The row number of this text within the header or footer, used for ordering.",
"type": "integer"
},
"Text": {
"description": "The text content of the row.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.ClientDetails": {
"description": "Client details of cash register, only set by MoreFlo Cash registers.",
"required": [
"RegisterNumber"
],
"type": "object",
"properties": {
"ClientId": {
"description": "Client ID, id of cash register.",
"maxLength": 512,
"minLength": 0,
"type": "string"
},
"ClientSerialNumber": {
"description": "Serial number, i.e. manufacturing number.",
"maxLength": 512,
"minLength": 0,
"type": "string"
},
"RegisterNumber": {
"description": "Register number",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.Voucher": {
"description": "Represents a voucher, which is a document used for accounting purposes.\r\nThis class encapsulates information about a voucher, including its identification, state, accounting details, and related rows.",
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the voucher.",
"type": "string"
},
"UpdateOnExisting": {
"description": "Indicates whether an update should be performed during creation if a voucher with the same Id already exists.\r\nThis is only applicable to voucher update API calls.",
"type": "boolean"
},
"SupportingNumber": {
"format": "int32",
"description": "A supporting number for the voucher, set by the system.",
"type": "integer"
},
"VoucherNumber": {
"description": "The verification number assigned by the external accounting system.\r\nSet by the system if the voucher is synchronized with an external accounting system.",
"type": "string"
},
"VoucherSeries": {
"description": "The verification series assigned by the external accounting system.\r\nSet by the system if the voucher is synchronized with an external accounting system.",
"type": "string"
},
"IsDeleted": {
"description": "A flag indicating if this supporting voucher is marked as deleted.\r\nThis is only relevant for voucher updates.",
"type": "boolean"
},
"State": {
"description": "The current state of the voucher.",
"enum": [
"Pending",
"ActionRequried",
"Locked",
"Done"
],
"type": "string"
},
"ErrorReason": {
"description": "The reason for an error if synchronization with an external system failed.",
"maxLength": 4096,
"minLength": 0,
"type": "string"
},
"IsBookkept": {
"description": "A flag indicating if this supporting voucher has been recorded in an external accounting system.\r\nIf true, the voucher will not be synchronized again.",
"type": "boolean"
},
"VoucherSyncReference": {
"description": "A name or other reference to the external accounting system.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"VoucherSyncTime": {
"format": "date-time",
"description": "The timestamp of when this supporting voucher was recorded in the external accounting system.",
"type": "string"
},
"CashierSerialNumber": {
"description": "The serial number of the cashier that sent this voucher, if the voucher originates from an end-of-day report.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"VoucherDate": {
"format": "date-time",
"description": "The accounting date of the voucher.",
"type": "string"
},
"VoucherText": {
"description": "The accounting text or description of the voucher.",
"maxLength": 1000,
"minLength": 0,
"type": "string"
},
"Project": {
"description": "A project reference associated with the voucher.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"CostCenter": {
"description": "A cost center reference associated with the voucher.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"ReferenceNumber": {
"description": "The identifier or number of a related reference, if any.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"ReferenceType": {
"description": "The type of reference, if any.",
"enum": [
"None",
"Invoice",
"WebOrder",
"PayLink",
"TicketOrder",
"BookingOrder",
"ServiceOrder",
"Receipt",
"EndOfDayReport",
"Manual",
"External",
"NorthmillTransaction",
"ValueCard",
"GiftCard"
],
"type": "string"
},
"Rows": {
"description": "A list of rows containing details about the voucher's entries.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.VoucherRow"
}
},
"CreatedTime": {
"format": "date-time",
"description": "The timestamp of when the voucher was created.",
"type": "string"
},
"ModifiedTime": {
"format": "date-time",
"description": "The timestamp of when the voucher was last modified.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.ArticleDiscount": {
"description": "Represents a discount applied to an article.",
"required": [
"DiscountType",
"Amount",
"Description"
],
"type": "object",
"properties": {
"DiscountType": {
"description": "The type of discount.",
"enum": [
"None",
"Percent",
"Amount"
],
"type": "string"
},
"Amount": {
"format": "double",
"description": "The total amount of the discount, even if the discount is a percentage.",
"type": "number"
},
"Description": {
"description": "The name or description of the discount.",
"type": "string"
},
"Percentage": {
"format": "double",
"description": "The percentage value of the discount, if the DiscountType is Percent.",
"type": "number"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.ReceiptArticleAttribute": {
"description": "Represents an attribute associated with an article in a receipt.\r\nThis encapsulates information about a specific property or characteristic of an article, such as size or color.",
"required": [
"AttrbuteType"
],
"type": "object",
"properties": {
"AttrbuteType": {
"description": "The type of attribute.",
"enum": [
"PrepayNumber",
"PrepayedOrderNumber",
"SerialNumber"
],
"type": "string"
},
"Value": {
"description": "The value of the attribute.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.ArticleTextRow": {
"description": "Represents a text row associated with an article.\r\nThis class encapsulates information about a single line of text related to an article, such as a description or instruction.",
"required": [
"RowNum",
"Text"
],
"type": "object",
"properties": {
"RowNum": {
"format": "int32",
"description": "The row number of this text row.",
"type": "integer"
},
"Text": {
"description": "The text content of the row.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.AppsTransaction": {
"description": "Represents a transaction initiated by an application, specifically relating to member cards.\r\nThis class encapsulates information about a transaction involving a member card, including the card number and type.",
"type": "object",
"properties": {
"MemberCardNumber": {
"description": "The member card number used in the transaction.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"MemberCardType": {
"description": "The type of member card used in the transaction.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.BankCardTransaction": {
"description": "Represents a bank card transaction, containing details related to the payment processing.\r\nThis class encapsulates information about a transaction made with a bank card, including details from the Bambora payment system and other transaction-specific data.",
"type": "object",
"properties": {
"AcquirerId": {
"description": "The acquirer identifier for the transaction.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"ApprovalCode": {
"description": "The approval code provided for the transaction.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"AuthorizationMethod": {
"description": "The method used for authorization.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"AuthorizationResponder": {
"description": "The responder for the authorization request.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"BaseAmount": {
"format": "double",
"description": "The base amount of the transaction.",
"type": "number"
},
"CurrencySymbol": {
"description": "The currency symbol for the transaction.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"DccAmount": {
"format": "double",
"description": "The amount in the cardholder's currency, if Dynamic Currency Conversion (DCC) was used.",
"type": "number"
},
"DccCardholderDisclaimer": {
"description": "Disclaimer for the cardholder related to DCC.",
"type": "string"
},
"DccCurrencyCode": {
"description": "The currency code for DCC.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"DccCurrencyExponent": {
"description": "The currency exponent for DCC.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"DccCurrencySymbol": {
"description": "The currency symbol for DCC.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"DccExchangeRate": {
"format": "double",
"description": "The exchange rate for DCC.",
"type": "number"
},
"DccMarginRate": {
"format": "double",
"description": "The margin rate for DCC.",
"type": "number"
},
"DccMerchantDisclaimer": {
"description": "Disclaimer for the merchant related to DCC.",
"type": "string"
},
"EmvAID": {
"description": "The Application Identifier (AID) for EMV transactions.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"EmvARC": {
"description": "The Application Response Code (ARC) for EMV transactions.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"EmvATC": {
"description": "The Application Transaction Counter (ATC) for EMV transactions.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"EmvPSN": {
"description": "The Application Preferred Name (PSN) for EMV transactions.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"EmvTSI": {
"description": "The Transaction Status Information (TSI) for EMV transactions.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"EmvTVR": {
"description": "The Terminal Verification Results (TVR) for EMV transactions.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"EncryptedInformation": {
"description": "Encrypted information related to the transaction.",
"maxLength": 1024,
"minLength": 0,
"type": "string"
},
"EntryMode": {
"description": "The mode of entry for the card information (e.g., swiped, chip, contactless).",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"ExtraAmount": {
"format": "double",
"description": "An extra amount associated with the transaction (e.g., tip).",
"type": "number"
},
"FinancialInstitution": {
"description": "The financial institution involved in the transaction.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"InternalReference": {
"description": "An internal reference for the transaction.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"MaskedPAN": {
"description": "The masked Primary Account Number (PAN) of the card.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"MerchantId": {
"description": "The merchant identifier.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"ProductName": {
"description": "The product name associated with the transaction.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"RetrievalReference": {
"description": "The retrieval reference for the transaction.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"ReversalReference": {
"description": "The reversal reference for the transaction.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"SPDHResponseCode": {
"description": "The SPDH (Specific Payment Data Host) response code.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"TerminalId": {
"description": "The terminal identifier.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"TotalAmount": {
"format": "double",
"description": "The total amount of the transaction.",
"type": "number"
},
"TransactionReference": {
"description": "The transaction reference.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"TransactionResult": {
"description": "The result of the transaction.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"TransactionType": {
"description": "The type of transaction.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"VerificationMethod": {
"description": "The method used for card verification.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"TransactionId": {
"description": "The transaction identifier.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"ReferenceNo": {
"description": "A reference number for the transaction.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"PwId": {
"description": "The Payment Window identifier.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"RefundId": {
"description": "The refund identifier.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"CardVendor": {
"description": "The card vendor (e.g., Visa, Mastercard).",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"CardAuthInfo": {
"description": "Card authorization information.",
"maxLength": 100,
"minLength": 0,
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.VoucherRow": {
"description": "Represents a row within a voucher, detailing an individual accounting entry.",
"type": "object",
"properties": {
"AccountDescription": {
"description": "Description of the account, either from the accounting system or manually entered.",
"type": "string"
},
"AccountNumber": {
"format": "int32",
"description": "The account number for this row.",
"type": "integer"
},
"DebitAmount": {
"format": "double",
"description": "The amount debited, if any.",
"type": "number"
},
"CreditAmount": {
"format": "double",
"description": "The amount credited, if any.",
"type": "number"
},
"TransactionText": {
"description": "Text from the external accounting system, if applicable (e.g., when synchronized).",
"type": "string"
},
"Project": {
"description": "A project reference associated with this row.",
"type": "string"
},
"CostCenter": {
"description": "A cost center reference associated with this row.",
"type": "string"
},
"IsDeleted": {
"description": "A flag indicating if this supporting voucher row is marked as deleted.",
"type": "boolean"
},
"CreatedTime": {
"format": "date-time",
"description": "The timestamp of when this row was created.",
"type": "string"
},
"ModifiedTime": {
"format": "date-time",
"description": "The timestamp of when this row was last modified.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.ReceiptsResult": {
"description": "Represents a paginated result containing a list of receipt results.\r\nThis class is used to return a collection of receipts, along with pagination information, in API responses.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ReceiptResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.Receipts.Receipt": {
"description": "Represents a receipt, containing details about a transaction.\r\nThis class encapsulates all the information related to a receipt, including transaction details, articles, payments, and customer information.",
"required": [
"ReceiptNumber",
"Origin",
"ReceiptType",
"TransactionDate",
"TotalPriceIncVat",
"TotalPriceExVat",
"TotalVat",
"DoStockMgmt",
"Merchant",
"Articles",
"Payments",
"Vat"
],
"type": "object",
"properties": {
"ReceiptNumber": {
"format": "int32",
"description": "The unique receipt number.",
"type": "integer"
},
"Origin": {
"description": "The origin of the receipt.\r\nThis should identify the source of the receipt, such as the serial number of a cashier or a descriptive name like \"Cashier 1\".",
"type": "string"
},
"Id": {
"description": "The unique identifier of the receipt.\r\nThis cannot be set externally and is generated by the system.",
"type": "string"
},
"ReceiptType": {
"description": "The type of receipt.",
"enum": [
"CashierReceipt",
"Invoice",
"External",
"Online",
"ExpressOrder"
],
"type": "string"
},
"InternalNote": {
"description": "An internal note associated with the receipt.\r\nThis note is not printed on the receipt.",
"maxLength": 1024,
"minLength": 0,
"type": "string"
},
"TransactionDate": {
"format": "date-time",
"description": "The date and time when the receipt transaction was made.",
"type": "string"
},
"CashierName": {
"description": "The name of the cashier who completed the receipt.\r\nThis represents the sales person on the receipt.",
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"TotalPriceIncVat": {
"format": "double",
"description": "The total price of the receipt, including VAT and all discounts.",
"type": "number"
},
"TotalPriceExVat": {
"format": "double",
"description": "The total price of the receipt, excluding VAT but including all discounts.",
"type": "number"
},
"TotalVat": {
"format": "double",
"description": "The total VAT amount for the receipt, including all discounts.",
"type": "number"
},
"DoStockMgmt": {
"description": "Defines if stock management should be performed for articles on the receipt.\r\nIf this is a normal sale and DoStockMgmt is TRUE, then the stock quantity of all articles on the receipt will be decreased according to their quantity.",
"type": "boolean"
},
"Merchant": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.Merchant",
"description": "Information about the merchant."
},
"Rounding": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.Rounding",
"description": "Information about any rounding applied to the receipt total.\r\nFor example, if 10.50 SEK is rounded to 11.00 SEK, then the rounding is 0.5 SEK."
},
"ControlUnit": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ControlUnit",
"description": "Information about the control unit used in the receipt transaction.\r\nThis is legally required in some regions for ordinary cashiers."
},
"Customers": {
"description": "A list of customers associated with the receipt.\r\nNormally, there should only be one customer, but sometimes a ContractCustomer is also relevant.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.Customer"
}
},
"Articles": {
"description": "A list of all articles included in the receipt.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.Article"
}
},
"Payments": {
"description": "A list of all payment methods used in the receipt.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.Payment"
}
},
"Vat": {
"description": "A list of all VAT types applied in the receipt.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.Vat"
}
},
"Orders": {
"description": "A list of order references from which articles may originate.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.OrderReference"
}
},
"Discounts": {
"description": "A list of all discounts applied to the receipt.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ReceiptDiscount"
}
},
"Recipients": {
"description": "A list of recipients if the receipt is to be sent to an end customer via email or SMS.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.Recipient"
}
},
"TextRows": {
"description": "A list of any additional text rows to be printed on the receipt.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ReceiptTextRow"
}
},
"ClientDetails": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Receipts.ClientDetails",
"description": "Client details, required for receipts originating from a Cashier when ReceiptType is set to CashierReceipt."
},
"Voucher": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Voucher",
"description": "Accounting details.\r\nIf this receipt should be bookkept, this section contains voucher information for creating the voucher."
}
}
},
"MoreFlo.Models.InterfaceModels.ArticleSaleEventsResult": {
"description": "Represents a paged result containing a list of ArticleSaleEvent objects.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ArticleSaleEvent"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.ArticleSaleEvent": {
"description": "Represents an event where an article is sold.",
"type": "object",
"properties": {
"SalesReference": {
"description": "The sales reference number (receipt number).",
"type": "string"
},
"SalesTime": {
"format": "date-time",
"description": "The time when the sale occurred.",
"type": "string"
},
"CreatedTime": {
"format": "date-time",
"description": "The time when the sale event was created.",
"type": "string"
},
"ArticleNumber": {
"description": "The article number of the sold item.",
"type": "string"
},
"CustomerNumber": {
"description": "The customer number associated with the sale.",
"type": "string"
},
"ArticleName": {
"description": "The name of the sold article.",
"type": "string"
},
"ArticleGroupName": {
"description": "The name of the article group the sold item belongs to.",
"type": "string"
},
"Quantity": {
"format": "double",
"description": "The quantity of the sold article.",
"type": "number"
},
"SalesPricePerItem": {
"format": "double",
"description": "The sales price per item.",
"type": "number"
},
"VatRate": {
"format": "double",
"description": "The VAT rate applied to the sale.",
"type": "number"
}
}
},
"MoreFlo.Models.InterfaceModels.ServiceOrderCreate": {
"description": "Represents the data used to create a new service order.\r\nThis class extends the ServiceOrder class and specifies the required information for creating a service order within the system.",
"required": [
"Id",
"Type",
"State"
],
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the service order to be created.\r\nThis is a required field.",
"type": "string"
},
"Type": {
"description": "The type of service order to be created.\r\nThis is a required field.",
"enum": [
"Notset",
"Express",
"Normal",
"Booking"
],
"type": "string"
},
"State": {
"description": "The initial state of the service order to be created.\r\nThis is a required field.",
"enum": [
"Created",
"Saved",
"Started",
"WaitingCustomerResp",
"ReadyForHandOut",
"Closed",
"WaitingParts",
"Cancelled",
"CostEstimate",
"SentToSupplier",
"WaitingConfirmation"
],
"type": "string"
},
"UpdateOnExisting": {
"description": "Indicates whether to update an existing service order if one with the same number already exists.",
"type": "boolean"
},
"Number": {
"format": "int32",
"description": "The order number.",
"type": "integer"
},
"Color": {
"description": "A color associated with the service order (e.g., for visual categorization).",
"type": "string"
},
"DeliveryTerm": {
"description": "The delivery terms for the service.",
"type": "string"
},
"OrderNo": {
"description": "The order number.",
"type": "string"
},
"YouOrderNo": {
"description": "The customer's order number or reference.",
"type": "string"
},
"BookableResourceId": {
"description": "The identifier of the bookable resource assigned to the service.",
"type": "string"
},
"BookingStartTime": {
"format": "date-time",
"description": "The start time of the booking (if applicable).",
"type": "string"
},
"BookingEndTime": {
"format": "date-time",
"description": "The end time of the booking (if applicable).",
"type": "string"
},
"IncomingDate": {
"format": "date-time",
"description": "The date when the service order was received.",
"type": "string"
},
"StartDate": {
"format": "date-time",
"description": "The date when the service is scheduled to start.",
"type": "string"
},
"ReadyDate": {
"format": "date-time",
"description": "The date when the service is expected to be ready.",
"type": "string"
},
"ExpireDate": {
"format": "date-time",
"description": "The date when the service order expires (if applicable).",
"type": "string"
},
"DeliveryDate": {
"format": "date-time",
"description": "The date when the service is scheduled for delivery.",
"type": "string"
},
"OurReference": {
"description": "The reference used by the system.",
"type": "string"
},
"PerformedBy": {
"description": "The person or entity performing the service.",
"type": "string"
},
"YourReference": {
"description": "The customer's reference.",
"type": "string"
},
"InternNote": {
"description": "Internal notes about the service order.",
"type": "string"
},
"IssueDescription": {
"description": "A description of the issue or problem being addressed.",
"type": "string"
},
"Discount": {
"format": "double",
"description": "The discount applied to the service order.",
"type": "number"
},
"TotalExclVat": {
"format": "double",
"description": "The total amount of the service order, excluding VAT.",
"type": "number"
},
"TotalInclVat": {
"format": "double",
"description": "The total amount of the service order, including VAT.",
"type": "number"
},
"TotalVat": {
"format": "double",
"description": "The total VAT amount for the service order.",
"type": "number"
},
"LastChanged": {
"format": "date-time",
"description": "The date and time when the service order was last changed.",
"type": "string"
},
"Customer": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrderCustomer",
"description": "Information about the customer associated with the service order."
},
"PaymentOption": {
"description": "The payment option selected for the service order.",
"enum": [
"NotSet",
"Web",
"Invoice",
"Cashier"
],
"type": "string"
},
"PaymentReference": {
"description": "A reference related to the payment for the service order.",
"type": "string"
},
"PaymentOrigin": {
"description": "The origin of the payment.",
"type": "string"
},
"PaymentStatus": {
"description": "The payment status of the service order.",
"enum": [
"NotSet",
"NotPaid",
"FullyPaid",
"Refunded"
],
"type": "string"
},
"Articles": {
"description": "A list of articles or items related to the service order.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrderArticle"
}
}
}
},
"MoreFlo.Models.InterfaceModels.ServiceOrderCustomer": {
"description": "Represents customer information associated with a service order.\r\nThis class encapsulates data related to the customer who requested the service, including contact details and identification information.",
"required": [
"Name"
],
"type": "object",
"properties": {
"CustomerNumber": {
"description": "The customer number.",
"type": "string"
},
"ReferenceNo": {
"format": "int64",
"description": "The reference number.",
"type": "integer"
},
"Name": {
"description": "The name of the customer.",
"type": "string"
},
"Address1": {
"description": "The first line of the customer's address.",
"type": "string"
},
"Address2": {
"description": "The second line of the customer's address (optional).",
"type": "string"
},
"PostCode": {
"description": "The postal code of the customer's address.",
"type": "string"
},
"City": {
"description": "The city of the customer's address.",
"type": "string"
},
"Country": {
"description": "The country of the customer's address.",
"type": "string"
},
"IdentityNo": {
"description": "The customer's identity number.",
"type": "string"
},
"Email": {
"description": "The customer's email address.",
"type": "string"
},
"Telephone1": {
"description": "The customer's primary telephone number.",
"type": "string"
},
"Telephone2": {
"description": "The customer's secondary telephone number (optional).",
"type": "string"
},
"Mobile": {
"description": "The customer's mobile phone number.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.ServiceOrderArticle": {
"description": "Represents an article or item associated with a service order.\r\nThis class encapsulates information about an article included in a service, such as its name, price, and quantity.",
"type": "object",
"properties": {
"ArticleNumber": {
"description": "The article number of the item.",
"type": "string"
},
"ArticleName": {
"description": "The name of the article.",
"type": "string"
},
"RetailPrice": {
"format": "double",
"description": "The retail price of the article.",
"type": "number"
},
"Discount": {
"format": "double",
"description": "The discount applied to the article.",
"type": "number"
},
"Vat": {
"format": "double",
"description": "The VAT (Value Added Tax) rate applied to the article.",
"type": "number"
},
"Quantity": {
"format": "double",
"description": "The quantity of the article.",
"type": "number"
},
"SerialNumber": {
"description": "The serial number of the article.",
"type": "string"
},
"RowSum": {
"format": "double",
"description": "The total sum or price of the row (quantity multiplied by unit price, after discount).",
"type": "number"
}
}
},
"MoreFlo.Models.InterfaceModels.ServiceOrdersResult": {
"description": "Represents a paginated result containing a list of service order results.\r\nThis class is used to return a collection of service orders, along with pagination information, in API responses.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrderResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.ServiceOrderResult": {
"description": "Represents the result of an operation that returns a service order.\r\nThis class encapsulates a ServiceOrder object and its unique identifier, typically used in API responses related to retrieving or managing service orders.",
"type": "object",
"properties": {
"ServiceOrder": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrder",
"description": "The ServiceOrder object containing the service order data."
},
"Id": {
"description": "The unique identifier of the service order.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.ServiceOrder": {
"description": "Represents a service order, containing details about a service request or job.\r\nThis class encapsulates information about a service order, including order details, dates, customer information, and financial data.",
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the service order.",
"type": "string"
},
"Number": {
"format": "int32",
"description": "The order number.",
"type": "integer"
},
"Color": {
"description": "A color associated with the service order (e.g., for visual categorization).",
"type": "string"
},
"Type": {
"description": "The type of service order.",
"enum": [
"Notset",
"Express",
"Normal",
"Booking"
],
"type": "string"
},
"State": {
"description": "The current state of the service order.",
"enum": [
"Created",
"Saved",
"Started",
"WaitingCustomerResp",
"ReadyForHandOut",
"Closed",
"WaitingParts",
"Cancelled",
"CostEstimate",
"SentToSupplier",
"WaitingConfirmation"
],
"type": "string"
},
"DeliveryTerm": {
"description": "The delivery terms for the service.",
"type": "string"
},
"OrderNo": {
"description": "The order number.",
"type": "string"
},
"YouOrderNo": {
"description": "The customer's order number or reference.",
"type": "string"
},
"BookableResourceId": {
"description": "The identifier of the bookable resource assigned to the service.",
"type": "string"
},
"BookingStartTime": {
"format": "date-time",
"description": "The start time of the booking (if applicable).",
"type": "string"
},
"BookingEndTime": {
"format": "date-time",
"description": "The end time of the booking (if applicable).",
"type": "string"
},
"IncomingDate": {
"format": "date-time",
"description": "The date when the service order was received.",
"type": "string"
},
"StartDate": {
"format": "date-time",
"description": "The date when the service is scheduled to start.",
"type": "string"
},
"ReadyDate": {
"format": "date-time",
"description": "The date when the service is expected to be ready.",
"type": "string"
},
"ExpireDate": {
"format": "date-time",
"description": "The date when the service order expires (if applicable).",
"type": "string"
},
"DeliveryDate": {
"format": "date-time",
"description": "The date when the service is scheduled for delivery.",
"type": "string"
},
"OurReference": {
"description": "The reference used by the system.",
"type": "string"
},
"PerformedBy": {
"description": "The person or entity performing the service.",
"type": "string"
},
"YourReference": {
"description": "The customer's reference.",
"type": "string"
},
"InternNote": {
"description": "Internal notes about the service order.",
"type": "string"
},
"IssueDescription": {
"description": "A description of the issue or problem being addressed.",
"type": "string"
},
"Discount": {
"format": "double",
"description": "The discount applied to the service order.",
"type": "number"
},
"TotalExclVat": {
"format": "double",
"description": "The total amount of the service order, excluding VAT.",
"type": "number"
},
"TotalInclVat": {
"format": "double",
"description": "The total amount of the service order, including VAT.",
"type": "number"
},
"TotalVat": {
"format": "double",
"description": "The total VAT amount for the service order.",
"type": "number"
},
"LastChanged": {
"format": "date-time",
"description": "The date and time when the service order was last changed.",
"type": "string"
},
"Customer": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrderCustomer",
"description": "Information about the customer associated with the service order."
},
"PaymentOption": {
"description": "The payment option selected for the service order.",
"enum": [
"NotSet",
"Web",
"Invoice",
"Cashier"
],
"type": "string"
},
"PaymentReference": {
"description": "A reference related to the payment for the service order.",
"type": "string"
},
"PaymentOrigin": {
"description": "The origin of the payment.",
"type": "string"
},
"PaymentStatus": {
"description": "The payment status of the service order.",
"enum": [
"NotSet",
"NotPaid",
"FullyPaid",
"Refunded"
],
"type": "string"
},
"Articles": {
"description": "A list of articles or items related to the service order.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ServiceOrderArticle"
}
}
}
},
"MoreFlo.Models.InterfaceModels.SettingsResult": {
"description": "Represents the result of an operation that returns application settings.\r\nThis class encapsulates a Settings object, typically used in API responses related to retrieving or managing application-wide settings.",
"type": "object",
"properties": {
"Settings": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Settings",
"description": "The Settings object containing the application settings data."
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.Settings": {
"description": "Represents general application or system settings.\r\nThis class encapsulates various configuration options, such as accounting integration, currency code, and company information.",
"type": "object",
"properties": {
"AccountingIntegrationEnabled": {
"description": "Indicates whether accounting integration is enabled.",
"type": "boolean"
},
"CurrencyCode": {
"description": "The currency code used by the system.",
"type": "string"
},
"PublicUrlOrHostPart": {
"description": "The public URL or host part of the application.",
"type": "string"
},
"CompanyName": {
"description": "The name of the company.",
"type": "string"
},
"OrganizationNumber": {
"description": "The organization number of the company.",
"type": "string"
},
"PartialRefundArticleNumber": {
"description": "The article number used for partial refunds.",
"type": "string"
},
"OrderExpireTimePartEnabled": {
"description": "Indicates whether the order expiration time part is enabled.",
"type": "boolean"
},
"ShippingArticleNumber": {
"description": "The article number used for shipping costs.",
"type": "string"
},
"IsTakeAwayEnabled": {
"description": "Specifies whether the takeaway functionality is enabled.",
"type": "boolean"
}
}
},
"MoreFlo.Models.InterfaceModels.BookingSettingsResult": {
"description": "Represents the result of an operation that returns booking settings.\r\nThis class encapsulates a SubscriberBookingSetting object, typically used in API responses related to retrieving or managing booking configuration.",
"type": "object",
"properties": {
"Settings": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SubscriberBookingSetting",
"description": "The SubscriberBookingSetting object containing the booking settings data."
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.SubscriberBookingSetting": {
"description": "Represents booking settings for a subscriber, including customer booking options, visibility, appearance, content, and company information.",
"type": "object",
"properties": {
"CustomerBookingEnabled": {
"description": "Indicates whether booking is enabled for external customers.",
"type": "boolean"
},
"CustomerBookingRequiresLogin": {
"description": "Indicates whether customers are required to have an account to make a booking.",
"type": "boolean"
},
"VisibibleInMoreFloBookingPortal": {
"description": "Indicates whether the store should be visible in the MoreFlo booking portal.",
"type": "boolean"
},
"SelectResourceStyleAuto": {
"description": "Determines if the resource selection style is automatic.",
"type": "boolean"
},
"FrontPageTextHtml": {
"description": "HTML formatted text for the front page.",
"type": "string"
},
"CreatedTime": {
"format": "date-time",
"description": "The time when the booking settings were created.",
"type": "string"
},
"LastUpdatedTime": {
"format": "date-time",
"description": "The time when the booking settings were last updated.",
"type": "string"
},
"CancellationInformationTextHtml": {
"description": "HTML formatted text for cancellation information.",
"maxLength": 65535,
"minLength": 0,
"type": "string"
},
"TermOfPurchaseTextHtml": {
"description": "HTML formatted text for terms of purchase.",
"maxLength": 65535,
"minLength": 0,
"type": "string"
},
"BookingThankYouInfoTextHtml": {
"description": "HTML formatted text for booking thank you information.",
"maxLength": 65535,
"minLength": 0,
"type": "string"
},
"BookingExtraInfo": {
"description": "Extra information for booking.",
"maxLength": 2048,
"minLength": 0,
"type": "string"
},
"OpeningHoursInformation": {
"description": "Plain text multi-line information about opening hours.",
"type": "string"
},
"CompanyName": {
"description": "The name of the company.",
"type": "string"
},
"Address1": {
"description": "The first line of the company's address.",
"type": "string"
},
"Address2": {
"description": "The second line of the company's address (optional).",
"type": "string"
},
"PostCode": {
"description": "The postal code of the company's address.",
"type": "string"
},
"City": {
"description": "The city of the company's address.",
"type": "string"
},
"Country": {
"description": "The country of the company's address.",
"type": "string"
},
"Telephone": {
"description": "The telephone number of the company.",
"type": "string"
},
"Email": {
"description": "The email address of the company.",
"type": "string"
},
"Gallery": {
"description": "A list of files representing the gallery images.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AttachedFile"
}
},
"Logotypes": {
"description": "A list of files representing the company's logotypes.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.AttachedFile"
}
}
}
},
"MoreFlo.Models.InterfaceModels.SmsMessage": {
"description": "Represents an SMS message to be sent, including the recipient's phone number and the message content.\r\nThis class encapsulates the data required to send an SMS message through an API.",
"required": [
"TelephoneNumber",
"Message"
],
"type": "object",
"properties": {
"TelephoneNumber": {
"description": "The telephone number of the recipient.\r\nMust be an international phone number with only digits, starting with a plus sign (+).",
"pattern": "^\\+\\d{5,}",
"type": "string"
},
"Message": {
"description": "The text content of the SMS message.\r\nMaximum length is 35000 characters.",
"maxLength": 35000,
"minLength": 0,
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.SmsSendResult": {
"description": "Represents the result of sending an SMS message.\r\nThis class encapsulates the phone number to which the SMS was sent, along with the base result status.",
"type": "object",
"properties": {
"TelephoneNumber": {
"description": "The telephone number to which the SMS message was sent.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.StoreCreate": {
"description": "Represents the data required to create a new store entry.\r\nThis class extends the Store class and specifies the required information for creating a new store within the system.",
"required": [
"ExternalStoreId",
"CompanyName",
"PublicCompanyName",
"StartDate",
"ValidTo",
"UsernamePrefix",
"Country",
"IsActive",
"CurrencyCode"
],
"type": "object",
"properties": {
"ExternalStoreId": {
"format": "int32",
"description": "The external identifier of the store to be created.\r\nThis is a required field.",
"type": "integer"
},
"CompanyName": {
"description": "The official name of the company for the store to be created.\r\nThis is a required field.",
"type": "string"
},
"PublicCompanyName": {
"description": "The public-facing name of the company for the store to be created (e.g., for invoices).\r\nThis is a required field.",
"type": "string"
},
"StartDate": {
"format": "date-time",
"description": "The start date of the store's validity or operation for the store to be created.\r\nThis is a required field.",
"type": "string"
},
"ValidTo": {
"format": "date-time",
"description": "The end date of the store's validity or operation for the store to be created.\r\nThis is a required field.",
"type": "string"
},
"UsernamePrefix": {
"description": "A prefix used for usernames associated with the store to be created.\r\nThis is a required field.",
"maxLength": 10,
"minLength": 3,
"type": "string"
},
"Country": {
"description": "The country of the store to be created.\r\nThis is a required field.",
"type": "string"
},
"IsActive": {
"description": "Indicates whether the store to be created is active.\r\nThis is a required field.",
"type": "boolean"
},
"CurrencyCode": {
"description": "The currency code used by the store to be created.\r\nThis is a required field.",
"type": "string"
},
"UpdateOnExisting": {
"description": "Indicates whether an existing store with the same identifier should be updated instead of creating a new one.",
"type": "boolean"
},
"SMSSenderName": {
"description": "The name used as the sender for SMS messages from this store.",
"type": "string"
},
"OrganizationNumber": {
"description": "The organization number of the company.",
"type": "string"
},
"Address1": {
"description": "The first line of the store's address.",
"type": "string"
},
"Address2": {
"description": "The second line of the store's address (optional).",
"type": "string"
},
"PostCode": {
"description": "The postal code of the store's address.",
"type": "string"
},
"City": {
"description": "The city of the store's address.",
"type": "string"
},
"PublicEmail": {
"description": "The public email address of the store.",
"type": "string"
},
"PublicPhone": {
"description": "The public phone number of the store.",
"type": "string"
},
"PublicFax": {
"description": "The public fax number of the store.",
"type": "string"
},
"ContactPerson": {
"description": "The name of a contact person at the store.",
"type": "string"
},
"Phone": {
"description": "The store's phone number.",
"type": "string"
},
"CellPhone": {
"description": "The store's cell phone number.",
"type": "string"
},
"Email": {
"description": "The store's email address.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.StoreResult": {
"description": "Represents the result of an operation that returns a store.\r\nThis class encapsulates a Store object and additional information about the operation's success or failure, typically used in API responses related to store retrieval or management.",
"type": "object",
"properties": {
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
},
"Store": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Store",
"description": "The Store object containing the store data."
}
}
},
"MoreFlo.Models.InterfaceModels.Store": {
"description": "Represents a store or business location, containing information such as identification, contact details, and address.",
"type": "object",
"properties": {
"ExternalStoreId": {
"format": "int32",
"description": "The external identifier for the store.",
"type": "integer"
},
"CompanyName": {
"description": "The official name of the company.",
"type": "string"
},
"PublicCompanyName": {
"description": "The public-facing name of the company (e.g., for invoices).",
"type": "string"
},
"SMSSenderName": {
"description": "The name used as the sender for SMS messages from this store.",
"type": "string"
},
"OrganizationNumber": {
"description": "The organization number of the company.",
"type": "string"
},
"StartDate": {
"format": "date-time",
"description": "The start date of the store's validity or operation.",
"type": "string"
},
"ValidTo": {
"format": "date-time",
"description": "The end date of the store's validity or operation.",
"type": "string"
},
"UsernamePrefix": {
"description": "A prefix used for usernames associated with this store.",
"maxLength": 10,
"minLength": 3,
"type": "string"
},
"Address1": {
"description": "The first line of the store's address.",
"type": "string"
},
"Address2": {
"description": "The second line of the store's address (optional).",
"type": "string"
},
"PostCode": {
"description": "The postal code of the store's address.",
"type": "string"
},
"City": {
"description": "The city of the store's address.",
"type": "string"
},
"Country": {
"description": "The country of the store's address.",
"type": "string"
},
"PublicEmail": {
"description": "The public email address of the store.",
"type": "string"
},
"PublicPhone": {
"description": "The public phone number of the store.",
"type": "string"
},
"PublicFax": {
"description": "The public fax number of the store.",
"type": "string"
},
"IsActive": {
"description": "Indicates whether the store is active.",
"type": "boolean"
},
"CurrencyCode": {
"description": "The currency code used by the store.",
"type": "string"
},
"ContactPerson": {
"description": "The name of a contact person at the store.",
"type": "string"
},
"Phone": {
"description": "The store's phone number.",
"type": "string"
},
"CellPhone": {
"description": "The store's cell phone number.",
"type": "string"
},
"Email": {
"description": "The store's email address.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.StoresResult": {
"description": "Represents a paginated result containing a list of store results.\r\nThis class is used to return a collection of stores, along with pagination information, in API responses.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.StoreResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.SupplierCreate": {
"description": "Represents the data used to create a new supplier entry.\r\nThis class extends the Supplier class and specifies the required information for creating a new supplier within the system.",
"required": [
"Name",
"SupplierNumber",
"Id"
],
"type": "object",
"properties": {
"Name": {
"description": "The name of the supplier to be created.\r\nThis is a required field.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"SupplierNumber": {
"description": "The supplier number of the supplier to be created.\r\nThis is a required field.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"UpdateOnExisting": {
"description": "Indicates whether an existing supplier with the same identifier should be updated instead of creating a new one.",
"type": "boolean"
},
"Id": {
"description": "The unique identifier of the supplier.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"Address1": {
"description": "The first line of the supplier's address.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"Address2": {
"description": "The second line of the supplier's address (optional).",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"PostalCode": {
"description": "The postal code of the supplier's address.",
"maxLength": 10,
"minLength": 0,
"type": "string"
},
"City": {
"description": "The city of the supplier's address.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"Country": {
"description": "The country of the supplier.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"CountryCode": {
"description": "The country code of the supplier.",
"maxLength": 10,
"minLength": 0,
"type": "string"
},
"BankgiroNumber": {
"description": "The Bankgiro number of the supplier.",
"maxLength": 50,
"minLength": 0,
"pattern": "^[0-9-]*$",
"type": "string"
},
"PlusgiroNumber": {
"description": "The Plusgiro number of the supplier.",
"maxLength": 10,
"minLength": 0,
"pattern": "^[0-9-]*$",
"type": "string"
},
"CreatedUtc": {
"format": "date-time",
"description": "The UTC timestamp when the supplier was created.",
"type": "string"
},
"ModifiedUtc": {
"format": "date-time",
"description": "The UTC timestamp when the supplier was last modified.",
"type": "string"
},
"Note": {
"description": "A general note about the supplier.",
"maxLength": 2048,
"minLength": 0,
"type": "string"
},
"Telephone": {
"description": "The supplier's telephone number.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"WwwAddress": {
"description": "The supplier's website address.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"Email": {
"description": "The supplier's email address.",
"maxLength": 256,
"minLength": 0,
"type": "string"
},
"IsActive": {
"description": "Indicates whether the supplier is active.",
"type": "boolean"
},
"ExternalSyncStatus": {
"description": "The external synchronization status of the supplier.",
"enum": [
"None",
"ActionRequired"
],
"type": "string"
},
"ExternalSyncMessage": {
"description": "A message related to the external synchronization status.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.SuppliersResult": {
"description": "Represents a paginated result containing a list of supplier results.\r\nThis class is used to return a collection of suppliers, along with pagination information, in API responses.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.SupplierResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.SupplierResult": {
"description": "Represents the result of an operation that returns a single supplier.\r\nThis class encapsulates a Supplier object and its unique identifier, typically used in API responses for single supplier operations.",
"type": "object",
"properties": {
"Supplier": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Supplier",
"description": "The Supplier object containing the supplier data."
},
"Id": {
"description": "The unique identifier of the supplier.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.Supplier": {
"description": "Represents a supplier, containing information such as identification, contact details, and financial information.",
"required": [
"Id",
"Name"
],
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the supplier.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"Name": {
"description": "The name of the supplier.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"SupplierNumber": {
"description": "The supplier number.",
"maxLength": 16,
"minLength": 0,
"type": "string"
},
"Address1": {
"description": "The first line of the supplier's address.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"Address2": {
"description": "The second line of the supplier's address (optional).",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"PostalCode": {
"description": "The postal code of the supplier's address.",
"maxLength": 10,
"minLength": 0,
"type": "string"
},
"City": {
"description": "The city of the supplier's address.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"Country": {
"description": "The country of the supplier.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"CountryCode": {
"description": "The country code of the supplier.",
"maxLength": 10,
"minLength": 0,
"type": "string"
},
"BankgiroNumber": {
"description": "The Bankgiro number of the supplier.",
"maxLength": 50,
"minLength": 0,
"pattern": "^[0-9-]*$",
"type": "string"
},
"PlusgiroNumber": {
"description": "The Plusgiro number of the supplier.",
"maxLength": 10,
"minLength": 0,
"pattern": "^[0-9-]*$",
"type": "string"
},
"CreatedUtc": {
"format": "date-time",
"description": "The UTC timestamp when the supplier was created.",
"type": "string"
},
"ModifiedUtc": {
"format": "date-time",
"description": "The UTC timestamp when the supplier was last modified.",
"type": "string"
},
"Note": {
"description": "A general note about the supplier.",
"maxLength": 2048,
"minLength": 0,
"type": "string"
},
"Telephone": {
"description": "The supplier's telephone number.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"WwwAddress": {
"description": "The supplier's website address.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"Email": {
"description": "The supplier's email address.",
"maxLength": 256,
"minLength": 0,
"type": "string"
},
"IsActive": {
"description": "Indicates whether the supplier is active.",
"type": "boolean"
},
"ExternalSyncStatus": {
"description": "The external synchronization status of the supplier.",
"enum": [
"None",
"ActionRequired"
],
"type": "string"
},
"ExternalSyncMessage": {
"description": "A message related to the external synchronization status.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.TicketOrderCreate": {
"description": "Represents the data used to create a new ticket order.\r\nThis class extends the TicketOrder class and specifies the required information for creating a ticket order within the system.",
"required": [
"ExternalReference"
],
"type": "object",
"properties": {
"ExternalReference": {
"description": "The external reference or order number from another system.\r\nThis is a required field.",
"type": "string"
},
"UpdateOnExisting": {
"description": "Indicates whether to update an existing ticket order if one with the same number already exists.",
"type": "boolean"
},
"Id": {
"description": "The unique identifier of the ticket order, set by the system.",
"type": "string"
},
"ReferenceTag": {
"description": "A reference tag for the order, issued by the system.",
"type": "string"
},
"Customer": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Customer",
"description": "Information about the customer who placed the order.\r\nCan be either a CustomerNumber within the system or a ReferenceNumber from an external system."
},
"OrderNumber": {
"format": "int32",
"description": "The order number, set by the system.",
"type": "integer"
},
"IncomingDate": {
"format": "date-time",
"description": "The date when the order was received.",
"type": "string"
},
"CreatedTime": {
"format": "date-time",
"description": "The time when the order was created, set by the system.",
"type": "string",
"readOnly": true
},
"UpdatedTime": {
"format": "date-time",
"description": "The time when the order was last updated, set by the system.",
"type": "string",
"readOnly": true
},
"ReadyDate": {
"format": "date-time",
"description": "The date when the tickets are ready for pickup or use.",
"type": "string"
},
"DeliveryTime": {
"format": "date-time",
"description": "The delivery time for the tickets.",
"type": "string"
},
"ExpireTime": {
"format": "date-time",
"description": "The time when the order expires (if applicable).",
"type": "string"
},
"OurReference": {
"description": "The reference used by the system.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"YourReference": {
"description": "The reference provided by the customer or an external system.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"Note": {
"description": "A general note about the order.",
"maxLength": 4096,
"minLength": 0,
"type": "string"
},
"OrderDiscountPercent": {
"format": "double",
"description": "The discount percentage applied to the order.",
"type": "number"
},
"State": {
"description": "The current state of the order.",
"enum": [
"New",
"Started",
"ReadyForHandOut",
"Cancelled",
"Delivered",
"Expired"
],
"type": "string"
},
"Rows": {
"description": "A list of rows containing details about the tickets in the order.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.TicketOrderRow"
}
},
"BillingAddress": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BillingAddress",
"description": "The billing address for the order."
},
"ShippingAddress": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ShippingAddress",
"description": "The shipping address for the order."
},
"PaymentReference": {
"description": "A reference related to the payment for the order.",
"maxLength": 512,
"minLength": 0,
"type": "string"
},
"PaymentOption": {
"description": "The payment option selected for the order.",
"enum": [
"NotSet",
"Web",
"Invoice",
"Cashier"
],
"type": "string"
},
"PaymentOrigin": {
"description": "Information about the origin of the payment.",
"maxLength": 512,
"minLength": 0,
"type": "string"
},
"PaymentStatus": {
"description": "The payment status of the order.",
"enum": [
"NotSet",
"NotPaid",
"FullyPaid",
"Refunded"
],
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.TicketOrderRow": {
"description": "Represents a row within a ticket order, detailing information about a specific ticket type and quantity.",
"type": "object",
"properties": {
"ArticleNumber": {
"description": "The article number of the ticket type.",
"type": "string"
},
"ArticleName": {
"description": "The name of the ticket type.",
"type": "string"
},
"Quantity": {
"format": "double",
"description": "The quantity of tickets of this type.",
"type": "number"
},
"UnitAmountInclVatInclDiscount": {
"format": "double",
"description": "The unit amount of the ticket, including VAT and discount.",
"type": "number"
},
"UnitAmountInclVatExclDiscount": {
"format": "double",
"description": "The unit amount of the ticket, including VAT but excluding discount.",
"type": "number"
},
"VatRate": {
"format": "double",
"description": "The VAT rate applied to the ticket.",
"type": "number"
},
"TotalDiscountAmount": {
"format": "double",
"description": "The total discount amount applied to the tickets.",
"type": "number"
},
"TotalAmountInclVatInclDiscount": {
"format": "double",
"description": "The total amount for the tickets, including VAT and discount.",
"type": "number"
},
"ReceiptNote": {
"description": "A note related to the receipt of the tickets.",
"type": "string"
},
"Tickets": {
"description": "A list of individual tickets associated with this row.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Ticket"
}
}
}
},
"MoreFlo.Models.InterfaceModels.Ticket": {
"description": "Represents a ticket for an event.\r\nThis class encapsulates information about a single ticket, including event details, seat information, pricing, and status.",
"type": "object",
"properties": {
"EventName": {
"description": "The name of the event.",
"type": "string"
},
"TicketName": {
"description": "The name or type of ticket.",
"type": "string"
},
"Barcode": {
"description": "The barcode associated with the ticket.",
"type": "string"
},
"SerialNumber": {
"description": "The serial number of the ticket.",
"type": "string"
},
"Section": {
"description": "The section in the venue where the seat is located.",
"type": "string"
},
"Row": {
"description": "The row number of the seat.",
"type": "string"
},
"Seat": {
"description": "The seat number.",
"type": "string"
},
"Information": {
"description": "Any additional information about the ticket.",
"type": "string"
},
"Price": {
"format": "double",
"description": "The price of the ticket.",
"type": "number"
},
"EntranceTime": {
"format": "date-time",
"description": "The time allowed for entrance with this ticket.",
"type": "string"
},
"PrintStatus": {
"description": "The print status of the ticket.",
"enum": [
"Pending",
"Printed"
],
"type": "string"
},
"Status": {
"description": "The current status of the ticket.",
"enum": [
"Reserved",
"Confirmed",
"Delivered",
"Canceled"
],
"type": "string"
},
"ShowInformation": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ShowInformation",
"description": "Information about the show or event associated with the ticket."
}
}
},
"MoreFlo.Models.InterfaceModels.ShowInformation": {
"description": "Represents information about a show or event.\r\nThis class encapsulates details about a show, such as its name, location, and date/time.",
"type": "object",
"properties": {
"Name": {
"description": "The name of the show or event.",
"type": "string"
},
"Arena": {
"description": "The name of the arena or venue where the show is held.",
"type": "string"
},
"City": {
"description": "The city where the show is held.",
"type": "string"
},
"DateTime": {
"format": "date-time",
"description": "The date and time of the show.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.TicketOrdersResult": {
"description": "Represents a paginated result containing a list of ticket order results.\r\nThis class is used to return a collection of ticket orders, along with pagination information, in API responses.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.TicketOrderResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.TicketOrderResult": {
"description": "Represents the result of an operation that returns a single ticket order.\r\nThis class encapsulates a TicketOrder object and its unique identifier, typically used in API responses for single ticket order operations.",
"type": "object",
"properties": {
"TicketOrder": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.TicketOrder",
"description": "The TicketOrder object containing the ticket order data."
},
"Id": {
"description": "The unique identifier of the ticket order.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.TicketOrder": {
"description": "Represents a ticket order, containing details about a ticket purchase or reservation.\r\nThis class encapsulates information about a ticket order, including order details, customer information, dates, and payment information.",
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the ticket order, set by the system.",
"type": "string"
},
"ReferenceTag": {
"description": "A reference tag for the order, issued by the system.",
"type": "string"
},
"ExternalReference": {
"description": "The order identifier from an external system.\r\nMust be set when creating the order.",
"type": "string"
},
"Customer": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Customer",
"description": "Information about the customer who placed the order.\r\nCan be either a CustomerNumber within the system or a ReferenceNumber from an external system."
},
"OrderNumber": {
"format": "int32",
"description": "The order number, set by the system.",
"type": "integer"
},
"IncomingDate": {
"format": "date-time",
"description": "The date when the order was received.",
"type": "string"
},
"CreatedTime": {
"format": "date-time",
"description": "The time when the order was created, set by the system.",
"type": "string",
"readOnly": true
},
"UpdatedTime": {
"format": "date-time",
"description": "The time when the order was last updated, set by the system.",
"type": "string",
"readOnly": true
},
"ReadyDate": {
"format": "date-time",
"description": "The date when the tickets are ready for pickup or use.",
"type": "string"
},
"DeliveryTime": {
"format": "date-time",
"description": "The delivery time for the tickets.",
"type": "string"
},
"ExpireTime": {
"format": "date-time",
"description": "The time when the order expires (if applicable).",
"type": "string"
},
"OurReference": {
"description": "The reference used by the system.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"YourReference": {
"description": "The reference provided by the customer or an external system.",
"maxLength": 128,
"minLength": 0,
"type": "string"
},
"Note": {
"description": "A general note about the order.",
"maxLength": 4096,
"minLength": 0,
"type": "string"
},
"OrderDiscountPercent": {
"format": "double",
"description": "The discount percentage applied to the order.",
"type": "number"
},
"State": {
"description": "The current state of the order.",
"enum": [
"New",
"Started",
"ReadyForHandOut",
"Cancelled",
"Delivered",
"Expired"
],
"type": "string"
},
"Rows": {
"description": "A list of rows containing details about the tickets in the order.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.TicketOrderRow"
}
},
"BillingAddress": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.BillingAddress",
"description": "The billing address for the order."
},
"ShippingAddress": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.ShippingAddress",
"description": "The shipping address for the order."
},
"PaymentReference": {
"description": "A reference related to the payment for the order.",
"maxLength": 512,
"minLength": 0,
"type": "string"
},
"PaymentOption": {
"description": "The payment option selected for the order.",
"enum": [
"NotSet",
"Web",
"Invoice",
"Cashier"
],
"type": "string"
},
"PaymentOrigin": {
"description": "Information about the origin of the payment.",
"maxLength": 512,
"minLength": 0,
"type": "string"
},
"PaymentStatus": {
"description": "The payment status of the order.",
"enum": [
"NotSet",
"NotPaid",
"FullyPaid",
"Refunded"
],
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.VouchersResult": {
"description": "Represents a paginated result containing a list of voucher results.\r\nThis class is used to return a collection of vouchers, along with pagination information, in API responses.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.VoucherResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.VoucherResult": {
"description": "Represents the result of an operation that returns a single voucher.\r\nThis class encapsulates a Voucher object and its unique identifier, typically used in API responses for single voucher operations.",
"type": "object",
"properties": {
"Voucher": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.Voucher",
"description": "The Voucher object containing the voucher data."
},
"Id": {
"description": "The unique identifier of the voucher.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.WebHookCategoriesResult": {
"description": "Represents a paginated result containing a list of WebHook category results.\r\nThis class is used to return a collection of WebHook categories, along with pagination information, in API responses.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHookCategoryResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.WebHookCategoryResult": {
"description": "Represents the result of an operation that returns a single WebHook category.\r\nThis class encapsulates a WebHookCategory object and its unique identifier, typically used in API responses for single WebHook category operations.",
"type": "object",
"properties": {
"WebHookCategory": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHookCategory",
"description": "The WebHookCategory object containing the WebHook category data."
},
"Id": {
"description": "The unique identifier of the WebHook category.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.WebHookCategory": {
"description": "Represents a WebHook category, used to group and identify different types of WebHooks.",
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the WebHook category, automatically generated by the system.\r\nThis cannot be set externally.",
"type": "string"
},
"IsEnabled": {
"description": "Indicates whether the WebHook category is enabled.",
"type": "boolean"
},
"Name": {
"description": "The name of the WebHook category.\r\nThe following names are supported:\r\nArticleStockChanged - A WebHook will be called when there are any stock changes.\r\nReceiptCreated - A WebHook will be called when a receipt is created. The POST request will contain a JSON body with the following definition:\r\n{\r\n \"receiptId\": \"6c30a0c6-44fd-473a-b7a7-ed164ba9083d\",\r\n \"receiptType\": \"CashierReceipt\",\r\n \"isRefund\": false\r\n}",
"type": "string"
},
"Description": {
"description": "A description of the WebHook category.",
"type": "string"
},
"CreatedTime": {
"format": "date-time",
"description": "The timestamp of when the WebHook category was created.",
"type": "string"
},
"ModifiedTime": {
"format": "date-time",
"description": "The timestamp of when the WebHook category was last modified.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.WebHooksResult": {
"description": "Represents a paginated result containing a list of WebHook results.\r\nThis class is used to return a collection of WebHooks, along with pagination information, in API responses.",
"type": "object",
"properties": {
"ExtraInformation": {
"description": "A list of extra information or messages related to the paginated result.",
"type": "array",
"items": {
"type": "string"
}
},
"list": {
"description": "The list of data items for the current page.",
"type": "array",
"items": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHookResult"
}
},
"Page": {
"format": "int32",
"description": "The current page number.",
"type": "integer"
},
"Total": {
"format": "int32",
"description": "The total number of pages available.",
"type": "integer"
},
"PageSize": {
"format": "int32",
"description": "The number of data items per page.",
"type": "integer"
}
}
},
"MoreFlo.Models.InterfaceModels.WebHookResult": {
"description": "Represents the result of an operation that returns a single WebHook.\r\nThis class encapsulates a WebHook object and its unique identifier, typically used in API responses for single WebHook operations.",
"type": "object",
"properties": {
"WebHook": {
"$ref": "#/definitions/MoreFlo.Models.InterfaceModels.WebHook",
"description": "The WebHook object containing the WebHook data."
},
"Id": {
"description": "The unique identifier of the WebHook.",
"type": "string"
},
"Success": {
"description": "Indicates whether the API operation was successful.",
"type": "boolean"
},
"ExtraInformation": {
"description": "A list of extra information or messages related to the API operation result.\r\nThis can include error messages, warnings, or informational notes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MoreFlo.Models.InterfaceModels.WebHook": {
"description": "Represents a WebHook, which is a mechanism for one application to provide real-time information to another.",
"required": [
"WebHookCategoryId",
"HttpMethod"
],
"type": "object",
"properties": {
"Id": {
"description": "The unique identifier of the WebHook, automatically generated by the system.\r\nThis cannot be set externally.",
"type": "string"
},
"WebHookCategoryId": {
"description": "The identifier of the WebHook category, used to group WebHooks.",
"type": "string"
},
"IsEnabled": {
"description": "Indicates whether the WebHook is enabled.",
"type": "boolean"
},
"RemoteUrl": {
"description": "The remote URL to which the WebHook will send data.",
"maxLength": 2048,
"minLength": 0,
"type": "string"
},
"HttpMethod": {
"description": "The HTTP method used to send the WebHook data (e.g., GET, POST).",
"enum": [
"Get",
"Post",
"Put"
],
"type": "string"
},
"CreatedTime": {
"format": "date-time",
"description": "The timestamp of when the WebHook was created.",
"type": "string"
},
"ModifiedTime": {
"format": "date-time",
"description": "The timestamp of when the WebHook was last modified.",
"type": "string"
}
}
},
"MoreFlo.Models.InterfaceModels.WebHookCreate": {
"description": "Represents the data used to create a new WebHook.\r\nThis class extends the WebHook class and adds properties specific to the creation of a WebHook.",
"required": [
"WebHookCategoryId",
"HttpMethod"
],
"type": "object",
"properties": {
"UpdateOnExisting": {
"description": "Indicates whether an existing WebHook with the same identifier should be updated instead of creating a new one.",
"type": "boolean"
},
"Id": {
"description": "The unique identifier of the WebHook, automatically generated by the system.\r\nThis cannot be set externally.",
"type": "string"
},
"WebHookCategoryId": {
"description": "The identifier of the WebHook category, used to group WebHooks.",
"type": "string"
},
"IsEnabled": {
"description": "Indicates whether the WebHook is enabled.",
"type": "boolean"
},
"RemoteUrl": {
"description": "The remote URL to which the WebHook will send data.",
"maxLength": 2048,
"minLength": 0,
"type": "string"
},
"HttpMethod": {
"description": "The HTTP method used to send the WebHook data (e.g., GET, POST).",
"enum": [
"Get",
"Post",
"Put"
],
"type": "string"
},
"CreatedTime": {
"format": "date-time",
"description": "The timestamp of when the WebHook was created.",
"type": "string"
},
"ModifiedTime": {
"format": "date-time",
"description": "The timestamp of when the WebHook was last modified.",
"type": "string"
}
}
}
},
"securityDefinitions": {
"basic": {
"type": "basic",
"description": "Basic HTTP Authentication"
}
}
}