products

Documentation

Index

• Variables
• type AddProductPayload
• type Content
• type MProduct
  • func CreateOrReplaceProduct(product *Product, saveOptions bool, apiClient *api.Client) (*MProduct, error)
  • func GetProductBySKU(sku string, apiClient *api.Client) (*MProduct, error)
  • func (mProduct *MProduct) UpdateProductFromRemote() error
  • func (mProduct *MProduct) UpdateQuantityForStockItem(stockItem string, quantity int, isInStock bool) error
• type MediaGalleryEntries
• type Options
• type Product
• type ProductLinks
• type StockItem
• type TierPrices
• type Values
• type VideoContent

Variables

var ErrNotFound = errors.New("no document found")

Types

type AddProductPayload

type AddProductPayload struct {
	Product     Product `json:"product"`
	SaveOptions bool    `json:"saveOptions"`
}

type Content

type Content struct {
	Base64EncodedData string `json:"base64_encoded_data"`
	Type              string `json:"type"`
	Name              string `json:"name"`
}

type MProduct

type MProduct struct {
	Route     string
	Product   *Product
	APIClient *api.Client
}

func CreateOrReplaceProduct

func CreateOrReplaceProduct(product *Product, saveOptions bool, apiClient *api.Client) (*MProduct, error)

func GetProductBySKU

func GetProductBySKU(sku string, apiClient *api.Client) (*MProduct, error)

func (*MProduct) UpdateProductFromRemote

func (mProduct *MProduct) UpdateProductFromRemote() error

func (*MProduct) UpdateQuantityForStockItem

func (mProduct *MProduct) UpdateQuantityForStockItem(stockItem string, quantity int, isInStock bool) error

type MediaGalleryEntries

type MediaGalleryEntries struct {
	ID                  int                    `json:"id"`
	MediaType           string                 `json:"media_type"`
	Label               string                 `json:"label"`
	Position            int                    `json:"position"`
	Disabled            bool                   `json:"disabled"`
	Types               []string               `json:"types"`
	File                string                 `json:"file"`
	Content             Content                `json:"content"`
	ExtensionAttributes map[string]interface{} `json:"extension_attributes"`
}

type Options

type Options struct {
	ProductSku          string                 `json:"product_sku,omitempty"`
	OptionID            int                    `json:"option_id,omitempty"`
	Title               string                 `json:"title,omitempty"`
	Type                string                 `json:"type,omitempty"`
	SortOrder           int                    `json:"sort_order,omitempty"`
	IsRequired          bool                   `json:"is_required,omitempty"`
	Price               float64                `json:"price,omitempty"`
	PriceType           string                 `json:"price_type,omitempty"`
	Sku                 string                 `json:"sku,omitempty"`
	FileExtension       string                 `json:"file_extension,omitempty"`
	MaxCharacters       int                    `json:"max_characters,omitempty"`
	ImageSizeX          int                    `json:"image_size_x,omitempty"`
	ImageSizeY          int                    `json:"image_size_y,omitempty"`
	Values              []Values               `json:"values,omitempty"`
	ExtensionAttributes map[string]interface{} `json:"extension_attributes,omitempty"`
}

type Product

type Product struct {
	ID                  int                      `json:"id,omitempty"`
	Sku                 string                   `json:"sku"`
	Name                string                   `json:"name"`
	AttributeSetID      int                      `json:"attribute_set_id"`
	Price               float64                  `json:"price"`
	Status              int                      `json:"status,omitempty"`
	Visibility          int                      `json:"visibility,omitempty"`
	TypeID              string                   `json:"type_id,omitempty"`
	CreatedAt           string                   `json:"created_at,omitempty"`
	UpdatedAt           string                   `json:"updated_at,omitempty"`
	Weight              float64                  `json:"weight,omitempty"`
	ExtensionAttributes map[string]interface{}   `json:"extension_attributes,omitempty"`
	ProductLinks        []ProductLinks           `json:"product_links,omitempty"`
	Options             []Options                `json:"options,omitempty"`
	MediaGalleryEntries []MediaGalleryEntries    `json:"media_gallery_entries,omitempty"`
	TierPrices          []TierPrices             `json:"tier_prices,omitempty"`
	CustomAttributes    []map[string]interface{} `json:"custom_attributes,omitempty"`
}

type ProductLinks

type ProductLinks struct {
	Sku                 string                 `json:"sku"`
	LinkType            string                 `json:"link_type"`
	LinkedProductSku    string                 `json:"linked_product_sku"`
	LinkedProductType   string                 `json:"linked_product_type"`
	Position            int                    `json:"position"`
	ExtensionAttributes map[string]interface{} `json:"extension_attributes"`
}

type StockItem

type StockItem struct {
	ItemID                         int                    `json:"item_id,omitempty"`
	ProductID                      int                    `json:"product_id,omitempty"`
	StockID                        int                    `json:"stock_id,omitempty"`
	Qty                            int                    `json:"qty,omitempty"`
	IsInStock                      bool                   `json:"is_in_stock,omitempty"`
	IsQtyDecimal                   bool                   `json:"is_qty_decimal,omitempty"`
	ShowDefaultNotificationMessage bool                   `json:"show_default_notification_message,omitempty"`
	UseConfigMinQty                bool                   `json:"use_config_min_qty,omitempty"`
	MinQty                         int                    `json:"min_qty,omitempty"`
	UseConfigMinSaleQty            int                    `json:"use_config_min_sale_qty,omitempty"`
	MinSaleQty                     int                    `json:"min_sale_qty,omitempty"`
	UseConfigMaxSaleQty            bool                   `json:"use_config_max_sale_qty,omitempty"`
	MaxSaleQty                     int                    `json:"max_sale_qty,omitempty"`
	UseConfigBackorders            bool                   `json:"use_config_backorders,omitempty"`
	Backorders                     int                    `json:"backorders,omitempty"`
	UseConfigNotifyStockQty        bool                   `json:"use_config_notify_stock_qty,omitempty"`
	NotifyStockQty                 int                    `json:"notify_stock_qty,omitempty"`
	UseConfigQtyIncrements         bool                   `json:"use_config_qty_increments,omitempty"`
	QtyIncrements                  int                    `json:"qty_increments,omitempty"`
	UseConfigEnableQtyInc          bool                   `json:"use_config_enable_qty_inc,omitempty"`
	EnableQtyIncrements            bool                   `json:"enable_qty_increments,omitempty"`
	UseConfigManageStock           bool                   `json:"use_config_manage_stock,omitempty"`
	ManageStock                    bool                   `json:"manage_stock,omitempty"`
	LowStockDate                   string                 `json:"low_stock_date,omitempty"`
	IsDecimalDivided               bool                   `json:"is_decimal_divided,omitempty"`
	StockStatusChangedAuto         int                    `json:"stock_status_changed_auto,omitempty"`
	ExtensionAttributes            map[string]interface{} `json:"extension_attributes,omitempty"`
}

type TierPrices

type TierPrices struct {
	CustomerGroupID     int                    `json:"customer_group_id"`
	Qty                 float64                `json:"qty"`
	Value               float64                `json:"value"`
	ExtensionAttributes map[string]interface{} `json:"extension_attributes"`
}

type Values

type Values struct {
	Title        string  `json:"title"`
	SortOrder    int     `json:"sort_order"`
	Price        float64 `json:"price"`
	PriceType    string  `json:"price_type"`
	Sku          string  `json:"sku"`
	OptionTypeID int     `json:"option_type_id"`
}

type VideoContent

type VideoContent struct {
	MediaType        string `json:"media_type"`
	VideoProvider    string `json:"video_provider"`
	VideoURL         string `json:"video_url"`
	VideoTitle       string `json:"video_title"`
	VideoDescription string `json:"video_description"`
	VideoMetadata    string `json:"video_metadata"`
}