new module:api/UsersApi(apiClient)
Constructs a new UsersApi.
Parameters:
| Name | Type | Description |
|---|---|---|
apiClient |
module:ApiClient | Optional API client implementation to use, default to module:ApiClient#instance if unspecified. |
- Source:
Methods
deleteCart(userId, cartId) → {Promise}
getCart Deletes a cart with a given cart id. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
deleteCartDeliveryAddress(userId, cartId) → {Promise}
postCartDeliveryAddress Removes the delivery address from the cart. Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
deleteCartDeliveryMode(userId, cartId) → {Promise}
getCartDeliveryMode Removes the delivery mode from the cart. Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
deleteCartEntry(userId, cartId, entryNumber) → {Promise}
getCartEntry Deletes cart entry. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
entryNumber |
String | Entry number. Zero-based numbering. |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
deleteCartPromotion(userId, cartId, promotionId) → {Promise}
getCartPromotion Disables the promotion for the order based on the promotionId defined for the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers and therefore some of them are currently not compatible with the new promotion engine. Security: Permitted only for trusted clients
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
promotionId |
String | Promotion identifier (code) |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
deleteCartVouchers(userId, cartId, voucherId) → {Promise}
deleteCartVouchers Removes a voucher based on the voucherId defined for the current cart. Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
voucherId |
String | Voucher identifier (code) |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
deletePaymentDetail(userId, paymentDetailsId) → {Promise}
getPaymentDetail Removes customer's credit card payment details based on its ID. Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
paymentDetailsId |
String | Payment details identifier |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
deleteUser(userId) → {Promise}
getUser Removes customer profile. Security: Permitted for trusted clients, customers and customer managers. Trusted client is able to impersonate as any other user and deactivate profile on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
deleteUserAddress(userId, addressId) → {Promise}
getUserAddress Removes customer's address. Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
addressId |
String | Address identifier |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
getCart(userId, cartId, opts) → {Promise}
getCart Returns the cart with a given identifier. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/Cart
- Type
- Promise
getCartDeliveryMode(userId, cartId, opts) → {Promise}
getCartDeliveryMode Returns the delivery mode selected for the cart. Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/DeliveryMode
- Type
- Promise
getCartDeliveryModes(userId, cartId, opts) → {Promise}
getCartDeliveryModes Returns all delivery modes supported for the current base store and cart delivery address. A delivery address must be set for the cart, otherwise an empty list will be returned. Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/DeliveryModeList
- Type
- Promise
getCartEntries(userId, cartId, opts) → {Promise}
getCartEntries Returns cart entries. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/OrderEntryList
- Type
- Promise
getCartEntry(userId, cartId, entryNumber, opts) → {Promise}
getCartEntry Returns the details of the cart entries. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
entryNumber |
String | Entry number. Zero-based numbering. |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/OrderEntry
- Type
- Promise
getCartPromotion(userId, cartId, promotionId, opts) → {Promise}
getCartPromotion Return information about promotion with given id, applied on cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers and therefore some of them are currently not compatible with the new promotion engine. Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
promotionId |
String | Promotion identifier (code) |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/PromotionResultList
- Type
- Promise
getCartPromotions(userId, cartId, opts) → {Promise}
getCartPromotions Return information about promotions applied on cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers and therefore some of them are currently not compatible with the new promotion engine. Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/PromotionResultList
- Type
- Promise
getCarts(userId, opts) → {Promise}
getCarts Lists all customer carts. Security: Permitted only for non-anonymous users.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/CartList
- Type
- Promise
getCartVouchers(userId, cartId, opts) → {Promise}
getCartVouchers Returns list of vouchers applied to the cart. Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/VoucherList
- Type
- Promise
getCustomerGroups(userId, opts) → {Promise}
getCustomerGroups Returns all customer groups of a customer. Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/UserGroupList
- Type
- Promise
getOrder(userId, code, opts) → {Promise}
getOrder Returns specific order details based on a specific order code. The response contains detailed order information. Security: Allowed only for customers, customer managers, clients or trusted clients. Trusted client is able to impersonate as any customer and access their orders.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
code |
String | Order GUID (Globally Unique Identifier) or order CODE |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/Order
- Type
- Promise
getOrders(userId, opts) → {Promise}
UsersOrdersByUserId Returns order history data for all orders placed by the specific user for the specific base store. Response contains orders search result displayed in several pages if needed. Security: Allowed only for customers, customer managers, trusted clients Trusted client is able to impersonate as any customer and access their orders.
Parameters:
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/OrderHistoryList
- Type
- Promise
getPaymentDetail(userId, paymentDetailsId, opts) → {Promise}
getPaymentDetail Returns customer's credit card payment details for a given id. Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
paymentDetailsId |
String | Payment details identifier |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/PaymentDetails
- Type
- Promise
getPaymentDetails(userId, opts) → {Promise}
getPaymentDetail Return customer's credit card payment details list. Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
|||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/PaymentDetailsList
- Type
- Promise
getSavedCart(userId, cartId, opts) → {Promise}
getSavedCart Returns saved cart by it id for authenticated user
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/SaveCartResult
- Type
- Promise
getUser(userId, opts) → {Promise}
getUser Returns customer profile. Security: Permitted for clients, customers and customer managers
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/User
- Type
- Promise
getUserAddress(userId, addressId, opts) → {Promise}
getUserAddress Returns detailed information about address with a given id. Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
addressId |
String | Address identifier |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/Address
- Type
- Promise
getUserAddresses(userId, opts) → {Promise}
getUserAddresses Returns customer's addresses. Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/AddressList
- Type
- Promise
patchCartEntry(userId, cartId, entryNumber, body, opts) → {Promise}
getCartEntry Updates the quantity of a single cart entry and details of the store where the cart entry will be picked. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
entryNumber |
String | Entry number. Zero-based numbering. |
||||||
body |
module:models/OrderEntryOCC | |||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/OrderEntryOCC
- Type
- Promise
patchCartFlagForDeletion(userId, cartId, opts) → {Promise}
patchCartFlagForDeletion Flags a cart for deletion (the cart doesn't have corresponding save cart attributes anymore). The cart is not actually deleted from the database. But with the removal of the saved cart attributes, this cart will be taken care of by the cart removal job just like any other cart.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/SaveCartResult
- Type
- Promise
patchCartRestoreSavedCart(userId, cartId) → {Promise}
patchCartRestoreSavedCart
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/SaveCartResult
- Type
- Promise
patchPaymentDetail(userId, paymentDetailsId, body) → {Promise}
getPaymentDetail Updates existing customer's credit card payment details based on its ID. Only attributes given in request will be changed. Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
paymentDetailsId |
String | Payment details identifier |
body |
module:models/PaymentDetailsOCC |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
patchSavedCart(userId, cartId, opts) → {Promise}
patchSavedCart Explicitly saves a cart
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/SaveCartResult
- Type
- Promise
patchUser(userId, body) → {Promise}
getUser Updates customer profile. Only attributes provided in the request body will be changed. Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager is able to impersonate as any other user and change profile on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
body |
module:models/UserOCC |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
patchUserAddress(userId, addressId, body) → {Promise}
getUserAddress Updates the address. Only attributes provided in the request body will be changed. Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
addressId |
String | Address identifier |
body |
module:models/AddressOCC |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
postCart(userId, opts) → {Promise}
getCarts Creates a new cart or restores an anonymous cart as a user's cart (if an old Cart Id is given in the request) Security: Cart may be created by everybody. Restoring anonymous carts is permitted only for non anonymous users.
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/Cart
- Type
- Promise
postCartCloneSavedcart(userId, cartId, opts) → {Promise}
postCartCloneSavedcart Explicitly clones a cart
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/SaveCartResult
- Type
- Promise
postCartDeliveryAddress(userId, cartId, body, opts) → {Promise}
postCartDeliveryAddress Creates an address and assigns it to the cart as the delivery address. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
body |
module:models/AddressOCC | |||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/AddressOCC
- Type
- Promise
postCartEntries(userId, cartId, body, opts) → {Promise}
getCartEntries Adds a product to the cart. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
body |
module:models/OrderEntryOCC | |||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/OrderEntryOCC
- Type
- Promise
postCartPaymentDetail(userId, cartId, body, opts) → {Promise}
postCartPaymentDetail Defines details of a new credit card payment details and assigns the payment to the cart. Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
body |
module:models/PaymentDetailsOCC | |||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/PaymentDetailsOCC
- Type
- Promise
postCartPromotion(userId, cartId, promotionId) → {Promise}
getCartPromotions Enables the promotion for the order based on the promotionId defined for the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers and therefore some of them are currently not compatible with the new promotion engine. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
promotionId |
String | Promotion identifier |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
postCartVoucher(userId, cartId, voucherId) → {Promise}
getCartVouchers Applies a voucher based on the voucherId defined for the cart. Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
voucherId |
String | Voucher identifier |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
postOrder(userId, cartId, opts) → {Promise}
UsersOrdersByUserId Authorizes cart and places the order. Response contains the new order data. Security: Allowed only for customers, customer managers, clients or trusted clients. Trusted client is able to impersonate as any customer and place order on his behalf
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
|||||||||
cartId |
String | Cart code for logged in user, cart GUID for guest checkout |
|||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/Order
- Type
- Promise
postUserAddress(userId, body, opts) → {Promise}
UsersAddressesByUserId Creates a new address. Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
body |
module:models/AddressOCC | |||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/AddressOCC
- Type
- Promise
postUserAddressesVerification(userId, body, opts) → {Promise}
postUserAddressesVerification Verifies address Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
body |
module:models/AddressOCC | |||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/AddressOCC
- Type
- Promise
postUsers(body) → {Promise}
postUsers Registers a customer. The following two sets of parameters are available: <ul> <li>First set is used to register a customer. In this case the required parameters are: login, password, firstName, lastName, titleCode.</li> <li>Second set is used to convert a guest to a customer. In this case the required parameters are: guid, password. </li> <ul> Security: Permitted only for customer managers, clients or trusted clients.
Parameters:
| Name | Type | Description |
|---|---|---|
body |
module:models/UserSignUp |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
putCartDeliveryAddress(userId, cartId, addressId) → {Promise}
postCartDeliveryAddress Sets a delivery address for the cart. The address country must be placed among the delivery countries of the current base store. Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
addressId |
String | Address identifier |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
putCartDeliveryMode(userId, cartId, deliveryModeId) → {Promise}
getCartDeliveryMode Sets the delivery mode with a given identifier for the cart. Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
deliveryModeId |
String | Delivery mode identifier (code) |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
putCartEmail(userId, cartId, opts) → {Promise}
putCartEmail Assigns an email to the cart. This step is required to make a guest checkout. Security: Permitted only for client or trusted client
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
putCartEntry(userId, cartId, entryNumber, body, opts) → {Promise}
getCartEntry Updates the quantity of a single cart entry and details of the store where the cart entry will be picked. Attributes not provided in request will be defined again (set to null or default) Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
entryNumber |
String | Entry number. Zero-based numbering. |
||||||
body |
module:models/OrderEntryOCC | |||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/OrderEntryOCC
- Type
- Promise
putCartPaymentDetail(userId, cartId, paymentDetailsId) → {Promise}
postCartPaymentDetail Sets credit card payment details for the cart. Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
paymentDetailsId |
String | Payment details identifier |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
putLogin(userId, opts) → {Promise}
putLogin Changes customer's login. Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager is able to impersonate as any other user and change login on their behalf.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
|||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
putPassword(userId, opts) → {Promise}
putPassword Changes customer's password. Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager may change someone's else password without knowing the old one.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
|||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
putPaymentDetail(userId, paymentDetailsId, body) → {Promise}
getPaymentDetail Updates existing customer's credit card payment info based on the payment info ID. Attributes not given in request will be defined again (set to null or default). Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
paymentDetailsId |
String | Payment details identifier |
body |
module:models/PaymentDetailsOCC |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
putUser(userId, body) → {Promise}
getUser Updates customer profile. Attributes not provided in the request body will be defined again (set to null or default). Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager is able to impersonate as any other user and change profile on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
body |
module:models/UserOCC |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
putUserAddress(userId, addressId, body) → {Promise}
getUserAddress Updates the address. Attributes not provided in the request will be defined again (set to null or default). Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
addressId |
String | Address identifier |
body |
module:models/AddressOCC |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
usersAddressesByUserId1WithHttpInfo(userId, body, opts) → {Promise}
UsersAddressesByUserId Creates a new address. Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
body |
module:models/AddressOCC | |||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/AddressOCC and HTTP response
- Type
- Promise
usersAddressesByUserIdAndAddressId1WithHttpInfo(userId, addressId, body) → {Promise}
getUserAddress Updates the address. Attributes not provided in the request will be defined again (set to null or default). Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
addressId |
String | Address identifier |
body |
module:models/AddressOCC |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersAddressesByUserIdAndAddressId2WithHttpInfo(userId, addressId, body) → {Promise}
getUserAddress Updates the address. Only attributes provided in the request body will be changed. Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
addressId |
String | Address identifier |
body |
module:models/AddressOCC |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersAddressesByUserIdAndAddressId3WithHttpInfo(userId, addressId) → {Promise}
getUserAddress Removes customer's address. Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
addressId |
String | Address identifier |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersAddressesByUserIdAndAddressIdWithHttpInfo(userId, addressId, opts) → {Promise}
getUserAddress Returns detailed information about address with a given id. Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
addressId |
String | Address identifier |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/Address and HTTP response
- Type
- Promise
usersAddressesByUserIdWithHttpInfo(userId, opts) → {Promise}
getUserAddresses Returns customer's addresses. Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/AddressList and HTTP response
- Type
- Promise
usersAddressesVerificationByUserIdWithHttpInfo(userId, body, opts) → {Promise}
postUserAddressesVerification Verifies address Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
body |
module:models/AddressOCC | |||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/AddressOCC and HTTP response
- Type
- Promise
usersByUserId1WithHttpInfo(userId, body) → {Promise}
getUser Updates customer profile. Attributes not provided in the request body will be defined again (set to null or default). Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager is able to impersonate as any other user and change profile on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
body |
module:models/UserOCC |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersByUserId2WithHttpInfo(userId, body) → {Promise}
getUser Updates customer profile. Only attributes provided in the request body will be changed. Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager is able to impersonate as any other user and change profile on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
body |
module:models/UserOCC |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersByUserId3WithHttpInfo(userId) → {Promise}
getUser Removes customer profile. Security: Permitted for trusted clients, customers and customer managers. Trusted client is able to impersonate as any other user and deactivate profile on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersByUserIdWithHttpInfo(userId, opts) → {Promise}
getUser Returns customer profile. Security: Permitted for clients, customers and customer managers
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/User and HTTP response
- Type
- Promise
usersCartsAddressesDeliveryByUserId1WithHttpInfo(userId, cartId, addressId) → {Promise}
postCartDeliveryAddress Sets a delivery address for the cart. The address country must be placed among the delivery countries of the current base store. Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
addressId |
String | Address identifier |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersCartsAddressesDeliveryByUserId2WithHttpInfo(userId, cartId) → {Promise}
postCartDeliveryAddress Removes the delivery address from the cart. Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersCartsAddressesDeliveryByUserIdWithHttpInfo(userId, cartId, body, opts) → {Promise}
postCartDeliveryAddress Creates an address and assigns it to the cart as the delivery address. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
body |
module:models/AddressOCC | |||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/AddressOCC and HTTP response
- Type
- Promise
usersCartsByUserId1WithHttpInfo(userId, opts) → {Promise}
getCarts Creates a new cart or restores an anonymous cart as a user's cart (if an old Cart Id is given in the request) Security: Cart may be created by everybody. Restoring anonymous carts is permitted only for non anonymous users.
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/Cart and HTTP response
- Type
- Promise
usersCartsByUserIdAndCartId1WithHttpInfo(userId, cartId) → {Promise}
getCart Deletes a cart with a given cart id. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersCartsByUserIdAndCartIdWithHttpInfo(userId, cartId, opts) → {Promise}
getCart Returns the cart with a given identifier. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/Cart and HTTP response
- Type
- Promise
usersCartsByUserIdWithHttpInfo(userId, opts) → {Promise}
getCarts Lists all customer carts. Security: Permitted only for non-anonymous users.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/CartList and HTTP response
- Type
- Promise
usersCartsClonesavedcartByUserIdWithHttpInfo(userId, cartId, opts) → {Promise}
postCartCloneSavedcart Explicitly clones a cart
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/SaveCartResult and HTTP response
- Type
- Promise
usersCartsDeliverymodeByUserIdAndCartId1WithHttpInfo(userId, cartId, deliveryModeId) → {Promise}
getCartDeliveryMode Sets the delivery mode with a given identifier for the cart. Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
deliveryModeId |
String | Delivery mode identifier (code) |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersCartsDeliverymodeByUserIdAndCartId2WithHttpInfo(userId, cartId) → {Promise}
getCartDeliveryMode Removes the delivery mode from the cart. Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersCartsDeliverymodeByUserIdAndCartIdWithHttpInfo(userId, cartId, opts) → {Promise}
getCartDeliveryMode Returns the delivery mode selected for the cart. Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/DeliveryMode and HTTP response
- Type
- Promise
usersCartsDeliverymodesByUserIdAndCartIdWithHttpInfo(userId, cartId, opts) → {Promise}
getCartDeliveryModes Returns all delivery modes supported for the current base store and cart delivery address. A delivery address must be set for the cart, otherwise an empty list will be returned. Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/DeliveryModeList and HTTP response
- Type
- Promise
usersCartsEmailByUserIdAndCartIdWithHttpInfo(userId, cartId, opts) → {Promise}
putCartEmail Assigns an email to the cart. This step is required to make a guest checkout. Security: Permitted only for client or trusted client
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersCartsEntriesByUserIdAndCartId1WithHttpInfo(userId, cartId, body, opts) → {Promise}
getCartEntries Adds a product to the cart. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
body |
module:models/OrderEntryOCC | |||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/OrderEntryOCC and HTTP response
- Type
- Promise
usersCartsEntriesByUserIdAndCartIdWithHttpInfo(userId, cartId, opts) → {Promise}
getCartEntries Returns cart entries. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/OrderEntryList and HTTP response
- Type
- Promise
usersCartsEntriesEntryNumberByUserId1WithHttpInfo(userId, cartId, entryNumber, body, opts) → {Promise}
getCartEntry Updates the quantity of a single cart entry and details of the store where the cart entry will be picked. Attributes not provided in request will be defined again (set to null or default) Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
entryNumber |
String | Entry number. Zero-based numbering. |
||||||
body |
module:models/OrderEntryOCC | |||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/OrderEntryOCC and HTTP response
- Type
- Promise
usersCartsEntriesEntryNumberByUserId2WithHttpInfo(userId, cartId, entryNumber, body, opts) → {Promise}
getCartEntry Updates the quantity of a single cart entry and details of the store where the cart entry will be picked. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
entryNumber |
String | Entry number. Zero-based numbering. |
||||||
body |
module:models/OrderEntryOCC | |||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/OrderEntryOCC and HTTP response
- Type
- Promise
usersCartsEntriesEntryNumberByUserId3WithHttpInfo(userId, cartId, entryNumber) → {Promise}
getCartEntry Deletes cart entry. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
entryNumber |
String | Entry number. Zero-based numbering. |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersCartsEntriesEntryNumberByUserIdWithHttpInfo(userId, cartId, entryNumber, opts) → {Promise}
getCartEntry Returns the details of the cart entries. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
entryNumber |
String | Entry number. Zero-based numbering. |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/OrderEntry and HTTP response
- Type
- Promise
usersCartsFlagForDeletionByUserIdWithHttpInfo(userId, cartId, opts) → {Promise}
patchCartFlagForDeletion Flags a cart for deletion (the cart doesn't have corresponding save cart attributes anymore). The cart is not actually deleted from the database. But with the removal of the saved cart attributes, this cart will be taken care of by the cart removal job just like any other cart.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/SaveCartResult and HTTP response
- Type
- Promise
usersCartsPaymentdetailsByUserId1WithHttpInfo(userId, cartId, paymentDetailsId) → {Promise}
postCartPaymentDetail Sets credit card payment details for the cart. Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
paymentDetailsId |
String | Payment details identifier |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersCartsPaymentdetailsByUserIdWithHttpInfo(userId, cartId, body, opts) → {Promise}
postCartPaymentDetail Defines details of a new credit card payment details and assigns the payment to the cart. Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
body |
module:models/PaymentDetailsOCC | |||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/PaymentDetailsOCC and HTTP response
- Type
- Promise
usersCartsPromotionsByUserIdAndCartId1WithHttpInfo(userId, cartId, promotionId) → {Promise}
getCartPromotions Enables the promotion for the order based on the promotionId defined for the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers and therefore some of them are currently not compatible with the new promotion engine. Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
promotionId |
String | Promotion identifier |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersCartsPromotionsByUserIdAndCartIdWithHttpInfo(userId, cartId, opts) → {Promise}
getCartPromotions Return information about promotions applied on cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers and therefore some of them are currently not compatible with the new promotion engine. Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/PromotionResultList and HTTP response
- Type
- Promise
usersCartsPromotionsPromotionIdByUserId1WithHttpInfo(userId, cartId, promotionId) → {Promise}
getCartPromotion Disables the promotion for the order based on the promotionId defined for the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers and therefore some of them are currently not compatible with the new promotion engine. Security: Permitted only for trusted clients
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
promotionId |
String | Promotion identifier (code) |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersCartsPromotionsPromotionIdByUserIdWithHttpInfo(userId, cartId, promotionId, opts) → {Promise}
getCartPromotion Return information about promotion with given id, applied on cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers and therefore some of them are currently not compatible with the new promotion engine. Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
promotionId |
String | Promotion identifier (code) |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/PromotionResultList and HTTP response
- Type
- Promise
usersCartsRestoresavedcartByUserIdWithHttpInfo(userId, cartId) → {Promise}
patchCartRestoreSavedCart
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/SaveCartResult and HTTP response
- Type
- Promise
usersCartsSaveByUserIdAndCartIdWithHttpInfo(userId, cartId, opts) → {Promise}
patchSavedCart Explicitly saves a cart
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/SaveCartResult and HTTP response
- Type
- Promise
usersCartsSavedcartByUserIdAndCartIdWithHttpInfo(userId, cartId, opts) → {Promise}
getSavedCart Returns saved cart by it id for authenticated user
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/SaveCartResult and HTTP response
- Type
- Promise
usersCartsVouchersByUserIdAndCartId1WithHttpInfo(userId, cartId, voucherId) → {Promise}
getCartVouchers Applies a voucher based on the voucherId defined for the cart. Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
voucherId |
String | Voucher identifier |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersCartsVouchersByUserIdAndCartIdWithHttpInfo(userId, cartId, opts) → {Promise}
getCartVouchers Returns list of vouchers applied to the cart. Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/VoucherList and HTTP response
- Type
- Promise
usersCartsVouchersVoucherIdByUserIdWithHttpInfo(userId, cartId, voucherId) → {Promise}
deleteCartVouchers Removes a voucher based on the voucherId defined for the current cart. Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
cartId |
String | Cart identifier <ul> <li>cart code for logged in user</li> <li>cart guid for anonymous user</li> <li>'current' for the last modified cart</li> </ul> |
voucherId |
String | Voucher identifier (code) |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersCustomergroupsByUserIdWithHttpInfo(userId, opts) → {Promise}
getCustomerGroups Returns all customer groups of a customer. Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/UserGroupList and HTTP response
- Type
- Promise
usersLoginByUserIdWithHttpInfo(userId, opts) → {Promise}
putLogin Changes customer's login. Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager is able to impersonate as any other user and change login on their behalf.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
|||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersOrdersByUserId1WithHttpInfo(userId, opts) → {Promise}
UsersOrdersByUserId Returns order history data for all orders placed by the specific user for the specific base store. Response contains orders search result displayed in several pages if needed. Security: Allowed only for customers, customer managers, trusted clients Trusted client is able to impersonate as any customer and access their orders.
Parameters:
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/OrderHistoryList and HTTP response
- Type
- Promise
usersOrdersByUserId2WithHttpInfo(userId, cartId, opts) → {Promise}
UsersOrdersByUserId Authorizes cart and places the order. Response contains the new order data. Security: Allowed only for customers, customer managers, clients or trusted clients. Trusted client is able to impersonate as any customer and place order on his behalf
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
|||||||||
cartId |
String | Cart code for logged in user, cart GUID for guest checkout |
|||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/Order and HTTP response
- Type
- Promise
usersOrdersByUserIdAndCodeWithHttpInfo(userId, code, opts) → {Promise}
getOrder Returns specific order details based on a specific order code. The response contains detailed order information. Security: Allowed only for customers, customer managers, clients or trusted clients. Trusted client is able to impersonate as any customer and access their orders.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
code |
String | Order GUID (Globally Unique Identifier) or order CODE |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/Order and HTTP response
- Type
- Promise
usersPasswordByUserIdWithHttpInfo(userId, opts) → {Promise}
putPassword Changes customer's password. Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager may change someone's else password without knowing the old one.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
|||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersPaymentdetailsByUserId1WithHttpInfo(userId, paymentDetailsId, body) → {Promise}
getPaymentDetail Updates existing customer's credit card payment info based on the payment info ID. Attributes not given in request will be defined again (set to null or default). Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
paymentDetailsId |
String | Payment details identifier |
body |
module:models/PaymentDetailsOCC |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersPaymentdetailsByUserId2WithHttpInfo(userId, paymentDetailsId, body) → {Promise}
getPaymentDetail Updates existing customer's credit card payment details based on its ID. Only attributes given in request will be changed. Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
paymentDetailsId |
String | Payment details identifier |
body |
module:models/PaymentDetailsOCC |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersPaymentdetailsByUserId3WithHttpInfo(userId, paymentDetailsId) → {Promise}
getPaymentDetail Removes customer's credit card payment details based on its ID. Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
paymentDetailsId |
String | Payment details identifier |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
usersPaymentdetailsByUserId4WithHttpInfo(userId, opts) → {Promise}
getPaymentDetail Return customer's credit card payment details list. Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
|||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/PaymentDetailsList and HTTP response
- Type
- Promise
usersPaymentdetailsByUserIdWithHttpInfo(userId, paymentDetailsId, opts) → {Promise}
getPaymentDetail Returns customer's credit card payment details for a given id. Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
userId |
String | User identifier or one of the literals below : <ul> <li>'current' for currently authenticated user</li> <li>'anonymous' for anonymous user</li> </ul> |
||||||
paymentDetailsId |
String | Payment details identifier |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/PaymentDetails and HTTP response
- Type
- Promise
usersWithHttpInfo(body) → {Promise}
postUsers Registers a customer. The following two sets of parameters are available: <ul> <li>First set is used to register a customer. In this case the required parameters are: login, password, firstName, lastName, titleCode.</li> <li>Second set is used to convert a guest to a customer. In this case the required parameters are: guid, password. </li> <ul> Security: Permitted only for customer managers, clients or trusted clients.
Parameters:
| Name | Type | Description |
|---|---|---|
body |
module:models/UserSignUp |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise