Admin API
stringinteger · min: 1 · max: 100integer · min: 1integer · min: 1stringinteger · min: 1stringstringinteger · enum · requiredintegerstringstringstring · enumstring · enumstring · enumnumber · floatstring · enumstring · date-timestring · date-time
integer · enum · requiredintegerstringstringstring · enumstring · enumstring · enumnumber · floatstring · enumstring · date-timestring · date-timeinteger · enum · requiredintegerstringstringstring · enumstring · enumstring · enumnumber · floatstring · enumstring · date-timestring · date-time
stringinteger · min: 1 · max: 100integer · min: 1integer · min: 1stringinteger · min: 1stringstring integer · required
string · pattern: integer · enum · requiredintegerstringstringstring · enumstring · enumstring · enumnumber · floatstring · enumstring · date-timestring · date-time
string · pattern: integer · enum · requiredintegerstringstringstring · enumstring · enumstring · enumnumber · floatstring · enumstring · date-timestring · date-timeinteger · enum · requiredintegerstringstringstring · enumstring · enumstring · enumnumber · floatstring · enumstring · date-timestring · date-time
PriceRule LIST
GET
https://your-store.myideasoft.com
/admin-api/price_rules
Bearer
or
OAuth 2.0
query Parameters
sortExample sort=id
limitNumber of requested PriceRule per page
Default: 20
pageWhich page to start from
Default: 1
idGet result by id
idsGet multiple result by ids
sinceIdRestrict results to after the specified id
qPriceRule search filter. Usage: q[
sSearch key filter.
PriceRule LIST › Responses
The request (GET or PUT) completed successfully.
statusEnum values:
0
1
idnameruleTypepriceTypeEnum values:
price1
price2
price3
price4
price5
operationEnum values:
increase
decrease
typeEnum values:
percentage
regular
valueroundingEnum values:
up
down
none
createdAtupdatedAtPriceRule POST
POST
https://your-store.myideasoft.com
/admin-api/price_rules
Bearer
or
OAuth 2.0
PriceRule POST › Request Body
statusEnum values:
0
1
idnameruleTypepriceTypeEnum values:
price1
price2
price3
price4
price5
operationEnum values:
increase
decrease
typeEnum values:
percentage
regular
valueroundingEnum values:
up
down
none
createdAtupdatedAtPriceRule POST › Responses
The create request (POST) completed successfully.
statusEnum values:
0
1
idnameruleTypepriceTypeEnum values:
price1
price2
price3
price4
price5
operationEnum values:
increase
decrease
typeEnum values:
percentage
regular
valueroundingEnum values:
up
down
none
createdAtupdatedAtPriceRule COUNT
GET
https://your-store.myideasoft.com
/admin-api/price_rules/count
Bearer
or
OAuth 2.0
query Parameters
sortExample sort=id
limitNumber of requested PriceRule per page
Default: 20
pageWhich page to start from
Default: 1
idGet result by id
idsGet multiple result by ids
sinceIdRestrict results to after the specified id
qPriceRule search filter. Usage: q[
sSearch key filter.
PriceRule COUNT › Responses
The request (GET or PUT) completed successfully.
Record count response.
total_countTotal number of records matching the filters.
PriceRule GET
GET
https://your-store.myideasoft.com
/admin-api/price_rules/{id}
Bearer
or
OAuth 2.0
path Parameters
id\d+ · requiredPriceRule GET › Responses
The request (GET or PUT) completed successfully.
statusEnum values:
0
1
idnameruleTypepriceTypeEnum values:
price1
price2
price3
price4
price5
operationEnum values:
increase
decrease
typeEnum values:
percentage
regular
valueroundingEnum values:
up
down
none
createdAtupdatedAtPriceRule PUT
PUT
https://your-store.myideasoft.com
/admin-api/price_rules/{id}
Bearer
or
OAuth 2.0
path Parameters
id\d+ · requiredPriceRule PUT › Request Body
statusEnum values:
0
1
idnameruleTypepriceTypeEnum values:
price1
price2
price3
price4
price5
operationEnum values:
increase
decrease
typeEnum values:
percentage
regular
valueroundingEnum values:
up
down
none
createdAtupdatedAtPriceRule PUT › Responses
The request (GET or PUT) completed successfully.
statusEnum values:
0
1
idnameruleTypepriceTypeEnum values:
price1
price2
price3
price4
price5
operationEnum values:
increase
decrease
typeEnum values:
percentage
regular
valueroundingEnum values:
up
down
none
createdAtupdatedAt