You are reading the documentation for v7.x and earlier, which is no longer the latest version. Switch to v8.x
@vsf-enterprise/sap-commerce-webservices-sdk
This is the API reference documentation for the @vsf-enterprise/sap-commerce-webservices-sdk library. It contains all of the available methods, interfaces, and other implementation details for interacting with the @vsf-enterprise/sap-commerce-webservices-sdk API.
Interfaces
- AccountSummary
- Address
- AddressList
- AddressValidation
- AmountBalance
- B2BApprovalProcess
- B2BApprovalProcessList
- B2BCostCenter
- B2BCostCenterList
- B2BCostCenterShallow
- B2BPaymentType
- B2BPaymentTypeData
- B2BPaymentTypeList
- B2BSelectionData
- B2BUnit
- B2BUnitNode
- B2BUnitNodeList
- BaseOption
- BaseSite
- BaseSiteList
- BaseStore
- BasicnotificationPreference
- BasicnotificationPreferenceList
- Breadcrumb
- Budget
- BudgetList
- BudgetShallow
- BundleStarter
- BundleTemplate
- CancellationRequestEntryInput
- CancellationRequestEntryInputList
- CaptchaConfig
- CardType
- CardTypeList
- Carrier
- Cart
- CartList
- CartModification
- CartModificationList
- Catalog
- CatalogList
- CatalogVersion
- Category
- CategoryHierarchy
- CCPAttribute
- CCPAttributePricing
- CCPAttributeValue
- CCPAttributeValueOverview
- CCPAttributeValuePricing
- CCPConfiguration
- CCPConfigurationOverallPricing
- CCPConfigurationOverview
- CCPConfigurationPricing
- CCPConfigurationProductVariant
- CCPConflict
- CCPFilterData
- CCPGroup
- CCPGroupOverview
- CCPKBData
- CCPMessage
- CCPOrderEntry
- ChinesePaymentInfo
- City
- CityList
- Classification
- Comment_2
- ComponentIDList
- ConfigurationInfo
- ConfigurationInfoList
- Consent
- ConsentTemplate
- ConsentTemplateList
- Consignment
- ConsignmentEntry
- ConsignmentTracking
- ConsignmentTrackingEvent
- Conversation
- ConversationList
- ConversationMessage
- ConversationMessageList
- Country
- CountryList
- CreateComment
- Currency
- CurrencyList
- CustomerCoupon
- CustomerCoupon2Customer
- CustomerCouponNotification
- CustomerCouponSearchResult
- CustomerInterestsSearchPage
- CXML
- DayRange
- DeliveryMode
- DeliveryModeList
- DeliveryOrderEntryGroup
- DeliveryTimeSlot
- DeprecatedPagination
- District
- DistrictList
- DsCanonicalizationMethod
- DsDigestMethod
- DsKeyInfo
- DsObject
- DsReference
- DsSignature
- DsSignatureMethod
- DsSignatureValue
- DsSignedInfo
- DsTransform
- DsTransforms
- DueBalanceRange
- EntryGroup
- ErrorList
- Facet
- FacetValue
- Feature
- FeatureUnit
- FeatureValue
- FutureStock
- GeoPoint
- Image_2
- Language
- LanguageList
- ListAdaptedComponents
- ListAdaptedPages
- MemberList
- ModelError
- NotificationPreference
- NotificationPreferenceList
- OpeningSchedule
- Order
- OrderApproval
- OrderApprovalDecision
- OrderApprovalList
- OrderApprovalPermission
- OrderApprovalPermissionList
- OrderApprovalPermissionResult
- OrderApprovalPermissionType
- OrderApprovalPermissionTypeList
- OrderApprovalRecord
- OrderEntry
- OrderEntryList
- OrderForm
- OrderFormEntry
- OrderFormList
- OrderHistory
- OrderHistoryList
- OrderStatusUpdateElement
- OrderStatusUpdateElementList
- OrgCustomerCreation
- OrgCustomerModification
- OrgDocument
- OrgDocumentAttachment
- OrgDocumentList
- OrgDocumentType
- OrgUnitReference
- OrgUnitUserGroup
- OrgUnitUserGroupList
- OrgUnitUserList
- OrgUserRegistrationData
- PackagingInfo
- Pagination
- PaymentDetails
- PaymentDetailsList
- PaymentMode
- PaymentModeList
- PaymentRequest_2
- PickupOrderEntryGroup
- PointOfService
- PointOfServiceList
- PointOfServiceStock
- Price
- PriceRange
- Principal
- Product
- ProductExpressUpdateElement
- ProductExpressUpdateElementList
- ProductFutureStocks
- ProductFutureStocksList
- ProductInterestEntry
- ProductInterestRelation
- ProductList
- ProductReference
- ProductReferenceList
- ProductSearchPage
- Promotion
- PromotionList
- PromotionOrderEntryConsumed
- PromotionRestriction
- PromotionResult
- PromotionResultList
- PunchOutSessionInfo
- PunchOutToken
- Quote
- QuoteAction
- QuoteDiscount
- QuoteList
- QuoteMetadata
- QuoteStarter
- Region
- RegionList
- ReplenishmentOrder
- ReplenishmentOrderList
- RequisitionFormData
- ResetPassword
- ReturnRequest
- ReturnRequestEntry
- ReturnRequestEntryInput
- ReturnRequestEntryInputList
- ReturnRequestList
- ReturnRequestModification
- Review
- ReviewList
- SAPInvoice
- SAPInvoiceList
- SaveCartResult
- ScheduleReplenishmentForm
- SearchQuery
- SearchState
- SiteMessage
- SiteMessageSearchResult
- Sort
- SpecialOpeningDay
- SpellingSuggestion
- StatusSummary
- Stock
- StoreCount
- StoreCountList
- StoreFinderSearchPage
- StoreFinderStockSearchPage
- Suggestion
- SuggestionList
- TaxInvoice
- Ticket
- TicketAssociatedObject
- TicketAssociatedObjectList
- TicketCategory
- TicketCategoryList
- TicketEvent
- TicketEventAttachment
- TicketList
- TicketStarter
- TicketStatus
- Time
- Title
- TitleList
- Trigger
- User
- UserAvatar
- UserGroup
- UserGroupList
- UserSignUp
- VariantCategory
- VariantMatrixElement
- VariantOption
- VariantOptionQualifier
- VariantValueCategory
- Voucher
- VoucherList
- WeekdayOpeningDay
Variables
- AddCartEntryFieldsEnum
- CCPAttributeTypeEnum
- CCPAttributeValidationTypeEnum
- CreateCartFromOrderFieldsEnum
- GetAllPagesFieldsEnum
- GetAllPagesPageTypeEnum
- GetAllPagesWithUserFieldsEnum
- GetAllPagesWithUserPageTypeEnum
- GetComponentByIdAndUserFieldsEnum
- GetComponentByIdFieldsEnum
- GetComponentsByIdsAndUserFieldsEnum
- GetComponentsByIdsFieldsEnum
- GetConversationsForAgentStatusEnum
- GetCountriesTypeEnum
- GetCustomerCouponsNeedsTotalEnum
- GetOrgCustomerFieldsEnum
- GetPageByIdAndUserFieldsEnum
- GetPageByIdFieldsEnum
- GetPageFieldsEnum
- GetPagePageTypeEnum
- GetPageWithUserFieldsEnum
- GetPageWithUserPageTypeEnum
- GetProductInterestsNeedsTotalEnum
- GetPromotionsTypeEnum
- ImageImageTypeEnum
- OrderApprovalPermissionPeriodRangeEnum
- PricePriceTypeEnum
- PunchOutSessionInfoPunchOutLevelEnum
- PunchOutSessionInfoPunchOutOperationEnum
- ReturnRequestModificationStatusEnum
- ScheduleReplenishmentFormDaysOfWeekEnum
- SearchComponentsByIdsFieldsEnum
- SiteMessageNotificationTypeEnum
- SiteMessagesNeedsTotalEnum
Functions
- AddressApiAxiosParamCreator
- AddressApiFactory
- AddressApiFp
- B2BCartsApiAxiosParamCreator
- B2BCartsApiFactory
- B2BCartsApiFp
- B2BCategoriesApiAxiosParamCreator
- B2BCategoriesApiFactory
- B2BCategoriesApiFp
- B2BCostCentersApiAxiosParamCreator
- B2BCostCentersApiFactory
- B2BCostCentersApiFp
- B2BMiscsApiAxiosParamCreator
- B2BMiscsApiFactory
- B2BMiscsApiFp
- B2BOrdersApiAxiosParamCreator
- B2BOrdersApiFactory
- B2BOrdersApiFp
- B2BProductsApiAxiosParamCreator
- B2BProductsApiFactory
- B2BProductsApiFp
- B2BUsersApiAxiosParamCreator
- B2BUsersApiFactory
- B2BUsersApiFp
- BaseSitesApiAxiosParamCreator
- BaseSitesApiFactory
- BaseSitesApiFp
- BaseStoresApiAxiosParamCreator
- BaseStoresApiFactory
- BaseStoresApiFp
- BudgetManagementApiAxiosParamCreator
- BudgetManagementApiFactory
- BudgetManagementApiFp
- BundlesApiAxiosParamCreator
- BundlesApiFactory
- BundlesApiFp
- CartAddressesApiAxiosParamCreator
- CartAddressesApiFactory
- CartAddressesApiFp
- CartDeliveryModesApiAxiosParamCreator
- CartDeliveryModesApiFactory
- CartDeliveryModesApiFp
- CartEntriesApiAxiosParamCreator
- CartEntriesApiFactory
- CartEntriesApiFp
- CartEntryGroupsApiAxiosParamCreator
- CartEntryGroupsApiFactory
- CartEntryGroupsApiFp
- CartPaymentsApiAxiosParamCreator
- CartPaymentsApiFactory
- CartPaymentsApiFp
- CartPromotionsApiAxiosParamCreator
- CartPromotionsApiFactory
- CartPromotionsApiFp
- CartsApiAxiosParamCreator
- CartsApiFactory
- CartsApiFp
- CatalogsApiAxiosParamCreator
- CatalogsApiFactory
- CatalogsApiFp
- CitiesApiAxiosParamCreator
- CitiesApiFactory
- CitiesApiFp
- ComponentsApiAxiosParamCreator
- ComponentsApiFactory
- ComponentsApiFp
- ConsentsApiAxiosParamCreator
- ConsentsApiFactory
- ConsentsApiFp
- ConsignmentTrackingApiAxiosParamCreator
- ConsignmentTrackingApiFactory
- ConsignmentTrackingApiFp
- CountriesApiAxiosParamCreator
- CountriesApiFactory
- CountriesApiFp
- CustomerCouponsApiAxiosParamCreator
- CustomerCouponsApiFactory
- CustomerCouponsApiFp
- CustomerGroupsApiAxiosParamCreator
- CustomerGroupsApiFactory
- CustomerGroupsApiFp
- ExportApiAxiosParamCreator
- ExportApiFactory
- ExportApiFp
- FeedsApiAxiosParamCreator
- FeedsApiFactory
- FeedsApiFp
- ForgottenPasswordsApiAxiosParamCreator
- ForgottenPasswordsApiFactory
- ForgottenPasswordsApiFp
- FutureStocksApiAxiosParamCreator
- FutureStocksApiFactory
- FutureStocksApiFp
- InvoicesApiAxiosParamCreator
- InvoicesApiFactory
- InvoicesApiFp
- LoginNotificationApiAxiosParamCreator
- LoginNotificationApiFactory
- LoginNotificationApiFp
- MerchantCallbackApiAxiosParamCreator
- MerchantCallbackApiFactory
- MerchantCallbackApiFp
- MessageCenterApiAxiosParamCreator
- MessageCenterApiFactory
- MessageCenterApiFp
- MiscsApiAxiosParamCreator
- MiscsApiFactory
- MiscsApiFp
- NotificationPreferenceApiAxiosParamCreator
- NotificationPreferenceApiFactory
- NotificationPreferenceApiFp
- OrderApprovalPermissionsApiAxiosParamCreator
- OrderApprovalPermissionsApiFactory
- OrderApprovalPermissionsApiFp
- OrderApprovalPermissionTypesApiAxiosParamCreator
- OrderApprovalPermissionTypesApiFactory
- OrderApprovalPermissionTypesApiFp
- OrderApprovalsApiAxiosParamCreator
- OrderApprovalsApiFactory
- OrderApprovalsApiFp
- OrderFormsApiAxiosParamCreator
- OrderFormsApiFactory
- OrderFormsApiFp
- OrdersApiAxiosParamCreator
- OrdersApiFactory
- OrdersApiFp
- OrganizationalUnitAccountSummaryApiAxiosParamCreator
- OrganizationalUnitAccountSummaryApiFactory
- OrganizationalUnitAccountSummaryApiFp
- OrganizationalUnitCustomerManagementApiAxiosParamCreator
- OrganizationalUnitCustomerManagementApiFactory
- OrganizationalUnitCustomerManagementApiFp
- OrganizationalUnitManagementApiAxiosParamCreator
- OrganizationalUnitManagementApiFactory
- OrganizationalUnitManagementApiFp
- OrganizationalUnitUserGroupsApiAxiosParamCreator
- OrganizationalUnitUserGroupsApiFactory
- OrganizationalUnitUserGroupsApiFp
- PagesApiAxiosParamCreator
- PagesApiFactory
- PagesApiFp
- PaymentDetailsApiAxiosParamCreator
- PaymentDetailsApiFactory
- PaymentDetailsApiFp
- PaymentModesApiAxiosParamCreator
- PaymentModesApiFactory
- PaymentModesApiFp
- ProductConfiguratorCCPApiAxiosParamCreator
- ProductConfiguratorCCPApiFactory
- ProductConfiguratorCCPApiFp
- ProductConfiguratorCCPCartIntegrationApiAxiosParamCreator
- ProductConfiguratorCCPCartIntegrationApiFactory
- ProductConfiguratorCCPCartIntegrationApiFp
- ProductConfiguratorCCPOrderIntegrationApiAxiosParamCreator
- ProductConfiguratorCCPOrderIntegrationApiFactory
- ProductConfiguratorCCPOrderIntegrationApiFp
- ProductConfiguratorCCPQuoteIntegrationApiAxiosParamCreator
- ProductConfiguratorCCPQuoteIntegrationApiFactory
- ProductConfiguratorCCPQuoteIntegrationApiFp
- ProductConfiguratorCCPSavedCartIntegrationApiAxiosParamCreator
- ProductConfiguratorCCPSavedCartIntegrationApiFactory
- ProductConfiguratorCCPSavedCartIntegrationApiFp
- ProductConfiguratorCCPVariantSearchApiAxiosParamCreator
- ProductConfiguratorCCPVariantSearchApiFactory
- ProductConfiguratorCCPVariantSearchApiFp
- ProductConfiguratorTextfieldTemplateApiAxiosParamCreator
- ProductConfiguratorTextfieldTemplateApiFactory
- ProductConfiguratorTextfieldTemplateApiFp
- ProductInterestsApiAxiosParamCreator
- ProductInterestsApiFactory
- ProductInterestsApiFp
- ProductsApiAxiosParamCreator
- ProductsApiFactory
- ProductsApiFp
- PromotionsApiAxiosParamCreator
- PromotionsApiFactory
- PromotionsApiFp
- PunchOutApiAxiosParamCreator
- PunchOutApiFactory
- PunchOutApiFp
- QuotesApiAxiosParamCreator
- QuotesApiFactory
- QuotesApiFp
- ReplenishmentOrderApiAxiosParamCreator
- ReplenishmentOrderApiFactory
- ReplenishmentOrderApiFp
- ReturnRequestsApiAxiosParamCreator
- ReturnRequestsApiFactory
- ReturnRequestsApiFp
- SaveCartApiAxiosParamCreator
- SaveCartApiFactory
- SaveCartApiFp
- SiteMessagesApiAxiosParamCreator
- SiteMessagesApiFactory
- SiteMessagesApiFp
- StoresApiAxiosParamCreator
- StoresApiFactory
- StoresApiFp
- TicketsApiAxiosParamCreator
- TicketsApiFactory
- TicketsApiFp
- UsersApiAxiosParamCreator
- UsersApiFactory
- UsersApiFp
- VouchersApiAxiosParamCreator
- VouchersApiFactory
- VouchersApiFp