Sales | Customer Set

The Customer Set represents a company container where customers are grouped. A customer can belong to a company or to several.

Overview

api/{tenantKey}/{orgKey}/salesCore/customerSets

URL	api/{tenantKey}/{orgKey}/salesCore/customerSets
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST CustomerSets
- POST Customer Set
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiCustomerSetCustomerSetCompaniesResource
ApiCustomerSetResource
CustomerSetCompanyResource
CustomerSetResource

GET Operations

GET CustomerSets

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See CustomerSetResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets

GET /salesCore/customerSets

GET CustomerSets (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See CustomerSetResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets?page={page}&pageSize={pageSize}

GET /salesCore/customerSets?page={page}&pageSize={pageSize}

GET CustomerSet by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See CustomerSetResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets/{id}

GET /salesCore/customerSets/{id}

GET CustomerSet by key

Returns the entity record that matches the specified key.

The following elements are required:

customerSetKey

(string) The customer set key.

Response:

When successful, the response body contains the entity record. See CustomerSetResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets/{customerSetKey}

GET /salesCore/customerSets/{customerSetKey}

GET Print CustomerSet by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets/{id}/print?template={template}

GET /salesCore/customerSets/{id}/print?template={template}

GET Print CustomerSet by key

Prints the specified entity record.

The following elements are required:

customerSetKey

(string) The customer set key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets/{customerSetKey}/print

GET /salesCore/customerSets/{customerSetKey}/print

GET Original Print CustomerSetOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets/{id}/printOriginal?template={template}

GET /salesCore/customerSets/{id}/printOriginal?template={template}

GET Original Print CustomerSet by key

Prints the specified entity record.

The following elements are required:

customerSetKey

(string) The customer set key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets/{customerSetKey}/printOriginal

GET /salesCore/customerSets/{customerSetKey}/printOriginal

POST Operations

POST CustomerSets

Creates a new entity record.

The following elements are required:

customerSetResource

(ApiCustomerSetResource) The request body should contain the entity record that should be created.
See ApiCustomerSetResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiCustomerSetResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets

POST /salesCore/customerSets

POST Customer Set

Inserts a new 'Customer Set Company' in the 'Customer Set'.

The following elements are required:

customerSetKey	(string) The customer set key.
value	(ApiCustomerSetCustomerSetCompaniesResource) The ApiCustomerSetCustomerSetCompaniesResource instance. See ApiCustomerSetCustomerSetCompaniesResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets/{customerSetKey}/customerSetCompanies

POST /salesCore/customerSets/{customerSetKey}/customerSetCompanies

PUT Operations

PUT Set Company CustomerSetCompany

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

customerSetKey	(string) The customer set key.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets/{customerSetKey}/customerSetCompanies/{lineId}/company

PUT /salesCore/customerSets/{customerSetKey}/customerSetCompanies/{lineId}/company

PUT Set CustomerSetKey CustomerSet

Updates the value of attribute 'CustomerSetKey' in the specified entity record.

The following elements are required:

customerSetKey	(string) The customer set key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets/{customerSetKey}/customerSetKey

PUT /salesCore/customerSets/{customerSetKey}/customerSetKey

PUT Set Description CustomerSet

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

customerSetKey	(string) The customer set key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets/{customerSetKey}/description

PUT /salesCore/customerSets/{customerSetKey}/description

PUT Set IsActive CustomerSet

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

customerSetKey	(string) The customer set key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets/{customerSetKey}/isActive

PUT /salesCore/customerSets/{customerSetKey}/isActive

PUT Set IsDefault CustomerSet

Updates the value of attribute 'IsDefault' in the specified entity record.

The following elements are required:

customerSetKey	(string) The customer set key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets/{customerSetKey}/isDefault

PUT /salesCore/customerSets/{customerSetKey}/isDefault

DELETE Operations

DELETE Customer Set Company by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

customerSetKey	(string) The customer set key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets/{customerSetKey}/customerSetCompanies/{lineId}

DELETE /salesCore/customerSets/{customerSetKey}/customerSetCompanies/{lineId}

DELETE CustomerSet by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets/{id}

DELETE /salesCore/customerSets/{id}

DELETE CustomerSet by key

Deletes the entity record that matches the specified key.

The following elements are required:

customerSetKey

(string) The customer set key.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerSets/{customerSetKey}

DELETE /salesCore/customerSets/{customerSetKey}

Resources

ApiCustomerSetCustomerSetCompaniesResource

The following elements are required:

company

(string) Company that use customer set.

ApiCustomerSetResource

The following elements are required:

customerSetKey	(string) The customer set key.
isDefault	(bool) Default ?.

The following elements are optional:

description	(string) The description of the customer set.
customerSetCompanies	(List of ApiCustomerSetCustomerSetCompaniesResource) The companies that can use this customer set. See ApiCustomerSetCustomerSetCompaniesResource.

CustomerSetCompanyResource

The following elements are required:

company

(string) Company that use customer set.

CustomerSetResource

The following elements are required:

customerSetKey	(string) The customer set key.
isDefault	(bool) Default ?.

The following elements are optional:

description	(string) The description of the customer set.
customerSetCompanies	(List of CustomerSetCompanyResource) The companies that can use this customer set. See CustomerSetCompanyResource.