ROSE Developers - Web API Reference

Sales | Item Info

The ItemInfos end point is used to get a summary of customers data.

Overview


URL api/{tenantKey}/{orgKey}/sales/itemInfos
Methods Supported GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Get Item Summary

Custom operation 'GetItemSummary'.

The following elements are required:

company (string) Company.
itemKey (string) ItemKey.

Response:

When successful, the response body contains a resource of type 'ItemSummary'. See ItemSummary.

Response status codes:

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

Resource URL:

GET /sales/itemInfos/getItemSummary/{company}

Resources


ItemSummary

The following elements are optional:

itemImage (string) Item Image.
item (string) Item.
itemTitle (string) Item Title.
salesVolume (string) Sales Volume.
salesVolumeTitle (string) Sales Volume Title.
salesVolumeSubTitle (string) Sales Volume Sub Title.
salesMargin (string) Sales Margin.
salesMarginTitle (string) Sales Margin Title.
stockQuantity (string) Stock Quantity.
stockQuantityTitle (string) Stock Quantity Title.
ordersQuantity (string) Orders Quantity.
ordersQuantityTitle (string) Orders Quantity Title.
lastSaleDate (string) Last Sale Date.
lastSaleDateTitle (string) Last Sale Date Title.