Flow Retail Docs
Ask or search...
Ctrl
K
Visit our website
API Documentation
More
Visit our website
API Documentation
Developers
API documentation
Models
Previous
Webhooks
Was this helpful?
Models
AccountUpdateSchema
AccountingHeaderSchema
AccountingPostSchema
AccountingReportResponseSchema
AccountingTotalsSchema
AllowSaleENUM
CustomerSearchScopeENUM
AllowDeliveryENUM
RMAOrderStatusRequestENUM
RMAOrderStatusResponseENUM
AllowedActionENUM
EnvironmentENUM
AvailabilityTypeENUM
AvailableReasonResponseSchema
AvailableReasonsSchema
Base64EncodedFileContentSchema
BatchAdjustStockSchema
BrandResponseSchema
BrandUpdateSchema
BrandCreateSchema
BrandSearchSchema
CashdrawerStatusSchema
CategoryResponseSchema
ChildCategoryResponseSchema
CountrySchema
ConsentSchema
ConsentCreateSchema
ConsentUpdateSchema
CustomerResponseSchema
CustomerExternalResponseSchema
CustomerCreateSchema
CustomerUpdateSchema
CustomerSearchSchema
CustomerExternalSearchSchema
CustomerTypeENUM
DeviceResponseSchema
DeviceUserResponseSchema
DeviceAuthorizationStatusENUM
DeviceInfoResponseSchema
DeviceCurrencyDenominationSchema
CashDetailSchema
CurrencyDenominationMaterialENUM
DevicePaymentMethodResponseSchema
OrderPaymentMethodResponseSchema
DeviceStatusENUM
EmailTYPE
FlowboxAttachSchema
FlowboxPeripheralErrorENUM
FlowboxUpdateRequestSchema
GiftcardDetailsResponseSchema
HandlingActionCreateRequestSchema
HandlingActionUpdateRequestSchema
HandlingActionResponseSchema
HandlingCreateRequestSchema
HandlingUpdateRequestSchema
HandlingResponseSchema
HandlingStateENUM
DeliveryStateENUM
HandlingTriggerENUM
HandlingTriggerSchema
LedgerTypeENUM
UpdateWarehouseProductDetailRequestSchema
NullableStockResponseSchema
NumberSeriesResponseSchema
NumberSeriesCreateSchema
NumberSeriesTypeENUM
NumberSeriesUpdateSchema
OrderResponseSchema
DeprecatedOrderAddressResponseSchema
OrderAddressResponseSchema
BaseAddressSchema
DeliveryAddressResponseSchema
InvoiceAddressResponseSchema
DeliveryAddressRequestSchema
OrderAddressSchema
CustomerAddressTypeENUM
CustomerAddressCreateRequestSchema
CustomerAddressUpdateRequestSchema
CustomerAddressResponseSchema
OrderChangeStatusENUM
OrderCreateRequestSchema
OrderUpdateRequestSchema
OrderCreateImportSchema
OrderDeliveryResponseSchema
DeliverySearchResponseSchema
OrderDeliveryStateENUM
ReceiptStateENUM
OrderHandlingCreateRequestSchema
OrderHandlingResponseSchema
OrderHandlingUpdateRequestSchema
OrderItemResponseSchema
OrderItemActionCreateRequestSchema
OrderItemActionResponseSchema
OrderItemActionUpdateRequestSchema
OrderItemCreateSchema
OrderItemDeliverRequestSchema
OrderItemDeliverResponseSchema
OrderItemLinkSchema
OrderItemUpdateSchema
OrderLinkTypeSchema
OrderLinkTypeResponseENUM
OrderLinkTypeRequestENUM
OrderOrderStateENUM
OrderProductLinePropertyResponseSchema
OrderProductLinePropertySchema
OrderSearchSchema
TenantPurchaseOrderSearchSchema
TenantOrderSearchSchema
TenantOrderReceiptSearchSchema
OrderSettleStateENUM
OrderSettlementCreateSchema
SettlementCreateRequestSchema
OrderSettlementImportSchema
OrderSettlementTotalsSchema
OrderStatusChangeSchema
OrderStatusENUM
AssetCategoryENUM
AssetResponseSchema
OrderTotalsResponseSchema
OrderTotalsImportSchema
OrderTotalsVatSpecificationSchema
OrderTypeENUM
Paging
PayexCallbackDataSchema
PayexCallbackReceiptSchema
PayexCallbackReceiptStringsSchema
PayexCallbackSchema
PaymentMethodResponseSchema
PaymentMethodCodeENUM
PaymentMethodParameterSchema
PaymentMethodParameterTypeENUM
PriceResponseSchema
PriceBatchErrorPriceSchema
BatchErrorProductSchema
PriceBatchRequestSchema
PriceBatchResponseSchema
PriceBatchResponseItemPriceSchema
BatchResponseItemProductSchema
PriceCreateSchema
PriceDeleteBatchSchema
PriceUpdateSchema
PriceUpdateBatchSchema
PricelistResponseSchema
PricelistCreateRequestSchema
PricelistUpdateRequestSchema
ProductCreateSchema
ProductResponseSchema
ProductGroupResponseSchema
ProductGroupCreateRequestSchema
ProductGroupUpdateRequestSchema
OrderPrintTypeENUM
OrderEmailTypeENUM
OrderPdfTypeENUM
ProductGroupScopeENUM
ProductGroupPathSchema
ProductGtinSchema
ProductGtinResponseSchema
ProductLinkResponseSchema
ProductGroupLinkResponseSchema
ProductLinkParentResponseSchema
ProductLinkRequestSchema
ProductGroupLinkRequestSchema
ProductGroupLinkTypeENUM
ProductLinkTypeENUM
ProductPropertyRequestSchema
ProductTextPropertyRequestSchema
ProductOptionPropertyRequestSchema
ProductTextPropertyUpdateRequestSchema
ProductTextPropertyUpdateSchema
ProductReportResponseItemSchema
ProductReportResponseSchema
ProductSearchSchema
ProductSearchStockDetailsSchema
ProductSearchStockRequestSchema
ProductSupplierResponseSchema
ProductTypeENUM
ProductUpdateSchema
PropertyResponseSchema
PropertyCreateRequestSchema
PropertySearchRequestSchema
PropertyUpdateRequestSchema
PropertyOptionResponseSchema
PropertyOptionCreateRequestSchema
PropertyOptionUpdateRequestSchema
PropertyTypeENUM
PurchaseOrderResponseSchema
PurchaseOrderCreateSchema
PurchaseOrderUpdateSchema
PurchaseOrderItemResponseSchema
InternalPurchaseOrderItemResponseSchema
PurchaseOrderItemCreateSchema
InternalPurchaseOrderItemCreateSchema
PurchaseOrderItemUpdateSchema
InternalPurchaseOrderItemUpdateSchema
InternalPurchaseOrderItemSendSchema
InternalPurchaseOrderItemReceiveSchema
PurchaseOrderStatusENUM
ReasonResponseSchema
ReasonCreateRequestSchema
ReasonUpdateRequestSchema
ReasonTypeENUM
ReceivementResponseSchema
ReceivementItemResponseSchema
ReceivementItemProductResponseSchema
ReceivementItemCreateRequestSchema
ReceivementItemUpdateRequestSchema
ReceivementStatusENUM
ReportTypeENUM
ReportTurnoverItemSchema
ReportTurnoverProductGroupResponseSchema
ReportTurnoverTotalSchema
SerialNoRequiredENUM
CustomerExtensionCodeENUM
ExtensionCodeENUM
SettlementResponseSchema
SettlementDisplayMessageSchema
SettlementIdMethodENUM
SettlementParameterSchema
SettlementStateENUM
SettlementStatusENUM
SortDirectionENUM
StockResponseSchema
StockLogResponseSchema
StockLogSearchRequestSchema
StocktakingControlTotalsResponseSchema
StocktakingControlItemResponseSchema
StocktakingControlResponseSchema
StocktakingCreateRequestSchema
StocktakingItemSchema
StocktakingItemProductSchema
StocktakingItemUpdateSchema
StocktakingRegistrationItemRequestSchema
StocktakingRegistrationRequestSchema
StocktakingRegistrationResponseSchema
StocktakingResponseSchema
StocktakingStatusENUM
StocktakingTypeENUM
StocktakingUpdateRequestSchema
StoreResponseSchema
DeviceStoreResponseSchema
OrganizationResponseSchema
StoreCreateRequestSchema
StoreUpdateRequestSchema
OrganizationCreateRequestSchema
OrganizationUpdateRequestSchema
StorePaymentMethodCreateRequestSchema
StorePaymentMethodResponseSchema
StorePaymentMethodUpdateRequestSchema
StoreProductResponseSchema
StoreProductDetailsSchema
StoreProductSearchSchema
StoreReportTurnoverItemSchema
StoreReportTurnoverDateSchema
TenantUserReportTurnoverSchema
StoreRoleENUM
StoreExtensionCreateRequestSchema
GeneralParameterRequestSchema
StoreExtensionUpdateRequestSchema
StoreExtensionTenantExtensionResponseSchema
StoreExtensionStoreResponseSchema
StoreExtensionResponseSchema
StoreSettingSchema
StoreSettingKeyENUM
StoreSettlementIssuerResponseSchema
StoreSettlementIssuerUpdateRequestSchema
SupplierResponseSchema
SupplierCreateRequestSchema
SupplierUpdateRequestSchema
SupplierProductResponseSchema
SupplierProductCreateRequestSchema
SupplierProductUpdateRequestSchema
TenantResponseSchema
TenantAccountAcceptInviteSchema
TenantAccountTypeENUM
TenantAccountUpdateSchema
TenantCreateSchema
TenantOnboardRequestSchema
TenantOnboardResponseSchema
TenantPaymentMethodCreateRequestSchema
TenantPaymentMethodResponseSchema
TenantPaymentMethodUpdateRequestSchema
TenantRoleENUM
TenantExtensionResponseSchema
TenantExtensionCreateRequestSchema
TenantExtensionUpdateRequestSchema
TenantUpdateSchema
TenantUserResponseSchema
TenantUserTokenResponseSchema
TillResponseSchema
TillCashReportResponseSchema
TillCreateSchema
TillDeviceRegisterSchema
TillPaymentTerminalENUM
TillSettingSchema
TillSettingKeyENUM
TillStatusENUM
TillUpdateSchema
TransactionTypeENUM
TransportHeaderSchema
TransportCreateRequestSchema
TransportUpdateRequestSchema
HttpTransportResponseSchema
UserStoreAccessResponseSchema
UserStoreAccessCreateSchema
VatCodeSchema
VatNumberTYPE
VatPrintENUM
WarehouseResponseSchema
WarehouseAccessResponseSchema
MyWarehouseAccessResponseSchema
WarehouseAccessGrantSchema
WarehouseAccessRoleENUM
WarehouseCreateRequestSchema
WarehouseUpdateRequestSchema
StockDetailResponseSchema
WarehouseStockDetailsResponseSchema
WebhookActionENUM
WebhookCreateRequestSchema
WebhookUpdateRequestSchema
WebhookResponseSchema
ZReportCountAmountNameSchema
ZReportTotalsSchema
ZReportCountAmountSchema
ZReportCountSchema
ZReportHeaderSchema
ZReportResponseSchema
ServiceOrderResponseSchema
ServiceTypeResponseSchema
ServiceStatusResponseSchema
ServiceStateENUM
VisibilityENUM
ServiceHoursResponseSchema
MessageTypeENUM
PriorityENUM
ServiceOrderItemResponseSchema
ServiceEventResponseSchema
OrderPDFSchema
OrderPrintSchema
OrderEmailSchema
ProductBarcodeTypeENUM
ImportEntityENUM
ImportFormatENUM
ImportStateENUM
ImportActionENUM
ImportOperationENUM
ProductBarcodePrintSchema
ImportTemplateCreateRequestSchema
ImportTemplateUpdateRequestSchema
ImportLayoutCreateRequestSchema
ImportLayoutUpdateRequestSchema
ImportConversionCreateRequestSchema
ImportConversionUpdateRequestSchema
ImportTemplateResponseSchema
ImportLayoutResponseSchema
ImportConversionResponseSchema
ImportFileResponseSchema
ImportFileRequestSchema
ImportFileDetailResponseSchema
ProductVariantResponseSchema
ProductAddonResponseSchema
ProductVariantRequestSchema
ProductPropertyResponseSchema
PurchaseReceivementItemResponseSchema
UID
DeprecatedUID
OptionalUID
OptionalNullableUID
DeprecatedOptionalUID
ServiceTypeCreateRequestSchema
ServiceTypeUpdateRequestSchema
ServiceStatusCreateRequestSchema
ServiceStatusUpdateRequestSchema
ServiceHoursCreateRequestSchema
ServiceHoursUpdateRequestSchema
ServiceEventCreateRequestSchema
ServiceEventUpdateRequestSchema
ServiceOrderItemCreateRequestSchema
ServiceOrderItemUpdateRequestSchema
ServiceOrderCreateRequestSchema
ServiceOrderUpdateRequestSchema
DeviceSystemInformationUpdateRequestSchema
DeviceRegisterRequestSchema
DeviceLinkRequestSchema
XZReportPDFRequestSchema
CashControlReportPDFRequestSchema
SAFTReportCreateRequestSchema
GeneralReportCreateRequestSchema
WarehouseStockDetailsReportCreateRequestSchema
ReportAbortRequestSchema
TurnoverRequestSchema
TenantUserTurnoverRequestSchema
TillStatusRequestSchema
TenantUserUpdateRequestSchema
TenantUserCreateRequestSchema
StocktakingItemListCreateRequestSchema
UpdateDeliveryRequestSchema
ReceivementUpdateRequestSchema
ReceivementCreateRequestSchema
ProductReportRequestSchema
EmailNotificationRequestSchema
PurchaseOrderEmailNotificationRequestSchema
MoveStockRequestSchema
CategoryUpdateRequestSchema
CategoryCreateRequestSchema
CashReportWithdrawalRequestSchema
CashReportUpdateRequestSchema
BatchAdjustStockRequestSchema
BatchAdjustStockResponseSchema
AdjustStockRequestSchema
AccountingRequestSchema
AccountLoginRequestSchema
DeviceAuthorizeRequestSchema
DeprecatedDeviceTokenRequestSchema
DeviceCreateRequestSchema
DeviceUpdateRequestSchema
DeliverySearchRequestSchema
DeliveryCreateRequestSchema
OrderImportDeliveryCreateRequestSchema
FlowboxTokenCreateSchema
GeneralNotificationRequestSchema
NotificationResponseSchema
NotificationSearchSchema
NotificationStateENUM
LinkmobilityCallbackRequestSchema
AvailableExtensionSchema
TenantExtensionSchema
ImportFileDataResponseSchema
ImportFileJobRequestSchema
ImportFileJobActionENUM
ProductRequirementRequestSchema
ProductRequirementResponseSchema
PaymentMethodRequirementResponseSchema
StoreSearchStockRequestSchema
WarehouseSearchStockRequestSchema
CustomerContactCreateRequestSchema
CustomerContactUpdateRequestSchema
OrderCustomerContactResponseSchema
CustomerContactResponseSchema
ProductMediaSchema
ProductMediaCreateSchema
ProductMediaUploadSchema
ProductMediaUpdateSchema
ReportStateENUM
ReportActionENUM
ReportResponseSchema
CoverImageSchema
DeliveryProviderUpdateRequestSchema
DeliveryProviderCreateRequestSchema
DeliveryProviderResponseSchema
DeliveryProviderMethodUpdateRequestSchema
DeliveryProviderMethodCreateRequestSchema
DeliveryProviderMethodResponseSchema
ServiceStatusWithPosition
ServiceTypeStatusSchema
ExternalWorkshopResponseSchema
ExternalWorkshopUpdateSchema
ExternalWorkshopCreateSchema
CustomerExtensionRequestSchema
CustomerExtensionResponseSchema
CustomerContactExtensionRequestSchema
CustomerContactExtensionResponseSchema
ServiceShipmentResponseSchema
ServiceShipmentStatusENUM
InternalPurchaseOrderStatusENUM
ServiceShipmentReceiverResponseSchema
ServiceShipmentUpdateSchema
InternalPurchaseOrderUpdateSchema
ServiceShipmentCreateSchema
InternalPurchaseOrderCreateSchema
InternalPurchaseOrderResponseSchema
ServiceShipmentReceiverUpdateSchema
ServiceShipmentSenderSchema
ServiceShipmentItemResponseSchema
ServiceShipmentItemUpdateSchema
WarehouseStockLogResponseSchema
WarehouseStockLogRequestSchema
ReportFormatENUM
AccountingFileRequestSchema
TillAppSettingsSchema
AccountingConfigsSchema
AccountingConfigsResponseSchema
AccountingConfigsRequestSchema
AccountingConfigsProductGroupRequestSchema
AccountingConfigsUpdateSchema
AccountingConfigTypeENUM
AccountingConfigKeyENUM
LanguageCode
DeliveryProviderMethodTimeslotResponseSchema
DeliveryProviderMethodTimeslotCreateRequestSchema
DeliveryProviderMethodTimeslotUpdateRequestSchema
WeekDayENUM
DeliveryProviderMethodTimeslotAvailableResponseSchema
OpeningHoursResponseSchema
OpeningHoursRequestSchema
WarehouseProductDetailsResponseSchema
TenantPaymentMethodParameterResponseSchema
TenantPaymentMethodParameterExtractResponseSchema
AvailablePaymentMethodParametersResponseSchema
TenantPaymentMethodParameterTypeENUM
TenantPaymentMethodParameterCreateRequestSchema
TenantPaymentMethodParameterUpdateRequestSchema
LocaleMetadataResponseSchema
ProductMediaSourceENUM
GeneratedSkuENUM
CurrencyResponseSchema
OrderOperationRequestSchema
OrderOperationENUM
InternalPurchaseOrderItemProductResponseSchema
SettlementCurrencySchema
ServiceEventNotificationResponseSchema
CurrencyMetadataResponseSchema
CustomerConsentChangeSchema
CustomerConsentStatusSchema
ServiceOrderTotalsSchema
HourlyRateResponseSchema
ServiceOrderSearchRequestSchema
LoyaltyMemberResponseSchema
LoyaltyDiscountResponseSchema
DiscountTypeENUM
OrderDiscountResponseSchema
DiscountOriginENUM
DiscountScopeENUM
StoreCustomerDetailsResponseSchema
CustomerCreditLimitSchema
BankInfoRequestSchema
BankInfoResponseSchema
ProductWarrantySchema
TillAppSettingsUpdateSchema
TenantSettingsResponseSchema
PaymentMethodVisibilityENUM
CampaignCreateRequestSchema
CampaignResponseSchema
CampaignProductSelectionSchema
CampaignSelectionResponseSchema
CampaignProductSelectionResponseSchema
CampaignStoreSchema
CampaignBrandSchema
CampaignCategorySchema
CampaignProductGroupSchema
CampaignProductSchema
CampaignPricelistSchema
CampaignUpdateRequestSchema
CampaignProductSelectionRequestSchema
CampaignSelectionRequestSchema
CampaignDiscountTypeENUM
CampaignTypeENUM
ProductOnCampaignType
SupplierPayoutResponseSchema
SupplierPayoutUpdateRequestSchema
SupplierPayoutScopeENUM
SupplierPayoutListRequestSchema
CommissionSaleResponseSchema
CampaignStatusENUM
TillTouchModeENUM
EntityTimestampResponseSchema
PaymentResponseSchema
SettlementAdditionalDetailsSchema
AssociatedWarehouseSchema
AssociatedOrderSchema
LabelENUM
LabelResponseSchema
LabelSizeENUM
AvailableExtensionParameterSchema
ExtensionParameterDataTypeENUM
ProductVisibilityENUM
CurrencyDenominationsMetadataSchema
ProductPackageSlotResponseSchema
CreatedModifiedSchema
ProductPackageComponentSchema
ProductPackageComponentProductSchema
ArtSupplierReportRequestSchema
CustomerCreditSchema
CustomerCreditResponseSchema
AccountManagerResponseSchema
AccountManagerRequestSchema
OrderAdditionalNoteResponseSchema
SimpleNotificationRequestSchema
TenantAppSettingsResponseSchema
PurchaseOrderCurrencySchema
PurchaseOrderItemCurrencySchema
DeprecatedPurchaseOrderItemCurrencySchema
DeliveryProviderSearchSchema
StoreVisitorResponseSchema
StoreVisitorRequestSchema
CompensationUpdateRequestSchema
CompensationCreateRequestSchema
CompensationResponseSchema
CompensationReasonUpdateRequestSchema
CompensationReasonCreateRequestSchema
CompensationReasonResponseSchema
ExternalReportUrlResponseSchema
RMAOrderCreateRequestSchema
RMAOrderUpdateRequestSchema
RMAOrderItemResponseSchema
RMAOrderItemCreateRequestSchema
RMAOrderResponseSchema
RMAOrderItemUpdateRequestSchema
AssetCreateRequestSchema
AssetUpdateRequestSchema
AssetUrlSchema
TenantAssetSchema
GeneralParameterResponseSchema
GeneralParameterTypeENUM
GiftcardExtensionENUM
ReceiptResponseSchema
LimitToStoreUidsSchema
DeviceTokenRequestSchema
DeviceLinkResponseSchema
DeviceTillResponseSchema
DeviceAppCodeENUM
SalesReservationTypeENUM
SalesReservationDetailsSchema
SalesReservationWarehouseSchema
SalesReservationPurchaseOrderSchema
PurchaseOrderItemReservationSchema
TimezoneTYPE
CustomerGroupResponseSchema
ExternalSystemCodeENUM
GeneralMappingCreateRequestSchema
GeneralMappingUpdateRequestSchema
GeneralMappingResponseSchema
DeliveryProviderMethodMappingResponseSchema
TenantPaymentMethodMappingResponseSchema
DeliverySourcingRequestSchema
DeliverySourcingItemResponse
DeliverySourcingResponseSchema
DeliveryOptionRequestSchema
DeliveryOptionResponseSchema
DeliveryOptionSchema
DeliveryOptionsSchema
DeliveryOptionPickupSchema
DeliveryOptionPickupPlaceSchema
DeliveryOptionVistitingAddressSchema
DeliveryOptionHomeDeliverySchema
DeliveryOptionArrivalDateTimeSchema
DeliveryOptionParcelSchema
CampaignSearchRequestSchema
PrinterTypeENUM
PrinterResponseSchema
PrinterUpdateRequestSchema
TenantCurrencySchema
PriceBrandResponseSchema
PriceProductGroupResponseSchema
PurchaseRequestProductSchema
PurchaseRequestSupplierSchema
DevicePrinterResponseSchema
PurchaseRequestOrderSchema
ExtendedGiftcardExtensionCodeENUM
OrderItemAddonResponseSchema
ReceiptCreateRequestSchema
ReceiptUpdateRequestSchema
PurchaseRequestOrderItemSchema
DateTimeRangeSchema
OrderItemsReservationUpdateSchema
OrderItemUpdateReservationSchema
DeviceSearchRequestSchema
PrinterRequestSearchSchema
PurchaseOrderItemUpdateQtyDeliveredSchema
ServiceOrderAssetResponse
