Create a Wholesale Role
This API allows you to create custom wholesale role.
Method
Endpoint
POST
/wp-json/wholesale/v1/roles/
Body Parameters
Type
Required
Description
role_key
string
yes
Wholesale Role key to be created.
role_name
string
yes
Wholesale Role name.
description
string
no
Wholesale Role description.
shipping_class_name
string
no
Shipping class name.
shipping_class_term_id
int
no
Shipping term ID.
only_allow_wholesale_purchases
string
no
Only allow wholesale purchases for this specific role. Value should be "yes" or "no".
Status: 200 OK
Successfully created
{
"message": "Successfully created role \"sample_role\"",
"data": {
"sample_role": {
"roleName": "Sample Role",
"desc": "The sample wholesale role",
"onlyAllowWholesalePurchases": "no"
}
}
}Status: 403 Forbidden
Duplicate or missing required fields
{
"code": "wholesale_rest_cannot_create",
"message": "Can't create item. Please make sure \"role_key\" is unique. Both \"role_key\" and \"role_name\" property are required.",
"data": {
"status": 403
}
}Last updated
Was this helpful?