API Test site
Base URLhttps://wholesale.samita.io/api/v1
GET/wholesale-pricings
Get list wholesale 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 wholesale pricings401Unauthorized403This action is unauthorized429Too Many Requests
POST/wholesale-pricings
Create wholesale pricing
Request body
| Field | Type | Description |
|---|---|---|
title | string | |
status | boolean | One of: true, false |
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 | string[] | |
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[].variant_pricingrequired | boolean | One of: true, false |
discount_for_variants[].variantsrequired | object[] | |
discount_for_variants[].variants[].idrequired | integer (int64) | |
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_group | object | |
discount_group.type | string | One of: percent, amount, fixed-amount |
discount_group.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 wholesale pricing401Unauthorized403This action is unauthorized429Too Many Requests
GET/wholesale-pricings/{id}
Get wholesale pricing with ID
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | integer |
Responses
200A wholesale pricing401Unauthorized403This action is unauthorized404Wholesale pricing not found429Too Many Requests
PUT/wholesale-pricings/{id}
Update wholesale pricing
Request body
| Field | Type | Description |
|---|---|---|
title | string | |
status | boolean | One of: true, false |
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 | string[] | |
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[].variant_pricingrequired | boolean | One of: true, false |
discount_for_variants[].variantsrequired | object[] | |
discount_for_variants[].variants[].idrequired | integer (int64) | |
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_group | object | |
discount_group.type | string | One of: percent, amount, fixed-amount |
discount_group.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 wholesale pricing401Unauthorized403This action is unauthorized429Too Many Requests
DELETE/wholesale-pricings/{ids}
Delete wholesale pricing by IDs
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idsrequired | path | integer |
Responses
200Delete wholesale pricings401Unauthorized403This action is unauthorized404Wholesale pricing not found429Too Many Requests
Was this helpful?
Thanks for your feedback.
Thanks.