Jasmin Developers - Web API Reference

Sales | Price List

Service to manage entities of type 'PriceList'.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET PriceLists (odata)

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

The following elements are optional:

opts (ODataQueryOptions) OData query option.

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:

GET /salesCore/priceLists/odata

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:

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:

GET /salesCore/priceLists/{priceListKey}

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.

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:

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:

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:

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:

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:

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:

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:

PUT /salesCore/priceLists/{priceListKey}/taxIncluded

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:

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:

DELETE /salesCore/priceLists/{priceListKey}

Resources


ApiPriceListResource

The following elements are required:

priceListKey (string) The key for the price list.
taxIncluded (bool) Indicates 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) Indicates 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.