Package com.commercetools.history.models.common
package com.commercetools.history.models.common
-
ClassDescriptionAddress type returned by read methods.AddressBuilder Example to create an instance using the builder patternAsset Example to create an instance using the builder patternAssetBuilder Example to create an instance using the builder patternDimensions of the Asset source specified by the number of pixels.AssetDimensionsBuilder Example to create an instance using the builder patternRepresentation of an Asset in a specific format, for example a video in a certain encoding, or an image in a certain resolution.AssetSourceBuilder Example to create an instance using the builder patternAssociate Example to create an instance using the builder patternAssociateBuilder Example to create an instance using the builder patternAssociateRoleAssignment Example to create an instance using the builder patternAssociateRoleAssignmentBuilder Example to create an instance using the builder patternRoles defining how an Associate can interact with a Business Unit.possible values of AssociateRoleDeprecatedDetermines whether an AssociateRoleAssignment can be inherited by child Business Units.possible values of AssociateRoleInheritanceModeKeyReference to an AssociateRole.AssociateRoleKeyReferenceBuilder Example to create an instance using the builder patternAttribute Example to create an instance using the builder patternAttributeBuilder Example to create an instance using the builder patternSpecifies how an Attribute (or a set of Attributes) should be validated across all variants of a Product:possible values of AttributeConstraintEnumAttributeDefinition Example to create an instance using the builder patternAttributeDefinitionBuilder Example to create an instance using the builder patternAttributeLevelEnumpossible values of AttributeLevelEnumA localized enum value must be unique within the enum, else a DuplicateEnumValues error is returned.AttributeLocalizedEnumValueBuilder Example to create an instance using the builder patternA plain enum value must be unique within the enum, else a DuplicateEnumValues error is returned.AttributePlainEnumValueBuilder Example to create an instance using the builder patternUmbrella type for specific attribute types discriminated by property
name.AttributeTypeBuilder Example to create an instance using the builder patternAuthenticationModepossible values of AuthenticationModePolymorphic base type that represents a postal address and contact details.BaseAddressBuilder Example to create an instance using the builder patternIndicates if a Product Discount or Cart Discount offers the best deal for a Cart or Order.BestDealBuilder Example to create an instance using the builder patternDetermines whether a Business Unit can inherit Approval Rules from a parent.possible values of BusinessUnitApprovalRuleModeDetermines whether a Business Unit can inherit Associates from a parent.possible values of BusinessUnitAssociateModeKeyReference to a BusinessUnit.BusinessUnitKeyReferenceBuilder Example to create an instance using the builder patternBusinessUnitResourceIdentifierBuilder Example to create an instance using the builder patternIndicates whether the Business Unit can be edited and used in Carts, Orders, Quote Requests, or Quotes.possible values of BusinessUnitStatusDefines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from its parent unit.possible values of BusinessUnitStoreModeThe type of the Business Unit indicating its position in a hierarchy.possible values of BusinessUnitTypeReference to a CartDiscount.CartDiscountReferenceBuilder Example to create an instance using the builder patternCartDiscountTarget Example to create an instance using the builder patternCartDiscountTargetBuilder Example to create an instance using the builder patternCartDiscountValue Example to create an instance using the builder patternCartDiscountValueBuilder Example to create an instance using the builder patternJSON object where the keys are Categoryid, and the values are order hint values: strings representing a number between0and1, but not ending in0.CategoryOrderHintsBuilder Example to create an instance using the builder patternCategoryReferenceBuilder Example to create an instance using the builder patternObject that stores money in cent amounts of a specific currency.CentPrecisionMoneyBuilder Example to create an instance using the builder patternChannelReferenceBuilder Example to create an instance using the builder patternDescribes the purpose and type of the Channel.possible values of ChannelRoleEnumThese objects represent information about which API Client created or modified a resource.ClientLoggingBuilder Example to create an instance using the builder patternCustomerGroupAssignment Example to create an instance using the builder patternCustomerGroupAssignmentBuilder Example to create an instance using the builder patternReference to a CustomerGroup.CustomerGroupReferenceBuilder Example to create an instance using the builder patternCustomerReferenceBuilder Example to create an instance using the builder patternDefines an allowed value of a CustomFieldEnumType field.CustomFieldEnumValueBuilder Example to create an instance using the builder patternDefines an allowed value of a CustomFieldLocalizedEnumType field.CustomFieldLocalizedEnumValueBuilder Example to create an instance using the builder patternServes as value of thecustomfield on a resource or data type customized with a Type.CustomFieldsBuilder Example to create an instance using the builder patternA generic item that can be added to the Cart but is not bound to a Product that can be used for discounts (negative money), vouchers, complex cart rules, additional services, or fees.CustomLineItemBuilder Example to create an instance using the builder patternDetermines if Cart Discounts can be applied to a Custom Line Item in the Cart.possible values of CustomLineItemPriceModeInformation about recurring orders and frequencies.CustomLineItemRecurrenceInfoBuilder Example to create an instance using the builder patternContains information on how items are shipped to Customers, for example, a delivery note.DeliveryBuilder Example to create an instance using the builder patternDeliveryItem Example to create an instance using the builder patternDeliveryItemBuilder Example to create an instance using the builder patternRepresents a CartDiscount that is only associated with a single Cart or Order.DirectDiscountBuilder Example to create an instance using the builder patternDiscountCodeInfo Example to create an instance using the builder patternDiscountCodeInfoBuilder Example to create an instance using the builder patternReference to a DiscountCode.DiscountCodeReferenceBuilder Example to create an instance using the builder patternIndicates the state of a Discount Code in a Cart.possible values of DiscountCodeStateDiscountedLineItemPortion Example to create an instance using the builder patternDiscountedLineItemPortionBuilder Example to create an instance using the builder patternDiscountedLineItemPrice Example to create an instance using the builder patternDiscountedLineItemPriceBuilder Example to create an instance using the builder patternDiscountedLineItemPriceForQuantity Example to create an instance using the builder patternDiscountedLineItemPriceForQuantityBuilder Example to create an instance using the builder patternDiscountedPrice Example to create an instance using the builder patternDiscountedPriceBuilder Example to create an instance using the builder patternDiscountedTotalPricePortion Example to create an instance using the builder patternDiscountedTotalPricePortionBuilder Example to create an instance using the builder patternDiscountOnTotalPrice Example to create an instance using the builder patternDiscountOnTotalPriceBuilder Example to create an instance using the builder patternDiscountTypeCombination Example to create a subtype instance using the builder patternDiscountTypeCombinationBuilderFieldContainer Example to create an instance using the builder patternFieldContainerBuilder Example to create an instance using the builder patternDefines a Custom Field and its meta-information.FieldDefinitionBuilder Example to create an instance using the builder patternFieldType Example to create an instance using the builder patternFieldTypeBuilder Example to create an instance using the builder patternGeoJSON Geometry represents a Geometry Object as defined in the GeoJSON standard.GeoJsonBuilderGeoLocation Example to create an instance using the builder patternGeoLocationBuilder Example to create an instance using the builder patternImage Example to create an instance using the builder patternImageBuilder Example to create an instance using the builder patternImageDimensions Example to create an instance using the builder patternImageDimensionsBuilder Example to create an instance using the builder patternInheritedAssociate Example to create an instance using the builder patternInheritedAssociateBuilder Example to create an instance using the builder patternInheritedAssociateRoleAssignment Example to create an instance using the builder patternInheritedAssociateRoleAssignmentBuilder Example to create an instance using the builder patternIndicates how Line Items in a Cart are tracked.possible values of InventoryModeItemShippingDetails Example to create an instance using the builder patternItemShippingDetailsBuilder Example to create an instance using the builder patternDetermines the address (as a reference to an address initemShippingAddresses) and the quantity shipped to the address.ItemShippingTargetBuilder Example to create an instance using the builder patternItemState Example to create an instance using the builder patternItemStateBuilder Example to create an instance using the builder patternA KeyReference represents a loose reference to another resource in the same Project identified by the resource'skeyfield.KeyReferenceBuilderLineItemBuilder Example to create an instance using the builder patternIndicates how a Line Item was added to a Cart.possible values of LineItemModeThis mode indicates how the price is set for the Line Item.possible values of LineItemPriceModeInformation about recurring orders and frequencies.LineItemRecurrenceInfoBuilder Example to create an instance using the builder patternJSON object where the keys are of type Locale, and the values are the strings used for the corresponding language.LocalizedStringBuilder Example to create an instance using the builder patternA geographical location representing a country and optionally a state within this country.LocationBuilder Example to create an instance using the builder patternMethodTaxedPrice Example to create an instance using the builder patternMethodTaxedPriceBuilder Example to create an instance using the builder patternMethodTaxRate Example to create an instance using the builder patternMethodTaxRateBuilder Example to create an instance using the builder patternDraft object to store money in cent amounts for a specific currency.MoneyBuilder Example to create an instance using the builder patternDetermines the type of money used.possible values of MoneyTypeIndicates the state of the Order.possible values of OrderStateInformation regarding the appearance, content, and shipment of a Parcel.ParcelBuilder Example to create an instance using the builder patternParcelMeasurements Example to create an instance using the builder patternParcelMeasurementsBuilder Example to create an instance using the builder patternPaymentInfo Example to create an instance using the builder patternPaymentInfoBuilder Example to create an instance using the builder patternPaymentReferenceBuilder Example to create an instance using the builder patternIndicates the payment status for the Order.possible values of PaymentStatePermissions grant granular access to Approval Rules, Approval Flows, Business Units, Carts, Orders, Quotes, Quote Requests, and Shopping Lists.possible values of PermissionThe representation for prices embedded in LineItems and in ProductVariants when the ProductPriceMode isEmbedded.PriceBuilder Example to create an instance using the builder patternIndicates how the price of a Line Item or Custom Line Item is selected during Order creation.possible values of PriceSelectionModeA Price tier is selected instead of the default Price when a certain quantity of the ProductVariant is added to a Cart and ordered.PriceTierBuilder Example to create an instance using the builder patternReference to a ProductDiscount.ProductDiscountReferenceBuilder Example to create an instance using the builder patternProductDiscountValue Example to create an instance using the builder patternProductDiscountValueBuilder Example to create an instance using the builder patternThis mode determines the type of Prices used for price selection by Line Items and Products.possible values of ProductPriceModeEnumProductReferenceBuilder Example to create an instance using the builder patternReference to a ProductSelection.ProductSelectionReferenceBuilder Example to create an instance using the builder patternProductSelectionSetting Example to create an instance using the builder patternProductSelectionSettingBuilder Example to create an instance using the builder patternReference to a ProductType.ProductTypeReferenceBuilder Example to create an instance using the builder patternA concrete sellable good for which inventory can be tracked.The InventoryEntry information of the Product Variant.ProductVariantAvailabilityBuilder Example to create an instance using the builder patternProductVariantBuilder Example to create an instance using the builder patternProductVariantChannelAvailability Example to create an instance using the builder patternProductVariantChannelAvailabilityBuilder Example to create an instance using the builder patternJSON object where the keys are supply Channelid, and the values are ProductVariantChannelAvailability.ProductVariantChannelAvailabilityMapBuilder Example to create an instance using the builder patternOnly Product Variants with the explicitly listed SKUs are part of a Product Selection withIndividualExclusionProductSelectionMode.ProductVariantExclusionBuilder Example to create an instance using the builder patternPolymorphic base type for Product Variant Selections.ProductVariantSelectionBuilder Example to create an instance using the builder patternProductVariantSelectionTypeEnumpossible values of ProductVariantSelectionTypeEnumPredefined states tracking the status of the Quote Request in the negotiation process.possible values of QuoteRequestStatePredefined states tracking the status of the Quote.possible values of QuoteStateReference to a RecurrencePolicy.RecurrencePolicyReferenceBuilder Example to create an instance using the builder patternA Reference represents a loose reference to another resource in the same Project identified by itsid.ReferenceBuilderType of resource the value should reference.possible values of ReferenceTypeIdReservation Example to create an instance using the builder patternReservationBuilder Example to create an instance using the builder patternResourceIdentifier Example to create an instance using the builder patternResourceIdentifierBuilder Example to create an instance using the builder patternWith Types, you can model your own Custom Fields on the following resources and data types.possible values of ResourceTypeIdStores information about returns connected to an Order.ReturnInfoBuilder Example to create an instance using the builder patternReturnItem Example to create an instance using the builder patternReturnItemBuilder Example to create an instance using the builder patternReturnPaymentStatepossible values of ReturnPaymentStateReturnShipmentStatepossible values of ReturnShipmentStateReviewRatingStatistics Example to create an instance using the builder patternReviewRatingStatisticsBuilder Example to create an instance using the builder patternDetermines how monetary values are rounded.possible values of RoundingModeScoped Price is contained in a ProductVariant which is returned in response to a Product Projection Search request when Scoped Price Search is used.ScopedPriceBuilder Example to create an instance using the builder patternSearchKeyword Example to create an instance using the builder patternSearchKeywordBuilder Example to create an instance using the builder patternSearch keywords are JSON objects primarily used by Search Term Suggestions, but are also considered for a full text search in the Product Projection Search API.SearchKeywordsBuilder Example to create an instance using the builder patternDefines which matching items are to be discounted.possible values of SelectionModeIndicates the shipment status of the Order.possible values of ShipmentStateShipping Example to create an instance using the builder patternShippingBuilder Example to create an instance using the builder patternShippingInfo Example to create an instance using the builder patternShippingInfoBuilder Example to create an instance using the builder patternReference to a ShippingMethod.ShippingMethodReferenceBuilder Example to create an instance using the builder patternDetermines whether the selected ShippingMethod is allowed for the Cart.possible values of ShippingMethodStateShippingRate Example to create an instance using the builder patternShippingRateBuilder Example to create an instance using the builder patternShippingRateInput Example to create an instance using the builder patternShippingRateInputBuilder Example to create an instance using the builder patternShippingRatePriceTier Example to create an instance using the builder patternShippingRatePriceTierBuilder Example to create an instance using the builder patternShippingRateTierTypepossible values of ShippingRateTierTypeShoppingListLineItems are Line Items that contain references to ProductVariants in a Product.ShoppingListLineItemBuilder Example to create an instance using the builder patternIndicates both Product Discounts and Cart Discounts apply to a Cart and Order.StackingBuilder Example to create an instance using the builder patternDescribes how the Cart Discount interacts with other Discounts.possible values of StackingModePredefined states tracking the status of the Staged Quote.possible values of StagedQuoteStateStateReferenceBuilder Example to create an instance using the builder patternFor some resource types, a State can fulfill the following predefined roles:possible values of StateRoleEnumResource or object type the State can be assigned to.possible values of StateTypeEnumStoreCountry Example to create an instance using the builder patternStoreCountryBuilder Example to create an instance using the builder patternKeyReference to a Store.StoreKeyReferenceBuilder Example to create an instance using the builder patternIt is used to calculate the taxPortions field in a Cart or Order.SubRateBuilder Example to create an instance using the builder patternSuggestTokenizer Example to create an instance using the builder patternSuggestTokenizerBuilder Example to create an instance using the builder patternContains synchronization activity information of the Order (like export or import).SyncInfoBuilder Example to create an instance using the builder patternDetermines in which Tax calculation mode taxed prices are calculated.possible values of TaxCalculationModeReference to a TaxCategory.TaxCategoryReferenceBuilder Example to create an instance using the builder patternTaxedItemPrice Example to create an instance using the builder patternTaxedItemPriceBuilder Example to create an instance using the builder patternTaxedPrice Example to create an instance using the builder patternTaxedPriceBuilder Example to create an instance using the builder patternIndicates how taxes are set on the Cart.possible values of TaxModeThe tax portions are calculated from the TaxRates.TaxPortionBuilder Example to create an instance using the builder patternTaxRate Example to create an instance using the builder patternTaxRateBuilder Example to create an instance using the builder patternA text input hint is a string with one of the following values:possible values of TextInputHintTextLineItems are Line Items that use text values instead of references to Products.TextLineItemBuilder Example to create an instance using the builder patternInformation that helps track a Parcel.TrackingDataBuilder Example to create an instance using the builder patternRepresents a financial transaction typically created as a result of a notification from the payment service.TransactionBuilder Example to create an instance using the builder patternTransactions can be in one of the following States:possible values of TransactionStateTransactionTypepossible values of TransactionTypeBase polymorphic read-only money type that stores currency in cent precision or high precision, that is in sub-cents.TypedMoneyBuilderTypeReferenceBuilder Example to create an instance using the builder patternProvides a visual representation type for this field.possible values of TypeTextInputHintVariant Example to create an instance using the builder patternVariantBuilder Example to create an instance using the builder patternResourceIdentifier to a Zone.ZoneResourceIdentifierBuilder Example to create an instance using the builder pattern