Struct Product

Source

pub struct Product {Show 65 fields
    pub id: i32,
    pub name: String,
    pub slug: String,
    pub permalink: String,
    pub date_created: NaiveDateTime,
    pub date_created_gmt: NaiveDateTime,
    pub date_modified: NaiveDateTime,
    pub date_modified_gmt: NaiveDateTime,
    pub product_type: ProductType,
    pub status: ProductStatus,
    pub featured: bool,
    pub catalog_visibility: CatalogVisibility,
    pub description: String,
    pub short_description: String,
    pub sku: String,
    pub price: String,
    pub regular_price: String,
    pub sale_price: String,
    pub date_on_sale_from: Option<NaiveDateTime>,
    pub date_on_sale_from_gmt: Option<NaiveDateTime>,
    pub date_on_sale_to: Option<NaiveDateTime>,
    pub date_on_sale_to_gmt: Option<NaiveDateTime>,
    pub price_html: String,
    pub on_sale: bool,
    pub purchasable: bool,
    pub total_sales: i32,
    pub is_virtual: bool,
    pub downloadable: bool,
    pub downloads: Vec<Download>,
    pub download_limit: i32,
    pub download_expiry: i32,
    pub external_url: String,
    pub button_text: String,
    pub tax_status: TaxStatus,
    pub tax_class: String,
    pub manage_stock: bool,
    pub stock_quantity: Option<i32>,
    pub stock_status: StockStatus,
    pub backorders: BackordersStatus,
    pub backorders_allowed: bool,
    pub backordered: bool,
    pub sold_individually: bool,
    pub weight: String,
    pub dimensions: Dimensions,
    pub shipping_required: bool,
    pub shipping_taxable: bool,
    pub shipping_class: String,
    pub shipping_class_id: i32,
    pub reviews_allowed: bool,
    pub average_rating: String,
    pub rating_count: i32,
    pub related_ids: Vec<i32>,
    pub upsell_ids: Vec<i32>,
    pub cross_sell_ids: Vec<i32>,
    pub parent_id: i32,
    pub purchase_note: String,
    pub categories: Vec<ProductCategory>,
    pub tags: Vec<ProductTag>,
    pub images: Vec<ProductImage>,
    pub attributes: Vec<ProductAttribute>,
    pub default_attributes: Vec<ProductDefaultAttribute>,
    pub variations: Vec<i32>,
    pub grouped_products: Vec<i32>,
    pub menu_order: i32,
    pub meta_data: Vec<MetaData>,
}

Fields§

§id: i32

Unique identifier for the resource.

§name: String

Product name.

§slug: String

Product slug.

§permalink: String

Product URL.

§date_created: NaiveDateTime

The date the product was created, in the site’s timezone.

§date_created_gmt: NaiveDateTime

The date the product was created, as GMT.

§date_modified: NaiveDateTime

The date the product was last modified, in the site’s timezone.

§date_modified_gmt: NaiveDateTime

The date the product was last modified, as GMT.

§product_type: ProductType

Product type, Options: simple, grouped, external and variable. Default is simple.

§status: ProductStatus

Product status (post status). Options: draft, pending, private and publish. Default is publish.

§featured: bool

Implementations§

Source §

impl Product

Source

pub fn builder() -> ProductModifyBuilder

Examples found in repository ?

examples/product.rs (line 25)

async fn main() -> Result<()> {
    tracing_subscriber::fmt::init();
    let config = Config::new("woo.toml")?;
    let client = ApiClient::new(&config)?;
    let start = std::time::Instant::now();
    let products = client.list_all::<Product>().await?;
    info!(
        "Got {} products in {} seconds",
        products.len(),
        start.elapsed().as_secs()
    );
    let random_id = products.first().map(|p| p.id).unwrap_or_default();
    let retrieved = client.retrieve::<Product>(random_id).await?;
    info!("Retrieved product has sku: {}", retrieved.sku);
    let attribute = Attribute::builder()
        .name("Test Attribute")
        .option("Best")
        .visible()
        .build();
    let new_product = Product::builder()
        .name("Test Product For Example")
        .featured()
        .short_description("The most professional description")
        .sku("product for test 42")
        .regular_price("6969")
        .manage_stock()
        .stock_quantity(42)
        .weight("50")
        .dimensions("4", "3", "2")
        .shipping_class("large")
        .images("https://cs14.pikabu.ru/post_img/2021/06/27/7/1624794514137159585.jpg")
        .attribute(attribute)
        .build();
    let batch_create = vec![new_product.clone()];
    let created: Product = client.create(new_product).await?;
    info!("Create product {} with id: {}", created.name, created.id);
    let update = Product::builder().unfeatured().build();
    let updated: Product = client.update(created.id, update).await?;
    info!(
        "Update product {}, new feature is {}",
        updated.name, updated.featured
    );
    let deleted: Product = client.delete(updated.id).await?;
    info!("Product {} deleted", deleted.name);
    let batch_created: Vec<Product> = client.batch_create(batch_create).await?;
    let id = batch_created.first().ok_or(anyhow!("Error"))?.id;
    let batch_update = Product::builder().id(id).unfeatured().build();
    let _batch_updated: Vec<Product> = client.batch_update(vec![batch_update]).await?;
    let _deleted: Product = client.delete(id).await?;
    Ok(())
}

More examples

Hide additional examples

examples/variation.rs (line 41)

async fn main() -> Result<()> {
    tracing_subscriber::fmt::init();
    let config = Config::new("woo.toml")?;
    let client = ApiClient::new(&config)?;
    let products = client.list_all::<Product>().await?;
    let random_variable_id = products
        .iter()
        .find(|p| !p.variations.is_empty())
        .map(|p| p.id)
        .unwrap_or_default();
    let variations = client
        .list_all_subentities::<ProductVariation>(random_variable_id)
        .await?;
    info!(
        "Got {} variations for product with id: {random_variable_id}",
        variations.len()
    );
    let retrieved_variation: ProductVariation = client
        .retrieve_subentity(
            random_variable_id,
            variations.first().map(|v| v.id).unwrap_or_default(),
        )
        .await?;
    info!("Retrieved variation has sku: {}", retrieved_variation.sku);
    let attribute = Attribute::builder()
        .name("Test Attribute")
        .option("Best")
        .option("Test")
        .variation()
        .visible()
        .build();
    let new_variable_product = Product::builder()
        .name("Test Product For Example")
        .product_type(ProductType::Variable)
        .featured()
        .short_description("The most professional description")
        .sku("product for test 42")
        .regular_price("6969")
        .manage_stock()
        .stock_quantity(42)
        .weight("50")
        .dimensions("4", "3", "2")
        .shipping_class("large")
        .images("https://cs14.pikabu.ru/post_img/2021/06/27/7/1624794514137159585.jpg")
        .attribute(attribute)
        .build();
    let created: Product = client.create(new_variable_product).await?;
    info!("Create product {} with id: {}", created.name, created.id);

    let variation = ProductVariation::builder()
        .sku(format!("{} Best", created.sku))
        .regular_price("6969")
        .manage_stock()
        .stock_quantity(96)
        .weight("52")
        .dimensions("5", "4", "3")
        .attribute(None, "Test Attribute", "Best")
        .build();
    let batch_create_variation = vec![variation.clone()];
    let created_variation: ProductVariation =
        client.create_subentity(created.id, variation).await?;
    info!(
        "Variation {} created with price: {}",
        created_variation.sku, created_variation.price
    );
    let update = ProductVariation::builder().regular_price("7000").build();
    let updated_variation: ProductVariation = client
        .update_subentity(created.id, created_variation.id, update)
        .await?;
    info!(
        "Variation {} updated with price: {}",
        updated_variation.sku, updated_variation.price
    );
    let deleted_variation: ProductVariation = client
        .delete_subentity(created.id, updated_variation.id)
        .await?;
    info!("Variation {} deleted", deleted_variation.sku);
    let batch_created_variation: Vec<ProductVariation> = client
        .batch_create_subentity(created.id, batch_create_variation)
        .await?;
    let bcv_id = batch_created_variation
        .first()
        .map(|v| v.id)
        .unwrap_or_default();
    let batch_update_variation = vec![ProductVariation::builder()
        .id(bcv_id)
        .regular_price("777")
        .build()];
    let _batch_updated_variation: Vec<ProductVariation> = client
        .batch_update_subentity(created.id, batch_update_variation)
        .await?;
    let _batch_deleted_variation: Vec<ProductVariation> = client
        .batch_delete_subentity(created.id, vec![bcv_id])
        .await?;
    let deleted: Product = client.delete(created.id).await?;
    info!("Product {} deleted", deleted.name);
    Ok(())
}