@ikas/api-client 0.0.1-canary.7 → 1.0.0

package/dist/api/admin/generated/index.d.ts

@@ -24,11 +24,20 @@ export declare type Scalars = {
     Timestamp: any;
 };
 export declare type AddOrderInvoiceInput = {
+    /** It is the app id  for which the invoice is issued. */
     appId: Scalars['String'];
+    /** It is the content of invoice. Is the entered value must be in base64 format. */
     base64: Scalars['String'];
+    /** It is the number of the order invoice. */
     invoiceNumber: Scalars['String'];
+    /**
+     * It is the order id for which the invoice is issued.
+     *  * Is the entered id must be exist in ikas.
+     */
     orderId: Scalars['String'];
+    /** If the customer is to be informed after the invoice information is saved, this field can be sent as "true". */
     sendNotificationToCustomer: Scalars['Boolean'];
+    /** It is the type enum of the invoice. */
     type: InvoiceTypeEnum;
 };
 /** OrderAdjustment Enum */
@@ -65,7 +74,6 @@ export declare type AuthorizedApp = {
     partnerId: Scalars['String'];
     /** The id of the sales channel owned by the merchant. */
     salesChannelId?: Maybe<Scalars['String']>;
-    /** It keeps the information of the operations that this application can access and perform.Valid scopes are `store/order/created` `store/order/updated` `store/product/created` `store/product/updated` `store/customer/created` `store/customer/updated` `store/customerFavoriteProducts/created` `store/customerFavoriteProducts/updated` `store/stock/created` `store/stock/updated`. */
     scope: Scalars['String'];
     /** The application's id in the store. */
     storeAppId: Scalars['String'];
@@ -74,90 +82,148 @@ export declare type AuthorizedApp = {
     updatedAt?: Maybe<Scalars['Timestamp']>;
 };
 export declare type BulkUpdateProductBrandInput = {
+    /** Description of the brand. */
     description?: InputMaybe<Scalars['String']>;
+    /** Image id of brand. */
     imageId?: InputMaybe<Scalars['String']>;
+    /** Name of the brand. */
     name: Scalars['String'];
 };
 export declare type BulkUpdateProductCategoryInput = {
+    /** Name of the category. */
     name: Array<Scalars['String']>;
 };
 export declare type BulkUpdateProductHTMLMetaDataInput = {
+    /** Description of the product in HTML metadata. */
     description?: InputMaybe<Scalars['String']>;
-    id?: InputMaybe<Scalars['String']>;
+    id: Scalars['String'];
+    /** Metadata overrides for the product */
     metadataOverrides?: InputMaybe<Array<BulkUpdateProductHTMLMetaDataOverrideInput>>;
+    /** Page title for the product */
     pageTitle?: InputMaybe<Scalars['String']>;
+    /** Redirect URL for the product. */
     redirectTo?: InputMaybe<Scalars['String']>;
+    /** Slug of the product */
     slug: Scalars['String'];
+    /** Target of HTML metadata. */
     target?: InputMaybe<Scalars['String']>;
+    /** Target type for HTML metadata. */
     targetType?: InputMaybe<Scalars['String']>;
 };
 export declare type BulkUpdateProductHTMLMetaDataOverrideInput = {
+    /** Description of the product in HTML metadata. */
     description: Scalars['String'];
+    /** Language metadata for the product. */
     language?: InputMaybe<Scalars['String']>;
+    /** Page title for the product */
     pageTitle: Scalars['String'];
 };
 export declare type BulkUpdateProductImageInput = {
+    /** URL of the image */
     imageUrl: Scalars['String'];
+    /** Whether the image is main image for the product or not. */
     isMain: Scalars['Boolean'];
+    /** Order of the product image. */
     order: Scalars['Float'];
 };
 export declare type BulkUpdateProductPriceInput = {
+    /** Buy price of product. */
     buyPrice?: InputMaybe<Scalars['Float']>;
+    /** Currency code for the price of product. */
     currencyCode?: InputMaybe<Scalars['String']>;
+    /** Discount price of product. */
     discountPrice?: InputMaybe<Scalars['Float']>;
+    /** Id of the price list that the product belongs to. */
     priceListId?: InputMaybe<Scalars['String']>;
+    /** Sell price of product. */
     sellPrice: Scalars['Float'];
 };
 export declare type BulkUpdateProductStockInput = {
+    /** Number of available items in the stock location. */
     stockCount: Scalars['Float'];
+    /** Id of the stock location. */
     stockLocationId: Scalars['String'];
 };
 export declare type BulkUpdateProductTagInput = {
+    /** Name of the product tag. */
     name: Scalars['String'];
 };
 export declare type BulkUpdateProductVariantInput = {
+    /** List of barcode for the variant. */
     barcodeList?: InputMaybe<Array<Scalars['String']>>;
+    /** Whether the variant is deleted or not */
     deleted: Scalars['Boolean'];
-    id?: InputMaybe<Scalars['String']>;
+    id: Scalars['String'];
+    /** List of images for variant. */
     images?: InputMaybe<Array<BulkUpdateProductImageInput>>;
+    /** Whether the variant is active or not. */
     isActive: Scalars['Boolean'];
+    /** List of prices for the variant. */
     prices: Array<BulkUpdateProductPriceInput>;
+    /** SKU of the variant. */
     sku?: InputMaybe<Scalars['String']>;
+    /** Source id for variant. */
     sourceId?: InputMaybe<Scalars['String']>;
+    /** List of stocks for the variant. */
     stocks?: InputMaybe<Array<BulkUpdateProductStockInput>>;
+    /** List of variant values. */
     variantValues: Array<BulkUpdateProductVariationValueRelationInput>;
+    /** Weight of the variant. */
     weight?: InputMaybe<Scalars['Float']>;
 };
 export declare type BulkUpdateProductVariantTypeImportInput = {
+    /** Order of the variant type. */
     order: Scalars['Float'];
+    /** Name of variant type. */
     variantTypeName?: InputMaybe<Scalars['String']>;
+    /** List of variant values. */
     variantValues: Array<BulkUpdateProductVariantValueImportInput>;
 };
 export declare type BulkUpdateProductVariantValueImportInput = {
+    /** Hex color code for the variant value. */
     colorCode?: InputMaybe<Scalars['String']>;
+    /** Name of the variant value. */
     name: Scalars['String'];
+    /** Source id for variant value. */
     sourceId?: InputMaybe<Scalars['String']>;
+    /** Thumbnail image url for the variant value. */
     thumbnailImageUrl?: InputMaybe<Scalars['String']>;
 };
 export declare type BulkUpdateProductVariationValueRelationInput = {
+    /** Name of variant type. */
     variantTypeName: Scalars['String'];
+    /** Name of the variant value. */
     variantValueName: Scalars['String'];
 };
 export declare type BulkUpdateProductsInput = {
+    /** Brand of the product. */
     brand?: InputMaybe<BulkUpdateProductBrandInput>;
+    /** List of categories of the product. */
     categories: Array<BulkUpdateProductCategoryInput>;
+    /** Whether the product is deleted or not */
     deleted: Scalars['Boolean'];
+    /** Description of the product. */
     description?: InputMaybe<Scalars['String']>;
-    id?: InputMaybe<Scalars['String']>;
+    id: Scalars['String'];
+    /** HTML Metadata identifier of the product. */
     metaData?: InputMaybe<BulkUpdateProductHTMLMetaDataInput>;
+    /** Name of the product */
     name: Scalars['String'];
+    /** Variant types of the product. */
     productVariantTypes: Array<BulkUpdateProductVariantTypeImportInput>;
+    /** Short description of the product. */
     shortDescription?: InputMaybe<Scalars['String']>;
+    /** Source id for bulk update. */
     sourceId?: InputMaybe<Scalars['String']>;
+    /** List of product tags. */
     tags?: InputMaybe<Array<BulkUpdateProductTagInput>>;
+    /** Type of the product. */
     type: ProductTypeEnum;
+    /** List of product variants. */
     variants: Array<BulkUpdateProductVariantInput>;
+    /** Vendor of the product. */
     vendor?: InputMaybe<Scalars['String']>;
+    /** Weight of the product. */
     weight?: InputMaybe<Scalars['String']>;
 };
 export declare type CancelFulfillmentInput = {
@@ -173,20 +239,28 @@ export declare enum CancelledReasonEnum {
 }
 export declare type Category = {
     __typename?: 'Category';
+    /** It is the id list information where the ids of all the superclasses of the category are found. */
     categoryPath?: Maybe<Array<Scalars['String']>>;
     conditions?: Maybe<Array<CategoryCondition>>;
     createdAt?: Maybe<Scalars['Timestamp']>;
     deleted?: Maybe<Scalars['Boolean']>;
+    /** It is the description of the category of the product. */
     description?: Maybe<Scalars['String']>;
     id: Scalars['ID'];
+    /** It is the id where the picture of the category is kept in the system. */
     imageId?: Maybe<Scalars['String']>;
     isAutomated?: Maybe<Scalars['Boolean']>;
+    /** It is the metadata information of the product category. */
     metaData?: Maybe<HTMLMetaData>;
+    /** It is the name of the category in which the product is located. */
     name: Scalars['String'];
     orderType?: Maybe<CategoryProductsOrderTypeEnum>;
+    /** It is the id of the superclass category of the category. */
     parentId?: Maybe<Scalars['String']>;
+    /** It is the information of which sales channel the product category is in. */
     salesChannelIds?: Maybe<Array<Scalars['String']>>;
     shouldMatchAllConditions?: Maybe<Scalars['Boolean']>;
+    /** It is the translation information of the product category. */
     translations?: Maybe<Array<CategoryTranslation>>;
     updatedAt?: Maybe<Scalars['Timestamp']>;
 };
@@ -210,16 +284,23 @@ export declare type CategoryInput = {
     conditions?: InputMaybe<Array<CategoryConditionInput>>;
     createdAt?: InputMaybe<Scalars['Timestamp']>;
     deleted?: InputMaybe<Scalars['Boolean']>;
+    /** It is the description of the category of the product. */
     description?: InputMaybe<Scalars['String']>;
     id?: InputMaybe<Scalars['ID']>;
+    /** It is the id where the picture of the category is kept in the system. */
     imageId?: InputMaybe<Scalars['String']>;
     isAutomated?: InputMaybe<Scalars['Boolean']>;
+    /** It is the metadata information of the product category. */
     metaData?: InputMaybe<HTMLMetaDataInput>;
+    /** It is the name of the category in which the product is located. */
     name: Scalars['String'];
     orderType?: InputMaybe<CategoryProductsOrderTypeEnum>;
+    /** It is the id of the superclass category of the category. */
     parentId?: InputMaybe<Scalars['String']>;
+    /** It is the information of which sales channel the product category is in. */
     salesChannelIds?: InputMaybe<Array<Scalars['String']>>;
     shouldMatchAllConditions?: InputMaybe<Scalars['Boolean']>;
+    /** It is the translation information of the product category. */
     translations?: InputMaybe<Array<CategoryTranslationInput>>;
     updatedAt?: InputMaybe<Scalars['Timestamp']>;
 };
@@ -239,13 +320,19 @@ export declare enum CategoryProductsOrderTypeEnum {
 }
 export declare type CategoryTranslation = {
     __typename?: 'CategoryTranslation';
+    /** It is the description information of the translation. */
     description?: Maybe<Scalars['String']>;
+    /** It is the name information of the translation. */
     locale: Scalars['String'];
+    /** It is the information in which language the translation is saved. */
     name?: Maybe<Scalars['String']>;
 };
 export declare type CategoryTranslationInput = {
+    /** It is the description information of the translation. */
     description?: InputMaybe<Scalars['String']>;
+    /** It is the name information of the translation. */
     locale: Scalars['String'];
+    /** It is the information in which language the translation is saved. */
     name?: InputMaybe<Scalars['String']>;
 };
 export declare type City = {
@@ -301,29 +388,59 @@ export declare type Country = {
     updatedAt?: Maybe<Scalars['Timestamp']>;
 };
 export declare type CreateOrderInput = {
+    /** It is the address to which the order will be billing. */
     billingAddress?: InputMaybe<OrderAddressInput>;
+    /** It is the branch session id of the order. If the order is placed via ikasPos, this field can be sent as filled. */
     branchSessionId?: InputMaybe<Scalars['String']>;
     createdAt?: InputMaybe<Scalars['Timestamp']>;
+    /** It is the currency code of the order. */
     currencyCode?: InputMaybe<Scalars['String']>;
+    /** It is the customer information in the order. */
     customer?: InputMaybe<OrderCustomerInput>;
     deleted?: InputMaybe<Scalars['Boolean']>;
     id?: InputMaybe<Scalars['ID']>;
+    /** It is an order note. */
     note?: InputMaybe<Scalars['String']>;
+    /** A list of adjustment objects, each containing information about a adjustment in the order. */
     orderAdjustments?: InputMaybe<Array<OrderAdjustmentInput>>;
+    /** A list of line item objects, each containing information about an item in the order. */
     orderLineItems: Array<OrderLineItemInput>;
+    /**
+     * It is the id list of the tags in the order.
+     * * Is the entered tag id list must be exist in ikas.
+     */
     orderTagIds?: InputMaybe<Array<Scalars['String']>>;
+    /** The date the order was ordered. */
     orderedAt?: InputMaybe<Scalars['Timestamp']>;
+    /**
+     * It is the id of the price list that includes the prices of the products in the order.
+     * * Is the entered id must be exist in ikas.
+     */
     priceListId?: InputMaybe<Scalars['String']>;
+    /**
+     * It is the sales channel id where the order was created.
+     * * Is the entered id must be exist in ikas.
+     */
     salesChannelId?: InputMaybe<Scalars['String']>;
+    /** It is the address to which the order will be shipping. */
     shippingAddress?: InputMaybe<OrderAddressInput>;
+    /** A list of shipping line objects, each containing information about a shipping in the order. */
     shippingLines?: InputMaybe<Array<OrderShippingLineInput>>;
+    /** It is the shipping method enum of the order */
     shippingMethod?: InputMaybe<ShippingMethodEnum>;
+    /** It is the terminal session id of the order. If the order is placed via ikasPos, this field can be sent as filled. */
     terminalId?: InputMaybe<Scalars['String']>;
     updatedAt?: InputMaybe<Scalars['Timestamp']>;
 };
 export declare type CreateOrderWithTransactionsInput = {
+    /** If there is no customer connected to the e-mail in the order and it is not desired to create a new customer with this e-mail, it can be sent as ```true```. */
     disableAutoCreateCustomer?: InputMaybe<Scalars['Boolean']>;
+    /** Contains the order information to be created. */
     order: CreateOrderInput;
+    /**
+     * A list of transaction objects.
+     * * The list must contain at least one transaction.
+     */
     transactions: Array<OrderTransactionInput>;
 };
 export declare type Customer = {
@@ -519,14 +636,18 @@ export declare type HTMLMetaData = {
     __typename?: 'HTMLMetaData';
     createdAt?: Maybe<Scalars['Timestamp']>;
     deleted?: Maybe<Scalars['Boolean']>;
+    /** The description of the metadata. */
     description?: Maybe<Scalars['String']>;
     id: Scalars['ID'];
     metadataOverrides?: Maybe<Array<HTMLMetaDataOverride>>;
+    /** The page title of the metadata. */
     pageTitle?: Maybe<Scalars['String']>;
     redirectTo?: Maybe<Scalars['String']>;
+    /** The token of the metadata. It is saved as completely unique. */
     slug: Scalars['String'];
     targetId?: Maybe<Scalars['String']>;
     targetType?: Maybe<HTMLMetaDataTargetTypeEnum>;
+    /** The translations information of the metadata. */
     translations?: Maybe<Array<HTMLMetaDataTranslation>>;
     updatedAt?: Maybe<Scalars['Timestamp']>;
 };
@@ -578,12 +699,19 @@ export declare type HTMLMetaDataTranslationInput = {
 };
 export declare type Invoice = {
     __typename?: 'Invoice';
+    /** It is the id of the order invoice. */
     appId: Scalars['String'];
+    /** It is the id of the order invoice. */
     appName: Scalars['String'];
+    /** It is the id of the order invoice. */
     createdAt?: Maybe<Scalars['Timestamp']>;
+    /** It is the id of the order invoice. */
     id: Scalars['String'];
+    /** It is the id of the order invoice. */
     invoiceNumber: Scalars['String'];
+    /** It is the id of the order invoice. */
     storeAppId: Scalars['String'];
+    /** It is the type enum of the invoice. */
     type: InvoiceTypeEnum;
 };
 /** Invoice Type Enum */
@@ -608,8 +736,8 @@ export declare type MeResponse = {
     partnerId?: Maybe<Scalars['String']>;
     /** The id of the sales channel owned by the merchant. */
     salesChannelId?: Maybe<Scalars['String']>;
-    /** It keeps the information of the operations that this application can access and perform.Valid scopes are `store/order/created` `store/order/updated` `store/product/created` `store/product/updated` `store/customer/created` `store/customer/updated` `store/customerFavoriteProducts/created` `store/customerFavoriteProducts/updated` `store/stock/created` `store/stock/updated`. */
     scope?: Maybe<Scalars['String']>;
+    /** It keeps the information of the operations that this application can access and perform.For more information please review [Scopes section](/docs/getting-started/api-overview#api-scopes). */
     scopes?: Maybe<Array<AppScopeEnum>>;
     /** The application's id in the store. */
     storeAppId?: Maybe<Scalars['String']>;
@@ -675,23 +803,33 @@ export declare type MerchantAddressState = {
 };
 export declare type MerchantAppPayment = {
     __typename?: 'MerchantAppPayment';
+    /** It keeps the information of which type of license is obtained. For example: trendyol-app-licence, foriba-app-licence etc. */
     appPaymentKey: Scalars['String'];
+    /** The id of the app that generated the app payment. Actually, the id of the app for which merchant app payment was created. */
     authorizedAppId?: Maybe<Scalars['String']>;
     createdAt?: Maybe<Scalars['Timestamp']>;
     deleted?: Maybe<Scalars['Boolean']>;
     id: Scalars['ID'];
+    /** The url where the Merchant will be redirected to the payment screen. On this page, the payment process is performed by obtaining the card information. */
     merchantPaymentUrl: Scalars['String'];
+    /** The created merchant app keeps the name of the payment.  */
     name: Scalars['String'];
+    /** The merchant app keeps the date of completion of the payment. In other words, it keeps the information of the date the payment was received. */
     paymentDate?: Maybe<Scalars['Timestamp']>;
+    /** Merchant app payment pricing description. */
     prices: Array<MerchantAppPaymentPrice>;
     status: MerchantAppPaymentStatusEnum;
+    /** The id of the application for which payment will be created in the store */
     storeAppId: Scalars['String'];
     type: MerchantAppPaymentTypeEnum;
     updatedAt?: Maybe<Scalars['Timestamp']>;
 };
 export declare type MerchantAppPaymentInput = {
+    /** It keeps the information of which type of license is obtained. For example: trendyol-app-licence, foriba-app-licence etc. */
     appPaymentKey: Scalars['String'];
+    /** The created merchant app keeps the name of the payment. */
     name: Scalars['String'];
+    /** Merchant app payment pricing description. */
     prices: Array<MerchantAppPaymentPriceInput>;
     type: MerchantAppPaymentTypeEnum;
 };
@@ -710,10 +848,12 @@ export declare type MerchantAppPaymentPaginationResponse = {
 export declare type MerchantAppPaymentPrice = {
     __typename?: 'MerchantAppPaymentPrice';
     period: SubscriptionPeriodEnum;
+    /** The area where the price information of the product is kept. Here, one-time, monthly or annual payments can be made and the information is kept in this way. */
     price: Scalars['Float'];
 };
 export declare type MerchantAppPaymentPriceInput = {
     period: SubscriptionPeriodEnum;
+    /** The area where the price information of the product is kept. Input array can be sent a minimum of one element and a maximum of 2 elements. */
     price: Scalars['Float'];
 };
 export declare enum MerchantAppPaymentStatusEnum {
@@ -727,42 +867,60 @@ export declare enum MerchantAppPaymentTypeEnum {
 }
 export declare type MerchantAppSubscription = {
     __typename?: 'MerchantAppSubscription';
+    /** The date the app licence was added. */
     addedDate?: Maybe<Scalars['Timestamp']>;
+    /** It is the information of which type of app license is obtained. */
     appPaymentKey: Scalars['String'];
+    /** The id of the app that generated the app payment. Actually, the id of the app for which merchant app payment was created. */
     authorizedAppId?: Maybe<Scalars['String']>;
     createdAt?: Maybe<Scalars['Timestamp']>;
     currency?: Maybe<SubscriptionPriceCurrencyEnum>;
     deleted?: Maybe<Scalars['Boolean']>;
     id: Scalars['ID'];
+    /** It is the date of receipt of the last payment for the license subscription. */
     lastPaymentDate?: Maybe<Scalars['Timestamp']>;
+    /** The discount rate on the last payment for the app license subscription. */
     lastPaymentDiscountRatio?: Maybe<Scalars['Float']>;
     lastPaymentPeriod: SubscriptionPeriodEnum;
+    /** The payment period of the license last payment. The purpose of keeping this information is to adjust the controls according to the last month if the subscription is withdrawn from annual to monthly. */
     lastPaymentPeriodInDays: Scalars['Float'];
+    /** It is the last payment information for the app license subscription. */
     lastPaymentPrice: Scalars['Float'];
+    /** It is the price information including KDV, for which the last payment is made for the app license subscription. */
     lastPaymentPriceWithTax: Scalars['Float'];
     merchantAppPaymentId: Scalars['String'];
+    /** The name of the created application license is the information. */
     name: Scalars['String'];
     status: MerchantSubscriptionStatusEnum;
+    /** The id of the application to be licensed in the store */
     storeAppId: Scalars['String'];
     updatedAt?: Maybe<Scalars['Timestamp']>;
 };
 export declare type MerchantLicence = {
     __typename?: 'MerchantLicence';
     activeSubscriptionCode: SubscriptionCodeEnum;
+    /** It is the id of the subscription to which the license is connected. */
     activeSubscriptionId: Scalars['String'];
+    /** If the license is attached to an app, its properties are kept in this domain. */
     appSubscriptions?: Maybe<Array<MerchantAppSubscription>>;
     createdAt?: Maybe<Scalars['Timestamp']>;
+    /** It is the field where private subscription information is kept. */
     customSubscriptionIds?: Maybe<Array<Scalars['String']>>;
     deleted?: Maybe<Scalars['Boolean']>;
+    /** It is the information of the start date of the license. */
     fromDate?: Maybe<Scalars['Timestamp']>;
     id: Scalars['ID'];
+    /** It is the information of the last date the license was active. */
     licenceActivationDate?: Maybe<Scalars['Timestamp']>;
     limits: Array<MerchantLimit>;
     period?: Maybe<SubscriptionPeriodEnum>;
     region: MerchantRegionEnum;
     status: MerchantLicenceStatusEnum;
+    /** The date the Merchant license status was updated. */
     statusUpdatedAt?: Maybe<Scalars['Timestamp']>;
+    /** It is the subscription properties information of the license. */
     subscriptions: Array<MerchantSubscription>;
+    /** It is the information of the expiry date of the license. */
     toDate?: Maybe<Scalars['Timestamp']>;
     updatedAt?: Maybe<Scalars['Timestamp']>;
 };
@@ -839,16 +997,24 @@ export declare type MerchantSubscription = {
     currency?: Maybe<SubscriptionPriceCurrencyEnum>;
     deleted?: Maybe<Scalars['Boolean']>;
     id: Scalars['ID'];
+    /** It is the date of receipt of the last payment for the license subscription. */
     lastPaymentDate?: Maybe<Scalars['Timestamp']>;
+    /** The discount rate on the last payment for the license subscription. */
     lastPaymentDiscountRatio?: Maybe<Scalars['Float']>;
     lastPaymentPeriod: SubscriptionPeriodEnum;
+    /** The payment period of the license last payment. The purpose of keeping this information is to adjust the controls according to the last month if the subscription is withdrawn from annual to monthly. */
     lastPaymentPeriodInDays: Scalars['Float'];
+    /** It is the last payment information for the license subscription. */
     lastPaymentPrice: Scalars['Float'];
+    /** It is the price information including KDV, for which the last payment is made for the license subscription. */
     lastPaymentPriceWithTax: Scalars['Float'];
     limits: Array<MerchantLimit>;
+    /** It is the subscription name of the license. */
     name?: Maybe<Scalars['String']>;
+    /** It is the Id information of the sales channel to which the subscription of the license is connected. */
     salesChannelId?: Maybe<Scalars['String']>;
     status: MerchantSubscriptionStatusEnum;
+    /** It is the subscription id of the license. */
     subscriptionId: Scalars['String'];
     updatedAt?: Maybe<Scalars['Timestamp']>;
 };
@@ -860,39 +1026,63 @@ export declare enum MerchantSubscriptionStatusEnum {
 export declare type Mutation = {
     __typename?: 'Mutation';
     addCustomTimelineEntry: Scalars['Boolean'];
+    /** Use this mutation to add invoice to order. */
     addOrderInvoice: Order;
+    /** Response indicating the status of operation. */
     bulkUpdateProducts: Scalars['Boolean'];
+    /** Use this mutation to cancel the already created package for an order. */
     cancelFulfillment: Order;
+    /** Using this api, you can add payment features to a merchant app. */
     createMerchantAppPayment: MerchantAppPayment;
+    /** Use this mutation if you want to create a new order with transactions. */
     createOrderWithTransactions: Order;
+    /** Using this api, you can delete the categories of products. */
     deleteCategoryList: Scalars['Boolean'];
+    /** Use this mutation to delete product attributes with specific ids. */
     deleteProductAttributeList: Scalars['Boolean'];
+    /** Using this api, you can delete the brands of products. */
     deleteProductBrandList: Scalars['Boolean'];
+    /** Use this mutation to delete products with specific product ids. */
     deleteProductList: Scalars['Boolean'];
+    /** Using this api, you can delete the tags of products. */
     deleteProductTagList: Scalars['Boolean'];
     /** Using this api, you can delete javascript script from a the storefront. */
     deleteStorefrontJSScript: Scalars['Boolean'];
+    /** Using this api, you can delete the brands of products. */
     deleteVariantTypeList: Scalars['Boolean'];
     /** Use this mutation to delete webhooks by giving `scope` list. */
     deleteWebhook: Scalars['Boolean'];
+    /** Use this mutation to fulfill order line items. */
     fulfillOrder: Order;
+    /** Use this mutation to refund operations. */
     refundOrderLine: Order;
+    /** Using this api, you can update the categories of products. */
     saveCategory: Category;
+    /** Use this mutation to create or update a product with provided input values. */
     saveProduct: Product;
+    /** Use this mutation to create or update product attributes with provided input values. */
     saveProductAttribute: ProductAttribute;
+    /** Using this api, you can update the brands of products. */
     saveProductBrand: ProductBrand;
+    /** Use this mutation to define new stock or update stocks by location. */
     saveProductStockLocations: Scalars['Boolean'];
+    /** Using this api, you can update the tags of products. */
     saveProductTag: ProductTag;
     /** Using this api you can update the sales channel name, priceList Id and stockLocations properties. */
     saveSalesChannel?: Maybe<SalesChannel>;
     /** Using this api, you can save javascript script to a the storefront. */
     saveStorefrontJSScript: StorefrontJSScript;
+    /** Using this api, you can update the brands of products. */
     saveVariantType: VariantType;
     /** Use this mutation to save webhooks by using multiple `scope` variables. After saving a webhook, **ikas** will start to push new webhooks to given url `endpoint`. If **endpoint** is unreachable or returns an error code other than `HTTP 200` **ikas** will try to push webhook for 3 times then stops sending webhook. */
     saveWebhook?: Maybe<Array<Webhook>>;
+    /** Use this mutation for order address information changes. */
     updateOrderAddresses: Order;
+    /** Use this mutation to cancel the fulfillment of the already created package for an order. */
     updateOrderLine: Order;
+    /** Use this mutation to update the status of packages linked to an order and the status of the order based on the status of those packages. */
     updateOrderPackageStatus: Order;
+    /** Response indicating the status of operation. */
     updateProductSalesChannelStatus: Scalars['Boolean'];
 };
 export declare type MutationaddCustomTimelineEntryArgs = {
@@ -1001,76 +1191,136 @@ export declare type NumberFilterInput = {
 };
 export declare type Order = {
     __typename?: 'Order';
+    /** It is the billing address of the order. */
     billingAddress?: Maybe<OrderAddress>;
+    /** It is the ```branch`` information of the orders created via ikasPOS. */
     branch?: Maybe<OrderBranch>;
+    /** It is the ```branchSessionId`` information of the orders created via ikasPOS. */
     branchSessionId?: Maybe<Scalars['String']>;
+    /** It is the cancel reason of the order. If the order has been cancelled, it indicates the cancellation reason of the order. */
     cancelReason?: Maybe<CancelledReasonEnum>;
+    /** If the order has been cancelled, it indicates the cancellation date of the order. */
     cancelledAt?: Maybe<Scalars['Timestamp']>;
+    /** The client ip address. */
     clientIp?: Maybe<Scalars['String']>;
     createdAt?: Maybe<Scalars['Timestamp']>;
+    /** It is the currency value of the order. */
     currencyCode: Scalars['String'];
+    /** A list of currency rate objects. */
     currencyRates: Array<OrderCurrencyRate>;
+    /** Information about the customer. The order does not have to be a customer information. If the order was created by ikasPOS, the customer information may be null. */
     customer?: Maybe<OrderCustomer>;
     deleted?: Maybe<Scalars['Boolean']>;
+    /** A list of gift package line objects, each containing information about a gift package pricing in the order. */
     giftPackageLines?: Maybe<Array<OrderGiftPackageLine>>;
+    /** An optional gift package note, can attach to the order. */
     giftPackageNote?: Maybe<Scalars['String']>;
+    /** It is the host where the order was created. */
     host?: Maybe<Scalars['String']>;
     id: Scalars['ID'];
+    /** A list of invoice objects, each containing information about an invoice. */
     invoices?: Maybe<Array<Invoice>>;
+    /** Indicates whether there is a gift package in the order. ***isGiftPackage*** returns  ```true``` if the order has gift package */
     isGiftPackage?: Maybe<Scalars['Boolean']>;
     merchantId: Scalars['String'];
+    /** An optional note, can attach to the order. */
     note?: Maybe<Scalars['String']>;
+    /** A list of adjustment objects, each containing information about a adjustment in the order. */
     orderAdjustments?: Maybe<Array<OrderAdjustment>>;
+    /** A list of line item objects, each containing information about an item in the order. */
     orderLineItems: Array<OrderLineItem>;
+    /** The position of the order in the store's order count starting from 1001. Order numbers are sequential and start from 1001. */
     orderNumber?: Maybe<Scalars['String']>;
+    /** is the sequence value of the packages in the order. */
     orderPackageSequence?: Maybe<Scalars['Float']>;
+    /** It is the package status enum of the order */
     orderPackageStatus?: Maybe<OrderPackageStatusEnum>;
+    /** A list of order package objects. */
     orderPackages?: Maybe<Array<OrderPackage>>;
+    /** It is the payment status enum of the order */
     orderPaymentStatus?: Maybe<OrderPaymentStatusEnum>;
+    /** It is the sequence value of the order_number. The sequence value starts from 1 and an order with order number 1001 has a sequence value of 1. */
     orderSequence?: Maybe<Scalars['Float']>;
+    /** It is the tag id list in the order. */
     orderTagIds?: Maybe<Array<Scalars['String']>>;
+    /** The date the order was ordered. */
     orderedAt?: Maybe<Scalars['Timestamp']>;
+    /** A list of payment method objects, each containing information about a payment method in the order. */
     paymentMethods?: Maybe<Array<OrderPaymentMethod>>;
+    /** Information about the ```priceList``` used when the order was created. */
     priceList?: Maybe<OrderPriceList>;
+    /** Information about the  ```salesChannel``` where the order was created. */
     salesChannel: OrderSalesChannel;
+    /** It is the shipping address of the order. */
     shippingAddress?: Maybe<OrderAddress>;
+    /** A list of shipping line objects, each containing information about a shipping in the order. */
     shippingLines?: Maybe<Array<OrderShippingLine>>;
+    /** It is the shipping method enum of the order */
     shippingMethod: ShippingMethodEnum;
+    /** It is the ```staff`` information of the orders created via ikasPOS. */
     staff?: Maybe<OrderStaff>;
+    /** It is the status enum of the order */
     status: OrderStatusEnum;
+    /** Information about the ```storefront``` where the order was created. */
     storefront?: Maybe<OrderStorefront>;
+    /** Information about the ```storefrontRouting``` used by the storefront at the time the order was created. */
     storefrontRouting?: Maybe<OrderStorefrontRouting>;
+    /** Information about the ```storefrontTheme``` used by the storefront at the time the order was created. */
     storefrontTheme?: Maybe<OrderStorefrontTheme>;
+    /** A list of tax line objects, tax line objects contain the taxes of the shippingLines, orderLineItems, and giftPackageLines. */
     taxLines?: Maybe<Array<OrderTaxLine>>;
+    /** It is the ```terminalId`` information of the orders created via ikasPOS. */
     terminalId?: Maybe<Scalars['String']>;
+    /** The total final price of the order resulting from the apply of ``orderAdjustments`` , ```shippingLines```, and  ```giftPackageLines``` pricing to the order total price. */
     totalFinalPrice: Scalars['Float'];
+    /** It is the sum of the net prices of the line items in the order. */
     totalPrice: Scalars['Float'];
     updatedAt?: Maybe<Scalars['Timestamp']>;
+    /** Details of the browsing client, including software and operating versions. */
     userAgent?: Maybe<Scalars['String']>;
 };
 export declare type OrderAddress = {
     __typename?: 'OrderAddress';
+    /** The street address of the address. */
     addressLine1: Scalars['String'];
+    /** An optional additional field for the street address of the address. */
     addressLine2?: Maybe<Scalars['String']>;
+    /** The city information of the address. */
     city: OrderAddressCity;
+    /** The company of the person associated with the address. */
     company?: Maybe<Scalars['String']>;
+    /** The country information of the address. */
     country: OrderAddressCountry;
+    /** The district information of the address. */
     district?: Maybe<OrderAddressDistrict>;
+    /** The first name of the person associated with the address */
     firstName: Scalars['String'];
+    /** The address"s id of the order address. */
     id?: Maybe<Scalars['String']>;
+    /** The identity number of the person associated with the address. */
     identityNumber?: Maybe<Scalars['String']>;
+    /** The address"s id of the order address. */
     isDefault: Scalars['Boolean'];
+    /** The last name of the person associated with the address */
     lastName: Scalars['String'];
+    /** The phone of the person associated with the address. */
     phone?: Maybe<Scalars['String']>;
+    /** The postal code of the address. */
     postalCode?: Maybe<Scalars['String']>;
+    /** The state information of the address. */
     state?: Maybe<OrderAddressState>;
+    /** The tax number of the person associated with the address. */
     taxNumber?: Maybe<Scalars['String']>;
+    /** The tax office of the person associated with the address. */
     taxOffice?: Maybe<Scalars['String']>;
 };
 export declare type OrderAddressCity = {
     __typename?: 'OrderAddressCity';
+    /** It is the code of the city of the address. */
     code?: Maybe<Scalars['String']>;
+    /** It is the id of the city of the address. */
     id?: Maybe<Scalars['String']>;
+    /** It is the name of the city of the address. */
     name: Scalars['String'];
 };
 export declare type OrderAddressCityInput = {
@@ -1080,10 +1330,15 @@ export declare type OrderAddressCityInput = {
 };
 export declare type OrderAddressCountry = {
     __typename?: 'OrderAddressCountry';
+    /** It is the code of the country of the address. */
     code?: Maybe<Scalars['String']>;
+    /** It is the id of the country of the address. */
     id?: Maybe<Scalars['String']>;
+    /** It is the two-letter code of the country of the address. */
     iso2?: Maybe<Scalars['String']>;
+    /** It is the three-letter code of the country of the address. */
     iso3?: Maybe<Scalars['String']>;
+    /** It is the name of the country of the address. */
     name: Scalars['String'];
 };
 export declare type OrderAddressCountryInput = {
@@ -1095,8 +1350,11 @@ export declare type OrderAddressCountryInput = {
 };
 export declare type OrderAddressDistrict = {
     __typename?: 'OrderAddressDistrict';
+    /** It is the code of the district of the address. */
     code?: Maybe<Scalars['String']>;
+    /** It is the id of the district of the address. */
     id?: Maybe<Scalars['String']>;
+    /** It is the name of the district of the address. */
     name?: Maybe<Scalars['String']>;
 };
 export declare type OrderAddressDistrictInput = {
@@ -1105,27 +1363,46 @@ export declare type OrderAddressDistrictInput = {
     name?: InputMaybe<Scalars['String']>;
 };
 export declare type OrderAddressInput = {
+    /** The street address of the address. */
     addressLine1: Scalars['String'];
+    /** An optional additional field for the street address of the address. */
     addressLine2?: InputMaybe<Scalars['String']>;
+    /** The name of the city of the address. */
     city: OrderAddressCityInput;
+    /** The company of the person associated with the address. */
     company?: InputMaybe<Scalars['String']>;
+    /** The name of the country of the address. */
     country: OrderAddressCountryInput;
+    /** The name of the district of the address. */
     district?: InputMaybe<OrderAddressDistrictInput>;
+    /** The first name of the person associated with the address */
     firstName: Scalars['String'];
+    /** If the address to be updated is registered in ikas, this field must be filled. If the Id field is sent blank, a new address is generated. */
     id?: InputMaybe<Scalars['String']>;
+    /** The identity number of the person associated with the address. */
     identityNumber?: InputMaybe<Scalars['String']>;
+    /** If the address is to be saved as default, this field can be sent as ```true```. */
     isDefault: Scalars['Boolean'];
+    /** The last name of the person associated with the address */
     lastName: Scalars['String'];
+    /** The phone of the person associated with the address. */
     phone?: InputMaybe<Scalars['String']>;
+    /** The postal code of the address. */
     postalCode?: InputMaybe<Scalars['String']>;
+    /** The name of the state of the address. */
     state?: InputMaybe<OrderAddressStateInput>;
+    /** The tax number of the person associated with the address. */
     taxNumber?: InputMaybe<Scalars['String']>;
+    /** The tax office of the person associated with the address. */
     taxOffice?: InputMaybe<Scalars['String']>;
 };
 export declare type OrderAddressState = {
     __typename?: 'OrderAddressState';
+    /** It is the code of the state of the address. */
     code?: Maybe<Scalars['String']>;
+    /** It is the id of the state of the address. */
     id?: Maybe<Scalars['String']>;
+    /** It is the name of the state of the address. */
     name?: Maybe<Scalars['String']>;
 };
 export declare type OrderAddressStateInput = {
@@ -1135,60 +1412,93 @@ export declare type OrderAddressStateInput = {
 };
 export declare type OrderAdjustment = {
     __typename?: 'OrderAdjustment';
+    /** It is the adjustment amount in the order. This amount can be positive or negative. */
     amount: Scalars['Float'];
     amountType: AmountTypeEnum;
+    /** A list of order line items, each containing information about a order line item in the order. */
     appliedOrderLines?: Maybe<Array<OrderAdjustmentAppliedOrderLine>>;
+    /** If the adjustment is associated to the campaign, it will show the campaign id. */
     campaignId?: Maybe<Scalars['String']>;
+    /** It is the coupon id generated depending on the campaign. */
     couponId?: Maybe<Scalars['String']>;
+    /** It is the name of the adjustment. */
     name: Scalars['String'];
+    /** It is the order of the adjustment. Adjustments are applied in this order. */
     order: Scalars['Float'];
     type: AdjustmentEnum;
 };
 export declare type OrderAdjustmentAppliedOrderLine = {
     __typename?: 'OrderAdjustmentAppliedOrderLine';
+    /** Is he amount of the applied adjustment. */
     amount: Scalars['Float'];
+    /** It is the quantity of variants within the order line item to which the adjustment is applied. */
     appliedQuantity: Scalars['Float'];
+    /** It is the id of the order line item to which the adjustment is applied. */
     orderLineId: Scalars['String'];
 };
 export declare type OrderAdjustmentInput = {
+    /** It is the amount of the order adjustment. */
     amount: Scalars['Float'];
+    /** It is the amount type of the order adjustment */
     amountType: AmountTypeEnum;
+    /** It is the campaign information that adjustment depends on. */
     campaignId?: InputMaybe<Scalars['String']>;
+    /** It is the coupon information of the campaign that adjustment is connected to. */
     couponId?: InputMaybe<Scalars['String']>;
+    /** It is the name of the order adjustment. */
     name: Scalars['String'];
+    /** It is the order information in which the adjustment will be applied. */
     order: Scalars['Float'];
+    /** It is the type enum of the order adjustment */
     type: AdjustmentEnum;
 };
 export declare type OrderBranch = {
     __typename?: 'OrderBranch';
+    /** It is the id of the branch where the order was created. */
     id: Scalars['String'];
+    /** It is the id of the branch where the order was created. */
     name?: Maybe<Scalars['String']>;
 };
 export declare type OrderCurrencyRate = {
     __typename?: 'OrderCurrencyRate';
+    /** It is the code of the currency.  */
     code: Scalars['String'];
+    /** It is the original rate of the currency. */
     originalRate: Scalars['Float'];
+    /** It is the rate of the currency. */
     rate: Scalars['Float'];
 };
 export declare type OrderCustomer = {
     __typename?: 'OrderCustomer';
+    /** It is the email of the customer who created the order. */
     email?: Maybe<Scalars['String']>;
+    /** It is the first name of the customer who created the order. */
     firstName?: Maybe<Scalars['String']>;
+    /** It is the id of the customer who created the order. */
     id?: Maybe<Scalars['String']>;
+    /** It is the identity number of the customer who created the order. */
     identityNumber?: Maybe<Scalars['String']>;
+    /** Indicates whether the order was created by a new customer with no email record. ***isGuestCheckout*** returns true if the order was created without customer email information. */
     isGuestCheckout?: Maybe<Scalars['Boolean']>;
+    /** It is the last name of the customer who created the order. */
     lastName?: Maybe<Scalars['String']>;
+    /** It is the phone number of the customer who created the order. */
     phone?: Maybe<Scalars['String']>;
 };
 export declare type OrderCustomerInput = {
+    /** It is the email of the customer who created the order. */
     email?: InputMaybe<Scalars['String']>;
+    /** It is the first name of the customer who created the order. */
     firstName?: InputMaybe<Scalars['String']>;
     id?: InputMaybe<Scalars['ID']>;
+    /** It is the last name of the customer who created the order. */
     lastName?: InputMaybe<Scalars['String']>;
 };
 export declare type OrderGiftPackageLine = {
     __typename?: 'OrderGiftPackageLine';
+    /** It is the price of the order gift package line. */
     price: Scalars['Float'];
+    /** It is the tax value of the order gift package line price. */
     taxValue?: Maybe<Scalars['Float']>;
 };
 export declare type OrderLineDiscount = {
@@ -1198,40 +1508,62 @@ export declare type OrderLineDiscount = {
     reason?: Maybe<Scalars['String']>;
 };
 export declare type OrderLineDiscountInput = {
+    /** It is the amount of the discount. */
     amount: Scalars['Float'];
+    /** It is the amount type enum. */
     amountType: AmountTypeEnum;
+    /** It is the reason of the discount. */
     reason?: InputMaybe<Scalars['String']>;
 };
 export declare type OrderLineItem = {
     __typename?: 'OrderLineItem';
     createdAt?: Maybe<Scalars['Timestamp']>;
+    /** It is the currency code of the order line item. */
     currencyCode?: Maybe<Scalars['String']>;
     deleted?: Maybe<Scalars['Boolean']>;
+    /** Information about the discount. Shows the details of the discount applied to the order line item. */
     discount?: Maybe<OrderLineDiscount>;
+    /** It is the discount price of the order line item. */
     discountPrice?: Maybe<Scalars['Float']>;
+    /** It is the final price of the order line item. If the discount price is less than the sell price, the final price is equal to the discount price. */
     finalPrice?: Maybe<Scalars['Float']>;
     id: Scalars['ID'];
+    /** It is the option information of the variant value in the order line item. */
     options?: Maybe<Array<OrderLineOption>>;
+    /** It is the original order line item id of the line item. If the line item is derived from another line item, this field is filled. */
     originalOrderLineItemId?: Maybe<Scalars['String']>;
+    /** It is the selling price of the order line item. */
     price: Scalars['Float'];
+    /** It is the quantity of variant in the order line item. */
     quantity: Scalars['Float'];
+    /** It is the status enum of the order line item */
     status: OrderLineItemStatusEnum;
+    /** It is the date when the last status of the order line item was updated. */
     statusUpdatedAt?: Maybe<Scalars['Timestamp']>;
+    /** It is the stock location id of the variant value in the order line item. */
     stockLocationId?: Maybe<Scalars['String']>;
+    /** It is the tax value of the order line item. */
     taxValue?: Maybe<Scalars['Float']>;
     updatedAt?: Maybe<Scalars['Timestamp']>;
+    /** Information about the variant of the order line item. */
     variant: OrderLineVariant;
 };
 export declare type OrderLineItemInput = {
     createdAt?: InputMaybe<Scalars['Timestamp']>;
     deleted?: InputMaybe<Scalars['Boolean']>;
+    /** It is the discount information that will be applied to the line item. */
     discount?: InputMaybe<OrderLineDiscountInput>;
+    /** It is the discount price of the line item. */
     discountPrice?: InputMaybe<Scalars['Float']>;
     id?: InputMaybe<Scalars['ID']>;
+    /** It is the options information in the order line item. */
     options?: InputMaybe<Array<OrderLineOptionInput>>;
+    /** It is the price of the line item. */
     price: Scalars['Float'];
+    /** It is the quantity of the line item. */
     quantity: Scalars['Float'];
     updatedAt?: InputMaybe<Scalars['Timestamp']>;
+    /** It is the variant information in the order line item. */
     variant: OrderLineVariantInput;
 };
 /** Order Line Item Status Enum */
@@ -1249,15 +1581,25 @@ export declare enum OrderLineItemStatusEnum {
 }
 export declare type OrderLineOption = {
     __typename?: 'OrderLineOption';
+    /** It is the name of order line option in the order line item. */
     name: Scalars['String'];
+    /** It is the product option id of the product in the order line item. */
     productOptionId: Scalars['String'];
+    /** It is the product option set id of the product in the order line item. */
     productOptionsSetId: Scalars['String'];
+    /** It is the type of the order line option. */
     type: ProductOptionTypeEnum;
     values: Array<OrderLineOptionValue>;
 };
 export declare type OrderLineOptionInput = {
+    /** It is the option id. */
     productOptionId: Scalars['String'];
+    /**
+     * It is the options set id information that option is connected to.
+     * * Is the entered id must be exist in ikas.
+     */
     productOptionsSetId: Scalars['String'];
+    /** A list of option value objects, each containing input about an option value. */
     values: Array<OrderLineOptionValueInput>;
 };
 export declare type OrderLineOptionValue = {
@@ -1267,69 +1609,119 @@ export declare type OrderLineOptionValue = {
     value: Scalars['String'];
 };
 export declare type OrderLineOptionValueInput = {
+    /** It is the price of the order line option */
     price?: InputMaybe<Scalars['Float']>;
+    /** It is the value of the order line option */
     value: Scalars['String'];
 };
 export declare type OrderLineVariant = {
     __typename?: 'OrderLineVariant';
+    /** It is the barcode list of the variant. */
     barcodeList?: Maybe<Array<Scalars['String']>>;
+    /** Information about the brand of variant. */
     brand?: Maybe<OrderLineVariantBrand>;
+    /** A list of category objects, each containing information about a category in the variant. */
     categories?: Maybe<Array<OrderLineVariantCategory>>;
+    /** It is the id of the variant. */
     id?: Maybe<Scalars['String']>;
+    /** It is the main image id of the variant. */
     mainImageId?: Maybe<Scalars['String']>;
+    /** It is the name of the variant. */
     name: Scalars['String'];
+    /** It is the price list of the variant. Different price lists may have different pricing. */
     prices?: Maybe<Array<OrderLineVariantPrice>>;
+    /** It is the product id of the variant. */
     productId?: Maybe<Scalars['String']>;
+    /** It is the sku of the variant. */
     sku?: Maybe<Scalars['String']>;
+    /** It is the slug of the variant. The slug value is unique each variant and product. */
     slug?: Maybe<Scalars['String']>;
+    /** It is the the tag id list  */
     tagIds?: Maybe<Array<Scalars['String']>>;
-    /** @deprecated Will be removed use OrderLineItem.taxValue */
+    /**
+     * It is the tax value of the variant.
+     * @deprecated Will be removed use OrderLineItem.taxValue
+     */
     taxValue?: Maybe<Scalars['Float']>;
     type?: Maybe<Scalars['Float']>;
+    /** It is the variant values of the variant. */
     variantValues?: Maybe<Array<OrderLineVariantVariantValues>>;
 };
 export declare type OrderLineVariantBrand = {
     __typename?: 'OrderLineVariantBrand';
+    /** It is the id of the brand of the variant. */
     id: Scalars['String'];
+    /** It is the name of the category. */
     name: Scalars['String'];
 };
 export declare type OrderLineVariantCategory = {
     __typename?: 'OrderLineVariantCategory';
-    categoryPath?: Maybe<Array<OrderLineVariantCategory>>;
+    /** It is the path of the category. */
+    categoryPath?: Maybe<Array<OrderLineVariantCategoryPath>>;
+    /** It is the id of the category of the variant. */
     id: Scalars['String'];
+    /** It is the name of the category. */
+    name: Scalars['String'];
+};
+export declare type OrderLineVariantCategoryPath = {
+    __typename?: 'OrderLineVariantCategoryPath';
+    /** It is the id of the category of the variant. */
+    id: Scalars['String'];
+    /** It is the name of the category. */
     name: Scalars['String'];
 };
 export declare type OrderLineVariantInput = {
+    /**
+     * It is the id of the variant. This field can be left blank if a product that is not registered in ikas will be sold.
+     * * Is the entered id must be exist in ikas.
+     */
     id?: InputMaybe<Scalars['String']>;
+    /** It is the name of the variant. */
     name?: InputMaybe<Scalars['String']>;
 };
 export declare type OrderLineVariantPrice = {
     __typename?: 'OrderLineVariantPrice';
+    /** It is the buy price of variant. */
     buyPrice?: Maybe<Scalars['Float']>;
+    /** It is the currency code of variant. */
     currency?: Maybe<Scalars['String']>;
+    /** It is the discount price of variant. */
     discountPrice?: Maybe<Scalars['Float']>;
+    /** It is the id of the price list to which the variant is associated. */
     priceListId?: Maybe<Scalars['String']>;
+    /** It is the sell price of variant. */
     sellPrice: Scalars['Float'];
 };
 export declare type OrderLineVariantVariantValues = {
     __typename?: 'OrderLineVariantVariantValues';
+    /** It is the order of variant value. The variant value order starts from 0. */
     order: Scalars['Float'];
+    /** It is the order of variant value. The variant value order starts from 0. */
     variantTypeId: Scalars['String'];
+    /** It is the order of variant value. The variant value order starts from 0. */
     variantTypeName?: Maybe<Scalars['String']>;
+    /** It is the order of variant value. The variant value order starts from 0. */
     variantValueId: Scalars['String'];
+    /** It is the order of variant value. The variant value order starts from 0. */
     variantValueName?: Maybe<Scalars['String']>;
 };
 export declare type OrderPackage = {
     __typename?: 'OrderPackage';
     createdAt?: Maybe<Scalars['Timestamp']>;
     deleted?: Maybe<Scalars['Boolean']>;
+    /** If the package was sent via the cargo application and received an error, this field is filled with an error message. */
     errorMessage?: Maybe<Scalars['String']>;
     id: Scalars['ID'];
+    /** An optional note, can attach to the order package. */
     note?: Maybe<Scalars['String']>;
+    /** It is the id list of the order line items in the package. */
     orderLineItemIds: Array<Scalars['String']>;
+    /** It is the fulfill status of the package */
     orderPackageFulfillStatus: OrderPackageFulfillStatusEnum;
+    /** It is the number of order package. Order package number is created with the order number - order package sequence format. */
     orderPackageNumber: Scalars['String'];
     stockLocationId: Scalars['String'];
+    /** It is the stock location id information where the package will be shipped. */
     trackingInfo?: Maybe<TrackingInfo>;
     updatedAt?: Maybe<Scalars['Timestamp']>;
 };
@@ -1380,7 +1772,9 @@ export declare type OrderPaginationResponse = {
 };
 export declare type OrderPaymentMethod = {
     __typename?: 'OrderPaymentMethod';
+    /** It is the amount charged by the payment method. */
     price: Scalars['Float'];
+    /** It is the type enum of the order payment method. */
     type: PaymentMethodTypeEnum;
 };
 /** Order Payment Status Enum */
@@ -1391,7 +1785,9 @@ export declare enum OrderPaymentStatusEnum {
 }
 export declare type OrderPriceList = {
     __typename?: 'OrderPriceList';
+    /** It is the id of the price list. */
     id: Scalars['String'];
+    /** It is the name of the price list. */
     name?: Maybe<Scalars['String']>;
 };
 export declare type OrderRefundInput = {
@@ -1409,28 +1805,43 @@ export declare type OrderRefundLineInput = {
 };
 export declare type OrderSalesChannel = {
     __typename?: 'OrderSalesChannel';
+    /** It is the sales channel id where the order was created. */
     id: Scalars['String'];
+    /** It is the sales channel name where the order was created. */
     name?: Maybe<Scalars['String']>;
+    /** It is the sales channel type where the order was created. */
     type?: Maybe<Scalars['Float']>;
 };
 export declare type OrderShippingLine = {
     __typename?: 'OrderShippingLine';
+    /** Indicates whether the shipping cost is refunded if the order is refunded. ***isRefunded*** returns ```true``` if the amount is refunded. */
     isRefunded?: Maybe<Scalars['Boolean']>;
+    /** It is the price of the order shipping line. */
     price: Scalars['Float'];
+    /** It is the shipping settings id of the order shipping line. */
     shippingSettingsId?: Maybe<Scalars['String']>;
+    /** It is the shipping zone rate id of the order shipping line. */
     shippingZoneRateId?: Maybe<Scalars['String']>;
+    /** It is the tax value of the order shipping line price. */
     taxValue?: Maybe<Scalars['Float']>;
+    /** It is the title of the order shipping line. */
     title: Scalars['String'];
 };
 export declare type OrderShippingLineInput = {
+    /** It is the price of the order shipping line. */
     price: Scalars['Float'];
+    /** It is the tax value of the order shipping line. */
     taxValue?: InputMaybe<Scalars['Float']>;
+    /** It is the title of the order shipping line. */
     title: Scalars['String'];
 };
 export declare type OrderStaff = {
     __typename?: 'OrderStaff';
+    /** It is the email of the staff who created the order. */
     email: Scalars['String'];
+    /** It is the first name of the staff who created the order. */
     firstName: Scalars['String'];
+    /** It is the last name of the staff who created the order. */
     lastName: Scalars['String'];
 };
 /** Order Status Enum */
@@ -1446,27 +1857,40 @@ export declare enum OrderStatusEnum {
 }
 export declare type OrderStorefront = {
     __typename?: 'OrderStorefront';
+    /** It is the storefront id where the order was created. */
     id: Scalars['String'];
+    /** It is the storefront name id where the order was created. */
     name?: Maybe<Scalars['String']>;
 };
 export declare type OrderStorefrontRouting = {
     __typename?: 'OrderStorefrontRouting';
+    /** It is the domain of the storefront routing. */
     domain?: Maybe<Scalars['String']>;
+    /** It is the storefront routing id used by the storefront when the order was created. */
     id: Scalars['String'];
+    /** It is the locale of the storefront routing. */
     locale?: Maybe<Scalars['String']>;
+    /** It is the path of the storefront routing. */
     path?: Maybe<Scalars['String']>;
+    /** It is the price list id that associated on the storefront routing. */
     priceListId?: Maybe<Scalars['String']>;
 };
 export declare type OrderStorefrontTheme = {
     __typename?: 'OrderStorefrontTheme';
+    /** It is the theme id customized by the merchant used by the storefront when the order was created. */
     id: Scalars['String'];
+    /** It is the theme theme name customized by the merchant used by the storefront when the order was created. */
     name?: Maybe<Scalars['String']>;
+    /** It is the ikas theme id used by the storefront when the order was created. */
     themeId?: Maybe<Scalars['String']>;
+    /** It is the ikas theme version id used by the storefront when the order was created. */
     themeVersionId?: Maybe<Scalars['String']>;
 };
 export declare type OrderTaxLine = {
     __typename?: 'OrderTaxLine';
+    /** It is the price of the order tax. */
     price: Scalars['Float'];
+    /** It is the percentage of the slice to which the calculated tax amount belongs. */
     rate: Scalars['Float'];
 };
 export declare type OrderTransactionInput = {
@@ -1493,49 +1917,77 @@ export declare enum PaymentMethodTypeEnum {
 export declare type PriceList = {
     __typename?: 'PriceList';
     createdAt?: Maybe<Scalars['Timestamp']>;
+    /** The currency of the product's price list. */
     currency: Scalars['String'];
     deleted?: Maybe<Scalars['Boolean']>;
     id: Scalars['ID'];
+    /** It is the name of the price list of the product. */
     name: Scalars['String'];
     updatedAt?: Maybe<Scalars['Timestamp']>;
 };
 export declare type Product = {
     __typename?: 'Product';
+    /** List of product attributes. */
     attributes?: Maybe<Array<ProductAttributeValue>>;
+    /** Brand of the product. */
     brand?: Maybe<ProductBrand>;
+    /** Brand id of the product. */
     brandId?: Maybe<Scalars['String']>;
+    /** List of categories of the product. */
     categories?: Maybe<Array<Category>>;
+    /** List category identifiers of the product. */
     categoryIds?: Maybe<Array<Scalars['String']>>;
     createdAt?: Maybe<Scalars['Timestamp']>;
     deleted?: Maybe<Scalars['Boolean']>;
+    /** Description of the product. */
     description?: Maybe<Scalars['String']>;
+    /** This is the variant type id that can be used to group variants by a specific variant type id. */
     groupVariantsByVariantTypeId?: Maybe<Scalars['String']>;
     id: Scalars['ID'];
+    /** HTML Metadata identifier of the product. */
     metaData?: Maybe<HTMLMetaData>;
+    /** Unique identifier of the product. */
     name: Scalars['String'];
+    /** Option set id of the product. */
     productOptionSetId?: Maybe<Scalars['String']>;
+    /** Variant types of the product. */
     productVariantTypes?: Maybe<Array<ProductVariantType>>;
+    /** List of sales channel ids of the product. */
     salesChannelIds?: Maybe<Array<Scalars['String']>>;
+    /** Short description of the product. */
     shortDescription?: Maybe<Scalars['String']>;
+    /** List of product tag identifiers. */
     tagIds?: Maybe<Array<Scalars['String']>>;
+    /** List of product tags. */
     tags?: Maybe<Array<ProductTag>>;
+    /** Translations for the product. */
     translations?: Maybe<Array<ProductTranslation>>;
+    /** Type of the product. */
     type: ProductTypeEnum;
     updatedAt?: Maybe<Scalars['Timestamp']>;
+    /** List of product variants. */
     variants: Array<Variant>;
+    /** Vendor id of the product. */
     vendorId?: Maybe<Scalars['String']>;
+    /** Weight of the product. */
     weight?: Maybe<Scalars['Float']>;
 };
 export declare type ProductAttribute = {
     __typename?: 'ProductAttribute';
     createdAt?: Maybe<Scalars['Timestamp']>;
     deleted?: Maybe<Scalars['Boolean']>;
+    /** Description of the attribute */
     description?: Maybe<Scalars['String']>;
     id: Scalars['ID'];
+    /** Name of the attribute */
     name: Scalars['String'];
+    /** Options of the attribute */
     options?: Maybe<Array<ProductAttributeOption>>;
+    /** Table template description for product attribute */
     tableTemplate?: Maybe<ProductAttributeTableTemplate>;
+    /** Translations for the attribute */
     translations?: Maybe<Array<ProductAttributeTranslation>>;
+    /** Type of the attribute */
     type: ProductAttributeTypeEnum;
     updatedAt?: Maybe<Scalars['Timestamp']>;
 };
@@ -1556,6 +2008,7 @@ export declare type ProductAttributeOption = {
     createdAt?: Maybe<Scalars['Timestamp']>;
     deleted?: Maybe<Scalars['Boolean']>;
     id: Scalars['ID'];
+    /** Name of the product attribute option */
     name: Scalars['String'];
     updatedAt?: Maybe<Scalars['Timestamp']>;
 };
@@ -1569,6 +2022,7 @@ export declare type ProductAttributeOptionInput = {
 export declare type ProductAttributeOptionTranslation = {
     __typename?: 'ProductAttributeOptionTranslation';
     id: Scalars['String'];
+    /** Name of the attribute option for translation. */
     name?: Maybe<Scalars['String']>;
 };
 export declare type ProductAttributeOptionTranslationInput = {
@@ -1578,6 +2032,7 @@ export declare type ProductAttributeOptionTranslationInput = {
 export declare type ProductAttributeTableCellData = {
     __typename?: 'ProductAttributeTableCellData';
     id: Scalars['String'];
+    /** Name of the product attribute table */
     name: Scalars['String'];
 };
 export declare type ProductAttributeTableCellDataInput = {
@@ -1586,7 +2041,9 @@ export declare type ProductAttributeTableCellDataInput = {
 };
 export declare type ProductAttributeTableTemplate = {
     __typename?: 'ProductAttributeTableTemplate';
+    /** List of columns for product attribute table. */
     columns: Array<ProductAttributeTableCellData>;
+    /** List of rows for product attribute table. */
     rows: Array<ProductAttributeTableCellData>;
 };
 export declare type ProductAttributeTableTemplateInput = {
@@ -1595,9 +2052,13 @@ export declare type ProductAttributeTableTemplateInput = {
 };
 export declare type ProductAttributeTranslation = {
     __typename?: 'ProductAttributeTranslation';
+    /** It is the description information of the translation. */
     description?: Maybe<Scalars['String']>;
+    /** It is the name information of the translation. */
     locale: Scalars['String'];
+    /** It is the information in which language the translation is saved. */
     name?: Maybe<Scalars['String']>;
+    /** List of translations for attribute options */
     options?: Maybe<Array<ProductAttributeOptionTranslation>>;
 };
 export declare type ProductAttributeTranslationInput = {
@@ -1620,8 +2081,11 @@ export declare enum ProductAttributeTypeEnum {
 }
 export declare type ProductAttributeValue = {
     __typename?: 'ProductAttributeValue';
+    /** Identifier of the product attribute */
     productAttributeId?: Maybe<Scalars['String']>;
+    /** Option identifier for the product attribute */
     productAttributeOptionId?: Maybe<Scalars['String']>;
+    /** Value of the product attribute */
     value?: Maybe<Scalars['String']>;
 };
 export declare type ProductAttributeValueInput = {
@@ -1633,44 +2097,65 @@ export declare type ProductBrand = {
     __typename?: 'ProductBrand';
     createdAt?: Maybe<Scalars['Timestamp']>;
     deleted?: Maybe<Scalars['Boolean']>;
+    /** The description of the product's brand. */
     description?: Maybe<Scalars['String']>;
     id: Scalars['ID'];
+    /** The image information of the product's brand. */
     imageId?: Maybe<Scalars['String']>;
+    /** It is the metadata information of the product brand. */
     metaData?: Maybe<HTMLMetaData>;
+    /** The name of the product's brand. */
     name: Scalars['String'];
     orderType?: Maybe<CategoryProductsOrderTypeEnum>;
+    /** It is the information of which sales channel the product brand is in. */
     salesChannelIds?: Maybe<Array<Scalars['String']>>;
+    /** It is the translation information of the product brand. */
     translations?: Maybe<Array<ProductBrandTranslation>>;
     updatedAt?: Maybe<Scalars['Timestamp']>;
 };
 export declare type ProductBrandInput = {
     createdAt?: InputMaybe<Scalars['Timestamp']>;
     deleted?: InputMaybe<Scalars['Boolean']>;
+    /** The description of the product's brand. */
     description?: InputMaybe<Scalars['String']>;
     id?: InputMaybe<Scalars['ID']>;
+    /** The image information of the product's brand. */
     imageId?: InputMaybe<Scalars['String']>;
+    /** It is the metadata information of the product brand. */
     metaData?: InputMaybe<HTMLMetaDataInput>;
+    /** The name of the product's brand. */
     name: Scalars['String'];
     orderType?: InputMaybe<CategoryProductsOrderTypeEnum>;
+    /** It is the information of which sales channel the product brand is in. */
     salesChannelIds?: InputMaybe<Array<Scalars['String']>>;
+    /** It is the translation information of the product brand. */
     translations?: InputMaybe<Array<ProductBrandTranslationInput>>;
     updatedAt?: InputMaybe<Scalars['Timestamp']>;
 };
 export declare type ProductBrandTranslation = {
     __typename?: 'ProductBrandTranslation';
+    /** It is the description information of the translation. */
     description?: Maybe<Scalars['String']>;
+    /** It is the name information of the translation. */
     locale: Scalars['String'];
+    /** It is the information in which language the translation is saved. */
     name?: Maybe<Scalars['String']>;
 };
 export declare type ProductBrandTranslationInput = {
+    /** It is the description information of the translation. */
     description?: InputMaybe<Scalars['String']>;
+    /** It is the name information of the translation. */
     locale: Scalars['String'];
+    /** It is the information in which language the translation is saved. */
     name?: InputMaybe<Scalars['String']>;
 };
 export declare type ProductImage = {
     __typename?: 'ProductImage';
+    /** Id of the product image. */
     imageId?: Maybe<Scalars['String']>;
+    /** Whether the image is main image for the product or not. */
     isMain: Scalars['Boolean'];
+    /** Order of the product image. */
     order: Scalars['Float'];
 };
 export declare type ProductImageInput = {
@@ -1725,10 +2210,15 @@ export declare type ProductPaginationResponse = {
 };
 export declare type ProductPrice = {
     __typename?: 'ProductPrice';
+    /** Buy price of product. */
     buyPrice?: Maybe<Scalars['Float']>;
+    /** Currency for the price of product. */
     currency?: Maybe<Scalars['String']>;
+    /** Discount price of product. */
     discountPrice?: Maybe<Scalars['Float']>;
+    /** Id of the price list that the product belongs to. */
     priceListId?: Maybe<Scalars['String']>;
+    /** Sell price of product. */
     sellPrice: Scalars['Float'];
 };
 export declare type ProductPriceInput = {
@@ -1740,10 +2230,15 @@ export declare type ProductPriceInput = {
 };
 export declare type ProductSearchResponse = {
     __typename?: 'ProductSearchResponse';
+    /** Number of search results listed in current page. */
     count: Scalars['Float'];
+    /** Search result */
     data: Scalars['JSON'];
+    /** Maximum number of results returned in each page. */
     limit: Scalars['Float'];
+    /** Current page number of the search results. */
     page: Scalars['Float'];
+    /** Total number of search results. */
     totalCount: Scalars['Float'];
 };
 export declare type ProductStockLocation = {
@@ -1761,10 +2256,14 @@ export declare type ProductStockLocationInput = {
     createdAt?: InputMaybe<Scalars['Timestamp']>;
     deleted?: InputMaybe<Scalars['Boolean']>;
     id?: InputMaybe<Scalars['ID']>;
+    /** It is the product id to which the variant associated. */
     productId: Scalars['String'];
+    /** It is the stock quantity of the variant. */
     stockCount: Scalars['Float'];
+    /** It is the stock location id information where the stock information will be edited. */
     stockLocationId: Scalars['String'];
     updatedAt?: InputMaybe<Scalars['Timestamp']>;
+    /** It is the of the variant. */
     variantId: Scalars['String'];
 };
 export declare type ProductStockLocationPaginationResponse = {
@@ -1784,7 +2283,9 @@ export declare type ProductTag = {
     createdAt?: Maybe<Scalars['Timestamp']>;
     deleted?: Maybe<Scalars['Boolean']>;
     id: Scalars['ID'];
+    /** The name of the product's tag. */
     name: Scalars['String'];
+    /** The name of the product's tag. */
     translations?: Maybe<Array<ProductTagTranslation>>;
     updatedAt?: Maybe<Scalars['Timestamp']>;
 };
@@ -1792,25 +2293,36 @@ export declare type ProductTagInput = {
     createdAt?: InputMaybe<Scalars['Timestamp']>;
     deleted?: InputMaybe<Scalars['Boolean']>;
     id?: InputMaybe<Scalars['ID']>;
+    /** The name of the product's tag. */
     name: Scalars['String'];
+    /** The name of the product's tag. */
     translations?: InputMaybe<Array<ProductTagTranslationInput>>;
     updatedAt?: InputMaybe<Scalars['Timestamp']>;
 };
 export declare type ProductTagTranslation = {
     __typename?: 'ProductTagTranslation';
+    /** It is the description information of the translation. */
     description?: Maybe<Scalars['String']>;
+    /** It is the name information of the translation. */
     locale: Scalars['String'];
+    /** It is the information in which language the translation is saved. */
     name?: Maybe<Scalars['String']>;
 };
 export declare type ProductTagTranslationInput = {
+    /** It is the description information of the translation. */
     description?: InputMaybe<Scalars['String']>;
+    /** It is the name information of the translation. */
     locale: Scalars['String'];
+    /** It is the information in which language the translation is saved. */
     name?: InputMaybe<Scalars['String']>;
 };
 export declare type ProductTranslation = {
     __typename?: 'ProductTranslation';
+    /** It is the description information of the translation. */
     description?: Maybe<Scalars['String']>;
+    /** It is the name information of the translation. */
     locale: Scalars['String'];
+    /** It is the information in which language the translation is saved. */
     name?: Maybe<Scalars['String']>;
 };
 export declare type ProductTranslationInput = {
@@ -1826,8 +2338,11 @@ export declare enum ProductTypeEnum {
 }
 export declare type ProductVariantType = {
     __typename?: 'ProductVariantType';
+    /** Order of the variant type. */
     order: Scalars['Float'];
+    /** Id of variant type. */
     variantTypeId: Scalars['String'];
+    /** List of variant value identifiers. */
     variantValueIds?: Maybe<Array<Scalars['String']>>;
 };
 export declare type ProductVariantTypeInput = {
@@ -1839,24 +2354,41 @@ export declare type Query = {
     __typename?: 'Query';
     /** By using this api you can get properties of merchant and merchant staff. */
     getAuthorizedApp?: Maybe<AuthorizedApp>;
+    /** Upload url for the specified image. */
     getImageUploadUrl: Scalars['String'];
     /** By using this api you can get properties of merchant and merchant staff. */
     getMerchant: MerchantResponse;
+    /** Using this api you can view all licenses owned by merchant. */
     getMerchantLicence: MerchantLicence;
     /** Using this api, you can view your sales channel. */
     getSalesChannel?: Maybe<SalesChannel>;
+    /**
+     * Using this api, you can view the categories of products.
+     * Search applies to following fields: `name`
+     */
     listCategory: Array<Category>;
     listCity: Array<City>;
     listCountry: Array<Country>;
     listCustomer: CustomerPaginationResponse;
     listDistrict: Array<District>;
+    /** Using this api, you can view the payment features that a merchant has created for the app. */
     listMerchantAppPayment: MerchantAppPaymentPaginationResponse;
     listOrder: OrderPaginationResponse;
     listPriceList: Array<PriceList>;
+    /**
+     * Use this query to list products.
+     * Sort applies to following fields: `updatedAt`
+     */
     listProduct: ProductPaginationResponse;
+    /** Use this query to list product attributes. */
     listProductAttribute: Array<ProductAttribute>;
+    /**
+     * Using this api, you can view the brands of products.
+     * Search applies to following fields: `name`
+     */
     listProductBrand: Array<ProductBrand>;
     listProductStockLocation: ProductStockLocationPaginationResponse;
+    /** Using this api, you can view the tags of products. */
     listProductTag: Array<ProductTag>;
     listSalesChannel: Array<SalesChannel>;
     listState: Array<State>;
@@ -1865,10 +2397,12 @@ export declare type Query = {
     /** Use this query to list storefront javascript scripts by supplying the `storefrontId` input. */
     listStorefrontJSScript: Array<StorefrontJSScript>;
     listTown: Array<Town>;
+    /** Using this api, you can view the brands of products. */
     listVariantType: Array<VariantType>;
     /** Use this query to list active webhooks of your application. */
     listWebhook: Array<Webhook>;
     me?: Maybe<MeResponse>;
+    /** Result(s) containing searched products. */
     searchProducts: ProductSearchResponse;
 };
 export declare type QuerygetImageUploadUrlArgs = {
@@ -1944,6 +2478,7 @@ export declare type QuerylistProductArgs = {
     includeDeleted?: InputMaybe<Scalars['Boolean']>;
     pagination?: InputMaybe<PaginationInput>;
     sku?: InputMaybe<StringFilterInput>;
+    sort?: InputMaybe<Scalars['String']>;
 };
 export declare type QuerylistProductAttributeArgs = {
     id?: InputMaybe<StringFilterInput>;
@@ -2061,9 +2596,13 @@ export declare type SaveStockLocationsInput = {
     productStockLocationInputs?: InputMaybe<Array<ProductStockLocationInput>>;
 };
 export declare type SearchInput = {
+    /** Barcode list search products. */
     barcodeList?: InputMaybe<Array<Scalars['String']>>;
+    /** Pagination input */
     pagination?: InputMaybe<PaginationInput>;
+    /** Query string to search products. */
     query?: InputMaybe<Scalars['String']>;
+    /** SKU list search products. */
     skuList?: InputMaybe<Array<Scalars['String']>>;
 };
 /** Shipping Method Enum */
@@ -2093,46 +2632,68 @@ export declare type State = {
 };
 export declare type StockLocation = {
     __typename?: 'StockLocation';
+    /** It is the address information of the stock location. */
     address?: Maybe<StockLocationAddress>;
     createdAt?: Maybe<Scalars['Timestamp']>;
     deleted?: Maybe<Scalars['Boolean']>;
     id: Scalars['ID'];
+    /** It is the name of the stock location. */
     name: Scalars['String'];
+    /** It is the type enum of the stock location. */
     type?: Maybe<StockLocationTypeEnum>;
     updatedAt?: Maybe<Scalars['Timestamp']>;
 };
 export declare type StockLocationAddress = {
     __typename?: 'StockLocationAddress';
+    /** It is the full address of the stock location. */
     address?: Maybe<Scalars['String']>;
+    /** It is the city information of the address. */
     city?: Maybe<StockLocationAddressCity>;
+    /** It is the country information of the address. */
     country?: Maybe<StockLocationAddressCountry>;
+    /** It is the district information of the address. */
     district?: Maybe<StockLocationAddressDistrict>;
+    /** It is the phone number of the address. */
     phone?: Maybe<Scalars['String']>;
+    /** It is the postal code of the address. */
     postalCode?: Maybe<Scalars['String']>;
+    /** It is the state information of the address. */
     state?: Maybe<StockLocationAddressState>;
 };
 export declare type StockLocationAddressCity = {
     __typename?: 'StockLocationAddressCity';
+    /** It is the code of the city of the address. */
     code?: Maybe<Scalars['String']>;
+    /** It is the id of the city of the address. */
     id?: Maybe<Scalars['String']>;
+    /** It is the name of the city of the address. */
     name: Scalars['String'];
 };
 export declare type StockLocationAddressCountry = {
     __typename?: 'StockLocationAddressCountry';
+    /** It is the code of the country of the address. */
     code?: Maybe<Scalars['String']>;
+    /** It is the id of the country of the address. */
     id?: Maybe<Scalars['String']>;
+    /** It is the name of the country of the address. */
     name: Scalars['String'];
 };
 export declare type StockLocationAddressDistrict = {
     __typename?: 'StockLocationAddressDistrict';
+    /** It is the code of the district of the address. */
     code?: Maybe<Scalars['String']>;
+    /** It is the id of the district of the address. */
     id?: Maybe<Scalars['String']>;
+    /** It is the name of the district of the address. */
     name?: Maybe<Scalars['String']>;
 };
 export declare type StockLocationAddressState = {
     __typename?: 'StockLocationAddressState';
+    /** It is the code of the state of the address. */
     code?: Maybe<Scalars['String']>;
+    /** It is the id of the state of the address. */
     id?: Maybe<Scalars['String']>;
+    /** It is the name of the state of the address. */
     name?: Maybe<Scalars['String']>;
 };
 /** Stock Location Types */
@@ -2219,22 +2780,38 @@ export declare type Town = {
 };
 export declare type TrackingInfo = {
     __typename?: 'TrackingInfo';
+    /** It is the barcode of the order package. */
     barcode?: Maybe<Scalars['String']>;
+    /** It is the name of the cargo company. */
     cargoCompany?: Maybe<Scalars['String']>;
+    /** Indicates whether the notification is sent to the customer after the cargo is delivered. ***isSendNotification*** returns true if the notification is sent. */
     isSendNotification?: Maybe<Scalars['Boolean']>;
+    /** It is the tracking link of the order package. */
     trackingLink?: Maybe<Scalars['String']>;
+    /** It is the tracking number of the order package. */
     trackingNumber?: Maybe<Scalars['String']>;
 };
 export declare type TrackingInfoDetailInput = {
+    /** It is the barcode of the order package. */
     barcode?: InputMaybe<Scalars['String']>;
+    /** It is the name of the cargo company. */
     cargoCompany?: InputMaybe<Scalars['String']>;
+    /** If the customer is to be informed after the cargo is delivered, this field can be sent as ```true```. */
     isSendNotification?: InputMaybe<Scalars['Boolean']>;
+    /** It is the tracking link of the order package. */
     trackingLink?: InputMaybe<Scalars['String']>;
+    /** It is the tracking number of the order package. */
     trackingNumber?: InputMaybe<Scalars['String']>;
 };
 export declare type UpdateOrderAddressesInput = {
+    /** The address information to which the order will be billing. */
     billingAddress?: InputMaybe<OrderAddressInput>;
+    /**
+     * It is the order id for which the invoice is issued.
+     *  * Is the entered id must be exist in ikas.
+     */
     orderId: Scalars['String'];
+    /** The address information to which the order will be shipping. */
     shippingAddress?: InputMaybe<OrderAddressInput>;
 };
 export declare type UpdateOrderInput = {
@@ -2244,33 +2821,56 @@ export declare type UpdateOrderInput = {
     restockItems?: InputMaybe<Scalars['Boolean']>;
 };
 export declare type UpdateOrderPackageStatusInput = {
+    /**
+     * It is the order id whose status will be updated.
+     *  * Is the entered id must be exist in ikas.
+     */
     orderId: Scalars['String'];
+    /** A list of package objects, each containing input about an package in the order. */
     packages: Array<UpdateOrderPackageStatusPackagesInput>;
 };
 export declare type UpdateOrderPackageStatusPackagesInput = {
+    /** If the package fulfill status is an ```ERROR``` , this field can be sent as full. */
     errorMessage?: InputMaybe<Scalars['String']>;
+    /**
+     * It is the package id whose status will be updated.
+     *  * Is the entered id must be exist in ikas.
+     */
     packageId: Scalars['String'];
+    /** It is the status enum  of the will be updated package */
     status: OrderPackageFulfillStatusEnum;
+    /** It is the tracking information of the package */
     trackingInfo?: InputMaybe<TrackingInfoDetailInput>;
 };
 export declare type UpdateProductSalesChannelStatusInput = {
+    /** Status of the product in the updated sales channels. */
     active: Scalars['Boolean'];
+    /** Id of the product to update its sales channels. */
     productId: Scalars['String'];
 };
 export declare type Variant = {
     __typename?: 'Variant';
+    /** List of variant attributes. */
     attributes?: Maybe<Array<ProductAttributeValue>>;
+    /** List of barcode for the variant. */
     barcodeList?: Maybe<Array<Scalars['String']>>;
     createdAt?: Maybe<Scalars['Timestamp']>;
     deleted?: Maybe<Scalars['Boolean']>;
     id: Scalars['ID'];
+    /** List of images for variant. */
     images?: Maybe<Array<ProductImage>>;
+    /** Whether the variant is active or not. */
     isActive?: Maybe<Scalars['Boolean']>;
+    /** List of prices for the variant. */
     prices: Array<ProductPrice>;
+    /** Whether to sell if variant is out of stock or not. */
     sellIfOutOfStock?: Maybe<Scalars['Boolean']>;
+    /** SKU of the variant. */
     sku?: Maybe<Scalars['String']>;
     updatedAt?: Maybe<Scalars['Timestamp']>;
+    /** List of variant value ids. */
     variantValueIds?: Maybe<Array<VariantValueRelation>>;
+    /** Weight of the variant. */
     weight?: Maybe<Scalars['Float']>;
 };
 export declare type VariantInput = {
@@ -2298,55 +2898,77 @@ export declare type VariantType = {
     createdAt?: Maybe<Scalars['Timestamp']>;
     deleted?: Maybe<Scalars['Boolean']>;
     id: Scalars['ID'];
+    /** Product variant type name information. ***For example: Size, Color, Number etc.***.It can be a maximum of 100 characters. */
     name: Scalars['String'];
+    /** Product variant type selection type. It can be choice or color. */
     selectionType: VariantSelectionTypeEnum;
+    /** It is the translation information of the product variant types. */
     translations?: Maybe<Array<VariantTypeTranslation>>;
     updatedAt?: Maybe<Scalars['Timestamp']>;
+    /** Variant values used in Variant type. *** For example, variant type: Size. Variant values can be thought of as S, M, L, XL. ***It is unique according to the value name.Values array size must have at least one element. */
     values: Array<VariantValue>;
 };
 export declare type VariantTypeInput = {
     createdAt?: InputMaybe<Scalars['Timestamp']>;
     deleted?: InputMaybe<Scalars['Boolean']>;
     id?: InputMaybe<Scalars['ID']>;
+    /** Product variant type name information. ***For example: Size, Color, Number etc.***.It can be a maximum of 100 characters. */
     name: Scalars['String'];
+    /** Product variant type selection type. It can be choice or color. */
     selectionType: VariantSelectionTypeEnum;
+    /** It is the translation information of the product variant types. */
     translations?: InputMaybe<Array<VariantTypeTranslationInput>>;
     updatedAt?: InputMaybe<Scalars['Timestamp']>;
+    /** Variant values used in Variant type. *** For example, variant type: Size. Variant values can be thought of as S, M, L, XL. ***It is unique according to the value name.Values array size must have at least one element. */
     values: Array<VariantValueInput>;
 };
 export declare type VariantTypeTranslation = {
     __typename?: 'VariantTypeTranslation';
+    /** It is the name information of the translation. */
     locale: Scalars['String'];
+    /** It is the information in which language the translation is saved. */
     name?: Maybe<Scalars['String']>;
+    /** It is the translation information of the values of variant types. */
     values?: Maybe<Array<VariantValueTranslation>>;
 };
 export declare type VariantTypeTranslationInput = {
+    /** It is the name information of the translation. */
     locale: Scalars['String'];
+    /** It is the information in which language the translation is saved. */
     name?: InputMaybe<Scalars['String']>;
+    /** It is the translation information of the values of variant types. */
     values?: InputMaybe<Array<VariantValueTranslationInput>>;
 };
 export declare type VariantValue = {
     __typename?: 'VariantValue';
+    /** It is the color code information of the variant values. It can be a maximum of 7 characters. */
     colorCode?: Maybe<Scalars['String']>;
     createdAt?: Maybe<Scalars['Timestamp']>;
     deleted?: Maybe<Scalars['Boolean']>;
     id: Scalars['ID'];
+    /** It is the name information of the values used in the Variant type. Value information of Variant type is unique according to name.It can be a maximum of 100 characters. */
     name: Scalars['String'];
+    /** It is the image information of the variant values. */
     thumbnailImageId?: Maybe<Scalars['String']>;
     updatedAt?: Maybe<Scalars['Timestamp']>;
 };
 export declare type VariantValueInput = {
+    /** It is the color code information of the variant values. It can be a maximum of 7 characters. */
     colorCode?: InputMaybe<Scalars['String']>;
     createdAt?: InputMaybe<Scalars['Timestamp']>;
     deleted?: InputMaybe<Scalars['Boolean']>;
     id?: InputMaybe<Scalars['ID']>;
+    /** It is the name information of the values used in the Variant type. Value information of Variant type is unique according to name.It can be a maximum of 100 characters. */
     name: Scalars['String'];
+    /** It is the image information of the variant values. */
     thumbnailImageId?: InputMaybe<Scalars['String']>;
     updatedAt?: InputMaybe<Scalars['Timestamp']>;
 };
 export declare type VariantValueRelation = {
     __typename?: 'VariantValueRelation';
+    /** Id of variant type. */
     variantTypeId: Scalars['String'];
+    /** iD of the variant value. */
     variantValueId: Scalars['String'];
 };
 export declare type VariantValueRelationInput = {
@@ -2356,10 +2978,12 @@ export declare type VariantValueRelationInput = {
 export declare type VariantValueTranslation = {
     __typename?: 'VariantValueTranslation';
     id: Scalars['String'];
+    /** It is the information in which language the translation is saved. */
     name?: Maybe<Scalars['String']>;
 };
 export declare type VariantValueTranslationInput = {
     id: Scalars['String'];
+    /** It is the information in which language the translation is saved. */
     name?: InputMaybe<Scalars['String']>;
 };
 /** **Webhook** model description. */