ikas

https://ikas.dev
Admin
ikas is a development platform that enables developers to build apps and themes for thousands of...
Tokens:288,479
Snippets:2,434
Trust Score:6.8
Update:1 day ago
Show doc for...
Tokens:
Raw
### Install dependencies and run ikas theme with yarn

Source: https://ikas.dev/docs/theme/getting-started/introduction

After copying your theme config into config.json, navigate to your theme folder and run these commands. Note that only yarn is currently supported for installing dependencies and running the theme.

```undefined
cd your-theme
yarn install
yarn dev
```

--------------------------------

### Responsive layout example with 16:9 aspect ratio

Source: https://ikas.dev/docs/theme/prop-types/image

Example of using layout="responsive" with width={16} and height={9} to create a 16:9 aspect ratio space. The objectFit="cover" makes the image cover the space, and sizes="500px" improves loading performance.

```tsx
<Image image={image} layout="responsive" width={16} height={9} sizes="500px" objectFit="cover" />
```

--------------------------------

### Order API Response Example

Source: https://ikas.dev/docs/api/admin-api/orders

An example of the JSON response structure returned by the addOrderInvoice mutation.

```json
{
  "data": {
    "addOrderInvoice": {
      "billingAddress": {
        "addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
        "addressLine2": null,
        "city": {
          "code": null,
          "id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
          "name": "Ankara"
        },
        "company": null,
        "country": {
          "code": "TUR",
          "id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
          "name": "Turkey"
        },
        "district": {
          "code": null,
          "id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
          "name": "Çankaya"
        },
        "firstName": "ikas",
        "identityNumber": null,
        "isDefault": false,
        "lastName": "docs",
        "phone": "+905555555555",
        "postalCode": null,
        "state": {
          "code": null,
          "id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
          "name": "Default"
        },
        "taxNumber": null,
        "taxOffice": null
      },
      "cancelReason": null,
      "cancelledAt": null,
      "clientIp": "176.42.29.28",
      "createdAt": 1637759203328,
      "currencyCode": "TRY",
      "currencyRates": [],
      "customer": {
        "email": "ikas@ikas.com",
        "firstName": "ikas",
        "id": "fa8b6fbc-210d-4488-88ab-a7bea0a2648b",
        "identityNumber": null,
        "lastName": "docs",
        "phone": null
      },
      "deleted": false,
      "host": "apidocs.myikas.dev"
```

--------------------------------

### cancelFulfillment Response Example

Source: https://ikas.dev/docs/api/admin-api/orders

Example JSON response from the cancelFulfillment mutation, showing the structure of the returned fulfillment data.

```json
{
  "data": {
    "cancelfulfillment": {
      "billingAddress": {
        "addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
        "addressLine2": null,
        "city": {
          "code": null,
          "id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
          "name": "Ankara"
        },
        "company": null,
        "country": {
          "code": "TUR",
          "id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
          "name": "Turkey"
        },
        "district": {
          "code": null,
          "id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
          "name": "Çankaya"
        },
        "firstName": "ikas",
        "identityNumber": null,
        "isDefault": false,
        "lastName": "docs",
        "phone": "+905555555555",
        "postalCode": null,
        "state": {
          "code": null,
          "id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
          "name": "Default"
        },
        "taxNumber": null,
        "taxOffice": null
      },
      "cancelReason": null,
      "cancelledAt": null,
      "clientIp": "176.42.29.28",
      "createdAt": 1637759203328,
      "currencyCode": "TRY",
      "currencyRates": [],
      "customer": {
        "email": "ikas@ikas.com",
        "firstName": "ikas",
        "id": "fa8b6fbc-210d-4488-88ab-a7bea0a2648b",
        "identityNumber": null,
        "lastName": "docs",
        "phone": null
      },
      "deleted": false,
      "host": "apidocs.myikas.dev",
      "id": "84ffbfd2-c92c-4f22-9675-8d3edb7a9084",
      "merchantId": "75d8a449-2feb-4230-9eb4-9014673324d5",
      "note": null,
      "orderAdjustments": [
        {
          "amount": 149.5,
          "amountType": "AMOUNT",
          "campaignId": "653aa7c2-4d3c-42ba-aba9-94060f52660d",
          "couponId": null,
          "name": "Kargo Bypass",
          "order": 1,
          "type": "DECREMENT"
        }
      ],
      "orderLineItems": [
        {
          "createdAt": 1638196461905,

```

--------------------------------

### addOrderInvoice Response Example

Source: https://ikas.dev/docs/api/admin-api/orders

Example JSON response from the addOrderInvoice mutation, showing the structure of the returned order invoice data.

```json
{
  "data": {
    "addOrderInvoice": {
      "billingAddress": {
        "addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
        "addressLine2": null,
        "city": {
          "code": null,
          "id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
          "name": "Ankara"
        },
        "company": null,
        "country": {
          "code": "TUR",
          "id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
          "name": "Turkey"
        },
        "district": {
          "code": null,
          "id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
          "name": "Çankaya"
        },
        "firstName": "ikas",
        "identityNumber": null,
        "isDefault": false,
        "lastName": "docs",
        "phone": "+905555555555",
        "postalCode": null,
        "state": {
          "code": null,
          "id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
          "name": "Default"
        },
        "taxNumber": null,
        "taxOffice": null
      },
      "cancelReason": null,
      "cancelledAt": null,
      "clientIp": "176.42.29.28",
      "createdAt": 1637759203328,
      "currencyCode": "TRY",
      "currencyRates": [],
      "customer": {
        "email": "ikas@ikas.com",
        "firstName": "ikas",
        "id": "fa8b6fbc-210d-4488-88ab-a7bea0a2648b",
        "identityNumber": null,
        "lastName": "docs",
        "phone": null
      },
      "deleted": false,
      "host": "apidocs.myikas.dev",
      "id": "84ffbfd2-c92c-4f22-9675-8d3edb7a9084",
      "merchantId": "75d8a449-2feb-4230-9eb4-9014673324d5",
      "note": null,
      "orderAdjustments": [
        {
          "amount": 149.5,
          "amountType": "AMOUNT",
          "campaignId": "653aa7c2-4d3c-42ba-aba9-94060f52660d",
          "couponId": null,
          "name": "Kargo Bypass",
          "order": 1,
          "type": "DECREMENT"
        }
      ],
      "orderLineItems": [
        {
          "createdAt": 1638189270536,
          "currencyCode": "TRY",
          "deleted": false,
          "discount": null,
          "discountPrice": null,
          "finalPrice": 149.5,
          "id": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
          "originalOrderLineItemId": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
          "price": 299,
          "quantity": 1,
          "status": "FULFILLED",
          "statusUpdatedAt": null,
          "stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
          "taxValue": null,
          "updatedAt": 1638189270536,
          "variant": {
            "barcodeList": [],
            "id": "bd9b2bd8-0110-4ded-84c0-b8298332e469",
            "mainImageId": "e047ce73-8b77-40f0-8f13-eff9c2b05f4f",
            "name": "ikas Ürünü Siyah Kılıf - iPhone 11 Pro Max Kılıf Silikon"
          }
        }
      ]
    }
  }
}
```

--------------------------------

### Get Access Token with Node.js

Source: https://ikas.dev/docs/api/getting-started/authentication

Node.js example using axios to POST to the ikas OAuth token endpoint with client_credentials grant. Requires your Client ID and Client Secret. Logs the response data or error.

```javascript
var axios = require("axios").default;
var options = {
  method: 'POST',
  url: 'https://<your_store_name>.myikas.com/api/admin/oauth/token',
  headers: {
    'content-type': 'application/x-www-form-urlencoded'
  },
  data: {
    grant_type: 'client_credentials',
    client_id: '<your_client_id>',
    client_secret: '<your_client_secret>'
  }
};
axios.request(options)
  .then((response) => {
    console.log(response.data);
  }).catch((error) => {
    console.error(error);
  });
```

--------------------------------

### Response for getSalesChannel

Source: https://ikas.dev/docs/api/admin-api/sales-channels

Example JSON response returned by the getSalesChannel query, shown as an empty object.

```json
{}
```

--------------------------------

### Response for listStorefront query

Source: https://ikas.dev/docs/api/admin-api/storefronts

Example JSON response returned by the listStorefront query, containing an array of storefront objects with id and name.

```json
{
  "data": {
    "listStorefront": [
      {
        "id": "78c58c28-d191-4ab1-a8df-4b23283a7fb4",
        "name": "Storefront's Name"
      }
    ]
  }
}
```

--------------------------------

### Response for listProductStockLocation

Source: https://ikas.dev/docs/api/admin-api/stock-locations

Example JSON response showing a list of product stock locations with fields like id, productId, stockCount, and stockLocationId.

```json
{
  "data": {
    "listProductStockLocation": {
      "count": 2,
      "hasNext": false,
      "limit": 200,
      "page": 1,
      "data": [
        {
          "createdAt": 1626700964797,
          "deleted": false,
          "id": "122fa5fa-2271-4f90-a26a-fb67539b788b",
          "productId": "08665baf-a982-4042-9d08-01b0ea21a2eb",
          "stockCount": 0,
          "stockLocationId": "1712d863-82f8-465c-a096-9d599ff94d37",
          "updatedAt": 1626701111813,
          "variantId": "40c802f1-6755-420a-8817-2976bbcfacde"
        },
        {
          "createdAt": 1626700701526,
          "deleted": false,
          "id": "b3f265f5-6588-4b67-aaae-e2d722589541",
          "productId": "08665baf-a982-4042-9d08-01b0ea21a2eb",
          "stockCount": 0,
          "stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
          "updatedAt": 1626855914363,
          "variantId": "40c802f1-6755-420a-8817-2976bbcfacde"
        }
      ]
    }
  }
}
```

--------------------------------

### Response for List Categories

Source: https://ikas.dev/docs/api/admin-api/category

Example JSON response from the listCategory query, showing a list of product attributes with id, name, and createdAt.

```json
{
  "data": {
    "listProductAttribute": {
      "data": [
        {
          "id": "a8befae6-2cb9-487a-bd7f-5e0bfff3676b",
          "name": "Category name",
          "createdAt": 1634019877744
        }
      ]
    }
  }
}
```

--------------------------------

### Response for addCustomTimelineEntry

Source: https://ikas.dev/docs/api/admin-api/timeline

Example JSON response showing a successful addCustomTimelineEntry call returning true.

```json
{
  "data": {
    "addCustomTimelineEntry": true
  }
}
```

--------------------------------

### Response for listProductAttribute query

Source: https://ikas.dev/docs/api/admin-api/product-attributes

Example JSON response returned by the listProductAttribute query, containing an array of product attributes with id, name, and createdAt.

```json
{
  "data": {
    "listProductAttribute": [
      {
        "id": "a8befae6-2cb9-487a-bd7f-5e0bfff3676b",
        "name": "Product attribute name",
        "createdAt": 1634019877744
      }
    ]
  }
}
```

--------------------------------

### Me Query - Response

Source: https://ikas.dev/docs/api/admin-api/merchant

Example JSON response from the Me query, showing the structure of the returned merchant data.

```json
{
  "data": {
    "me": {
      "addedDate": 1637050545408,
      "email": null,
      "id": "92be8a2f-47e4-471b-8c17-bc17d3de90fe",
      "name": null,
      "partnerId": "02032105-e67f-42e9-aaff-32b608c500f9",
      "salesChannelId": null,
      "scope": "read_customers,write_customers",
      "scopes": null,
      "storeAppId": "68e29a17-ae29-484b-9e94-839a108dcf57",
      "supportsMultipleInstallation": null
    }
  }
}
```

--------------------------------

### Create webhook response

Source: https://ikas.dev/docs/api/admin-api/webhooks

Example JSON response for the saveWebhook mutation, showing the created webhook object with its fields.

```json
{
  "data": {
    "saveWebhook": [
      {
        "createdAt": 1637328436979,
        "deleted": false,
        "endpoint": "https://www.google.com/",
        "id": "e96e7c71-3521-43be-b905-1a607a1e4fa5",
        "scope": "store/customer/created",
        "updatedAt": 1637764765953
      }
    ]
  }
}
```

--------------------------------

### Response for listProductTag query

Source: https://ikas.dev/docs/api/admin-api/product-tag

Example JSON response returned by the listProductTag query, containing an array of product tags with id and name fields.

```json
{
  "data": {
    "listProductTag": [
      {
        "id": "a8befae6-2cb9-487a-bd7f-5e0bfff3676b",
        "name": "Tag name"
      }
    ]
  }
}
```

--------------------------------

### Get Authorized App

Source: https://ikas.dev/docs/api/admin-api/merchant

Retrieves information about an authorized application installed for the merchant, including installation details and scope.

```APIDOC
## Get Authorized App

### Description
Retrieves information about an authorized application installed for the merchant, including installation details and scope.

### Query
```graphql
query GetAuthorizedApp {
  authorizedApp {
    id
    addedDate
    partnerId
    salesChannelId
    scope
    storeAppId
    supportsMultipleInstallation
  }
}
```

### Response Type
`AuthorizedApp`

### Fields
- `id` (ID!) - required - The unique identifier of the authorized app.
- `addedDate` (Timestamp!) - required - The date the app was added.
- `partnerId` (String!) - required - The partner ID associated with the app.
- `salesChannelId` (String) - The id of the sales channel owned by the merchant.
- `scope` (String!) - required - The scope of the app.
- `storeAppId` (String!) - required - The application's id in the store.
- `supportsMultipleInstallation` (Boolean) - Indicates if the merchant can install more than one application. If `true`, merchant can add more than one application.
```

--------------------------------

### Get Authorized App - Response

Source: https://ikas.dev/docs/api/admin-api/merchant

Example JSON response for the getAuthorizedApp query, showing app authorization details including timestamps, IDs, and scope.

```json
{
  "data": {
    "getAuthorizedApp": {
      "addedDate": 1637050545408,
      "createdAt": 1637050545409,
      "deleted": false,
      "id": "92be8a2f-47e4-471b-8c17-bc17d3de90fe",
      "partnerId": "02032105-e67f-42e9-aaff-32b608c500f9",
      "salesChannelId": null,
      "scope": "read_customers,write_customers",
      "storeAppId": "68e29a17-ae29-484b-9e94-839a108dcf57",
      "supportsMultipleInstallation": null,
      "updatedAt": 1637050545409
    }
  }
}
```

--------------------------------

### getInitial

Source: https://ikas.dev/docs/theme/api/models/ikas-customer-review-list

Initializes the list and fetches the first page of data.

```APIDOC
## getInitial

### Description
Initializes the list and fetches the first page of data.

### Method
function

### Signature
```typescript
function getInitial(): Promise<void>
```

### Parameters
None

### Returns
Promise<void>
```

--------------------------------

### Retrieve list of products (Node.js axios)

Source: https://ikas.dev/docs/api/admin-api/products

Node.js example using axios to POST the same GraphQL query. Replace 'your_token' with a valid access token.

```javascript
const axios = require('axios');
const data = {"query":`{
     listProduct {
       data {
         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));
  }
});
```

--------------------------------

### Get Merchant Detail - Response

Source: https://ikas.dev/docs/api/admin-api/merchant

Example JSON response for the getMerchant query, showing the merchant's details including email, name, ID, and store name.

```json
{
  "data": {
    "getMerchant": {
      "email": "taylan-app@gmail.com",
      "firstName": "taylan",
      "id": "f2813818-6d01-4f48-b205-a94041ee703d",
      "lastName": "ilkyaz",
      "merchantName": "Taylan İlkyaz",
      "merchantSequence": 310,
      "phoneNumber": null,
      "storeName": "taylan-app"
    }
  }
}
```

--------------------------------

### Using useTranslation hook in a component

Source: https://ikas.dev/docs/theme/translations

Example of using the useTranslation hook from @ikas/storefront to get the t function and access translations. The t function takes a namespace:path string, e.g., 'common:orderDetail.deliveryAddress'.

```tsx
import { useTranslation } from '@ikas/storefront';

const Address = ({ order }: Props) => {
  const { t } = useTranslation();
  return (
    <S.Address>
      <S.DeliveryAddress>{t('common:orderDetail.deliveryAddress')}</S.DeliveryAddress>
      <S.Text>
        <div>
          {order.shippingAddress?.firstName} {order.shippingAddress?.lastName}
        </div>
        <div>{order.shippingAddress?.addressText}</div>
      </S.Text>
    </S.Address>
  );
};
```

--------------------------------

### getInitial

Source: https://ikas.dev/docs/theme/api/models/ikas-customer-review-summary-list

Function to initialize the list and fetch the first page of data.

```APIDOC
## getInitial

### Description
Function to initialize the list and fetch the first page of data.

### Method
function

### Signature
```typescript
function getInitial(): Promise<void>
```

### Parameters
None

### Returns
- **Promise<void>** - Resolves when the initialization is complete.
```

--------------------------------

### Create ikas theme with npx create-ikas-theme@latest

Source: https://ikas.dev/docs/theme/getting-started/introduction

Run this command in a terminal to scaffold a new ikas theme template. Follow the interactive steps to complete the setup.

```bash
npx create-ikas-theme@latest
```

--------------------------------

### Locale file format example (product-detail.json)

Source: https://ikas.dev/docs/theme/translations

JSON structure for a component's locale file. Keys are nested objects; variables are wrapped in {{ }}. The file name must match the component directory name (e.g., product-detail.json).

```json
{
  "detail": {
    "addToCart": {
      "text": "ADD TO CART"
    }
  },
  "settings": {
    "required": "This field is required",
    "minMax": "Must be a minimum of {{min}} characters and a maximum of {{max}} characters",
    "min": "Must be a minimum of {{min}} characters",
    "max": "Must be a minimum of {{max}} characters",
    "selectMinMax": "Minimum {{min}}, maximum {{max}} selections should be made",
    "selectMin": "Minimum {{min}} selections should be made",
    "selectMax": "Maximum {{max}} selections should be made",
    "maxFileSizeInfoText": "You can upload files up to 3 MB in size."
  }
}
```

--------------------------------

### TransactionInstallmentPrice

Source: https://ikas.dev/docs/api/type-definitions/admin-api/objects/transaction-installment-price

GraphQL object type representing installment price details. It includes fields for installment count, installment price, original rate, rate, and total price.

```APIDOC
## TransactionInstallmentPrice

### Description
A GraphQL object type that represents installment price information.

### Type
GraphQL Object

### Fields
- **installmentCount** (Float) - The number of installments.
- **installmentPrice** (Float) - The price per installment.
- **originalRate** (Float) - The original rate.
- **rate** (Float) - The rate.
- **totalPrice** (Float) - The total price.

### Example
```graphql
type TransactionInstallmentPrice {
  installmentCount: Float
  installmentPrice: Float
  originalRate: Float
  rate: Float
  totalPrice: Float
}
```
```

--------------------------------

### login

Source: https://ikas.dev/docs/theme/api/stores/ikas-customer-store

Logs in a customer with email and password.

```APIDOC
## login

### Description
Logs in a customer with email and password.

### Method
async function

### Signature
```typescript
async login(email: string, password: string)
```

### Parameters
- **email** (string) - Required - The customer's email.
- **password** (string) - Required - The customer's password.
```

--------------------------------

### Node.js example for createOrderWithTransactions mutation

Source: https://ikas.dev/docs/api/admin-api/orders

Uses axios to send a GraphQL mutation to create an order with transactions. Includes billing/shipping addresses, order line items, adjustments, and transaction details. Requires the axios library and an access token.

```javascript
const axios = require('axios');
const data = {"mutation":`{
              createOrderWithTransactions(
                    input: {
                      disableAutoCreateCustomer: true
                      order: {
                        billingAddress: {
                          addressLine1: 'ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi'
                          city: { id: '6f9272a3-9924-4223-baf8-9b21c9360f0c', name: 'Ankara' }
                          country: {
                            code: 'TUR'
                            id: 'da8c5f2a-8d37-48a8-beff-6ab3793a1861'
                            name: 'Turkey'
                          }
                          firstName: 'ikas'
                          lastName: 'docs'
                          isDefault: false
                        }
                        currencyCode: 'TRY'
                        orderLineItems: [
                          {
                            price: 299
                            quantity: 1
                            variant: {
                              id: 'bd9b2bd8-0110-4ded-84c0-b8298332e469'
                              name: 'ikas Ürünü Siyah Kılıf - iPhone 11 Pro Max Kılıf Silikon'
                            }
                          }
                        ]
                        customer: { id: 'fa8b6fbc-210d-4488-88ab-a7bea0a2648b' }
                        orderAdjustments: [
                          {
                            amount: 149.5
                            amountType: AMOUNT
                            campaignId: '653aa7c2-4d3c-42ba-aba9-94060f52660d'
                            name: 'Kargo Bypass'
                            order: 1
                            type: DECREMENT
                          }
                        ]
                        salesChannelId: '9fa400f3-fbf1-4ee7-bc26-3cae7f9c3427'
                        shippingAddress: {
                          addressLine1: 'ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi'
                          city: { id: '6f9272a3-9924-4223-baf8-9b21c9360f0c', name: 'Ankara' }
                          country: {
                            code: 'TUR'
                            id: 'da8c5f2a-8d37-48a8-beff-6ab3793a1861'
                            name: 'Turkey'
                          }
                          firstName: 'ikas'
                          lastName: 'docs'
                          isDefault: false
                        }
                        shippingLines: [{ price: 21, title: 'Kkk' }]
                        shippingMethod: SHIPMENT
                      }
                      transactions: [
                        {
                          amount: 149.5
                          paymentGatewayId: 'e3e9f662-511c-11ec-bf63-0242ac130002'
                        }
                      ]
                    }
              ) {billingAddress {
                  addressLine1
                  addressLine2
                  city {
                    code
                    id
                    name
                  }
                  company
                  country {
                    code
                    id
                    iso2
                    iso3
                    name
                  }
                  district {
                    code
                    id
                    name
                  }
                  firstName
                  id
                  identityNumber
                  isDefault
                  lastName
                  phone
                  postalCode
                  state {
                    code
                    id
                    name
                  }
                  taxNumber
                  taxOffice
                }
                branch {
                  id
                  name
                }
                branchSessionId`}
```

--------------------------------

### type SearchProductCampaignBuyXThenGetY

Source: https://ikas.dev/docs/api/type-definitions/admin-api/objects/search-product-campaign-buy-xthen-get-y

GraphQL type definition for a buy X get Y campaign, containing the buy X condition, get Y reward, and maximum usage per order.

```APIDOC
## type SearchProductCampaignBuyXThenGetY

### Description
Represents a buy X get Y campaign in the Admin API.

### Fields
- **buyX** ([SearchProductCampaignBuyX!]) - required - The buy X condition.
- **getY** ([SearchProductCampaignGetY!]) - required - The get Y reward.
- **maxUsagePerOrder** ([Float]) - optional - The maximum usage per order.

### Example
```graphql
type SearchProductCampaignBuyXThenGetY {
  buyX: SearchProductCampaignBuyX!
  getY: SearchProductCampaignGetY!
  maxUsagePerOrder: Float
}
```
```

--------------------------------

### BuyXThenGetYInput

Source: https://ikas.dev/docs/api/type-definitions/admin-api/inputs/buy-xthen-get-yinput

GraphQL input type for Buy X Get Y discount configuration. It contains the buy condition, the get reward, and an optional maximum usage per order.

```APIDOC
## BuyXThenGetYInput

### Description
GraphQL input type for Buy X Get Y discount configuration.

### Type
Input Object

### Fields
- **buyX** ([BuyXInput!](https://ikas.dev/docs/api/type-definitions/admin-api/inputs/buy-xinput)) - Required - The buy condition.
- **getY** ([GetYInput!](https://ikas.dev/docs/api/type-definitions/admin-api/inputs/get-yinput)) - Required - The get reward.
- **maxUsagePerOrder** ([Int](https://ikas.dev/docs/api/type-definitions/admin-api/scalars/int)) - Optional - The maximum usage per order.

```

--------------------------------

### POST getAuthorizedApp

Source: https://ikas.dev/docs/api/admin-api/merchant

Retrieves information about the authorized app installation for the current merchant, including installation dates, scope, and partner details. This query is executed via a POST request to the GraphQL endpoint.

```APIDOC
## POST /api/v1/admin/graphql

### Description
Retrieves information about the authorized app installation for the current merchant, including installation dates, scope, and partner details.

### Method
POST

### Endpoint
https://api.myikas.com/api/v1/admin/graphql

### Parameters
#### Request Body
- **query** (string) - Required - The GraphQL query string. For this operation, the query is: `{ getAuthorizedApp { addedDate createdAt deleted id partnerId salesChannelId scope storeAppId supportsMultipleInstallation updatedAt } }`

### Request Example
```json
{
  "query": "{ getAuthorizedApp { addedDate createdAt deleted id partnerId salesChannelId scope storeAppId supportsMultipleInstallation updatedAt }}"
}
```

### Response
#### Success Response (200)
- **data.getAuthorizedApp.addedDate** (integer) - The timestamp when the app was added.
- **data.getAuthorizedApp.createdAt** (integer) - The timestamp when the app was created.
- **data.getAuthorizedApp.deleted** (boolean) - Indicates if the app is deleted.
- **data.getAuthorizedApp.id** (string) - The unique identifier of the authorized app.
- **data.getAuthorizedApp.partnerId** (string) - The identifier of the partner.
- **data.getAuthorizedApp.salesChannelId** (string or null) - The identifier of the sales channel.
- **data.getAuthorizedApp.scope** (string) - The scope of permissions granted to the app.
- **data.getAuthorizedApp.storeAppId** (string) - The identifier of the store app.
- **data.getAuthorizedApp.supportsMultipleInstallation** (boolean or null) - Indicates if multiple installations are supported.
- **data.getAuthorizedApp.updatedAt** (integer) - The timestamp when the app was last updated.

#### Response Example
```json
{
  "data": {
    "getAuthorizedApp": {
      "addedDate": 1637050545408,
      "createdAt": 1637050545409,
      "deleted": false,
      "id": "92be8a2f-47e4-471b-8c17-bc17d3de90fe",
      "partnerId": "02032105-e67f-42e9-aaff-32b608c500f9",
      "salesChannelId": null,
      "scope": "read_customers,write_customers",
      "storeAppId": "68e29a17-ae29-484b-9e94-839a108dcf57",
      "supportsMultipleInstallation": null,
      "updatedAt": 1637050545409
    }
  }
}
```

```

--------------------------------

### Retrieve list of products (BASH cURL)

Source: https://ikas.dev/docs/api/admin-api/products

Sends a GraphQL query to list products, returning id, name, and createdAt. Requires an access token in the Authorization header.

```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":"{ listProduct { data { id name createdAt } } }"}'
```

--------------------------------

### getCustomerAttributes

Source: https://ikas.dev/docs/theme/api/stores/ikas-customer-store

Gets the customer attributes.

```APIDOC
## getCustomerAttributes

### Description
Gets the customer attributes.

### Method
async function

### Signature
```typescript
async getCustomerAttributes()
```
```

--------------------------------

### ProductOptionFileSettings

Source: https://ikas.dev/docs/api/type-definitions/admin-api/objects/product-option-file-settings

GraphQL type definition for ProductOptionFileSettings, containing fields for allowed file extensions and min/max quantity limits.

```APIDOC
## ProductOptionFileSettings

### Description
Represents file settings for a product option, including allowed file extensions and quantity limits.

### Type
GraphQL Object

### Fields
- **allowedExtensions** ([String!]) - List of allowed file extensions.
- **maxQuantity** (Float) - Maximum quantity allowed.
- **minQuantity** (Float) - Minimum quantity allowed.

### Example
```graphql
type ProductOptionFileSettings {
  allowedExtensions: [String!]
  maxQuantity: Float
  minQuantity: Float
}
```
```

--------------------------------

### Response for listProduct query

Source: https://ikas.dev/docs/api/admin-api/products

Expected JSON response containing a list of products with id, name, and createdAt timestamp.

```json
{
  "data": {
    "listProduct": {
      "data": [
        {
          "id": "a8befae6-2cb9-487a-bd7f-5e0bfff3676b",
          "name": "Product name",
          "createdAt": 1634019877744
        }
      ]
    }
  }
}
```

--------------------------------

### getOrderTransactions

Source: https://ikas.dev/docs/theme/api/stores/ikas-customer-store

Get payment transactions of an order.

```APIDOC
## getOrderTransactions

### Description
Get payment transactions of an order.

### Method
async function

### Signature
```typescript
async getOrderTransactions(params: { checkoutId?: string; id?: string; orderId?: string; } = {})
```

### Parameters
- **params** (object) - Optional - An object containing optional identifiers: `checkoutId`, `id`, or `orderId`.
```

--------------------------------

### getFavoriteProducts

Source: https://ikas.dev/docs/theme/api/stores/ikas-customer-store

Gets the customer's favorite products.

```APIDOC
## getFavoriteProducts

### Description
Gets the customer's favorite products.

### Method
async function

### Signature
```typescript
async getFavoriteProducts()
```
```

--------------------------------

### getOrder

Source: https://ikas.dev/docs/theme/api/stores/ikas-customer-store

Get a specific customer order by id.

```APIDOC
## getOrder

### Description
Get a specific customer order by id.

### Method
async function

### Signature
```typescript
async getOrder(id: string)
```

### Parameters
- **id** (string) - Required - The order id.
```

--------------------------------

### Open Theme Editor URL

Source: https://ikas.dev/docs/theme/getting-started/editor

Use this URL to open the theme editor for your development store. Replace 'dev-your-store' with your actual development store name.

```bash
https://dev-your-store.myikas.com/admin/storefront/partner/theme/edit
```

--------------------------------

### getSalesChannel

Source: https://ikas.dev/docs/api/admin-api/sales-channels

Query to get the current sales channel.

```APIDOC
## Query: getSalesChannel

### Description
Using this API, you can view your sales channel.

### GraphQL Query
```graphql
getSalesChannel: SalesChannel
```

### Return Type
- **SalesChannel** - The SalesChannel object.
```

--------------------------------

### List Orders with cURL (Bash)

Source: https://ikas.dev/docs/api/admin-api/orders

Bash example using curl to send a POST request to the ikas Admin GraphQL endpoint to list orders. Requires an access token for authorization.

```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":"{ listOrder { data { billingAddress { addressLine1 addressLine2 city { code id name } company country { code id iso2 iso3 name } district { code id name } firstName id identityNumber isDefault lastName phone postalCode state { code id name } taxNumber taxOffice } branch { id name } branchSessionId cancelReason cancelledAt clientIp createdAt currencyCode currencyRates { code originalRate rate } customer { email firstName id identityNumber isGuestCheckout lastName phone } deleted giftPackageLines { price taxValue } giftPackageNote host id invoices { appId appName createdAt id invoiceNumber storeAppId type } isGiftPackage merchantId note orderAdjustments { amount amountType appliedOrderLines { amount appliedQuantity orderLineId } campaignId couponId name order type } orderLineItems { createdAt currencyCode deleted discount { amount amountType reason } discountPrice finalPrice id options { name productOptionId productOptionsSetId type values { name price value } } originalOrderLineItemId price quantity status statusUpdatedAt stockLocationId taxValue updatedAt variant { barcodeList brand { id name } categories { categoryPath { id name } id name } id mainImageId name prices { buyPrice currency discountPrice priceListId sellPrice } productId sku slug tagIds taxValue type variantValues { order variantTypeId variantTypeName variantValueId variantValueName } } } orderNumber orderPackageSequence orderPackageStatus orderPackages { createdAt deleted errorMessage id note orderLineItemIds orderPackageFulfillStatus orderPackageNumber stockLocationId trackingInfo { barcode cargoCompany isSendNotification trackingLink trackingNumber } updatedAt } orderPaymentStatus orderSequence orderTagIds orderedAt paymentMethods { price type } priceList { id name } salesChannel { id name type } shippingAddress { addressLine1 addressLine2 city { code id name } company country { code id iso2 iso3 name } district { code id name } firstName id identityNumber isDefault lastName phone postalCode state { code id name } taxNumber taxOffice } shippingLines { isRefunded price shippingSettingsId shippingZoneRateId taxValue title } shippingMethod staff { email firstName lastName } status storefront { id name } storefrontRouting { domain id locale path priceListId } storefrontTheme { id name themeId themeVersionId } taxLines { price rate } terminalId totalFinalPrice totalPrice updatedAt userAgent } } }"}'
```

--------------------------------

### getFavoriteProductsIds

Source: https://ikas.dev/docs/theme/api/stores/ikas-customer-store

Gets the IDs of the customer's favorite products.

```APIDOC
## getFavoriteProductsIds

### Description
Gets the IDs of the customer's favorite products.

### Method
async function

### Signature
```typescript
async getFavoriteProductsIds()
```
```

--------------------------------

### getOrderByEmail

Source: https://ikas.dev/docs/theme/api/stores/ikas-customer-store

Get a specific customer order by email and orderNumber.

```APIDOC
## getOrderByEmail

### Description
Get a specific customer order by email and orderNumber.

### Method
async function

### Signature
```typescript
async getOrderByEmail(email: string, orderNumber: string)
```

### Parameters
- **email** (string) - Required - The customer's email.
- **orderNumber** (string) - Required - The order number.
```

--------------------------------

### List Orders with Node.js (axios)

Source: https://ikas.dev/docs/api/admin-api/orders

Node.js example using axios to send a POST request to the ikas Admin GraphQL endpoint to list orders. Requires an access token for authorization.

```javascript
const axios = require('axios');
const data = {"query":`{
     listOrder {
       data {
             billingAddress {
                  addressLine1
                  addressLine2
                  city {
                    code
                    id
                    name
                  }
                  company
                  country {
                    code
                    id
                    iso2
                    iso3
                    name
                  }
                  district {
                    code
                    id
                    name
                  }
                  firstName
                  id
                  identityNumber
                  isDefault
                  lastName
                  phone
                  postalCode
                  state {
                    code
                    id
                    name
                  }
                  taxNumber
                  taxOffice
                }
                branch {
                  id
                  name
                }
                branchSessionId
                cancelReason
                cancelledAt
                clientIp
                createdAt
                currencyCode
                currencyRates {
                  code
                  originalRate
                  rate
                }
                customer {
                  email
```

--------------------------------

### getGlobalTaxSettings

Source: https://ikas.dev/docs/api/type-definitions/admin-api/queries/get-global-tax-settings

Use this mutation to get global settings. The query returns a GlobalTaxSettings object.

```APIDOC
## getGlobalTaxSettings

### Description
Use this mutation to get global settings.

### Query
```graphql
getGlobalTaxSettings: GlobalTaxSettings
```

### Return Type
`GlobalTaxSettings` - [GlobalTaxSettings](https://ikas.dev/docs/api/type-definitions/admin-api/objects/global-tax-settings)
```

--------------------------------

### JSON response for listCustomer query

Source: https://ikas.dev/docs/api/admin-api/customers

Example response returned by the listCustomer query. Shows a single customer object with fields such as accountStatus, email, phone, and orderCount. Use this to understand the structure of the response data.

```json
{
  "data": {
    "listCustomer": {
      "data": [
        {
          "accountStatus": "ACTIVE_ACCOUNT",
          "accountStatusUpdatedAt": null,
          "createdAt": 1634019877744,
          "customerGroupIds": [],
          "deleted": false,
          "email": "onur@gmail.com",
          "emailVerifiedDate": null,
          "firstName": "onur",
          "id": "a8befae6-2cb9-487a-bd7f-5e0bfff3676b",
          "isEmailVerified": false,
          "isPhoneVerified": false,
          "lastName": "ilkyaz",
          "note": null,
          "passwordUpdateDate": null,
          "phone": "+905554443322",
          "phoneVerifiedDate": null,
          "subscriptionStatus": "NOT_SUBSCRIBED",
          "subscriptionStatusUpdatedAt": null,
          "tagIds": [],
          "updatedAt": 1634019877744,
          "orderCount": 5
        }
      ]
    }
  }
}
```

--------------------------------

### listCategory

Source: https://ikas.dev/docs/api/admin-api/category

Query to retrieve a list of categories. The example shows fetching id and name fields.

```APIDOC
## listCategory

### Description
Retrieves a list of categories.

### Method
Query

### Endpoint
POST https://api.myikas.com/api/v1/admin/graphql

### Example
```graphql
query {
  listCategory {
    id
    name
  }
}
```

### Response Example
```json
{
  "data": {
    "listProductAttribute": {
      "data": [
        {
          "id": "a8befae6-2cb9-487a-bd7f-5e0bfff3676b",
          "name": "Category name",
          "createdAt": 1634019877744
        }
      ]
    }
  }
}
```
```

--------------------------------

### getCampaigns

Source: https://ikas.dev/docs/theme/api/models/ikas-product

Returns campaigns for the product.

```APIDOC
## getCampaigns

### Description
Returns campaigns for the product.

### Method
async function

### Signature
```typescript
async function getCampaigns(): Promise<IkasProductCampaign[] | undefined>
```

### Parameters
None

### Returns
Promise<IkasProductCampaign[] | undefined>
```
Tokens:
Raw