clayful-lib-spec
Version:
API specifications for Clayful
1,898 lines (1,897 loc) • 169 kB
JSON
[
{
"module": "brand.list",
"httpMethod": "GET",
"path": "/v1/brands",
"modelName": "brand",
"className": "Brand",
"method": "list",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "catalog.list",
"httpMethod": "GET",
"path": "/v1/catalogs",
"modelName": "catalog",
"className": "Catalog",
"method": "list",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "collection.list",
"httpMethod": "GET",
"path": "/v1/collections",
"modelName": "collection",
"className": "Collection",
"method": "list",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "country.list",
"httpMethod": "GET",
"path": "/v1/countries",
"modelName": "country",
"className": "Country",
"method": "list",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "coupon.list",
"httpMethod": "GET",
"path": "/v1/coupons",
"modelName": "coupon",
"className": "Coupon",
"method": "list",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "currency.list",
"httpMethod": "GET",
"path": "/v1/currencies",
"modelName": "currency",
"className": "Currency",
"method": "list",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "customer.list",
"httpMethod": "GET",
"path": "/v1/customers",
"modelName": "customer",
"className": "Customer",
"method": "list",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "discount.list",
"httpMethod": "GET",
"path": "/v1/discounts",
"modelName": "discount",
"className": "Discount",
"method": "list",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "downloadable.list",
"httpMethod": "GET",
"path": "/v1/downloadables",
"modelName": "downloadable",
"className": "Downloadable",
"method": "list",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "group.list",
"httpMethod": "GET",
"path": "/v1/groups",
"modelName": "group",
"className": "Group",
"method": "list",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "image.list",
"httpMethod": "GET",
"path": "/v1/images",
"modelName": "image",
"className": "Image",
"method": "list",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "customer.getMe",
"httpMethod": "GET",
"path": "/v1/me",
"modelName": "customer",
"className": "Customer",
"method": "getMe",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered"
],
"module": false
}
},
{
"module": "order.list",
"httpMethod": "GET",
"path": "/v1/orders",
"modelName": "order",
"className": "Order",
"method": "list",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "product.list",
"httpMethod": "GET",
"path": "/v1/products",
"modelName": "product",
"className": "Product",
"method": "list",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "store.get",
"httpMethod": "GET",
"path": "/v1/store",
"modelName": "store",
"className": "Store",
"method": "get",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "subscription.list",
"httpMethod": "GET",
"path": "/v1/subscriptions",
"modelName": "subscription",
"className": "Subscription",
"method": "list",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "vendor.list",
"httpMethod": "GET",
"path": "/v1/vendors",
"modelName": "vendor",
"className": "Vendor",
"method": "list",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "wishList.list",
"httpMethod": "GET",
"path": "/v1/wishlists",
"modelName": "wishList",
"className": "WishList",
"method": "list",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "brand.count",
"httpMethod": "GET",
"path": "/v1/brands/count",
"modelName": "brand",
"className": "Brand",
"method": "count",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "brand.get",
"httpMethod": "GET",
"path": "/v1/brands/{brandId}",
"modelName": "brand",
"className": "Brand",
"method": "get",
"arguments": [
"brandId"
],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "catalog.count",
"httpMethod": "GET",
"path": "/v1/catalogs/count",
"modelName": "catalog",
"className": "Catalog",
"method": "count",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "catalog.get",
"httpMethod": "GET",
"path": "/v1/catalogs/{catalogId}",
"modelName": "catalog",
"className": "Catalog",
"method": "get",
"arguments": [
"catalogId"
],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "collection.count",
"httpMethod": "GET",
"path": "/v1/collections/count",
"modelName": "collection",
"className": "Collection",
"method": "count",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "collection.get",
"httpMethod": "GET",
"path": "/v1/collections/{collectionId}",
"modelName": "collection",
"className": "Collection",
"method": "get",
"arguments": [
"collectionId"
],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "country.count",
"httpMethod": "GET",
"path": "/v1/countries/count",
"modelName": "country",
"className": "Country",
"method": "count",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "country.get",
"httpMethod": "GET",
"path": "/v1/countries/{countryId}",
"modelName": "country",
"className": "Country",
"method": "get",
"arguments": [
"countryId"
],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "coupon.count",
"httpMethod": "GET",
"path": "/v1/coupons/count",
"modelName": "coupon",
"className": "Coupon",
"method": "count",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "coupon.get",
"httpMethod": "GET",
"path": "/v1/coupons/{couponId}",
"modelName": "coupon",
"className": "Coupon",
"method": "get",
"arguments": [
"couponId"
],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "currency.count",
"httpMethod": "GET",
"path": "/v1/currencies/count",
"modelName": "currency",
"className": "Currency",
"method": "count",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "currency.get",
"httpMethod": "GET",
"path": "/v1/currencies/{currencyId}",
"modelName": "currency",
"className": "Currency",
"method": "get",
"arguments": [
"currencyId"
],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "customer.isAuthenticated",
"httpMethod": "GET",
"path": "/v1/customers/auth",
"modelName": "customer",
"className": "Customer",
"method": "isAuthenticated",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [],
"module": false
}
},
{
"module": "customer.count",
"httpMethod": "GET",
"path": "/v1/customers/count",
"modelName": "customer",
"className": "Customer",
"method": "count",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "customer.get",
"httpMethod": "GET",
"path": "/v1/customers/{customerId}",
"modelName": "customer",
"className": "Customer",
"method": "get",
"arguments": [
"customerId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "discount.count",
"httpMethod": "GET",
"path": "/v1/discounts/count",
"modelName": "discount",
"className": "Discount",
"method": "count",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "discount.get",
"httpMethod": "GET",
"path": "/v1/discounts/{discountId}",
"modelName": "discount",
"className": "Discount",
"method": "get",
"arguments": [
"discountId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "downloadable.count",
"httpMethod": "GET",
"path": "/v1/downloadables/count",
"modelName": "downloadable",
"className": "Downloadable",
"method": "count",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "downloadable.get",
"httpMethod": "GET",
"path": "/v1/downloadables/{downloadableId}",
"modelName": "downloadable",
"className": "Downloadable",
"method": "get",
"arguments": [
"downloadableId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "group.count",
"httpMethod": "GET",
"path": "/v1/groups/count",
"modelName": "group",
"className": "Group",
"method": "count",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "group.get",
"httpMethod": "GET",
"path": "/v1/groups/{groupId}",
"modelName": "group",
"className": "Group",
"method": "get",
"arguments": [
"groupId"
],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "image.count",
"httpMethod": "GET",
"path": "/v1/images/count",
"modelName": "image",
"className": "Image",
"method": "count",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "image.get",
"httpMethod": "GET",
"path": "/v1/images/{imageId}",
"modelName": "image",
"className": "Image",
"method": "get",
"arguments": [
"imageId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "customer.listCouponsForMe",
"httpMethod": "GET",
"path": "/v1/me/coupons",
"modelName": "customer",
"className": "Customer",
"method": "listCouponsForMe",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered"
],
"module": false
}
},
{
"module": "image.listForMe",
"httpMethod": "GET",
"path": "/v1/me/images",
"modelName": "image",
"className": "Image",
"method": "listForMe",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered"
],
"module": false
}
},
{
"module": "order.listForMe",
"httpMethod": "GET",
"path": "/v1/me/orders",
"modelName": "order",
"className": "Order",
"method": "listForMe",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered"
],
"module": false
}
},
{
"module": "subscription.listForMe",
"httpMethod": "GET",
"path": "/v1/me/subscriptions",
"modelName": "subscription",
"className": "Subscription",
"method": "listForMe",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered"
],
"module": false
}
},
{
"module": "wishList.listForMe",
"httpMethod": "GET",
"path": "/v1/me/wishlists",
"modelName": "wishList",
"className": "WishList",
"method": "listForMe",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered"
],
"module": false
}
},
{
"module": "order.count",
"httpMethod": "GET",
"path": "/v1/orders/count",
"modelName": "order",
"className": "Order",
"method": "count",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "orderTag.list",
"httpMethod": "GET",
"path": "/v1/orders/tags",
"modelName": "orderTag",
"className": "OrderTag",
"method": "list",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "order.get",
"httpMethod": "GET",
"path": "/v1/orders/{orderId}",
"modelName": "order",
"className": "Order",
"method": "get",
"arguments": [
"orderId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "paymentMethod.list",
"httpMethod": "GET",
"path": "/v1/payments/methods",
"modelName": "paymentMethod",
"className": "PaymentMethod",
"method": "list",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "product.count",
"httpMethod": "GET",
"path": "/v1/products/count",
"modelName": "product",
"className": "Product",
"method": "count",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "review.list",
"httpMethod": "GET",
"path": "/v1/products/reviews",
"modelName": "review",
"className": "Review",
"method": "list",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "product.get",
"httpMethod": "GET",
"path": "/v1/products/{productId}",
"modelName": "product",
"className": "Product",
"method": "get",
"arguments": [
"productId"
],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "shippingMethod.list",
"httpMethod": "GET",
"path": "/v1/shipping/methods",
"modelName": "shippingMethod",
"className": "ShippingMethod",
"method": "list",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "subscription.count",
"httpMethod": "GET",
"path": "/v1/subscriptions/count",
"modelName": "subscription",
"className": "Subscription",
"method": "count",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "subscriptionPlan.list",
"httpMethod": "GET",
"path": "/v1/subscriptions/plans",
"modelName": "subscriptionPlan",
"className": "SubscriptionPlan",
"method": "list",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "subscription.get",
"httpMethod": "GET",
"path": "/v1/subscriptions/{subscriptionId}",
"modelName": "subscription",
"className": "Subscription",
"method": "get",
"arguments": [
"subscriptionId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "taxCategory.list",
"httpMethod": "GET",
"path": "/v1/taxes/categories",
"modelName": "taxCategory",
"className": "TaxCategory",
"method": "list",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "vendor.count",
"httpMethod": "GET",
"path": "/v1/vendors/count",
"modelName": "vendor",
"className": "Vendor",
"method": "count",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "vendor.get",
"httpMethod": "GET",
"path": "/v1/vendors/{vendorId}",
"modelName": "vendor",
"className": "Vendor",
"method": "get",
"arguments": [
"vendorId"
],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "wishList.count",
"httpMethod": "GET",
"path": "/v1/wishlists/count",
"modelName": "wishList",
"className": "WishList",
"method": "count",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "wishList.get",
"httpMethod": "GET",
"path": "/v1/wishlists/{wishListId}",
"modelName": "wishList",
"className": "WishList",
"method": "get",
"arguments": [
"wishListId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "customer.listCoupons",
"httpMethod": "GET",
"path": "/v1/customers/{customerId}/coupons",
"modelName": "customer",
"className": "Customer",
"method": "listCoupons",
"arguments": [
"customerId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "customer.countCouponsForMe",
"httpMethod": "GET",
"path": "/v1/me/coupons/count",
"modelName": "customer",
"className": "Customer",
"method": "countCouponsForMe",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered"
],
"module": false
}
},
{
"module": "image.countForMe",
"httpMethod": "GET",
"path": "/v1/me/images/count",
"modelName": "image",
"className": "Image",
"method": "countForMe",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered"
],
"module": false
}
},
{
"module": "image.getForMe",
"httpMethod": "GET",
"path": "/v1/me/images/{imageId}",
"modelName": "image",
"className": "Image",
"method": "getForMe",
"arguments": [
"imageId"
],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered"
],
"module": false
}
},
{
"module": "order.countForMe",
"httpMethod": "GET",
"path": "/v1/me/orders/count",
"modelName": "order",
"className": "Order",
"method": "countForMe",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered"
],
"module": false
}
},
{
"module": "order.getForMe",
"httpMethod": "GET",
"path": "/v1/me/orders/{orderId}",
"modelName": "order",
"className": "Order",
"method": "getForMe",
"arguments": [
"orderId"
],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered",
"order"
],
"module": false
}
},
{
"module": "subscription.countForMe",
"httpMethod": "GET",
"path": "/v1/me/subscriptions/count",
"modelName": "subscription",
"className": "Subscription",
"method": "countForMe",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered"
],
"module": false
}
},
{
"module": "subscription.getForMe",
"httpMethod": "GET",
"path": "/v1/me/subscriptions/{subscriptionId}",
"modelName": "subscription",
"className": "Subscription",
"method": "getForMe",
"arguments": [
"subscriptionId"
],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered",
"subscription"
],
"module": false
}
},
{
"module": "wishList.countForMe",
"httpMethod": "GET",
"path": "/v1/me/wishlists/count",
"modelName": "wishList",
"className": "WishList",
"method": "countForMe",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered"
],
"module": false
}
},
{
"module": "wishList.getForMe",
"httpMethod": "GET",
"path": "/v1/me/wishlists/{wishListId}",
"modelName": "wishList",
"className": "WishList",
"method": "getForMe",
"arguments": [
"wishListId"
],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered"
],
"module": false
}
},
{
"module": "orderTag.count",
"httpMethod": "GET",
"path": "/v1/orders/tags/count",
"modelName": "orderTag",
"className": "OrderTag",
"method": "count",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "orderTag.get",
"httpMethod": "GET",
"path": "/v1/orders/tags/{orderTagId}",
"modelName": "orderTag",
"className": "OrderTag",
"method": "get",
"arguments": [
"orderTagId"
],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "paymentMethod.count",
"httpMethod": "GET",
"path": "/v1/payments/methods/count",
"modelName": "paymentMethod",
"className": "PaymentMethod",
"method": "count",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "paymentMethod.get",
"httpMethod": "GET",
"path": "/v1/payments/methods/{paymentMethodId}",
"modelName": "paymentMethod",
"className": "PaymentMethod",
"method": "get",
"arguments": [
"paymentMethodId"
],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "reviewComment.list",
"httpMethod": "GET",
"path": "/v1/products/reviews/comments",
"modelName": "reviewComment",
"className": "ReviewComment",
"method": "list",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "review.count",
"httpMethod": "GET",
"path": "/v1/products/reviews/count",
"modelName": "review",
"className": "Review",
"method": "count",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "review.listPublished",
"httpMethod": "GET",
"path": "/v1/products/reviews/published",
"modelName": "review",
"className": "Review",
"method": "listPublished",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "review.get",
"httpMethod": "GET",
"path": "/v1/products/reviews/{reviewId}",
"modelName": "review",
"className": "Review",
"method": "get",
"arguments": [
"reviewId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "shippingMethod.count",
"httpMethod": "GET",
"path": "/v1/shipping/methods/count",
"modelName": "shippingMethod",
"className": "ShippingMethod",
"method": "count",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "shippingMethod.get",
"httpMethod": "GET",
"path": "/v1/shipping/methods/{shippingMethodId}",
"modelName": "shippingMethod",
"className": "ShippingMethod",
"method": "get",
"arguments": [
"shippingMethodId"
],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "subscriptionPlan.count",
"httpMethod": "GET",
"path": "/v1/subscriptions/plans/count",
"modelName": "subscriptionPlan",
"className": "SubscriptionPlan",
"method": "count",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "subscriptionPlan.get",
"httpMethod": "GET",
"path": "/v1/subscriptions/plans/{subscriptionPlanId}",
"modelName": "subscriptionPlan",
"className": "SubscriptionPlan",
"method": "get",
"arguments": [
"subscriptionPlanId"
],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "order.listBySubscription",
"httpMethod": "GET",
"path": "/v1/subscriptions/{subscriptionId}/orders",
"modelName": "order",
"className": "Order",
"method": "listBySubscription",
"arguments": [
"subscriptionId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "taxCategory.count",
"httpMethod": "GET",
"path": "/v1/taxes/categories/count",
"modelName": "taxCategory",
"className": "TaxCategory",
"method": "count",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "taxCategory.get",
"httpMethod": "GET",
"path": "/v1/taxes/categories/{taxCategoryId}",
"modelName": "taxCategory",
"className": "TaxCategory",
"method": "get",
"arguments": [
"taxCategoryId"
],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "wishList.listProducts",
"httpMethod": "GET",
"path": "/v1/wishlists/{wishListId}/products",
"modelName": "wishList",
"className": "WishList",
"method": "listProducts",
"arguments": [
"wishListId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "customer.countCoupons",
"httpMethod": "GET",
"path": "/v1/customers/{customerId}/coupons/count",
"modelName": "customer",
"className": "Customer",
"method": "countCoupons",
"arguments": [
"customerId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "cart.countItemsForMe",
"httpMethod": "GET",
"path": "/v1/me/cart/items/count",
"modelName": "cart",
"className": "Cart",
"method": "countItemsForMe",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered"
],
"module": false
}
},
{
"module": "order.listBySubscriptionForMe",
"httpMethod": "GET",
"path": "/v1/me/subscriptions/{subscriptionId}/orders",
"modelName": "order",
"className": "Order",
"method": "listBySubscriptionForMe",
"arguments": [
"subscriptionId"
],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered",
"subscription"
],
"module": false
}
},
{
"module": "wishList.listProductsForMe",
"httpMethod": "GET",
"path": "/v1/me/wishlists/{wishListId}/products",
"modelName": "wishList",
"className": "WishList",
"method": "listProductsForMe",
"arguments": [
"wishListId"
],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered"
],
"module": false
}
},
{
"module": "order.listInventoryOperations",
"httpMethod": "GET",
"path": "/v1/orders/{orderId}/inventory/operations",
"modelName": "order",
"className": "Order",
"method": "listInventoryOperations",
"arguments": [
"orderId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "reviewComment.count",
"httpMethod": "GET",
"path": "/v1/products/reviews/comments/count",
"modelName": "reviewComment",
"className": "ReviewComment",
"method": "count",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "reviewComment.get",
"httpMethod": "GET",
"path": "/v1/products/reviews/comments/{reviewCommentId}",
"modelName": "reviewComment",
"className": "ReviewComment",
"method": "get",
"arguments": [
"reviewCommentId"
],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "review.countPublished",
"httpMethod": "GET",
"path": "/v1/products/reviews/published/count",
"modelName": "review",
"className": "Review",
"method": "countPublished",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "review.getPublished",
"httpMethod": "GET",
"path": "/v1/products/reviews/published/{reviewId}",
"modelName": "review",
"className": "Review",
"method": "getPublished",
"arguments": [
"reviewId"
],
"access": {
"public": true,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "subscription.listInventoryOperations",
"httpMethod": "GET",
"path": "/v1/subscriptions/{subscriptionId}/inventory/operations",
"modelName": "subscription",
"className": "Subscription",
"method": "listInventoryOperations",
"arguments": [
"subscriptionId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "wishList.countProducts",
"httpMethod": "GET",
"path": "/v1/wishlists/{wishListId}/products/count",
"modelName": "wishList",
"className": "WishList",
"method": "countProducts",
"arguments": [
"wishListId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "cart.countItems",
"httpMethod": "GET",
"path": "/v1/customers/{customerId}/cart/items/count",
"modelName": "cart",
"className": "Cart",
"method": "countItems",
"arguments": [
"customerId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "wishList.countProductsForMe",
"httpMethod": "GET",
"path": "/v1/me/wishlists/{wishListId}/products/count",
"modelName": "wishList",
"className": "WishList",
"method": "countProductsForMe",
"arguments": [
"wishListId"
],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"registered"
],
"module": false
}
},
{
"module": "customer.listByFlagVotes",
"httpMethod": "GET",
"path": "/v1/{voteModel}/{voteModelId}/flags/customers",
"modelName": "customer",
"className": "Customer",
"method": "listByFlagVotes",
"arguments": [
"voteModel",
"voteModelId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "customer.listByFlagVotes",
"httpMethod": "GET",
"path": "/v1/{voteModel}/{voteModelId}/flags/customers",
"modelName": "customer",
"className": "Customer",
"method": "listByFlagVotes",
"arguments": [
"voteModel",
"voteModelId"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "customer.listByHelpVotes",
"httpMethod": "GET",
"path": "/v1/{voteModel}/{voteModelId}/helped/{upDown}/customers",
"modelName": "customer",
"className": "Customer",
"method": "listByHelpVotes",
"arguments": [
"voteModel",
"voteModelId",
"upDown"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "customer.listByHelpVotes",
"httpMethod": "GET",
"path": "/v1/{voteModel}/{voteModelId}/helped/{upDown}/customers",
"modelName": "customer",
"className": "Customer",
"method": "listByHelpVotes",
"arguments": [
"voteModel",
"voteModelId",
"upDown"
],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
}
},
{
"module": "customer.create",
"httpMethod": "POST",
"path": "/v1/customers",
"modelName": "customer",
"className": "Customer",
"method": "create",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
},
"withoutPayload": false,
"optionalPayload": false,
"usesFormData": false
},
{
"module": "image.create",
"httpMethod": "POST",
"path": "/v1/images",
"modelName": "image",
"className": "Image",
"method": "create",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": false
},
"withoutPayload": false,
"optionalPayload": false,
"usesFormData": true
},
{
"module": "customer.createMe",
"httpMethod": "POST",
"path": "/v1/me",
"modelName": "customer",
"className": "Customer",
"method": "createMe",
"arguments": [],
"access": {
"public": true,
"private": true,
"me": true,
"customer": [
"non-registered"
],
"module": false
},
"withoutPayload": false,
"optionalPayload": false,
"usesFormData": false
},
{
"module": "product.create",
"httpMethod": "POST",
"path": "/v1/products",
"modelName": "product",
"className": "Product",
"method": "create",
"arguments": [],
"access": {
"public": false,
"private": true,
"me": false,
"customer": [],
"module": true
},
"withoutPayload": false,
"optionalPayload": false,
"usesFormData": false
},
{
"module": "vendor.create",
"httpMethod": "POST",
"path": "/v1/vendors",
"modelName": "vendor",