Zippendo .NET SDK

https://github.com/zippendo/zippendo-csharp
Admin
Official C#/.NET SDK for the Zippendo shipping and logistics API, enabling developers to book...
Tokens:560,542
Snippets:2,744
Trust Score:7.5
License:MIT
Update:6 days ago
Show doc for...
Tokens:
Raw
### Install Zippendo package with dotnet add

Source: https://github.com/zippendo/zippendo-csharp/blob/main/README.md

Adds the Zippendo NuGet package to a .NET project. Requires the .NET CLI and a project file.

```sh
dotnet add package Zippendo
```

--------------------------------

### GET /orgs/{orgId}/brands/{brandId}/logo

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/BrandsApi.md

Gets a brand logo.

```APIDOC
## [GET] /orgs/{orgId}/brands/{brandId}/logo

### Description
Gets a brand logo.

### Method
GET

### Endpoint
/orgs/{orgId}/brands/{brandId}/logo

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **brandId** (string) - Required - Brand ID

### Response
#### Success Response (200)
- **Default Response** - Default Response

#### Response Example
(Not provided)

### Error Handling
- **401** - Default Response
- **403** - Default Response
- **404** - Default Response
```

--------------------------------

### GET /orgs/{orgId}/brands/{brandId}

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/BrandsApi.md

Gets a brand.

```APIDOC
## [GET] /orgs/{orgId}/brands/{brandId}

### Description
Gets a brand.

### Method
GET

### Endpoint
/orgs/{orgId}/brands/{brandId}

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **brandId** (string) - Required - Brand ID

### Response
#### Success Response (200)
- **Default Response** - Default Response

#### Response Example
(Not provided)

### Error Handling
- **401** - Default Response
- **403** - Default Response
- **404** - Default Response
```

--------------------------------

### Create an order with order lines

Source: https://github.com/zippendo/zippendo-csharp/blob/main/README.md

Creates an order using `IOrdersApi.CreateOrderAsync` with a `CreateOrderRequest` containing an order number, channel ID, and order lines. Prints the created order's ID via `response.Created()?.Id`.

```csharp
using Zippendo.Model;

var orders = provider.GetRequiredService<IOrdersApi>();
var response = await orders.CreateOrderAsync("org_8f3kd92ld0", new CreateOrderRequest(
    orderNumber: "1001",
    orderChannelId: "chan_7d2k1",
    orderLines: new List<CreateOrderRequestOrderLinesInner>
    {
        new CreateOrderRequestOrderLinesInner(name: "T-shirt", quantity: 2)
    }));
Console.WriteLine(response.Created()?.Id);
```

--------------------------------

### GET /orgs/{orgId}/carriers/{carrierId}/products

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/CarriersApi.md

Lists products available for a specific carrier.

```APIDOC
## [GET] /orgs/{orgId}/carriers/{carrierId}/products

### Description
Lists products available for a specific carrier.

### Method
GET

### Endpoint
/orgs/{orgId}/carriers/{carrierId}/products

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **carrierId** (string) - Required - Carrier ID

### Response
#### Success Response (200)
- **data** (array) - List of carrier products

#### Response Example
{
  "data": []
}

### Error Handling
- **400** - Default Response
- **403** - Default Response
- **404** - Default Response
```

--------------------------------

### List shipments with pagination and check response

Source: https://github.com/zippendo/zippendo-csharp/blob/main/README.md

List endpoints accept `page` (1-based) and `limit`, returning a page with `Data` plus `Total`, `Page`, `Limit`, and `TotalPages`. Responses do not throw on HTTP error, so check the result with `TryOk`.

```csharp
var response = await shipments.ListShipmentsAsync("org_8f3kd92ld0", page: 1, limit: 50);
if (response.TryOk(out var result) && result != null)
{
    Console.WriteLine($"{result.Data.Count} of {result.Total} ({result.TotalPages} pages)");
}
```

--------------------------------

### Register Zippendo API clients with dependency injection

Source: https://github.com/zippendo/zippendo-csharp/blob/main/README.md

Configures the Zippendo API client with a Bearer token from the ZIPPENDO_API_TOKEN environment variable. Requires the Zippendo, Zippendo.Api, Zippendo.Client, and Zippendo.Extensions namespaces. The base URL defaults to https://api.zippendo.com.

```csharp
using Microsoft.Extensions.DependencyInjection;
using Zippendo.Api;
using Zippendo.Client;
using Zippendo.Extensions;

var services = new ServiceCollection();
services.AddLogging();
services.AddApi(options =>
{
    options.AddTokens(new BearerToken(Environment.GetEnvironmentVariable("ZIPPENDO_API_TOKEN")!));
});

var provider = services.BuildServiceProvider();
var shipments = provider.GetRequiredService<IShipmentsApi>();
```

--------------------------------

### GET /orgs/{orgId}/shipping-rules

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/RulesApi.md

Lists all shipping rules for an organization. Requires bearer authentication.

```APIDOC
## [GET] /orgs/{orgId}/shipping-rules

### Description
Lists all shipping rules for an organization.

### Method
GET

### Endpoint
/orgs/{orgId}/shipping-rules

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

### Response
#### Success Response (200)
- **List<ShippingRule>** - List of shipping rules

#### Response Example
[
  {}
]

### Authorization
bearerAuth

### HTTP request headers
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Default Response |  -  |
| **400** | Default Response |  -  |
| **403** | Default Response |  -  |
| **404** | Default Response |  -  |
```

--------------------------------

### Handle API errors by parsing the error code

Source: https://github.com/zippendo/zippendo-csharp/blob/main/README.md

Non-2xx responses have `IsSuccessStatusCode` false and Zippendo's canonical `{ code, error, message }` body in `RawContent`. Branch on the machine-readable `code` by parsing `RawContent` with `JsonDocument`.

```csharp
using System.Text.Json;

var response = await shipments.GetShipmentAsync("org_8f3kd92ld0", "shp_missing");
if (!response.IsSuccessStatusCode)
{
    using var body = JsonDocument.Parse(response.RawContent);
    var code = body.RootElement.GetProperty("code").GetString();
    Console.Error.WriteLine($"{(int)response.StatusCode} {code}"); // e.g. "404 SHIPMENT_NOT_FOUND"
}
```

--------------------------------

### Configure API HTTP clients with BaseAddress and retry/timeout policies

Source: https://github.com/zippendo/zippendo-csharp/blob/main/README.md

Sets the client's BaseAddress to a staging environment and configures each client's IHttpClientBuilder with retry and timeout policies. The default token provider spaces requests made with one token at least 40 ms apart; pass a shorter timeout to BearerToken to change that.

```csharp
options.AddApiHttpClients(
    client => client.BaseAddress = new Uri("https://staging.api.zippendo.com"),
    builder => builder.AddRetryPolicy(2).AddTimeoutPolicy(TimeSpan.FromSeconds(30)));
```

--------------------------------

### GET /orgs/{orgId}/brands

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/BrandsApi.md

Lists brands.

```APIDOC
## [GET] /orgs/{orgId}/brands

### Description
Lists brands.

### Method
GET

### Endpoint
/orgs/{orgId}/brands

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

### Response
#### Success Response (200)
- **Default Response** - Default Response

#### Response Example
(Not provided)

### Error Handling
- **401** - Default Response
- **403** - Default Response
- **404** - Default Response
```

--------------------------------

### GET /orgs/{orgId}/webhooks

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/WebhooksApi.md

Lists all webhooks for an organization.

```APIDOC
## [GET] /orgs/{orgId}/webhooks

### Description
List webhooks for an organization.

### Method
GET

### Endpoint
/orgs/{orgId}/webhooks

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

### Response
#### Success Response (200)
- **webhooks** (array) - List of webhook objects

#### Response Example
{
  "webhooks": [
    {
      "id": "wh_123",
      "url": "https://example.com/hook"
    }
  ]
}

### Error Responses
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
```

--------------------------------

### GET /orgs/{orgId}/branding

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/OrgsApi.md

Retrieves the branding settings for an org.

```APIDOC
## GET /orgs/{orgId}/branding

### Description
Get org branding

### Method
GET

### Endpoint
/orgs/{orgId}/branding

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

### Response
#### Success Response (200)
- **GetOrgBranding200Response** - Default Response

#### Response Example
(No response body example provided)

### Authorization
bearerAuth

### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Default Response |  -  |
| **404** | Default Response |  -  |
```

--------------------------------

### GET /orgs/{orgId}/branding/logo

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/OrgsApi.md

Downloads the org logo.

```APIDOC
## GET /orgs/{orgId}/branding/logo

### Description
Download org logo

### Method
GET

### Endpoint
/orgs/{orgId}/branding/logo

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

### Response
#### Success Response (200)
- **GetOrgLogo200Response** - Default Response

#### Response Example
(No response body example provided)

### Authorization
bearerAuth

### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Default Response |  -  |
| **404** | Default Response |  -  |
```

--------------------------------

### GET /orgs/{id}

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/OrgsApi.md

Retrieves an org by its ID.

```APIDOC
## GET /orgs/{id}

### Description
Get org

### Method
GET

### Endpoint
/orgs/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Organization ID

### Response
#### Success Response (200)
- **GetOrg200Response** - Default Response

#### Response Example
(No response body example provided)

### Authorization
bearerAuth

### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Default Response |  -  |
| **404** | Default Response |  -  |
```

--------------------------------

### GET /orgs/{orgId}/brands/check-slug/{slug}

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/BrandsApi.md

Checks brand slug availability.

```APIDOC
## [GET] /orgs/{orgId}/brands/check-slug/{slug}

### Description
Checks brand slug availability.

### Method
GET

### Endpoint
/orgs/{orgId}/brands/check-slug/{slug}

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **slug** (string) - Required - Brand slug

### Response
#### Success Response (200)
- **Default Response** - Default Response

#### Response Example
(Not provided)

### Error Handling
- **401** - Default Response
- **403** - Default Response
- **404** - Default Response
```

--------------------------------

### Use Zippendo API client in a .NET host

Source: https://github.com/zippendo/zippendo-csharp/blob/main/src/Zippendo/README.md

Example of using the generated Zippendo API client in a .NET application. It shows how to configure the API client with a BearerToken, set up retry, timeout, and circuit breaker policies, and call an API method. The token type depends on the API security specifications; available types are ApiKeyToken, BasicToken, BearerToken, HttpSigningToken, and OAuthToken.

```csharp
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.DependencyInjection;
using Zippendo.Api;
using Zippendo.Client;
using Zippendo.Model;
using Org.OpenAPITools.Extensions;

namespace YourProject
{
    public class Program
    {
        public static async Task Main(string[] args)
        {
            var host = CreateHostBuilder(args).Build();
            var api = host.Services.GetRequiredService<IAddressesApi>();
            ICreateAddressApiResponse apiResponse = await api.CreateAddressAsync("todo");
            ListAddresses200ResponseDataInner? model = apiResponse.Ok();
        }

        public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args)
          .ConfigureApi((context, options) =>
          {
              // The type of token here depends on the api security specifications
              // Available token types are ApiKeyToken, BasicToken, BearerToken, HttpSigningToken, and OAuthToken.
              BearerToken token = new("<your token>");
              options.AddTokens(token);

              // optionally choose the method the tokens will be provided with, default is RateLimitProvider
              options.UseProvider<RateLimitProvider<BearerToken>, BearerToken>();

              options.ConfigureJsonOptions((jsonOptions) =>
              {
                  // your custom converters if any
              });

              options.AddApiHttpClients(client =>
              {
                  // client configuration
              }, builder =>
              {
                  builder
                      .AddRetryPolicy(2)
                      .AddTimeoutPolicy(TimeSpan.FromSeconds(5))
                      .AddCircuitBreakerPolicy(10, TimeSpan.FromSeconds(30));
                      // add whatever middleware you prefer
                  }
              );
          });
    }
}
```

--------------------------------

### Configure HttpClient with X-Zippendo-Brand header

Source: https://github.com/zippendo/zippendo-csharp/blob/main/README.md

Sets the X-Zippendo-Brand header on the HttpClient so every API call inherits the brand context. Configuring the HttpClient replaces the default that sets the base URL, so BaseAddress must be set explicitly. The header value is the brand's ID or slug.

```csharp
services.AddApi(options =>
{
    options.AddTokens(new BearerToken(token));
    options.AddApiHttpClients(client =>
    {
        // Configuring the HttpClient replaces the default that sets the base URL, so set it here too.
        client.BaseAddress = new Uri(ClientUtils.BASE_ADDRESS);
        client.DefaultRequestHeaders.Add("X-Zippendo-Brand", "acme"); // brand ID or slug
    });
});
```

--------------------------------

### GET /health

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/SystemApi.md

Performs a health check on the service. Returns the service health status, current timestamp, and version.

```APIDOC
## [GET] /health

### Description
Performs a health check on the service. Returns the service health status, current timestamp, and version.

### Method
GET

### Endpoint
/health

### Parameters
This endpoint does not need any parameter.

### Response
#### Success Response (200)
- **HealthCheck200Response** - The health check response containing status, timestamp, and version.

#### Response Example
```json
{
  "status": "ok",
  "timestamp": "2023-01-01T00:00:00Z",
  "version": "1.0.0"
}
```

### Authorization
bearerAuth

### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
```

--------------------------------

### GetOrgWebhook

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/WebhooksApi.md

Get a specific webhook including its signing secret. Requires bearer authentication.

```APIDOC
## GET /orgs/{orgId}/webhooks/{webhookId}

### Description
Get a specific webhook including its signing secret.

### Method
GET

### Endpoint
/orgs/{orgId}/webhooks/{webhookId}

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **webhookId** (string) - Required - Webhook ID

### Request Example
(No request body)

### Response
#### Success Response (200)
- **CreateOrgWebhook201Response** - Default Response

#### Response Example
(No response body example provided)

### Error Handling
- **401** - Default Response
- **403** - Default Response
- **404** - Default Response

### Authorization
bearerAuth
```

--------------------------------

### GET /orgs/{orgId}/shipping-rules/{ruleId}

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/RulesApi.md

Retrieves a shipping rule by its ID. Requires bearer authentication.

```APIDOC
## [GET] /orgs/{orgId}/shipping-rules/{ruleId}

### Description
Retrieves a shipping rule by its ID.

### Method
GET

### Endpoint
/orgs/{orgId}/shipping-rules/{ruleId}

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **ruleId** (string) - Required - Shipping rule ID

### Response
#### Success Response (200)
- **ShippingRule** - The shipping rule details

#### Response Example
{
  "ShippingRule": {}
}

### Authorization
bearerAuth

### HTTP request headers
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Default Response |  -  |
| **400** | Default Response |  -  |
| **403** | Default Response |  -  |
| **404** | Default Response |  -  |
```

--------------------------------

### GET /orgs/{orgId}/webhooks/{webhookId}

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/WebhooksApi.md

Retrieves details of a specific webhook.

```APIDOC
## [GET] /orgs/{orgId}/webhooks/{webhookId}

### Description
Get a webhook by ID.

### Method
GET

### Endpoint
/orgs/{orgId}/webhooks/{webhookId}

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **webhookId** (string) - Required - Webhook ID

### Response
#### Success Response (200)
- **id** (string) - Webhook ID
- **url** (string) - Webhook URL
- **events** (array) - Subscribed events

#### Response Example
{
  "id": "wh_123",
  "url": "https://example.com/hook",
  "events": ["order.created"]
}

### Error Responses
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
```

--------------------------------

### GET /orgs/{orgId}/addresses

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/AddressesApi.md

Lists all addresses for an organization.

```APIDOC
## GET /orgs/{orgId}/addresses

### Description
Lists all addresses for an organization.

### Method
GET

### Endpoint
/orgs/{orgId}/addresses

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

### Response
#### Success Response (200)
- **ListAddresses200ResponseDataInner** - A list of addresses.

#### Response Example
```json
{
  "data": []
}
```

### Error Responses
- **400** - Default Response
- **403** - Default Response
- **404** - Default Response

### Authorization
bearerAuth

### HTTP request headers
- **Accept**: application/json
```

--------------------------------

### GET /orgs/{orgId}/webhooks/{webhookId}/deliveries

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/WebhooksApi.md

Lists all deliveries for a specific webhook.

```APIDOC
## [GET] /orgs/{orgId}/webhooks/{webhookId}/deliveries

### Description
List webhook deliveries.

### Method
GET

### Endpoint
/orgs/{orgId}/webhooks/{webhookId}/deliveries

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **webhookId** (string) - Required - Webhook ID

### Response
#### Success Response (200)
- **deliveries** (array) - List of delivery objects

#### Response Example
{
  "deliveries": [
    {
      "id": "del_123",
      "status": "delivered"
    }
  ]
}

### Error Responses
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
```

--------------------------------

### GET /orgs/{orgId}/api-tokens

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/TokensApi.md

Lists all API tokens for the specified organization.

```APIDOC
## [GET] /orgs/{orgId}/api-tokens

### Description
Lists all API tokens for the specified organization.

### Method
GET

### Endpoint
/orgs/{orgId}/api-tokens

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

### Response
#### Success Response (200)
- **ListApiTokensResponse** - List of API tokens

#### Response Example
```json
{
  "ListApiTokensResponse": []
}
```

### Authorization
bearerAuth

### HTTP request headers
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Default Response |  -  |
| **401** | Default Response |  -  |
| **403** | Default Response |  -  |
```

--------------------------------

### GET /orgs/{orgId}/order-channels

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/OrderChannelsApi.md

Lists all order channels for an organization. Requires bearer authentication.

```APIDOC
## [GET] /orgs/{orgId}/order-channels

### Description
List order channels.

### Method
GET

### Endpoint
/orgs/{orgId}/order-channels

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

### Response
#### Success Response (200)
- **ListOrderChannels200ResponseDataInner** - List of order channels

#### Response Example
{
  "data": []
}

### Error Responses
- **400** - Default Response
- **403** - Default Response

### Authorization
bearerAuth

### HTTP Request Headers
- **Accept**: application/json
```

--------------------------------

### GET /orgs/{orgId}/available-carriers

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/CarrierCatalogApi.md

Lists the carriers available to connect, as supported by the carrier server. This endpoint returns a list of available carriers for a given organization.

```APIDOC
## [GET] /orgs/{orgId}/available-carriers

### Description
Returns the carriers available to connect, as supported by the carrier server.

### Method
GET

### Endpoint
/orgs/{orgId}/available-carriers

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

### Response
#### Success Response (200)
- **List<ListAvailableCarriers200ResponseInner>** - List of available carriers

#### Response Example
```json
[
  {
    "id": "string",
    "name": "string"
  }
]
```

### Authorization
bearerAuth

### HTTP request headers
- **Accept**: application/json

### HTTP response details
| Status code | Description |
|-------------|-------------|
| **200** | Default Response |
| **403** | Default Response |
| **404** | Default Response |
| **500** | Default Response |
```

--------------------------------

### GET /orgs/{orgId}/order-channels/{channelId}

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/OrderChannelsApi.md

Retrieves details of a specific order channel. Requires bearer authentication.

```APIDOC
## [GET] /orgs/{orgId}/order-channels/{channelId}

### Description
Get order channel.

### Method
GET

### Endpoint
/orgs/{orgId}/order-channels/{channelId}

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **channelId** (string) - Required - Order channel ID

### Response
#### Success Response (200)
- **ListOrderChannels200ResponseDataInner** - Order channel details

#### Response Example
{
  "data": {}
}

### Error Responses
- **400** - Default Response
- **403** - Default Response

### Authorization
bearerAuth

### HTTP Request Headers
- **Accept**: application/json
```

--------------------------------

### GET /orgs/{orgId}/billing/usage

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/BillingApi.md

Retrieves detailed usage statistics for the current billing period for a specific organization. Requires bearer authentication.

```APIDOC
## GET /orgs/{orgId}/billing/usage

### Description
Get detailed usage statistics for the current billing period.

### Method
GET

### Endpoint
/orgs/{orgId}/billing/usage

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

### Response
#### Success Response (200)
- **GetBillingUsage200Response** - The usage statistics for the billing period.

#### Response Example
```json
{
  "example": "response body"
}
```

### Authorization
bearerAuth

### HTTP Request Headers
- **Accept**: application/json

### HTTP Response Details
| Status Code | Description |
|-------------|-------------|
| 200 | Default Response |
| 401 | Default Response |
| 403 | Default Response |
```

--------------------------------

### GET /orgs/{orgId}/shipments/{shipmentId}

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/ShipmentsApi.md

Get shipment. This endpoint retrieves a specific shipment.

```APIDOC
## GET /orgs/{orgId}/shipments/{shipmentId}

### Description
Get shipment.

### Method
GET

### Endpoint
/orgs/{orgId}/shipments/{shipmentId}

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **shipmentId** (string) - Required - Shipment ID

```

--------------------------------

### GET /orgs/{orgId}/shipments/{shipmentId}/tracking

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/ShipmentsApi.md

Get shipment tracking. This endpoint retrieves tracking information for a shipment.

```APIDOC
## GET /orgs/{orgId}/shipments/{shipmentId}/tracking

### Description
Get shipment tracking.

### Method
GET

### Endpoint
/orgs/{orgId}/shipments/{shipmentId}/tracking

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **shipmentId** (string) - Required - Shipment ID

```

--------------------------------

### Generate C# library with OpenAPI Generator config.yaml

Source: https://github.com/zippendo/zippendo-csharp/blob/main/src/Zippendo/README.md

Configuration file for generating the C# client library. Run the command `java -jar "<path>/openapi-generator/modules/openapi-generator-cli/target/openapi-generator-cli.jar" generate -c config.yaml` to generate the library. The `packageGuid` is required for C# generation.

```yaml
generatorName: csharp
inputSpec: /local/openapi.csharp.json
outputDir: out

# https://openapi-generator.tech/docs/generators/csharp
additionalProperties:
  packageGuid: '{52B08D70-7036-4EEB-B17C-D6E165DD6365}'

# https://openapi-generator.tech/docs/integrations/#github-integration
# gitHost:
# gitUserId:
# gitRepoId:

# https://openapi-generator.tech/docs/globals
# globalProperties:

# https://openapi-generator.tech/docs/customization/#inline-schema-naming
# inlineSchemaOptions:

# https://openapi-generator.tech/docs/customization/#name-mapping
# modelNameMappings:
# nameMappings:

# https://openapi-generator.tech/docs/customization/#openapi-normalizer
# openapiNormalizer:

# templateDir: https://openapi-generator.tech/docs/templating/#modifying-templates

# releaseNote:
```

--------------------------------

### GET /orgs/{orgId}/carriers

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/CarriersApi.md

Lists all carriers connected to the organization.

```APIDOC
## [GET] /orgs/{orgId}/carriers

### Description
Lists all carriers connected to the organization.

### Method
GET

### Endpoint
/orgs/{orgId}/carriers

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

### Response
#### Success Response (200)
- **data** (array) - List of carriers

#### Response Example
{
  "data": []
}

### Error Handling
- **400** - Default Response
- **403** - Default Response
- **404** - Default Response
```

--------------------------------

### CreateOrgBrand

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/BrandsApi.md

Creates a brand (sub-account) in the organization. The slug is derived from the name when omitted. Requires a plan that includes brands.

```APIDOC
## CreateOrgBrand

### Description
Creates a brand (sub-account) in the organization. The slug is derived from the name when omitted. Requires a plan that includes brands.

### Method
POST

### Endpoint
/orgs/{orgId}/brands

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

#### Request Body
- **createOrgBrandRequest** (CreateOrgBrandRequest) - Required - The request body

### Request Example
{
  "example": "request body"
}

### Response
#### Success Response (201)
- **ListOrgBrands200ResponseDataInner** - Default Response

#### Response Example
{
  "example": "response body"
}

### Error Responses
- **401** - Default Response
- **403** - Default Response
- **409** - Default Response

### Authorization
bearerAuth

### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
```

--------------------------------

### TestOrgWebhook

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/WebhooksApi.md

Sends a test ping event to the webhook endpoint to verify connectivity. Requires organization ID and webhook ID.

```APIDOC
## TestOrgWebhook

### Description
Send a test ping event to the webhook endpoint to verify connectivity.

### Method
POST

### Endpoint
/orgs/{orgId}/webhooks/{webhookId}/test

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **webhookId** (string) - Required - Webhook ID

### Request Example
(No request body)

### Response
#### Success Response (200)
- **TestOrgWebhook200Response** - Default Response

#### Response Example
(Not provided)

### Error Responses
- **401** - Default Response
- **403** - Default Response
- **404** - Default Response

```

--------------------------------

### GET /orgs/{orgId}/carriers/{carrierId}

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/CarriersApi.md

Retrieves a specific carrier by ID.

```APIDOC
## [GET] /orgs/{orgId}/carriers/{carrierId}

### Description
Retrieves a specific carrier by ID.

### Method
GET

### Endpoint
/orgs/{orgId}/carriers/{carrierId}

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **carrierId** (string) - Required - Carrier ID

### Response
#### Success Response (200)
- **data** (ListCarriers200ResponseDataInner) - The carrier details

#### Response Example
{
  "data": {}
}

### Error Handling
- **400** - Default Response
- **403** - Default Response
- **404** - Default Response
```

--------------------------------

### GetOrgBranding

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/OrgsApi.md

Returns the org's brand colors and an authenticated URL to download the logo.

```APIDOC
## GET /orgs/{orgId}/branding

### Description
Returns the org's brand colors and an authenticated URL to download the logo.

### Method
GET

### Endpoint
/orgs/{orgId}/branding

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

### Response
#### Success Response (200)
- **GetOrgBranding200Response** - Default Response

#### Response Example
```json
{
  "orgId": "string",
  "brandColors": {
    "primary": "string",
    "secondary": "string"
  },
  "logoUrl": "string"
}
```

#### Error Response (404)
- **Default Response**
```

--------------------------------

### POST /orgs/{orgId}/shipping-rules

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/RulesApi.md

Creates a new shipping rule with conditions and carrier product for the organization. Requires bearer authentication.

```APIDOC
## [POST] /orgs/{orgId}/shipping-rules

### Description
Creates a new shipping rule with conditions and carrier product for the organization.

### Method
POST

### Endpoint
/orgs/{orgId}/shipping-rules

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

#### Request Body
- **createShippingRuleRequest** (CreateShippingRuleRequest) - Required - The shipping rule details

### Request Example
{
  "createShippingRuleRequest": {}
}

### Response
#### Success Response (201)
- **CreateShippingRule201Response** - The created shipping rule

#### Response Example
{
  "CreateShippingRule201Response": {}
}

### Authorization
bearerAuth

### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **201** | Default Response |  -  |
| **400** | Default Response |  -  |
| **403** | Default Response |  -  |
| **404** | Default Response |  -  |
```

--------------------------------

### PATCH /orgs/{orgId}/webhooks/{webhookId}

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/WebhooksApi.md

Updates an existing webhook's configuration.

```APIDOC
## [PATCH] /orgs/{orgId}/webhooks/{webhookId}

### Description
Update a webhook's configuration.

### Method
PATCH

### Endpoint
/orgs/{orgId}/webhooks/{webhookId}

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **webhookId** (string) - Required - Webhook ID

#### Request Body
- **url** (string) - Optional - New webhook URL
- **events** (array) - Optional - New list of subscribed events

### Request Example
{
  "url": "https://new-url.com/hook",
  "events": ["order.updated"]
}

### Response
#### Success Response (200)
- **id** (string) - Webhook ID
- **url** (string) - Updated webhook URL
- **events** (array) - Updated subscribed events

#### Response Example
{
  "id": "wh_123",
  "url": "https://new-url.com/hook",
  "events": ["order.updated"]
}

### Error Responses
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
```

--------------------------------

### POST /orgs/{orgId}/brands

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/BrandsApi.md

Creates a brand.

```APIDOC
## [POST] /orgs/{orgId}/brands

### Description
Creates a brand.

### Method
POST

### Endpoint
/orgs/{orgId}/brands

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

### Response
#### Success Response (200)
- **Default Response** - Default Response

#### Response Example
(Not provided)

### Error Handling
- **401** - Default Response
- **403** - Default Response
- **404** - Default Response
```

--------------------------------

### POST /api-tokens/verify

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/TokensApi.md

Verifies an API token.

```APIDOC
## [POST] /api-tokens/verify

### Description
Verifies an API token.

### Method
POST

### Endpoint
/api-tokens/verify

### Parameters
#### Request Body
- **verifyApiTokenRequest** (VerifyApiTokenRequest) - Required - Request body for verifying an API token

### Request Example
```json
{
  "verifyApiTokenRequest": {}
}
```

### Response
#### Success Response (200)
- **VerifyApiTokenResponse** - Verification result

#### Response Example
```json
{
  "VerifyApiTokenResponse": {}
}
```

### Authorization
bearerAuth

### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Default Response |  -  |
| **401** | Default Response |  -  |
| **403** | Default Response |  -  |
```

--------------------------------

### GET /orgs/{orgId}/addresses/{addressId}

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/AddressesApi.md

Retrieves a specific address by its ID.

```APIDOC
## GET /orgs/{orgId}/addresses/{addressId}

### Description
Retrieves a specific address by its ID.

### Method
GET

### Endpoint
/orgs/{orgId}/addresses/{addressId}

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **addressId** (string) - Required - Address ID

### Response
#### Success Response (200)
- **ListAddresses200ResponseDataInner** - The address data.

#### Response Example
```json
{
  "data": {}
}
```

### Error Responses
- **400** - Default Response
- **403** - Default Response
- **404** - Default Response

### Authorization
bearerAuth

### HTTP request headers
- **Accept**: application/json
```

--------------------------------

### PUT /orgs/{id}

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/OrgsApi.md

Updates an existing org.

```APIDOC
## PUT /orgs/{id}

### Description
Update org

### Method
PUT

### Endpoint
/orgs/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Organization ID

### Request Body
(No request body details provided)

### Response
#### Success Response (200)
- **UpdateOrg200Response** - Default Response

#### Response Example
(No response body example provided)

### Authorization
bearerAuth

### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Default Response |  -  |
| **404** | Default Response |  -  |
```

--------------------------------

### GET /orgs/{orgId}/shipments

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/ShipmentsApi.md

List shipments. This endpoint lists all shipments for an organization.

```APIDOC
## GET /orgs/{orgId}/shipments

### Description
List shipments.

### Method
GET

### Endpoint
/orgs/{orgId}/shipments

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

```

--------------------------------

### POST /orgs/{orgId}/brands/{brandId}/unarchive

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/BrandsApi.md

Unarchives a brand.

```APIDOC
## [POST] /orgs/{orgId}/brands/{brandId}/unarchive

### Description
Unarchives a brand.

### Method
POST

### Endpoint
/orgs/{orgId}/brands/{brandId}/unarchive

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **brandId** (string) - Required - Brand ID

### Response
#### Success Response (200)
- **Default Response** - Default Response

#### Response Example
(Not provided)

### Error Handling
- **401** - Default Response
- **403** - Default Response
- **404** - Default Response
```

--------------------------------

### GET /orgs/{orgId}/orders

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/OrdersApi.md

Lists all orders for an organization. Requires bearer authentication.

```APIDOC
## GET /orgs/{orgId}/orders

### Description
Lists all orders for an organization.

### Method
GET

### Endpoint
/orgs/{orgId}/orders

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

### Response
#### Success Response (200)
- **List of Orders** - An array of order objects.

#### Response Example
```json
[
  {
    "id": "string",
    "status": "string"
  }
]
```

### Error Responses
- **400** - Default Response
- **403** - Default Response
- **404** - Default Response

### Authorization
bearerAuth

### HTTP Request Headers
- **Accept**: application/json
```

--------------------------------

### POST /orgs/{orgId}/webhooks/{webhookId}/test

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/WebhooksApi.md

Sends a test event to the webhook endpoint.

```APIDOC
## [POST] /orgs/{orgId}/webhooks/{webhookId}/test

### Description
Test a webhook by sending a test event.

### Method
POST

### Endpoint
/orgs/{orgId}/webhooks/{webhookId}/test

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **webhookId** (string) - Required - Webhook ID

### Response
#### Success Response (200)
- **status** (string) - Test result status

#### Response Example
{
  "status": "success"
}

### Error Responses
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
```

--------------------------------

### GET /orgs/{orgId}/api-tokens/{tokenId}

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/TokensApi.md

Retrieves a specific API token by its ID for the specified organization.

```APIDOC
## [GET] /orgs/{orgId}/api-tokens/{tokenId}

### Description
Retrieves a specific API token by its ID for the specified organization.

### Method
GET

### Endpoint
/orgs/{orgId}/api-tokens/{tokenId}

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **tokenId** (string) - Required - API token ID

### Response
#### Success Response (200)
- **GetApiTokenResponse** - The API token details

#### Response Example
```json
{
  "GetApiTokenResponse": {}
}
```

### Authorization
bearerAuth

### HTTP request headers
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Default Response |  -  |
| **401** | Default Response |  -  |
| **403** | Default Response |  -  |
```

--------------------------------

### POST /orgs/{orgId}/branding/logo

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/OrgsApi.md

Uploads an org logo.

```APIDOC
## POST /orgs/{orgId}/branding/logo

### Description
Upload org logo

### Method
POST

### Endpoint
/orgs/{orgId}/branding/logo

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

### Request Body
(No request body details provided)

### Response
#### Success Response (200)
- **UploadOrgLogo200Response** - Default Response

#### Response Example
(No response body example provided)

### Authorization
bearerAuth

### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Default Response |  -  |
| **404** | Default Response |  -  |
```

--------------------------------

### POST /orgs/{orgId}/brands/{brandId}/logo

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/BrandsApi.md

Uploads a brand logo.

```APIDOC
## [POST] /orgs/{orgId}/brands/{brandId}/logo

### Description
Uploads a brand logo.

### Method
POST

### Endpoint
/orgs/{orgId}/brands/{brandId}/logo

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **brandId** (string) - Required - Brand ID

### Response
#### Success Response (200)
- **Default Response** - Default Response

#### Response Example
(Not provided)

### Error Handling
- **401** - Default Response
- **403** - Default Response
- **404** - Default Response
```

--------------------------------

### GET /orgs/{orgId}/orders/{orderId}

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/OrdersApi.md

Retrieves a specific order by its ID. Requires bearer authentication.

```APIDOC
## GET /orgs/{orgId}/orders/{orderId}

### Description
Retrieves a specific order by its ID.

### Method
GET

### Endpoint
/orgs/{orgId}/orders/{orderId}

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **orderId** (string) - Required - Order ID

### Response
#### Success Response (200)
- **Order** - The order details.

#### Response Example
```json
{
  "id": "string",
  "status": "string"
}
```

### Error Responses
- **400** - Default Response
- **403** - Default Response
- **404** - Default Response

### Authorization
bearerAuth

### HTTP Request Headers
- **Accept**: application/json
```

--------------------------------

### GET /orgs/{orgId}/order-channels/{channelId}/webhooks

Source: https://github.com/zippendo/zippendo-csharp/blob/main/docs/apis/OrderChannelsApi.md

Retrieves the webhook status for an order channel. Requires bearer authentication.

```APIDOC
## [GET] /orgs/{orgId}/order-channels/{channelId}/webhooks

### Description
Get channel webhook status.

### Method
GET

### Endpoint
/orgs/{orgId}/order-channels/{channelId}/webhooks

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID
- **channelId** (string) - Required - Order channel ID

### Response
#### Success Response (200)
- **object** - Webhook status

#### Response Example
{
  "status": "active"
}

### Error Responses
- **400** - Default Response
- **403** - Default Response

### Authorization
bearerAuth

### HTTP Request Headers
- **Accept**: application/json
```
Tokens:
Raw