EXPERIMENTAL
Explore
0.0.0
OAS3
Authorize
AdminUserToken
POST
/api
/v2
/admin
/authentication-token
Get JWT token to login.
Address
GET
/api
/v2
/admin
/addresses
/{id}
Retrieves a Address resource.
GET
/api
/v2
/shop
/addresses
Retrieves the collection of Address resources.
POST
/api
/v2
/shop
/addresses
Creates a Address resource.
GET
/api
/v2
/shop
/addresses
/{id}
Retrieves a Address resource.
DELETE
/api
/v2
/shop
/addresses
/{id}
Removes the Address resource.
PUT
/api
/v2
/shop
/addresses
/{id}
Replaces the Address resource.
Adjustment
GET
/api
/v2
/admin
/adjustments
/{id}
Retrieves a Adjustment resource.
GET
/api
/v2
/admin
/order-items
/{id}
/adjustments
Retrieves the collection of Adjustment resources.
GET
/api
/v2
/shop
/adjustments
/{id}
Retrieves a Adjustment resource.
GET
/api
/v2
/shop
/orders
/{tokenValue}
/adjustments
Retrieves the collection of Adjustment resources.
GET
/api
/v2
/shop
/orders
/{tokenValue}
/items
/{items}
/adjustments
Retrieves the collection of Adjustment resources.
Administrator
GET
/api
/v2
/admin
/administrators
Retrieves the collection of Administrator resources.
POST
/api
/v2
/admin
/administrators
Creates a Administrator resource.
GET
/api
/v2
/admin
/administrators
/{id}
Retrieves a Administrator resource.
PUT
/api
/v2
/admin
/administrators
/{id}
Replaces the Administrator resource.
DELETE
/api
/v2
/admin
/administrators
/{id}
Removes the Administrator resource.
AvatarImage
POST
/api
/v2
/admin
/avatar-images
Creates a AvatarImage resource.
GET
/api
/v2
/admin
/avatar-images
/{id}
Retrieves a AvatarImage resource.
DELETE
/api
/v2
/admin
/avatar-images
/{id}
Removes the AvatarImage resource.
CatalogPromotionTranslation
GET
/api
/v2
/admin
/catalog-promotion-translations
/{id}
Retrieves a CatalogPromotionTranslation resource.
CatalogPromotion
GET
/api
/v2
/admin
/catalog-promotions
Retrieves the collection of CatalogPromotion resources.
POST
/api
/v2
/admin
/catalog-promotions
Creates a CatalogPromotion resource.
GET
/api
/v2
/admin
/catalog-promotions
/{code}
Retrieves a CatalogPromotion resource.
PUT
/api
/v2
/admin
/catalog-promotions
/{code}
Replaces the CatalogPromotion resource.
DELETE
/api
/v2
/admin
/catalog-promotions
/{code}
Removes the CatalogPromotion resource.
GET
/api
/v2
/shop
/catalog-promotions
/{code}
Retrieves a CatalogPromotion resource.
Channel
GET
/api
/v2
/admin
/channels
Retrieves the collection of Channel resources.
POST
/api
/v2
/admin
/channels
Creates a Channel resource.
GET
/api
/v2
/admin
/channels
/{code}
Use $code to retrieve a channel resource.
PUT
/api
/v2
/admin
/channels
/{code}
Replaces the Channel resource.
GET
/api
/v2
/admin
/channels
/{code}
/shop-billing-data
Retrieves a ShopBillingData resource.
GET
/api
/v2
/shop
/channels
Retrieves the collection of Channel resources.
GET
/api
/v2
/shop
/channels
/{code}
Use $code to retrieve a channel resource.
ShopBillingData
GET
/api
/v2
/admin
/channels
/{code}
/shop-billing-data
Retrieves a ShopBillingData resource.
GET
/api
/v2
/admin
/shop-billing-datas
/{id}
Retrieves a ShopBillingData resource.
Country
GET
/api
/v2
/admin
/countries
Retrieves the collection of Country resources.
POST
/api
/v2
/admin
/countries
Creates a Country resource.
GET
/api
/v2
/admin
/countries
/{code}
Retrieves a Country resource.
PUT
/api
/v2
/admin
/countries
/{code}
Replaces the Country resource.
GET
/api
/v2
/admin
/countries
/{code}
/provinces
Retrieves the collection of Province resources.
GET
/api
/v2
/shop
/countries
Retrieves the collection of Country resources.
GET
/api
/v2
/shop
/countries
/{code}
Retrieves a Country resource.
Province
GET
/api
/v2
/admin
/countries
/{code}
/provinces
Retrieves the collection of Province resources.
GET
/api
/v2
/admin
/provinces
/{code}
Retrieves a Province resource.
PUT
/api
/v2
/admin
/provinces
/{code}
Replaces the Province resource.
Currency
GET
/api
/v2
/admin
/currencies
Retrieves the collection of Currency resources.
POST
/api
/v2
/admin
/currencies
Creates a Currency resource.
GET
/api
/v2
/admin
/currencies
/{code}
Retrieves a Currency resource.
GET
/api
/v2
/shop
/currencies
Retrieves the collection of Currency resources.
GET
/api
/v2
/shop
/currencies
/{code}
Retrieves a Currency resource.
CustomerGroup
GET
/api
/v2
/admin
/customer-groups
Retrieves the collection of CustomerGroup resources.
POST
/api
/v2
/admin
/customer-groups
Creates a CustomerGroup resource.
GET
/api
/v2
/admin
/customer-groups
/{code}
Retrieves a CustomerGroup resource.
PUT
/api
/v2
/admin
/customer-groups
/{code}
Replaces the CustomerGroup resource.
DELETE
/api
/v2
/admin
/customer-groups
/{code}
Removes the CustomerGroup resource.
Customer
GET
/api
/v2
/admin
/customers
/{id}
Retrieves a Customer resource.
POST
/api
/v2
/shop
/customers
Registers a new customer
GET
/api
/v2
/shop
/customers
/{id}
Retrieves a Customer resource.
PUT
/api
/v2
/shop
/customers
/{id}
Replaces the Customer resource.
PUT
/api
/v2
/shop
/customers
/{id}
/password
Change password for logged in customer
ExchangeRate
GET
/api
/v2
/admin
/exchange-rates
Retrieves the collection of ExchangeRate resources.
POST
/api
/v2
/admin
/exchange-rates
Creates a ExchangeRate resource.
GET
/api
/v2
/admin
/exchange-rates
/{id}
Retrieves a ExchangeRate resource.
PUT
/api
/v2
/admin
/exchange-rates
/{id}
Replaces the ExchangeRate resource.
DELETE
/api
/v2
/admin
/exchange-rates
/{id}
Removes the ExchangeRate resource.
GET
/api
/v2
/shop
/exchange-rates
Retrieves the collection of ExchangeRate resources.
GET
/api
/v2
/shop
/exchange-rates
/{id}
Retrieves a ExchangeRate resource.
Locale
GET
/api
/v2
/admin
/locales
Retrieves the collection of Locale resources.
POST
/api
/v2
/admin
/locales
Creates a Locale resource.
GET
/api
/v2
/admin
/locales
/{code}
Retrieves a Locale resource.
GET
/api
/v2
/shop
/locales
Retrieves the collection of Locale resources.
GET
/api
/v2
/shop
/locales
/{code}
Retrieves a Locale resource.
OrderItemUnit
GET
/api
/v2
/admin
/order-item-units
/{id}
Retrieves a OrderItemUnit resource.
GET
/api
/v2
/shop
/order-item-units
/{id}
Retrieves a OrderItemUnit resource.
OrderItem
GET
/api
/v2
/admin
/order-items
/{id}
Retrieves a OrderItem resource.
GET
/api
/v2
/admin
/order-items
/{id}
/adjustments
Retrieves the collection of Adjustment resources.
GET
/api
/v2
/shop
/order-items
/{id}
Retrieves a OrderItem resource.
GET
/api
/v2
/shop
/orders
/{tokenValue}
/items
Retrieves the collection of OrderItem resources.
GET
/api
/v2
/shop
/orders
/{tokenValue}
/items
/{items}
/adjustments
Retrieves the collection of Adjustment resources.
Order
GET
/api
/v2
/admin
/orders
Retrieves the collection of Order resources.
GET
/api
/v2
/admin
/orders
/{tokenValue}
Retrieves a Order resource.
PATCH
/api
/v2
/admin
/orders
/{tokenValue}
/cancel
Cancels Order
GET
/api
/v2
/admin
/orders
/{tokenValue}
/payments
Retrieves the collection of Payment resources.
GET
/api
/v2
/admin
/orders
/{tokenValue}
/shipments
Retrieves the collection of Shipment resources.
PATCH
/api
/v2
/shop
/account
/orders
/{tokenValue}
/payments
/{paymentId}
Change the payment method as logged shop user
POST
/api
/v2
/shop
/orders
Pickups a new cart
GET
/api
/v2
/shop
/orders
Retrieves the collection of Order resources.
GET
/api
/v2
/shop
/orders
/{tokenValue}
Retrieves a Order resource.
DELETE
/api
/v2
/shop
/orders
/{tokenValue}
Deletes cart
PUT
/api
/v2
/shop
/orders
/{tokenValue}
Addresses cart to given location, logged in Customer does not have to provide an email. Applies coupon to cart.
GET
/api
/v2
/shop
/orders
/{tokenValue}
/adjustments
Retrieves the collection of Adjustment resources.
PATCH
/api
/v2
/shop
/orders
/{tokenValue}
/complete
Completes checkout
POST
/api
/v2
/shop
/orders
/{tokenValue}
/items
Adds Item to cart
GET
/api
/v2
/shop
/orders
/{tokenValue}
/items
Retrieves the collection of OrderItem resources.
DELETE
/api
/v2
/shop
/orders
/{tokenValue}
/items
/{itemId}
Removes the Order resource.
PATCH
/api
/v2
/shop
/orders
/{tokenValue}
/items
/{orderItemId}
Changes quantity of order item
PATCH
/api
/v2
/shop
/orders
/{tokenValue}
/payments
/{paymentId}
Selects payment methods for particular payment
GET
/api
/v2
/shop
/orders
/{tokenValue}
/payments
/{paymentId}
/configuration
Retrieve payment method configuration
PATCH
/api
/v2
/shop
/orders
/{tokenValue}
/shipments
/{shipmentId}
Selects shipping methods for particular shipment
Payment
GET
/api
/v2
/admin
/orders
/{tokenValue}
/payments
Retrieves the collection of Payment resources.
GET
/api
/v2
/admin
/payments
Retrieves the collection of Payment resources.
GET
/api
/v2
/admin
/payments
/{id}
Retrieves a Payment resource.
PATCH
/api
/v2
/admin
/payments
/{id}
/complete
Completes Payment
GET
/api
/v2
/shop
/payments
/{id}
Retrieves a Payment resource.
Shipment
GET
/api
/v2
/admin
/orders
/{tokenValue}
/shipments
Retrieves the collection of Shipment resources.
GET
/api
/v2
/admin
/shipments
Retrieves the collection of Shipment resources.
GET
/api
/v2
/admin
/shipments
/{id}
Retrieves a Shipment resource.
PATCH
/api
/v2
/admin
/shipments
/{id}
/ship
Ships Shipment
GET
/api
/v2
/shop
/shipments
/{id}
Retrieves a Shipment resource.
PaymentMethod
GET
/api
/v2
/admin
/payment-methods
/{code}
Retrieves a PaymentMethod resource.
GET
/api
/v2
/shop
/payment-methods
Retrieves the collection of PaymentMethod resources.
GET
/api
/v2
/shop
/payment-methods
/{code}
Retrieves a PaymentMethod resource.
ProductAssociationTypeTranslation
GET
/api
/v2
/admin
/product-association-type-translations
/{id}
Retrieves a ProductAssociationTypeTranslation resource.
ProductAssociationType
GET
/api
/v2
/admin
/product-association-types
Retrieves the collection of ProductAssociationType resources.
POST
/api
/v2
/admin
/product-association-types
Creates a ProductAssociationType resource.
GET
/api
/v2
/admin
/product-association-types
/{code}
Retrieves a ProductAssociationType resource.
PUT
/api
/v2
/admin
/product-association-types
/{code}
Replaces the ProductAssociationType resource.
DELETE
/api
/v2
/admin
/product-association-types
/{code}
Removes the ProductAssociationType resource.
GET
/api
/v2
/shop
/product-association-types
/{code}
Retrieves a ProductAssociationType resource.
ProductImage
GET
/api
/v2
/admin
/product-images
Retrieves the collection of ProductImage resources.
GET
/api
/v2
/admin
/product-images
/{id}
Retrieves a ProductImage resource.
GET
/api
/v2
/shop
/product-images
/{id}
Retrieves a ProductImage resource.
ProductOptionTranslation
GET
/api
/v2
/admin
/product-option-translations
/{id}
Retrieves a ProductOptionTranslation resource.
ProductOptionValue
GET
/api
/v2
/admin
/product-option-values
/{code}
Retrieves a ProductOptionValue resource.
GET
/api
/v2
/admin
/product-options
/{code}
/values
Retrieves the collection of ProductOptionValue resources.
GET
/api
/v2
/shop
/product-option-values
/{code}
Retrieves a ProductOptionValue resource.
ProductOption
GET
/api
/v2
/admin
/product-options
Retrieves the collection of ProductOption resources.
POST
/api
/v2
/admin
/product-options
Creates a ProductOption resource.
GET
/api
/v2
/admin
/product-options
/{code}
Retrieves a ProductOption resource.
PUT
/api
/v2
/admin
/product-options
/{code}
Replaces the ProductOption resource.
GET
/api
/v2
/admin
/product-options
/{code}
/values
Retrieves the collection of ProductOptionValue resources.
GET
/api
/v2
/shop
/product-options
/{code}
Retrieves a ProductOption resource.
ProductReview
GET
/api
/v2
/admin
/product-reviews
Retrieves the collection of ProductReview resources.
GET
/api
/v2
/admin
/product-reviews
/{id}
Retrieves a ProductReview resource.
DELETE
/api
/v2
/admin
/product-reviews
/{id}
Removes the ProductReview resource.
PUT
/api
/v2
/admin
/product-reviews
/{id}
Replaces the ProductReview resource.
PATCH
/api
/v2
/admin
/product-reviews
/{id}
/accept
Accepts Product Review
PATCH
/api
/v2
/admin
/product-reviews
/{id}
/reject
Rejects Product Review
POST
/api
/v2
/shop
/product-reviews
Creates a ProductReview resource.
GET
/api
/v2
/shop
/product-reviews
Retrieves the collection of ProductReview resources.
GET
/api
/v2
/shop
/product-reviews
/{id}
Retrieves a ProductReview resource.
ProductTaxon
GET
/api
/v2
/admin
/product-taxons
Retrieves the collection of ProductTaxon resources.
GET
/api
/v2
/admin
/product-taxons
/{id}
Retrieves a ProductTaxon resource.
GET
/api
/v2
/shop
/product-taxons
/{id}
Retrieves a ProductTaxon resource.
ProductTranslation
GET
/api
/v2
/admin
/product-translations
/{id}
Retrieves a ProductTranslation resource.
GET
/api
/v2
/shop
/product-translations
/{id}
Retrieves a ProductTranslation resource.
ProductVariantTranslation
GET
/api
/v2
/admin
/product-variant-translation
/{id}
Retrieves a ProductVariantTranslation resource.
GET
/api
/v2
/shop
/product-variant-translation
/{id}
Retrieves a ProductVariantTranslation resource.
ProductVariant
GET
/api
/v2
/admin
/product-variants
Retrieves the collection of ProductVariant resources.
POST
/api
/v2
/admin
/product-variants
Creates a ProductVariant resource.
GET
/api
/v2
/admin
/product-variants
/{code}
Retrieves a ProductVariant resource.
PUT
/api
/v2
/admin
/product-variants
/{code}
Replaces the ProductVariant resource.
GET
/api
/v2
/shop
/product-variants
Retrieves the collection of ProductVariant resources.
GET
/api
/v2
/shop
/product-variants
/{code}
Retrieves a ProductVariant resource.
Product
GET
/api
/v2
/admin
/products
Retrieves the collection of Product resources.
POST
/api
/v2
/admin
/products
Creates a Product resource.
GET
/api
/v2
/admin
/products
/{code}
Use code to retrieve a product resource.
PUT
/api
/v2
/admin
/products
/{code}
Replaces the Product resource.
DELETE
/api
/v2
/admin
/products
/{code}
Removes the Product resource.
GET
/api
/v2
/shop
/products
Retrieves the collection of Product resources.
GET
/api
/v2
/shop
/products-by-slug
/{slug}
Use slug to retrieve a product resource.
GET
/api
/v2
/shop
/products
/{code}
Use code to retrieve a product resource.
GET
/api
/v2
/shop
/products
/{code}
/attributes
Retrieves the collection of ProductAttributeValue resources.
Promotion
POST
/api
/v2
/admin
/promotions
Creates a Promotion resource.
GET
/api
/v2
/admin
/promotions
Retrieves the collection of Promotion resources.
GET
/api
/v2
/admin
/promotions
/{code}
Retrieves a Promotion resource.
DELETE
/api
/v2
/admin
/promotions
/{code}
Removes the Promotion resource.
AdminResetPasswordRequest
POST
/api
/v2
/admin
/reset-password-requests
Requests administrator's password reset
PATCH
/api
/v2
/admin
/reset-password-requests
/{resetPasswordToken}
Resets administrator's password
ShippingCategory
GET
/api
/v2
/admin
/shipping-categories
Retrieves the collection of ShippingCategory resources.
POST
/api
/v2
/admin
/shipping-categories
Creates a ShippingCategory resource.
GET
/api
/v2
/admin
/shipping-categories
/{code}
Retrieves a ShippingCategory resource.
PUT
/api
/v2
/admin
/shipping-categories
/{code}
Replaces the ShippingCategory resource.
DELETE
/api
/v2
/admin
/shipping-categories
/{code}
Removes the ShippingCategory resource.
ShippingMethodTranslation
GET
/api
/v2
/admin
/shipping-method-translations
/{id}
Retrieves a ShippingMethodTranslation resource.
GET
/api
/v2
/shop
/shipping-method-translations
/{id}
Retrieves a ShippingMethodTranslation resource.
ShippingMethod
GET
/api
/v2
/admin
/shipping-methods
Retrieves the collection of ShippingMethod resources.
POST
/api
/v2
/admin
/shipping-methods
Creates a ShippingMethod resource.
GET
/api
/v2
/admin
/shipping-methods
/{code}
Retrieves a ShippingMethod resource.
PUT
/api
/v2
/admin
/shipping-methods
/{code}
Replaces the ShippingMethod resource.
DELETE
/api
/v2
/admin
/shipping-methods
/{code}
Removes the ShippingMethod resource.
PATCH
/api
/v2
/admin
/shipping-methods
/{code}
/archive
Archives Shipping Method
PATCH
/api
/v2
/admin
/shipping-methods
/{code}
/restore
Restores archived Shipping Method
GET
/api
/v2
/shop
/shipping-methods
Retrieves the collection of ShippingMethod resources.
GET
/api
/v2
/shop
/shipping-methods
/{code}
Retrieves a ShippingMethod resource.
TaxCategory
GET
/api
/v2
/admin
/tax-categories
Retrieves the collection of TaxCategory resources.
POST
/api
/v2
/admin
/tax-categories
Creates a TaxCategory resource.
GET
/api
/v2
/admin
/tax-categories
/{code}
Retrieves a TaxCategory resource.
PUT
/api
/v2
/admin
/tax-categories
/{code}
Replaces the TaxCategory resource.
DELETE
/api
/v2
/admin
/tax-categories
/{code}
Removes the TaxCategory resource.
TaxonTranslation
GET
/api
/v2
/admin
/taxon-translations
Retrieves the collection of TaxonTranslation resources.
GET
/api
/v2
/admin
/taxon-translations
/{id}
Retrieves a TaxonTranslation resource.
GET
/api
/v2
/shop
/taxon-translations
/{id}
Retrieves a TaxonTranslation resource.
Taxon
GET
/api
/v2
/admin
/taxons
Retrieves the collection of Taxon resources.
POST
/api
/v2
/admin
/taxons
Creates a Taxon resource.
GET
/api
/v2
/admin
/taxons
/{code}
Retrieves a Taxon resource.
PUT
/api
/v2
/admin
/taxons
/{code}
Replaces the Taxon resource.
GET
/api
/v2
/shop
/taxons
Retrieves the collection of Taxon resources.
GET
/api
/v2
/shop
/taxons
/{code}
Retrieves a Taxon resource.
ZoneMember
GET
/api
/v2
/admin
/zone-members
/{id}
Retrieves a ZoneMember resource.
GET
/api
/v2
/admin
/zones
/{code}
/members
Retrieves the collection of ZoneMember resources.
Zone
GET
/api
/v2
/admin
/zones
Retrieves the collection of Zone resources.
POST
/api
/v2
/admin
/zones
Creates a Zone resource.
GET
/api
/v2
/admin
/zones
/{code}
Retrieves a Zone resource.
PUT
/api
/v2
/admin
/zones
/{code}
Replaces the Zone resource.
DELETE
/api
/v2
/admin
/zones
/{code}
Removes the Zone resource.
GET
/api
/v2
/admin
/zones
/{code}
/members
Retrieves the collection of ZoneMember resources.
VerifyCustomerAccount
POST
/api
/v2
/shop
/account-verification-requests
Resends verification email
PATCH
/api
/v2
/shop
/account-verification-requests
/{token}
Verifies Customer account
RequestContact
POST
/api
/v2
/shop
/contact-requests
Send contact request
Menu
GET
/api
/v2
/shop
/megamenu-plugin
/menu
Retrieves the collection of Menu resources.
GET
/api
/v2
/shop
/megamenu-plugin
/menu
/{id}
Retrieves a Menu resource.
MenuItemTranslation
GET
/api
/v2
/shop
/megamenu-plugin
/menu-item-translation
/{id}
Retrieves a MenuItemTranslation resource.
MenuItem
GET
/api
/v2
/shop
/megamenu-plugin
/menu-item
/{id}
Retrieves a MenuItem resource.
ProductAssociation
GET
/api
/v2
/shop
/product-associations
/{id}
Retrieves a ProductAssociation resource.
ProductAttributeValue
GET
/api
/v2
/shop
/product-attribute-values
/{id}
Retrieves a ProductAttributeValue resource.
GET
/api
/v2
/shop
/products
/{code}
/attributes
Retrieves the collection of ProductAttributeValue resources.
ProductAttribute
GET
/api
/v2
/shop
/product-attributes
/{code}
Retrieves a ProductAttribute resource.
AccountResetPasswordRequest
POST
/api
/v2
/shop
/reset-password-requests
Requests password reset
PATCH
/api
/v2
/shop
/reset-password-requests
/{resetPasswordToken}
Resets password
ShopUserToken
POST
/api
/v2
/shop
/authentication-token
Get JWT token to login.
Schemas
AccountResetPasswordRequest-shop.reset_password.update
AccountResetPasswordRequest.RequestResetPasswordToken-shop.reset_password.create
AccountResetPasswordRequest.RequestResetPasswordToken.jsonld-shop.reset_password.create
Address
Address-admin.address.read
Address-admin.order.read
Address-shop.address.create
Address-shop.address.read
Address-shop.address.update
Address-shop.cart.read
Address-shop.order.account.read
Address-shop.order.read_shop.cart.read
Address.jsonld
Address.jsonld-admin.address.read
Address.jsonld-admin.order.read
Address.jsonld-shop.address.create
Address.jsonld-shop.address.read
Address.jsonld-shop.address.update
Address.jsonld-shop.cart.read
Address.jsonld-shop.order.account.read
Address.jsonld-shop.order.read_shop.cart.read
AddressInterface-shop.cart.update
AddressInterface.jsonld-shop.cart.update
AdjustableInterface
AdjustableInterface.jsonld
Adjustment
Adjustment-admin.adjustment.read
Adjustment-shop.adjustment.read
Adjustment.jsonld
Adjustment.jsonld-admin.adjustment.read
Adjustment.jsonld-shop.adjustment.read
AdjustmentInterface
AdjustmentInterface.jsonld
AdminResetPasswordRequest-admin.reset_password.update
AdminResetPasswordRequest.RequestResetPasswordEmail-admin.reset_password.create
AdminResetPasswordRequest.RequestResetPasswordEmail.jsonld-admin.reset_password.create
Administrator
Administrator-admin.admin_user.create
Administrator-admin.admin_user.read
Administrator-admin.admin_user.update
Administrator.jsonld
Administrator.jsonld-admin.admin_user.create
Administrator.jsonld-admin.admin_user.read
Administrator.jsonld-admin.admin_user.update
AttributeValueInterface
AttributeValueInterface.jsonld
AvatarImage-admin.avatar_image.read
AvatarImage.jsonld-admin.avatar_image.read
CatalogPromotion-admin.catalog_promotion.create
CatalogPromotion-admin.catalog_promotion.read
CatalogPromotion-admin.catalog_promotion.update
CatalogPromotion-shop.catalog_promotion.read
CatalogPromotion.jsonld-admin.catalog_promotion.create
CatalogPromotion.jsonld-admin.catalog_promotion.read
CatalogPromotion.jsonld-admin.catalog_promotion.update
CatalogPromotion.jsonld-shop.catalog_promotion.read
CatalogPromotionAction-admin.catalog_promotion.create
CatalogPromotionAction-admin.catalog_promotion.read
CatalogPromotionAction-admin.catalog_promotion.update
CatalogPromotionAction.jsonld-admin.catalog_promotion.create
CatalogPromotionAction.jsonld-admin.catalog_promotion.read
CatalogPromotionAction.jsonld-admin.catalog_promotion.update
CatalogPromotionScope-admin.catalog_promotion.create
CatalogPromotionScope-admin.catalog_promotion.read
CatalogPromotionScope-admin.catalog_promotion.update
CatalogPromotionScope.jsonld-admin.catalog_promotion.create
CatalogPromotionScope.jsonld-admin.catalog_promotion.read
CatalogPromotionScope.jsonld-admin.catalog_promotion.update
CatalogPromotionTranslation
CatalogPromotionTranslation-admin.catalog_promotion.create
CatalogPromotionTranslation-admin.catalog_promotion.read
CatalogPromotionTranslation-admin.catalog_promotion.update
CatalogPromotionTranslation.jsonld
CatalogPromotionTranslation.jsonld-admin.catalog_promotion.create
CatalogPromotionTranslation.jsonld-admin.catalog_promotion.read
CatalogPromotionTranslation.jsonld-admin.catalog_promotion.update
Channel
Channel-admin.channel.create
Channel-admin.channel.read
Channel-admin.channel.update
Channel-shop.channel.read
Channel.jsonld
Channel.jsonld-admin.channel.create
Channel.jsonld-admin.channel.read
Channel.jsonld-admin.channel.update
Channel.jsonld-shop.channel.read
ChannelInterface
ChannelInterface.jsonld
ChannelPricing-admin.product_variant.create
ChannelPricing-admin.product_variant.read
ChannelPricing-admin.product_variant.update
ChannelPricing.jsonld-admin.product_variant.create
ChannelPricing.jsonld-admin.product_variant.read
ChannelPricing.jsonld-admin.product_variant.update
Collection
Collection.jsonld
Country
Country-admin.country.create
Country-admin.country.read
Country-admin.country.update
Country-shop.country.read
Country.jsonld
Country.jsonld-admin.country.create
Country.jsonld-admin.country.read
Country.jsonld-admin.country.update
Country.jsonld-shop.country.read
Currency
Currency-admin.currency.read
Currency-shop.currency.read
Currency.jsonld
Currency.jsonld-admin.currency.read
Currency.jsonld-shop.currency.read
Customer-admin.customer.read
Customer-shop.customer.read
Customer-shop.customer.update
Customer.ChangeShopUserPassword-shop.customer.password.update
Customer.ChangeShopUserPassword.jsonld-shop.customer.password.update
Customer.RegisterShopUser-shop.customer.create
Customer.RegisterShopUser.jsonld-shop.customer.create
Customer.jsonld-admin.customer.read
Customer.jsonld-shop.customer.read
Customer.jsonld-shop.customer.update
CustomerGroup
CustomerGroup-admin.customer_group.create
CustomerGroup-admin.customer_group.read
CustomerGroup-admin.customer_group.update
CustomerGroup.jsonld
CustomerGroup.jsonld-admin.customer_group.create
CustomerGroup.jsonld-admin.customer_group.read
CustomerGroup.jsonld-admin.customer_group.update
CustomerInterface
CustomerInterface.jsonld
ExchangeRate
ExchangeRate-admin.exchange_rate.create
ExchangeRate-admin.exchange_rate.read
ExchangeRate-admin.exchange_rate.update
ExchangeRate-shop.exchange_rate.read
ExchangeRate.jsonld
ExchangeRate.jsonld-admin.exchange_rate.create
ExchangeRate.jsonld-admin.exchange_rate.read
ExchangeRate.jsonld-admin.exchange_rate.update
ExchangeRate.jsonld-shop.exchange_rate.read
ImageInterface
ImageInterface.jsonld
Locale
Locale-admin.locale.create
Locale-admin.locale.read
Locale-shop.locale.read
Locale.jsonld
Locale.jsonld-admin.locale.create
Locale.jsonld-admin.locale.read
Locale.jsonld-shop.locale.read
Menu-shop.megamenu.read
Menu.jsonld-shop.megamenu.read
MenuItem-shop.megamenu-item.read
MenuItem.jsonld-shop.megamenu-item.read
MenuItemTranslation-shop.megamenu-item-translation.read
MenuItemTranslation.jsonld-shop.megamenu-item-translation.read
Order
Order-admin.order.read
Order-shop.cart.read
Order-shop.order.account.read
Order-shop.order.read
Order-shop.order.read_shop.cart.read
Order.AddItemToCart-shop.cart.add_item
Order.AddItemToCart.jsonld-shop.cart.add_item
Order.ChangeItemQuantityInCart-shop.cart.change_quantity
Order.ChangePaymentMethod-shop.order.account.change_payment_method
Order.ChoosePaymentMethod-shop.cart.select_payment_method
Order.ChooseShippingMethod-shop.cart.select_shipping_method
Order.CompleteOrder-shop.cart.complete
Order.PickupCart-shop.order.create
Order.PickupCart.jsonld-shop.order.create
Order.UpdateCart-shop.cart.update
Order.UpdateCart.jsonld-shop.cart.update
Order.jsonld
Order.jsonld-admin.order.read
Order.jsonld-shop.cart.read
Order.jsonld-shop.order.account.read
Order.jsonld-shop.order.read
Order.jsonld-shop.order.read_shop.cart.read
OrderItem
OrderItem-admin.order.read
OrderItem-admin.order_item.read
OrderItem-shop.cart.read
OrderItem-shop.order.account.read
OrderItem-shop.order.read_shop.cart.read
OrderItem.jsonld
OrderItem.jsonld-admin.order.read
OrderItem.jsonld-admin.order_item.read
OrderItem.jsonld-shop.cart.read
OrderItem.jsonld-shop.order.account.read
OrderItem.jsonld-shop.order.read_shop.cart.read
OrderItemInterface
OrderItemInterface.jsonld
OrderItemUnit-admin.order_item_unit.read
OrderItemUnit-shop.order_item_unit.read
OrderItemUnit.jsonld-admin.order_item_unit.read
OrderItemUnit.jsonld-shop.order_item_unit.read
OrderItemUnitInterface
OrderItemUnitInterface.jsonld
Payment
Payment-admin.order.read
Payment-admin.payment.read
Payment-shop.cart.read
Payment-shop.order.account.read
Payment-shop.order.read_shop.cart.read
Payment-shop.payment.read
Payment.jsonld
Payment.jsonld-admin.order.read
Payment.jsonld-admin.payment.read
Payment.jsonld-shop.cart.read
Payment.jsonld-shop.order.account.read
Payment.jsonld-shop.order.read_shop.cart.read
Payment.jsonld-shop.payment.read
PaymentInterface
PaymentInterface.jsonld
PaymentMethod-admin.payment.read
PaymentMethod-admin.payment_method.read
PaymentMethod-shop.order.account.read
PaymentMethod-shop.payment.read
PaymentMethod-shop.payment_method.read
PaymentMethod.jsonld-admin.payment.read
PaymentMethod.jsonld-admin.payment_method.read
PaymentMethod.jsonld-shop.order.account.read
PaymentMethod.jsonld-shop.payment.read
PaymentMethod.jsonld-shop.payment_method.read
Product
Product-admin.product.create
Product-admin.product.read
Product-admin.product.update
Product-shop.product.read
Product.jsonld
Product.jsonld-admin.product.create
Product.jsonld-admin.product.read
Product.jsonld-admin.product.update
Product.jsonld-shop.product.read
ProductAssociation-shop.product_association.read
ProductAssociation.jsonld-shop.product_association.read
ProductAssociationType-admin.product_association_type.create
ProductAssociationType-admin.product_association_type.read
ProductAssociationType-admin.product_association_type.update
ProductAssociationType-shop.product_association_type.read
ProductAssociationType.jsonld-admin.product_association_type.create
ProductAssociationType.jsonld-admin.product_association_type.read
ProductAssociationType.jsonld-admin.product_association_type.update
ProductAssociationType.jsonld-shop.product_association_type.read
ProductAssociationTypeTranslation
ProductAssociationTypeTranslation-admin.product_association_type.create
ProductAssociationTypeTranslation-admin.product_association_type.read
ProductAssociationTypeTranslation-admin.product_association_type.update
ProductAssociationTypeTranslation.jsonld
ProductAssociationTypeTranslation.jsonld-admin.product_association_type.create
ProductAssociationTypeTranslation.jsonld-admin.product_association_type.read
ProductAssociationTypeTranslation.jsonld-admin.product_association_type.update
ProductAttribute-shop.product_attribute.read
ProductAttribute.jsonld-shop.product_attribute.read
ProductAttributeValue-shop.product_attribute_value.read
ProductAttributeValue.jsonld-shop.product_attribute_value.read
ProductImage-admin.product.read
ProductImage-admin.product_image.read
ProductImage-shop.product.read
ProductImage-shop.product_image.read
ProductImage.jsonld-admin.product.read
ProductImage.jsonld-admin.product_image.read
ProductImage.jsonld-shop.product.read
ProductImage.jsonld-shop.product_image.read
ProductInterface
ProductInterface-admin.order_item.read
ProductInterface.jsonld
ProductInterface.jsonld-admin.order_item.read
ProductOption-admin.product_option.create
ProductOption-admin.product_option.read
ProductOption-admin.product_option.update
ProductOption-shop.product_option.read
ProductOption.jsonld-admin.product_option.create
ProductOption.jsonld-admin.product_option.read
ProductOption.jsonld-admin.product_option.update
ProductOption.jsonld-shop.product_option.read
ProductOptionInterface
ProductOptionInterface.jsonld
ProductOptionTranslation
ProductOptionTranslation-admin.product_option.create
ProductOptionTranslation-admin.product_option.read
ProductOptionTranslation-admin.product_option.update
ProductOptionTranslation.jsonld
ProductOptionTranslation.jsonld-admin.product_option.create
ProductOptionTranslation.jsonld-admin.product_option.read
ProductOptionTranslation.jsonld-admin.product_option.update
ProductOptionValue
ProductOptionValue-admin.product_option.create
ProductOptionValue-admin.product_option.update
ProductOptionValue-admin.product_option_value.read
ProductOptionValue-shop.product_option_value.read
ProductOptionValue.jsonld
ProductOptionValue.jsonld-admin.product_option.create
ProductOptionValue.jsonld-admin.product_option.update
ProductOptionValue.jsonld-admin.product_option_value.read
ProductOptionValue.jsonld-shop.product_option_value.read
ProductOptionValueInterface
ProductOptionValueInterface.jsonld
ProductOptionValueTranslation
ProductOptionValueTranslation-admin.product_option.create
ProductOptionValueTranslation-admin.product_option.update
ProductOptionValueTranslation-admin.product_option_value.read
ProductOptionValueTranslation.jsonld
ProductOptionValueTranslation.jsonld-admin.product_option.create
ProductOptionValueTranslation.jsonld-admin.product_option.update
ProductOptionValueTranslation.jsonld-admin.product_option_value.read
ProductReview
ProductReview-admin.product_review.read
ProductReview-admin.product_review.update
ProductReview-shop.product_review.read
ProductReview.AddProductReview-shop.product_review.create
ProductReview.AddProductReview.jsonld-shop.product_review.create
ProductReview.jsonld
ProductReview.jsonld-admin.product_review.read
ProductReview.jsonld-admin.product_review.update
ProductReview.jsonld-shop.product_review.read
ProductTaxon-admin.product_taxon.read
ProductTaxon-shop.product_taxon.read
ProductTaxon.jsonld-admin.product_taxon.read
ProductTaxon.jsonld-shop.product_taxon.read
ProductTaxonInterface
ProductTaxonInterface.jsonld
ProductTranslation
ProductTranslation-admin.product.create
ProductTranslation-admin.product.read
ProductTranslation-admin.product.update
ProductTranslation.jsonld
ProductTranslation.jsonld-admin.product.create
ProductTranslation.jsonld-admin.product.read
ProductTranslation.jsonld-admin.product.update
ProductVariant-admin.product_variant.create
ProductVariant-admin.product_variant.read
ProductVariant-admin.product_variant.update
ProductVariant-shop.product_variant.read
ProductVariant.jsonld-admin.product_variant.create
ProductVariant.jsonld-admin.product_variant.read
ProductVariant.jsonld-admin.product_variant.update
ProductVariant.jsonld-shop.product_variant.read
ProductVariantInterface
ProductVariantInterface.jsonld
ProductVariantTranslation
ProductVariantTranslation-admin.product_variant.read
ProductVariantTranslation.jsonld
ProductVariantTranslation.jsonld-admin.product_variant.read
Promotion
Promotion-admin.promotion.create
Promotion-admin.promotion.read
Promotion.jsonld
Promotion.jsonld-admin.promotion.create
Promotion.jsonld-admin.promotion.read
PromotionAction
PromotionAction-admin.promotion.read
PromotionAction.jsonld
PromotionAction.jsonld-admin.promotion.read
PromotionActionInterface
PromotionActionInterface.jsonld
PromotionCoupon
PromotionCoupon-admin.promotion.read
PromotionCoupon.jsonld
PromotionCoupon.jsonld-admin.promotion.read
PromotionCouponInterface
PromotionCouponInterface.jsonld
PromotionInterface
PromotionInterface.jsonld
PromotionRule
PromotionRule-admin.promotion.read
PromotionRule.jsonld
PromotionRule.jsonld-admin.promotion.read
PromotionRuleInterface
PromotionRuleInterface.jsonld
Province
Province-admin.country.create
Province-admin.country.update
Province-admin.province.read
Province-shop.country.read
Province.jsonld
Province.jsonld-admin.country.create
Province.jsonld-admin.country.update
Province.jsonld-admin.province.read
Province.jsonld-shop.country.read
RequestContact-shop.contact_request.create
RequestContact.jsonld-shop.contact_request.create
Shipment
Shipment-admin.order.read
Shipment-admin.shipment.read
Shipment-shop.cart.read
Shipment-shop.order.account.read
Shipment-shop.order.read_shop.cart.read
Shipment-shop.shipment.read
Shipment.ShipShipment-admin.shipment.update
Shipment.jsonld
Shipment.jsonld-admin.order.read
Shipment.jsonld-admin.shipment.read
Shipment.jsonld-shop.cart.read
Shipment.jsonld-shop.order.account.read
Shipment.jsonld-shop.order.read_shop.cart.read
Shipment.jsonld-shop.shipment.read
ShipmentInterface
ShipmentInterface.jsonld
ShipmentUnitInterface
ShipmentUnitInterface.jsonld
ShippableInterface
ShippableInterface-admin.order_item_unit.read
ShippableInterface-shop.order_item_unit.read
ShippableInterface.jsonld
ShippableInterface.jsonld-admin.order_item_unit.read
ShippableInterface.jsonld-shop.order_item_unit.read
ShippingCategory
ShippingCategory-admin.shipping_category.create
ShippingCategory-admin.shipping_category.read
ShippingCategory-admin.shipping_category.update
ShippingCategory.jsonld
ShippingCategory.jsonld-admin.shipping_category.create
ShippingCategory.jsonld-admin.shipping_category.read
ShippingCategory.jsonld-admin.shipping_category.update
ShippingMethod-admin.shipping_method.create
ShippingMethod-admin.shipping_method.read
ShippingMethod-admin.shipping_method.update
ShippingMethod-shop.shipping_method.read
ShippingMethod.jsonld-admin.shipping_method.create
ShippingMethod.jsonld-admin.shipping_method.read
ShippingMethod.jsonld-admin.shipping_method.update
ShippingMethod.jsonld-shop.shipping_method.read
ShippingMethodTranslation
ShippingMethodTranslation-admin.shipping_method.create
ShippingMethodTranslation-admin.shipping_method.read
ShippingMethodTranslation-admin.shipping_method.update
ShippingMethodTranslation.jsonld
ShippingMethodTranslation.jsonld-admin.shipping_method.create
ShippingMethodTranslation.jsonld-admin.shipping_method.read
ShippingMethodTranslation.jsonld-admin.shipping_method.update
ShopBillingData
ShopBillingData-admin.channel.create
ShopBillingData-admin.shop_billing_data.read
ShopBillingData.jsonld
ShopBillingData.jsonld-admin.channel.create
ShopBillingData.jsonld-admin.shop_billing_data.read
ShopUser
ShopUser-shop.customer.read
ShopUser.jsonld
ShopUser.jsonld-shop.customer.read
TaxCategory
TaxCategory-admin.tax_category.create
TaxCategory-admin.tax_category.read
TaxCategory-admin.tax_category.update
TaxCategory.jsonld
TaxCategory.jsonld-admin.tax_category.create
TaxCategory.jsonld-admin.tax_category.read
TaxCategory.jsonld-admin.tax_category.update
TaxRate
TaxRate.jsonld
Taxon
Taxon-admin.taxon.create
Taxon-admin.taxon.read
Taxon-admin.taxon.update
Taxon-shop.taxon.read
Taxon.jsonld
Taxon.jsonld-admin.taxon.create
Taxon.jsonld-admin.taxon.read
Taxon.jsonld-admin.taxon.update
Taxon.jsonld-shop.taxon.read
TaxonImage
TaxonImage.jsonld
TaxonTranslation-admin.taxon.read
TaxonTranslation-admin.taxon.read_admin.taxon_translation.read
TaxonTranslation-admin.taxon.read_shop.taxon_translation.read
TaxonTranslation.jsonld-admin.taxon.read
TaxonTranslation.jsonld-admin.taxon.read_admin.taxon_translation.read
TaxonTranslation.jsonld-admin.taxon.read_shop.taxon_translation.read
TranslatableInterface
TranslatableInterface.jsonld
TranslationInterface
TranslationInterface.jsonld
UserInterface
UserInterface.jsonld
UserOAuth
UserOAuth.jsonld
UserOAuthInterface
UserOAuthInterface.jsonld
VerifyCustomerAccount-shop.account_verification.update
VerifyCustomerAccount.ResendVerificationEmail-shop.resend_verification_email.create
VerifyCustomerAccount.ResendVerificationEmail.jsonld-shop.resend_verification_email.create
Zone
Zone-admin.zone.create
Zone-admin.zone.read
Zone-admin.zone.update
Zone.jsonld
Zone.jsonld-admin.zone.create
Zone.jsonld-admin.zone.read
Zone.jsonld-admin.zone.update
ZoneMember
ZoneMember-admin.zone.create
ZoneMember-admin.zone.update
ZoneMember-admin.zone_member.read
ZoneMember.jsonld
ZoneMember.jsonld-admin.zone.create
ZoneMember.jsonld-admin.zone.update
ZoneMember.jsonld-admin.zone_member.read
AdminUserToken
AdminUserCredentials
ShopUserToken
ShopUserCredentials
Available formats:
jsonld
json
html
Other API docs:
ReDoc
GraphiQL
