Skip to content
Ideasoft
Admin API

PriceRule

Serverhttps://your-store.myideasoft.com

PriceRule LIST

GET
https://your-store.myideasoft.com
/admin-api/price_rules
Bearer
or
OAuth 2.0

PriceRule LIST › query Parameters

sort
​string

Example sort=id

limit
​integer · min: 1 · max: 100

Number of requested PriceRule per page

Default: 20
page
​integer · min: 1

Which page to start from

Default: 1
id
​integer · min: 1

Get result by id

ids
​string

Get multiple result by ids

sinceId
​integer · min: 1

Restrict results to after the specified id

q
​string

PriceRule search filter. Usage: q[]

s
​string

Search key filter.

PriceRule LIST › Responses

The request (GET or PUT) completed successfully.

status
​integer · enum · required
Enum values:
0
1
id
​integer
name
​string
ruleType
​string
​CountrySummary
​CurrencySummary
priceType
​string · enum
Enum values:
price1
price2
price3
price4
price5
operation
​string · enum
Enum values:
increase
decrease
type
​string · enum
Enum values:
percentage
regular
value
​number · float
rounding
​string · enum
Enum values:
up
down
none
createdAt
​string · date-time
updatedAt
​string · date-time

PriceRule POST

POST
https://your-store.myideasoft.com
/admin-api/price_rules
Bearer
or
OAuth 2.0

PriceRule POST › Request Body

status
​integer · enum · required
Enum values:
0
1
id
​integer
name
​string
ruleType
​string
​CountrySummary
​CurrencySummary
priceType
​string · enum
Enum values:
price1
price2
price3
price4
price5
operation
​string · enum
Enum values:
increase
decrease
type
​string · enum
Enum values:
percentage
regular
value
​number · float
rounding
​string · enum
Enum values:
up
down
none
createdAt
​string · date-time
updatedAt
​string · date-time

PriceRule POST › Responses

The create request (POST) completed successfully.

status
​integer · enum · required
Enum values:
0
1
id
​integer
name
​string
ruleType
​string
​CountrySummary
​CurrencySummary
priceType
​string · enum
Enum values:
price1
price2
price3
price4
price5
operation
​string · enum
Enum values:
increase
decrease
type
​string · enum
Enum values:
percentage
regular
value
​number · float
rounding
​string · enum
Enum values:
up
down
none
createdAt
​string · date-time
updatedAt
​string · date-time

PriceRule COUNT

GET
https://your-store.myideasoft.com
/admin-api/price_rules/count
Bearer
or
OAuth 2.0

PriceRule COUNT › query Parameters

sort
​string

Example sort=id

limit
​integer · min: 1 · max: 100

Number of requested PriceRule per page

Default: 20
page
​integer · min: 1

Which page to start from

Default: 1
id
​integer · min: 1

Get result by id

ids
​string

Get multiple result by ids

sinceId
​integer · min: 1

Restrict results to after the specified id

q
​string

PriceRule search filter. Usage: q[]

s
​string

Search key filter.

PriceRule COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


PriceRule GET

GET
https://your-store.myideasoft.com
/admin-api/price_rules/{id}
Bearer
or
OAuth 2.0

PriceRule GET › path Parameters

id
​string · pattern: \d+ · required

PriceRule GET › Responses

The request (GET or PUT) completed successfully.

status
​integer · enum · required
Enum values:
0
1
id
​integer
name
​string
ruleType
​string
​CountrySummary
​CurrencySummary
priceType
​string · enum
Enum values:
price1
price2
price3
price4
price5
operation
​string · enum
Enum values:
increase
decrease
type
​string · enum
Enum values:
percentage
regular
value
​number · float
rounding
​string · enum
Enum values:
up
down
none
createdAt
​string · date-time
updatedAt
​string · date-time

PriceRule PUT

PUT
https://your-store.myideasoft.com
/admin-api/price_rules/{id}
Bearer
or
OAuth 2.0

PriceRule PUT › path Parameters

id
​string · pattern: \d+ · required

PriceRule PUT › Request Body

status
​integer · enum · required
Enum values:
0
1
id
​integer
name
​string
ruleType
​string
​CountrySummary
​CurrencySummary
priceType
​string · enum
Enum values:
price1
price2
price3
price4
price5
operation
​string · enum
Enum values:
increase
decrease
type
​string · enum
Enum values:
percentage
regular
value
​number · float
rounding
​string · enum
Enum values:
up
down
none
createdAt
​string · date-time
updatedAt
​string · date-time

PriceRule PUT › Responses

The request (GET or PUT) completed successfully.

status
​integer · enum · required
Enum values:
0
1
id
​integer
name
​string
ruleType
​string
​CountrySummary
​CurrencySummary
priceType
​string · enum
Enum values:
price1
price2
price3
price4
price5
operation
​string · enum
Enum values:
increase
decrease
type
​string · enum
Enum values:
percentage
regular
value
​number · float
rounding
​string · enum
Enum values:
up
down
none
createdAt
​string · date-time
updatedAt
​string · date-time

PriceRule DELETE

DELETE
https://your-store.myideasoft.com
/admin-api/price_rules/{id}
Bearer
or
OAuth 2.0

PriceRule DELETE › path Parameters

id
​string · pattern: \d+ · required

PriceRule DELETE › Responses

The delete request completed successfully (the response has no content).

No data returned