Resource

Orders

Orders, their files and downloads, access, licence keys and download emails.

The order object

Attributes

idstring, nullable
Example: 3e84eb8d-e1d9-4e92-a4b2-a419c7f1122f
shopify_order_idstring, nullable
Example: gid://shopify/Order/7555375595815
namestring, nullable
Example: #1077
confirmation_numberstring, nullable
Example: H5CZG3GZX
ordered_atstring, nullable
Example: 2026-10-26T14:19:15Z
customerobject
Show 9 child attributesHide child attributes
- idstring, nullable
  Example: b797db3a-cbc3-4643-804f-adf34c7f08d7
- shopify_customer_idstring, nullable
  Example: gid://shopify/Customer/9026290417959
- emailstring, nullable
  Example: shopper@example.com
- phoneany
- first_namestring, nullable
  Example: Jane
- last_namestring, nullable
  Example: Doe
- country_codeany
- localeany
- unsubscribedboolean, nullable
  Example: false
totalobject
Show 2 child attributesHide child attributes
- amountstring, nullable
  Example: 1142.89
- currencystring, nullable
  Example: INR
statusobject
Show 8 child attributesHide child attributes
- financialstring, nullable
  Example: paid
- fulfillmentstring, nullable
  Example: unfulfilled
- cancelled_atany
- paid_atstring, nullable
  Example: 2026-10-30T21:48:16Z
- flagged_as_fraudboolean, nullable
  Example: false
- fraud_check_completedboolean, nullable
  Example: false
- marked_fulfilled_atany
- delivery_conditions_metboolean, nullable
  Example: false
accessobject
Show 5 child attributesHide child attributes
- statestring, nullable
  Example: active
- revoked_atany
- available_untilany
- download_reset_atstring, nullable
  Example: 2026-10-30T22:19:10Z
- downloads_countinteger, nullable
  Example: 0
deliveryobject
Show 4 child attributesHide child attributes
- email_sent_atstring, nullable
  Example: 2026-10-30T22:34:30Z
- delivery_failed_atany
- download_page_urlstring, nullable
  Example: https://example-store.myshopify.com/apps/filemonk/orders/…
- sourcestring, nullable
  Example: webhook
line_itemsarray of objects
Show 12 child attributesHide child attributes
- idstring, nullable
  Example: 5956bb41-dc65-45d5-b7d7-25f570598468
- digital_product_idstring, nullable
  Example: 7ea3c05d-6f29-42b6-b24f-43260caeaa32
- titlestring, nullable
  Example: Watercolour Course
- skustring, nullable
  Example: b0f5fbd0-f231-470f-b3d1-a392e3136a50
- quantityinteger, nullable
  Example: 2
- shopify_line_item_idstring, nullable
  Example: gid://shopify/LineItem/18329329434919
- shopify_product_idstring, nullable
  Example: gid://shopify/Product/9642107044135
- shopify_variant_idstring, nullable
  Example: gid://shopify/ProductVariant/49417714893095
- attached_to_this_order_onlyboolean, nullable
  Example: false
- accessobject
  Show 2 child attributesHide child attributes
  - revokedboolean, nullable
    Example: false
  - revoked_atany
- preorderobject
  Show 4 child attributesHide child attributes
  - enabledboolean, nullable
    Example: false
  - launch_atany
  - releasedboolean, nullable
    Example: true
  - messageany
- filesarray of objects
  Show 5 child attributesHide child attributes
  - idany
  - assetobject
    Show 3 child attributesHide child attributes
    idstring, nullable
    Example: 7ea42f2a-6dbe-459c-b8a4-27b0eb823e52
    namestring, nullable
    Example: price-list.csv
    typestring, nullable
    Example: file
  - download_countinteger, nullable
    Example: 0
  - watermarkobject
    Show 2 child attributesHide child attributes
    enabledboolean, nullable
    Example: false
    statusstring, nullable
    Example: not_required
  - licence_keysarray of anys
eu_withdrawalobject
Show 3 child attributesHide child attributes
- consent_requiredboolean, nullable
  Example: false
- consented_atany
- consent_textany
shopify_tagsarray of anys
imported_atany
deleted_atany
created_atstring, nullable
Example: 2026-10-26T14:19:29Z
updated_atstring, nullable
Example: 2026-10-30T22:19:10Z

The order object

{
  "id": "3e84eb8d-e1d9-4e92-a4b2-a419c7f1122f",
  "shopify_order_id": "gid://shopify/Order/7555375595815",
  "name": "#1077",
  "confirmation_number": "H5CZG3GZX",
  "ordered_at": "2026-10-26T14:19:15Z",
  "customer": {
    "id": "b797db3a-cbc3-4643-804f-adf34c7f08d7",
    "shopify_customer_id": "gid://shopify/Customer/9026290417959",
    "email": "shopper@example.com",
    "phone": null,
    "first_name": "Jane",
    "last_name": "Doe",
    "country_code": null,
    "locale": null,
    "unsubscribed": false
  },
  "total": {
    "amount": "1142.89",
    "currency": "INR"
  },
  "status": {
    "financial": "paid",
    "fulfillment": "unfulfilled",
    "cancelled_at": null,
    "paid_at": "2026-10-30T21:48:16Z",
    "flagged_as_fraud": false,
    "fraud_check_completed": false,
    "marked_fulfilled_at": null,
    "delivery_conditions_met": false
  },
  "access": {
    "state": "active",
    "revoked_at": null,
    "available_until": null,
    "download_reset_at": "2026-10-30T22:19:10Z",
    "downloads_count": 0
  },
  "delivery": {
    "email_sent_at": "2026-10-30T22:34:30Z",
    "delivery_failed_at": null,
    "download_page_url": "https://example-store.myshopify.com/apps/filemonk/orders/3e84eb8d-e1d9-4e92-a4b2-a419c7f1122f",
    "source": "webhook"
  },
  "line_items": [
    {
      "id": "5956bb41-dc65-45d5-b7d7-25f570598468",
      "digital_product_id": "7ea3c05d-6f29-42b6-b24f-43260caeaa32",
      "title": "Watercolour Course",
      "sku": "b0f5fbd0-f231-470f-b3d1-a392e3136a50",
      "quantity": 2,
      "shopify_line_item_id": "gid://shopify/LineItem/18329329434919",
      "shopify_product_id": "gid://shopify/Product/9642107044135",
      "shopify_variant_id": "gid://shopify/ProductVariant/49417714893095",
      "attached_to_this_order_only": false,
      "access": {
        "revoked": false,
        "revoked_at": null
      },
      "preorder": {
        "enabled": false,
        "launch_at": null,
        "released": true,
        "message": null
      },
      "files": [
        {
          "id": null,
          "asset": {
            "id": "7ea42f2a-6dbe-459c-b8a4-27b0eb823e52",
            "name": "price-list.csv",
            "type": "file"
          },
          "download_count": 0,
          "watermark": {
            "enabled": false,
            "status": "not_required"
          },
          "licence_keys": []
        },
        {
          "id": "66e2751c-9812-422c-864d-f8ce6a95c605",
          "asset": {
            "id": "96fbe30b-c819-4cb8-9666-814c0c8853f1",
            "name": "Beginner's Guide.pdf",
            "type": "file"
          },
          "download_count": 0,
          "watermark": {
            "enabled": true,
            "status": "ready"
          },
          "licence_keys": []
        }
      ]
    }
  ],
  "eu_withdrawal": {
    "consent_required": false,
    "consented_at": null,
    "consent_text": null
  },
  "shopify_tags": [],
  "imported_at": null,
  "deleted_at": null,
  "created_at": "2026-10-26T14:19:29Z",
  "updated_at": "2026-10-30T22:19:10Z"
}