Skip to main content
POST
/
product
/
Create Product
curl --request POST \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/product/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "upc": "AB12fdfdg348vvfv67890ff",
  "catalog": "CAT001",
  "title": "Mavins sabi girl",
  "displayArtist": "arya star",
  "mainArtist": [
    "arya star"
  ],
  "type": "Audio",
  "format": "Single",
  "releaseDate": "2022-02-01",
  "mainGenre": [
    "Pop"
  ],
  "subGenre": [
    "Electronic"
  ],
  "label": "Example Label",
  "status": "Live",
  "distribution": "Example Distribution",
  "metadata": {
    "anyitem": "itemvalue",
    "contributor": "your data"
  },
  "artists": [
    "artist-id-1",
    "artist-id-2"
  ],
  "split": [
    {
      "user": "user-id-1",
      "share": 60
    },
    {
      "user": "user-id-2",
      "share": 40
    }
  ]
}'
{
  "id": "77339e1c-f962-447c-bf13-8fc047d4f8d2",
  "TenantId": 2,
  "upc": "AB12fdfdg348vvfv67890ff",
  "isDraft": false,
  "catalog": "CAT001",
  "title": "Mavins sabi girl",
  "displayArtist": "arya star",
  "type": "Audio",
  "format": "Single",
  "releaseDate": "2022-02-01",
  "mainGenre": [
    "Pop"
  ],
  "subGenre": [
    "Electronic"
  ],
  "label": "Example Label",
  "status": "Live",
  "distribution": "Example Distribution",
  "metadata": {
    "anyitem": "itemvalue",
    "contributor": "your data"
  },
  "media": [
    {
      "url": "https://storage.example.com/artwork.jpg",
      "type": "image",
      "name": "artwork"
    }
  ],
  "updatedAt": "2024-12-12T10:30:00.000Z",
  "createdAt": "2024-12-12T10:30:00.000Z",
  "externalId": null,
  "takedownDate": null,
  "mainArtist": [
    "arya star"
  ],
  "otherArtist": null,
  "links": null,
  "contributors": null,
  "extra": null
}

​
POST /product/

This endpoint allows the creation of a new product.

​
Request Body

  • upc (string): The UPC of the product.
  • catalog (string): The catalog of the product.
  • title (string): The title of the product.
  • displayArtist (string): The display artist of the product.
  • mainArtist (string): The main artist of the product.
  • type (string): The type of the product.
  • releaseDate (string): The release date of the product.
  • mainGenre (array of strings): The main genre of the product.
  • subGenre (array of strings): The sub-genre of the product.
  • label (string): The label of the product.
  • status (string): The status of the product.
  • distribution (string): The distribution of the product.
  • artists (array of strings): The artists associated with the product.
  • assets (array of objects): The assets associated with the product.
  • split (array of objects): The split details for the product.
  • metadata (object): Additional metadata for the product.
  • media (object): The media details for the product. (artwork files are always named ‘artwork’ for easy identification)
  • File: Attach the artwork file if the media object is not provided.

​
Authentication

This endpoint requires authentication. Include your bearer token in the Authorization header.

​
Request Body

​
Example Request

{
  "upc": "AB12fdfdg348vvfv67890ff",
  "catalog": "CAT001",
  "title": "Mavins sabi girl",
  "displayArtist": "arya star",
  "mainArtist": [
    "arya star"
  ],
  "type": "Audio",
  "format": "Single",
  "releaseDate": "2022-02-01",
  "mainGenre": [
    "Pop"
  ],
  "subGenre": [
    "Electronic"
  ],
  "label": "Example Label",
  "status": "Live",
  "distribution": "Example Distribution",
  "metadata": {
    "anyitem": "itemvalue",
    "contributor": "your data"
  },
  "artists": [
    "artist-id-1",
    "artist-id-2"
  ],
  "split": [
    {
      "user": "user-id-1",
      "share": 60
    },
    {
      "user": "user-id-2",
      "share": 40
    }
  ]
}

​
Request Schema

FieldTypeRequiredDescription
upcstring✅The UPC of the product
catalogstring❌The catalog of the product
titlestring✅The title of the product
displayArtiststring✅The display artist of the product
mainArtistarray❌The main artist(s) of the product
otherArtistarray❌Other artists associated with the product
typestring✅The type of the product
formatstring❌The format of the product (e.g., Single, Album, EP)
releaseDatestring✅The release date of the product
mainGenrearray✅The main genre(s) of the product
subGenrearray❌The sub-genre(s) of the product
labelstring❌The label of the product
statusstring❌The status of the product
distributionstring❌The distribution of the product
artistsarray❌The artists associated with the product
assetsarray❌The assets associated with the product
splitarray❌The split details for the product
metadataobject❌Additional metadata for the product
mediaobject❌The media details for the product
externalIdstring❌The external ID of the product

​
Responses

​
✅ 201 - Success - Product created

​
⚠️ 400 - Bad Request

​
⚠️ 401 - Unauthorized

​
⚠️ 404 - Not Found

​
❌ 500 - Internal Server Error

​
Tags

Product

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json
​
upc
string
required

The UPC of the product

​
title
string
required

The title of the product

​
displayArtist
string
required

The display artist of the product

​
type
enum<string>
required

The type of the product

Available options:
Audio,
Video
​
releaseDate
string<date>
required

The release date of the product

​
mainGenre
string[]
required

The main genre(s) of the product

​
catalog
string

The catalog of the product

​
mainArtist
string[]

The main artist(s) of the product

​
otherArtist
string[]

Other artists associated with the product

​
format
string

The format of the product (e.g., Single, Album, EP)

​
subGenre
string[]

The sub-genre(s) of the product

​
label
string

The label of the product

​
status
enum<string>

The status of the product

Available options:
Draft,
Live,
Scheduled,
Taken Down
​
distribution
string

The distribution of the product

​
artists
string[]

The artists associated with the product

​
assets
object[]

The assets associated with the product

​
split
object[]

The split details for the product

​
metadata
object

Additional metadata for the product

​
media
object

The media details for the product

​
externalId
string

The external ID of the product

Response

Success - Product created

​
id
string
​
TenantId
integer
​
upc
string
​
isDraft
boolean
​
catalog
string
​
title
string
​
displayArtist
string
​
type
string
​
format
string
​
releaseDate
string<date>
​
mainGenre
string[]
​
subGenre
string[]
​
label
string
​
status
string
​
distribution
string
​
metadata
object
​
media
object[]
​
updatedAt
string<date-time>
​
createdAt
string<date-time>
​
externalId
string | null
​
takedownDate
string | null
​
mainArtist
string[] | null
​
otherArtist
string[] | null
​
links
object | null
​
contributors
object | null
​
extra
object | null
⌘I