FlexOps.Sdk 1.0.0

FlexOps .NET SDK

Official .NET client for the FlexOps multi-carrier shipping platform — typed, resource-based, async/await throughout.

Installation

dotnet add package FlexOps.Sdk

Quick start

The FlexOpsTypedClient is the primary entry point. It exposes 20 resource properties — one per Gateway domain — each with strongly-typed methods, XML doc comments, and CancellationToken support.

using FlexOps.Sdk;

using var client = new FlexOpsTypedClient(
    baseUrl: "https://gateway.flexops.io",
    apiKey: "fxk_test_...",      // sandbox key — see below
    workspaceId: "ws_abc123"
);

// Rate shop across all connected carriers
var rates = await client.Shipping.GetRatesAsync(new
{
    fromAddress = new { street1 = "123 Main St", city = "New York",   state = "NY", zip = "10001", country = "US" },
    toAddress   = new { street1 = "456 Oak Ave", city = "Los Angeles", state = "CA", zip = "90210", country = "US" },
    parcel      = new { weight  = 16, weightUnit = "oz" }
});

// Cheapest rate only
var cheapest = await client.Shipping.GetCheapestRateAsync(new { /* same shape */ });

// Buy a label
var label = await client.Shipping.CreateLabelAsync(new
{
    carrier = "USPS",
    service = "PRIORITY_MAIL",
    fromAddress = new { /* ... */ },
    toAddress   = new { /* ... */ },
    parcel      = new { weight = 16, weightUnit = "oz" }
});

// Track
var tracking = await client.Shipping.TrackAsync("9400111899223456789012");

// Create a return
var rma = await client.Returns.CreateRmaAsync(new { originalShipmentId = label!.Data!.Id, reason = "wrong_size" });

Resources

The typed client exposes:

Authentication

Workspace API key (recommended)

using var client = new FlexOpsTypedClient(
    "https://gateway.flexops.io",
    apiKey: "fxk_live_...",
    workspaceId: "ws_abc123");

JWT bearer token

using var client = new FlexOpsTypedClient("https://gateway.flexops.io");
client.SetAccessToken("eyJhbGciOi...");
client.WorkspaceId = "ws_abc123";

Custom HttpClient

Useful for IHttpClientFactory, custom handlers (telemetry, retries), or DI:

var httpClient = new HttpClient { BaseAddress = new Uri("https://gateway.flexops.io/") };
using var client = new FlexOpsTypedClient(
    "https://gateway.flexops.io",
    apiKey: "fxk_live_...",
    httpClient: httpClient);

Sandbox

Use an fxk_test_... API key instead of fxk_live_... to hit the sandbox. Mock carriers respond, no real charges, no real labels — useful for CI, integration tests, and demos. Tracking numbers are prefixed SBOX... so you can tell them apart from production.

Advanced: lower-level HTTP client

FlexOpsClient is the underlying HTTP client used by every resource. Use it directly when you need an endpoint that hasn't been wrapped yet, or when you want to call a future endpoint without waiting for a SDK release.

using var client = new FlexOpsClient(
    "https://gateway.flexops.io",
    apiKey: "fxk_live_...",
    workspaceId: "ws_abc123");

// Path helpers: WsPath() prefixes with /api/workspaces/{workspaceId}/
var custom = await client.PostAsync<ApiResponse<MyType>>(
    client.WsPath("some/new/endpoint"),
    new { /* payload */ });

FlexOpsTypedClient wraps FlexOpsClient and forwards auth + workspace context, so you can mix and match if needed.

Curl quickstart

If you'd rather verify the API directly before wiring the SDK:

# Rate shop
curl -X POST https://gateway.flexops.io/api/workspaces/ws_abc123/shipping/rates \
  -H "X-API-Key: fxk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "fromAddress": {"street1": "123 Main St", "city": "New York",   "state": "NY", "zip": "10001", "country": "US"},
    "toAddress":   {"street1": "456 Oak Ave", "city": "Los Angeles", "state": "CA", "zip": "90210", "country": "US"},
    "parcel":      {"weight": 16, "weightUnit": "oz"}
  }'

# Buy a label
curl -X POST https://gateway.flexops.io/api/workspaces/ws_abc123/shipping/labels \
  -H "X-API-Key: fxk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "carrier":  "USPS",
    "service":  "PRIORITY_MAIL",
    "fromAddress": {"name": "Warehouse", "street1": "123 Main St", "city": "New York",   "state": "NY", "zip": "10001", "country": "US"},
    "toAddress":   {"name": "Customer",  "street1": "456 Oak Ave", "city": "Los Angeles", "state": "CA", "zip": "90210", "country": "US"},
    "parcel":   {"weight": 16, "weightUnit": "oz"}
  }'

# Track
curl https://gateway.flexops.io/api/workspaces/ws_abc123/shipping/track/9400111899223456789012 \
  -H "X-API-Key: fxk_test_..."

Requirements

• .NET 10.0 or higher

Links

• FlexOps Platform
• API Reference — interactive Scalar reference
• Quickstart guide — first label in 5 minutes
• Source on GitHub

License

MIT