@zippendo/sdk 1.0.2 → 1.1.0

package/docs/CheckBrandSlug200Response.md

@@ -0,0 +1,36 @@
+
+# CheckBrandSlug200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`slug` | string
+`available` | boolean
+
+## Example
+
+```typescript
+import type { CheckBrandSlug200Response } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "slug": acme,
+  "available": true,
+} satisfies CheckBrandSlug200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CheckBrandSlug200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateApiToken201Response.md

@@ -10,6 +10,7 @@ Name | Type
 `name` | string
 `tokenPrefix` | string
 `scopes` | Array<string>
+`brandId` | string
 `lastUsedAt` | string
 `expiresAt` | string
 `createdAt` | string
@@ -26,6 +27,7 @@ const example = {
   "name": Warehouse integration,
   "tokenPrefix": zipp_live_8f,
   "scopes": ["read:shipments","write:shipments"],
+  "brandId": brnd_8f3kd92ld0,
   "lastUsedAt": 2026-06-22T14:30:00.000Z,
   "expiresAt": 2026-09-20T14:30:00.000Z,
   "createdAt": 2026-06-22T14:30:00.000Z,

package/docs/CreateApiTokenRequest.md

@@ -9,6 +9,7 @@ Name | Type
 `name` | string
 `scopes` | Array<string>
 `expiresInDays` | number
+`brandId` | string
 
 ## Example
 
@@ -20,6 +21,7 @@ const example = {
   "name": Warehouse integration,
   "scopes": ["read:shipments","write:shipments"],
   "expiresInDays": 90,
+  "brandId": brnd_8f3kd92ld0,
 } satisfies CreateApiTokenRequest
 
 console.log(example)

package/docs/CreateOrgBrandRequest.md

@@ -0,0 +1,58 @@
+
+# CreateOrgBrandRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`companyName` | string
+`vatNumber` | string
+`customs` | { [key: string]: string; }
+`addressLine1` | string
+`addressLine2` | string
+`city` | string
+`postalCode` | string
+`country` | string
+`primaryColor` | string
+`secondaryColor` | string
+`name` | string
+`slug` | string
+`useOrgCustoms` | boolean
+
+## Example
+
+```typescript
+import type { CreateOrgBrandRequest } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "companyName": Acme ApS,
+  "vatNumber": DK12345678,
+  "customs": {"eori":"DK12345678"},
+  "addressLine1": Vestergade 12,
+  "addressLine2": 3. sal,
+  "city": København,
+  "postalCode": 1456,
+  "country": DK,
+  "primaryColor": #1D4ED8,
+  "secondaryColor": #F59E0B,
+  "name": Acme,
+  "slug": acme,
+  "useOrgCustoms": true,
+} satisfies CreateOrgBrandRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateOrgBrandRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListApiTokens200ResponseDataInner.md

@@ -10,6 +10,7 @@ Name | Type
 `name` | string
 `tokenPrefix` | string
 `scopes` | Array<string>
+`brandId` | string
 `lastUsedAt` | string
 `expiresAt` | string
 `createdAt` | string
@@ -26,6 +27,7 @@ const example = {
   "name": Warehouse integration,
   "tokenPrefix": zipp_live_8f,
   "scopes": ["read:shipments","write:shipments"],
+  "brandId": brnd_8f3kd92ld0,
   "lastUsedAt": 2026-06-22T14:30:00.000Z,
   "expiresAt": 2026-09-20T14:30:00.000Z,
   "createdAt": 2026-06-22T14:30:00.000Z,

package/docs/ListOrders200ResponseDataInner.md

@@ -11,6 +11,7 @@ Name | Type
 `customerName` | string
 `customerEmail` | string
 `status` | string
+`brandId` | string
 `subtotalAmount` | number
 `totalAmount` | number
 `currency` | string
@@ -31,6 +32,7 @@ const example = {
   "customerName": Anna Jensen,
   "customerEmail": anna@example.dk,
   "status": processing,
+  "brandId": brnd_8f3kd92ld0,
   "subtotalAmount": 998,
   "totalAmount": 1047,
   "currency": DKK,

package/docs/ListOrgBrands200Response.md

@@ -0,0 +1,34 @@
+
+# ListOrgBrands200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<ListOrgBrands200ResponseDataInner>](ListOrgBrands200ResponseDataInner.md)
+
+## Example
+
+```typescript
+import type { ListOrgBrands200Response } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies ListOrgBrands200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListOrgBrands200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListOrgBrands200ResponseDataInner.md

@@ -0,0 +1,70 @@
+
+# ListOrgBrands200ResponseDataInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`companyName` | string
+`vatNumber` | string
+`customs` | { [key: string]: string; }
+`addressLine1` | string
+`addressLine2` | string
+`city` | string
+`postalCode` | string
+`country` | string
+`primaryColor` | string
+`secondaryColor` | string
+`id` | string
+`orgId` | string
+`name` | string
+`slug` | string
+`useOrgCustoms` | boolean
+`logoUrl` | string
+`archivedAt` | string
+`createdAt` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { ListOrgBrands200ResponseDataInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "companyName": Acme ApS,
+  "vatNumber": DK12345678,
+  "customs": {"eori":"DK12345678"},
+  "addressLine1": Vestergade 12,
+  "addressLine2": 3. sal,
+  "city": København,
+  "postalCode": 1456,
+  "country": DK,
+  "primaryColor": #1D4ED8,
+  "secondaryColor": #F59E0B,
+  "id": brnd_8f3kd92ld0,
+  "orgId": org_8f3kd92ld0,
+  "name": Acme,
+  "slug": acme,
+  "useOrgCustoms": true,
+  "logoUrl": /orgs/org_1/brands/brnd_1/logo,
+  "archivedAt": 2026-08-05T10:00:00.000Z,
+  "createdAt": 2026-06-22T14:30:00.000Z,
+  "updatedAt": 2026-06-22T14:30:00.000Z,
+} satisfies ListOrgBrands200ResponseDataInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListOrgBrands200ResponseDataInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListShipments200ResponseDataInner.md

@@ -11,6 +11,7 @@ Name | Type
 `type` | string
 `carrierSettings` | [ListShipments200ResponseDataInnerCarrierSettings](ListShipments200ResponseDataInnerCarrierSettings.md)
 `status` | string
+`brandId` | string
 `address` | [ListShipments200ResponseDataInnerAddress](ListShipments200ResponseDataInnerAddress.md)
 `createdAt` | string
 `updatedAt` | string
@@ -27,6 +28,7 @@ const example = {
   "type": outbound,
   "carrierSettings": null,
   "status": pending,
+  "brandId": brnd_8f3kd92ld0,
   "address": null,
   "createdAt": 2026-06-22T14:30:00.000Z,
   "updatedAt": 2026-06-22T14:30:00.000Z,

package/docs/OrdersApi.md

@@ -244,7 +244,7 @@ example().catch(console.error);
 
 ## listOrders
 
-> ListOrders200Response listOrders(orgId, page, limit, status, orderChannelId, search)
+> ListOrders200Response listOrders(orgId, page, limit, brandId, status, orderChannelId, search)
 
 List orders
 
@@ -274,6 +274,8 @@ async function example() {
     page: 1,
     // number | Items per page (max 100) (optional)
     limit: 20,
+    // string | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. (optional)
+    brandId: brnd_8f3kd92ld0,
     // 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'error' | 'cancelled' | Order fulfilment status derived from its shipments. (optional)
     status: processing,
     // string | Filter by order channel ID. (optional)
@@ -302,6 +304,7 @@ example().catch(console.error);
 | **orgId** | `string` | Organization ID | [Defaults to `undefined`] |
 | **page** | `number` | Page number (1-based) | [Optional] [Defaults to `1`] |
 | **limit** | `number` | Items per page (max 100) | [Optional] [Defaults to `20`] |
+| **brandId** | `string` | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [Optional] [Defaults to `undefined`] |
 | **status** | `pending`, `processing`, `partially_fulfilled`, `fulfilled`, `error`, `cancelled` | Order fulfilment status derived from its shipments. | [Optional] [Defaults to `undefined`] [Enum: pending, processing, partially_fulfilled, fulfilled, error, cancelled] |
 | **orderChannelId** | `string` | Filter by order channel ID. | [Optional] [Defaults to `undefined`] |
 | **search** | `string` | Search by order number or customer name/email. | [Optional] [Defaults to `undefined`] |

package/docs/OrgsApi.md

@@ -296,7 +296,7 @@ example().catch(console.error);
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | The org logo image bytes |  -  |
+| **200** | The logo image bytes |  -  |
 | **404** | Default Response |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/ShipmentsApi.md

@@ -568,7 +568,7 @@ example().catch(console.error);
 
 ## listShipments
 
-> ListShipments200Response listShipments(orgId, page, limit)
+> ListShipments200Response listShipments(orgId, page, limit, brandId)
 
 List shipments
 
@@ -598,6 +598,8 @@ async function example() {
     page: 1,
     // number | Items per page (max 100) (optional)
     limit: 20,
+    // string | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. (optional)
+    brandId: brnd_8f3kd92ld0,
   } satisfies ListShipmentsRequest;
 
   try {
@@ -620,6 +622,7 @@ example().catch(console.error);
 | **orgId** | `string` | Organization ID | [Defaults to `undefined`] |
 | **page** | `number` | Page number (1-based) | [Optional] [Defaults to `1`] |
 | **limit** | `number` | Items per page (max 100) | [Optional] [Defaults to `20`] |
+| **brandId** | `string` | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 

package/docs/UpdateOrgBrandRequest.md

@@ -0,0 +1,58 @@
+
+# UpdateOrgBrandRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`companyName` | string
+`vatNumber` | string
+`customs` | { [key: string]: string; }
+`addressLine1` | string
+`addressLine2` | string
+`city` | string
+`postalCode` | string
+`country` | string
+`primaryColor` | string
+`secondaryColor` | string
+`name` | string
+`slug` | string
+`useOrgCustoms` | boolean
+
+## Example
+
+```typescript
+import type { UpdateOrgBrandRequest } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "companyName": Acme ApS,
+  "vatNumber": DK12345678,
+  "customs": {"eori":"DK12345678"},
+  "addressLine1": Vestergade 12,
+  "addressLine2": 3. sal,
+  "city": København,
+  "postalCode": 1456,
+  "country": DK,
+  "primaryColor": #1D4ED8,
+  "secondaryColor": #F59E0B,
+  "name": Acme,
+  "slug": acme,
+  "useOrgCustoms": true,
+} satisfies UpdateOrgBrandRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UpdateOrgBrandRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zippendo/sdk",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "OpenAPI client for @zippendo/sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/AddressesApi.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Zippendo Public API
- * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
  *
  * The version of the OpenAPI document: 1.0.0
  * Contact: support@zippendo.com

package/src/apis/BillingApi.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Zippendo Public API
- * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
  *
  * The version of the OpenAPI document: 1.0.0
  * Contact: support@zippendo.com