Commerce Webservices

Responses

HTTP Code	Description	Schema
201	Created	Address
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/xml
application/json

Security

Type	Name
oauth2	oauth2_Password
oauth2	oauth2_client_credentials

Type

Name

oauth2

oauth2

3.1.2. Get customer’s addresses

GET /{baseSiteId}/users/{userId}/addresses

Description

Returns customer’s addresses.

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Path	baseSiteId required	Base site identifier	string
Path	userId required	User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user	string
Query	fields optional	Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL	string	`"DEFAULT"`

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code	Description	Schema
200	OK	AddressList
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

HTTP Code

Description

Schema

200

AddressList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type	Name
oauth2	oauth2_Password
oauth2	oauth2_client_credentials

Type

Name

oauth2

oauth2

3.1.3. Verifies address.

POST /{baseSiteId}/users/{userId}/addresses/verification

Description

Verifies address.

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Path	baseSiteId required	Base site identifier	string
Path	userId required	User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user	string
Query	fields optional	Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL	string	`"DEFAULT"`
Body	address required	Address object.	Address

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

address
required

Address object.

Responses

HTTP Code	Description	Schema
200	OK	AddressValidation
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

HTTP Code

Description

Schema

200

AddressValidation

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/xml
application/json

Security

Type	Name
oauth2	oauth2_Password
oauth2	oauth2_client_credentials

Type

Name

oauth2

oauth2

3.1.4. Get info about address

GET /{baseSiteId}/users/{userId}/addresses/{addressId}

Description

Returns detailed information about address with a given id.

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Path	addressId required	Address identifier.	string
Path	baseSiteId required	Base site identifier	string
Path	userId required	User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user	string
Query	fields optional	Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL	string	`"DEFAULT"`

Path

addressId
required

Address identifier.

string

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code	Description	Schema
200	OK	Address
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type	Name
oauth2	oauth2_Password
oauth2	oauth2_client_credentials

Type

Name

oauth2

oauth2

3.1.5. Updates the address

PUT /{baseSiteId}/users/{userId}/addresses/{addressId}

Description

Updates the address. Attributes not provided in the request will be defined again (set to null or default).

Parameters

Type	Name	Description	Schema
Path	addressId required	Address identifier.	string
Path	baseSiteId required	Base site identifier	string
Path	userId required	User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user	string
Body	address required	Address object.	Address

Type

Name

Description

Schema

Path

addressId
required

Address identifier.

string

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

address
required

Address object.

Responses

HTTP Code	Description	Schema
200	OK	No Content
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/xml
application/json

Security

Type	Name
oauth2	oauth2_Password
oauth2	oauth2_client_credentials

Type

Name

oauth2

oauth2

3.1.6. Delete customer’s address.

DELETE /{baseSiteId}/users/{userId}/addresses/{addressId}

Description

Removes customer’s address.

Parameters

Type	Name	Description	Schema
Path	addressId required	Address identifier.	string
Path	baseSiteId required	Base site identifier	string
Path	userId required	User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user	string

Type

Name

Description

Schema

Path

addressId
required

Address identifier.

string

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code	Description	Schema
200	OK	No Content
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type	Name
oauth2	oauth2_Password
oauth2	oauth2_client_credentials

Type

Name

oauth2

oauth2

3.1.7. Updates the address

PATCH /{baseSiteId}/users/{userId}/addresses/{addressId}

Description

Updates the address. Only attributes provided in the request body will be changed.

Parameters

Type	Name	Description	Schema
Path	addressId required	Address identifier.	string
Path	baseSiteId required	Base site identifier	string
Path	userId required	User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user	string
Body	address required	Address object	Address

Type

Name

Description

Schema

Path

addressId
required

Address identifier.

string

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

address
required

Address object

Responses

HTTP Code	Description	Schema
200	OK	No Content
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/xml
application/json

Security

Type	Name
oauth2	oauth2_Password
oauth2	oauth2_client_credentials

Type

Name

oauth2

oauth2

3.2. B2B Carts

B 2 B Carts Controller

3.2.1. Sets the delivery address for the checkout cart.

PUT /{baseSiteId}/orgUsers/{userId}/carts/{cartId}/addresses/delivery

Description

Sets the delivery address for the checkout cart.

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Path	baseSiteId required	Base site identifier	string
Path	cartId required	Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart	string
Path	userId required	User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user	string
Query	addressId required	The id of the address.	string
Query	fields optional	Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL	string	`"DEFAULT"`

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

addressId
required

The id of the address.

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code	Description	Schema
200	OK	Cart
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type	Name
oauth2	oauth2_Password
oauth2	oauth2_client_credentials

Type

Name

oauth2

oauth2

3.2.2. Adds more quantity to the cart of specific products

POST /{baseSiteId}/orgUsers/{userId}/carts/{cartId}/entries/

Description

Updates the details of specified products in the cart, based either on the product code or the entryNumber.

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Path	baseSiteId required	Base site identifier	string
Path	cartId required	Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart	string
Path	userId required	User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user	string
Query	fields optional	Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL	string	`"DEFAULT"`
Body	entries optional	List of entries containing the amount to add and the product code or the entryNumber.	OrderEntryList

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

entries
optional

List of entries containing the amount to add and the product code or the entryNumber.

OrderEntryList

Responses

HTTP Code	Description	Schema
200	OK	CartModificationList
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type	Name
oauth2	oauth2_Password
oauth2	oauth2_client_credentials

Type

Name

oauth2

oauth2

3.2.3. Updates the quantity for specific products in the cart

PUT /{baseSiteId}/orgUsers/{userId}/carts/{cartId}/entries/

Description

Creates the specified products in the cart, or overwrites the details of existing products in the cart, based either on the product code or the entryNumber. For existing products, attributes not provided in the request body will be defined again (set to null or default).

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Path	baseSiteId required	Base site identifier	string
Path	cartId required	Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart	string
Path	userId required	User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user	string
Query	fields optional	Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL	string	`"DEFAULT"`
Body	entries optional	List of entries containing the amount to add and the product code or the entryNumber.	OrderEntryList

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

entries
optional

List of entries containing the amount to add and the product code or the entryNumber.

OrderEntryList

Responses

HTTP Code	Description	Schema
200	OK	CartModificationList
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type	Name
oauth2	oauth2_Password
oauth2	oauth2_client_credentials

Type

Name

oauth2

oauth2

3.2.4. Gets the current cart.

GET /{baseSiteId}/users/{userId}/carts/current

Description

Gets the current cart.

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Path	baseSiteId required	Base site identifier	string
Path	userId required	User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user	string
Query	fields optional	Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL	string	`"DEFAULT"`

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code	Description	Schema
200	OK	Cart
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type	Name
oauth2	oauth2_Password
oauth2	oauth2_client_credentials

Type

Name

oauth2

oauth2

3.2.5. Sets the cost center for the checkout cart.

PUT /{baseSiteId}/users/{userId}/carts/{cartId}/costcenter

Description

Sets the cost center for the checkout cart.

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Path	baseSiteId required	Base site identifier	string
Path	cartId required	Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart	string
Path	userId required	User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user	string
Query	costCenterId required	The id of the cost center.	string
Query	fields optional	Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL	string	`"DEFAULT"`

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

costCenterId
required

The id of the cost center.

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code	Description	Schema
200	OK	Cart
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type	Name
oauth2	oauth2_Password
oauth2	oauth2_client_credentials

Type

Name

oauth2

oauth2

3.2.6. Set the payment type for the checkout cart

PUT /{baseSiteId}/users/{userId}/carts/{cartId}/paymenttype

Description

Sets the payment type for the checkout cart. If the purchaseOrderNumber is not null, the purchaseOrderNumber is also assigned to the cart.

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Path	baseSiteId required	Base site identifier	string
Path	cartId required	Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart	string
Path	userId required	User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user	string
Query	fields optional	Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL	string	`"DEFAULT"`
Query	paymentType required	Payment type choice (between card and account).	string
Query	purchaseOrderNumber optional	Purchase order number to assign to the checkout cart.	string

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

paymentType
required

Payment type choice (between card and account).

string

Query

purchaseOrderNumber
optional

Purchase order number to assign to the checkout cart.

string

Responses

HTTP Code	Description	Schema
200	OK	Cart
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type	Name
oauth2	oauth2_Password
oauth2	oauth2_client_credentials

Type

Name

oauth2

oauth2

3.3. B2B Categories

B 2 B Categories Controller

3.3.1. Gets a list of products under a specific category

GET /{baseSiteId}/categories/{categoryId}/products

Description

Returns a list of products in the specified category.

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Path	baseSiteId required	Base site identifier	string
Path	categoryId required	The category ID	string
Query	currentPage optional	The current result page requested.	integer(int32)	`"0"`
Query	fields optional	Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL	string	`"DEFAULT"`
Query	pageSize optional	The number of results returned per page.	integer(int32)	`"20"`
Query	query optional	Serialized query in format: freeTextSearch: sort: facetKey1: facetValue1: facetKey2: facetValue2	string
Query	sort optional	Sorting method applied to the display search results.	string

Path

baseSiteId
required

Base site identifier

string

Path

categoryId
required

The category ID

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

query
optional

Serialized query in format: freeTextSearch: sort: facetKey1: facetValue1: facetKey2: facetValue2

string

Query

sort
optional

Sorting method applied to the display search results.

string

Responses

HTTP Code	Description	Schema
200	OK	ProductSearchPage
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

HTTP Code

Description

Schema

200

ProductSearchPage

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type	Name
oauth2	oauth2_Password
oauth2	oauth2_client_credentials

Type

Name

oauth2

oauth2

3.4. B2B Cost Centers

B 2 B Cost Centers Controller

3.4.1. Create a new cost center.

POST /{baseSiteId}/costcenters

Description

Creates a new cost center.

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Path	baseSiteId required	Base site identifier	string
Query	fields optional	Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL	string	`"DEFAULT"`
Body	costCenter required	Cost center object.	B2BCostCenter

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

costCenter
required

Cost center object.

Responses

HTTP Code	Description	Schema
201	Created	B2BCostCenter
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type	Name
oauth2	oauth2_Password
oauth2	oauth2_client_credentials

Type

Name

oauth2

oauth2

3.4.2. Get active cost centers.

GET /{baseSiteId}/costcenters

Description

Returns the list of all active cost centers.

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Path	baseSiteId required	Base site identifier	string
Query	fields optional	Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL	string	`"DEFAULT"`

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code	Description	Schema
200	OK	B2BCostCenterList
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

HTTP Code

Description

Schema

200

B2BCostCenterList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type	Name
oauth2	oauth2_Password
oauth2	oauth2_client_credentials

Type

Name

oauth2

oauth2

3.4.3. Get a cost center.

GET /{baseSiteId}/costcenters/{costCenterCode}

Description

Returns a specific cost center based on specific code. The response contains detailed cost center information.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

costCenterCode
required

Cost center identifier.

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.4.4. Update a cost center.

PATCH /{baseSiteId}/costcenters/{costCenterCode}

Description

Updates a cost center. Only attributes provided in the request body will be changed.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

costCenterCode
required

Cost center identifier.

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

costCenter
required

Cost center object.

Responses

HTTP Code

Description

Schema

200

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.4.5. Add a budget to a specific cost center.

POST /{baseSiteId}/costcenters/{costCenterCode}/budgets

Description

Adds a budget to a specific cost center.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

costCenterCode
required

Identifier of the cost center to which the budget will be added.

string

Query

budgetCode
required

The budget which will be added to a specific cost center.

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.4.6. Get all budgets and select budgets which belong to a specific cost center.

GET /{baseSiteId}/costcenters/{costCenterCode}/budgets

Description

Returns the list of all budgets, where those budgets, which belong to a specific cost center, are selected.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

costCenterCode
required

Cost center identifier.

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the return results.

string

Responses

HTTP Code

Description

Schema

200

BudgetList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.4.7. Remove a budget from a specific cost center.

DELETE /{baseSiteId}/costcenters/{costCenterCode}/budgets/{budgetCode}

Description

Removes a budget from a specific cost center.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

budgetCode
required

The budget which will be removed from a specific cost center.

string

Path

costCenterCode
required

Identifier of the cost center from which the budget will be removed.

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.4.8. Get cost centers.

GET /{baseSiteId}/costcentersall

Description

Returns the list of all cost centers.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the return results.

string

Responses

HTTP Code

Description

Schema

200

B2BCostCenterList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.5. B2B Miscs

B 2 B Miscs Controller

3.5.1. Returns a list of the available payment types.

GET /{baseSiteId}/paymenttypes

Description

Returns a list of the available payment types in the B2B checkout process.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

B2BPaymentTypeList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.6. B2B Orders

B 2 B Orders Controller

3.6.1. Create a cart based on a previous order

POST /{baseSiteId}/orgUsers/{userId}/cartFromOrder

Description

Returns a list of modification applied to the new cart compared to original. e.g lower quantity was added

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

orderCode
required

The order code

string

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.6.2. Places a B2B Order.

POST /{baseSiteId}/orgUsers/{userId}/orders

Description

Places a B2B Order. By default the payment type is ACCOUNT. Please set payment type to CARD if placing an order using credit card.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

termsChecked
required

Whether terms were accepted or not.

boolean

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

ScheduleReplenishmentForm

3.6.3. Creates an Order and schedules Replenishment.

POST /{baseSiteId}/orgUsers/{userId}/replenishmentOrders

Description

Creates an Order and schedules Replenishment. By default the payment type is ACCOUNT. Please set payment type to CARD if placing an order using credit card.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

termsChecked
required

Whether terms were accepted or not.

boolean

Body

scheduleReplenishmentForm
required

Schedule replenishment form object.

Responses

HTTP Code

Description

Schema

201

Created

ReplenishmentOrder

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.7. B2B Products

B 2 B Products Controller

3.7.1. Returns a product.

GET /{baseSiteId}/orgProducts/{productCode}

Description

Returns a product, based on the specified product code.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

The product code

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.8. B2B Users

B 2 B Users Controller

3.8.1. Create a registration request for a B2B user

POST /{baseSiteId}/orgUsers

Description

Create a registration request for a B2B user.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

orgUserRegistrationData
required

Data object that contains information necessary to apply user registration

OrgUserRegistrationData

Responses

HTTP Code

Description

Schema

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.8.2. Get a B2B user profile

GET /{baseSiteId}/orgUsers/{userId}

Description

Returns a B2B user profile.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.9. Base Sites

Base Sites Controller

3.9.1. Get all base sites.

GET /basesites

Description

Get all base sites with corresponding base stores details in FULL mode.

Parameters

Type Name Description Schema Default

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

BaseSiteList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.10. Base Stores

Base Stores Controller

3.10.1. Get a base store.

GET /{baseSiteId}/basestores/{baseStoreUid}

Description

Returns details of a specific base store based on its identifier. The response contains detailed base store information.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

baseStoreUid
required

Base store name

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

BaseStore

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.11. Budget Management

Budget Management Controller

3.11.1. Creates a new budget

POST /{baseSiteId}/users/{userId}/budgets

Description

Creates a new budget.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

budget
required

Budget

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.11.2. Gets the list of budgets for a specified base store

GET /{baseSiteId}/users/{userId}/budgets

Description

Returns the list of budgets accessible to a specified user for a specified base store. The response can display the results across multiple pages, if required.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the returned results.

string

"code"

Responses

HTTP Code

Description

Schema

200

BudgetList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.11.3. Gets specific budget details accessible to a specified user for a specified base store based on budget code

GET /{baseSiteId}/users/{userId}/budgets/{budgetCode}

Description

Returns specific budget details accessible to a specified user for a specified base store based on budget code. The response contains detailed order information.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

budgetCode
required

Budget GUID (Globally Unique Identifier) or budget CODE.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.11.4. Updates the budget

PATCH /{baseSiteId}/users/{userId}/budgets/{budgetCode}

Description

Updates the budget. Only attributes provided in the request body will be changed.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

budgetCode
required

Budget GUID (Globally Unique Identifier) or budget CODE.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

budget
required

Budget.

Responses

HTTP Code

Description

Schema

200

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.12. Cart Addresses

Cart Addresses Controller

3.12.1. Creates a delivery address for the cart.

POST /{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery

Description

Creates an address and assigns it to the cart as the delivery address.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

address
required

Request body parameter that contains details such as the customer’s first name (firstName), the customer’s last name (lastName), the customer’s title (titleCode), the customer’s phone (phone), the country (country.isocode), the first part of the address (line1), the second part of the address (line2), the town (town), the postal code (postalCode), and the region (region.isocode).

The DTO is in XML or .json format.

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.12.2. Sets a delivery address for the cart.

PUT /{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery

Description

Sets a delivery address for the cart. The address country must be placed among the delivery countries of the current base store.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

addressId
required

Address identifier

string

Responses

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.12.3. Deletes the delivery address from the cart.

DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery

Description

Deletes the delivery address from the cart.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type

Name

oauth2

oauth2

3.13. Cart Delivery Modes

Cart Delivery Modes Controller

3.13.1. Get the delivery mode selected for the cart.

GET /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode

Description

Returns the delivery mode selected for the cart.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.13.2. Sets the delivery mode for a cart.

PUT /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode

Description

Sets the delivery mode with a given identifier for the cart.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

deliveryModeId
required

Delivery mode identifier (code)

string

Responses

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.13.3. Deletes the delivery mode from the cart.

DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode

Description

Deletes the delivery mode from the cart.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type

Name

oauth2

oauth2

3.13.4. Get all delivery modes for the current store and delivery address.

GET /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymodes

Description

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.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

DeliveryModeList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.14. Cart Entries

Cart Entries Controller

3.14.1. Adds a product to the cart.

POST /{baseSiteId}/users/{userId}/carts/{cartId}/entries

Description

Adds a product to the cart.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

entry
required

Request body parameter that contains details such as the product code (product.code), the quantity of product (quantity), and the pickup store name (deliveryPointOfService.name).

The DTO is in XML or .json format.

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.14.2. Get cart entries.

GET /{baseSiteId}/users/{userId}/carts/{cartId}/entries

Description

Returns cart entries.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

OrderEntryList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.14.3. Get the details of the cart entries.

GET /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}

Description

Returns the details of the cart entries.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

entryNumber
required

The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).

integer(int64)

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.14.4. Set quantity and store details of a cart entry.

PUT /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}

Description

Updates the quantity of a single cart entry and the details of the store where the cart entry will be picked up. Attributes not provided in request will be defined again (set to null or default)

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

entryNumber
required

The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).

integer(int64)

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

entry
required

Request body parameter that contains details such as the quantity of product (quantity), and the pickup store name (deliveryPointOfService.name)

The DTO is in XML or .json format.

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.14.5. Deletes cart entry.

DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}

Description

Deletes cart entry.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

entryNumber
required

The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).

integer(int64)

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type

Name

oauth2

oauth2

3.14.6. Update quantity and store details of a cart entry.

PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}

Description

Updates the quantity of a single cart entry and the details of the store where the cart entry will be picked up.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

entryNumber
required

The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).

integer(int64)

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

entry
required

Request body parameter that contains details such as the quantity of product (quantity), and the pickup store name (deliveryPointOfService.name)

The DTO is in XML or .json format.

Responses

HTTP Code

Description

Schema

200

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.15. Cart Entry Groups

Cart Entry Groups Controller

3.15.1. Add a product to a cart entry group.

POST /{baseSiteId}/users/{userId}/carts/{cartId}/entrygroups/{entryGroupNumber}

Description

Adds a product to a cart entry group.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

entryGroupNumber
required

Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.

integer(int32)

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

entry
required

Request body parameter that contains details such as the product code (product.code) and the quantity of product (quantity).

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.15.2. Delete an entry group.

DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/entrygroups/{entryGroupNumber}

Description

Removes an entry group from an associated cart. The entry group is identified by an entryGroupNumber. The cart is identified by the cartId.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

entryGroupNumber
required

Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.

integer(int32)

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type

Name

oauth2

oauth2

3.16. Cart Payments

Cart Payments Controller

3.16.1. Defines and assigns details of a new credit card payment to the cart.

POST /{baseSiteId}/users/{userId}/carts/{cartId}/paymentdetails

Description

Defines the details of a new credit card, and assigns this payment option to the cart.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

paymentDetails
required

Request body parameter that contains details such as the name on the card (accountHolderName), the card number (cardNumber), the card type (cardType.code), the month of the expiry date (expiryMonth), the year of the expiry date (expiryYear), whether the payment details should be saved (saved), whether the payment details should be set as default (defaultPaymentInfo), and the billing address (billingAddress.firstName, billingAddress.lastName, billingAddress.titleCode, billingAddress.country.isocode, billingAddress.line1, billingAddress.line2, billingAddress.town, billingAddress.postalCode, billingAddress.region.isocode)

The DTO is in XML or .json format.

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.16.2. Sets credit card payment details for the cart.

PUT /{baseSiteId}/users/{userId}/carts/{cartId}/paymentdetails

Description

Sets credit card payment details for the cart.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

paymentDetailsId
required

Payment details identifier.

string

Responses

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.17. Cart Promotions

Cart Promotions Controller

3.17.1. Enables promotions based on the promotionsId of the cart.

POST /{baseSiteId}/users/{userId}/carts/{cartId}/promotions

Description

Enables a 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 as a result, some of them are currently not compatible with the new promotions engine.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

promotionId
required

Promotion identifier (code)

string

Responses

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.17.2. Get information about promotions applied on cart.

GET /{baseSiteId}/users/{userId}/carts/{cartId}/promotions

Description

Returns information about the promotions applied on the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers, and as a result, some of them are currently not compatible with the new promotions engine.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

PromotionResultList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.17.3. Get information about promotion applied on cart.

GET /{baseSiteId}/users/{userId}/carts/{cartId}/promotions/{promotionId}

Description

Returns information about a promotion (with a specific promotionId), that has been applied on the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers, and as a result, some of them are currently not compatible with the new promotions engine.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

promotionId
required

Promotion identifier (code)

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

PromotionResultList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.17.4. Disables the promotion based on the promotionsId of the cart.

DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/promotions/{promotionId}

Description

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 as a result, some of them are currently not compatible with the new promotions engine.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

promotionId
required

Promotion identifier (code)

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type

Name

oauth2

oauth2

3.17.5. Applies a voucher based on the voucherId defined for the cart.

POST /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers

Description

Applies a voucher based on the voucherId defined for the cart.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

voucherId
required

Voucher identifier (code)

string

Responses

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.17.6. Get a list of vouchers applied to the cart.

GET /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers

Description

Returns a list of vouchers applied to the cart.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

VoucherList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.17.7. Deletes a voucher defined for the current cart.

DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers/{voucherId}

Description

Deletes a voucher based on the voucherId defined for the current cart.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Path

voucherId
required

Voucher identifier (code)

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type

Name

oauth2

oauth2

3.18. Carts

Carts Controller

3.18.1. Creates or restore a cart for a user.

POST /{baseSiteId}/users/{userId}/carts

Description

Creates a new cart or restores an anonymous cart as a user’s cart (if an old Cart Id is given in the request).

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

oldCartId
optional

Anonymous cart GUID.

string

Query

toMergeCartGuid
optional

The GUID of the user’s cart that will be merged with the anonymous cart.

string

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.18.2. Get all customer carts.

GET /{baseSiteId}/users/{userId}/carts

Description

Lists all customer carts.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

Optional pagination parameter in case of savedCartsOnly == true. Default value 0.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

Optional {@link PaginationData} parameter in case of savedCartsOnly == true. Default value 20.

integer(int32)

"20"

Query

savedCartsOnly
optional

Optional parameter. If the parameter is provided and its value is true, only saved carts are returned.

boolean

"false"

Query

sort
optional

Optional sort criterion in case of savedCartsOnly == true. No default value.

string

Responses

HTTP Code

Description

Schema

200

CartList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.18.3. Get a cart with a given identifier.

GET /{baseSiteId}/users/{userId}/carts/{cartId}

Description

Returns the cart with a given identifier.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.18.4. Deletes a cart with a given cart id.

DELETE /{baseSiteId}/users/{userId}/carts/{cartId}

Description

Deletes a cart with a given cart id.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type

Name

oauth2

oauth2

3.18.5. Assigns an email to the cart.

PUT /{baseSiteId}/users/{userId}/carts/{cartId}/email

Description

Assigns an email to the cart. This step is required to make a guest checkout.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

email
required

Email of the guest user. It will be used during the checkout process.

string

Responses

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.18.6. Validates the cart

POST /{baseSiteId}/users/{userId}/carts/{cartId}/validate

Description

Runs a cart validation and returns the result.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.19. Catalogs

Catalogs Controller

3.19.1. Get a list of catalogs

GET /{baseSiteId}/catalogs

Description

Returns all catalogs with versions defined for the base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

CatalogList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.19.2. Get a catalog

GET /{baseSiteId}/catalogs/{catalogId}

Description

Returns information about a catalog based on its ID, along with the versions defined for the current base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

catalogId
required

Catalog identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

Catalog

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.19.3. Get information about catalog version

GET /{baseSiteId}/catalogs/{catalogId}/{catalogVersionId}

Description

Returns information about the catalog version that exists for the current base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

catalogId
required

Catalog identifier

string

Path

catalogVersionId
required

Catalog version identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

CatalogVersion

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.19.4. Get information about catagory in a catalog version

GET /{baseSiteId}/catalogs/{catalogId}/{catalogVersionId}/categories/{categoryId}

Description

Returns information about a specified category that exists in a catalog version available for the current base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

catalogId
required

Catalog identifier

string

Path

catalogVersionId
required

Catalog version identifier

string

Path

categoryId
required

Category identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

CategoryHierarchy

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.20. Components

Component Controller

3.20.1. Get components' data by id given in body

POST /{baseSiteId}/cms/components

Caution

operation.deprecated

Description

Given a list of component identifiers in body, return cms component data.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

catalogCode
optional

Catalog code

string

Query

categoryCode
optional

Category code

string

Query

currentPage
optional

Optional pagination parameter. Default value 0.

integer(int32)

"0"

Query

fields
optional

Response configuration (list of fields, which should be returned in response)

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

pageSize
optional

Optional pagination parameter. Default value 10.

integer(int32)

"10"

Query

productCode
optional

Product code

string

Query

sort
optional

Optional sort criterion. No default value.

string

Body

componentIdList
required

List of Component identifiers

ComponentIDList

Responses

HTTP Code

Description

Schema

200

ListAdaptedComponents

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.20.2. Get component data

GET /{baseSiteId}/cms/components

Description

Finds cms components by the specified IDs. When none is provided, this will retrieve all components
The components list will be filtered by the given catalog, product or category restrictions, as well as by the pagination information. The result will be sorted in the specified order.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

catalogCode
optional

Catalog code

string

Query

categoryCode
optional

Category code

string

Query

componentIds
optional

List of Component identifiers

< string > array(multi)

Query

currentPage
optional

Optional pagination parameter. Default value 0.

integer(int32)

"0"

Query

fields
optional

Response configuration (list of fields, which should be returned in response)

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

pageSize
optional

Optional pagination parameter. Default value 10.

integer(int32)

"10"

Query

productCode
optional

Product code

string

Query

sort
optional

Optional sort criterion. No default value.

string

Responses

HTTP Code

Description

Schema

200

ListAdaptedComponents

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.20.3. Get component data by id

GET /{baseSiteId}/cms/components/{componentId}

Description

Given a component identifier, return cms component data.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

componentId
required

Component identifier

string

Query

catalogCode
optional

Catalog code

string

Query

categoryCode
optional

Category code

string

Query

fields
optional

Response configuration (list of fields, which should be returned in response)

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

productCode
optional

Product code

string

Responses

HTTP Code

Description

Schema

200

ComponentAdaptedData

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.21. Consents

Consents Controller

3.21.1. A user can give consent.

POST /{baseSiteId}/users/{userId}/consents

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

consentTemplateId
required

Consent template ID.

string

Query

consentTemplateVersion
required

Consent template version.

integer(int32)

Responses

HTTP Code

Description

Schema

200

ConsentTemplate

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.21.2. Withdraw the user consent for a given consent code.

DELETE /{baseSiteId}/users/{userId}/consents/{consentCode}

Description

If the user consent was given, the consent is withdrawn. If consent was already withdrawn then returns consent already withdrawn error. If there is no such consent then returns not found. If the current user is an anonymous user then returns access denied error.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

consentCode
required

Consent code.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type

Name

oauth2

oauth2

3.21.3. Fetch the list of consents

GET /{baseSiteId}/users/{userId}/consenttemplates

Description

If user has not given or withdrawn consent to any of the template, no given or withdraw date is returned.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

ConsentTemplateList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.21.4. Fetch the consent.

GET /{baseSiteId}/users/{userId}/consenttemplates/{consentTemplateId}

Description

If user has not given or withdrawn consent to the template, no given or withdraw date is returned.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

consentTemplateId
required

Consent template id.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

ConsentTemplate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.22. Countries

Countries Controller

3.22.1. Get a list of countries.

GET /{baseSiteId}/countries

Description

If the value of type equals to shipping, then return shipping countries. If the value of type equals to billing, then return billing countries. If the value of type is not given, return all countries. The list is sorted alphabetically.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

type
optional

The type of countries.

enum (SHIPPING, BILLING)

Responses

HTTP Code

Description

Schema

200

CountryList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.22.2. Fetch the list of regions for the provided country.

GET /{baseSiteId}/countries/{countyIsoCode}/regions

Description

Lists all regions.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

countyIsoCode
required

An ISO code for a country

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

RegionList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

CustomerCouponSearchResult

3.23. Customer Coupons

Customer Coupons Controller

3.23.1. Gets all customer coupons of the current customer.

GET /{baseSiteId}/users/{userId}/customercoupons

Description

Gets the customer coupon list of the current customer.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

needsTotal
optional

The flag for indicating if total number of results is needed or not.

enum (true, false)

"true"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"10"

Query

sort
optional

The sorting method applied to the return results.

string

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.23.2. Claims a customer coupon.

POST /{baseSiteId}/users/{userId}/customercoupons/{couponCode}/claim

Description

Claims a customer coupon by coupon code.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

couponCode
required

Coupon code

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

201

Created

CustomerCoupon2Customer

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

CustomerCouponNotification

3.23.3. Subscribes to a coupon notification.

POST /{baseSiteId}/users/{userId}/customercoupons/{couponCode}/notification

Description

Make a subscription to a customer coupon to receive notifications when it will be in effect soon, or will expire soon.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

couponCode
required

Coupon code

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.23.4. Unsubscribes from the coupon notification.

DELETE /{baseSiteId}/users/{userId}/customercoupons/{couponCode}/notification

Description

Removes notification subscription from the specific customer coupon.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

couponCode
required

Coupon code

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type

Name

oauth2

oauth2

3.24. Customer Groups

Customer Groups Controller

3.24.1. Creates a new customer group.

POST /{baseSiteId}/customergroups

Description

Creates a new customer group that is a direct subgroup of a customergroup.

To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Body

userGroup
required

User group object with id and name.

UserGroup

Responses

HTTP Code

Description

Schema

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.24.2. Get all subgroups of a customergroup.

GET /{baseSiteId}/customergroups

Description

Returns all customer groups that are direct subgroups of a customergroup.

To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

currentPage
optional

Current page number (starts with 0).

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"BASIC"

Query

pageSize
optional

Number of customer group returned in one page.

integer(int32)

"20"

Responses

HTTP Code

Description

Schema

200

UserGroupList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.24.3. Get a specific customer group.

GET /{baseSiteId}/customergroups/{groupId}

Description

Returns a customer group with a specific groupId.

To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

groupId
required

Group identifier.

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"BASIC"

Responses

HTTP Code

Description

Schema

200

UserGroup

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.24.4. Sets members for a user group.

PUT /{baseSiteId}/customergroups/{groupId}/members

Description

Sets members for a user group. The list of existing members is overwritten with a new one.

To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

groupId
required

Group identifier.

string

Body

members
required

List of users to set for customer group.

MemberList

Responses

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.24.5. Assigns user(s) to a customer group.

PATCH /{baseSiteId}/customergroups/{groupId}/members

Description

Assigns user(s) to a customer group.

To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

groupId
required

Group identifier.

string

Body

members
required

List of users to assign to customer group.

MemberList

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.24.6. Deletes a user from a customer group.

DELETE /{baseSiteId}/customergroups/{groupId}/members/{userId}

Description

Deletes user from a customer group.

To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

groupId
required

Group identifier.

string

Path

userId
required

User identifier.

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type

Name

oauth2

oauth2

3.25. Export

Export Controller

3.25.1. Get a list of product exports.

GET /{baseSiteId}/export/products

Description

Used for product export. Depending on the timestamp parameter, it can return all products or only products modified after the given time.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

catalog
optional

The catalog to retrieve products from. The catalog must be provided along with the version.

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

timestamp
optional

When this parameter is set, only products modified after the given time will be returned. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).

string

Query

version
optional

The catalog version. The catalog version must be provided along with the catalog.

string

Responses

HTTP Code

Description

Schema

200

ProductList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.26. Extended Carts

Extended Carts Controller

3.26.1. Handles the consolidating pickup locations.

POST /{baseSiteId}/users/{userId}/carts/{cartId}/consolidate

Description

Specifies one store location where all items will be picked up.

Note, if any of the items are not available at the specified location, these items are removed from the cart.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

storeName
required

The name of the store where items will be picked up

string

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.26.2. Get consolidated pickup options.

GET /{baseSiteId}/users/{userId}/carts/{cartId}/consolidate

Description

Returns a list of stores that have all the pick-up items in stock.

Note, if there are no stores that have all the pick up items in stock, or all items are already set to the same pick up location, the response returns an empty list.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

PointOfServiceList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.26.3. Get information needed for create subscription

GET /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/request

Description

Returns the necessary information for creating a subscription that contacts the payment provider directly. This information contains the payment provider URL and a list of parameters that are needed to create the subscription.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

extendedMerchantCallback
optional

Define which url should be returned

boolean

"false"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

responseUrl
required

The URL that the payment provider uses to return payment information. Possible values for responseUrl include the following: “orderPage_cancelResponseURL”, “orderPage_declineResponseURL”, and “orderPage_receiptResponseURL”.

string

Responses

HTTP Code

Description

Schema

200

PaymentRequest

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.26.4. Handles response from payment provider and create payment details

POST /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/response

Description

Handles the response from the payment provider and creates payment details.

Note, the “Try it out” button is not enabled for this method (always returns an error) because the Extended Carts Controller handles parameters differently, depending on which payment provider is used. For more information about this controller, please refer to the “acceleratorocc AddOn” documentation on help.hybris.com.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.26.5. Get information about create subscription request results

GET /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/response

Description

Returns information related to creating subscription request results. If there is no response from the payment provider, a "202 Accepted" status is returned. If the subscription is created successfully, the payment details are returned. Otherwise, an error response is returned.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.26.6. Deletes payment provider response related to cart.

DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/response

Description

Deletes the payment provider response related to the specified cart.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type

Name

oauth2

oauth2

3.27. FS Agents

FS Agents Controller

3.27.1. Get a list of agents either by specified category code or by query string.

GET /{baseSiteId}/agents

Description

Lists all agents for specified category code or query param. If code is specified search will be executed based on that, otherwise query string will be used.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

categoryCode
optional

Category code

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

latitude
optional

Coordinate that specifies the north-south position of a point on the Earth’s surface.

number(double)

Query

longitude
optional

Coordinate that specifies the east-west position of a point on the Earth’s surface.

number(double)

Query

page
optional

The current result page requested.

integer(int32)

"0"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"10"

Query

queryParam
optional

Parameter for filtering agents based on the query param which can be first name, last name, full name, category code and category name.

string

Responses

HTTP Code

Description

Schema

200

AgentList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.27.2. Get an agent

GET /{baseSiteId}/agents/{agentId}

Description

Returns information about agent based on provided agent identifier.

Parameters

Type Name Description Schema Default

Path

agentId
required

Agent identifier

string

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

Agent

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.28. FS Appointment Scheduling

FS Appointment Controller

3.28.1. Create an appointment

POST /{baseSiteId}/users/{userId}/appointments

Description

Creates an appointment for current user.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

agentId
optional

agentId

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

appointment
required

Data object that contains information necessary for appointment creation

FSAppointment

Responses

HTTP Code

Description

Schema

201

Created

FSAppointment

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.29. FS Billing Time

FS Billing Time Controller

3.29.1. Get list of billing times for product

GET /{baseSiteId}/billing-times

Description

Get list of billing times based (without duplicates) on the provided product codes. Returns the basic information of the billing events.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

productCodes
required

List of product codes

< string > array(multi)

Responses

HTTP Code

Description

Schema

200

BillingTimeList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.30. FS Bundles

FS Configurable Bundles Controller

3.30.1. Get bundle template by code

GET /{baseSiteId}/fs-bundle-templates/{bundleTemplateCode}

Description

Get specific bundle template information based on the provided bundle code. Returns the basic information of the bundle, as well as the information on which products are included in the bundle (nested bundles). Parameter to be passed which determines until which depth the nested bundles should be searched for. The product information can be used for later calls.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

bundleTemplateCode
required

Bundle Template identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

recurrencies
optional

Response configuration. This is the number of recurrencies in the response body.

integer(int32)

"4"

Responses

HTTP Code

Description

Schema

200

BundleTemplate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.30.2. Add to Cart

POST /{baseSiteId}/users/{userId}/carts/{cartId}/fs-add-to-cart

Description

Adds a provided product to the specified cart of a specified user.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

entryNumber
optional

Entry number

integer(int32)

"1"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

productCode
optional

Product code

string

Query

quantity
optional

Quantity

integer(int32)

"1"

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.30.3. Start bundle

POST /{baseSiteId}/users/{userId}/carts/{cartId}/fs-start-bundle

Description

Starts a new bundle with a specified main product of a specified cart.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

bundleTemplateId
optional

Bundle Template identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

productCode
optional

Product code

string

Query

quantity
optional

Quantity

integer(int32)

"1"

Body

productPriceDescriptorWsDTO
optional

Product price descriptors

FSProductPriceAttributes

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.31. FS Carts

FS Carts Controller

3.31.1. Get customer carts for comparison

GET /{baseSiteId}/users/{userId}/fscarts

Description

Lists customer’s carts for comparison by provided codes

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

cartCodes
required

List of cart identifiers

< string > array(multi)

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

CartList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.31.2. Set user identification type.

PATCH /{baseSiteId}/users/{userId}/fscarts/{cartId}/userIdentification

Description

Set user identification type.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

identificationType
required

Identification type of User. It will be used during the checkout process. Possible values of standard use cases are: LEGAL_IDENTIFICATION, NEAREST_BRANCH, VIDEO_IDENTIFICATION

string

Responses

HTTP Code

Description

Schema

200

string

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.32. FS Change Requests

FS Change Requests Controller

3.32.1. Create fs change request

POST /{baseSiteId}/users/{userId}/fsChangeRequests

Description

Creates change request for provided policyId, contractId, request type and effective date for the current user.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

contractId
required

Contract identifier

string

Query

effectiveDate
optional

Effective date

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

policyId
required

Policy identifier

string

Query

requestType
required

Request type

string

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.32.2. Get a change request

GET /{baseSiteId}/users/{userId}/fsChangeRequests/{requestId}

Description

Returns information on change request for a provided user of a specified base store and request id.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

requestId
required

FS change request identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.32.3. Invokes specified action on particular change request object

POST /{baseSiteId}/users/{userId}/fsChangeRequests/{requestId}/action

Description

Supported value for action is CANCEL. Cancel actiontriggers cancellation of fs change request status and changes its status.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

requestId
required

FS change request identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

action
required

FS action for change request

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.32.4. Simulate change request

POST /{baseSiteId}/users/{userId}/fsChangeRequests/{requestId}/simulation

Description

Perform simulation of changes for the change request.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

requestId
required

FS change request identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

fsChangeRequest
required

FS change request content

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.33. FS Claims

FS Claims Controller

3.33.1. Get all claims

GET /{baseSiteId}/users/{userId}/claims

Description

Returns information on all claims for a provided user of a specified base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

FsClaimList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.33.2. Create a claim

POST /{baseSiteId}/users/{userId}/claims/create

Description

Creates a claim for a provided policy.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

contractId
required

Contract identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

policyId
required

Policy identifier

string

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.33.3. Get a claim

GET /{baseSiteId}/users/{userId}/claims/{claimId}

Description

Returns information on claim for a provided user of a specified base store and claim number.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

claimId
required

Claim identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.33.4. Delete a claim

DELETE /{baseSiteId}/users/{userId}/claims/{claimId}

Description

Deletes a claim for a provided user of a specified base store.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

claimId
required

Claim identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type

Name

oauth2

oauth2

3.33.5. Update a claim

PATCH /{baseSiteId}/users/{userId}/claims/{claimId}

Description

Updates a claim for a provided user of a specified base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

claimId
required

Claim identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

claim
required

claim

Responses

HTTP Code

Description

Schema

200

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.33.6. Invokes specified action on particular claim object. Supported value is SUBMIT

POST /{baseSiteId}/users/{userId}/claims/{claimId}/action

Description

Submit action triggers submission of claim for a provided user of a specified base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

claimId
required

Claim identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

action
required

action

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.34. FS Customer Support Tickets

FS Cs Tickets Contoller

3.34.1. Create a customer support ticket

POST /{baseSiteId}/users/{userId}/csTickets

Description

Creates a customer support ticket for agent.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

agentId
optional

The agent identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

ticket
required

ticket

FSTicket

Responses

HTTP Code

Description

Schema

201

Created

FSTicket

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.35. FS Document

FS Documents Controller

3.35.1. Create a document

POST /{baseSiteId}/users/{userId}/documents

Description

Creates a document for current user.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

FormData

file
required

The file representing the actual binary contents of the document to be created.

file

Responses

HTTP Code

Description

Schema

201

Created

FSDocument

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

multipart/form-data

Security

Type

Name

oauth2

oauth2

3.35.2. Get documents for user

GET /{baseSiteId}/users/{userId}/documents

Description

Returns information of documents for a provided user of a specified base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

documentCodes
optional

List of document identifiers

< string > array(multi)

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

FSDocumentList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.35.3. Get a document

GET /{baseSiteId}/users/{userId}/documents/{documentId}

Description

Returns byte array of document for a provided user of a specified base store and document Id.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

documentId
required

Document identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

string(byte)

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.35.4. Delete a document

DELETE /{baseSiteId}/users/{userId}/documents/{documentId}

Description

Deletes a document for a provided user of a specified base store.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

documentId
required

Document identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type

Name

oauth2

oauth2

3.36. FS Forms

FS Forms Controller

3.36.1. Get form definitions by category and definition type

GET /{baseSiteId}/formDefinitions

Description

Returns list of form definitions.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

categoryCode
required

Category identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

yFormDefinitionType
required

YForm definition type code. Could be PRODUCT_CONFIGURE or PERSONAL_DETAILS. With this type components could load different form definitions.

string

Responses

HTTP Code

Description

Schema

200

YFormDefinitionList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.36.2. Get form definition by id

GET /{baseSiteId}/formDefinitions/{formDefinitionId}

Description

Returns definition of single form by specified identifier.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

formDefinitionId
required

Form definition identifier

string

Query

applicationId
required

Parameter which identifies application for specified form definition.

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

versionNumber
optional

Parameter which identifies version number for specified form definition.

integer(int32)

"1"

Responses

HTTP Code

Description

Schema

200

YFormDefinition

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.36.3. Create form data

POST /{baseSiteId}/users/{userId}/formData

Description

Creates new form data.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

applicationId
required

Parameter which identifies application for specified form definition.

string

Query

definitionId
required

Parameter which identifies form definition.

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

formDataType
optional

Parameter which represents form data type. Could be DATA or DRAFT. DRAFT represents the temporary form which will be deleted once DATA version is created.

string

"DATA"

Query

refId
optional

Parameter which identifies reference id.

string

Body

formData
required

Form data object. Represents the map with key/value pairs of form.

object

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.36.4. Get form data by id

GET /{baseSiteId}/users/{userId}/formData/{formDataId}

Description

Returns data of single form by specified identifier.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

formDataId
required

Parameter which identifies form data.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.36.5. Update form data

PUT /{baseSiteId}/users/{userId}/formData/{formDataId}

Description

Updates existing content of form data.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

formDataId
required

Parameter which identifies form data.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

applicationId
required

Parameter which identifies application for specified form definition.

string

Query

definitionId
required

Parameter which identifies form definition.

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

formDataType
optional

Parameter which represents form data type. Could be DATA or DRAFT. DRAFT represents the temporary form which will be deleted once DATA version is created.

string

"DATA"

Query

refId
optional

Parameter which identifies reference id.

string

Body

formData
required

Form data object. Represents the map with key/value pairs of form.

object

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.37. FS Insurance Policies

FS Insurance Policies Controller

3.37.1. Get all policies

GET /{baseSiteId}/users/{userId}/policies

Description

Returns information on all policies for a provided user of a specified base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

category
optional

Parameter for filtering policies based on the category code.

string

Query

date
optional

Parameter for filtering policies based on the start date.

string

Query

dateOperator
optional

Parameter for filtering policies date based on the operator. Standard allowable values are: >=, <=. Default value: <=

string

"⇐"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

status
optional

Parameter for filtering policies based on the policy status.

string

Responses

HTTP Code

Description

Schema

200

InsurancePolicyList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.37.2. Get a premium calendar

GET /{baseSiteId}/users/{userId}/policies/premium-calendar

Description

Returns premium calendar for a provided user of a specified base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

InsurancePolicyList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.37.3. Get a policy

GET /{baseSiteId}/users/{userId}/policies/{policyId}/contracts/{contractNumber}

Description

Returns policy details for a provided user of a specified base store based on the policy number and contract number.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

contractNumber
required

Contract identifier; used to distinguish cases in which one policy may have multiple insured persons and, therefore, multiple contracts associated with it.

string

Path

policyId
required

Policy identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.38. FS Insurance Quotes

FS Insurance Quotes Controller

3.38.1. Create insurance quote for a specific user

POST /{baseSiteId}/users/{userId}/carts/{cartId}/insurance-quotes

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.38.2. Update insurance quote for a specific user

PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/insurance-quotes

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

insuranceQuote
required

insuranceQuote

Responses

HTTP Code

Description

Schema

200

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.38.3. Invoke particular action on insurance quote object. Currently available action is BIND

POST /{baseSiteId}/users/{userId}/carts/{cartId}/insurance-quotes/action

Description

Bind action is used to change state of insurance quote for specified cart.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: the cart for which insurance quote is being bound

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

action
required

action

Responses

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.38.4. Get all insurance quotes

GET /{baseSiteId}/users/{userId}/insurance-quotes

Description

Returns information on all quotes for a provided user of a specified base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

InsuranceQuoteList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.38.5. Get insurance quote for a specific user and quoteId

GET /{baseSiteId}/users/{userId}/insurance-quotes/{quoteId}

Description

Returns information on quote for a provided user of a specified base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

quoteId
required

Parameter for filtering quotes based on the quoteId.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.39. FS Miscs

FS Miscs Controller

3.39.1. Get a list of values.

GET /{baseSiteId}/catalogs/{catalogId}/valueLists/{valueListId}

Description

Lists all values for specified list.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

catalogId
required

Catalog identifier.

string

Path

valueListId
required

Value List identifier.

string

Query

categoryCode
optional

Parameter for getting value list based on category code.

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

parentListItemCode
optional

Parameter for getting value list based on selected parent list item.

string

Responses

HTTP Code

Description

Schema

200

FSValueList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.39.2. Get a list of incident types per category.

GET /{baseSiteId}/fsIncidentTypes

Description

Lists all incident types for specified category.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

categoryCode
optional

Parameter for filtering incident types based on the category code.

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

FSIncidentTypeList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.40. FS OBO Consents

FSOBO Consents Controller

3.40.1. Transfer cart to customer created by consent holder

PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/oboconsents/action

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

oboCustomerUid
required

Uid of customer created by consent holder on which cart should be transferred.

string

Body

action
required

action

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.40.2. Get on behalf of consents

GET /{baseSiteId}/users/{userId}/oboconsents

Description

Returns information of on behalf of consents for a provided user of a specified base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

FSOBOConsentList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.40.3. Registers a OBO customer

POST /{baseSiteId}/users/{userId}/oboconsents/customers

Description

Creates a new customer. Operation initiated by seller user.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

customerCreation
required

Data object that contains information necessary for user creation

FSOBOCustomerCreation

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.40.4. Gets the list of customers created by consent holder

GET /{baseSiteId}/users/{userId}/oboconsents/customers

Description

Returns the list of customers for a specified base store, created by specified consent holder. The response can display the results across multiple pages, if required.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

Query

sort
optional

Sorting method applied to the returned results.

string

"name"

Query

sortOrder
optional

the sorting order method applied to the return results

string

"desc"

Responses

HTTP Code

Description

Schema

200

FSCustomerSearchPage

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.40.5. Update permission for OBO customer

PATCH /{baseSiteId}/users/{userId}/oboconsents/customers/permission

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

oboConsentHolderUid
required

Uid of consent holder for whose customer permission should be updated.

string

Query

oboPermissionName
required

Name of permission which should be updated.

string

Query

oboPermissionValue
required

Permission value which should be updated.

boolean

Body

action
required

action

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.40.6. Get a OBO customer profile

GET /{baseSiteId}/users/{userId}/oboconsents/customers/{customerId}

Description

Returns a OBO customer profile.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

customerId
required

OBO Customer UID (Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"FULL"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.40.7. Creates a new address for customer that has given On-Behalf-Of Consent.

POST /{baseSiteId}/users/{userId}/oboconsents/customers/{customerId}/addresses

Description

Creates a new address for specifier customer.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

customerId
required

OBO Customer UID (Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

address
required

Address object.

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.40.8. Updates the existing address for customer that has given On-Behalf-Of Consent.

PATCH /{baseSiteId}/users/{userId}/oboconsents/customers/{customerId}/addresses/{addressId}

Description

Updates the address. Only attributes provided in the request body will be changed.

Parameters

Type

Name

Description

Schema

Path

addressId
required

Address identifier.

string

Path

baseSiteId
required

Base site identifier

string

Path

customerId
required

OBO Customer UID (Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

address
required

Address object

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.40.9. Get claims for OBO customer profile

GET /{baseSiteId}/users/{userId}/oboconsents/customers/{customerId}/claims

Description

Returns claims for OBO customer.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

customerId
required

OBO Customer UID (Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

FsClaimList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.40.10. Get insurance policies for OBO customer profile

GET /{baseSiteId}/users/{userId}/oboconsents/customers/{customerId}/policies

Description

Returns insurance policies for OBO customer.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

customerId
required

OBO Customer UID (Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

InsurancePolicyList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.40.11. Get insurance quotes for OBO customer profile

GET /{baseSiteId}/users/{userId}/oboconsents/customers/{customerId}/quotes

Description

Returns insurance quotes for OBO customer.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

customerId
required

OBO Customer UID (Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

InsuranceQuoteList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.41. FS OrgUnit Product Assignments

FS Org Unit Product Assignments Controller

3.41.1. Creates product assignment for B2B unit.

POST /{baseSiteId}/users/{userId}/orgUnits/{orgUnitId}/fsProductAssignments

Description

Creates product assignment for B2B unit by organizational manager.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitId
required

Organizational Unit identifier.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

productCode
required

Code of product that should be assigned for specified B2B Unit.

string

Responses

HTTP Code

Description

Schema

201

Created

FSProductAssignment

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.41.2. Get list of assigned products for B2B unit.

GET /{baseSiteId}/users/{userId}/orgUnits/{orgUnitId}/fsProductAssignments

Description

Get list of products which are assigned for B2B unit from organization manager.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitId
required

Organizational Unit identifier.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

active
optional

Parameter for filtering assignments by active status.

boolean

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"2147483647"

Query

sortCode
optional

The sorting method applied to the return results.

string

"active"

Query

sortOrder
optional

The sorting order method applied to the return results.

string

"asc"

Responses

HTTP Code

Description

Schema

200

FSProductAssignmentList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.41.3. Removes product assignment for specific orgUnit.

DELETE /{baseSiteId}/users/{userId}/orgUnits/{orgUnitId}/fsProductAssignments/{fsProductAssignmentCode}

Description

Removes product assignment for specific organizational unit.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

fsProductAssignmentCode
required

Identifier of the product assignment which will be removed.

string

Path

orgUnitId
required

Organizational Unit identifier.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type

Name

oauth2

oauth2

3.41.4. Updates product assignment for specified orgUnit.

PATCH /{baseSiteId}/users/{userId}/orgUnits/{orgUnitId}/fsProductAssignments/{fsProductAssignmentCode}

Description

Updates product assignment for specified organizational unit.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

fsProductAssignmentCode
required

Assignment code.

string

Path

orgUnitId
required

Organizational Unit identifier.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

productAssignment
required

productAssignment

FSProductAssignment

Responses

HTTP Code

Description

Schema

200

FSProductAssignment

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.42. FS Products

FS Products Controller

3.42.1. Calculates product price.

POST /{baseSiteId}/fsproducts/{productCode}/calculation

Description

Calculates price for a single product according to product code and product price attributes.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

productPriceAttributes
optional

Product price attributes

FSProductPriceAttributes

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.43. FS Site Messages

FS Site Messages Controller

3.43.1. Get all site messages by message group

GET /{baseSiteId}/users/{userId}/notifications/fssitemessages

Description

Returns the site messages of customer for specified message group.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

the current result page requested

string

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

lang
optional

specifies the language

string

"en"

Query

messagegroup
optional

Message group. Default value is generalMessageGroup.

string

Query

pageSize
optional

the number of results returned per page

string

Query

read
optional

specifies the flag for filtering read/unread messages

boolean

Query

sortCode
optional

the sorting method applied to the return results

string

"sentDate"

Query

sortOrder
optional

the sorting order method applied to the return results

string

"desc"

Responses

HTTP Code

Description

Schema

200

siteMessageSearchPage

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.43.2. Updates the read date of provided site messages

PUT /{baseSiteId}/users/{userId}/notifications/fssitemessages/read-unread

Description

Updates the read date of provided site messages for a customer

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

messageCodes
required

List of site message identifiers

< string > array(multi)

Query

readStatus
required

Read status

boolean

Responses

HTTP Code

Description

Schema

200

SiteMessageList

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.43.3. Get a site message by message code

GET /{baseSiteId}/users/{userId}/notifications/fssitemessages/{messageCode}

Description

Returns the site message of customer for specified message code.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

messageCode
required

Message Code

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

siteMessage

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.44. FS User Requests

FS User Requests Controller

3.44.1. Get user request

GET /{baseSiteId}/users/{userId}/fsUserRequests/{fsUserRequestId}

Description

Returns information about user request for the provided requestId for the current user

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

fsUserRequestId
required

User request identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.44.2. Update user request

PATCH /{baseSiteId}/users/{userId}/fsUserRequests/{fsUserRequestId}

Description

Updates step data for user request for the provided requestId for the current user

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

fsUserRequestId
required

User request identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

fsStepData
required

Step data content

FSStepData

Responses

HTTP Code

Description

Schema

200

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.44.3. Invokes specified action on particular fs user request object. Supported value is SUBMIT

POST /{baseSiteId}/users/{userId}/fsUserRequests/{fsUserRequestId}/action

Description

Submit action triggers submission of fs user request for a provided user of a specified base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

fsUserRequestId
required

User request identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

action
required

action

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.45. FS Users

FS Users Controller

3.45.1. Registers a financial customer

POST /{baseSiteId}/fsusers

Description

Registers a financial customer. Requires the UserSignUp object with following parameters: uid, password, firstName, lastName, phoneNumber, dateOfBirth, titleCode.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

user
required

User’s object.

UserSignUp

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.45.2. Get financial customer profile

GET /{baseSiteId}/fsusers/{userId}

Description

Returns financial customer profile.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.45.3. Updates customer profile

PATCH /{baseSiteId}/fsusers/{userId}

Description

Updates customer profile. Only attributes provided in the request body will be changed.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

user
required

User’s object.

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

OrderStatusUpdateElementList

3.46. Feeds

Feeds Controller

3.46.1. Get a list of orders with status updates.

GET /{baseSiteId}/feeds/orders/statusfeed

Description

Returns the orders that have changed status. Returns only the elements from the current baseSite that have been updated after the provided timestamp.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

timestamp
required

Only items newer than the given parameter are retrieved. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).

string

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.47. Forgotten Passwords

Forgotten Passwords Controller

3.47.1. Generates a token to restore a customer’s forgotten password.

POST /{baseSiteId}/forgottenpasswordtokens

Description

Generates a token to restore a customer’s forgotten password.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Query

userId
required

Customer’s user id. Customer user id is case insensitive.

string

Responses

HTTP Code

Description

Schema

201

Created

No Content

202

Accepted

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.47.2. Reset password after customer’s clicked forgotten password link.

POST /{baseSiteId}/resetpassword

Description

Reset password after customer’s clicked forgotten password link.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Body

resetPassword
required

Request body parameter that contains details such as token and new password

ResetPassword

Responses

HTTP Code

Description

Schema

201

Created

No Content

202

Accepted

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.48. Future Stocks

Future Stocks Controller

3.48.1. Gets the future product availability for the list of specified products.

GET /{baseSiteId}/users/{userId}/futureStocks

Description

Returns a list of product codes with a list of future product availability.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

productCodes
required

Products identifiers.

string

Responses

HTTP Code

Description

Schema

200

ProductFutureStocksList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.48.2. Gets the future product availability for the specified product.

GET /{baseSiteId}/users/{userId}/futureStocks/{productCode}

Description

Returns a list of future product availability of the specified product.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

ProductFutureStocks

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.49. Login Notification

3.49.1. Notify about successful login.

POST /{baseSiteId}/users/{userId}/loginnotification

Description

Publish notification event about successful login.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

201

Created

No Content

202

Accepted

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.50. Merchant Callback

Merchant Callback Controller

3.50.1. Verify the decision of the Merchant

POST /{baseSiteId}/integration/merchant_callback

Description

Verifies the decision of the merchant.

Note, the “Try it out” button is not enabled for this method (always returns an error) because the Merchant Callback Controller handles parameters differently, depending on which payment provider is used. For more information about this controller, please refer to the “acceleratorocc AddOn” documentation on help.hybris.com.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Responses

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.50.2. Verify the decision of the Merchant for a cart

POST /{baseSiteId}/integration/users/{userId}/carts/{cartId}/payment/sop/response

Description

Verifies the decision of the merchant for a specified cart, and stores information of the PaymentSubscriptionResult for the cart.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.51. Miscs

Miscs Controller

3.51.1. Get a list of supported payment card types.

GET /{baseSiteId}/cardtypes

Description

Lists supported payment card types.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

CardTypeList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.51.2. Get a list of available currencies.

GET /{baseSiteId}/currencies

Description

Lists all available currencies (all usable currencies for the current store). If the list of currencies for a base store is empty, a list of all currencies available in the system is returned.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

CurrencyList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.51.3. Get a list of shipping countries.

GET /{baseSiteId}/deliverycountries

Caution

operation.deprecated

Description

Lists all supported delivery countries for the current store. The list is sorted alphabetically.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

CountryList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.51.4. Get a list of available languages.

GET /{baseSiteId}/languages

Description

Lists all available languages (all languages used for a particular store). If the list of languages for a base store is empty, a list of all languages available in the system will be returned.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

LanguageList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.51.5. Get a list of all localized titles.

GET /{baseSiteId}/titles

Description

Lists all localized titles.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

TitleList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

notificationPreferenceList

3.52. Notification Preference

Notification Preference Controller

3.52.1. Gets all notification preferences of the current customer

GET /{baseSiteId}/users/{userId}/notificationpreferences

Description

Returns the notification preferences of the current customer.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

BasicnotificationPreferenceList

3.52.2. Updates the notification preferences of the current customer

PATCH /{baseSiteId}/users/{userId}/notificationpreferences

Description

Updates the notification preference of the current customer.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

notificationPreferences
required

Notification preference list

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

OrderApprovalPermissionTypeList

3.53. Order Approval Permission Types

Order Approval Permission Types Controller

3.53.1. Get order approval permission types.

GET /{baseSiteId}/orderApprovalPermissionTypes

Description

Returns the list of order approval permission types.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.54. Order Approval Permissions

Order Approval Permissions Controller

3.54.1. Create a new order approval permission.

POST /{baseSiteId}/users/{userId}/orderApprovalPermissions

Description

Creates a new order approval permission.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

orderApprovalPermission
required

Order Approval Permission object.

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

OrderApprovalPermissionList

3.54.2. Get order approval permissions.

GET /{baseSiteId}/users/{userId}/orderApprovalPermissions

Description

Returns the list of order approval permissions for the company of the identified user. The response can display the results across multiple pages, if required.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the return results.

string

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.54.3. Get an order approval permission.

GET /{baseSiteId}/users/{userId}/orderApprovalPermissions/{orderApprovalPermissionCode}

Description

Returns a specific order approval permission based on specific code. The response contains detailed order approval permission information.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orderApprovalPermissionCode
required

Order Approval Permission identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.54.4. Update the order approval permission

PATCH /{baseSiteId}/users/{userId}/orderApprovalPermissions/{orderApprovalPermissionCode}

Description

Updates the order approval permission. Only attributes provided in the request body will be changed.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orderApprovalPermissionCode
required

Order Approval Permission identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

orderApprovalPermission
required

Order Approval Permission object.

Responses

HTTP Code

Description

Schema

200

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.55. Order Approvals

Order Approvals Controller

3.55.1. Get orders to approve.

GET /{baseSiteId}/users/{userId}/orderapprovals

Description

Returns the list of orders the specified user is allowed to approve.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the return results.

string

Responses

HTTP Code

Description

Schema

200

OrderApprovalList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.55.2. Get an order to approve.

GET /{baseSiteId}/users/{userId}/orderapprovals/{orderApprovalCode}

Description

Returns specific order details based on a specific order code. The response contains detailed order information.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orderApprovalCode
required

Code that identifies the order approval.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

OrderApproval

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.55.3. Makes an approval decision for an order.

POST /{baseSiteId}/users/{userId}/orderapprovals/{orderApprovalCode}/decision

Description

Makes a decision on the order approval that will trigger the next step in the approval workflow.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orderApprovalCode
required

Code that identifies the order approval.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

orderApprovalDecision
required

The order approval decision. The approval decision field is mandatory, and the approval comment field is mandatory if the decision is 'rejected'.

OrderApprovalDecision

Responses

HTTP Code

Description

Schema

200

OrderApprovalDecision

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.56. Orders

Orders Controller

3.56.1. Get a order.

GET /{baseSiteId}/orders/{code}

Description

Returns details of a specific order based on the order GUID (Globally Unique Identifier) or the order CODE. The response contains detailed order information.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

code
required

Order GUID (Globally Unique Identifier) or order CODE

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.56.2. Place a order.

POST /{baseSiteId}/users/{userId}/orders

Description

Authorizes the cart and places the order. The response contains the new order data.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

cartId
required

Cart code for logged in user, cart GUID for guest checkout

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.56.3. Get order history for user.

GET /{baseSiteId}/users/{userId}/orders

Description

Returns order history data for all orders placed by a specified user for a specified base store. The response can display the results across multiple pages, if required.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the return results.

string

Query

statuses
optional

Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID.

string

Responses

HTTP Code

Description

Schema

200

OrderHistoryList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.56.4. Get total number of orders.

HEAD /{baseSiteId}/users/{userId}/orders

Description

In the response header, the "x-total-count" indicates the total number of orders placed by a specified user for a specified base store.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

statuses
optional

Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID.

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.56.5. Get a order.

GET /{baseSiteId}/users/{userId}/orders/{code}

Description

Returns specific order details based on a specific order code. The response contains detailed order information.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

code
required

Order GUID (Globally Unique Identifier) or order CODE

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

CancellationRequestEntryInputList

3.56.6. Cancel an order.

POST /{baseSiteId}/users/{userId}/orders/{code}/cancellation

Description

Cancels an order partially or completely

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

code
required

Order code

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

cancellationRequestEntryInputList
required

Cancellation request input list for the current order.

Responses

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.57. Organizational Unit Customer Management

Org Customer Management Controller

3.57.1. Registers a org customer

POST /{baseSiteId}/users/{userId}/orgCustomers

Description

Creates a new organizational customer.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

orgCustomerCreation
required

Data object that contains information necessary for user creation

OrgCustomerCreation

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.57.2. Gets the list of org customers for a specified base store

GET /{baseSiteId}/users/{userId}/orgCustomers

Description

Returns the list of org customers for a specified base store. The response can display the results across multiple pages, if required.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the returned results.

string

"name"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.57.3. Get a org customer profile

GET /{baseSiteId}/users/{userId}/orgCustomers/{orgCustomerId}

Description

Returns a org customer profile.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgCustomerId
required

Org Customer GUID (Globally Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.57.4. Updates org customer profile

PATCH /{baseSiteId}/users/{userId}/orgCustomers/{orgCustomerId}

Description

Updates org customer profile. Only attributes provided in the request body will be changed.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

orgCustomerId
required

Org Customer GUID (Globally Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

orgCustomerModification
required

Data object which contains information necessary for user modification

OrgCustomerModification

Responses

HTTP Code

Description

Schema

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.57.5. Gets the list of approvers for an specified org customer

GET /{baseSiteId}/users/{userId}/orgCustomers/{orgCustomerId}/approvers

Description

Returns the list of approvers for an specified org customer. The response can display the results across multiple pages, if required.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgCustomerId
required

Org Customer GUID (Globally Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the returned results.

string

"name"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.57.6. Add an approver to an specific org customer

POST /{baseSiteId}/users/{userId}/orgCustomers/{orgCustomerId}/approvers/{approverId}

Description

Add an approver to an specific org customer

Parameters

Type Name Description Schema Default

Path

approverId
required

Approver GUID (Globally Unique Identifier).

string

Path

baseSiteId
required

Base site identifier

string

Path

orgCustomerId
required

Org Customer GUID (Globally Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.57.7. Deletes an approver from an specific org customer with the provided approverId

DELETE /{baseSiteId}/users/{userId}/orgCustomers/{orgCustomerId}/approvers/{approverId}

Description

Deletes an approver from an specific org customer with the provided approverId

Parameters

Type Name Description Schema Default

Path

approverId
required

Approver GUID (Globally Unique Identifier).

string

Path

baseSiteId
required

Base site identifier

string

Path

orgCustomerId
required

Org Customer GUID (Globally Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.57.8. Gets the list of org user groups for a specified org customer

GET /{baseSiteId}/users/{userId}/orgCustomers/{orgCustomerId}/orgUserGroups

Description

Returns the list of org user gruops for a specified org customer. The response can display the results across multiple pages, if required.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgCustomerId
required

Org Customer GUID (Globally Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the returned results.

string

"name"

Responses

HTTP Code

Description

Schema

200

OrgUnitUserGroupList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.57.9. Add an org user group to an specific org customer

POST /{baseSiteId}/users/{userId}/orgCustomers/{orgCustomerId}/orgUserGroups/{userGroupId}

Description

Add an org user group to an specific org customer

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgCustomerId
required

Org Customer GUID (Globally Unique Identifier).

string

Path

userGroupId
required

Org User Group GUID (Globally Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.57.10. Deletes an org user group from an specific org customer with the provided orgUserGroupId

DELETE /{baseSiteId}/users/{userId}/orgCustomers/{orgCustomerId}/orgUserGroups/{userGroupId}

Description

Deletes an org user group from an specific org customer with the provided orgUserGroupId

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

orgCustomerId
required

Org Customer GUID (Globally Unique Identifier).

string

Path

userGroupId
required

Org User Group GUID (Globally Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

OrderApprovalPermissionList

3.57.11. Gets the list of permissions for an org customer

GET /{baseSiteId}/users/{userId}/orgCustomers/{orgCustomerId}/permissions

Description

Returns the list of permissions for a user. The response can display the results across multiple pages, if required.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgCustomerId
required

Org Customer GUID (Globally Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the returned results.

string

"name"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.57.12. Add a permission to an specific org customer

POST /{baseSiteId}/users/{userId}/orgCustomers/{orgCustomerId}/permissions/{permissionId}

Description

Add a permission to an specific org customer

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgCustomerId
required

Org Customer GUID (Globally Unique Identifier).

string

Path

permissionId
required

Permission GUID (Globally Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.57.13. Deletes a permission from an specific org customer with the provided permissionId

DELETE /{baseSiteId}/users/{userId}/orgCustomers/{orgCustomerId}/permissions/{permissionId}

Description

Deletes a permission from an specific org customer with the provided permissionId

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgCustomerId
required

Org Customer GUID (Globally Unique Identifier).

string

Path

permissionId
required

Permission GUID (Globally Unique Identifier).

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.58. Organizational Unit Management

Org Units Controller

3.58.1. Get available organizational unit nodes.

GET /{baseSiteId}/users/{userId}/availableOrgUnitNodes

Description

Returns list of available organizational unit nodes.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

B2BUnitNodeList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.58.2. Add a role to a specific organizational customer

POST /{baseSiteId}/users/{userId}/orgCustomers/{orgCustomerId}/roles

Description

Adds a role to a specific organizational customer

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgCustomerId
required

Identifier of the organizational customer which the role will be added.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

roleId
required

The role which is added to the organizational customer. Example roles are: b2badmingroup, b2bmanagergroup, b2bcustomergroup

string

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.58.3. Remove a role from a specific organizational customer

DELETE /{baseSiteId}/users/{userId}/orgCustomers/{orgCustomerId}/roles/{roleId}

Description

Removes a role from a specific organizational customer

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgCustomerId
required

Identifier of the organizational customer which the role will be removed.

string

Path

roleId
required

The role which is removed from the user. Example roles are: b2badmingroup, b2bmanagergroup, b2bcustomergroup

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.58.4. Create a new organizational unit.

POST /{baseSiteId}/users/{userId}/orgUnits

Description

Creates a new organizational unit.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

orgUnit
required

Organizational Unit object.

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.58.5. Get an organizational unit.

GET /{baseSiteId}/users/{userId}/orgUnits/{orgUnitId}

Description

Returns a specific organizational unit based on specific id. The response contains detailed organizational unit information.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitId
required

Organizational Unit identifier.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.58.6. Update the organizational unit

PATCH /{baseSiteId}/users/{userId}/orgUnits/{orgUnitId}

Description

Updates the organizational unit. Only attributes provided in the request body will be changed.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitId
required

Organizational Unit identifier.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

orgUnit
required

Organizational Unit object.

Responses

HTTP Code

Description

Schema

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.58.7. Create a new organizational unit address

POST /{baseSiteId}/users/{userId}/orgUnits/{orgUnitId}/addresses

Description

Creates a new organizational unit address

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitId
required

Organizational unit id.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

address
required

Address object.

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.58.8. Get organizational unit addresses

GET /{baseSiteId}/users/{userId}/orgUnits/{orgUnitId}/addresses

Description

Retrieves organizational unit addresses

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitId
required

Organizational unit id.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

AddressList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.58.9. Remove the organizational unit address.

DELETE /{baseSiteId}/users/{userId}/orgUnits/{orgUnitId}/addresses/{addressId}

Description

Removes the organizational unit address.

Parameters

Type

Name

Description

Schema

Path

addressId
required

Address id.

string

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitId
required

Organizational unit id.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.58.10. Update the organizational unit address.

PATCH /{baseSiteId}/users/{userId}/orgUnits/{orgUnitId}/addresses/{addressId}

Description

Updates the organizational unit address. Only attributes provided in the request body will be changed.

Parameters

Type

Name

Description

Schema

Path

addressId
required

Address id.

string

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitId
required

Organizational unit id.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

address
required

Address object.

Responses

HTTP Code

Description

Schema

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.58.11. Get available parent units.

GET /{baseSiteId}/users/{userId}/orgUnits/{orgUnitId}/availableParents

Description

Returns a list of parent units for which the unit with id can be assigned as a child.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitId
required

Organizational Unit identifier.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

B2BUnitNodeList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.58.12. Get users who belongs to the organization unit.

GET /{baseSiteId}/users/{userId}/orgUnits/{orgUnitId}/availableUsers/{roleId}

Description

Returns list of users which belongs to the organizational unit and can be assigned to a specific role. Users who are already assigned to the role are flagged by 'selected' attribute.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitId
required

Organizational unit id.

string

Path

roleId
required

Filtering parameter which is used to return a specific role. Example roles are: b2bapprovergroup, b2badmingroup, b2bmanagergroup, b2bcustomergroup

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the display search results.

string

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.58.13. Add an organizational unit dependent role to a specific organizational customer

POST /{baseSiteId}/users/{userId}/orgUnits/{orgUnitId}/orgCustomers/{orgCustomerId}/roles

Description

Adds an organizational unit dependent role to a specific organizational customer

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

orgCustomerId
required

Identifier of the organizational customer which the role will be added.

string

Path

orgUnitId
required

Organizational unit id.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

roleId
required

The role which is added to the user. Example roles are: b2bapprovergroup

string

Responses

HTTP Code

Description

Schema

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.58.14. Remove an organizational unit dependent role from a specific organizational customer.

DELETE /{baseSiteId}/users/{userId}/orgUnits/{orgUnitId}/orgCustomers/{orgCustomerId}/roles/{roleId}

Description

Removes an organizational unit dependent role from a specific organizational customer.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

orgCustomerId
required

Identifier of the organizational customer which the role will be removed.

string

Path

orgUnitId
required

Organizational unit id.

string

Path

roleId
required

The role which is removed from the user. Example roles are: b2bapprovergroup, b2badmingroup, b2bmanagergroup, b2bcustomergroup

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.58.15. Get available approval business processes.

GET /{baseSiteId}/users/{userId}/orgUnitsAvailableApprovalProcesses

Description

Returns list of available approval business processes.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

B2BApprovalProcessList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.58.16. Get the root organizational unit node.

GET /{baseSiteId}/users/{userId}/orgUnitsRootNodeTree

Description

Returns the root organizational unit node. The response contains detailed organizational unit node information and the child nodes associated to it.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

B2BUnitNode

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.59. Organizational Unit User Groups

Org Unit User Groups Controller

3.59.1. Creates a new organizational unit user group

POST /{baseSiteId}/users/{userId}/orgUnitUserGroups

Description

Creates a new organizational unit user group.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

orgUnitUserGroup
required

Organizational unit user group object.

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.59.2. Gets the list of organizational unit user groups for a specified base store

GET /{baseSiteId}/users/{userId}/orgUnitUserGroups

Description

Returns the list of organizational unit user groups accessible for a specified base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the returned results.

string

"uid"

Responses

HTTP Code

Description

Schema

200

OrgUnitUserGroupList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.59.3. Gets specific organizational unit user group details accessible for a specified base store based on user group code

GET /{baseSiteId}/users/{userId}/orgUnitUserGroups/{orgUnitUserGroupId}

Description

Returns specific UserGroup details accessible for a specified base store based on UserGroup code. The response contains detailed order information.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitUserGroupId
required

Organizational unit user group identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.59.4. Removes the organizational unit user group

DELETE /{baseSiteId}/users/{userId}/orgUnitUserGroups/{orgUnitUserGroupId}

Description

Removes the organizational unit user group.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitUserGroupId
required

Organizational unit user group identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.59.5. Updates the organizational unit user group

PATCH /{baseSiteId}/users/{userId}/orgUnitUserGroups/{orgUnitUserGroupId}

Description

Updates the organizational unit user group. Only attributes provided in the request body will be changed.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitUserGroupId
required

Organizational unit user group identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

orgUnitUserGroup
required

Organizational unit user group object.

Responses

HTTP Code

Description

Schema

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

OrderApprovalPermissionList

3.59.6. Gets the list of order approval permissions for a specified organizational unit user group

GET /{baseSiteId}/users/{userId}/orgUnitUserGroups/{orgUnitUserGroupId}/availableOrderApprovalPermissions

Description

Returns the list of order approval permissions who can belong to a specific organizational unit user group. Order approval permissions who already belong to the user group are flagged by 'selected' attribute.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitUserGroupId
required

Organizational unit user group identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the returned results.

string

"name"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.59.7. Gets the list of organizational customers for a specified organizational unit user group

GET /{baseSiteId}/users/{userId}/orgUnitUserGroups/{orgUnitUserGroupId}/availableOrgCustomers

Description

Returns the list of organizational customers who can belong to a specific organizational unit user group. Users who already belong to the user group are flagged by 'selected' attribute.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitUserGroupId
required

Organizational unit user group identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the returned results.

string

"name"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.59.8. Add an organizational customer to a specific unit user group members

POST /{baseSiteId}/users/{userId}/orgUnitUserGroups/{orgUnitUserGroupId}/members

Description

Adds an organizational customer to a specific unit user group members

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitUserGroupId
required

Organizational unit user group identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

orgCustomerId
required

Identifier of the organizational customer which will be added to the organizational unit user group members

string

Responses

HTTP Code

Description

Schema

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.59.9. Removes all organizational customers in the organizational unit user group members

DELETE /{baseSiteId}/users/{userId}/orgUnitUserGroups/{orgUnitUserGroupId}/members

Description

Removes all organizational customers in the organizational unit user group members which marks the user group disabled until a new member is added

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitUserGroupId
required

Organizational unit user group identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.59.10. Remove an organizational customer from the organizational unit user group members

DELETE /{baseSiteId}/users/{userId}/orgUnitUserGroups/{orgUnitUserGroupId}/members/{orgCustomerId}

Description

Removes an organizational customer from the organizational unit user group members

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

orgCustomerId
required

Identifier of the organizational customer which will be removed from the organizational unit user group members

string

Path

orgUnitUserGroupId
required

Organizational unit user group identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.59.11. Add an order approval permission to a specific organizational unit user group

POST /{baseSiteId}/users/{userId}/orgUnitUserGroups/{orgUnitUserGroupId}/orderApprovalPermissions

Description

Adds an order approval permission to a specific organizational unit user group

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orgUnitUserGroupId
required

Identifier of the organizational unit user group which the order approval permission will be added.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

orderApprovalPermissionCode
required

Order approval permission identifier which is added to the organizational unit user group.

string

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.59.12. Remove an order approval permission from a specific organizational unit user group

DELETE /{baseSiteId}/users/{userId}/orgUnitUserGroups/{orgUnitUserGroupId}/orderApprovalPermissions/{orderApprovalPermissionCode}

Description

Removes an order approval permission from a specific organizational unit user group

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

orderApprovalPermissionCode
required

Order approval permission identifier which is removed from the organizational unit user group.

string

Path

orgUnitUserGroupId
required

Organizational unit user group identifier which is added to the organizational customer.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.60. Pages

Page Controller

3.60.1. Get page data with a list of cms content slots

GET /{baseSiteId}/cms/pages

Description

Get page data with a list of cms content slots based on pageLabelOrId or code. If none is provided then this will retrieve a Homepage cms content slots.
Content pages can be filtered by pageLabelOrId while the rest of the page types can be filtered by the code.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

code
optional

If pageType is ProductPage, code should be product code; if pageType is CategoryPage, code should be category code; if pageType is CatalogPage, code should be catalog code

string

Query

fields
optional

Response configuration (list of fields, which should be returned in response)

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

pageLabelOrId
optional

Page Label or Id; if no page has a label that matches the provided label exactly, try to find pages whose label starts with a section of the provided label. Otherwise, try to find the page by id. Note: URL encoding on the page label should be applied when the label contains special characters

string

Query

pageType
optional

Page type

enum (ContentPage, ProductPage, CategoryPage, CatalogPage)

"ContentPage"

Responses

HTTP Code

Description

Schema

200

PageAdaptedData

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.60.2. Get page data for specific page id with a list of cms content slots

GET /{baseSiteId}/cms/pages/{pageId}

Description

Given a page identifier, return the page data with a list of cms content slots, each of which contains a list of cms component data.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

pageId
required

Page Id

string

Query

fields
optional

Response configuration (list of fields, which should be returned in response)

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

PageAdaptedData

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.60.3. Get a list of page data.

GET /{baseSiteId}/cms/sitepages

Description

Get a list page data with pagination support.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

currentPage
optional

Pagination parameter. Default value 0.

integer(int32)

"0"

Query

fields
optional

Response configuration (list of fields, which should be returned in response)

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

pageSize
optional

Optional pagination parameter. Default value 10.

integer(int32)

"10"

Query

pageType
optional

Page type.

enum (ContentPage, ProductPage, CategoryPage, CatalogPage)

Query

sort
optional

Optional sort criterion. No default value.

string

Responses

HTTP Code

Description

Schema

200

ListAdaptedPages

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.61. Payment Details

Payment Details Controller

3.61.1. Get customer’s credit card payment details list.

GET /{baseSiteId}/users/{userId}/paymentdetails

Description

Return customer’s credit card payment details list.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

saved
optional

Type of payment details.

boolean

"false"

Responses

HTTP Code

Description

Schema

200

PaymentDetailsList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.61.2. Get customer’s credit card payment details.

GET /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}

Description

Returns a customer’s credit card payment details for the specified paymentDetailsId.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

paymentDetailsId
required

Payment details identifier.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.61.3. Updates existing customer’s credit card payment info.

PUT /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}

Description

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).

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

paymentDetailsId
required

Payment details identifier.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

paymentDetails
required

Payment details object.

Responses

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.61.4. Deletes customer’s credit card payment details.

DELETE /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}

Description

Deletes a customer’s credit card payment details based on a specified paymentDetailsId.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

paymentDetailsId
required

Payment details identifier.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type

Name

oauth2

oauth2

3.61.5. Updates existing customer’s credit card payment details.

PATCH /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}

Description

Updates an existing customer’s credit card payment details based on the specified paymentDetailsId. Only those attributes provided in the request will be updated.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

paymentDetailsId
required

Payment details identifier.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

paymentDetails
required

Payment details object

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.62. Payment Modes

Payment Modes Controller

3.62.1. Gets all available payment modes.

GET /{baseSiteId}/paymentmodes

Description

Gets all payment modes defined for the base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

PaymentModeList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

ProductExpressUpdateElementList

3.63. Products

Products Controller

3.63.1. Get products added to the express update feed.

GET /{baseSiteId}/products/expressupdate

Description

Returns products added to the express update feed. Returns only elements updated after the provided timestamp. The queue is cleared using a defined cronjob.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

catalog
optional

Only products from this catalog are returned. Format: catalogId:catalogVersion

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

timestamp
required

Only items newer than the given parameter are retrieved from the queue. This parameter should be in ISO-8601 format.

string

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.63.2. Get a list of products and additional data

GET /{baseSiteId}/products/search

Description

Returns a list of products and additional data, such as available facets, available sorting, and pagination options. It can also include spelling suggestions. To make spelling suggestions work, you need to make sure that "enableSpellCheck" on the SearchQuery is set to "true" (by default, it should already be set to "true"). You also need to have indexed properties configured to be used for spellchecking.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

query
optional

Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2

string

Query

searchQueryContext
optional

The context to be used in the search query.

string

Query

sort
optional

Sorting method applied to the return results.

string

Responses

HTTP Code

Description

Schema

200

ProductSearchPage

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.63.3. Get a header with total number of products.

HEAD /{baseSiteId}/products/search

Description

In the response header, the "x-total-count" indicates the total number of products satisfying a query.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Query

query
optional

Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.63.4. Get a list of available suggestions

GET /{baseSiteId}/products/suggestions

Description

Returns a list of all available suggestions related to a given term and limits the results to a specific value of the max parameter.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

max
optional

Specifies the limit of results.

integer(int32)

"10"

Query

term
required

Specified term

string

Responses

HTTP Code

Description

Schema

200

SuggestionList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.63.5. Get product details.

GET /{baseSiteId}/products/{productCode}

Description

Returns details of a single product according to a product code.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.63.6. Get a product reference

GET /{baseSiteId}/products/{productCode}/references

Description

Returns references for a product with a given product code. Reference type specifies which references to return.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

Maximum size of returned results.

integer(int32)

"2147483647"

Query

referenceType
optional

Comma-separated list of reference types according to enum ProductReferenceTypeEnum. If not specified, all types of product references will be used.

string

Responses

HTTP Code

Description

Schema

200

ProductReferenceList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.63.7. Creates a new customer review as an anonymous user.

POST /{baseSiteId}/products/{productCode}/reviews

Description

Creates a new customer review as an anonymous user.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

review
required

Object contains review details like : rating, alias, headline, comment

Review

Responses

HTTP Code

Description

Schema

201

Created

Review

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.63.8. Get reviews for a product

GET /{baseSiteId}/products/{productCode}/reviews

Description

Returns the reviews for a product with a given product code.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

maxCount
optional

Maximum count of reviews

integer(int32)

Responses

HTTP Code

Description

Schema

200

ReviewList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

StoreFinderStockSearchPage

3.63.9. Get a product’s stock level.

GET /{baseSiteId}/products/{productCode}/stock

Description

Returns a product’s stock levels sorted by distance from the specified location, which is provided using the free-text "location" parameter, or by using the longitude and latitude parameters. The following two sets of parameters are available: location (required), currentPage (optional), pageSize (optional); or longitude (required), latitude (required), currentPage (optional), pageSize(optional).

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

latitude
optional

Latitude location parameter.

number(double)

Query

location
optional

Free-text location

string

Query

longitude
optional

Longitude location parameter.

number(double)

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.63.10. Get header with a total number of product’s stock levels.

HEAD /{baseSiteId}/products/{productCode}/stock

Description

In the response header, the "x-total-count" indicates the total number of a product’s stock levels. The following two sets of parameters are available: location (required); or longitude (required), and latitude (required).

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

latitude
optional

Latitude location parameter.

number(double)

Query

location
optional

Free-text location

string

Query

longitude
optional

Longitude location parameter.

number(double)

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.63.11. Get a product’s stock level for a store

GET /{baseSiteId}/products/{productCode}/stock/{storeName}

Description

Returns a product’s stock level for a particular store (in other words, for a particular point of sale).

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Path

storeName
required

Store identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.64. Promotions

Promotions Controller

3.64.1. Get a list of promotions.

GET /{baseSiteId}/promotions

Description

Returns promotions defined for a current base site. 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.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"BASIC"

Query

promotionGroup
optional

Only promotions from this group are returned

string

Query

type
required

Defines what type of promotions should be returned. Values supported for that parameter are: <ul><li>all: All available promotions are returned</li><li>product: Only product promotions are returned</li><li>order: Only order promotions are returned</li></ul>

enum (all, product, order)

Responses

HTTP Code

Description

Schema

200

PromotionList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.64.2. Get a promotion based on code

GET /{baseSiteId}/promotions/{code}

Description

Returns details of a single promotion specified by a promotion code. 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.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

code
required

Promotion identifier (code)

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"BASIC"

Responses

HTTP Code

Description

Schema

200

Promotion

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.65. Quotes

Quote Controller

3.65.1. Request a quote.

POST /{baseSiteId}/users/{userId}/quotes

Description

In the edit state the quote can be requested via cartId, the current content of a cart will be then linked with the quote. The requote action can be triggered by providing the quoteCode parameter, instead of cartId inside the body. The response will contain the new quote’s data.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

quoteStarter
required

Object representing ways of creating new quote - by cartId for creating a new quote from the cart, by quoteCode for the requote action

QuoteStarter

Responses

HTTP Code

Description

Schema

201

Created

Quote

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.65.2. Get all quotes for user.

GET /{baseSiteId}/users/{userId}/quotes

Description

Returns history data for all quotes requested by a specified user for a specified base store. The response can display the results across multiple pages, if required.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"BASIC"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the return results.

string

Responses

HTTP Code

Description

Schema

200

QuoteList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.65.3. Get a specific quote.

GET /{baseSiteId}/users/{userId}/quotes/{quoteCode}

Description

Returns quote details based on a specific quote code. The response contains detailed quote information

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

quoteCode
required

Identifying code of the quote

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

Quote

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.65.4. Edit the quote.

PUT /{baseSiteId}/users/{userId}/quotes/{quoteCode}

Description

Updates name, description or expiry date of the quote.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

quoteCode
required

Identifying code of the quote

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

metadata
required

Updated name, description or expiry date of the quote

QuoteMetadata

Responses

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.65.5. Edit the quote.

PATCH /{baseSiteId}/users/{userId}/quotes/{quoteCode}

Description

Updates name, description or expiry date of the quote.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

quoteCode
required

Identifying code of the quote

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

metadata
required

Updated name, description or expiry date of the quote

QuoteMetadata

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.65.6. Perform workflow actions with the quote.

POST /{baseSiteId}/users/{userId}/quotes/{quoteCode}/action

Description

Perform cancel, submit, edit, checkout, approve, reject actions with the quote.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

quoteCode
required

Identifying code of the quote

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

quoteAction
required

The action with the quote. The quote action field is mandatory.

QuoteAction

Responses

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.65.7. Add a comment to a quote.

POST /{baseSiteId}/users/{userId}/quotes/{quoteCode}/comments

Description

Adds a comment to the quote

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

quoteCode
required

Identifying code of the quote

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

comment
required

Text of the comment

CreateComment

Responses

HTTP Code

Description

Schema

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.65.8. Apply a discount to an existing quote.

POST /{baseSiteId}/users/{userId}/quotes/{quoteCode}/discounts

Description

In the edit state, a seller can apply a discount to a quote. Type of the discount - PERCENT for discount by percentage, ABSOLUTE for discount by amount, TARGET for discount by adjustment of the total value

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

quoteCode
required

Identifying code of the quote

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

quoteDiscount
required

Discount applied to the quote - discountType for type of the discount, discountRate for value of the discount

QuoteDiscount

Responses

HTTP Code

Description

Schema

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.65.9. Add a comment to a line item of a quote.

POST /{baseSiteId}/users/{userId}/quotes/{quoteCode}/entries/{entryNumber}/comments

Description

Add a comment to a line item of a quote.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

entryNumber
required

The entry number. Each entry in a quote has an entry number. Quote entries are numbered in ascending order, starting with zero (0).

integer(int64)

Path

quoteCode
required

Identifying code of the quote

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

comment
required

Text of the comment

CreateComment

Responses

HTTP Code

Description

Schema

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.66. Replenishment Order

Replenishment Order Controller

3.66.1. Gets the list of replenishment orders for a specified user.

GET /{baseSiteId}/users/{userId}/replenishmentOrders

Description

Returns the list of replenishment orders accessible to a specified user.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the returned results.

string

"code"

Responses

HTTP Code

Description

Schema

200

ReplenishmentOrderList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.66.2. Gets replenishment order for a specified user and replenishment order code.

GET /{baseSiteId}/users/{userId}/replenishmentOrders/{replenishmentOrderCode}

Description

Returns specific replenishment order details accessible for a specified user. The response contains detailed orders information from the replenishment order.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

replenishmentOrderCode
required

Unique code for the replenishment order.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

ReplenishmentOrder

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.66.3. Updates the replenishment order for a specified user and replenishment order code.

PATCH /{baseSiteId}/users/{userId}/replenishmentOrders/{replenishmentOrderCode}

Description

Updates the replenishment order. Only cancellation of the replenishment order is supported by setting the attribute 'active' to FALSE. Cancellation of the replenishment order cannot be reverted.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

replenishmentOrderCode
required

Unique code for the replenishment order.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

ReplenishmentOrder

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.66.4. Gets replenishment order history.

GET /{baseSiteId}/users/{userId}/replenishmentOrders/{replenishmentOrderCode}/orders

Description

Returns order history data from a replenishment order placed by a specified user.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

replenishmentOrderCode
required

Unique code for the replenishment order.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the returned results.

string

"code"

Responses

HTTP Code

Description

Schema

200

OrderHistoryList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

ReturnRequestEntryInputList

3.67. Return Requests

Order Returns Controller

3.67.1. Create an order return request.

POST /{baseSiteId}/users/{userId}/orderReturns

Description

Creates an order return request.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

returnRequestEntryInputList
required

Return request input list for the current order.

Responses

HTTP Code

Description

Schema

201

Created

ReturnRequest

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.67.2. Gets the user’s return requests history

GET /{baseSiteId}/users/{userId}/orderReturns

Description

Returns order return request data associated with a specified user for a specified base store.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the return results.

string

Responses

HTTP Code

Description

Schema

200

ReturnRequestList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.67.3. Get the details of a return request.

GET /{baseSiteId}/users/{userId}/orderReturns/{returnRequestCode}

Description

Returns specific order return request details based on a specific return request code. The response contains detailed order return request information.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

returnRequestCode
required

Order return request code

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

ReturnRequest

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces

application/json

Security

Type

Name

oauth2

oauth2

ReturnRequestModification

3.67.4. Updates the order return request.

PATCH /{baseSiteId}/users/{userId}/orderReturns/{returnRequestCode}

Description

Updates the order return request. Only cancellation of the request is supported by setting the attribute status to CANCELLING. Cancellation of the return request cannot be reverted

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

returnRequestCode
required

Order return request code

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

returnRequestModification
required

Return request modification object.

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Produces

application/json

Security

Type

Name

oauth2

oauth2

3.68. Save Cart

Save Cart Controller

3.68.1. Explicitly clones a cart.

POST /{baseSiteId}/users/{userId}/carts/{cartId}/clonesavedcart

Description

Explicitly clones a cart.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

description
optional

The description that should be applied to the cloned cart.

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

name
optional

The name that should be applied to the cloned cart.

string

Responses

HTTP Code

Description

Schema

200

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.68.2. Flag a cart for deletion.

PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/flagForDeletion

Description

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

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.68.3. Restore a saved cart.

PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/restoresavedcart

Description

Restore a saved cart.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.68.4. Explicitly saves a cart.

PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/save

Description

Explicitly saves a cart.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

saveCartDescription
optional

The description that should be applied to the saved cart.

string

Query

saveCartName
optional

The name that should be applied to the saved cart.

string

Responses

HTTP Code

Description

Schema

200

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.68.5. Get a saved cart.

GET /{baseSiteId}/users/{userId}/carts/{cartId}/savedcart

Description

Returns a saved cart for an authenticated user. The cart is identified using the "cartId" parameter.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.69. Site Messages

Site Message Controller

3.69.1. Gets all site messages of current customer.

GET /{baseSiteId}/users/{userId}/notifications/sitemessages

Description

Returns the site messages of current customer.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user.

string

Query

currentPage
optional

The current result page requested.

string

"0"

Query

needsTotal
optional

The flag for indicating if total number of results is needed or not.

enum (true, false)

"true"

Query

pageSize
optional

The number of results returned per page.

string

"10"

Query

sort
optional

The sorting method applied to the return results.

string

Responses

HTTP Code

Description

Schema

200

siteMessageSearchResult

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.70. Stores

Stores Controller

3.70.1. Get a list of store locations

GET /{baseSiteId}/stores

Description

Lists all store locations that are near the location specified in a query or based on latitude and longitude.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

accuracy
optional

Accuracy in meters.

number(double)

"0.0"

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

latitude
optional

Coordinate that specifies the north-south position of a point on the Earth’s surface.

number(double)

Query

longitude
optional

Coordinate that specifies the east-west position of a point on the Earth’s surface.

number(double)

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

query
optional

Location in natural language i.e. city or country.

string

Query

radius
optional

Radius in meters. Max value: 40075000.0 (Earth’s perimeter).

number(double)

"100000.0"

Query

sort
optional

Sorting method applied to the return results.

string

"asc"

Responses

HTTP Code

Description

Schema

200

StoreFinderSearchPage

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.70.2. Get a header with the number of store locations.

HEAD /{baseSiteId}/stores

Description

In the response header, the "x-total-count" indicates the number of all store locations that are near the location specified in a query, or based on latitude and longitude.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

accuracy
optional

Accuracy in meters.

number(double)

"0.0"

Query

latitude
optional

Coordinate that specifies the north-south position of a point on the Earth’s surface.

number(double)

Query

longitude
optional

Coordinate that specifies the east-west position of a point on the Earth’s surface.

number(double)

Query

query
optional

Location in natural language i.e. city or country.

string

Query

radius
optional

Radius in meters. Max value: 40075000.0 (Earth’s perimeter).

number(double)

"100000.0"

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.70.3. Get a list of store locations for a given country

GET /{baseSiteId}/stores/country/{countryIso}

Description

Lists all store locations that are in the specified country.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

countryIso
required

Country ISO code

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

PointOfServiceList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.70.4. Get a list of store locations for a given country and region

GET /{baseSiteId}/stores/country/{countryIso}/region/{regionIso}

Description

Lists all store locations that are in the specified country and region.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

countryIso
required

Country ISO code

string

Path

regionIso
required

Region ISO code

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

PointOfServiceList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.70.5. Gets a store location count per country and regions

GET /{baseSiteId}/stores/storescounts

Description

Returns store counts in countries and regions

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Responses

HTTP Code

Description

Schema

200

StoreCountList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.70.6. Get a store location

GET /{baseSiteId}/stores/{storeId}

Description

Returns store location based on its unique name.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

storeId
required

Store identifier (currently store name)

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.71. Users

Users Controller

3.71.1. Registers a customer

POST /{baseSiteId}/users

Description

Registers a customer. Requires the following parameters: login, password, firstName, lastName, titleCode.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

user
required

User’s object.

UserSignUp

Responses

HTTP Code

Description

Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.71.2. Get customer profile

GET /{baseSiteId}/users/{userId}

Description

Returns customer profile.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.71.3. Updates customer profile

PUT /{baseSiteId}/users/{userId}

Description

Updates customer profile. Attributes not provided in the request body will be defined again (set to null or default).

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

user
required

User’s object

Responses

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.71.4. Delete customer profile.

DELETE /{baseSiteId}/users/{userId}

Description

Removes customer profile.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Security

Type

Name

oauth2

oauth2

3.71.5. Updates customer profile

PATCH /{baseSiteId}/users/{userId}

Description

Updates customer profile. Only attributes provided in the request body will be changed.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

user
required

User’s object.

Responses

HTTP Code

Description

Schema

200

No Content

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

application/xml
application/json

Security

Type

Name

oauth2

oauth2

3.71.6. Get all customer groups of a customer.

GET /{baseSiteId}/users/{userId}/customergroups

Description

Returns all customer groups of a customer.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Responses

HTTP Code

Description

Schema

200

UserGroupList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

3.71.7. Changes customer’s login name.

PUT /{baseSiteId}/users/{userId}/login

Description

Changes a customer’s login name. Requires the customer’s current password.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

newLogin
required

Customer’s new login name. Customer login is case insensitive.

string

Query

password
required

Customer’s current password.

string

Responses

HTTP Code

Description

Schema

200

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.71.8. Changes customer’s password

PUT /{baseSiteId}/users/{userId}/password

Description

Changes customer’s password.

Parameters

Type

Name

Description

Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

new
required

New password.

string

Query

old
optional

Old password. Required only for ROLE_CUSTOMERGROUP

string

Responses

HTTP Code

Description

Schema

201

Created

No Content

202

Accepted

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

application/json

Security

Type

Name

oauth2

oauth2

3.72. Vouchers

Vouchers Controller

3.72.1. Get a voucher based on code.

GET /{baseSiteId}/vouchers/{code}

Description

Returns details of a single voucher that is specified by its voucher identification code.

Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

code
required

Voucher identifier (code)

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"BASIC"

Responses

HTTP Code

Description

Schema

200

Voucher

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Security

Type

Name

oauth2

oauth2

4. Definitions

4.1. Address

Request body fields required and optional to operate on address data. The DTO is in XML or .json format

Name

Description

Schema

cellphone
optional

Cellphone number

string

companyName
optional

Company Name

string

country
optional

Country where address is located

Country

defaultAddress
optional

Boolean flag if address is default

boolean

district
optional

District name

string

email
optional

Email address

string

firstName
required

First name of the address person

string

formattedAddress
optional

Boolean flag if address is formatted

string

id
optional

Unique id value of the address which is optional while creating new address. While performing other address operations this value is the key

string

lastName
required

Last name of the address person

string

line1
required

First line of the address

string

line2
optional

Second line of the address

string

phone
optional

Phone number

string

postalCode
required

Postal code of the address

string

region
optional

Region where address belongs to

Region

shippingAddress
optional

Boolean flag if address is for shipping

boolean

title
optional

Title of the address person

string

titleCode
required

Code of the title

string

town
required

Town, field required

string

visibleInAddressBook
optional

Boolean flag if address is visible in the Address Book

boolean

4.2. AddressList

Representation of an Address list

Name

Description

Schema

addresses
optional

List of addresses

< Address > array

4.3. AddressValidation

Representation of an Address Validation

Name

Description

Schema

decision
optional

Decision

string

errors
optional

List of errors

errorList

suggestedAddresses
optional

List of suggested addresses

< Address > array

4.4. Agent

Name

Schema

categories
optional

< Category > array

displayName
optional

string

email
optional

string

externalId
optional

string

firstName
optional

string

lastName
optional

string

participationStatus
optional

boolean

pointsOfService
optional

< PointOfService > array

thumbnail
optional

4.5. AgentList

Agent list with pagination

Name

Description

Schema

agents
optional

< Agent > array

pagination
optional

pagination information

sorts
optional

sorting information

< sort > array

4.6. AllowedFSRequestType

Name

Schema

code
optional

string

requestType
optional

FSRequestType

4.7. B2BApprovalProcess

Representation of an organizational approval process

Name Description Schema

code
required

Code of the Organizational Approval Process
Example : "accApproval"

string

name
optional

Name of the Organizational Approval Process
Example : "Escalation Approval with Merchant Check"

string

4.8. B2BApprovalProcessList

Representation of an organizational approval process list

Name

Description

Schema

approvalProcesses
required

List of Organizational Approval Process

< B2BApprovalProcess > array

4.9. B2BCostCenter

Representation of a cost center. This bean may have relationships to other Org Unit WsDTO, whose type are WsDTO beans as well.

Name Description Schema

active
optional

Indication of whether the cost center is active. Deprecated since 2005. Read-only, used for display purposes.
Example : "true"

string

activeFlag
optional

Boolean flag of whether the cost center is active.
Example : true

boolean

assignedBudgets
optional

Budgets assigned to this cost center

< BudgetShallow > array

code
optional

The code of the cost center
Example : "Custom_Retail"

string

currency
optional

The currency of the cost center

name
optional

The name of the cost center
Example : "Custom Retail"

string

originalCode
optional

The original code of the cost center. Deprecated since 2005.
Example : "Custom_Retail"

string

unit
optional

The parent unit of the cost center

4.10. B2BCostCenterList

Representation of a cost center list

Name

Description

Schema

costCenters
optional

List of cost centers

< B2BCostCenter > array

pagination
optional

Pagination items

sorts
optional

List of sorts

< Sort > array

4.11. B2BCostCenterShallow

Representation of a cost center. This bean is shallow, which means its potential relationship fields to other Org Unit fields are simple ids. No Org Unit WsDTO fields should be declared in this bean to avoid circular references.

Name Description Schema

active
optional

Indication of whether the cost center is active. Deprecated since 2005. Read-only, used for display purposes.
Example : "true"

string

activeFlag
optional

Boolean flag of whether the cost center is active.
Example : true

boolean

code
optional

The code of the cost center
Example : "Custom_Retail"

string

currency
optional

The currency of the cost center

name
optional

The name of the cost center
Example : "Custom Retail"

string

originalCode
optional

The original code of the cost center. Deprecated since 2005.
Example : "Custom_Retail"

string

4.12. B2BPaymentType

Name

Schema

code
optional

string

displayName
optional

string

4.13. B2BPaymentTypeData

Name

Schema

code
optional

string

displayName
optional

string

4.14. B2BPaymentTypeList

Name

Schema

paymentTypes
optional

< B2BPaymentType > array

4.15. B2BSelectionData

Representation of object selection data

Name Description Schema

active
optional

If this object is active
Example : false

boolean

displayRoles
optional

display roles

< string > array

id
optional

The ID of the selected object
Example : "Retail_2K"

string

normalizedCode
optional

The normalized code

string

roles
optional

roles

< string > array

selected
optional

If the this object was selected
Example : true

boolean

4.16. B2BUnit

Representation of an organizational unit

Name Description Schema

active
optional

Boolean flag of whether Organizational Unit is active
Example : true

boolean

addresses
optional

Addresses of the organizational unit node

< Address > array

administrators
optional

Administrators of the organizational unit node

< User > array

approvalProcess
optional

Approval Process of the organizational unit node

B2BApprovalProcess

approvers
optional

Approvers of the organizational unit node

< User > array

costCenters
optional

The cost centers of the organizational unit node

< B2BCostCenterShallow > array

customers
optional

Customers of the organizational unit node

< User > array

managers
optional

Managers of the organizational unit node

< User > array

name
optional

Name of the organizational unit
Example : "Pronto"

string

parentOrgUnit
optional

Parent unit of the organizational unit

uid
required

Identifier of the organizational unit
Example : "Pronto"

string

4.17. B2BUnitNode

Representation of an organizational unit node

Name Description Schema

active
optional

Boolean flag of whether organizational unit represented by the node is active
Example : true

boolean

children
optional

Child nodes of the organizational unit node

< B2BUnitNode > array

id
required

Identifier of the organizational unit represented by the node
Example : "Pronto_Retail"

string

name
optional

Name of the organizational unit represented by the node
Example : "Pronto Retail"

string

parent
optional

Unique identifier of organizational unit node’s parent unit
Example : "Pronto"

string

4.18. B2BUnitNodeList

Representation of an organizational unit node list

Name

Description

Schema

unitNodes
required

List of Unit Nodes

< B2BUnitNode > array

4.19. BaseOption

Representation of a Base Option

Name

Description

Schema

options
optional

List of all variant options

< VariantOption > array

selected
optional

Variant option selected

VariantOption

variantType
optional

Variant type of base option

string

4.20. BaseSite

Representation of a Base Site

Name Description Schema

channel
optional

Channel

string

defaultLanguage
optional

Default language for Basesite

Language

defaultPreviewCatalogId
optional

Default preview catalog id

string

defaultPreviewCategoryCode
optional

Default preview category code

string

defaultPreviewProductCode
optional

Default preview product code

string

locale
optional

Locale data for Basesite

string

name
optional

Name of Basesite

string

registrationEnabled
optional

Indicates if the website supports registration
Example : true

boolean

requiresAuthentication
optional

Indicates if the BaseSite requires authentication prior to use it
Example : true

boolean

stores
optional

List of Basestores

< BaseStore > array

theme
optional

Theme of Basesite

string

uid
optional

Unique identifier of Basesite

string

urlEncodingAttributes
optional

List of url encoding attributes

< string > array

urlPatterns
optional

List of url patterns

< string > array

4.21. BaseSiteList

Representation of a Base Site List

Name

Description

Schema

baseSites
optional

List of basesites

< BaseSite > array

4.22. BaseStore

Representation of a Base Store

Name

Description

Schema

createReturnProcessCode
optional

Create return process code

string

currencies
optional

List of currencies

< Currency > array

defaultCurrency
optional

Default currency

defaultDeliveryOrigin
optional

Point of service being default delivery origin

defaultLanguage
optional

Default language

Language

deliveryCountries
optional

List of delivery countries

< Country > array

deliveryModes
optional

List of delivery modes

DeliveryModeList

expressCheckoutEnabled
optional

Flag specifying whether the express checkout option is enabled

boolean

externalTaxEnabled
optional

Flag defining is external tax is enabled

boolean

languages
optional

List of languages

< Language > array

maxRadiusForPosSearch
optional

Maximum radius for searching point of service

number(double)

name
optional

Base store name

string

paymentProvider
optional

Payment provider

string

pointsOfService
optional

List of points of service

< PointOfService > array

submitOrderProcessCode
optional

Submit order process code

string

4.23. BasicnotificationPreference

Basic notification preference

Name Description Schema

channel
optional

preference channel
Example : "email, sms, site_message"

string

enabled
optional

if true, the channel is on; if false, the channel is off

boolean

4.24. BasicnotificationPreferenceList

Basic notification preference list

Name

Description

Schema

preferences
optional

Basic notification preferences

< BasicnotificationPreference > array

4.25. BillingCycleType

Name

Schema

code
optional

string

name
optional

string

4.26. BillingPlan

Name

Schema

billingCycleDay
optional

integer(int32)

billingCycleTypeData
optional

BillingCycleType

billingTimeData
optional

BillingTime

id
optional

string

name
optional

string

4.27. BillingTime

Name

Schema

code
optional

string

description
optional

string

helpContent
optional

string

name
optional

string

nameInOrder
optional

string

orderNumber
optional

integer(int32)

4.28. BillingTimeList

Name

Schema

billingTimes
optional

< BillingTime > array

4.29. Breadcrumb

Representation of a Breadcrumb

Name

Description

Schema

facetCode
optional

Code of the facet

string

facetName
optional

Name of the facet

string

facetValueCode
optional

Value code of the facet

string

facetValueName
optional

Value name of the facet

string

removeQuery
optional

Remove query

truncateQuery
optional

Truncate query

4.30. Budget

Request body fields required and optional to operate on Budget data. This bean may have relationships to other Org Unit WsDTO, whose type are WsDTO beans as well.

Name Description Schema

active
optional

Boolean flag of whether the Budget is active

boolean

budget
optional

Value of Budget
Example : 50000.0

number

code
optional

Code of the Budget
Example : "Monthly_50K_USD"

string

costCenters
optional

List of Cost Centers

< B2BCostCenter > array

currency
optional

Currency of the Budget

endDate
optional

The end date of the Budget
Example : "2020-12-31T09:00:00+0000"

string(date-time)

name
optional

The name of the Budget
Example : "Monthly 50K USD"

string

orgUnit
optional

The unit of the Budget

selected
optional

Boolean flag whether the budget is selected for a cost center
Example : true

boolean

startDate
optional

The start date of the Budget
Example : "2020-11-31T09:00:00+0000"

string(date-time)

4.31. BudgetList

Representation of a Budget List

Name

Description

Schema

budgets
optional

List of Budgets

< Budget > array

pagination
optional

Pagination items

sorts
optional

List of sorts

< Sort > array

4.32. BudgetShallow

Request body fields required and optional to operate on Budget data. This bean is shallow, which means its potential relationship fields to other Org Unit fields are simple ids. No Org Unit WsDTO should be declared in this bean to avoid circular references.

Name Description Schema

active
optional

Boolean flag of whether the Budget is active

boolean

budget
optional

Value of Budget
Example : 50000.0

number

code
optional

Code of the Budget
Example : "Monthly_50K_USD"

string

currency
optional

Currency of the Budget

endDate
optional

The end date of the Budget
Example : "2020-12-31T09:00:00+0000"

string(date-time)

name
optional

The name of the Budget
Example : "Monthly 50K USD"

string

selected
optional

Boolean flag whether the budget is selected for a cost center
Example : true

boolean

startDate
optional

The start date of the Budget
Example : "2020-11-31T09:00:00+0000"

string(date-time)

4.33. BundleTemplate

Name

Schema

childBundleTemplates
optional

< BundleTemplate > array

id
optional

string

name
optional

string

products
optional

< Product > array

rootBundleTemplateName
optional

string

type
optional

string

version
optional

string

4.34. CancellationRequestEntryInput

Representation of a cancellation request entry input for an order

Name Description Schema

orderEntryNumber
required

Order entry number of the cancelled product
Example : 1

integer(int32)

quantity
required

Quantity of the product which belongs to the order entry and is requested to be cancelled
Example : 5

integer(int64)

4.35. CancellationRequestEntryInputList

Representation of a cancellation request entry input list for an order

Name

Description

Schema

cancellationRequestEntryInputs
required

Cancellation request entry inputs which contain information about the order entries which are requested to be cancelled

< CancellationRequestEntryInput > array

4.36. CardType

Representation of a Card Type

Name

Description

Schema

code
optional

Card type code

string

name
optional

Card type name

string

4.37. CardTypeList

Representation of a Card Type List

Name

Description

Schema

cardTypes
optional

List of card types

< CardType > array

4.38. Cart

Representation of a Cart

Name

Description

Schema

appliedOrderPromotions
optional

List of applied order promotions

< PromotionResult > array

appliedProductPromotions
optional

List of applied product promotions

< PromotionResult > array

appliedVouchers
optional

List of applied vouchers

< Voucher > array

calculated
optional

Flag showing if order is calculated

boolean

code
optional

Code number of order

string

costCenter
optional

deliveryAddress
optional

Delivery address

deliveryCost
optional

Delivery cost

deliveryItemsQuantity
optional

Quantity of delivery items

integer(int64)

deliveryMode
optional

Delivery mode information

deliveryOrderGroups
optional

List of delivery order entries group

< DeliveryOrderEntryGroup > array

description
optional

Description of the cart

string

entries
optional

List of order entries

< OrderEntry > array

entryGroups
optional

List of entry groups

< EntryGroup > array

expirationTime
optional

Date of cart expiration time

string(date-time)

guid
optional

Guest user id identifier

string

insuranceQuote
optional

name
optional

Name of the cart

string

net
optional

Flag stating iv value is net-value

boolean

orderDiscounts
optional

Order discounts

paymentInfo
optional

Payment information

paymentType
optional

B2BPaymentTypeData

pickupItemsQuantity
optional

Quantity of pickup items

integer(int64)

pickupOrderGroups
optional

List of pickup order entry group

< PickupOrderEntryGroup > array

potentialOrderPromotions
optional

List of potential order promotions for cart

< PromotionResult > array

potentialProductPromotions
optional

List of potential product promotions for cart

< PromotionResult > array

productDiscounts
optional

Product discounts

purchaseOrderNumber
optional

string

saveTime
optional

Date of saving cart

string(date-time)

savedBy
optional

Information about person who saved cart

site
optional

Site

string

store
optional

Store

string

subTotal
optional

Subtotal price

totalDiscounts
optional

Total discounts

totalItems
optional

integer(int32)

totalPrice
optional

Total price value

totalPriceWithTax
optional

Total price with tax

totalTax
optional

Total tax price

totalUnitCount
optional

Total unit count

integer(int32)

user
optional

User information

4.39. CartList

Representation of a Cart list

Name

Description

Schema

carts
optional

List of carts

< Cart > array

4.40. CartModification

Representation of a Cart modification

Name

Description

Schema

cartCode
optional

string

deliveryModeChanged
optional

Delivery mode changed

boolean

entry
optional

Order entry

guid
optional

string

quantity
optional

Final quantity after cart modification

integer(int64)

quantityAdded
optional

Quantity added with cart modification

integer(int64)

statusCode
optional

Status code of cart modification

string

statusMessage
optional

Status message

string

4.41. CartModificationList

Representation of a Cart modification list

Name

Description

Schema

cartModifications
optional

List of cart modifications

< CartModification > array

4.42. Catalog

Representation of an Catalog

Name

Description

Schema

catalogVersions
optional

List of versions of catalog

< CatalogVersion > array

id
optional

Identifier of abstract catalog item

string

lastModified
optional

Date of last modification

string(date-time)

name
optional

Name of abstract catalog item

string

url
optional

Url address of abstract catalog item

string

4.43. CatalogList

Representation of a Catalog List

Name

Description

Schema

catalogs
optional

List of catalog items

< Catalog > array

4.44. CatalogVersion

Representation of a Catalog Version

Name

Description

Schema

categories
optional

List of category hierarchies

< CategoryHierarchy > array

id
optional

Identifier of abstract catalog item

string

lastModified
optional

Date of last modification

string(date-time)

name
optional

Name of abstract catalog item

string

url
optional

Url address of abstract catalog item

string

4.45. Category

Representation of a Category

Name

Description

Schema

allowedFSRequestTypes
optional

< AllowedFSRequestType > array

code
optional

Code of the category

string

image
optional

Category image

name
optional

Name of the category

string

parentCategory
optional

url
optional

URL of the category

string

yformConfiguratorSettings
optional

< FSYFormConfiguratorSettings > array

4.46. CategoryHierarchy

Representation of a Category Hierarchy

Name

Description

Schema

id
optional

Identifier of abstract catalog item

string

lastModified
optional

Date of last modification

string(date-time)

name
optional

Name of abstract catalog item

string

products
optional

< Product > array

subcategories
optional

List of subcategory hierarchies

< CategoryHierarchy > array

url
optional

Url address of abstract catalog item

string

4.47. Classification

Representation of a Classification

Name

Description

Schema

code
optional

Code of the classification

string

features
optional

List of features for given classification

< Feature > array

name
optional

Name of the classification

string

4.48. Comment

Object of the comment, which can be added to any Item in the commerce suite.

Name Description Schema

author
optional

Author of the comment.

creationDate
required

Date when the comment was created.
Example : "yyyy-MM-dd HH:mm:ss+0000"

string(date-time)

fromCustomer
required

Flag showing if the current customer was the author of the comment.
Example : true

boolean

text
required

Text of the comment.
Example : "Text of the comment"

string

4.49. ComponentAdaptedData

Type : object

4.50. ComponentIDList

Name

Schema

idList
optional

< string > array

4.51. ConfigurationInfo

Representation of a Configuration Info

Name

Description

Schema

configurationLabel
optional

Label of configuration info

string

configurationValue
optional

Value of configuration info

string

configurationValues
optional

Map of configuration values

< string, string > map

configuratorType
optional

Type of configuration info

string

status
optional

Status of configuration info

string

4.52. Consent

Representation of a Consent

Name

Description

Schema

code
optional

Code of consent

string

consentGivenDate
optional

Date of consenting

string(date-time)

consentWithdrawnDate
optional

Consent withdrawn date

string(date-time)

4.53. ConsentTemplate

Representation of a Consent Template

Name

Description

Schema

currentConsent
optional

Current consent

Consent

description
optional

Consent template description

string

exposed
optional

boolean

id
optional

Consent template identifier

string

name
optional

Consent template name

string

version
optional

Consent template version

integer(int32)

4.54. ConsentTemplateList

Representation of a Consent Template List

Name

Description

Schema

consentTemplates
optional

List of consent templates

< ConsentTemplate > array

4.55. Consignment

Representation of a Consignment

Name

Description

Schema

code
optional

Consignment code

string

deliveryPointOfService
optional

Delivery point of service

entries
optional

List of consignment entries

< ConsignmentEntry > array

shippingAddress
optional

Shipping address

status
optional

Consignment status

string

statusDate
optional

Consignment status date

string(date-time)

statusDisplay
optional

Consignment status display

string

trackingID
optional

Consignment tracking identifier

string

4.56. ConsignmentEntry

Representation of a Consignment Entry

Name

Description

Schema

orderEntry
optional

Order entry of Consignment entry

quantity
optional

Quantity value of Consignment entry

integer(int64)

shippedQuantity
optional

Shipped quantity

integer(int64)

4.57. Country

Response body fields which will be returned while fetching the list of countries. The DTO is in XML or .json format

Name

Description

Schema

isocode
optional

Country code in iso format

string

name
optional

Name of the country

string

4.58. CountryList

List of countries

Name

Description

Schema

countries
optional

This is the list of Country fields that should be returned in the response body

< Country > array

4.59. CreateComment

Object of the comment, which can be used to add a comment.

Name Description Schema

text
required

Text of the comment.
Example : "Text of the comment"

string

4.60. Currency

Representation of a Currency

Name

Description

Schema

active
optional

Boolean flag whether currency is active

boolean

isocode
optional

Code of the currency in iso format

string

name
optional

Name of the currency

string

symbol
optional

Symbol of the currency

string

4.61. CurrencyList

Representation of a Currency List

Name

Description

Schema

currencies
optional

List of currencies

< Currency > array

4.62. CustomerCoupon

Customer coupon

Name Description Schema

allProductsApplicable
optional

Indicates whether the coupon is applicable for all products

boolean

couponId
optional

Coupon identifier

string

description
optional

Description of the coupon

string

endDate
optional

End date of the coupon

string(date-time)

name
optional

Name of the coupon

string

notificationOn
optional

Indicates if notification is enabled or disabled

boolean

startDate
optional

Start date of the coupon

string(date-time)

status
optional

Status of the coupon
Example : "Effective"

string

4.63. CustomerCoupon2Customer

Customer coupon for customer

Name

Description

Schema

coupon
optional

Customer coupon

CustomerCoupon

customer
optional

Customer

4.64. CustomerCouponNotification

Customer coupon notification

Name Description Schema

coupon
optional

Customer coupon

CustomerCoupon

customer
optional

Customer

status
optional

Notification status
Example : "EFFECTIVESENT"

string

4.65. CustomerCouponSearchResult

Customer coupon search result

Name

Description

Schema

coupons
optional

List of coupon

< CustomerCoupon > array

pagination
optional

Pagination information

sorts
optional

Sorting information

< sort > array

4.66. DeliveryMode

Representation of a Delivery mode

Name

Description

Schema

code
optional

Code of the delivery mode

string

deliveryCost
optional

Cost of the delivery

description
optional

Description of the delivery mode

string

name
optional

Name of the delivery mode

string

4.67. DeliveryModeList

Representation of a Delivery mode list

Name

Description

Schema

deliveryModes
optional

List of delivery modes

< DeliveryMode > array

4.68. DeliveryOrderEntryGroup

Representation of a Delivery Order Entry Group

Name

Description

Schema

deliveryAddress
optional

Delivery address for order entry group

entries
optional

List of order entries

< OrderEntry > array

quantity
optional

Quantity of order entries in a group

integer(int64)

totalPriceWithTax
optional

Total price with tax

4.69. DynamicAttributeObject

Name

Schema

formattedValue
optional

string

4.70. Employee

Name

Schema

contactInfos
optional

< PhoneContactInfo > array

displayName
optional

string

email
optional

string

4.71. EntryGroup

Representation of an Entry Group

Name Description Schema

entries
optional

List of order entries

< OrderEntry > array

entryGroupNumber
optional

Identifier of the entry group
Example : 1

integer(int32)

entryGroups
optional

List of child entry groups

< EntryGroup > array

erroneous
optional

Indicates if the entry group is in an error state
Example : true

boolean

label
optional

Label for the entry group
Example : "Photo On The Go Package"

string

type
optional

Indicates type of the group, possible values are STANDALONE, CONFIGURABLEBUNDLE or any customer implemented type for any new provider
Example : "STANDALONE"

string

4.72. FSAction

Generic action used for different business processes

Name Description Schema

actionName
optional

Action name
Example : "BIND, SUBMIT, CANCEL"

string

body
optional

Body content with price attributes for action

FSProductPriceAttributes

4.73. FSAppointment

Name

Schema

assignedAgent
optional

Agent

code
optional

string

consentGiven
optional

boolean

customer
optional

date
optional

string

description
optional

string

status
optional

string

subject
optional

string

4.74. FSChangeRequest

Change Request created by user

Name Description Schema

changedPolicy
optional

Changed Insurance Policy

configurationSteps
optional

List of configuration steps for user request

< FSStepData > array

effectiveDate
optional

Effective date

string(date-time)

fsStepGroupDefinition
optional

Definition of step group associated to request

FSStepGroupDefinition

insurancePolicy
optional

Original Insurance Policy

requestId
optional

User request Id
Example : "000001"

string

requestStatus
optional

User request status
Example : "SUBMITTED"

string

4.75. FSClaimParticipant

Name

Schema

address
optional

string

name
optional

string

phoneNumber
optional

string

roles
optional

< string > array

4.76. FSCustomerSearchPage

Name

Schema

entries
optional

< User > array

pagination
optional

sorts
optional

< sort > array

4.77. FSDocument

Representation of Document

Name Description Schema

altText
optional

Alternative text of document
Example : "Sample image text."

string

claim
optional

Claim to which document is associated

code
optional

Document code
Example : "document1"

string

createdByExternalSystem
optional

Indicates if document is uploaded by customer on storefront or it is imported from external system.

boolean

creationTime
optional

Document creation time

string(date-time)

documentBundleId
optional

Document bundle identification code
Example : "documentBundle1"

string

documentType
optional

Type of document
Example : "pdf,text,xml"

string

downloadUrl
optional

Document url address

string

insurancePolicy
optional

Insurance policy to which document is associated

itemTimestamp
optional

Document timestamp

string(date-time)

mime
optional

Label used to identify a type of document data
Example : "image/png"

string

name
optional

Name of the document
Example : "Sample image name."

string

size
optional

The size of the document in bytes
Example : 25643545

integer(int64)

4.78. FSDocumentList

List of documents

Name

Description

Schema

documents
optional

List of documents

< FSDocument > array

4.79. FSIncidentType

Name

Schema

icon
optional

incidentCode
optional

string

incidentName
optional

string

4.80. FSIncidentTypeList

List of incident types used in FNOL process

Name

Description

Schema

incidentTypes
optional

Incident type list

< FSIncidentType > array

4.81. FSInvestmentInfo

Name

Schema

distributionPercentage
optional

number(double)

investmentType
optional

FSInvestmentType

4.82. FSInvestmentType

Name

Schema

factSheetDocument
optional

MediaData

fiveYearPerformance
optional

number(double)

fundName
optional

string

isin
optional

string

riskReturningRating
optional

string

4.83. FSLocationOfLoss

Name

Schema

additionalDetails
optional

string

address
optional

string

city
optional

string

code
optional

string

countryCode
optional

string

postcode
optional

string

4.84. FSOBOConsentList

Name

Schema

oboConsents
optional

< Consent > array

4.85. FSOBOCustomerCreation

Name

Schema

dateOfBirth
optional

string

email
optional

string

firstName
optional

string

lastName
optional

string

titleCode
optional

string

4.86. FSOBOPermissionConfiguration

Name

Schema

permissions
optional

< string, boolean > map

4.87. FSPaymentTransactionEntry

Name

Schema

amount
optional

number

currencyIsocode
optional

string

payee
optional

string

paymentMethod
optional

string

time
optional

string

4.88. FSPriceAttribute

Key/value attribute relevant for pricing

Name Description Schema

key
optional

Price attribute key
Example : "tripDestination"

string

value
optional

Price attribute value
Example : "Europe"

string

4.89. FSPriceAttributeGroup

Price attributes for one group

Name Description Schema

name
optional

Price attribute group name
Example : "trip"

string

priceAttributes
optional

List of price attributes

< FSPriceAttribute > array

4.90. FSProductAssignment

FS Product Assignment shows which product is assigned for particular unit.

Name

Description

Schema

active
optional

Indicates if product assignment is active.

boolean

code
optional

Unique identifier for single product assignment.

string

product
optional

4.91. FSProductAssignmentList

FS Product Assignment list with pagination

Name

Description

Schema

assignments
optional

< FSProductAssignment > array

pagination
optional

pagination information

sorts
optional

sorting information

< sort > array

4.92. FSProductPriceAttributes

Input data for getting product prices

Name

Description

Schema

priceAttributeGroups
optional

List of grouped price attributes

< FSPriceAttributeGroup > array

4.93. FSRequestType

Name

Schema

code
optional

string

4.94. FSSalesIllustrationDiagramEntry

Name

Schema

contribution
optional

number(double)

date
optional

string(date-time)

expectedSavingAmount
optional

number(double)

4.95. FSStepContent

Content of request step

Name Description Schema

contentData
optional

Step content data

< string, string > map

title
optional

Step content title
Example : "Summary Step"

string

4.96. FSStepData

Data for user request step

Name Description Schema

configuratorType
optional

Configurator type of step
Example : "YFORM"

string

name
optional

Step name
Example : "Summary Step"

string

pageLabelOrId
optional

Label or Id of CMS page associated with step
Example : "reviewPage"

string

sequenceNumber
optional

Sequence number
Example : 1

integer(int32)

status
optional

Step status
Example : "OPEN"

string

stepContent
optional

FSStepContent

summaryStep
optional

Indicates if particular step is summary
Example : true

boolean

yformConfigurator
optional

Id for yForm configurator

4.97. FSStepGroupDefinition

Group definition for user request step

Name Description Schema

category
optional

Category associate with step group definition

code
optional

Step group definition code
Example : "checkoutGroup"

string

confirmationUrl
optional

URL for confirmation page of request process

string

requestType
optional

Request type for step group

FSRequestType

title
optional

Title of step group definition
Example : "Checkout group"

string

4.98. FSTicket

Name

Schema

message
optional

string

primaryContactEmail
optional

string

primaryContactPhoneNumber
optional

string

subject
optional

string

supportedResponseType
optional

string

ticketCategory
optional

string

4.99. FSUserRequest

Request created by user

Name Description Schema

causeOfLoss
optional

string

claimHandler
optional

Employee

claimNumber
optional

string

claimParticipants
optional

< FSClaimParticipant > array

claimStatus
optional

string

configurationSteps
optional

List of configuration steps for user request

< FSStepData > array

dateOfLoss
optional

string

documents
optional

< FSDocument > array

fsStepGroupDefinition
optional

Definition of step group associated to request

FSStepGroupDefinition

incidentType
optional

FSIncidentType

insurancePolicy
optional

locationOfLoss
optional

FSLocationOfLoss

properties
optional

< string, string > map

requestId
optional

User request Id
Example : "000001"

string

requestStatus
optional

User request status
Example : "SUBMITTED"

string

subclaims
optional

< FsSubclaim > array

timeOfLoss
optional

string

4.100. FSValueList

List of values

Name

Description

Schema

values
optional

List of item values

< FSValueListItem > array

4.101. FSValueListItem

Item of list

Name Description Schema

key
optional

Item key
Example : "Gender"

string

value
optional

Item value
Example : "Female"

string

4.102. FSYFormConfiguratorSettings

Name

Schema

configurationApplicationId
optional

string

configurationFormId
optional

string

configuratorType
optional

string

4.103. Facet

Representation of a Facet

Name

Description

Schema

category
optional

Flag stating if facet is category facet

boolean

multiSelect
optional

Flag stating if facet is multiSelect

boolean

name
optional

Name of the facet

string

priority
optional

Priority value of the facet

integer(int32)

topValues
optional

List of top facet values

< FacetValue > array

values
optional

List of all facet values

< FacetValue > array

visible
optional

Flag stating if facet is visible

boolean

4.104. FacetValue

Representation of a Facet Value

Name

Description

Schema

count
optional

Count of the facet value

integer(int64)

name
optional

Name of the facet value

string

query
optional

Query of the facet value

selected
optional

Flag stating if facet value is selected

boolean

4.105. Feature

Representation of a Feature

Name

Description

Schema

code
optional

Code of the feature

string

comparable
optional

Flag defining it feature is comparable

boolean

description
optional

Description of the feature

string

featureUnit
optional

Feature unit

FeatureUnit

featureValues
optional

List of feature values

< FeatureValue > array

name
optional

Name of the feature

string

range
optional

Range number of the feature

boolean

type
optional

Type of the feature

string

4.106. FeatureUnit

Representation of a Feature Unit

Name

Description

Schema

name
optional

Name of the feature unit

string

symbol
optional

Symbol of the feature unit

string

unitType
optional

Type of the feature unit

string

4.107. FeatureValue

Representation of a Feature Value

Name

Description

Schema

value
optional

Value of the feature

string

4.108. FsClaimList

Name

Schema

claims
optional

< FSUserRequest > array

4.109. FsSubclaim

Name

Schema

claimant
optional

string

paymentTransactions
optional

< FSPaymentTransactionEntry > array

status
optional

string

subclaimNumber
optional

string

type
optional

string

4.110. FulfilmentType

Name

Schema

code
optional

string

4.111. FutureStock

Representation of a Future Stock

Name Description Schema

date
optional

Date of future stock
Example : "2056-12-31T09:00:00+0000"

string(date-time)

formattedDate
optional

Date of future stock expressed in text value
Example : "31/12/2056"

string

stock
optional

Stock information of future stock

4.112. GeoPoint

Representation of a GeoPoint

Name

Description

Schema

latitude
optional

Geopoint latitude

number(double)

longitude
optional

Geopoint longitude

number(double)

4.113. Image

Representation of an Image

Name

Description

Schema

altText
optional

Tooltip content which is visible while image mouse hovering

string

format
optional

Format of the image, can be zoom, product, thumbnail, store, cartIcon, etc.

string

galleryIndex
optional

Index of the image while displayed in gallery

integer(int32)

imageType
optional

Type of the image, can be PRIMARY or GALLERY

enum (PRIMARY, GALLERY)

url
optional

URL address of the image

string

4.114. InsuranceBenefit

Name

Schema

coverageInformation
optional

string

coverageValue
optional

string

description
optional

string

name
optional

string

4.115. InsuranceCoverage

Name

Schema

benefits
optional

< InsuranceBenefit > array

coverageIsIncluded
optional

boolean

coverageProduct
optional

investmentInfo
optional

< FSInvestmentInfo > array

isMandatory
optional

boolean

4.116. InsurancePolicy

Name

Schema

billingData
optional

< SubscriptionBilling > array

cancellationDate
optional

string(date-time)

cancellationReason
optional

string

categoryData
optional

contractNumber
optional

string

documents
optional

< FSDocument > array

endDate
optional

string(date-time)

expiredPolicyNumber
optional

string

insuredObjectList
optional

InsuredObjectList

mainProduct
optional

InsuranceCoverage

optionalProducts
optional

< InsuranceCoverage > array

orderNumber
optional

string

paymentFrequency
optional

string

paymentMethod
optional

policyNumber
optional

string

policyPremium
optional

policyProduct
optional

policyStatus
optional

string

responsibleAgent
optional

Agent

startDate
optional

string(date-time)

4.117. InsurancePolicyList

Name

Schema

insurancePolicies
optional

< InsurancePolicy > array

4.118. InsuranceQuote

Name

Schema

cartCode
optional

string

configurable
optional

boolean

defaultCategory
optional

expiryDate
optional

string(date-time)

insuredObjectList
optional

InsuredObjectList

isExpired
optional

boolean

isMonthly
optional

boolean

original
optional

boolean

paymentFrequency
optional

string

planName
optional

string

policyId
optional

string

quoteDetails
optional

< string, string > map

quoteId
optional

string

quoteImages
optional

< Image > array

quotePrice
optional

string

quoteStatus
optional

string

quoteTitle
optional

string

quoteType
optional

string

quoteWorkflowStatus
optional

QuoteWorkflowStatus

renewal
optional

boolean

startDate
optional

string(date-time)

state
optional

QuoteBindingState

4.119. InsuranceQuoteList

Name

Schema

insuranceQuotes
optional

< InsuranceQuote > array

4.120. InsuredObject

Name

Schema

childInsuredObjectList
optional

InsuredObjectList

insuredObjectId
optional

string

insuredObjectItems
optional

< InsuredObjectItem > array

insuredObjectType
optional

string

maxNumberOfInsuredObjects
optional

integer(int32)

4.121. InsuredObjectItem

Name

Schema

changeable
optional

boolean

formattedValue
optional

string

key
optional

string

label
optional

string

order
optional

integer(int32)

value
optional

string

4.122. InsuredObjectList

List of insured objects

Name

Description

Schema

insuredObjects
optional

Insured object list

< InsuredObject > array

4.123. Language

Representation of a Language

Name

Description

Schema

active
optional

true/false indicator when the language is active

boolean

isocode
optional

iso code of the language

string

name
optional

name of the language

string

nativeName
optional

name the language in native form

string

4.124. LanguageList

Lists all available languages (all languages used for a particular store). If the list of languages for a base store is empty, a list of all languages available in the system will be returned

Name

Description

Schema

languages
optional

This is the list of Language fields that should be returned in the response body

< Language > array

4.125. ListAdaptedComponents

Name

Schema

component
optional

< ComponentAdaptedData > array

pagination
optional

sorts
optional

< sort > array

4.126. ListAdaptedPages

Name

Schema

page
optional

< PageAdaptedData > array

pagination
optional

sorts
optional

< sort > array

4.127. MediaData

Name

Schema

altText
optional

string

catalogId
optional

string

catalogVersion
optional

string

code
optional

string

description
optional

string

downloadUrl
optional

string

mime
optional

string

url
optional

string

uuid
optional

string

4.128. MemberList

Representation of a Member List

Name

Description

Schema

members
optional

List of member

< Principal > array

4.129. OneTimeChargeEntry

Name

Schema

billingTime
optional

BillingTime

chargeInformation
optional

string

mandatory
optional

boolean

name
optional

string

price
optional

4.130. OpeningSchedule

Representation of an Opening schedule

Name

Description

Schema

code
optional

Code of the opening schedule

string

name
optional

Name of the opening schedule

string

specialDayOpeningList
optional

List of special opening days

< SpecialOpeningDay > array

weekDayOpeningList
optional

List of weekday opening days

< WeekdayOpeningDay > array

4.131. Order

Representation of an Order

Name Description Schema

appliedOrderPromotions
optional

List of applied order promotions

< PromotionResult > array

appliedProductPromotions
optional

List of applied product promotions

< PromotionResult > array

appliedVouchers
optional

List of applied vouchers

< Voucher > array

calculated
optional

Flag showing if order is calculated

boolean

cancellable
optional

Boolean flag showing if order is cancellable
Example : true

boolean

code
optional

Code number of order

string

consignments
optional

List of consignment

< Consignment > array

costCenter
optional

Cost Center associated with the order

created
optional

Date of order creation

string(date-time)

deliveryAddress
optional

Delivery address

deliveryCost
optional

Delivery cost

deliveryItemsQuantity
optional

Quantity of delivery items

integer(int64)

deliveryMode
optional

Delivery mode information

deliveryOrderGroups
optional

List of delivery order entries group

< DeliveryOrderEntryGroup > array

deliveryStatus
optional

Order delivery status

string

deliveryStatusDisplay
optional

Order delivery status display

string

entries
optional

List of order entries

< OrderEntry > array

entryGroups
optional

List of entry groups

< EntryGroup > array

guestCustomer
optional

Flag showing if customer is Guest customer

boolean

guid
optional

Guest user id identifier

string

insuranceQuote
optional

net
optional

Flag stating iv value is net-value

boolean

orderDiscounts
optional

Order discounts

orgCustomer
optional

Customer who placed the order

paymentInfo
optional

Payment information

permissionResults
optional

Results of permissions associated with the order

< OrderApprovalPermissionResult > array

pickupItemsQuantity
optional

Quantity of pickup items

integer(int64)

pickupOrderGroups
optional

List of pickup order entry group

< PickupOrderEntryGroup > array

productDiscounts
optional

Product discounts

purchaseOrderNumber
optional

Purchase order number

string

returnable
optional

Boolean flag showing if order is returnable
Example : true

boolean

site
optional

Site

string

status
optional

Status of order

string

statusDisplay
optional

Status display

string

store
optional

Store

string

subTotal
optional

Subtotal price

totalDiscounts
optional

Total discounts

totalItems
optional

integer(int32)

totalPrice
optional

Total price value

totalPriceWithTax
optional

Total price with tax

totalTax
optional

Total tax price

totalUnitCount
optional

integer(int32)

unconsignedEntries
optional

List of unconsigned order entries

< OrderEntry > array

user
optional

User information

4.132. OrderApproval

Details of one specific order approval

Name Description Schema

approvalDecisionRequired
optional

Boolean flag which states whether an approval decision is required.

boolean

code
required

Code that identifies the approval.
Example : "00000005"

string

customerOrderApprovalRecords
optional

Customer approval records related to this order approval.

< OrderApprovalRecord > array

merchantOrderApprovalRecords
optional

Merchant approval records related to this order approval.

< OrderApprovalRecord > array

order
optional

Order linked to this approval.

trigger
optional

Replenishment trigger if this is an approval for a replenishment order.

Trigger

4.133. OrderApprovalDecision

Decision for an order approval

Name Description Schema

comment
optional

Any comments the approver (or the workflow system) adds when approving/rejecting an order.
Example : "Rejected because montly budget was exceeded"

string

decision
required

Decision from the approver when approving/rejecting an order. Typical decisions are: APPROVE, REJECT
Example : "APPROVE"

string

4.134. OrderApprovalList

Representation of a Order Approval List

Name

Description

Schema

orderApprovals
required

List of Order Approvals

< OrderApproval > array

pagination
required

Pagination items

sorts
required

List of sorts

< Sort > array

4.135. OrderApprovalPermission

Request body fields required and optional to operate on Order Approval Permission data.

Name Description Schema

active
optional

Boolean flag of whether Order Approval Permission is active
Example : true

boolean

code
required

Code of the Order Approval Permission
Example : "Rustic_10K_USD_MONTH"

string

currency
optional

Currency of the Order Approval Permission, used for type B2BOrderThresholdPermission and B2BOrderThresholdTimespanPermission

OrderApprovalPermissionType

orderApprovalPermissionType
optional

Type of the Order Approval Permission

orgUnit
optional

Order Approval Permission’s organizational unit

periodRange
optional

Period range of the Order Approval Permission, used for type B2BOrderThresholdTimespanPermission
Example : "MONTH"

enum (DAY, WEEK, MONTH, QUARTER, YEAR)

selected
optional

Boolean flag of whether the user is selected
Example : true

boolean

threshold
optional

Threshold value of the Order Approval Permission, used for type B2BOrderThresholdPermission and B2BOrderThresholdTimespanPermission
Example : 10000.0

number(double)

4.136. OrderApprovalPermissionList

Representation of a Order Approval Permission List

Name

Description

Schema

orderApprovalPermissions
required

List of Order Approval Permissions

< OrderApprovalPermission > array

pagination
required

Pagination items

OrderApprovalPermissionType

sorts
required

List of sorts

< Sort > array

4.137. OrderApprovalPermissionResult

Details of an order approval permission result related to an order

Name Description Schema

approverName
optional

Name of the approver responsible for this permission result.

string

approverNotes
optional

Any comments the approver added to the approval item.
Example : "The order is rejected due to insufficient budget"

string

permissionType
optional

Permission type related to the permission result.

statusDisplay
optional

Status of the order approval.
Example : "Pending approval"

string

4.138. OrderApprovalPermissionType

Request body fields required and optional to operate on Order Approval Permission Type data. Typical permission types are: B2BBudgetExceededPermission, B2BOrderThresholdTimespanPermission and B2BOrderThresholdPermission

Name Description Schema

code
required

Code of the Order Approval Permission Type
Example : "B2BOrderThresholdTimespanPermission"

string

name
optional

Name of the Order Approval Permission Type
Example : "Allowed Order Threshold (per timespan)"

string

4.139. OrderApprovalPermissionTypeList

Representation of an Order Approval Permission Type list

Name

Description

Schema

orderApprovalPermissionTypes
required

List of Order Approval Permission Types

< OrderApprovalPermissionType > array

4.140. OrderApprovalRecord

Details of one order approval record

Name Description Schema

approver
optional

Principal responsible to this approval record.

comments
optional

Any comments the approver (or the workflow system) added to the approval item.
Example : "Submitted for approval"

string

permissionTypes
optional

List of permission types related to this approval record.

< OrderApprovalPermissionType > array

statusDisplay
optional

Status of the order approval.
Example : "Pending approval"

string

4.141. OrderEntry

Representation of an Order entry

Name Description Schema

addable
optional

boolean

basePrice
optional

Base price of order entry item

cancellableQuantity
optional

Quantity number of cancellable items in order entry
Example : 5

integer(int64)

cancelledItemsPrice
optional

Total price of cancelled items which belong to the order entry item

comments
optional

List of order entry comments.

< Comment > array

configurationInfos
optional

Configuration info of order entry

< ConfigurationInfo > array

deliveryMode
optional

Delivery mode

deliveryPointOfService
optional

Point of service associated with order entry

entryNumber
optional

Entry number of the order entry

integer(int32)

formData
optional

< YFormData > array

product
optional

Product details of order entry

quantity
optional

Quantity number of items in order entry

integer(int64)

removeable
optional

boolean

returnableQuantity
optional

Quantity number of returnable items in order entry
Example : 5

integer(int64)

returnedItemsPrice
optional

Total price of returned items which belong to the order entry item

statusSummaryList
optional

List of aggregated status information per entry, relevant if the entry is configurable and its configuration contains one or many issues in different severities. Note that configurators typically raise such issues only in case the parent document is changeable. In this case the issues (depending on their severity) need to be fixed before a checkout can be done. This means this segment can be present for a cart entry, for order entries it will always be empty

< StatusSummary > array

totalPrice
optional

Total price of order entry item

updateable
optional

Flag defining if order entry item is updateable

boolean

4.142. OrderEntryList

Representation of an Order entry list consumed

Name

Description

Schema

orderEntries
optional

List of order entries

< OrderEntry > array

4.143. OrderHistory

Representation of an Order History

Name

Description

Schema

code
optional

Code of Order History

string

costCenter
optional

Order Cost Center

entries
optional

List of order entries

< OrderEntry > array

guid
optional

Guest user identifier

string

insurancePolicies
optional

List of insurance policies

< InsurancePolicy > array

placed
optional

Date of placing order

string(date-time)

purchaseOrderNumber
optional

Purchase order number

string

status
optional

Status of Order History

string

statusDisplay
optional

Status display

string

total
optional

Total price

4.144. OrderHistoryList

Representation of an Order History List

Name

Description

Schema

orders
optional

List of order history items

< OrderHistory > array

pagination
optional

Pagination items

sorts
optional

List of sorts

< Sort > array

4.145. OrderStatusUpdateElement

Representation of an Order Status Update Element

Name

Description

Schema

baseSiteId
optional

BaseSite identifier

string

code
optional

Code of update element of order status

string

status
optional

Status of update element

string

4.146. OrderStatusUpdateElementList

Representation of an Order Status Update Element List

Name

Description

Schema

orderStatusUpdateElements
optional

List of order status update elements

< OrderStatusUpdateElement > array

4.147. OrgCustomerCreation

Representation of data used for user creation operations. Consists of fields used to create customer

Name Description Schema

dateOfBirth
optional

Date of birth

string

email
optional

Email of the user
Example : "akiro.nakamura@rustic-hw.com"

string

firstName
optional

First name of the user
Example : "Akiro"

string

lastName
optional

Last name of the user
Example : "Nakamura"

string

orgUnit
optional

The unit of the user

roles
optional

List of organizational approvers

< string > array

titleCode
optional

Code of the user’s title
Example : "mr"

string

4.148. OrgCustomerModification

Representation of data used for user modification operations. Consists of fields used to modify customer

Name Description Schema

active
optional

Boolean flag of whether the user is active/enabled or not
Example : true

boolean

dateOfBirth
optional

Date of birth

string

email
optional

Email of the user
Example : "akiro.nakamura@rustic-hw.com"

string

firstName
optional

First name of the user
Example : "Akiro"

string

lastName
optional

Last name of the user
Example : "Nakamura"

string

orgUnit
optional

The unit of the user

password
optional

Password of the user

string

roles
optional

List of organizational approvers

< string > array

titleCode
optional

Code of the user’s title
Example : "mr"

string

4.149. OrgUnitUserGroup

Name Description Schema

members
optional

List of members

< Principal > array

membersCount
optional

Number of members

integer(int32)

name
optional

Name of the user

string

orgUnit
optional

Organizational Unit of the user group

permissions
optional

Order approval permission of the user group

< OrderApprovalPermission > array

roles
optional

List of Roles

< string > array

selected
optional

Boolean flag of whether a user group is selected or not
Example : true

boolean

subGroups
optional

List of subgroups

< UserGroup > array

uid
optional

Unique user identifier

string

4.150. OrgUnitUserGroupList

Representation of an user list used in organizational units

Name

Description

Schema

orgUnitUserGroups
required

List of organizational unit user groups

< OrgUnitUserGroup > array

pagination
required

Pagination items

sorts
required

List of sorts

< Sort > array

4.151. OrgUnitUserList

Representation of an user list used in organizational units

Name

Description

Schema

pagination
required

Pagination items

sorts
required

List of sorts

< Sort > array

users
required

List of users

< User > array

4.152. OrgUserRegistrationData

Representation of data used for user registration operations. Consists of fields used to apply to create new customer

Name Description Schema

email
required

Email of the user
Example : "akiro.nakamura@rustic-hw.com"

string

firstName
required

First name of the user
Example : "akiro"

string

lastName
required

Last name of the user
Example : "nakamura"

string

message
optional

Contains info to approver, usually composed by UI with a template
Example : "Department:Ground support; Position:Chief safe guard; Report to: steve jackson; comments: Please create new account for me"

string

titleCode
optional

Code of the user’s title
Example : "mr"

string

4.153. PageAdaptedData

Type : object

4.154. PaymentDetails

Representation of a Payment Details

Name

Description

Schema

accountHolderName
optional

Name of account holder

string

billingAddress
optional

Address details to be considered as billing address

cardNumber
optional

Payment card number

string

cardType
optional

Type of payment card

CardType

defaultPayment
optional

Flag to mark if payment the default one

boolean

expiryMonth
optional

Month of expiration of payment

string

expiryYear
optional

Year of expiration of payment

string

id
optional

Unique identifier of payment detail

string

issueNumber
optional

Issue number

string

paymentOption
optional

string

saved
optional

Flag to mark if payment is saved one

boolean

startMonth
optional

Start month from which payment is valid

string

startYear
optional

Start year from which payment is valid

string

subscriptionId
optional

Identifier of subscription

string

4.155. PaymentDetailsList

Representation of a Payment details list

Name

Description

Schema

payments
optional

List of payment details

< PaymentDetails > array

4.156. PaymentMode

Representation of a Payment Mode

Name

Description

Schema

code
optional

Payment mode code

string

description
optional

Payment mode description

string

name
optional

Payment mode name

string

4.157. PaymentModeList

Representation of a Payment Mode List

Name

Description

Schema

paymentModes
optional

List of payment modes

< PaymentMode > array

4.158. PaymentRequest

Name

Schema

mappingLabels
optional

< string, string > map

parameters
optional

< string, string > map

postUrl
optional

string

4.159. PhoneContactInfo

Name

Schema

code
optional

string

phoneNumber
optional

string

4.160. PickupOrderEntryGroup

Representation of a Pickup Order Entry Group

Name

Description

Schema

deliveryPointOfService
optional

Delivery point of service

distance
optional

Distance calculated to pickup place

number(double)

entries
optional

List of order entries

< OrderEntry > array

quantity
optional

Quantity of order entries in a group

integer(int64)

totalPriceWithTax
optional

Total price with tax

4.161. PointOfService

Representation of a Point of service

Name

Description

Schema

address
optional

Address information of point of service

description
optional

Description of the point of service

string

displayName
optional

Display name of the point of service

string

distanceKm
optional

Distance to the point of service as number value

number(double)

features
optional

List of features for a given point of service

< string, string > map

formattedDistance
optional

Distance to the point of service as text value

string

geoPoint
optional

Geopoint localization info about point of service

GeoPoint

mapIcon
optional

Image associated with the point of service

name
optional

Name of the point of service

string

openingHours
optional

Opening hours of point of service

OpeningSchedule

storeContent
optional

Store content of given point of service

string

storeImages
optional

Collection of images associated with a point of service

< Image > array

url
optional

Url address of the point of service

string

4.162. PointOfServiceList

Representation of a Point of Service List

Name

Description

Schema

pointOfServices
optional

List of points of service

< PointOfService > array

4.163. PointOfServiceStock

Representation of a Point Of Service Stock

Name

Description

Schema

address
optional

Address information of point of service

description
optional

Description of the point of service

string

displayName
optional

Display name of the point of service

string

distanceKm
optional

Distance to the point of service as number value

number(double)

features
optional

List of features for a given point of service

< string, string > map

formattedDistance
optional

Distance to the point of service as text value

string

geoPoint
optional

Geopoint localization info about point of service

GeoPoint

mapIcon
optional

Image associated with the point of service

name
optional

Name of the point of service

string

openingHours
optional

Opening hours of point of service

OpeningSchedule

stockInfo
optional

Stock information about point of service

storeContent
optional

Store content of given point of service

string

storeImages
optional

Collection of images associated with a point of service

< Image > array

url
optional

Url address of the point of service

string

4.164. Price

Representation of a Price

Name

Description

Schema

currencyIso
optional

Currency iso format

string

formattedValue
optional

Value of price formatted

string

maxQuantity
optional

Maximum quantity of the price value

integer(int64)

minQuantity
optional

Minimum quantity of the price value

integer(int64)

name
optional

string

oneTimeChargeEntries
optional

< OneTimeChargeEntry > array

priceType
optional

Type of the price

enum (BUY, FROM)

recurringChargeEntries
optional

< RecurringChargeEntry > array

value
optional

Value of price in BigDecimal format

number

4.165. PriceRange

Representation of a Price Range

Name

Description

Schema

maxPrice
optional

Maximum value of the Price Range

minPrice
optional

Minium value of the Price Range

4.166. Principal

Representation of a Principal webservice DTO used for defining User data types

Name

Description

Schema

name
optional

Name of the user

string

uid
optional

Unique user identifier

string

4.167. Product

Representation of a Product

Name

Description

Schema

addToCartDisabled
optional

boolean

addToCartDisabledMessage
optional

string

availableForPickup
optional

Flag defining if product is available for pickup

boolean

averageRating
optional

Rating number of average value

number(double)

baseOptions
optional

List of base options related to the product

< BaseOption > array

baseProduct
optional

Information about base product

string

bundleTemplates
optional

< BundleTemplate > array

cartDisplayName
optional

string

categories
optional

List of categories product belongs to

< Category > array

classifications
optional

List of classifications related to the product

< Classification > array

code
optional

Code of the product

string

configurable
optional

Flag stating if product is configurable

boolean

configuratorType
optional

Configurator type related to the product

string

defaultCategory
optional

description
optional

Description of the product

string

displayClassifications
optional

boolean

documents
optional

< FSDocument > array

dynamicAttributes
optional

< string, DynamicAttributeObject > map

firstVariantCode
optional

string

firstVariantImage
optional

string

fulfilmentType
optional

FulfilmentType

futureStocks
optional

List of future stocks

< FutureStock > array

images
optional

List of images linked to product

< Image > array

investments
optional

< FSInvestmentInfo > array

keywords
optional

< string > array

lowestBundlePrice
optional

manufacturer
optional

Data of product manufacturer

string

multidimensional
optional

Flag stating if product is multidimensional

boolean

name
optional

Name of the product

string

numberOfReviews
optional

Number of reviews associated with the product

integer(int32)

potentialPromotions
optional

List of potential promotions related to the product

< Promotion > array

price
optional

Price of the product

priceRange
optional

Price range assigned to the product

PriceRange

productReferences
optional

List of product references

< ProductReference > array

purchasable
optional

Flag defining if product is purchasable

boolean

reviews
optional

List of reviews associated with the product

< Review > array

salesIllustrationDiagramData
optional

< FSSalesIllustrationDiagramEntry > array

soldIndividually
optional

boolean

stock
optional

Stock value of the product

subscriptionTerm
optional

SubscriptionTerm

summary
optional

Product summary

string

tags
optional

Tags associated with the product

< string > array

url
optional

Url address of the product

string

variantMatrix
optional

List of variant matrixes associated with the product

< VariantMatrixElement > array

variantOptions
optional

List of variant options related to the product

< VariantOption > array

variantType
optional

Variant type of the product

string

volumePrices
optional

List of volume prices

< Price > array

volumePricesFlag
optional

Flag stating if volume price should be displayed

boolean

4.168. ProductExpressUpdateElement

Representation of a Product Express Update Element

Name

Description

Schema

catalogId
optional

Catalog identifier

string

catalogVersion
optional

Catalog version

string

code
optional

Code of product express update element

string

4.169. ProductExpressUpdateElementList

Representation of a Product Express Update Element List

Name

Description

Schema

productExpressUpdateElements
optional

List of product express update element

< ProductExpressUpdateElement > array

4.170. ProductFutureStocks

Representation of a Product Future Stocks

Name Description Schema

futureStocks
optional

List of future stocks

< FutureStock > array

productCode
optional

Product identifier
Example : "3318057"

string

4.171. ProductFutureStocksList

Representation of a Product Future Stocks List

Name

Description

Schema

productFutureStocks
optional

List of product future stocks

< ProductFutureStocks > array

4.172. ProductList

Representation of a Product List

Name

Description

Schema

catalog
optional

Catalog of product list

string

currentPage
optional

Number of current page

integer(int32)

products
optional

List of products

< Product > array

totalPageCount
optional

Total page count

integer(int32)

totalProductCount
optional

Total product count

integer(int32)

version
optional

Version of product list

string

4.173. ProductReference

Representation of a Product Reference

Name

Description

Schema

description
optional

Reference description

string

preselected
optional

Flag stating if product reference is preselected

boolean

quantity
optional

Reference quantity

integer(int32)

referenceType
optional

Reference type

string

target
optional

Target product

4.174. ProductReferenceList

Representation of a Product Reference List

Name

Description

Schema

references
optional

List of product references

< ProductReference > array

4.175. ProductSearchPage

Representation of a Product Search Page

Name

Description

Schema

breadcrumbs
optional

List of breadcrumbs info

< Breadcrumb > array

categoryCode
optional

Code of category

string

currentQuery
optional

Current query

facets
optional

List of facets

< Facet > array

freeTextSearch
optional

Free text search

string

keywordRedirectUrl
optional

Redirect url address keyword

string

pagination
optional

Pagination number

products
optional

List of products

< Product > array

sorts
optional

List of sorts

< Sort > array

spellingSuggestion
optional

Spelling suggestion

SpellingSuggestion

4.176. Promotion

Representation of a Promotion

Name

Description

Schema

code
optional

Code of the promotion

string

couldFireMessages
optional

Message about promotion which is displayed when planning potential promotion. This field has higher priority over promotion description

< string > array

description
optional

Description of the promotion

string

enabled
optional

Boolean flag if promotion is enabled

boolean

endDate
optional

Last date of validity of the promotion

string(date-time)

firedMessages
optional

Message fired while the promotion is active. This is info how much you will get when applying the promotion

< string > array

priority
optional

Priority index as numeric value of the promotion. Higher number means higher priority

integer(int32)

productBanner
optional

Image banner of the promotion

promotionGroup
optional

Group of the promotion

string

promotionType
optional

Type of the promotion

string

restrictions
optional

List of promotion restrictions

< PromotionRestriction > array

startDate
optional

The initial date of the promotion

string(date-time)

title
optional

Promotion title

string

4.177. PromotionList

Representation of a Promotion list

Name

Description

Schema

promotions
optional

List of promotions

< Promotion > array

4.178. PromotionOrderEntryConsumed

Representation of a Promotion order entry consumed

Name

Description

Schema

adjustedUnitPrice
optional

Adjusted unit price for promotion order entry

number(double)

code
optional

Order entry code

string

orderEntryNumber
optional

Order entry number

integer(int32)

quantity
optional

Quantity of promotion order entry

integer(int64)

4.179. PromotionRestriction

Representation of a Promotion Restriction

Name

Description

Schema

description
optional

Description of the promotion restriction

string

restrictionType
optional

Type of the promotion restriction

string

4.180. PromotionResult

Representation of a Promotion result

Name

Description

Schema

consumedEntries
optional

List of promotion order entries consumed

< PromotionOrderEntryConsumed > array

description
optional

Description of promotion result

string

promotion
optional

Promotion information for given promotion result

Promotion

4.181. PromotionResultList

Representation of a Promotion result list

Name

Description

Schema

promotions
optional

List of promotion results

< PromotionResult > array

4.182. Quote

Representation of the quote object.

Name Description Schema

allowedActions
optional

Actions, which are allowed to perform with the quote.

< string > array

cartId
optional

Id of the cart, which is linked to the quote.
Example : "000350"

string

code
required

Code of the quote.
Example : "0003005"

string

comments
optional

List of quote comments.

< Comment > array

creationTime
required

Date of quote creation.
Example : "yyyy-MM-dd HH:mm:ss+0000"

string(date-time)

description
optional

Description of the quote.
Example : "Quote description"

string

entries
optional

Entries of the cart.

< OrderEntry > array

expirationTime
required

Expiration time of the quote.
Example : "yyyy-MM-ddTHH:mm:ss+0000"

string(date-time)

name
required

Name of the quote.
Example : "Quote 0003005"

string

orderDiscounts
optional

Discounts available for the current order.

previousEstimatedTotal
optional

Previously estimated total price of the quote.

productDiscounts
optional

Discount applied to the product.

quoteDiscounts
optional

Discounts available for the current quote.

state
required

Current state of the quote. Possible state values - DRAFT, SUBMITTED, OFFER, CANCELLED, EXPIRED, etc.. The list of the states can be extended.
Example : "CANCELLED"

string

subTotalWithDiscounts
optional

Subtotal of the quote with applied discount.

threshold
required

Minimum subtotal value for the quote in the currency of the store.
Example : 25000.0

number(double)

totalItems
required

Total number of the items in the quote.
Example : 2

integer(int32)

totalPrice
optional

Total price of the cart.

totalPriceWithTax
optional

Total price of the cart with taxes.

updatedTime
required

Date of the last quote update.
Example : "yyyy-MM-dd HH:mm:ss+0000"

string(date-time)

version
required

Current version of the quote.
Example : 1

integer(int32)

4.183. QuoteAction

Action for the quote.

Name Description Schema

action
required

User’s actions with the quote. Typical actions are: CANCEL, SUBMIT, ACCEPT, APPROVE, REJECT.
Example : "SUBMIT"

string

4.184. QuoteBindingState

Name

Schema

code
optional

string

4.185. QuoteDiscount

Discount applied to the quote

Name Description Schema

discountRate
optional

Value of the discount
Example : 10.0

number(double)

discountType
optional

Type of the discount - PERCENT for discount by percentage, ABSOLUTE for discount by amount, TARGET for discount by adjustment of the total value
Example : "PERCENT"

string

4.186. QuoteList

Representation of a Quote result list.

Name

Description

Schema

pagination
optional

Pagination of quotes list.

quotes
optional

List of quotes.

< Quote > array

4.187. QuoteMetadata

Representation of quote metadata.

Name Description Schema

description
optional

Description of the quote.
Example : "Quote Description"

string

expirationTime
required

Expiration time of the quote.
Example : "yyyy-MM-ddTHH:mm:ss+0000"

string(date-time)

name
required

Name of the quote.
Example : "Quote Name"

string

4.188. QuoteStarter

Object for the quote creation, either cartId or quoteCode must be specified.

Name Description Schema

cartId
optional

CartId of the cart from which the quote will be created.
Example : "0003050"

string

quoteCode
optional

Code of the quote for the requote action.
Example : "0003060"

string

4.189. QuoteWorkflowStatus

Name

Schema

code
optional

string

4.190. RecurringChargeEntry

Name

Schema

price
optional

4.191. Region

Response body fields which will be returned while fetching the list of country’s regions.

Name

Description

Schema

countryIso
optional

Country code in iso format

string

isocode
optional

Country and Region code in iso format

string

isocodeShort
optional

Region code in short iso form

string

name
optional

Name of the region

string

4.192. RegionList

List of Regions

Name

Description

Schema

regions
optional

This is the list of Region fields that should be returned in the response body

< Region > array

4.193. ReplenishmentOrder

Request body fields required and optional to operate on Replenishment Order data.

Name Description Schema

active
optional

Is the Replenishment Order active
Example : false

boolean

appliedOrderPromotions
optional

List of applied order promotions

< PromotionResult > array

appliedProductPromotions
optional

List of applied product promotions

< PromotionResult > array

appliedVouchers
optional

List of applied vouchers

< Voucher > array

calculated
optional

Flag showing if order is calculated

boolean

code
optional

Code number of order

string

costCenter
optional

deliveryAddress
optional

Delivery address

deliveryCost
optional

Delivery cost

deliveryItemsQuantity
optional

Quantity of delivery items

integer(int64)

deliveryMode
optional

Delivery mode information

deliveryOrderGroups
optional

List of delivery order entries group

< DeliveryOrderEntryGroup > array

description
optional

Description of the cart

string

entries
optional

List of order entries

< OrderEntry > array

entryGroups
optional

List of entry groups

< EntryGroup > array

expirationTime
optional

Date of cart expiration time

string(date-time)

firstDate
optional

First date of the replenishment order
Example : "2020-12-31T09:00:00+0000"

string(date-time)

guid
optional

Guest user id identifier

string

insuranceQuote
optional

name
optional

Name of the cart

string

net
optional

Flag stating iv value is net-value

boolean

orderDiscounts
optional

Order discounts

paymentInfo
optional

Payment information

paymentType
optional

B2BPaymentTypeData

pickupItemsQuantity
optional

Quantity of pickup items

integer(int64)

pickupOrderGroups
optional

List of pickup order entry group

< PickupOrderEntryGroup > array

potentialOrderPromotions
optional

List of potential order promotions for cart

< PromotionResult > array

potentialProductPromotions
optional

List of potential product promotions for cart

< PromotionResult > array

productDiscounts
optional

Product discounts

purchaseOrderNumber
optional

string

replenishmentOrderCode
required

Unique code for the replenishment order
Example : "502BJ"

string

saveTime
optional

Date of saving cart

string(date-time)

savedBy
optional

Information about person who saved cart

site
optional

Site

string

store
optional

Store

string

subTotal
optional

Subtotal price

totalDiscounts
optional

Total discounts

totalItems
optional

integer(int32)

totalPrice
optional

Total price value

totalPriceWithTax
optional

Total price with tax

totalTax
optional

Total tax price

totalUnitCount
optional

Total unit count

integer(int32)

trigger
optional

Trigger for the replenishment order

Trigger

user
optional

User information

4.194. ReplenishmentOrderList

Representation of a Replenishment Order List

Name

Description

Schema

pagination
optional

Pagination items

replenishmentOrders
optional

List of Replenishment Orders

< ReplenishmentOrder > array

sorts
optional

List of sorts

< Sort > array

4.195. ResetPassword

Representation of a Reset Password

Name

Description

Schema

newPassword
required

new password string which is required to complete process of resetting password

string

token
required

token value which will be generated as unique string that will be sent with email to allow user for completing reset-password operation

string

4.196. ReturnRequest

Representation of a return request for an order

Name Description Schema

cancellable
optional

Boolean flag for whether the return request is cancellable
Example : true

boolean

code
optional

Return request code
Example : "00000001"

string

creationTime
optional

Date of the return request creation
Example : "2020-12-31T09:00:00+0000"

string(date-time)

deliveryCost
optional

Delivery cost

order
optional

Order related to the return request

refundDeliveryCost
optional

Boolean flag for whether there is a delivery cost for refund
Example : false

boolean

returnEntries
optional

Entries of the return request which contains information about the returned product

< ReturnRequestEntry > array

returnLabelDownloadUrl
optional

URL of the return label

string

rma
optional

Return merchandise authorization number
Example : "00000001"

string

status
optional

Status of return request

string

subTotal
optional

Subtotal price

totalPrice
optional

Total price

4.197. ReturnRequestEntry

Representation of a return request entry which contains information about the returned product

Name Description Schema

expectedQuantity
optional

Quantity which is expected to be returned for this return request entry
Example : 5

integer(int64)

orderEntry
optional

Order entry related to the return request entry

refundAmount
optional

Refund amount of the entry

4.198. ReturnRequestEntryInput

Representation of a return request entry input for an order

Name Description Schema

orderEntryNumber
required

Order entry number of the returned product
Example : 1

integer(int32)

quantity
required

Quantity of the product which belongs to the order entry and is requested to be returned
Example : 5

integer(int64)

4.199. ReturnRequestEntryInputList

Representation of a return request entry input list for an order

Name Description Schema

orderCode
required

Code of the order which return request is related to
Example : "00000001"

string

returnRequestEntryInputs
required

Return request entry inputs which contain information about the order entries which are requested to be returned

< ReturnRequestEntryInput > array

4.200. ReturnRequestList

Representation of an Order Return Request List

Name

Description

Schema

pagination
optional

Pagination items

returnRequests
optional

List of order return requests

< ReturnRequest > array

sorts
optional

List of sorts

< Sort > array

4.201. ReturnRequestModification

Representation of modifications for a return request

Name

Description

Schema

status
optional

Status of the return request

enum (CANCELLING)

4.202. Review

Representation of a Review

Name

Description

Schema

alias
optional

Alias name for the review

string

comment
optional

Review comment

string

date
optional

Date of the review

string(date-time)

headline
optional

Review headline

string

id
optional

Identifier of review

string

principal
optional

Person related to the review

rating
optional

Review rating value

number(double)

4.203. ReviewList

Representation of a Review List

Name

Description

Schema

reviews
optional

List of reviews

< Review > array

4.204. SaveCartResult

Representation of a Save Cart Result

Name

Description

Schema

savedCartData
optional

Cart data information for saved cart

4.205. ScheduleReplenishmentForm

Representation of a Schedule Replenishment Form

Name Description Schema

daysOfWeek
optional

List of days of week on which replenishment should occur. Mandatory with 'recurrencePeriod=WEEKLY'.

< enum (SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY) > array

nthDayOfMonth
optional

On which date of month replenishment should be activated. Mandatory with 'recurrencePeriod=MONTHLY'.
Example : "1"

string

numberOfDays
optional

How frequent replenishment should be activated expressed in days. Mandatory with 'recurrencePeriod=DAILY'.
Example : "14"

string

numberOfWeeks
optional

How frequent replenishment should be activated expressed in weeks. Mandatory with 'recurrencePeriod=WEEKLY'.
Example : "1"

string

recurrencePeriod
optional

Replenishment recurrence period. Available values are DAILY, WEEKLY and MONTHLY. DAILY requires 'numberOfDays'. WEEKLY requires 'daysOfWeek' AND 'numberOfWeeks'. MONTHLY requires 'nthDayOfMonth'.
Example : "WEEKLY"

string

replenishmentStartDate
optional

First day for replenishment order
Example : "2020-12-31T09:00:00+0000"

string(date-time)

4.206. SearchQuery

Representation of a Search Query

Name

Description

Schema

value
optional

Value of search query

string

4.207. SearchState

Representation of a Search State

Name

Description

Schema

query
optional

Query of search state

SearchQuery

url
optional

Url address of search state

string

4.208. SiteMessageList

Name

Schema

messages
optional

< siteMessage > array

4.209. Sort

Representation a Sort option

Name

Description

Schema

code
optional

Code of Sort

string

name
optional

Name of Sort

string

selected
optional

Flag stating when Sort is selected

boolean

4.210. SpecialOpeningDay

Representation of a special opening day

Name

Description

Schema

closed
optional

Flag stating if special opening day is closed

boolean

closingTime
optional

Closing time of opening day

comment
optional

Comment field

string

date
optional

Date of special opening day

string(date-time)

formattedDate
optional

Text representation of the date of special opening day

string

name
optional

Name of the special opening day event

string

openingTime
optional

Starting time of opening day

4.211. SpellingSuggestion

Representation of a Spell Checker Suggestion

Name

Description

Schema

query
optional

Query for spelling suggestion

string

suggestion
optional

Spelling suggestion

string

4.212. StatusSummary

Representation of a status summary, an aggregated view on issues for a specific status or severity. These issues are attached to configurations of products or order entries

Name Description Schema

numberOfIssues
optional

Number of issues per status
Example : 3

integer(int32)

status
optional

Status or severity indicator, can be one of ERROR, WARNING, INFO or SUCCESS
Example : "ERROR"

string

4.213. Stock

Representation of a Stock

Name Description Schema

isValueRounded
optional

Indicate whether Stock level value is rounded
Example : false

boolean

stockLevel
optional

Stock level expressed as number
Example : 25

integer(int64)

stockLevelStatus
optional

Status of stock level
Example : "inStock"

string

4.214. StoreCount

Representation of a Store Count

Name

Description

Schema

count
optional

Count

integer(int32)

isoCode
optional

Iso code of store

string

name
optional

Name of store count

string

storeCountDataList
optional

List of store counts

< StoreCount > array

type
optional

Type of store count

string

4.215. StoreCountList

Representation of a Store Count List

Name

Description

Schema

countriesAndRegionsStoreCount
optional

List of store counts

< StoreCount > array

4.216. StoreFinderSearchPage

Representation of a Store finder search page

Name

Description

Schema

boundEastLongitude
optional

Bound east longitude

number(double)

boundNorthLatitude
optional

Bound north latitude

number(double)

boundSouthLatitude
optional

Bound south latitude

number(double)

boundWestLongitude
optional

Bound west longitude

number(double)

locationText
optional

Location text

string

pagination
optional

Pagination

sorts
optional

List of sortings

< Sort > array

sourceLatitude
optional

Source latitude

number(double)

sourceLongitude
optional

Source longitude

number(double)

stores
optional

List of stores

< PointOfService > array

4.217. StoreFinderStockSearchPage

Representation of a Store Finder Stock Search Page

Name

Description

Schema

boundEastLongitude
optional

Bound to east longitude

number(double)

boundNorthLatitude
optional

Bound to north latitude

number(double)

boundSouthLatitude
optional

Bound to south latitude

number(double)

boundWestLongitude
optional

Bound to west longitude

number(double)

locationText
optional

Location text

string

pagination
optional

Pagination

product
optional

Product

sorts
optional

List of sorts

< Sort > array

sourceLatitude
optional

Source latitude

number(double)

sourceLongitude
optional

Source longitude

number(double)

stores
optional

List of stores

< PointOfServiceStock > array

4.218. SubscriptionBilling

Name

Schema

billingDate
optional

string

billingPeriod
optional

string

dueDate
optional

string(date-time)

paymentAmount
optional

string

paymentStatus
optional

string

4.219. SubscriptionTerm

Name

Schema

billingPlan
optional

BillingPlan

cancellable
optional

boolean

id
optional

string

name
optional

string

termOfServiceFrequency
optional

TermOfServiceFrequency

termOfServiceNumber
optional

integer(int32)

termOfServiceRenewal
optional

TermOfServiceRenewal

4.220. Suggestion

Representation of a Suggestion

Name

Description

Schema

value
optional

Suggestion value

string

4.221. SuggestionList

Representation of a Suggestion List

Name

Description

Schema

suggestions
optional

List of suggestions

< Suggestion > array

4.222. TermOfServiceFrequency

Name

Schema

code
optional

string

name
optional

string

4.223. TermOfServiceRenewal

Name

Schema

code
optional

string

name
optional

string

4.224. Time

Representation of a Time

Name Description Schema

formattedHour
optional

Formatted hour

string

hour
optional

Hour part of the time data
Minimum value : -128
Maximum value : 127

integer(int32)

minute
optional

Minute part of the time data
Minimum value : -128
Maximum value : 127

integer(int32)

4.225. Title

Representation of a Title

Name

Description

Schema

code
optional

Title code

string

name
optional

Title name

string

4.226. TitleList

Representation of a Title List

Name

Description

Schema

titles
optional

List of titles

< Title > array

4.227. Trigger

Representation of a Trigger

Name Description Schema

activationTime
optional

The time the trigger will be activated
Example : "2020-12-31T09:00:00+0000"

string(date-time)

displayTimeTable
optional

Description of when the trigger is being activated
Example : "Every Monday at 00:00:00"

string

4.228. User

Representation of an User

Name Description Schema

active
optional

Boolean flag of whether the user is active/enabled or not
Example : true

boolean

address
optional

approvers
optional

List of organizational approvers

< User > array

contactInfos
optional

< PhoneContactInfo > array

currency
optional

User preferred currency

customerId
optional

Customer identifier

string

dateOfBirth
optional

string

deactivationDate
optional

Deactivation date

string(date-time)

defaultAddress
optional

User address

displayUid
optional

User identifier

string

email
optional

Email of the user
Example : "mark.rivers@rustic-hw.com"

string

firstName
optional

User first name

string

language
optional

User preferred language

Language

lastName
optional

User last name

string

name
optional

Name of the user

string

orgUnit
optional

The unit of the User

roles
optional

< string > array

selected
optional

Boolean flag of whether the user is selected
Example : true

boolean

thumbnail
optional

title
optional

User title

string

titleCode
optional

User title code

string

uid
optional

Unique user identifier

string

4.229. UserGroup

Representation of an User Group

Name

Description

Schema

members
optional

List of members

< Principal > array

membersCount
optional

Number of members

integer(int32)

name
optional

Name of the user

string

subGroups
optional

List of subgroups

< UserGroup > array

uid
optional

Unique user identifier

string

4.230. UserGroupList

Representation of an User Group List

Name

Description

Schema

currentPage
optional

Current page

integer(int32)

numberOfPages
optional

Number of pages

integer(int32)

pageSize
optional

Page size

integer(int32)

totalNumber
optional

Total number

integer(int32)

userGroups
optional

List of user groups

< UserGroup > array

4.231. UserSignUp

Representation of an UserSignUp. Consists of fields required to register new customer

Name

Description

Schema

dateOfBirth
optional

string

firstName
required

first name of the user

string

lastName
required

last name of the user

string

password
required

user password

string

phoneNumber
optional

string

titleCode
optional

string

uid
required

user id, unique string required to create new user. It can be email

string

4.232. VariantCategory

Representation of a Variant Category

Name

Description

Schema

hasImage
optional

Flag if varian category has image assigned

boolean

name
optional

Variant category name

string

priority
optional

Priority number of variant category

integer(int32)

4.233. VariantMatrixElement

Representation of a Variant Matrix Element

Name

Description

Schema

elements
optional

List of elements with the type of variant matrix element

< VariantMatrixElement > array

isLeaf
optional

boolean

parentVariantCategory
optional

Parent variant category for variant matrix element

VariantCategory

variantOption
optional

Variant option for variant matrix element

VariantOption

variantValueCategory
optional

Variant value category for variant matrix element

VariantValueCategory

4.234. VariantOption

Representation of a Variant Option

Name

Description

Schema

code
optional

Code of the variant option

string

priceData
optional

Price data information of the variant option

stock
optional

Stock value of the variant option

url
optional

Url address of the variant option

string

variantOptionQualifiers
optional

List of variant option qualifiers

< VariantOptionQualifier > array

4.235. VariantOptionQualifier

Representation of a Variant Option Qualifier

Name

Description

Schema

image
optional

Image associated with variant option qualifier

name
optional

Name of variant option qualifier

string

qualifier
optional

Qualifier

string

value
optional

Value of variant option qualifier

string

4.236. VariantValueCategory

Representation of a Variant Value Category

Name

Description

Schema

name
optional

Name of the variant value category

string

sequence
optional

Sequence number of variant value category

integer(int32)

superCategories
optional

Parent category of variant value category

< VariantCategory > array

4.237. Voucher

Representation of a Voucher

Name

Description

Schema

appliedValue
optional

Applied value when using this voucher

code
optional

The identifier of the Voucher. This is the first part of voucher code which holds first 3 letters, like: 123

string

currency
optional

Currency of the voucher

description
optional

Description of the voucher

string

freeShipping
optional

Specifies if the order this voucher is applied to is shipped for free (true) or not (false). Defaults to false.

boolean

name
optional

Name of the voucher

string

value
optional

Value of the voucher. Example of such value is: 15.0d

number(double)

valueFormatted
optional

Formatted value of the voucher

string

valueString
optional

The value of the voucher to display. Example: 15.0%

string

voucherCode
optional

Voucher code, is the holder for keeping specific occasional voucher related to business usage. It can be generated and looks like: 123-H8BC-Y3D5-34AL

string

4.238. VoucherList

Representation of a Voucher List

Name

Description

Schema

vouchers
optional

List of vouchers

< Voucher > array

4.239. WeekdayOpeningDay

Representation of a Weekday Opening Day

Name

Description

Schema

closed
optional

Flag stating if weekday opening day is closed

boolean

closingTime
optional

Closing time of opening day

openingTime
optional

Starting time of opening day

weekDay
optional

Text representation of week day opening day

string

4.240. YFormData

Represents the form data object with fields, values and definition

Name Description Schema

content
optional

JSON content with form fields and values

string

formDefinition
optional

Structural definition of form

YFormDefinition

id
optional

YForm data identifier

string

type
optional

YForm data type, could be DATA or DRAFT
Example : "DATA"

string

4.241. YFormDefinition

Represents structural definition of form. How form should look like, which fields of which type should be rendered.

Name Description Schema

applicationId
optional

Application identifier
Example : "insurance"

string

content
optional

Structural definition in JSON format. Defines structure of form with fields, their types and labels grouped in sections.

string

description
optional

Description of YForm definition
Example : "Life details information"

string

formId
optional

YForm identifier
Example : "life_details_form"

string

subject
optional

Subject of YForm definition
Example : "Renters Information"

string

title
optional

Title of YForm definition
Example : "Life Details"

string

4.242. YFormDefinitionList

List of form definitions

Name

Description

Schema

formDefinitions
optional

List of structural definitions of forms

< YFormDefinition > array

4.243. deprecatedPagination

Representation of a search results pagination

Name

Description

Schema

currentPage
optional

The current page number. The first page is number zero (0), the second page is number one (1), and so on

integer(int32)

pageSize
optional

The number of results per page. A page may have less results if there are less than a full page of results, only on the last page in the results

integer(int32)

sort
optional

The selected sort code

string

totalPages
optional

The total number of pages. This is the number of pages, each of pageSize, required to display the totalResults.

integer(int32)

totalResults
optional

The total number of matched results across all pages

integer(int64)

4.244. error

Error message

Name Description Schema

errorCode
optional

Error code

string

exceptionMessage
optional

string

language
optional

Example : "English"

string

message
optional

Descriptive, human readable error message.

string

position
optional

Example : 1

integer(int32)

reason
optional

Additional classification specific for each error type e.g. 'noStock'.

string

subject
optional

Identifier of the related object e.g. '1'.

string

subjectType
optional

Type of the object related to the error e.g. 'entry'.

string

type
optional

Type of the error e.g. 'LowStockError'.

string

4.245. errorList

List of errors

Name

Schema

errors
optional

< error > array

4.246. notificationPreference

Notification preference

Name Description Schema

channel
optional

preference channel
Example : "email, sms, site_message"

string

enabled
optional

if true, the channel is on; if false, the channel is off

boolean

value
optional

the corresponding value of current channel, for example, for SMS it should be a mobile number; for email it should be an email address

string

visible
optional

if true, the channel is visible; if false, the channel is invisible

boolean

4.247. notificationPreferenceList

Notification preference list

Name

Description

Schema

preferences
optional

notification preferences

< notificationPreference > array

4.248. pagination

Pagination info

Name

Description

Schema

count
optional

Number of elements on this page

integer(int32)

hasNext
optional

Indicates if there is next page

boolean

hasPrevious
optional

Indicates if there is previous page

boolean

page
optional

Current page number

integer(int32)

totalCount
optional

Total number of elements

integer(int64)

totalPages
optional

Total number of pages

integer(int32)

4.249. siteMessage

Name

Description

Schema

body
optional

message body

string

documents
optional

list of attachments for site message

< FSDocument > array

notificationType
optional

notification type used for this message

enum (COUPON_EFFECTIVE, NOTIFICATION, COUPON_EXPIRE)

readDate
optional

message read date

string(date-time)

richContent
optional

message rich content

string

richTitle
optional

message rich title

string

sentDate
optional

sent date

string(date-time)

subject
optional

message subject

string

uid
optional

message uid

string

4.250. siteMessageSearchPage

Site message search page

Name

Description

Schema

messages
optional

site messages

< siteMessage > array

pagination
optional

pagination information

sorts
optional

sorting information

< sort > array

4.251. siteMessageSearchResult

Site message search result

Name

Description

Schema

messages
optional

site messages

< siteMessage > array

pagination
optional

pagination information