Category links

API Links

Get Inventory Class

Action: POST

Endpoint: /api/CoreCredit/ControlParameters/GetInventoryClass

Use this API to obtain the defined inventory class for inventory codes used for a sales transaction to make a post-sales transaction by using the inventory code and internal inventory class.

Request fields details
Fields Description

Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Mandatory

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

InventoryCode

string

Optional

These are unique ID for Inventory codes defined for any products/inventory to make post sales transaction. Valid Values:0-9, A-Z Format: Example:35519

Allowable Values:

255

InventoryClass

string

Optional

These are the classes defined for any products/inventory to make post sales transaction. Valid Values:0-9 Format: Example:1234

Allowable Values:

255

InternalInventoryClass

string

Optional

These are the internal ID for classes made based on Inventory Codes defined for any products/inventory to make post sales transaction. Valid Values:0-9, A-Z Example:6049 - Accessories

Allowable Values:

255

InventoryClassDescription

string

Optional

These are the description given for classes made based on Inventory Codes defined for any products/inventory to make post sales transaction. Valid Values:0-9, A-Z Example:Bags,Belts

Allowable Values:

255

BatchSize

integer

Optional

BatchSize

PageIndex

integer

Optional

PageIndex

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "InventoryCode": "35519",
  "InventoryClass": null,
  "InternalInventoryClass": "1030",
  "InventoryClassDescription": null,
  "BatchSize": null,
  "PageIndex": null
}
Response fields details
Fields Description

InventoryClassList

array

Inventory Class List

TotalCount

integer

This tag will show the total count of the Inventory Class wiith the respective search made. Valid Values:0-9 Example:12

Sample response body

{
  "Message": "Success.",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": {
    "InventoryClassList": [
      {
        "InventoryCode": "35519",
        "InventoryClass": "Andrisen",
        "InternalInventoryClass": "1030 = inventoryclass1",
        "InventoryClassDescription": "inventoryclass1"
      }
    ],
    "TotalCount": 1
  }
}