@zippendo/sdk 1.2.5 → 1.2.7

package/dist/esm/models/GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner.js

@@ -0,0 +1,51 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner interface.
+ */
+export function instanceOfGetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('quantity' in value) || value['quantity'] === undefined)
+        return false;
+    return true;
+}
+export function GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerFromJSON(json) {
+    return GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerFromJSONTyped(json, false);
+}
+export function GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        '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'],
+    };
+}
+export function GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerToJSON(json) {
+    return GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerToJSONTyped(json, false);
+}
+export function GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'sku': value['sku'],
+        'quantity': value['quantity'],
+        'description': value['description'],
+    };
+}

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

@@ -61,6 +61,9 @@ export declare const ListApiTokens401ResponseCodeEnum: {
     readonly AuthMfaRequired: "AUTH_MFA_REQUIRED";
     readonly AuthMfaInvalidCode: "AUTH_MFA_INVALID_CODE";
     readonly AuthMfaAlreadyEnabled: "AUTH_MFA_ALREADY_ENABLED";
+    readonly CaptchaFailed: "CAPTCHA_FAILED";
+    readonly EmailDomainBlocked: "EMAIL_DOMAIN_BLOCKED";
+    readonly VatInvalid: "VAT_INVALID";
     readonly AuthMfaNotEnabled: "AUTH_MFA_NOT_ENABLED";
     readonly SessionRequired: "SESSION_REQUIRED";
     readonly OrgNotFound: "ORG_NOT_FOUND";
@@ -113,6 +116,7 @@ export declare const ListApiTokens401ResponseCodeEnum: {
     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/ListApiTokens401Response.js

@@ -38,6 +38,9 @@ export const ListApiTokens401ResponseCodeEnum = {
     AuthMfaRequired: 'AUTH_MFA_REQUIRED',
     AuthMfaInvalidCode: 'AUTH_MFA_INVALID_CODE',
     AuthMfaAlreadyEnabled: 'AUTH_MFA_ALREADY_ENABLED',
+    CaptchaFailed: 'CAPTCHA_FAILED',
+    EmailDomainBlocked: 'EMAIL_DOMAIN_BLOCKED',
+    VatInvalid: 'VAT_INVALID',
     AuthMfaNotEnabled: 'AUTH_MFA_NOT_ENABLED',
     SessionRequired: 'SESSION_REQUIRED',
     OrgNotFound: 'ORG_NOT_FOUND',
@@ -90,6 +93,7 @@ export const ListApiTokens401ResponseCodeEnum = {
     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/SendShipment422Response.d.ts

@@ -68,6 +68,9 @@ export declare const SendShipment422ResponseCodeEnum: {
     readonly AuthMfaRequired: "AUTH_MFA_REQUIRED";
     readonly AuthMfaInvalidCode: "AUTH_MFA_INVALID_CODE";
     readonly AuthMfaAlreadyEnabled: "AUTH_MFA_ALREADY_ENABLED";
+    readonly CaptchaFailed: "CAPTCHA_FAILED";
+    readonly EmailDomainBlocked: "EMAIL_DOMAIN_BLOCKED";
+    readonly VatInvalid: "VAT_INVALID";
     readonly AuthMfaNotEnabled: "AUTH_MFA_NOT_ENABLED";
     readonly SessionRequired: "SESSION_REQUIRED";
     readonly OrgNotFound: "ORG_NOT_FOUND";
@@ -120,6 +123,7 @@ export declare const SendShipment422ResponseCodeEnum: {
     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/SendShipment422Response.js

@@ -39,6 +39,9 @@ export const SendShipment422ResponseCodeEnum = {
     AuthMfaRequired: 'AUTH_MFA_REQUIRED',
     AuthMfaInvalidCode: 'AUTH_MFA_INVALID_CODE',
     AuthMfaAlreadyEnabled: 'AUTH_MFA_ALREADY_ENABLED',
+    CaptchaFailed: 'CAPTCHA_FAILED',
+    EmailDomainBlocked: 'EMAIL_DOMAIN_BLOCKED',
+    VatInvalid: 'VAT_INVALID',
     AuthMfaNotEnabled: 'AUTH_MFA_NOT_ENABLED',
     SessionRequired: 'SESSION_REQUIRED',
     OrgNotFound: 'ORG_NOT_FOUND',
@@ -91,6 +94,7 @@ export const SendShipment422ResponseCodeEnum = {
     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/UpdateOrderRequest.d.ts

@@ -83,6 +83,12 @@ export interface UpdateOrderRequest {
      * @memberof UpdateOrderRequest
      */
     shippingRuleId?: string | null;
+    /**
+     * Service point (parcel shop) ID to apply to unsent outbound shipments.
+     * @type {string}
+     * @memberof UpdateOrderRequest
+     */
+    servicePointId?: string | null;
 }
 /**
  * @export

package/dist/esm/models/UpdateOrderRequest.js

@@ -49,6 +49,7 @@ export function UpdateOrderRequestFromJSONTyped(json, ignoreDiscriminator) {
         'notes': json['notes'] === undefined ? undefined : json['notes'] === null ? null : json['notes'],
         'status': json['status'] == null ? undefined : json['status'],
         'shippingRuleId': json['shippingRuleId'] === undefined ? undefined : json['shippingRuleId'] === null ? null : json['shippingRuleId'],
+        'servicePointId': json['servicePointId'] === undefined ? undefined : json['servicePointId'] === null ? null : json['servicePointId'],
     };
 }
 export function UpdateOrderRequestToJSON(json) {
@@ -70,5 +71,6 @@ export function UpdateOrderRequestToJSONTyped(value, ignoreDiscriminator = false
         'notes': value['notes'],
         'status': value['status'],
         'shippingRuleId': value['shippingRuleId'],
+        'servicePointId': value['servicePointId'],
     };
 }

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

@@ -45,12 +45,6 @@ export interface UpdateOrgRequest {
      * @memberof UpdateOrgRequest
      */
     vatNumber?: string | null;
-    /**
-     * Allow shipments beyond plan limit (overage charges apply)
-     * @type {boolean}
-     * @memberof UpdateOrgRequest
-     */
-    overageEnabled?: boolean;
     /**
      * Billing/contact phone number
      * @type {string}

package/dist/esm/models/UpdateOrgRequest.js

@@ -41,7 +41,6 @@ export function UpdateOrgRequestFromJSONTyped(json, ignoreDiscriminator) {
         'description': json['description'] == null ? undefined : json['description'],
         'currency': json['currency'] == null ? undefined : json['currency'],
         'vatNumber': json['vatNumber'] === undefined ? undefined : json['vatNumber'] === null ? null : json['vatNumber'],
-        'overageEnabled': json['overageEnabled'] == null ? undefined : json['overageEnabled'],
         'phone': json['phone'] === undefined ? undefined : json['phone'] === null ? null : json['phone'],
         'billingEmail': json['billingEmail'] === undefined ? undefined : json['billingEmail'] === null ? null : json['billingEmail'],
         'companyName': json['companyName'] === undefined ? undefined : json['companyName'] === null ? null : json['companyName'],
@@ -66,7 +65,6 @@ export function UpdateOrgRequestToJSONTyped(value, ignoreDiscriminator = false)
         'description': value['description'],
         'currency': value['currency'],
         'vatNumber': value['vatNumber'],
-        'overageEnabled': value['overageEnabled'],
         'phone': value['phone'],
         'billingEmail': value['billingEmail'],
         'companyName': value['companyName'],

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

@@ -73,7 +73,10 @@ export * from './GetBillingUsage200ResponseLimitsTeamMembers';
 export * from './GetBillingUsage200ResponseShipments';
 export * from './GetBillingUsage200ResponseZippyMessages';
 export * from './GetOrder200Response';
+export * from './GetOrder200ResponseOrderLinesInner';
 export * from './GetOrder200ResponseShipmentsInner';
+export * from './GetOrder200ResponseShipmentsInnerParcelsInner';
+export * from './GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner';
 export * from './GetOrder200ResponseShippingRule';
 export * from './GetOrderChannelWebhookStatus200Response';
 export * from './GetOrderChannelWebhookStatus200ResponseWebhooksInner';

package/dist/esm/models/index.js

@@ -75,7 +75,10 @@ export * from './GetBillingUsage200ResponseLimitsTeamMembers';
 export * from './GetBillingUsage200ResponseShipments';
 export * from './GetBillingUsage200ResponseZippyMessages';
 export * from './GetOrder200Response';
+export * from './GetOrder200ResponseOrderLinesInner';
 export * from './GetOrder200ResponseShipmentsInner';
+export * from './GetOrder200ResponseShipmentsInnerParcelsInner';
+export * from './GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner';
 export * from './GetOrder200ResponseShippingRule';
 export * from './GetOrderChannelWebhookStatus200Response';
 export * from './GetOrderChannelWebhookStatus200ResponseWebhooksInner';

package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts

@@ -83,6 +83,9 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
     readonly AuthMfaRequired: "AUTH_MFA_REQUIRED";
     readonly AuthMfaInvalidCode: "AUTH_MFA_INVALID_CODE";
     readonly AuthMfaAlreadyEnabled: "AUTH_MFA_ALREADY_ENABLED";
+    readonly CaptchaFailed: "CAPTCHA_FAILED";
+    readonly EmailDomainBlocked: "EMAIL_DOMAIN_BLOCKED";
+    readonly VatInvalid: "VAT_INVALID";
     readonly AuthMfaNotEnabled: "AUTH_MFA_NOT_ENABLED";
     readonly SessionRequired: "SESSION_REQUIRED";
     readonly OrgNotFound: "ORG_NOT_FOUND";
@@ -135,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/models/BatchSendShipments200ResponseResultsInner.js

@@ -55,6 +55,9 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
     AuthMfaRequired: 'AUTH_MFA_REQUIRED',
     AuthMfaInvalidCode: 'AUTH_MFA_INVALID_CODE',
     AuthMfaAlreadyEnabled: 'AUTH_MFA_ALREADY_ENABLED',
+    CaptchaFailed: 'CAPTCHA_FAILED',
+    EmailDomainBlocked: 'EMAIL_DOMAIN_BLOCKED',
+    VatInvalid: 'VAT_INVALID',
     AuthMfaNotEnabled: 'AUTH_MFA_NOT_ENABLED',
     SessionRequired: 'SESSION_REQUIRED',
     OrgNotFound: 'ORG_NOT_FOUND',
@@ -107,6 +110,7 @@ exports.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/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/models/GetOrder200Response.js

@@ -19,10 +19,10 @@ exports.GetOrder200ResponseFromJSON = GetOrder200ResponseFromJSON;
 exports.GetOrder200ResponseFromJSONTyped = GetOrder200ResponseFromJSONTyped;
 exports.GetOrder200ResponseToJSON = GetOrder200ResponseToJSON;
 exports.GetOrder200ResponseToJSONTyped = GetOrder200ResponseToJSONTyped;
+const GetOrder200ResponseOrderLinesInner_1 = require("./GetOrder200ResponseOrderLinesInner");
 const GetOrder200ResponseShippingRule_1 = require("./GetOrder200ResponseShippingRule");
 const ListOrders200ResponseDataInnerOrderChannel_1 = require("./ListOrders200ResponseDataInnerOrderChannel");
 const CreateOrder201ResponseShippingAddress_1 = require("./CreateOrder201ResponseShippingAddress");
-const CreateOrder201ResponseOrderLinesInner_1 = require("./CreateOrder201ResponseOrderLinesInner");
 const GetOrder200ResponseShipmentsInner_1 = require("./GetOrder200ResponseShipmentsInner");
 /**
  * @export
@@ -75,7 +75,7 @@ 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 : (0, CreateOrder201ResponseShippingAddress_1.CreateOrder201ResponseShippingAddressFromJSON)(json['shippingAddress']),
-        'orderLines': (json['orderLines'].map(CreateOrder201ResponseOrderLinesInner_1.CreateOrder201ResponseOrderLinesInnerFromJSON)),
+        'orderLines': (json['orderLines'].map(GetOrder200ResponseOrderLinesInner_1.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'],
@@ -106,7 +106,7 @@ function GetOrder200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'customerName': value['customerName'],
         'customerEmail': value['customerEmail'],
         'shippingAddress': (0, CreateOrder201ResponseShippingAddress_1.CreateOrder201ResponseShippingAddressToJSON)(value['shippingAddress']),
-        'orderLines': (value['orderLines'].map(CreateOrder201ResponseOrderLinesInner_1.CreateOrder201ResponseOrderLinesInnerToJSON)),
+        'orderLines': (value['orderLines'].map(GetOrder200ResponseOrderLinesInner_1.GetOrder200ResponseOrderLinesInnerToJSON)),
         'subtotalAmount': value['subtotalAmount'],
         'totalAmount': value['totalAmount'],
         'currency': value['currency'],

package/dist/models/GetOrder200ResponseOrderLinesInner.d.ts

@@ -0,0 +1,156 @@
+/**
+ * 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;
+    /**
+     * 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/models/GetOrder200ResponseOrderLinesInner.js

@@ -0,0 +1,102 @@
+"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.GetOrder200ResponseOrderLinesInnerWeightUnitEnum = void 0;
+exports.instanceOfGetOrder200ResponseOrderLinesInner = instanceOfGetOrder200ResponseOrderLinesInner;
+exports.GetOrder200ResponseOrderLinesInnerFromJSON = GetOrder200ResponseOrderLinesInnerFromJSON;
+exports.GetOrder200ResponseOrderLinesInnerFromJSONTyped = GetOrder200ResponseOrderLinesInnerFromJSONTyped;
+exports.GetOrder200ResponseOrderLinesInnerToJSON = GetOrder200ResponseOrderLinesInnerToJSON;
+exports.GetOrder200ResponseOrderLinesInnerToJSONTyped = GetOrder200ResponseOrderLinesInnerToJSONTyped;
+/**
+ * @export
+ */
+exports.GetOrder200ResponseOrderLinesInnerWeightUnitEnum = {
+    Kg: 'kg',
+    G: 'g',
+    Lb: 'lb',
+    Oz: 'oz'
+};
+/**
+ * Check if a given object implements the GetOrder200ResponseOrderLinesInner interface.
+ */
+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;
+}
+function GetOrder200ResponseOrderLinesInnerFromJSON(json) {
+    return GetOrder200ResponseOrderLinesInnerFromJSONTyped(json, false);
+}
+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'],
+        'packedQuantity': json['packedQuantity'],
+    };
+}
+function GetOrder200ResponseOrderLinesInnerToJSON(json) {
+    return GetOrder200ResponseOrderLinesInnerToJSONTyped(json, false);
+}
+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'],
+        'packedQuantity': value['packedQuantity'],
+    };
+}

package/dist/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/models/GetOrder200ResponseShipmentsInner.js

@@ -20,6 +20,7 @@ exports.GetOrder200ResponseShipmentsInnerFromJSONTyped = GetOrder200ResponseShip
 exports.GetOrder200ResponseShipmentsInnerToJSON = GetOrder200ResponseShipmentsInnerToJSON;
 exports.GetOrder200ResponseShipmentsInnerToJSONTyped = GetOrder200ResponseShipmentsInnerToJSONTyped;
 const CreateShipment201ResponseDocumentsInner_1 = require("./CreateShipment201ResponseDocumentsInner");
+const GetOrder200ResponseShipmentsInnerParcelsInner_1 = require("./GetOrder200ResponseShipmentsInnerParcelsInner");
 const ListShipments200ResponseDataInnerCarrierSettings_1 = require("./ListShipments200ResponseDataInnerCarrierSettings");
 const CreateShipment201ResponseTracking_1 = require("./CreateShipment201ResponseTracking");
 /**
@@ -60,6 +61,8 @@ 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;
 }
 function GetOrder200ResponseShipmentsInnerFromJSON(json) {
@@ -81,6 +84,7 @@ function GetOrder200ResponseShipmentsInnerFromJSONTyped(json, ignoreDiscriminato
         'updatedAt': json['updatedAt'],
         'shippingRuleId': json['shippingRuleId'] === undefined ? undefined : json['shippingRuleId'] === null ? null : json['shippingRuleId'],
         'documents': json['documents'] == null ? undefined : (json['documents'].map(CreateShipment201ResponseDocumentsInner_1.CreateShipment201ResponseDocumentsInnerFromJSON)),
+        'parcels': (json['parcels'].map(GetOrder200ResponseShipmentsInnerParcelsInner_1.GetOrder200ResponseShipmentsInnerParcelsInnerFromJSON)),
     };
 }
 function GetOrder200ResponseShipmentsInnerToJSON(json) {
@@ -102,5 +106,6 @@ function GetOrder200ResponseShipmentsInnerToJSONTyped(value, ignoreDiscriminator
         'updatedAt': value['updatedAt'],
         'shippingRuleId': value['shippingRuleId'],
         'documents': value['documents'] == null ? undefined : (value['documents'].map(CreateShipment201ResponseDocumentsInner_1.CreateShipment201ResponseDocumentsInnerToJSON)),
+        'parcels': (value['parcels'].map(GetOrder200ResponseShipmentsInnerParcelsInner_1.GetOrder200ResponseShipmentsInnerParcelsInnerToJSON)),
     };
 }