Kōbō PLM API Documentation

The Kōbō PLM API provides programmatic access to your product lifecycle management data. Use it to integrate with ERPs, build custom workflows, or sync data with external systems.

Base URL

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Authentication

All API requests require authentication using an API key. Include your API key in theX-API-Key header with every request.

If your HTTP client prefers the standard Authorization header,Authorization: Bearer your_api_key is also accepted. Always send Accept: application/json so errors come back as JSON — validation failures return 422 with anerrors object.

curl -X GET "https://api.kobolabs.io/api/v1/styles" \
  -H "X-API-Key: your_api_key_here" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

# Or with the Authorization header:
curl -X GET "https://api.kobolabs.io/api/v1/styles" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Accept: application/json"

Getting an API Key

1. Log in to Kōbō PLM
2. Go to Account Settings → API Keys
3. Click Create API Key
4. Select the scopes (permissions) you need
5. Copy and securely store your key - it won't be shown again

API Key Scopes

Scope names must match exactly — note that some use a hyphen (purchase-orders:read, sales-orders:write,stock-takes:read) and others an underscore (credit_notes:read, sample_requests:write). Every scope a V1 route checks can be granted to a key; a request without the scope returns403 with error_code: insufficient_scope and the required_scopes it needed.

Rate Limiting

Requests are limited at two levels, and the first limit reached wins:

The company limits mean extra keys do not multiply throughput. Rate limit headers are included in every response (they describe the key’s per-minute window):

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1699574400

Pagination

List endpoints return paginated results. Use these query parameters:

Response includes pagination metadata:

{
  "data": [...],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "per_page": 25,
    "to": 25,
    "total": 250
  },
  "links": {
    "first": "https://api.kobolabs.io/api/v1/styles?page=1",
    "last": "https://api.kobolabs.io/api/v1/styles?page=10",
    "prev": null,
    "next": "https://api.kobolabs.io/api/v1/styles?page=2"
  }
}

Filtering

Most list endpoints support filtering for incremental sync:

# Get styles updated in the last 24 hours
curl "https://api.kobolabs.io/api/v1/styles?updated_since=2024-01-14T00:00:00Z" \
  -H "X-API-Key: your_api_key"

Including Relations

More than forty endpoints can return related records inline with?include=, so you can avoid a second round trip for each row. Separate several with commas, and use a dot for one level of nesting.

# Inventory rows with the style and location attached
curl "https://api.kobolabs.io/api/v1/style-inventory?include=style,location" \
  -H "X-API-Key: your_api_key"

Each endpoint publishes its own allow-list. Asking for something that is not on it returns a 422 naming the relations that are valid, so you can discover them without guessing. A relation only appears when you ask for it.

Two limits keep responses predictable: at most five relations per request, and at most one level of nesting (style.season is fine,style.season.brand is not).

What each endpoint can include

Relations not listed here are not includable. Where a relation has no public representation of its own it comes back as a compact summary (id, name/number and status) rather than the whole record. Includes are tenant-checked: a related record that belongs to another company is never returned.

Error Handling

The API uses standard HTTP status codes:

Error responses include details:

{
  "message": "The given data was invalid.",
  "errors": {
    "name": ["The name field is required."],
    "style_code": ["The style code has already been taken."]
  }
}

Limits & Errors

Besides the request rate limits, a few actions carry their own guards. Every limit answers with a JSON error that has an error_code; throttles answer 429 with a Retry-After header and a retry_after field in seconds.

Document send

Every POST .../send endpoint takes the same body and emails the same PDF the app sends. Kōbō never emails anyone outside your company and the document’s own customer or supplier contacts.

curl -X POST "https://api.kobolabs.io/api/v1/invoices/412/send" \
  -H "X-API-Key: your_api_key" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"recipients": ["accounts@buyer-store.com"], "subject": "Invoice INV-0412", "message": "Please find your invoice attached."}'

# 422 when a recipient is not allowed
{
  "success": false,
  "message": "One or more recipients are not allowed for this document",
  "error_code": "validation_error",
  "errors": {
    "recipients.0": ["Recipients must be users of your company or contacts of this document's customer or supplier."]
  }
}

File uploads

Multipart uploads (files, QC photos, labdip images and other attachments) accept up to 25 MB per file and these extensions: jpg jpeg png gif webp heic tif tiff bmp pdf doc docx xls xlsx ppt pptx csv txt rtf zip ai eps psd dxf dwg. Executables, scripts, HTML and SVG are refused. A company can upload 500 files a day through the API; past that you get 429 with upload_limit_exceeded.

Webhook URLs

Webhook URLs must use https and resolve to a public address. Private, loopback, link-local and cloud-metadata hosts are rejected when you save the webhook and checked again at delivery time. Redirects are not followed and your endpoint’s response body is not echoed back in delivery logs. A company can have at most 10 webhooks.

Common error codes

Changes in This Release

The October 2026 release adds document downloads and sending, critical path, seasons and drops, exchange rates, sample requests, labdip swatches, quote award, inbound shipments, purchase-order workflows, partial invoicing, showroom and merchandising endpoints, about 120 new response fields and many new ?include= relations. Most of it is additive. These behaviour changes may need a change on your side:

Styles

Styles represent your products/designs in Kōbō PLM.

List Styles

Example Request

curl "https://api.kobolabs.io/api/v1/styles?per_page=50&status=active" \
  -H "X-API-Key: your_api_key"

Example Response

{
  "data": [
    {
      "id": 1,
      "style_code": "SS24-001",
      "name": "Classic Cotton Tee",
      "description": "Premium cotton t-shirt",
      "status": "active",
      "category": {
        "id": 1,
        "name": "Tops"
      },
      "season": {
        "id": 1,
        "name": "Spring/Summer 2024"
      },
      "brand": {
        "id": 1,
        "name": "Main Brand"
      },
      "wholesale_price": "45.00",
      "retail_price": "89.00",
      "cost_price": "22.50",
      "currency": "USD",
      "sizes": ["XS", "S", "M", "L", "XL"],
      "colors": [
        {"id": 1, "name": "White", "hex": "#FFFFFF"},
        {"id": 2, "name": "Black", "hex": "#000000"}
      ],
      "images": [
        {
          "id": 1,
          "url": "https://storage.googleapis.com/kobo-system-files/styles/1/main.jpg",
          "type": "main"
        }
      ],
      "skus": [
        {
          "id": 1,
          "sku": "SS24-001-WHT-S",
          "size": "S",
          "color": "White",
          "barcode": "1234567890123"
        }
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T14:45:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 150
  }
}

Create Style

curl -X POST "https://api.kobolabs.io/api/v1/styles" \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "style_code": "SS24-002",
    "name": "Slim Fit Chinos",
    "description": "Modern slim fit chinos",
    "category_id": 2,
    "season_id": 1,
    "status": "development",
    "wholesale_price": 65.00,
    "retail_price": 129.00,
    "cost_price": 32.50,
    "currency": "USD",
    "sizes": ["28", "30", "32", "34", "36"]
  }'

Components

Components represent materials, trims, and other items used in production.

List Components

Shared Components

A component either belongs to one brand or is shared across every brand in the company. Send "shared": true (and no brand_id) onPOST /components or per row on POST /components/import to create a shared component; only a company-wide API key can. With a company-wide key and more than one brand, a brand-owned component needs brand_id. Every component returnsshared (boolean) and brand ({ id, name }, or null when shared). A brand-scoped key lists its brand's components plus the shared ones, and can read shared components but not change them (403).

Example Response

{
  "data": [
    {
      "id": 1,
      "code": "FAB-001",
      "name": "Organic Cotton Jersey",
      "type": "fabric",
      "description": "180gsm organic cotton jersey",
      "supplier": {
        "id": 1,
        "name": "Premium Textiles Ltd"
      },
      "unit": "meter",
      "unit_price": "8.50",
      "currency": "USD",
      "minimum_order_quantity": 100,
      "lead_time_days": 14,
      "specifications": {
        "weight": "180gsm",
        "width": "150cm",
        "composition": "100% Organic Cotton"
      },
      "created_at": "2024-01-10T09:00:00Z",
      "updated_at": "2024-01-12T11:30:00Z"
    }
  ]
}

Suppliers

Update Lifecycle Status

List Suppliers

Example Response

{
  "data": [
    {
      "id": 1,
      "name": "Premium Textiles Ltd",
      "code": "SUP-001",
      "type": "manufacturer",
      "email": "contact@premiumtextiles.com",
      "phone": "+1-555-0100",
      "website": "https://premiumtextiles.com",
      "address": {
        "street": "123 Industrial Way",
        "city": "Los Angeles",
        "state": "CA",
        "postal_code": "90001",
        "country": "US"
      },
      "contacts": [
        {
          "name": "John Smith",
          "email": "john@premiumtextiles.com",
          "phone": "+1-555-0101",
          "role": "Sales Manager"
        }
      ],
      "payment_terms": "Net 30",
      "currency": "USD",
      "rating": 4.5,
      "certifications": ["GOTS", "OEKO-TEX"],
      "created_at": "2024-01-05T08:00:00Z",
      "updated_at": "2024-01-14T16:20:00Z"
    }
  ]
}

Supplier Certifications

Track a supplier’s compliance certifications — BSCI, OEKO-TEX, GOTS, ISO and more — with issue and expiry dates. Each certification carries a derived expiry state (current, expiring, expired, no_expiry) computed from its dates, and the list can be filtered by type, status or expiry state.

Supplier File Sections

The collapsible sections that group uploads on a supplier. Files themselves are managed through the Files endpoints using ?supplier_id=; these are the structures they hang in. Deleting a section never deletes its files — they are simply unfiled.

Purchase Orders

Purchase orders now also expose supplier acknowledgement (supplier_acknowledged_at, supplier_ack_status, supplier_ack_note), client approval and payment-request fields, payment_waived, bill_to_location_id, pack_per_destination and original ship/delivery dates. bill_to_location_id and payment_waived are writable.

Status Values

draft, pending,confirmed, in_production,shipped, delivered,cancelled

Example Response

{
  "data": [
    {
      "id": 1,
      "po_number": "PO-2024-0001",
      "status": "confirmed",
      "supplier": {
        "id": 1,
        "name": "Premium Textiles Ltd"
      },
      "order_date": "2024-01-15",
      "expected_delivery_date": "2024-02-15",
      "ship_to": {
        "name": "Main Warehouse",
        "address": "789 Warehouse Blvd, Chicago, IL 60601"
      },
      "currency": "USD",
      "subtotal": "5000.00",
      "tax": "0.00",
      "shipping": "250.00",
      "total": "5250.00",
      "line_items": [
        {
          "id": 1,
          "style": {
            "id": 1,
            "style_code": "SS24-001",
            "name": "Classic Cotton Tee"
          },
          "sku": "SS24-001-WHT-M",
          "size": "M",
          "color": "White",
          "quantity": 100,
          "unit_price": "22.50",
          "total": "2250.00"
        }
      ],
      "notes": "Rush order - priority shipping required",
      "created_at": "2024-01-15T10:00:00Z",
      "updated_at": "2024-01-15T14:30:00Z"
    }
  ]
}

Inventory

List Inventory

Bulk Update Example

{
  "updates": [
    {
      "sku": "SS24-001-WHT-M",
      "location_id": 1,
      "qty_on_hand": 175
    },
    {
      "sku": "SS24-001-WHT-L",
      "location_id": 1,
      "qty_on_hand": 200
    }
  ]
}

Customers

List Customers

Customer Addresses

Manage shipping, billing, and other addresses for customers.

Create Address

Example Response

{
  "data": {
    "id": 1,
    "address_type": "shipping",
    "address_name": "Main Warehouse",
    "is_default": true,
    "street_address": "456 Commerce Blvd",
    "city": "New York",
    "state": "NY",
    "country": "US",
    "postal_code": "10001",
    "contact_name": "Jane Doe",
    "contact_email": "jane@example.com",
    "contact_phone": "+1-555-0200",
    "notes": null,
    "created_at": "2024-01-10T09:00:00Z",
    "updated_at": "2024-01-10T09:00:00Z"
  }
}

Customer Contacts

Manage contact people associated with customers.

Create Contact

Example Response

{
  "data": {
    "id": 1,
    "name": "Sarah Johnson",
    "email": "sarah@example.com",
    "phone": "+1-555-0300",
    "role": "Buyer",
    "is_primary": true,
    "notes": null,
    "created_at": "2024-01-10T09:00:00Z",
    "updated_at": "2024-01-10T09:00:00Z"
  }
}

Customer Portal & Access

Customer actions, customer portal invitations and per-style access control for portal users.

Customer Actions

Portal Access

Style Access

Customer File Sections

The collapsible sections that group uploads on a customer. Files are managed through the Files endpoints using ?customer_id=. Deleting a section never deletes its files — they are simply unfiled.

Colors

Manage the color library used across styles and products.

List Colors

Create Color

Example Response

{
  "data": [
    {
      "id": 1,
      "colour_name": "Midnight Blue",
      "hex": "#191970",
      "pantone_ref": "19-3933 TCX",
      "starred": false,
      "group": {
        "id": 2,
        "name": "Blues"
      },
      "created_at": "2024-01-10T09:00:00Z",
      "updated_at": "2024-01-10T09:00:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 48
  }
}

Seasons

Seasons organise styles and collections. Writes use the same rules as the app (for example a season still in use cannot be deleted) and need seasons:write.

List Seasons

Example Response

{
  "data": [
    {
      "id": 1,
      "season_name": "Spring/Summer 2025",
      "created_at": "2024-01-05T08:00:00Z",
      "updated_at": "2024-01-05T08:00:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 12
  }
}

Drops (Season Deliveries)

A drop is a dated delivery window within a season. Styles point at one with season_delivery_id and critical-path dates can follow each drop’s launch. Read with seasons:read, write with seasons:write.

List Drops

Exchange Rates

Dated sales exchange rates used to convert prices and orders between currencies. Needs exchange_rates:read / exchange_rates:write.

Create Exchange Rate

List filters

Files

Upload and manage files attached to records across the system — styles, components, purchase orders, sales orders, customers, suppliers, notes, sample review issues and QC inspections. Requires the files:read / files:write scopes.

List Files

Upload a File

Send a multipart/form-data request with the binary in thefile field plus exactly one subject foreign key (style_id, component_id,purchase_order_id, sales_order_id,customer_id, supplier_id,note_id or sample_review_issue_id).variant_id may only accompany style_id(variant imagery), and section_id may only accompanystyle_id.

Example Request

curl -X POST "https://api.kobolabs.io/api/v1/files" \
  -H "X-API-Key: your_api_key" \
  -F "file=@techpack-sketch.png" \
  -F "style_id=123" \
  -F "is_primary=true"

Download URL Response

{
  "success": true,
  "data": {
    "url": "https://storage.googleapis.com/.../techpack-sketch.png",
    "file_name": "techpack-sketch.png",
    "mime_type": "image/png",
    "size": 245120
  }
}

Bill of Materials (BOM)

The BOM represents the list of components and materials used to manufacture a style.

List BOM Items

Add BOM Item Example

{
  "component_id": 123,
  "quantity": 1.5,
  "unit": "meter",
  "placement": "Body",
  "notes": "Main fabric"
}

Points of Measure (POM)

Points of Measure define the measurement specifications for a style.

List POM Items

Add POM Item Example

{
  "name": "Chest Width",
  "code": "A",
  "tolerance_plus": 0.5,
  "tolerance_minus": 0.5,
  "measurements": {
    "S": 48,
    "M": 51,
    "L": 54,
    "XL": 57
  }
}

Colorway Propagation

Copy data between a style's colorway peers. The same three-endpoint pattern is available for BOM, POM, quality control and sample review issues:colorway-import lists the items available to import from peers,import-from-colorway imports selected items from a peer colorway, and apply-to-colorways pushes items out to all colorway peers.

BOM

POM

Quality Control

Sample Review Issues

Variants & SKUs

Manage style variants (color/size combinations), SKUs, and colorways.

Variants

SKUs

Colorways

Create Variant Example

{
  "color_id": 5,
  "size_range_id": 2,
  "is_active": true
}

Barcodes

Manage the barcode inventory pool and assign barcodes to SKUs. Supported barcode types:upc, ean,code39, code128.

Assign Barcodes to SKUs

Validate Barcode

Library Constructions

Manage reusable construction specifications and techniques stored in the product library.

List Constructions

Create Construction Example

{
  "name": "Flat Felled Seam",
  "description": "A strong, flat seam commonly used in denim and workwear",
  "category": "seams",
  "notes": "Requires double-needle sewing machine"
}

Sales Orders

Status Values

draft, pending,confirmed, processing,shipped, delivered,cancelled

Update Status Example

{
  "status": "confirmed",
  "notes": "Order confirmed by warehouse"
}

Invoices

Create and manage invoices linked to sales orders.

Partial (line-by-line) invoicing

Pass lines to POST /invoices to bill exactly the quantities you name. When lines is present invoice_type is ignored and a draft invoice is created for just those lines. Read invoiceable-lines first to see what each line may still take.

{
  "sales_order_id": 981,
  "lines": [
    { "sales_order_style_id": 5521, "sizes": { "S": 2, "M": 3 } },
    { "sales_order_style_id": 5522, "quantity": 10 }
  ]
}

List Invoices

Create Invoice Example

{
  "sales_order_id": 123,
  "invoice_number": "INV-2024-0001",
  "due_date": "2024-02-15",
  "notes": "Net 30 payment terms",
  "line_items": [
    {
      "description": "Classic Cotton Tee - White - M",
      "quantity": 50,
      "unit_price": 45.00
    }
  ]
}

Credit Notes

Manage credit notes for returns, adjustments, and refunds.

List Credit Notes

Create Credit Note Example

{
  "sales_order_id": 123,
  "reason": "Damaged goods returned",
  "amount": 225.00,
  "notes": "5 units returned in defective condition"
}

Sales Order Payments

Track payments received against sales orders.

List Payments

Record Payment Example

{
  "sales_order_id": 123,
  "amount": 2250.00,
  "payment_method": "bank_transfer",
  "payment_date": "2024-01-20",
  "reference": "TT-SO-2024-001"
}

Pick Tickets

Manage warehouse pick tickets for fulfilling sales orders.

Perform Pick

List Pick Tickets

Delivery Notes

Manage delivery notes linked to sales orders. Supports soft delete.

List Delivery Notes

Create Delivery Note

Example Response

{
  "data": {
    "id": 1,
    "sales_order": {
      "id": 10,
      "order_number": "SO-2024-010"
    },
    "items": [
      {
        "id": 1,
        "sku": "SS24-001-WHT-M",
        "quantity": 50
      }
    ],
    "delivery_date": "2024-03-15",
    "status": "pending",
    "notes": null,
    "tracking_number": "1Z999AA10123456784",
    "carrier": "UPS",
    "created_at": "2024-03-10T09:00:00Z",
    "updated_at": "2024-03-10T09:00:00Z"
  }
}

Packing Lists

Manage packing lists for transferring goods between locations.

List Packing Lists

Create Packing List

Example Response

{
  "data": {
    "id": 1,
    "from_location": {
      "id": 1,
      "name": "Main Warehouse"
    },
    "to_location": {
      "id": 2,
      "name": "Retail Store NYC"
    },
    "items": [
      {
        "id": 1,
        "sku": "SS24-001-WHT-M",
        "quantity": 25
      }
    ],
    "status": "packed",
    "notes": null,
    "packed_date": "2024-03-12",
    "created_at": "2024-03-10T09:00:00Z",
    "updated_at": "2024-03-12T14:00:00Z"
  }
}

Sales Shipments

Track outbound shipments for sales orders.

List Shipments

Update Status Example

{
  "status": "in_transit",
  "tracking_number": "1Z999AA10123456784",
  "carrier": "UPS"
}

Order Confirmations

Manage order confirmation documents for sales orders.

List Order Confirmations

Deliveries

Inbound deliveries against purchase orders. Receiving a delivery is a real check-in: stock moves into the location exactly as it does in the app.

List Deliveries

Receive a Delivery

Omit items to receive everything still outstanding on the delivery. Deliveries now include parcel_shipment_id (the ASN link), cartons, internal notes and per-item purchase_order_item_id.

{
  "location_id": 3,
  "items": [
    { "style_id": 120, "size": "M", "quantity": 48, "purchase_order_item_id": 301 },
    { "style_id": 120, "size": "L", "quantity": 36, "purchase_order_item_id": 301 }
  ],
  "received_notes": "Two cartons damaged on arrival"
}

PO Workflows

The purchase-order workflows the app runs beyond plain CRUD, each through the same service. Reads need purchase-orders:read, writes purchase-orders:write.

{checkInId} is the check-in reference string (for example CI-000123), not a numeric id.

Short-split

Destination split / preview

Supplier confirmation

Documents (PDF & Send)

Download the same PDFs the app produces, and email them through a guarded send. Downloads return application/pdf and need the document’s :read scope; sends need its :write scope.

Send body

curl "https://api.kobolabs.io/api/v1/styles/123/bom/download-pdf" \
  -H "X-API-Key: your_api_key" \
  -o bom.pdf

curl -X POST "https://api.kobolabs.io/api/v1/purchase-orders/88/send" \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"recipients": ["orders@yoursupplier.com"], "message": "PO attached, please confirm the ship date."}' 

Inbound Shipments (ASN)

Inbound shipments (advance shipping notices) carry purchase orders from a supplier, with deliveries, cartons and tracking. Read with shipments:read, write with shipments:write.

List Shipments

Attach Purchase Orders

Carrier Accounts

Read-only list of the company’s carrier accounts. Credentials are never returned. Needs shipments:read.

Shipping Rules

Rules that pick carriers and services for shipments. Read with shipments:read, write with shipments:write.

Goods Receipts

Record goods received against purchase orders and deliveries.

List Goods Receipts

Create Goods Receipt Example

{
  "order": "PO-2024-0001",
  "delivery_name": "DEL-001",
  "warehouse": "Main Warehouse",
  "supplier_id": 1,
  "date_received": "2024-02-15",
  "pcs_received": 500,
  "quantities": {"S": 100, "M": 150, "L": 150, "XL": 100}
}

Cutting Tickets

An instruction to cut part or all of a confirmed production purchase order. Tickets never change PO quantities, stock or money. Issued tickets show in the supplier portal, where the factory records the actual cut.

Cancellations

Manage purchase order cancellation requests with approval workflows.

Status Values

draft, pending,approved, rejected

List Cancellations

Returns

Manage purchase order returns for defective or incorrect goods.

Status Values

draft, confirmed,processing, completed

List Returns

Payments

Track payments against purchase orders.

List Payments

Create Payment Example

{
  "purchase_order_id": 123,
  "amount": 5000.00,
  "currency": "USD",
  "payment_method": "bank_transfer",
  "payment_date": "2024-01-15",
  "reference": "TT-2024-001",
  "notes": "First payment - 30% deposit"
}

Budgets

Create and manage budgets for purchasing, production, and development spend tracking.

List Budgets

Create Budget Example

{
  "name": "SS25 Sourcing Budget",
  "amount": 50000.00,
  "currency": "USD",
  "period_start": "2025-01-01",
  "period_end": "2025-06-30",
  "notes": "Spring/Summer 2025 component and fabric sourcing"
}

Component Inventory

Track inventory levels for components and materials.

List Component Inventory

Check In Example

{
  "quantity": 500,
  "reference": "PO-2024-0015",
  "notes": "Received from supplier shipment"
}

Style Inventory

Track finished goods inventory by style, size, and color.

List Style Inventory

Transfer Example

{
  "to_location_id": 2,
  "quantity": 50,
  "notes": "Transfer to retail warehouse"
}

Inventory Operations

Advanced inventory management operations including transfers, reservations, and check-ins.

Low Stock Query

Transfer Inventory Example

{
  "to_location_id": 2,
  "quantity": 50,
  "notes": "Transfer to retail warehouse"
}

Reserve Inventory Example

{
  "quantity": 100,
  "reference_type": "sales_order",
  "reference_id": 456,
  "notes": "Reserved for SO-2024-0050"
}

Stock Takes

Manage physical inventory counts and reconciliation.

Status Values

draft, in_progress,completed, cancelled

List Stock Takes

Add Stock Take Item Example

{
  "inventory_id": 123,
  "counted_quantity": 95,
  "notes": "5 units damaged"
}

Locations

Manage warehouse and storage locations used for inventory tracking and stock takes.

List Locations

Create Location Example

{
  "name": "Warehouse A - Shelf 3B",
  "code": "WH-A-3B",
  "description": "Main warehouse, aisle 3, shelf B",
  "is_active": true
}

Component Reservations

Manage reservations of component inventory for production orders and style development.

List Reservations

Create Reservation Example

{
  "component_id": 45,
  "quantity": 500,
  "reserved_for": "production_order",
  "reference_id": 123,
  "expires_at": "2025-03-31T00:00:00Z",
  "notes": "Reserved for SS25 production run"
}

Range Plans

Plan and manage seasonal ranges before converting to full styles.

Range plans now return their financial settings (margin_basis, vat_rate, market_id, currency, channel_mix_wholesale_pct, margin_floor_pct, target_margin_pct, model_budget), and each card its cost_price, wholesale_price, rrp, season_delivery_id, newness and ranging fields.

List Range Plans

Create Range Plan Example

{
  "name": "SS25 Core Range",
  "season_id": 5,
  "category_id": 1,
  "target_price": 45.00,
  "target_margin": 60,
  "notes": "Core basics collection for Spring/Summer 2025"
}

Quotations

Create and manage supplier quotations for production costing.

Status Decision

List Quotations

Create Quotation Example

{
  "supplier_id": 1,
  "style_id": 123,
  "unit_price": 22.50,
  "currency": "USD",
  "moq": 500,
  "lead_time_days": 30,
  "valid_until": "2024-03-01",
  "notes": "Price includes packaging"
}

Quote Comparison & Award

Compare every supplier quote on a style with weighted price, quality and delivery scores, then place (award) the style. Read with quotations:read, write with quotations:write.

Award Example

{
  "allocations": [
    { "quotation_id": 77 }
  ]
}

Linesheets

Create and manage linesheets for wholesale buyers and showrooms.

List Linesheets

Share a Linesheet

Download the PDF

curl -X POST "https://api.kobolabs.io/api/v1/linesheets/18/generate" \
  -H "X-API-Key: your_api_key" \
  -o linesheet.pdf

Linesheets now also return their ordering rules: minimum order, ship window, price visibility and stock settings.

Sample Requests

Request samples from a supplier for a style, then record what arrives, the verdict and what happens to the sample. Needs sample_requests:read / sample_requests:write. Writes respect the style lock.

List Sample Requests

Create Sample Request Example

{
  "style_id": 123,
  "supplier_id": 8,
  "sample_stage_id": 2,
  "due_at": "2026-11-20",
  "items": [
    { "variant_id": 451, "size": "M", "quantity_ordered": 2 }
  ]
}

Sample Reviews

Track and manage sample review workflows during product development.

List Sample Reviews

In agency workspaces each review also returns client_approval: the client's latest decision from the client portal ({ id, status, comment, created_at }, statusapproved or changes_requested), or null if the client hasn't responded.

Change Status Example

{
  "status": "approved",
  "comments": "Sample meets all specifications. Ready for production."
}

Quality Control

Access QC inspection reports for styles and production runs.

Inspection Categories

Each QC inspection covers these categories:fabric_inspection, dimensional_stability,garment_measurements, garment_construction,labeling_packaging, overall_appearance,compliance_safety, random_sampling

Example Response

{
  "data": {
    "id": 1,
    "style": {"id": 123, "name": "Classic Cotton Tee"},
    "inspector_name": "Jane Smith",
    "inspection_date": "2024-02-10",
    "fabric_inspection": {"status": "pass", "notes": "Fabric weight within tolerance"},
    "garment_measurements": {"status": "fail", "notes": "Chest width 1cm over tolerance"},
    "overall_result": "conditional_pass"
  }
}

Lab Tests

Lab testing against a style, a material, or both — colourfastness, shrinkage, chemical, flammability and more — with the lab, the standard, the report reference, dates and a status. Filter by style, component, supplier, type, status, or the outstanding and failing shortcuts. Note that expiry_date means “retest due by” rather than “this result stops being true”, and is null for most tests.

Tech Packs

Generate comprehensive tech pack documents for styles, including BOM, POM, construction details, and specifications.

Tech Pack Contents

The generated tech pack includes style details, bill of materials, points of measure, colorways, construction notes, and supplier information — all consolidated into a single response.

Labdips

Manage lab dip requests and submissions for color matching with suppliers.

List Labdips

Create Labdip

Example Response

{
  "data": {
    "id": 1,
    "name": "Navy Cotton Labdip",
    "supplier": {
      "id": 5,
      "name": "Premium Textiles Ltd"
    },
    "status": "pending",
    "target_colour": "Pantone 19-3933 TCX",
    "notes": "Match to Spring collection navy",
    "created_at": "2024-02-01T10:00:00Z",
    "updated_at": "2024-02-01T10:00:00Z"
  }
}

Labdip Swatches & Images

A labdip request carries swatches (options) from the dye house. Decide each swatch, pin an approved one to colourways as the standard, or reject the round and re-request. Status changes go through the same service as the app. Read with labdips:read, write with labdips:write.

Decide a Swatch

Moodboards

Create and manage visual moodboards for design inspiration and collection planning.

List Moodboards

Create Moodboard

Example Response

{
  "data": {
    "id": 1,
    "name": "SS25 Color Palette",
    "description": "Spring/Summer 2025 color inspiration",
    "canvas_data": {},
    "thumbnail": "https://storage.googleapis.com/kobo-system-files/moodboards/1/thumb.jpg",
    "created_at": "2024-02-05T11:00:00Z",
    "updated_at": "2024-02-05T11:00:00Z"
  }
}

Component Sourcing

Manage sourcing requests for components, including supplier submissions and pricing.

Submissions & Response Cycle

List Sourcing Requests

Create Sourcing Request