Brand Relationship
POST
Create Brand Relationship(s)
https://api.moltin.com/v2/products/:productId/relationships/brands
Create a Product relationship to one or more Brands. If any relationships already exist, the ones made in the request are added to them.
Path Parameters:
Name | Required | Type | Description |
---|---|---|---|
productId | Required | string | The ID of the product you want to relate to the brand(s). |
Headers:
Name | Required | Type | Description |
---|---|---|---|
Authorization | Required | string | The Bearer used to access the API. |
Body:
Name | Required | Type | Description |
---|---|---|---|
data[].type | Required | string | Represents the type of object (should be brand). |
data[].id | Required | string | The ID of the brand. |
200 OK
{
"data": [
{
"type": "brand",
"id": "d1e04526-7870-469c-a940-8f3033893084"
}
]
}
curl -X POST https://api.moltin.com/v2/products/:productID/relationships/brands \
-H "Authorization: Bearer XXXX" \
-H "Content-Type: application/json" \
-d $'{
"data": [
{
"type": "brand",
"id": "8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c"
}
]
}'
const MoltinGateway = require('@moltin/sdk').gateway
const Moltin = MoltinGateway({
client_id: 'X',
client_secret: 'X'
})
const productId = 'XXXX'
const brandIds = [
'8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c'
]
Moltin.Products.CreateRelationships(productId, 'brand', brandIds).then((relationships) => {
// Do something
})
PUT
Update Brand Relationship(s)
https://api.moltin.com/v2/products/:productId/relationships/brands
Replace the relationships between a Product and a Brand. Unlike a POST
to this endpoint, a PUT
overrides any existing relationships.
Path Parameters:
Name | Required | Type | Description |
---|---|---|---|
productId | Required | string | The ID of the product you want to relate to the brand(s). |
Headers:
Name | Required | Type | Description |
---|---|---|---|
Authorization | Required | string | The Bearer token used to access the API. |
Body:
Name | Required | Type | Description |
---|---|---|---|
data[].type | Required | string | Represents the type of object (should be brand). |
data[].id | Required | string | The ID of the brand. |
200 OK
{
"data": [
{
"type": "brand",
"id": "0af10e37-066a-47a9-ad14-cc17eb31eed4"
}
]
}
curl -X PUT https://api.moltin.com/v2/products/:productId/relationships/brands \
-H "Authorization: Bearer XXXX" \
-H "Content-Type: application/json" \
-d $'{
"data": [
{
"type": "brand",
"id": "8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c"
}
]
}'
const MoltinGateway = require('@moltin/sdk').gateway
const Moltin = MoltinGateway({
client_id: 'X',
client_secret: 'X'
})
const productId = 'XXXX'
const brandIds = [
'8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c'
]
Moltin.Products.UpdateRelationships(productId, 'brand', brandIds).then((relationships) => {
// Do something
})
DELETE
Delete Brand Relationship(s)
https://api.moltin.com/v2/products/:productId/relationships/brands
Remove a relationship between a Product and Brand(s). This deletes the relationships specified in the payload.
Path Parameters:
Name | Required | Type | Description |
---|---|---|---|
productId | Required | string | The iID of the product you want to relate to the brand. |
Headers:
Name | Required | Type | Description |
---|---|---|---|
Authorization | Required | string | The Bearer token used to access the API. |
Body:
Name | Required | Type | Description |
---|---|---|---|
data[].type | Required | string | Represents the type of object (should be brand). |
data[].id | Required | string | The ID of the brand. |
204 No Content
curl -X DELETE https://api.moltin.com/v2/products/:productId/relationships/brands \
-H "Authorization: Bearer XXXX" \
-H "Content-Type: application/json" \
-d $'{
"data": [
{
"type": "brand",
"id": "8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c"
}
]
}'
const MoltinGateway = require('@moltin/sdk').gateway
const Moltin = MoltinGateway({
client_id: 'X',
client_secret: 'X'
})
const productId = 'XXXX'
const brandIds = [
'8a43aea7-79f0-4bcf-9bc8-a0f5d3d3642c'
]
Moltin.Products.DeleteRelationships(productId, 'brand', brandIds).then((relationships) => {
// Do something
})