Skip to content

Ecommercen Docs

Main Navigation API Guides Business Flows API Reference Wiki Changelog

Appearance

Sidebar Navigation

Rest/Admin/Me

GET Get the authenticated admin user's own profile

Rest/Admin/Role

GET List available admin roles

GET Get a single role by ID

GET Role endpoint metadata

Rest/Admin/User

GET List admin users

POST Create a new admin user

GET Get a single admin user

POST Update an admin user

DELETE Soft-delete an admin user

GET Get a single admin user by filters

POST Restore a soft-deleted admin user

POST Admin reset another user's password

POST Change own password (any backend user)

Rest/Ai/ContentGeneration

GET Get AI content generation collection

POST Create new AI content generation entry

GET Get a single AI content generation entry

POST Update an existing AI content generation entry

DELETE Delete an AI content generation entry

GET Get a single AI content generation entry based on filters

Rest/Ai/Position

GET Get AI position collection

POST Create new AI position

GET Get a single AI position

POST Update an existing AI position

DELETE Delete an AI position

GET Get a single AI position based on filters

Rest/Auth/Admin

POST Authenticate as an admin user

POST Refresh an admin access token

Rest/Auth/Customer

POST Authenticate as a customer

POST Refresh a customer access token

POST Register a new customer account

POST Request a password reset email

POST Consume a reset token and set a new password

Rest/Cart/Cart

GET Get current cart with items and totals

DELETE Clear entire cart

POST Add an item to the cart

POST Update item quantity

DELETE Remove an item from the cart

POST Apply a coupon code to the cart

DELETE Remove coupon from the cart

POST Merge a guest cart into the authenticated customer cart

Rest/Checkout

POST Calculate available shipping options

POST Validate a coupon code against the current cart

POST Calculate full checkout totals (items + shipping + coupon)

POST Place an order from the current cart

GET Get payment status for an order

POST Verify and confirm payment with the gateway after customer returns

GET List payment methods available to a headless storefront

POST Cancel a PENDING order (customer-initiated abort)

Rest/Cms/Blog/Article

GET Get blog article collection

POST Create new blog article

GET Get a single blog article by ID

POST Update an existing blog article

DELETE Delete a blog article

GET Get a single blog article based on filters

Rest/Cms/Blog/Author

GET Get blog author collection

POST Create new blog author

GET Get a single blog author by ID

POST Update an existing blog author

DELETE Delete a blog author

GET Get a single blog author based on filters

Rest/Cms/Blog/Category

GET Get blog category collection

POST Create new blog category

GET Get a single blog category by ID

POST Update an existing blog category

DELETE Delete a blog category

GET Get a single blog category based on filters

Rest/Cms/Blog/Comment

GET Get blog comment collection

POST Create new blog comment

GET Get a single blog comment by ID

POST Update an existing blog comment

DELETE Delete a blog comment

GET Get a single blog comment based on filters

Rest/Cms/Blog/Tag

GET Get blog tag collection

POST Create new blog tag

GET Get a single blog tag by ID

POST Update an existing blog tag

DELETE Delete a blog tag

GET Get a single blog tag based on filters

Rest/Cms/Builder

GET Get builder block collection

POST Create a new builder block

GET Get a single builder block by ID

POST Update an existing builder block

DELETE Delete a builder block (nullifies FK references in 7 *_mui tables, then deletes the row)

GET Get a single builder block by filters

Rest/Cms/ContactEmail

GET Get contact email collection

POST Create new contact email

GET Get a single contact email by ID

POST Update an existing contact email

DELETE Delete a contact email

GET Get a single contact email based on filters

Rest/Cms/Cookie

GET Get cookie collection

POST Create new cookie

GET Get a single cookie entry by ID

POST Update an existing cookie

DELETE Delete a cookie

GET Get a single cookie entry based on filters

Rest/Cms/Document

GET Get document collection

POST Create new document

GET Get a single document by ID

POST Update an existing document

DELETE Delete a document

GET Get a single document based on filters

Rest/Cms/Offer

GET Get offer collection

POST Create new offer

GET Get a single offer by ID

POST Update an existing offer

DELETE Delete an offer

GET Get a single offer based on filters

Rest/Cms/OfferCategory

GET Get offer category collection

POST Create new offer category

GET Get a single offer category by ID

POST Update an existing offer category

DELETE Delete an offer category

GET Get a single offer category based on filters

Rest/Cms/Page

GET Get page collection

POST Create new page

GET Get a single page by ID

POST Update an existing page

DELETE Delete a page

GET Get a single page based on filters

Rest/Cms/Subcontent

GET Get subcontent collection

POST Create new subcontent

GET Get a single subcontent by ID

POST Update an existing subcontent

DELETE Delete a subcontent

GET Get a single subcontent based on filters

Rest/Cms/Video

GET Get video collection

POST Create new video

GET Get a single video by ID

POST Update an existing video

DELETE Delete a video

GET Get a single video based on filters

Rest/Country/Country

GET Get country collection

POST Create new country

GET Get a single country by alpha-2 code

POST Update an existing country

DELETE Delete a country

GET Get a single country based on filters

Rest/Country/County

GET Get country collection

POST Create new county

GET Get a single county by alpha-2 code

POST Update an existing county

DELETE Delete a county

GET Get a single county based on filters

Rest/Currency/Currency

GET Get currency collection

POST Create new currency

GET Get a single currency by ID

POST Update an existing currency

DELETE Delete a currency

GET Get a single currency based on filters

Rest/Customer/Customer

GET Get customer collection

POST Create a new customer (admin)

GET Get a single customer by ID

POST Update an existing customer (admin)

DELETE Delete a customer (admin)

GET Get a single customer based on filters

GET Get the authenticated customer's own profile

POST Update the authenticated customer's own profile

POST Change the authenticated customer's password

Rest/Customer/CustomerCampaign

GET Get customer campaign collection

POST Create new customer campaign

GET Get a single customer campaign by ID

POST Update an existing customer campaign

DELETE Delete a customer campaign

GET Get a single customer campaign based on filters

Rest/Customer/CustomerMessageHistory

GET Get customer message history collection

POST Create new customer message history entry

GET Get a single customer message history entry by ID

POST Update an existing customer message history entry

DELETE Delete a customer message history entry

GET Get a single customer message history entry based on filters

Rest/Customer/CustomerReview

GET Get customer review collection

POST Create new customer review

GET Get a single customer review by ID

POST Update an existing customer review

DELETE Delete a customer review

GET Get a single customer review based on filters

Rest/Customer/CustomerSmsMarketing

GET Get customer SMS marketing collection

POST Create new customer SMS marketing entry

GET Get a single customer SMS marketing entry by ID

POST Update an existing customer SMS marketing entry

DELETE Delete a customer SMS marketing entry

GET Get a single customer SMS marketing entry based on filters

Rest/Customer/CustomerTag

GET Get customer tag collection

POST Create new customer tag

GET Get a single customer tag by ID

POST Update an existing customer tag

DELETE Delete a customer tag

GET Get a single customer tag based on filters

Rest/Event/Event

GET Get event collection

POST Create new event

GET Get a single event by ID

POST Update an existing event

DELETE Delete an event

GET Get a single event based on filters

Rest/Event/EventCategory

GET Get event category collection

POST Create new event category

GET Get a single event category by ID

POST Update an existing event category

DELETE Delete an event category

GET Get a single event category based on filters

Rest/Map/Location

GET Get location collection

POST Create new location

GET Get a single location by ID

POST Update an existing location

DELETE Delete a location

GET Get a single location based on filters

Rest/Map/Map

GET Get map collection

POST Create new map

GET Get a single map by ID

POST Update an existing map

DELETE Delete a map

GET Get a single map based on filters

Rest/Marketplace/IrisOrder

GET Get Iris order collection

GET Get a single Iris order by ID

GET Get a single Iris order based on filters

Rest/Marketplace/JccOrder

GET Get JCC order collection

GET Get a single JCC order by ID

GET Get a single JCC order based on filters

Rest/Marketplace/PublicLineItem

GET Get Public marketplace line item collection

GET Get a single Public marketplace line item by ID

GET Get a single Public marketplace line item based on filters

Rest/Marketplace/PublicOrder

GET Get Public marketplace order collection

GET Get a single Public marketplace order by ID

GET Get a single Public marketplace order based on filters

Rest/Marketplace/ShopflixLineItem

GET Get Shopflix line item collection

GET Get a single Shopflix line item by ID

GET Get a single Shopflix line item based on filters

Rest/Marketplace/ShopflixOrder

GET Get Shopflix order collection

GET Get a single Shopflix order by ID

GET Get a single Shopflix order based on filters

Rest/Marketplace/SkroutzInvoiceDetail

GET Get Skroutz invoice detail collection

GET Get a single Skroutz invoice detail by ID

GET Get a single Skroutz invoice detail based on filters

Rest/Marketplace/SkroutzLineItem

GET Get Skroutz line item collection

GET Get a single Skroutz line item by ID

GET Get a single Skroutz line item based on filters

Rest/Marketplace/SkroutzOrder

GET Get Skroutz order collection

GET Get a single Skroutz order by code

GET Get a single Skroutz order based on filters

Rest/Order/Basket

GET Get basket collection

GET Get a single basket item by ID

GET Get a single basket item based on filters

Rest/Order/DhlVoucher

GET Get DHL voucher collection

GET Get a single DHL voucher by ID

GET Get a single DHL voucher based on filters

Rest/Order/GiftCardOrder

GET Get gift card order collection

POST Create new gift card order

GET Get a single gift card order by ID

POST Update an existing gift card order

DELETE Delete a gift card order

GET Get a single gift card order based on filters

Rest/Order/Note

GET Get note collection

POST Create new note

GET Get a single note by ID

POST Update an existing note

DELETE Delete a note

GET Get a single note based on filters

Rest/Order/Order

GET Get order collection

POST Create a new order (admin)

GET Get a single order by ID

POST Update an existing order (admin)

DELETE Delete an order (admin)

GET Get a single order based on filters

POST Request cancellation of an order (customer-scoped)

GET Get order tracking information

Rest/Order/OrderTag

GET Get order tag collection

POST Create new order tag

GET Get a single order tag by ID

POST Update an existing order tag

DELETE Delete an order tag

GET Get a single order tag based on filters

Rest/Order/SmartPoint

GET Get smart point collection

GET Get a single smart point by ID

GET Get a single smart point based on filters

Rest/Order/Store

GET Get store collection

POST Create new store

GET Get a single store by ID

POST Update an existing store

DELETE Delete a store

GET Get specific store based on filters and sort

Rest/Order/Vat

GET Get vat collection

POST Create new vat

GET Get a single vat by ID

POST Update an existing vat

DELETE Delete a vat

GET Get a single vat based on filters

Rest/Plus/Audience

GET Get audience collection

POST Create new audience

GET Get a single audience by ID

POST Update an existing audience

DELETE Delete an audience

GET Get a single audience based on filters

Rest/Plus/AudienceCriteria

GET Get audience criteria collection

POST Create new audience criteria

GET Get a single audience criteria by ID

POST Update an existing audience criteria

DELETE Delete an audience criteria

GET Get a single audience criteria based on filters

Rest/Product/Attribute

GET Get attribute collection

POST Create new attribute

GET Get a single attribute by ID

POST Update an existing attribute

DELETE Delete an attribute

GET Get a single attribute based on filters

Rest/Product/AttributeGroup

GET Get attribute group collection

POST Create new attribute group

GET Get a single attribute group by ID

POST Update an existing attribute group

DELETE Delete an attribute group

GET Get a single attribute group based on filters

Rest/Product/Badge

GET Get badge collection

POST Create new badge

GET Get a single badge by ID

POST Update an existing badge

DELETE Delete a badge

GET Get a single badge based on filters

Rest/Product/Barcode

GET Get barcode collection

POST Create new barcode

GET Get a single barcode by ID

POST Update an existing barcode

DELETE Delete a barcode

GET Get a single barcode based on filters

Rest/Product/Bundle

GET Get bundle collection

POST Create new bundle

GET Get a single bundle by ID

POST Update an existing bundle

DELETE Delete a bundle

GET Get a single bundle based on filters

Rest/Product/BundleBuilderReference

GET Get bundle builder reference collection

POST Create new bundle builder reference

GET Get a single bundle builder reference by ID

POST Update an existing bundle builder reference

DELETE Delete a bundle builder reference

GET Get a single bundle builder reference based on filters

Rest/Product/BundleCriteria

GET Get bundle criteria collection

POST Create new bundle criteria

GET Get a single bundle criterion by ID

POST Update an existing bundle criteria

DELETE Delete a bundle criteria

GET Get a single bundle criterion based on filters

Rest/Product/BundleCriteriaReference

GET Get bundle criteria reference collection

POST Create new bundle criteria reference

GET Get a single bundle criteria reference by ID

POST Update an existing bundle criteria reference

DELETE Delete a bundle criteria reference

GET Get a single bundle criteria reference based on filters

Rest/Product/BundleDisplay

GET Get bundle display message collection

POST Create new bundle display

GET Get a single bundle display message by ID

POST Update an existing bundle display

DELETE Delete a bundle display

GET Get a single bundle display message based on filters

Rest/Product/BundlePricing

GET Get bundle pricing collection

POST Create new bundle pricing

GET Get a single bundle pricing rule by ID

POST Update an existing bundle pricing

DELETE Delete a bundle pricing

GET Get a single bundle pricing rule based on filters

Rest/Product/Category

GET Get category collection

POST Create new category

GET Get a single category by ID

POST Update an existing category

DELETE Delete a category

GET Get a single category based on filters

Rest/Product/CustomizationSchema

GET Get customization schema collection

POST Create new customization schema

GET Get a single customization schema by ID

POST Update an existing customization schema

DELETE Delete a customization schema

GET Get a single customization schema based on filters

Rest/Product/Download

GET Get product download collection

POST Create new download

GET Get a single product download by ID

POST Update an existing download

DELETE Delete a download

GET Get a single product download based on filters

Rest/Product/Line

GET Get line collection

POST Create new line

GET Get a single line by ID

POST Update an existing line

DELETE Delete a line

GET Get a single line resource based on filters and sorts

Rest/Product/Media

GET Get media collection

POST Create new media

GET Get a single media by ID

POST Update an existing media

DELETE Delete a media

GET Get a single media based on filters

Rest/Product/PriceTracking

GET Get price tracking collection

GET Get a single price tracking record by ID

GET Get a single price tracking record based on filters

GET Get the price-history graph payload for a single product (Omnibus-compliant)

GET Get the price-history graph payload for multiple products in a single call

Rest/Product/Product

GET Get product collection

POST Create new product

GET Get a single product by ID

POST Update an existing product

DELETE Delete a product

GET Get a single product based on filters

Rest/Product/ProductCode

GET Get product code collection

POST Create new product code

GET Get a single product code by ID

POST Update an existing product code

DELETE Delete a product code

GET Get a single product code based on filters

Rest/Product/ProductCodeAttribute

GET Get product code attribute collection

POST Create new product code attribute

GET Get a single product code attribute by ID

POST Update an existing product code attribute

DELETE Delete a product code attribute

GET Get a single product code attribute based on filters

Rest/Product/ProductList

GET Get product list collection

POST Create new product list

GET Get a single product list by ID

POST Update an existing product list

DELETE Delete a product list

GET Get a single product list based on filters

Rest/Product/ProductListGroup

GET Get product list group collection

POST Create new product list group

GET Get a single product list group by ID

POST Update an existing product list group

DELETE Delete a product list group

GET Get a single product list group based on filters

Rest/Product/ProductListProductLp

GET Get product list product link collection

POST Create new product list product lp

GET Get a single product list product link by ID

POST Update an existing product list product lp

DELETE Delete a product list product lp

GET Get a single product list product link based on filters

Rest/Product/ProductMeta

GET Get product meta collection

POST Create new product meta

GET Get a single product meta by ID

POST Update an existing product meta

DELETE Delete a product meta

GET Get a single product meta based on filters

Rest/Product/Promo

GET Get promo collection

POST Create new promo

GET Get a single promo by ID

POST Update an existing promo

DELETE Delete a promo

GET Get a single promo resource based on filters and sorts

Rest/Product/Related

GET Get related products collection

POST Create new related

GET Get a single related product entry by ID

POST Update an existing related

DELETE Delete a related

GET Get a single related product entry based on filters

Rest/Product/RelatedGroup

GET Get related group collection

POST Create new related group

GET Get a single related group by ID

POST Update an existing related group

DELETE Delete a related group

GET Get a single related group based on filters

Rest/Product/Review

GET Get product review collection

POST Create new review

GET Get a single product review by ID

POST Update an existing review

DELETE Delete a review

GET Get a single product review based on filters

Rest/Product/Shelfcode

GET Get shelfcode collection

POST Create new shelfcode

GET Get a single shelfcode by ID

POST Update an existing shelfcode

DELETE Delete a shelfcode

GET Get a single shelfcode based on filters

Rest/Product/Supplier

GET Get supplier collection

POST Create new supplier

GET Get a single supplier by ID

POST Update an existing supplier

DELETE Delete a supplier

GET Get supplier resource based on filters and sorts

Rest/Product/Tag

GET Get tag collection

POST Create new tag

GET Get a single tag by ID

POST Update an existing tag

DELETE Delete a tag

GET Get a single tag based on filters and sort

Rest/Product/TagCategory

GET Get tag category collection

POST Create new tag category

GET Get a single tag category by ID

POST Update an existing tag category

DELETE Delete a tag category

GET Get a single tag category based on filters

Rest/Product/Variation

GET Get variation collection

POST Create new variation

GET Get a single variation by ID

POST Update an existing variation

DELETE Delete a variation

GET Get a single variation based on filters and sort

Rest/Product/VariationGroup

GET Get variation group collection

POST Create new variation group

GET Get a single variation group by ID

POST Update an existing variation group

DELETE Delete a variation group

GET Get a single variation group based on filters and sort

Rest/Product/VariationValue

GET Get variation value collection

POST Create new variation value

GET Get a single variation value by ID

POST Update an existing variation value

DELETE Delete a variation value

GET Get a single variation value based on filters and sort

Rest/Product/Vendor

GET Get vendor collection

POST Create new vendor

GET Get a single vendor by ID

POST Update an existing vendor

DELETE Delete a vendor

GET Get a single vendor based on filters

Rest/Product/WaitingList

GET Get waiting list collection

POST Create new waiting list

GET Get a single waiting list entry by ID

POST Update an existing waiting list

DELETE Delete a waiting list

GET Get a single waiting list entry based on filters

Rest/Product/Wishlist

GET Get wishlist collection

POST Add a product to the customer wishlist (customer-scoped)

GET Get a single wishlist entry by ID

POST Update a wishlist entry (customer-scoped)

DELETE Remove a product from the customer wishlist (customer-scoped)

GET Get a single wishlist entry based on filters

Rest/Promotion/Coupon

GET Get coupon collection

POST Create new coupon

GET Get a single coupon by ID

POST Update an existing coupon

DELETE Delete a coupon

GET Get a single coupon based on filters

Rest/Promotion/CouponCode

GET Get coupon code collection

POST Create new coupon code

GET Get a single coupon code by ID

POST Update an existing coupon code

DELETE Delete a coupon code

GET Get a single coupon code based on filters

Rest/Promotion/CouponProduct

GET Get coupon product restriction collection

POST Create new coupon product restriction

GET Get a single coupon product restriction by ID

POST Update an existing coupon product restriction

DELETE Delete a coupon product restriction

GET Get a single coupon product restriction based on filters

Rest/Promotion/CouponRule

GET Get coupon rule collection

POST Create new coupon rule

GET Get a single coupon rule by ID

POST Update an existing coupon rule

DELETE Delete a coupon rule

GET Get a single coupon rule based on filters

Rest/Promotion/CouponVendor

GET Get coupon vendor restriction collection

POST Create new coupon vendor restriction

GET Get a single coupon vendor restriction by ID

POST Update an existing coupon vendor restriction

DELETE Delete a coupon vendor restriction

GET Get a single coupon vendor restriction based on filters

Rest/Promotion/Gift

GET Get gift collection

POST Create new gift

GET Get a single gift by ID

POST Update an existing gift

DELETE Delete a gift

GET Get a single gift based on filters

Rest/Promotion/GiftChoice

GET Get gift choice collection

POST Create new gift choice

GET Get a single gift choice by ID

POST Update an existing gift choice

DELETE Delete a gift choice

GET Get a single gift choice based on filters

Rest/Promotion/GiftRequirement

GET Get gift requirement collection

POST Create new gift requirement

GET Get a single gift requirement by ID

POST Update an existing gift requirement

DELETE Delete a gift requirement

GET Get a single gift requirement based on filters

Rest/Seo/CustomMetaTag

GET Get custom meta tag collection

POST Create a new custom meta tag

GET Get a single custom meta tag by ID

POST Update an existing custom meta tag

DELETE Delete a custom meta tag

GET Get a single custom meta tag by filters (typically by URL)

Rest/Seo/DefaultMetaTag

GET Get default meta tag collection

POST Create new default meta tag

GET Get a single default meta tag by ID

POST Update an existing default meta tag

DELETE Delete a default meta tag

GET Get a single default meta tag based on filters

Rest/Slider/Group

GET Get slider group collection

POST Create new slider group

GET Get a single slider group by ID

POST Update an existing slider group

DELETE Delete a slider group

GET Get a single slider group based on filters

Rest/Slider/Slide

GET Get slide collection

POST Create new slide

GET Get a single slide by ID

POST Update an existing slide

DELETE Delete a slide

GET Get a single slide based on filters

Rest/Slider/Slider

GET Get slider collection

POST Create new slider

GET Get a single slider by ID

POST Update an existing slider

DELETE Delete a slider

GET Get a single slider based on filters

Rest/Transporter/AsapServices

GET Get the live ASAP service list for a transporter

Rest/Transporter/CountyAvailability

GET Get transporter county availability collection

POST Create new transporter county availability entry

DELETE Delete a transporter county availability entry

GET Get a single transporter county availability entry based on filters

Rest/Transporter/DhlRates

GET Get the live DHL rate list for a transporter

Rest/Transporter/OptionPricing

GET Get transporter option pricing collection

POST Create new transporter option pricing entry

DELETE Delete a transporter option pricing entry

GET Get a single transporter option pricing entry based on filters

Rest/Transporter/PostAvailability

GET Get transporter post availability collection

POST Create new transporter post availability entry

DELETE Delete a transporter post availability entry

GET Get a single transporter post availability entry based on filters

Rest/Transporter/PostPricing

GET Get transporter post pricing collection

POST Create new transporter post pricing entry

DELETE Delete a transporter post pricing entry

GET Get a single transporter post pricing entry based on filters

Rest/Transporter/Pricing

GET Get transporter pricing collection

POST Create new transporter pricing entry

DELETE Delete a transporter pricing entry

GET Get a single transporter pricing entry based on filters

Rest/Transporter/PublicMapping

GET Get public transporter mapping collection

POST Create new transporter public mapping

DELETE Delete a transporter public mapping

GET Get a single public transporter mapping based on filters

Rest/Transporter/Setting

GET Get transporter settings collection

POST Create new transporter setting

DELETE Delete a transporter setting

GET Get a single transporter setting based on filters

Rest/Transporter/SmartPoint

GET Get the live pickup-point catalog for a transporter

Rest/Transporter

GET Get transporter collection

POST Create new transporter

GET Get a single transporter by ID

POST Update an existing transporter

DELETE Delete a transporter

GET Get a single transporter based on filters

Create new gift choice

POST

/rest/v1/promotion/gift-choice

Request Body

application/json

JSON

"string"

Responses

Gift choice created successfully

Content-Type

application/json

JSON

"string"

POST

/rest/v1/promotion/gift-choice

Playground

Body

Samples

Powered by VitePress OpenAPI

Last updated:

Pager

Previous page GET Get gift choice collection

Next page GET Get a single gift choice by ID