Enums
CacheControlScope
Values
| Value | Description |
|---|---|
| PUBLIC | |
| PRIVATE |
DeliveryProviderError
Values
| Value | Description |
|---|---|
| ADAPTER_NOT_FOUND | |
| NOT_IMPLEMENTED | |
| INCOMPLETE_CONFIGURATION | |
| WRONG_CREDENTIALS |
DeliveryProviderType
Values
| Value | Description |
|---|---|
| PICKUP | Pick-Up |
| SHIPPING | Shipping |
EnrollmentStatus
Values
| Value | Description |
|---|---|
| INITIAL | Initial |
| ACTIVE | Active Enrollment |
| PAUSED | Paused because of overdue payments |
| TERMINATED | Terminated / Ended enrollment |
EventType
Values
| Value | Description |
|---|---|
| PAGE_VIEW | |
| API_LOGIN_TOKEN_CREATED | |
| API_LOGOUT | |
| ASSORTMENT_CREATE | |
| ASSORTMENT_REMOVE | |
| ASSORTMENT_SET_BASE | |
| ASSORTMENT_UPDATE | |
| ASSORTMENT_ADD_FILTER | |
| ASSORTMENT_REMOVE_FILTER | |
| ASSORTMENT_REORDER_FILTERS | |
| ASSORTMENT_ADD_LINK | |
| ASSORTMENT_REMOVE_LINK | |
| ASSORTMENT_REORDER_LINKS | |
| ASSORTMENT_ADD_PRODUCT | |
| ASSORTMENT_REMOVE_PRODUCT | |
| ASSORTMENT_REORDER_PRODUCTS | |
| ASSORTMENT_UPDATE_TEXT | |
| ASSORTMENT_ADD_MEDIA | |
| ASSORTMENT_REMOVE_MEDIA | |
| ASSORTMENT_REORDER_MEDIA | |
| ASSORTMENT_UPDATE_MEDIA_TEXT | |
| BOOKMARK_CREATE | |
| BOOKMARK_UPDATE | |
| BOOKMARK_REMOVE | |
| COUNTRY_CREATE | |
| COUNTRY_UPDATE | |
| COUNTRY_REMOVE | |
| CURRENCY_CREATE | |
| CURRENCY_UPDATE | |
| CURRENCY_REMOVE | |
| DELIVERY_PROVIDER_CREATE | |
| DELIVERY_PROVIDER_UPDATE | |
| DELIVERY_PROVIDER_REMOVE | |
| ENROLLMENT_ADD_PERIOD | |
| ENROLLMENT_CREATE | |
| ENROLLMENT_REMOVE | |
| ENROLLMENT_UPDATE | |
| FILE_CREATE | |
| FILE_UPDATE | |
| FILE_REMOVE | |
| FILTER_CREATE | |
| FILTER_REMOVE | |
| FILTER_UPDATE | |
| FILTER_UPDATE_TEXT | |
| LANGUAGE_CREATE | |
| LANGUAGE_UPDATE | |
| LANGUAGE_REMOVE | |
| ORDER_CHECKOUT | |
| ORDER_CONFIRMED | |
| ORDER_REJECTED | |
| ORDER_FULLFILLED | |
| ORDER_CREATE | |
| ORDER_REMOVE | |
| ORDER_SET_DELIVERY_PROVIDER | |
| ORDER_SET_PAYMENT_PROVIDER | |
| ORDER_UPDATE | |
| ORDER_CREATE_DISCOUNT | |
| ORDER_UPDATE_DISCOUNT | |
| ORDER_REMOVE_DISCOUNT | |
| ORDER_ADD_DISCOUNT | |
| ORDER_UPDATE_CART_ITEM | |
| ORDER_REMOVE_CART_ITEM | |
| ORDER_EMPTY_CART | |
| ORDER_ADD_PRODUCT | |
| ORDER_UPDATE_PAYMENT | |
| ORDER_SIGN_PAYMENT | |
| ORDER_PAY | |
| ORDER_DELIVER | |
| ORDER_UPDATE_DELIVERY | |
| PAYMENT_PROVIDER_CREATE | |
| PAYMENT_PROVIDER_UPDATE | |
| PAYMENT_PROVIDER_REMOVE | |
| PRODUCT_CREATE | |
| PRODUCT_REMOVE | |
| PRODUCT_SET_BASE | |
| PRODUCT_UPDATE | |
| PRODUCT_PUBLISH | |
| PRODUCT_UNPUBLISH | |
| PRODUCT_ADD_ASSIGNMENT | |
| PRODUCT_REMOVE_ASSIGNMENT | |
| PRODUCT_CREATE_BUNDLE_ITEM | |
| PRODUCT_REMOVE_BUNDLE_ITEM | |
| PRODUCT_UPDATE_TEXT | |
| PRODUCT_ADD_MEDIA | |
| PRODUCT_REMOVE_MEDIA | |
| PRODUCT_REORDER_MEDIA | |
| PRODUCT_UPDATE_MEDIA_TEXT | |
| PRODUCT_REVIEW_CREATE | |
| PRODUCT_REMOVE_REVIEW | |
| PRODUCT_UPDATE_REVIEW | |
| PRODUCT_REVIEW_ADD_VOTE | |
| PRODUCT_REMOVE_REVIEW_VOTE | |
| PRODUCT_CREATE_VARIATION | |
| PRODUCT_REMOVE_VARIATION | |
| PRODUCT_UPDATE_VARIATION_TEXT | |
| PRODUCT_VARIATION_OPTION_CREATE | |
| PRODUCT_REMOVE_VARIATION_OPTION | |
| QUOTATION_REQUEST_CREATE | |
| QUOTATION_REMOVE | |
| QUOTATION_UPDATE | |
| USER_ACCOUNT_ACTION | |
| USER_CREATE | |
| USER_ADD_ROLES | |
| USER_UPDATE | |
| USER_UPDATE_PROFILE | |
| USER_UPDATE_ROLE | |
| USER_UPDATE_TAGS | |
| USER_UPDATE_AVATAR | |
| USER_UPDATE_GUEST | |
| USER_UPDATE_USERNAME | |
| USER_UPDATE_PASSWORD | |
| USER_UPDATE_HEARTBEAT | |
| USER_UPDATE_BILLING_ADDRESS | |
| USER_UPDATE_LAST_CONTACT | |
| USER_REMOVE | |
| WAREHOUSING_PROVIDER_CREATE | |
| WAREHOUSING_PROVIDER_UPDATE | |
| WAREHOUSING_PROVIDER_REMOVE | |
| TOKEN_OWNERSHIP_CHANGED | |
| TOKEN_INVALIDATED | |
| WORK_ADDED | |
| WORK_ALLOCATED | |
| WORK_FINISHED | |
| WORK_DELETED | |
| WORK_RESCHEDULED | |
| UNKNOWN |
ExternalLinkTarget
Values
| Value | Description |
|---|---|
| BLANK | Open on new tab |
| SELF | Open in own Iframe |
FilterType
Values
| Value | Description |
|---|---|
| SWITCH | Switch / Boolean |
| SINGLE_CHOICE | Single-choice |
| MULTI_CHOICE | Multi-choice |
| RANGE | Range |
LengthUnit
Values
| Value | Description |
|---|---|
| METERS | |
| FEET | |
| MILLIMETERS |
MassUnit
Values
| Value | Description |
|---|---|
| KILOGRAM | |
| GRAM | |
| POUNDS |
OrderDeliveryStatus
Values
| Value | Description |
|---|---|
| OPEN | Order is not delivered |
| DELIVERED | Delivery complete |
| RETURNED | Delivery returned |
OrderDiscountTrigger
Values
| Value | Description |
|---|---|
| SYSTEM | System triggered |
| USER | User triggered |
OrderItemPriceCategory
Values
| Value | Description |
|---|---|
| DISCOUNT | Discount |
| TAX | Tax |
| ITEM | Items |
OrderPaymentStatus
Values
| Value | Description |
|---|---|
| OPEN | Unpaid Order |
| PAID | Order has been paid |
| REFUNDED | Order has been refunded |
OrderPriceCategory
Values
| Value | Description |
|---|---|
| ITEMS | Product Price Total |
| PAYMENT | Payment Fees |
| DELIVERY | Delivery Fees |
| TAXES | Tax |
| DISCOUNTS | Discount |
OrderStatus
Values
| Value | Description |
|---|---|
| OPEN | Open Order / Cart |
| PENDING | Order has been sent but confirmation awaiting |
| REJECTED | Order has been rejected |
| CONFIRMED | Order has been confirmed |
| FULLFILLED | Order has been fulfilled completely (all positions in delivery) |
PaymentProviderError
Values
| Value | Description |
|---|---|
| ADAPTER_NOT_FOUND | |
| NOT_IMPLEMENTED | |
| INCOMPLETE_CONFIGURATION | |
| WRONG_CREDENTIALS |
PaymentProviderType
Values
| Value | Description |
|---|---|
| CARD | Card |
| INVOICE | Invoice |
| GENERIC | Generic |
ProductPlanConfigurationInterval
Values
| Value | Description |
|---|---|
| HOURS | |
| DAYS | |
| WEEKS | |
| MONTHS | |
| YEARS |
ProductPlanUsageCalculationType
Values
| Value | Description |
|---|---|
| LICENSED | |
| METERED |
ProductReviewVoteType
Values
| Value | Description |
|---|---|
| UPVOTE | |
| DOWNVOTE | |
| REPORT |
ProductStatus
Values
| Value | Description |
|---|---|
| DRAFT | Unpublished (hidden from catalog) |
| ACTIVE | Published |
| DELETED | Deleted |
ProductVariationType
Values
| Value | Description |
|---|---|
| COLOR | Color Picker |
| TEXT | Text Answers |
QuotationDocumentType
Values
| Value | Description |
|---|---|
| PROPOSAL | Proposal |
| OTHER | Other |
QuotationStatus
Values
| Value | Description |
|---|---|
| REQUESTED | Request for Proposal |
| PROCESSING | Awaiting Offer |
| PROPOSED | Proposal ready |
| REJECTED | Quotation has been rejected by either party |
| FULLFILLED | Quotation has been used to order the product |
RoleAction
Values
| Value | Description |
|---|---|
| viewEvent | |
| viewEvents | |
| viewUserRoles | |
| viewUserOrders | |
| viewUserQuotations | |
| viewUserPublicInfos | |
| viewUserPrivateInfos | |
| viewUserEnrollments | |
| viewUserTokens | |
| viewLogs | |
| viewUser | |
| viewUsers | |
| viewProduct | |
| viewProducts | |
| viewLanguages | |
| viewLanguage | |
| viewCountries | |
| viewCountry | |
| viewCurrencies | |
| viewCurrency | |
| viewPaymentProviders | |
| viewPaymentProvider | |
| viewPaymentInterfaces | |
| viewDeliveryProviders | |
| viewDeliveryProvider | |
| viewDeliveryInterfaces | |
| viewWarehousingProviders | |
| viewWarehousingProvider | |
| viewWarehousingInterfaces | |
| viewTranslations | |
| viewOrders | |
| viewOrder | |
| viewShopInfo | |
| updateUser | |
| updateUsername | |
| sendEmail | |
| manageUsers | |
| manageLanguages | |
| manageCountries | |
| manageProducts | |
| manageCurrencies | |
| managePaymentProviders | |
| manageDeliveryProviders | |
| manageWarehousingProviders | |
| updateToken | |
| viewToken | |
| viewTokens | |
| manageAssortments | |
| manageFilters | |
| createCart | |
| createEnrollment | |
| updateEnrollment | |
| updateCart | |
| checkoutCart | |
| updateOrder | |
| updateOrderDelivery | |
| updateOrderPayment | |
| updateOrderDiscount | |
| updateOrderItem | |
| markOrderConfirmed | |
| markOrderRejected | |
| markOrderPaid | |
| markOrderDelivered | |
| viewAssortments | |
| viewAssortment | |
| viewFilter | |
| viewFilters | |
| reviewProduct | |
| updateProductReview | |
| manageProductReviews | |
| voteProductReview | |
| requestQuotation | |
| viewQuotations | |
| viewQuotation | |
| manageQuotations | |
| answerQuotation | |
| bookmarkProduct | |
| manageBookmarks | |
| search | |
| manageWorker | |
| viewEnrollments | |
| viewEnrollment | |
| registerPaymentCredentials | |
| managePaymentCredentials | |
| bulkImport | |
| logout | |
| loginAsGuest | |
| loginWithPassword | |
| loginWithWebAuthn | |
| verifyEmail | |
| useWebAuthn | |
| pageView | |
| createUser | |
| forgotPassword | |
| resetPassword | |
| changePassword | |
| viewUserProductReviews | |
| heartbeat | |
| confirmMediaUpload | |
| viewStatistics |
SearchOrderBy
Values
| Value | Description |
|---|---|
| default |
SmartContractStandard
Values
| Value | Description |
|---|---|
| ERC1155 | |
| ERC721 |
SortDirection
Values
| Value | Description |
|---|---|
| ASC | |
| DESC |
TokenExportStatus
Values
| Value | Description |
|---|---|
| CENTRALIZED | |
| EXPORTING | |
| DECENTRALIZED |
WarehousingProviderError
Values
| Value | Description |
|---|---|
| ADAPTER_NOT_FOUND | |
| NOT_IMPLEMENTED | |
| INCOMPLETE_CONFIGURATION | |
| WRONG_CREDENTIALS |
WarehousingProviderType
Values
| Value | Description |
|---|---|
| PHYSICAL | Physical warehousing providers resemble stores or facilities that hold a quantity of stocks physically in stock. |
| VIRTUAL | Virtual warehousing providers resemble software that control ownership and validity of virtual products (for ex. smart contract bridges) |
WorkStatus
Values
| Value | Description |
|---|---|
| NEW | |
| ALLOCATED | |
| SUCCESS | |
| FAILED | |
| DELETED |
WorkType
Values
| Value | Description |
|---|---|
| BULK_IMPORT | |
| ZOMBIE_KILLER | |
| MESSAGE | |
| EXTERNAL | |
| HTTP_REQUEST | |
| HEARTBEAT | |
| ERROR_NOTIFICATIONS | |
| UPDATE_ECB_RATES | |
| UPDATE_COINBASE_RATES | |
| EXPORT_TOKEN | |
| SMS | |
| PUSH | |
| ENROLLMENT_ORDER_GENERATOR | |
| UNKNOWN |