File Relationships

Create File Relationship(s)

POST https://api.moltin.com/v2/products/:productId/relationships/files

Create a product relationship to one or more Files. If any relationships already exist, the one's made in the request will be added to them.

Path Parameters

Name	Type	Description
productId	string	The ID of the product you wish to relate to the file(s).

Headers

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

Request Body

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

200

{
    "data": [
        {
            "type": "file",
            "id": "2c51711-35f9-403e-aa73-8e6c80c2258b"
        },
        {
          "type": "file",
          "id": "2C090e3c8-0206-4243-9a3b-f28175f7e9de"
        }
    ]
}

cURL

curl -X "POST" https://api.moltin.com/v2/products/:productId/relationships/files \
     -H "Authorization: Bearer XXXX" \
     -H "Content-Type: application/json" \
     -d $'{
      "data": [
        {
          "type": "file",
          "id": "82c51711-35f9-403e-aa73-8e6c80c2258b"
        },
        {
          "type": "file",
          "id": "c090e3c8-0206-4243-9a3b-f28175f7e9de"
        }
      ]
    }'

JavaScript SDK

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

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

const productId = 'XXXX'

const fileIds = [
    '82c51711-35f9-403e-aa73-8e6c80c2258b',
    'c090e3c8-0206-4243-9a3b-f28175f7e9de'
]

Moltin.Products.CreateRelationships(productId, 'file', fileIds).then((relationships) => {
  // Do something
})

Update File Relationship(s)

PUT https://api.moltin.com/v2/products/:productId/relationships/file

Replace the relationships between a Product and a File. Unlike a POST to this endpoint, a PUT overrides any existing relationships.

Path Parameters

Name	Type	Description
productId	string	The ID of the product you wish to relate to the file(s).

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 file).
data[].id	string	The ID of the file.

200

{
    "data": [
        {
            "type": "file",
            "id": "2c51711-35f9-403e-aa73-8e6c80c2258b"
        }
}

cURL

curl -X "PUT" https://api.moltin.com/v2/products/:productId/relationships/files \
     -H "Authorization: Bearer XXXX" \
     -H "Content-Type: application/json" \
     -d $'{
      "data": [
        {
          "type": "file",
          "id": "82c51711-35f9-403e-aa73-8e6c80c2258b"
        }
      ]
    }

JavaScript SDK

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

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

const productId = 'XXXX'

const fileIds = [
    '82c51711-35f9-403e-aa73-8e6c80c2258b'
]

Moltin.Products.UpdateRelationships(productId, 'file', fileIds).then((relationships) => {
  // Do something
})

Delete File Relationships(s)

DELETE https://api.moltin.com/v2/products/:productId/relationships/file

Remove a relationship between a Product and File(s). This deletes the relationships specified in the payload.

Path Parameters

Name	Type	Description
productId	string	The ID of the product you wish to delete the relationship with file(s).

Headers

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

Request Body

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

200

cURL

curl -X "DELETE" https://api.moltin.com/v2/products/:productId/relationships/files \
     -H "Authorization: Bearer XXXX" \
     -H "Content-Type: application/json" \
     -d $'{
      "data": [
        {
          "type": "file",
          "id": "82c51711-35f9-403e-aa73-8e6c80c2258b"
        }
      ]
    }'

JavaScript SDK

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

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

const productId = 'XXXX'

const fileIds = [
    '82c51711-35f9-403e-aa73-8e6c80c2258b'
]

Moltin.Products.DeleteRelationships(productId, 'file', fileIds).then((relationships) => {
  // Do something
})