Zoey REST API reference ยท Interactive version: apidocs.zoey.com
GET https://container-url.zoeysite.com/api/rest/customers/groups?limit=1&page=1&order=customer_group_id&dir=ASC&filter[0][attribute]=customer_group_id&filter[0][gt]=2
Query parameters:
| Name | Example | Notes |
|---|---|---|
limit | 1 | Limit the response. |
page | 1 | Paginate the response. |
order | customer_group_id | Order the response by attribute. |
dir | ASC | Order direction. (ASC, DESC) |
filter[0][attribute] | customer_group_id | Filter the response. |
filter[0][gt] | 2 |
GET https://container-url.zoeysite.com/api/rest/customers/groups/:groupId
PUT https://container-url.zoeysite.com/api/rest/customers/groups/:groupId
TYPES restrictedStoresCurrenciesType
// Example when Store ID is equal to 1
{
"1": ["USD"]
},
groupSalesIncrementsType
customIncrementDataType
Example request body:
{
"customer_group_code": "API TEST",
"tax_class_id": "3",
"sales_rep_user_id": [],
"restricted_stores_currencies": {
"1": [
"USD"
]
},
"login_redirect_path": "shirts",
"b2b_quote_product_attribute_restriction": "92",
"mage_quote_product_attribute_restriction": "92",
"use_group_sales_increments_order": "1",
"use_group_sales_increments_invoice": "1",
"use_group_sales_increments_creditmemo": "1",
"use_group_sales_increments_shipment": "1",
"use_po_increments": "0",
"po_increment_data": {
"prefix": "api_group_",
"last_id": ""
},
"group_sales_increments": {
"order": {
"prefix": "api_group_",
"last_id": "10000000"
},
"invoice": {
"prefix": "api_group_",
"last_id": "20000000"
},
"creditmemo": {
"prefix": "api_group_",
"last_id": "30000000"
},
"shipment": {
"prefix": "api_group_",
"last_id": "40000000"
}
}
}
POST https://container-url.zoeysite.com/api/rest/customers/groups
TYPES restrictedStoresCurrenciesType
// Example when Store ID is equal to 1
{
"1": ["USD"]
},
groupSalesIncrementsType
customIncrementDataType
Example request body:
{
"customer_group_code": "API TEST",
"tax_class_id": 3,
"sales_rep_user_id": [],
"restricted_stores_currencies": {
"1": [
"USD"
]
},
"login_redirect_path": "shirts",
"b2b_quote_product_attribute_restriction": 92,
"mage_quote_product_attribute_restriction": 92,
"use_group_sales_increments_order": 1,
"use_group_sales_increments_invoice": 1,
"use_group_sales_increments_creditmemo": 1,
"use_group_sales_increments_shipment": 1,
"use_po_increments": 0,
"group_sales_increments": {
"order": {
"prefix": "api_group_",
"last_id": "10000000"
},
"invoice": {
"prefix": "api_group_",
"last_id": "20000000"
},
"creditmemo": {
"prefix": "api_group_",
"last_id": "30000000"
},
"shipment": {
"prefix": "api_group_",
"last_id": "40000000"
}
}
}
DELETE https://container-url.zoeysite.com/api/rest/customers/groups/:groupId
Example request body:
{
"customer_group_code": "API TEST"
}