1. Overview

These services provide the ability for agents to assist customers with their order, and look up the order by name, email, cart, or order number.

1.1. Version information

Version : 1.0.0

1.2. License information

License : Use of this file is subject to the terms of your agreement with SAP SE or its affiliates respecting the use of the SAP product for which this file relates.
Terms of service : null

1.3. URI scheme

Host : electronics.local:9002
BasePath : /assistedservicewebservices

1.4. Tags

  • customer-lists-controller : Customer Lists Controller

  • customers-controller : Customers Controller

2. Security

2.1. oauth2

Type : oauth2
Flow : password
Token URL : /authorizationserver/oauth/token

Name

basic

3. Resources

3.1. Customer-lists-controller

Customer Lists Controller

3.1.1. Returns customer lists

GET /customerlists
Description

This endpoint returns list of all customer lists. This can only be done when logged in

Parameters
Type Name Description Schema

Query

baseSite
required

Id of the BaseSite

string
Responses
HTTP Code Description Schema

200

OK

UserGroupList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

oauth2

basic

3.1.2. Returns single customer list details

GET /customerlists/{customerlist}
Description

This endpoint returns details of customer list with valid Id

Parameters
Type Name Description Schema

Path

customerlist
required

Id of the customer list

string

Query

baseSite
required

Id of the BaseSite

string
Responses
HTTP Code Description Schema

200

OK

CustomerListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

oauth2

basic

3.2. Customers-controller

Customers Controller

3.2.1. Binds customer with provided id to cart if it’s anonymous cart

POST /bind-cart
Parameters
Type Name Description Schema

Query

baseSite
required

Id of the BaseSite

string

Query

cartId
required

Id of the anonymous Cart

string

Query

customerId
required

Id of the Customer

string
Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • /

Security
Type Name Scopes

oauth2

oauth2

basic

3.2.2. Returns customers to auto complete based on customerQuery parameter

GET /customers/autocomplete
Parameters
Type Name Description Schema

Query

baseSite
required

Id of the BaseSite

string

Query

customerQuery
required

Customer query: first characters of customer email or part of name. A BadRequestException is thrown when the query is too short. Minimum query length can be updated via assistedserviceswebservices.customer.suggestions.minimum.query.length property.

string
Responses
HTTP Code Description Schema

200

OK

< CustomerSuggestionWsDto > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

oauth2

basic

3.2.3. Returns customers based on query parameters

GET /customers/search
Description

This endpoint returns paginated list of customers based on provided query parameters. If query term is present it will return customers based on provided value. If customerListId is present it will ignore query term and return only customers who belong to the given customer list. If orderId parameter is present it will ignore previous parameters and it will return customer associated to the given order.This can only be done by the logged in user.

Parameters
Type Name Description Schema Default

Query

baseSite
required

Id of the BaseSite

string

Query

currentPage
optional

Current page

integer(int32)

"0"

Query

customerListId
optional

Id of the customer list

string

Query

orderId
optional

Id of the order

string

Query

pageSize
optional

Page size

integer(int32)

"20"

Query

query
optional

Customer uid search term

string

Query

sort
optional

Sort parameter. Possible values: byUidAsc, byUidDesc, byNameAsc, byNameDesc

string
Responses
HTTP Code Description Schema

200

OK

CustomerSearchPageWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

oauth2

basic

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. 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.3. 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.4. CustomerListWsDTO

Name Schema

additionalColumnsKeys
optional

< string > array

name
optional

string

searchBoxEnabled
optional

boolean

uid
optional

string

4.5. CustomerSearchPageWsDTO

Name Schema

entries
optional

< User > array

pagination
optional

deprecatedPagination

sorts
optional

< Sort > array

4.6. CustomerSuggestionWsDto

Name Schema

card
optional

string

carts
optional

< string > array

date
optional

string

email
optional

string

fullName
optional

string

4.7. 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.8. 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.9. 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.10. 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.11. User

Representation of an User

Name Description Schema

currency
optional

User preferred currency

Currency

customerId
optional

Customer identifier

string

deactivationDate
optional

Deactivation date

string(date-time)

defaultAddress
optional

User address

Address

displayUid
optional

User identifier

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

title
optional

User title

string

titleCode
optional

User title code

string

uid
optional

Unique user identifier

string

4.12. 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.13. 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.14. 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)