REST API v2

API Reference

Read and write your inventory, stock, sales orders, and purchase orders over HTTPS. This page covers the most-used endpoints. The full reference documents every endpoint and field.

Get an API keyFull reference
Base URLhttps://fiddle.io/rest/api/v2Auth headerX-API-Key: YOUR_API_KEY
Redoc referenceSwagger UI

Authentication

Send your API key in the X-API-Key header on every request. Each key acts as the Fiddle user it is assigned to. Do not send API keys as Authorization: Bearer.

Inventory Items

Products, materials, and components, with their stock totals.

Stock and Lots

Stock is held in inventory lots, and each lot records its quantity at one or more locations. Adjust, transfer, receive, and deplete stock through the lot endpoints.

Sales Orders

Customer orders, with their line items, shipping details, and status.

Purchase Orders

Orders to your suppliers, from draft through receiving and close.

All endpoints

Every endpoint the REST API serves. Paths are relative to the base URL. The full reference documents each one's parameters, body, and response.

Users

  • GET/users/me

Inventory items

  • GET/inventory-items
  • GET/inventory-items/{inventoryItemId}
  • GET/inventory-items/sku/{sku}
  • GET/inventory-items/{inventoryItemId}/lots
  • GET/inventory-items/{inventoryItemId}/supplier-pricing
  • POST/inventory-items
  • PUT/inventory-items/{inventoryItemId}
  • POST/inventory-items/{inventoryItemId}/archive
  • POST/inventory-items/{inventoryItemId}/activate
  • POST/inventory-items/{inventoryItemId}/deactivate

Inventory lots

  • GET/inventory-lots
  • GET/inventory-lots/quarantine
  • GET/inventory-lots/{inventoryLotId}
  • PUT/inventory-lots/{inventoryLotId}
  • POST/inventory-lots/receive
  • POST/inventory-lots/adjust
  • POST/inventory-lots/transfer
  • POST/inventory-lots/deplete
  • POST/inventory-lots/{inventoryLotId}/void
  • POST/inventory-lots/{inventoryLotId}/release

Locations and sites

  • GET/inventory-locations
  • GET/inventory-locations/{inventoryLocationId}
  • POST/inventory-locations
  • PUT/inventory-locations/{inventoryLocationId}
  • DELETE/inventory-locations/{inventoryLocationIds}
  • GET/sites
  • GET/sites/{siteId}
  • GET/sites/{siteId}/locations

Sales orders

  • GET/sales-orders
  • GET/sales-orders/{salesOrderId}
  • POST/sales-orders
  • PUT/sales-orders
  • DELETE/sales-orders/{salesOrderIds}
  • GET/sales-order-items
  • GET/sales-order-items/{salesOrderItemId}
  • POST/sales-order-items
  • PUT/sales-order-items
  • POST/sales-order-items/delete

Purchase orders

  • GET/purchase-orders
  • GET/purchase-orders/{purchaseOrderId}
  • POST/purchase-orders
  • PUT/purchase-orders
  • POST/purchase-orders/{purchaseOrderId}/{status}
  • DELETE/purchase-orders/{purchaseOrderIds}

Customers and suppliers

  • GET/customers
  • GET/customers/{customerId}
  • POST/customers
  • PUT/customer/{customerId}
  • DELETE/customers/{customerIds}
  • GET/suppliers
  • GET/suppliers/{supplierId}
  • POST/suppliers
  • PUT/supplier/{supplierId}
  • DELETE/suppliers/{supplierIds}

Supplier pricing

  • GET/supplier-pricing/{supplierPricingId}
  • POST/supplier-pricing
  • PUT/supplier-pricing
  • DELETE/supplier-pricing/{supplierPricingIds}

Quotes and work orders

  • GET/quotes
  • GET/quotes/{quoteId}
  • GET/work-orders
  • GET/work-orders/{workOrderId}

Catalog settings

  • GET/inventory-types
  • GET/inventory-types/{inventoryTypeId}
  • POST/inventory-types
  • PUT/inventory-types
  • DELETE/inventory-types/{inventoryTypeIds}
  • GET/measurement-units
  • GET/measurement-units/{measurementUnitId}
  • GET/service-items
  • GET/service-items/{serviceItemId}
  • POST/service-items
  • PUT/service-items
  • POST/service-items/{serviceItemId}/archive
  • POST/service-items/{serviceItemId}/unarchive

Rate Limits

With API Key

100 requests

per minute, per key

Without API Key

20 requests

per minute, per IP address

Requests over the limit get 429 Too Many Requests. Back off briefly and retry.

Need Help?

The developer guides cover API keys, errors, and ready-to-run recipes. Reach out if you are mapping an integration and want help choosing endpoints.

Contact SupportDeveloper guides