eConnect.PosSdk 3.0.4

eConnect PosSdk

.NET client for eConnect POS JsonApi.

Technologies

Project supports

• .NET 8.0 and above

Code Example

// sample authentication parameters
// production parameters provided by eConnect
var options = new PosClientOptions
{
    PluginId = "b510fb1f-124f-46dc-a7f3-cc9813755fa6",
    AuthId = Guid.NewGuid().ToString(),
    Host = "devcenter.econnect.tv",
    Port = 6500,
    UseSsl = true, // optional, defaults to true
    TcpTimeout = TimeSpan.FromMinutes(1), // optional, defaults to 1 minute
    EnableAutomaticRecovery = true, // optional, defaults to true
    ConnectionRetryDelay = TimeSpan.FromMinutes(3), // optional, defaults to 3 minutes
    // set KeepAliveInterval = Timespan.Zero to disable TCP KeepAlive messages being sent
    KeepAliveInterval = TimeSpan.FromMinutes(2) // optional, defaults to 2 minutes
};

await using var client = new PosClient(options);
await client.ConnectAsync();
// when using EnableAutomaticRecovery true, use this EventHandler to catch errors during Reconnect attempts
client.ReconnectError += (sender, exception) =>
            {
                // do some logging in here
            };

var signIn = new SignInEvent
{
    RevenueCenterNumber = 1,
    TerminalNumber = 123,
    EmployeeNumber = 456
};

string response = await client.SendAsync(signIn);
// response == "Valid signIn event object received."

var newCheck = new NewCheckEvent
{
    RevenueCenterNumber = 248,
    TerminalNumber = 1132,
    EmployeeNumber = 634277,
    CheckNumber = 237712
};
response = await client.SendAsync(newCheck);
// response == "Valid newcheck event object received"

var itemAdd = new ItemAddEvent
{
    RevenueCenterNumber = 248,
    TerminalNumber = 1132,
    EmployeeNumber = 634277,
    CheckNumber = 237712,
    ItemId = "049000608779",
    ItemName = "Apple (Golden Delicious)",
    Quantity = 1,
    Amount = 0.99M
};
response = await client.SendAsync(itemAdd);
// response == "Valid itemadd event object received"

var totalDue = new TotalDueEvent
{
    RevenueCenterNumber = 248,
    TerminalNumber = 1132,
    EmployeeNumber = 634277,
    CheckNumber = 237712,
    Amount = -.99M
};
response = await client.SendAsync(totalDue);
// response == "Valid totaldue event object received"

var tenderApply = new TenderApplyEvent
{
    RevenueCenterNumber = 248,
    TerminalNumber = 1132,
    EmployeeNumber = 634277,
    CheckNumber = 237712,
    TenderTypeNumber = 5,
    TenderTypeName = "Cash",
    Amount = 1M
};
response = await client.SendAsync(tenderApply);
// response == "Valid tenderapply event object received"

var changeDue = new ChangeDueEvent
{
    RevenueCenterNumber = 248,
    TerminalNumber = 1132,
    EmployeeNumber = 634277,
    CheckNumber = 237712,
    Amount = .01M
};
response = await client.SendAsync(changeDue);
// response == "Valid changedue event object received"

var closeCheck = new CloseCheckEvent
{
    RevenueCenterNumber = 11291,
    TerminalNumber = 88332,
    EmployeeNumber = 634277,
    CheckNumber = 237712
};
response = await client.SendAsync(closeCheck);
// response == "Valid closecheck event object received"

Testing

eConnect provides a TCP JSON API Test Service, showing sample credentials that work in combination with an online Testing Console.