API Reference

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.store_info({});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->storeInfo();

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.delivery_settings_manage({
    "action": "example",
    "delivery_logistics_enabled": true,
    "driver_self_serve_claim_enabled": true
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->deliverySettingsManage([
    'action' => 'example',
    'delivery_logistics_enabled' => true,
    'driver_self_serve_claim_enabled' => true,
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.store_settings_manage({
    "action": "example",
    "name": "example",
    "phone": "example"
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->storeSettingsManage([
    'action' => 'example',
    'name' => 'example',
    'phone' => 'example',
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.order_dashboard({
    "order_number": "example",
    "customer_email": "example",
    "customer_phone": "example"
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->orderDashboard([
    'order_number' => 'example',
    'customer_email' => 'example',
    'customer_phone' => 'example',
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.inventory_status({
    "alert_only": true
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->inventoryStatus([
    'alert_only' => true,
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.product_inspect({
    "product_id": 10,
    "name_query": "example",
    "sku": "example"
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->productInspect([
    'product_id' => 10,
    'name_query' => 'example',
    'sku' => 'example',
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.product_unit_price_search({
    "unit": "example",
    "name_query": "example",
    "min_price": 10.5
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->productUnitPriceSearch([
    'unit' => 'example',
    'name_query' => 'example',
    'min_price' => 10.5,
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.strain_lookup({
    "query": "example"
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->strainLookup([
    'query' => 'example',
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.catalog_flattening_audit({});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->catalogFlatteningAudit();

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.catalog_variant_audit({
    "name_query": "example"
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->catalogVariantAudit([
    'name_query' => 'example',
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.inventory_audit_lookup({
    "product_ids": [],
    "cutoff_iso": "example"
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->inventoryAuditLookup([
    'product_ids' => [],
    'cutoff_iso' => 'example',
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.product_image_strain_match({
    "product_ids": [],
    "search": "example",
    "limit": 10
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->productImageStrainMatch([
    'product_ids' => [],
    'search' => 'example',
    'limit' => 10,
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.catalog_collapse({
    "base_name": "example",
    "dry_run": true
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->catalogCollapse([
    'base_name' => 'example',
    'dry_run' => true,
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.catalog_variant_compact({
    "survivor_product_id": 10,
    "products": [],
    "name": "example"
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->catalogVariantCompact([
    'survivor_product_id' => 10,
    'products' => [],
    'name' => 'example',
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.pricing_structure_list({
    "kind": "example",
    "include_tiers": true,
    "include_product_ids": true
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->pricingStructureList([
    'kind' => 'example',
    'include_tiers' => true,
    'include_product_ids' => true,
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.pricing_structure_upsert({
    "structure_id": 10,
    "product_slug": "example",
    "product_id": 10
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->pricingStructureUpsert([
    'structure_id' => 10,
    'product_slug' => 'example',
    'product_id' => 10,
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.pricing_structure_assign({
    "structure_id": 10,
    "product_slugs": [],
    "product_ids": []
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->pricingStructureAssign([
    'structure_id' => 10,
    'product_slugs' => [],
    'product_ids' => [],
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.pricing_structure_delete({
    "structure_ids": [],
    "force": true,
    "orphan_products_acknowledged": true
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->pricingStructureDelete([
    'structure_ids' => [],
    'force' => true,
    'orphan_products_acknowledged' => true,
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.pricing_structure_restore({
    "product_id": 10,
    "tracking_type": "example",
    "inventory_mode": "example"
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->pricingStructureRestore([
    'product_id' => 10,
    'tracking_type' => 'example',
    'inventory_mode' => 'example',
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.product_update_by_sku({
    "sku": "example",
    "stock_quantity": 10.5,
    "price": 10.5
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->productUpdateBySku([
    'sku' => 'example',
    'stock_quantity' => 10.5,
    'price' => 10.5,
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.category_manage({
    "action": "example",
    "category_id": 10,
    "name": "example"
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->categoryManage([
    'action' => 'example',
    'category_id' => 10,
    'name' => 'example',
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.product_manage({
    "action": "example",
    "product_id": 10,
    "name": "example"
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->productManage([
    'action' => 'example',
    'product_id' => 10,
    'name' => 'example',
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.product_visibility_manage({
    "product_ids": [],
    "visibility": "example",
    "dry_run": true
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->productVisibilityManage([
    'product_ids' => [],
    'visibility' => 'example',
    'dry_run' => true,
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.catalog_import({
    "categories": [],
    "products": [],
    "dry_run": true
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->catalogImport([
    'categories' => [],
    'products' => [],
    'dry_run' => true,
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.product_feature_manage({
    "action": "example",
    "product_ids": [],
    "featured": true
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->productFeatureManage([
    'action' => 'example',
    'product_ids' => [],
    'featured' => true,
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.product_image_assign({
    "product_id": 10,
    "media_id": 10,
    "gallery_media_ids": []
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->productImageAssign([
    'product_id' => 10,
    'media_id' => 10,
    'gallery_media_ids' => [],
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.product_image_strain_assign({
    "assignments": [],
    "auto_match": true,
    "search": "example"
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->productImageStrainAssign([
    'assignments' => [],
    'auto_match' => true,
    'search' => 'example',
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.supplier_upsert({
    "supplier_id": 10,
    "name": "example",
    "email": "example"
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->supplierUpsert([
    'supplier_id' => 10,
    'name' => 'example',
    'email' => 'example',
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.purchase_order_draft_create({
    "supplier_id": 10,
    "notes": "example"
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->purchaseOrderDraftCreate([
    'supplier_id' => 10,
    'notes' => 'example',
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.purchase_order_line_add({
    "purchase_order_id": 10,
    "product_id": 10,
    "variation_id": 10
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->purchaseOrderLineAdd([
    'purchase_order_id' => 10,
    'product_id' => 10,
    'variation_id' => 10,
]);

import { DabDash } from '@shadow-software/dabdash-sdk';

const dabdash = new DabDash({ token: process.env.DABDASH_API_TOKEN });

const result = await dabdash.tools.media_list({
    "visibility": "example",
    "folder": "example",
    "search": "example"
});

use ShadowSoftware\DabDash\DabDashClient;

$dabdash = new DabDashClient(token: $_ENV['DABDASH_API_TOKEN']);

$result = $dabdash->tools()->mediaList([
    'visibility' => 'example',
    'folder' => 'example',
    'search' => 'example',
]);