zippendo 1.3.7 → 1.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 339c4ca6aaae461f7d670d1499f46e2f0bd4c3fce2c03c6b5ac397b5485fd2a5
-  data.tar.gz: 012cabfb082e071a5a7141db72cc4d16315191b95533b947b055d39bd4392a55
+  metadata.gz: d5e5755b60b98b4e75b95ec499ad54d55a851617d5ba61d12c367688fd914660
+  data.tar.gz: c1917aa982689ef872c21ac05b3df54132f7d08ae7fd6de7d3115f6fc9ccd469
 SHA512:
-  metadata.gz: d0eb971aca04d5cedb746f2329b7de0f07822dbe50bc526ea98e468cc82a2a02cd3d78f8df2350fae87f6db13feb9fa9d45402af6dd4bb677853d04acc3232fe
-  data.tar.gz: 5e1a3673046c5dea33f694d4cdf42846eea6ccbbe73429e0f253e3f3375623033479415b35b6927319b186db5139f81f0ef7a27d6a1c8db7b770408aa452eb21
+  metadata.gz: f3511429f315f7075483ab29c026dc5df21cf2fbcc3595f42c06805779328048edeb3d640f08d3080c56de5a160904a241f207e536f5fcd1a607639cc9f3d8f5
+  data.tar.gz: e0a5c84eaff16133b4db4cd34eca6b9a57eadac2390f371b1b824af8d8acfa845102668975e60db56a79539de845201e315baab394600782d8951c51f0a1bc77

data/docs/BatchSendShipments200ResponseResultsInner.md

@@ -5,10 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **shipment_id** | **String** | The shipment this result refers to. |  |
-| **status** | **String** | `sent` when the carrier booked it, `failed` when the carrier or Zippendo rejected it, and `skipped` when the batch ran out of time before reaching it. A `skipped` shipment was never sent to the carrier and is safe to submit again. |  |
+| **status** | **String** | `sent` when the carrier accepted it, `failed` when the carrier or Zippendo rejected it, and `skipped` when the batch ran out of time before reaching it. A `skipped` shipment was never sent to the carrier and is safe to submit again. |  |
 | **code** | **String** | Canonical machine-readable error code, present when `status` is `failed` or `skipped`. | [optional] |
 | **message** | **String** | Human-readable detail, present when `status` is `failed` or `skipped`. | [optional] |
-| **errors** | [**Array<SendShipment422ResponseErrorsInner>**](SendShipment422ResponseErrorsInner.md) | Carrier-specific errors, present when the carrier rejected the booking. | [optional] |
+| **errors** | [**Array<SendShipment422ResponseErrorsInner>**](SendShipment422ResponseErrorsInner.md) | Carrier-specific errors, present when the carrier rejected the shipment. | [optional] |
 
 ## Example
 

data/docs/BatchSendShipments200ResponseSummary.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **total** | **Integer** | Number of unique shipments requested. |  |
-| **sent** | **Integer** | How many were successfully booked. |  |
+| **sent** | **Integer** | How many were sent successfully. |  |
 | **failed** | **Integer** | How many the carrier or Zippendo rejected. |  |
 | **skipped** | **Integer** | How many the batch ran out of time to attempt. Submit these again. |  |
 

data/docs/BatchSendShipmentsRequest.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **shipment_ids** | **Array<String>** | IDs of the shipments to book. Each must be in `pending` or `error` status; duplicates are ignored. Max 100 per request. |  |
+| **shipment_ids** | **Array<String>** | IDs of the shipments to send. Each must be in `pending` or `error` status; duplicates are ignored. Max 100 per request. |  |
 
 ## Example
 

data/docs/BrandsApi.md

@@ -592,7 +592,7 @@ end
 
 Update brand
 
-Updates a brand's name, slug, identity overrides (company name, VAT, customs, address) and document colours. Null clears an override so the organization's value applies again.
+Updates a brand's name, slug, identity overrides (company name, VAT, customs, address) and document colors. Null clears an override so the organization's value applies again.
 
 ### Examples
 

data/docs/CarriersApi.md

@@ -307,7 +307,7 @@ end
 
 List carrier products
 
-Returns the shipping products available for a connected carrier.
+Returns the carrier products available for a connected carrier.
 
 ### Examples
 

data/docs/CreateOrder201Response.md

@@ -14,7 +14,7 @@
 | **subtotal_amount** | **Float** | Order subtotal before shipping and tax. | [optional] |
 | **total_amount** | **Float** | Order grand total. | [optional] |
 | **currency** | **String** | ISO 4217 currency code. | [optional] |
-| **status** | **String** | Order fulfilment status derived from its shipments. |  |
+| **status** | **String** | Order fulfillment status derived from its shipments. |  |
 | **shipping_rule_id** | **String** | ID of the applied shipping rule. | [optional] |
 | **notes** | **String** | Free-form internal notes. | [optional] |
 | **external_data** | **Hash<String, Object>** | Raw platform-specific payload for reference. | [optional] |

data/docs/CreateOrder201ResponseShippingAddress.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Recipient full name. |  |
+| **name** | **String** | Receiver full name. |  |
 | **attention** | **String** | Attention / care-of line. | [optional] |
 | **company** | **String** | Company name. | [optional] |
 | **address1** | **String** | Street address line 1. |  |
@@ -15,8 +15,8 @@
 | **postal_code** | **String** | Postal code. |  |
 | **country** | **String** | Country name. | [optional] |
 | **country_code** | **String** | ISO 3166-1 alpha-2 country code. |  |
-| **phone** | **String** | Recipient phone number. | [optional] |
-| **email** | **String** | Recipient email address. | [optional] |
+| **phone** | **String** | Receiver phone number. | [optional] |
+| **email** | **String** | Receiver email address. | [optional] |
 
 ## Example
 

data/docs/CreateOrderChannelRequest.md

@@ -8,7 +8,7 @@
 | **type** | **String** | Type of the order channel. Platform channels (Shopify, WooCommerce) are created via their connect flows. |  |
 | **brand_id** | **String** | Brand this channel belongs to; null for organization-wide | [optional] |
 | **enabled** | **Boolean** | Whether the channel is active. | [optional][default to true] |
-| **role** | **String** | What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfilment or tracking is pushed back to the platform. | [optional][default to 'orders_and_rates'] |
+| **role** | **String** | What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfillment or tracking is pushed back to the platform. | [optional][default to 'orders_and_rates'] |
 | **settings** | [**CreateOrderChannelRequestSettings**](CreateOrderChannelRequestSettings.md) |  | [optional] |
 
 ## Example

data/docs/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **match** | **String** | Shipping-method title to match against imported orders (trimmed, case-insensitive, exact). |  |
 | **shipping_rule_id** | **String** | Shipping rule applied to orders whose shipping-method title matches. |  |
-| **service_point_selection** | **String** | For rules whose product delivers to a service point: 'nearest' auto-selects the closest point to the recipient address; 'manual' keeps the shipment in draft for manual selection. | [optional] |
+| **service_point_selection** | **String** | For rules whose product delivers to a service point: 'nearest' auto-selects the closest point to the receiver's address; 'manual' keeps the shipment in draft for manual selection. | [optional] |
 
 ## Example
 

data/docs/CreateOrderRequestShippingAddress.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Recipient full name. |  |
+| **name** | **String** | Receiver full name. |  |
 | **attention** | **String** | Attention / care-of line. | [optional] |
 | **company** | **String** | Company name. | [optional] |
 | **address1** | **String** | Street address line 1. |  |
@@ -15,8 +15,8 @@
 | **postal_code** | **String** | Postal code. |  |
 | **country** | **String** | Country name. | [optional] |
 | **country_code** | **String** | ISO 3166-1 alpha-2 country code. |  |
-| **phone** | **String** | Recipient phone number. | [optional] |
-| **email** | **String** | Recipient email address. | [optional] |
+| **phone** | **String** | Receiver phone number. | [optional] |
+| **email** | **String** | Receiver email address. | [optional] |
 
 ## Example
 

data/docs/CreateOrgBrandRequest.md

@@ -12,8 +12,8 @@
 | **city** | **String** | City | [optional] |
 | **postal_code** | **String** | Postal code | [optional] |
 | **country** | **String** | Country (ISO 3166-1 alpha-2) | [optional] |
-| **primary_color** | **String** | Primary brand colour — document title and table headers | [optional] |
-| **secondary_color** | **String** | Secondary brand colour — subtitle, section headings, totals accent | [optional] |
+| **primary_color** | **String** | Primary brand color — document title and table headers | [optional] |
+| **secondary_color** | **String** | Secondary brand color — subtitle, section headings, totals accent | [optional] |
 | **name** | **String** | Brand display name |  |
 | **slug** | **String** | URL-safe identifier, unique within the org. Derived from the name when omitted. | [optional] |
 | **use_org_customs** | **Boolean** | Whether this brand ships under the organization's fiscal identity. True (the default) declares the organization's VAT number and customs identifiers and ignores the brand's own. False makes the brand's own values the sole source — nothing falls back to the organization, so an identifier the brand has not set is not declared at all. | [optional] |

data/docs/CreateShipment201Response.md

@@ -7,7 +7,7 @@
 | **id** | **String** | Unique shipment identifier. |  |
 | **reference** | **String** | Customer-facing shipment reference. |  |
 | **address_id** | **String** | Sender address identifier. | [optional] |
-| **service_point_id** | **String** | Selected carrier service point identifier. | [optional] |
+| **service_point_id** | **String** | Selected service point ID. | [optional] |
 | **parties** | [**Array<CreateShipment201ResponsePartiesInner>**](CreateShipment201ResponsePartiesInner.md) | Parties involved in the shipment (sender, receiver, etc.). |  |
 | **type** | **String** | Direction of the shipment relative to the organization. |  |
 | **carrier_settings** | [**ListShipments200ResponseDataInnerCarrierSettings**](ListShipments200ResponseDataInnerCarrierSettings.md) |  |  |

data/docs/CreateShipmentRequest.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **reference** | **String** | Customer-facing shipment reference. | [optional] |
 | **address_id** | **String** | Sender address identifier. | [optional] |
-| **service_point_id** | **String** | Selected carrier service point identifier. | [optional] |
+| **service_point_id** | **String** | Selected service point ID. | [optional] |
 | **parties** | [**Array<CreateShipmentRequestPartiesInner>**](CreateShipmentRequestPartiesInner.md) | Parties involved in the shipment. Optional when orderId is provided. | [optional] |
 | **type** | **String** | Direction of the shipment relative to the organization. |  |
 | **carrier_settings** | [**CreateShipmentRequestCarrierSettings**](CreateShipmentRequestCarrierSettings.md) |  | [optional] |

data/docs/CreateShippingRule201Response.md

@@ -14,8 +14,8 @@
 | **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] |
-| **phone_notification** | **Boolean** | Send SMS notification to recipient | [default to false] |
+| **email_notification** | **Boolean** | Send an email notification to the receiver | [default to false] |
+| **phone_notification** | **Boolean** | Send an SMS notification to the receiver | [default to false] |
 | **min_weight** | **Float** | Minimum required weight in kg. Orders below this are excluded from the rule. |  |
 | **max_weight** | **Float** | Maximum allowed weight in kg. Orders exceeding this are excluded from the rule. |  |
 | **min_order_value** | **Float** | Minimum required order value in currency units. Orders below this are excluded from the rule. |  |
@@ -23,7 +23,7 @@
 | **conditions** | [**Array<ListShippingRules200ResponseDataInnerConditionsInner>**](ListShippingRules200ResponseDataInnerConditionsInner.md) | Rule conditions (weight/price/quantity) |  |
 | **generate_proforma_invoice** | **Boolean** | Generate proforma invoice for shipments | [default to false] |
 | **generate_commercial_invoice** | **Boolean** | Generate commercial invoice for international shipments | [default to false] |
-| **generate_packing_list** | **Boolean** | Generate packing slip with package and item details | [default to false] |
+| **generate_packing_list** | **Boolean** | Generate a packing slip with parcel and item details | [default to false] |
 | **auto_print_labels** | **Boolean** | Automatically print labels when shipment is sent | [default to false] |
 | **auto_print_documents** | **Boolean** | Automatically print documents when shipment is sent | [default to false] |
 | **label_printer_id** | **String** | ID of the label printer |  |

data/docs/CreateShippingRuleRequest.md

@@ -13,8 +13,8 @@
 | **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] |
-| **phone_notification** | **Boolean** | Send SMS notification to recipient | [optional][default to false] |
+| **email_notification** | **Boolean** | Send an email notification to the receiver | [optional][default to false] |
+| **phone_notification** | **Boolean** | Send an SMS notification to the receiver | [optional][default to false] |
 | **min_weight** | **Float** | Minimum required weight in kg | [optional] |
 | **max_weight** | **Float** | Maximum allowed weight in kg | [optional] |
 | **min_order_value** | **Float** | Minimum required order value in currency units | [optional] |
@@ -22,7 +22,7 @@
 | **conditions** | [**Array<CreateShippingRuleRequestConditionsInner>**](CreateShippingRuleRequestConditionsInner.md) | Rule conditions (weight/price/quantity) |  |
 | **generate_proforma_invoice** | **Boolean** | Generate proforma invoice for shipments | [optional][default to false] |
 | **generate_commercial_invoice** | **Boolean** | Generate commercial invoice for international shipments | [optional][default to false] |
-| **generate_packing_list** | **Boolean** | Generate packing slip with package and item details | [optional][default to false] |
+| **generate_packing_list** | **Boolean** | Generate a packing slip with parcel and item details | [optional][default to false] |
 | **auto_print_labels** | **Boolean** | Automatically print labels when shipment is sent | [optional][default to false] |
 | **auto_print_documents** | **Boolean** | Automatically print documents when shipment is sent | [optional][default to false] |
 | **label_printer_id** | **String** | ID of the label printer | [optional] |

data/docs/GetOrder200Response.md

@@ -14,7 +14,7 @@
 | **subtotal_amount** | **Float** | Order subtotal before shipping and tax. | [optional] |
 | **total_amount** | **Float** | Order grand total. | [optional] |
 | **currency** | **String** | ISO 4217 currency code. | [optional] |
-| **status** | **String** | Order fulfilment status derived from its shipments. |  |
+| **status** | **String** | Order fulfillment status derived from its shipments. |  |
 | **shipping_rule_id** | **String** | ID of the applied shipping rule. | [optional] |
 | **notes** | **String** | Free-form internal notes. | [optional] |
 | **external_data** | **Hash<String, Object>** | Raw platform-specific payload for reference. | [optional] |

data/docs/GetOrder200ResponseShipmentsInner.md

@@ -10,12 +10,12 @@
 | **type** | **String** | Direction of the shipment relative to the organization. |  |
 | **tracking** | [**CreateShipment201ResponseTracking**](CreateShipment201ResponseTracking.md) |  | [optional] |
 | **carrier_settings** | [**ListShipments200ResponseDataInnerCarrierSettings**](ListShipments200ResponseDataInnerCarrierSettings.md) |  |  |
-| **service_point_id** | **String** | Selected carrier service point identifier. | [optional] |
+| **service_point_id** | **String** | Selected service point ID. | [optional] |
 | **created_at** | **String** | Timestamp when the shipment was created. |  |
 | **updated_at** | **String** | Timestamp when the shipment was last updated. |  |
 | **shipping_rule_id** | **String** | ID of the shipping rule used for this shipment. | [optional] |
 | **documents** | [**Array<CreateShipment201ResponseDocumentsInner>**](CreateShipment201ResponseDocumentsInner.md) | Documents (labels, customs forms) for this shipment. | [optional] |
-| **parcels** | [**Array<GetOrder200ResponseShipmentsInnerParcelsInner>**](GetOrder200ResponseShipmentsInnerParcelsInner.md) | Compact parcels for the order fulfillment workspace (no QR/label payloads). |  |
+| **parcels** | [**Array<GetOrder200ResponseShipmentsInnerParcelsInner>**](GetOrder200ResponseShipmentsInnerParcelsInner.md) | Compact parcels for the order's fulfillment view (no QR/label payloads). |  |
 
 ## Example
 

data/docs/ListCarrierProducts200ResponseInner.md

@@ -4,13 +4,13 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Display name of the shipping product |  |
+| **name** | **String** | Display name of the carrier product |  |
 | **product_id** | **String** | Unique carrier product identifier |  |
 | **type** | **String** | Direction of the shipment for this product |  |
-| **description** | **String** | Description of the shipping product | [optional] |
-| **available_countries** | **Array<String>** | Recipient countries supported by this product |  |
+| **description** | **String** | Description of the carrier product | [optional] |
+| **available_countries** | **Array<String>** | Receiver countries this product delivers to |  |
 | **available_sender_countries** | **Array<String>** | Sender countries supported by this product |  |
-| **is_service_point** | **Boolean** | Whether delivery is to a service point/pickup location | [default to false] |
+| **is_service_point** | **Boolean** | Whether this product delivers to a service point | [default to false] |
 | **is_pickup_available** | **Boolean** | Whether carrier pickup is available for this product | [default to false] |
 | **services** | [**Array<ListCarrierProducts200ResponseInnerServicesInner>**](ListCarrierProducts200ResponseInnerServicesInner.md) | Additional services available for this product | [optional] |
 | **additional_parameters** | [**Array<ListCarrierProducts200ResponseInnerAdditionalParametersInner>**](ListCarrierProducts200ResponseInnerAdditionalParametersInner.md) | Extra parameters that can or must be supplied for this product | [optional] |

data/docs/ListOrderChannels200ResponseDataInner.md

@@ -8,7 +8,7 @@
 | **name** | **String** | Display name of the channel. |  |
 | **type** | **String** | Type of the order channel (sales platform). |  |
 | **enabled** | **Boolean** | Whether the channel is active. |  |
-| **role** | **String** | What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfilment or tracking is pushed back to the platform. |  |
+| **role** | **String** | What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfillment or tracking is pushed back to the platform. |  |
 | **brand_id** | **String** | Brand this channel belongs to, or null for organization-wide. Orders synced from this channel inherit it, and so do the shipments and documents made from them. |  |
 | **has_credentials** | **Boolean** | Whether credentials are configured (values are never exposed). |  |
 | **settings** | [**ListOrderChannels200ResponseDataInnerSettings**](ListOrderChannels200ResponseDataInnerSettings.md) |  |  |

data/docs/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **match** | **String** | Shipping-method title to match against imported orders (trimmed, case-insensitive, exact). |  |
 | **shipping_rule_id** | **String** | Shipping rule applied to orders whose shipping-method title matches. |  |
-| **service_point_selection** | **String** | For rules whose product delivers to a service point: 'nearest' auto-selects the closest point to the recipient address; 'manual' keeps the shipment in draft for manual selection. | [optional] |
+| **service_point_selection** | **String** | For rules whose product delivers to a service point: 'nearest' auto-selects the closest point to the receiver's address; 'manual' keeps the shipment in draft for manual selection. | [optional] |
 
 ## Example
 

data/docs/ListOrders200ResponseDataInner.md

@@ -8,7 +8,7 @@
 | **order_number** | **String** | Human-readable order number. |  |
 | **customer_name** | **String** | Customer full name. | [optional] |
 | **customer_email** | **String** | Customer email address. | [optional] |
-| **status** | **String** | Order fulfilment status derived from its shipments. |  |
+| **status** | **String** | Order fulfillment status derived from its shipments. |  |
 | **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **subtotal_amount** | **Float** | Order subtotal before shipping and tax. | [optional] |
 | **total_amount** | **Float** | Order grand total. | [optional] |

data/docs/ListOrgBrands200ResponseDataInner.md

@@ -12,8 +12,8 @@
 | **city** | **String** | City | [optional] |
 | **postal_code** | **String** | Postal code | [optional] |
 | **country** | **String** | Country (ISO 3166-1 alpha-2) | [optional] |
-| **primary_color** | **String** | Primary brand colour — document title and table headers | [optional] |
-| **secondary_color** | **String** | Secondary brand colour — subtitle, section headings, totals accent | [optional] |
+| **primary_color** | **String** | Primary brand color — document title and table headers | [optional] |
+| **secondary_color** | **String** | Secondary brand color — subtitle, section headings, totals accent | [optional] |
 | **id** | **String** | Unique brand identifier |  |
 | **org_id** | **String** | Owning organization |  |
 | **name** | **String** | Brand display name |  |

data/docs/ListShippingRules200ResponseDataInner.md

@@ -14,8 +14,8 @@
 | **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] |
-| **phone_notification** | **Boolean** | Send SMS notification to recipient | [default to false] |
+| **email_notification** | **Boolean** | Send an email notification to the receiver | [default to false] |
+| **phone_notification** | **Boolean** | Send an SMS notification to the receiver | [default to false] |
 | **min_weight** | **Float** | Minimum required weight in kg. Orders below this are excluded from the rule. |  |
 | **max_weight** | **Float** | Maximum allowed weight in kg. Orders exceeding this are excluded from the rule. |  |
 | **min_order_value** | **Float** | Minimum required order value in currency units. Orders below this are excluded from the rule. |  |
@@ -23,7 +23,7 @@
 | **conditions** | [**Array<ListShippingRules200ResponseDataInnerConditionsInner>**](ListShippingRules200ResponseDataInnerConditionsInner.md) | Rule conditions (weight/price/quantity) |  |
 | **generate_proforma_invoice** | **Boolean** | Generate proforma invoice for shipments | [default to false] |
 | **generate_commercial_invoice** | **Boolean** | Generate commercial invoice for international shipments | [default to false] |
-| **generate_packing_list** | **Boolean** | Generate packing slip with package and item details | [default to false] |
+| **generate_packing_list** | **Boolean** | Generate a packing slip with parcel and item details | [default to false] |
 | **auto_print_labels** | **Boolean** | Automatically print labels when shipment is sent | [default to false] |
 | **auto_print_documents** | **Boolean** | Automatically print documents when shipment is sent | [default to false] |
 | **label_printer_id** | **String** | ID of the label printer |  |

data/docs/OrdersApi.md

@@ -250,7 +250,7 @@ opts = {
   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.
+  status: 'pending', # String | Order fulfillment 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.
   filter: '{"conjunction":"and","conditions":[{"id":"c_1","field":"status","operator":"in","value":["pending","processing"]}]}' # String | Advanced filter as a JSON-encoded definition: a `conjunction` (`and`/`or`) over `conditions`, each `{ id, field, operator, value }` or a nested group. Fields and operators per list are documented under Filtering lists in the API overview. An invalid filter returns 400 `FILTER_INVALID`.
@@ -292,7 +292,7 @@ end
 | **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] |
+| **status** | **String** | Order fulfillment 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] |
 | **filter** | **String** | Advanced filter as a JSON-encoded definition: a `conjunction` (`and`/`or`) over `conditions`, each `{ id, field, operator, value }` or a nested group. Fields and operators per list are documented under Filtering lists in the API overview. An invalid filter returns 400 `FILTER_INVALID`. | [optional] |

data/docs/SendShipment422Response.md

@@ -7,7 +7,7 @@
 | **code** | **String** | Machine-readable error code. | [optional] |
 | **error** | **String** | Error category. |  |
 | **message** | **String** | Human-readable summary of the carrier failure. |  |
-| **errors** | [**Array<SendShipment422ResponseErrorsInner>**](SendShipment422ResponseErrorsInner.md) | Detailed carrier errors that caused the booking to fail. |  |
+| **errors** | [**Array<SendShipment422ResponseErrorsInner>**](SendShipment422ResponseErrorsInner.md) | Detailed carrier errors that made sending fail. |  |
 
 ## Example
 

data/docs/ShipmentsApi.md

@@ -26,7 +26,7 @@ All URIs are relative to *https://api.zippendo.com*
 
 Batch send shipments
 
-Book multiple pending/error shipments with their carriers in one request. Each shipment is processed independently and reported in `results`; a failure on one shipment never aborts the others. Use it to send every shipment on an order at once.
+Send multiple shipments in `pending` or `error` status to their carriers in one request. Each shipment is processed independently and reported in `results`; a failure on one shipment never aborts the others. Use it to send every shipment on an order at once.
 
 ### Examples
 
@@ -170,7 +170,7 @@ end
 
 Create return shipment
 
-Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with its booking outcome: `dispatched`, or `error` with the carrier's reasons in `errors`.
+Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with the outcome of sending it: `dispatched`, or `error` with the carrier's reasons in `errors`.
 
 ### Examples
 
@@ -690,7 +690,7 @@ end
 
 Send shipment
 
-Book a pending or error shipment with the carrier, generating labels and tracking. Returns 422 with carrier errors if booking fails.
+Send a shipment in `pending` or `error` status to its carrier, generating labels and tracking. Returns 422 with the carrier's errors if sending fails.
 
 ### Examples
 

data/docs/UpdateOrderChannelRequest.md

@@ -7,7 +7,7 @@
 | **brand_id** | **String** | Brand this channel belongs to; null for organization-wide | [optional] |
 | **name** | **String** | Display name for the channel. | [optional] |
 | **enabled** | **Boolean** | Whether the channel is active. | [optional] |
-| **role** | **String** | What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfilment or tracking is pushed back to the platform. | [optional] |
+| **role** | **String** | What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfillment or tracking is pushed back to the platform. | [optional] |
 | **credentials** | **Hash<String, Object>** | Type-specific platform credentials. | [optional] |
 | **settings** | [**UpdateOrderChannelRequestSettings**](UpdateOrderChannelRequestSettings.md) |  | [optional] |
 | **shipping_rule_ids** | **Array<String>** | IDs of shipping rules linked to this channel. | [optional] |

data/docs/UpdateOrderRequest.md

@@ -13,9 +13,9 @@
 | **total_amount** | **Float** | Order grand total. | [optional] |
 | **currency** | **String** | ISO 4217 currency code. | [optional] |
 | **notes** | **String** | Free-form internal notes. | [optional] |
-| **status** | **String** | Order fulfilment status derived from its shipments. | [optional] |
+| **status** | **String** | Order fulfillment status derived from its shipments. | [optional] |
 | **shipping_rule_id** | **String** | ID of the shipping rule to apply. | [optional] |
-| **service_point_id** | **String** | Service point (parcel shop) ID to apply to unsent outbound shipments. | [optional] |
+| **service_point_id** | **String** | Service point ID to apply to unsent outbound shipments. | [optional] |
 
 ## Example
 

data/docs/UpdateOrgBrandRequest.md

@@ -12,8 +12,8 @@
 | **city** | **String** | City | [optional] |
 | **postal_code** | **String** | Postal code | [optional] |
 | **country** | **String** | Country (ISO 3166-1 alpha-2) | [optional] |
-| **primary_color** | **String** | Primary brand colour — document title and table headers | [optional] |
-| **secondary_color** | **String** | Secondary brand colour — subtitle, section headings, totals accent | [optional] |
+| **primary_color** | **String** | Primary brand color — document title and table headers | [optional] |
+| **secondary_color** | **String** | Secondary brand color — subtitle, section headings, totals accent | [optional] |
 | **name** | **String** | Brand display name | [optional] |
 | **slug** | **String** | URL-safe identifier, unique within the org | [optional] |
 | **use_org_customs** | **Boolean** | Whether this brand ships under the organization's fiscal identity. True (the default) declares the organization's VAT number and customs identifiers and ignores the brand's own. False makes the brand's own values the sole source — nothing falls back to the organization, so an identifier the brand has not set is not declared at all. | [optional] |

data/docs/UpdateShipmentRequest.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **reference** | **String** | Customer-facing shipment reference. | [optional] |
 | **address_id** | **String** | Sender address identifier. | [optional] |
-| **service_point_id** | **String** | Selected carrier service point identifier. | [optional] |
+| **service_point_id** | **String** | Selected service point ID. | [optional] |
 | **parties** | [**Array<CreateShipmentRequestPartiesInner>**](CreateShipmentRequestPartiesInner.md) | Parties involved in the shipment. Optional when orderId is provided. | [optional] |
 | **type** | **String** | Direction of the shipment relative to the organization. | [optional] |
 | **carrier_settings** | [**UpdateShipmentRequestCarrierSettings**](UpdateShipmentRequestCarrierSettings.md) |  | [optional] |

data/docs/UpdateShippingRuleRequest.md

@@ -13,8 +13,8 @@
 | **additional_parameters** | [**Hash<String, CreateShippingRuleRequestAdditionalParametersValue>**](CreateShippingRuleRequestAdditionalParametersValue.md) | Carrier-specific extra parameters, keyed by the carrier parameter `key` from the product's `additionalParameters[].key`. Omit to leave the rule's parameters unchanged. | [optional] |
 | **address_id** | **String** | Sender address ID | [optional] |
 | **receiving_countries** | **Array<String>** | List of supported country codes | [optional] |
-| **email_notification** | **Boolean** | Send email notification to recipient | [optional][default to false] |
-| **phone_notification** | **Boolean** | Send SMS notification to recipient | [optional][default to false] |
+| **email_notification** | **Boolean** | Send an email notification to the receiver | [optional][default to false] |
+| **phone_notification** | **Boolean** | Send an SMS notification to the receiver | [optional][default to false] |
 | **min_weight** | **Float** | Minimum required weight in kg | [optional] |
 | **max_weight** | **Float** | Maximum allowed weight in kg | [optional] |
 | **min_order_value** | **Float** | Minimum required order value in currency units | [optional] |
@@ -22,7 +22,7 @@
 | **conditions** | [**Array<CreateShippingRuleRequestConditionsInner>**](CreateShippingRuleRequestConditionsInner.md) | Rule conditions (weight/price/quantity) | [optional] |
 | **generate_proforma_invoice** | **Boolean** | Generate proforma invoice for shipments | [optional][default to false] |
 | **generate_commercial_invoice** | **Boolean** | Generate commercial invoice for international shipments | [optional][default to false] |
-| **generate_packing_list** | **Boolean** | Generate packing slip with package and item details | [optional][default to false] |
+| **generate_packing_list** | **Boolean** | Generate a packing slip with parcel and item details | [optional][default to false] |
 | **auto_print_labels** | **Boolean** | Automatically print labels when shipment is sent | [optional][default to false] |
 | **auto_print_documents** | **Boolean** | Automatically print documents when shipment is sent | [optional][default to false] |
 | **label_printer_id** | **String** | ID of the label printer | [optional] |

data/lib/zippendo/api/brands_api.rb

@@ -587,7 +587,7 @@ module Zippendo
     end
 
     # Update brand
-    # Updates a brand's name, slug, identity overrides (company name, VAT, customs, address) and document colours. Null clears an override so the organization's value applies again.
+    # Updates a brand's name, slug, identity overrides (company name, VAT, customs, address) and document colors. Null clears an override so the organization's value applies again.
     # @param org_id [String] Organization ID
     # @param brand_id [String] Brand ID
     # @param update_org_brand_request [UpdateOrgBrandRequest] 
@@ -599,7 +599,7 @@ module Zippendo
     end
 
     # Update brand
-    # Updates a brand's name, slug, identity overrides (company name, VAT, customs, address) and document colours. Null clears an override so the organization's value applies again.
+    # Updates a brand's name, slug, identity overrides (company name, VAT, customs, address) and document colors. Null clears an override so the organization's value applies again.
     # @param org_id [String] Organization ID
     # @param brand_id [String] Brand ID
     # @param update_org_brand_request [UpdateOrgBrandRequest] 

data/lib/zippendo/api/carriers_api.rb

@@ -318,7 +318,7 @@ module Zippendo
     end
 
     # List carrier products
-    # Returns the shipping products available for a connected carrier.
+    # Returns the carrier products available for a connected carrier.
     # @param org_id [String] Organization ID
     # @param carrier_id [String] Carrier ID
     # @param [Hash] opts the optional parameters
@@ -329,7 +329,7 @@ module Zippendo
     end
 
     # List carrier products
-    # Returns the shipping products available for a connected carrier.
+    # Returns the carrier products available for a connected carrier.
     # @param org_id [String] Organization ID
     # @param carrier_id [String] Carrier ID
     # @param [Hash] opts the optional parameters

data/lib/zippendo/api/orders_api.rb

@@ -239,7 +239,7 @@ module Zippendo
     # @option opts [Integer] :limit Items per page (max 100) (default to 20)
     # @option opts [String] :brand_id Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
     # @option opts [String] :brand_scope 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.
-    # @option opts [String] :status Order fulfilment status derived from its shipments.
+    # @option opts [String] :status Order fulfillment status derived from its shipments.
     # @option opts [String] :order_channel_id Filter by order channel ID.
     # @option opts [String] :search Search by order number or customer name/email.
     # @option opts [String] :filter Advanced filter as a JSON-encoded definition: a `conjunction` (`and`/`or`) over `conditions`, each `{ id, field, operator, value }` or a nested group. Fields and operators per list are documented under Filtering lists in the API overview. An invalid filter returns 400 `FILTER_INVALID`.
@@ -257,7 +257,7 @@ module Zippendo
     # @option opts [Integer] :limit Items per page (max 100) (default to 20)
     # @option opts [String] :brand_id Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
     # @option opts [String] :brand_scope 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.
-    # @option opts [String] :status Order fulfilment status derived from its shipments.
+    # @option opts [String] :status Order fulfillment status derived from its shipments.
     # @option opts [String] :order_channel_id Filter by order channel ID.
     # @option opts [String] :search Search by order number or customer name/email.
     # @option opts [String] :filter Advanced filter as a JSON-encoded definition: a `conjunction` (`and`/`or`) over `conditions`, each `{ id, field, operator, value }` or a nested group. Fields and operators per list are documented under Filtering lists in the API overview. An invalid filter returns 400 `FILTER_INVALID`.

data/lib/zippendo/api/shipments_api.rb

@@ -20,7 +20,7 @@ module Zippendo
       @api_client = api_client
     end
     # Batch send shipments
-    # Book multiple pending/error shipments with their carriers in one request. Each shipment is processed independently and reported in `results`; a failure on one shipment never aborts the others. Use it to send every shipment on an order at once.
+    # Send multiple shipments in `pending` or `error` status to their carriers in one request. Each shipment is processed independently and reported in `results`; a failure on one shipment never aborts the others. Use it to send every shipment on an order at once.
     # @param org_id [String] Organization ID
     # @param batch_send_shipments_request [BatchSendShipmentsRequest] 
     # @param [Hash] opts the optional parameters
@@ -31,7 +31,7 @@ module Zippendo
     end
 
     # Batch send shipments
-    # Book multiple pending/error shipments with their carriers in one request. Each shipment is processed independently and reported in `results`; a failure on one shipment never aborts the others. Use it to send every shipment on an order at once.
+    # Send multiple shipments in `pending` or `error` status to their carriers in one request. Each shipment is processed independently and reported in `results`; a failure on one shipment never aborts the others. Use it to send every shipment on an order at once.
     # @param org_id [String] Organization ID
     # @param batch_send_shipments_request [BatchSendShipmentsRequest] 
     # @param [Hash] opts the optional parameters
@@ -174,7 +174,7 @@ module Zippendo
     end
 
     # Create return shipment
-    # Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with its booking outcome: `dispatched`, or `error` with the carrier's reasons in `errors`.
+    # Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with the outcome of sending it: `dispatched`, or `error` with the carrier's reasons in `errors`.
     # @param org_id [String] Organization identifier.
     # @param shipment_id [String] Shipment identifier.
     # @param [Hash] opts the optional parameters
@@ -185,7 +185,7 @@ module Zippendo
     end
 
     # Create return shipment
-    # Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with its booking outcome: `dispatched`, or `error` with the carrier's reasons in `errors`.
+    # Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with the outcome of sending it: `dispatched`, or `error` with the carrier's reasons in `errors`.
     # @param org_id [String] Organization identifier.
     # @param shipment_id [String] Shipment identifier.
     # @param [Hash] opts the optional parameters
@@ -726,7 +726,7 @@ module Zippendo
     end
 
     # Send shipment
-    # Book a pending or error shipment with the carrier, generating labels and tracking. Returns 422 with carrier errors if booking fails.
+    # Send a shipment in `pending` or `error` status to its carrier, generating labels and tracking. Returns 422 with the carrier's errors if sending fails.
     # @param org_id [String] Organization identifier.
     # @param shipment_id [String] Shipment identifier.
     # @param [Hash] opts the optional parameters
@@ -737,7 +737,7 @@ module Zippendo
     end
 
     # Send shipment
-    # Book a pending or error shipment with the carrier, generating labels and tracking. Returns 422 with carrier errors if booking fails.
+    # Send a shipment in `pending` or `error` status to its carrier, generating labels and tracking. Returns 422 with the carrier's errors if sending fails.
     # @param org_id [String] Organization identifier.
     # @param shipment_id [String] Shipment identifier.
     # @param [Hash] opts the optional parameters