Category links

API Links

InventoryDispatch

Action: POST

Endpoint: /api/InventoryDispatch

API Version 1.3

Request fields details
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

OrderID

string

Mandatory

Order number for an inventory. Valid values : 0-9 Example : 3478

Allowable Values:

19

DispatchDate

datetime

Mandatory

Date of inventory dispatch Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00

InvoiceNumber

string

Optional

Invoice Number Valid Values: A-Z 0-9 Example: AB987567757

ShippingMode

string

Optional

Shipping Method to send cards valid values 0=Standard 1=Priority 2=Overnight Example : 0

Allowable Values:

50

AWBNumber

string

Optional

Air Way Bill Number of an inventory transfer Valid values: 0-9 Example: 156463

Allowable Values:

50
Sample request body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "OrderID": "190083",
  "DispatchDate": "2025-01-14T00:00:00-05:00",
  "InvoiceNumber": "145654645",
  "ShippingMode": "1",
  "AWBNumber": "1210201901"
}
Response fields details
Fields Description

Message

string

Returns Error Message in case of Error.

Status

boolean

Returns result of API processing. If any error is found then value will be 'false' else 'true'.

ErrorCode

string

Returns Error Code in case of Error.

ResponseData

This is group of below data elements.

OrderID

string

Order number for an inventory. Valid values : 0-9 Example : 3478

Sample response body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "OrderID": "190083"
  }
}
POST /api/InventoryDispatch