Zippendo Ruby SDK

https://github.com/zippendo/zippendo-ruby
Admin
Official Ruby SDK for the Zippendo shipping and logistics API, letting developers book shipments,...
Tokens:615,334
Snippets:4,246
Trust Score:7.5
License:MIT
Update:6 days ago
Show doc for...
Tokens:
Raw
### get_address example with bearerAuth setup

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

Shows how to call get_address with a bearer token. Requires the 'time' and 'zippendo' gems and a valid bearer token. The example prints the result or catches a Zippendo::ApiError.

```ruby
require 'time'
require 'zippendo'
# setup authorization
Zippendo.configure do |config|
  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Zippendo::AddressesApi.new
org_id = 'org_01HZX9K2QF' # String | Organization ID
address_id = 'addr_01HZX9K2QF' # String | Address ID

begin
  # Get address
  result = api_instance.get_address(org_id, address_id)
  p result
rescue Zippendo::ApiError => e
  puts "Error when calling AddressesApi->get_address: #{e}"
end
```

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

### CreateShippingQuote200ResponseRatesInner initialization example

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateShippingQuote200ResponseRatesInner.md

Shows how to instantiate a Zippendo::CreateShippingQuote200ResponseRatesInner object with all required and optional properties. The example sets service_name, service_code, total_price, currency, description, delivery dates, carrier details, product_id, and shipping_rule_id.

```ruby
require 'zippendo'

instance = Zippendo::CreateShippingQuote200ResponseRatesInner.new(
  service_name: Standard DK,
  service_code: postnord:PNL13:rule_01HZX9K2QF,
  total_price: 3900,
  currency: DKK,
  description: Standard levering i Danmark,
  min_delivery_date: 2026-06-24,
  max_delivery_date: 2026-06-26,
  carrier_name: PostNord,
  carrier_slug: postnord,
  product_id: PNL13,
  shipping_rule_id: rule_01HZX9K2QF
)
```

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

### delete_address example with bearerAuth setup

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

Shows how to delete an address by providing org_id and address_id. Requires a bearer token configured via Zippendo.configure. Prints the returned String or catches Zippendo::ApiError.

```ruby
require 'time'
require 'zippendo'
# setup authorization
Zippendo.configure do |config|
  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Zippendo::AddressesApi.new
org_id = 'org_01HZX9K2QF' # String | Organization ID
address_id = 'addr_01HZX9K2QF' # String | Address ID

begin
  # Delete address
  result = api_instance.delete_address(org_id, address_id)
  p result
rescue Zippendo::ApiError => e
  puts "Error when calling AddressesApi->delete_address: #{e}"
end
```

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

### CreateShippingRule201Response initialization example in Ruby

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateShippingRule201Response.md

Shows how to instantiate the Zippendo::CreateShippingRule201Response model with all properties, including defaults like direction 'outbound' and various boolean flags. Values such as id, name, and carrier_id are shown as unquoted literals in the source example.

```ruby
require 'zippendo'

instance = Zippendo::CreateShippingRule201Response.new(
  id: rule_01HZX9K2QF,
  name: Standard DK,
  description: Standard levering i Danmark,
  direction: outbound,
  carrier_id: carr_01HZX9K2QF,
  product_id: PNL13,
  services: ["EMAIL_NOTIFICATION"],
  additional_parameters: {"returnFunctionality":"LABELLESS","returnQrEmail":true},
  address_id: addr_01HZX9K2QF,
  receiving_countries: ["DK","SE"],
  email_notification: true,
  phone_notification: false,
  min_weight: 0,
  max_weight: 20,
  min_order_value: 0,
  max_order_value: 5000,
  conditions: [{"type":"flatRate","shippingPrice":39,"currency":"DKK"}],
  generate_proforma_invoice: false,
  generate_commercial_invoice: false,
  generate_packing_list: false,
  auto_print_labels: false,
  auto_print_documents: false,
  label_printer_id: null,
  document_printer_id: null,
  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
)
```

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

### CreateOrderChannelRequest initialization example

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateOrderChannelRequest.md

Shows how to construct a Zippendo::CreateOrderChannelRequest instance in Ruby. The example sets name, type, brand_id, enabled, role, and settings fields; note that brand_id, enabled, role, and settings are optional, with enabled defaulting to true and role defaulting to 'orders_and_rates'.

```ruby
require 'zippendo'

instance = Zippendo::CreateOrderChannelRequest.new(
  name: Anna's webshop,
  type: custom,
  brand_id: brnd_8f3kd92ld0,
  enabled: true,
  role: orders_and_rates,
  settings: null
)
```

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

### CreateOrgWebhook201Response example

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateOrgWebhook201Response.md

Shows how to instantiate a Zippendo::CreateOrgWebhook201Response object with all properties set. The example uses the zippendo gem and includes sample values for id, name, url, secret, events, is_active, brand_id, created_at, and updated_at.

```ruby
require 'zippendo'

instance = Zippendo::CreateOrgWebhook201Response.new(
  id: wh_clx1a2b3c4,
  name: Order fulfilment notifier,
  url: https://hooks.example.dk/zippendo,
  secret: whsec_8f3a1c2b9d4e5f6a,
  events: [&quot;shipment.created&quot;],
  is_active: true,
  brand_id: brnd_8f3kd92ld0,
  created_at: 2026-06-01T09:30:00.000Z,
  updated_at: 2026-06-10T11:15:00.000Z
)
```

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

### get_address_with_http_info variant example

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

Shows how to call get_address_with_http_info, which returns an array containing the response data, status code, and headers. The example prints status_code, headers, and data, and catches a Zippendo::ApiError.

```ruby
begin
  # Get address
  data, status_code, headers = api_instance.get_address_with_http_info(org_id, address_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ListAddresses200ResponseDataInner>
rescue Zippendo::ApiError => e
  puts "Error when calling AddressesApi->get_address_with_http_info: #{e}"
end
```

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

### Instantiate ListOrders200Response with example values

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/ListOrders200Response.md

Shows how to create a Zippendo::ListOrders200Response instance with the required 'zippendo' require. The example sets data to null and provides numeric values for total, page, limit, and total_pages.

```ruby
require 'zippendo'

instance = Zippendo::ListOrders200Response.new(
  data: null,
  total: 137,
  page: 1,
  limit: 20,
  total_pages: 7
)
```

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

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

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

Lists all shipping rules for an organization.

```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)
- **Array<ShippingRule>** - List of shipping rules
```

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

### CreateShippingRuleRequestConditionsInnerOneOf4 initialization example

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateShippingRuleRequestConditionsInnerOneOf4.md

Shows how to instantiate Zippendo::CreateShippingRuleRequestConditionsInnerOneOf4 with a flatRate type, shipping price, and currency. Requires the 'zippendo' gem. The example uses type: flatRate, shipping_price: 39, and currency: DKK.

```ruby
require 'zippendo'

instance = Zippendo::CreateShippingRuleRequestConditionsInnerOneOf4.new(
  type: flatRate,
  shipping_price: 39,
  currency: DKK
)
```

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

### CreateShipment201ResponseActivitiesInner example

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateShipment201ResponseActivitiesInner.md

Shows how to instantiate the Zippendo::CreateShipment201ResponseActivitiesInner model with the required properties id, action, description, and created_at, plus the optional metadata. The example requires the 'zippendo' gem.

```ruby
require 'zippendo'

instance = Zippendo::CreateShipment201ResponseActivitiesInner.new(
  id: act_1d2e3f4a,
  action: created,
  description: Shipment created,
  metadata: null,
  created_at: 2026-06-22T14:30:00.000Z
)
```

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

### CreateShipment201ResponseDocumentsInner initialization example

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateShipment201ResponseDocumentsInner.md

Shows how to instantiate the Zippendo::CreateShipment201ResponseDocumentsInner model with all documented properties. The size field defaults to 'A4' when not provided. The content field expects Base64-encoded document/label content.

```ruby
require 'zippendo'

instance = Zippendo::CreateShipment201ResponseDocumentsInner.new(
  id: doc_8f3a2b1c,
  shipment_id: shp_4d9e7a2f,
  document_type: label,
  format: pdf,
  content: JVBERi0xLjQKJeLjz9MKMS...,
  size: 100X150,
  created_at: 2026-06-22T14:30:00.000Z,
  updated_at: 2026-06-22T14:30:00.000Z
)
```

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

### Create address with create_address_with_http_info variant

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

Uses the create_address_with_http_info variant to get an Array containing response data, status code, and headers. The example prints the status code (2xx), headers, and data object. Errors are caught as Zippendo::ApiError.

```ruby
begin
  # Create address
  data, status_code, headers = api_instance.create_address_with_http_info(org_id, create_address_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ListAddresses200ResponseDataInner>
rescue Zippendo::ApiError => e
  puts "Error when calling AddressesApi->create_address_with_http_info: #{e}"
end
```

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

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

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/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)
Returns a list of addresses.

#### Response Example
[
  {
    "id": "addr_123",
    "name": "Zippendo ApS",
    "address1": "Vesterbrogade 1",
    "zipcode": "1620",
    "city": "København",
    "phone": "+4533123456",
    "country_code": "DK",
    "email": "lager@example.dk"
  }
]
```

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

### CreateShipment201ResponsePartiesInner initialization example

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateShipment201ResponsePartiesInner.md

Shows how to instantiate a Zippendo::CreateShipment201ResponsePartiesInner object with party details such as type, name, address, contact info, and attributes. The attributes field is optional and set to null in this example.

```ruby
require 'zippendo'

instance = Zippendo::CreateShipment201ResponsePartiesInner.new(
  type: receiver,
  name: Anna Jensen,
  attention: Reception,
  address1: Vesterbrogade 12,
  address2: 2. sal,
  postal_code: 1620,
  city: København V,
  country_code: DK,
  email: anna@example.dk,
  phone: +4520123456,
  attributes: null
)
```

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

### Create ListAvailableCarriers200ResponseInnerRequiredFieldsInner instance

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.md

Shows how to instantiate the Zippendo::ListAvailableCarriers200ResponseInnerRequiredFieldsInner model with example field values. Requires the 'zippendo' gem. The example sets name, key, type, options, description, and required fields.

```ruby
require 'zippendo'

instance = Zippendo::ListAvailableCarriers200ResponseInnerRequiredFieldsInner.new(
  name: Customer number,
  key: customerNumber,
  type: string,
  options: null,
  description: Your PostNord customer number,
  required: true
)
```

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

### Create ListOrders200ResponseDataInnerOrderChannel instance

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/ListOrders200ResponseDataInnerOrderChannel.md

Constructs a Zippendo::ListOrders200ResponseDataInnerOrderChannel object with id, name, and type fields. The example uses a Shopify store channel with a sample ID and type.

```ruby
require 'zippendo'

instance = Zippendo::ListOrders200ResponseDataInnerOrderChannel.new(
  id: clz9k2f0a0001abcd1234efgh,
  name: Anna&#39;s Shopify Store,
  type: shopify
)
```

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

### CreateShippingQuoteRequestItemsInner example

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateShippingQuoteRequestItemsInner.md

Shows how to instantiate Zippendo::CreateShippingQuoteRequestItemsInner with the required and optional properties. The example sets name, quantity, grams, and price, with optional sku, product_id, and variant_id.

```ruby
require 'zippendo'

instance = Zippendo::CreateShippingQuoteRequestItemsInner.new(
  name: Uld trøje,
  sku: SKU-1001,
  quantity: 2,
  grams: 500,
  price: 29900,
  product_id: prod_01HZX9K2QF,
  variant_id: var_01HZX9K2QF
)
```

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

### Create ListCarrierProductServicePoints200ResponseInner instance

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/ListCarrierProductServicePoints200ResponseInner.md

Initializes a Zippendo::ListCarrierProductServicePoints200ResponseInner object with example values for latitude, longitude, name, service point ID, opening hours, description, distance, and address. Requires the 'zippendo' gem. The opening_hours and address fields are optional and set to null in this example.

```ruby
require 'zippendo'

instance = Zippendo::ListCarrierProductServicePoints200ResponseInner.new(
  lat: 55.6761,
  lng: 12.5683,
  name: PostNord Pakkeshop Netto,
  service_point_id: 1234567,
  opening_hours: null,
  description: Located inside Netto supermarket,
  distance: 320,
  address: null
)
```

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

### Create shipping rule with bearerAuth setup

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

Configures Bearer authorization (JWT) with an access token, then creates a shipping rule using the RulesApi. The request includes organization ID, rule name, carrier, product, services, address, receiving countries, and conditions. Prints the result or catches Zippendo::ApiError.

```Ruby
require 'time'
require 'zippendo'
# setup authorization
Zippendo.configure do |config|
  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Zippendo::RulesApi.new
org_id = 'org_01HZX9K2QF' # String | Organization ID
create_shipping_rule_request = Zippendo::CreateShippingRuleRequest.new({name: 'Standard DK', carrier_id: 'carr_01HZX9K2QF', product_id: 'PNL13', services: ["EMAIL_NOTIFICATION"], address_id: 'addr_01HZX9K2QF', receiving_countries: ["DK", "SE"], conditions: [{"type": "flatRate", "shippingPrice": 39, "currency": "DKK"}]}) # CreateShippingRuleRequest | 

begin
  # Create shipping rule
  result = api_instance.create_shipping_rule(org_id, create_shipping_rule_request)
  p result
rescue Zippendo::ApiError => e
  puts "Error when calling RulesApi->create_shipping_rule: #{e}"
end
```

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

### Create ListOrderChannels200ResponseDataInnerSettings instance

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/ListOrderChannels200ResponseDataInnerSettings.md

Constructs a new settings object for a channel order list response. Requires the 'zippendo' gem. All properties are optional except use_webhooks and auto_sync which have defaults; unset optional fields are omitted. The example shows typical values for webhook configuration, auto-fulfillment, polling, and shipping mappings.

```ruby
require 'zippendo'

instance = Zippendo::ListOrderChannels200ResponseDataInnerSettings.new(
  use_webhooks: true,
  webhook_id: gid://shopify/WebhookSubscription/12345,
  webhook_ids: [12,13,14],
  webhook_secret_created_at: 2026-06-22T14:30Z,
  site_url: https://butik.dk,
  auto_fulfill: true,
  checkout_token_created_at: 2026-06-22T14:30Z,
  auto_sync: false,
  sync_interval_minutes: 15,
  auto_ship_on_create: false,
  default_carrier_id: clz9k2f0a0006abcd1357yzab,
  default_product_id: postnord-home-delivery,
  default_address_id: clz9k2f0a0005abcd7890uvwx,
  shipping_method_mappings: [{"match":"GLS Hjemmelevering","shippingRuleId":"clz9k2f0a0007abcd2468qrst"}],
  sync_only_unfulfilled: true,
  sync_orders_since: 2026-05-22T00:00Z,
  service_point_count: 6
)
```

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

### Create ListCarrierProductServicePointsRequest instance

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/ListCarrierProductServicePointsRequest.md

Initializes a Zippendo::ListCarrierProductServicePointsRequest object with address fields. The example sets address1, address2, postal_code, state, city, and country_code; note that state is null and postal_code is provided as a number rather than a string.

```ruby
require 'zippendo'

instance = Zippendo::ListCarrierProductServicePointsRequest.new(
  address1: Vesterbrogade 1,
  address2: 2. sal,
  postal_code: 1620,
  state: null,
  city: København,
  country_code: DK
)
```

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

### CreateShipmentRequestPickupDetails example

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateShipmentRequestPickupDetails.md

Creates a new instance of Zippendo::CreateShipmentRequestPickupDetails with pickup date, time range, and optional instruction. The date and time values are shown as unquoted literals in the source example.

```ruby
require 'zippendo'

instance = Zippendo::CreateShipmentRequestPickupDetails.new(
  date: 2026-06-22,
  from: 08:00:00,
  to: 16:00:00,
  instruction: Ring the bell at the loading dock.
)
```

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

### CreateOrgBrandRequest example

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateOrgBrandRequest.md

Constructs a Zippendo::CreateOrgBrandRequest instance with all properties. Note that the example omits quotes around string values and the hash, which would be invalid Ruby as written.

```ruby
require 'zippendo'

instance = Zippendo::CreateOrgBrandRequest.new(
  company_name: Acme ApS,
  vat_number: DK12345678,
  customs: {"eori":"DK12345678"},
  address_line1: Vestergade 12,
  address_line2: 3. sal,
  city: København,
  postal_code: 1456,
  country: DK,
  primary_color: #1D4ED8,
  secondary_color: #F59E0B,
  name: Acme,
  slug: acme,
  use_org_customs: true
)
```

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

### Initialize Zippendo::ListCarriers200ResponseDataInner

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/ListCarriers200ResponseDataInner.md

Creates a new instance of the Zippendo::ListCarriers200ResponseDataInner model with example carrier data. Requires the 'zippendo' gem. The config hash contains carrier-specific fields like customerNumber.

```ruby
require 'zippendo'

instance = Zippendo::ListCarriers200ResponseDataInner.new(
  id: carr_01HZX9K2QF,
  name: PostNord,
  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,
  brand_color: #005BAA,
  deprecated: true,
  deprecation_message: The standalone Instabox API is deprecated. Migrate to the Instabee-powered Instabox integration.,
  beta: true,
  generates_customs_documents: true,
  generates_commercial_invoice: true
)
```

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

### Initialize ListOrderChannels200ResponseDataInner in Ruby

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/ListOrderChannels200ResponseDataInner.md

Creates a new instance of Zippendo::ListOrderChannels200ResponseDataInner with sample values for all properties. Requires the 'zippendo' gem. Note that string values are shown without quotes in the example, and HTML entities like &#39; and &quot; represent apostrophes and quotes in the original source.

```ruby
require 'zippendo'

instance = Zippendo::ListOrderChannels200ResponseDataInner.new(
  id: clz9k2f0a0001abcd1234efgh,
  name: Anna&#39;s Shopify Store,
  type: shopify,
  enabled: true,
  role: orders_and_rates,
  brand_id: brnd_8f3kd92ld0,
  has_credentials: true,
  settings: null,
  webhooks_enabled: true,
  last_sync_at: 2026-06-22T14:30Z,
  last_sync_error: Invalid API credentials,
  shipping_rule_ids: [&quot;clz9k2f0a0002abcd5678ijkl&quot;],
  org_id: clz9k2f0a0000abcd0000zzzz,
  created_at: 2026-06-22T14:30:00.000Z,
  updated_at: 2026-06-22T14:30:00.000Z
)
```

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

### Create BatchSendShipments200ResponseSummary instance

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/BatchSendShipments200ResponseSummary.md

Use this Ruby example to instantiate a Zippendo::BatchSendShipments200ResponseSummary object with the total, sent, failed, and skipped properties. The example requires the 'zippendo' gem and sets total to 3, sent to 2, failed to 1, and skipped to 0.

```ruby
require 'zippendo'

instance = Zippendo::BatchSendShipments200ResponseSummary.new(
  total: 3,
  sent: 2,
  failed: 1,
  skipped: 0
)
```

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

### Initialize GetOrder200ResponseShipmentsInnerParcelsInner in Ruby

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/GetOrder200ResponseShipmentsInnerParcelsInner.md

Creates a new instance of Zippendo::GetOrder200ResponseShipmentsInnerParcelsInner with the documented properties. The example sets id, weight, weight_unit, dimensions, and order_lines; dimensions and order_lines are shown as null. Requires the 'zippendo' gem.

```ruby
require 'zippendo'

instance = Zippendo::GetOrder200ResponseShipmentsInnerParcelsInner.new(
  id: prc_5a6b7c8d,
  weight: 2.5,
  weight_unit: kg,
  dimensions: null,
  order_lines: null
)
```

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

### Create ListApiTokens200ResponseDataInner instance

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/ListApiTokens200ResponseDataInner.md

Constructs a new instance of Zippendo::ListApiTokens200ResponseDataInner with example values. Requires the 'zippendo' gem. The example shows typical token metadata including scopes, brand restriction, and timestamps.

```ruby
require 'zippendo'

instance = Zippendo::ListApiTokens200ResponseDataInner.new(
  id: tok_6e2fa83ij9,
  name: Warehouse integration,
  token_prefix: zipp_live_8f,
  scopes: [&quot;read:shipments&quot;,&quot;write:shipments&quot;],
  brand_id: brnd_8f3kd92ld0,
  last_used_at: 2026-06-22T14:30:00.000Z,
  expires_at: 2026-09-20T14:30:00.000Z,
  created_at: 2026-06-22T14:30:00.000Z,
  created_by: null
)
```

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

### Create ListShipments200Response instance

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/ListShipments200Response.md

Shows how to instantiate Zippendo::ListShipments200Response with example values for paginated shipment results. The data field is set to null in this example.

```ruby
require 'zippendo'

instance = Zippendo::ListShipments200Response.new(
  data: null,
  total: 137,
  page: 1,
  limit: 20,
  total_pages: 7
)
```

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

### CreateAddressRequest example

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateAddressRequest.md

Constructs a Zippendo::CreateAddressRequest instance with all properties, including optional fields like customs and address_types. The example shows required fields such as name, address1, zipcode, city, phone, country_code, and email. Note that string values are not quoted in the source example.

```ruby
require 'zippendo'

instance = Zippendo::CreateAddressRequest.new(
  name: Zippendo ApS,
  description: Main warehouse, Copenhagen,
  att_contact: Mette Hansen,
  address1: Vesterbrogade 1,
  address2: 2. sal,
  zipcode: 1620,
  city: København,
  phone: +4533123456,
  country_code: DK,
  state: Hovedstaden,
  email: lager@example.dk,
  customs: {"eori":"DK12345678"},
  address_types: ["sender"],
  brand_id: brnd_8f3kd92ld0
)
```

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

### CreateShippingRuleRequestConditionsInnerOneOf example

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateShippingRuleRequestConditionsInnerOneOf.md

Constructs an instance of Zippendo::CreateShippingRuleRequestConditionsInnerOneOf with weight condition fields. The example sets type to 'weight', min and max in kg, shipping_price, and currency.

```ruby
require 'zippendo'

instance = Zippendo::CreateShippingRuleRequestConditionsInnerOneOf.new(
  type: weight,
  min: 0,
  max: 5,
  shipping_price: 39,
  currency: DKK
)
```

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

### CreateShipmentRequestPartiesInnerAttributesInner example

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateShipmentRequestPartiesInnerAttributesInner.md

Shows how to instantiate a Zippendo::CreateShipmentRequestPartiesInnerAttributesInner object with name and value attributes.

```ruby
require 'zippendo'

instance = Zippendo::CreateShipmentRequestPartiesInnerAttributesInner.new(
  name: vatNumber,
  value: DK12345678
)
```

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

### Get carrier with get_carrier_with_http_info variant

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

Returns an Array containing response data, status code, and headers. The example prints status_code (2xx), headers, and data. Requires the same setup as the get_carrier example.

```ruby
begin
  # Get carrier
  data, status_code, headers = api_instance.get_carrier_with_http_info(org_id, carrier_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ListCarriers200ResponseDataInner>
rescue Zippendo::ApiError => e
  puts "Error when calling CarriersApi->get_carrier_with_http_info: #{e}"
end
```

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

### Ruby example for ListCarrierProducts200ResponseInnerAdditionalParametersInner

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/ListCarrierProducts200ResponseInnerAdditionalParametersInner.md

Shows how to create an instance of Zippendo::ListCarrierProducts200ResponseInnerAdditionalParametersInner with sample values. Requires the 'zippendo' gem.

```ruby
require 'zippendo'

instance = Zippendo::ListCarrierProducts200ResponseInnerAdditionalParametersInner.new(
  name: Return Mode,
  key: returnFunctionality,
  type: enum,
  options: null,
  description: Instruction shown to the delivery driver,
  is_required: false,
  required_service: null
)
```

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

### Create a SplitShipment201Response instance

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/SplitShipment201Response.md

Use this example to instantiate a Zippendo::SplitShipment201Response object with the original_shipment and new_shipment properties. The example requires the 'zippendo' gem and sets both properties to null.

```ruby
require 'zippendo'

instance = Zippendo::SplitShipment201Response.new(
  original_shipment: null,
  new_shipment: null
)
```

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

### List brands with list_org_brands_with_http_info variant

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

Uses the list_org_brands_with_http_info variant to get an Array containing response data, status code, and headers. The example prints status_code (e.g., 2xx), headers, and data (a ListOrgBrands200Response). Requires the same setup as the basic list_org_brands example.

```ruby
begin
  # List brands
  data, status_code, headers = api_instance.list_org_brands_with_http_info(org_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ListOrgBrands200Response>
rescue Zippendo::ApiError => e
  puts "Error when calling BrandsApi->list_org_brands_with_http_info: #{e}"
end
```

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

### Create ListShippingRules200ResponseDataInnerConditionsInnerOneOf2 instance

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.md

Use this Ruby example to instantiate the Zippendo::ListShippingRules200ResponseDataInnerConditionsInnerOneOf2 model with a price range condition. The example sets type to 'priceRange', price_type to 'total', min to 0, max to 499, shipping_price to 49, and currency to 'DKK'. Requires the 'zippendo' gem.

```ruby
require 'zippendo'

instance = Zippendo::ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.new(
  type: priceRange,
  price_type: total,
  min: 0,
  max: 499,
  shipping_price: 49,
  currency: DKK
)
```

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

### Update address with update_address_with_http_info variant

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

Returns an Array containing the response data, status code, and headers. The example calls update_address_with_http_info with the same parameters and prints status_code, headers, and data. Catches Zippendo::ApiError on failure.

```ruby
begin
  # Update address
  data, status_code, headers = api_instance.update_address_with_http_info(org_id, address_id, update_address_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ListAddresses200ResponseDataInner>
rescue Zippendo::ApiError => e
  puts "Error when calling AddressesApi->update_address_with_http_info: #{e}"
end
```

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

### CreateShippingRuleRequestConditionsInnerOneOf1 example

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateShippingRuleRequestConditionsInnerOneOf1.md

Constructs an instance of Zippendo::CreateShippingRuleRequestConditionsInnerOneOf1 with the required and optional properties. The example sets type to 'price', price_type to 'total', operator to 'gte', value to 500, shipping_price to 0, and currency to 'DKK'.

```ruby
require 'zippendo'

instance = Zippendo::CreateShippingRuleRequestConditionsInnerOneOf1.new(
  type: price,
  price_type: total,
  operator: gte,
  value: 500,
  shipping_price: 0,
  currency: DKK
)
```

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

### Create ListOrgWebhookDeliveries200ResponseDataInner instance

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/ListOrgWebhookDeliveries200ResponseDataInner.md

Instantiate the Zippendo::ListOrgWebhookDeliveries200ResponseDataInner model with all documented properties. The example shows typical values for a webhook delivery log, including the delivery ID, webhook ID, event type, payload, status code, response, duration, success flag, attempt number, error, and creation timestamp.

```ruby
require 'zippendo'

instance = Zippendo::ListOrgWebhookDeliveries200ResponseDataInner.new(
  id: whd_clx9z8y7x6,
  webhook_id: wh_clx1a2b3c4,
  event: shipment.created,
  payload: {"id":"shp_123"},
  status_code: 200,
  response: OK,
  duration: 142,
  success: true,
  attempt: 1,
  error: null,
  created_at: 2026-06-10T11:16:00.000Z
)
```

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

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

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

Retrieves a shipping rule by its ID.

```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
```

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

### CreateShipment201ResponsePickupDetails example

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateShipment201ResponsePickupDetails.md

Shows how to instantiate Zippendo::CreateShipment201ResponsePickupDetails with pickup date, time range, and optional instruction.

```ruby
require 'zippendo'

instance = Zippendo::CreateShipment201ResponsePickupDetails.new(
  date: 2026-06-22,
  from: 08:00:00,
  to: 16:00:00,
  instruction: Ring the bell at the loading dock.
)
```

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

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

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/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)
Returns the address object.

#### Response Example
{
  "id": "addr_123",
  "name": "Zippendo ApS",
  "address1": "Vesterbrogade 1",
  "zipcode": "1620",
  "city": "København",
  "phone": "+4533123456",
  "country_code": "DK",
  "email": "lager@example.dk"
}
```

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

### Create UpdateOrderChannelRequest instance

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/UpdateOrderChannelRequest.md

Constructs a Zippendo::UpdateOrderChannelRequest object with optional fields for updating an order channel. The role field accepts 'orders_and_rates' (default) or 'rates_only'; credentials and settings are type-specific and can be null. The example shows a brand_id, name, enabled flag, role, null credentials/settings, and a shipping_rule_ids array.

```ruby
require 'zippendo'

instance = Zippendo::UpdateOrderChannelRequest.new(
  brand_id: brnd_8f3kd92ld0,
  name: Anna's Shopify Store,
  enabled: true,
  role: orders_and_rates,
  credentials: null,
  settings: null,
  shipping_rule_ids: ["clz9k2f0a0002abcd5678ijkl"]
)
```

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

### Create ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner instance

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.md

Instantiates the Zippendo model with name, key, and value fields. The example shows a Standard option with key 'standard' and value 'STD'.

```ruby
require 'zippendo'

instance = Zippendo::ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.new(
  name: Standard,
  key: standard,
  value: STD
)
```

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

### Get carrier with get_carrier

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

Returns a single connected carrier. Requires a bearer token (JWT) configured via Zippendo.configure. The example uses org_id 'org_01HZX9K2QF' and carrier_id 'carr_01HZX9K2QF'.

```ruby
require 'time'
require 'zippendo'
# setup authorization
Zippendo.configure do |config|
  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Zippendo::CarriersApi.new
org_id = 'org_01HZX9K2QF' # String | Organization ID
carrier_id = 'carr_01HZX9K2QF' # String | Carrier ID

begin
  # Get carrier
  result = api_instance.get_carrier(org_id, carrier_id)
  p result
rescue Zippendo::ApiError => e
  puts "Error when calling CarriersApi->get_carrier: #{e}"
end
```

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

### Get shipping rule with get_shipping_rule

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

Returns a single shipping rule with its carrier, address and printer relations. Requires bearerAuth authorization and an organization ID and shipping rule ID.

```ruby
require 'time'
require 'zippendo'
# setup authorization
Zippendo.configure do |config|
  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Zippendo::RulesApi.new
org_id = 'org_01HZX9K2QF' # String | Organization ID
rule_id = 'rule_01HZX9K2QF' # String | Shipping Rule ID

begin
  # Get shipping rule
  result = api_instance.get_shipping_rule(org_id, rule_id)
  p result
rescue Zippendo::ApiError => e
  puts "Error when calling RulesApi->get_shipping_rule: #{e}"
end
```

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

### CreateApiToken201Response example in Ruby

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateApiToken201Response.md

Shows how to instantiate a Zippendo::CreateApiToken201Response object with all properties, including the full API token that is only shown once.

```ruby
require 'zippendo'

instance = Zippendo::CreateApiToken201Response.new(
  id: tok_6e2fa83ij9,
  name: Warehouse integration,
  token_prefix: zipp_live_8f,
  scopes: [&quot;read:shipments&quot;,&quot;write:shipments&quot;],
  brand_id: brnd_8f3kd92ld0,
  last_used_at: 2026-06-22T14:30:00.000Z,
  expires_at: 2026-09-20T14:30:00.000Z,
  created_at: 2026-06-22T14:30:00.000Z,
  token: zipp_live_8f3kd92ld0a7b6c5d4e3f2a1
)
```

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

### Call list_carrier_product_service_points_with_http_info variant

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

Returns an Array containing response data, status code, and headers. The example prints the status code (2xx), headers, and data. Requires the same setup as the basic variant.

```ruby
begin
  # List product service points
  data, status_code, headers = api_instance.list_carrier_product_service_points_with_http_info(org_id, carrier_id, product_id, list_carrier_product_service_points_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<ListCarrierProductServicePoints200ResponseInner>>
rescue Zippendo::ApiError => e
  puts "Error when calling CarriersApi->list_carrier_product_service_points_with_http_info: #{e}"
end
```

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

### Create order channel with create_order_channel_with_http_info variant

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

Returns an Array containing response data, status code, and headers. The example prints status_code (2xx), headers, and data. Requires the same setup as the basic variant.

```ruby
begin
  # Create order channel
  data, status_code, headers = api_instance.create_order_channel_with_http_info(org_id, create_order_channel_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ListOrderChannels200ResponseDataInner>
rescue Zippendo::ApiError => e
  puts "Error when calling OrderChannelsApi->create_order_channel_with_http_info: #{e}"
end
```

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

### CreateOrderChannelRequestSettingsShippingMethodMappingsInner initialization

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.md

Initializes a shipping method mapping for an order channel request. The match field is trimmed, case-insensitive, and exact; service_point_selection is optional and can be 'nearest' or 'manual'.

```ruby
require 'zippendo'

instance = Zippendo::CreateOrderChannelRequestSettingsShippingMethodMappingsInner.new(
  match: GLS Hjemmelevering,
  shipping_rule_id: clz9k2f0a0007abcd2468qrst,
  service_point_selection: nearest
)
```

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

### Connect carrier with connect_carrier_with_http_info variant

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

Returns an Array containing response data, status code, and headers. The example prints status_code (2xx), headers, and data. Requires the same authorization setup as the standard variant.

```ruby
begin
  # Connect carrier
  data, status_code, headers = api_instance.connect_carrier_with_http_info(org_id, connect_carrier_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ListCarriers200ResponseDataInner>
rescue Zippendo::ApiError => e
  puts "Error when calling CarriersApi->connect_carrier_with_http_info: #{e}"
end
```

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

### CreateShippingQuote400Response example

Source: https://github.com/zippendo/zippendo-ruby/blob/main/docs/CreateShippingQuote400Response.md

Shows how to instantiate a Zippendo::CreateShippingQuote400Response object with error and message fields.

```ruby
require 'zippendo'

instance = Zippendo::CreateShippingQuote400Response.new(
  error: Bad Request,
  message: Invalid destination country
)
```

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

### Get webhook with get_org_webhook_with_http_info variant

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

Returns an Array containing response data, status code, and headers. The example calls get_org_webhook_with_http_info with the same parameters and prints the status code, headers, and data, handling ApiError similarly.

```ruby
begin
  # Get webhook
  data, status_code, headers = api_instance.get_org_webhook_with_http_info(org_id, webhook_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CreateOrgWebhook201Response>
rescue Zippendo::ApiError => e
  puts "Error when calling WebhooksApi->get_org_webhook_with_http_info: #{e}"
end
```

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

### Delete webhook with http_info variant

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

Uses the delete_org_webhook_with_http_info variant to get an Array containing response data, status code, and headers. The example prints the status code, headers, and data, and catches Zippendo::ApiError.

```ruby
begin
  # Delete webhook
  data, status_code, headers = api_instance.delete_org_webhook_with_http_info(org_id, webhook_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DeleteOrgWebhook200Response>
rescue Zippendo::ApiError => e
  puts "Error when calling WebhooksApi->delete_org_webhook_with_http_info: #{e}"
end
```

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

### Get shipping rule with get_shipping_rule_with_http_info variant

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

Returns an Array containing response data, status code, and headers. Use this variant when you need the HTTP status code and headers in addition to the response data.

```ruby
begin
  # Get shipping rule
  data, status_code, headers = api_instance.get_shipping_rule_with_http_info(org_id, rule_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ListShippingRules200ResponseDataInner>
rescue Zippendo::ApiError => e
  puts "Error when calling RulesApi->get_shipping_rule_with_http_info: #{e}"
end
```

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

### Create resource clients

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

Instantiate resource clients for the API, such as `ShipmentsApi` and `OrdersApi`.

```ruby
shipments = Zippendo::ShipmentsApi.new
orders = Zippendo::OrdersApi.new
```
Tokens:
Raw