zippendo 1.1.0 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6aaf1baa2de3d223d92918b490e2b49ac9afa412885ea42ede4696e60e5f2b26
-  data.tar.gz: ffe470a730eca79b84f43cfd585e85b6c9b69763227bf47a0207bb4fd16c9fef
+  metadata.gz: bae775bf1a1ae7660b693ca59ba5fc02b8a7d1c4c29b56fde73d294ae0f1cb38
+  data.tar.gz: 8e939ec19a2cd78b0f7136abe4a8de1a13e715e510a78cb22cc8fb2a3264960b
 SHA512:
-  metadata.gz: 432cb92d03d9346172fb92c6515418ddc03cb07b61dd624c3ced733715091211ed8cc7517bd7269f344f2224a01ec6b241c76e277c4438ad67e8ae1a9ef6af28
-  data.tar.gz: 9e0102de45be5372af45c788e95addf49712d1f1ae8afbf18fee53545e1d8b945d1f03d2094eaf02b6dc303d15269486c32a94dea87695410a3beb62902322dc
+  metadata.gz: 1ea90cdc79f094275431f7179c16013682ad5388d29b5ede0b00bd242bae3d40274857fd745308f6deed11be28398f32c0f5f0654d8b4e73f2043c5a2277f2c5
+  data.tar.gz: 2384357611670e6188f32ee9343d82aa65ab7696c623d026548217ddd5520a07f21e47db130304583f9d2835d0f743eeca80f40b2c96b47ea24f4e88939140ae

data/README.md

@@ -76,6 +76,17 @@ A token created with a `brand_id` (see `CreateApiTokenRequest`) is permanently c
 needs no header. Sending `X-Zippendo-Brand` naming a *different* brand on such a token is refused with
 `403 BRAND_ACCESS_DENIED` — the binding is never widened.
 
+List operations also take a `brand_scope` query parameter (`"own"` / `"shared"` / `"both"`) to narrow
+further within whichever brand context already applies: `"own"` returns only that brand's rows and needs
+a brand context (otherwise `400`); `"shared"` returns only the unassigned rows (equivalent to
+`brand_id=none`). Set `X-Zippendo-Brand-Scope` as a default header the same way to cover every call:
+
+```ruby
+Zippendo::ApiClient.default.default_headers["X-Zippendo-Brand-Scope"] = "own"
+```
+
+An explicit `brand_scope` parameter passed to a call still wins over the header.
+
 ### Managing brands
 
 Brands are managed with `BrandsApi`. Use an organization-wide client for this — you are administering

data/docs/AddressesApi.md

@@ -248,7 +248,9 @@ org_id = 'org_01HZX9K2QF' # String | Organization ID
 opts = {
   page: 1, # Integer | Page number (1-based)
   limit: 20, # Integer | Items per page (max 100)
-  type: 'sender' # String | Filter by address type (sender, pickup, return)
+  type: 'sender', # String | Filter by address type (sender, pickup, return)
+  brand_id: 'brnd_8f3kd92ld0', # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
+  brand_scope: 'own' # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
 }
 
 begin
@@ -286,6 +288,8 @@ end
 | **page** | **Integer** | Page number (1-based) | [optional][default to 1] |
 | **limit** | **Integer** | Items per page (max 100) | [optional][default to 20] |
 | **type** | **String** | Filter by address type (sender, pickup, return) | [optional] |
+| **brand_id** | **String** | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [optional] |
+| **brand_scope** | **String** | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [optional] |
 
 ### Return type
 

data/docs/BatchSplitShipmentRequest.md

@@ -9,7 +9,7 @@
 | **carrier_id** | **String** | Carrier for all new shipments. Copied from the original if omitted. | [optional] |
 | **product_id** | **String** | Carrier product for all new shipments. Copied from the original if omitted. | [optional] |
 | **services** | **Array<String>** | Service codes for all new shipments. Copied from the original if omitted. | [optional] |
-| **additional_parameters** | **Hash<String, Object>** | Carrier-specific parameters for all new shipments. | [optional] |
+| **additional_parameters** | [**Hash<String, CreateShippingRuleRequestAdditionalParametersValue>**](CreateShippingRuleRequestAdditionalParametersValue.md) | Carrier-specific parameters for all new shipments. Copied from the original if omitted. | [optional] |
 
 ## Example
 

data/docs/CarriersApi.md

@@ -395,7 +395,9 @@ api_instance = Zippendo::CarriersApi.new
 org_id = 'org_01HZX9K2QF' # String | Organization ID
 opts = {
   page: 1, # Integer | Page number (1-based)
-  limit: 20 # Integer | Items per page (max 100)
+  limit: 20, # Integer | Items per page (max 100)
+  brand_id: 'brnd_8f3kd92ld0', # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
+  brand_scope: 'own' # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
 }
 
 begin
@@ -432,6 +434,8 @@ end
 | **org_id** | **String** | Organization ID |  |
 | **page** | **Integer** | Page number (1-based) | [optional][default to 1] |
 | **limit** | **Integer** | Items per page (max 100) | [optional][default to 20] |
+| **brand_id** | **String** | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [optional] |
+| **brand_scope** | **String** | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [optional] |
 
 ### Return type
 

data/docs/ConnectCarrierRequest.md

@@ -7,6 +7,7 @@
 | **name** | **String** | Carrier display name |  |
 | **carrier_slug** | **String** | Carrier slug identifier |  |
 | **config** | [**Hash<String, ListCarriers200ResponseDataInnerConfigValue>**](ListCarriers200ResponseDataInnerConfigValue.md) | Carrier configuration (required and optional fields) |  |
+| **brand_id** | **String** | Brand this record is assigned to; null (or omitted outside a brand session) keeps it organization-wide | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'zippendo'
 instance = Zippendo::ConnectCarrierRequest.new(
   name: PostNord,
   carrier_slug: postnord,
-  config: {"customerNumber":"123456"}
+  config: {"customerNumber":"123456"},
+  brand_id: brnd_8f3kd92ld0
 )
 ```
 

data/docs/CreateAddressRequest.md

@@ -16,6 +16,7 @@
 | **email** | **String** | Email address |  |
 | **customs** | **Hash<String, String>** | Customs identifiers (voec, eori, sprn, ioss, fda, duns) | [optional] |
 | **address_types** | **Array<String>** | Address types (sender, pickup, return) | [optional] |
+| **brand_id** | **String** | Brand this record is assigned to; null (or omitted outside a brand session) keeps it organization-wide | [optional] |
 
 ## Example
 
@@ -34,7 +35,8 @@ instance = Zippendo::CreateAddressRequest.new(
   state: ,
   email: lager@example.dk,
   customs: {"eori":"DK12345678"},
-  address_types: ["sender"]
+  address_types: ["sender"],
+  brand_id: brnd_8f3kd92ld0
 )
 ```
 

data/docs/CreateOrgWebhook201Response.md

@@ -10,6 +10,7 @@
 | **secret** | **String** | Signing secret used to verify webhook payloads |  |
 | **events** | **Array<String>** | Events the webhook is subscribed to |  |
 | **is_active** | **Boolean** | Whether the webhook is active |  |
+| **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **created_at** | **String** | Creation timestamp (ISO 8601) |  |
 | **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
 
@@ -25,6 +26,7 @@ instance = Zippendo::CreateOrgWebhook201Response.new(
   secret: whsec_8f3a1c2b9d4e5f6a,
   events: ["shipment.created"],
   is_active: true,
+  brand_id: brnd_8f3kd92ld0,
   created_at: 2026-06-01T09:30:00.000Z,
   updated_at: 2026-06-10T11:15:00.000Z
 )

data/docs/CreateOrgWebhookRequest.md

@@ -8,6 +8,7 @@
 | **url** | **String** | Webhook endpoint URL |  |
 | **events** | **Array<String>** | Events to subscribe to |  |
 | **is_active** | **Boolean** | Whether the webhook is active | [optional][default to true] |
+| **brand_id** | **String** | Brand this record is assigned to; null (or omitted outside a brand session) keeps it organization-wide | [optional] |
 
 ## Example
 
@@ -18,7 +19,8 @@ instance = Zippendo::CreateOrgWebhookRequest.new(
   name: Order fulfilment notifier,
   url: https://hooks.example.dk/zippendo,
   events: ["shipment.created","tracking.updated"],
-  is_active: true
+  is_active: true,
+  brand_id: brnd_8f3kd92ld0
 )
 ```
 

data/docs/CreateShipment201ResponseParcelsInner.md

@@ -13,8 +13,8 @@
 | **tracking_url** | **String** | Public carrier tracking URL for this parcel. | [optional] |
 | **label_free_code** | **String** | Label-free drop-off code for the parcel. | [optional] |
 | **qr_code_link** | **String** | DEPRECATED — use `qrCodeDataUri` (embeddable data URI) or `qrCodeUrl` (hosted link). Catch-all that carries whichever applies, kept populated for backwards compatibility during the migration and until it is disabled. | [optional] |
-| **qr_code_data_uri** | **String** | Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email. Null when the carrier returns a hosted link instead (see `qrCodeUrl`). | [optional] |
-| **qr_code_url** | **String** | Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it. Null when the carrier returns embeddable bytes (see `qrCodeDataUri`). | [optional] |
+| **qr_code_data_uri** | **String** | Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email. Populated whenever the image bytes are available, including for carriers that host the image (it is fetched and inlined); null if the carrier published no QR code or its image could not be retrieved. | [optional] |
+| **qr_code_url** | **String** | Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it. Independent of `qrCodeDataUri` — both are set when the hosted image was inlined successfully; null for carriers that only return embedded bytes. | [optional] |
 
 ## Example
 

data/docs/CreateShipment201ResponseTracking.md

@@ -8,8 +8,8 @@
 | **number** | **String** | Carrier tracking number. | [optional] |
 | **label_free_code** | **String** | Label-free drop-off code. | [optional] |
 | **qr_code_link** | **String** | DEPRECATED — use `qrCodeDataUri` (embeddable data URI) or `qrCodeUrl` (hosted link). Catch-all that carries whichever applies, kept populated for backwards compatibility during the migration and until it is disabled. | [optional] |
-| **qr_code_data_uri** | **String** | Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email. Null when the carrier returns a hosted link instead (see `qrCodeUrl`). | [optional] |
-| **qr_code_url** | **String** | Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it. Null when the carrier returns embeddable bytes (see `qrCodeDataUri`). | [optional] |
+| **qr_code_data_uri** | **String** | Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email. Populated whenever the image bytes are available, including for carriers that host the image (it is fetched and inlined); null if the carrier published no QR code or its image could not be retrieved. | [optional] |
+| **qr_code_url** | **String** | Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it. Independent of `qrCodeDataUri` — both are set when the hosted image was inlined successfully; null for carriers that only return embedded bytes. | [optional] |
 
 ## Example
 

data/docs/CreateShipmentRequestCarrierSettings.md

@@ -7,7 +7,7 @@
 | **carrier_id** | **String** | Identifier of the carrier to use. |  |
 | **product_id** | **String** | Identifier of the carrier product/service. |  |
 | **services** | **Array<String>** | Additional service codes requested from the carrier. |  |
-| **additional_parameters** | [**Hash<String, CreateShippingRuleRequestAdditionalParametersAnyOfValue>**](CreateShippingRuleRequestAdditionalParametersAnyOfValue.md) | Carrier-specific extra parameters as key/value pairs. |  |
+| **additional_parameters** | [**Hash<String, CreateShippingRuleRequestAdditionalParametersValue>**](CreateShippingRuleRequestAdditionalParametersValue.md) | Carrier-specific extra parameters as key/value pairs. |  |
 
 ## Example
 

data/docs/CreateShipmentRequestParcelsInner.md

@@ -13,8 +13,8 @@
 | **tracking_url** | **String** | Public carrier tracking URL for this parcel. | [optional] |
 | **label_free_code** | **String** | Label-free drop-off code for the parcel. | [optional] |
 | **qr_code_link** | **String** | DEPRECATED — use `qrCodeDataUri` (embeddable data URI) or `qrCodeUrl` (hosted link). Catch-all that carries whichever applies, kept populated for backwards compatibility during the migration and until it is disabled. | [optional] |
-| **qr_code_data_uri** | **String** | Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email. Null when the carrier returns a hosted link instead (see `qrCodeUrl`). | [optional] |
-| **qr_code_url** | **String** | Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it. Null when the carrier returns embeddable bytes (see `qrCodeDataUri`). | [optional] |
+| **qr_code_data_uri** | **String** | Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email. Populated whenever the image bytes are available, including for carriers that host the image (it is fetched and inlined); null if the carrier published no QR code or its image could not be retrieved. | [optional] |
+| **qr_code_url** | **String** | Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it. Independent of `qrCodeDataUri` — both are set when the hosted image was inlined successfully; null for carriers that only return embedded bytes. | [optional] |
 
 ## Example
 

data/docs/CreateShippingRule201Response.md

@@ -11,7 +11,7 @@
 | **carrier_id** | **String** | Carrier ID |  |
 | **product_id** | **String** | Product ID from carrier |  |
 | **services** | **Array<String>** | List of selected services |  |
-| **additional_parameters** | [**Array<ListShippingRules200ResponseDataInnerAdditionalParametersInner>**](ListShippingRules200ResponseDataInnerAdditionalParametersInner.md) | Carrier-specific extra parameters. DEPRECATED array form `[{ name, val }]` where `name` is the carrier parameter `key` (from the product's `additionalParameters[].key`, e.g. `returnFunctionality`) and `val` is the stringified value. This will change to a `{ key: value }` object in a future version — writes already accept either shape. |  |
+| **additional_parameters** | [**Hash<String, ListShippingRules200ResponseDataInnerAdditionalParametersValue>**](ListShippingRules200ResponseDataInnerAdditionalParametersValue.md) | Carrier-specific extra parameters, keyed by the carrier parameter `key` from the product's `additionalParameters[].key`. |  |
 | **address_id** | **String** | Sender address ID |  |
 | **receiving_countries** | **Array<String>** | List of supported country codes |  |
 | **email_notification** | **Boolean** | Send email notification to recipient | [default to false] |
@@ -31,6 +31,7 @@
 | **return_shipping_rule_id** | **String** | ID of the return shipping rule |  |
 | **auto_create_return_shipment** | **Boolean** | Automatically create and send a return shipment on dispatch | [default to false] |
 | **org_id** | **String** | Owning organization ID |  |
+| **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **created_at** | **String** | Creation timestamp (ISO 8601) |  |
 | **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
 
@@ -47,7 +48,7 @@ instance = Zippendo::CreateShippingRule201Response.new(
   carrier_id: carr_01HZX9K2QF,
   product_id: PNL13,
   services: ["EMAIL_NOTIFICATION"],
-  additional_parameters: [{"name":"returnFunctionality","val":"LABELLESS"}],
+  additional_parameters: {"returnFunctionality":"LABELLESS","returnQrEmail":true},
   address_id: addr_01HZX9K2QF,
   receiving_countries: ["DK","SE"],
   email_notification: true,
@@ -67,6 +68,7 @@ instance = Zippendo::CreateShippingRule201Response.new(
   return_shipping_rule_id: null,
   auto_create_return_shipment: false,
   org_id: org_01HZX9K2QF,
+  brand_id: brnd_8f3kd92ld0,
   created_at: 2026-06-22T09:00:00.000Z,
   updated_at: 2026-06-22T09:00:00.000Z
 )

data/docs/CreateShippingRuleRequest.md

@@ -10,7 +10,7 @@
 | **carrier_id** | **String** | Carrier ID |  |
 | **product_id** | **String** | Product ID from carrier |  |
 | **services** | **Array<String>** | List of selected services |  |
-| **additional_parameters** | [**CreateShippingRuleRequestAdditionalParameters**](CreateShippingRuleRequestAdditionalParameters.md) |  | [optional] |
+| **additional_parameters** | [**Hash<String, CreateShippingRuleRequestAdditionalParametersValue>**](CreateShippingRuleRequestAdditionalParametersValue.md) | Carrier-specific extra parameters, keyed by the carrier parameter `key` from the product's `additionalParameters[].key` (e.g. `returnFunctionality`). | [optional] |
 | **address_id** | **String** | Sender address ID |  |
 | **receiving_countries** | **Array<String>** | List of supported country codes |  |
 | **email_notification** | **Boolean** | Send email notification to recipient | [optional][default to false] |
@@ -29,6 +29,7 @@
 | **document_printer_id** | **String** | ID of the document printer | [optional] |
 | **return_shipping_rule_id** | **String** | ID of the return shipping rule | [optional] |
 | **auto_create_return_shipment** | **Boolean** | Automatically create and send a return shipment on dispatch | [optional][default to false] |
+| **brand_id** | **String** | Brand this record is assigned to; null (or omitted outside a brand session) keeps it organization-wide | [optional] |
 
 ## Example
 
@@ -42,7 +43,7 @@ instance = Zippendo::CreateShippingRuleRequest.new(
   carrier_id: carr_01HZX9K2QF,
   product_id: PNL13,
   services: ["EMAIL_NOTIFICATION"],
-  additional_parameters: null,
+  additional_parameters: {"returnFunctionality":"LABELLESS","returnQrEmail":true},
   address_id: addr_01HZX9K2QF,
   receiving_countries: ["DK","SE"],
   email_notification: true,
@@ -60,7 +61,8 @@ instance = Zippendo::CreateShippingRuleRequest.new(
   label_printer_id: null,
   document_printer_id: null,
   return_shipping_rule_id: null,
-  auto_create_return_shipment: false
+  auto_create_return_shipment: false,
+  brand_id: brnd_8f3kd92ld0
 )
 ```
 

data/docs/{CreateShippingRuleRequestAdditionalParametersAnyOfValue.md → CreateShippingRuleRequestAdditionalParametersValue.md}

@@ -1,4 +1,4 @@
-# Zippendo::CreateShippingRuleRequestAdditionalParametersAnyOfValue
+# Zippendo::CreateShippingRuleRequestAdditionalParametersValue
 
 ## Properties
 
@@ -7,14 +7,14 @@
 | **id** | **String** | Identifier of the selected service point. |  |
 | **name** | **String** | Display name of the service point. |  |
 | **address** | **String** | Formatted address of the service point. |  |
-| **coordinates** | [**Array<CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner>**](CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.md) | Latitude/longitude of the service point. | [optional] |
+| **coordinates** | [**Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>**](ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.md) | Latitude/longitude of the service point. | [optional] |
 
 ## Example
 
 ```ruby
 require 'zippendo'
 
-instance = Zippendo::CreateShippingRuleRequestAdditionalParametersAnyOfValue.new(
+instance = Zippendo::CreateShippingRuleRequestAdditionalParametersValue.new(
   id: sp_pn_4521,
   name: Føtex Nørrebro,
   address: Nørrebrogade 20, 2200 København N,

data/docs/{CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.md → CreateShippingRuleRequestAdditionalParametersValueAnyOf.md}

@@ -1,4 +1,4 @@
-# Zippendo::CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf
+# Zippendo::CreateShippingRuleRequestAdditionalParametersValueAnyOf
 
 ## Properties
 
@@ -7,14 +7,14 @@
 | **id** | **String** | Identifier of the selected service point. |  |
 | **name** | **String** | Display name of the service point. |  |
 | **address** | **String** | Formatted address of the service point. |  |
-| **coordinates** | [**Array<CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner>**](CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.md) | Latitude/longitude of the service point. | [optional] |
+| **coordinates** | [**Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>**](ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.md) | Latitude/longitude of the service point. | [optional] |
 
 ## Example
 
 ```ruby
 require 'zippendo'
 
-instance = Zippendo::CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.new(
+instance = Zippendo::CreateShippingRuleRequestAdditionalParametersValueAnyOf.new(
   id: sp_pn_4521,
   name: Føtex Nørrebro,
   address: Nørrebrogade 20, 2200 København N,

data/docs/GetBillingUsage200Response.md

@@ -8,6 +8,7 @@
 | **shipments** | [**GetBillingUsage200ResponseShipments**](GetBillingUsage200ResponseShipments.md) |  |  |
 | **limits** | [**GetBillingUsage200ResponseLimits**](GetBillingUsage200ResponseLimits.md) |  |  |
 | **add_ons** | [**Array<GetBillingUsage200ResponseAddOnsInner>**](GetBillingUsage200ResponseAddOnsInner.md) | Active add-ons on the subscription |  |
+| **zippy_messages** | [**GetBillingUsage200ResponseZippyMessages**](GetBillingUsage200ResponseZippyMessages.md) |  | [optional] |
 
 ## Example
 
@@ -18,7 +19,8 @@ instance = Zippendo::GetBillingUsage200Response.new(
   current_period: null,
   shipments: null,
   limits: null,
-  add_ons: []
+  add_ons: [],
+  zippy_messages: null
 )
 ```
 

data/docs/GetBillingUsage200ResponseZippyMessages.md

@@ -0,0 +1,20 @@
+# Zippendo::GetBillingUsage200ResponseZippyMessages
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **used** | **Float** | Zippy messages used this period |  |
+| **charges** | **Float** | Zippy message charges so far, in øre |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::GetBillingUsage200ResponseZippyMessages.new(
+  used: 42,
+  charges: 4158
+)
+```
+

data/docs/ListAddresses200ResponseDataInner.md

@@ -18,6 +18,7 @@
 | **customs** | **Hash<String, String>** | Customs identifiers keyed by type | [optional] |
 | **address_types** | **Array<String>** | Address types (sender, pickup, return) |  |
 | **org_id** | **String** | Owning organization ID |  |
+| **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **created_at** | **String** | Creation timestamp (ISO 8601) |  |
 | **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
 
@@ -41,6 +42,7 @@ instance = Zippendo::ListAddresses200ResponseDataInner.new(
   customs: {"eori":"DK12345678"},
   address_types: ["sender"],
   org_id: org_01HZX9K2QF,
+  brand_id: brnd_8f3kd92ld0,
   created_at: 2026-06-22T09:00:00.000Z,
   updated_at: 2026-06-22T09:00:00.000Z
 )

data/docs/ListCarriers200ResponseDataInner.md

@@ -9,6 +9,7 @@
 | **carrier_slug** | **String** | Carrier slug identifier |  |
 | **config** | [**Hash<String, ListCarriers200ResponseDataInnerConfigValue>**](ListCarriers200ResponseDataInnerConfigValue.md) | Carrier configuration (required and optional fields) |  |
 | **org_id** | **String** | Owning organization ID |  |
+| **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **created_at** | **String** | Creation timestamp (ISO 8601) |  |
 | **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
 | **logo** | **String** | Carrier logo URL | [optional] |
@@ -27,6 +28,7 @@ instance = Zippendo::ListCarriers200ResponseDataInner.new(
   carrier_slug: postnord,
   config: {"customerNumber":"123456"},
   org_id: org_01HZX9K2QF,
+  brand_id: brnd_8f3kd92ld0,
   created_at: 2026-06-22T09:00:00.000Z,
   updated_at: 2026-06-22T09:00:00.000Z,
   logo: https://cdn.zippendo.com/logos/postnord.svg,

data/docs/ListOrgWebhooks200ResponseDataInner.md

@@ -9,6 +9,7 @@
 | **url** | **String** | Webhook endpoint URL |  |
 | **events** | **Array<String>** | Events the webhook is subscribed to |  |
 | **is_active** | **Boolean** | Whether the webhook is active |  |
+| **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **created_at** | **String** | Creation timestamp (ISO 8601) |  |
 | **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
 
@@ -23,6 +24,7 @@ instance = Zippendo::ListOrgWebhooks200ResponseDataInner.new(
   url: https://hooks.example.dk/zippendo,
   events: ["shipment.created"],
   is_active: true,
+  brand_id: brnd_8f3kd92ld0,
   created_at: 2026-06-01T09:30:00.000Z,
   updated_at: 2026-06-10T11:15:00.000Z
 )

data/docs/ListShipments200ResponseDataInnerAddress.md

@@ -18,6 +18,7 @@
 | **customs** | **Hash<String, String>** | Customs identifiers keyed by type | [optional] |
 | **address_types** | **Array<String>** | Address types (sender, pickup, return) |  |
 | **org_id** | **String** | Owning organization ID |  |
+| **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **created_at** | **String** | Creation timestamp (ISO 8601) |  |
 | **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
 
@@ -41,6 +42,7 @@ instance = Zippendo::ListShipments200ResponseDataInnerAddress.new(
   customs: {"eori":"DK12345678"},
   address_types: ["sender"],
   org_id: org_01HZX9K2QF,
+  brand_id: brnd_8f3kd92ld0,
   created_at: 2026-06-22T09:00:00.000Z,
   updated_at: 2026-06-22T09:00:00.000Z
 )

data/docs/ListShipments200ResponseDataInnerCarrierSettings.md

@@ -7,7 +7,7 @@
 | **carrier_id** | **String** | Identifier of the carrier to use. |  |
 | **product_id** | **String** | Identifier of the carrier product/service. |  |
 | **services** | **Array<String>** | Additional service codes requested from the carrier. |  |
-| **additional_parameters** | [**Hash<String, ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue>**](ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.md) | Carrier-specific extra parameters as key/value pairs. |  |
+| **additional_parameters** | [**Hash<String, ListShippingRules200ResponseDataInnerAdditionalParametersValue>**](ListShippingRules200ResponseDataInnerAdditionalParametersValue.md) | Carrier-specific extra parameters as key/value pairs. |  |
 
 ## Example
 

data/docs/ListShippingRules200ResponseDataInner.md

@@ -11,7 +11,7 @@
 | **carrier_id** | **String** | Carrier ID |  |
 | **product_id** | **String** | Product ID from carrier |  |
 | **services** | **Array<String>** | List of selected services |  |
-| **additional_parameters** | [**Array<ListShippingRules200ResponseDataInnerAdditionalParametersInner>**](ListShippingRules200ResponseDataInnerAdditionalParametersInner.md) | Carrier-specific extra parameters. DEPRECATED array form `[{ name, val }]` where `name` is the carrier parameter `key` (from the product's `additionalParameters[].key`, e.g. `returnFunctionality`) and `val` is the stringified value. This will change to a `{ key: value }` object in a future version — writes already accept either shape. |  |
+| **additional_parameters** | [**Hash<String, ListShippingRules200ResponseDataInnerAdditionalParametersValue>**](ListShippingRules200ResponseDataInnerAdditionalParametersValue.md) | Carrier-specific extra parameters, keyed by the carrier parameter `key` from the product's `additionalParameters[].key`. |  |
 | **address_id** | **String** | Sender address ID |  |
 | **receiving_countries** | **Array<String>** | List of supported country codes |  |
 | **email_notification** | **Boolean** | Send email notification to recipient | [default to false] |
@@ -31,6 +31,7 @@
 | **return_shipping_rule_id** | **String** | ID of the return shipping rule |  |
 | **auto_create_return_shipment** | **Boolean** | Automatically create and send a return shipment on dispatch | [default to false] |
 | **org_id** | **String** | Owning organization ID |  |
+| **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **created_at** | **String** | Creation timestamp (ISO 8601) |  |
 | **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
 | **carrier** | [**ListShippingRules200ResponseDataInnerCarrier**](ListShippingRules200ResponseDataInnerCarrier.md) |  |  |
@@ -52,7 +53,7 @@ instance = Zippendo::ListShippingRules200ResponseDataInner.new(
   carrier_id: carr_01HZX9K2QF,
   product_id: PNL13,
   services: ["EMAIL_NOTIFICATION"],
-  additional_parameters: [{"name":"returnFunctionality","val":"LABELLESS"}],
+  additional_parameters: {"returnFunctionality":"LABELLESS","returnQrEmail":true},
   address_id: addr_01HZX9K2QF,
   receiving_countries: ["DK","SE"],
   email_notification: true,
@@ -72,6 +73,7 @@ instance = Zippendo::ListShippingRules200ResponseDataInner.new(
   return_shipping_rule_id: null,
   auto_create_return_shipment: false,
   org_id: org_01HZX9K2QF,
+  brand_id: brnd_8f3kd92ld0,
   created_at: 2026-06-22T09:00:00.000Z,
   updated_at: 2026-06-22T09:00:00.000Z,
   carrier: null,

data/docs/{ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.md → ListShippingRules200ResponseDataInnerAdditionalParametersValue.md}

@@ -1,4 +1,4 @@
-# Zippendo::ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue
+# Zippendo::ListShippingRules200ResponseDataInnerAdditionalParametersValue
 
 ## Properties
 
@@ -7,14 +7,14 @@
 | **id** | **String** | Identifier of the selected service point. |  |
 | **name** | **String** | Display name of the service point. |  |
 | **address** | **String** | Formatted address of the service point. |  |
-| **coordinates** | [**Array<CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner>**](CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.md) | Latitude/longitude of the service point. | [optional] |
+| **coordinates** | [**Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>**](ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.md) | Latitude/longitude of the service point. | [optional] |
 
 ## Example
 
 ```ruby
 require 'zippendo'
 
-instance = Zippendo::ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.new(
+instance = Zippendo::ListShippingRules200ResponseDataInnerAdditionalParametersValue.new(
   id: sp_pn_4521,
   name: Føtex Nørrebro,
   address: Nørrebrogade 20, 2200 København N,

data/docs/{ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.md → ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.md}

@@ -1,4 +1,4 @@
-# Zippendo::ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf
+# Zippendo::ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf
 
 ## Properties
 
@@ -7,14 +7,14 @@
 | **id** | **String** | Identifier of the selected service point. |  |
 | **name** | **String** | Display name of the service point. |  |
 | **address** | **String** | Formatted address of the service point. |  |
-| **coordinates** | [**Array<CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner>**](CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.md) | Latitude/longitude of the service point. | [optional] |
+| **coordinates** | [**Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>**](ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.md) | Latitude/longitude of the service point. | [optional] |
 
 ## Example
 
 ```ruby
 require 'zippendo'
 
-instance = Zippendo::ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.new(
+instance = Zippendo::ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.new(
   id: sp_pn_4521,
   name: Føtex Nørrebro,
   address: Nørrebrogade 20, 2200 København N,

data/docs/{ListShippingRules200ResponseDataInnerAdditionalParametersInner.md → ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.md}

@@ -1,20 +1,15 @@
-# Zippendo::ListShippingRules200ResponseDataInnerAdditionalParametersInner
+# Zippendo::ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Carrier parameter key |  |
-| **val** | **String** | Parameter value (stringified) |  |
 
 ## Example
 
 ```ruby
 require 'zippendo'
 
-instance = Zippendo::ListShippingRules200ResponseDataInnerAdditionalParametersInner.new(
-  name: returnFunctionality,
-  val: LABELLESS
-)
+instance = Zippendo::ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.new()
 ```
 

data/docs/ListShippingRules200ResponseDataInnerCarrier.md

@@ -9,6 +9,7 @@
 | **carrier_slug** | **String** | Carrier slug identifier |  |
 | **config** | [**Hash<String, ListCarriers200ResponseDataInnerConfigValue>**](ListCarriers200ResponseDataInnerConfigValue.md) | Carrier configuration (required and optional fields) |  |
 | **org_id** | **String** | Owning organization ID |  |
+| **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **created_at** | **String** | Creation timestamp (ISO 8601) |  |
 | **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
 
@@ -23,6 +24,7 @@ instance = Zippendo::ListShippingRules200ResponseDataInnerCarrier.new(
   carrier_slug: postnord,
   config: {"customerNumber":"123456"},
   org_id: org_01HZX9K2QF,
+  brand_id: brnd_8f3kd92ld0,
   created_at: 2026-06-22T09:00:00.000Z,
   updated_at: 2026-06-22T09:00:00.000Z
 )

data/docs/OrdersApi.md

@@ -249,6 +249,7 @@ opts = {
   page: 1, # Integer | Page number (1-based)
   limit: 20, # Integer | Items per page (max 100)
   brand_id: 'brnd_8f3kd92ld0', # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
+  brand_scope: 'own', # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
   status: 'pending', # String | Order fulfilment status derived from its shipments.
   order_channel_id: 'clz9k2f0a0001abcd1234efgh', # String | Filter by order channel ID.
   search: 'Anna' # String | Search by order number or customer name/email.
@@ -289,6 +290,7 @@ end
 | **page** | **Integer** | Page number (1-based) | [optional][default to 1] |
 | **limit** | **Integer** | Items per page (max 100) | [optional][default to 20] |
 | **brand_id** | **String** | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [optional] |
+| **brand_scope** | **String** | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [optional] |
 | **status** | **String** | Order fulfilment status derived from its shipments. | [optional] |
 | **order_channel_id** | **String** | Filter by order channel ID. | [optional] |
 | **search** | **String** | Search by order number or customer name/email. | [optional] |

data/docs/RulesApi.md

@@ -247,7 +247,9 @@ api_instance = Zippendo::RulesApi.new
 org_id = 'org_01HZX9K2QF' # String | Organization ID
 opts = {
   page: 1, # Integer | Page number (1-based)
-  limit: 20 # Integer | Items per page (max 100)
+  limit: 20, # Integer | Items per page (max 100)
+  brand_id: 'brnd_8f3kd92ld0', # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
+  brand_scope: 'own' # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
 }
 
 begin
@@ -284,6 +286,8 @@ end
 | **org_id** | **String** | Organization ID |  |
 | **page** | **Integer** | Page number (1-based) | [optional][default to 1] |
 | **limit** | **Integer** | Items per page (max 100) | [optional][default to 20] |
+| **brand_id** | **String** | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [optional] |
+| **brand_scope** | **String** | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [optional] |
 
 ### Return type