com

package

Go to main page

Versions in this module

v1

v1.2.3

May 1, 2024

v1.2.2

Apr 10, 2024

v1.2.1

Mar 19, 2024

v1.2.0

Mar 19, 2024

Changes in this version

+ const SearchFilterTypeContains

+ const SearchFilterTypeMulti

+ const SearchFilterTypeNot

+ const SearchFilterTypePrefix

+ const SearchFilterTypeRange

+ const SearchFilterTypeSuffix

type Criteria

+ Query []CriteriaQuery

type CriteriaFilter

+ Operator string

+ Queries []CriteriaFilter

+ type CriteriaFilterQuery struct

+ Field string

+ Value interface{}

+ type CriteriaQuery struct

+ Query CriteriaFilterQuery

+ Score uint64

v1.1.0

Feb 15, 2024

Changes in this version

+ type ACLRoleCollection struct

+ Data []model.AclRole

+ type ACLUserRoleCollection struct

+ Data []model.AclUserRole

+ type APIContext struct

+ LanguageID string

+ SkipFlows bool

+ VersionID string

+ func NewAPIContext(ctx context.Context) APIContext

type Client

+ func (c *Client) SearchIDs(ctx APIContext, criteria Criteria, v interface{}) (*SearchIDsResponse, error)

type IntegrationCredentials

+ ClientID string

+ type SEOUrlCollection struct

+ Data []model.SeoUrl

+ type SEOUrlTemplateCollection struct

+ Data []model.SeoUrlTemplate

+ type SearchIDsResponse struct

+ Data []string

+ Total int

v1.0.4

Dec 20, 2023

v1.0.3

Aug 24, 2023

v1.0.2

Jul 24, 2023

Changes in this version

type ErrorResponse

+ Errors []struct{ ... }

+ Extensions []interface{}

v1.0.1

Feb 22, 2023

v1.0.0

Feb 13, 2023

Changes in this version

+ const SearchFilterTypeEquals

+ const SearchFilterTypeEqualsAny

+ const SearchSortDirectionAscending

+ const SearchSortDirectionDescending

+ const TotalCountModeDefault

+ const TotalCountModeExact

+ const TotalCountModeNextPage

+ type APIError struct

+ Raw []byte

+ Response ErrorResponse

+ StatusCode int

+ func (e APIError) Error() string

+ type AclRoleCollection struct

+ Data []model.AclRole

+ type AclUserRoleCollection struct

+ Data []model.AclUserRole

+ type ApiContext struct

+ Context context.Context

+ LanguageId string

+ SkipFlows bool

+ VersionId string

+ func NewApiContext(ctx context.Context) ApiContext

+ type AppActionButtonCollection struct

+ Data []model.AppActionButton

+ type AppActionButtonTranslationCollection struct

+ Data []model.AppActionButtonTranslation

+ type AppCmsBlockCollection struct

+ Data []model.AppCmsBlock

+ type AppCmsBlockTranslationCollection struct

+ Data []model.AppCmsBlockTranslation

+ type AppCollection struct

+ Data []model.App

+ type AppPaymentMethodCollection struct

+ Data []model.AppPaymentMethod

+ type AppTemplateCollection struct

+ Data []model.AppTemplate

+ type AppTranslationCollection struct

+ Data []model.AppTranslation

+ type CategoryCollection struct

+ Data []model.Category

+ type CategoryTagCollection struct

+ Data []model.CategoryTag

+ type CategoryTranslationCollection struct

+ Data []model.CategoryTranslation

+ type Client struct

+ ResponseHandler func(resp *http.Response) error

+ func NewClient(ctx context.Context, shopURL string, credentials OAuthCredentials, ...) (*Client, error)

+ func (c *Client) BareDo(ctx context.Context, req *http.Request) (*http.Response, error)

+ func (c *Client) Delete(ctx ApiContext, entity interface{}, ids []string) (*http.Response, error)

+ func (c *Client) Do(ctx context.Context, req *http.Request, v interface{}) (*http.Response, error)

+ func (c *Client) GetSegment(v interface{}) string

+ func (c *Client) GetSegmentSnakeCase(v interface{}) string

+ func (c *Client) Info(ctx ApiContext) (*InfoResponse, *http.Response, error)

+ func (c *Client) NewRawRequest(context ApiContext, method, path string, options map[string]string, ...) (*http.Request, error)

+ func (c *Client) NewRequest(context ApiContext, method, path string, options map[string]string, ...) (*http.Request, error)

+ func (c *Client) Search(ctx ApiContext, criteria Criteria, v Collection) error

+ func (c *Client) SearchAll(ctx ApiContext, criteria Criteria, v Collection) error

+ func (c *Client) SearchIds(ctx ApiContext, criteria Criteria, v interface{}) (*SearchIdsResponse, error)

+ func (c *Client) Sync(ctx ApiContext, payload map[string]SyncOperation) (*http.Response, error)

+ func (c *Client) Upsert(ctx ApiContext, entities interface{}) (*http.Response, error)

+ func (c Client) Clear(ctx ApiContext) (*http.Response, error)

+ type CmsBlockCollection struct

+ Data []model.CmsBlock

+ type CmsPageCollection struct

+ Data []model.CmsPage

+ type CmsPageTranslationCollection struct

+ Data []model.CmsPageTranslation

+ type CmsSectionCollection struct

+ Data []model.CmsSection

+ type CmsSlotCollection struct

+ Data []model.CmsSlot

+ type CmsSlotTranslationCollection struct

+ Data []model.CmsSlotTranslation

+ type Collection interface

+ type CountryCollection struct

+ Data []model.Country

+ type CountryStateCollection struct

+ Data []model.CountryState

+ type CountryStateTranslationCollection struct

+ Data []model.CountryStateTranslation

+ type CountryTranslationCollection struct

+ Data []model.CountryTranslation

+ type Criteria struct

+ Associations map[string]Criteria

+ Filter []CriteriaFilter

+ IDs []string

+ Includes map[string][]string

+ Limit int64

+ Page int64

+ PostFilter []CriteriaFilter

+ Sort []CriteriaSort

+ Term string

+ TotalCountMode int

+ type CriteriaFilter struct

+ Field string

+ Type string

+ Value interface{}

+ type CriteriaSort struct

+ Direction string

+ Field string

+ NaturalSorting bool

+ type CurrencyCollection struct

+ Data []model.Currency

+ type CurrencyCountryRoundingCollection struct

+ Data []model.CurrencyCountryRounding

+ type CurrencyTranslationCollection struct

+ Data []model.CurrencyTranslation

+ type CustomFieldCollection struct

+ Data []model.CustomField

+ type CustomFieldSetCollection struct

+ Data []model.CustomFieldSet

+ type CustomFieldSetRelationCollection struct

+ Data []model.CustomFieldSetRelation

+ type CustomPriceCollection struct

+ Data []model.CustomPrice

+ type CustomerAddressCollection struct

+ Data []model.CustomerAddress

+ type CustomerCollection struct

+ Data []model.Customer

+ type CustomerGroupCollection struct

+ Data []model.CustomerGroup

+ type CustomerGroupRegistrationSalesChannelsCollection struct

+ Data []model.CustomerGroupRegistrationSalesChannels

+ type CustomerGroupTranslationCollection struct

+ Data []model.CustomerGroupTranslation

+ type CustomerRecoveryCollection struct

+ Data []model.CustomerRecovery

+ type CustomerTagCollection struct

+ Data []model.CustomerTag

+ type CustomerWishlistCollection struct

+ Data []model.CustomerWishlist

+ type CustomerWishlistProductCollection struct

+ Data []model.CustomerWishlistProduct

+ type DeadMessageCollection struct

+ Data []model.DeadMessage

+ type DeliveryTimeCollection struct

+ Data []model.DeliveryTime

+ type DeliveryTimeTranslationCollection struct

+ Data []model.DeliveryTimeTranslation

+ type DocumentBaseConfigCollection struct

+ Data []model.DocumentBaseConfig

+ type DocumentBaseConfigSalesChannelCollection struct

+ Data []model.DocumentBaseConfigSalesChannel

+ type DocumentCollection struct

+ Data []model.Document

+ type DocumentTypeCollection struct

+ Data []model.DocumentType

+ type DocumentTypeTranslationCollection struct

+ Data []model.DocumentTypeTranslation

+ type EntityCollection struct

+ Aggregations interface{}

+ Data []interface{}

+ Total int64

+ type ErrorResponse struct

+ Data map[string]struct{ ... }

+ Success bool

+ type EventActionCollection struct

+ Data []model.EventAction

+ type EventActionRuleCollection struct

+ Data []model.EventActionRule

+ type EventActionSalesChannelCollection struct

+ Data []model.EventActionSalesChannel

+ type FlowCollection struct

+ Data []model.Flow

+ type FlowSequenceCollection struct

+ Data []model.FlowSequence

+ type ImportExportFileCollection struct

+ Data []model.ImportExportFile

+ type ImportExportLogCollection struct

+ Data []model.ImportExportLog

+ type ImportExportProfileCollection struct

+ Data []model.ImportExportProfile

+ type ImportExportProfileTranslationCollection struct

+ Data []model.ImportExportProfileTranslation

+ type InfoResponse struct

+ AdminWorker struct{ ... }

+ Bundles map[string]infoResponseBundle

+ Settings struct{ ... }

+ Version string

+ VersionRevision string

+ func (r InfoResponse) IsCloudShop() bool

+ type IntegrationCollection struct

+ Data []model.Integration

+ type IntegrationCredentials struct

+ ClientId string

+ ClientSecret string

+ Scopes []string

+ func NewIntegrationCredentials(clientId, clientSecret string, scopes []string) IntegrationCredentials

+ func (c IntegrationCredentials) GetTokenSource(ctx context.Context, tokenURL string) (oauth2.TokenSource, error)

+ type IntegrationRoleCollection struct

+ Data []model.IntegrationRole

+ type LandingPageCollection struct

+ Data []model.LandingPage

+ type LandingPageSalesChannelCollection struct

+ Data []model.LandingPageSalesChannel

+ type LandingPageTagCollection struct

+ Data []model.LandingPageTag

+ type LandingPageTranslationCollection struct

+ Data []model.LandingPageTranslation

+ type LanguageCollection struct

+ Data []model.Language

+ type LocaleCollection struct

+ Data []model.Locale

+ type LocaleTranslationCollection struct

+ Data []model.LocaleTranslation

+ type LogEntryCollection struct

+ Data []model.LogEntry

+ type MailHeaderFooterCollection struct

+ Data []model.MailHeaderFooter

+ type MailHeaderFooterTranslationCollection struct

+ Data []model.MailHeaderFooterTranslation

+ type MailTemplateCollection struct

+ Data []model.MailTemplate

+ type MailTemplateMediaCollection struct

+ Data []model.MailTemplateMedia

+ type MailTemplateTranslationCollection struct

+ Data []model.MailTemplateTranslation

+ type MailTemplateTypeCollection struct

+ Data []model.MailTemplateType

+ type MailTemplateTypeTranslationCollection struct

+ Data []model.MailTemplateTypeTranslation

+ type MainCategoryCollection struct

+ Data []model.MainCategory

+ type MediaCollection struct

+ Data []model.Media

+ type MediaDefaultFolderCollection struct

+ Data []model.MediaDefaultFolder

+ type MediaFolderCollection struct

+ Data []model.MediaFolder

+ type MediaFolderConfigurationCollection struct

+ Data []model.MediaFolderConfiguration

+ type MediaFolderConfigurationMediaThumbnailSizeCollection struct

+ Data []model.MediaFolderConfigurationMediaThumbnailSize

+ type MediaTagCollection struct

+ Data []model.MediaTag

+ type MediaThumbnailCollection struct

+ Data []model.MediaThumbnail

+ type MediaThumbnailSizeCollection struct

+ Data []model.MediaThumbnailSize

+ type MediaTranslationCollection struct

+ Data []model.MediaTranslation

+ type MessageQueueStatsCollection struct

+ Data []model.MessageQueueStats

+ type NewsletterRecipientCollection struct

+ Data []model.NewsletterRecipient

+ type NewsletterRecipientTagCollection struct

+ Data []model.NewsletterRecipientTag

+ type NotificationCollection struct

+ Data []model.Notification

+ type NumberRangeCollection struct

+ Data []model.NumberRange

+ type NumberRangeSalesChannelCollection struct

+ Data []model.NumberRangeSalesChannel

+ type NumberRangeStateCollection struct

+ Data []model.NumberRangeState

+ type NumberRangeTranslationCollection struct

+ Data []model.NumberRangeTranslation

+ type NumberRangeTypeCollection struct

+ Data []model.NumberRangeType

+ type NumberRangeTypeTranslationCollection struct

+ Data []model.NumberRangeTypeTranslation

+ type OAuthCredentials interface

+ GetTokenSource func(ctx context.Context, tokenURL string) (oauth2.TokenSource, error)

+ type OrderAddressCollection struct

+ Data []model.OrderAddress

+ type OrderCollection struct

+ Data []model.Order

+ type OrderCustomerCollection struct

+ Data []model.OrderCustomer

+ type OrderDeliveryCollection struct

+ Data []model.OrderDelivery

+ type OrderDeliveryPositionCollection struct

+ Data []model.OrderDeliveryPosition

+ type OrderLineItemCollection struct

+ Data []model.OrderLineItem

+ type OrderTagCollection struct

+ Data []model.OrderTag

+ type OrderTransactionCollection struct

+ Data []model.OrderTransaction

+ type PasswordCredentials struct

+ Password string

+ Scopes []string

+ Username string

+ func NewPasswordCredentials(username, password string, scopes []string) PasswordCredentials

+ func (c PasswordCredentials) GetTokenSource(ctx context.Context, tokenURL string) (oauth2.TokenSource, error)

+ type PaymentMethodCollection struct

+ Data []model.PaymentMethod

+ type PaymentMethodTranslationCollection struct

+ Data []model.PaymentMethodTranslation

+ type PluginCollection struct

+ Data []model.Plugin

+ type PluginTranslationCollection struct

+ Data []model.PluginTranslation

+ type ProductCategoryCollection struct

+ Data []model.ProductCategory

+ type ProductCategoryTreeCollection struct

+ Data []model.ProductCategoryTree

+ type ProductCollection struct

+ Data []model.Product

+ type ProductConfiguratorSettingCollection struct

+ Data []model.ProductConfiguratorSetting

+ type ProductCrossSellingAssignedProductsCollection struct

+ Data []model.ProductCrossSellingAssignedProducts

+ type ProductCrossSellingCollection struct

+ Data []model.ProductCrossSelling

+ type ProductCrossSellingTranslationCollection struct

+ Data []model.ProductCrossSellingTranslation

+ type ProductCustomFieldSetCollection struct

+ Data []model.ProductCustomFieldSet

+ type ProductExportCollection struct

+ Data []model.ProductExport

+ type ProductFeatureSetCollection struct

+ Data []model.ProductFeatureSet

+ type ProductFeatureSetTranslationCollection struct

+ Data []model.ProductFeatureSetTranslation

+ type ProductKeywordDictionaryCollection struct

+ Data []model.ProductKeywordDictionary

+ type ProductManufacturerCollection struct

+ Data []model.ProductManufacturer

+ type ProductManufacturerTranslationCollection struct

+ Data []model.ProductManufacturerTranslation

+ type ProductMediaCollection struct

+ Data []model.ProductMedia

+ type ProductOptionCollection struct

+ Data []model.ProductOption

+ type ProductPriceCollection struct

+ Data []model.ProductPrice

+ type ProductPropertyCollection struct

+ Data []model.ProductProperty

+ type ProductReviewCollection struct

+ Data []model.ProductReview

+ type ProductSearchConfigCollection struct

+ Data []model.ProductSearchConfig

+ type ProductSearchConfigFieldCollection struct

+ Data []model.ProductSearchConfigField

+ type ProductSearchKeywordCollection struct

+ Data []model.ProductSearchKeyword

+ type ProductSortingCollection struct

+ Data []model.ProductSorting

+ type ProductSortingTranslationCollection struct

+ Data []model.ProductSortingTranslation

+ type ProductStreamCollection struct

+ Data []model.ProductStream

+ type ProductStreamFilterCollection struct

+ Data []model.ProductStreamFilter

+ type ProductStreamMappingCollection struct

+ Data []model.ProductStreamMapping

+ type ProductStreamTranslationCollection struct

+ Data []model.ProductStreamTranslation

+ type ProductTagCollection struct

+ Data []model.ProductTag

+ type ProductTranslationCollection struct

+ Data []model.ProductTranslation

+ type ProductVisibilityCollection struct

+ Data []model.ProductVisibility

+ type PromotionCartRuleCollection struct

+ Data []model.PromotionCartRule

+ type PromotionCollection struct

+ Data []model.Promotion

+ type PromotionDiscountCollection struct

+ Data []model.PromotionDiscount

+ type PromotionDiscountPricesCollection struct

+ Data []model.PromotionDiscountPrices

+ type PromotionDiscountRuleCollection struct

+ Data []model.PromotionDiscountRule

+ type PromotionIndividualCodeCollection struct

+ Data []model.PromotionIndividualCode

+ type PromotionOrderRuleCollection struct

+ Data []model.PromotionOrderRule

+ type PromotionPersonaCustomerCollection struct

+ Data []model.PromotionPersonaCustomer

+ type PromotionPersonaRuleCollection struct

+ Data []model.PromotionPersonaRule

+ type PromotionSalesChannelCollection struct

+ Data []model.PromotionSalesChannel

+ type PromotionSetgroupCollection struct

+ Data []model.PromotionSetgroup

+ type PromotionSetgroupRuleCollection struct

+ Data []model.PromotionSetgroupRule

+ type PromotionTranslationCollection struct

+ Data []model.PromotionTranslation

+ type PropertyGroupCollection struct

+ Data []model.PropertyGroup

+ type PropertyGroupOptionCollection struct

+ Data []model.PropertyGroupOption

+ type PropertyGroupOptionTranslationCollection struct

+ Data []model.PropertyGroupOptionTranslation

+ type PropertyGroupTranslationCollection struct

+ Data []model.PropertyGroupTranslation

+ type RuleCollection struct

+ Data []model.Rule

+ type RuleConditionCollection struct

+ Data []model.RuleCondition

+ type RuleTagCollection struct

+ Data []model.RuleTag

+ type SalesChannelAnalyticsCollection struct

+ Data []model.SalesChannelAnalytics

+ type SalesChannelCollection struct

+ Data []model.SalesChannel

+ type SalesChannelCountryCollection struct

+ Data []model.SalesChannelCountry

+ type SalesChannelCurrencyCollection struct

+ Data []model.SalesChannelCurrency

+ type SalesChannelDomainCollection struct

+ Data []model.SalesChannelDomain

+ type SalesChannelLanguageCollection struct

+ Data []model.SalesChannelLanguage

+ type SalesChannelPaymentMethodCollection struct

+ Data []model.SalesChannelPaymentMethod

+ type SalesChannelShippingMethodCollection struct

+ Data []model.SalesChannelShippingMethod

+ type SalesChannelTranslationCollection struct

+ Data []model.SalesChannelTranslation

+ type SalesChannelTypeCollection struct

+ Data []model.SalesChannelType

+ type SalesChannelTypeTranslationCollection struct

+ Data []model.SalesChannelTypeTranslation

+ type SalutationCollection struct

+ Data []model.Salutation

+ type SalutationTranslationCollection struct

+ Data []model.SalutationTranslation

+ type ScheduledTaskCollection struct

+ Data []model.ScheduledTask

+ type ScriptCollection struct

+ Data []model.Script

+ type SearchFilterType string

+ type SearchIdsResponse struct

+ Data []string

+ Total int

+ type SearchSortDirection string

+ type SeoUrlCollection struct

+ Data []model.SeoUrl

+ type SeoUrlTemplateCollection struct

+ Data []model.SeoUrlTemplate

+ type ShippingMethodCollection struct

+ Data []model.ShippingMethod

+ type ShippingMethodPriceCollection struct

+ Data []model.ShippingMethodPrice

+ type ShippingMethodTagCollection struct

+ Data []model.ShippingMethodTag

+ type ShippingMethodTranslationCollection struct

+ Data []model.ShippingMethodTranslation

+ type SnippetCollection struct

+ Data []model.Snippet

+ type SnippetSetCollection struct

+ Data []model.SnippetSet

+ type StateMachineCollection struct

+ Data []model.StateMachine

+ type StateMachineHistoryCollection struct

+ Data []model.StateMachineHistory

+ type StateMachineStateCollection struct

+ Data []model.StateMachineState

+ type StateMachineStateTranslationCollection struct

+ Data []model.StateMachineStateTranslation

+ type StateMachineTransitionCollection struct

+ Data []model.StateMachineTransition

+ type StateMachineTranslationCollection struct

+ Data []model.StateMachineTranslation

+ type SyncOperation struct

+ Action string

+ Entity string

+ Payload interface{}

+ type SystemConfigCollection struct

+ Data []model.SystemConfig

+ type TagCollection struct

+ Data []model.Tag

+ type TaxCollection struct

+ Data []model.Tax

+ type TaxRuleCollection struct

+ Data []model.TaxRule

+ type TaxRuleTypeCollection struct

+ Data []model.TaxRuleType

+ type TaxRuleTypeTranslationCollection struct

+ Data []model.TaxRuleTypeTranslation

+ type ThemeChildCollection struct

+ Data []model.ThemeChild

+ type ThemeCollection struct

+ Data []model.Theme

+ type ThemeMediaCollection struct

+ Data []model.ThemeMedia

+ type ThemeSalesChannelCollection struct

+ Data []model.ThemeSalesChannel

+ type ThemeTranslationCollection struct

+ Data []model.ThemeTranslation

+ type TotalCountMode uint

+ type UnitCollection struct

+ Data []model.Unit

+ type UnitTranslationCollection struct

+ Data []model.UnitTranslation

+ type UserAccessKeyCollection struct

+ Data []model.UserAccessKey

+ type UserCollection struct

+ Data []model.User

+ type UserConfigCollection struct

+ Data []model.UserConfig

+ type UserRecoveryCollection struct

+ Data []model.UserRecovery

+ type VersionCollection struct

+ Data []model.Version

+ type VersionCommitCollection struct

+ Data []model.VersionCommit

+ type VersionCommitDataCollection struct

+ Data []model.VersionCommitData

+ type WebhookCollection struct

+ Data []model.Webhook

+ type WebhookEventLogCollection struct

+ Data []model.WebhookEventLog

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL