ExtensivSharp 1.3.0

ExtensivSharp

A C# client library for the Extensiv (formerly 3PL Central) Warehouse Management System REST API.

Features

• OAuth authentication with Extensiv's auth server
• Strongly-typed request/response models
• Fluent RQL (Resource Query Language) query builder
• Support for orders, inventory, items, and receivers endpoints
• Built for dependency injection with IHttpClientFactory

Requirements

• .NET 10.0 or later
• Extensiv API credentials (API key and user login)

Installation

dotnet add package ExtensivSharp

Dependencies

• Microsoft.Extensions.Http (v9.0.0)
• Newtonsoft.Json (v13.0.3)

Quick Start

Authentication

using ExtensivSharp.Services;
using ExtensivSharp.Models.Auth;

var authRequest = new ExtensivAuthRequest
{
    Key = "your-base64-encoded-api-key",
    UserId = "your-user-login"
};

var authResponse = await AuthenticationService.GetAuthenticationKey(authRequest);
string token = authResponse.AccessToken;

Fetching Orders

using ExtensivSharp.Endpoints.Orders;

var getOrders = new GET_Orders
{
    AuthorizationToken = token,
    PageSize = 50,
    PageNumber = 1,
    Detail = SpecifyDetailType.All
};

var result = await getOrders.GetAsync(httpClientFactory);

if (result.Success)
{
    foreach (var order in result.Data.ResourceList)
    {
        Console.WriteLine($"Order: {order.ReferenceNum}");
    }
}

Using the RQL Query Builder

The library includes a fluent query builder for Extensiv's Resource Query Language:

using ExtensivSharp.RQL;

var query = new RqlQueryBuilder()
    .Where("Status", "==", "Open")
    .Where("CreationDate", ">=", "2024-01-01")
    .In("Facility", "WH1", "WH2", "WH3")
    .HasValue("ShipDate", false)
    .Build();

var getOrders = new GET_Orders
{
    AuthorizationToken = token,
    RqlFilter = query
};

Available RQL Methods:

• Where(field, operator, value) - Add an AND condition
• Or(field, operator, value) - Add an OR condition
• In(field, values...) - Match any of the provided values
• NotIn(field, values...) - Exclude the provided values
• HasValue(field, bool) - Check if field has/doesn't have a value

Available Endpoints

Orders

Inventory

Items

Project Structure

ExtensivSharp/
├── Endpoints/
│   ├── Orders/        # Order-related API endpoints
│   ├── Inventory/     # Inventory and receiver endpoints
│   └── Items/         # Item master endpoints
├── Models/
│   ├── Auth/          # Authentication models
│   ├── Order/         # Order data models
│   ├── Inventory/     # Inventory models
│   ├── Items/         # Item models
│   ├── Receivers/     # Receiver models
│   ├── Generic/       # Shared identifier types
│   ├── Helper/        # API result wrapper and utilities
│   └── Webhooks/      # Webhook payload models
├── RQL/
│   └── RqlQueryBuilder.cs  # Fluent RQL query builder
└── Services/
    └── AuthenticationService.cs  # OAuth token generation

Response Handling

All endpoint methods return an ExtensivApiResult<T> wrapper:

public class ExtensivApiResult<T>
{
    public bool Success { get; set; }
    public HttpStatusCode StatusCode { get; set; }
    public string? Message { get; set; }
    public string? Etag { get; set; }
    public T? Data { get; set; }
}

API Documentation

For full API documentation, refer to the Extensiv API Reference or REL documentation

License

MIT License

Last Modified: 2026-04-06