Offers

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

Release configurations including release dates, pricing, territories, and platform selections. Each product can have multiple offers for different markets or release windows.

List offers

GET

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

/offers

Retrieve release configurations

List 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[product-id]

string

List offers › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create an offer

POST

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

/offers

Create a new release configuration.

Important notes:

Leave the dsp-upload-identifications relationship empty if you want to create a default offer on a product
The track-price-code attribute is a DistributorPriceCode object with a is-track-price attribute set to true
Find more details on how to provide the options attribute in the DSP Upload Identifications section

Create an offer › Request Body

object · required

Create an offer › Responses

Offer created successfully

object

object[]

Related resources included in the response

object

POST/offers

curl --request POST \
  --url https://api.idol.io/api/v2/offers \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "offers",
    "id": "id",
    "attributes": {
      "status": "draft",
      "release-date": "2024-08-25",
      "preorder-date": "2024-08-25",
      "pitch-date": "2024-08-25",
      "is-default": true,
      "usage": "usage",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "subgenre": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "subgenre2": {
        "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"
        }
      },
      "track-price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "track-offers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "offers",
    "id": "id",
    "attributes": {
      "status": "draft",
      "release-date": "2024-08-25",
      "preorder-date": "2024-08-25",
      "pitch-date": "2024-08-25",
      "is-default": true,
      "usage": "usage",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "subgenre": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "subgenre2": {
        "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"
        }
      },
      "track-price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "track-offers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Get offer details

GET

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

/offers/{id}

Get offer details › path Parameters

id

string · required

Resource ID

Get offer details › Responses

Successful response

object

object[]

Related resources included in the response

object

Delete an offer

DELETE

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

/offers/{id}

Delete an offer › path Parameters

id

string · required

Resource ID

Delete an offer › Responses

Offer deleted successfully

No data returned

Update an offer

PATCH

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

/offers/{id}

Update an existing release configuration.

Important notes:

Leave the dsp-upload-identifications relationship empty if you want to create a default offer on a product
The track-price-code attribute is a DistributorPriceCode object with a is-track-price attribute set to true
Find more details on how to provide the options attribute in the DSP Upload Identifications section

Update an offer › path Parameters

id

string · required

Resource ID

Update an offer › Request Body

object · required

Update an offer › Responses

Offer updated successfully

object

object[]

Related resources included in the response

object

PATCH/offers/{id}

curl --request PATCH \
  --url https://api.idol.io/api/v2/offers/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "offers",
    "id": "id",
    "attributes": {
      "status": "draft",
      "release-date": "2024-08-25",
      "preorder-date": "2024-08-25",
      "pitch-date": "2024-08-25",
      "is-default": true,
      "usage": "usage",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "subgenre": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "subgenre2": {
        "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"
        }
      },
      "track-price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "track-offers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "offers",
    "id": "id",
    "attributes": {
      "status": "draft",
      "release-date": "2024-08-25",
      "preorder-date": "2024-08-25",
      "pitch-date": "2024-08-25",
      "is-default": true,
      "usage": "usage",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "subgenre": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "subgenre2": {
        "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"
        }
      },
      "track-price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "track-offers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Track Videos Track Offers

Labelcamp API v2

Offers

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

Release configurations including release dates, pricing, territories, and platform selections. Each product can have multiple offers for different markets or release windows.

List offers

GET

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

/offers

Retrieve release configurations

List 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[product-id]

string

List offers › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create an offer

POST

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

/offers

Create a new release configuration.

Important notes:

Leave the dsp-upload-identifications relationship empty if you want to create a default offer on a product
The track-price-code attribute is a DistributorPriceCode object with a is-track-price attribute set to true
Find more details on how to provide the options attribute in the DSP Upload Identifications section

Create an offer › Request Body

object · required

Create an offer › Responses

Offer created successfully

object

object[]

Related resources included in the response

object

POST/offers

curl --request POST \
  --url https://api.idol.io/api/v2/offers \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "offers",
    "id": "id",
    "attributes": {
      "status": "draft",
      "release-date": "2024-08-25",
      "preorder-date": "2024-08-25",
      "pitch-date": "2024-08-25",
      "is-default": true,
      "usage": "usage",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "subgenre": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "subgenre2": {
        "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"
        }
      },
      "track-price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "track-offers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "offers",
    "id": "id",
    "attributes": {
      "status": "draft",
      "release-date": "2024-08-25",
      "preorder-date": "2024-08-25",
      "pitch-date": "2024-08-25",
      "is-default": true,
      "usage": "usage",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "subgenre": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "subgenre2": {
        "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"
        }
      },
      "track-price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "track-offers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Get offer details

GET

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

/offers/{id}

Get offer details › path Parameters

id

string · required

Resource ID

Get offer details › Responses

Successful response

object

object[]

Related resources included in the response

object

Delete an offer

DELETE

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

/offers/{id}

Delete an offer › path Parameters

id

string · required

Resource ID

Delete an offer › Responses

Offer deleted successfully

No data returned

Update an offer

PATCH

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

/offers/{id}

Update an existing release configuration.

Important notes:

Leave the dsp-upload-identifications relationship empty if you want to create a default offer on a product
The track-price-code attribute is a DistributorPriceCode object with a is-track-price attribute set to true
Find more details on how to provide the options attribute in the DSP Upload Identifications section

Update an offer › path Parameters

id

string · required

Resource ID

Update an offer › Request Body

object · required

Update an offer › Responses

Offer updated successfully

object

object[]

Related resources included in the response

object

PATCH/offers/{id}

curl --request PATCH \
  --url https://api.idol.io/api/v2/offers/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "offers",
    "id": "id",
    "attributes": {
      "status": "draft",
      "release-date": "2024-08-25",
      "preorder-date": "2024-08-25",
      "pitch-date": "2024-08-25",
      "is-default": true,
      "usage": "usage",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "subgenre": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "subgenre2": {
        "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"
        }
      },
      "track-price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "track-offers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "offers",
    "id": "id",
    "attributes": {
      "status": "draft",
      "release-date": "2024-08-25",
      "preorder-date": "2024-08-25",
      "pitch-date": "2024-08-25",
      "is-default": true,
      "usage": "usage",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "subgenre": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "subgenre2": {
        "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"
        }
      },
      "track-price-code": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "track-offers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Track Videos Track Offers