@zippendo/sdk 1.1.4 → 1.2.1

package/dist/models/CreateShipmentRequestParcelsInnerOrderLinesInner.js

@@ -22,8 +22,6 @@ exports.CreateShipmentRequestParcelsInnerOrderLinesInnerToJSONTyped = CreateShip
  * Check if a given object implements the CreateShipmentRequestParcelsInnerOrderLinesInner interface.
  */
 function instanceOfCreateShipmentRequestParcelsInnerOrderLinesInner(value) {
-    if (!('sku' in value) || value['sku'] === undefined)
-        return false;
     if (!('quantity' in value) || value['quantity'] === undefined)
         return false;
     return true;
@@ -37,7 +35,7 @@ function CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSONTyped(json, ign
     }
     return {
         'id': json['id'] == null ? undefined : json['id'],
-        'sku': json['sku'],
+        'sku': json['sku'] === undefined ? undefined : json['sku'] === null ? null : json['sku'],
         'quantity': json['quantity'],
         'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
         'unitPrice': json['unitPrice'] === undefined ? undefined : json['unitPrice'] === null ? null : json['unitPrice'],

package/dist/models/GetOrder200ResponseShipmentsInner.d.ts

@@ -54,6 +54,12 @@ export interface GetOrder200ResponseShipmentsInner {
      * @memberof GetOrder200ResponseShipmentsInner
      */
     carrierSettings: ListShipments200ResponseDataInnerCarrierSettings;
+    /**
+     * Selected carrier service point identifier.
+     * @type {string}
+     * @memberof GetOrder200ResponseShipmentsInner
+     */
+    servicePointId?: string | null;
     /**
      * Timestamp when the shipment was created.
      * @type {string}

package/dist/models/GetOrder200ResponseShipmentsInner.js

@@ -76,6 +76,7 @@ function GetOrder200ResponseShipmentsInnerFromJSONTyped(json, ignoreDiscriminato
         'type': json['type'],
         'tracking': json['tracking'] === undefined ? undefined : json['tracking'] === null ? null : (0, CreateShipment201ResponseTracking_1.CreateShipment201ResponseTrackingFromJSON)(json['tracking']),
         'carrierSettings': (0, ListShipments200ResponseDataInnerCarrierSettings_1.ListShipments200ResponseDataInnerCarrierSettingsFromJSON)(json['carrierSettings']),
+        'servicePointId': json['servicePointId'] === undefined ? undefined : json['servicePointId'] === null ? null : json['servicePointId'],
         'createdAt': json['createdAt'],
         'updatedAt': json['updatedAt'],
         'shippingRuleId': json['shippingRuleId'] === undefined ? undefined : json['shippingRuleId'] === null ? null : json['shippingRuleId'],
@@ -96,6 +97,7 @@ function GetOrder200ResponseShipmentsInnerToJSONTyped(value, ignoreDiscriminator
         'type': value['type'],
         'tracking': (0, CreateShipment201ResponseTracking_1.CreateShipment201ResponseTrackingToJSON)(value['tracking']),
         'carrierSettings': (0, ListShipments200ResponseDataInnerCarrierSettings_1.ListShipments200ResponseDataInnerCarrierSettingsToJSON)(value['carrierSettings']),
+        'servicePointId': value['servicePointId'],
         'createdAt': value['createdAt'],
         'updatedAt': value['updatedAt'],
         'shippingRuleId': value['shippingRuleId'],

package/dist/models/ListApiTokens401Response.d.ts

@@ -102,6 +102,8 @@ export declare const ListApiTokens401ResponseCodeEnum: {
     readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
     readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
     readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
+    readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
+    readonly ShipmentSendNotAttempted: "SHIPMENT_SEND_NOT_ATTEMPTED";
     readonly ParcelNotFound: "PARCEL_NOT_FOUND";
     readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
     readonly PickupNotFound: "PICKUP_NOT_FOUND";

package/dist/models/ListApiTokens401Response.js

@@ -87,6 +87,8 @@ exports.ListApiTokens401ResponseCodeEnum = {
     ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
     ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
     ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
+    ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
+    ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
     ParcelNotFound: 'PARCEL_NOT_FOUND',
     ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
     PickupNotFound: 'PICKUP_NOT_FOUND',

package/dist/models/SendShipment422Response.d.ts

@@ -109,6 +109,8 @@ export declare const SendShipment422ResponseCodeEnum: {
     readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
     readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
     readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
+    readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
+    readonly ShipmentSendNotAttempted: "SHIPMENT_SEND_NOT_ATTEMPTED";
     readonly ParcelNotFound: "PARCEL_NOT_FOUND";
     readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
     readonly PickupNotFound: "PICKUP_NOT_FOUND";

package/dist/models/SendShipment422Response.js

@@ -88,6 +88,8 @@ exports.SendShipment422ResponseCodeEnum = {
     ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
     ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
     ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
+    ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
+    ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
     ParcelNotFound: 'PARCEL_NOT_FOUND',
     ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
     PickupNotFound: 'PICKUP_NOT_FOUND',

package/dist/models/UpdateShipmentRequest.d.ts

@@ -10,8 +10,9 @@
  * Do not edit the class manually.
  */
 import type { CreateShipmentRequestPickupDetails } from './CreateShipmentRequestPickupDetails';
-import type { CreateShipmentRequestCarrierSettings } from './CreateShipmentRequestCarrierSettings';
+import type { UpdateShipmentRequestDroppoint } from './UpdateShipmentRequestDroppoint';
 import type { CreateShipmentRequestPartiesInner } from './CreateShipmentRequestPartiesInner';
+import type { UpdateShipmentRequestCarrierSettings } from './UpdateShipmentRequestCarrierSettings';
 import type { CreateShipmentRequestParcelsInner } from './CreateShipmentRequestParcelsInner';
 /**
  *
@@ -51,10 +52,10 @@ export interface UpdateShipmentRequest {
     type?: UpdateShipmentRequestTypeEnum;
     /**
      *
-     * @type {CreateShipmentRequestCarrierSettings}
+     * @type {UpdateShipmentRequestCarrierSettings}
      * @memberof UpdateShipmentRequest
      */
-    carrierSettings?: CreateShipmentRequestCarrierSettings;
+    carrierSettings?: UpdateShipmentRequestCarrierSettings;
     /**
      * Parcels to include. Optional when orderId is provided.
      * @type {Array<CreateShipmentRequestParcelsInner>}
@@ -103,6 +104,12 @@ export interface UpdateShipmentRequest {
      * @memberof UpdateShipmentRequest
      */
     shippingRuleId?: string | null;
+    /**
+     *
+     * @type {UpdateShipmentRequestDroppoint}
+     * @memberof UpdateShipmentRequest
+     */
+    droppoint?: UpdateShipmentRequestDroppoint;
 }
 /**
  * @export

package/dist/models/UpdateShipmentRequest.js

@@ -20,8 +20,9 @@ exports.UpdateShipmentRequestFromJSONTyped = UpdateShipmentRequestFromJSONTyped;
 exports.UpdateShipmentRequestToJSON = UpdateShipmentRequestToJSON;
 exports.UpdateShipmentRequestToJSONTyped = UpdateShipmentRequestToJSONTyped;
 const CreateShipmentRequestPickupDetails_1 = require("./CreateShipmentRequestPickupDetails");
-const CreateShipmentRequestCarrierSettings_1 = require("./CreateShipmentRequestCarrierSettings");
+const UpdateShipmentRequestDroppoint_1 = require("./UpdateShipmentRequestDroppoint");
 const CreateShipmentRequestPartiesInner_1 = require("./CreateShipmentRequestPartiesInner");
+const UpdateShipmentRequestCarrierSettings_1 = require("./UpdateShipmentRequestCarrierSettings");
 const CreateShipmentRequestParcelsInner_1 = require("./CreateShipmentRequestParcelsInner");
 /**
  * @export
@@ -62,7 +63,7 @@ function UpdateShipmentRequestFromJSONTyped(json, ignoreDiscriminator) {
         'servicePointId': json['servicePointId'] === undefined ? undefined : json['servicePointId'] === null ? null : json['servicePointId'],
         'parties': json['parties'] == null ? undefined : (json['parties'].map(CreateShipmentRequestPartiesInner_1.CreateShipmentRequestPartiesInnerFromJSON)),
         'type': json['type'] == null ? undefined : json['type'],
-        'carrierSettings': json['carrierSettings'] == null ? undefined : (0, CreateShipmentRequestCarrierSettings_1.CreateShipmentRequestCarrierSettingsFromJSON)(json['carrierSettings']),
+        'carrierSettings': json['carrierSettings'] == null ? undefined : (0, UpdateShipmentRequestCarrierSettings_1.UpdateShipmentRequestCarrierSettingsFromJSON)(json['carrierSettings']),
         'parcels': json['parcels'] == null ? undefined : (json['parcels'].map(CreateShipmentRequestParcelsInner_1.CreateShipmentRequestParcelsInnerFromJSON)),
         'pickupDetails': json['pickupDetails'] === undefined ? undefined : json['pickupDetails'] === null ? null : (0, CreateShipmentRequestPickupDetails_1.CreateShipmentRequestPickupDetailsFromJSON)(json['pickupDetails']),
         'termOfTrade': json['termOfTrade'] == null ? undefined : json['termOfTrade'],
@@ -71,6 +72,7 @@ function UpdateShipmentRequestFromJSONTyped(json, ignoreDiscriminator) {
         'labelPrinterId': json['labelPrinterId'] === undefined ? undefined : json['labelPrinterId'] === null ? null : json['labelPrinterId'],
         'documentPrinterId': json['documentPrinterId'] === undefined ? undefined : json['documentPrinterId'] === null ? null : json['documentPrinterId'],
         'shippingRuleId': json['shippingRuleId'] === undefined ? undefined : json['shippingRuleId'] === null ? null : json['shippingRuleId'],
+        'droppoint': json['droppoint'] == null ? undefined : (0, UpdateShipmentRequestDroppoint_1.UpdateShipmentRequestDroppointFromJSON)(json['droppoint']),
     };
 }
 function UpdateShipmentRequestToJSON(json) {
@@ -86,7 +88,7 @@ function UpdateShipmentRequestToJSONTyped(value, ignoreDiscriminator = false) {
         'servicePointId': value['servicePointId'],
         'parties': value['parties'] == null ? undefined : (value['parties'].map(CreateShipmentRequestPartiesInner_1.CreateShipmentRequestPartiesInnerToJSON)),
         'type': value['type'],
-        'carrierSettings': (0, CreateShipmentRequestCarrierSettings_1.CreateShipmentRequestCarrierSettingsToJSON)(value['carrierSettings']),
+        'carrierSettings': (0, UpdateShipmentRequestCarrierSettings_1.UpdateShipmentRequestCarrierSettingsToJSON)(value['carrierSettings']),
         'parcels': value['parcels'] == null ? undefined : (value['parcels'].map(CreateShipmentRequestParcelsInner_1.CreateShipmentRequestParcelsInnerToJSON)),
         'pickupDetails': (0, CreateShipmentRequestPickupDetails_1.CreateShipmentRequestPickupDetailsToJSON)(value['pickupDetails']),
         'termOfTrade': value['termOfTrade'],
@@ -95,5 +97,6 @@ function UpdateShipmentRequestToJSONTyped(value, ignoreDiscriminator = false) {
         'labelPrinterId': value['labelPrinterId'],
         'documentPrinterId': value['documentPrinterId'],
         'shippingRuleId': value['shippingRuleId'],
+        'droppoint': (0, UpdateShipmentRequestDroppoint_1.UpdateShipmentRequestDroppointToJSON)(value['droppoint']),
     };
 }

package/dist/models/UpdateShipmentRequestCarrierSettings.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { CreateShippingRuleRequestAdditionalParametersValue } from './CreateShippingRuleRequestAdditionalParametersValue';
+/**
+ *
+ * @export
+ * @interface UpdateShipmentRequestCarrierSettings
+ */
+export interface UpdateShipmentRequestCarrierSettings {
+    /**
+     * Identifier of the carrier to use.
+     * @type {string}
+     * @memberof UpdateShipmentRequestCarrierSettings
+     */
+    carrierId: string;
+    /**
+     * Identifier of the carrier product/service.
+     * @type {string}
+     * @memberof UpdateShipmentRequestCarrierSettings
+     */
+    productId: string;
+    /**
+     * Additional service codes requested from the carrier.
+     * @type {Array<string>}
+     * @memberof UpdateShipmentRequestCarrierSettings
+     */
+    services: Array<string>;
+    /**
+     * Carrier-specific extra parameters as key/value pairs.
+     * @type {{ [key: string]: CreateShippingRuleRequestAdditionalParametersValue; }}
+     * @memberof UpdateShipmentRequestCarrierSettings
+     */
+    additionalParameters: {
+        [key: string]: CreateShippingRuleRequestAdditionalParametersValue;
+    };
+}
+/**
+ * Check if a given object implements the UpdateShipmentRequestCarrierSettings interface.
+ */
+export declare function instanceOfUpdateShipmentRequestCarrierSettings(value: object): value is UpdateShipmentRequestCarrierSettings;
+export declare function UpdateShipmentRequestCarrierSettingsFromJSON(json: any): UpdateShipmentRequestCarrierSettings;
+export declare function UpdateShipmentRequestCarrierSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateShipmentRequestCarrierSettings;
+export declare function UpdateShipmentRequestCarrierSettingsToJSON(json: any): UpdateShipmentRequestCarrierSettings;
+export declare function UpdateShipmentRequestCarrierSettingsToJSONTyped(value?: UpdateShipmentRequestCarrierSettings | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UpdateShipmentRequestCarrierSettings.js

@@ -0,0 +1,64 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfUpdateShipmentRequestCarrierSettings = instanceOfUpdateShipmentRequestCarrierSettings;
+exports.UpdateShipmentRequestCarrierSettingsFromJSON = UpdateShipmentRequestCarrierSettingsFromJSON;
+exports.UpdateShipmentRequestCarrierSettingsFromJSONTyped = UpdateShipmentRequestCarrierSettingsFromJSONTyped;
+exports.UpdateShipmentRequestCarrierSettingsToJSON = UpdateShipmentRequestCarrierSettingsToJSON;
+exports.UpdateShipmentRequestCarrierSettingsToJSONTyped = UpdateShipmentRequestCarrierSettingsToJSONTyped;
+const runtime_1 = require("../runtime");
+const CreateShippingRuleRequestAdditionalParametersValue_1 = require("./CreateShippingRuleRequestAdditionalParametersValue");
+/**
+ * Check if a given object implements the UpdateShipmentRequestCarrierSettings interface.
+ */
+function instanceOfUpdateShipmentRequestCarrierSettings(value) {
+    if (!('carrierId' in value) || value['carrierId'] === undefined)
+        return false;
+    if (!('productId' in value) || value['productId'] === undefined)
+        return false;
+    if (!('services' in value) || value['services'] === undefined)
+        return false;
+    if (!('additionalParameters' in value) || value['additionalParameters'] === undefined)
+        return false;
+    return true;
+}
+function UpdateShipmentRequestCarrierSettingsFromJSON(json) {
+    return UpdateShipmentRequestCarrierSettingsFromJSONTyped(json, false);
+}
+function UpdateShipmentRequestCarrierSettingsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'carrierId': json['carrierId'],
+        'productId': json['productId'],
+        'services': json['services'],
+        'additionalParameters': ((0, runtime_1.mapValues)(json['additionalParameters'], CreateShippingRuleRequestAdditionalParametersValue_1.CreateShippingRuleRequestAdditionalParametersValueFromJSON)),
+    };
+}
+function UpdateShipmentRequestCarrierSettingsToJSON(json) {
+    return UpdateShipmentRequestCarrierSettingsToJSONTyped(json, false);
+}
+function UpdateShipmentRequestCarrierSettingsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'carrierId': value['carrierId'],
+        'productId': value['productId'],
+        'services': value['services'],
+        'additionalParameters': ((0, runtime_1.mapValues)(value['additionalParameters'], CreateShippingRuleRequestAdditionalParametersValue_1.CreateShippingRuleRequestAdditionalParametersValueToJSON)),
+    };
+}

package/dist/models/UpdateShipmentRequestDroppoint.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner } from './ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner';
+/**
+ * Display details of the selected service point, stored alongside `servicePointId`. Used when applying a service-point shipping rule (whose parameters otherwise replace the stored droppoint).
+ * @export
+ * @interface UpdateShipmentRequestDroppoint
+ */
+export interface UpdateShipmentRequestDroppoint {
+    /**
+     * Identifier of the selected service point.
+     * @type {string}
+     * @memberof UpdateShipmentRequestDroppoint
+     */
+    id: string;
+    /**
+     * Display name of the service point.
+     * @type {string}
+     * @memberof UpdateShipmentRequestDroppoint
+     */
+    name: string;
+    /**
+     * Formatted address of the service point.
+     * @type {string}
+     * @memberof UpdateShipmentRequestDroppoint
+     */
+    address: string;
+    /**
+     * Latitude/longitude of the service point.
+     * @type {Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>}
+     * @memberof UpdateShipmentRequestDroppoint
+     */
+    coordinates?: Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>;
+}
+/**
+ * Check if a given object implements the UpdateShipmentRequestDroppoint interface.
+ */
+export declare function instanceOfUpdateShipmentRequestDroppoint(value: object): value is UpdateShipmentRequestDroppoint;
+export declare function UpdateShipmentRequestDroppointFromJSON(json: any): UpdateShipmentRequestDroppoint;
+export declare function UpdateShipmentRequestDroppointFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateShipmentRequestDroppoint;
+export declare function UpdateShipmentRequestDroppointToJSON(json: any): UpdateShipmentRequestDroppoint;
+export declare function UpdateShipmentRequestDroppointToJSONTyped(value?: UpdateShipmentRequestDroppoint | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UpdateShipmentRequestDroppoint.js

@@ -0,0 +1,61 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfUpdateShipmentRequestDroppoint = instanceOfUpdateShipmentRequestDroppoint;
+exports.UpdateShipmentRequestDroppointFromJSON = UpdateShipmentRequestDroppointFromJSON;
+exports.UpdateShipmentRequestDroppointFromJSONTyped = UpdateShipmentRequestDroppointFromJSONTyped;
+exports.UpdateShipmentRequestDroppointToJSON = UpdateShipmentRequestDroppointToJSON;
+exports.UpdateShipmentRequestDroppointToJSONTyped = UpdateShipmentRequestDroppointToJSONTyped;
+const ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner_1 = require("./ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner");
+/**
+ * Check if a given object implements the UpdateShipmentRequestDroppoint interface.
+ */
+function instanceOfUpdateShipmentRequestDroppoint(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('address' in value) || value['address'] === undefined)
+        return false;
+    return true;
+}
+function UpdateShipmentRequestDroppointFromJSON(json) {
+    return UpdateShipmentRequestDroppointFromJSONTyped(json, false);
+}
+function UpdateShipmentRequestDroppointFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'address': json['address'],
+        'coordinates': json['coordinates'] == null ? undefined : (json['coordinates'].map(ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner_1.ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerFromJSON)),
+    };
+}
+function UpdateShipmentRequestDroppointToJSON(json) {
+    return UpdateShipmentRequestDroppointToJSONTyped(json, false);
+}
+function UpdateShipmentRequestDroppointToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'address': value['address'],
+        'coordinates': value['coordinates'] == null ? undefined : (value['coordinates'].map(ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner_1.ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerToJSON)),
+    };
+}

package/dist/models/index.d.ts

@@ -35,6 +35,7 @@ export * from './CreateShipment201ResponseShippingRule';
 export * from './CreateShipment201ResponseTracking';
 export * from './CreateShipmentRequest';
 export * from './CreateShipmentRequestCarrierSettings';
+export * from './CreateShipmentRequestDroppoint';
 export * from './CreateShipmentRequestParcelsInner';
 export * from './CreateShipmentRequestParcelsInnerDimensions';
 export * from './CreateShipmentRequestParcelsInnerOrderLinesInner';
@@ -141,6 +142,8 @@ export * from './UpdateOrgBrandingRequest';
 export * from './UpdateOrgRequest';
 export * from './UpdateOrgWebhookRequest';
 export * from './UpdateShipmentRequest';
+export * from './UpdateShipmentRequestCarrierSettings';
+export * from './UpdateShipmentRequestDroppoint';
 export * from './UpdateShippingRuleRequest';
 export * from './VerifyApiToken200Response';
 export * from './VerifyApiTokenRequest';

package/dist/models/index.js

@@ -53,6 +53,7 @@ __exportStar(require("./CreateShipment201ResponseShippingRule"), exports);
 __exportStar(require("./CreateShipment201ResponseTracking"), exports);
 __exportStar(require("./CreateShipmentRequest"), exports);
 __exportStar(require("./CreateShipmentRequestCarrierSettings"), exports);
+__exportStar(require("./CreateShipmentRequestDroppoint"), exports);
 __exportStar(require("./CreateShipmentRequestParcelsInner"), exports);
 __exportStar(require("./CreateShipmentRequestParcelsInnerDimensions"), exports);
 __exportStar(require("./CreateShipmentRequestParcelsInnerOrderLinesInner"), exports);
@@ -159,6 +160,8 @@ __exportStar(require("./UpdateOrgBrandingRequest"), exports);
 __exportStar(require("./UpdateOrgRequest"), exports);
 __exportStar(require("./UpdateOrgWebhookRequest"), exports);
 __exportStar(require("./UpdateShipmentRequest"), exports);
+__exportStar(require("./UpdateShipmentRequestCarrierSettings"), exports);
+__exportStar(require("./UpdateShipmentRequestDroppoint"), exports);
 __exportStar(require("./UpdateShippingRuleRequest"), exports);
 __exportStar(require("./VerifyApiToken200Response"), exports);
 __exportStar(require("./VerifyApiTokenRequest"), exports);

package/docs/BatchSendShipments200ResponseSummary.md

@@ -10,6 +10,7 @@ Name | Type
 `total` | number
 `sent` | number
 `failed` | number
+`skipped` | number
 
 ## Example
 
@@ -21,6 +22,7 @@ const example = {
   "total": 3,
   "sent": 2,
   "failed": 1,
+  "skipped": 0,
 } satisfies BatchSendShipments200ResponseSummary
 
 console.log(example)

package/docs/CreateShipmentRequest.md

@@ -19,6 +19,8 @@ Name | Type
 `orderId` | string
 `labelPrinterId` | string
 `documentPrinterId` | string
+`shippingRuleId` | string
+`droppoint` | [CreateShipmentRequestDroppoint](CreateShipmentRequestDroppoint.md)
 
 ## Example
 
@@ -40,6 +42,8 @@ const example = {
   "orderId": ord_5e6f7a8b,
   "labelPrinterId": prn_label_01,
   "documentPrinterId": prn_doc_01,
+  "shippingRuleId": rule_3c4d5e6f,
+  "droppoint": null,
 } satisfies CreateShipmentRequest
 
 console.log(example)

package/docs/CreateShipmentRequestCarrierSettings.md

@@ -1,6 +1,7 @@
 
 # CreateShipmentRequestCarrierSettings
 
+Carrier configuration for the shipment. Optional when shippingRuleId is provided.
 
 ## Properties
 

package/docs/CreateShipmentRequestDroppoint.md

@@ -0,0 +1,41 @@
+
+# CreateShipmentRequestDroppoint
+
+Display details of the selected service point, stored alongside `servicePointId`. Used with a service-point shipping rule.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`address` | string
+`coordinates` | [Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>](ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.md)
+
+## Example
+
+```typescript
+import type { CreateShipmentRequestDroppoint } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": sp_pn_4521,
+  "name": Føtex Nørrebro,
+  "address": Nørrebrogade 20, 2200 København N,
+  "coordinates": [55.6987,12.5501],
+} satisfies CreateShipmentRequestDroppoint
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateShipmentRequestDroppoint
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetOrder200ResponseShipmentsInner.md

@@ -12,6 +12,7 @@ Name | Type
 `type` | string
 `tracking` | [CreateShipment201ResponseTracking](CreateShipment201ResponseTracking.md)
 `carrierSettings` | [ListShipments200ResponseDataInnerCarrierSettings](ListShipments200ResponseDataInnerCarrierSettings.md)
+`servicePointId` | string
 `createdAt` | string
 `updatedAt` | string
 `shippingRuleId` | string
@@ -30,6 +31,7 @@ const example = {
   "type": outbound,
   "tracking": null,
   "carrierSettings": null,
+  "servicePointId": sp_pn_4521,
   "createdAt": 2026-06-22T14:30:00.000Z,
   "updatedAt": 2026-06-22T14:30:00.000Z,
   "shippingRuleId": clz9k2f0a0002abcd5678ijkl,

package/docs/ShipmentsApi.md

@@ -259,7 +259,7 @@ example().catch(console.error);
 
 Create shipment
 
-Create a new shipment for an organization. When orderId is provided, parties and parcels are derived from the order.
+Create a new shipment for an organization. When orderId is provided, parties and parcels are derived from the order. When shippingRuleId is provided, carrier settings and the sender address derive from the rule.
 
 ### Example
 

package/docs/UpdateShipmentRequest.md

@@ -11,7 +11,7 @@ Name | Type
 `servicePointId` | string
 `parties` | [Array<CreateShipmentRequestPartiesInner>](CreateShipmentRequestPartiesInner.md)
 `type` | string
-`carrierSettings` | [CreateShipmentRequestCarrierSettings](CreateShipmentRequestCarrierSettings.md)
+`carrierSettings` | [UpdateShipmentRequestCarrierSettings](UpdateShipmentRequestCarrierSettings.md)
 `parcels` | [Array<CreateShipmentRequestParcelsInner>](CreateShipmentRequestParcelsInner.md)
 `pickupDetails` | [CreateShipmentRequestPickupDetails](CreateShipmentRequestPickupDetails.md)
 `termOfTrade` | string
@@ -20,6 +20,7 @@ Name | Type
 `labelPrinterId` | string
 `documentPrinterId` | string
 `shippingRuleId` | string
+`droppoint` | [UpdateShipmentRequestDroppoint](UpdateShipmentRequestDroppoint.md)
 
 ## Example
 
@@ -42,6 +43,7 @@ const example = {
   "labelPrinterId": prn_label_01,
   "documentPrinterId": prn_doc_01,
   "shippingRuleId": rule_3c4d5e6f,
+  "droppoint": null,
 } satisfies UpdateShipmentRequest
 
 console.log(example)

package/docs/UpdateShipmentRequestCarrierSettings.md

@@ -0,0 +1,40 @@
+
+# UpdateShipmentRequestCarrierSettings
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`carrierId` | string
+`productId` | string
+`services` | Array<string>
+`additionalParameters` | [{ [key: string]: CreateShippingRuleRequestAdditionalParametersValue; }](CreateShippingRuleRequestAdditionalParametersValue.md)
+
+## Example
+
+```typescript
+import type { UpdateShipmentRequestCarrierSettings } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "carrierId": car_pn_001,
+  "productId": prod_mypack_home,
+  "services": ["A7"],
+  "additionalParameters": {"notificationEmail":"anna@example.dk"},
+} satisfies UpdateShipmentRequestCarrierSettings
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UpdateShipmentRequestCarrierSettings
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+