Jasmin Developers - Web API Reference

Sales | Associate Sales Items To Sales Channel

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Associate Sales Items To Sales Channel

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).
salesChannel (string) Sales Channel.
defaultPriceList (string) Default Price List.

The following elements are optional:

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.

Response:

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

Response status codes:

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

Resource URL:

GET /salesCore/associateSalesItemsToSalesChannels/{pageIndex}/{pageSize}?descriptionFilter={descriptionFilter}&assortmentFilter={assortmentFilter}&brandFilter={brandFilter}&brandModelFilter={brandModelFilter}

POST Operations

POST Associate

Custom operation 'Associate'.

The following elements are required:

apiAssociateSalesItemsToSalesChannels (ApiAssociateSalesItemsToSalesChannels) ApiAssociateSalesItemsToSalesChannels.

Response:

When successful, the response body is empty.

Resource URL:

POST /salesCore/associateSalesItemsToSalesChannels/associate

POST Associate Sales Items To Sales Channel

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

The following elements are required:

list (AssociateSalesItemsToSalesChannelsLine) List of the entity records that should be processed.
See AssociateSalesItemsToSalesChannelsLine.
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/associateSalesItemsToSalesChannels/{companyKey}

Resources


ApiAssociateSalesItemsToSalesChannels

The following elements are required:

salesChannel (string) Sales Channel.


AssociateSalesItemsToSalesChannels

The following elements are required:

selectedCount (int) Selected Count.
salesChannel (string) Sales Channel.
defaultPriceList (string) Default Price List.

The following elements are optional:

descriptionFilter (string) Description.
assortmentFilter (string) Assortment.
brandFilter (string) Brand.
brandModelFilter (string) Brand Model.


AssociateSalesItemsToSalesChannelsLine

The following elements are required:

selected (bool) Selected.
item (string) Item.
description (string) Description.
priceList (string) Price List.
salesUnit (string) Sales Unit.
currency (string) Currency.
disablePriceChange (bool) Disable Price Change.

The following elements are optional:

price (decimal) Price.
isDefaultPriceList (bool) Is Default Price List.