# Functions
New creates an EcomClient struct for interacting with the API Service.
# Variables
ErrAddressNotFound error.
ErrBadRequest is returned on 400 status code.
ErrCartNotFound error.
ErrCartProductExists error.
ErrCartProductNotFound error.
ErrCouponNotFound coupon not found.
ErrDeveloperKeyNotFound error.
ErrEventTypeNotFound error.
ErrInventoryNotFound error.
ErrOfferExists error (offers/offer-exists).
ErrOfferNotFound error (offers/offer-not-found).
ErrOrderNotFound error.
ErrPPAssocGroupNotFound error.
ErrPPAssocNotFound error.
ErrPriceListCodeExists error.
ErrPriceListNotFound error.
ErrProductNotFound indicates the product with given SKU could not be found.
ErrPromoRuleNotFound 404.
ErrShippingTariffNotFound 404.
ErrWebhookExists webhook already exists.
ErrWebhookNotFound webhook not found error.
Version string.
# Structs
Address contains address information for a user.
AddressListContainer object.
An AssocProduct holds details of a product in the context of an AssocSet.
AssocResponse details a catalog association including products.
Cart JSON response.
CartProduct JSON response.
CartProductRequest JSON request for adding a product to an existing cart.
CartProductsContainer container.
A CatalogYAML contains a single root node of the catalog.
CategoriesContainerResponse a container for list of catgory objects.
Category contains the JSON response from the API.
CategoryContainer is container struct for a list of Category.
CategoryRequest body for updating the categories tree.
CategoryTreeResponse is a single node in the catalog.
A CategoryYAML is a single node in the categories tree in the YAML file.
ConfigContainerResponse container.
Coupon a single coupon for use with the cart.
CreateAddressRequest JSON payload.
CreateCouponRequest request body.
CreateOfferRequest request.
CreatePAGroupRequest Product Associations Group request.
CreatePriceListRequest request body for creating a new price list.
CreateProductsCategories request body.
CreateProductsCategoriesContainer request body.
CreateShippingTariffRequest request body.
CreateUserRequest request body.
CreateWebhookRequest payload.
DevKeyRequest request body.
DevKeyResponse developer key JSON response body.
DevKeysContainer object.
EcomClient structure.
FirebaseConfigResponse firebase config response.
ImageRequest JSON request body.
ImageResponse JSON image response body.
Inventory holds inventory for a single product.
InventoryBatchContainerYAML main container for inventory YAML file.
InventoryBatchUpdateContainer list of inventory update request.
InventoryBatchUpdateRequest JSON batch inventory update request.
InventoryBatchYAML individual update.
InventoryContainer list of inventory objects.
Offer response.
OfferContainer list container.
Order summary.
OrderAddr shipping or billing address.
OrderAddressRequest contains the new address request body.
OrderItem product item inside the order.
OrderListContainer object.
OrderRequest for guest and registered user orders.
PPAssoc represents a single product to product association.
PPAssocGroupContainer container.
PPAssocGroupResponse holds a product to product associations group.
PPAssocsContainer structure.
Price a single price.
PriceList price list JSON response body.
PriceListContainer price list container JSON body.
PriceRequest JSON price request body.
PricesContainer a container for a list of price lists.
PricesContainerRequest JSON request body.
PriceYAML YAML price.
ProductApplyYAML contains fields used when applying a product.
ProductCategoryContainerResponse container.
ProductCategoryRelationsYAML for the product to category relations.
ProductCategoryResponse response body.
ProductContainerResponse is a container for a list of products.
ProductContainerYAML container for a YAML product.
ProductImage struct for capturing OpReplaceProduct JSON response.
ProductImageApply contains the product image data.
ProductImageApplyYAML contains the product image data.
ProductPricing struct.
ProductPricingApply contains the product pricing data.
ProductRequest contains fields used when applying a product.
ProductResponse contains all the fields that comprise a product in the catalog.
An ProductSetYAML holds a single product to catalog association.
ProductYAML contains all the fields that comprise a product in the catalog.
PromoRule price list JSON response body.
PromoRuleRequest request body.
PromoRulesContainer promo rules container JSON body.
ShippingTariff shipping tariff JSON response body.
ShippingTariffContainer promo rules container JSON body.
SysInfo provides a record of system information.
UpdateAddressRequest JSON payload.
UpdateInventoryRequest JSON payload.
UpdatePriceListRequest request body for updating a new price list.
UpdateWebhookRequest payload.
UserContainer object.
UserResponse user JSON response body.
WebhookContainer structure.
WebhookEventsRequest events.
WebhookResponse object.