← API Reference

E-Commerce API

Shopping carts, shops, transactions, recommendations

Base URL: https://ecommerce-api.ayoune.app — 10 entities

Example

cURL

curl -H "Authorization: Bearer pat_your_token" \
  https://ecommerce-api.ayoune.app/orders?limit=10

TypeScript SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

const result = await ay.ecommerce.orders.find().limit(10).exec();
console.log(result.payload());

Entities

Entity	REST Path	SDK	Access	Right
Orders	/orders	ay.ecommerce.orders	CRUD	ecommerce.orders	play_circle
ProductReviews	/productreviews	ay.ecommerce.productReviews	CRUD	ecommerce.productreviews	play_circle
Recommendations	/recommendations	ay.ecommerce.recommendations	read-only	ecommerce.recommendations	play_circle
ShippingClasses	/shippingclasses	ay.ecommerce.shippingClasses	CRUD	ecommerce.shippingclasses	play_circle
ShippingMethods	/shippingmethods	ay.ecommerce.shippingMethods	CRUD	ecommerce.shippingmethods	play_circle
ShippingZones	/shippingzones	ay.ecommerce.shippingZones	CRUD	ecommerce.shippingzones	play_circle
ShoppingCarts	/shoppingcarts	ay.ecommerce.shoppingCarts	CRUD	ecommerce.shoppingcarts	play_circle
Shops	/shops	ay.ecommerce.shops	CRUD	ecommerce.shops	play_circle
Transactions	/transactions	ay.ecommerce.transactions	CRUD	ecommerce.transactions	play_circle
Watchlists	/watchlists	ay.ecommerce.watchlists	CRUD	ecommerce.watchlists	play_circle