Price List

By using this api, you can view your price lists.

Models

Price List

type PriceList {
  id: ID!
  addProductsAutomatically: Boolean
  currency: String!
  currencyCode: String
  currencySymbol: String
  name: String!
  ruleList: [PriceListRuleList!]
  type: PriceListTypeEnum
}

Fields

idID!required

addProductsAutomaticallyBoolean

currencyString!required

The currency of the product's price list.

currencyCodeString

currencySymbolString

nameString!required

It is the name of the price list of the product.

ruleList[PriceListRuleList!]

typePriceListTypeEnum

Type of price price list

Queries

List Price Lists

listPriceList(
  id: StringFilterInput
): [PriceList!]!

Arguments

idStringFilterInput

Return Type

PriceListPriceList

Examples

Retrieves a list of price lists

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":"{ listPriceList { id name } }"}'

NODE.JS

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

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": {
    "listPriceList": [
      {
        "id": "a8befae6-2cb9-487a-bd7f-5e0bfff3676b",
        "name": "Price list name"
      }
    ]
  }
}