@zippendo/sdk 1.2.6 → 1.3.0

package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts

@@ -138,6 +138,7 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
     readonly CarrierAuthFailed: "CARRIER_AUTH_FAILED";
     readonly CarrierNotFound: "CARRIER_NOT_FOUND";
     readonly CarrierProductNotFound: "CARRIER_PRODUCT_NOT_FOUND";
+    readonly CarrierProductRouteUnsupported: "CARRIER_PRODUCT_ROUTE_UNSUPPORTED";
     readonly CarrierConfigInvalid: "CARRIER_CONFIG_INVALID";
     readonly CarrierParameterInvalid: "CARRIER_PARAMETER_INVALID";
     readonly CarrierServerUnavailable: "CARRIER_SERVER_UNAVAILABLE";

package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js

@@ -102,6 +102,7 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
     CarrierAuthFailed: 'CARRIER_AUTH_FAILED',
     CarrierNotFound: 'CARRIER_NOT_FOUND',
     CarrierProductNotFound: 'CARRIER_PRODUCT_NOT_FOUND',
+    CarrierProductRouteUnsupported: 'CARRIER_PRODUCT_ROUTE_UNSUPPORTED',
     CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
     CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
     CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',

package/dist/esm/models/CreateOrder201ResponseOrderLinesInner.d.ts

@@ -129,6 +129,12 @@ export interface CreateOrder201ResponseOrderLinesInner {
      * @memberof CreateOrder201ResponseOrderLinesInner
      */
     vendor?: string | null;
+    /**
+     * Order line ID. Present once the line is a row. Absent for jsonb-only lines during the dual-write window — do not synthesise one, or an edit would re-point packed lines.
+     * @type {string}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    id?: string;
 }
 /**
  * @export

package/dist/esm/models/CreateOrder201ResponseOrderLinesInner.js

@@ -57,6 +57,7 @@ export function CreateOrder201ResponseOrderLinesInnerFromJSONTyped(json, ignoreD
         'taxable': json['taxable'] === undefined ? undefined : json['taxable'] === null ? null : json['taxable'],
         'giftCard': json['giftCard'] === undefined ? undefined : json['giftCard'] === null ? null : json['giftCard'],
         'vendor': json['vendor'] === undefined ? undefined : json['vendor'] === null ? null : json['vendor'],
+        'id': json['id'] == null ? undefined : json['id'],
     };
 }
 export function CreateOrder201ResponseOrderLinesInnerToJSON(json) {
@@ -86,5 +87,6 @@ export function CreateOrder201ResponseOrderLinesInnerToJSONTyped(value, ignoreDi
         'taxable': value['taxable'],
         'giftCard': value['giftCard'],
         'vendor': value['vendor'],
+        'id': value['id'],
     };
 }

package/dist/esm/models/CreateOrderRequestOrderLinesInner.d.ts

@@ -129,6 +129,12 @@ export interface CreateOrderRequestOrderLinesInner {
      * @memberof CreateOrderRequestOrderLinesInner
      */
     vendor?: string | null;
+    /**
+     * ID of the existing order line this entry edits. Omit to add a new line.
+     * @type {string}
+     * @memberof CreateOrderRequestOrderLinesInner
+     */
+    id?: string;
 }
 /**
  * @export

package/dist/esm/models/CreateOrderRequestOrderLinesInner.js

@@ -57,6 +57,7 @@ export function CreateOrderRequestOrderLinesInnerFromJSONTyped(json, ignoreDiscr
         'taxable': json['taxable'] === undefined ? undefined : json['taxable'] === null ? null : json['taxable'],
         'giftCard': json['giftCard'] === undefined ? undefined : json['giftCard'] === null ? null : json['giftCard'],
         'vendor': json['vendor'] === undefined ? undefined : json['vendor'] === null ? null : json['vendor'],
+        'id': json['id'] == null ? undefined : json['id'],
     };
 }
 export function CreateOrderRequestOrderLinesInnerToJSON(json) {
@@ -86,5 +87,6 @@ export function CreateOrderRequestOrderLinesInnerToJSONTyped(value, ignoreDiscri
         'taxable': value['taxable'],
         'giftCard': value['giftCard'],
         'vendor': value['vendor'],
+        'id': value['id'],
     };
 }

package/dist/esm/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.d.ts

@@ -21,6 +21,12 @@ export interface CreateShipment201ResponseParcelsInnerOrderLinesInner {
      * @memberof CreateShipment201ResponseParcelsInnerOrderLinesInner
      */
     id?: string;
+    /**
+     * ID of the order line this packed line came from. Null when the item did not originate from an order line, such as a free gift or a replacement part.
+     * @type {string}
+     * @memberof CreateShipment201ResponseParcelsInnerOrderLinesInner
+     */
+    orderLineId?: string | null;
     /**
      * Stock keeping unit of the product. Optional — not every webshop assigns SKUs.
      * @type {string}
@@ -70,7 +76,13 @@ export interface CreateShipment201ResponseParcelsInnerOrderLinesInner {
      */
     countryOfOrigin?: string;
     /**
-     * Customs tariff (HS) code.
+     * Harmonized System customs code.
+     * @type {string}
+     * @memberof CreateShipment201ResponseParcelsInnerOrderLinesInner
+     */
+    hsCode?: string | null;
+    /**
+     * Deprecated misspelling of `hsCode`, kept for backwards compatibility.
      * @type {string}
      * @memberof CreateShipment201ResponseParcelsInnerOrderLinesInner
      */

package/dist/esm/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.js

@@ -28,6 +28,7 @@ export function CreateShipment201ResponseParcelsInnerOrderLinesInnerFromJSONType
     }
     return {
         'id': json['id'] == null ? undefined : json['id'],
+        'orderLineId': json['orderLineId'] === undefined ? undefined : json['orderLineId'] === null ? null : json['orderLineId'],
         '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'],
@@ -36,6 +37,7 @@ export function CreateShipment201ResponseParcelsInnerOrderLinesInnerFromJSONType
         'vatPercent': json['vatPercent'] === undefined ? undefined : json['vatPercent'] === null ? null : json['vatPercent'],
         'location': json['location'] === undefined ? undefined : json['location'] === null ? null : json['location'],
         'countryOfOrigin': json['countryOfOrigin'] == null ? undefined : json['countryOfOrigin'],
+        'hsCode': json['hsCode'] === undefined ? undefined : json['hsCode'] === null ? null : json['hsCode'],
         'tarrifNumber': json['tarrifNumber'] === undefined ? undefined : json['tarrifNumber'] === null ? null : json['tarrifNumber'],
     };
 }
@@ -48,6 +50,7 @@ export function CreateShipment201ResponseParcelsInnerOrderLinesInnerToJSONTyped(
     }
     return {
         'id': value['id'],
+        'orderLineId': value['orderLineId'],
         'sku': value['sku'],
         'quantity': value['quantity'],
         'description': value['description'],
@@ -56,6 +59,7 @@ export function CreateShipment201ResponseParcelsInnerOrderLinesInnerToJSONTyped(
         'vatPercent': value['vatPercent'],
         'location': value['location'],
         'countryOfOrigin': value['countryOfOrigin'],
+        'hsCode': value['hsCode'],
         'tarrifNumber': value['tarrifNumber'],
     };
 }

package/dist/esm/models/CreateShipmentRequestParcelsInnerOrderLinesInner.d.ts

@@ -21,6 +21,12 @@ export interface CreateShipmentRequestParcelsInnerOrderLinesInner {
      * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
      */
     id?: string;
+    /**
+     * ID of the order line this packed line came from. Null when the item did not originate from an order line, such as a free gift or a replacement part.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    orderLineId?: string | null;
     /**
      * Stock keeping unit of the product. Optional — not every webshop assigns SKUs.
      * @type {string}
@@ -70,7 +76,13 @@ export interface CreateShipmentRequestParcelsInnerOrderLinesInner {
      */
     countryOfOrigin?: string;
     /**
-     * Customs tariff (HS) code.
+     * Harmonized System customs code.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    hsCode?: string | null;
+    /**
+     * Deprecated misspelling of `hsCode`, kept for backwards compatibility.
      * @type {string}
      * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
      */

package/dist/esm/models/CreateShipmentRequestParcelsInnerOrderLinesInner.js

@@ -28,6 +28,7 @@ export function CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSONTyped(js
     }
     return {
         'id': json['id'] == null ? undefined : json['id'],
+        'orderLineId': json['orderLineId'] === undefined ? undefined : json['orderLineId'] === null ? null : json['orderLineId'],
         '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'],
@@ -36,6 +37,7 @@ export function CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSONTyped(js
         'vatPercent': json['vatPercent'] === undefined ? undefined : json['vatPercent'] === null ? null : json['vatPercent'],
         'location': json['location'] === undefined ? undefined : json['location'] === null ? null : json['location'],
         'countryOfOrigin': json['countryOfOrigin'] == null ? undefined : json['countryOfOrigin'],
+        'hsCode': json['hsCode'] === undefined ? undefined : json['hsCode'] === null ? null : json['hsCode'],
         'tarrifNumber': json['tarrifNumber'] === undefined ? undefined : json['tarrifNumber'] === null ? null : json['tarrifNumber'],
     };
 }
@@ -48,6 +50,7 @@ export function CreateShipmentRequestParcelsInnerOrderLinesInnerToJSONTyped(valu
     }
     return {
         'id': value['id'],
+        'orderLineId': value['orderLineId'],
         'sku': value['sku'],
         'quantity': value['quantity'],
         'description': value['description'],
@@ -56,6 +59,7 @@ export function CreateShipmentRequestParcelsInnerOrderLinesInnerToJSONTyped(valu
         'vatPercent': value['vatPercent'],
         'location': value['location'],
         'countryOfOrigin': value['countryOfOrigin'],
+        'hsCode': value['hsCode'],
         'tarrifNumber': value['tarrifNumber'],
     };
 }

package/dist/esm/models/GetOrder200Response.d.ts

@@ -9,10 +9,10 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { GetOrder200ResponseOrderLinesInner } from './GetOrder200ResponseOrderLinesInner';
 import type { GetOrder200ResponseShippingRule } from './GetOrder200ResponseShippingRule';
 import type { ListOrders200ResponseDataInnerOrderChannel } from './ListOrders200ResponseDataInnerOrderChannel';
 import type { CreateOrder201ResponseShippingAddress } from './CreateOrder201ResponseShippingAddress';
-import type { CreateOrder201ResponseOrderLinesInner } from './CreateOrder201ResponseOrderLinesInner';
 import type { GetOrder200ResponseShipmentsInner } from './GetOrder200ResponseShipmentsInner';
 /**
  *
@@ -57,11 +57,11 @@ export interface GetOrder200Response {
      */
     shippingAddress?: CreateOrder201ResponseShippingAddress | null;
     /**
-     * Line items in the order.
-     * @type {Array<CreateOrder201ResponseOrderLinesInner>}
+     * Sold line items with quantity already allocated to outbound shipments.
+     * @type {Array<GetOrder200ResponseOrderLinesInner>}
      * @memberof GetOrder200Response
      */
-    orderLines: Array<CreateOrder201ResponseOrderLinesInner>;
+    orderLines: Array<GetOrder200ResponseOrderLinesInner>;
     /**
      * Order subtotal before shipping and tax.
      * @type {number}

package/dist/esm/models/GetOrder200Response.js

@@ -11,10 +11,10 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { GetOrder200ResponseOrderLinesInnerFromJSON, GetOrder200ResponseOrderLinesInnerToJSON, } from './GetOrder200ResponseOrderLinesInner';
 import { GetOrder200ResponseShippingRuleFromJSON, GetOrder200ResponseShippingRuleToJSON, } from './GetOrder200ResponseShippingRule';
 import { ListOrders200ResponseDataInnerOrderChannelFromJSON, ListOrders200ResponseDataInnerOrderChannelToJSON, } from './ListOrders200ResponseDataInnerOrderChannel';
 import { CreateOrder201ResponseShippingAddressFromJSON, CreateOrder201ResponseShippingAddressToJSON, } from './CreateOrder201ResponseShippingAddress';
-import { CreateOrder201ResponseOrderLinesInnerFromJSON, CreateOrder201ResponseOrderLinesInnerToJSON, } from './CreateOrder201ResponseOrderLinesInner';
 import { GetOrder200ResponseShipmentsInnerFromJSON, GetOrder200ResponseShipmentsInnerToJSON, } from './GetOrder200ResponseShipmentsInner';
 /**
  * @export
@@ -67,7 +67,7 @@ export function GetOrder200ResponseFromJSONTyped(json, ignoreDiscriminator) {
         'customerName': json['customerName'] === undefined ? undefined : json['customerName'] === null ? null : json['customerName'],
         'customerEmail': json['customerEmail'] === undefined ? undefined : json['customerEmail'] === null ? null : json['customerEmail'],
         'shippingAddress': json['shippingAddress'] === undefined ? undefined : json['shippingAddress'] === null ? null : CreateOrder201ResponseShippingAddressFromJSON(json['shippingAddress']),
-        'orderLines': (json['orderLines'].map(CreateOrder201ResponseOrderLinesInnerFromJSON)),
+        'orderLines': (json['orderLines'].map(GetOrder200ResponseOrderLinesInnerFromJSON)),
         'subtotalAmount': json['subtotalAmount'] === undefined ? undefined : json['subtotalAmount'] === null ? null : json['subtotalAmount'],
         'totalAmount': json['totalAmount'] === undefined ? undefined : json['totalAmount'] === null ? null : json['totalAmount'],
         'currency': json['currency'] === undefined ? undefined : json['currency'] === null ? null : json['currency'],
@@ -98,7 +98,7 @@ export function GetOrder200ResponseToJSONTyped(value, ignoreDiscriminator = fals
         'customerName': value['customerName'],
         'customerEmail': value['customerEmail'],
         'shippingAddress': CreateOrder201ResponseShippingAddressToJSON(value['shippingAddress']),
-        'orderLines': (value['orderLines'].map(CreateOrder201ResponseOrderLinesInnerToJSON)),
+        'orderLines': (value['orderLines'].map(GetOrder200ResponseOrderLinesInnerToJSON)),
         'subtotalAmount': value['subtotalAmount'],
         'totalAmount': value['totalAmount'],
         'currency': value['currency'],

package/dist/esm/models/GetOrder200ResponseOrderLinesInner.d.ts

@@ -0,0 +1,162 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface GetOrder200ResponseOrderLinesInner
+ */
+export interface GetOrder200ResponseOrderLinesInner {
+    /**
+     * Stock keeping unit identifier.
+     * @type {string}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    sku?: string | null;
+    /**
+     * Product name.
+     * @type {string}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    name: string;
+    /**
+     * Quantity ordered.
+     * @type {number}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    quantity: number;
+    /**
+     * Price per unit.
+     * @type {number}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    unitPrice?: number | null;
+    /**
+     * Total price for the line.
+     * @type {number}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    totalPrice?: number | null;
+    /**
+     * ISO 4217 currency code.
+     * @type {string}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    currency?: string | null;
+    /**
+     * Item weight in the given unit.
+     * @type {number}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    weight?: number | null;
+    /**
+     * Unit of the weight value.
+     * @type {GetOrder200ResponseOrderLinesInnerWeightUnitEnum}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    weightUnit?: GetOrder200ResponseOrderLinesInnerWeightUnitEnum | null;
+    /**
+     * Platform variant identifier.
+     * @type {string}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    variantId?: string | null;
+    /**
+     * Platform product identifier.
+     * @type {string}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    productId?: string | null;
+    /**
+     * Product image URL.
+     * @type {string}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    imageUrl?: string | null;
+    /**
+     * Harmonized System customs code (6-13 digits).
+     * @type {string}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    hsCode?: string | null;
+    /**
+     * ISO 3166-1 alpha-2 country of origin.
+     * @type {string}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    countryOfOrigin?: string | null;
+    /**
+     * ISO 3166-2 province of origin.
+     * @type {string}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    provinceOfOrigin?: string | null;
+    /**
+     * Item barcode (EAN/UPC).
+     * @type {string}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    barcode?: string | null;
+    /**
+     * Whether the item requires shipping.
+     * @type {boolean}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    requiresShipping?: boolean | null;
+    /**
+     * Whether the item is taxable.
+     * @type {boolean}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    taxable?: boolean | null;
+    /**
+     * Whether the item is a gift card.
+     * @type {boolean}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    giftCard?: boolean | null;
+    /**
+     * Vendor or brand name.
+     * @type {string}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    vendor?: string | null;
+    /**
+     * Order line ID. Present once the line is a row. Absent for jsonb-only lines during the dual-write window — do not synthesise one, or an edit would re-point packed lines.
+     * @type {string}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    id?: string;
+    /**
+     * Quantity already allocated to outbound shipments.
+     * @type {number}
+     * @memberof GetOrder200ResponseOrderLinesInner
+     */
+    packedQuantity: number;
+}
+/**
+ * @export
+ */
+export declare const GetOrder200ResponseOrderLinesInnerWeightUnitEnum: {
+    readonly Kg: "kg";
+    readonly G: "g";
+    readonly Lb: "lb";
+    readonly Oz: "oz";
+};
+export type GetOrder200ResponseOrderLinesInnerWeightUnitEnum = typeof GetOrder200ResponseOrderLinesInnerWeightUnitEnum[keyof typeof GetOrder200ResponseOrderLinesInnerWeightUnitEnum];
+/**
+ * Check if a given object implements the GetOrder200ResponseOrderLinesInner interface.
+ */
+export declare function instanceOfGetOrder200ResponseOrderLinesInner(value: object): value is GetOrder200ResponseOrderLinesInner;
+export declare function GetOrder200ResponseOrderLinesInnerFromJSON(json: any): GetOrder200ResponseOrderLinesInner;
+export declare function GetOrder200ResponseOrderLinesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetOrder200ResponseOrderLinesInner;
+export declare function GetOrder200ResponseOrderLinesInnerToJSON(json: any): GetOrder200ResponseOrderLinesInner;
+export declare function GetOrder200ResponseOrderLinesInnerToJSONTyped(value?: GetOrder200ResponseOrderLinesInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetOrder200ResponseOrderLinesInner.js

@@ -0,0 +1,96 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const GetOrder200ResponseOrderLinesInnerWeightUnitEnum = {
+    Kg: 'kg',
+    G: 'g',
+    Lb: 'lb',
+    Oz: 'oz'
+};
+/**
+ * Check if a given object implements the GetOrder200ResponseOrderLinesInner interface.
+ */
+export function instanceOfGetOrder200ResponseOrderLinesInner(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('quantity' in value) || value['quantity'] === undefined)
+        return false;
+    if (!('packedQuantity' in value) || value['packedQuantity'] === undefined)
+        return false;
+    return true;
+}
+export function GetOrder200ResponseOrderLinesInnerFromJSON(json) {
+    return GetOrder200ResponseOrderLinesInnerFromJSONTyped(json, false);
+}
+export function GetOrder200ResponseOrderLinesInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'sku': json['sku'] === undefined ? undefined : json['sku'] === null ? null : json['sku'],
+        'name': json['name'],
+        'quantity': json['quantity'],
+        'unitPrice': json['unitPrice'] === undefined ? undefined : json['unitPrice'] === null ? null : json['unitPrice'],
+        'totalPrice': json['totalPrice'] === undefined ? undefined : json['totalPrice'] === null ? null : json['totalPrice'],
+        'currency': json['currency'] === undefined ? undefined : json['currency'] === null ? null : json['currency'],
+        'weight': json['weight'] === undefined ? undefined : json['weight'] === null ? null : json['weight'],
+        'weightUnit': json['weightUnit'] === undefined ? undefined : json['weightUnit'] === null ? null : json['weightUnit'],
+        'variantId': json['variantId'] === undefined ? undefined : json['variantId'] === null ? null : json['variantId'],
+        'productId': json['productId'] === undefined ? undefined : json['productId'] === null ? null : json['productId'],
+        'imageUrl': json['imageUrl'] === undefined ? undefined : json['imageUrl'] === null ? null : json['imageUrl'],
+        'hsCode': json['hsCode'] === undefined ? undefined : json['hsCode'] === null ? null : json['hsCode'],
+        'countryOfOrigin': json['countryOfOrigin'] === undefined ? undefined : json['countryOfOrigin'] === null ? null : json['countryOfOrigin'],
+        'provinceOfOrigin': json['provinceOfOrigin'] === undefined ? undefined : json['provinceOfOrigin'] === null ? null : json['provinceOfOrigin'],
+        'barcode': json['barcode'] === undefined ? undefined : json['barcode'] === null ? null : json['barcode'],
+        'requiresShipping': json['requiresShipping'] === undefined ? undefined : json['requiresShipping'] === null ? null : json['requiresShipping'],
+        'taxable': json['taxable'] === undefined ? undefined : json['taxable'] === null ? null : json['taxable'],
+        'giftCard': json['giftCard'] === undefined ? undefined : json['giftCard'] === null ? null : json['giftCard'],
+        'vendor': json['vendor'] === undefined ? undefined : json['vendor'] === null ? null : json['vendor'],
+        'id': json['id'] == null ? undefined : json['id'],
+        'packedQuantity': json['packedQuantity'],
+    };
+}
+export function GetOrder200ResponseOrderLinesInnerToJSON(json) {
+    return GetOrder200ResponseOrderLinesInnerToJSONTyped(json, false);
+}
+export function GetOrder200ResponseOrderLinesInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'sku': value['sku'],
+        'name': value['name'],
+        'quantity': value['quantity'],
+        'unitPrice': value['unitPrice'],
+        'totalPrice': value['totalPrice'],
+        'currency': value['currency'],
+        'weight': value['weight'],
+        'weightUnit': value['weightUnit'],
+        'variantId': value['variantId'],
+        'productId': value['productId'],
+        'imageUrl': value['imageUrl'],
+        'hsCode': value['hsCode'],
+        'countryOfOrigin': value['countryOfOrigin'],
+        'provinceOfOrigin': value['provinceOfOrigin'],
+        'barcode': value['barcode'],
+        'requiresShipping': value['requiresShipping'],
+        'taxable': value['taxable'],
+        'giftCard': value['giftCard'],
+        'vendor': value['vendor'],
+        'id': value['id'],
+        'packedQuantity': value['packedQuantity'],
+    };
+}

package/dist/esm/models/GetOrder200ResponseShipmentsInner.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { CreateShipment201ResponseDocumentsInner } from './CreateShipment201ResponseDocumentsInner';
+import type { GetOrder200ResponseShipmentsInnerParcelsInner } from './GetOrder200ResponseShipmentsInnerParcelsInner';
 import type { ListShipments200ResponseDataInnerCarrierSettings } from './ListShipments200ResponseDataInnerCarrierSettings';
 import type { CreateShipment201ResponseTracking } from './CreateShipment201ResponseTracking';
 /**
@@ -84,6 +85,12 @@ export interface GetOrder200ResponseShipmentsInner {
      * @memberof GetOrder200ResponseShipmentsInner
      */
     documents?: Array<CreateShipment201ResponseDocumentsInner>;
+    /**
+     * Compact parcels for the order fulfillment workspace (no QR/label payloads).
+     * @type {Array<GetOrder200ResponseShipmentsInnerParcelsInner>}
+     * @memberof GetOrder200ResponseShipmentsInner
+     */
+    parcels: Array<GetOrder200ResponseShipmentsInnerParcelsInner>;
 }
 /**
  * @export

package/dist/esm/models/GetOrder200ResponseShipmentsInner.js

@@ -12,6 +12,7 @@
  * Do not edit the class manually.
  */
 import { CreateShipment201ResponseDocumentsInnerFromJSON, CreateShipment201ResponseDocumentsInnerToJSON, } from './CreateShipment201ResponseDocumentsInner';
+import { GetOrder200ResponseShipmentsInnerParcelsInnerFromJSON, GetOrder200ResponseShipmentsInnerParcelsInnerToJSON, } from './GetOrder200ResponseShipmentsInnerParcelsInner';
 import { ListShipments200ResponseDataInnerCarrierSettingsFromJSON, ListShipments200ResponseDataInnerCarrierSettingsToJSON, } from './ListShipments200ResponseDataInnerCarrierSettings';
 import { CreateShipment201ResponseTrackingFromJSON, CreateShipment201ResponseTrackingToJSON, } from './CreateShipment201ResponseTracking';
 /**
@@ -52,6 +53,8 @@ export function instanceOfGetOrder200ResponseShipmentsInner(value) {
         return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined)
         return false;
+    if (!('parcels' in value) || value['parcels'] === undefined)
+        return false;
     return true;
 }
 export function GetOrder200ResponseShipmentsInnerFromJSON(json) {
@@ -73,6 +76,7 @@ export function GetOrder200ResponseShipmentsInnerFromJSONTyped(json, ignoreDiscr
         'updatedAt': json['updatedAt'],
         'shippingRuleId': json['shippingRuleId'] === undefined ? undefined : json['shippingRuleId'] === null ? null : json['shippingRuleId'],
         'documents': json['documents'] == null ? undefined : (json['documents'].map(CreateShipment201ResponseDocumentsInnerFromJSON)),
+        'parcels': (json['parcels'].map(GetOrder200ResponseShipmentsInnerParcelsInnerFromJSON)),
     };
 }
 export function GetOrder200ResponseShipmentsInnerToJSON(json) {
@@ -94,5 +98,6 @@ export function GetOrder200ResponseShipmentsInnerToJSONTyped(value, ignoreDiscri
         'updatedAt': value['updatedAt'],
         'shippingRuleId': value['shippingRuleId'],
         'documents': value['documents'] == null ? undefined : (value['documents'].map(CreateShipment201ResponseDocumentsInnerToJSON)),
+        'parcels': (value['parcels'].map(GetOrder200ResponseShipmentsInnerParcelsInnerToJSON)),
     };
 }

package/dist/esm/models/GetOrder200ResponseShipmentsInnerParcelsInner.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 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 { GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner } from './GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner';
+import type { CreateShipment201ResponseParcelsInnerDimensions } from './CreateShipment201ResponseParcelsInnerDimensions';
+/**
+ *
+ * @export
+ * @interface GetOrder200ResponseShipmentsInnerParcelsInner
+ */
+export interface GetOrder200ResponseShipmentsInnerParcelsInner {
+    /**
+     * Parcel ID.
+     * @type {string}
+     * @memberof GetOrder200ResponseShipmentsInnerParcelsInner
+     */
+    id: string;
+    /**
+     * Parcel weight in the given unit.
+     * @type {number}
+     * @memberof GetOrder200ResponseShipmentsInnerParcelsInner
+     */
+    weight: number;
+    /**
+     * Unit of measurement for parcel weight.
+     * @type {GetOrder200ResponseShipmentsInnerParcelsInnerWeightUnitEnum}
+     * @memberof GetOrder200ResponseShipmentsInnerParcelsInner
+     */
+    weightUnit: GetOrder200ResponseShipmentsInnerParcelsInnerWeightUnitEnum;
+    /**
+     *
+     * @type {CreateShipment201ResponseParcelsInnerDimensions}
+     * @memberof GetOrder200ResponseShipmentsInnerParcelsInner
+     */
+    dimensions: CreateShipment201ResponseParcelsInnerDimensions;
+    /**
+     * Contents of this parcel.
+     * @type {Array<GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner>}
+     * @memberof GetOrder200ResponseShipmentsInnerParcelsInner
+     */
+    orderLines: Array<GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner>;
+}
+/**
+ * @export
+ */
+export declare const GetOrder200ResponseShipmentsInnerParcelsInnerWeightUnitEnum: {
+    readonly Kg: "kg";
+    readonly G: "g";
+    readonly Lb: "lb";
+    readonly Oz: "oz";
+};
+export type GetOrder200ResponseShipmentsInnerParcelsInnerWeightUnitEnum = typeof GetOrder200ResponseShipmentsInnerParcelsInnerWeightUnitEnum[keyof typeof GetOrder200ResponseShipmentsInnerParcelsInnerWeightUnitEnum];
+/**
+ * Check if a given object implements the GetOrder200ResponseShipmentsInnerParcelsInner interface.
+ */
+export declare function instanceOfGetOrder200ResponseShipmentsInnerParcelsInner(value: object): value is GetOrder200ResponseShipmentsInnerParcelsInner;
+export declare function GetOrder200ResponseShipmentsInnerParcelsInnerFromJSON(json: any): GetOrder200ResponseShipmentsInnerParcelsInner;
+export declare function GetOrder200ResponseShipmentsInnerParcelsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetOrder200ResponseShipmentsInnerParcelsInner;
+export declare function GetOrder200ResponseShipmentsInnerParcelsInnerToJSON(json: any): GetOrder200ResponseShipmentsInnerParcelsInner;
+export declare function GetOrder200ResponseShipmentsInnerParcelsInnerToJSONTyped(value?: GetOrder200ResponseShipmentsInnerParcelsInner | null, ignoreDiscriminator?: boolean): any;