Qodex.ai
Qodex.ai
Introduction
01 - Authenticate
Authenticate
02 - Create Product and add prices
add Product 581
createExampleProductAndStoreProductIdretrieveExampleProductupdateExampleProductdeleteExampleProduct
add Product 5839249
createExampleProduct2updateExampleProduct2deleteExampleProduct2
Add Images
Create Cloudinary ImageAdd external image to product
getAllProductsAndStoreFirstInProductIdfilterProductsGet SalesOrders
03 - Add prices
get prices for exampleProduct and store first in var priceIdadd prices for Product Xdelete price in var priceId
04 - Create a customer
Anonymous Login CopyCreating a new customerRetrieving all customersLogging in as this customerChange Email Address
05 - add to cart as a customer
Anonymous Login CopyCreating a new cartRetrieving a cart's details by criteriaCheck AvailabilityAdding a product to cart
05b - add to cart as an admin-user
Creating a new cartRetrieving a cart's details by criteriaAdding a product to cart
06 - Categories
Creating a new root categoryCreating a new subcategoryAssigning a resource to a categoryAssigning a resource to a categoryCreating a new localized catalog Copy
07 - Checkout Standalone Collection
Prepare Products
Authenticate CopySetup TaxescreateExampleProductAndStoreProductId Copyadd prices for Product
Anonymous LoginCreating a new customerLogging in as this customerCreating a new cartMatch Price By ContextAdding a product to cartRetrieve the cart of this customerTrigger Checkout
08 - Guest Checkout Standalone Collection
Prepare Products
Authenticate CopySetup TaxescreateExampleProductAndStoreProductId Copyadd prices for Product
Anonymous LoginCreating a new cartMatch Price By ContextAdding a product to cartRetrieve the cart of this customerTrigger Checkout
13 - Add prices (deprecated v1)
get prices for exampleProduct and store first in var priceIdadd Price for Product 5839249delete price in var priceId
Algolia Search and Write Keys
Retrieving a client configuration
Configuration Service
{tenant}-configurations-{property Key}
Retrieving a configurationUpdating a configurationDeleting a configuration
{tenant}-configurations
Retrieving configurationsCreating configurations
{tenant}-clients/{client}/configurations-{property Key}
Retrieving a client configurationUpdating a client configurationDeleting a client configuration
{tenant}-clients/{client}/configurations
Retrieving client configurationsCreating client configurations
{tenant}-Check and Change Opt-In-Configuration
Retrieving Double Opt-In ConfigurationUpdating opt-in configurationsCreating new Opt-In Configuration
Import Service
Create Import Job PricesPost Job Data Import Without 581List Import JobsFinish Import JobPost Job Data CopyList Import Job\FINISH import job
Indexing Service
{tenant}-configurations-{provider}
Get configuration by provider nameUpdate configuration by provider nameDelete configuration
{tenant}-configurations
Create a new configurationGet all configurations
{tenant}-public-configurations-{provider}
Get public configuration
{tenant}-public-configurations
Get all public configurations
{tenant}-reindex
Reindex
Media
{tenant}/assets-{assetId}
Retrieve an assetUpdate an assetDelete an assetDownload an asset
{tenant}/assets
Create an assetRetrieve all assets
Order Service
{tenant}-salesorders-{order Id}-transitions
GET tenant-salesorders-order Id-transitionsPOST tenant-salesorders-order Id-transitions
{tenant}-salesorders-{order Id}
GET tenant-salesorders-order IdPUT tenant-salesorders-order IdPATCH tenant-salesorders-order IdDELETE tenant-salesorders-order IdPOST changeDeliveredAmount
{tenant}-salesorders
GET tenant-salesordersPOST tenant-salesordersGET tenant-salesorders-count
{tenant}-orders-{order Id}-transitions
GET tenant-orders-order Id-transitionsPOST tenant-orders-order Id-transitions
{tenant}-orders-{order Id}
GET tenant-orders-order Id
{tenant}-orders
GET tenant-ordersPOST tenant-orders
Site Service
{tenant}-sites-{site Code}-mixins-{mixin Name}
Retrieving a site mixinDeleting a site mixinFully updating a site mixinPartially updating a site mixin
{tenant}-sites-{site Code}-mixins
Retrieving site mixinsCreating a site mixin
{tenant}-sites-{site Code}
Retrieving a siteFully updating a siteDeleting a sitePartially updating a site
{tenant}-sites
Retrieving sitesCreating a site
{tenant}
Retrieving site codes
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
Introduction
01 - Authenticate
Authenticate
02 - Create Product and add prices
add Product 581
createExampleProductAndStoreProductIdretrieveExampleProductupdateExampleProductdeleteExampleProduct
add Product 5839249
createExampleProduct2updateExampleProduct2deleteExampleProduct2
Add Images
Create Cloudinary ImageAdd external image to product
getAllProductsAndStoreFirstInProductIdfilterProductsGet SalesOrders
03 - Add prices
get prices for exampleProduct and store first in var priceIdadd prices for Product Xdelete price in var priceId
04 - Create a customer
Anonymous Login CopyCreating a new customerRetrieving all customersLogging in as this customerChange Email Address
05 - add to cart as a customer
Anonymous Login CopyCreating a new cartRetrieving a cart's details by criteriaCheck AvailabilityAdding a product to cart
05b - add to cart as an admin-user
Creating a new cartRetrieving a cart's details by criteriaAdding a product to cart
06 - Categories
Creating a new root categoryCreating a new subcategoryAssigning a resource to a categoryAssigning a resource to a categoryCreating a new localized catalog Copy
07 - Checkout Standalone Collection
Prepare Products
Authenticate CopySetup TaxescreateExampleProductAndStoreProductId Copyadd prices for Product
Anonymous LoginCreating a new customerLogging in as this customerCreating a new cartMatch Price By ContextAdding a product to cartRetrieve the cart of this customerTrigger Checkout
08 - Guest Checkout Standalone Collection
Prepare Products
Authenticate CopySetup TaxescreateExampleProductAndStoreProductId Copyadd prices for Product
Anonymous LoginCreating a new cartMatch Price By ContextAdding a product to cartRetrieve the cart of this customerTrigger Checkout
13 - Add prices (deprecated v1)
get prices for exampleProduct and store first in var priceIdadd Price for Product 5839249delete price in var priceId
Algolia Search and Write Keys
Retrieving a client configuration
Configuration Service
{tenant}-configurations-{property Key}
Retrieving a configurationUpdating a configurationDeleting a configuration
{tenant}-configurations
Retrieving configurationsCreating configurations
{tenant}-clients/{client}/configurations-{property Key}
Retrieving a client configurationUpdating a client configurationDeleting a client configuration
{tenant}-clients/{client}/configurations
Retrieving client configurationsCreating client configurations
{tenant}-Check and Change Opt-In-Configuration
Retrieving Double Opt-In ConfigurationUpdating opt-in configurationsCreating new Opt-In Configuration
Import Service
Create Import Job PricesPost Job Data Import Without 581List Import JobsFinish Import JobPost Job Data CopyList Import Job\FINISH import job
Indexing Service
{tenant}-configurations-{provider}
Get configuration by provider nameUpdate configuration by provider nameDelete configuration
{tenant}-configurations
Create a new configurationGet all configurations
{tenant}-public-configurations-{provider}
Get public configuration
{tenant}-public-configurations
Get all public configurations
{tenant}-reindex
Reindex
Media
{tenant}/assets-{assetId}
Retrieve an assetUpdate an assetDelete an assetDownload an asset
{tenant}/assets
Create an assetRetrieve all assets
Order Service
{tenant}-salesorders-{order Id}-transitions
GET tenant-salesorders-order Id-transitionsPOST tenant-salesorders-order Id-transitions
{tenant}-salesorders-{order Id}
GET tenant-salesorders-order IdPUT tenant-salesorders-order IdPATCH tenant-salesorders-order IdDELETE tenant-salesorders-order IdPOST changeDeliveredAmount
{tenant}-salesorders
GET tenant-salesordersPOST tenant-salesordersGET tenant-salesorders-count
{tenant}-orders-{order Id}-transitions
GET tenant-orders-order Id-transitionsPOST tenant-orders-order Id-transitions
{tenant}-orders-{order Id}
GET tenant-orders-order Id
{tenant}-orders
GET tenant-ordersPOST tenant-orders
Site Service
{tenant}-sites-{site Code}-mixins-{mixin Name}
Retrieving a site mixinDeleting a site mixinFully updating a site mixinPartially updating a site mixin
{tenant}-sites-{site Code}-mixins
Retrieving site mixinsCreating a site mixin
{tenant}-sites-{site Code}
Retrieving a siteFully updating a siteDeleting a sitePartially updating a site
{tenant}-sites
Retrieving sitesCreating a site
{tenant}
Retrieving site codes
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
HomeConfiguration Service{tenant}-configurations-{property Key}

{tenant}-configurations-{property Key}

Number of APIs: 3

  1. Retrieving a configuration GET {{baseUrl}}/configuration/{{tenant}}/configurations/customer.deletion.redirecturl

  2. Updating a configuration PUT {{baseUrl}}/configuration/{{tenant}}/configurations/:propertyKey

  3. Deleting a configuration DELETE {{baseUrl}}/configuration/{{tenant}}/configurations/:propertyKey

Previous
Configuration Service
Next
Retrieving a configuration