Main Image Relationship

Create a Main Image Relationship

POST https://api.moltin.com/v2/products/:productId/relationships/main-image

Create a Product relationship to a single File, which can be used as a main_image. You can only have one main image relationship.

Path Parameters

Name	Type	Description
productId	string	The ID of the product you wish to relate to the image.

Headers

Name	Type	Description
Authorization	string	The Bearer token used to access the API.

Request Body

Name	Type	Description
data[].type	string	Represents the type of the object (should be main_image).
data[].id	string	The ID of the image.

200

{
    "data": [
        {
            "type": "main_image",
            "id": "8df7738-febe-4987-bc0e-b857297b30e9"
        }
    ]
}

cURL

curl -X "POST" https://api.moltin.com/v2/products/:productId/relationships/main-image \
     -H "Authorization: Bearer XXXX" \
     -H "Content-Type: application/json" \
     -d $'{
      "data": {
        "type": "main_image",
        "id": "98df7738-febe-4987-bc0e-b857297b30e9"
      }
    }'

JavaScript SDK

const MoltinGateway = require('@moltin/sdk').gateway

const Moltin = MoltinGateway({
  client_id: 'X',
  client_secret: 'X'
})

const productId = 'XXXX'

const imageIds = [
  'e9737dc6-876a-4eab-b3b7-af62a1999123'
]

Moltin.Products.CreateRelationships(productId, 'main-image', imageIds).then((relationships) => {
  // Do something
})

Update a Main Image Relationship

PUT https://api.moltin.com/v2/products/:productId/relationships/main-image

Update the main image relationship. This will replace any currently related image.

Path Parameters

Name	Type	Description
productId	string	The ID of the product you wish to relate to the image.

Headers

Name	Type	Description
Authorization	string	The Bearer token used to access the API.

Request Body

Name	Type	Description
data[].type	string	Represents the type of object (should be main_image)
data[].id	string	The ID of the image.

200

{
    "data": [
        {
            "type": "main_image",
            "id": "e9737dc6-876a-4eab-b3b7-af62a1999123"
        }
    ]
}

cURL

curl -X "PUT" https://api.moltin.com/v2/products/:productId/relationships/main-image \
     -H "Authorization: Bearer XXXX" \
     -H "Content-Type: application/json" \
     -d $'{
      "data": {
        "type": "main_image",
        "id": "e9737dc6-876a-4eab-b3b7-af62a1999123"
      }
    }'

JavaScript SDK

const MoltinGateway = require('@moltin/sdk').gateway

const Moltin = MoltinGateway({
  client_id: 'X',
  client_secret: 'X'
})

const productId = 'XXXX'

const imageIds = [
  'e9737dc6-876a-4eab-b3b7-af62a1999123'
]

Moltin.Products.UpdateRelationships(productId, 'main-image', imageIds).then((relationships) => {
  // Do something
})

Delete a Main Image Relationship

DELETE https://api.moltin.com/v2/products/:productId/relationships/main-image

Delete the main image relationship. This will remove the related main image.

Path Parameters

Name	Type	Description
productId	string	The ID of the product you wish to remove the relationship for.

Headers

Name	Type	Description
Authorization	string	The Bearer token used to access the API.

Request Body

Name	Type	Description
data[].type	string	Represents the type of object (should be main_image).
data[].id	string	The ID of the image.

200

cURL

curl -X "DELETE" https://api.moltin.com/v2/products/:productId/relationships/main-image \
     -H "Authorization: Bearer XXXX" \
     -H "Content-Type: application/json" \
     -d $'{
      "data": {
        "type": "main_image",
        "id": "e9737dc6-876a-4eab-b3b7-af62a1999123"
      }
    }'

JavaScript SDK

const MoltinGateway = require('@moltin/sdk').gateway

const Moltin = MoltinGateway({
  client_id: 'X',
  client_secret: 'X'
})

const productId = 'XXXX'

const imageIds = [
  'e9737dc6-876a-4eab-b3b7-af62a1999123'
]

Moltin.Products.DeleteRelationships(productId, 'main-image', imageIds).then((relationships) => {
  // Do something
})