downloadable

Collection: downloadables

Downloadables are items configured directly in Foxy for users to purchase and download. When creating a downloadable, you'll also send the file directly. Additionally, the downloadable must have an item_category_uri of an item_category which is configured for downloaded item delivery.

To create a downloadable, you need to POST a file with the value being the downloadable file you want to create.

You can also update an existing downloadable file using the file property, but you may also need to include the X-HTTP-Method-Override: PATCH header since our server expects a PATCH or a PUT when updating an existing resource.

Required Scopes

Full store_full_access
Read downloadables_read
Write downloadables_write

Actions

GET View a downloadable
PATCH Update a downloadable (send only the properties you want to modify)
PUT Replace a downloadable (send the entire representation)
DELETE Delete a downloadable
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (9)

item_category_uri String · Required

The full API URI of the item category this product is part of. The item category must have an item delivery type of downloaded.

Obtained from the self link relation of an item category.

name String · Required · max 100

The name of this downloadable. This will be shown to the customer in the cart.

code String · Required · max 50

The code for this downloadable. When adding this item to the cart, this is the code which will be used.

price Number

The item total for this downloadable. This is the amount the customer will pay to purchase this downloadable item.

Greater than or equal to 0.

file_name String · Read-only

The name of the file uploaded to our server. This is originally set when creating a downloadable with the file property.

file_size Number · Read-only

The size of the file uploaded to our server. This is originally set when creating a downloadable with the file property.

upload_date String · Read-only

The date this file was last uploaded.

date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (4)

self This Downloadable
fx:store GET PATCH PUT DELETE This Store
fx:item_category GET PATCH PUT DELETE Item Category for this downloadable
fx:downloadable_item_categories Downloadable Item Categories for this store
https://api.foxycart.com/downloadables/{id}
Available via fx:downloadable on downloadable_purchase

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/downloadables/123",
      "title": "This Downloadable"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:item_category": {
      "href": "https://api.foxycart.com/item_categories/999",
      "title": "Item Category for this downloadable"
    },
    "fx:downloadable_item_categories": {
      "href": "https://api.foxycart.com/stores/456/item_categories?item_delivery_type=downloaded",
      "title": "Downloadable Item Categories for this store"
    }
  },
  "item_category_uri": "https://api-sandbox.foxycart.com/item_categories/307",
  "name": "Unicorn",
  "code": "unicorn",
  "price": 10,
  "file_name": "unicorn_web.png",
  "file_size": 267069,
  "upload_date": "2015-04-16T09:33:28-0700",
  "date_created": "2015-04-16T09:33:28-0700",
  "date_modified": "2015-04-16T09:46:46-0700"
}