Create a Wholesale Variation

This API handles creating wholesale and non-wholesale variation.

Method

Endpoint

POST

/wp-json/wholesale/v1/products/{variable_id}/variations

Path parameters

Required

Type

Description

variable_id

yes

int

The variable ID.

Body Parameters

Required

Type

Description

wholesale_price

array

Wholesale prices for each wholesale role.

wholesale_sale_price

array

Wholesale sale prices for each wholesale role.

Postman

Creating wholesale variation

POST: /wp-json/wholesale/v1/products/{variable_id}/variations

JSON Body:
{
    "regular_price": "19.00",
    "attributes": [
        {
            "id": 1,
            "name": "Color",
            "option": "Black"
        }
    ],
    "wholesale_price": {
        "wholesale_customer": "12"
    },
    // With sale price.
    "wholesale_sale_price": {
        "wholesale_customer": "10"
    }
}

Status: 200 OK

POST: /wp-json/wholesale/v1/products/{variable_id}/variations

JSON Body:
{
    "regular_price": "19.00",
    "attributes": [
        {
            "id": 1,
            "name": "Color",
            "option": "Black"
        }
    ],
    "wholesale_price": {
        "wholesale_customer": "12"
    },
    // With sale price.
    "wholesale_sale_price": {
        "wholesale_customer": "10"
    }
}

Response:
{
    "id": 7075,
    "date_created": "2021-10-20T13:23:09",
    "date_created_gmt": "2021-10-20T13:23:09",
    "date_modified": "2021-10-20T13:23:09",
    "date_modified_gmt": "2021-10-20T13:23:09",
    "description": "",
    "permalink": "https://example.com/product/variable-test/?attribute_pa_color=black",
    "sku": "",
    "price": "19.00",
    "regular_price": "19.00",
    "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,
    "status": "publish",
    "purchasable": true,
    "virtual": false,
    "downloadable": false,
    "downloads": [],
    "download_limit": -1,
    "download_expiry": -1,
    "tax_status": "taxable",
    "tax_class": "",
    "manage_stock": false,
    "stock_quantity": null,
    "stock_status": "instock",
    "backorders": "no",
    "backorders_allowed": false,
    "backordered": false,
    "low_stock_amount": null,
    "weight": "",
    "dimensions": {
        "length": "",
        "width": "",
        "height": ""
    },
    "shipping_class": "",
    "shipping_class_id": 0,
    "image": null,
    "attributes": [
        {
            "id": 1,
            "name": "Color",
            "option": "Black"
        }
    ],
    "menu_order": 0,
    "wholesale_data": {
        "wholesale_price": {
            "wholesale_customer": "12"
        },
        // With sale price.
        "wholesale_sale_price": {
            "wholesale_customer": "10"
        }
    }
}

Status: 400 Bad Request

The wholesale role key and wholesale price are invalid

GET: /wp-json/wholesale/v1/products/{variation_id}/variations/{variation_id}?wholesale_role=invalid_role

JSON Body:
{
    "regular_price": "19.00",
    "attributes": [
        {
            "id": 1,
            "name": "Color",
            "option": "Black"
        }
    ],
    "wholesale_price": {
        "wholesale_role_key_invalid": "wholesale_price_invalid"
    }
}

Response:
{
    "code": "wholesale_rest_variation_cannot_create",
    "message": "Unable to create. Invalid wholesale price.",
    "data": {
        "status": 400,
        "invalid_roles": [
            "wholesale_role_key_invalid"
        ],
        "invalid_wholesale_price": {
            "wholesale_role_key_invalid": "wholesale_price_invalid"
        }
    }
}

PreviousRetrieve a Wholesale Variation NextUpdate a Wholesale Variation

Last updated 1 year ago

Was this helpful?