/** * 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 { OrderCheckoutOrderRow } from './OrderCheckoutOrderRow'; import type { OrderFreightClass } from './OrderFreightClass'; /** * * @export * @interface OrderCheckoutOrder */ export interface OrderCheckoutOrder { /** * * @type {string} * @memberof OrderCheckoutOrder */ orderId?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ externalOrderId?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ cartId?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ sessionId?: string; /** * * @type {number} * @memberof OrderCheckoutOrder */ siteId?: number; /** * * @type {string} * @memberof OrderCheckoutOrder */ currency?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ status?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ ipAddress?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ message?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ internalMessage?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ locale?: string; /** * * @type {Array} * @memberof OrderCheckoutOrder */ rows?: Array; /** * * @type {number} * @memberof OrderCheckoutOrder */ campaignId?: number; /** * * @type {string} * @memberof OrderCheckoutOrder */ campaignCode?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ campaignName?: string; /** * * @type {Array} * @memberof OrderCheckoutOrder */ campaignIds?: Array; /** * * @type {Array} * @memberof OrderCheckoutOrder */ campaignNames?: Array; /** * * @type {number} * @memberof OrderCheckoutOrder */ customerId?: number; /** * * @type {number} * @memberof OrderCheckoutOrder */ customerTypeId?: number; /** * * 0 = Unknown * 1 = Female * 2 = Male * @type {number} * @memberof OrderCheckoutOrder */ gender?: OrderCheckoutOrderGenderEnum; /** * * @type {Date} * @memberof OrderCheckoutOrder */ dateOfBirth?: Date; /** * * @type {string} * @memberof OrderCheckoutOrder */ personalId?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ userAgent?: string; /** * * @type {{ [key: string]: string; }} * @memberof OrderCheckoutOrder */ metaData?: { [key: string]: string; }; /** * * @type {number} * @memberof OrderCheckoutOrder */ memberId?: number; /** * * @type {number} * @memberof OrderCheckoutOrder */ paymentId?: number; /** * * @type {string} * @memberof OrderCheckoutOrder */ transactionId?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ secondaryTransactionId?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ country?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ company?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ organizationNumber?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ firstName?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ lastName?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ email?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ address1?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ address2?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ zip?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ city?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ region?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ phone?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ mobilePhone?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ careOf?: string; /** * * @type {number} * @memberof OrderCheckoutOrder */ shippingId?: number; /** * * @type {string} * @memberof OrderCheckoutOrder */ shippingCountry?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ shippingCompany?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ shippingOrganizationNumber?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ shippingFirstName?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ shippingLastName?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ shippingEmail?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ shippingAddress1?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ shippingAddress2?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ shippingZip?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ shippingCity?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ shippingRegion?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ shippingPhone?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ shippingMobilePhone?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ shippingCareOf?: string; /** * * @type {string} * @memberof OrderCheckoutOrder */ pickupPoint?: string; /** * * @type {Date} * @memberof OrderCheckoutOrder */ desiredDeliveryDate?: Date; /** * * @type {OrderFreightClass} * @memberof OrderCheckoutOrder */ freightClass?: OrderFreightClass; /** * * @type {number} * @memberof OrderCheckoutOrder */ freeShippingLimit?: number; /** * * @type {boolean} * @memberof OrderCheckoutOrder */ freeShippingFromLimit?: boolean; /** * * @type {boolean} * @memberof OrderCheckoutOrder */ freeShippingFromCampaign?: boolean; /** * * @type {number} * @memberof OrderCheckoutOrder */ readonly sum?: number; /** * * @type {number} * @memberof OrderCheckoutOrder */ expectedSum?: number; /** * * @type {number} * @memberof OrderCheckoutOrder */ readonly orderValueIncVat?: number; /** * * @type {number} * @memberof OrderCheckoutOrder */ readonly orderValueExVat?: number; /** * * @type {number} * @memberof OrderCheckoutOrder */ readonly itemValueIncVat?: number; /** * * @type {number} * @memberof OrderCheckoutOrder */ readonly itemValueExVat?: number; /** * * @type {number} * @memberof OrderCheckoutOrder */ discountIncVat?: number; /** * * @type {number} * @memberof OrderCheckoutOrder */ discountExVat?: number; /** * * @type {number} * @memberof OrderCheckoutOrder */ percentDiscount?: number; /** * * @type {number} * @memberof OrderCheckoutOrder */ balance?: number; /** * * @type {number} * @memberof OrderCheckoutOrder */ shippingFeeIncVat?: number; /** * * @type {number} * @memberof OrderCheckoutOrder */ shippingFeeExVat?: number; /** * * @type {number} * @memberof OrderCheckoutOrder */ paymentFeeIncVat?: number; /** * * @type {number} * @memberof OrderCheckoutOrder */ paymentFeeExVat?: number; } /** * @export */ export declare const OrderCheckoutOrderGenderEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; }; export type OrderCheckoutOrderGenderEnum = typeof OrderCheckoutOrderGenderEnum[keyof typeof OrderCheckoutOrderGenderEnum]; /** * Check if a given object implements the OrderCheckoutOrder interface. */ export declare function instanceOfOrderCheckoutOrder(value: object): boolean; export declare function OrderCheckoutOrderFromJSON(json: any): OrderCheckoutOrder; export declare function OrderCheckoutOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderCheckoutOrder; export declare function OrderCheckoutOrderToJSON(value?: OrderCheckoutOrder | null): any;