# Api Client
# Table of contents
# Namespaces
# Enumerations
# Interfaces
- AccessTokenData
- AccessTokenParams
- AccessTokenParamsAttributes
- AddCartItemParams
- AddCartItemParamsAttributes
- AddCartItemParamsAttributesProductOption
- AddCartItemParamsAttributesSalesUnit
- AddGuestCartItemParams
- ApiError
- ApiErrors
- ApiSetupConfig
- CancelTokenRecord
- CancelableRequestObject
- CartConcreteProductAttributes
- CartConcreteProductAvailabilitiesAttributes
- CartConcreteProductImageAttributes
- CartConcreteProductImageSetsAttributes
- CartConcreteProductImagesAttributes
- CartConcreteProductPrice
- CartConcreteProductPricesAttributes
- CartData
- CartDataAttributes
- CartDataDiscount
- CartDataRelationshipItem
- CartDataTotals
- CartItemAttributes
- CartItemAttributesCalculations
- CartParams
- CartParamsAttributes
- CheckoutAddress
- CheckoutData
- CheckoutIncludesList
- CheckoutOrderCustomer
- CheckoutOrderParams
- CheckoutOrderRequestAttributes
- CheckoutOrderRequestHeaders
- CheckoutOrderResponseAttributes
- CheckoutParams
- CheckoutPaymentMethodAttributes
- CheckoutRequestParams
- CheckoutShipmentAddressAttributes
- CheckoutShipmentMethodAttributes
- CheckoutShipmentsAttributes
- CheckoutTotals
- ConfirmCustomerParams
- CreateApiFactoryParams
- CreateCustomerAddressParams
- CreateCustomerParams
- CreateReturnData
- CreateReturnParams
- CreateUserCartParams
- CustomerAddress
- CustomerAddressAttributes
- CustomerData
- CustomerParams
- CustommerForgottenPasswordParams
- CustommerRestorePasswordParams
- DeleteCustomerAddressParams
- Error
- GenericDataSuccess
- GetReturnsParams
- GuestCartData
- GuestCartParams
- GuestCartRelationships
- Headers
- Include
- IncludedReturnItemsAttributes
- Links
- OrderAttributes
- OrderItem
- OrdersLoadParams
- PaymentProviderMethod
- RemoveCartItemParams
- RemoveGuestCartItemParams
- Request
- RequestError
- Response
- ReturnItems
- ReturnReasonsAttributes
- ReturnsData
- ReturnsDataRelationships
- TokenData
- UpdateCartItemQuantityAttributes
- UpdateCartItemQuantityParams
- UpdateCartParams
- UpdateCustomerAddressParams
- UpdateGuestCartItemQuantityAttributes
- UpdateGuestCartItemQuantityParams
- UpdateGuestCartParams
- UserCartData
- UserCartRelationships
- ValidationError
# Type aliases
- AcceptHeader
- AccessTokenRequestData
- AccessTokenResult
- AddCartItemRequestData
- AddGuestCartItemRequestData
- AddProductToWishlistResult
- AddedProductToWishlistInclude
- CancelableRequestFactory
- Cart
- CartConcreteProductAvailabilitiesInclude
- CartConcreteProductImageSetsInclude
- CartConcreteProductInclude
- CartConcreteProductPricesInclude
- CartInclude
- CartIncludeAttributes
- CartItemInclude
- CartRuleAttribute
- CartRuleInclude
- CartVoucherAttributes
- CartVoucherInclude
- CatalogData
- CatalogDataAttributes
- CatalogSearchParams
- CatalogSearchResponse
- Category
- CategoryFilter
- CategoryTreeInclude
- CategoryTreeResponse
- CheckoutIncludes
- CheckoutOrderRequest
- CheckoutOrderResult
- CheckoutPaymentMethodInclude
- CheckoutResponse
- CheckoutShipmentAddressInclude
- CheckoutShipmentMethodInclude
- CheckoutShipmentsInclude
- ConfirmCustomerRequestConfig
- CreateCustomerAddressAttributes
- CreateCustomerAddressRequestData
- CreateCustomerRequestConfig
- CreateReturnRequestConfig
- CreateUserCartRequestData
- CustomerAddressResult
- CustomerAddressesResult
- CustomerDataResult
- CustomerUpdatePassword
- CustomerUpdatePasswordResult
- CustommerForgottenPasswordRequestConfig
- CustommerRestorePasswordRequestConfig
- FacetConfig
- FilterParam
- GenericResult
- GiftCardAttributes
- GiftCardInclude
- GuestCartResult
- LineItem
- OrdersData
- OrdersDataResult
- Pagination
- PaginationConfig
- ProductImages
- ProductInclude
- ProductPrice
- ProductRelations
- ProductResponse
- ProductReview
- ProductReviewInclude
- ProductSearchParams
- ProductVariant
- RangeFacetItem
- RelationData
- RemoveGuestCartItemResult
- RemoveProductFromWishlistResult
- RemoveWishlistResult
- Result
- ReturnReason
- ReturnReasonsResponse
- ReturnsDataResult
- ReturnsDetailsResult
- ReturnsIncluded
- ReturnsListResult
- ShippingMethod
- SingleCategoryResponse
- Sort
- UpdateCartItemRequestData
- UpdateCustomerAddressRequestData
- UpdateGuestCartItemRequestData
- UserCartResult
- ValueFacetItem
- VoucherCardInclude
- VoucherCardResult
- Wishlist
- WishlistAttributes
- WishlistCreateResult
- WishlistInclude
- WishlistRelationships
- WishlistResponse
- WishlistsResponse
# Properties
# Functions
- addEtagToData
- createApiFactory
- extractEtag
- generateIncludes
- generateParam
- generateParams
- generateUrl
- getData
- handleError
- handleResponse
- makeCancelableRequestObject
- mapToGenericSuccess
- unwrapData
# Properties
# endpoints
• endpoints: object
# Type declaration:
Name | Type |
---|---|
accessTokens | object |
accessTokens.url | string |
carts | object |
carts.cartCodes | string |
carts.include | EIncludeTypes[] |
carts.url | string |
catalog | object |
catalog.include | string[] |
catalog.url | string |
checkout | object |
checkout.url | string |
checkoutOrder | object |
checkoutOrder.url | string |
customerConfirmation | object |
customerConfirmation.url | string |
customerRestorePassword | object |
customerRestorePassword.url | string |
customers | object |
customers.customerPassword | string |
customers.url | string |
custommerForgottenPassword | object |
custommerForgottenPassword.url | string |
guestCartItems | object |
guestCartItems.include | EIncludeTypes[] |
guestCartItems.url | string |
guestCarts | object |
guestCarts.include | EIncludeTypes[] |
guestCarts.url | string |
orders | object |
orders.include | EIncludeTypes[] |
orders.url | string |
products | object |
products.abstract | object |
products.abstract.include | string[] |
products.abstract.url | string |
products.alternative | object |
products.alternative.include | string[] |
products.alternative.slug | string[] |
products.alternative.url | string |
products.concrete | object |
products.concrete.include | string[] |
products.concrete.url | string |
returns | object |
returns.include | EIncludeTypes[] |
returns.returnReasonsUrl | string |
returns.url | string |
wishlists | object |
wishlists.include | string[] |
wishlists.url | string |