Skip to content

PlentyONE Onlineshop Docs

Main Navigation

Appearance

Sidebar Navigation

Composables

Interfaces

Filters

GetFacetsFromURLResponse

Notification

UseActiveShippingCountries

UseActiveShippingCountriesState

UseAdditionalInformation

UseAdditionalInformationState

UseAddressMethods

UseAddressMethodsState

UseAgreementCheckboxMethods

UseAgreementCheckboxState

UseCanonical

UseCanonicalState

UseCart

UseCartShippingMethods

UseCartShippingMethodsState

UseCartState

UseCategoryFiltersResponse

UseCategoryTemplate

UseCategoryTemplateState

UseCategoryTreeMethods

UseCategoryTreeState

UseCookieReturn

UseCoupon

UseCouponState

UseCustomer

UseCustomerContact

UseCustomerContactState

UseCustomerOrder

UseCustomerOrderState

UseCustomerOrders

UseCustomerOrdersState

UseCustomerReturns

UseCustomerReturnsState

UseCustomerState

UseInitialSetup

UseLegalInformationMethods

UseLegalInformationState

UseMakeOrder

UseMakeOrderState

UseMegaMenuMethods

UseMegaMenuState

UseModernImage

UseNewsletter

UseNewsletterState

UseNotification

UseNotificationState

UseOffer

UseOfferState

UseOrderDocumentMethods

UseOrderDocumentState

UsePaymentMethods

UsePaymentMethodsState

UseProduct

UseProductAttributesReturn

UseProductAttributesState

UseProductOrderProperties

UseProductOrderPropertiesState

UseProductReviewAverageState

UseProductReviewsAverageReturn

UseProductReviewsReturn

UseProductReviewsState

UseProductState

UseProducts

UseProductsState

UseQuickCheckout

UseQuickCheckoutState

UseReturnOrder

UseReturnOrderState

UseSearch

UseSearchState

UseStructuredData

UseStructuredDataState

UseValidatorAggregator

UseValidatorAggregatorState

UseWishlist

UseWishlistState

ValidatorMethodObject

Type Aliases

AcceptOffer

AddCoupon

AddItemsToCart

AddModernImageExtension

AddModernImageExtensionForGallery

AddModernImageExtensionForSfImages

AddToCart

AddWishlistItem

CategoriesPageMeta

ChangePassword

CleanReturnData

ClearCartItems

ClearNotification

CloseMegaMenu

CloseQuickCheckout

CloseReviewModal

CreateOrder

CreateProductReview

DeclineOffer

DeleteAddress

DeleteCartItem

DeleteCoupon

DeleteProductReview

DeleteWishlistItem

DoAdditionalInformation

DoAdditionalInformationReturn

DoCustomerContactMail

DownloadFile

EndTimer

ErrorParams

FetchCategoryTemplate

FetchCustomerOrders

FetchCustomerReturns

FetchOffer

FetchOrder

FetchPaymentMethods

FetchProduct

FetchProductReviewAverage

FetchProductReviews

FetchProducts

FetchReturnReasons

FetchReviews

FetchWishlist

GetActiveShippingCountries

GetAddresses

GetCart

GetCategoryTree

GetCombination

GetDocument

GetImageForViewport

GetLegalInformation

GetPropertiesPrice

GetSearch

GetSession

GetShippingMethods

GetValue

InteractWithWishlist

IsWishlistItem

Login

LoginAsGuest

Logout

MakeOrderReturn

OpenMegaMenu

OpenQuickCheckout

OpenReviewModal

PayPalLoadScript

PayPalScript

Register

SaveAddress

SavePaymentMethod

SaveShippingMethod

SearchByTag

SelectAll

SendNotification

SetAttribute

SetBreadcrumbs

SetCart

SetCartItemQuantity

SetCategory

SetCategoryTemplate

SetCategoryTree

SetCheckboxValue

SetCheckoutAddress

SetCurrentProduct

SetCurrentReturnOrder

SetDefault

SetDisplayAddress

SetInitialData

SetLogoMeta

SetProductMetaData

SetProductReview

SetProperties

SetSelectedMethod

SetShippingPrivacyAgreement

SetShippingPrivacyAgreementErrors

SetShowErrors

SetUser

SetWishlistItemIds

StartTimer

StaticPageMeta

Subscribe

UpdateQuantity

UpdateReason

UpdateValue

UseActiveShippingCountriesReturn

UseAddressReturn

UseAgreementCheckboxReturn

UseCanonicalReturn

UseCartReturn

UseCartShippingMethodsReturn

UseCategoryTemplateReturn

UseCategoryTreeMethodsReturn

UseCouponReturn

UseCustomerContactReturn

UseCustomerOrderReturn

UseCustomerOrdersReturn

UseCustomerReturn

UseCustomerReturnsReturn

UseHandleError

UseInitialSetupReturn

UseLegalInformationMethodsReturn

UseMakeOrderReturn

UseMegaMenuReturn

UseModernImageReturn

UseNewsletterReturn

UseNotificationReturn

UseOfferReturn

UseOrderDocumentMethodsReturn

UsePaymentMethodsReturn

UseProductAttributes

UseProductOrderPropertiesReturn

UseProductReturn

UseProductReviewAverage

UseProductReviews

UseProductsReturn

UseQuickCheckoutReturn

UseReturnOrderReturn

UseSearchReturn

UseValidatorAggregatorReturn

UseWishlistReturn

ValidatorInvalidFields

ValidatorMethodType

useStructuredDataReturn

Variables

PayPalApplePayKey

PayPalCreditCardPaymentKey

PayPalGooglePayKey

PayPalPaymentKey

defaults

Functions

cookieBarHelper

useActiveShippingCountries

useAdditionalInformation

useAddress

useAddressForm

useAgreementCheckbox

useCanonical

useCart

useCartShippingMethods

useCategoryFilter

useCategoryTemplate

useCategoryTree

useCheckout

useCookieBar

useCookieConsent

useCoupon

useCsrfToken

useCustomer

useCustomerContact

useCustomerOrder

useCustomerOrders

useCustomerReturns

useHandleError

useInitialSetup

useLegalInformation

useLocalization

useMakeOrder

useMegaMenu

useModernImage

useNewsletter

useNotification

useOffer

useOrderDocument

usePageTitle

usePayPal

usePaymentMethods

useProcessingOrder

useProduct

useProductAttributes

useProductOrderProperties

useProductRecommended

useProductReviewAverage

useProductReviews

useProducts

useQuickCheckout

useReadCookieBar

useReturnOrder

useSearch

useStructuredData

useValidatorAggregator

useWishlist

API

Enumerations

AddressOptionType

AddressType

Classes

ApiError

Interfaces

AddCouponResponse

AdditionalInformationParams

AddressRelation

AddWishlistItemParams

AddWishlistItemResponse

AmountVat

ApiErrorParams

ApiProductResponse

ApiSessionResponse

appContext

Attribute

AttributeNames

AttributeValue

AttributeValueNames

AuthenticatedReviewSearchParams

Availability

AvailabilityNames

BasketItem

BillingAddressDetailsParams

CartItem

Category

CategoryDetails

CategoryTemplate

CategoryTreeItemCount

CompanyDetails

Condition

cookie

cookieGetter

cookieGroup

CookieGroupFromNuxtConfig

cookieGroupInMem

CreateReturnResponse

CreateReviewParams

CustomerContactEmailParams

Data

DateElement

Default

DefaultCategory

DefaultData

DeleteAddressResponse

DeleteCartItemParams

DeleteCartResponse

DeleteCouponResponse

DeleteReviewParams

DeleteWishlistItemParams

Discount

DoAddCouponParams

DoAddItemParams

Document

DoSaveAddressParams

ExecutePaymentParams

Facet

FacetFilter

FacetProductItem

FacetSearchCriteria

FeedbackAverageParams

GetAddressesParams

GetOfferError

GetOfferReject

GetOrderAgainInformationParams

GetOrderAgainInformationResponse

GetOrderError

GiftCard

ImageNames

Images

ImagesData

Item

ItemCount

ItemList

ItemSearchParams

LanguageNames

LanguageUrls

LegalTextsParams

LoginAsGuestParams

LoginParams

MakeOrderParams

MakeOrderReturnParams

Manufacturer

MiddlewareConfig

MigrateGuestOrderToCustomerParams

Names

NewsletterEmailConfirmationParams

NewsletterParams

NewsletterSubscribeResponse

NewsletterUnsubscribeResponse

Offer

OfferSearchParams

Option

Order

OrderAmount

OrderDetails

OrderDocument

OrderDocumentParams

OrderItem

OrderItemAmount

OrderItemAttribute

OrderItemCurrentStatus

OrderItemOrderProperty

OrderItemProperty

OrderPaymentBankDetails

OrderProperty

OrderPropertyFileParams

OrderPropertyFileResponse

OrderPropertySelectionValue

OrderPropertySelectionValues

OrderReference

OrderReturnReason

OrderReturnsResponse

OrderReturnVariation

OrderSearchParams

OrderTotals

OrderTotalsAdditionalCost

OrderTotalsAdditionalCostMap

OrderTotalsVat

Pagination

PaymentMethodListForSwitch

PayPalApproveOrder

PayPalApproveTransactionParams

PayPalCaptureOrderParams

PayPalConfigResponse

PayPalCreateOrder

PayPalCreateTransactionParams

PayPalCreditCardTransaction

PayPalExecuteParams

PayPalExecutePayment

PayPalLink

PlentyAgnosticTotals

Price

Prices

ProducingCountry

Product

ProductAttribute

ProductDataFilter

ProductItem

ProductItemDocument

ProductItemDocumentData

ProductProperty

ProductPropertyDetails

ProductPropertyDetailsNames

ProductPropertyGroup

ProductPropertyGroupNames

ProductTag

RegisterParams

Relation

ReviewAverageParams

ReviewSearchParams

SaveAddressResponse

SetAddressDefaultParams

SetAddressDefaultResponse

SetCartItemQuantityParams

ShippingAddressDetailsParams

ShippingPrivacyInformation

ShippingProvider

ShippingProviderParams

Texts

Unit

UnitNames

UpdateReviewParams

UploadFileForOrderPropertyParams

UploadFileForOrderPropertyResponse

UserChangePasswordParams

UserChangeResponse

UserOptions

UserRegisterParams

UseUserOrderSearchParams

Variation

VariationProperty

VariationPropertyGroup

VariationsPropertyGroup

VariationsPropertyGroupOption

Vat

WishlistServerResponse

Type Aliases

ActiveShippingCountry

Address

AddressData

AddressOption

AddressPivot

AfterAccountAuthentication

AfterBasketChanged

AggregatedCountries

ApiMethods

BasketItemOrderParam

BasketItemOrderParamsProperty

BillingAddress

Breadcrumb

BundleComponentData

Cart

CartItemError

CategoryTemplateParams

CategoryTreeItem

CategoryTreeItemDetails

CheckoutChanged

Country

Coupon

Endpoints

Filter

FilterGroup

FrontendUpdateCustomerSettings

GeoRegulatedCountry

GetOrdersResponse

GetPaymentResponse

GetReturnsResponse

GraduatedPriceList

InitResult

ItemSearchResult

LegalInformationResponse

OrderPropertiesGroup

OrderPropertiesGroups

OrderPropertyLabel

PaginatedResult

PasswordResetResult

PaymentMethod

PaymentProviders

PayPalAllowApplePayRequest

PayPalAllowGooglePayResponse

PayPalGetOrderDetailsParams

PayPalGooglePayAllowedPaymentMethod

PayPalGooglePayAllowedPaymentMethodParameters

PayPalGooglePayBillingAddressParameters

PayPalGooglePayPaymentMethods

PayPalGooglePayTokenizationSpecification

PayPalGooglePayTokenizationSpecificationParameters

PayPalOrderStatus

PlentysystemsIntegrationContext

PreparePaymentResult

ProductBundleComponent

ProductFilter

ProductParams

ReturnsParams

Review

ReviewAverage

ReviewCounts

ReviewItem

ReviewPagination

SessionResult

SessionSearchPramas

SetMobilePaymentProviderListParams

SetMobilePaymentProviderResponse

SetPaymentProviderParams

SetPaymentProviderResponse

ShippingAddress

ShippingCountryName

ShippingCountryState

ShippingMethod

SourceRelationItem

State

Store

TODO

TotalVat

User

UserBillingAddress

UserBillingAddressItem

UserBillingAddressSearchCriteria

UserShippingAddress

UserShippingAddressItem

UserShippingAddressSearchCriteria

VariationMapProductAttribute

VariationMapProductAttributeValue

VariationMapProductVariation

WishlistItem

Variables

bannerGetters

cartGetters

categoryGetters

categoryTreeGetters

companyGetters

cookieBarGetters

countryGetters

facetGetters

forgotPasswordGetters

heroesGetters

legalGetters

localesGetters

manufacturerGetters

offerGetters

orderDocumentGetters

orderGetters

paginationGetters

paymentProviderGetters

paypalGetters

productAttributeGetters

productBundleGetters

productGetters

productImageGetters

productPriceGetters

productPropertyGetters

returnGetters

reviewGetters

shippingProviderGetters

tagGetters

userAddressGetters

userGetters

wishlistGetters

Functions

deleteAddress

deleteAllCartItems

deleteCart

deleteCartItem

deleteCoupon

deleteNewsletterSubscription

deleteReview

deleteWishlistItem

doAcceptOffer

doAddCartItem

doAddCartItems

doAddCoupon

doAdditionalInformation

doAddWishlistItem

doApprovePayPalTransaction

doCapturePayPalOrder

doChangeUserPassword

doCreatePayPalCreditCardTransaction

doCreatePayPalTransaction

doCustomerContactMail

doEmailConfirmation

doExecutePayment

doHandleAllowPaymentApplePay

doHandleAllowPaymentGooglePay

doLogin

doLoginAsGuest

doLogoutUser

doMakeOrderReturn

doMigrateGuestOrderToCustomer

doOrderAgainInformation

doPlaceOrder

doPreparePayment

doRegisterUser

doRejectOffer

doReview

doSaveAddress

doSubscribeNewsletter

doUploadOrderPropertyFile

getActiveShippingCountries

getAddresses

getAggregatedCountries

getAuthenticatedReview

getCart

getCategoryTemplate

getCategoryTree

getExecutePayPalOrder

getFacet

getFeedbackAverage

getInit

getLegalTexts

getOffer

getOrder

getOrderDocument

getOrderPropertyFile

getOrders

getPaymentProviders

getPayPalDataClientToken

getPayPalMerchantAndClientIds

getPayPalOrderDetails

getProduct

getReturnReasons

getReturns

getReview

getReviewAverage

getSearch

getSession

getShippingProvider

getWishlist

setCartItemQuantity

setCategoryTemplate

setCheckoutAddress

setMobilePaymentProviderList

setPaymentProvider

setReview

setShippingProvider

On this page

@plentymarkets/shop-api / ApiMethods

Type Alias: ApiMethods

ApiMethods: typeof apiMethods

Defined in

types/api/endpoints.ts:4

Pager

Previous pageAggregatedCountries

Next pageBasketItemOrderParam