Extras

View as Markdown

Approved bought-in parts that your SKUs ship with.

The extra object

Attributes

  • idstring

    Opaque public identifier for this extra (xtr_ prefix + 33 base62 chars). Use this value verbatim when referencing the extra in other endpoints.

  • namestring

    Display name of the extra.

  • purchase_linksarray of string

    List of URLs where the extra can be purchased.

  • descriptionobjectOptional

    Free-text description of the extra.

  • priceobjectOptional

    Unit price in USD, as a string to preserve precision.

The extra object
{
  ,
  ,
  ,
  ,
  
}

List approved extras visible to your farm

GET/v1/print-farm/extras

Credentials
An API key with the SKU or FULL permission.
For
Print farms
Operation id
listPrintFarmExtras

Returns a paginated list of approved extras reachable from your farm. An extra is visible iff it is referenced in extra_list of a SKU that appears in one of your allocated orders, or in a SKU whose stock is held at one of your farms. Extras outside that chain are not returned. Requires an API key with the SKU (or FULL) permission scope.

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.
  • idarray of string

    Filter by extra id. Accepts a comma-separated list of UUIDs.

  • namestring

    Filter by extra name (case-insensitive partial match).

Returns200 OK

Paginated list of approved extras visible to the authenticated farm.

Responses

  • 200

    Paginated list of approved extras visible to the authenticated farm.

  • 400

    page or page_size is outside the allowed range.

  • 401

    API key is missing or invalid.

  • 403

    The API key does not have the required permission scope.

  • 429

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

  • 500

    An unexpected error occurred on our side.

Errors use the print farm error body.

GET/v1/print-farm/extras
curl "https://public-api.dapi.digital/v1/print-farm/extras" \
  -H "x-api-key: $DAPI_API_KEY"
Response
{
  "extras": [
    {
      "id": "xtr_mW2yH7cVjPq8rT5dN3kFx9eL4bA1uZcRh",
      "name": "M3 screws (set of 4)",
      "purchase_links": [
        "https://example.com/m3-screws"
      ],
      "description": "Pack of four M3×10mm steel screws.",
      "price": "1.50"
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 42
}

Get one approved extra visible to your farm

GET/v1/print-farm/extras/{id}

Credentials
An API key with the SKU or FULL permission.
For
Print farms
Operation id
getPrintFarmExtra

Returns the approved extra matching the given id, scoped to extras reachable from your farm via the SKU graph (orders ∪ stock_levels). Requires an API key with the SKU (or FULL) permission scope.

Path parameters

  • idstringRequired

    The public extra identifier (xtr_…) returned by the list endpoint.

Returns200 OK

The requested extra. Returns the extra object.

Responses

  • 200

    The requested extra.

  • 401

    API key is missing or invalid.

  • 403

    The API key does not have the required permission scope.

  • 404

    No approved extra with this id is visible to your farm (it may exist in the catalog but isn't reachable via any of your orders or stock_levels).

  • 429

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

  • 500

    An unexpected error occurred on our side.

Errors use the print farm error body.

GET/v1/print-farm/extras/{id}
curl "https://public-api.dapi.digital/v1/print-farm/extras/xtr_mW2yH7cVjPq8rT5dN3kFx9eL4bA1uZcRh" \
  -H "x-api-key: $DAPI_API_KEY"
Response
{
  "id": "xtr_mW2yH7cVjPq8rT5dN3kFx9eL4bA1uZcRh",
  "name": "M3 screws (set of 4)",
  "purchase_links": [
    "https://example.com/m3-screws"
  ],
  "description": "Pack of four M3×10mm steel screws.",
  "price": "1.50"
}