Struct mailchimp_api::ecommerce::Ecommerce

pub struct Ecommerce {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Ecommerce

pub async fn get_order(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    campaign_id: &str,
    outreach_id: &str,
    customer_id: &str,
    has_outreach: bool
) -> Result<OrdersData>

List account orders.

This function performs a GET to the /ecommerce/orders endpoint.

Get information about an account’s orders.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• campaign_id: &str – Restrict results to orders with a specific campaign_id value.
• outreach_id: &str – Restrict results to orders with a specific outreach_id value.
• customer_id: &str – Restrict results to orders made by a specific customer.
• has_outreach: bool – Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad.

pub async fn get_store(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64
) -> Result<ECommerceStores>

List stores.

This function performs a GET to the /ecommerce/stores endpoint.

Get information about all stores in the account.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.

pub async fn post_store(&self, body: &ECommerceStore) -> Result<Stores>

Add store.

This function performs a POST to the /ecommerce/stores endpoint.

Add a new store to your Mailchimp account.

pub async fn get_store_ecommerce(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    store_id: &str
) -> Result<Stores>

Get store info.

This function performs a GET to the /ecommerce/stores/{store_id} endpoint.

Get information about a specific store.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• store_id: &str – The name of the folder.

pub async fn delete_stores(&self, store_id: &str) -> Result<()>

Delete store.

This function performs a DELETE to the /ecommerce/stores/{store_id} endpoint.

Delete a store. Deleting a store will also delete any associated subresources, including Customers, Orders, Products, and Carts.

Parameters:

• store_id: &str – The name of the folder.

pub async fn patch_stores(
    &self,
    store_id: &str,
    body: &ECommerceStoreData
) -> Result<Stores>

Update store.

This function performs a PATCH to the /ecommerce/stores/{store_id} endpoint.

Update a store.

Parameters:

• store_id: &str – The name of the folder.

pub async fn get_stores_cart(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    store_id: &str
) -> Result<CartsData>

List carts.

This function performs a GET to the /ecommerce/stores/{store_id}/carts endpoint.

Get information about a store’s carts.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• store_id: &str – The name of the folder.

pub async fn post_stores_cart(
    &self,
    store_id: &str,
    body: &ECommerceCart
) -> Result<Carts>

Add cart.

This function performs a POST to the /ecommerce/stores/{store_id}/carts endpoint.

Add a new cart to a store.

Parameters:

• store_id: &str – The name of the folder.

pub async fn get_stores_cart_ecommerce(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    store_id: &str,
    cart_id: &str
) -> Result<Carts>

Get cart info.

This function performs a GET to the /ecommerce/stores/{store_id}/carts/{cart_id} endpoint.

Get information about a specific cart.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• store_id: &str – The name of the folder.
• cart_id: &str – The name of the folder.

pub async fn delete_stores_carts(
    &self,
    store_id: &str,
    cart_id: &str
) -> Result<()>

Delete cart.

This function performs a DELETE to the /ecommerce/stores/{store_id}/carts/{cart_id} endpoint.

Delete a cart.

Parameters:

• store_id: &str – The name of the folder.
• cart_id: &str – The name of the folder.

pub async fn patch_stores_carts(
    &self,
    store_id: &str,
    cart_id: &str,
    body: &ECommerceCartData
) -> Result<Carts>

Update cart.

This function performs a PATCH to the /ecommerce/stores/{store_id}/carts/{cart_id} endpoint.

Update a specific cart.

Parameters:

• store_id: &str – The name of the folder.
• cart_id: &str – The name of the folder.

pub async fn get_stores_carts_line(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    store_id: &str,
    cart_id: &str
) -> Result<CartLines>

List cart line items.

This function performs a GET to the /ecommerce/stores/{store_id}/carts/{cart_id}/lines endpoint.

Get information about a cart’s line items.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• store_id: &str – The name of the folder.
• cart_id: &str – The name of the folder.

pub async fn post_stores_carts_line(
    &self,
    store_id: &str,
    cart_id: &str,
    body: &ECommerceCartLineItemData
) -> Result<ECommerceCartLineItem>

Add cart line item.

This function performs a POST to the /ecommerce/stores/{store_id}/carts/{cart_id}/lines endpoint.

Add a new line item to an existing cart.

Parameters:

• store_id: &str – The name of the folder.
• cart_id: &str – The name of the folder.

pub async fn get_stores_carts_line_ecommerce(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    store_id: &str,
    cart_id: &str,
    line_id: &str
) -> Result<ECommerceCartLineItem>

Get cart line item.

This function performs a GET to the /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} endpoint.

Get information about a specific cart line item.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• store_id: &str – The name of the folder.
• cart_id: &str – The name of the folder.
• line_id: &str – The id for the line item of a cart.

pub async fn delete_stores_carts_lines(
    &self,
    store_id: &str,
    cart_id: &str,
    line_id: &str
) -> Result<()>

Delete cart line item.

This function performs a DELETE to the /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} endpoint.

Delete a specific cart line item.

Parameters:

• store_id: &str – The name of the folder.
• cart_id: &str – The name of the folder.
• line_id: &str – The id for the line item of a cart.

pub async fn patch_stores_carts_lines(
    &self,
    store_id: &str,
    cart_id: &str,
    line_id: &str,
    body: &ECommerceCartLineItemDataType
) -> Result<ECommerceCartLineItem>

Update cart line item.

This function performs a PATCH to the /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} endpoint.

Update a specific cart line item.

Parameters:

• store_id: &str – The name of the folder.
• cart_id: &str – The name of the folder.
• line_id: &str – The id for the line item of a cart.

pub async fn get_stores_customer(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    store_id: &str,
    email_address: &str
) -> Result<Customers>

List customers.

This function performs a GET to the /ecommerce/stores/{store_id}/customers endpoint.

Get information about a store’s customers.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• store_id: &str – The name of the folder.
• email_address: &str – Restrict the response to customers with the email address.

pub async fn post_stores_customer(
    &self,
    store_id: &str,
    body: &ECommerceCustomerData
) -> Result<Customer>

Add customer.

This function performs a POST to the /ecommerce/stores/{store_id}/customers endpoint.

Add a new customer to a store.

Parameters:

• store_id: &str – The name of the folder.

pub async fn get_stores_customer_ecommerce(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    store_id: &str,
    customer_id: &str
) -> Result<Customer>

Get customer info.

This function performs a GET to the /ecommerce/stores/{store_id}/customers/{customer_id} endpoint.

Get information about a specific customer.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• store_id: &str – The name of the folder.
• customer_id: &str – The id for the customer of a store.

pub async fn put_stores_customers(
    &self,
    store_id: &str,
    customer_id: &str,
    body: &ECommerceCustomerDataType
) -> Result<Customer>

Add or update customer.

This function performs a PUT to the /ecommerce/stores/{store_id}/customers/{customer_id} endpoint.

Add or update a customer.

Parameters:

• store_id: &str – The name of the folder.
• customer_id: &str – The id for the customer of a store.

pub async fn delete_stores_customers(
    &self,
    store_id: &str,
    customer_id: &str
) -> Result<()>

Delete customer.

This function performs a DELETE to the /ecommerce/stores/{store_id}/customers/{customer_id} endpoint.

Delete a customer from a store.

Parameters:

• store_id: &str – The name of the folder.
• customer_id: &str – The id for the customer of a store.

pub async fn patch_stores_customers(
    &self,
    store_id: &str,
    customer_id: &str,
    body: &ECommerceCartCustomer
) -> Result<Customer>

Update customer.

This function performs a PATCH to the /ecommerce/stores/{store_id}/customers/{customer_id} endpoint.

Update a customer.

Parameters:

• store_id: &str – The name of the folder.
• customer_id: &str – The id for the customer of a store.

pub async fn get_stores_promorule(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    store_id: &str
) -> Result<PromoRulesData>

List promo rules.

This function performs a GET to the /ecommerce/stores/{store_id}/promo-rules endpoint.

Get information about a store’s promo rules.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• store_id: &str – The name of the folder.

pub async fn post_stores_promorule(
    &self,
    store_id: &str,
    body: &ECommercePromoRule
) -> Result<PromoRules>

Add promo rule.

This function performs a POST to the /ecommerce/stores/{store_id}/promo-rules endpoint.

Add a new promo rule to a store.

Parameters:

• store_id: &str – The name of the folder.

pub async fn get_stores_promorule_ecommerce(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    store_id: &str,
    promo_rule_id: &str
) -> Result<PromoRules>

Get promo rule.

This function performs a GET to the /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} endpoint.

Get information about a specific promo rule.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• store_id: &str – The name of the folder.
• promo_rule_id: &str – The id for the promo rule of a store.

pub async fn delete_stores_promorules(
    &self,
    store_id: &str,
    promo_rule_id: &str
) -> Result<()>

Delete promo rule.

This function performs a DELETE to the /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} endpoint.

Delete a promo rule from a store.

Parameters:

• store_id: &str – The name of the folder.
• promo_rule_id: &str – The id for the promo rule of a store.

pub async fn patch_stores_promorules(
    &self,
    store_id: &str,
    promo_rule_id: &str,
    body: &ECommercePromoRuleData
) -> Result<PromoRules>

Update promo rule.

This function performs a PATCH to the /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} endpoint.

Update a promo rule.

Parameters:

• store_id: &str – The name of the folder.
• promo_rule_id: &str – The id for the promo rule of a store.

pub async fn get_stores_promocode(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    promo_rule_id: &str,
    store_id: &str
) -> Result<PromoCodesData>

List promo codes.

This function performs a GET to the /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes endpoint.

Get information about a store’s promo codes.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• promo_rule_id: &str – The id for the promo rule of a store.
• store_id: &str – The name of the folder.

pub async fn post_stores_promocode(
    &self,
    store_id: &str,
    promo_rule_id: &str,
    body: &ECommercePromoCode
) -> Result<PromoCodes>

Add promo code.

This function performs a POST to the /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes endpoint.

Add a new promo code to a store.

Parameters:

• store_id: &str – The name of the folder.
• promo_rule_id: &str – The id for the promo rule of a store.

pub async fn get_stores_promocode_ecommerce(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    store_id: &str,
    promo_rule_id: &str,
    promo_code_id: &str
) -> Result<PromoCodes>

Get promo code.

This function performs a GET to the /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} endpoint.

Get information about a specific promo code.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• store_id: &str – The name of the folder.
• promo_rule_id: &str – The id for the promo rule of a store.
• promo_code_id: &str – The id for the promo code of a store.

pub async fn delete_stores_promocodes(
    &self,
    store_id: &str,
    promo_rule_id: &str,
    promo_code_id: &str
) -> Result<()>

Delete promo code.

This function performs a DELETE to the /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} endpoint.

Delete a promo code from a store.

Parameters:

• store_id: &str – The name of the folder.
• promo_rule_id: &str – The id for the promo rule of a store.
• promo_code_id: &str – The id for the promo code of a store.

pub async fn patch_stores_promocodes(
    &self,
    store_id: &str,
    promo_rule_id: &str,
    promo_code_id: &str,
    body: &ECommercePromoCodeData
) -> Result<PromoCodes>

Update promo code.

This function performs a PATCH to the /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} endpoint.

Update a promo code.

Parameters:

• store_id: &str – The name of the folder.
• promo_rule_id: &str – The id for the promo rule of a store.
• promo_code_id: &str – The id for the promo code of a store.

pub async fn get_stores_order(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    store_id: &str,
    customer_id: &str,
    has_outreach: bool,
    campaign_id: &str,
    outreach_id: &str
) -> Result<OrdersDataType>

List orders.

This function performs a GET to the /ecommerce/stores/{store_id}/orders endpoint.

Get information about a store’s orders.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• store_id: &str – The name of the folder.
• customer_id: &str – Restrict results to orders made by a specific customer.
• has_outreach: bool – Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad.
• campaign_id: &str – Restrict results to orders with a specific campaign_id value.
• outreach_id: &str – Restrict results to orders with a specific outreach_id value.

pub async fn post_stores_order(
    &self,
    store_id: &str,
    body: &ECommerceOrder
) -> Result<Orders>

Add order.

This function performs a POST to the /ecommerce/stores/{store_id}/orders endpoint.

Add a new order to a store.

Parameters:

• store_id: &str – The name of the folder.

pub async fn get_stores_order_ecommerce(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    store_id: &str,
    order_id: &str
) -> Result<Orders>

Get order info.

This function performs a GET to the /ecommerce/stores/{store_id}/orders/{order_id} endpoint.

Get information about a specific order.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• store_id: &str – The name of the folder.
• order_id: &str – The id for the order in a store.

pub async fn delete_stores_orders(
    &self,
    store_id: &str,
    order_id: &str
) -> Result<()>

Delete order.

This function performs a DELETE to the /ecommerce/stores/{store_id}/orders/{order_id} endpoint.

Delete an order.

Parameters:

• store_id: &str – The name of the folder.
• order_id: &str – The id for the order in a store.

pub async fn patch_stores_orders(
    &self,
    store_id: &str,
    order_id: &str,
    body: &ECommerceOrderData
) -> Result<Orders>

Update order.

This function performs a PATCH to the /ecommerce/stores/{store_id}/orders/{order_id} endpoint.

Update a specific order.

Parameters:

• store_id: &str – The name of the folder.
• order_id: &str – The id for the order in a store.

pub async fn get_stores_orders_line(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    store_id: &str,
    order_id: &str
) -> Result<OrderLines>

List order line items.

This function performs a GET to the /ecommerce/stores/{store_id}/orders/{order_id}/lines endpoint.

Get information about an order’s line items.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• store_id: &str – The name of the folder.
• order_id: &str – The id for the order in a store.

pub async fn post_stores_orders_line(
    &self,
    store_id: &str,
    order_id: &str,
    body: &ECommerceOrderLineItem
) -> Result<Lines>

Add order line item.

This function performs a POST to the /ecommerce/stores/{store_id}/orders/{order_id}/lines endpoint.

Add a new line item to an existing order.

Parameters:

• store_id: &str – The name of the folder.
• order_id: &str – The id for the order in a store.

pub async fn get_stores_orders_line_ecommerce(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    store_id: &str,
    order_id: &str,
    line_id: &str
) -> Result<Lines>

Get order line item.

This function performs a GET to the /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} endpoint.

Get information about a specific order line item.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• store_id: &str – The name of the folder.
• order_id: &str – The id for the order in a store.
• line_id: &str – The id for the line item of an order.

pub async fn delete_stores_orders_lines(
    &self,
    store_id: &str,
    order_id: &str,
    line_id: &str
) -> Result<()>

Delete order line item.

This function performs a DELETE to the /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} endpoint.

Delete a specific order line item.

Parameters:

• store_id: &str – The name of the folder.
• order_id: &str – The id for the order in a store.
• line_id: &str – The id for the line item of an order.

pub async fn patch_stores_orders_lines(
    &self,
    store_id: &str,
    order_id: &str,
    line_id: &str,
    body: &ECommerceOrderLineItemData
) -> Result<Lines>

Update order line item.

This function performs a PATCH to the /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} endpoint.

Update a specific order line item.

Parameters:

• store_id: &str – The name of the folder.
• order_id: &str – The id for the order in a store.
• line_id: &str – The id for the line item of an order.

pub async fn get_stores_product(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    store_id: &str
) -> Result<ProductsData>

List product.

This function performs a GET to the /ecommerce/stores/{store_id}/products endpoint.

Get information about a store’s products.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• store_id: &str – The name of the folder.

pub async fn post_stores_product(
    &self,
    store_id: &str,
    body: &ECommerceProductData
) -> Result<ECommerceProduct>

Add product.

This function performs a POST to the /ecommerce/stores/{store_id}/products endpoint.

Add a new product to a store.

Parameters:

• store_id: &str – The name of the folder.

pub async fn get_stores_product_ecommerce(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    store_id: &str,
    product_id: &str
) -> Result<ECommerceProduct>

Get product info.

This function performs a GET to the /ecommerce/stores/{store_id}/products/{product_id} endpoint.

Get information about a specific product.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• store_id: &str – The name of the folder.
• product_id: &str – The id for the product of a store.

pub async fn delete_stores_products(
    &self,
    store_id: &str,
    product_id: &str
) -> Result<()>

Delete product.

This function performs a DELETE to the /ecommerce/stores/{store_id}/products/{product_id} endpoint.

Delete a product.

Parameters:

• store_id: &str – The name of the folder.
• product_id: &str – The id for the product of a store.

pub async fn patch_stores_products(
    &self,
    store_id: &str,
    product_id: &str,
    body: &ECommerceProductDataType
) -> Result<ECommerceProduct>

Update product.

This function performs a PATCH to the /ecommerce/stores/{store_id}/products/{product_id} endpoint.

Update a specific product.

Parameters:

• store_id: &str – The name of the folder.
• product_id: &str – The id for the product of a store.

pub async fn get_stores_products_variant(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    store_id: &str,
    product_id: &str
) -> Result<EcommerceProductVariants>

List product variants.

This function performs a GET to the /ecommerce/stores/{store_id}/products/{product_id}/variants endpoint.

Get information about a product’s variants.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• store_id: &str – The name of the folder.
• product_id: &str – The id for the product of a store.

pub async fn post_stores_products_variant(
    &self,
    store_id: &str,
    product_id: &str,
    body: &ECommerceProductVariant
) -> Result<Variants>

Add product variant.

This function performs a POST to the /ecommerce/stores/{store_id}/products/{product_id}/variants endpoint.

Add a new variant to the product.

Parameters:

• store_id: &str – The name of the folder.
• product_id: &str – The id for the product of a store.

pub async fn get_stores_products_variant_ecommerce(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    store_id: &str,
    product_id: &str,
    variant_id: &str
) -> Result<Variants>

Get product variant info.

This function performs a GET to the /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} endpoint.

Get information about a specific product variant.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• store_id: &str – The name of the folder.
• product_id: &str – The id for the product of a store.
• variant_id: &str – The id for the product variant.

pub async fn put_stores_products_variants(
    &self,
    store_id: &str,
    product_id: &str,
    variant_id: &str,
    body: &ECommerceProductVariant
) -> Result<Variants>

Add or update product variant.

This function performs a PUT to the /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} endpoint.

Add or update a product variant.

Parameters:

• store_id: &str – The name of the folder.
• product_id: &str – The id for the product of a store.
• variant_id: &str – The id for the product variant.

pub async fn delete_stores_products_variants(
    &self,
    store_id: &str,
    product_id: &str,
    variant_id: &str
) -> Result<()>

Delete product variant.

This function performs a DELETE to the /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} endpoint.

Delete a product variant.

Parameters:

• store_id: &str – The name of the folder.
• product_id: &str – The id for the product of a store.
• variant_id: &str – The id for the product variant.

pub async fn patch_stores_products_variants(
    &self,
    store_id: &str,
    product_id: &str,
    variant_id: &str,
    body: &ECommerceProductVariantData
) -> Result<Variants>

Update product variant.

This function performs a PATCH to the /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} endpoint.

Update a product variant.

Parameters:

• store_id: &str – The name of the folder.
• product_id: &str – The id for the product of a store.
• variant_id: &str – The id for the product variant.

pub async fn get_stores_products_image(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    store_id: &str,
    product_id: &str
) -> Result<EcommerceProductImages>

List product images.

This function performs a GET to the /ecommerce/stores/{store_id}/products/{product_id}/images endpoint.

Get information about a product’s images.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• store_id: &str – The name of the folder.
• product_id: &str – The id for the product of a store.

pub async fn post_stores_products_image(
    &self,
    store_id: &str,
    product_id: &str,
    body: &ECommerceProductImage
) -> Result<Images>

Add product image.

This function performs a POST to the /ecommerce/stores/{store_id}/products/{product_id}/images endpoint.

Add a new image to the product.

Parameters:

• store_id: &str – The name of the folder.
• product_id: &str – The id for the product of a store.

pub async fn get_stores_products_image_ecommerce(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    store_id: &str,
    product_id: &str,
    image_id: &str
) -> Result<Images>

Get product image info.

This function performs a GET to the /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} endpoint.

Get information about a specific product image.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• store_id: &str – The name of the folder.
• product_id: &str – The id for the product of a store.
• image_id: &str – The id for the product image.

pub async fn delete_stores_products_images(
    &self,
    store_id: &str,
    product_id: &str,
    image_id: &str
) -> Result<()>

Delete product image.

This function performs a DELETE to the /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} endpoint.

Delete a product image.

Parameters:

• store_id: &str – The name of the folder.
• product_id: &str – The id for the product of a store.
• image_id: &str – The id for the product image.

pub async fn patch_stores_products_images(
    &self,
    store_id: &str,
    product_id: &str,
    image_id: &str,
    body: &ECommerceProductImageData
) -> Result<Images>

Update product image.

This function performs a PATCH to the /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} endpoint.

Update a product image.

Parameters:

• store_id: &str – The name of the folder.
• product_id: &str – The id for the product of a store.
• image_id: &str – The id for the product image.