Namespace Reference — Modules
ShopByAntly
Curated JQL namespaces and examples for shopbyantly.
ShopByAntly namespaces cover shops, product listings, listing variants, carts, cart items, shipping rates, checkout sessions, shop payments, storefront transactions, and merchant registration.
Key namespaces and models
shopbyantly.Shopshopbyantly.ProductListingshopbyantly.ProductListingVariantshopbyantly.Cartshopbyantly.CartItemshopbyantly.ShippingRateshopbyantly.CheckoutSessionshopbyantly.ShopPaymentshopbyantly.ShopTransaction
Common controller intents
shopbyantly.Registration.createMerchantAccountshopbyantly.Shop.getStorefrontshopbyantly.ProductListing.getStorefrontListingsshopbyantly.ProductListing.getListingDetailshopbyantly.ProductListing.createProductshopbyantly.Cart.getCartshopbyantly.Cart.clearCartshopbyantly.CheckoutSession.getCheckoutSummaryshopbyantly.ShopPayment.initializeCheckoutshopbyantly.ShopPayment.getPaymentStatus
Common model intents
Most listed model namespaces support retrieve, retrieveOne, retrieveV2, create, update/patch, deleteOne, metadata, and aggregate subject to model permissions. Use consequence only for models that implement an on_<consequence> hook.
Retrieve example
json
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "shopbyantly.ProductListing",
5 "intent": "retrieve",
6 "authenticationClass": "jwt",
7 "ordering": "-created",
8 "limit": 20
9 },
10 "id": null,
11 "created": null
12}Create example
json
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "shopbyantly.Shop",
5 "intent": "create",
6 "authenticationClass": "jwt",
7 "return": {
8 "id": null,
9 "name": null,
10 "alias": null
11 }
12 },
13 "name": "Demo store",
14 "alias": "demo-store"
15}For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.