TrackOffer

List TrackOffers

GET https://api.idol.io/api/v2/track-offers

Headers

Name
Type
Description

Authorization*

string

Bearer <token>

Content-Type*

string

application/vnd.api+json

{
  "data": [
    {
      "id": "<ID>",
      "type": "track-offers",
      "links": {
        "self": "https://api.idol.io/api/v2/track-offers/<ID>"
      },
      "attributes": {
        "created-at": "2024-11-16T15:57:37.967+01:00",
        "updated-at": "2025-11-26T10:39:47.186+01:00",
        "usage": {
          "download": true,
          "on_demand_stream": true,
          "non_interactive_stream": true,
          "copy_scan": true
        },
        "download": true,
        "stream": true,
        "release-date": "2024-11-27T00:00:00.000Z"
      },
      "relationships": {
        "track": {
          "links": {
            "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/track",
            "related": "https://api.idol.io/api/v2/track-offers/<ID>/track"
          },
          "data": {
            "type": "tracks",
            "id": "<ID>"
          }
        },
        "offer": {
          "links": {
            "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/offer",
            "related": "https://api.idol.io/api/v2/track-offers/<ID>/offer"
          },
          "data": {
            "type": "offers",
            "id": "<ID>"
          }
        },
        "price-code": {
          "links": {
            "self": "http://idolcamp.test/api/v2/track-offers/<ID>/relationships/price-code",
            "related": "http://idolcamp.test/api/v2/track-offers/<ID>/price-code"
          },
          "data": {
            "type": "distributor-price-codes",
            "id": "<ID>"
          }
        },
        "genre": {
          "links": {
            "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/genre",
            "related": "https://api.idol.io/api/v2/track-offers/<ID>/genre"
          },
          "data": {
            "type": "distributor-product-subgenres",
            "id": "<ID>"
          }
        }
      }
    },
    {
      "id": "<ID>",
      "type": "track-offers",
      "links": {
        "self": "https://api.idol.io/api/v2/track-offers/<ID>"
      },
      "attributes": {
        "created-at": "2024-11-16T15:57:38.032+01:00",
        "updated-at": "2024-11-26T10:35:48.967+01:00",
        "usage": {
          "download": true,
          "on_demand_stream": true,
          "non_interactive_stream": true,
          "copy_scan": true
        },
        "download": true,
        "stream": true,
        "release-date": null
      },
      "relationships": {
        "track": {
          "links": {
            "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/track",
            "related": "https://api.idol.io/api/v2/track-offers/<ID>/track"
          },
          "data": {
            "type": "tracks",
            "id": "<ID>"
          }
        },
        "offer": {
          "links": {
            "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/offer",
            "related": "https://api.idol.io/api/v2/track-offers/<ID>/offer"
          },
          "data": {
            "type": "offers",
            "id": "<ID>"
          }
        },
        "price-code": {
          "links": {
            "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/price-code",
            "related": "https://api.idol.io/api/v2/track-offers/<ID>/price-code"
          },
          "data": null
        },
        "genre": {
          "links": {
            "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/genre",
            "related": "https://api.idol.io/api/v2/track-offers/<ID>/genre"
          },
          "data": {
            "type": "distributor-product-subgenres",
            "id": "<ID>"
          }
        }
      }
    },
    {
      "id": "<ID>",
      "type": "track-offers",
      "links": {
        "self": "https://api.idol.io/api/v2/track-offers/<ID>"
      },
      "attributes": {
        "created-at": "2018-11-21T16:53:37.256+01:00",
        "updated-at": "2018-11-26T10:35:48.919+01:00",
        "usage": {
          "download": true,
          "on_demand_stream": true,
          "non_interactive_stream": true,
          "copy_scan": true
        },
        "download": true,
        "stream": true,
        "release-date": null
      },
      "relationships": {
        "track": {
          "links": {
            "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/track",
            "related": "https://api.idol.io/api/v2/track-offers/<ID>/track"
          },
          "data": {
            "type": "tracks",
            "id": "<ID>"
          }
        },
        "offer": {
          "links": {
            "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/offer",
            "related": "https://api.idol.io/api/v2/track-offers/<ID>/offer"
          },
          "data": {
            "type": "offers",
            "id": "<ID>"
          }
        },
        "price-code": {
          "links": {
            "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/price-code",
            "related": "https://api.idol.io/api/v2/track-offers/<ID>/price-code"
          },
          "data": null
        },
        "genre": {
          "links": {
            "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/genre",
            "related": "https://api.idol.io/api/v2/track-offers/<ID>/genre"
          },
          "data": {
            "type": "distributor-product-subgenres",
            "id": "<ID>"
          }
        }
      }
    }
  ],
  "meta": {
    "record-count": 3,
    "page-count": 1
  },
  "links": {
    "first": "https://api.idol.io/api/v2/track-offers?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "last": "https://api.idol.io/api/v2/track-offers?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}

Filter resources

api/v2/track-offers?filter[distributor-id]=true

Get TrackOffer

GET https://api.idol.io/api/v2/track-offers/:id

Path Parameters

Name
Type
Description

id*

number

ID of the TrackOffer

Headers

Name
Type
Description

Authorization*

string

Bearer <token>

Content-Type*

string

application/vnd.api+json

{
  "data": {
    "id": "<ID>",
    "type": "track-offers",
    "links": {
      "self": "https://api.idol.io/api/v2/track-offers/<ID>"
    },
    "attributes": {
      "created-at": "2024-07-12T17:09:25.997+02:00",
      "updated-at": "2024-07-12T17:09:25.997+02:00",
      "usage": {
        "download": true,
        "on_demand_stream": true,
        "non_interactive_stream": true,
        "copy_scan": true
      },
      "download": true,
      "stream": true
    },
    "relationships": {
      "track": {
        "links": {
          "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/track",
          "related": "https://api.idol.io/api/v2/track-offers/<ID>/track"
        },
        "data": {
          "type": "tracks",
          "id": "<ID>"
        }
      },
      "offer": {
        "links": {
          "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/offer",
          "related": "https://api.idol.io/api/v2/track-offers/<ID>/offer"
        },
        "data": {
          "type": "offers",
          "id": "<ID>"
        }
      },
      "price-code": {
        "links": {
          "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/price-code",
          "related": "https://api.idol.io/api/v2/track-offers/<ID>/price-code"
        },
        "data": {
          "type": "distributor-price-codes",
          "id": "<ID>"
        }
      },
      "genre": {
        "links": {
          "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/genre",
          "related": "https://api.idol.io/api/v2/track-offers/<ID>/genre"
        },
        "data": {
          "type": "distributor-product-subgenres",
          "id": "<ID>"
        }
      }
    }
  }
}

Create TrackOffer

POST https://api.idol.io/api/v2/track-offers

Headers

Name
Type
Description

Authorization*

string

Bearer <token>

Content-Type*

string

application/vnd.api+json

Request Body

Name
Type
Description

track*

object

Track Object

price-code

object

DistributorPriceCode Object

track-price-code

object

DistributorPriceCode Object

offer*

object

Offer Object

genre

object

DistributorProductSubgenre Object

release-date

string

date - e.g. 2024-01-01

usage*

object

{ "download": true, "on_demand_stream": true, "copy_scan": true, "non_interactive_stream": true }

track-options

array

[{ "name": "release_time", value: "10:00"}, { "name": "release_time_global", "value": true}]

{
  "data": {
    "id": "<ID>",
    "type": "track-offers",
    "links": {
      "self": "https://api.idol.io/api/v2/track-offers/<ID>"
    },
    "attributes": {
      "created-at": "2024-07-12T17:09:25.997+02:00",
      "updated-at": "2024-07-12T17:09:25.997+02:00",
      "options": [{name: "release_time", value: "10:00"}, {"name":"release_time_global","value":true}],
      "usage": {
        "download": true,
        "on_demand_stream": true,
        "non_interactive_stream": true,
        "copy_scan": true
      },
      "download": true,
      "stream": true
    },
    "relationships": {
      "track": {
        "links": {
          "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/track",
          "related": "https://api.idol.io/api/v2/track-offers/<ID>/track"
        },
        "data": {
          "type": "tracks",
          "id": "<ID>"
        }
      },
      "offer": {
        "links": {
          "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/offer",
          "related": "https://api.idol.io/api/v2/track-offers/<ID>/offer"
        },
        "data": {
          "type": "offers",
          "id": "<ID>"
        }
      },
      "price-code": {
        "links": {
          "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/price-code",
          "related": "https://api.idol.io/api/v2/track-offers/<ID>/price-code"
        },
        "data": {
          "type": "distributor-price-codes",
          "id": "<ID>"
        }
      },
      "genre": {
        "links": {
          "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/genre",
          "related": "https://api.idol.io/api/v2/track-offers/<ID>/genre"
        },
        "data": {
          "type": "distributor-product-subgenres",
          "id": "<ID>"
        }
      }
    }
  }
}

  • The track-price-code attribute is a DistributorPriceCode object with a is-track-price attribute set to true. It is only optional in the TrackOffer, if left blank the track-price-code set in the Offer will apply.

  • Same as above applies for genre attribute.

  • Find more details on how to provide the track-options attribute here.

Update TrackOffer

PUT https://api.idol.io/api/v2/track-offers/:id

Path Parameters

Name
Type
Description

id*

number

ID of the TrackOffer

Headers

Name
Type
Description

Authorization*

string

Bearer <token>

Content-Type*

string

application/vnd.api+json

Request Body

Name
Type
Description

track*

object

Track Object

price-code

object

DistributorPriceCode Object

track-price-code

object

DistributorPriceCode Object

offer*

object

Offer Object

genre

object

DistributorProductSubgenre Object

release-date

string

date - e.g. 2024-01-01

usage*

object

{ "download": true, "on_demand_stream": true, "copy_scan": true, "non_interactive_stream": true }

track-options

array

[{ "name": "release_time", value: "10:00"}, { "name": "release_time_global", "value": true}]

{
  "data": {
    "id": "<ID>",
    "type": "track-offers",
    "links": {
      "self": "https://api.idol.io/api/v2/track-offers/<ID>"
    },
    "attributes": {
      "created-at": "2024-07-12T17:09:25.997+02:00",
      "updated-at": "2024-07-12T17:09:25.997+02:00",
      "options": [
        {
          "name": "release_time",
          "value": "10:00"
         },
         {
           "name": "release_time_global",
           "value": true
         }
      ],
      "usage": {
        "download": true,
        "on_demand_stream": true,
        "non_interactive_stream": true,
        "copy_scan": true
      },
      "download": true,
      "stream": true
    },
    "relationships": {
      "track": {
        "links": {
          "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/track",
          "related": "https://api.idol.io/api/v2/track-offers/<ID>/track"
        },
        "data": {
          "type": "tracks",
          "id": "<ID>"
        }
      },
      "offer": {
        "links": {
          "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/offer",
          "related": "https://api.idol.io/api/v2/track-offers/<ID>/offer"
        },
        "data": {
          "type": "offers",
          "id": "<ID>"
        }
      },
      "price-code": {
        "links": {
          "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/price-code",
          "related": "https://api.idol.io/api/v2/track-offers/<ID>/price-code"
        },
        "data": {
          "type": "distributor-price-codes",
          "id": "<ID>"
        }
      },
      "genre": {
        "links": {
          "self": "https://api.idol.io/api/v2/track-offers/<ID>/relationships/genre",
          "related": "https://api.idol.io/api/v2/track-offers/<ID>/genre"
        },
        "data": {
          "type": "distributor-product-subgenres",
          "id": "<ID>"
        }
      }
    }
  }
}

  • The track-price-code attribute is a DistributorPriceCode object with a is-track-price attribute set to true. It is only optional in the TrackOffer, if left blank the track-price-code set in the Offer will apply.

  • Same as above applies for genre attribute.

  • Find more details on how to provide the track-options attribute here.

Delete TrackOffer

DELETE https://api.idol.io/api/v2/track-offers/:id

Path Parameters

Name
Type
Description

id*

number

ID of the TrackOffer

Headers

Name
Type
Description

Authorization*

string

Bearer <token>

Content-Type*

string

application/vnd.api+json

PreviousTrackNextTrackVideo

Last updated