Create Usergroup Pricing
POST/usergroups/:lookupKey/:lookupValue/pricing
Use this endpoint to define pricing for an existing usergroup. The usergroup can be identified by it's lookup key. It is required to provide either categories
or products
or both in the payload.
Use cases
A common use case for this endpoint is when you want to give discounts only for a specific usergroup and all users in that usergroup. If a user in that usergroup already has pricing defined, the price set on the parent usergroup will be ignored.
If you want for ex. to give a discount of 20% of sales price on all products in a given category you can use the SP
type pricing for a category. The usergroup will have discounted prices on all products that belong in that category.
Another common use case is to set a specific price for a product only for users in a given usergroup.
Request
Path Parameters
Lookup key. Read more about usergroup lookup keys
The value of the key (id or sourceId)
- application/json
Body
Array [
]
Array [
]
categories
object[]
pricing
object
products
object[]
pricing
object
Responses
- 200
- 404
Create Usergroup Pricing - 200
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Create Usergroup Pricing - 200
Schema
Array [
]
data
object[]
{
"data": [
{
"action": "create",
"key": 1797,
"lookupKey": "id",
"success": true
},
{
"action": "create",
"key": 77138,
"lookupKey": "id",
"success": true
},
{
"action": "create",
"error": "product with id [1036522] not found",
"key": 1036522,
"lookupKey": "id",
"success": false
}
],
"messages": [
"completed"
],
"total": 3
}
{
"data": [
{
"action": "create",
"key": 1797,
"lookupKey": "id",
"success": true
},
{
"action": "create",
"key": 77138,
"lookupKey": "id",
"success": true
},
{
"action": "create",
"error": "product with id [1036522] not found",
"key": 1036522,
"lookupKey": "id",
"success": false
}
],
"messages": [
"completed"
],
"total": 3
}
Create Usergroup Pricing - 404
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Create Usergroup Pricing - 404
Schema
error
object
{
"error": {
"code": 20007,
"messages": [
"Parent resource [Usergroup] with id [122589] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/20007",
"status": 404,
"type": "ParentUsergroupNotFound"
}
}
{
"error": {
"code": 20007,
"messages": [
"Parent resource [Usergroup] with id [122589] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/20007",
"status": 404,
"type": "ParentUsergroupNotFound"
}
}