Resource

Assets

Files, links and licence-key files in the library.

The asset object

Attributes

idstring, nullable
Example: e2b7727e-45ad-42b7-b842-cc4615205b10
typestring, nullable
Example: link
namestring, nullable
Example: ebook-2026
filenamestring, nullable
Example: ebook-2026.zip
extensionstring, nullable
Example: zip
content_typestring, nullable
Example: application/zip
byte_sizeinteger, nullable
Example: 0
urlstring, nullable
Example: https://example.com/ebook-2026.zip
url_expires_atany
watermarkobject
Show 1 child attributeHide child attributes
- enabledboolean, nullable
  Example: false
licence_keysobject
Show 2 child attributesHide child attributes
- autogenerateboolean, nullable
  Example: false
- tagsarray of anys
usageobject
Show 2 child attributesHide child attributes
- digital_products_countinteger, nullable
  Example: 2
- orders_countinteger, nullable
  Example: 0
digital_productsarray of objects
Show 13 child attributesHide child attributes
- idstring, nullable
  Example: f5f278c8-4a92-48a3-bc40-216468b9bccd
- scopestring, nullable
  Example: variant
- shopify_product_idstring, nullable
  Example: gid://shopify/Product/9642107207975
- shopify_variant_idstring, nullable
  Example: gid://shopify/ProductVariant/49417715843367
- titlestring, nullable
  Example: Watercolour Course
- variant_titlestring, nullable
  Example: xs / blue / water
- skustring, nullable
  Example: ae8ea669-7bd1-4afd-b200-a7b75777b46a
- files_countinteger, nullable
  Example: 2
- preorderobject
  Show 1 child attributeHide child attributes
  - enabledboolean, nullable
    Example: false
- deliveryobject
  Show 1 child attributeHide child attributes
  - attach_to_every_orderboolean, nullable
    Example: false
- exists_on_shopifyany
- updated_atstring, nullable
  Example: 2026-10-30T16:55:48Z
- folderany
recent_ordersarray of anys
created_atstring, nullable
Example: 2026-10-30T16:49:38Z
updated_atstring, nullable
Example: 2026-10-30T16:49:38Z

Endpoints

The asset object

{
  "id": "e2b7727e-45ad-42b7-b842-cc4615205b10",
  "type": "link",
  "name": "ebook-2026",
  "filename": "ebook-2026.zip",
  "extension": "zip",
  "content_type": "application/zip",
  "byte_size": 0,
  "url": "https://example.com/ebook-2026.zip",
  "url_expires_at": null,
  "watermark": {
    "enabled": false
  },
  "licence_keys": {
    "autogenerate": false,
    "tags": []
  },
  "usage": {
    "digital_products_count": 2,
    "orders_count": 0
  },
  "digital_products": [
    {
      "id": "f5f278c8-4a92-48a3-bc40-216468b9bccd",
      "scope": "variant",
      "shopify_product_id": "gid://shopify/Product/9642107207975",
      "shopify_variant_id": "gid://shopify/ProductVariant/49417715843367",
      "title": "Watercolour Course",
      "variant_title": "xs / blue / water",
      "sku": "ae8ea669-7bd1-4afd-b200-a7b75777b46a",
      "files_count": 2,
      "preorder": {
        "enabled": false
      },
      "delivery": {
        "attach_to_every_order": false
      },
      "exists_on_shopify": null,
      "updated_at": "2026-10-30T16:55:48Z",
      "folder": null
    },
    {
      "id": "4d08443e-549b-44c8-afee-c3836d767e7c",
      "scope": "product",
      "shopify_product_id": "gid://shopify/Product/9642103537959",
      "shopify_variant_id": null,
      "title": "The Draft Snowboard",
      "variant_title": null,
      "sku": null,
      "files_count": 2,
      "preorder": {
        "enabled": false
      },
      "delivery": {
        "attach_to_every_order": false
      },
      "exists_on_shopify": null,
      "updated_at": "2026-10-30T16:56:48Z",
      "folder": "Extras"
    }
  ],
  "recent_orders": [],
  "created_at": "2026-10-30T16:49:38Z",
  "updated_at": "2026-10-30T16:49:38Z"
}