# API reference

Every resource of the 3DAPI API, one page each: the object, then every endpoint that works with it. Designers and integrators use API v2 (`https://public-api.dapi.digital/v2/...`, version 2.0.0); print farms use the print farm API (`/v1/print-farm/...`, version 1.0.0).

Machine-readable: [OpenAPI 3.1 for v2](https://public-api.dapi.digital/docs/openapi.json), [OpenAPI 3.0 for the print farm API](https://public-api.dapi.digital/docs/print-farm.openapi.json).

## Production

- [Orders](https://public-api.dapi.digital/docs/reference/print-farm-orders.md): Orders allocated to your farm, and moving them through their production statuses. For print farms. Operations: `listPrintFarmOrders`, `getPrintFarmOrder`, `updatePrintFarmOrderStatus`.
- [SKUs](https://public-api.dapi.digital/docs/reference/print-farm-skus.md): Products in your allocated orders or in stocks you hold, with their designs, extras and stock. For print farms. Operations: `listPrintFarmSkus`, `getPrintFarmSku`.
- [Designs](https://public-api.dapi.digital/docs/reference/print-farm-designs.md): Approved print files your SKUs use, with short-lived download links. For print farms. Operations: `listPrintFarmDesigns`, `getPrintFarmDesign`.
- [Extras](https://public-api.dapi.digital/docs/reference/print-farm-extras.md): Approved bought-in parts that your SKUs ship with. For print farms. Operations: `listPrintFarmExtras`, `getPrintFarmExtra`.
- [Materials](https://public-api.dapi.digital/docs/reference/print-farm-materials.md): Materials your SKUs' designs are printed in. For print farms. Operations: `listPrintFarmMaterials`, `getPrintFarmMaterial`.
- [Stock levels](https://public-api.dapi.digital/docs/reference/print-farm-stock-levels.md): Stock batches ordered from your farm, and reporting the units you have printed. For print farms. Operations: `listPrintFarmStockLevels`, `getPrintFarmStockLevel`, `addPrintFarmStockLevelItemsMade`.
- [Stocks](https://public-api.dapi.digital/docs/reference/print-farm-stocks.md): Ready-made stock products with at least one batch at your farm. For print farms. Operations: `listPrintFarmStocks`, `getPrintFarmStock`.
- [Courier options](https://public-api.dapi.digital/docs/reference/print-farm-courier-options.md): Couriers you can name when you mark an order as shipping. For print farms. Operations: `listPrintFarmCourierOptions`.

## Catalog

- [Products](https://public-api.dapi.digital/docs/reference/products.md): What you sell and its variants. For designers. Operations: `list_products`, `create_product`, `get_product`, `update_product`, `delete_product`, `publish_product`, `unpublish_product`, `create_variant`, `update_variant`, `delete_variant`, `upload_compliance_document`, `delete_compliance_document`, `get_product_compliance`.
- [Designs](https://public-api.dapi.digital/docs/reference/designs.md): Printable model files. For designers. Operations: `add_design`, `get_design`, `update_design`, `delete_design`.
- [Attachments](https://public-api.dapi.digital/docs/reference/attachments.md): Production documents. For designers. Operations: `get_attachment`.
- [Uploads](https://public-api.dapi.digital/docs/reference/uploads.md): Sending files: photos, design files and documents. For designers and integrators. Operations: `create_upload`.
- [Materials](https://public-api.dapi.digital/docs/reference/materials.md): The material catalog. For designers and integrators. Operations: `list_materials`, `get_material`.
- [Categories](https://public-api.dapi.digital/docs/reference/categories.md): Product categories and their safety requirements. For designers and integrators. Operations: `list_categories`, `get_category`.

## Stock

- [Stocks](https://public-api.dapi.digital/docs/reference/stocks.md): Ready-made units bought in batches. For designers. Operations: `list_stocks`, `create_stock`, `get_stock`, `update_stock`, `add_stock_design`, `set_stock_restock`, `list_all_stock_batches`, `list_stock_batch_usage`, `list_stock_batches`, `get_stock_batch`, `create_stock_purchase`, `get_region`.
- [Extras](https://public-api.dapi.digital/docs/reference/extras.md): Bought-in parts shipped with products (designers) or with order lines (integrators). For designers and integrators. Operations: `list_extras`, `create_extra`, `get_extra`, `update_extra`.

## Orders

- [Orders](https://public-api.dapi.digital/docs/reference/orders.md): Orders for your products, from every channel. For designers. Operations: `list_orders`, `create_order`, `cancel_order`, `get_order`, `list_import_issues`, `get_import_issue`.
- [Quality control](https://public-api.dapi.digital/docs/reference/quality-control.md): Quality checks, partner questions and issue reports on orders. For designers. Operations: `review_qc_ticket`, `send_qc_message`, `list_qc_tickets`, `create_qc_ticket`, `get_qc_ticket`.

## Money

- [Wallet](https://public-api.dapi.digital/docs/reference/wallet.md): Your balance and money history. For designers and integrators. Operations: `get_wallet`, `get_billing_details`, `save_billing_details`, `list_cards`, `start_card_setup`, `complete_card_setup`, `make_card_default`, `remove_card`, `start_top_up`, `get_wallet_settings`, `update_wallet_settings`, `list_withdrawals`, `create_withdrawal`, `get_withdrawal_eligibility`, `cancel_withdrawal`, `get_payout_details`, `save_payout_details`, `list_transactions`, `get_transaction_summary`.
- [Shipping](https://public-api.dapi.digital/docs/reference/shipping.md): Shipping zones and prices. For designers and integrators. Operations: `get_shipping_rates`, `get_shipping_quote`.

## Platform

- [Integrator orders](https://public-api.dapi.digital/docs/reference/integrator-orders.md): Orders integrators place for their own customers, paid from the wallet or through a hosted checkout. For integrators. Operations: `list_integrator_orders`, `create_integrator_order`, `estimate_integrator_order_shipping`, `get_integrator_order`, `cancel_integrator_order`.
- [Webhooks](https://public-api.dapi.digital/docs/reference/webhooks.md): Events sent to your endpoints, and the events log. For designers and integrators. Operations: `list_events`, `get_event`, `create_webhook_endpoint`, `update_webhook_endpoint`, `delete_webhook_endpoint`, `rotate_webhook_endpoint_secret`, `send_test_webhook_event`, `list_webhook_endpoint_deliveries`, `get_event_deliveries`, `resend_event`, `list_webhook_endpoints`.
- [Quotes](https://public-api.dapi.digital/docs/reference/quotes.md): Prices for printing model files. For integrators. Operations: `list_quotes`, `create_quote`, `get_quote`.
- [Integrator onboarding](https://public-api.dapi.digital/docs/reference/integrator-onboarding.md): Signing up as an integrator and getting the account approved. For integrators. Operations: `create_integrator_account`, `resend_integrator_confirmation`, `get_integrator_onboarding`, `list_approval_requests`, `create_approval_request`, `get_approval_request`.
- [Integrator account](https://public-api.dapi.digital/docs/reference/integrator-account.md): Your integrator account: names, sign-in email and password, and your EU responsible person. For integrators. Operations: `get_integrator_account`, `update_integrator_account`, `change_integrator_password`, `request_integrator_email_change`, `get_eu_responsible_person`, `set_eu_responsible_person`, `remove_eu_responsible_person`.
- [Analytics](https://public-api.dapi.digital/docs/reference/analytics.md): Figures about your account over time: quote volume, value and reviews. For integrators. Operations: `get_integrator_analytics`.
- [Logs](https://public-api.dapi.digital/docs/reference/logs.md): The requests you made in the last 30 days, with bodies and the webhooks they caused. For integrators. Operations: `list_api_requests`, `get_api_request`.
- [API keys](https://public-api.dapi.digital/docs/reference/api-keys.md): Keys for calling the API from your servers. For integrators. Operations: `list_api_keys`, `create_api_key`, `revoke_api_key`.
- [Identity](https://public-api.dapi.digital/docs/reference/identity.md): Who the credentials belong to. For designers and integrators. Operations: `get_me`.
- [Health](https://public-api.dapi.digital/docs/reference/health.md): Service status. For designers and integrators. Operations: `get_health`.

## Webhook events

- [order.created](https://public-api.dapi.digital/docs/reference/events/order.created.md): Order created
- [order.paid](https://public-api.dapi.digital/docs/reference/events/order.paid.md): Order paid
- [order.assigned](https://public-api.dapi.digital/docs/reference/events/order.assigned.md): Order assigned
- [order.in_production](https://public-api.dapi.digital/docs/reference/events/order.in_production.md): Order in production
- [order.shipped](https://public-api.dapi.digital/docs/reference/events/order.shipped.md): Order shipped
- [order.completed](https://public-api.dapi.digital/docs/reference/events/order.completed.md): Order completed
- [order.on_hold](https://public-api.dapi.digital/docs/reference/events/order.on_hold.md): Order on hold
- [order.rejected](https://public-api.dapi.digital/docs/reference/events/order.rejected.md): Order rejected
- [order.returned](https://public-api.dapi.digital/docs/reference/events/order.returned.md): Order returned
- [order.cancelled](https://public-api.dapi.digital/docs/reference/events/order.cancelled.md): Order cancelled
- [checkout.expired](https://public-api.dapi.digital/docs/reference/events/checkout.expired.md): Checkout link expired
- [qc_ticket.needs_your_action](https://public-api.dapi.digital/docs/reference/events/qc_ticket.needs_your_action.md): QC ticket needs your action
- [qc_ticket.resolved](https://public-api.dapi.digital/docs/reference/events/qc_ticket.resolved.md): QC ticket resolved
- [product.approved](https://public-api.dapi.digital/docs/reference/events/product.approved.md): Product approved
- [product.rejected](https://public-api.dapi.digital/docs/reference/events/product.rejected.md): Product rejected
- [stock_batch.purchased](https://public-api.dapi.digital/docs/reference/events/stock_batch.purchased.md): Stock batch purchased
- [stock_batch.completed](https://public-api.dapi.digital/docs/reference/events/stock_batch.completed.md): Stock batch completed
- [stock.low](https://public-api.dapi.digital/docs/reference/events/stock.low.md): Stock running low
- [quote.ready](https://public-api.dapi.digital/docs/reference/events/quote.ready.md): Quote ready
- [quote.failed](https://public-api.dapi.digital/docs/reference/events/quote.failed.md): Quote failed
- [quote.approved](https://public-api.dapi.digital/docs/reference/events/quote.approved.md): Quote approved
- [quote.rejected](https://public-api.dapi.digital/docs/reference/events/quote.rejected.md): Quote rejected
- [approval_request.approved](https://public-api.dapi.digital/docs/reference/events/approval_request.approved.md): Account approved
- [approval_request.changes_requested](https://public-api.dapi.digital/docs/reference/events/approval_request.changes_requested.md): Changes requested

---

3DAPI API Docs. This page on the web: https://public-api.dapi.digital/docs/reference. Index of every page: https://public-api.dapi.digital/docs/llms.txt.
