Sap-commerce-webservices-v2 NPM

commerce_webservices_v2

CommerceWebservicesV2 - JavaScript client for commerce_webservices_v2 Commerce Webservices Version 2 This SDK is automatically generated by the Swagger Codegen project:

API version: 2.0
Package version: 2.0
Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install commerce_webservices_v2 --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your commerce_webservices_v2 from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('commerce_webservices_v2') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/commerce_webservices_v2 then install it via:

    npm install YOUR_USERNAME/commerce_webservices_v2 --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var CommerceWebservicesV2 = require('commerce_webservices_v2');

var defaultClient = CommerceWebservicesV2.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservicesV2.AddressApi()

var address = new CommerceWebservicesV2.AddressWsDTO(); // {AddressWsDTO} Address object.

var baseSiteId = "baseSiteId_example"; // {String} Base site identifier

var userId = "userId_example"; // {String} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var opts = { 
  'fields': "DEFAULT" // {String} Response configuration. This is the list of fields that should be returned in the response body.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAddress(address, baseSiteId, userId, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://re-ec-default-b3c5829e-8fbb-4440-a6ec-2156539041ea.kyma-integration.svc.cluster.local

Class	Method	HTTP request	Description
CommerceWebservicesV2.AddressApi	createAddress	POST /{baseSiteId}/users/{userId}/addresses	Creates a new address.
CommerceWebservicesV2.AddressApi	getAddress	GET /{baseSiteId}/users/{userId}/addresses/{addressId}	Get info about address
CommerceWebservicesV2.AddressApi	getAddresses	GET /{baseSiteId}/users/{userId}/addresses	Get customer's addresses
CommerceWebservicesV2.AddressApi	removeAddress	DELETE /{baseSiteId}/users/{userId}/addresses/{addressId}	Delete customer's address.
CommerceWebservicesV2.AddressApi	replaceAddress	PUT /{baseSiteId}/users/{userId}/addresses/{addressId}	Updates the address
CommerceWebservicesV2.AddressApi	updateAddress	PATCH /{baseSiteId}/users/{userId}/addresses/{addressId}	Updates the address
CommerceWebservicesV2.AddressApi	validateAddress	POST /{baseSiteId}/users/{userId}/addresses/verification	Verifies address.
CommerceWebservicesV2.BaseStoresApi	getBaseStore	GET /{baseSiteId}/basestores/{baseStoreUid}	Get a base store.
CommerceWebservicesV2.CartsApi	createCart	POST /{baseSiteId}/users/{userId}/carts	Creates or restore a cart for a user.
CommerceWebservicesV2.CartsApi	createCartDeliveryAddress	POST /{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery	Creates a delivery address for the cart.
CommerceWebservicesV2.CartsApi	createCartEntry	POST /{baseSiteId}/users/{userId}/carts/{cartId}/entries	Adds a product to the cart.
CommerceWebservicesV2.CartsApi	createCartPaymentDetails	POST /{baseSiteId}/users/{userId}/carts/{cartId}/paymentdetails	Defines and assigns details of a new credit card payment to the cart.
CommerceWebservicesV2.CartsApi	doApplyCartPromotion	POST /{baseSiteId}/users/{userId}/carts/{cartId}/promotions	Enables promotions based on the promotionsId of the cart.
CommerceWebservicesV2.CartsApi	doApplyCartVoucher	POST /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers	Applies a voucher based on the voucherId defined for the cart.
CommerceWebservicesV2.CartsApi	getCart	GET /{baseSiteId}/users/{userId}/carts/{cartId}	Get a cart with a given identifier.
CommerceWebservicesV2.CartsApi	getCartDeliveryMode	GET /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode	Get the delivery mode selected for the cart.
CommerceWebservicesV2.CartsApi	getCartDeliveryModes	GET /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymodes	Get all delivery modes for the current store and delivery address.
CommerceWebservicesV2.CartsApi	getCartEntries	GET /{baseSiteId}/users/{userId}/carts/{cartId}/entries	Get cart entries.
CommerceWebservicesV2.CartsApi	getCartEntry	GET /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}	Get the details of the cart entries.
CommerceWebservicesV2.CartsApi	getCartPromotion	GET /{baseSiteId}/users/{userId}/carts/{cartId}/promotions/{promotionId}	Get information about promotion applied on cart.
CommerceWebservicesV2.CartsApi	getCartPromotions	GET /{baseSiteId}/users/{userId}/carts/{cartId}/promotions	Get information about promotions applied on cart.
CommerceWebservicesV2.CartsApi	getCartVouchers	GET /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers	Get a list of vouchers applied to the cart.
CommerceWebservicesV2.CartsApi	getCarts	GET /{baseSiteId}/users/{userId}/carts	Get all customer carts.
CommerceWebservicesV2.CartsApi	removeCart	DELETE /{baseSiteId}/users/{userId}/carts/{cartId}	Deletes a cart with a given cart id.
CommerceWebservicesV2.CartsApi	removeCartDeliveryAddress	DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery	Deletes the delivery address from the cart.
CommerceWebservicesV2.CartsApi	removeCartDeliveryMode	DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode	Deletes the delivery mode from the cart.
CommerceWebservicesV2.CartsApi	removeCartEntry	DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}	Deletes cart entry.
CommerceWebservicesV2.CartsApi	removeCartPromotion	DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/promotions/{promotionId}	Disables the promotion based on the promotionsId of the cart.
CommerceWebservicesV2.CartsApi	removeCartVoucher	DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers/{voucherId}	Deletes a voucher defined for the current cart.
CommerceWebservicesV2.CartsApi	replaceCartDeliveryAddress	PUT /{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery	Sets a delivery address for the cart.
CommerceWebservicesV2.CartsApi	replaceCartDeliveryMode	PUT /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode	Sets the delivery mode for a cart.
CommerceWebservicesV2.CartsApi	replaceCartEntry	PUT /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}	Set quantity and store details of a cart entry.
CommerceWebservicesV2.CartsApi	replaceCartGuestUser	PUT /{baseSiteId}/users/{userId}/carts/{cartId}/email	Assigns an email to the cart.
CommerceWebservicesV2.CartsApi	replaceCartPaymentDetails	PUT /{baseSiteId}/users/{userId}/carts/{cartId}/paymentdetails	Sets credit card payment details for the cart.
CommerceWebservicesV2.CartsApi	updateCartEntry	PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}	Update quantity and store details of a cart entry.
CommerceWebservicesV2.CatalogsApi	getCatalog	GET /{baseSiteId}/catalogs/{catalogId}	Get a catalog
CommerceWebservicesV2.CatalogsApi	getCatalogVersion	GET /{baseSiteId}/catalogs/{catalogId}/{catalogVersionId}	Get information about catalog version
CommerceWebservicesV2.CatalogsApi	getCatalogs	GET /{baseSiteId}/catalogs	Get a list of catalogs
CommerceWebservicesV2.CatalogsApi	getCategories	GET /{baseSiteId}/catalogs/{catalogId}/{catalogVersionId}/categories/{categoryId}	Get information about catagory in a catalog version
CommerceWebservicesV2.ComponentApi	getComponentByIdListUsingPOST	POST /{baseSiteId}/cms/components	Get components' data by id given in body
CommerceWebservicesV2.ComponentApi	getComponentByIdUsingGET	GET /{baseSiteId}/cms/components/{componentId}	Get component data
CommerceWebservicesV2.ConsentsApi	doGiveConsent	POST /{baseSiteId}/users/{userId}/consents	A user can give consent.
CommerceWebservicesV2.ConsentsApi	getConsentTemplate	GET /{baseSiteId}/users/{userId}/consenttemplates/{consentTemplateId}	Fetch the consent.
CommerceWebservicesV2.ConsentsApi	getConsentTemplates	GET /{baseSiteId}/users/{userId}/consenttemplates	Fetch the list of consents
CommerceWebservicesV2.ConsentsApi	removeConsent	DELETE /{baseSiteId}/users/{userId}/consents/{consentCode}	Withdraw the user consent for a given consent code.
CommerceWebservicesV2.CountriesApi	getCountries	GET /{baseSiteId}/countries	Get a list of countries.
CommerceWebservicesV2.CountriesApi	getCountryRegions	GET /{baseSiteId}/countries/{countyIsoCode}/regions	Fetch the list of regions for the provided country.
CommerceWebservicesV2.CustomerGroupsApi	createCustomerGroup	POST /{baseSiteId}/customergroups	Creates a new customer group.
CommerceWebservicesV2.CustomerGroupsApi	getCustomerGroup	GET /{baseSiteId}/customergroups/{groupId}	Get a specific customer group.
CommerceWebservicesV2.CustomerGroupsApi	getCustomerGroups	GET /{baseSiteId}/customergroups	Get all subgroups of a customergroup.
CommerceWebservicesV2.CustomerGroupsApi	removeUsersFromCustomerGroup	DELETE /{baseSiteId}/customergroups/{groupId}/members/{userId}	Deletes a user from a customer group.
CommerceWebservicesV2.CustomerGroupsApi	replaceUsersForCustomerGroup	PUT /{baseSiteId}/customergroups/{groupId}/members	Sets members for a user group.
CommerceWebservicesV2.CustomerGroupsApi	updateCustomerGroupWithUsers	PATCH /{baseSiteId}/customergroups/{groupId}/members	Assigns user(s) to a customer group.
CommerceWebservicesV2.ExportApi	getExportedProducts	GET /{baseSiteId}/export/products	Get a list of product exports.
CommerceWebservicesV2.ExtendedCartsApi	createConsolidatedPickupLocation	POST /{baseSiteId}/users/{userId}/carts/{cartId}/consolidate	Handles the consolidating pickup locations.
CommerceWebservicesV2.ExtendedCartsApi	doHandleSopPaymentResponse	POST /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/response	Handles response from payment provider and create payment details
CommerceWebservicesV2.ExtendedCartsApi	getConsolidatedPickupLocations	GET /{baseSiteId}/users/{userId}/carts/{cartId}/consolidate	Get consolidated pickup options.
CommerceWebservicesV2.ExtendedCartsApi	getSopPaymentRequestDetails	GET /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/request	Get information needed for create subscription
CommerceWebservicesV2.ExtendedCartsApi	getSopPaymentResponse	GET /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/response	Get information about create subscription request results
CommerceWebservicesV2.ExtendedCartsApi	removeSopPaymentResponse	DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/response	Deletes payment provider response related to cart.
CommerceWebservicesV2.FeedsApi	getOrderStatusFeed	GET /{baseSiteId}/feeds/orders/statusfeed	Get a list of orders with status updates.
CommerceWebservicesV2.ForgottenPasswordsApi	doRestorePassword	POST /{baseSiteId}/forgottenpasswordtokens	Generates a token to restore a customer's forgotten password.
CommerceWebservicesV2.MerchantCallbackApi	doHandleCartMerchantCallback	POST /{baseSiteId}/integration/users/{userId}/carts/{cartId}/payment/sop/response	Verify the decision of the Merchant for a cart
CommerceWebservicesV2.MerchantCallbackApi	doHandleMerchantCallback	POST /{baseSiteId}/integration/merchant_callback	Verify the decision of the Merchant
CommerceWebservicesV2.MiscsApi	getCardTypes	GET /{baseSiteId}/cardtypes	Get a list of supported payment card types.
CommerceWebservicesV2.MiscsApi	getCurrencies	GET /{baseSiteId}/currencies	Get a list of available currencies.
CommerceWebservicesV2.MiscsApi	getDeliveryCountries	GET /{baseSiteId}/deliverycountries	Get a list of shipping countries.
CommerceWebservicesV2.MiscsApi	getLanguages	GET /{baseSiteId}/languages	Get a list of available languages.
CommerceWebservicesV2.MiscsApi	getTitles	GET /{baseSiteId}/titles	Get a list of all localized titles.
CommerceWebservicesV2.OrdersApi	countUserOrders	HEAD /{baseSiteId}/users/{userId}/orders	Get total number of orders.
CommerceWebservicesV2.OrdersApi	getOrder	GET /{baseSiteId}/orders/{code}	Get a order.
CommerceWebservicesV2.OrdersApi	getUserOrderHistory	GET /{baseSiteId}/users/{userId}/orders	Get order history for user.
CommerceWebservicesV2.OrdersApi	getUserOrders	GET /{baseSiteId}/users/{userId}/orders/{code}	Get a order.
CommerceWebservicesV2.OrdersApi	placeOrder	POST /{baseSiteId}/users/{userId}/orders	Place a order.
CommerceWebservicesV2.PageApi	getPageDataUsingGET	GET /{baseSiteId}/cms/pages	Get page data with list of cms content slots
CommerceWebservicesV2.PaymentDetailsApi	getPaymentDetails	GET /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}	Get customer's credit card payment details.
CommerceWebservicesV2.PaymentDetailsApi	getPaymentDetailsList	GET /{baseSiteId}/users/{userId}/paymentdetails	Get customer's credit card payment details list.
CommerceWebservicesV2.PaymentDetailsApi	removePaymentDetails	DELETE /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}	Deletes customer's credit card payment details.
CommerceWebservicesV2.PaymentDetailsApi	replacePaymentDetails	PUT /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}	Updates existing customer's credit card payment info.
CommerceWebservicesV2.PaymentDetailsApi	updatePaymentDetails	PATCH /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}	Updates existing customer's credit card payment details.
CommerceWebservicesV2.ProductsApi	countProductStockByLocation	HEAD /{baseSiteId}/products/{productCode}/stock	Get header with a total number of product's stock levels.
CommerceWebservicesV2.ProductsApi	countProducts	HEAD /{baseSiteId}/products/search	Get a header with total number of products.
CommerceWebservicesV2.ProductsApi	createProductReview	POST /{baseSiteId}/products/{productCode}/reviews	Creates a new customer review as an anonymous user.
CommerceWebservicesV2.ProductsApi	getExpressUpdateProducts	GET /{baseSiteId}/products/expressupdate	Get products added to the express update feed.
CommerceWebservicesV2.ProductsApi	getLocationProductStock	GET /{baseSiteId}/products/{productCode}/stock	Get a product's stock level.
CommerceWebservicesV2.ProductsApi	getProduct	GET /{baseSiteId}/products/{productCode}	Get product details.
CommerceWebservicesV2.ProductsApi	getProductReferences	GET /{baseSiteId}/products/{productCode}/references	Get a product reference
CommerceWebservicesV2.ProductsApi	getProductReviews	GET /{baseSiteId}/products/{productCode}/reviews	Get reviews for a product
CommerceWebservicesV2.ProductsApi	getProducts	GET /{baseSiteId}/products/search	Get a list of products and additional data
CommerceWebservicesV2.ProductsApi	getStoreProductStock	GET /{baseSiteId}/products/{productCode}/stock/{storeName}	Get a product's stock level for a store
CommerceWebservicesV2.ProductsApi	getSuggestions	GET /{baseSiteId}/products/suggestions	Get a list of available suggestions
CommerceWebservicesV2.PromotionsApi	getPromotion	GET /{baseSiteId}/promotions/{code}	Get a promotion based on code
CommerceWebservicesV2.PromotionsApi	getPromotions	GET /{baseSiteId}/promotions	Get a list of promotions.
CommerceWebservicesV2.SaveCartApi	doCartClone	POST /{baseSiteId}/users/{userId}/carts/{cartId}/clonesavedcart	Explicitly clones a cart.
CommerceWebservicesV2.SaveCartApi	doSaveCart	PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/save	Explicitly saves a cart.
CommerceWebservicesV2.SaveCartApi	doUpdateFlagForDeletion	PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/flagForDeletion	Flag a cart for deletion.
CommerceWebservicesV2.SaveCartApi	doUpdateSavedCart	PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/restoresavedcart	Restore a saved cart.
CommerceWebservicesV2.SaveCartApi	getSavedCart	GET /{baseSiteId}/users/{userId}/carts/{cartId}/savedcart	Get a saved cart.
CommerceWebservicesV2.StoresApi	countStoreLocations	HEAD /{baseSiteId}/stores	Get a header with the number of store locations.
CommerceWebservicesV2.StoresApi	getStoreLocation	GET /{baseSiteId}/stores/{storeId}	Get a store location.
CommerceWebservicesV2.StoresApi	getStoreLocations	GET /{baseSiteId}/stores	Get a list of store locations
CommerceWebservicesV2.UsersApi	createUser	POST /{baseSiteId}/users	Registers a customer
CommerceWebservicesV2.UsersApi	getUser	GET /{baseSiteId}/users/{userId}	Get customer profile
CommerceWebservicesV2.UsersApi	getUserCustomerGroups	GET /{baseSiteId}/users/{userId}/customergroups	Get all customer groups of a customer.
CommerceWebservicesV2.UsersApi	removeUser	DELETE /{baseSiteId}/users/{userId}	Delete customer profile.
CommerceWebservicesV2.UsersApi	replaceUser	PUT /{baseSiteId}/users/{userId}	Updates customer profile
CommerceWebservicesV2.UsersApi	replaceUserLogin	PUT /{baseSiteId}/users/{userId}/login	Changes customer's login name.
CommerceWebservicesV2.UsersApi	replaceUserPassword	PUT /{baseSiteId}/users/{userId}/password	Changes customer's password
CommerceWebservicesV2.UsersApi	updateUser	PATCH /{baseSiteId}/users/{userId}	Updates customer profile
CommerceWebservicesV2.VouchersApi	getVoucher	GET /{baseSiteId}/vouchers/{code}	Get a voucher based on code.

Documentation for Models

Documentation for Authorization

oauth2_Password

Type: OAuth
Flow: password
Authorization URL:
Scopes:
- basic:

oauth2_client_credentials

Type: OAuth
Flow: application
Authorization URL:
Scopes:
- extended:

superagent

@infinitebrahmanuniverse/nolb-sap

0.0.1

6 years ago