Sales | Price List

The Price List represents a convenient way to create different prices to service and items that you sell to your customers.

Overview

api/{tenantKey}/{orgKey}/salesCore/priceLists

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

All Operations

This service includes the following operations:

GET:
POST:
- POST PriceLists
PUT:
DELETE:
- DELETE PriceList by identifier
- DELETE PriceList by key

All Resources

This service uses the following resources:

ApiPriceListResource
PriceListResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET PriceLists

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/priceLists

GET /salesCore/priceLists

GET PriceLists (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 PriceListResource.

Response status codes:

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

Resource URL:

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

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

GET PriceList 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 PriceListResource.

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/priceLists/{id}

GET /salesCore/priceLists/{id}

GET PriceList by key

Returns the entity record that matches the specified key.

The following elements are required:

priceListKey

(string) The key for the price list.

Response:

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

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/priceLists/{priceListKey}

GET /salesCore/priceLists/{priceListKey}

GET Print PriceList 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/priceLists/{id}/print?template={template}

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

GET Print PriceList by key

Prints the specified entity record.

The following elements are required:

priceListKey

(string) The key for the price list.

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/priceLists/{priceListKey}/print

GET /salesCore/priceLists/{priceListKey}/print

GET Original Print PriceListOriginal 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/priceLists/{id}/printOriginal?template={template}

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

GET Original Print PriceList by key

Prints the specified entity record.

The following elements are required:

priceListKey

(string) The key for the price list.

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/priceLists/{priceListKey}/printOriginal

GET /salesCore/priceLists/{priceListKey}/printOriginal

POST Operations

POST PriceLists

Creates a new entity record.

The following elements are required:

priceListResource

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

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 ApiPriceListResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/priceLists

POST /salesCore/priceLists

PUT Operations

PUT Set Currency PriceList

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

The following elements are required:

priceListKey	(string) The key for the price list.
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/priceLists/{priceListKey}/currency

PUT /salesCore/priceLists/{priceListKey}/currency

PUT Set Description PriceList

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

The following elements are required:

priceListKey	(string) The key for the price list.
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/priceLists/{priceListKey}/description

PUT /salesCore/priceLists/{priceListKey}/description

PUT Set IsActive PriceList

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

The following elements are required:

priceListKey	(string) The key for the price list.
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/priceLists/{priceListKey}/isActive

PUT /salesCore/priceLists/{priceListKey}/isActive

PUT Set PosInSalesItemsList PriceList

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

The following elements are required:

priceListKey	(string) The key for the price list.
value	(int) 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/priceLists/{priceListKey}/posInSalesItemsList

PUT /salesCore/priceLists/{priceListKey}/posInSalesItemsList

PUT Set PriceListKey PriceList

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

The following elements are required:

priceListKey	(string) The key for the price list.
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/priceLists/{priceListKey}/priceListKey

PUT /salesCore/priceLists/{priceListKey}/priceListKey

PUT Set TaxIncluded PriceList

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

The following elements are required:

priceListKey	(string) The key for the price list.
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/priceLists/{priceListKey}/taxIncluded

PUT /salesCore/priceLists/{priceListKey}/taxIncluded

PUT Set Custom Attribute PriceList

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

priceListKey	(string) The key for the price list.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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/priceLists/{priceListKey}/{customAttributeName}

PUT /salesCore/priceLists/{priceListKey}/{customAttributeName}

DELETE Operations

DELETE PriceList 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/priceLists/{id}

DELETE /salesCore/priceLists/{id}

DELETE PriceList by key

Deletes the entity record that matches the specified key.

The following elements are required:

priceListKey

(string) The key for the price list.

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/priceLists/{priceListKey}

DELETE /salesCore/priceLists/{priceListKey}

Resources

ApiPriceListResource

The following elements are required:

priceListKey	(string) The key for the price list.
taxIncluded	(bool) The wheter the prices of this list have taxes included or not.
currency	(string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values.

The following elements are optional:

description	(string) The description for the price list.
posInSalesItemsList	(int) Position in the sales Items list.

PriceListResource

The following elements are required:

priceListKey	(string) The key for the price list.
taxIncluded	(bool) The wheter the prices of this list have taxes included or not.
currency	(string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.

The following elements are optional:

description	(string) The description for the price list.
posInSalesItemsList	(int) Position in the sales Items list.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.