/** * Geins Management API * Geins Management API is a RESTful api that powers your applications and helps you manage your Geins services. Geins provides an easy-to-use and scalable solution for managing all aspects of an online store, from product listings and customer information to order processing and payment transactions. :::tip Tip With this API, you can build custom applications and integrate with third-party systems, feeds, dashboards and other bussiness logic apps. ::: ## Getting started Once you have created an account, you can start using the Management API by creating an `API User`. You can create as many API users as you need. Each `API user` is connected to a specific account so you can keep track of operations and manage keys. You can find all your API credentials in `Geins Merchant Center`. ### Fast track Use one of our [SDKs](https://docs.geins.io/docs/sdk/introduction) to get started quickly. The SDKs are available for the most popular programming languages and frameworks. Or, if you prefer to just take it for a test run: [![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/25895885-aaf6598f-1a7c-4949-85d7-ba846c42d553?action=collection%2Ffork&collection-url=entityId%3D25895885-aaf6598f-1a7c-4949-85d7-ba846c42d553%26entityType%3Dcollection%26workspaceId%3Da2a179ce-158e-46b0-8d06-e9640f45112c) ### Authentication Two authentication methods are required: - `Basic Auth` - `API Key` All API credentials can be found in `Geins Merchant Center`. #### Basic Auth A Basic auth `Authorization` header needs to be included in every request. The value should be `Basic ` where `` is the Base64 encoding of your `API username` and `API password` joined by a single colon `:`. See [Wikipedia](https://en.wikipedia.org/wiki/Basic_access_authentication) for more information on Basic auth. #### API Key An `X-ApiKey` header needs to be included in every request. This header should contain the value of your `API key`. #### Example ```bash curl -X GET \"https://mgmtapi.geins.io/API/Market/List\" \\ -H \"Authorization: Basic [USER-CREDENTIALS-BASE64-ENCODED]\" \\ -H \"X-ApiKey: [API-KEY]\" ``` * * The version of the OpenAPI document: v1.10.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { CategoryModelsReadCategory } from './CategoryModelsReadCategory'; import type { MarketModelsMarket } from './MarketModelsMarket'; import type { PriceListModelsReadPriceListPrice } from './PriceListModelsReadPriceListPrice'; import type { ProductModelsReadDiscountCampaign } from './ProductModelsReadDiscountCampaign'; import type { ProductModelsReadFeedMembership } from './ProductModelsReadFeedMembership'; import type { ProductModelsReadImage } from './ProductModelsReadImage'; import type { ProductModelsReadProductItem } from './ProductModelsReadProductItem'; import type { ProductModelsReadProductUrl } from './ProductModelsReadProductUrl'; import type { ProductModelsReadRelatedProduct } from './ProductModelsReadRelatedProduct'; import type { ProductParameterModelsReadProductParameterValue } from './ProductParameterModelsReadProductParameterValue'; import type { SharedModelsLocalizableContent } from './SharedModelsLocalizableContent'; import type { VariantModelsReadVariant } from './VariantModelsReadVariant'; /** * A product. * @export * @interface ProductModelsReadProduct */ export interface ProductModelsReadProduct { /** * The unique identifier for the product. * @type {number} * @memberof ProductModelsReadProduct */ productId?: number; /** * The article number of the product. * @type {string} * @memberof ProductModelsReadProduct */ articleNumber?: string; /** * The localized names of the product. * @type {Array} * @memberof ProductModelsReadProduct */ names?: Array; /** * The date the product was created. * @type {Date} * @memberof ProductModelsReadProduct */ dateCreated?: Date; /** * The date the product was last updated. * @type {Date} * @memberof ProductModelsReadProduct */ dateUpdated?: Date; /** * The date the product was first available. * @type {Date} * @memberof ProductModelsReadProduct */ dateFirstAvailable?: Date; /** * The current state of the product. * @type {boolean} * @memberof ProductModelsReadProduct */ active?: boolean; /** * The purchase price in the currency defined in PurchasePriceCurrency. * @type {number} * @memberof ProductModelsReadProduct */ purchasePrice?: number; /** * The 3-letter ISO 4217 currency code for the amount given in PurchasePrice. * @type {string} * @memberof ProductModelsReadProduct */ purchasePriceCurrency?: string; /** * Localized short texts for the product. * @type {Array} * @memberof ProductModelsReadProduct */ shortTexts?: Array; /** * Localized long texts for the product. * @type {Array} * @memberof ProductModelsReadProduct */ longTexts?: Array; /** * Localized tech texts for the product. * @type {Array} * @memberof ProductModelsReadProduct */ techTexts?: Array; /** * The items belonging to the product. * @type {Array} * @memberof ProductModelsReadProduct */ items?: Array; /** * The current prices of the product. * @type {Array} * @memberof ProductModelsReadProduct */ prices?: Array; /** * The categories the product belongs to. * @type {Array} * @memberof ProductModelsReadProduct */ categories?: Array; /** * The images for the product * @type {Array} * @memberof ProductModelsReadProduct */ images?: Array; /** * The brand id of the product. * @type {number} * @memberof ProductModelsReadProduct */ brandId?: number; /** * The brand name of the product. * @type {string} * @memberof ProductModelsReadProduct */ brandName?: string; /** * The supplier id of the product. * @type {number} * @memberof ProductModelsReadProduct */ supplierId?: number; /** * The supplier name of the product. * @type {string} * @memberof ProductModelsReadProduct */ supplierName?: string; /** * The parameter values associated with the product. * @type {Array} * @memberof ProductModelsReadProduct */ parameterValues?: Array; /** * The variants for this product. * @type {Array} * @memberof ProductModelsReadProduct */ variants?: Array; /** * The markets for this product * @type {Array} * @memberof ProductModelsReadProduct */ markets?: Array; /** * The vat percent for this product. Eg) 0.25 meaning 25% VAT. * @type {number} * @memberof ProductModelsReadProduct */ vat?: number; /** * The filename of this products primary image. * @type {string} * @memberof ProductModelsReadProduct */ primaryImage?: string; /** * Id of freight class. * @type {number} * @memberof ProductModelsReadProduct */ freightClassId?: number; /** * Intrastat code of the product. * @type {string} * @memberof ProductModelsReadProduct */ intrastatCode?: string; /** * Country of orgin of product. * @type {string} * @memberof ProductModelsReadProduct */ countryOfOrigin?: string; /** * Id of Variant Group to which the product is associated. * @type {number} * @memberof ProductModelsReadProduct */ variantGroupId?: number; /** * Id of VAT. * @type {number} * @memberof ProductModelsReadProduct */ vatId?: number; /** * External Id of the product. * @type {string} * @memberof ProductModelsReadProduct */ externalId?: string; /** * Activation date for the product. * @type {Date} * @memberof ProductModelsReadProduct */ activationDate?: Date; /** * The feeds the product is a member of. * @type {Array} * @memberof ProductModelsReadProduct */ feeds?: Array; /** * All canonical urls for the product. * @type {Array} * @memberof ProductModelsReadProduct */ urls?: Array; /** * The main category id for the product. * @type {number} * @memberof ProductModelsReadProduct */ mainCategoryId?: number; /** * The related products for the product. * @type {Array} * @memberof ProductModelsReadProduct */ relatedProducts?: Array; /** * The discount campaigns for the product. * @type {Array} * @memberof ProductModelsReadProduct */ discountCampaigns?: Array; } /** * Check if a given object implements the ProductModelsReadProduct interface. */ export declare function instanceOfProductModelsReadProduct(value: object): boolean; export declare function ProductModelsReadProductFromJSON(json: any): ProductModelsReadProduct; export declare function ProductModelsReadProductFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProductModelsReadProduct; export declare function ProductModelsReadProductToJSON(value?: ProductModelsReadProduct | null): any;