itemImageRegister Mutation

Description

Registers an uploaded image for an item after it has been uploaded using the signed URL from itemImageSignedUrl.

mutation itemImageRegister(
  $itemRef: ID!
  $filename: String!
  $key: String!
  $alternative: Boolean!
  $index: Int
) {
  itemImageRegister(
    itemRef: $itemRef
    filename: $filename
    key: $key
    alternative: $alternative
    index: $index
  ) {
    _id
    id
    type
    incId
    uniqueId
    oldId
    created
    modified
    seo {
      index
      description
      slug
      title
    }
    isForbiddenForSale
    logs {
      action
      description
      date
      ip
    }
    handle
    path
    uri
    wants
    bitly
    descriptions {
      main
    }
    listings {
      _id
      id
      status
      comments
      privateComments
      location
      discogsId
      taxDefinition
      preventDiscogsListing
      readOnly
      onePerCustomer
      supplierCode
      sku
      barcode
      posted
      available
      preOrder
      categories
      archived
      secondHand
    }
    data {
      id
      assetLink
      thumb
      title
      discogsId
      country
      releaseDate
      weight
      genres
      year
      styles
      manufacturer
      cat
      type
      subtitle
      authors
      publisher
      publishedDate
      pageCount
      categories
      maturityRating
      language
      search
      format
    }
  }
}

Variables

{
    "itemRef": "e7bae2cc11368d9032e9e5d6",
    "filename": "example.jpg",
    "key": "key",
    "alternative": true,
    "index": 42
}

Response

{
    "itemImageRegister": {
        "_id": "f13d1c4c9c14ad43947b9da9",
        "id": 1.23,
        "type": "ReleaseItem",
        "incId": 1.23,
        "uniqueId": "example",
        "oldId": 1.23,
        "created": 1742943161877,
        "modified": 1747104386069,
        "seo": {
            "index": true,
            "description": "example",
            "slug": "example",
            "title": "example"
        },
        "isForbiddenForSale": true,
        "logs": [
            {
                "action": "example",
                "description": "example",
                "date": 1714354651872,
                "ip": "example"
            }
        ],
        "handle": "example",
        "path": "/release/1763553751/release-artist-release-name",
        "uri": "https://www.my-common-ground-store.com/release/1763553751/release-artist-release-name",
        "wants": 42,
        "bitly": "example",
        "descriptions": {
            "main": "example"
        },
        "listings": [
            {
                "_id": "63015e52007c1b9afbd201fc",
                "id": 1.23,
                "status": "example",
                "comments": "example",
                "privateComments": "example",
                "location": "example",
                "discogsId": 987654321,
                "taxDefinition": "example",
                "preventDiscogsListing": true,
                "readOnly": true,
                "onePerCustomer": true,
                "supplierCode": "example",
                "sku": "example",
                "barcode": "example",
                "posted": 1717178917855,
                "available": 1749161752364,
                "preOrder": true,
                "categories": [
                    "example"
                ],
                "archived": true,
                "secondHand": true
            }
        ],
        "data": {
            "id": 1.23,
            "assetLink": "example",
            "thumb": "example",
            "title": "example",
            "discogsId": 987654321,
            "country": "example",
            "releaseDate": 1710580954863,
            "weight": 1.23,
            "genres": [
                "example"
            ],
            "year": 42,
            "styles": [
                "example"
            ],
            "manufacturer": "example",
            "cat": "example",
            "type": "example",
            "subtitle": "example",
            "authors": [
                "example"
            ],
            "publisher": "example",
            "publishedDate": 1736196161750,
            "pageCount": 42,
            "categories": [
                "example"
            ],
            "maturityRating": "example",
            "language": "example",
            "search": "example",
            "format": "example"
        }
    }
}

Arguments

Name	Type	Description
itemRef	ID!	Reference ID of the item to register the image for.
filename	String!	Filename of the uploaded image.
key	String!	Storage key returned from the signed URL upload.
alternative	Boolean!	Whether this is an alternative image variant.
index	Int	Index position for the image in the item's image array.

Returns

Item!