Kobo PLM API Documentation

The Kobo 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

https://api.kobolabs.io/api/v1

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.

bash

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

Getting an API Key

Log in to Kobo PLM
Go to Account Settings → API Keys
Click Create API Key
Select the scopes (permissions) you need
Copy and securely store your key - it won't be shown again

API Key Scopes

Scope	Description
`*`	Full access to all resources
`styles:read`	Read styles/products
`styles:write`	Create, update, delete styles
`components:read`	Read components/materials
`components:write`	Create, update, delete components
`suppliers:read`	Read suppliers
`suppliers:write`	Create, update, delete suppliers
`purchase_orders:read`	Read purchase orders
`purchase_orders:write`	Create, update, delete purchase orders
`inventory:read`	Read inventory levels
`inventory:write`	Update inventory
`customers:read`	Read customers
`customers:write`	Create, update, delete customers
`sales_orders:read`	Read sales orders
`sales_orders:write`	Create, update, delete sales orders
`deliveries:read`	Read deliveries
`bom:read`	Read bill of materials
`bom:write`	Manage bill of materials
`pom:read`	Read points of measure
`pom:write`	Manage points of measure
`tasks:read`	Read tasks
`tasks:write`	Create, update, delete tasks
`notes:read`	Read notes
`notes:write`	Create, update, delete notes
`projects:read`	Read projects
`projects:write`	Create, update, delete projects
`cancellations:read`	Read cancellations
`cancellations:write`	Manage cancellations
`returns:read`	Read returns
`returns:write`	Manage returns
`payments:read`	Read payments
`payments:write`	Create, update payments
`invoices:read`	Read invoices
`invoices:write`	Create, update, manage invoices
`credit_notes:read`	Read credit notes
`credit_notes:write`	Create, update, delete credit notes
`sales_order_payments:read`	Read sales order payments
`sales_order_payments:write`	Create, update, delete payments
`pick_tickets:read`	Read pick tickets
`pick_tickets:write`	Create, update, delete pick tickets
`shipments:read`	Read sales shipments
`shipments:write`	Create, update, manage shipments
`order_confirmations:read`	Read order confirmations
`order_confirmations:write`	Create, update, delete confirmations
`goods_receipts:read`	Read goods receipts
`goods_receipts:write`	Create, update, delete goods receipts
`range_plans:read`	Read range plans
`range_plans:write`	Create, update, delete range plans
`quotations:read`	Read quotations
`quotations:write`	Create, update, delete quotations
`linesheets:read`	Read linesheets
`linesheets:write`	Create, update, manage linesheets
`sample_reviews:read`	Read sample reviews
`sample_reviews:write`	Create, update sample reviews
`quality_control:read`	Read QC inspections and reports
`tech_packs:read`	Generate and read tech packs
`stock_takes:read`	Read stock takes
`stock_takes:write`	Manage stock takes
`workflows:read`	Read workflows
`workflows:write`	Manage workflows
`notifications:read`	Read notifications
`notifications:write`	Manage notifications
`webhooks:read`	Read webhook configurations
`webhooks:write`	Manage webhooks
`api_keys:read`	Read API keys
`api_keys:write`	Manage API keys

Rate Limiting

API requests are rate limited based on your subscription tier:

Tier	Requests per Minute
Basic	100
Professional	500
Enterprise	2,000

Rate limit headers are included in every response:

http

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

Rate Limit Exceeded

When rate limited, you'll receive a 429 Too Many Requests response. Implement exponential backoff to handle this gracefully.

Pagination

List endpoints return paginated results. Use these query parameters:

Parameter	Type	Description
`page`	integer	Page number (default: 1)
`per_page`	integer	Items per page (default: 25, max: 100)

Response includes pagination metadata:

json

{
  "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:

Parameter	Type	Description
`updated_since`	datetime	ISO 8601 datetime (e.g., 2024-01-01T00:00:00Z)
`created_since`	datetime	ISO 8601 datetime (e.g., 2024-01-01T00:00:00Z)

bash

# 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"

Error Handling

The API uses standard HTTP status codes:

Code	Description
200	Success
201	Created
204	No Content (successful delete)
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid or missing API key
403	Forbidden - Insufficient permissions
404	Not Found
422	Validation Error
429	Rate Limited
500	Server Error

Error responses include details:

json

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

Styles

Styles represent your products/designs in Kobo PLM.

GET/styles

List all styles with optional filtering and pagination

GET/styles/{id}

Get a specific style by ID

POST/styles

Create a new style

PUT/styles/{id}

Update an existing style

DELETE/styles/{id}

Delete a style

POST/styles/{id}/duplicate

Duplicate a style

POST/styles/{id}/restore

Restore an archived style

GET/styles/export

Export styles as CSV

List Styles

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page (max 100)
`updated_since`	datetime	Filter by update time
`created_since`	datetime	Filter by creation time
`status`	string	Filter by status
`season_id`	integer	Filter by season

Example Request

bash

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

Example Response

json

{
  "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.koboplm.com/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

bash

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.

GET/components

List all components

GET/components/{id}

Get a specific component

POST/components

Create a new component

PUT/components/{id}

Update an existing component

DELETE/components/{id}

Delete a component

POST/components/{id}/duplicate

Duplicate a component

GET/components/export

Export components as CSV

List Components

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`type`	string	Filter by component type
`supplier_id`	integer	Filter by supplier

Example Response

json

{
  "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

GET/suppliers

List all suppliers

GET/suppliers/{id}

Get a specific supplier

POST/suppliers

Create a new supplier

PUT/suppliers/{id}

Update an existing supplier

DELETE/suppliers/{id}

Delete a supplier

GET/suppliers/export

Export suppliers as CSV

List Suppliers

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`country`	string	Filter by country code
`type`	string	Filter by supplier type

Example Response

json

{
  "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"
    }
  ]
}

Purchase Orders

GET/purchase-orders

List all purchase orders

GET/purchase-orders/{id}

Get a specific purchase order

POST/purchase-orders

Create a new purchase order

PUT/purchase-orders/{id}

Update an existing purchase order

DELETE/purchase-orders/{id}

Delete a draft purchase order

GET/purchase-orders/export

Export purchase orders as CSV

Status Values

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

Example Response

json

{
  "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

GET/inventory

List inventory items

GET/inventory/{id}

Get a specific inventory item

PUT/inventory/{id}

Update inventory levels

POST/inventory/bulk-update

Bulk update inventory

List Inventory

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`style_id`	integer	Filter by style
`location_id`	integer	Filter by location
`low_stock`	boolean	Filter low stock items

Bulk Update Example

json

{
  "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

GET/customers

List all customers

GET/customers/{id}

Get a specific customer

POST/customers

Create a new customer

PUT/customers/{id}

Update an existing customer

DELETE/customers/{id}

Delete a customer

GET/customers/export

Export customers as CSV

List Customers

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`type`	string	Filter by type (wholesale, retail)

Bill of Materials (BOM)

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

GET/bom

List all BOM items

GET/bom/{id}

Get a specific BOM item

PUT/bom/{id}

Update a BOM item

DELETE/bom/{id}

Delete a BOM item

GET/styles/{styleId}/bom

Get BOM for a specific style

POST/styles/{styleId}/bom

Add component to style BOM

List BOM Items

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`style_id`	integer	Filter by style ID
`component_id`	integer	Filter by component ID

Add BOM Item Example

json

{
  "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.

GET/pom

List all POM items

GET/pom/{id}

Get a specific POM item

PUT/pom/{id}

Update a POM item

DELETE/pom/{id}

Delete a POM item

GET/styles/{styleId}/pom

Get POM for a specific style

POST/styles/{styleId}/pom

Add POM item to style

List POM Items

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`style_id`	integer	Filter by style ID

Add POM Item Example

json

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

Variants & SKUs

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

Variants

GET/styles/{id}/variants

Get style variants

POST/styles/{id}/variants

Create a style variant

PUT/styles/{id}/variants/{variantId}

Update a variant

DELETE/styles/{id}/variants/{variantId}

Delete a variant

SKUs

GET/styles/{id}/skus

Get style SKUs

POST/styles/{id}/skus

Create a SKU

PUT/styles/{id}/skus/{skuId}

Update a SKU

DELETE/styles/{id}/skus/{skuId}

Delete a SKU

Colorways

GET/styles/{id}/colorways

Get style colorways

Create Variant Example

json

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

Sales Orders

GET/sales-orders

List all sales orders

GET/sales-orders/{id}

Get a specific sales order

POST/sales-orders

Create a new sales order

PUT/sales-orders/{id}

Update an existing sales order

DELETE/sales-orders/{id}

Delete a sales order

POST/sales-orders/{id}/status

Update sales order status

POST/sales-orders/{id}/invoice

Create invoice from sales order

Status Values

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

Update Status Example

json

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

Invoices

Create and manage invoices linked to sales orders.

GET/invoices

List all invoices

GET/invoices/{id}

Get a specific invoice

POST/invoices

Create a new invoice

PUT/invoices/{id}

Update an invoice

POST/invoices/{id}/confirm

Confirm a draft invoice

POST/invoices/{id}/cancel

Cancel an invoice

List Invoices

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`status`	string	Filter by status (draft, confirmed, cancelled)
`sales_order_id`	integer	Filter by sales order
`customer_id`	integer	Filter by customer

Create Invoice Example

json

{
  "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.

GET/credit-notes

List all credit notes

GET/credit-notes/{id}

Get a specific credit note

POST/credit-notes

Create a credit note

PUT/credit-notes/{id}

Update a credit note

DELETE/credit-notes/{id}

Delete a credit note

List Credit Notes

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time

Create Credit Note Example

json

{
  "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.

GET/sales-order-payments

List all sales order payments

GET/sales-order-payments/{id}

Get a specific payment

POST/sales-order-payments

Record a payment

PUT/sales-order-payments/{id}

Update a payment

DELETE/sales-order-payments/{id}

Delete a payment

List Payments

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`sales_order_id`	integer	Filter by sales order

Record Payment Example

json

{
  "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.

GET/pick-tickets

List all pick tickets

GET/pick-tickets/{id}

Get a specific pick ticket

POST/pick-tickets

Create a pick ticket

PUT/pick-tickets/{id}

Update a pick ticket

DELETE/pick-tickets/{id}

Delete a pick ticket

List Pick Tickets

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time

Sales Shipments

Track outbound shipments for sales orders.

GET/sales-shipments

List all shipments

GET/sales-shipments/{id}

Get a specific shipment

POST/sales-shipments

Create a shipment

PUT/sales-shipments/{id}

Update a shipment

DELETE/sales-shipments/{id}

Delete a shipment

POST/sales-shipments/{id}/update-status

Update shipment status

List Shipments

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`status`	string	Filter by status

Update Status Example

json

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

Order Confirmations

Manage order confirmation documents for sales orders.

GET/order-confirmations

List all order confirmations

GET/order-confirmations/{id}

Get a specific confirmation

POST/order-confirmations

Create an order confirmation

PUT/order-confirmations/{id}

Update an order confirmation

DELETE/order-confirmations/{id}

Delete an order confirmation

List Order Confirmations

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time

Deliveries

Deliveries are read-only via the API.

GET/deliveries

List all deliveries

GET/deliveries/{id}

Get a specific delivery

List Deliveries

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`status`	string	Filter by status
`purchase_order_id`	integer	Filter by PO

GET/deliveries/by-delivery-id/{deliveryId}

Get delivery by delivery ID (not internal ID)

Goods Receipts

Record goods received against purchase orders and deliveries.

GET/goods-receipts

List all goods receipts

GET/goods-receipts/{id}

Get a specific goods receipt

POST/goods-receipts

Create a goods receipt

PUT/goods-receipts/{id}

Update a goods receipt

DELETE/goods-receipts/{id}

Delete a goods receipt

List Goods Receipts

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`supplier_id`	integer	Filter by supplier

Create Goods Receipt Example

json

{
  "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}
}

Cancellations

Manage purchase order cancellation requests with approval workflows.

GET/cancellations

List all cancellations

GET/cancellations/{id}

Get a specific cancellation

POST/cancellations

Create a cancellation request

PUT/cancellations/{id}

Update a cancellation

DELETE/cancellations/{id}

Delete a cancellation

POST/cancellations/{id}/approve

Approve a cancellation

POST/cancellations/{id}/reject

Reject a cancellation

Status Values

draft, pending,approved, rejected

List Cancellations

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`status`	string	Filter by status
`purchase_order_id`	integer	Filter by purchase order ID

Returns

Manage purchase order returns for defective or incorrect goods.

GET/returns

List all returns

GET/returns/{id}

Get a specific return

POST/returns

Create a return

PUT/returns/{id}

Update a return

DELETE/returns/{id}

Delete a return

POST/returns/{id}/confirm

Confirm a return

Status Values

draft, confirmed,processing, completed

List Returns

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`status`	string	Filter by status
`purchase_order_id`	integer	Filter by purchase order ID

Payments

Track payments against purchase orders.

GET/payments

List all payments

GET/payments/{id}

Get a specific payment

POST/payments

Create a payment

PUT/payments/{id}

Update a payment

DELETE/payments/{id}

Delete a payment

GET/payments/summary/{poId}

Get payment summary for a PO

List Payments

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`status`	string	Filter by status
`purchase_order_id`	integer	Filter by purchase order ID
`payment_method`	string	Filter by payment method
`date_from`	date	Filter payments from date
`date_to`	date	Filter payments to date

Create Payment Example

json

{
  "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"
}

Component Inventory

Track inventory levels for components and materials.

GET/component-inventory

List component inventory

GET/component-inventory/{id}

Get a specific inventory item

POST/component-inventory

Create a component inventory record

POST/component-inventory/bulk-update

Bulk update component inventory

POST/component-inventory/{id}/check-in

Check in component inventory

List Component Inventory

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`component_id`	integer	Filter by component

Check In Example

json

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

Style Inventory

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

GET/style-inventory

List style inventory

GET/style-inventory/{id}

Get a specific inventory item

PUT/style-inventory/{id}

Update inventory levels

POST/style-inventory/{id}/check-in

Check in style inventory

POST/style-inventory/{id}/transfer

Transfer inventory between locations

List Style Inventory

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`style_id`	integer	Filter by style
`location_id`	integer	Filter by location

Transfer Example

json

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

Inventory Operations

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

GET/inventory/summary

Get inventory summary across all locations

GET/inventory/low-stock

Get items below reorder threshold

GET/inventory/{id}/transactions

Get transaction history for an inventory item

POST/inventory/{id}/transfer

Transfer inventory between locations

POST/inventory/{id}/reserve

Reserve inventory for an order

POST/inventory/{id}/unreserve

Release reserved inventory

POST/inventory/{id}/check-in

Check in inventory from a delivery

Low Stock Query

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`threshold`	integer	Low stock threshold (default: 10)

Transfer Inventory Example

json

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

Reserve Inventory Example

json

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

Stock Takes

Manage physical inventory counts and reconciliation.

GET/stock-takes

List all stock takes

GET/stock-takes/{id}

Get a specific stock take

POST/stock-takes

Create a stock take

PUT/stock-takes/{id}

Update a stock take

DELETE/stock-takes/{id}

Delete a stock take

GET/stock-takes/statuses

Get available stock take statuses

POST/stock-takes/{id}/start

Start a stock take

POST/stock-takes/{id}/complete

Complete a stock take

POST/stock-takes/{id}/finalize

Finalize and apply stock take adjustments

GET/stock-takes/{id}/items

Get stock take items

POST/stock-takes/{id}/items

Add item to stock take

Status Values

draft, in_progress,completed, cancelled

List Stock Takes

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`status`	string	Filter by status
`location_id`	integer	Filter by location ID

Add Stock Take Item Example

json

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

Range Plans

Plan and manage seasonal ranges before converting to full styles.

GET/range-plans

List all range plans

GET/range-plans/{id}

Get a specific range plan

POST/range-plans

Create a range plan

PUT/range-plans/{id}

Update a range plan

DELETE/range-plans/{id}

Delete a range plan

POST/range-plans/{id}/duplicate

Duplicate a range plan

POST/range-plans/{id}/styles/{styleId}/convert

Convert range plan item to a full style

List Range Plans

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`season_id`	integer	Filter by season

Create Range Plan Example

json

{
  "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.

GET/quotations

List all quotations

GET/quotations/{id}

Get a specific quotation

POST/quotations

Create a quotation

PUT/quotations/{id}

Update a quotation

DELETE/quotations/{id}

Delete a quotation

POST/quotations/{id}/revise

Create a revision of a quotation

List Quotations

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`supplier_id`	integer	Filter by supplier
`style_id`	integer	Filter by style

Create Quotation Example

json

{
  "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"
}

Linesheets

Create and manage linesheets for wholesale buyers and showrooms.

GET/linesheets

List all linesheets

GET/linesheets/{id}

Get a specific linesheet

POST/linesheets

Create a linesheet

PUT/linesheets/{id}

Update a linesheet

DELETE/linesheets/{id}

Delete a linesheet

POST/linesheets/{id}/duplicate

Duplicate a linesheet

POST/linesheets/{id}/archive

Archive a linesheet

POST/linesheets/{id}/restore

Restore an archived linesheet

POST/linesheets/{id}/share

Generate a shareable link

List Linesheets

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`season_id`	integer	Filter by season

Sample Reviews

Track and manage sample review workflows during product development.

GET/sample-reviews

List all sample reviews

GET/sample-reviews/{id}

Get a specific sample review

POST/sample-reviews

Create a sample review

PUT/sample-reviews/{id}

Update a sample review

DELETE/sample-reviews/{id}

Delete a sample review

POST/sample-reviews/{id}/change-status

Change review status (approved, rejected, revision needed)

List Sample Reviews

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`style_id`	integer	Filter by style
`status`	string	Filter by status

Change Status Example

json

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

Quality Control

Access QC inspection reports for styles and production runs.

GET/quality-control/{id}

Get a QC inspection

GET/quality-control/{id}/report

Generate a QC inspection report

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

json

{
  "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"
  }
}

Tech Packs

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

GET/tech-packs/styles/{styleId}

Generate a tech pack for a style

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.

Tasks

Manage tasks and to-dos for team collaboration.

GET/tasks

List all tasks

GET/tasks/{id}

Get a specific task

POST/tasks

Create a task

PUT/tasks/{id}

Update a task

DELETE/tasks/{id}

Delete a task

POST/tasks/{id}/complete

Mark task as completed

PATCH/tasks/bulk

Bulk update multiple tasks

DELETE/tasks/bulk

Bulk delete multiple tasks

List Tasks

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`status`	string	Filter by status (pending, in_progress, completed, cancelled)
`priority`	string	Filter by priority (low, medium, high, urgent)
`assignee_id`	integer	Filter by assignee user ID
`due_before`	date	Filter tasks due before date
`due_after`	date	Filter tasks due after date

Create Task Example

json

{
  "title": "Review fabric samples",
  "description": "Check quality of cotton jersey samples from new supplier",
  "priority": "high",
  "due_date": "2024-01-20",
  "assignee_id": 5,
  "related_type": "style",
  "related_id": 123
}

Notes

Add notes and comments to any resource in the system.

GET/notes

List all notes

GET/notes/{id}

Get a specific note

POST/notes

Create a note

PUT/notes/{id}

Update a note

DELETE/notes/{id}

Delete a note

List Notes

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`notable_type`	string	Filter by resource type (style, component, supplier, customer, purchase_order, sales_order)
`notable_id`	integer	Filter by resource ID

Create Note Example

json

{
  "notable_type": "style",
  "notable_id": 123,
  "content": "Customer requested wider fit for this style.",
  "is_internal": false
}

Projects

Organize styles and work into projects for better management.

GET/projects

List all projects

GET/projects/{id}

Get a specific project

POST/projects

Create a project

PUT/projects/{id}

Update a project

DELETE/projects/{id}

Delete a project

List Projects

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`status`	string	Filter by status

Create Project Example

json

{
  "name": "Fall 2024 Collection",
  "description": "Main fall collection development",
  "start_date": "2024-03-01",
  "end_date": "2024-06-30",
  "status": "active"
}

Notifications

Access and manage user notifications.

GET/notifications

List notifications

GET/notifications/{id}

Get a specific notification

DELETE/notifications/{id}

Delete a notification

POST/notifications/{id}/read

Mark notification as read

POST/notifications/mark-all-read

Mark all notifications as read

GET/notifications/unread-count

Get unread notification count

List Notifications

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`is_read`	boolean	Filter by read status
`type`	string	Filter by notification type

Workflows

Automate processes with workflow rules and triggers.

GET/workflows

List all workflows

GET/workflows/{id}

Get a specific workflow

POST/workflows

Create a workflow

PUT/workflows/{id}

Update a workflow

DELETE/workflows/{id}

Delete a workflow

POST/workflows/{id}/execute

Manually execute a workflow

GET/workflows/{id}/executions

Get workflow execution history

GET/workflows/templates

Get available workflow templates

List Workflows

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`updated_since`	datetime	Filter by update time
`is_active`	boolean	Filter by active status
`trigger_type`	string	Filter by trigger type

Execute Workflow Example

json

{
  "context": {
    "style_id": 123,
    "action": "status_change"
  }
}

Supplier Scoring

Access supplier performance scores and metrics.

GET/suppliers/{id}/score

Get supplier overall score

GET/suppliers/{id}/metrics

Get detailed supplier metrics

GET/suppliers/rankings

Get supplier rankings

Supplier Metrics Query

Parameter	Type	Description
`period`	string	Metrics period: 30d, 90d, 1y, all (default: 90d)

Supplier Rankings Query

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Items per page
`sort_by`	string	Sort by: overall_score, quality_score, delivery_score, communication_score
`sort_dir`	string	Sort direction: asc, desc

Example Response

json

{
  "data": {
    "supplier_id": 1,
    "overall_score": 4.2,
    "quality_score": 4.5,
    "delivery_score": 3.8,
    "communication_score": 4.3,
    "total_orders": 45,
    "on_time_delivery_rate": 0.85,
    "defect_rate": 0.02,
    "average_lead_time_days": 21
  }
}

Lookups

Access reference data for use in forms and integrations.

GET/lookups/size-ranges

Get available size ranges

GET/lookups/currencies

Get supported currencies

GET/lookups/component-categories

Get component categories

GET/lookups/units

Get units of measure

Example Response - Currencies

json

{
  "success": true,
  "data": [
    { "code": "USD", "name": "US Dollar", "symbol": "$" },
    { "code": "EUR", "name": "Euro", "symbol": "€" },
    { "code": "GBP", "name": "British Pound", "symbol": "£" },
    { "code": "AUD", "name": "Australian Dollar", "symbol": "A$" }
  ]
}

API Keys

Manage API keys programmatically (requires api_keys:write scope).

GET/api-keys

List all API keys

GET/api-keys/{id}

Get a specific API key

GET/api-keys/{id}/usage

Get API key usage statistics

POST/api-keys/{id}/revoke

Revoke an API key

Security Note

API keys can only be created through the Kobo PLM web interface for security reasons. The API allows listing, viewing usage, and revoking keys only.

Usage Statistics Response

json

{
  "data": {
    "api_key_id": 1,
    "total_requests": 15420,
    "requests_today": 342,
    "requests_this_month": 8750,
    "last_used_at": "2024-01-15T14:30:00Z",
    "rate_limit_hits": 3
  }
}

Webhooks

Webhooks allow you to receive real-time notifications when events occur in Kobo PLM. When you configure a webhook, Kobo PLM will send an HTTP POST request to your specified URL whenever the subscribed events occur.

Available Events

Style Events

Event	Description
`style.created`	A new style was created
`style.updated`	A style was updated
`style.deleted`	A style was deleted
`style.status_changed`	A style's status changed

Component Events

Event	Description
`component.created`	A new component was created
`component.updated`	A component was updated
`component.deleted`	A component was deleted

Supplier Events

Event	Description
`supplier.created`	A new supplier was created
`supplier.updated`	A supplier was updated
`supplier.deleted`	A supplier was deleted

Purchase Order Events

Event	Description
`purchase_order.created`	A new PO was created
`purchase_order.updated`	A PO was updated
`purchase_order.status_changed`	A PO's status changed
`purchase_order.confirmed`	A PO was confirmed
`purchase_order.cancelled`	A PO was cancelled

Inventory Events

Event	Description
`inventory.updated`	Inventory levels changed
`inventory.low_stock`	Inventory fell below reorder point

Customer Events

Event	Description
`customer.created`	A new customer was created
`customer.updated`	A customer was updated
`customer.deleted`	A customer was deleted

Sales Order Events

Event	Description
`sales_order.created`	A new sales order was created
`sales_order.updated`	A sales order was updated
`sales_order.status_changed`	A sales order's status changed

Delivery Events

Event	Description
`delivery.created`	A new delivery was created
`delivery.checked_in`	A delivery was received
`delivery.status_changed`	A delivery's status changed

BOM Events

Event	Description
`bom.created`	A BOM item was added
`bom.updated`	A BOM item was updated
`bom.deleted`	A BOM item was removed

Task Events

Event	Description
`task.created`	A new task was created
`task.updated`	A task was updated
`task.completed`	A task was marked complete
`task.assigned`	A task was assigned

Project Events

Event	Description
`project.created`	A new project was created
`project.updated`	A project was updated
`project.status_changed`	A project's status changed

Payment Events

Event	Description
`payment.created`	A new payment was recorded
`payment.updated`	A payment was updated

Stock Take Events

Event	Description
`stock_take.created`	A stock take was created
`stock_take.started`	A stock take was started
`stock_take.completed`	A stock take was completed
`stock_take.finalized`	A stock take was finalized

Workflow Events

Event	Description
`workflow.executed`	A workflow was executed
`workflow.failed`	A workflow execution failed

Webhook Payload

All webhooks send a JSON payload with the following structure:

json

{
  "event": "style.updated",
  "created_at": "2024-01-15T14:30:00Z",
  "data": {
    "id": 1,
    "type": "Style",
    "attributes": {
      "id": 1,
      "style_code": "SS24-001",
      "name": "Classic Cotton Tee",
      "status": "active"
    }
  },
  "meta": {
    "api_version": "v1",
    "change": {
      "field": "status",
      "previous_value": "development",
      "new_value": "active"
    }
  }
}

Webhook Headers

Header	Description
`Content-Type`	application/json
`User-Agent`	KOBO-PLM-Webhooks/1.0
`X-Webhook-Event`	Event type (e.g., style.updated)
`X-Webhook-Event-Id`	Unique event ID (UUID)
`X-Webhook-Timestamp`	Unix timestamp
`X-Webhook-Signature`	HMAC-SHA256 signature

Signature Verification

To verify that a webhook came from Kobo PLM, validate the signature:

javascript

const crypto = require('crypto');

function verifyWebhookSignature(payload, signature, timestamp, secret) {
  const signedPayload = `${timestamp}.${payload}`;
  const expectedSignature = crypto
    .createHmac('sha256', secret)
    .update(signedPayload)
    .digest('hex');

  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(`sha256=${expectedSignature}`)
  );
}

// In your webhook handler:
app.post('/webhook', (req, res) => {
  const signature = req.headers['x-webhook-signature'];
  const timestamp = req.headers['x-webhook-timestamp'];
  const payload = JSON.stringify(req.body);

  if (!verifyWebhookSignature(payload, signature, timestamp, WEBHOOK_SECRET)) {
    return res.status(401).send('Invalid signature');
  }

  // Process the webhook
  console.log('Received event:', req.body.event);
  res.status(200).send('OK');
});

python

import hmac
import hashlib

def verify_webhook_signature(payload, signature, timestamp, secret):
    signed_payload = f"{timestamp}.{payload}"
    expected_signature = hmac.new(
        secret.encode(),
        signed_payload.encode(),
        hashlib.sha256
    ).hexdigest()

    return hmac.compare_digest(
        signature,
        f"sha256={expected_signature}"
    )

php

function verifyWebhookSignature($payload, $signature, $timestamp, $secret) {
    $signedPayload = "{$timestamp}.{$payload}";
    $expectedSignature = 'sha256=' . hash_hmac('sha256', $signedPayload, $secret);

    return hash_equals($expectedSignature, $signature);
}

Retry Policy

Failed webhook deliveries are automatically retried with exponential backoff:

Attempt	Delay
1	Immediate
2	1 minute
3	5 minutes
4	30 minutes
5	2 hours

Managing Webhooks

GET/webhooks/events

List available webhook events

GET/webhooks

List all webhooks

POST/webhooks

Create a new webhook

GET/webhooks/{id}

Get a specific webhook

PUT/webhooks/{id}

Update a webhook

DELETE/webhooks/{id}

Delete a webhook

POST/webhooks/{id}/rotate-secret

Rotate webhook signing secret

POST/webhooks/{id}/test

Send a test event

POST/webhooks/{id}/reset

Reset webhook failure count

GET/webhooks/{id}/stats

Get webhook delivery statistics

GET/webhooks/{id}/deliveries

Get delivery history

POST/webhooks/{id}/deliveries/{deliveryId}/retry

Retry a failed delivery

Create Webhook

json

{
  "name": "ERP Sync",
  "url": "https://your-system.com/webhooks/kobo",
  "events": ["style.created", "style.updated", "inventory.updated"],
  "is_active": true
}

Best Practices

Incremental Sync

For efficient data synchronization, use the updated_since filter:

bash

# Store the last sync timestamp
LAST_SYNC="2024-01-15T00:00:00Z"

# Fetch only changed records
curl "https://api.kobolabs.io/api/v1/styles?updated_since=$LAST_SYNC" \
  -H "X-API-Key: your_api_key"

Pagination

Always paginate through results to avoid timeouts:

javascript

async function getAllStyles(apiKey) {
  let allStyles = [];
  let page = 1;
  let hasMore = true;

  while (hasMore) {
    const response = await fetch(
      `https://api.kobolabs.io/api/v1/styles?page=${page}&per_page=100`,
      { headers: { 'X-API-Key': apiKey } }
    );
    const data = await response.json();

    allStyles = allStyles.concat(data.data);
    hasMore = page < data.meta.last_page;
    page++;
  }

  return allStyles;
}

Rate Limit Handling

Implement exponential backoff when rate limited:

javascript

async function apiRequest(url, options, retries = 3) {
  for (let i = 0; i < retries; i++) {
    const response = await fetch(url, options);

    if (response.status === 429) {
      const retryAfter = response.headers.get('Retry-After') || 60;
      await sleep(retryAfter * 1000 * Math.pow(2, i));
      continue;
    }

    return response;
  }

  throw new Error('Rate limit exceeded after retries');
}

Idempotency

Use idempotency keys for create operations to prevent duplicates:

bash

curl -X POST "https://api.kobolabs.io/api/v1/purchase-orders" \
  -H "X-API-Key: your_api_key" \
  -H "Idempotency-Key: unique-request-id-12345" \
  -H "Content-Type: application/json" \
  -d '{"supplier_id": 1, ...}'

SDK & Tools

Official Libraries

Coming Soon: JavaScript/TypeScript SDK
Coming Soon: Python SDK
Coming Soon: PHP SDK

OpenAPI Specification

Download our OpenAPI 3.0 specification for use with code generators:

https://api.kobolabs.io/api/v1/openapi.yaml

Postman Collection

Import our Postman collection to quickly test the API:

https://api.kobolabs.io/api/v1/postman-collection.json

Support

Email: api-support@koboplm.com
Documentation: https://docs.koboplm.com
Status Page: https://status.koboplm.com

Last updated: March 2026