Jasmin Developers - Web API Reference

Sales | Change Sales Item

Overview


URL api/{tenantKey}/{orgKey}/salesCore/changeSalesItems
Methods Supported POST, GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Change Sales Item

Returns the list of entity records that can be processed by the 'SalesItems' service.

The following elements are required:

pageIndex (int) The index of the page of the list that should be returned.
pageSize (int) The number of page elements that should be returned (max. is 1000).

The following elements are optional:

toApplyItemTaxSchema (string) Item Tax Schema This is a query string parameter.
descriptionFilter (string) Description This is a query string parameter.
assortmentFilter (string) Assortment This is a query string parameter.
brandFilter (string) Brand This is a query string parameter.
brandModelFilter (string) Brand Model This is a query string parameter.
itemTaxSchemaFilter (string) Item Tax Schema This is a query string parameter.

Response:

When successful, the response body contains the list of entity records available for processing. See ChangeSalesItemsLine.

Response status codes:

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

Resource URL:

GET /salesCore/changeSalesItems/{pageIndex}/{pageSize}?toApplyItemTaxSchema={toApplyItemTaxSchema}&descriptionFilter={descriptionFilter}&assortmentFilter={assortmentFilter}&brandFilter={brandFilter}&brandModelFilter={brandModelFilter}&itemTaxSchemaFilter={itemTaxSchemaFilter}

POST Operations

POST Change

Custom operation 'Change'.

The following elements are required:

apiChangeSalesItems (ApiChangeSalesItems) ApiChangeSalesItems.

Response:

When successful, the response body is empty.

Resource URL:

POST /salesCore/changeSalesItems/change

POST Change Sales Item

Instructs the 'SalesItems' service to process the specified entity records.

The following elements are required:

list (ChangeSalesItemsLine) List of the entity records that should be processed.
See ChangeSalesItemsLine.
companyKey (string) The company key.

Response:

When successful, the response body is empty. The URL of the processed items is returned in the response location header.

Response status codes:

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

Resource URL:

POST /salesCore/changeSalesItems/{companyKey}

Resources


ApiChangeSalesItems

The following elements are optional:

itemTaxSchema (string) Item Tax Schema.


ChangeSalesItems

The following elements are required:

selectedCount (int) Selected Count.

The following elements are optional:

toApplyItemTaxSchema (string) Item Tax Schema.
descriptionFilter (string) Description.
assortmentFilter (string) Assortment.
brandFilter (string) Brand.
brandModelFilter (string) Brand Model.
itemTaxSchemaFilter (string) Item Tax Schema.


ChangeSalesItemsLine

The following elements are required:

selected (bool) Selected.
item (string) Item.
description (string) Description.
itemTaxSchema (string) Item Tax Schema.