Qodex.ai
Qodex.ai
Introduction
brand
Access tokenCreating a brandRetrieving brands with existing field "localizedDescription"Retrieving brands with version > 1Retrieving all brandsRetrieving a brand with localized fields in en lang onlyUpdating a brandDeleting a brand
cart
prerequisites
Retrieving an anonymous tokenCreating a new customerLogging in the customer - retrieving saasToken and customer access tokenRetrieving access tokenCreating a second productCreating new price model (BASIC)Retrieving price modelCreating price for second product
cart
Creating a new cart as a logged customerRetrieving a cart's details by IDRetrieving lead time and non-delivery times for a cartRetrieving a cart's details by criteriaUpdating a cartDeleting a cartChanging a cart's siteMerging carts
items
Adding a product to cart CopyRetrieving a cart itemRetrieving all products added to a cartUpdating a cart itemRemoving an item from cartDeleting all products added to a cart
discounts
Applying a discount to cartRemoving all discounts from cartRemoving a discount from cart
catalog
Access tokenCreating catalog with language mapUpdating catalog with language mapPartially update a catalogRetrieving catalog by idRetrieving filtered or sorted list of catalogsRetrieving catalogs by filter with total countRetrieving catalogs containing categoryRemoving catalog
category
Access TokenCreating a new subcategoryRetrieving a category’s detailsRetrieving a list of categoriesUpdating a categoryUpdating a categoryRetrieving a list of categories for which the reference id is assignedRetrieving parents for a categoryRetrieving subcategories for a categoryRetrieving the category treesRetrieving the category treeRetrieving resources assigned to a categoryAssigning a resource to a categoryAdding media (blob) to the categoryDeleting all category assignmentsDeleting a category assignment by reference id
configuration
global configurations
Creating configurationsRetrieving configurationsRetrieving a configurationUpdating a configurationDeleting a configuration
client configurations
Creating client configurationsRetrieving client configurationsRetrieving a client configurationUpdating a client configurationDeleting a client configuration
Access Token
country
Access TokenRetrieving all countriesRetrieving a countryUpdating a countryRetrieving all regionsRetrieving a region
coupon
Manage coupons
Access TokenRetrieving all couponsCreating ABSOLUTE Coupon with MinOrderValue SelectedUserUpdating couponPartial update couponRetrieving a couponSoft deleting a couponRetrieving all coupon redemptionsDeleting redemption
Validate & Redeem coupons
Access Token validation&redeemCoupon validationCoupon redemption
currency
Access TokenCreating a new currencyRetrieving all currenciesRetrieving currency by codeUpdating currency by codeDeleting currencyCreating a new exchange rateRetrieving all exchange ratesRetrieving exchange rate by codeUpdating exchange rate by codeDeleting exchange rate
customer-management
legal-entities
Creating legal entityRetrieving all legal entitiesRetrieving a legal entityUpdate a legal entityDelete a legal entity
contacts
Creating contactRetrieving all contactsRetrieving a contactUpdate a contactDelete a contact
contact-assignments
Creating contact assignmentRetrieving all contact assignmentsRetrieving a contact assignmentUpdate a contact assignmentDelete a contact assignment
locations
Creating locationRetrieving all locationsRetrieving a locationUpdate a locationDelete a location
Access Token
media
Access TokenCREATE public BLOB assetPUT public BLOB asseGET assetGET all assetsDOWNLOAD assetDELETE asset
order
salesorders
Retrieving orders (by a merchant)Creating new order (by a merchant)Retrieving number of ordersDeleting order (by a merchant)Updating order partially (by a merchant)Updating order (by a merchant)Retrieving order by ID (by a merchant)Recalculating number of entriesRetrieving status transitions for the specific order (by a merchant)Updating order status (by a merchant)
orders
Retrieving a list of orders (for customer)Creating new order (by a customer)Retrieving details about an order (by a customer)Updating the status of the specific order (by a customer)Retrieving status transitions for the specific order (by a customer)
Access Token CopyRetrieving an anonymous tokenLogging in the customer
price
price model
Create new price modelGet price modelGet all price modelsUpdate price modelDelete price model
matching
Matching prices for session contextCalculate gross price between countries
prices management
Creating priceRetrieving pricesRetrieving price by idUpdating price by idDeleting price by id
Access Token
product
product templates
Access TokenCreating a new product templateGetting a list of product templatesGetting a single product templateUpdating a product templateDeleting a product templateCreating product with templateRetrieving a product's details
products
Access TokenCreating a bundle productCreating a variant productRetrieving a productRetrieving all productsUpdating a product's detailsUpdating a product's detailsSearching for products by YRNsDeleting a product
quote
Quote management
Retrieving quotesCreating a quote from cartRetrieving a single quotePartially updating a quote - change customer of the quoteDeleting a quote
Quote history
Retrieving quote history
Quote pdf
Creating a quote PDF
Quote reason
Creating a reason for changing the quote statusRetrieving the reasons for changing the quote statusDeleting the reason for changing the quote statusUpdating the reason for changing the quote statusRetrieving the reason for changing the quote status
Access Token
returns
Prerequisites
Retrieve first anonymous tokenCreate a new customerLog in the customerAccess Token for an employee
Manage returns
Creating a return as a customerRetrieving all returns for the customerUpdating return as a customerUpdating return as an employeeRetrieving return as a customerRetrieving return as an employeeDeleting return as a customerDeleting return as an employee
reward-points
Customer Reedem Options
Retrieve Redeem Options
Reedem Options Management
Creating redeem option (percentage coupon)
Signed-In Customer Reward Points
Retrieving reward points of a signed-in customerRetrieving a reward points summary of a signed-in customerRedeeming a logged-in customer's reward points for a coupon code
Reward Points Management
Retrieving reward points for all customersRetrieving reward points for a customerCreating a new reward points entry for a customerDeleting reward points of a customerRetrieving a reward points summary for a single customerAdding reward points for a customerRedeeming reward points of a customer
Access Token
supplier
suppliers
Creating a supplier with custom idRetrieving suppliersRetrievng supplier by idUpdating supplierDeleting supplier
psrelations
Creating PSrelationRetrieving psrelationsRetrieving PSrelation by idRetrieving PSrelation by product idSearching PSrelationsUpdating PSrelationDeleting PSrelation
Access Token
tax
Access TokenCreating a new tax configurationRetrieving all tax configurationsRetrieving tax configuration by country codeUpdating tax configuration by country codeDeleting tax configuration by country codeCalculation commands gross to gross (two countries)
unit-handling
Access TokenCreating a unit with language mapRetrieving a localized unitRetrieving a unit with language mapRetrieving unit typesUpdating localized unitRetrieving unitsRetrieving units by filtersRetrieving units by filters with sortingConverting unit commandsConverting factor commandDeleting a unitDeleting units
Introduction
brand
Access tokenCreating a brandRetrieving brands with existing field "localizedDescription"Retrieving brands with version > 1Retrieving all brandsRetrieving a brand with localized fields in en lang onlyUpdating a brandDeleting a brand
cart
prerequisites
Retrieving an anonymous tokenCreating a new customerLogging in the customer - retrieving saasToken and customer access tokenRetrieving access tokenCreating a second productCreating new price model (BASIC)Retrieving price modelCreating price for second product
cart
Creating a new cart as a logged customerRetrieving a cart's details by IDRetrieving lead time and non-delivery times for a cartRetrieving a cart's details by criteriaUpdating a cartDeleting a cartChanging a cart's siteMerging carts
items
Adding a product to cart CopyRetrieving a cart itemRetrieving all products added to a cartUpdating a cart itemRemoving an item from cartDeleting all products added to a cart
discounts
Applying a discount to cartRemoving all discounts from cartRemoving a discount from cart
catalog
Access tokenCreating catalog with language mapUpdating catalog with language mapPartially update a catalogRetrieving catalog by idRetrieving filtered or sorted list of catalogsRetrieving catalogs by filter with total countRetrieving catalogs containing categoryRemoving catalog
category
Access TokenCreating a new subcategoryRetrieving a category’s detailsRetrieving a list of categoriesUpdating a categoryUpdating a categoryRetrieving a list of categories for which the reference id is assignedRetrieving parents for a categoryRetrieving subcategories for a categoryRetrieving the category treesRetrieving the category treeRetrieving resources assigned to a categoryAssigning a resource to a categoryAdding media (blob) to the categoryDeleting all category assignmentsDeleting a category assignment by reference id
configuration
global configurations
Creating configurationsRetrieving configurationsRetrieving a configurationUpdating a configurationDeleting a configuration
client configurations
Creating client configurationsRetrieving client configurationsRetrieving a client configurationUpdating a client configurationDeleting a client configuration
Access Token
country
Access TokenRetrieving all countriesRetrieving a countryUpdating a countryRetrieving all regionsRetrieving a region
coupon
Manage coupons
Access TokenRetrieving all couponsCreating ABSOLUTE Coupon with MinOrderValue SelectedUserUpdating couponPartial update couponRetrieving a couponSoft deleting a couponRetrieving all coupon redemptionsDeleting redemption
Validate & Redeem coupons
Access Token validation&redeemCoupon validationCoupon redemption
currency
Access TokenCreating a new currencyRetrieving all currenciesRetrieving currency by codeUpdating currency by codeDeleting currencyCreating a new exchange rateRetrieving all exchange ratesRetrieving exchange rate by codeUpdating exchange rate by codeDeleting exchange rate
customer-management
legal-entities
Creating legal entityRetrieving all legal entitiesRetrieving a legal entityUpdate a legal entityDelete a legal entity
contacts
Creating contactRetrieving all contactsRetrieving a contactUpdate a contactDelete a contact
contact-assignments
Creating contact assignmentRetrieving all contact assignmentsRetrieving a contact assignmentUpdate a contact assignmentDelete a contact assignment
locations
Creating locationRetrieving all locationsRetrieving a locationUpdate a locationDelete a location
Access Token
media
Access TokenCREATE public BLOB assetPUT public BLOB asseGET assetGET all assetsDOWNLOAD assetDELETE asset
order
salesorders
Retrieving orders (by a merchant)Creating new order (by a merchant)Retrieving number of ordersDeleting order (by a merchant)Updating order partially (by a merchant)Updating order (by a merchant)Retrieving order by ID (by a merchant)Recalculating number of entriesRetrieving status transitions for the specific order (by a merchant)Updating order status (by a merchant)
orders
Retrieving a list of orders (for customer)Creating new order (by a customer)Retrieving details about an order (by a customer)Updating the status of the specific order (by a customer)Retrieving status transitions for the specific order (by a customer)
Access Token CopyRetrieving an anonymous tokenLogging in the customer
price
price model
Create new price modelGet price modelGet all price modelsUpdate price modelDelete price model
matching
Matching prices for session contextCalculate gross price between countries
prices management
Creating priceRetrieving pricesRetrieving price by idUpdating price by idDeleting price by id
Access Token
product
product templates
Access TokenCreating a new product templateGetting a list of product templatesGetting a single product templateUpdating a product templateDeleting a product templateCreating product with templateRetrieving a product's details
products
Access TokenCreating a bundle productCreating a variant productRetrieving a productRetrieving all productsUpdating a product's detailsUpdating a product's detailsSearching for products by YRNsDeleting a product
quote
Quote management
Retrieving quotesCreating a quote from cartRetrieving a single quotePartially updating a quote - change customer of the quoteDeleting a quote
Quote history
Retrieving quote history
Quote pdf
Creating a quote PDF
Quote reason
Creating a reason for changing the quote statusRetrieving the reasons for changing the quote statusDeleting the reason for changing the quote statusUpdating the reason for changing the quote statusRetrieving the reason for changing the quote status
Access Token
returns
Prerequisites
Retrieve first anonymous tokenCreate a new customerLog in the customerAccess Token for an employee
Manage returns
Creating a return as a customerRetrieving all returns for the customerUpdating return as a customerUpdating return as an employeeRetrieving return as a customerRetrieving return as an employeeDeleting return as a customerDeleting return as an employee
reward-points
Customer Reedem Options
Retrieve Redeem Options
Reedem Options Management
Creating redeem option (percentage coupon)
Signed-In Customer Reward Points
Retrieving reward points of a signed-in customerRetrieving a reward points summary of a signed-in customerRedeeming a logged-in customer's reward points for a coupon code
Reward Points Management
Retrieving reward points for all customersRetrieving reward points for a customerCreating a new reward points entry for a customerDeleting reward points of a customerRetrieving a reward points summary for a single customerAdding reward points for a customerRedeeming reward points of a customer
Access Token
supplier
suppliers
Creating a supplier with custom idRetrieving suppliersRetrievng supplier by idUpdating supplierDeleting supplier
psrelations
Creating PSrelationRetrieving psrelationsRetrieving PSrelation by idRetrieving PSrelation by product idSearching PSrelationsUpdating PSrelationDeleting PSrelation
Access Token
tax
Access TokenCreating a new tax configurationRetrieving all tax configurationsRetrieving tax configuration by country codeUpdating tax configuration by country codeDeleting tax configuration by country codeCalculation commands gross to gross (two countries)
unit-handling
Access TokenCreating a unit with language mapRetrieving a localized unitRetrieving a unit with language mapRetrieving unit typesUpdating localized unitRetrieving unitsRetrieving units by filtersRetrieving units by filters with sortingConverting unit commandsConverting factor commandDeleting a unitDeleting units
Homereward-pointsSigned-In Customer Reward Points

Signed-In Customer Reward Points

Number of APIs: 3

  1. Retrieving reward points of a signed-in customer GET {{api-url}}/reward-points/public/customer

  2. Retrieving a reward points summary of a signed-in customer GET {{api-url}}/reward-points/public/customer/summary

  3. Redeeming a logged-in customer's reward points for a coupon code POST {{api-url}}/reward-points/public/customer/redeem?siteCode=main

Previous
Creating redeem option (percentage coupon)
Next
Retrieving reward points of a signed-in customer