Track Offers

Endpointhttps://api.idol.io/api/v2

Track-level release configurations and availability settings. 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.

List track offers

GET

https://api.idol.io/api/v2

/track-offers

Retrieve track-level release configurations

List track offers › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

filter[distributor-id]

string

Filter by distributor ID

filter[company-ids]

string

Comma-separated company IDs

filter[label-ids]

string

Comma-separated label IDs

filter[product-ids]

string

Comma-separated product IDs

filter[track-id]

string

Filter by track ID

filter[is-default]

boolean

Filter by default status

List track offers › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create a track offer

POST

https://api.idol.io/api/v2

/track-offers

Create a new track-level release configuration

Create a track offer › Request Body

object · required

Create a track offer › Responses

Track offer created successfully

object

object[]

Related resources included in the response

object

POST/track-offers

curl --request POST \
  --url https://api.idol.io/api/v2/track-offers \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "track-offers",
    "id": "id",
    "attributes": {
      "usage": {
        "download": true,
        "on-demand-stream": true,
        "non-interactive-stream": true,
        "copy-scan": true
      },
      "release-date": "2024-08-25",
      "track-options": {},
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "track": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "offer": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "genre": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "track-offers",
    "id": "id",
    "attributes": {
      "usage": {
        "download": true,
        "on-demand-stream": true,
        "non-interactive-stream": true,
        "copy-scan": true
      },
      "release-date": "2024-08-25",
      "track-options": {},
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "track": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "offer": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "genre": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Get track offer details

GET

https://api.idol.io/api/v2

/track-offers/{id}

Retrieve details for a specific track offer by ID

Get track offer details › path Parameters

id

string · required

Resource ID

Get track offer details › Responses

Successful response

object

object[]

Related resources included in the response

object

Update a track offer

PUT

https://api.idol.io/api/v2

/track-offers/{id}

Update an existing track offer

Update a track offer › path Parameters

id

string · required

Resource ID

Update a track offer › Request Body

object · required

Update a track offer › Responses

Track offer updated successfully

object

object[]

Related resources included in the response

object

PUT/track-offers/{id}

curl --request PUT \
  --url https://api.idol.io/api/v2/track-offers/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "track-offers",
    "id": "id",
    "attributes": {
      "usage": {
        "download": true,
        "on-demand-stream": true,
        "non-interactive-stream": true,
        "copy-scan": true
      },
      "release-date": "2024-08-25",
      "track-options": {},
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "track": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "offer": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "genre": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "track-offers",
    "id": "id",
    "attributes": {
      "usage": {
        "download": true,
        "on-demand-stream": true,
        "non-interactive-stream": true,
        "copy-scan": true
      },
      "release-date": "2024-08-25",
      "track-options": {},
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "track": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "offer": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "genre": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Delete a track offer

DELETE

https://api.idol.io/api/v2

/track-offers/{id}

Delete a track offer

Delete a track offer › path Parameters

id

string · required

Resource ID

Delete a track offer › Responses

Track offer deleted successfully

No data returned

Offers Rights

Labelcamp API v2

Track Offers

Endpointhttps://api.idol.io/api/v2

List track offers

GET

https://api.idol.io/api/v2

/track-offers

Retrieve track-level release configurations

List track offers › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

filter[distributor-id]

string

Filter by distributor ID

filter[company-ids]

string

Comma-separated company IDs

filter[label-ids]

string

Comma-separated label IDs

filter[product-ids]

string

Comma-separated product IDs

filter[track-id]

string

Filter by track ID

filter[is-default]

boolean

Filter by default status

List track offers › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create a track offer

POST

https://api.idol.io/api/v2

/track-offers

Create a new track-level release configuration

Create a track offer › Request Body

object · required

Create a track offer › Responses

Track offer created successfully

object

object[]

Related resources included in the response

object

POST/track-offers

curl --request POST \
  --url https://api.idol.io/api/v2/track-offers \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "track-offers",
    "id": "id",
    "attributes": {
      "usage": {
        "download": true,
        "on-demand-stream": true,
        "non-interactive-stream": true,
        "copy-scan": true
      },
      "release-date": "2024-08-25",
      "track-options": {},
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "track": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "offer": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "genre": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "track-offers",
    "id": "id",
    "attributes": {
      "usage": {
        "download": true,
        "on-demand-stream": true,
        "non-interactive-stream": true,
        "copy-scan": true
      },
      "release-date": "2024-08-25",
      "track-options": {},
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "track": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "offer": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "genre": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Get track offer details

GET

https://api.idol.io/api/v2

/track-offers/{id}

Retrieve details for a specific track offer by ID

Get track offer details › path Parameters

id

string · required

Resource ID

Get track offer details › Responses

Successful response

object

object[]

Related resources included in the response

object

Update a track offer

PUT

https://api.idol.io/api/v2

/track-offers/{id}

Update an existing track offer

Update a track offer › path Parameters

id

string · required

Resource ID

Update a track offer › Request Body

object · required

Update a track offer › Responses

Track offer updated successfully

object

object[]

Related resources included in the response

object

PUT/track-offers/{id}

curl --request PUT \
  --url https://api.idol.io/api/v2/track-offers/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "track-offers",
    "id": "id",
    "attributes": {
      "usage": {
        "download": true,
        "on-demand-stream": true,
        "non-interactive-stream": true,
        "copy-scan": true
      },
      "release-date": "2024-08-25",
      "track-options": {},
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "track": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "offer": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "genre": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "track-offers",
    "id": "id",
    "attributes": {
      "usage": {
        "download": true,
        "on-demand-stream": true,
        "non-interactive-stream": true,
        "copy-scan": true
      },
      "release-date": "2024-08-25",
      "track-options": {},
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "track": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "offer": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "genre": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Delete a track offer

DELETE

https://api.idol.io/api/v2

/track-offers/{id}

Delete a track offer

Delete a track offer › path Parameters

id

string · required

Resource ID

Delete a track offer › Responses

Track offer deleted successfully

No data returned

Offers Rights