Wholesale Suite API
  • REST API
  • wholesale/v1 (Free)
    • Products
      • List All Wholesale Products
      • Retrieve a Wholesale Product
      • Create a Wholesale Product
      • Update a Wholesale Product
      • Delete a Wholesale Product
      • Batch Update Products
    • Variations
      • List All Wholesale Variations
      • Retrieve a Wholesale Variation
      • Create a Wholesale Variation
      • Update a Wholesale Variation
      • Delete a Wholesale Variation
      • Batch Update Variations
    • Wholesale Role
      • List Wholesale Roles
      • Retrieve a Wholesale Role
      • Update a Wholesale Role
  • wholesale/v1 (Premium)
    • Products
      • List All Wholesale Products
      • Retrieve a Wholesale Product
      • Create a Wholesale Product
      • Update a Wholesale Product
      • Delete a Wholesale Product
      • Batch Update Products
    • Variations
      • List All Wholesale Variations
      • Retrieve a Wholesale Variation
      • Create a Wholesale Variation
      • Update a Wholesale Variation
      • Delete a Wholesale Variation
      • Batch Update Variations
    • Wholesale Role
      • List Wholesale Roles
      • Retrieve a Wholesale Role
      • Create a Wholesale Role
      • Update a Wholesale Role
      • Delete a Wholesale Role
    • Category Discounts
      • List Category Discounts
      • Retrieve Category Discount
      • Create Category Discount
      • Update Category Discount
      • Delete Category Discount
    • General Discounts
      • List General Discounts
      • Retrieve Specific Role Discount
      • Create a General Discount
      • Update a general Discount
      • Delete a General Discount
    • Bundle
      • Create Bundle Product
      • Batch Update
    • Composite
      • Create Composite Product
      • Batch Update
Powered by GitBook
On this page

Was this helpful?

  1. wholesale/v1 (Free)
  2. Products

Update a Wholesale Product

This API handles updating a wholesale or non-wholesale product.

Method

Endpoint

PUT

/wp-json/wholesale/v1/products/{product_id}

Body Parameters

Required

Type

Description

wholesale_price

yes

array

The wholesale price.

wholesale_sale_price

no

array

The wholesale sale price.

Postman

Update a simple product

PUT: /wp-json/wholesale/v1/products/{product_id}

JSON Body:
{
  "name" : "Premium Quality",
  "type" : "simple",
  "regular_price" : "21.99",
  "wholesale_price" : { 
    "wholesale_customer" : "15"
  },
  // With sale price.
  "wholesale_sale_price" : { 
    "wholesale_customer" : "12"
  }
}

Status: 200 OK

Wholesale product updated

PUT: /wp-json/wholesale/v1/products/{product_id}

JSON Body:
{
  "name" : "Premium Quality",
  "type" : "simple",
  "regular_price" : "21.99",
  "wholesale_price" : { 
    "wholesale_customer" : "15"
  },
  // With sale price.
  "wholesale_sale_price" : { 
    "wholesale_customer" : "12"
  }
}

Response:
{
    "id": 4297,
    "name": "Premium Quality",
    "slug": "premium-quality",
    "permalink": "https://example.com/product/premium-quality/",
    "date_created": "2021-03-15T03:59:31",
    "date_created_gmt": "2021-03-15T03:59:31",
    "date_modified": "2021-03-15T04:17:36",
    "date_modified_gmt": "2021-03-15T04:17:36",
    "type": "simple",
    "status": "publish",
    "featured": false,
    "catalog_visibility": "visible",
    "description": "",
    "short_description": "",
    "sku": "",
    "price": "21.99",
    "regular_price": "21.99",
    "sale_price": "",
    "date_on_sale_from": null,
    "date_on_sale_from_gmt": null,
    "date_on_sale_to": null,
    "date_on_sale_to_gmt": null,
    "on_sale": false,
    "purchasable": true,
    "total_sales": 0,
    "virtual": false,
    "downloadable": false,
    "downloads": [],
    "download_limit": -1,
    "download_expiry": -1,
    "external_url": "",
    "button_text": "",
    "tax_status": "taxable",
    "tax_class": "",
    "manage_stock": false,
    "stock_quantity": null,
    "backorders": "no",
    "backorders_allowed": false,
    "backordered": false,
    "sold_individually": false,
    "weight": "",
    "dimensions": {
        "length": "",
        "width": "",
        "height": ""
    },
    "shipping_required": true,
    "shipping_taxable": true,
    "shipping_class": "",
    "shipping_class_id": 0,
    "reviews_allowed": true,
    "average_rating": "0",
    "rating_count": 0,
    "upsell_ids": [],
    "cross_sell_ids": [],
    "parent_id": 0,
    "purchase_note": "",
    "tags": [],
    "images": [],
    "attributes": [],
    "default_attributes": [],
    "variations": [],
    "grouped_products": [],
    "menu_order": 0,
    "price_html": "<span class=\"woocommerce-Price-amount amount\"><bdi><span class=\"woocommerce-Price-currencySymbol\">&#36;</span>21.99</bdi></span>",
    "related_ids": [
        4296,
        4292,
        4295,
        4291,
        4294
    ],
    "stock_status": "instock",
    "wholesale_data": {
        "wholesale_price": {
            "wholesale_customer": "15"
        },
        // With sale price.
        "wholesale_sale_price": {
            "wholesale_customer": "12"
        },
    }
}

Status: 400 Bad Request

Invalid Wholesale Role key and Wholesale Price.

POST: /wp-json/wholesale/v1/products/

JSON Body:
{
  "name" : "Premium Quality",
  "type" : "simple",
  "regular_price" : "21.99",
  "wholesale_price" : { 
    "invalid_role_key" : "invalid_wholesale_price"
  }
}

Response:
{
    "code": "wholesale_rest_product_cannot_update",
    "message": "Unable to update. Invalid wholesale price.",
    "data": {
        "status": 400,
        "invalid_roles": [
            "invalid_role_key"
        ],
        "invalid_wholesale_price": {
            "invalid_role_key": "invalid_wholesale_price"
        }
    }
}
PreviousCreate a Wholesale ProductNextDelete a Wholesale Product

Last updated 11 months ago

Was this helpful?