@plentymarkets/shop-api ​
api-client
for plentyShop PWA.
Remarks ​
This section provides a reference to the API client of plentyShop PWA. It includes the available types and API endpoints.
Exports ​
Enumerations ​
Interfaces ​
- AddWishlistItemParams
- AddWishlistItemResponse
- AdditionalInformationParams
- AddressRelation
- AmountVat
- ApiProductResponse
- Attribute
- AttributeNames
- AttributeValue
- AttributeValueNames
- AuthenticatedReviewSearchParams
- Availability
- AvailabilityNames
- BasketItem
- BillingAddressDetailsParams
- CartItem
- Category
- CategoryDetails
- CategoryTreeItemCount
- CompanyDetails
- Condition
- CookieGroupFromNuxtConfig
- CreateReturnResponse
- CreateReviewParams
- CustomerContactEmailParams
- Data
- DateElement
- Default
- DefaultCategory
- DefaultData
- DeleteAddressResponse
- DeleteCartItemParams
- DeleteCartResponse
- DeleteReviewParams
- DeleteWishlistItemParams
- Discount
- DoAddCouponParams
- DoAddItemParams
- DoSaveAddressParams
- Document
- Endpoints
- ExecutePaymentParams
- Facet
- FacetFilter
- FacetProductItem
- FacetSearchCriteria
- FeedbackAverageParams
- GetAddressesParams
- GetOrderError
- GiftCard
- Images
- ImagesData
- Item
- ItemCount
- ItemList
- ItemSearchParams
- LanguageNames
- LanguageUrls
- LegalTextsParams
- LoginAsGuestParams
- LoginParams
- MakeOrderParams
- MakeOrderReturnParams
- MiddlewareConfig
- Names
- NewsletterParams
- NewsletterSubscribeResponse
- NewsletterUnsubscribeResponse
- Option
- Order
- OrderAmount
- OrderDetails
- OrderDocument
- OrderDocumentParams
- OrderItem
- OrderItemAmount
- OrderItemAttribute
- OrderItemOrderProperty
- OrderItemProperty
- OrderProperty
- OrderPropertySelectionValue
- OrderPropertySelectionValues
- OrderReference
- OrderReturnReason
- OrderReturnVariation
- OrderReturnsResponse
- OrderSearchParams
- OrderTotals
- OrderTotalsAdditionalCost
- OrderTotalsAdditionalCostMap
- OrderTotalsVat
- Pagination
- PayPalApproveOrder
- PayPalApproveTransactionParams
- PayPalCaptureOrderParams
- PayPalConfigResponse
- PayPalCreateOrder
- PayPalCreateTransactionParams
- PayPalCreditCardTransaction
- PayPalExecuteParams
- PayPalExecutePayment
- PayPalLink
- PaymentMethodListForSwitch
- 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
- UseUserOrderSearchParams
- UserChangePasswordParams
- UserChangeResponse
- UserOptions
- UserRegisterParams
- Variation
- VariationProperty
- VariationPropertyGroup
- VariationsPropertyGroup
- VariationsPropertyGroupOption
- Vat
- WishlistServerResponse
- appContext
- cookie
- cookieGetter
- cookieGroup
- cookieGroupInMem
Type Aliases ​
- ActiveShippingCountry
- Address
- AddressData
- AddressOption
- AddressPivot
- AfterAccountAuthentication
- AfterBasketChanged
- BasketItemOrderParam
- BasketItemOrderParamsProperty
- BillingAddress
- Breadcrumb
- BundleComponentData
- Cart
- CartResponse
- CategoryTreeItem
- CategoryTreeItemDetails
- CheckoutChanged
- ContextualizedEndpoints
- Country
- Coupon
- CouponErrorResponse
- FacetResponse
- Filter
- FilterGroup
- FrontendUpdateCustomerSettings
- GetOrdersResponse
- GetPaymentResponse
- GetReturnsResponse
- GraduatedPriceList
- InitResult
- ItemSearchResult
- LegalInformationResponse
- OrderPropertiesGroup
- OrderPropertiesGroups
- OrderPropertyLabel
- PaginatedResult
- PasswordResetResult
- PaymentMethod
- PaymentProviders
- PreparePaymentResult
- ProductBundleComponent
- ProductFilter
- ProductParams
- ProductResponse
- Review
- ReviewAverage
- ReviewAverageResponse
- ReviewItem
- ReviewResponse
- SessionResult
- SessionSearchPramas
- SetPaymentProviderParams
- SetPaymentProviderResponse
- ShippingAddress
- ShippingCountryName
- ShippingCountryState
- ShippingMethod
- SourceRelationItem
- State
- Store
- TODO
- TotalVat
- UploadFileForOrderPropertyParams
- User
- UserBillingAddress
- UserBillingAddressItem
- UserBillingAddressSearchCriteria
- UserShippingAddress
- UserShippingAddressItem
- UserShippingAddressSearchCriteria
- VariationMapProductAttribute
- VariationMapProductAttributeValue
- VariationMapProductVariation
- WishlistItem
Functions ​
- deleteAddress
- deleteAllCartItems
- deleteCart
- deleteCartItem
- deleteCoupon
- deleteNewsletterSubscription
- deleteReview
- deleteWishlistItem
- doAddCartItem
- doAddCoupon
- doAddWishlistItem
- doAdditionalInformation
- doApprovePayPalTransaction
- doCapturePayPalOrder
- doChangeUserPassword
- doCreatePayPalCreditCardTransaction
- doCreatePayPalTransaction
- doCustomerContactMail
- doExecutePayment
- doLogin
- doLoginAsGuest
- doLogoutUser
- doMakeOrderReturn
- doPlaceOrder
- doPreparePayment
- doRegisterUser
- doReview
- doSaveAddress
- doSubscribeNewsletter
- doUploadOrderPropertyFile
- exampleEndpoint
- getActiveShippingCountries
- getAddresses
- getAuthenticatedReview
- getCart
- getCategoryTree
- getExecutePayPalOrder
- getFacet
- getFeedbackAverage
- getInit
- getLegalTexts
- getOrder
- getOrderDocument
- getOrders
- getPayPalDataClientToken
- getPaymentProviders
- getProduct
- getReturnReasons
- getReturns
- getReview
- getReviewAverage
- getSearch
- getSession
- getShippingProvider
- getWishlist
- setCartItemQuantity
- setCheckoutAddress
- setPaymentProvider
- setReview
- setShippingProvider
Generated using typedoc-plugin-markdown and TypeDoc