Deprecated

API v1 is deprecated. It keeps working for existing integrations but gets no new features. New integrations should use API v2: start with the v2 quickstart or browse the v2 reference.

Orders

View as Markdown

Orders placed from completed quotes, their shipping costs, and paying for them from the wallet.

The order object

Attributes

  • order_idstring

    Unique identifier for this order.

  • statusstring

    Current lifecycle stage of the order. Progresses from pending → paid → in_production → shipping → completed. May also be rejected or returned.

    Possible valuespendingpaidin_productionshippingcompletedrejectedreturned
  • deliverynumber

    Flat delivery fee in USD, added on top of the item subtotals.

  • order_totalnumber

    Grand total in USD, including all line items and the delivery fee.

  • customervalue

    Recipient contact and shipping address details.

  • itemsarray of V1OrderItemPublicDto

    Line items that make up this order, each derived from a completed quote.

  • tracking_numberobjectOptional

    Carrier tracking number. Populated once the order moves to shipping status.

  • courierobjectOptional

    Name of the shipping carrier (e.g. ups, dhl). Populated alongside tracking_number.

  • created_attimestamp

    ISO 8601 timestamp of when this order was placed.

  • updated_attimestamp

    ISO 8601 timestamp of the most recent change to this order (status update, tracking added, etc.).

The order object
{
  ,
  ,
  ,
  ,
  ,
  ,
  ,
  ,
  ,
  
}

List your orders

GET/v1/designer/orders

Credentials
An API key with the ORDER or FULL permission.
For
Designers
Operation id
v1_listOrders

Returns a paginated list of your orders, sorted by creation date (newest first). Each entry includes the current lifecycle status, shipping address, item breakdown, and tracking details when available. Use the order_id field to fetch full details via GET /orders/:orderId.

Query parameters

  • pageinteger

    1-based page index.

    Range at least 1. Defaults to 1.
  • page_sizeinteger

    Page size (max 100).

    Range 1 to 100. Defaults to 20.
  • store_idstring

    Return only orders belonging to this store. Omit to return orders from every store on your account.

Returns200 OK

Paginated list of orders for the authenticated account.

Responses

  • 200

    Paginated list of orders for the authenticated account.

  • 400

    page or page_size is outside the allowed range.

  • 401

    API key is missing or invalid.

  • 403

    The API key does not have permission to use order endpoints.

  • 429

    Rate limit exceeded - wait until the window resets before retrying.

  • 500

    An unexpected error occurred on our side.

Errors use the v1 error body.

GET/v1/designer/orders
curl "https://public-api.dapi.digital/v1/designer/orders" \
  -H "x-api-key: $DAPI_API_KEY"
Response
{
  "items": [
    {
      "order_id": "AP7K2M9X",
      "status": "pending",
      "delivery": 10,
      "order_total": 133.4,
      "customer": null,
      "items": [
        {
          "quoteId": "dapi_a3f9b2c1e4",
          "filaments": [
            "PLA-GREEN",
            "PLA-RED"
          ],
          "individual_price": 12.34,
          "quantity": 5,
          "total": 61.7
        }
      ],
      "tracking_number": "1Z999AA10123456784",
      "courier": "ups",
      "created_at": "2026-03-24T12:00:00.000Z",
      "updated_at": "2026-03-24T12:05:00.000Z"
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 42
}

Create an order from completed quotes

POST/v1/designer/orders

Credentials
An API key with the ORDER or FULL permission.
For
Designers
Operation id
v1_createOrder

Places a new order by combining one or more completed quotes. Each item references a quote by its publicId and specifies the filament and quantity to produce.

Prerequisites:

  • All referenced quotes must have status equal to DONE.
  • All filament codes must be valid - retrieve available codes from GET /orders/filaments.
  • At least one item is required.
  • Each item lists its filaments in filaments, one code per colour slot in slot order; a single-colour design sends a one-element array.

Multi-colour items: filaments lists one code per colour slot in the design's own extruder order, so ["PLA-GREEN","PLA-RED"] and ["PLA-RED","PLA-GREEN"] order different products. Each distinct combination becomes its own SKU; repeating the same quote with the same combination reuses it.

The order is created with status pending. Use POST /orders/:orderId/pay to pay for it and move it into production.

Request body

  • customervalueRequired

    Recipient contact and shipping address. All nested fields are required.

  • itemsarray of V1OrderItemDtoRequired

    One or more items to include in the order. Each item references a completed quote and specifies a filament and quantity. At least one item is required.

  • store_idstring

    The store this order belongs to. Required once your account has at least one store. Every quote referenced in items must belong to this same store.

  • customer_notesstring

    Optional notes for the order (e.g. delivery instructions).

  • checkout_linkboolean

    When true, a hosted Stripe Checkout URL is generated and returned in the response as checkout_link. The customer can open this URL in a browser to pay for the order. The order status will automatically advance to paid once payment is completed via Stripe. Requires checkout_success_url and checkout_cancel_url.

    Defaults to false.
  • checkout_success_urlstring

    URL to redirect the customer to after a successful Stripe Checkout payment. Required when checkout_link is true. You may include {CHECKOUT_SESSION_ID} as a placeholder - Stripe will substitute it with the actual session ID.

  • checkout_cancel_urlstring

    URL to redirect the customer to if they cancel the Stripe Checkout flow. Required when checkout_link is true.

Returns201 Created

Order created with status pending. Pay with POST /orders/:orderId/pay to proceed.

Responses

  • 201

    Order created with status pending. Pay with POST /orders/:orderId/pay to proceed.

  • 400

    Request body failed validation, a filament code is unrecognised, or a referenced quote does not have status DONE.

  • 401

    API key is missing or invalid.

  • 403

    The API key does not have permission to use order endpoints.

  • 404

    One or more referenced quote publicId values were not found for your account.

  • 429

    Rate limit exceeded - wait until the window resets before retrying.

  • 500

    An unexpected error occurred on our side.

Errors use the v1 error body.

POST/v1/designer/orders
curl -X POST "https://public-api.dapi.digital/v1/designer/orders" \
  -H "x-api-key: $DAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "customer": null,
  "items": [
    {
      "quoteId": "dapi_a3f9b2c1e4",
      "filaments": [
        "PLA-GREEN",
        "PLA-RED"
      ],
      "quantity": 5
    }
  ],
  "store_id": "str_9f2c4a7b13d84e0fa6c5b8e21d47a903",
  "customer_notes": "Please leave at the door.",
  "checkout_link": false,
  "checkout_success_url": "https://yourstore.com/orders/success?ref={CHECKOUT_SESSION_ID}",
  "checkout_cancel_url": "https://yourstore.com/orders/cancelled"
}'
Response
{
  "orderId": "AP7K2M9X",
  "status": "pending",
  "delivery": 10,
  "order_total": 133.4,
  "items": [
    {
      "quoteId": "dapi_a3f9b2c1e4",
      "individual_price": 12.34,
      "quantity": 5,
      "total": 61.7
    }
  ],
  "checkout_link": "https://checkout.stripe.com/c/pay/cs_test_..."
}

List available filaments

GET/v1/designer/orders/filaments

Credentials
An API key with the ORDER or FULL permission.
For
Designers
Operation id
v1_listFilaments

Returns all filament options currently available for ordering. Use the code value (e.g. PLA-GREEN) in the filaments array of each item when creating an order via POST /orders.

Returns200 OK

All filaments available for use in orders.

Responses

  • 200

    All filaments available for use in orders.

  • 401

    API key is missing or invalid.

  • 403

    The API key does not have permission to use order endpoints.

  • 429

    Rate limit exceeded - wait until the window resets before retrying.

Errors use the v1 error body.

GET/v1/designer/orders/filaments
curl "https://public-api.dapi.digital/v1/designer/orders/filaments" \
  -H "x-api-key: $DAPI_API_KEY"
Response
{
  "items": [
    {
      "code": "PLA-GREEN",
      "name": "PLA Green",
      "color": "green"
    }
  ]
}

Get the shipping rate card

GET/v1/designer/orders/shipping/rates

Credentials
An API key with the ORDER or FULL permission.
For
Designers
Operation id
v1_getShippingRates

Returns every shipping zone, the countries it covers as ISO 3166-1 alpha-2 codes, and the price of the first item in each weight tier plus each additional item.

How a parcel is priced:

  • The tier comes from the HEAVIEST single item, not the summed weight of the order. Two small items ship as one Small plus one additional item, not as a Medium.
  • Items under extra_small_max_grams are exempt from additional_item_price.
  • A destination no zone lists falls to the zone with catch_all set.
  • An order that cannot be rated at all is charged flat_rate.

Use POST /orders/shipping/estimate to price a specific order rather than deriving it.

Returns200 OK

The active rate card.

Responses

  • 200

    The active rate card.

  • 401

    API key is missing or invalid.

  • 403

    The API key does not have permission to use order endpoints.

  • 429

    Rate limit exceeded - wait until the window resets before retrying.

Errors use the v1 error body.

GET/v1/designer/orders/shipping/rates
curl "https://public-api.dapi.digital/v1/designer/orders/shipping/rates" \
  -H "x-api-key: $DAPI_API_KEY"
Response
{
  "zones": [
    {
      "zone": "EU",
      "label": "European Union",
      "countries": [
        "AT",
        "BE",
        "DE",
        "FR"
      ],
      "unmapped_countries": [],
      "catch_all": false,
      "small_first_price": 4.5,
      "medium_first_price": 7.9,
      "large_first_price": 14,
      "additional_item_price": 1
    }
  ],
  "tiers": [
    {
      "tier": "small",
      "max_grams": 600
    }
  ],
  "extra_small_max_grams": 100,
  "flat_rate": 10
}

Estimate shipping for an order

POST/v1/designer/orders/shipping/estimate

Credentials
An API key with the ORDER or FULL permission.
For
Designers
Operation id
v1_estimateShipping

Prices shipping for a set of quotes and a destination, without placing an order. Runs the same weigh -> tier -> price steps order creation does, against the same rate card, so the number returned is the number the order will be charged.

Filaments are not accepted: colour does not change what a parcel weighs.

A destination that cannot be rated against the card is still priced - shipping is always what the order will be charged - but comes back with zone and tier null.

Request body

  • countrystringRequired

    2-letter ISO 3166-1 alpha-2 destination code, uppercase.

  • itemsarray of V1EstimateShippingItemDtoRequired

    Items to ship. Filaments are not needed: colour does not change what a parcel weighs.

Returns200 OK

The shipping cost this order would be charged.

Responses

  • 200

    The shipping cost this order would be charged.

  • 400

    Request body failed validation, or a quote has not finished slicing.

  • 401

    API key is missing or invalid.

  • 403

    The API key does not have permission to use order endpoints.

  • 404

    One or more quotes do not exist for your account.

  • 429

    Rate limit exceeded - wait until the window resets before retrying.

Errors use the v1 error body.

POST/v1/designer/orders/shipping/estimate
curl -X POST "https://public-api.dapi.digital/v1/designer/orders/shipping/estimate" \
  -H "x-api-key: $DAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "country": "DE",
  "items": [
    {
      "quoteId": "dapi_a3f9b2c1e4",
      "quantity": 5
    }
  ]
}'
Response
{
  "country": "DE",
  "zone": "EU",
  "zone_label": "European Union",
  "tier": "small",
  "item_count": 5,
  "billable_item_count": 0,
  "extra_small_items": true,
  "shipping": 4.5
}

Get one order

GET/v1/designer/orders/{orderId}

Credentials
An API key with the ORDER or FULL permission.
For
Designers
Operation id
v1_getOrderById

Returns the order matching the given orderId. Includes current status, recipient details, item breakdown, and tracking information once the order ships.

Webhook Notifications

When an order status changes to paid, in_production, shipping, or completed, we send an HTTP POST to your configured webhook URL (set via the dashboard). Each notification is signed - verify the X-Dapi-Webhook-Signature header using your webhook secret.

Webhook Payload Shape

JSON
{
  "event": "order.in_production",
  "order": {
    "order_id": "AP7K2M9X",
    "status": "in_production",
    "tracking_number": null,
    "courier": null
  },
  "timestamp": "2026-03-25T12:05:00.000Z"
}

Expected Response

Return any 2xx status code to acknowledge receipt. We retry on non-2xx responses.

Path parameters

  • orderIdstringRequired

    The unique order identifier returned when the order was created.

Returns200 OK

The requested order object. Returns the order object.

Responses

  • 200

    The requested order object.

  • 401

    API key is missing or invalid.

  • 403

    The API key does not have permission to use order endpoints.

  • 404

    No order with this orderId exists for your account.

  • 429

    Rate limit exceeded - wait until the window resets before retrying.

  • 500

    An unexpected error occurred on our side.

Errors use the v1 error body.

GET/v1/designer/orders/{orderId}
curl "https://public-api.dapi.digital/v1/designer/orders/AP7K2M9X" \
  -H "x-api-key: $DAPI_API_KEY"
Response
{
  "order_id": "AP7K2M9X",
  "status": "pending",
  "delivery": 10,
  "order_total": 133.4,
  "customer": null,
  "items": [
    {
      "quoteId": "dapi_a3f9b2c1e4",
      "filaments": [
        "PLA-GREEN",
        "PLA-RED"
      ],
      "individual_price": 12.34,
      "quantity": 5,
      "total": 61.7
    }
  ],
  "tracking_number": "1Z999AA10123456784",
  "courier": "ups",
  "created_at": "2026-03-24T12:00:00.000Z",
  "updated_at": "2026-03-24T12:05:00.000Z"
}

Pay for an order using wallet balance

POST/v1/orders/{orderId}/pay

Credentials
An API key with the ORDER or FULL permission.
For
Designers
Operation id
v1_payOrder

Pay for a pending order. Three payment methods are available:

  • wallet: Debit the order amount directly from your wallet balance. Fails if the balance is insufficient.
  • wallet_auto: If wallet balance is insufficient, automatically top up from your saved card to the configured auto-topup amount, then debit.
  • wallet_difference: If wallet balance is insufficient, automatically top up only the deficit from your saved card, then debit.

Both wallet_auto and wallet_difference require a saved card on your wallet.

This endpoint is idempotent - calling it on an already-paid order returns 409 Conflict.

Path parameters

  • orderIdstringRequired

    The unique order identifier returned when the order was created.

Request body

  • paymentMethodstringRequired

    How to fund the payment.

    • wallet - deduct the full order amount from your wallet. Fails with 400 if the balance is insufficient.
    • wallet_auto - if your wallet balance is too low, top it up from your saved card to the configured auto-topup target, then deduct. Requires a saved card.
    • wallet_difference - if your wallet balance is too low, charge only the deficit to your saved card, then deduct. Requires a saved card.
    Possible valueswalletwallet_autowallet_difference

Returns200 OK

Payment successful. Order status is now paid.

Responses

  • 200

    Payment successful. Order status is now paid.

  • 400

    Wallet balance is insufficient and no auto-topup is configured, or no saved card is on file for the selected payment method.

  • 401

    API key is missing or invalid.

  • 402

    Card charge failed. The payment could not be confirmed - verify your saved card details or add a new card via the dashboard.

  • 403

    The API key does not have permission to use order endpoints, or this order belongs to a different account.

  • 404

    No order with this orderId exists for your account.

  • 409

    The order has already been paid. No further action is needed.

  • 429

    Rate limit exceeded - wait until the window resets before retrying.

  • 500

    An unexpected error occurred on our side.

Errors use the v1 error body.

POST/v1/orders/{orderId}/pay
curl -X POST "https://public-api.dapi.digital/v1/orders/AP-A1B2C3/pay" \
  -H "x-api-key: $DAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "paymentMethod": "wallet"
}'
Response
{
  "orderId": "AP-A1B2C3",
  "status": "paid",
  "topupAmountUsd": 50,
  "walletDebitedUsd": 25.5
}