ProductBrand

By using this api, you can manage brands of your products.

Models

ProductBrand

type ProductBrand {
  id: ID!
  description: String
  imageId: String
  metaData: HTMLMetaData
  name: String!
  orderType: CategoryProductsOrderTypeEnum
  salesChannelIds: [String!]
  translations: [ProductBrandTranslation!]
}

Fields

idID!required

descriptionString

The description of the product's brand.

imageIdString

The image information of the product's brand.

metaDataHTMLMetaData

It is the metadata information of the product brand.

nameString!required

The name of the product's brand.

orderTypeCategoryProductsOrderTypeEnum

salesChannelIds[String!]

It is the information of which sales channel the product brand is in.

translations[ProductBrandTranslation!]

It is the translation information of the product brand.

ProductBrandTranslation

type ProductBrandTranslation {
  description: String
  locale: String!
  name: String
}

Fields

descriptionString

It is the description information of the translation.

localeString!required

It is the name information of the translation.

nameString

It is the information in which language the translation is saved.

Queries

List Product Brands

Using this api, you can view the brands of products. Search applies to following fields: name

listProductBrand(
  id: StringFilterInput
  name: StringFilterInput
  search: String
  updatedAt: DateFilterInput
): [ProductBrand!]!

Arguments

idStringFilterInput

nameStringFilterInput

You can filter by product brand name.

searchString

Some listing APIs have searchable fields. You can search in these fields as you wish. For example, in an API; Let the searchableFields :['name', 'description']. If we send search: AAA as input in args, it will return records with 'AAA' in both the name and description fields.

updatedAtDateFilterInput

Return Type

ProductBrandProductBrand

Mutations

Save Product Brand

Using this api, you can update the brands of products.

saveProductBrand(
  input: ProductBrandInput!
): ProductBrand!

Arguments

inputProductBrandInput!required

Return Type

ProductBrandProductBrand

Delete Product Brand List

Using this api, you can delete the brands of products.

deleteProductBrandList(
  idList: [String!]!
): Boolean!

Arguments

idList[String!]!required

Return Type

BooleanBoolean

The Boolean scalar type represents true or false.

Examples

Retrieves a list of brands

BASH

curl --location --request POST 'https://api.myikas.com/api/v1/admin/graphql' \
      --header 'Content-Type: application/json' \
      --header 'Authorization: Bearer <your_access_token>' \
      --data-raw '{"query":"{ listProductBrand { id name createdAt } }"}'

NODE.JS

const axios = require('axios');
const data = {"query":`{
     listProductBrand {
        id
        name
        createdAt
     }
   }
`};

const config = {
  method: 'POST',
  url: 'https://api.myikas.com/api/v1/admin/graphql',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer your_token'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  if (error.response) {
    console.log(JSON.stringify(error.response.data));
  }
});

Response

{
  "data": {
    "listProductBrand": [
      {
        "id": "a8befae6-2cb9-487a-bd7f-5e0bfff3676b",
        "name": "Brand name",
        "createdAt": 1634019877744
      }
    ]
  }
}