@thorprovider/types 5.3.2 → 5.3.3

package/dist/index.d.ts

@@ -3689,14 +3689,11 @@ interface DropshipperCostTier {
     minQuantity: number | null;
     maxQuantity: number | null;
 }
-/** A quantity-based sale tier (Y→V) configured by the dropshipper (read response) */
+/** A quantity-based sale tier (Y→V) derived by the backend (read response) */
 interface DropshipperSaleTier {
-    /** Markup % over cost applied to this tier (X→Y baseline). */
-    margin_percent: number;
-    /** Derived sale price: round(cost × (1 + margin_percent/100)). */
-    sale_amount: number;
-    minQuantity: number;
-    maxQuantity?: number | null;
+    amount: number;
+    minQuantity: number | null;
+    maxQuantity: number | null;
 }
 /** A quantity-based sale tier in a price update payload (Y→V) */
 interface DropshipperPriceTier {
@@ -3740,6 +3737,7 @@ interface OnboardDropshipperResponse {
 interface DropshipperProductImage {
     id: string;
     url: string;
+    rank: number;
 }
 /** A product attachment (file/doc) linked via the product_attachment module */
 interface DropshipperProductAttachment {
@@ -3766,34 +3764,67 @@ interface DropshipperProductPrivateMedia {
     size: number;
     metadata: Record<string, unknown> | null;
 }
+/** A selected option value on a variant */
+interface DropshipperVariantOption {
+    option_id: string;
+    option_title: string;
+    value_id: string;
+    value: string;
+}
+/** Inventory aggregates for a variant */
+interface DropshipperVariantInventory {
+    stockedQuantity: number | null;
+    reservedQuantity: number | null;
+    availableQuantity: number | null;
+    incomingQuantity: number | null;
+}
+/** Stock level at a single location */
+interface DropshipperVariantLocation {
+    id: string;
+    name: string;
+    stockedQuantity: number;
+    reservedQuantity: number;
+    availableQuantity: number;
+    incomingQuantity: number;
+}
+/** Cost price and tiers (X→Y) */
+interface DropshipperVariantCostPricing {
+    amount: number;
+    currency: string;
+    source: 'custom' | 'base_price';
+    tiers: DropshipperCostTier[];
+}
+/** Sale price and tiers (Y→V) */
+interface DropshipperVariantSalePricing {
+    amount: number;
+    currency: string;
+    tiers: DropshipperSaleTier[];
+}
+/** Margin (Y) */
+interface DropshipperVariantMarginPricing {
+    amount: number;
+    percent: number;
+}
+/** Pricing bundle for a variant */
+interface DropshipperVariantPricing {
+    cost: DropshipperVariantCostPricing;
+    sale: DropshipperVariantSalePricing;
+    margin: DropshipperVariantMarginPricing;
+    markup_percent: number;
+}
 /** A product variant as seen by the dropshipper */
 interface DropshipperVariant {
     id: string;
     title: string;
     sku: string | null;
-    availableQuantity: number;
+    options: DropshipperVariantOption[];
     /** Whether inventory is tracked for this variant */
     manageInventory: boolean;
     /** Whether backorders are allowed when out of stock */
     allowBackorder: boolean;
-    /** Price Y pays to X. Read-only for Y. */
-    cost_price: number;
-    cost_price_currency: string;
-    /** "custom" if a custom cost was set, "base_price" if fallback */
-    cost_price_source: 'custom' | 'base_price';
-    /** Quantity-based cost tiers (X→Y) from the Price List */
-    cost_tiers: DropshipperCostTier[];
-    /** Price Y charges to V. From the channel's price list. */
-    sale_price: number;
-    sale_price_currency: string;
-    /** Markup % over cost applied to the base sale price (0–1000). */
-    sale_margin_percent: number;
-    /** Quantity-based sale tiers (Y→V) configured by the dropshipper */
-    sale_tiers: DropshipperSaleTier[];
-    /** sale_price - cost_price (calculated by backend) */
-    margin: number;
-    /** (margin / sale_price) × 100 (calculated by backend) */
-    margin_percent: number;
+    inventory: DropshipperVariantInventory;
+    locations: DropshipperVariantLocation[];
+    pricing: DropshipperVariantPricing;
 }
 /** A native Medusa product option value */
 interface DropshipperProductOptionValue {
@@ -3806,49 +3837,63 @@ interface DropshipperProductOption {
     title: string | null;
     values: DropshipperProductOptionValue[];
 }
+/** Standard (provider) physical attributes of a product */
+interface DropshipperProductStandardAttributes {
+    width: number | null;
+    height: number | null;
+    length: number | null;
+    weight: number | null;
+    material: string | null;
+    origin_country: string | null;
+    hs_code: string | null;
+    mid_code: string | null;
+}
+/** A custom attribute assigned to a product */
+interface DropshipperProductCustomAttribute {
+    id: string;
+    code: string;
+    name: string;
+    type: string;
+    value: string | null;
+}
+/** Product attributes bundle */
+interface DropshipperProductAttributes {
+    standard: DropshipperProductStandardAttributes;
+    custom: DropshipperProductCustomAttribute[];
+}
+/** Product media bundle */
+interface DropshipperProductMedia {
+    thumbnail: string | null;
+    images: DropshipperProductImage[];
+    private_images: DropshipperProductPrivateMedia[];
+}
+/** A channel-scoped category the product belongs to */
+interface DropshipperProductCategory {
+    id: string;
+    name: string;
+    handle: string;
+}
 /** A product as seen by the dropshipper */
 interface DropshipperProduct {
     id: string;
     title: string;
-    thumbnail: string | null;
-    status: 'published' | 'draft' | string;
-    global_status?: string | null;
-    can_publish?: boolean;
-    cannot_publish_reason?: 'missing_price' | 'product_not_published' | null;
-    /** Default margin applied to variants that do not have an override. */
-    margin_percent?: number;
-    variants: DropshipperVariant[];
-    subtitle?: string | null;
-    description?: string | null;
-    handle?: string | null;
-    /** Physical dimensions and shipping metadata */
-    width?: number | null;
-    height?: number | null;
-    length?: number | null;
-    weight?: number | null;
-    material?: string | null;
-    origin_country?: string | null;
-    hs_code?: string | null;
-    mid_code?: string | null;
-    collection?: {
+    subtitle: string | null;
+    description: string | null;
+    handle: string | null;
+    status: 'published' | 'draft' | 'archived' | string;
+    can_publish: boolean;
+    attributes: DropshipperProductAttributes;
+    media: DropshipperProductMedia;
+    categories: DropshipperProductCategory[];
+    collection: {
         id: string;
         title: string;
-        handle?: string;
+        handle: string;
     } | null;
-    medusa_categories?: Array<{
-        id: string;
-        name: string;
-        handle?: string;
-        parent_category_id?: string | null;
-    }>;
-    /** Native Medusa product options (Size, Color, etc.) */
-    medusa_options?: DropshipperProductOption[];
-    /** Public gallery images from Medusa — only set when the endpoint fetches them */
-    images?: DropshipperProductImage[];
+    options: DropshipperProductOption[];
+    variants: DropshipperVariant[];
     /** Product attachments (PDFs, CSVs, etc.) from the product_attachment module */
     attachments?: DropshipperProductAttachment[];
-    /** Private media (images/videos for dropshipper internal use) */
-    private_media?: DropshipperProductPrivateMedia[];
 }
 /** Options for `GET /admin/thor/dropshipper/products` */
 interface GetDropshipperProductsOptions {
@@ -3933,12 +3978,17 @@ interface DropshipperOrderCustomer {
 interface DropshipperOrder {
     id: string;
     display_id: number;
+    custom_display_id?: string | null;
+    version: number;
     status: string;
+    payment_status: string;
     fulfillment_status: string | null;
     created_at: string;
     customer: DropshipperOrderCustomer;
     currency_code: string;
     total: number;
+    tax_total: number;
+    net_revenue: number;
     profit: number;
     margin_percent: number;
     items_count: number;
@@ -4042,28 +4092,85 @@ interface DropshipperOrderShippingAddress {
     phone?: string | null;
 }
 /** A line item with cost and profit breakdown */
+interface DropshipperItemCost {
+    unit_amount: number;
+    total: number;
+}
+interface DropshipperItemProfit {
+    amount: number;
+    margin_percent: number;
+}
+interface DropshipperItemDetail {
+    quantity: number;
+    fulfilled_quantity: number;
+    delivered_quantity: number;
+    shipped_quantity: number;
+    return_requested_quantity: number;
+    return_received_quantity: number;
+    return_dismissed_quantity: number;
+    written_off_quantity: number;
+}
+interface DropshipperItemAdjustment {
+    id: string;
+    promotion_id: string | null;
+    code: string | null;
+    amount: number;
+    description: string | null;
+}
+interface DropshipperItemTaxLine {
+    id: string;
+    code: string | null;
+    rate: number;
+    total: number;
+    subtotal: number;
+}
 interface DropshipperOrderItem {
     id: string;
     title: string;
-    variant_title: string;
-    sku: string | null;
+    variant_title: string | null;
+    thumbnail: string | null;
     quantity: number;
     unit_price: number;
-    cost_price: number;
+    applied_tier_min_qty: number | null;
+    subtitle: string | null;
+    product_id: string | null;
+    product_title: string;
+    variant_id: string | null;
+    variant_sku: string | null;
+    variant_barcode: string | null;
+    variant_option_values: Record<string, string> | null;
+    compare_at_unit_price: number | null;
+    requires_shipping: boolean;
+    is_discountable: boolean;
+    is_tax_inclusive: boolean;
+    detail: DropshipperItemDetail;
+    adjustments: DropshipperItemAdjustment[];
+    tax_lines: DropshipperItemTaxLine[];
+    original_total: number;
+    original_subtotal: number;
+    original_tax_total: number;
+    item_total: number;
+    item_subtotal: number;
+    item_tax_total: number;
+    total: number;
     subtotal: number;
-    cost_subtotal: number;
-    profit: number;
-    thumbnail: string | null;
-    /** Minimum quantity of the cost tier that matched this item at order.placed.
-     *  null when no tier matching occurred (base price was used). */
-    applied_tier_min_qty?: number | null;
+    tax_total: number;
+    discount_total: number;
+    discount_tax_total: number;
+    refundable_total: number;
+    refundable_total_per_unit: number;
+    cost: DropshipperItemCost;
+    profit: DropshipperItemProfit;
+    metadata: null;
 }
 /** Order totals with profit breakdown */
 interface DropshipperOrderTotals {
     subtotal: number;
+    tax_total: number;
     shipping_total: number;
     discount_total: number;
     total: number;
+    net_revenue: number;
     cost_total: number;
     profit: number;
     margin_percent: number;
@@ -4071,15 +4178,132 @@ interface DropshipperOrderTotals {
 /** Timeline event on an order */
 interface DropshipperOrderTimelineEvent {
     id: string;
-    event: string;
-    description?: string;
-    type?: "info" | "success" | "warning" | "error";
+    code: string;
+    title: string;
+    description: string;
+    type: "info" | "success" | "warning" | "error";
     timestamp: string;
 }
+/** Payment collection on an order */
+interface DropshipperPaymentSession {
+    id: string;
+    provider: string;
+    status: string;
+    amount: number;
+    currency_code: string;
+    authorized_at: string | null;
+    provider_reference: string | null;
+}
+interface DropshipperPaymentCapture {
+    id: string;
+    amount: number;
+    created_at: string;
+    created_by: string | null;
+}
+interface DropshipperPaymentRefund {
+    id: string;
+    amount: number;
+    created_at: string;
+    created_by: string | null;
+}
+interface DropshipperPayment {
+    id: string;
+    provider: string;
+    amount: number;
+    currency_code: string;
+    authorized_amount: number;
+    captured_amount: number;
+    refunded_amount: number;
+    created_at: string;
+    updated_at: string;
+    captured_at: string | null;
+    canceled_at: string | null;
+    captures: DropshipperPaymentCapture[];
+    refunds: DropshipperPaymentRefund[];
+}
+interface DropshipperPaymentCollection {
+    id: string;
+    currency_code: string;
+    amount: number;
+    status: string;
+    payment_sessions: DropshipperPaymentSession[];
+    payments: DropshipperPayment[];
+}
+/** Return on an order */
+interface DropshipperReturnItem {
+    id: string;
+    item_id: string;
+    quantity: number;
+    received_quantity: number;
+    damaged_quantity: number;
+    reason_id: string | null;
+    note: string | null;
+    metadata: unknown | null;
+}
+interface DropshipperReturn {
+    id: string;
+    display_id: number;
+    status: string;
+    order_version: number;
+    refund_amount: number;
+    no_notification: boolean;
+    requested_at: string | null;
+    received_at: string | null;
+    canceled_at: string | null;
+    created_by: string | null;
+    items: DropshipperReturnItem[];
+}
+/** Transaction on an order */
+interface DropshipperTransaction {
+    id: string;
+    amount: number;
+    currency_code: string;
+    reference: string | null;
+    reference_id: string | null;
+    created_at: string;
+}
+/** Financial summary of an order */
+interface DropshipperFinancialSummary {
+    paid_total: number;
+    refunded_total: number;
+    pending_difference: number;
+    current_order_total: number;
+    original_order_total: number;
+    transaction_total: number;
+    accounting_total: number;
+}
+/** Pickup location */
+interface DropshipperPickupLocation {
+    id: string;
+    name: string;
+    address: {
+        address_1: string;
+        city: string | null;
+        province: string | null;
+        postal_code: string | null;
+        country_code: string;
+    } | null;
+}
+/** A shipping method on an order */
+interface DropshipperShippingMethod {
+    id: string;
+    name: string;
+    amount: number;
+    is_tax_inclusive: boolean;
+    original_total: number;
+    total: number;
+    tax_total: number;
+    discount_total: number;
+    shipping_option_id: string | null;
+    fulfillment_set_type: string | null;
+    pickup_location: DropshipperPickupLocation | null;
+}
 /** Full order detail as returned by GET /admin/thor/dropshipper/orders/:id */
 interface DropshipperOrderDetail {
     id: string;
     display_id: number;
+    custom_display_id?: string | null;
+    version: number;
     status: string;
     payment_status?: string;
     fulfillment_status: string | null;
@@ -4088,28 +4312,16 @@ interface DropshipperOrderDetail {
     customer: DropshipperOrderCustomer & {
         phone?: string;
     };
-    shipping_address: DropshipperOrderShippingAddress;
+    shipping_address: DropshipperOrderShippingAddress | null;
+    billing_address: DropshipperOrderShippingAddress | null;
     items: DropshipperOrderItem[];
     totals: DropshipperOrderTotals;
-    shipping_method?: {
-        id: string;
-        name: string;
-        amount: number;
-        shipping_option_id: string | null;
-        /** Fulfillment intent of the underlying shipping option: 'delivery' | 'pickup' | 'shipping' | null */
-        fulfillment_set_type?: string | null;
-        pickup_location?: {
-            id: string;
-            name: string;
-            address: {
-                address_1: string;
-                city: string | null;
-                province: string | null;
-                postal_code: string | null;
-                country_code: string;
-            } | null;
-        } | null;
-    } | null;
+    shipping_methods: DropshipperShippingMethod[];
+    payment_collections: DropshipperPaymentCollection[];
+    returns: DropshipperReturn[];
+    transactions: DropshipperTransaction[];
+    financial_summary: DropshipperFinancialSummary;
+    timeline: DropshipperOrderTimelineEvent[];
     payment_collected_by: 'dropshipper' | 'provider' | null;
     payment_method?: {
         id: string;
@@ -4118,7 +4330,16 @@ interface DropshipperOrderDetail {
     paid_amount?: number;
     due_date?: string | null;
     settlement_status: 'settled' | 'unsettled';
-    timeline: DropshipperOrderTimelineEvent[];
+    pickup_location: DropshipperPickupLocation | null;
+    /** Legacy singular shipping_method kept for backward compatibility */
+    shipping_method?: {
+        id: string;
+        name: string;
+        amount: number;
+        shipping_option_id: string | null;
+        fulfillment_set_type?: string | null;
+        pickup_location?: DropshipperPickupLocation | null;
+    } | null;
 }
 /** Response for `GET /admin/thor/dropshipper/orders/:id` */
 interface GetDropshipperOrderDetailResponse {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thorprovider/types",
-  "version": "5.3.2",
+  "version": "5.3.3",
   "description": "Shared TypeScript types for Thor Commerce ecosystem - Framework-agnostic type definitions",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",