history

package
v1.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 21, 2024 License: MIT Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source
const Version = "1.5.0"

Version identifies the current library version. Should match the git tag

Variables

View Source
var ErrNotFound = errors.New("resource not found")

Functions

func GetUserAgent

func GetUserAgent() string

Types

type AddAddressChange

type AddAddressChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue Address `json:"nextValue"`
}

* * Change triggered by the [Add Address](ctp:api:type:CustomerAddAddressAction) update action.

func (AddAddressChange) MarshalJSON

func (obj AddAddressChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddAssetChange

type AddAssetChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Asset `json:"previousValue"`
	// Value after the change.
	NextValue Asset `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Add Asset](ctp:api:type:CategoryAddAssetAction) on Categories. * - [Add Asset](ctp:api:type:ProductAddAssetAction) on Products. *

func (AddAssetChange) MarshalJSON

func (obj AddAssetChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddAssociateChange added in v1.5.0

type AddAssociateChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue Associate `json:"nextValue"`
}

* * Change triggered by the [Add Associate](ctp:api:type:BusinessUnitAddAssociateAction) update action.

func (AddAssociateChange) MarshalJSON added in v1.5.0

func (obj AddAssociateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddAttributeDefinitionChange

type AddAttributeDefinitionChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue AttributeDefinition `json:"nextValue"`
}

* * Change triggered by the [Add Attribute Definition](ctp:api:type:ProductTypeAddAttributeDefinitionAction) update action.

func (AddAttributeDefinitionChange) MarshalJSON

func (obj AddAttributeDefinitionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddBillingAddressIdChange

type AddBillingAddressIdChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []string `json:"previousValue"`
	// Value after the change.
	NextValue []string `json:"nextValue"`
	// Address added to `billingAddressIds`.
	Address Address `json:"address"`
}

* * Change triggered by the [Add Billing Address ID](ctp:api:type:CustomerAddBillingAddressIdAction) update action.

func (AddBillingAddressIdChange) MarshalJSON

func (obj AddBillingAddressIdChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddChannelRolesChange

type AddChannelRolesChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []ChannelRoleEnum `json:"previousValue"`
	// Value after the change.
	NextValue []ChannelRoleEnum `json:"nextValue"`
}

* * Change triggered by the [Add Roles](ctp:api:type:ChannelAddRolesAction) update action.

func (AddChannelRolesChange) MarshalJSON

func (obj AddChannelRolesChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddCustomLineItemChange

type AddCustomLineItemChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue CustomLineItem `json:"previousValue"`
	// Value after the change.
	NextValue CustomLineItem `json:"nextValue"`
}

* * Change triggered by the [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction) update action.

func (AddCustomLineItemChange) MarshalJSON

func (obj AddCustomLineItemChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddDeliveryChange

type AddDeliveryChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue DeliveryChangeValue `json:"previousValue"`
	// Value after the change.
	NextValue DeliveryChangeValue `json:"nextValue"`
}

* * Change triggered by the [Add Delivery](ctp:api:type:OrderAddDeliveryAction) update action.

func (AddDeliveryChange) MarshalJSON

func (obj AddDeliveryChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddDiscountCodeChange

type AddDiscountCodeChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue DiscountCodeInfo `json:"nextValue"`
}

* * Change triggered by the [Add DiscountCode](ctp:api:type:StagedOrderAddDiscountCodeAction) update action.

func (AddDiscountCodeChange) MarshalJSON

func (obj AddDiscountCodeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddEnumValueChange

type AddEnumValueChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue EnumValue `json:"nextValue"`
	// Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition).
	FieldName string `json:"fieldName"`
}

* * Change triggered by the [Add EnumValue to FieldDefinition](ctp:api:type:TypeAddEnumValueAction) update action.

func (AddEnumValueChange) MarshalJSON

func (obj AddEnumValueChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddExternalImageChange

type AddExternalImageChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []Image `json:"previousValue"`
	// Value after the change.
	NextValue []Image `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
}

* * Change triggered by the [Add External Image](ctp:api:type:ProductAddExternalImageAction) update action.

func (AddExternalImageChange) MarshalJSON

func (obj AddExternalImageChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddFieldDefinitionChange

type AddFieldDefinitionChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue FieldDefinition `json:"nextValue"`
}

* * Change triggered by the [Add FieldDefinition](ctp:api:type:TypeAddFieldDefinitionAction) update action.

func (AddFieldDefinitionChange) MarshalJSON

func (obj AddFieldDefinitionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddInheritedAssociateChange added in v1.5.0

type AddInheritedAssociateChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue InheritedAssociate `json:"nextValue"`
}

* * Change triggered by the [Add Associate](ctp:api:type:BusinessUnitAddAssociateAction) update action on a parent of a Business Unit in cases where [inheritance applies](/../api/associates-overview#conditions-for-inheritance).

func (AddInheritedAssociateChange) MarshalJSON added in v1.5.0

func (obj AddInheritedAssociateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddInterfaceInteractionChange

type AddInterfaceInteractionChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue CustomFieldExpandedValue `json:"nextValue"`
}

* * Change triggered by the [Add InterfaceInteraction](ctp:api:type:PaymentAddInterfaceInteractionAction) update action.

func (AddInterfaceInteractionChange) MarshalJSON

func (obj AddInterfaceInteractionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddItemShippingAddressesChange

type AddItemShippingAddressesChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Address `json:"previousValue"`
	// Value after the change.
	NextValue Address `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Add ItemShippingAddress](ctp:api:type:OrderAddItemShippingAddressAction) on Orders. * - [Add ItemShippingAddress](ctp:api:type:StagedOrderAddItemShippingAddressAction) on Staged Orders. *

func (AddItemShippingAddressesChange) MarshalJSON

func (obj AddItemShippingAddressesChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddLocalizedEnumValueChange

type AddLocalizedEnumValueChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue AttributeLocalizedEnumValue `json:"nextValue"`
	// Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition); only present on changes to Types.
	FieldName string `json:"fieldName"`
	// Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition); only present on changes to Product Types.
	AttributeName string `json:"attributeName"`
}

* * Change triggered by the following update actions: * * - [Add LocalizableEnumValue to AttributeDefinition](ctp:api:type:ProductTypeAddLocalizedEnumValueAction) on Product Types. * - [Add LocalizedEnumValue to FieldDefinition](ctp:api:type:TypeAddLocalizedEnumValueAction) on Types. *

func (AddLocalizedEnumValueChange) MarshalJSON

func (obj AddLocalizedEnumValueChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddLocationChange

type AddLocationChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue Location `json:"nextValue"`
}

* * Change triggered by the [Add Location](ctp:api:type:ZoneAddLocationAction) update action.

func (AddLocationChange) MarshalJSON

func (obj AddLocationChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddOrderLineItemChange

type AddOrderLineItemChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LineItem `json:"previousValue"`
	// Value after the change.
	NextValue LineItem `json:"nextValue"`
}

* * Change triggered by the [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction) update action.

func (AddOrderLineItemChange) MarshalJSON

func (obj AddOrderLineItemChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddParcelToDeliveryChange

type AddParcelToDeliveryChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue Parcel `json:"nextValue"`
	// `id` of the [Delivery](ctp:api:type:Delivery) to which the Parcel was added.
	DeliveryId string `json:"deliveryId"`
}

* * Change triggered by the following update actions: * * - [Add Parcel](ctp:api:type:OrderAddParcelToDeliveryAction) on Orders. * - [Add Parcel](ctp:api:type:StagedOrderAddParcelToDeliveryAction) on Staged Orders. *

func (AddParcelToDeliveryChange) MarshalJSON

func (obj AddParcelToDeliveryChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddPaymentChange

type AddPaymentChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue PaymentInfo `json:"previousValue"`
	// Value after the change.
	NextValue PaymentInfo `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Add Payment](ctp:api:type:OrderAddPaymentAction) on Orders. * - [Add Payment](ctp:api:type:StagedOrderAddPaymentAction) on Staged Orders. *

func (AddPaymentChange) MarshalJSON

func (obj AddPaymentChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddPlainEnumValueChange

type AddPlainEnumValueChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue AttributePlainEnumValue `json:"nextValue"`
	// Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition).
	AttributeName string `json:"attributeName"`
}

* * Change triggered by the [Add PlainEnumValue to AttributeDefinition](ctp:api:type:ProductTypeAddPlainEnumValueAction) update action.

func (AddPlainEnumValueChange) MarshalJSON

func (obj AddPlainEnumValueChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddPriceChange

type AddPriceChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue Price `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
	// `id` of the Embedded [Price](ctp:api:type:Price).
	PriceId string `json:"priceId"`
}

* * Change triggered by the [Add Price](ctp:api:type:ProductAddPriceAction) update action.

func (AddPriceChange) MarshalJSON

func (obj AddPriceChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddProductChange added in v1.2.0

type AddProductChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue Reference `json:"nextValue"`
	// The [Product Variants](ctp:api:type:ProductVariant) included in the [Product Selection](ctp:api:type:ProductSelection).
	VariantSelection ProductVariantSelection `json:"variantSelection"`
}

* * Change triggered by the [Add Product](ctp:api:type:ProductSelectionAddProductAction) update action.

func (AddProductChange) MarshalJSON added in v1.2.0

func (obj AddProductChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddProductSelectionChange added in v1.5.0

type AddProductSelectionChange struct {
	Change        string                  `json:"change"`
	PreviousValue ProductSelectionSetting `json:"previousValue"`
	NextValue     ProductSelectionSetting `json:"nextValue"`
}

* * Change triggered by the [Add Product Selection](ctp:api:type:StoreAddProductSelectionAction) update action.

func (AddProductSelectionChange) MarshalJSON added in v1.5.0

func (obj AddProductSelectionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddPropertyChange

type AddPropertyChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue interface{} `json:"nextValue"`
	// Path to the new property that was added.
	Path string `json:"path"`
}

* * Change triggered by the [Update CustomObject](ctp:api:endpoint:/{projectKey}/custom-objects:POST) request when a new property is added.

func (AddPropertyChange) MarshalJSON

func (obj AddPropertyChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddReturnInfoChange

type AddReturnInfoChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue ReturnInfo `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Add ReturnInfo](ctp:api:type:OrderAddReturnInfoAction) on Orders. * - [Add ReturnInfo](ctp:api:type:StagedOrderAddReturnInfoAction) on Staged Orders. *

func (AddReturnInfoChange) MarshalJSON

func (obj AddReturnInfoChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddShippingAddressIdChange

type AddShippingAddressIdChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []string `json:"previousValue"`
	// Value after the change.
	NextValue []string `json:"nextValue"`
	// Address added to `shippingAddressIds`.
	Address Address `json:"address"`
}

* * Change triggered by the [Add Shipping Address ID](ctp:api:type:CustomerAddShippingAddressIdAction) update action.

func (AddShippingAddressIdChange) MarshalJSON

func (obj AddShippingAddressIdChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddShoppingListLineItemChange

type AddShoppingListLineItemChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LineItem `json:"previousValue"`
	// Value after the change.
	NextValue LineItem `json:"nextValue"`
}

* * Change triggered by the [Add ShoppingListLineItem](ctp:api:type:ShoppingListAddLineItemAction) update action.

func (AddShoppingListLineItemChange) MarshalJSON

func (obj AddShoppingListLineItemChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddStateRolesChange

type AddStateRolesChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []StateRoleEnum `json:"previousValue"`
	// Value after the change.
	NextValue []StateRoleEnum `json:"nextValue"`
}

* * Change triggered by the [Add State roles](ctp:api:type:StateAddRolesAction) update action.

func (AddStateRolesChange) MarshalJSON

func (obj AddStateRolesChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddTaxRateChange

type AddTaxRateChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue TaxRate `json:"nextValue"`
}

* * Change triggered by the [Add TaxRate](ctp:api:type:TaxCategoryAddTaxRateAction) update action.

func (AddTaxRateChange) MarshalJSON

func (obj AddTaxRateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddTextLineItemChange

type AddTextLineItemChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue TextLineItem `json:"nextValue"`
}

* * Change triggered by the [Add TextLineItem](ctp:api:type:ShoppingListAddTextLineItemAction) update action.

func (AddTextLineItemChange) MarshalJSON

func (obj AddTextLineItemChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddToCategoryChange

type AddToCategoryChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []Reference `json:"previousValue"`
	// Value after the change.
	NextValue []Reference `json:"nextValue"`
	// Category to which the Product was added.
	Category Reference `json:"category"`
}

* * Change triggered by the [Add to Category](ctp:api:type:ProductAddToCategoryAction) update action.

func (AddToCategoryChange) MarshalJSON

func (obj AddToCategoryChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddTransactionChange

type AddTransactionChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue Transaction `json:"nextValue"`
}

* * Change triggered by the [Add Transaction](ctp:api:type:PaymentAddTransactionAction) update action.

func (AddTransactionChange) MarshalJSON

func (obj AddTransactionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AddVariantChange

type AddVariantChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Variant `json:"previousValue"`
	// Value after the change.
	NextValue Variant `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
}

* * Change triggered by the [Add ProductVariant](ctp:api:type:ProductAddVariantAction) update action.

func (AddVariantChange) MarshalJSON

func (obj AddVariantChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type Address

type Address struct {
	// Unique ID of the Address.
	ID                   string `json:"id"`
	Key                  string `json:"key"`
	Title                string `json:"title"`
	Salutation           string `json:"salutation"`
	FirstName            string `json:"firstName"`
	LastName             string `json:"lastName"`
	StreetName           string `json:"streetName"`
	StreetNumber         string `json:"streetNumber"`
	AdditionalStreetInfo string `json:"additionalStreetInfo"`
	PostalCode           string `json:"postalCode"`
	City                 string `json:"city"`
	Region               string `json:"region"`
	State                string `json:"state"`
	// Two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
	Country               string `json:"country"`
	Company               string `json:"company"`
	Department            string `json:"department"`
	Building              string `json:"building"`
	Apartment             string `json:"apartment"`
	POBox                 string `json:"pOBox"`
	Phone                 string `json:"phone"`
	Mobile                string `json:"mobile"`
	Email                 string `json:"email"`
	Fax                   string `json:"fax"`
	AdditionalAddressInfo string `json:"additionalAddressInfo"`
	ExternalId            string `json:"externalId"`
}

type Asset

type Asset struct {
	ID          string          `json:"id"`
	Name        LocalizedString `json:"name"`
	Description LocalizedString `json:"description"`
	Custom      CustomFields    `json:"custom"`
	Key         string          `json:"key"`
}

type AssetChangeValue

type AssetChangeValue struct {
	// `id` of the [Asset](ctp:api:type:Asset).
	ID string `json:"id"`
	// Name of the Asset.
	Name LocalizedString `json:"name"`
}

type AssetDimensions

type AssetDimensions struct {
	W int `json:"w"`
	H int `json:"h"`
}

type AssetSource

type AssetSource struct {
	Uri         string          `json:"uri"`
	Key         string          `json:"key"`
	Dimensions  AssetDimensions `json:"dimensions"`
	ContentType string          `json:"contentType"`
}

type Associate added in v1.5.0

type Associate struct {
	AssociateRoleAssignments []AssociateRoleAssignment `json:"associateRoleAssignments"`
	Customer                 Reference                 `json:"customer"`
}

type AssociateRoleAssignment added in v1.5.0

type AssociateRoleAssignment struct {
	AssociateRole KeyReference `json:"associateRole"`
	// Determines whether an [AssociateRoleAssignment](ctp:api:type:AssociateRoleAssignment) can be inherited by child Business Units.
	Inheritance AssociateRoleInheritanceMode `json:"inheritance"`
}

type AssociateRoleInheritanceMode added in v1.5.0

type AssociateRoleInheritanceMode string

* * Determines whether an AssociateRoleAssignment(ctp:api:type:AssociateRoleAssignment) can be inherited by child Business Units.

const (
	AssociateRoleInheritanceModeEnabled  AssociateRoleInheritanceMode = "Enabled"
	AssociateRoleInheritanceModeDisabled AssociateRoleInheritanceMode = "Disabled"
)

type AssociateRoleLabel added in v1.5.0

type AssociateRoleLabel struct {
	// User-defined unique identifier of the [Associate Role](ctp:api:type:AssociateRole).
	Key string `json:"key"`
	// Name of the Associate Role.
	Name string `json:"name"`
}

func (AssociateRoleLabel) MarshalJSON added in v1.5.0

func (obj AssociateRoleLabel) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type AttributeConstraintEnum

type AttributeConstraintEnum string
const (
	AttributeConstraintEnumNone              AttributeConstraintEnum = "None"
	AttributeConstraintEnumUnique            AttributeConstraintEnum = "Unique"
	AttributeConstraintEnumCombinationUnique AttributeConstraintEnum = "CombinationUnique"
	AttributeConstraintEnumSameForAll        AttributeConstraintEnum = "SameForAll"
)

type AttributeDefinition

type AttributeDefinition struct {
	Type AttributeType `json:"type"`
	// The unique name of the attribute used in the API. The name must be between two and 256 characters long and can contain the ASCII letters A to Z in lowercase or uppercase, digits, underscores (`_`) and the hyphen-minus (`-`). When using the same `name` for an attribute in two or more product types all fields of the AttributeDefinition of this attribute need to be the same across the product types, otherwise an AttributeDefinitionAlreadyExists error code will be returned. An exception to this are the values of an `enum` or `lenum` type and sets thereof.
	Name  string          `json:"name"`
	Label LocalizedString `json:"label"`
	// Whether the attribute is required to have a value.
	IsRequired          bool                    `json:"isRequired"`
	AttributeConstraint AttributeConstraintEnum `json:"attributeConstraint"`
	InputTip            LocalizedString         `json:"inputTip"`
	InputHint           TextInputHint           `json:"inputHint"`
	// Whether the attribute's values should generally be enabled in product search. This determines whether the value is stored in products for matching terms in the context of full-text search queries  and can be used in facets & filters as part of product search queries. The exact features that are enabled/disabled with this flag depend on the concrete attribute type and are described there. The max size of a searchable field is **restricted to 10922 characters**. This constraint is enforced at both product creation and product update. If the length of the input exceeds the maximum size an InvalidField error is returned.
	IsSearchable bool `json:"isSearchable"`
}

type AttributeLocalizedEnumValue added in v1.5.0

type AttributeLocalizedEnumValue struct {
	// Key of the value used as a programmatic identifier, for example in facets & filters.
	Key string `json:"key"`
	// Descriptive, localized label of the value.
	Label LocalizedString `json:"label"`
}

* * A localized enum value must be unique within the enum, else a [DuplicateEnumValues](ctp:api:type:DuplicateEnumValuesError) error is returned. *

type AttributePlainEnumValue added in v1.5.0

type AttributePlainEnumValue struct {
	// Key of the value used as a programmatic identifier, for example in facets & filters.
	Key string `json:"key"`
	// Descriptive label of the value.
	Label string `json:"label"`
}

* * A plain enum value must be unique within the enum, else a [DuplicateEnumValues](ctp:api:type:DuplicateEnumValuesError) error is returned. *

type AttributeType

type AttributeType struct {
	Name string `json:"name"`
}

type AttributeValue

type AttributeValue struct {
	// Name of the Attribute set.
	Name string `json:"name"`
	// Value set for the Attribute determined by the [AttributeType](ctp:api:type:AttributeType):
	//
	// - For [Enum Type](ctp:api:type:AttributeEnumType) and [Localized Enum Type](ctp:api:type:AttributeLocalizedEnumType), `value` is the `key` of the [Plain Enum Value](ctp:api:type:AttributePlainEnumValue) or [Localized Enum Value](ctp:api:type:AttributeLocalizedEnumValue) objects,
	//   or the complete objects.
	// - For [Localizable Text Type](ctp:api:type:AttributeLocalizableTextType), `value` is the [LocalizedString](ctp:api:type:LocalizedString) object.
	// - For [Money Type](ctp:api:type:AttributeMoneyType) Attributes, `value` is the [Money](ctp:api:type:Money) object.
	// - For [Set Type](ctp:api:type:AttributeSetType) Attributes, `value` is the entire `set` object.
	// - For [Nested Type](ctp:api:type:AttributeNestedType) Attributes, `value` is the list of values of all Attributes of the nested Product.
	// - For [Reference Type](ctp:api:type:AttributeReferenceType) Attributes, `value` is the [Reference](ctp:api:type:Reference) object.
	Value interface{} `json:"value"`
}

type AuthenticationMode added in v1.2.0

type AuthenticationMode string
const (
	AuthenticationModePassword     AuthenticationMode = "Password"
	AuthenticationModeExternalAuth AuthenticationMode = "ExternalAuth"
)

type BusinessUnitAssociateMode added in v1.5.0

type BusinessUnitAssociateMode string

* * Determines whether a Business Unit can inherit Associates from a parent.

const (
	BusinessUnitAssociateModeExplicit              BusinessUnitAssociateMode = "Explicit"
	BusinessUnitAssociateModeExplicitAndFromParent BusinessUnitAssociateMode = "ExplicitAndFromParent"
)

type BusinessUnitLabel added in v1.5.0

type BusinessUnitLabel struct {
	// User-defined unique identifier of the [Business Unit](ctp:api:type:BusinessUnit).
	Key string `json:"key"`
	// Name of the Business Unit.
	Name string `json:"name"`
}

func (BusinessUnitLabel) MarshalJSON added in v1.5.0

func (obj BusinessUnitLabel) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type BusinessUnitStatus added in v1.5.0

type BusinessUnitStatus string

* * Indicates whether the Business Unit can be edited and used in [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quote Requests](ctp:api:type:QuoteRequest), or [Quotes](ctp:api:type:Quote).

const (
	BusinessUnitStatusActive   BusinessUnitStatus = "Active"
	BusinessUnitStatusInactive BusinessUnitStatus = "Inactive"
)

type BusinessUnitStoreMode added in v1.5.0

type BusinessUnitStoreMode string

* * Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from its parent unit.

const (
	BusinessUnitStoreModeExplicit   BusinessUnitStoreMode = "Explicit"
	BusinessUnitStoreModeFromParent BusinessUnitStoreMode = "FromParent"
)

type ByProjectKeyByResourceTypeByIDRequestBuilder

type ByProjectKeyByResourceTypeByIDRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyByResourceTypeByIDRequestBuilder) Get

* * The `view_audit_log:{projectKey}` scope is required, and depending on the [resource type](ctp:history:type:ChangeHistoryResourceType) queried, their respective scopes must be granted.

type ByProjectKeyByResourceTypeByIDRequestMethodGet

type ByProjectKeyByResourceTypeByIDRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) AssociateId added in v1.5.0

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) BusinessUnit added in v1.5.0

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) Changes

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) ClientId

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) CustomerId

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) DateFrom

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) DateTo

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) Dump

func (r *ByProjectKeyByResourceTypeByIDRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) ExcludePlatformInitiatedChanges

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) Execute

* * The `view_audit_log:{projectKey}` scope is required, and depending on the [resource type](ctp:history:type:ChangeHistoryResourceType) queried, their respective scopes must be granted.

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) Expand

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) Limit

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) Offset

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) Source

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) Stores

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) Type

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) UserId

func (*ByProjectKeyByResourceTypeByIDRequestMethodGet) WithHeaders

type ByProjectKeyByResourceTypeByIDRequestMethodGetInput

type ByProjectKeyByResourceTypeByIDRequestMethodGetInput struct {
	DateFrom                        *interface{}
	DateTo                          *interface{}
	Limit                           *int
	Offset                          *int
	UserId                          *string
	ClientId                        *string
	CustomerId                      *string
	AssociateId                     *string
	BusinessUnit                    *string
	Type                            *string
	Source                          *string
	Changes                         []string
	Stores                          []string
	ExcludePlatformInitiatedChanges []PlatformInitiatedChange
	Expand                          *bool
}

func (*ByProjectKeyByResourceTypeByIDRequestMethodGetInput) Values

type ByProjectKeyByResourceTypeRequestBuilder

type ByProjectKeyByResourceTypeRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyByResourceTypeRequestBuilder) Get

* * The `view_audit_log:{projectKey}` scope is required, and depending on the [resource type](ctp:history:type:ChangeHistoryResourceType) queried, their respective scopes must be granted.

func (*ByProjectKeyByResourceTypeRequestBuilder) WithIdValue

type ByProjectKeyByResourceTypeRequestMethodGet

type ByProjectKeyByResourceTypeRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyByResourceTypeRequestMethodGet) AssociateId added in v1.5.0

func (*ByProjectKeyByResourceTypeRequestMethodGet) BusinessUnit added in v1.5.0

func (*ByProjectKeyByResourceTypeRequestMethodGet) Changes

func (*ByProjectKeyByResourceTypeRequestMethodGet) ClientId

func (*ByProjectKeyByResourceTypeRequestMethodGet) CustomerId

func (*ByProjectKeyByResourceTypeRequestMethodGet) DateFrom

func (*ByProjectKeyByResourceTypeRequestMethodGet) DateTo

func (*ByProjectKeyByResourceTypeRequestMethodGet) Dump

func (r *ByProjectKeyByResourceTypeRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyByResourceTypeRequestMethodGet) ExcludePlatformInitiatedChanges

func (*ByProjectKeyByResourceTypeRequestMethodGet) Execute

* * The `view_audit_log:{projectKey}` scope is required, and depending on the [resource type](ctp:history:type:ChangeHistoryResourceType) queried, their respective scopes must be granted.

func (*ByProjectKeyByResourceTypeRequestMethodGet) Expand

func (*ByProjectKeyByResourceTypeRequestMethodGet) Limit

func (*ByProjectKeyByResourceTypeRequestMethodGet) Offset

func (*ByProjectKeyByResourceTypeRequestMethodGet) ResourceKey added in v1.5.0

func (*ByProjectKeyByResourceTypeRequestMethodGet) Source

func (*ByProjectKeyByResourceTypeRequestMethodGet) Stores

func (*ByProjectKeyByResourceTypeRequestMethodGet) Type

func (*ByProjectKeyByResourceTypeRequestMethodGet) UserId

func (*ByProjectKeyByResourceTypeRequestMethodGet) WithHeaders

type ByProjectKeyByResourceTypeRequestMethodGetInput

type ByProjectKeyByResourceTypeRequestMethodGetInput struct {
	DateFrom                        *interface{}
	DateTo                          *interface{}
	Limit                           *int
	Offset                          *int
	UserId                          *string
	ClientId                        *string
	CustomerId                      *string
	AssociateId                     *string
	BusinessUnit                    *string
	Type                            *string
	ResourceKey                     *string
	Source                          *string
	Changes                         []string
	Stores                          []string
	ExcludePlatformInitiatedChanges []PlatformInitiatedChange
	Expand                          *bool
}

func (*ByProjectKeyByResourceTypeRequestMethodGetInput) Values

type ByProjectKeyRequestBuilder

type ByProjectKeyRequestBuilder struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyRequestBuilder) Get

* * The `view_audit_log:{projectKey}` scope is required, and depending on the [resource type](ctp:history:type:ChangeHistoryResourceType) queried, their respective scopes must be granted.

func (*ByProjectKeyRequestBuilder) WithResourceTypeValue

func (rb *ByProjectKeyRequestBuilder) WithResourceTypeValue(resourceType string) *ByProjectKeyByResourceTypeRequestBuilder

type ByProjectKeyRequestMethodGet

type ByProjectKeyRequestMethodGet struct {
	// contains filtered or unexported fields
}

func (*ByProjectKeyRequestMethodGet) AssociateId added in v1.5.0

func (*ByProjectKeyRequestMethodGet) BusinessUnit added in v1.5.0

func (*ByProjectKeyRequestMethodGet) Changes

func (*ByProjectKeyRequestMethodGet) ClientId

func (*ByProjectKeyRequestMethodGet) CustomerId

func (*ByProjectKeyRequestMethodGet) DateFrom

func (rb *ByProjectKeyRequestMethodGet) DateFrom(v interface{}) *ByProjectKeyRequestMethodGet

func (*ByProjectKeyRequestMethodGet) DateTo

func (*ByProjectKeyRequestMethodGet) Dump

func (r *ByProjectKeyRequestMethodGet) Dump() map[string]interface{}

func (*ByProjectKeyRequestMethodGet) ExcludePlatformInitiatedChanges

func (rb *ByProjectKeyRequestMethodGet) ExcludePlatformInitiatedChanges(v []PlatformInitiatedChange) *ByProjectKeyRequestMethodGet

func (*ByProjectKeyRequestMethodGet) Execute

* * The `view_audit_log:{projectKey}` scope is required, and depending on the [resource type](ctp:history:type:ChangeHistoryResourceType) queried, their respective scopes must be granted.

func (*ByProjectKeyRequestMethodGet) Expand

func (*ByProjectKeyRequestMethodGet) Limit

func (*ByProjectKeyRequestMethodGet) Offset

func (*ByProjectKeyRequestMethodGet) ResourceId

func (*ByProjectKeyRequestMethodGet) ResourceKey added in v1.5.0

func (*ByProjectKeyRequestMethodGet) ResourceTypes added in v1.3.0

func (*ByProjectKeyRequestMethodGet) Source

func (*ByProjectKeyRequestMethodGet) Stores

func (*ByProjectKeyRequestMethodGet) Type

func (*ByProjectKeyRequestMethodGet) UserId

func (*ByProjectKeyRequestMethodGet) WithHeaders

func (*ByProjectKeyRequestMethodGet) WithQueryParams

type ByProjectKeyRequestMethodGetInput

type ByProjectKeyRequestMethodGetInput struct {
	ResourceTypes                   []ChangeHistoryResourceType
	DateFrom                        *interface{}
	DateTo                          *interface{}
	Limit                           *int
	Offset                          *int
	UserId                          *string
	ClientId                        *string
	CustomerId                      *string
	AssociateId                     *string
	BusinessUnit                    *string
	Type                            *string
	ResourceId                      *string
	ResourceKey                     *string
	Source                          *string
	Changes                         []string
	Stores                          []string
	ExcludePlatformInitiatedChanges []PlatformInitiatedChange
	Expand                          *bool
}

func (*ByProjectKeyRequestMethodGetInput) Values

type CategoryOrderHints

type CategoryOrderHints map[string]string

type Change

type Change interface{}

* * Difference between the previous and next version of a resource represented by `previousValue` (omitted, for example, on creations) and `nextValue` of the associated change. A Change can also contain extra fields that provide further information. * * They are not identical to the actual update actions sent. *

type ChangeAddressChange

type ChangeAddressChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Address `json:"previousValue"`
	// Value after the change.
	NextValue Address `json:"nextValue"`
}

* * Change triggered by the [Change Address](ctp:api:type:CustomerChangeAddressAction) update action.

func (ChangeAddressChange) MarshalJSON

func (obj ChangeAddressChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeAmountAuthorizedChange

type ChangeAmountAuthorizedChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Money `json:"previousValue"`
	// Value after the change.
	NextValue Money `json:"nextValue"`
}

* * Change triggered automatically due to a user-initiated change.

func (ChangeAmountAuthorizedChange) MarshalJSON

func (obj ChangeAmountAuthorizedChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeAmountPlannedChange

type ChangeAmountPlannedChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Money `json:"previousValue"`
	// Value after the change.
	NextValue Money `json:"nextValue"`
}

* * Change triggered by the [Change AmountPlanned](ctp:api:type:PaymentChangeAmountPlannedAction) update action.

func (ChangeAmountPlannedChange) MarshalJSON

func (obj ChangeAmountPlannedChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeAssetNameChange

type ChangeAssetNameChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
	// Information about the updated Asset.
	Asset AssetChangeValue `json:"asset"`
}

* * Change triggered by the following update actions: * * - [Change Asset Name](ctp:api:type:CategoryChangeAssetNameAction) on Categories. * - [Change Asset Name](ctp:api:type:ProductChangeAssetNameAction) on Products. *

func (ChangeAssetNameChange) MarshalJSON

func (obj ChangeAssetNameChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeAssetOrderChange

type ChangeAssetOrderChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue []LocalizedString `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Change Asset Order](ctp:api:type:CategoryChangeAssetOrderAction) on Categories. * - [Change Asset Order](ctp:api:type:ProductChangeAssetOrderAction) on Products. *

func (ChangeAssetOrderChange) MarshalJSON

func (obj ChangeAssetOrderChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeAssociateChange added in v1.5.0

type ChangeAssociateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Associate `json:"previousValue"`
	// Value after the change.
	NextValue Associate `json:"nextValue"`
}

* * Change triggered by the [Change Associate](ctp:api:type:BusinessUnitChangeAssociateAction) update action.

func (ChangeAssociateChange) MarshalJSON added in v1.5.0

func (obj ChangeAssociateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeAssociateModeChange added in v1.5.0

type ChangeAssociateModeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue BusinessUnitAssociateMode `json:"previousValue"`
	// Value after the change.
	NextValue BusinessUnitAssociateMode `json:"nextValue"`
}

* * Change triggered by the [Change Associate Mode](ctp:api:type:BusinessUnitChangeAssociateModeAction) update action.

func (ChangeAssociateModeChange) MarshalJSON added in v1.5.0

func (obj ChangeAssociateModeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeAttributeConstraintChange

type ChangeAttributeConstraintChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue AttributeConstraintEnum `json:"previousValue"`
	// Value after the change.
	NextValue AttributeConstraintEnum `json:"nextValue"`
	// Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition).
	AttributeName string `json:"attributeName"`
}

* * Change triggered by the [Change AttributeDefinition AttributeConstraint](ctp:api:type:ProductTypeChangeAttributeConstraintAction) update action.

func (ChangeAttributeConstraintChange) MarshalJSON

func (obj ChangeAttributeConstraintChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeAttributeOrderByNameChange

type ChangeAttributeOrderByNameChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []string `json:"previousValue"`
	// Value after the change.
	NextValue []string `json:"nextValue"`
}

* * Change triggered by the [Change the order of AttributeDefinitions](ctp:api:type:ProductTypeChangeAttributeOrderByNameAction) update action.

func (ChangeAttributeOrderByNameChange) MarshalJSON

func (obj ChangeAttributeOrderByNameChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeBuyerAssignableChange added in v1.5.0

type ChangeBuyerAssignableChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue bool `json:"previousValue"`
	// Value after the change.
	NextValue bool `json:"nextValue"`
}

* * Change triggered by the [Change BuyerAssignable](ctp:api:type:AssociateRoleChangeBuyerAssignableAction) update action. *

func (ChangeBuyerAssignableChange) MarshalJSON added in v1.5.0

func (obj ChangeBuyerAssignableChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeCartDiscountsChange

type ChangeCartDiscountsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []Reference `json:"previousValue"`
	// Value after the change.
	NextValue []Reference `json:"nextValue"`
}

* * Change triggered by the [Change CartDiscounts](ctp:api:type:DiscountCodeChangeCartDiscountsAction) update action.

func (ChangeCartDiscountsChange) MarshalJSON

func (obj ChangeCartDiscountsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeCartPredicateChange

type ChangeCartPredicateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Change Cart Predicate](ctp:api:type:CartDiscountChangeCartPredicateAction) update action.

func (ChangeCartPredicateChange) MarshalJSON

func (obj ChangeCartPredicateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeCustomLineItemQuantityChange

type ChangeCustomLineItemQuantityChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue int `json:"previousValue"`
	// Value after the change.
	NextValue int `json:"nextValue"`
	// Name of the CustomLineItem.
	CustomLineItem LocalizedString `json:"customLineItem"`
	// `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
}

* * Change triggered by the [Change CustomLineItem Quantity](ctp:api:type:StagedOrderChangeCustomLineItemQuantityAction) update action.

func (ChangeCustomLineItemQuantityChange) MarshalJSON

func (obj ChangeCustomLineItemQuantityChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeDescriptionChange

type ChangeDescriptionChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Change Description](ctp:api:type:ProductTypeChangeDescriptionAction) update action. *

func (ChangeDescriptionChange) MarshalJSON

func (obj ChangeDescriptionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeEmailChange

type ChangeEmailChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Change Email](ctp:api:type:CustomerChangeEmailAction) update action.

func (ChangeEmailChange) MarshalJSON

func (obj ChangeEmailChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeEnumValueLabelChange

type ChangeEnumValueLabelChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
	// Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition).
	FieldName string `json:"fieldName"`
	// Key of the updated values.
	ValueKey string `json:"valueKey"`
}

* * Change triggered by the [Change EnumValue Label](ctp:api:type:TypeChangeEnumValueLabelAction) update action.

func (ChangeEnumValueLabelChange) MarshalJSON

func (obj ChangeEnumValueLabelChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeEnumValueOrderChange

type ChangeEnumValueOrderChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []EnumValue `json:"previousValue"`
	// Value after the change.
	NextValue []EnumValue `json:"nextValue"`
	// Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition).
	FieldName string `json:"fieldName"`
}

* * Change triggered by the [Change the order of EnumValues](ctp:api:type:TypeChangeEnumValueOrderAction) update action.

func (ChangeEnumValueOrderChange) MarshalJSON

func (obj ChangeEnumValueOrderChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeFieldDefinitionOrderChange

type ChangeFieldDefinitionOrderChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []FieldDefinitionOrderValue `json:"previousValue"`
	// Value after the change.
	NextValue []FieldDefinitionOrderValue `json:"nextValue"`
}

* * Change triggered by the [Change the order of FieldDefinitions](ctp:api:type:TypeChangeFieldDefinitionOrderAction) update action.

func (ChangeFieldDefinitionOrderChange) MarshalJSON

func (obj ChangeFieldDefinitionOrderChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeGroupsChange

type ChangeGroupsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []string `json:"previousValue"`
	// Value after the change.
	NextValue []string `json:"nextValue"`
}

* * Change triggered by the [Change Groups](ctp:api:type:DiscountCodeChangeGroupsAction) update action.

func (ChangeGroupsChange) MarshalJSON

func (obj ChangeGroupsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeHistoryResourceType

type ChangeHistoryResourceType string

* * This data type represents the supported resource types. * The value must be one of the following: *

const (
	ChangeHistoryResourceTypeAssociateRole    ChangeHistoryResourceType = "associate-role"
	ChangeHistoryResourceTypeBusinessUnit     ChangeHistoryResourceType = "business-unit"
	ChangeHistoryResourceTypeCartDiscount     ChangeHistoryResourceType = "cart-discount"
	ChangeHistoryResourceTypeCategory         ChangeHistoryResourceType = "category"
	ChangeHistoryResourceTypeChannel          ChangeHistoryResourceType = "channel"
	ChangeHistoryResourceTypeCustomer         ChangeHistoryResourceType = "customer"
	ChangeHistoryResourceTypeCustomerGroup    ChangeHistoryResourceType = "customer-group"
	ChangeHistoryResourceTypeDiscountCode     ChangeHistoryResourceType = "discount-code"
	ChangeHistoryResourceTypeInventoryEntry   ChangeHistoryResourceType = "inventory-entry"
	ChangeHistoryResourceTypeKeyValueDocument ChangeHistoryResourceType = "key-value-document"
	ChangeHistoryResourceTypeOrder            ChangeHistoryResourceType = "order"
	ChangeHistoryResourceTypePayment          ChangeHistoryResourceType = "payment"
	ChangeHistoryResourceTypeProduct          ChangeHistoryResourceType = "product"
	ChangeHistoryResourceTypeProductDiscount  ChangeHistoryResourceType = "product-discount"
	ChangeHistoryResourceTypeProductSelection ChangeHistoryResourceType = "product-selection"
	ChangeHistoryResourceTypeProductType      ChangeHistoryResourceType = "product-type"
	ChangeHistoryResourceTypeQuoteRequest     ChangeHistoryResourceType = "quote-request"
	ChangeHistoryResourceTypeQuote            ChangeHistoryResourceType = "quote"
	ChangeHistoryResourceTypeReview           ChangeHistoryResourceType = "review"
	ChangeHistoryResourceTypeShoppingList     ChangeHistoryResourceType = "shopping-list"
	ChangeHistoryResourceTypeStagedQuote      ChangeHistoryResourceType = "staged-quote"
	ChangeHistoryResourceTypeState            ChangeHistoryResourceType = "state"
	ChangeHistoryResourceTypeStore            ChangeHistoryResourceType = "store"
	ChangeHistoryResourceTypeTaxCategory      ChangeHistoryResourceType = "tax-category"
	ChangeHistoryResourceTypeType             ChangeHistoryResourceType = "type"
	ChangeHistoryResourceTypeZone             ChangeHistoryResourceType = "zone"
)

type ChangeInheritedAssociateChange added in v1.5.0

type ChangeInheritedAssociateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue InheritedAssociate `json:"previousValue"`
	// Value after the change.
	NextValue InheritedAssociate `json:"nextValue"`
}

* * Change triggered by the [Change Associate](ctp:api:type:BusinessUnitChangeAssociateAction) update action on a parent of a Business Unit in cases where [inheritance applies](/../api/associates-overview#conditions-for-inheritance).

func (ChangeInheritedAssociateChange) MarshalJSON added in v1.5.0

func (obj ChangeInheritedAssociateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeInitialChange

type ChangeInitialChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue bool `json:"previousValue"`
	// Value after the change.
	NextValue bool `json:"nextValue"`
}

* * Change triggered by the [Change initial State](ctp:api:type:StateChangeInitialAction) update action.

func (ChangeInitialChange) MarshalJSON

func (obj ChangeInitialChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeInputHintChange

type ChangeInputHintChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue TextInputHint `json:"previousValue"`
	// Value after the change.
	NextValue TextInputHint `json:"nextValue"`
	// Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition); only present on changes to Types.
	FieldName string `json:"fieldName"`
	// Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition); only present on changes to Product Types.
	AttributeName string `json:"attributeName"`
}

* * Change triggered by the following update actions: * * - [Change AttributeDefinition InputHint](ctp:api:type:ProductTypeChangeInputHintAction) on Product Types. * - [Change InputHint](ctp:api:type:TypeChangeInputHintAction) on Types. *

func (ChangeInputHintChange) MarshalJSON

func (obj ChangeInputHintChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeIsActiveChange

type ChangeIsActiveChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue bool `json:"previousValue"`
	// Value after the change.
	NextValue bool `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Change IsActive](ctp:api:type:CartDiscountChangeIsActiveAction) on Cart Discounts. * - [Change IsActive](ctp:api:type:DiscountCodeChangeIsActiveAction) on Discount Codes. * - [Change IsActive](ctp:api:type:ProductDiscountChangeIsActiveAction) on Product Discounts. *

func (ChangeIsActiveChange) MarshalJSON

func (obj ChangeIsActiveChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeIsSearchableChange

type ChangeIsSearchableChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue bool `json:"previousValue"`
	// Value after the change.
	NextValue bool `json:"nextValue"`
	// Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition).
	AttributeName string `json:"attributeName"`
}

* * Change triggered by the [Change AttributeDefinition IsSearchable](ctp:api:type:ProductTypeChangeIsSearchableAction) update action.

func (ChangeIsSearchableChange) MarshalJSON

func (obj ChangeIsSearchableChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeKeyChange

type ChangeKeyChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Change Key](ctp:api:type:ChannelChangeKeyAction) on Channels. * - [Change State key](ctp:api:type:StateChangeKeyAction) on States. * - [Change Key](ctp:api:type:TypeChangeKeyAction) on Types. *

func (ChangeKeyChange) MarshalJSON

func (obj ChangeKeyChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeLabelChange

type ChangeLabelChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
	// Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition); only present on changes to Types).
	FieldName string `json:"fieldName"`
	// Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition); only present on changes to Product Types.
	AttributeName string `json:"attributeName"`
}

* * Change triggered by the following update actions: * * - [Change AttributeDefinition Label](ctp:api:type:ProductTypeChangeLabelAction) on Product Types. * - [Change FieldDefinition Label](ctp:api:type:TypeChangeLabelAction) on Types. *

func (ChangeLabelChange) MarshalJSON

func (obj ChangeLabelChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeLineItemQuantityChange

type ChangeLineItemQuantityChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue int `json:"previousValue"`
	// Value after the change
	NextValue int `json:"nextValue"`
	// Name of the [Product](ctp:api:type:Product) the updated Line Item is based on.
	LineItem LocalizedString `json:"lineItem"`
	// `id` of the updated [LineItem](ctp:api:type:LineItem).
	LineItemId string `json:"lineItemId"`
}

* * Change triggered by the [Change LineItem Quantity](ctp:api:type:StagedOrderChangeLineItemQuantityAction) update action.

func (ChangeLineItemQuantityChange) MarshalJSON

func (obj ChangeLineItemQuantityChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeLocalizedDescriptionChange

type ChangeLocalizedDescriptionChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
}

* * Change triggered by the [Change Description](ctp:api:type:ChannelChangeDescriptionAction) update action. *

func (ChangeLocalizedDescriptionChange) MarshalJSON

func (obj ChangeLocalizedDescriptionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeLocalizedEnumValueLabelChange

type ChangeLocalizedEnumValueLabelChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
	// Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition); only present on changes to Types.
	FieldName string `json:"fieldName"`
	// Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition); only present on changes to Product Types.
	AttributeName string `json:"attributeName"`
	// Key of the updated values.
	ValueKey string `json:"valueKey"`
}

* * Change triggered by the following update actions: * * - [Change the label of a LocalizedEnumValue](ctp:api:type:ProductTypeChangeLocalizedEnumValueLabelAction) on Product Types. * - [Change LocalizedEnumValue Label](ctp:api:type:TypeChangeLocalizedEnumValueLabelAction) on Types. *

func (ChangeLocalizedEnumValueLabelChange) MarshalJSON

func (obj ChangeLocalizedEnumValueLabelChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeLocalizedEnumValueOrderChange

type ChangeLocalizedEnumValueOrderChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []LocalizedEnumValue `json:"previousValue"`
	// Value after the change.
	NextValue []LocalizedEnumValue `json:"nextValue"`
	// Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition); only present on changes to Types.
	FieldName string `json:"fieldName"`
	// Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition); only present on changes to Product Types.
	AttributeName string `json:"attributeName"`
}

* * Change triggered by the following update actions: * * - [Change the order of LocalizedEnumValues](ctp:api:type:ProductTypeChangeLocalizedEnumValueOrderAction) on Product Types. * - [Change the order of LocalizedEnumValues](ctp:api:type:TypeChangeLocalizedEnumValueOrderAction) on Types. *

func (ChangeLocalizedEnumValueOrderChange) MarshalJSON

func (obj ChangeLocalizedEnumValueOrderChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeLocalizedNameChange

type ChangeLocalizedNameChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Change Name](ctp:api:type:CartDiscountChangeNameAction) on Cart Discounts. * - [Change Name](ctp:api:type:CategoryChangeNameAction) on Categories. * - [Change Name](ctp:api:type:ChannelChangeNameAction) on Channels. * - [Change Name](ctp:api:type:ProductChangeNameAction) on Products. * - [Change Name](ctp:api:type:ProductDiscountChangeNameAction) on Product Discounts. * - [Change Name](ctp:api:type:ProductSelectionChangeNameAction) on Product Selections. * - [Change Name](ctp:api:type:ShoppingListChangeNameAction) on Shopping Lists. * - [Change Name](ctp:api:type:ZoneChangeNameAction) on Zones. *

func (ChangeLocalizedNameChange) MarshalJSON

func (obj ChangeLocalizedNameChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeMasterVariantChange

type ChangeMasterVariantChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Variant `json:"previousValue"`
	// Value after the change.
	NextValue Variant `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
}

* * Change triggered by the [Change Master Variant](ctp:api:type:ProductChangeMasterVariantAction) update action.

func (ChangeMasterVariantChange) MarshalJSON

func (obj ChangeMasterVariantChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeNameChange

type ChangeNameChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Change Name](ctp:api:type:CustomerGroupChangeNameAction) on Customer Groups. * - [Change Name](ctp:api:type:ProductTypeChangeNameAction) on Product Types. * - [Change Name](ctp:api:type:TaxCategoryChangeNameAction) on Tax Categories. * - [Change Name](ctp:api:type:ZoneChangeNameAction) on Zones. *

func (ChangeNameChange) MarshalJSON

func (obj ChangeNameChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeOrderHintChange

type ChangeOrderHintChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Change OrderHint](ctp:api:type:CategoryChangeOrderHintAction) update action.

func (ChangeOrderHintChange) MarshalJSON

func (obj ChangeOrderHintChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeOrderStateChange

type ChangeOrderStateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue OrderState `json:"previousValue"`
	// Value after the change.
	NextValue OrderState `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Change OrderState](ctp:api:type:OrderChangeOrderStateAction) on Orders. * - [Change OrderState](ctp:api:type:StagedOrderChangeOrderStateAction) on Staged Orders. *

func (ChangeOrderStateChange) MarshalJSON

func (obj ChangeOrderStateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeParentChange

type ChangeParentChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Reference `json:"previousValue"`
	// Value after the change.
	NextValue Reference `json:"nextValue"`
}

* * Change triggered by the [Change Parent](ctp:api:type:CategoryChangeParentAction) update action.

func (ChangeParentChange) MarshalJSON

func (obj ChangeParentChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeParentUnitChange added in v1.5.0

type ChangeParentUnitChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue KeyReference `json:"previousValue"`
	// Value after the change.
	NextValue KeyReference `json:"nextValue"`
}

* * Change triggered by the [Change Parent Unit](ctp:api:type:BusinessUnitChangeParentUnitAction) update action.

func (ChangeParentUnitChange) MarshalJSON added in v1.5.0

func (obj ChangeParentUnitChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangePaymentStateChange

type ChangePaymentStateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue PaymentState `json:"previousValue"`
	// Value after the change.
	NextValue PaymentState `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Change PaymentState](ctp:api:type:OrderChangePaymentStateAction) on Orders. * - [Change PaymentState](ctp:api:type:StagedOrderChangePaymentStateAction) on Staged Orders. *

func (ChangePaymentStateChange) MarshalJSON

func (obj ChangePaymentStateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangePlainEnumValueLabelChange

type ChangePlainEnumValueLabelChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
	// Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition).
	AttributeName string `json:"attributeName"`
	// Key of the updated values.
	ValueKey string `json:"valueKey"`
}

* * Change triggered by the [Change the label of an EnumValue](ctp:api:type:ProductTypeChangePlainEnumValueLabelAction) update action.

func (ChangePlainEnumValueLabelChange) MarshalJSON

func (obj ChangePlainEnumValueLabelChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangePlainEnumValueOrderChange

type ChangePlainEnumValueOrderChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []EnumValue `json:"previousValue"`
	// Value after the change.
	NextValue []EnumValue `json:"nextValue"`
	// Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition).
	AttributeName string `json:"attributeName"`
}

* * Change triggered by the [Change the order of EnumValues](ctp:api:type:ProductTypeChangePlainEnumValueOrderAction) update action.

func (ChangePlainEnumValueOrderChange) MarshalJSON

func (obj ChangePlainEnumValueOrderChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangePredicateChange

type ChangePredicateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Change Predicate](ctp:api:type:ProductDiscountChangePredicateAction) update action.

func (ChangePredicateChange) MarshalJSON

func (obj ChangePredicateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangePriceChange

type ChangePriceChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Price `json:"previousValue"`
	// Value after the change.
	NextValue Price `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
	// `id` of the Embedded [Price](ctp:api:type:Price).
	PriceId string `json:"priceId"`
}

* * Change triggered by the [Change Price](ctp:api:type:ProductChangePriceAction) update action.

func (ChangePriceChange) MarshalJSON

func (obj ChangePriceChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeProductSelectionActiveChange added in v1.5.0

type ChangeProductSelectionActiveChange struct {
	Change string `json:"change"`
	// Reference to the Product Selection which was changed.
	ProductSelection Reference `json:"productSelection"`
	// Value before the change.
	PreviousValue bool `json:"previousValue"`
	// Value after the change.
	NextValue bool `json:"nextValue"`
}

* * Change triggered by the [Change Product Selection Active](ctp:api:type:StoreChangeProductSelectionAction) update action.

func (ChangeProductSelectionActiveChange) MarshalJSON added in v1.5.0

func (obj ChangeProductSelectionActiveChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeQuantityChange

type ChangeQuantityChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue InventoryQuantityValue `json:"previousValue"`
	// Value after the change.
	NextValue InventoryQuantityValue `json:"nextValue"`
}

* * Change triggered by the [Change Quantity](ctp:api:type:InventoryEntryChangeQuantityAction) update action.

func (ChangeQuantityChange) MarshalJSON

func (obj ChangeQuantityChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeQuoteRequestStateChange added in v1.2.0

type ChangeQuoteRequestStateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue QuoteRequestState `json:"previousValue"`
	// Value after the change.
	NextValue QuoteRequestState `json:"nextValue"`
}

* * Change triggered by the [Change Quote Request State](ctp:api:type:QuoteRequestChangeQuoteRequestStateAction) update action.

func (ChangeQuoteRequestStateChange) MarshalJSON added in v1.2.0

func (obj ChangeQuoteRequestStateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeQuoteStateChange added in v1.2.0

type ChangeQuoteStateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue QuoteState `json:"previousValue"`
	// Value after the change.
	NextValue QuoteState `json:"nextValue"`
}

* * Change triggered by the [Change Quote State](ctp:api:type:QuoteChangeQuoteStateAction) update action.

func (ChangeQuoteStateChange) MarshalJSON added in v1.2.0

func (obj ChangeQuoteStateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeRequiresDiscountCodeChange

type ChangeRequiresDiscountCodeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue bool `json:"previousValue"`
	// Value after the change.
	NextValue bool `json:"nextValue"`
}

* * Change triggered by the [Change Requires DiscountCode](ctp:api:type:CartDiscountChangeRequiresDiscountCodeAction) update action.

func (ChangeRequiresDiscountCodeChange) MarshalJSON

func (obj ChangeRequiresDiscountCodeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeReviewRatingStatisticsChange

type ChangeReviewRatingStatisticsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue ReviewRatingStatistics `json:"previousValue"`
	// Value after the change.
	NextValue ReviewRatingStatistics `json:"nextValue"`
}

func (ChangeReviewRatingStatisticsChange) MarshalJSON

func (obj ChangeReviewRatingStatisticsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeShipmentStateChange

type ChangeShipmentStateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue ShipmentState `json:"previousValue"`
	// Value after the change.
	NextValue ShipmentState `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Change ShipmentState](ctp:api:type:OrderChangeShipmentStateAction) on Orders. * - [Change ShipmentState](ctp:api:type:StagedOrderChangeShipmentStateAction) on Staged Orders. *

func (ChangeShipmentStateChange) MarshalJSON

func (obj ChangeShipmentStateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeShoppingListLineItemQuantityChange

type ChangeShoppingListLineItemQuantityChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue int `json:"previousValue"`
	// Value after the change.
	NextValue int `json:"nextValue"`
	// Holds information about the updated Shopping List Line Item.
	LineItem ShoppingListLineItemValue `json:"lineItem"`
}

* * Change triggered by the [Change ShoppingListLineItem Quantity](ctp:api:type:ShoppingListChangeLineItemQuantityAction) update action.

func (ChangeShoppingListLineItemQuantityChange) MarshalJSON

func (obj ChangeShoppingListLineItemQuantityChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeShoppingListLineItemsOrderChange

type ChangeShoppingListLineItemsOrderChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []ShoppingListLineItemValue `json:"previousValue"`
	// Value after the change.
	NextValue []ShoppingListLineItemValue `json:"nextValue"`
}

* * Change triggered by the [Change ShoppingListLineItems Order](ctp:api:type:ShoppingListChangeLineItemsOrderAction) update action.

func (ChangeShoppingListLineItemsOrderChange) MarshalJSON

func (obj ChangeShoppingListLineItemsOrderChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeSlugChange

type ChangeSlugChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Change Slug](ctp:api:type:CategoryChangeSlugAction) on Categories. * - [Change Slug](ctp:api:type:ProductChangeSlugAction) on Products. *

func (ChangeSlugChange) MarshalJSON

func (obj ChangeSlugChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeSortOrderChange

type ChangeSortOrderChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Change Sort Order](ctp:api:type:CartDiscountChangeSortOrderAction) on Cart Discounts. * - [Change Sort Order](ctp:api:type:ProductDiscountChangeSortOrderAction) on Product Discounts. *

func (ChangeSortOrderChange) MarshalJSON

func (obj ChangeSortOrderChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeStackingModeChange

type ChangeStackingModeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue StackingMode `json:"previousValue"`
	// Value after the change.
	NextValue StackingMode `json:"nextValue"`
}

* * Change triggered by the [Change Stacking Mode](ctp:api:type:CartDiscountChangeStackingModeAction) update action.

func (ChangeStackingModeChange) MarshalJSON

func (obj ChangeStackingModeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeStagedQuoteStateChange added in v1.2.0

type ChangeStagedQuoteStateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue StagedQuoteState `json:"previousValue"`
	// Value after the change.
	NextValue StagedQuoteState `json:"nextValue"`
}

* * Change triggered by the [ChangeStagedQuoteState](ctp:api:type:StagedQuoteChangeStagedQuoteStateAction) update action.

func (ChangeStagedQuoteStateChange) MarshalJSON added in v1.2.0

func (obj ChangeStagedQuoteStateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeStateTypeChange

type ChangeStateTypeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue StateTypeEnum `json:"previousValue"`
	// Value after the change.
	NextValue StateTypeEnum `json:"nextValue"`
}

* * Change triggered by the [Change State Type](ctp:api:type:StateChangeTypeAction) update action.

func (ChangeStateTypeChange) MarshalJSON

func (obj ChangeStateTypeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeStatusChange added in v1.5.0

type ChangeStatusChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue BusinessUnitStatus `json:"previousValue"`
	// Value after the change.
	NextValue BusinessUnitStatus `json:"nextValue"`
}

* * Change triggered by the [Change Status](ctp:api:type:BusinessUnitChangeStatusAction) update action.

func (ChangeStatusChange) MarshalJSON added in v1.5.0

func (obj ChangeStatusChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeTargetChange

type ChangeTargetChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue ChangeTargetChangeValue `json:"previousValue"`
	// Value after the change.
	NextValue ChangeTargetChangeValue `json:"nextValue"`
}

* * Change triggered by the [Change Target](ctp:api:type:CartDiscountChangeTargetAction) update action.

func (ChangeTargetChange) MarshalJSON

func (obj ChangeTargetChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ChangeTargetChange) UnmarshalJSON

func (obj *ChangeTargetChange) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ChangeTargetChangeValue

type ChangeTargetChangeValue interface{}

type ChangeTargetCustomLineItemsChangeValue

type ChangeTargetCustomLineItemsChangeValue struct {
	// Valid [CustomLineItem target predicate](/../api/projects/predicates#customlineitem-field-identifiers).
	Predicate string `json:"predicate"`
}

func (ChangeTargetCustomLineItemsChangeValue) MarshalJSON

func (obj ChangeTargetCustomLineItemsChangeValue) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeTargetLineItemsChangeValue

type ChangeTargetLineItemsChangeValue struct {
	// Valid [LineItem target predicate](/../api/projects/predicates#lineitem-field-identifiers).
	Predicate string `json:"predicate"`
}

func (ChangeTargetLineItemsChangeValue) MarshalJSON

func (obj ChangeTargetLineItemsChangeValue) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeTargetMultiBuyCustomLineItemsChangeValue

type ChangeTargetMultiBuyCustomLineItemsChangeValue struct {
	// Valid [CustomLineItem target predicate](/../api/projects/predicates#customlineitem-field-identifiers).
	Predicate string `json:"predicate"`
	// Quantity of Custom Line Items that triggered the application of the discount.
	TriggerQuantity int `json:"triggerQuantity"`
	// Quantity of Custom Line Items discounted per application of this discount.
	DiscountedQuantity int `json:"discountedQuantity"`
	// Maximum number of times the discount is applicable.
	MaxOccurrence int `json:"maxOccurrence"`
	// SelectionMode based on which particular Custom Line Items were discounted.
	SelectionMode SelectionMode `json:"selectionMode"`
}

func (ChangeTargetMultiBuyCustomLineItemsChangeValue) MarshalJSON

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeTargetMultiBuyLineItemsChangeValue

type ChangeTargetMultiBuyLineItemsChangeValue struct {
	// Valid [LineItem target predicate](/../api/projects/predicates#lineitem-field-identifiers).
	Predicate string `json:"predicate"`
	// Quantity of Line Items that triggered the application of the discount.
	TriggerQuantity int `json:"triggerQuantity"`
	// Quantity of Line Items discounted per application of this discount.
	DiscountedQuantity int `json:"discountedQuantity"`
	// Maximum number of times the discount is applicable.
	MaxOccurrence int `json:"maxOccurrence"`
	// SelectionMode based on which particular Line Items were discounted.
	SelectionMode SelectionMode `json:"selectionMode"`
}

func (ChangeTargetMultiBuyLineItemsChangeValue) MarshalJSON

func (obj ChangeTargetMultiBuyLineItemsChangeValue) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeTargetShippingChangeValue

type ChangeTargetShippingChangeValue struct {
}

func (ChangeTargetShippingChangeValue) MarshalJSON

func (obj ChangeTargetShippingChangeValue) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeTaxCalculationModeChange

type ChangeTaxCalculationModeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue TaxCalculationMode `json:"previousValue"`
	// Value after the change.
	NextValue TaxCalculationMode `json:"nextValue"`
}

* * Change triggered by the [Change TaxCalculationMode](ctp:api:type:StagedOrderChangeTaxCalculationModeAction) update action.

func (ChangeTaxCalculationModeChange) MarshalJSON

func (obj ChangeTaxCalculationModeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeTaxModeChange

type ChangeTaxModeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue TaxMode `json:"previousValue"`
	// Value after the change.
	NextValue TaxMode `json:"nextValue"`
}

* * Change triggered by the [Change TaxMode](ctp:api:type:StagedOrderChangeTaxModeAction) update action.

func (ChangeTaxModeChange) MarshalJSON

func (obj ChangeTaxModeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeTaxRoundingModeChange

type ChangeTaxRoundingModeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue RoundingMode `json:"previousValue"`
	// Value after the change.
	NextValue RoundingMode `json:"nextValue"`
}

* * Change triggered by the [Change Tax RoundingMode](ctp:api:type:StagedOrderChangeTaxRoundingModeAction) update action.

func (ChangeTaxRoundingModeChange) MarshalJSON

func (obj ChangeTaxRoundingModeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeTextLineItemNameChange

type ChangeTextLineItemNameChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
	// Holds information about the updated Text Line Item.
	TextLineItem TextLineItemValue `json:"textLineItem"`
}

* * Change triggered by the [Change TextLineItem Name](ctp:api:type:ShoppingListChangeTextLineItemNameAction) update action.

func (ChangeTextLineItemNameChange) MarshalJSON

func (obj ChangeTextLineItemNameChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeTextLineItemQuantityChange

type ChangeTextLineItemQuantityChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue int `json:"previousValue"`
	// Value after the change.
	NextValue int `json:"nextValue"`
	// Holds information about the updated Text Line Item.
	TextLineItem TextLineItemValue `json:"textLineItem"`
}

* * Change triggered by the [Change TextLineItem Quantity](ctp:api:type:ShoppingListChangeTextLineItemQuantityAction) update action.

func (ChangeTextLineItemQuantityChange) MarshalJSON

func (obj ChangeTextLineItemQuantityChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeTextLineItemsOrderChange

type ChangeTextLineItemsOrderChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []TextLineItemValue `json:"previousValue"`
	// Value after the change.
	NextValue []TextLineItemValue `json:"nextValue"`
}

* * Change triggered by the [Change TextLineItems Order](ctp:api:type:ShoppingListChangeTextLineItemsOrderAction) update action.

func (ChangeTextLineItemsOrderChange) MarshalJSON

func (obj ChangeTextLineItemsOrderChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeTransactionInteractionIdChange

type ChangeTransactionInteractionIdChange struct {
	Change string `json:"change"`
	// Value after the change.
	PreviousValue string `json:"previousValue"`
	// Value before the change.
	NextValue string `json:"nextValue"`
	// Holds information about the updated Transaction.
	Transaction TransactionChangeValue `json:"transaction"`
}

* * Change triggered by the [Change TransactionInteractionId](ctp:api:type:PaymentChangeTransactionInteractionIdAction) update action.

func (ChangeTransactionInteractionIdChange) MarshalJSON

func (obj ChangeTransactionInteractionIdChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeTransactionStateChange

type ChangeTransactionStateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue TransactionState `json:"previousValue"`
	// Value after the change.
	NextValue TransactionState `json:"nextValue"`
	// Holds information about the updated Transaction.
	Transaction TransactionChangeValue `json:"transaction"`
}

* * Change triggered by the [Change TransactionState](ctp:api:type:PaymentChangeTransactionStateAction) update action.

func (ChangeTransactionStateChange) MarshalJSON

func (obj ChangeTransactionStateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeTransactionTimestampChange

type ChangeTransactionTimestampChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
	// Holds information about the updated Transaction.
	Transaction TransactionChangeValue `json:"transaction"`
}

* * Change triggered by the [Change TransactionTimestamp](ctp:api:type:PaymentChangeTransactionTimestampAction) update action.

func (ChangeTransactionTimestampChange) MarshalJSON

func (obj ChangeTransactionTimestampChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeValueAbsoluteChangeValue

type ChangeValueAbsoluteChangeValue struct {
	// Money values in different currencies.
	Money []Money `json:"money"`
}

func (ChangeValueAbsoluteChangeValue) MarshalJSON

func (obj ChangeValueAbsoluteChangeValue) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeValueChange

type ChangeValueChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue ChangeValueChangeValue `json:"previousValue"`
	// Value after the change.
	NextValue ChangeValueChangeValue `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Change Value](ctp:api:type:CartDiscountChangeValueAction) on Cart Discounts. * - [Change Value](ctp:api:type:ProductDiscountChangeValueAction) on Product Discounts. *

func (ChangeValueChange) MarshalJSON

func (obj ChangeValueChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

func (*ChangeValueChange) UnmarshalJSON

func (obj *ChangeValueChange) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type ChangeValueChangeValue

type ChangeValueChangeValue interface{}

type ChangeValueExternalChangeValue

type ChangeValueExternalChangeValue struct {
}

func (ChangeValueExternalChangeValue) MarshalJSON

func (obj ChangeValueExternalChangeValue) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeValueGiftLineItemChangeValue

type ChangeValueGiftLineItemChangeValue struct {
	// Reference to a [Product](ctp:api:type:Product).
	Product Reference `json:"product"`
	// `id` of the [ProductVariant](ctp:api:type:ProductVariant).
	VariantId int `json:"variantId"`
	// Channel with [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum) `InventorySupply`.
	SupplyChannel *Reference `json:"supplyChannel,omitempty"`
	// Channel with [ChannelRoleEnum](ctp:api:type:ChannelRoleEnum) `ProductDistribution`.
	DistributionChannel Reference `json:"distributionChannel"`
}

func (ChangeValueGiftLineItemChangeValue) MarshalJSON

func (obj ChangeValueGiftLineItemChangeValue) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChangeValueRelativeChangeValue

type ChangeValueRelativeChangeValue struct {
	// Fraction (per ten thousand) the price is reduced by. For example, 1000 results in a 10% price reduction.
	Permyriad int `json:"permyriad"`
}

func (ChangeValueRelativeChangeValue) MarshalJSON

func (obj ChangeValueRelativeChangeValue) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ChannelRoleEnum added in v1.5.0

type ChannelRoleEnum string

* * Describes the purpose and type of the Channel. A Channel can have one or more roles. *

const (
	ChannelRoleEnumInventorySupply     ChannelRoleEnum = "InventorySupply"
	ChannelRoleEnumProductDistribution ChannelRoleEnum = "ProductDistribution"
	ChannelRoleEnumOrderExport         ChannelRoleEnum = "OrderExport"
	ChannelRoleEnumOrderImport         ChannelRoleEnum = "OrderImport"
	ChannelRoleEnumPrimary             ChannelRoleEnum = "Primary"
)

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(cfg *ClientConfig) (*Client, error)

NewClient creates a new client based on the provided ClientConfig

func (*Client) WithProjectKeyValue

func (c *Client) WithProjectKeyValue(projectKey string) *ByProjectKeyRequestBuilder

type ClientConfig

type ClientConfig struct {
	URL         string
	Credentials *clientcredentials.Config
	LogLevel    int
	HTTPClient  *http.Client
	UserAgent   string
}

type CustomFieldExpandedValue

type CustomFieldExpandedValue struct {
	// Name of the Custom Field.
	Name string `json:"name"`
	// [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
	Value interface{} `json:"value"`
	// User-defined label of the Custom Field.
	Label LocalizedString `json:"label"`
}

* * Only present if `expand` is set to `true`.

type CustomFields

type CustomFields struct {
	Type Reference `json:"type"`
	// A valid JSON object, based on FieldDefinition.
	Fields interface{} `json:"fields"`
}

type CustomLineItem

type CustomLineItem struct {
	// The unique ID of this CustomLineItem.
	ID         string          `json:"id"`
	Name       LocalizedString `json:"name"`
	Money      Money           `json:"money"`
	TaxedPrice TaxedItemPrice  `json:"taxedPrice"`
	TotalPrice Money           `json:"totalPrice"`
	// A unique String in the cart to identify this CustomLineItem.
	Slug string `json:"slug"`
	// The amount of a CustomLineItem in the cart. Must be a positive integer.
	Quantity int `json:"quantity"`
}

type CustomObjectLabel

type CustomObjectLabel struct {
	// User-defined unique identifier of the CustomObject within the defined `container`.
	Key string `json:"key"`
	// Namespace to group Custom Objects.
	Container string `json:"container"`
}

func (CustomObjectLabel) MarshalJSON

func (obj CustomObjectLabel) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type CustomShippingMethodChangeValue

type CustomShippingMethodChangeValue struct {
	// Name of the Custom ShippingMethod.
	Name string `json:"name"`
}

type CustomerLabel

type CustomerLabel struct {
	// Given name (first name) of the Customer.
	FirstName string `json:"firstName"`
	// Family name (last name) of the Customer.
	LastName string `json:"lastName"`
	// User-defined unique identifier of the [Customer](ctp:api:type:Customer).
	CustomerNumber string `json:"customerNumber"`
}

func (CustomerLabel) MarshalJSON

func (obj CustomerLabel) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type Date

type Date struct {
	Year  int
	Month time.Month
	Day   int
}

Date holds date information for Commercetools API format

func NewDate

func NewDate(year int, month time.Month, day int) Date

NewDate initializes a Date struct

func (*Date) MarshalJSON

func (d *Date) MarshalJSON() ([]byte, error)

MarshalJSON marshals into the commercetools date format

func (*Date) UnmarshalJSON

func (d *Date) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes JSON data into a Date struct

type DateStringFilter

type DateStringFilter string

* * This type consists of one enum value: *

const (
	DateStringFilterNow DateStringFilter = "now"
)

type DecodeStruct added in v1.1.0

type DecodeStruct interface {
	DecodeStruct(map[string]interface{}) error
}

type Delivery

type Delivery struct {
	ID        string         `json:"id"`
	CreatedAt string         `json:"createdAt"`
	Items     []DeliveryItem `json:"items"`
	Parcels   []Parcel       `json:"parcels"`
	Address   *Address       `json:"address,omitempty"`
	// Custom Fields for the Transaction.
	Custom *CustomFields `json:"custom,omitempty"`
}

type DeliveryChangeValue

type DeliveryChangeValue struct {
	// Line Items or Custom Line Items shipped in the [Delivery](ctp:api:type:Delivery).
	Items []DeliveryItem `json:"items"`
	// Address to which the parcels are delivered.
	Address Address `json:"address"`
	// Parcels included in the [Delivery](ctp:api:type:Delivery).
	Parcels []Parcel `json:"parcels"`
}

type DeliveryItem

type DeliveryItem struct {
	ID       string `json:"id"`
	Quantity int    `json:"quantity"`
}

type DiscountCodeInfo

type DiscountCodeInfo struct {
	DiscountCode Reference         `json:"discountCode"`
	State        DiscountCodeState `json:"state"`
}

type DiscountCodeState

type DiscountCodeState string
const (
	DiscountCodeStateNotActive                            DiscountCodeState = "NotActive"
	DiscountCodeStateDoesNotMatchCart                     DiscountCodeState = "DoesNotMatchCart"
	DiscountCodeStateMatchesCart                          DiscountCodeState = "MatchesCart"
	DiscountCodeStateMaxApplicationReached                DiscountCodeState = "MaxApplicationReached"
	DiscountCodeStateApplicationStoppedByPreviousDiscount DiscountCodeState = "ApplicationStoppedByPreviousDiscount"
	DiscountCodeStateNotValid                             DiscountCodeState = "NotValid"
)

type DiscountedLineItemPortion

type DiscountedLineItemPortion struct {
	Discount         Reference `json:"discount"`
	DiscountedAmount Money     `json:"discountedAmount"`
}

type DiscountedLineItemPrice

type DiscountedLineItemPrice struct {
	Value             Money                       `json:"value"`
	IncludedDiscounts []DiscountedLineItemPortion `json:"includedDiscounts"`
}

type DiscountedLineItemPriceForQuantity

type DiscountedLineItemPriceForQuantity struct {
	Quantity        int                     `json:"quantity"`
	DiscountedPrice DiscountedLineItemPrice `json:"discountedPrice"`
}

type EnumValue

type EnumValue struct {
	// Key of the value used as a programmatic identifier.
	Key string `json:"key"`
	// Descriptive label of the value.
	Label string `json:"label"`
}

type ErrorObject

type ErrorObject struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

func (ErrorObject) Error

func (obj ErrorObject) Error() string

type ErrorResponse

type ErrorResponse struct {
	StatusCode       int           `json:"statusCode"`
	Message          string        `json:"message"`
	ErrorMessage     *string       `json:"error,omitempty"`
	ErrorDescription *string       `json:"error_description,omitempty"`
	Errors           []ErrorObject `json:"errors"`
}

func (ErrorResponse) Error

func (obj ErrorResponse) Error() string

func (ErrorResponse) MarshalJSON

func (obj ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type FieldDefinition

type FieldDefinition struct {
	Type FieldType `json:"type"`
	// The name of the field. The name must be between two and 36 characters long and can contain the ASCII letters A to Z in lowercase or uppercase, digits, underscores (`_`) and the hyphen-minus (`-`). The name must be unique for a given resource type ID. In case there is a field with the same name in another type it has to have the same FieldType also.
	Name      string          `json:"name"`
	Label     LocalizedString `json:"label"`
	InputHint TextInputHint   `json:"inputHint"`
}

type FieldDefinitionOrderValue

type FieldDefinitionOrderValue struct {
	// Name of the [FieldDefinition](ctp:api:type:FieldDefinition).
	Name string `json:"name"`
	// Descriptive label of the field.
	Label LocalizedString `json:"label"`
}

type FieldType

type FieldType struct {
	Name string `json:"name"`
}

type GenericRequestError

type GenericRequestError struct {
	Content    []byte
	StatusCode int
	Response   *http.Response
}

func (GenericRequestError) Error

func (e GenericRequestError) Error() string

type GeoLocation

type GeoLocation struct {
	Type        string `json:"type"`
	Coordinates []int  `json:"coordinates"`
}

type Image

type Image struct {
	Url        string          `json:"url"`
	Dimensions ImageDimensions `json:"dimensions"`
	Label      string          `json:"label"`
}

type ImageDimensions

type ImageDimensions struct {
	W int `json:"w"`
	H int `json:"h"`
}

type InheritedAssociate added in v1.5.0

type InheritedAssociate struct {
	AssociateRoleAssignments []InheritedAssociateRoleAssignment `json:"associateRoleAssignments"`
	Customer                 Reference                          `json:"customer"`
}

type InheritedAssociateRoleAssignment added in v1.5.0

type InheritedAssociateRoleAssignment struct {
	AssociateRole KeyReference `json:"associateRole"`
	Source        KeyReference `json:"source"`
}

type InventoryQuantityValue

type InventoryQuantityValue struct {
	// Overall amount of stock (`availableQuantity` + reserved).
	QuantityOnStock int `json:"quantityOnStock"`
	// Available amount of stock (`quantityOnStock` - reserved).
	AvailableQuantity int `json:"availableQuantity"`
}

type ItemShippingDetails

type ItemShippingDetails struct {
	Targets []ItemShippingTarget `json:"targets"`
	// true if the quantity of the (custom) line item is equal to the sum of the sub-quantities in `targets`, `false` otherwise. A cart cannot be ordered when the value is `false`. The error InvalidItemShippingDetails will be triggered.
	Valid bool `json:"valid"`
}

type ItemShippingTarget

type ItemShippingTarget struct {
	// The key of the address in the cart's `itemShippingAddresses`
	AddressKey string `json:"addressKey"`
	// The quantity of items that should go to the address with the specified `addressKey`. Only positive values are allowed. Using `0` as quantity is also possible in a draft object, but the element will not be present in the resulting ItemShippingDetails.
	Quantity int `json:"quantity"`
}

type ItemState

type ItemState struct {
	Quantity int       `json:"quantity"`
	State    Reference `json:"state"`
}

type KeyReference

type KeyReference struct {
	Key    string          `json:"key"`
	TypeId ReferenceTypeId `json:"typeId"`
}

type Label

type Label interface{}

* * Provides descriptive information specific to the resource.

type LineItem

type LineItem struct {
	AddedAt     string          `json:"addedAt"`
	Custom      CustomFields    `json:"custom"`
	ID          string          `json:"id"`
	Name        LocalizedString `json:"name"`
	ProductId   string          `json:"productId"`
	ProductSlug LocalizedString `json:"productSlug"`
	ProductType Reference       `json:"productType"`
	Quantity    int             `json:"quantity"`
	Variant     Variant         `json:"variant"`
	VariantId   int             `json:"variantId"`
}

type LocalizedEnumValue

type LocalizedEnumValue struct {
	// Key of the value used as a programmatic identifier.
	Key string `json:"key"`
	// Descriptive localized label of the value.
	Label LocalizedString `json:"label"`
}

type LocalizedLabel

type LocalizedLabel struct {
	// Changed value.
	Value LocalizedString `json:"value"`
}

func (LocalizedLabel) MarshalJSON

func (obj LocalizedLabel) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type LocalizedString

type LocalizedString map[string]string

type Location

type Location struct {
	// Two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
	Country string `json:"country"`
	State   string `json:"state"`
}

* * Shape of the value for `addLocation` and `removeLocation` actions

type ModifiedBy

type ModifiedBy struct {
	// [ID](/general-concepts#identifier) of the Merchant Center user who made the change.
	//
	// Present only if the change was made in the Merchant Center.
	ID string `json:"id"`
	// Indicates who performed the change.
	//
	// - If the change was made by a user, the value is `"user"`.
	// - If the change was made by an API Client with or without an [external user ID](/general-concepts#external-user-ids), the value is `"external-user"`.
	// - If the change was made by an [Associate](ctp:api:type:Associate), the value is `"associate"`.
	Type string `json:"type"`
	// [ID](/general-concepts#identifier) of the [API Client](ctp:api:type:ApiClient) that made the change.
	//
	// Present only if the change was made using an API Client.
	ClientId *string `json:"clientId,omitempty"`
	// Present only if the change was made using a token from an [anonymous session](/authorization#tokens-for-anonymous-sessions).
	AnonymousId *string `json:"anonymousId,omitempty"`
	// The [Customer](ctp:api:type:Customer) who made the change.
	//
	// Present only if the change was made using a token from the [password flow](/authorization#password-flow).
	Customer *Reference `json:"customer,omitempty"`
	// The [Associate](ctp:api:type:Associate) who made the change in the context of a [Business Unit](ctp:api:type:BusinessUnit). Present only if the Associate acts on behalf of a company using the [associate endpoints](/associates-overview#on-the-associate-endpoints).
	Associate *Reference `json:"associate,omitempty"`
	// `true` if the change was made using the Merchant Center or [ImpEx](https://impex.europe-west1.gcp.commercetools.com/).
	IsPlatformClient bool `json:"isPlatformClient"`
}

* * Information about the user or API Client who performed the change. This is a variant of [LastModifiedBy](ctp:api:type:LastModifiedBy). *

type Money

type Money struct {
	// Currency code compliant to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
	CurrencyCode   string    `json:"currencyCode"`
	CentAmount     int       `json:"centAmount"`
	FractionDigits int       `json:"fractionDigits"`
	Type           MoneyType `json:"type"`
}

type MoneyType

type MoneyType string
const (
	MoneyTypeCentPrecision MoneyType = "centPrecision"
	MoneyTypeHighPrecision MoneyType = "highPrecision"
)

type MoveImageToPositionChange

type MoveImageToPositionChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []Image `json:"previousValue"`
	// Value after the change.
	NextValue []Image `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
}

* * Change triggered by the [Move image to position](ctp:api:type:ProductMoveImageToPositionAction) update action.

func (MoveImageToPositionChange) MarshalJSON

func (obj MoveImageToPositionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderLabel

type OrderLabel struct {
	// Email address of the Customer that the Order belongs to.
	CustomerEmail string `json:"customerEmail"`
	// User-defined unique identifier of the Order that is unique across a Project.
	OrderNumber string `json:"orderNumber"`
}

func (OrderLabel) MarshalJSON

func (obj OrderLabel) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type OrderState

type OrderState string
const (
	OrderStateOpen      OrderState = "Open"
	OrderStateConfirmed OrderState = "Confirmed"
	OrderStateComplete  OrderState = "Complete"
	OrderStateCancelled OrderState = "Cancelled"
)

type Parcel

type Parcel struct {
	ID           string             `json:"id"`
	CreatedAt    string             `json:"createdAt"`
	Measurements ParcelMeasurements `json:"measurements"`
	TrackingData TrackingData       `json:"trackingData"`
	Items        []DeliveryItem     `json:"items"`
}

type ParcelChangeValue

type ParcelChangeValue struct {
	// `id` of the [Parcel](ctp:api:type:Parcel).
	ID string `json:"id"`
	// Date and time (UTC) the Parcel was created.
	CreatedAt string `json:"createdAt"`
}

type ParcelMeasurements

type ParcelMeasurements struct {
	HeightInMillimeter int `json:"heightInMillimeter"`
	LengthInMillimeter int `json:"lengthInMillimeter"`
	WidthInMillimeter  int `json:"widthInMillimeter"`
	WeightInGram       int `json:"weightInGram"`
}

type PaymentInfo

type PaymentInfo struct {
	Payments []Reference `json:"payments"`
}

type PaymentLabel

type PaymentLabel struct {
	// User-defined unique identifier of the Payment.
	Key string `json:"key"`
	// Money value the Payment intends to receive from the Customer.
	AmountPlanned Money `json:"amountPlanned"`
}

func (PaymentLabel) MarshalJSON

func (obj PaymentLabel) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type PaymentState

type PaymentState string
const (
	PaymentStateBalanceDue PaymentState = "BalanceDue"
	PaymentStateFailed     PaymentState = "Failed"
	PaymentStatePending    PaymentState = "Pending"
	PaymentStateCreditOwed PaymentState = "CreditOwed"
	PaymentStatePaid       PaymentState = "Paid"
)

type Permission added in v1.5.0

type Permission string

* * Permissions grant granular access to [Business Units](ctp:api:type:BusinessUnit), [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), and [Quote Requests](ctp:api:type:QuoteRequest).

const (
	PermissionAddChildUnits                      Permission = "AddChildUnits"
	PermissionUpdateAssociates                   Permission = "UpdateAssociates"
	PermissionUpdateBusinessUnitDetails          Permission = "UpdateBusinessUnitDetails"
	PermissionUpdateParentUnit                   Permission = "UpdateParentUnit"
	PermissionViewMyCarts                        Permission = "ViewMyCarts"
	PermissionViewOthersCarts                    Permission = "ViewOthersCarts"
	PermissionUpdateMyCarts                      Permission = "UpdateMyCarts"
	PermissionUpdateOthersCarts                  Permission = "UpdateOthersCarts"
	PermissionCreateMyCarts                      Permission = "CreateMyCarts"
	PermissionCreateOthersCarts                  Permission = "CreateOthersCarts"
	PermissionDeleteMyCarts                      Permission = "DeleteMyCarts"
	PermissionDeleteOthersCarts                  Permission = "DeleteOthersCarts"
	PermissionViewMyOrders                       Permission = "ViewMyOrders"
	PermissionViewOthersOrders                   Permission = "ViewOthersOrders"
	PermissionUpdateMyOrders                     Permission = "UpdateMyOrders"
	PermissionUpdateOthersOrders                 Permission = "UpdateOthersOrders"
	PermissionCreateMyOrdersFromMyCarts          Permission = "CreateMyOrdersFromMyCarts"
	PermissionCreateMyOrdersFromMyQuotes         Permission = "CreateMyOrdersFromMyQuotes"
	PermissionCreateOrdersFromOthersCarts        Permission = "CreateOrdersFromOthersCarts"
	PermissionCreateOrdersFromOthersQuotes       Permission = "CreateOrdersFromOthersQuotes"
	PermissionViewMyQuotes                       Permission = "ViewMyQuotes"
	PermissionViewOthersQuotes                   Permission = "ViewOthersQuotes"
	PermissionAcceptMyQuotes                     Permission = "AcceptMyQuotes"
	PermissionAcceptOthersQuotes                 Permission = "AcceptOthersQuotes"
	PermissionDeclineMyQuotes                    Permission = "DeclineMyQuotes"
	PermissionDeclineOthersQuotes                Permission = "DeclineOthersQuotes"
	PermissionRenegotiateMyQuotes                Permission = "RenegotiateMyQuotes"
	PermissionRenegotiateOthersQuotes            Permission = "RenegotiateOthersQuotes"
	PermissionReassignMyQuotes                   Permission = "ReassignMyQuotes"
	PermissionReassignOthersQuotes               Permission = "ReassignOthersQuotes"
	PermissionViewMyQuoteRequests                Permission = "ViewMyQuoteRequests"
	PermissionViewOthersQuoteRequests            Permission = "ViewOthersQuoteRequests"
	PermissionUpdateMyQuoteRequests              Permission = "UpdateMyQuoteRequests"
	PermissionUpdateOthersQuoteRequests          Permission = "UpdateOthersQuoteRequests"
	PermissionCreateMyQuoteRequestsFromMyCarts   Permission = "CreateMyQuoteRequestsFromMyCarts"
	PermissionCreateQuoteRequestsFromOthersCarts Permission = "CreateQuoteRequestsFromOthersCarts"
)

type PlatformInitiatedChange

type PlatformInitiatedChange string

* * Updates that are triggered automatically as a result of a user-initiated change.

const (
	PlatformInitiatedChangeExcludeAll                   PlatformInitiatedChange = "excludeAll"
	PlatformInitiatedChangeChangeLineItemName           PlatformInitiatedChange = "changeLineItemName"
	PlatformInitiatedChangeChangeReviewRatingStatistics PlatformInitiatedChange = "changeReviewRatingStatistics"
	PlatformInitiatedChangeSetApplicationVersion        PlatformInitiatedChange = "setApplicationVersion"
	PlatformInitiatedChangeSetIsValid                   PlatformInitiatedChange = "setIsValid"
	PlatformInitiatedChangeSetVariantAvailability       PlatformInitiatedChange = "setVariantAvailability"
)

type Price

type Price struct {
	ID    string `json:"id"`
	Value Money  `json:"value"`
}

type ProductLabel

type ProductLabel struct {
	// User-defined identifier used in a deep-link URL for the Product.
	Slug LocalizedString `json:"slug"`
	// Name of the Product.
	Name LocalizedString `json:"name"`
}

func (ProductLabel) MarshalJSON

func (obj ProductLabel) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ProductSelectionSetting added in v1.2.0

type ProductSelectionSetting struct {
	ProductSelection Reference `json:"productSelection"`
	Active           bool      `json:"active"`
}

type ProductVariantAvailability

type ProductVariantAvailability struct {
	IsOnStock         bool                                 `json:"isOnStock"`
	RestockableInDays int                                  `json:"restockableInDays"`
	AvailableQuantity int                                  `json:"availableQuantity"`
	Channels          ProductVariantChannelAvailabilityMap `json:"channels"`
}

type ProductVariantChannelAvailability

type ProductVariantChannelAvailability struct {
	IsOnStock         bool `json:"isOnStock"`
	RestockableInDays int  `json:"restockableInDays"`
	AvailableQuantity int  `json:"availableQuantity"`
}

type ProductVariantChannelAvailabilityMap

type ProductVariantChannelAvailabilityMap map[string]ProductVariantChannelAvailability

type ProductVariantSelection added in v1.5.0

type ProductVariantSelection struct {
	Type ProductVariantSelectionTypeEnum `json:"type"`
	Skus []string                        `json:"skus"`
}

type ProductVariantSelectionTypeEnum added in v1.5.0

type ProductVariantSelectionTypeEnum string
const (
	ProductVariantSelectionTypeEnumInclusion ProductVariantSelectionTypeEnum = "inclusion"
	ProductVariantSelectionTypeEnumExclusion ProductVariantSelectionTypeEnum = "exclusion"
)

type PublishChange

type PublishChange struct {
	Change string `json:"change"`
}

* * Change triggered by the [Publish](ctp:api:type:ProductPublishAction) update action.

func (PublishChange) MarshalJSON

func (obj PublishChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteLabel added in v1.2.0

type QuoteLabel struct {
	// User-defined unique identifier of the Quote.
	Key string `json:"key"`
	// The [Buyer](/../api/quotes-overview#buyer) who requested the Quote.
	Customer Reference `json:"customer"`
	// Staged Quote related to the Quote.
	StagedQuote Reference `json:"stagedQuote"`
	// Quote Request related to the Quote.
	QuoteRequest Reference `json:"quoteRequest"`
}

func (QuoteLabel) MarshalJSON added in v1.2.0

func (obj QuoteLabel) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRequestLabel added in v1.2.0

type QuoteRequestLabel struct {
	// User-defined unique identifier of the Quote Request.
	Key string `json:"key"`
	// The [Buyer](/../api/quotes-overview#buyer) who raised the Quote Request.
	Customer Reference `json:"customer"`
}

func (QuoteRequestLabel) MarshalJSON added in v1.2.0

func (obj QuoteRequestLabel) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type QuoteRequestState added in v1.2.0

type QuoteRequestState string
const (
	QuoteRequestStateSubmitted QuoteRequestState = "Submitted"
	QuoteRequestStateAccepted  QuoteRequestState = "Accepted"
	QuoteRequestStateClosed    QuoteRequestState = "Closed"
	QuoteRequestStateRejected  QuoteRequestState = "Rejected"
	QuoteRequestStateCancelled QuoteRequestState = "Cancelled"
)

type QuoteState added in v1.2.0

type QuoteState string
const (
	QuoteStatePending                  QuoteState = "Pending"
	QuoteStateDeclined                 QuoteState = "Declined"
	QuoteStateDeclinedForRenegotiation QuoteState = "DeclinedForRenegotiation"
	QuoteStateAccepted                 QuoteState = "Accepted"
	QuoteStateFailed                   QuoteState = "Failed"
	QuoteStateWithdrawn                QuoteState = "Withdrawn"
)

type Record

type Record struct {
	// Version of the resource after the change.
	//
	// For more information on how the version is incremented, see [Optimistic Concurrency Control](/../api/general-concepts#optimistic-concurrency-control).
	Version int `json:"version"`
	// Version of the resource before the change.
	PreviousVersion int `json:"previousVersion"`
	// Indicates the type of change.
	// For creation, update, or deletion, the value is `"ResourceCreated"`, `"ResourceUpdated"`, or `"ResourceDeleted"` respectively.
	Type string `json:"type"`
	// Information about the user or API Client who performed the change.
	ModifiedBy ModifiedBy `json:"modifiedBy"`
	// Date and time (UTC) when the change was made.
	ModifiedAt string `json:"modifiedAt"`
	// Information that describes the resource after the change.
	Label Label `json:"label"`
	// Information that describes the resource before the change.
	PreviousLabel Label `json:"previousLabel"`
	// Shows the differences in the resource between `previousVersion` and `version`.
	//
	// The value is not identical to the actual array of update actions sent and is not limited to update actions (see, for example, [Optimistic  Concurrency Control](/general-concepts#optimistic-concurrency-control)).
	Changes []Change `json:"changes"`
	// ResourceIdentifier of the changed resource.
	Resource ResourceIdentifier `json:"resource"`
	// References to the [Stores](ctp:api:type:Store) associated with the [Change](ctp:history:type:Change).
	Stores []KeyReference `json:"stores"`
	// Reference to the [Business Unit](ctp:api:type:BusinessUnit) associated with the [Change](ctp:history:type:Change).
	BusinessUnit *KeyReference `json:"businessUnit,omitempty"`
	// `true` if no change was detected.
	//
	// The version number of the resource can be increased even without any change in the resource.
	WithoutChanges bool `json:"withoutChanges"`
}

* * Captures the differences between the previous and next version of a resource. * * The maximum number of Records that can be stored and their retention period are subject to a [limit](/../api/limits#records). *

func (*Record) UnmarshalJSON

func (obj *Record) UnmarshalJSON(data []byte) error

UnmarshalJSON override to deserialize correct attribute types based on the discriminator value

type RecordPagedQueryResponse

type RecordPagedQueryResponse struct {
	// Number of [results requested](/../api/general-concepts#limit).
	Limit int `json:"limit"`
	// Actual number of results returned.
	Count int `json:"count"`
	// Total number of results matching the query.
	// This number is an estimation and not [strongly consistent](/../api/general-concepts#strong-consistency).
	Total int `json:"total"`
	// Number of [elements skipped](/../api/general-concepts#offset).
	Offset int `json:"offset"`
	// Records matching the query.
	Results []Record `json:"results"`
}

* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of Record(ctp:history:type:Record). *

type Reference

type Reference struct {
	ID     string          `json:"id"`
	TypeId ReferenceTypeId `json:"typeId"`
}

type ReferenceTypeId

type ReferenceTypeId string
const (
	ReferenceTypeIdAssociateRole         ReferenceTypeId = "associate-role"
	ReferenceTypeIdBusinessUnit          ReferenceTypeId = "business-unit"
	ReferenceTypeIdCart                  ReferenceTypeId = "cart"
	ReferenceTypeIdCartDiscount          ReferenceTypeId = "cart-discount"
	ReferenceTypeIdCategory              ReferenceTypeId = "category"
	ReferenceTypeIdChannel               ReferenceTypeId = "channel"
	ReferenceTypeIdCustomer              ReferenceTypeId = "customer"
	ReferenceTypeIdCustomerEmailToken    ReferenceTypeId = "customer-email-token"
	ReferenceTypeIdCustomerGroup         ReferenceTypeId = "customer-group"
	ReferenceTypeIdCustomerPasswordToken ReferenceTypeId = "customer-password-token"
	ReferenceTypeIdDiscountCode          ReferenceTypeId = "discount-code"
	ReferenceTypeIdExtension             ReferenceTypeId = "extension"
	ReferenceTypeIdInventoryEntry        ReferenceTypeId = "inventory-entry"
	ReferenceTypeIdKeyValueDocument      ReferenceTypeId = "key-value-document"
	ReferenceTypeIdOrder                 ReferenceTypeId = "order"
	ReferenceTypeIdOrderEdit             ReferenceTypeId = "order-edit"
	ReferenceTypeIdPayment               ReferenceTypeId = "payment"
	ReferenceTypeIdProduct               ReferenceTypeId = "product"
	ReferenceTypeIdProductDiscount       ReferenceTypeId = "product-discount"
	ReferenceTypeIdProductSelection      ReferenceTypeId = "product-selection"
	ReferenceTypeIdProductType           ReferenceTypeId = "product-type"
	ReferenceTypeIdQuote                 ReferenceTypeId = "quote"
	ReferenceTypeIdQuoteRequest          ReferenceTypeId = "quote-request"
	ReferenceTypeIdReview                ReferenceTypeId = "review"
	ReferenceTypeIdShippingMethod        ReferenceTypeId = "shipping-method"
	ReferenceTypeIdShoppingList          ReferenceTypeId = "shopping-list"
	ReferenceTypeIdStagedQuote           ReferenceTypeId = "staged-quote"
	ReferenceTypeIdState                 ReferenceTypeId = "state"
	ReferenceTypeIdStore                 ReferenceTypeId = "store"
	ReferenceTypeIdSubscription          ReferenceTypeId = "subscription"
	ReferenceTypeIdTaxCategory           ReferenceTypeId = "tax-category"
	ReferenceTypeIdType                  ReferenceTypeId = "type"
	ReferenceTypeIdZone                  ReferenceTypeId = "zone"
)

type RemoveAddressChange

type RemoveAddressChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Address `json:"previousValue"`
}

* * Change triggered by the [Remove Address](ctp:api:type:CustomerRemoveAddressAction) update action.

func (RemoveAddressChange) MarshalJSON

func (obj RemoveAddressChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveAssetChange

type RemoveAssetChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Asset `json:"previousValue"`
}

* * Change triggered by the following update actions: * * - [Remove Asset](ctp:api:type:CategoryRemoveAssetAction) on Categories. * - [Remove Asset](ctp:api:type:ProductRemoveAssetAction) on Products. *

func (RemoveAssetChange) MarshalJSON

func (obj RemoveAssetChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveAssociateChange added in v1.5.0

type RemoveAssociateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Associate `json:"previousValue"`
}

* * Change triggered by the [Remove Associate](ctp:api:type:BusinessUnitRemoveAssociateAction) update action.

func (RemoveAssociateChange) MarshalJSON added in v1.5.0

func (obj RemoveAssociateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveAttributeDefinitionChange

type RemoveAttributeDefinitionChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue AttributeDefinition `json:"previousValue"`
}

* * Change triggered by the [Remove AttributeDefinition](ctp:api:type:ProductTypeRemoveAttributeDefinitionAction) update action.

func (RemoveAttributeDefinitionChange) MarshalJSON

func (obj RemoveAttributeDefinitionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveBillingAddressIdChange

type RemoveBillingAddressIdChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []string `json:"previousValue"`
	// Value after the change.
	NextValue []string `json:"nextValue"`
	// Address removed from `billingAddressesIds`.
	Address Address `json:"address"`
}

* * Change triggered by the [Remove Billing Address ID](ctp:api:type:CustomerRemoveBillingAddressIdAction) update action.

func (RemoveBillingAddressIdChange) MarshalJSON

func (obj RemoveBillingAddressIdChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveChannelRolesChange

type RemoveChannelRolesChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []ChannelRoleEnum `json:"previousValue"`
	// Value after the change.
	NextValue []ChannelRoleEnum `json:"nextValue"`
}

* * Change triggered by the [Remove Roles](ctp:api:type:ChannelRemoveRolesAction) update action.

func (RemoveChannelRolesChange) MarshalJSON

func (obj RemoveChannelRolesChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveCustomLineItemChange

type RemoveCustomLineItemChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue CustomLineItem `json:"previousValue"`
	// Value after the change.
	NextValue CustomLineItem `json:"nextValue"`
}

* * Change triggered by the [Remove CustomLineItem](ctp:api:type:StagedOrderRemoveCustomLineItemAction) update action.

func (RemoveCustomLineItemChange) MarshalJSON

func (obj RemoveCustomLineItemChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveDeliveryItemsChange

type RemoveDeliveryItemsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Delivery `json:"previousValue"`
}

* * Change triggered by the [Remove Delivery](ctp:api:type:OrderRemoveDeliveryAction) update action.

func (RemoveDeliveryItemsChange) MarshalJSON

func (obj RemoveDeliveryItemsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveDiscountCodeChange

type RemoveDiscountCodeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue DiscountCodeInfo `json:"previousValue"`
}

* * Change triggered by the [Remove DiscountCode](ctp:api:type:StagedOrderRemoveDiscountCodeAction) update action.

func (RemoveDiscountCodeChange) MarshalJSON

func (obj RemoveDiscountCodeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveEnumValuesChange

type RemoveEnumValuesChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue EnumValue `json:"previousValue"`
	// Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition).
	AttributeName string `json:"attributeName"`
}

* * Change triggered by the [Remove EnumValues from AttributeDefinition](ctp:api:type:ProductTypeRemoveEnumValuesAction) update action.

func (RemoveEnumValuesChange) MarshalJSON

func (obj RemoveEnumValuesChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveFieldDefinitionChange

type RemoveFieldDefinitionChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue FieldDefinition `json:"previousValue"`
}

* * Change triggered by the [Remove FieldDefinition](ctp:api:type:TypeRemoveFieldDefinitionAction) update action.

func (RemoveFieldDefinitionChange) MarshalJSON

func (obj RemoveFieldDefinitionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveFromCategoryChange

type RemoveFromCategoryChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []Reference `json:"previousValue"`
	// Value after the change.
	NextValue []Reference `json:"nextValue"`
	// Category from which the Product was removed.
	Category Reference `json:"category"`
}

* * Change triggered by the [Remove from Category](ctp:api:type:ProductRemoveFromCategoryAction) update action.

func (RemoveFromCategoryChange) MarshalJSON

func (obj RemoveFromCategoryChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveImageChange

type RemoveImageChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []Image `json:"previousValue"`
	// Value after the change.
	NextValue []Image `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
}

* * Change triggered by the [Remove Image](ctp:api:type:ProductRemoveImageAction) update action.

func (RemoveImageChange) MarshalJSON

func (obj RemoveImageChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveInheritedAssociateChange added in v1.5.0

type RemoveInheritedAssociateChange struct {
	Change string `json:"change"`
	// The value before the change.
	PreviousValue InheritedAssociate `json:"previousValue"`
}

* * Change triggered by the [Remove Associate](ctp:api:type:BusinessUnitRemoveAssociateAction) update action on a parent of a Business Unit in cases where [inheritance applies](/../api/associates-overview#conditions-for-inheritance).

func (RemoveInheritedAssociateChange) MarshalJSON added in v1.5.0

func (obj RemoveInheritedAssociateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveItemShippingAddressesChange

type RemoveItemShippingAddressesChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Address `json:"previousValue"`
	// Value after the change.
	NextValue Address `json:"nextValue"`
}

* * Change triggered by the [Remove Item Shipping Address](ctp:api:type:OrderRemoveItemShippingAddressAction) update action.

func (RemoveItemShippingAddressesChange) MarshalJSON

func (obj RemoveItemShippingAddressesChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveLocalizedEnumValuesChange

type RemoveLocalizedEnumValuesChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedEnumValue `json:"previousValue"`
	// Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition).
	AttributeName string `json:"attributeName"`
}

* * Change triggered by the [Remove EnumValues from AttributeDefinition](ctp:api:type:ProductTypeRemoveEnumValuesAction) update action.

func (RemoveLocalizedEnumValuesChange) MarshalJSON

func (obj RemoveLocalizedEnumValuesChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveLocationChange

type RemoveLocationChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Location `json:"previousValue"`
}

* * Change triggered by the [Remove Location](ctp:api:type:ZoneRemoveLocationAction) update action.

func (RemoveLocationChange) MarshalJSON

func (obj RemoveLocationChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveOrderLineItemChange

type RemoveOrderLineItemChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LineItem `json:"previousValue"`
	// Value after the change.
	NextValue LineItem `json:"nextValue"`
}

* * Change triggered by the [Remove Parcel From Delivery](ctp:api:type:StagedOrderRemoveLineItemAction) update action.

func (RemoveOrderLineItemChange) MarshalJSON

func (obj RemoveOrderLineItemChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveParcelFromDeliveryChange

type RemoveParcelFromDeliveryChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Parcel `json:"previousValue"`
	// `id` of the [Delivery](ctp:api:type:Delivery) from which the Parcel was removed.
	DeliveryId string `json:"deliveryId"`
}

* * Change triggered by the following update actions: * * - [Remove Parcel From Delivery](ctp:api:type:OrderRemoveParcelFromDeliveryAction) on Orders. * - [Remove Parcel From Delivery](ctp:api:type:StagedOrderRemoveParcelFromDeliveryAction) on Staged Orders. *

func (RemoveParcelFromDeliveryChange) MarshalJSON

func (obj RemoveParcelFromDeliveryChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemovePaymentChange

type RemovePaymentChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue PaymentInfo `json:"previousValue"`
	// Value after the change.
	NextValue PaymentInfo `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Remove Payment](ctp:api:type:OrderRemovePaymentAction) on Orders. * - [Remove Payment](ctp:api:type:StagedOrderRemovePaymentAction) on Staged Orders. *

func (RemovePaymentChange) MarshalJSON

func (obj RemovePaymentChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemovePriceChange

type RemovePriceChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Price `json:"previousValue"`
	// Value after the change.
	NextValue Price `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
	// `id` of the Embedded [Price](ctp:api:type:Price).
	PriceId string `json:"priceId"`
}

* * Change triggered by the [Remove Embedded Price](ctp:api:type:ProductRemovePriceAction) update action.

func (RemovePriceChange) MarshalJSON

func (obj RemovePriceChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveProductChange added in v1.2.0

type RemoveProductChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Reference `json:"previousValue"`
}

* * Change triggered by the [Remove Product](ctp:api:type:ProductSelectionRemoveProductAction) update action.

func (RemoveProductChange) MarshalJSON added in v1.2.0

func (obj RemoveProductChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveProductSelectionChange added in v1.5.0

type RemoveProductSelectionChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue ProductSelectionSetting `json:"previousValue"`
}

* * Change triggered by the [Remove Product Selection](ctp:api:type:StoreRemoveProductSelectionAction) update action.

func (RemoveProductSelectionChange) MarshalJSON added in v1.5.0

func (obj RemoveProductSelectionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemovePropertyChange

type RemovePropertyChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue interface{} `json:"previousValue"`
	// Path to the property that was removed.
	Path string `json:"path"`
}

* * Change triggered by the [Update CustomObject](ctp:api:endpoint:/{projectKey}/custom-objects:POST) request when an existing property is removed.

func (RemovePropertyChange) MarshalJSON

func (obj RemovePropertyChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveShippingAddressIdChange

type RemoveShippingAddressIdChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []string `json:"previousValue"`
	// Value after the change.
	NextValue []string `json:"nextValue"`
	// Address removed from `shippingAddressesIds`.
	Address Address `json:"address"`
}

* * Change triggered by the [Remove Shipping Address ID](ctp:api:type:CustomerRemoveShippingAddressIdAction) update action.

func (RemoveShippingAddressIdChange) MarshalJSON

func (obj RemoveShippingAddressIdChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveShoppingListLineItemChange

type RemoveShoppingListLineItemChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LineItem `json:"previousValue"`
	// Value after the change.
	NextValue LineItem `json:"nextValue"`
}

* * Change triggered by the [Remove ShoppingListLineItem](ctp:api:type:ShoppingListRemoveLineItemAction) update action.

func (RemoveShoppingListLineItemChange) MarshalJSON

func (obj RemoveShoppingListLineItemChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveStateRolesChange

type RemoveStateRolesChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []StateRoleEnum `json:"previousValue"`
	// Value after the change.
	NextValue []StateRoleEnum `json:"nextValue"`
}

* * Change triggered by the [Remove State roles](ctp:api:type:StateRemoveRolesAction) update action.

func (RemoveStateRolesChange) MarshalJSON

func (obj RemoveStateRolesChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveTaxRateChange

type RemoveTaxRateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue TaxRate `json:"previousValue"`
}

* * Change triggered by the [Remove TaxRate](ctp:api:type:TaxCategoryRemoveTaxRateAction) update action.

func (RemoveTaxRateChange) MarshalJSON

func (obj RemoveTaxRateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveTextLineItemChange

type RemoveTextLineItemChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue TextLineItem `json:"previousValue"`
	// Value after the change.
	NextValue TextLineItem `json:"nextValue"`
}

* * Change triggered by the [Remove TextLineItem](ctp:api:type:ShoppingListRemoveTextLineItemAction) update action.

func (RemoveTextLineItemChange) MarshalJSON

func (obj RemoveTextLineItemChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RemoveVariantChange

type RemoveVariantChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Variant `json:"previousValue"`
	// Value after the change.
	NextValue Variant `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
}

* * Change triggered by the [Remove ProductVariant](ctp:api:type:ProductRemoveVariantAction) update action.

func (RemoveVariantChange) MarshalJSON

func (obj RemoveVariantChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type RequestQuoteRenegotiationChange added in v1.5.0

type RequestQuoteRenegotiationChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue QuoteState `json:"previousValue"`
	// Value after the change.
	NextValue QuoteState `json:"nextValue"`
	// Message from the [Buyer](/../api/quotes-overview#buyer) regarding the [Quote](ctp:api:type:Quote) renegotiation request.
	BuyerComment string `json:"buyerComment"`
}

* * Change triggered by the [Request Quote Renegotiation](ctp:api:type:QuoteRequestQuoteRenegotiationAction) update action. *

func (RequestQuoteRenegotiationChange) MarshalJSON added in v1.5.0

func (obj RequestQuoteRenegotiationChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type Reservation

type Reservation struct {
	Quantity          int       `json:"quantity"`
	Owner             Reference `json:"owner"`
	CreatedAt         string    `json:"createdAt"`
	CheckoutStartedAt string    `json:"checkoutStartedAt"`
}

type ResourceIdentifier added in v1.5.0

type ResourceIdentifier struct {
	ID     string          `json:"id"`
	Key    string          `json:"key"`
	TypeId ReferenceTypeId `json:"typeId"`
}

type ReturnInfo

type ReturnInfo struct {
	Items []ReturnItem `json:"items"`
	// Identifies, which return tracking ID is connected to this particular return.
	ReturnTrackingId string `json:"returnTrackingId"`
	ReturnDate       string `json:"returnDate"`
}

type ReturnItem

type ReturnItem struct {
	ID             string              `json:"id"`
	Quantity       int                 `json:"quantity"`
	Type           string              `json:"type"`
	Comment        string              `json:"comment"`
	ShipmentState  ReturnShipmentState `json:"shipmentState"`
	PaymentState   ReturnPaymentState  `json:"paymentState"`
	LastModifiedAt string              `json:"lastModifiedAt"`
	CreatedAt      string              `json:"createdAt"`
}

type ReturnPaymentState

type ReturnPaymentState string
const (
	ReturnPaymentStateNonRefundable ReturnPaymentState = "NonRefundable"
	ReturnPaymentStateInitial       ReturnPaymentState = "Initial"
	ReturnPaymentStateRefunded      ReturnPaymentState = "Refunded"
	ReturnPaymentStateNotRefunded   ReturnPaymentState = "NotRefunded"
)

type ReturnShipmentState

type ReturnShipmentState string
const (
	ReturnShipmentStateAdvised     ReturnShipmentState = "Advised"
	ReturnShipmentStateReturned    ReturnShipmentState = "Returned"
	ReturnShipmentStateBackInStock ReturnShipmentState = "BackInStock"
	ReturnShipmentStateUnusable    ReturnShipmentState = "Unusable"
)

type ReviewLabel

type ReviewLabel struct {
	// User-defined unique identifier of the Review.
	Key string `json:"key"`
	// Title of the Review.
	Title string `json:"title"`
}

func (ReviewLabel) MarshalJSON

func (obj ReviewLabel) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ReviewRatingStatistics

type ReviewRatingStatistics struct {
	// Average rating of one target This number is rounded with 5 decimals.
	AverageRating int `json:"averageRating"`
	// Highest rating of one target
	HighestRating int `json:"highestRating"`
	// Lowest rating of one target
	LowestRating int `json:"lowestRating"`
	// Number of ratings taken into account
	Count int `json:"count"`
	// The full distribution of the ratings. The keys are the different ratings and the values are the count of reviews having this rating. Only the used ratings appear in this object.
	RatingsDistribution interface{} `json:"ratingsDistribution"`
}

type RoundingMode

type RoundingMode string
const (
	RoundingModeHalfEven RoundingMode = "HalfEven"
	RoundingModeHalfUp   RoundingMode = "HalfUp"
	RoundingModeHalfDown RoundingMode = "HalfDown"
)

type SearchKeyword

type SearchKeyword struct {
	Text             string           `json:"text"`
	SuggestTokenizer SuggestTokenizer `json:"suggestTokenizer"`
}

type SearchKeywords

type SearchKeywords map[string][]SearchKeyword

type SelectionMode

type SelectionMode string
const (
	SelectionModeCheapest      SelectionMode = "Cheapest"
	SelectionModeMostExpensive SelectionMode = "MostExpensive"
)

type SetAddressChange

type SetAddressChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Address `json:"previousValue"`
	// Value after the change.
	NextValue Address `json:"nextValue"`
}

* * Change triggered by the [Set Address](ctp:api:type:ChannelSetAddressAction) update action.

func (SetAddressChange) MarshalJSON

func (obj SetAddressChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetAddressCustomFieldChange added in v1.5.0

type SetAddressCustomFieldChange struct {
	Change string `json:"change"`
	// [Address](ctp:api:type:Address) which was extended.
	Address Address `json:"address"`
	// Name of the [Custom Field](ctp:api:type:CustomFields).
	Name string `json:"name"`
	// `id` of the referenced [Type](ctp:api:type:Type).
	CustomTypeId string `json:"customTypeId"`
	// Value before the change.
	PreviousValue interface{} `json:"previousValue"`
	// Value after the change.
	NextValue interface{} `json:"nextValue"`
}

* * Change triggered by the [Set Address Custom Field](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. *

func (SetAddressCustomFieldChange) MarshalJSON added in v1.5.0

func (obj SetAddressCustomFieldChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetAddressCustomTypeChange added in v1.5.0

type SetAddressCustomTypeChange struct {
	Change string `json:"change"`
	// [Address](ctp:api:type:Address) which was extended.
	Address Address `json:"address"`
	// Value before the change.
	PreviousValue CustomFields `json:"previousValue"`
	// Value after the change.
	NextValue CustomFields `json:"nextValue"`
}

* * Change triggered by the [Set Address Custom Type](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action.

func (SetAddressCustomTypeChange) MarshalJSON added in v1.5.0

func (obj SetAddressCustomTypeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetAnonymousIdChange

type SetAnonymousIdChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set AnonymousId](ctp:api:type:PaymentSetAnonymousIdAction) on Payments. * - [Set AnonymousId](ctp:api:type:ShoppingListSetAnonymousIdAction) on Shopping Lists. *

func (SetAnonymousIdChange) MarshalJSON

func (obj SetAnonymousIdChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetApplicationVersionChange

type SetApplicationVersionChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue int `json:"previousValue"`
	// Value after the change.
	NextValue int `json:"nextValue"`
}

* * Change triggered automatically due to a user-initiated change.

func (SetApplicationVersionChange) MarshalJSON

func (obj SetApplicationVersionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetAssetCustomFieldChange

type SetAssetCustomFieldChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue interface{} `json:"previousValue"`
	// Value after the change.
	NextValue interface{} `json:"nextValue"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// `id` of the referenced [Type](ctp:api:type:Type).
	CustomTypeId string `json:"customTypeId"`
	// Information about the updated Asset.
	Asset AssetChangeValue `json:"asset"`
}

* * Change triggered by the following update actions: * * - [Set Asset CustomField](ctp:api:type:CategorySetAssetCustomFieldAction) on Categories. * - [Set Asset CustomField](ctp:api:type:ProductSetAssetCustomFieldAction) on Products. *

func (SetAssetCustomFieldChange) MarshalJSON

func (obj SetAssetCustomFieldChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetAssetCustomTypeChange

type SetAssetCustomTypeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue CustomFields `json:"previousValue"`
	// Value after the change.
	NextValue CustomFields `json:"nextValue"`
	// Information about the updated Asset.
	Asset AssetChangeValue `json:"asset"`
}

* * Change triggered by the following update actions: * * - [Set Asset Custom Type](ctp:api:type:CategorySetAssetCustomTypeAction) on Categories. * - [Set Asset Custom Type](ctp:api:type:ProductSetAssetCustomTypeAction) on Products. *

func (SetAssetCustomTypeChange) MarshalJSON

func (obj SetAssetCustomTypeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetAssetDescriptionChange

type SetAssetDescriptionChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
	// Information about the updated Asset.
	Asset AssetChangeValue `json:"asset"`
}

* * Change triggered by the following update actions: * * - [Set Asset Description](ctp:api:type:CategorySetAssetDescriptionAction) on Categories. * - [Set Asset Description](ctp:api:type:ProductSetAssetDescriptionAction) on Products. *

func (SetAssetDescriptionChange) MarshalJSON

func (obj SetAssetDescriptionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetAssetKeyChange

type SetAssetKeyChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
	// Information about the updated Asset.
	Asset AssetChangeValue `json:"asset"`
}

* * Change triggered by the following update actions: * * - [Set Asset Key](ctp:api:type:CategorySetAssetKeyAction) on Categories. * - [Set Asset Key](ctp:api:type:ProductSetAssetKeyAction) on Products. *

func (SetAssetKeyChange) MarshalJSON

func (obj SetAssetKeyChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetAssetSourcesChange

type SetAssetSourcesChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []AssetSource `json:"previousValue"`
	// Value after the change.
	NextValue []AssetSource `json:"nextValue"`
	// Information about the updated Asset.
	Asset AssetChangeValue `json:"asset"`
}

* * Change triggered by the following update actions: * * - [Set Asset Sources](ctp:api:type:CategorySetAssetSourcesAction) on Categories. * - [Set Asset Sources](ctp:api:type:ProductSetAssetSourcesAction) on Products. *

func (SetAssetSourcesChange) MarshalJSON

func (obj SetAssetSourcesChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetAssetTagsChange

type SetAssetTagsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []string `json:"previousValue"`
	// Value after the change.
	NextValue []string `json:"nextValue"`
	// Information about the updated Asset.
	Asset AssetChangeValue `json:"asset"`
}

* * Change triggered by the following update actions: * * - [Change Asset Tags](ctp:api:type:CategorySetAssetTagsAction) on Categories. * - [Change Asset Tags](ctp:api:type:ProductSetAssetTagsAction) on Products. *

func (SetAssetTagsChange) MarshalJSON

func (obj SetAssetTagsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetAttributeChange

type SetAttributeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue AttributeValue `json:"previousValue"`
	// Value after the change.
	NextValue AttributeValue `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
}

* * Change triggered by the [Set Attribute](ctp:api:type:ProductSetAttributeAction) update action.

func (SetAttributeChange) MarshalJSON

func (obj SetAttributeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetAuthenticationModeChange added in v1.2.0

type SetAuthenticationModeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue AuthenticationMode `json:"previousValue"`
	// Value after the change.
	NextValue AuthenticationMode `json:"nextValue"`
}

* * Change triggered by the [Set AuthenticationMode](ctp:api:type:CustomerSetAuthenticationModeAction) update action.

func (SetAuthenticationModeChange) MarshalJSON added in v1.2.0

func (obj SetAuthenticationModeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetAuthorNameChange

type SetAuthorNameChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set Author Name](ctp:api:type:ReviewSetAuthorNameAction) update action.

func (SetAuthorNameChange) MarshalJSON

func (obj SetAuthorNameChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetBillingAddressChange

type SetBillingAddressChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Address `json:"previousValue"`
	// Value after the change.
	NextValue Address `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Billing Address](ctp:api:type:OrderSetBillingAddressAction) on Orders. * - [Set Billing Address](ctp:api:type:StagedOrderSetBillingAddressAction) on Staged Orders. *

func (SetBillingAddressChange) MarshalJSON

func (obj SetBillingAddressChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCartClassificationShippingRateInputValue

type SetCartClassificationShippingRateInputValue struct {
	Type string `json:"type"`
	// Key of the value used as a programmatic identifier.
	Key string `json:"key"`
	// Descriptive localized label of the value.
	Label LocalizedString `json:"label"`
}

type SetCartPredicateChange

type SetCartPredicateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set Cart Predicate](ctp:api:type:DiscountCodeSetCartPredicateAction) update action.

func (SetCartPredicateChange) MarshalJSON

func (obj SetCartPredicateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCartScoreShippingRateInputValue

type SetCartScoreShippingRateInputValue struct {
	Type string `json:"type"`
	// Abstract value for categorizing a Cart.
	Score int `json:"score"`
}

type SetCategoryOrderHintChange

type SetCategoryOrderHintChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue CategoryOrderHints `json:"previousValue"`
	// Value after the change.
	NextValue CategoryOrderHints `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
	// `id` of the updated [Category](ctp:api:type:Category).
	CategoryId string `json:"categoryId"`
}

* * Change triggered by the [Set Category Order Hint](ctp:api:type:ProductSetCategoryOrderHintAction) update action.

func (SetCategoryOrderHintChange) MarshalJSON

func (obj SetCategoryOrderHintChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetChannelRolesChange

type SetChannelRolesChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []ChannelRoleEnum `json:"previousValue"`
	// Value after the change.
	NextValue []ChannelRoleEnum `json:"nextValue"`
}

* * Change triggered by the [Set Roles](ctp:api:type:ChannelSetRolesAction) update action.

func (SetChannelRolesChange) MarshalJSON

func (obj SetChannelRolesChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCompanyNameChange

type SetCompanyNameChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set Company Name](ctp:api:type:CustomerSetCompanyNameAction) update action.

func (SetCompanyNameChange) MarshalJSON

func (obj SetCompanyNameChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetContactEmailChange added in v1.5.0

type SetContactEmailChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set Contact Email](ctp:api:type:BusinessUnitSetContactEmailAction) update action.

func (SetContactEmailChange) MarshalJSON added in v1.5.0

func (obj SetContactEmailChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCountriesChange added in v1.3.0

type SetCountriesChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []StoreCountry `json:"previousValue"`
	// Value after the change.
	NextValue []StoreCountry `json:"nextValue"`
}

* * Change triggered by the [Set Countries](ctp:api:type:StoreSetCountriesAction) update action.

func (SetCountriesChange) MarshalJSON added in v1.3.0

func (obj SetCountriesChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCountryChange

type SetCountryChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set Country](ctp:api:type:StagedOrderSetCountryAction) update action.

func (SetCountryChange) MarshalJSON

func (obj SetCountryChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomFieldChange

type SetCustomFieldChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue interface{} `json:"previousValue"`
	// Value after the change.
	NextValue interface{} `json:"nextValue"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// `id` of the referenced [Type](ctp:api:type:Type).
	CustomTypeId string `json:"customTypeId"`
}

* * Change triggered by the following update actions: * * - [Set CustomField](ctp:api:type:CartDiscountSetCustomFieldAction) on Cart Discounts. * - [Set CustomField](ctp:api:type:CategorySetCustomFieldAction) on Categories. * - [Set CustomField](ctp:api:type:ChannelSetCustomFieldAction) on Channels. * - [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) on Customers. * - [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) on Customer Groups. * - [Set CustomField](ctp:api:type:DiscountCodeSetCustomFieldAction) on Discount Codes. * - [Set CustomField](ctp:api:type:InventoryEntrySetCustomFieldAction) on Inventories. * - [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) on Orders. * - [Set CustomField](ctp:api:type:OrderEditSetCustomFieldAction) on Order Edits. * - [Set CustomField](ctp:api:type:PaymentSetCustomFieldAction) on Payments. * - [Set CustomField](ctp:api:type:ProductSelectionSetCustomFieldAction) on Product Selections. * - [Set CustomField](ctp:api:type:QuoteSetCustomFieldAction) on Quotes. * - [Set CustomField](ctp:api:type:QuoteRequestSetCustomFieldAction) on Quote Requests. * - [Set CustomField](ctp:api:type:ReviewSetCustomFieldAction) on Reviews. * - [Set CustomField](ctp:api:type:ShoppingListSetCustomFieldAction) on Shopping Lists. * - [Set CustomField](ctp:api:type:StagedOrderSetCustomFieldAction) on Staged Orders. * - [Set CustomField](ctp:api:type:StagedQuoteSetCustomFieldAction) on Staged Quotes. * - [Set CustomField](ctp:api:type:StoreSetCustomFieldAction) on Stores. *

func (SetCustomFieldChange) MarshalJSON

func (obj SetCustomFieldChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomLineItemCustomFieldChange

type SetCustomLineItemCustomFieldChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue interface{} `json:"previousValue"`
	// Value after the change.
	NextValue interface{} `json:"nextValue"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItem LocalizedString `json:"customLineItem"`
	// `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
}

* * Change triggered by the following update actions: * * - [Set CustomLineItem Custom Type](ctp:api:type:OrderSetCustomLineItemCustomFieldAction) on Orders. * - [Set CustomLineItem Custom Type](ctp:api:type:StagedOrderSetCustomLineItemCustomFieldAction) on Staged Orders. *

func (SetCustomLineItemCustomFieldChange) MarshalJSON

func (obj SetCustomLineItemCustomFieldChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomLineItemCustomTypeChange

type SetCustomLineItemCustomTypeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue CustomFields `json:"previousValue"`
	// Value after the change.
	NextValue CustomFields `json:"nextValue"`
	// Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItem LocalizedString `json:"customLineItem"`
	// `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
}

* * Change triggered by the following update actions: * * - [Set CustomLineItem CustomField](ctp:api:type:OrderSetCustomLineItemCustomTypeAction) on Orders. * - [Set CustomLineItem CustomField](ctp:api:type:StagedOrderSetCustomLineItemCustomTypeAction) on Staged Orders. *

func (SetCustomLineItemCustomTypeChange) MarshalJSON

func (obj SetCustomLineItemCustomTypeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomLineItemMoneyChange

type SetCustomLineItemMoneyChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Money `json:"previousValue"`
	// Value after the change.
	NextValue Money `json:"nextValue"`
	// Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItem LocalizedString `json:"customLineItem"`
	// `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
}

* * Change triggered by the [Set CustomLineItem Money](ctp:api:type:StagedOrderChangeCustomLineItemMoneyAction) update action.

func (SetCustomLineItemMoneyChange) MarshalJSON

func (obj SetCustomLineItemMoneyChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomLineItemShippingDetailsChange

type SetCustomLineItemShippingDetailsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue ItemShippingDetails `json:"previousValue"`
	// Value after the change.
	NextValue ItemShippingDetails `json:"nextValue"`
	// `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
}

* * Change triggered by the following update actions: * * - [Set CustomLineItem ShippingDetails](ctp:api:type:OrderSetCustomLineItemShippingDetailsAction) on Orders. * - [Set CustomLineItem ShippingDetails](ctp:api:type:StagedOrderSetCustomLineItemShippingDetailsAction) on Staged Orders. *

func (SetCustomLineItemShippingDetailsChange) MarshalJSON

func (obj SetCustomLineItemShippingDetailsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomLineItemTaxAmountChange

type SetCustomLineItemTaxAmountChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue TaxRate `json:"previousValue"`
	// Value after the change.
	NextValue TaxRate `json:"nextValue"`
	// Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItem LocalizedString `json:"customLineItem"`
	// `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
	// `"ExternalAmount"`
	TaxMode TaxMode `json:"taxMode"`
}

* * Change triggered by the [Set CustomLineItem TaxAmount](ctp:api:type:StagedOrderSetCustomLineItemTaxAmountAction) update action.

func (SetCustomLineItemTaxAmountChange) MarshalJSON

func (obj SetCustomLineItemTaxAmountChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomLineItemTaxCategoryChange

type SetCustomLineItemTaxCategoryChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Reference `json:"previousValue"`
	// Value after the change.
	NextValue Reference `json:"nextValue"`
	// Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItem LocalizedString `json:"customLineItem"`
	// `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
}

func (SetCustomLineItemTaxCategoryChange) MarshalJSON

func (obj SetCustomLineItemTaxCategoryChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomLineItemTaxRateChange

type SetCustomLineItemTaxRateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue TaxRate `json:"previousValue"`
	// Value after the change.
	NextValue TaxRate `json:"nextValue"`
	// Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItem LocalizedString `json:"customLineItem"`
	// `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
	// `"External"`
	TaxMode TaxMode `json:"taxMode"`
}

* * Change triggered by the [Set CustomLineItem TaxRate](ctp:api:type:StagedOrderSetCustomLineItemTaxRateAction) update action.

func (SetCustomLineItemTaxRateChange) MarshalJSON

func (obj SetCustomLineItemTaxRateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomLineItemTaxedPriceChange

type SetCustomLineItemTaxedPriceChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Money `json:"previousValue"`
	// Value after the change.
	NextValue Money `json:"nextValue"`
	// Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItem LocalizedString `json:"customLineItem"`
	// `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
}

func (SetCustomLineItemTaxedPriceChange) MarshalJSON

func (obj SetCustomLineItemTaxedPriceChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomLineItemTotalPriceChange

type SetCustomLineItemTotalPriceChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Money `json:"previousValue"`
	// Value after the change.
	NextValue Money `json:"nextValue"`
	// Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItem LocalizedString `json:"customLineItem"`
	// `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	CustomLineItemId string `json:"customLineItemId"`
}

func (SetCustomLineItemTotalPriceChange) MarshalJSON

func (obj SetCustomLineItemTotalPriceChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomShippingMethodChange

type SetCustomShippingMethodChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue CustomShippingMethodChangeValue `json:"previousValue"`
	// Value after the change.
	NextValue CustomShippingMethodChangeValue `json:"nextValue"`
}

* * Change triggered by the [Set Custom ShippingMethod](ctp:api:type:StagedOrderSetCustomShippingMethodAction) update action.

func (SetCustomShippingMethodChange) MarshalJSON

func (obj SetCustomShippingMethodChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomTypeChange

type SetCustomTypeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue CustomFields `json:"previousValue"`
	// Value after the change.
	NextValue CustomFields `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Custom Type](ctp:api:type:CartDiscountSetCustomTypeAction) on Cart Discounts. * - [Set Custom Type](ctp:api:type:CategorySetCustomTypeAction) on Categories. * - [Set Custom Type](ctp:api:type:ChannelSetCustomTypeAction) on Channels. * - [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) on Customers. * - [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) on Customer Groups. * - [Set Custom Type](ctp:api:type:DiscountCodeSetCustomTypeAction) on Discount Codes. * - [Set Custom Type](ctp:api:type:InventoryEntrySetCustomTypeAction) on Inventories. * - [Set Custom Type](ctp:api:type:OrderSetCustomTypeAction) on Orders. * - [Set Custom Type](ctp:api:type:OrderEditSetCustomTypeAction) on Order Edits. * - [Set Custom Type](ctp:api:type:StagedOrderSetCustomTypeAction) on Staged Orders. * - [Set Custom Type](ctp:api:type:PaymentSetCustomTypeAction) on Payments. * - [Set Custom Type](ctp:api:type:ProductSelectionSetCustomTypeAction) on Product Selections. * - [Set Custom Type](ctp:api:type:QuoteSetCustomTypeAction) on Quotes. * - [Set Custom Type](ctp:api:type:StagedQuoteSetCustomTypeAction) on Staged Quotes. * - [Set Custom Type](ctp:api:type:QuoteRequestSetCustomTypeAction) on Quote Requests. * - [Set Custom Type](ctp:api:type:ReviewSetCustomTypeAction) on Reviews. * - [Set Custom Type](ctp:api:type:ShoppingListSetCustomTypeAction) on Shopping Lists. * - [Set Custom Type](ctp:api:type:StoreSetCustomTypeAction) on Stores. *

func (SetCustomTypeChange) MarshalJSON

func (obj SetCustomTypeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomerChange

type SetCustomerChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Reference `json:"previousValue"`
	// Value after the change.
	NextValue Reference `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Customer](ctp:api:type:PaymentSetCustomerAction) on Payments. * - [Set Customer](ctp:api:type:ReviewSetCustomerAction) on Reviews. * - [Set Customer](ctp:api:type:ShoppingListSetCustomerAction) on Shopping Lists. *

func (SetCustomerChange) MarshalJSON

func (obj SetCustomerChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomerEmailChange

type SetCustomerEmailChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Customer Email](ctp:api:type:OrderSetCustomerEmailAction) on Orders. * - [Set Customer Email](ctp:api:type:StagedOrderSetCustomerEmailAction) on Staged Orders. *

func (SetCustomerEmailChange) MarshalJSON

func (obj SetCustomerEmailChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomerGroupChange

type SetCustomerGroupChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Reference `json:"previousValue"`
	// Value after the change.
	NextValue Reference `json:"nextValue"`
}

* * Change triggered by the [Set CustomerGroup](ctp:api:type:CustomerSetCustomerGroupAction) update action.

func (SetCustomerGroupChange) MarshalJSON

func (obj SetCustomerGroupChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomerIdChange

type SetCustomerIdChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Customer ID](ctp:api:type:OrderSetCustomerIdAction) on Orders. * - [Set Customer ID](ctp:api:type:StagedOrderSetCustomerIdAction) on Staged Orders. *

func (SetCustomerIdChange) MarshalJSON

func (obj SetCustomerIdChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetCustomerNumberChange

type SetCustomerNumberChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set Customer Number](ctp:api:type:CustomerSetCustomerNumberAction) update action.

func (SetCustomerNumberChange) MarshalJSON

func (obj SetCustomerNumberChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetDateOfBirthChange

type SetDateOfBirthChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set Date of Birth](ctp:api:type:CustomerSetDateOfBirthAction) update action.

func (SetDateOfBirthChange) MarshalJSON

func (obj SetDateOfBirthChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetDefaultBillingAddressChange

type SetDefaultBillingAddressChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Address `json:"previousValue"`
	// Value after the change.
	NextValue Address `json:"nextValue"`
}

* * Change triggered by the [Set Default Billing Address](ctp:api:type:CustomerSetDefaultBillingAddressAction) update action.

func (SetDefaultBillingAddressChange) MarshalJSON

func (obj SetDefaultBillingAddressChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetDefaultShippingAddressChange

type SetDefaultShippingAddressChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Address `json:"previousValue"`
	// Value after the change.
	NextValue Address `json:"nextValue"`
}

* * Change triggered by the [Set Default Shipping Address](ctp:api:type:CustomerSetDefaultShippingAddressAction) update action.

func (SetDefaultShippingAddressChange) MarshalJSON

func (obj SetDefaultShippingAddressChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetDeleteDaysAfterLastModificationChange

type SetDeleteDaysAfterLastModificationChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue int `json:"previousValue"`
	// Value after the change.
	NextValue int `json:"nextValue"`
}

* * Change triggered by the [Set DeleteDaysAfterLastModification](ctp:api:type:ShoppingListSetDeleteDaysAfterLastModificationAction) update action.

func (SetDeleteDaysAfterLastModificationChange) MarshalJSON

func (obj SetDeleteDaysAfterLastModificationChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetDeliveryAddressChange

type SetDeliveryAddressChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Address `json:"previousValue"`
	// Value after the change.
	NextValue Address `json:"nextValue"`
	// `id` of the updated [Delivery](ctp:api:type:Delivery).
	DeliveryId string `json:"deliveryId"`
}

* * Change triggered by the following update actions: * * - [Set DeliveryAddress](ctp:api:type:OrderSetDeliveryAddressAction) on Orders. * - [Set DeliveryAddress](ctp:api:type:StagedOrderSetDeliveryAddressAction) on Staged Orders. *

func (SetDeliveryAddressChange) MarshalJSON

func (obj SetDeliveryAddressChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetDeliveryItemsChange

type SetDeliveryItemsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []DeliveryItem `json:"previousValue"`
	// Value after the change.
	NextValue []DeliveryItem `json:"nextValue"`
	// `id` of the updated [Delivery](ctp:api:type:Delivery).
	DeliveryId string `json:"deliveryId"`
}

* * Change triggered by the following update actions: * * - [Set Delivery Items](ctp:api:type:OrderSetDeliveryItemsAction) on Orders. * - [Set Delivery Items](ctp:api:type:StagedOrderSetDeliveryItemsAction) on Staged Orders. *

func (SetDeliveryItemsChange) MarshalJSON

func (obj SetDeliveryItemsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetDescriptionChange

type SetDescriptionChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Description](ctp:api:type:TaxCategorySetDescriptionAction) on Tax Categories. * - [Set Description](ctp:api:type:ZoneSetDescriptionAction) on Zones. *

func (SetDescriptionChange) MarshalJSON

func (obj SetDescriptionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetDiscountedPriceChange

type SetDiscountedPriceChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Price `json:"previousValue"`
	// Value after the change.
	NextValue Price `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
	// `sku` or `key` of the updated [ProductVariant](ctp:api:type:ProductVariant).
	Variant string `json:"variant"`
	// `id` of the Embedded [Price](ctp:api:type:Price).
	PriceId string `json:"priceId"`
}

* * Change triggered by the [Set Discounted Embedded Price](ctp:api:type:ProductSetDiscountedPriceAction) update action.

func (SetDiscountedPriceChange) MarshalJSON

func (obj SetDiscountedPriceChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetDistributionChannelsChange

type SetDistributionChannelsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []Reference `json:"previousValue"`
	// Value after the change.
	NextValue []Reference `json:"nextValue"`
}

* * Change triggered by the [Set Distribution Channels](ctp:api:type:StoreSetDistributionChannelsAction) update action.

func (SetDistributionChannelsChange) MarshalJSON

func (obj SetDistributionChannelsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetExpectedDeliveryChange

type SetExpectedDeliveryChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set ExpectedDelivery](ctp:api:type:InventoryEntrySetExpectedDeliveryAction) update action.

func (SetExpectedDeliveryChange) MarshalJSON

func (obj SetExpectedDeliveryChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetExternalIdChange

type SetExternalIdChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set External ID](ctp:api:type:CategorySetExternalIdAction) on Categories. * - [Set External ID](ctp:api:type:CustomerSetExternalIdAction) on Customers. *

func (SetExternalIdChange) MarshalJSON

func (obj SetExternalIdChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetFirstNameChange

type SetFirstNameChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set First Name](ctp:api:type:CustomerSetFirstNameAction) update action.

func (SetFirstNameChange) MarshalJSON

func (obj SetFirstNameChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetGeoLocationChange

type SetGeoLocationChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue GeoLocation `json:"previousValue"`
	// Value after the change.
	NextValue GeoLocation `json:"nextValue"`
}

* * Change triggered by the [Set GeoLocation](ctp:api:type:ChannelSetGeoLocationAction) update action.

func (SetGeoLocationChange) MarshalJSON

func (obj SetGeoLocationChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetImageLabelChange

type SetImageLabelChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Image `json:"previousValue"`
	// Value after the change.
	NextValue Image `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
}

* * Change triggered by the [Set Image Label](ctp:api:type:ProductSetImageLabelAction) update action.

func (SetImageLabelChange) MarshalJSON

func (obj SetImageLabelChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetInputTipChange

type SetInputTipChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
	// Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition).
	AttributeName string `json:"attributeName"`
}

* * Change triggered by the [Set AttributeDefinition InputTip](ctp:api:type:ProductTypeSetInputTipAction) update action.

func (SetInputTipChange) MarshalJSON

func (obj SetInputTipChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetInterfaceIdChange

type SetInterfaceIdChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set InterfaceId](ctp:api:type:PaymentSetInterfaceIdAction) update action.

func (SetInterfaceIdChange) MarshalJSON

func (obj SetInterfaceIdChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetIsValidChange

type SetIsValidChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue bool `json:"previousValue"`
	// Value after the change.
	NextValue bool `json:"nextValue"`
}

* * Change triggered automatically due to a user-initiated change.

func (SetIsValidChange) MarshalJSON

func (obj SetIsValidChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetKeyChange

type SetKeyChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Key](ctp:api:type:CartDiscountSetKeyAction) on Cart Discounts. * - [Set Key](ctp:api:type:CategorySetKeyAction) on Categories. * - [Set Key](ctp:api:type:CustomerSetKeyAction) on Customers. * - [Set Key](ctp:api:type:CustomerGroupSetKeyAction) on Customer Groups. * - [Set Key](ctp:api:type:PaymentSetKeyAction) on Payments. * - [Set Key](ctp:api:type:ProductSetKeyAction) on Products. * - [Set Key](ctp:api:type:ProductDiscountSetKeyAction) on Product Discounts. * - [Set Key](ctp:api:type:ProductSelectionSetKeyAction) on Product Selections. * - [Set Key](ctp:api:type:ProductTypeSetKeyAction) on Product Types. * - [Set Key](ctp:api:type:ReviewSetKeyAction) on Reviews. * - [Set Key](ctp:api:type:ShoppingListSetKeyAction) on Shopping Lists. * - [Set Key](ctp:api:type:ZoneSetKeyAction) on Zones. *

func (SetKeyChange) MarshalJSON

func (obj SetKeyChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLanguagesChange

type SetLanguagesChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []string `json:"previousValue"`
	// Value after the change.
	NextValue []string `json:"nextValue"`
}

* * Change triggered by [Set Languages](ctp:api:type:StoreSetLanguagesAction) update action.

func (SetLanguagesChange) MarshalJSON

func (obj SetLanguagesChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLastNameChange

type SetLastNameChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by [Set Last Name](ctp:api:type:CustomerSetLastNameAction) update action.

func (SetLastNameChange) MarshalJSON

func (obj SetLastNameChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLineItemDeactivatedAtChange added in v1.2.0

type SetLineItemDeactivatedAtChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
	// Holds information about the updated Shopping List Line Item.
	LineItem ShoppingListLineItemValue `json:"lineItem"`
}

func (SetLineItemDeactivatedAtChange) MarshalJSON added in v1.2.0

func (obj SetLineItemDeactivatedAtChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLineItemDiscountedPriceChange

type SetLineItemDiscountedPriceChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue DiscountedLineItemPrice `json:"previousValue"`
	// Value after the change.
	NextValue DiscountedLineItemPrice `json:"nextValue"`
	// Name of the [Product](ctp:api:type:Product) the Line Item is based on.
	LineItem LocalizedString `json:"lineItem"`
	// `sku` or `key` of the updated [ProductVariant](ctp:api:type:ProductVariant).
	Variant string `json:"variant"`
}

func (SetLineItemDiscountedPriceChange) MarshalJSON

func (obj SetLineItemDiscountedPriceChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLineItemDiscountedPricePerQuantityChange

type SetLineItemDiscountedPricePerQuantityChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue DiscountedLineItemPriceForQuantity `json:"previousValue"`
	// Value after the change.
	NextValue DiscountedLineItemPriceForQuantity `json:"nextValue"`
	// Name of the [Product](ctp:api:type:Product) the Line Item is based on.
	LineItem LocalizedString `json:"lineItem"`
	// `sku` or `key` of the updated [ProductVariant](ctp:api:type:ProductVariant).
	Variant string `json:"variant"`
}

func (SetLineItemDiscountedPricePerQuantityChange) MarshalJSON

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLineItemDistributionChannelChange

type SetLineItemDistributionChannelChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Reference `json:"previousValue"`
	// Value after the change.
	NextValue Reference `json:"nextValue"`
	// Name of the [Product](ctp:api:type:Product) the Line Item is based on.
	LineItem LocalizedString `json:"lineItem"`
	// `sku` or `key` of the updated [ProductVariant](ctp:api:type:ProductVariant).
	Variant string `json:"variant"`
}

* * Change triggered by the [Set LineItem DistributionChannel](ctp:api:type:StagedOrderSetLineItemDistributionChannelAction) update action.

func (SetLineItemDistributionChannelChange) MarshalJSON

func (obj SetLineItemDistributionChannelChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLineItemPriceChange

type SetLineItemPriceChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Price `json:"previousValue"`
	// Value after the change.
	NextValue Price `json:"nextValue"`
	// Name of the [Product](ctp:api:type:Product) the updated Line Item is based on.
	LineItem LocalizedString `json:"lineItem"`
}

* * Change triggered by the [Set LineItem Price](ctp:api:type:StagedOrderSetLineItemPriceAction) update action.

func (SetLineItemPriceChange) MarshalJSON

func (obj SetLineItemPriceChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLineItemProductKeyChange added in v1.2.0

type SetLineItemProductKeyChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
	// Name of the [Product](ctp:api:type:Product) the Line Item is based on.
	LineItem LocalizedString `json:"lineItem"`
	// `id` of the updated [LineItem](ctp:api:type:LineItem).
	LineItemId string `json:"lineItemId"`
	// `sku` or `key` of the updated [ProductVariant](ctp:api:type:ProductVariant).
	Variant string `json:"variant"`
}

func (SetLineItemProductKeyChange) MarshalJSON added in v1.2.0

func (obj SetLineItemProductKeyChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLineItemProductSlugChange

type SetLineItemProductSlugChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
	// Name of the [Product](ctp:api:type:Product) the updated Line Item is based on.
	LineItem LocalizedString `json:"lineItem"`
	// `sku` or `key` of the updated [ProductVariant](ctp:api:type:ProductVariant).
	Variant string `json:"variant"`
}

* * Change triggered automatically due to a user-initiated change.

func (SetLineItemProductSlugChange) MarshalJSON

func (obj SetLineItemProductSlugChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLineItemShippingDetailsChange

type SetLineItemShippingDetailsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue ItemShippingDetails `json:"previousValue"`
	// Value after the change.
	NextValue ItemShippingDetails `json:"nextValue"`
	// `id` of the updated [LineItem](ctp:api:type:LineItem).
	LineItemId string `json:"lineItemId"`
}

* * Change triggered by the following update actions: * * - [Set LineItem ShippingDetails](ctp:api:type:OrderSetLineItemShippingDetailsAction) on Orders. * - [Set LineItem ShippingDetails](ctp:api:type:StagedOrderSetLineItemShippingDetailsAction) on Staged Orders. *

func (SetLineItemShippingDetailsChange) MarshalJSON

func (obj SetLineItemShippingDetailsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLineItemTaxAmountChange

type SetLineItemTaxAmountChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue TaxRate `json:"previousValue"`
	// Value after the change.
	NextValue TaxRate `json:"nextValue"`
	// Name of the [Product](ctp:api:type:Product) the Line Item is based on.
	LineItem LocalizedString `json:"lineItem"`
	// `sku` or `key` of the [ProductVariant](ctp:api:type:ProductVariant).
	Variant string `json:"variant"`
	// `"ExternalAmount"`
	TaxMode TaxMode `json:"taxMode"`
}

* * Change triggered by the [Set LineItem TaxAmount](ctp:api:type:StagedOrderSetLineItemTaxAmountAction) update action.

func (SetLineItemTaxAmountChange) MarshalJSON

func (obj SetLineItemTaxAmountChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLineItemTaxRateChange

type SetLineItemTaxRateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue TaxRate `json:"previousValue"`
	// Value after the change.
	NextValue TaxRate `json:"nextValue"`
	// Name of the [Product](ctp:api:type:Product) the Line Item is based on.
	LineItem LocalizedString `json:"lineItem"`
	// `sku` or `key` of the [ProductVariant](ctp:api:type:ProductVariant).
	Variant string `json:"variant"`
	// `"External"`
	TaxMode TaxMode `json:"taxMode"`
}

* * Change triggered by the [Set LineItemTaxRate](ctp:api:type:StagedOrderSetLineItemTaxRateAction) update action.

func (SetLineItemTaxRateChange) MarshalJSON

func (obj SetLineItemTaxRateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLineItemTaxedPriceChange

type SetLineItemTaxedPriceChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue TaxedItemPrice `json:"previousValue"`
	// Value after the change.
	NextValue TaxedItemPrice `json:"nextValue"`
	// Name of the [Product](ctp:api:type:Product) the Line Item is based on.
	LineItem LocalizedString `json:"lineItem"`
	// `id` of the updated [LineItem](ctp:api:type:LineItem).
	LineItemId string `json:"lineItemId"`
}

func (SetLineItemTaxedPriceChange) MarshalJSON

func (obj SetLineItemTaxedPriceChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLineItemTotalPriceChange

type SetLineItemTotalPriceChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Money `json:"previousValue"`
	// Value after the change.
	NextValue Money `json:"nextValue"`
	// Name of the [Product](ctp:api:type:Product) the updated Line Item is based on.
	LineItem LocalizedString `json:"lineItem"`
}

* * Change triggered by the [Set LineItemTotalPrice](ctp:api:type:StagedOrderSetLineItemTotalPriceAction) update action.

func (SetLineItemTotalPriceChange) MarshalJSON

func (obj SetLineItemTotalPriceChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLocaleChange

type SetLocaleChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Locale](ctp:api:type:CustomerSetLocaleAction) on Customers. * - [Set Locale](ctp:api:type:OrderSetLocaleAction) on Orders. * - [Set Locale](ctp:api:type:StagedOrderSetLocaleAction) on Staged Orders. * - [Set Locale](ctp:api:type:ReviewSetLocaleAction) on Reviews. *

func (SetLocaleChange) MarshalJSON

func (obj SetLocaleChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLocalizedDescriptionChange

type SetLocalizedDescriptionChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Description](ctp:api:type:CartDiscountSetDescriptionAction) on Cart Discounts. * - [Set Description](ctp:api:type:CategorySetDescriptionAction) on Categories. * - [Set Description](ctp:api:type:DiscountCodeSetDescriptionAction) on Discount Codes. * - [Set Description](ctp:api:type:ProductSetDescriptionAction) on Products. * - [Set Description](ctp:api:type:ProductDiscountSetDescriptionAction) on Product Discounts. * - [Set Description](ctp:api:type:ShoppingListSetDescriptionAction) on Shopping Lists. * - [Set Description](ctp:api:type:StateSetDescriptionAction) on States. * - [Set Description](ctp:api:type:TypeSetDescriptionAction) on Types. *

func (SetLocalizedDescriptionChange) MarshalJSON

func (obj SetLocalizedDescriptionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetLocalizedNameChange added in v1.5.0

type SetLocalizedNameChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Name](ctp:api:type:DiscountCodeSetNameAction) on Discount Codes. * - [Set State Name](ctp:api:type:StateSetNameAction) on States. * - [Set Name](ctp:api:type:StoreSetNameAction) on Stores. *

func (SetLocalizedNameChange) MarshalJSON added in v1.5.0

func (obj SetLocalizedNameChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetMaxApplicationsChange

type SetMaxApplicationsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue int `json:"previousValue"`
	// Value after the change.
	NextValue int `json:"nextValue"`
}

* * Change triggered by the [Set Max Applications](ctp:api:type:DiscountCodeSetMaxApplicationsAction) update action.

func (SetMaxApplicationsChange) MarshalJSON

func (obj SetMaxApplicationsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetMaxApplicationsPerCustomerChange

type SetMaxApplicationsPerCustomerChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue int `json:"previousValue"`
	// Value after the change.
	NextValue int `json:"nextValue"`
}

* * Change triggered by the [Set Max Applications Per Customer](ctp:api:type:DiscountCodeSetMaxApplicationsPerCustomerAction) update action.

func (SetMaxApplicationsPerCustomerChange) MarshalJSON

func (obj SetMaxApplicationsPerCustomerChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetMetaDescriptionChange

type SetMetaDescriptionChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Meta Description](ctp:api:type:CategorySetMetaDescriptionAction) on Categories. * - [Set Meta Description](ctp:api:type:ProductSetMetaDescriptionAction) on Products. *

func (SetMetaDescriptionChange) MarshalJSON

func (obj SetMetaDescriptionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetMetaKeywordsChange

type SetMetaKeywordsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Meta Keywords](ctp:api:type:CategorySetMetaKeywordsAction) on Categories. * - [Set Meta Keywords](ctp:api:type:ProductSetMetaKeywordsAction) on Products. *

func (SetMetaKeywordsChange) MarshalJSON

func (obj SetMetaKeywordsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetMetaTitleChange

type SetMetaTitleChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Meta Title](ctp:api:type:CategorySetMetaTitleAction) on Categories. * - [Set Meta Title](ctp:api:type:ProductSetMetaTitleAction) on Products. *

func (SetMetaTitleChange) MarshalJSON

func (obj SetMetaTitleChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetMethodInfoInterfaceChange

type SetMethodInfoInterfaceChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set MethodInfoInterface](ctp:api:type:PaymentSetMethodInfoInterfaceAction) update action.

func (SetMethodInfoInterfaceChange) MarshalJSON

func (obj SetMethodInfoInterfaceChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetMethodInfoMethodChange

type SetMethodInfoMethodChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set MethodInfoInterface](ctp:api:type:PaymentSetMethodInfoMethodAction) update action.

func (SetMethodInfoMethodChange) MarshalJSON

func (obj SetMethodInfoMethodChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetMethodInfoNameChange

type SetMethodInfoNameChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
}

* * Change triggered by the [Set MethodInfoName](ctp:api:type:PaymentSetMethodInfoNameAction) update action.

func (SetMethodInfoNameChange) MarshalJSON

func (obj SetMethodInfoNameChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetMiddleNameChange

type SetMiddleNameChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set Middle Name](ctp:api:type:CustomerSetMiddleNameAction) update action.

func (SetMiddleNameChange) MarshalJSON

func (obj SetMiddleNameChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetNameChange

type SetNameChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set Name](ctp:api:type:AssociateRoleSetNameAction) update action.

func (SetNameChange) MarshalJSON

func (obj SetNameChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetOrderLineItemCustomFieldChange

type SetOrderLineItemCustomFieldChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue interface{} `json:"previousValue"`
	// Value after the change.
	NextValue interface{} `json:"nextValue"`
	// `id` of the referenced [Type](ctp:api:type:Type).
	CustomTypeId string `json:"customTypeId"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// Name of the [Product](ctp:api:type:Product) the Line Item is based on.
	LineItem LocalizedString `json:"lineItem"`
	// `sku` or `key` of the [ProductVariant](ctp:api:type:ProductVariant).
	Variant string `json:"variant"`
}

* * Change triggered by the following update actions: * * - [Set LineItem CustomField](ctp:api:type:OrderSetLineItemCustomFieldAction) on Orders. * - [Set LineItem CustomField](ctp:api:type:StagedOrderSetLineItemCustomFieldAction) on Staged Orders. *

func (SetOrderLineItemCustomFieldChange) MarshalJSON

func (obj SetOrderLineItemCustomFieldChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetOrderLineItemCustomTypeChange

type SetOrderLineItemCustomTypeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue CustomFields `json:"previousValue"`
	// Value after the change.
	NextValue CustomFields `json:"nextValue"`
	// Name of the [Product](ctp:api:type:Product) the updated Line Item is based on.
	LineItem LocalizedString `json:"lineItem"`
	// `sku` or `key` of the [ProductVariant](ctp:api:type:ProductVariant).
	Variant string `json:"variant"`
}

* * Change triggered by the following update actions: * * - [Set LineItem Custom Type](ctp:api:type:OrderSetLineItemCustomTypeAction) on Orders. * - [Set LineItem Custom Type](ctp:api:type:StagedOrderSetLineItemCustomTypeAction) on Staged Orders. *

func (SetOrderLineItemCustomTypeChange) MarshalJSON

func (obj SetOrderLineItemCustomTypeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetOrderNumberChange

type SetOrderNumberChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Order Number](ctp:api:type:OrderSetOrderNumberAction) on Orders. * - [Set Order Number](ctp:api:type:StagedOrderSetOrderNumberAction) on Staged Order. *

func (SetOrderNumberChange) MarshalJSON

func (obj SetOrderNumberChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetOrderTaxedPriceChange

type SetOrderTaxedPriceChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue TaxedItemPrice `json:"previousValue"`
	// Value after the change.
	NextValue TaxedItemPrice `json:"nextValue"`
	TaxMode   TaxMode        `json:"taxMode"`
}

func (SetOrderTaxedPriceChange) MarshalJSON

func (obj SetOrderTaxedPriceChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetOrderTotalPriceChange

type SetOrderTotalPriceChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Money `json:"previousValue"`
	// Value after the change.
	NextValue Money `json:"nextValue"`
}

* * Change triggered automatically due to a user-initiated change.

func (SetOrderTotalPriceChange) MarshalJSON

func (obj SetOrderTotalPriceChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetOrderTotalTaxChange

type SetOrderTotalTaxChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Money `json:"previousValue"`
	// Value after the change.
	NextValue Money `json:"nextValue"`
	// `"ExternalAmount"`
	TaxMode TaxMode `json:"taxMode"`
}

* * Change triggered by the [Set OrderTotalTax](ctp:api:type:StagedOrderSetOrderTotalTaxAction) update action.

func (SetOrderTotalTaxChange) MarshalJSON

func (obj SetOrderTotalTaxChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetParcelItemsChange

type SetParcelItemsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []DeliveryItem `json:"previousValue"`
	// Value after the change.
	NextValue []DeliveryItem `json:"nextValue"`
	// Information about the updated Parcel.
	Parcel ParcelChangeValue `json:"parcel"`
}

* * Change triggered by the following update actions: * * - [Set Parcel Items](ctp:api:type:OrderSetParcelItemsAction) on Orders. * - [Set Parcel Items](ctp:api:type:StagedOrderSetParcelItemsAction) on Staged Orders. *

func (SetParcelItemsChange) MarshalJSON

func (obj SetParcelItemsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetParcelMeasurementsChange

type SetParcelMeasurementsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue ParcelMeasurements `json:"previousValue"`
	// Value after the change.
	NextValue ParcelMeasurements `json:"nextValue"`
	// Information about the updated Parcel.
	Parcel ParcelChangeValue `json:"parcel"`
}

* * Change triggered by the following update actions: * * - [SetParcelMeasurements](ctp:api:type:OrderSetParcelMeasurementsAction) on Orders. * - [SetParcelMeasurements](ctp:api:type:StagedOrderSetParcelMeasurementsAction) on Staged Orders. *

func (SetParcelMeasurementsChange) MarshalJSON

func (obj SetParcelMeasurementsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetParcelTrackingDataChange

type SetParcelTrackingDataChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue TrackingData `json:"previousValue"`
	// Value after the change.
	NextValue TrackingData `json:"nextValue"`
	// Information about the updated Parcel.
	Parcel ParcelChangeValue `json:"parcel"`
}

* * Change triggered by the following update actions: * * - [Set Parcel Tracking Data](ctp:api:type:OrderSetParcelTrackingDataAction) on Orders. * - [Set Parcel Tracking Data](ctp:api:type:StagedOrderSetParcelTrackingDataAction) on Staged Orders. *

func (SetParcelTrackingDataChange) MarshalJSON

func (obj SetParcelTrackingDataChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetPermissionsChange added in v1.5.0

type SetPermissionsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []Permission `json:"previousValue"`
	// Value after the change.
	NextValue []Permission `json:"nextValue"`
}

* * Change triggered by the [Set Permissions](ctp:api:type:AssociateRoleSetPermissionsAction), [Add Permission](ctp:api:type:AssociateRoleAddPermissionAction), and [Remove Permission](ctp:api:type:AssociateRoleRemovePermissionAction) update actions. *

func (SetPermissionsChange) MarshalJSON added in v1.5.0

func (obj SetPermissionsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetPricesChange

type SetPricesChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []Price `json:"previousValue"`
	// Value after the change.
	NextValue []Price `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
	// `sku` or `key` of the [ProductVariant](ctp:api:type:ProductVariant).
	Variant string `json:"variant"`
}

* * Change triggered by the [Set Prices](ctp:api:type:ProductSetPricesAction) update action.

func (SetPricesChange) MarshalJSON

func (obj SetPricesChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetProductCountChange added in v1.2.0

type SetProductCountChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue int `json:"previousValue"`
	// Value after the change.
	NextValue int `json:"nextValue"`
}

* * Change triggered automatically by the [Add Product](ctp:api:type:ProductSelectionAddProductAction) or [Remove Product](ctp:api:type:ProductSelectionRemoveProductAction) update action.

func (SetProductCountChange) MarshalJSON added in v1.2.0

func (obj SetProductCountChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetProductPriceCustomFieldChange

type SetProductPriceCustomFieldChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue CustomFields `json:"previousValue"`
	// Value after the change.
	NextValue CustomFields `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
}

* * Change triggered by the [Set Price CustomField](ctp:api:type:ProductSetProductPriceCustomFieldAction) update action.

func (SetProductPriceCustomFieldChange) MarshalJSON

func (obj SetProductPriceCustomFieldChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetProductPriceCustomTypeChange

type SetProductPriceCustomTypeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue CustomFields `json:"previousValue"`
	// Value after the change.
	NextValue CustomFields `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
}

* * Change triggered by the [Set Price Custom Type](ctp:api:type:ProductSetProductPriceCustomTypeAction) update action.

func (SetProductPriceCustomTypeChange) MarshalJSON

func (obj SetProductPriceCustomTypeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetProductSelectionsChange added in v1.2.0

type SetProductSelectionsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []ProductSelectionSetting `json:"previousValue"`
	// Value after the change.
	NextValue []ProductSelectionSetting `json:"nextValue"`
}

* * Change triggered by the [Set Product Selections](ctp:api:type:StoreSetProductSelectionsAction) update action.

func (SetProductSelectionsChange) MarshalJSON added in v1.2.0

func (obj SetProductSelectionsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetProductVariantKeyChange

type SetProductVariantKeyChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
}

* * Change triggered by the [Set ProductVariant Key](ctp:api:type:ProductSetProductVariantKeyAction) update action.

func (SetProductVariantKeyChange) MarshalJSON

func (obj SetProductVariantKeyChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetPropertyChange

type SetPropertyChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue interface{} `json:"previousValue"`
	// Value after the change.
	NextValue interface{} `json:"nextValue"`
	// Path to the property that was updated.
	Path string `json:"path"`
}

* * Change triggered by the [Update CustomObject](ctp:api:endpoint:/{projectKey}/custom-objects:POST) request when an existing property is updated.

func (SetPropertyChange) MarshalJSON

func (obj SetPropertyChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetPurchaseOrderNumberChange added in v1.3.0

type SetPurchaseOrderNumberChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Purchase Order Number](ctp:api:type:OrderSetPurchaseOrderNumberAction) on Orders. * - [Set Purchase Order Number](ctp:api:type:StagedOrderSetPurchaseOrderNumberAction) on Staged Orders. *

func (SetPurchaseOrderNumberChange) MarshalJSON added in v1.3.0

func (obj SetPurchaseOrderNumberChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetRatingChange

type SetRatingChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue int `json:"previousValue"`
	// Value after the change.
	NextValue int `json:"nextValue"`
}

* * Change triggered by the [Set Rating](ctp:api:type:ReviewSetRatingAction) update action.

func (SetRatingChange) MarshalJSON

func (obj SetRatingChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetReservationsChange

type SetReservationsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []Reservation `json:"previousValue"`
	// Value after the change.
	NextValue []Reservation `json:"nextValue"`
}

func (SetReservationsChange) MarshalJSON

func (obj SetReservationsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetRestockableInDaysChange

type SetRestockableInDaysChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue int `json:"previousValue"`
	// Value after the change.
	NextValue int `json:"nextValue"`
}

* * Change triggered by the [Set RestockableInDays](ctp:api:type:InventoryEntrySetRestockableInDaysAction) update action.

func (SetRestockableInDaysChange) MarshalJSON

func (obj SetRestockableInDaysChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetReturnPaymentStateChange

type SetReturnPaymentStateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue ReturnPaymentState `json:"previousValue"`
	// Value after the change.
	NextValue ReturnPaymentState `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set PaymentShipmentState](ctp:api:type:OrderSetReturnPaymentStateAction) on Orders. * - [Set PaymentShipmentState](ctp:api:type:StagedOrderSetReturnPaymentStateAction) on Staged Orders. *

func (SetReturnPaymentStateChange) MarshalJSON

func (obj SetReturnPaymentStateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetReturnShipmentStateChange

type SetReturnShipmentStateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue ReturnShipmentState `json:"previousValue"`
	// Value after the change.
	NextValue ReturnShipmentState `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set ReturnShipmentState](ctp:api:type:OrderSetReturnShipmentStateAction) on Orders. * - [Set ReturnShipmentState](ctp:api:type:StagedOrderSetReturnShipmentStateAction) on Staged Orders. *

func (SetReturnShipmentStateChange) MarshalJSON

func (obj SetReturnShipmentStateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetSalutationChange

type SetSalutationChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set Salutation](ctp:api:type:CustomerSetSalutationAction) update action.

func (SetSalutationChange) MarshalJSON

func (obj SetSalutationChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetSearchKeywordsChange

type SetSearchKeywordsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue SearchKeywords `json:"previousValue"`
	// Value after the change.
	NextValue SearchKeywords `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
}

* * Change triggered by the [Set SearchKeywords](ctp:api:type:ProductSetSearchKeywordsAction) update action.

func (SetSearchKeywordsChange) MarshalJSON

func (obj SetSearchKeywordsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetSellerCommentChange added in v1.2.0

type SetSellerCommentChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set Seller Comment](ctp:api:type:StagedQuoteSetSellerCommentAction) update action.

func (SetSellerCommentChange) MarshalJSON added in v1.2.0

func (obj SetSellerCommentChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetShippingAddressChange

type SetShippingAddressChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Address `json:"previousValue"`
	// Value after the change.
	NextValue Address `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Shipping Address](ctp:api:type:OrderSetShippingAddressAction) on Orders. * - [Set Shipping Address](ctp:api:type:StagedOrderSetShippingAddressAction) on Staged Orders. *

func (SetShippingAddressChange) MarshalJSON

func (obj SetShippingAddressChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetShippingInfoPriceChange

type SetShippingInfoPriceChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Money `json:"previousValue"`
	// Value after the change.
	NextValue Money `json:"nextValue"`
}

func (SetShippingInfoPriceChange) MarshalJSON

func (obj SetShippingInfoPriceChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetShippingInfoTaxedPriceChange

type SetShippingInfoTaxedPriceChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue TaxedPrice `json:"previousValue"`
	// Value after the change.
	NextValue TaxedPrice `json:"nextValue"`
}

func (SetShippingInfoTaxedPriceChange) MarshalJSON

func (obj SetShippingInfoTaxedPriceChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetShippingMethodChange

type SetShippingMethodChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue ShippingMethodChangeValue `json:"previousValue"`
	// Value after the change.
	NextValue ShippingMethodChangeValue `json:"nextValue"`
}

* * Change triggered by the [Set ShippingMethod](ctp:api:type:StagedOrderSetShippingMethodAction) update action.

func (SetShippingMethodChange) MarshalJSON

func (obj SetShippingMethodChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetShippingMethodTaxAmountChange

type SetShippingMethodTaxAmountChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue ShippingMethodTaxAmountChangeValue `json:"previousValue"`
	// Value after the change.
	NextValue ShippingMethodTaxAmountChangeValue `json:"nextValue"`
	// `"ExternalAmount"`
	TaxMode TaxMode `json:"taxMode"`
}

* * Change triggered by the [Set ShippingMethod TaxAmount](ctp:api:type:StagedOrderSetShippingMethodTaxAmountAction) update action.

func (SetShippingMethodTaxAmountChange) MarshalJSON

func (obj SetShippingMethodTaxAmountChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetShippingMethodTaxRateChange

type SetShippingMethodTaxRateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue TaxRate `json:"previousValue"`
	// Value after the change.
	NextValue TaxRate `json:"nextValue"`
	// `"External"`
	TaxMode TaxMode `json:"taxMode"`
}

* * Change triggered by the [Set ShippingMethod TaxRate](ctp:api:type:StagedOrderSetShippingMethodTaxRateAction) update action.

func (SetShippingMethodTaxRateChange) MarshalJSON

func (obj SetShippingMethodTaxRateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetShippingRateChange

type SetShippingRateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Money `json:"previousValue"`
	// Value after the change.
	NextValue Money `json:"nextValue"`
}

func (SetShippingRateChange) MarshalJSON

func (obj SetShippingRateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetShippingRateInputChange

type SetShippingRateInputChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue interface{} `json:"previousValue"`
	// Value after the change.
	NextValue interface{} `json:"nextValue"`
}

* * Change triggered by the [Set Shipping Rate Input](ctp:api:type:StagedOrderSetShippingRateInputAction) update action.

func (SetShippingRateInputChange) MarshalJSON

func (obj SetShippingRateInputChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetShoppingListLineItemCustomFieldChange

type SetShoppingListLineItemCustomFieldChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue interface{} `json:"previousValue"`
	// Value after the change.
	NextValue interface{} `json:"nextValue"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// `id` of the referenced [Type](ctp:api:type:Type).
	CustomTypeId string `json:"customTypeId"`
	// Holds information about the updated Shopping List Line Item.
	LineItem ShoppingListLineItemValue `json:"lineItem"`
}

* * Change triggered by the [Set ShoppingListLineItem Custom Field](ctp:api:type:ShoppingListSetLineItemCustomFieldAction) update action.

func (SetShoppingListLineItemCustomFieldChange) MarshalJSON

func (obj SetShoppingListLineItemCustomFieldChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetShoppingListLineItemCustomTypeChange

type SetShoppingListLineItemCustomTypeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue CustomFields `json:"previousValue"`
	// Value after the change.
	NextValue CustomFields `json:"nextValue"`
	// Holds information about the updated Shopping List Line Item.
	LineItem ShoppingListLineItemValue `json:"lineItem"`
}

* * Change triggered by the [Set ShoppingListLineItem Custom Type](ctp:api:type:ShoppingListSetLineItemCustomTypeAction) update action.

func (SetShoppingListLineItemCustomTypeChange) MarshalJSON

func (obj SetShoppingListLineItemCustomTypeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetSkuChange

type SetSkuChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
}

* * Change triggered by the [Set SKU](ctp:api:type:ProductSetSkuAction) update action.

func (SetSkuChange) MarshalJSON

func (obj SetSkuChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetSlugChange

type SetSlugChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
}

* * Change triggered by the [Set Slug](ctp:api:type:ShoppingListSetSlugAction) update action.

func (SetSlugChange) MarshalJSON

func (obj SetSlugChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetStateRolesChange

type SetStateRolesChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []StateRoleEnum `json:"previousValue"`
	// Value after the change.
	NextValue []StateRoleEnum `json:"nextValue"`
}

* * Change triggered by the [Set State roles](ctp:api:type:StateSetRolesAction) update action.

func (SetStateRolesChange) MarshalJSON

func (obj SetStateRolesChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetStatusInterfaceCodeChange

type SetStatusInterfaceCodeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set StatusInterfaceCode](ctp:api:type:PaymentSetStatusInterfaceCodeAction) update action.

func (SetStatusInterfaceCodeChange) MarshalJSON

func (obj SetStatusInterfaceCodeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetStatusInterfaceTextChange

type SetStatusInterfaceTextChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set StatusInterfaceText](ctp:api:type:PaymentSetStatusInterfaceTextAction) update action.

func (SetStatusInterfaceTextChange) MarshalJSON

func (obj SetStatusInterfaceTextChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetStoreChange

type SetStoreChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Reference `json:"previousValue"`
	// Value after the change.
	NextValue Reference `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Store](ctp:api:type:OrderSetStoreAction) on Orders. * - [Set Store](ctp:api:type:ShoppingListSetStoreAction) on Shopping Lists. *

func (SetStoreChange) MarshalJSON

func (obj SetStoreChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetStoreModeChange added in v1.5.0

type SetStoreModeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue BusinessUnitStoreMode `json:"previousValue"`
	// Value after the change.
	NextValue BusinessUnitStoreMode `json:"nextValue"`
}

* * Change triggered by the [Set Store Mode](ctp:api:type:BusinessUnitSetStoreModeAction) update action.

func (SetStoreModeChange) MarshalJSON added in v1.5.0

func (obj SetStoreModeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetStoresChange

type SetStoresChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []Reference `json:"previousValue"`
	// Value after the change.
	NextValue []Reference `json:"nextValue"`
}

* * Change triggered by the [Set Stores](ctp:api:type:CustomerSetStoresAction) update action.

func (SetStoresChange) MarshalJSON

func (obj SetStoresChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetSupplyChannelChange

type SetSupplyChannelChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Reference `json:"previousValue"`
	// Value after the change.
	NextValue Reference `json:"nextValue"`
}

* * Change triggered by the [Set SupplyChannel](ctp:api:type:InventoryEntrySetSupplyChannelAction) update action.

func (SetSupplyChannelChange) MarshalJSON

func (obj SetSupplyChannelChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetSupplyChannelsChange

type SetSupplyChannelsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []Reference `json:"previousValue"`
	// Value after the change.
	NextValue []Reference `json:"nextValue"`
}

* * Change triggered by the [Set Supply Channels](ctp:api:type:StoreSetSupplyChannelsAction) update action.

func (SetSupplyChannelsChange) MarshalJSON

func (obj SetSupplyChannelsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetTargetChange

type SetTargetChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Reference `json:"previousValue"`
	// Value after the change.
	NextValue Reference `json:"nextValue"`
}

* * Change triggered by the [Set Target](ctp:api:type:ReviewSetTargetAction) update action.

func (SetTargetChange) MarshalJSON

func (obj SetTargetChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetTaxCategoryChange

type SetTaxCategoryChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Reference `json:"previousValue"`
	// Value after the change.
	NextValue Reference `json:"nextValue"`
}

* * Change triggered by the [Set TaxCategory](ctp:api:type:ProductSetTaxCategoryAction) update action.

func (SetTaxCategoryChange) MarshalJSON

func (obj SetTaxCategoryChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetTextChange

type SetTextChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set Text](ctp:api:type:ReviewSetTextAction) update action.

func (SetTextChange) MarshalJSON

func (obj SetTextChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetTextLineItemCustomFieldChange

type SetTextLineItemCustomFieldChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue interface{} `json:"previousValue"`
	// Value after the change.
	NextValue interface{} `json:"nextValue"`
	// Name of the [Custom Field](/../api/projects/custom-fields).
	Name string `json:"name"`
	// `id` of the referenced [Type](ctp:api:type:Type).
	CustomTypeId string `json:"customTypeId"`
	// Holds information about the updated Text Line Item.
	TextLineItem TextLineItemValue `json:"textLineItem"`
}

* * Change triggered by the [Set TextLineItem CustomField](ctp:api:type:ShoppingListSetTextLineItemCustomFieldAction) update action.

func (SetTextLineItemCustomFieldChange) MarshalJSON

func (obj SetTextLineItemCustomFieldChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetTextLineItemCustomTypeChange

type SetTextLineItemCustomTypeChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue CustomFields `json:"previousValue"`
	// Value after the change.
	NextValue CustomFields `json:"nextValue"`
	// Holds information about the updated Text Line Item.
	TextLineItem TextLineItemValue `json:"textLineItem"`
}

* * Change triggered by the [Set TextLineItem Custom Type](ctp:api:type:ShoppingListSetTextLineItemCustomTypeAction) update action.

func (SetTextLineItemCustomTypeChange) MarshalJSON

func (obj SetTextLineItemCustomTypeChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetTextLineItemDescriptionChange

type SetTextLineItemDescriptionChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue LocalizedString `json:"previousValue"`
	// Value after the change.
	NextValue LocalizedString `json:"nextValue"`
	// Holds information about the updated Text Line Item.
	TextLineItem TextLineItemValue `json:"textLineItem"`
}

* * Change triggered by the [Set TextLineItem Description](ctp:api:type:ShoppingListSetTextLineItemDescriptionAction) update action.

func (SetTextLineItemDescriptionChange) MarshalJSON

func (obj SetTextLineItemDescriptionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetTitleChange

type SetTitleChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Title](ctp:api:type:CustomerSetTitleAction) on Customers. * - [Set Title](ctp:api:type:ReviewSetTitleAction) on Reviews. *

func (SetTitleChange) MarshalJSON

func (obj SetTitleChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetTransitionsChange

type SetTransitionsChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []Reference `json:"previousValue"`
	// Value after the change.
	NextValue []Reference `json:"nextValue"`
}

* * Change triggered by the [Set Transitions](ctp:api:type:StateSetTransitionsAction) update action.

func (SetTransitionsChange) MarshalJSON

func (obj SetTransitionsChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetUserAgentTransport added in v1.0.1

type SetUserAgentTransport struct {
	T http.RoundTripper
	// contains filtered or unexported fields
}

func (*SetUserAgentTransport) RoundTrip added in v1.0.1

func (sat *SetUserAgentTransport) RoundTrip(req *http.Request) (*http.Response, error)

type SetValidFromAndUntilChange

type SetValidFromAndUntilChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue ValidFromAndUntilValue `json:"previousValue"`
	// Value after the change.
	NextValue ValidFromAndUntilValue `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Valid From and Until](ctp:api:type:CartDiscountSetValidFromAndUntilAction) on Cart Discounts. * - [Set Valid From and Until](ctp:api:type:DiscountCodeSetValidFromAndUntilAction) on Discount Codes. * - [Set Valid From and Until](ctp:api:type:ProductDiscountSetValidFromAndUntilAction) on Product Discounts. *

func (SetValidFromAndUntilChange) MarshalJSON

func (obj SetValidFromAndUntilChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetValidFromChange

type SetValidFromChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Valid From](ctp:api:type:CartDiscountSetValidFromAction) on Cart Discounts. * - [Set Valid From](ctp:api:type:DiscountCodeSetValidFromAction) on Discount Codes. * - [Set Valid From](ctp:api:type:ProductDiscountSetValidFromAction) on Product Discounts. *

func (SetValidFromChange) MarshalJSON

func (obj SetValidFromChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetValidToChange added in v1.2.0

type SetValidToChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set Valid To](ctp:api:type:StagedQuoteSetValidToAction) update action.

func (SetValidToChange) MarshalJSON added in v1.2.0

func (obj SetValidToChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetValidUntilChange

type SetValidUntilChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Set Valid Until](ctp:api:type:CartDiscountSetValidUntilAction) on Cart Discounts. * - [Set Valid Until](ctp:api:type:DiscountCodeSetValidUntilAction) on Discount Codes. * - [Set Valid Until](ctp:api:type:ProductDiscountSetValidUntilAction) on Product Discounts. *

func (SetValidUntilChange) MarshalJSON

func (obj SetValidUntilChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetValueChange

type SetValueChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue interface{} `json:"previousValue"`
	// Value after the change.
	NextValue interface{} `json:"nextValue"`
}

* * Change triggered by the [Update CustomObject](ctp:api:endpoint:/{projectKey}/custom-objects:POST) request when a value of a property is updated.

func (SetValueChange) MarshalJSON

func (obj SetValueChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetVariantAvailabilityChange

type SetVariantAvailabilityChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue ProductVariantAvailability `json:"previousValue"`
	// Value after the change.
	NextValue ProductVariantAvailability `json:"nextValue"`
	// - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	// - `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
	CatalogData string `json:"catalogData"`
	// `sku` or `key` of the [ProductVariant](ctp:api:type:ProductVariant).
	Variant string `json:"variant"`
}

* * Change triggered automatically when an [InventoryEntry](ctp:api:type:InventoryEntry) associated with a Product changes.

func (SetVariantAvailabilityChange) MarshalJSON

func (obj SetVariantAvailabilityChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetVariantSelectionChange added in v1.5.0

type SetVariantSelectionChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue ProductVariantSelection `json:"previousValue"`
	// Value after the change.
	NextValue ProductVariantSelection `json:"nextValue"`
	// Reference to the updated [Product](ctp:api:type:Product).
	Product Reference `json:"product"`
}

* * Change triggered by the [Set Variant Selection](ctp:api:type:ProductSelectionSetVariantSelectionAction) update action.

func (SetVariantSelectionChange) MarshalJSON added in v1.5.0

func (obj SetVariantSelectionChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SetVatIdChange

type SetVatIdChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue string `json:"previousValue"`
	// Value after the change.
	NextValue string `json:"nextValue"`
}

* * Change triggered by the [Set Vat ID](ctp:api:type:CustomerSetVatIdAction) update action.

func (SetVatIdChange) MarshalJSON

func (obj SetVatIdChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type ShipmentState

type ShipmentState string
const (
	ShipmentStateShipped   ShipmentState = "Shipped"
	ShipmentStateReady     ShipmentState = "Ready"
	ShipmentStatePending   ShipmentState = "Pending"
	ShipmentStateDelayed   ShipmentState = "Delayed"
	ShipmentStatePartial   ShipmentState = "Partial"
	ShipmentStateBackorder ShipmentState = "Backorder"
)

type ShippingMethodChangeValue

type ShippingMethodChangeValue struct {
	// `id` of the [ShippingMethod](ctp:api:type:ShippingMethod).
	ID string `json:"id"`
	// Name of the ShippingMethod.
	Name string `json:"name"`
}

type ShippingMethodTaxAmountChangeValue

type ShippingMethodTaxAmountChangeValue struct {
	// Taxed price for the Shipping Method based on `taxRate`.
	TaxedPrice TaxedPrice `json:"taxedPrice"`
	// Tax rate set externally for the Shipping Method.
	TaxRate TaxRate `json:"taxRate"`
}

type ShippingRate

type ShippingRate struct {
	Price     Money `json:"price"`
	FreeAbove Money `json:"freeAbove"`
	// Only appears in response to requests for ShippingMethods by Cart or location to mark this shipping rate as one that matches the Cart or location.
	IsMatching bool                    `json:"isMatching"`
	Tiers      []ShippingRatePriceTier `json:"tiers"`
}

type ShippingRatePriceTier

type ShippingRatePriceTier struct {
	Type ShippingRateTierType `json:"type"`
}

type ShippingRateTierType

type ShippingRateTierType string
const (
	ShippingRateTierTypeCartValue          ShippingRateTierType = "CartValue"
	ShippingRateTierTypeCartClassification ShippingRateTierType = "CartClassification"
	ShippingRateTierTypeCartScore          ShippingRateTierType = "CartScore"
)

type ShoppingListLineItemValue

type ShoppingListLineItemValue struct {
	// `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem).
	ID string `json:"id"`
	// Name of the corresponding Product the Product Variant belongs to.
	Name LocalizedString `json:"name"`
	// `id` of the [ProductVariant](ctp:api:type:ProductVariant) the ShoppingListLineItem refers to.
	VariantId int `json:"variantId"`
}

type Source

type Source string

* * Values for the Source enumeration.

const (
	SourceMerchantCenter Source = "MerchantCenter"
	SourceImpEx          Source = "ImpEx"
	SourceApiClient      Source = "ApiClient"
)

type StackingMode

type StackingMode string
const (
	StackingModeStacking              StackingMode = "Stacking"
	StackingModeStopAfterThisDiscount StackingMode = "StopAfterThisDiscount"
)

type StagedQuoteLabel added in v1.2.0

type StagedQuoteLabel struct {
	// User-defined unique identifier of the Staged Quote.
	Key string `json:"key"`
	// The [Buyer](/../api/quotes-overview#buyer) who requested the Quote.
	Customer Reference `json:"customer"`
	// Quote Request related to the Staged Quote.
	QuoteRequest Reference `json:"quoteRequest"`
}

func (StagedQuoteLabel) MarshalJSON added in v1.2.0

func (obj StagedQuoteLabel) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type StagedQuoteState added in v1.2.0

type StagedQuoteState string
const (
	StagedQuoteStateInProgress StagedQuoteState = "InProgress"
	StagedQuoteStateSent       StagedQuoteState = "Sent"
	StagedQuoteStateClosed     StagedQuoteState = "Closed"
)

type StateRoleEnum added in v1.5.0

type StateRoleEnum string

* * For some resource types, a State can fulfill the following predefined roles: *

const (
	StateRoleEnumReviewIncludedInStatistics StateRoleEnum = "ReviewIncludedInStatistics"
	StateRoleEnumReturn                     StateRoleEnum = "Return"
)

type StateTypeEnum added in v1.5.0

type StateTypeEnum string

* * Resource or object type the State can be assigned to. *

const (
	StateTypeEnumOrderState        StateTypeEnum = "OrderState"
	StateTypeEnumLineItemState     StateTypeEnum = "LineItemState"
	StateTypeEnumProductState      StateTypeEnum = "ProductState"
	StateTypeEnumReviewState       StateTypeEnum = "ReviewState"
	StateTypeEnumPaymentState      StateTypeEnum = "PaymentState"
	StateTypeEnumQuoteRequestState StateTypeEnum = "QuoteRequestState"
	StateTypeEnumStagedQuoteState  StateTypeEnum = "StagedQuoteState"
	StateTypeEnumQuoteState        StateTypeEnum = "QuoteState"
)

type StoreCountry added in v1.3.0

type StoreCountry struct {
	// Two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
	Code string `json:"code"`
}

type StringLabel

type StringLabel struct {
	// Changed value.
	Value string `json:"value"`
}

func (StringLabel) MarshalJSON

func (obj StringLabel) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type SubRate

type SubRate struct {
	Name   string `json:"name"`
	Amount int    `json:"amount"`
}

type SuggestTokenizer

type SuggestTokenizer struct {
	Type string `json:"type"`
}

type SyncInfo

type SyncInfo struct {
	Channel Reference `json:"channel"`
	// Can be used to reference an external order instance, file etc.
	ExternalId string `json:"externalId"`
	SyncedAt   string `json:"syncedAt"`
}

type TaxCalculationMode

type TaxCalculationMode string
const (
	TaxCalculationModeLineItemLevel  TaxCalculationMode = "LineItemLevel"
	TaxCalculationModeUnitPriceLevel TaxCalculationMode = "UnitPriceLevel"
)

type TaxMode

type TaxMode string
const (
	TaxModePlatform       TaxMode = "Platform"
	TaxModeExternal       TaxMode = "External"
	TaxModeExternalAmount TaxMode = "ExternalAmount"
	TaxModeDisabled       TaxMode = "Disabled"
)

type TaxRate

type TaxRate struct {
	// The ID is always set if the tax rate is part of a TaxCategory. The external tax rates in a Cart do not contain an `id`.
	ID   string `json:"id"`
	Name string `json:"name"`
	// Percentage in the range of [0..1]. The sum of the amounts of all `subRates`, if there are any.
	Amount          int  `json:"amount"`
	IncludedInPrice bool `json:"includedInPrice"`
	// Two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
	Country string `json:"country"`
	// The state in the country
	State    string    `json:"state"`
	SubRates []SubRate `json:"subRates"`
}

* * Shape of the value for `addTaxRate` and `removeTaxRate` actions

type TaxedItemPrice

type TaxedItemPrice struct {
	TotalNet   Money `json:"totalNet"`
	TotalGross Money `json:"totalGross"`
}

type TaxedPrice

type TaxedPrice struct {
	// Total net price of the Order.
	TotalNet Money `json:"totalNet"`
	// Total gross price of the Order.
	TotalGross Money `json:"totalGross"`
}

type TextInputHint

type TextInputHint string
const (
	TextInputHintSingleLine TextInputHint = "SingleLine"
	TextInputHintMultiLine  TextInputHint = "MultiLine"
)

type TextLineItem

type TextLineItem struct {
	AddedAt     string          `json:"addedAt"`
	Custom      CustomFields    `json:"custom"`
	Description LocalizedString `json:"description"`
	ID          string          `json:"id"`
	Name        LocalizedString `json:"name"`
	Quantity    int             `json:"quantity"`
}

type TextLineItemValue

type TextLineItemValue struct {
	// `id` of the [TextLineItem](ctp:api:type:TextLineItem).
	ID string `json:"id"`
	// Name of the TextLineItem.
	Name LocalizedString `json:"name"`
}

type TrackingData

type TrackingData struct {
	// The ID to track one parcel.
	TrackingId string `json:"trackingId"`
	// The carrier that delivers the parcel.
	Carrier             string `json:"carrier"`
	Provider            string `json:"provider"`
	ProviderTransaction string `json:"providerTransaction"`
	// Flag to distinguish if the parcel is on the way to the customer (false) or on the way back (true).
	IsReturn bool `json:"isReturn"`
}

type Transaction

type Transaction struct {
	// Unique identifier of the Transaction.
	ID string `json:"id"`
	// Time at which the transaction took place.
	Timestamp string          `json:"timestamp"`
	Type      TransactionType `json:"type"`
	Amount    Money           `json:"amount"`
	// Identifier used by the interface that manages the transaction (usually the PSP). If a matching interaction was logged in the `interfaceInteractions` array, the corresponding interaction should be findable with this ID.
	InteractionId string           `json:"interactionId"`
	State         TransactionState `json:"state"`
}

type TransactionChangeValue

type TransactionChangeValue struct {
	// `id` of the [Transaction](ctp:api:type:Transaction).
	ID string `json:"id"`
	// Identifier used by the interface that manages the Transaction (usually the PSP).
	InteractionId string `json:"interactionId"`
	// Date and time (UTC) the Transaction took place.
	Timestamp string `json:"timestamp"`
}

type TransactionState

type TransactionState string
const (
	TransactionStateInitial TransactionState = "Initial"
	TransactionStatePending TransactionState = "Pending"
	TransactionStateSuccess TransactionState = "Success"
	TransactionStateFailure TransactionState = "Failure"
)

type TransactionType

type TransactionType string
const (
	TransactionTypeAuthorization       TransactionType = "Authorization"
	TransactionTypeCancelAuthorization TransactionType = "CancelAuthorization"
	TransactionTypeCharge              TransactionType = "Charge"
	TransactionTypeRefund              TransactionType = "Refund"
	TransactionTypeChargeback          TransactionType = "Chargeback"
)

type TransitionCustomLineItemStateChange

type TransitionCustomLineItemStateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []ItemState `json:"previousValue"`
	// Value after the change.
	NextValue []ItemState `json:"nextValue"`
	// `id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
	LineItemId string `json:"lineItemId"`
	// `id` of the [State](ctp:api:type:State) involved in the transition.
	StateId string `json:"stateId"`
}

* * Change triggered by the following update actions: * * - [Change the state of CustomLineItem according to allowed transitions](ctp:api:type:OrderTransitionCustomLineItemStateAction) on Orders. * - [Change the state of CustomLineItem according to allowed transitions](ctp:api:type:StagedOrderTransitionCustomLineItemStateAction) on Staged Orders. *

func (TransitionCustomLineItemStateChange) MarshalJSON

func (obj TransitionCustomLineItemStateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TransitionLineItemStateChange

type TransitionLineItemStateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue []ItemState `json:"previousValue"`
	// Value after the change.
	NextValue []ItemState `json:"nextValue"`
	// `id` of the updated [LineItem](ctp:api:type:LineItem).
	LineItemId string `json:"lineItemId"`
	// `id` of the [State](ctp:api:type:State) involved in the transition.
	StateId string `json:"stateId"`
}

* * Change triggered by the following update actions: * * - [Change the state of LineItem according to allowed transitions](ctp:api:type:OrderTransitionLineItemStateAction) on Orders. * - [Change the state of LineItem according to allowed transitions](ctp:api:type:OrderTransitionLineItemStateAction) on Staged Orders. *

func (TransitionLineItemStateChange) MarshalJSON

func (obj TransitionLineItemStateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type TransitionStateChange

type TransitionStateChange struct {
	Change string `json:"change"`
	// Value before the change.
	PreviousValue Reference `json:"previousValue"`
	// Value after the change.
	NextValue Reference `json:"nextValue"`
}

* * Change triggered by the following update actions: * * - [Transition State](ctp:api:type:OrderTransitionStateAction) on Orders. * - [Transition State](ctp:api:type:StagedOrderTransitionStateAction) on Staged Orders. * - [Transition State](ctp:api:type:PaymentTransitionStateAction) on Payments. * - [Transition State](ctp:api:type:ProductTransitionStateAction) on Products. * - [Transition State](ctp:api:type:QuoteTransitionStateAction) on Quotes. * - [Transition State](ctp:api:type:StagedQuoteTransitionStateAction) on Staged Quotes. * - [Transition State](ctp:api:type:QuoteRequestTransitionStateAction) on Quote Requests. * - [Transition State](ctp:api:type:ReviewTransitionStateAction) on Reviews. * - [Transition State](ctp:api:type:StateSetTransitionsAction) on States. *

func (TransitionStateChange) MarshalJSON

func (obj TransitionStateChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type UnknownChange

type UnknownChange struct {
	// Identifier for the type of modification.
	Change string `json:"change"`
	// Value before the change.
	PreviousValue interface{} `json:"previousValue"`
	// Value after the change.
	NextValue interface{} `json:"nextValue"`
}

* * Change triggered when the format of changes on an entity is not identified by Audit Log.

func (UnknownChange) MarshalJSON

func (obj UnknownChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type UnpublishChange

type UnpublishChange struct {
	Change string `json:"change"`
}

* * Change triggered by the [Unpublish](ctp:api:type:ProductUnpublishAction) update action.

func (UnpublishChange) MarshalJSON

func (obj UnpublishChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type UpdateSyncInfoChange

type UpdateSyncInfoChange struct {
	Change string `json:"change"`
	// Value after the change.
	NextValue SyncInfo `json:"nextValue"`
	// `id` of the updated [Channel](ctp:api:type:Channel).
	ChannelId string `json:"channelId"`
}

* * Change triggered by the following update actions: * * - [Update SyncInfo](ctp:api:type:OrderUpdateSyncInfoAction) on Orders. * - [Update SyncInfo](ctp:api:type:StagedOrderUpdateSyncInfoAction) on Staged Orders. *

func (UpdateSyncInfoChange) MarshalJSON

func (obj UpdateSyncInfoChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

type UpdateType

type UpdateType string
const (
	UpdateTypeAddAddress                            UpdateType = "addAddress"
	UpdateTypeAddAsset                              UpdateType = "addAsset"
	UpdateTypeAddAssociate                          UpdateType = "addAssociate"
	UpdateTypeAddAttributeDefinition                UpdateType = "addAttributeDefinition"
	UpdateTypeAddBillingAddressId                   UpdateType = "addBillingAddressId"
	UpdateTypeAddCustomLineItem                     UpdateType = "addCustomLineItem"
	UpdateTypeAddDelivery                           UpdateType = "addDelivery"
	UpdateTypeAddDiscountCode                       UpdateType = "addDiscountCode"
	UpdateTypeAddEnumValue                          UpdateType = "addEnumValue"
	UpdateTypeAddExternalImage                      UpdateType = "addExternalImage"
	UpdateTypeAddFieldDefinition                    UpdateType = "addFieldDefinition"
	UpdateTypeAddInterfaceInteraction               UpdateType = "addInterfaceInteraction"
	UpdateTypeAddItemShippingAddress                UpdateType = "addItemShippingAddress"
	UpdateTypeAddLineItem                           UpdateType = "addLineItem"
	UpdateTypeAddLocalizedEnumValue                 UpdateType = "addLocalizedEnumValue"
	UpdateTypeAddLocation                           UpdateType = "addLocation"
	UpdateTypeAddParcelToDelivery                   UpdateType = "addParcelToDelivery"
	UpdateTypeAddPayment                            UpdateType = "addPayment"
	UpdateTypeAddPlainEnumValue                     UpdateType = "addPlainEnumValue"
	UpdateTypeAddPrice                              UpdateType = "addPrice"
	UpdateTypeAddProduct                            UpdateType = "addProduct"
	UpdateTypeAddProductSelection                   UpdateType = "addProductSelection"
	UpdateTypeAddProperty                           UpdateType = "addProperty"
	UpdateTypeAddReturnInfo                         UpdateType = "addReturnInfo"
	UpdateTypeAddRoles                              UpdateType = "addRoles"
	UpdateTypeAddShippingAddressId                  UpdateType = "addShippingAddressId"
	UpdateTypeAddTaxRate                            UpdateType = "addTaxRate"
	UpdateTypeAddTextLineItem                       UpdateType = "addTextLineItem"
	UpdateTypeAddToCategory                         UpdateType = "addToCategory"
	UpdateTypeAddTransaction                        UpdateType = "addTransaction"
	UpdateTypeAddVariant                            UpdateType = "addVariant"
	UpdateTypeChangeAddress                         UpdateType = "changeAddress"
	UpdateTypeChangeAmountAuthorized                UpdateType = "changeAmountAuthorized"
	UpdateTypeChangeAmountPlanned                   UpdateType = "changeAmountPlanned"
	UpdateTypeChangeAssetName                       UpdateType = "changeAssetName"
	UpdateTypeChangeAssetOrder                      UpdateType = "changeAssetOrder"
	UpdateTypeChangeAssociate                       UpdateType = "changeAssociate"
	UpdateTypeChangeAssociateMode                   UpdateType = "changeAssociateMode"
	UpdateTypeChangeAttributeConstraint             UpdateType = "changeAttributeConstraint"
	UpdateTypeChangeAttributeName                   UpdateType = "changeAttributeName"
	UpdateTypeChangeAttributeOrderByName            UpdateType = "changeAttributeOrderByName"
	UpdateTypeChangeCartDiscounts                   UpdateType = "changeCartDiscounts"
	UpdateTypeChangeCartPredicate                   UpdateType = "changeCartPredicate"
	UpdateTypeChangeCustomLineItemQuantity          UpdateType = "changeCustomLineItemQuantity"
	UpdateTypeChangeDescription                     UpdateType = "changeDescription"
	UpdateTypeChangeEmail                           UpdateType = "changeEmail"
	UpdateTypeChangeEnumKey                         UpdateType = "changeEnumKey"
	UpdateTypeChangeEnumValueLabel                  UpdateType = "changeEnumValueLabel"
	UpdateTypeChangeEnumValueOrder                  UpdateType = "changeEnumValueOrder"
	UpdateTypeChangeFieldDefinitionOrder            UpdateType = "changeFieldDefinitionOrder"
	UpdateTypeChangeGroups                          UpdateType = "changeGroups"
	UpdateTypeChangeInitial                         UpdateType = "changeInitial"
	UpdateTypeChangeInputHint                       UpdateType = "changeInputHint"
	UpdateTypeChangeIsActive                        UpdateType = "changeIsActive"
	UpdateTypeChangeIsSearchable                    UpdateType = "changeIsSearchable"
	UpdateTypeChangeKey                             UpdateType = "changeKey"
	UpdateTypeChangeLabel                           UpdateType = "changeLabel"
	UpdateTypeChangeLineItemName                    UpdateType = "changeLineItemName"
	UpdateTypeChangeLineItemQuantity                UpdateType = "changeLineItemQuantity"
	UpdateTypeChangeLineItemsOrder                  UpdateType = "changeLineItemsOrder"
	UpdateTypeChangeLocalizedEnumValueLabel         UpdateType = "changeLocalizedEnumValueLabel"
	UpdateTypeChangeLocalizedEnumValueOrder         UpdateType = "changeLocalizedEnumValueOrder"
	UpdateTypeChangeMasterVariant                   UpdateType = "changeMasterVariant"
	UpdateTypeChangeName                            UpdateType = "changeName"
	UpdateTypeChangeOrderHint                       UpdateType = "changeOrderHint"
	UpdateTypeChangeOrderState                      UpdateType = "changeOrderState"
	UpdateTypeChangeParent                          UpdateType = "changeParent"
	UpdateTypeChangeParentUnit                      UpdateType = "changeParentUnit"
	UpdateTypeChangePaymentState                    UpdateType = "changePaymentState"
	UpdateTypeChangePlainEnumValueLabel             UpdateType = "changePlainEnumValueLabel"
	UpdateTypeChangePredicate                       UpdateType = "changePredicate"
	UpdateTypeChangePrice                           UpdateType = "changePrice"
	UpdateTypeChangeProductSelectionActive          UpdateType = "changeProductSelectionActive"
	UpdateTypeChangeQuantity                        UpdateType = "changeQuantity"
	UpdateTypeChangeQuoteRequestState               UpdateType = "changeQuoteRequestState"
	UpdateTypeChangeQuoteState                      UpdateType = "changeQuoteState"
	UpdateTypeChangeRequiresDiscountCode            UpdateType = "changeRequiresDiscountCode"
	UpdateTypeChangeReviewRatingStatistics          UpdateType = "changeReviewRatingStatistics"
	UpdateTypeChangeShipmentState                   UpdateType = "changeShipmentState"
	UpdateTypeChangeSlug                            UpdateType = "changeSlug"
	UpdateTypeChangeSortOrder                       UpdateType = "changeSortOrder"
	UpdateTypeChangeStackingMode                    UpdateType = "changeStackingMode"
	UpdateTypeChangeStagedQuoteState                UpdateType = "changeStagedQuoteState"
	UpdateTypeChangeStatus                          UpdateType = "changeStatus"
	UpdateTypeChangeTarget                          UpdateType = "changeTarget"
	UpdateTypeChangeTaxCalculationMode              UpdateType = "changeTaxCalculationMode"
	UpdateTypeChangeTaxMode                         UpdateType = "changeTaxMode"
	UpdateTypeChangeTaxRoundingMode                 UpdateType = "changeTaxRoundingMode"
	UpdateTypeChangeTextLineItemName                UpdateType = "changeTextLineItemName"
	UpdateTypeChangeTextLineItemQuantity            UpdateType = "changeTextLineItemQuantity"
	UpdateTypeChangeTextLineItemsOrder              UpdateType = "changeTextLineItemsOrder"
	UpdateTypeChangeTransactionInteractionId        UpdateType = "changeTransactionInteractionId"
	UpdateTypeChangeTransactionState                UpdateType = "changeTransactionState"
	UpdateTypeChangeTransactionTimestamp            UpdateType = "changeTransactionTimestamp"
	UpdateTypeChangeType                            UpdateType = "changeType"
	UpdateTypeChangeValue                           UpdateType = "changeValue"
	UpdateTypeMoveImageToPosition                   UpdateType = "moveImageToPosition"
	UpdateTypePublish                               UpdateType = "publish"
	UpdateTypeRemoveAddress                         UpdateType = "removeAddress"
	UpdateTypeRemoveAsset                           UpdateType = "removeAsset"
	UpdateTypeRemoveAssociate                       UpdateType = "removeAssociate"
	UpdateTypeRemoveAttributeDefinition             UpdateType = "removeAttributeDefinition"
	UpdateTypeRemoveBillingAddressId                UpdateType = "removeBillingAddressId"
	UpdateTypeRemoveCustomLineItem                  UpdateType = "removeCustomLineItem"
	UpdateTypeRemoveDelivery                        UpdateType = "removeDelivery"
	UpdateTypeRemoveDiscountCode                    UpdateType = "removeDiscountCode"
	UpdateTypeRemoveEnumValues                      UpdateType = "removeEnumValues"
	UpdateTypeRemoveFieldDefinition                 UpdateType = "removeFieldDefinition"
	UpdateTypeRemoveFromCategory                    UpdateType = "removeFromCategory"
	UpdateTypeRemoveImage                           UpdateType = "removeImage"
	UpdateTypeRemoveItemShippingAddress             UpdateType = "removeItemShippingAddress"
	UpdateTypeRemoveLineItem                        UpdateType = "removeLineItem"
	UpdateTypeRemoveLocation                        UpdateType = "removeLocation"
	UpdateTypeRemoveParcelFromDelivery              UpdateType = "removeParcelFromDelivery"
	UpdateTypeRemovePayment                         UpdateType = "removePayment"
	UpdateTypeRemovePrice                           UpdateType = "removePrice"
	UpdateTypeRemoveProduct                         UpdateType = "removeProduct"
	UpdateTypeRemoveProductSelection                UpdateType = "removeProductSelection"
	UpdateTypeRemoveProperty                        UpdateType = "removeProperty"
	UpdateTypeRemoveRoles                           UpdateType = "removeRoles"
	UpdateTypeRemoveShippingAddressId               UpdateType = "removeShippingAddressId"
	UpdateTypeRemoveTaxRate                         UpdateType = "removeTaxRate"
	UpdateTypeRemoveTextLineItem                    UpdateType = "removeTextLineItem"
	UpdateTypeRemoveVariant                         UpdateType = "removeVariant"
	UpdateTypeRequestQuoteRenegotiation             UpdateType = "requestQuoteRenegotiation"
	UpdateTypeSetAddress                            UpdateType = "setAddress"
	UpdateTypeSetAddressCustomField                 UpdateType = "setAddressCustomField"
	UpdateTypeSetAddressCustomType                  UpdateType = "setAddressCustomType"
	UpdateTypeSetAnonymousId                        UpdateType = "setAnonymousId"
	UpdateTypeSetApplicationVersion                 UpdateType = "setApplicationVersion"
	UpdateTypeSetAssetCustomField                   UpdateType = "setAssetCustomField"
	UpdateTypeSetAssetCustomType                    UpdateType = "setAssetCustomType"
	UpdateTypeSetAssetDescription                   UpdateType = "setAssetDescription"
	UpdateTypeSetAssetSources                       UpdateType = "setAssetSources"
	UpdateTypeSetAssetTags                          UpdateType = "setAssetTags"
	UpdateTypeSetAsssetKey                          UpdateType = "setAsssetKey"
	UpdateTypeSetAttribute                          UpdateType = "setAttribute"
	UpdateTypeSetAuthenticationMode                 UpdateType = "setAuthenticationMode"
	UpdateTypeSetAuthorName                         UpdateType = "setAuthorName"
	UpdateTypeSetBillingAddress                     UpdateType = "setBillingAddress"
	UpdateTypeSetCartPredicate                      UpdateType = "setCartPredicate"
	UpdateTypeSetCategoryOrderHint                  UpdateType = "setCategoryOrderHint"
	UpdateTypeSetCompanyName                        UpdateType = "setCompanyName"
	UpdateTypeSetContactEmail                       UpdateType = "setContactEmail"
	UpdateTypeSetCountries                          UpdateType = "setCountries"
	UpdateTypeSetCountry                            UpdateType = "setCountry"
	UpdateTypeSetCustomField                        UpdateType = "setCustomField"
	UpdateTypeSetCustomLineItemCustomField          UpdateType = "setCustomLineItemCustomField"
	UpdateTypeSetCustomLineItemCustomType           UpdateType = "setCustomLineItemCustomType"
	UpdateTypeSetCustomLineItemMoney                UpdateType = "setCustomLineItemMoney"
	UpdateTypeSetCustomLineItemShippingDetails      UpdateType = "setCustomLineItemShippingDetails"
	UpdateTypeSetCustomLineItemTaxAmount            UpdateType = "setCustomLineItemTaxAmount"
	UpdateTypeSetCustomLineItemTaxCategory          UpdateType = "setCustomLineItemTaxCategory"
	UpdateTypeSetCustomLineItemTaxRate              UpdateType = "setCustomLineItemTaxRate"
	UpdateTypeSetCustomLineItemTaxedPrice           UpdateType = "setCustomLineItemTaxedPrice"
	UpdateTypeSetCustomLineItemTotalPrice           UpdateType = "setCustomLineItemTotalPrice"
	UpdateTypeSetCustomShippingMethod               UpdateType = "setCustomShippingMethod"
	UpdateTypeSetCustomType                         UpdateType = "setCustomType"
	UpdateTypeSetCustomer                           UpdateType = "setCustomer"
	UpdateTypeSetCustomerEmail                      UpdateType = "setCustomerEmail"
	UpdateTypeSetCustomerGroup                      UpdateType = "setCustomerGroup"
	UpdateTypeSetCustomerId                         UpdateType = "setCustomerId"
	UpdateTypeSetCustomerNumber                     UpdateType = "setCustomerNumber"
	UpdateTypeSetDateOfBirth                        UpdateType = "setDateOfBirth"
	UpdateTypeSetDefaultBillingAddress              UpdateType = "setDefaultBillingAddress"
	UpdateTypeSetDefaultShippingAddress             UpdateType = "setDefaultShippingAddress"
	UpdateTypeSetDeleteDaysAfterLastModification    UpdateType = "setDeleteDaysAfterLastModification"
	UpdateTypeSetDeliveryAddress                    UpdateType = "setDeliveryAddress"
	UpdateTypeSetDeliveryItems                      UpdateType = "setDeliveryItems"
	UpdateTypeSetDescription                        UpdateType = "setDescription"
	UpdateTypeSetDiscountedPrice                    UpdateType = "setDiscountedPrice"
	UpdateTypeSetDistributionChannels               UpdateType = "setDistributionChannels"
	UpdateTypeSetExpectedDelivery                   UpdateType = "setExpectedDelivery"
	UpdateTypeSetExternalId                         UpdateType = "setExternalId"
	UpdateTypeSetFirstName                          UpdateType = "setFirstName"
	UpdateTypeSetGeoLocation                        UpdateType = "setGeoLocation"
	UpdateTypeSetImageLabel                         UpdateType = "setImageLabel"
	UpdateTypeSetInputTip                           UpdateType = "setInputTip"
	UpdateTypeSetInterfaceId                        UpdateType = "setInterfaceId"
	UpdateTypeSetIsValid                            UpdateType = "setIsValid"
	UpdateTypeSetKey                                UpdateType = "setKey"
	UpdateTypeSetLanguages                          UpdateType = "setLanguages"
	UpdateTypeSetLastName                           UpdateType = "setLastName"
	UpdateTypeSetLineItemCustomField                UpdateType = "setLineItemCustomField"
	UpdateTypeSetLineItemCustomType                 UpdateType = "setLineItemCustomType"
	UpdateTypeSetLineItemDeactivatedAt              UpdateType = "setLineItemDeactivatedAt"
	UpdateTypeSetLineItemDiscountedPrice            UpdateType = "setLineItemDiscountedPrice"
	UpdateTypeSetLineItemDiscountedPricePerQuantity UpdateType = "setLineItemDiscountedPricePerQuantity"
	UpdateTypeSetLineItemDistributionChannel        UpdateType = "setLineItemDistributionChannel"
	UpdateTypeSetLineItemPrice                      UpdateType = "setLineItemPrice"
	UpdateTypeSetLineItemProductKey                 UpdateType = "setLineItemProductKey"
	UpdateTypeSetLineItemProductSlug                UpdateType = "setLineItemProductSlug"
	UpdateTypeSetLineItemShippingDetails            UpdateType = "setLineItemShippingDetails"
	UpdateTypeSetLineItemTaxAmount                  UpdateType = "setLineItemTaxAmount"
	UpdateTypeSetLineItemTaxRate                    UpdateType = "setLineItemTaxRate"
	UpdateTypeSetLineItemTaxedPrice                 UpdateType = "setLineItemTaxedPrice"
	UpdateTypeSetLineItemTotalPrice                 UpdateType = "setLineItemTotalPrice"
	UpdateTypeSetLocale                             UpdateType = "setLocale"
	UpdateTypeSetMaxApplications                    UpdateType = "setMaxApplications"
	UpdateTypeSetMaxApplicationsPerCustomer         UpdateType = "setMaxApplicationsPerCustomer"
	UpdateTypeSetMetaDescription                    UpdateType = "setMetaDescription"
	UpdateTypeSetMetaKeywords                       UpdateType = "setMetaKeywords"
	UpdateTypeSetMetaTitle                          UpdateType = "setMetaTitle"
	UpdateTypeSetMethodInfoInterface                UpdateType = "setMethodInfoInterface"
	UpdateTypeSetMethodInfoMethod                   UpdateType = "setMethodInfoMethod"
	UpdateTypeSetMethodInfoName                     UpdateType = "setMethodInfoName"
	UpdateTypeSetMiddleName                         UpdateType = "setMiddleName"
	UpdateTypeSetName                               UpdateType = "setName"
	UpdateTypeSetOrderNumber                        UpdateType = "setOrderNumber"
	UpdateTypeSetOrderTaxedPrice                    UpdateType = "setOrderTaxedPrice"
	UpdateTypeSetOrderTotalPrice                    UpdateType = "setOrderTotalPrice"
	UpdateTypeSetOrderTotalTax                      UpdateType = "setOrderTotalTax"
	UpdateTypeSetParcelItems                        UpdateType = "setParcelItems"
	UpdateTypeSetParcelMeasurements                 UpdateType = "setParcelMeasurements"
	UpdateTypeSetParcelTrackingData                 UpdateType = "setParcelTrackingData"
	UpdateTypeSetPassword                           UpdateType = "setPassword"
	UpdateTypeSetPrices                             UpdateType = "setPrices"
	UpdateTypeSetProductCount                       UpdateType = "setProductCount"
	UpdateTypeSetProductPriceCustomField            UpdateType = "setProductPriceCustomField"
	UpdateTypeSetProductPriceCustomType             UpdateType = "setProductPriceCustomType"
	UpdateTypeSetProductSelections                  UpdateType = "setProductSelections"
	UpdateTypeSetProductVariantKey                  UpdateType = "setProductVariantKey"
	UpdateTypeSetProperty                           UpdateType = "setProperty"
	UpdateTypeSetPurchaseOrderNumber                UpdateType = "setPurchaseOrderNumber"
	UpdateTypeSetRating                             UpdateType = "setRating"
	UpdateTypeSetReservations                       UpdateType = "setReservations"
	UpdateTypeSetRestockableInDays                  UpdateType = "setRestockableInDays"
	UpdateTypeSetReturnPaymentState                 UpdateType = "setReturnPaymentState"
	UpdateTypeSetReturnShipmentState                UpdateType = "setReturnShipmentState"
	UpdateTypeSetRoles                              UpdateType = "setRoles"
	UpdateTypeSetSalutation                         UpdateType = "setSalutation"
	UpdateTypeSetSearchKeywords                     UpdateType = "setSearchKeywords"
	UpdateTypeSetSellerComment                      UpdateType = "setSellerComment"
	UpdateTypeSetShippingAddress                    UpdateType = "setShippingAddress"
	UpdateTypeSetShippingInfoPrice                  UpdateType = "setShippingInfoPrice"
	UpdateTypeSetShippingInfoTaxedPrice             UpdateType = "setShippingInfoTaxedPrice"
	UpdateTypeSetShippingMethod                     UpdateType = "setShippingMethod"
	UpdateTypeSetShippingMethodTaxAmount            UpdateType = "setShippingMethodTaxAmount"
	UpdateTypeSetShippingMethodTaxRate              UpdateType = "setShippingMethodTaxRate"
	UpdateTypeSetShippingRate                       UpdateType = "setShippingRate"
	UpdateTypeSetShippingRateInput                  UpdateType = "setShippingRateInput"
	UpdateTypeSetSku                                UpdateType = "setSku"
	UpdateTypeSetSlug                               UpdateType = "setSlug"
	UpdateTypeSetStatusInterfaceCode                UpdateType = "setStatusInterfaceCode"
	UpdateTypeSetStatusInterfaceText                UpdateType = "setStatusInterfaceText"
	UpdateTypeSetStore                              UpdateType = "setStore"
	UpdateTypeSetStoreMode                          UpdateType = "setStoreMode"
	UpdateTypeSetStores                             UpdateType = "setStores"
	UpdateTypeSetSupplyChannel                      UpdateType = "setSupplyChannel"
	UpdateTypeSetSupplyChannels                     UpdateType = "setSupplyChannels"
	UpdateTypeSetTarget                             UpdateType = "setTarget"
	UpdateTypeSetTaxCategory                        UpdateType = "setTaxCategory"
	UpdateTypeSetText                               UpdateType = "setText"
	UpdateTypeSetTextLineItemCustomField            UpdateType = "setTextLineItemCustomField"
	UpdateTypeSetTextLineItemCustomType             UpdateType = "setTextLineItemCustomType"
	UpdateTypeSetTextLineItemDescription            UpdateType = "setTextLineItemDescription"
	UpdateTypeSetTitle                              UpdateType = "setTitle"
	UpdateTypeSetTransitions                        UpdateType = "setTransitions"
	UpdateTypeSetValidFrom                          UpdateType = "setValidFrom"
	UpdateTypeSetValidFromAndUntil                  UpdateType = "setValidFromAndUntil"
	UpdateTypeSetValidTo                            UpdateType = "setValidTo"
	UpdateTypeSetValidUntil                         UpdateType = "setValidUntil"
	UpdateTypeSetValue                              UpdateType = "setValue"
	UpdateTypeSetVariantAvailability                UpdateType = "setVariantAvailability"
	UpdateTypeSetVariantSelection                   UpdateType = "setVariantSelection"
	UpdateTypeSetVatId                              UpdateType = "setVatId"
	UpdateTypeTransitionCustomLineItemState         UpdateType = "transitionCustomLineItemState"
	UpdateTypeTransitionLineItemState               UpdateType = "transitionLineItemState"
	UpdateTypeTransitionState                       UpdateType = "transitionState"
	UpdateTypeUnpublish                             UpdateType = "unpublish"
	UpdateTypeUpdateItemShippingAddress             UpdateType = "updateItemShippingAddress"
	UpdateTypeUpdateSyncInfo                        UpdateType = "updateSyncInfo"
	UpdateTypeVerifyEmail                           UpdateType = "verifyEmail"
)

type ValidFromAndUntilValue

type ValidFromAndUntilValue struct {
	// Date and time (UTC) from when the Discount is effective.
	ValidFrom string `json:"validFrom"`
	// Date and time (UTC) until when the Discount is effective.
	ValidUntil string `json:"validUntil"`
}

type Variant

type Variant struct {
	ID  int    `json:"id"`
	Sku string `json:"sku"`
	Key string `json:"key"`
}

type VerifyEmailChange

type VerifyEmailChange struct {
	Change string `json:"change"`
}

* * Change triggered by a Customer email verification.

func (VerifyEmailChange) MarshalJSON

func (obj VerifyEmailChange) MarshalJSON() ([]byte, error)

MarshalJSON override to set the discriminator value or remove optional nil slices

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL