API Test site

Base URLhttps://wholesale.samita.io/api/v1

GET/volume-pricings

Get list volume pricings

Parameters

Name	In	Type	Description
query	query	string
limit	query	integer
status	query	string
sort	query	string	One of: decrease, ascrease

Responses

• 200A list of volume pricings
• 401Unauthorized
• 403This action is unauthorized
• 429Too Many Requests

POST/volume-pricings

Create volume pricing

Request body

Field	Type	Description
title	string
status	boolean	One of: true, false
type	string
apply_customer	object
apply_customer.type	string	One of: all, logged, non-logged, customer-tags
apply_customer.tags	string[]
exclude_customer	object
exclude_customer.type	string	One of: none, customer-tags
exclude_customer.tags	any[]
apply_product	object
apply_product.type	string	One of: all, products, collections, product-tags
apply_product.product_ids	integer (int64)[]
apply_product.product_tags	string[]
apply_product.collection_ids	integer (int64)[]
apply_product.apply_for_variants	boolean	One of: true, false
exclude_product	object
exclude_product.type	string	One of: none, products, collections
exclude_product.product_ids	integer (int64)[]
exclude_product.collection_ids	integer (int64)[]
discount_for_variants	object[]
discount_for_variants[].idrequired	integer (int64)
discount_for_variants[].duplicated	boolean	One of: true, false
discount_for_variants[].variant_pricingrequired	boolean	One of: true, false
discount_for_variants[].from_qty	string
discount_for_variants[].from_amount	string
discount_for_variants[].to_qty	string
discount_for_variants[].to_amount	string
discount_for_variants[].discount_groups	object[]
discount_for_variants[].discount_groups[].namerequired	string
discount_for_variants[].discount_groups[].typerequired	string	One of: percent, amount, fixed-amount
discount_for_variants[].discount_groups[].valuerequired	string
discount_for_variants[].variantsrequired	object[]
discount_for_variants[].variants[].idrequired	integer (int64)
discount_for_variants[].variants[].duplicated	boolean	One of: true, false
discount_for_variants[].variants[].from_qty	string	Volume pricing type is quantity
discount_for_variants[].variants[].from_amount	string	Volume pricing type is amount
discount_for_variants[].variants[].to_qty	string	Volume pricing type is quantity
discount_for_variants[].variants[].to_amount	string	Volume pricing type is amount
discount_for_variants[].variants[].discount_groupsrequired	object[]
discount_for_variants[].variants[].discount_groups[].namerequired	string
discount_for_variants[].variants[].discount_groups[].typerequired	string	One of: percent, amount, fixed-amount
discount_for_variants[].variants[].discount_groups[].valuerequired	string
apply_market	object
apply_market.type	string	One of: all, specific-market
apply_market.handle	string[]
discount_method	string
discount_groups	object[]
discount_groups[].from_qty	string	Volume pricing type is quantity
discount_groups[].from_amount	string	Volume pricing type is amount
discount_groups[].to_qty	string	Volume pricing type is quantity
discount_groups[].to_amount	string	Volume pricing type is amount
discount_groups[].type	string	One of: percent, amount, fixed-amount
discount_groups[].value	string
active_date	object
active_date.types	string[]	One of: start_date, end_date
active_date.start_at	string
active_date.end_at	string

Responses

• 200A volume pricing
• 401Unauthorized
• 403This action is unauthorized
• 429Too Many Requests

GET/volume-pricings/{id}

Get volume pricing with ID

Parameters

Name	In	Type	Description
idrequired	path	integer

Responses

• 200A volume pricing
• 401Unauthorized
• 403This action is unauthorized
• 404Volume pricing not found
• 429Too Many Requests

PUT/volume-pricings/{id}

Update volume pricing

Request body

Field	Type	Description
title	string
status	boolean	One of: true, false
type	string
apply_customer	object
apply_customer.type	string	One of: all, logged, non-logged, customer-tags
apply_customer.tags	string[]
exclude_customer	object
exclude_customer.type	string	One of: none, customer-tags
exclude_customer.tags	any[]
apply_product	object
apply_product.type	string	One of: all, products, collections, product-tags
apply_product.product_ids	integer (int64)[]
apply_product.product_tags	string[]
apply_product.collection_ids	integer (int64)[]
apply_product.apply_for_variants	boolean	One of: true, false
exclude_product	object
exclude_product.type	string	One of: none, products, collections
exclude_product.product_ids	integer (int64)[]
exclude_product.collection_ids	integer (int64)[]
discount_for_variants	object[]
discount_for_variants[].idrequired	integer (int64)
discount_for_variants[].duplicated	boolean	One of: true, false
discount_for_variants[].variant_pricingrequired	boolean	One of: true, false
discount_for_variants[].from_qty	string
discount_for_variants[].from_amount	string
discount_for_variants[].to_qty	string
discount_for_variants[].to_amount	string
discount_for_variants[].discount_groups	object[]
discount_for_variants[].discount_groups[].namerequired	string
discount_for_variants[].discount_groups[].typerequired	string	One of: percent, amount, fixed-amount
discount_for_variants[].discount_groups[].valuerequired	string
discount_for_variants[].variantsrequired	object[]
discount_for_variants[].variants[].idrequired	integer (int64)
discount_for_variants[].variants[].duplicated	boolean	One of: true, false
discount_for_variants[].variants[].from_qty	string	Volume pricing type is quantity
discount_for_variants[].variants[].from_amount	string	Volume pricing type is amount
discount_for_variants[].variants[].to_qty	string	Volume pricing type is quantity
discount_for_variants[].variants[].to_amount	string	Volume pricing type is amount
discount_for_variants[].variants[].discount_groupsrequired	object[]
discount_for_variants[].variants[].discount_groups[].namerequired	string
discount_for_variants[].variants[].discount_groups[].typerequired	string	One of: percent, amount, fixed-amount
discount_for_variants[].variants[].discount_groups[].valuerequired	string
apply_market	object
apply_market.type	string	One of: all, specific-market
apply_market.handle	string[]
discount_method	string
discount_groups	object[]
discount_groups[].from_qty	string	Volume pricing type is quantity
discount_groups[].from_amount	string	Volume pricing type is amount
discount_groups[].to_qty	string	Volume pricing type is quantity
discount_groups[].to_amount	string	Volume pricing type is amount
discount_groups[].type	string	One of: percent, amount, fixed-amount
discount_groups[].value	string
active_date	object
active_date.types	string[]	One of: start_date, end_date
active_date.start_at	string
active_date.end_at	string

Responses

• 200A volume pricing
• 401Unauthorized
• 403This action is unauthorized
• 429Too Many Requests

DELETE/volume-pricings/{ids}

Delete volume pricing by IDs

Parameters

Name	In	Type	Description
idsrequired	path	integer

Responses

• 200Delete volume pricings
• 401Unauthorized
• 403This action is unauthorized
• 404Volume pricing not found
• 429Too Many Requests