Administration API
-
Administration.API.ApiModels.ConfigurationItemsData changed:
-
stores property model Administration.API.ApiModels.StoreBasicSettingsOutModel changed:
-
added a new string property assortmentId,
-
added a new boolean property deliveryInUse,
-
added a new string property kitchenFlow,
-
added a new boolean property kitchenInUse,
-
added a new nullable boolean property kitchenOrderCancellationEnabled,
-
added a new string property masterWorkstationId,
-
added a new boolean property mergeCustomProducts,
-
added a new number property minPreOrderTime,
-
added a new boolean property pickupInUse,
-
added a new nullable boolean property seatHandlingEnabled,
-
added a new nullable boolean property webShopEnabled,
-
added a new enum property defaultDeliveryType, of type Administration.Infrastructure.Models.Enums.DeliveryOption,
-
added a new array property zebraCloudPrinters of Administration.Infrastructure.Models.ZebraPrinterConfiguration model
"Administration.Infrastructure.Models.ZebraPrinterConfiguration": { "additionalProperties": false, "properties": { "autoPrint": { "type": "boolean" }, "defaultTemplate": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "serialNumber": { "nullable": true, "type": "string" } }, "type": "object" }
-
-
affected 200 status responses on:
-
GET /v1-ext/Configuration
-
-
-
Administration.API.ApiModels.CurrencyConfigurationModel changed:
-
added a new array property currencyCashPaymentTypes of Administration.Infrastructure.Models.CurrencyCashPaymentType model
"Administration.Infrastructure.Models.CurrencyCashPaymentType": { "additionalProperties": false, "properties": { "id": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" } }, "type": "object" } -
affected 200 status response on:
-
GET /v1-ext/Currencies
-
GET /v1-ext/Currencies/{currencyCode}
-
GET /v1-ext/Currencies/default
-
-
affected request body of:
-
POST /v1-ext/Currencies/{currencyCode}
-
-
-
Administration.API.ApiModels.CompanyApiModel changed:
-
company property model Administration.Infrastructure.Models.Company.CompanySettings changed:
-
added a new boolean property blockParkingOrdersWithoutCustomer,
-
added a new boolean property laundryTaggingEnabled,
-
added a new boolean property parkingAllowedWithPayments,
-
added a new boolean property productDeliveredStatusEnabled,
-
added a new boolean property rowBasedPayment,
-
added a new boolean property useExtendedOrderParkSearch,
-
added a new boolean property washingEnabled,
-
added a new nullable boolean property zebraCloudApiKey,
-
added a new boolean property zebraCloudPrintingEnabled,
-
added a new string property zebraCloudTenantId
-
-
affected 200 status responses on:
-
GET /v1-ext/Company
-
-
-
Administration.API.ApiModels.WorkstationApiModel changed:
-
interactionService property Administration.Infrastructure.Models.Workstation.InteractionService changed:
-
interactionDeviceConfigurations property Administration.Infrastructure.Models.Workstation.InteractionDeviceConfiguration changed:
-
added nullable property lightAvailable of type Administration.Infrastructure.Models.Workstation.InteractionDeviceLightParameter,
-
added nullable property lightClosed of type Administration.Infrastructure.Models.Workstation.InteractionDeviceLightParameter,
-
added nullable property lightError of type Administration.Infrastructure.Models.Workstation.InteractionDeviceLightParameter,
-
added nullable property lightSuccessful of type Administration.Infrastructure.Models.Workstation.InteractionDeviceLightParameter,
-
renamed nullable property deviceParameters to parameters of type Administration.Infrastructure.Models.Workstation.InteractionDeviceParameters,
-
added string property serviceName,
-
added string property uniqueId,
"Administration.Infrastructure.Models.Workstation.InteractionDeviceLightParameter": { "additionalProperties": false, "properties": { "blinkingInterval": { "format": "int32", "nullable": true, "type": "integer" }, "blinkingLength": { "format": "int32", "nullable": true, "type": "integer" }, "lightColor": { "nullable": true, "type": "string" }, "volume": { "format": "int32", "nullable": true, "type": "integer" } }, "type": "object" }
-
-
-
kiosk property of Administration.Infrastructure.Models.Workstation.Kiosk model changed:
-
added a new string property orderButtonText_da,
-
added a new string property orderReady_da,
-
-
-
affected 200 status response on:
-
GET /v1-ext/Workstation
-
GET /v1-ext/Workstation/{id}
-
-
Catalog API
-
added new models
-
Products.Infrastructure.DomainModels.Common.Washing
-
Pricing.Application.ApiModels.Incoming.DiscountInApiModel changed
-
added a new boolean property giveDiscountFromTheCheapestProduct,
-
POST /v1-ext/Discounts
-
POST /v1-ext/Discounts/bulk
-
rules property Pricing.Application.ApiModels.DiscountRuleApiModel changed:
-
affected request body of:
-
-
Pricing.Application.ApiModels.DiscountReplicaResponse changed:
-
documents array property of Pricing.Application.ApiModels.DiscountReplicaApiModel changed:
-
rules property Pricing.Application.ApiModels.DiscountRuleApiModel changed:
-
added a new boolean property giveDiscountFromTheCheapestProduct,
-
-
-
affected 200 status response on:
-
GET /v1-ext/Discounts/getAllAfter/{timestamp}
-
-
-
Pricing.Application.ApiModels.Incoming.RegularPriceInApiModel changed:
-
added nullable string array property customerGroupIds
-
added nullable string array property customerIds
-
-
affected request body of:
-
POST /v1-ext/RegularPrices
-
-
-
Pricing.Application.ApiModels.RegularPriceReplicaResponse changed:
-
documents array property Pricing.Application.ApiModels.RegularPriceReplicaApiModel changed:
-
added nullable string array property customerGroupIds
-
added nullable string array property customerIds
-
-
affected request body of:
-
POST /v1-ext/RegularPrices/getAllAfter/{timestamp}
-
-
-
added new property washing of type Products.Infrastructure.DomainModels.Common.Washing in the following models
-
Products.API.Models.Incoming.Products.CustomProductInApiModel
-
Products.API.Models.Incoming.Products.GiftCardProductInApiModel
-
Products.API.Models.Incoming.Products.ServiceProductInApiModel
-
Products.API.Models.Incoming.Products.StockProductInApiModel
-
Products.API.Models.Incoming.Products.VariantProductInApiModel
-
-
affected request body of:
-
POST /v1-ext/Products/addProduct
-
POST /v1-ext/Products/bulk
-
-
Catalog API 2
-
Products.API.Models.Products.CustomProduct.ExtendedProductSize changed
-
product array Products.API.Models.Products.CustomProduct.ExtendedSizeProduct changed:
-
added new property washing of type Products.Infrastructure.DomainModels.Common.Washing
-
-
productOptions array of Products.API.Models.Products.CustomProduct.ExtendedSizeProductOption
-
options array of Products.API.Models.Products.CustomProduct.ExtendedSizeProductOptionItem changed:
-
added new property washing of type Products.Infrastructure.DomainModels.Common.Washing
-
-
-
-
Products.API.Models.Products.PackageProducts.ExtendedPackageProduct changed
-
products array of Products.API.Models.Products.PackageProducts.ExtendedNestedStockPackageProduct
|| Products.API.Models.Products.PackageProducts.ExtendedNestedVariantModelPackageProduct
|| Products.API.Models.Products.PackageProducts.ExtendedNestedVariantPackageProduct-
which has a common base class of Products.API.Models.Products.PackageProducts.ExtendedNestedPackageProduct
-
added new property washing of type Products.Infrastructure.DomainModels.Common.Washing
-
-
-
-
added new property washing of type Products.Infrastructure.DomainModels.Common.Washing in the following models
-
Products.API.Models.Products.CustomProduct.ExtendedCustomProduct
-
Products.API.Models.Products.ServiceProducts.ExtendedServiceProduct
-
Products.API.Models.Products.StockProduct.ExtendedStockProduct
-
Products.API.Models.Products.VariantProducts.ExtendedVariantProduct
-
Products.API.Models.Products.GiftCardProducts.ExtendedGiftCardProduct
-
affected 200 status response on:
-
GET /v2-ext/products/{id}
-
-
all of these 5 models can be a document property of Products.API.Models.ProductPaginationModel
-
affected 200 status response on:
-
GET /v2-ext/products/getAllAfter/{timestamp}
-
GET /v2-ext/products/getSelectedAfter
-
-
-
Products.Infrastructure.DomainModels.Common.Washing
-
Reporting API
-
Reporting.CashReports.CashReports.Models.CashReport changed
-
added a new string property companyName
-
added a new boolean property customBankImportForm
-
added a new string property paymentReceiverBBAN
-
added a new string property paymentReceiverBIC
-
added a new string property paymentReceiverIBAN
-
added a new string property paymentReceiverName
-
added a new string property postalCity
-
added a new string property postalCode
-
added a new string property settlementReference
-
added a new int32 property storeNumber
-
added a new string property streetAddress
-
added a new boolean property useCashBreakdown
-
added a new array property currencyPaymentTypes of type Reporting.CashReports.CashReports.Models.CurrencyPaymentType
Reporting.CashReports.CashReports.Models.CurrencyPaymentType
-
-
affected 200 status response on:
-
GET /v1-ext/CashReport
-
-
Reporting.Orders.OrderModel.ReportingOrder changed:
-
eventHistory array of type Reporting.Orders.OrderModel.EventHistory changed:
-
added a new string property receiptId
-
-
reportingCustomer property Reporting.Orders.OrderModel.ReportingCustomer changed :
-
added a new array of string property allowedProducts
-
-
added a new property laundryTag of type Reporting.Orders.OrderModel.ReportingLaundryTag
Reporting.Orders.OrderModel.ReportingLaundryTag
-
added a new property receipts of type Reporting.Orders.OrderModel.ReportingReceiptInfo
-
Reporting.Orders.OrderModel.ReportingReceiptInfo
-
products & refundedRows array properties Reporting.Orders.OrderModel.ReportingProduct changed (also self-referenced in the property products):
-
added a new nullable boolean property delivered
-
added a new nullable boolean property readyToBeDelivered
-
added a new property priceCalculationResult of type Reporting.IntegrationEvents.OrderEvents.EventEntities.ReportingPriceCalculationResult
-
Reporting.IntegrationEvents.OrderEvents.EventEntities.ReportingPriceCalculationResult
-
added a new property customNote of type Reporting.Orders.OrderModel.CustomNote
-
Reporting.Orders.OrderModel.CustomNote
-
added a new property washing of type Reporting.Orders.OrderModel.Washing
-
Reporting.CashReports.CashReports.Models.CurrencyPaymentType
-
-
CustomerShip API
-
new endpoint POST /v1-ext/Customers/byIds, description: Search customers by database ids. If no ids are given, all customers are returned
-
request body is an array of strings (uuid format)
-
200 status response is a list of Customership.Data.Models.CustomerModel
-
-
new endpoint POST /v1-ext/Customers/groupsByIds, description: Search customer groups by database ids. If no ids are given, all groups are returned.
-
request body is an array of strings
-
200 status response is a list of Customership.Data.Models.CustomerGroupModel
-
-
new endpoint GET /v1-ext/Customers/identifierTypes,
-
query parameter search
-
200 status response is a list of Customership.Api.ApiModels.IdentifierTypeApiResponseModel
-
Customership.Api.ApiModels.IdentifierTypeApiResponseModel
-
-
400, 401, 404 status response of type Microsoft.AspNetCore.Mvc.ProblemDetails
-
-
new endpoint POST /v1-ext/Customers/identifierTypes,
-
request body message of type Customership.Api.ApiModels.IdentifierTypeApiRequestModel (above)
-
202 status response "Accepted"
-
400, 401, 404 status response of type Microsoft.AspNetCore.Mvc.ProblemDetails
-
-
new endpoint DELETE /v1-ext/Customers/identifierTypes/{id},
-
path parameter id in uuid format
-
202 status response "Accepted"
-
400, 401, 404 status response of type Microsoft.AspNetCore.Mvc.ProblemDetails
-
-
new endpoint GET /v1-ext/Customers/identifierTypes/{id},
-
path parameter id in uuid format
-
200 status response is a list of Customership.Api.ApiModels.IdentifierTypeApiResponseModel
-
400, 401, 404 status response of type Microsoft.AspNetCore.Mvc.ProblemDetails
-
-
existing endpoint /v1-ext/Customers changed request body from Customership.Data.Models.CustomerModel to Customership.Api.ApiModels.CustomerApiRequestModel
-
Customership.Api.ApiModels.CustomerApiRequestModel
-
to sum up
-
dropped irrelevant properties:
-
_ts
-
clientTaxCode
-
created
-
createdBy
-
displayId
-
lastPurchase
-
type
-
updated
-
updatedBy
-
-
identifiers model changed from Customership.Data.Models.IdentifierModel
-
-
-
existing endpoint /v1-ext/Customers/filter added support for new query parameters:
-
datetime string parameter AfterLastPurchaseDate; description: Search everything after last purchase date.
-
datetime string parameter BeforeLastPurchaseDate; description: Search everything before last purchase date.
-
string parameter Name; description: Search by customer name or company name.
-
string parameter PhoneNumber; description: Search by customer phone number.
-
string parameter PostalCode; description: Search by customer address postal code.
-
string parameter City; description: Search by customer address city.
-
string parameter CustomerIdentifier; description: Search by customer external Id.
-
-
existing endpoint /v1-ext/Customers/groups changed its 200 status response from Customership.Data.Models.CustomerGroupModel to an array of Customership.Data.Models.CustomerGroupModel
-
Customership.Data.Models.CustomerModel changed
-
added a new array of strings property allowedProducts
-
added a new readonly int32 property displayId
-
added a new nullable date-time property lastPurchase
-
property contact details of Customership.Data.Models.ContactDetailModel type
-
email property has a validation check with a pattern
-
-
property companyName does not have a length limit anymore
-
property customNote does not have a length limit anymore
-
-
affected 200 status response on:
-
GET /v1-ext/Customers/byIds
-
-
as a customers list property of Customership.Data.Models.CustomerFilterResultModel
-
affected 200 status response on:
-
GET /v1-ext/Customers/filter
-
-
-
-
Customership.Data.Models.IdentifierModel changed:
-
added a new boolean property isDefault
-
added a new boolean property isSearchable
-
added a new boolean property showOnPos
-
-