/** * 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. */ /** * An order query. * @export * @interface OrderModelsOrderQuery */ export interface OrderModelsOrderQuery { /** * Given a date, only orders updated after the provided date will be returned. * @type {Date} * @memberof OrderModelsOrderQuery */ updated?: Date; /** * Comma separated list of statuses to filter on. * Valid statuses are: * cancelled * on-hold * inactive * refunded * partial * backorder * completed * pending * @type {string} * @memberof OrderModelsOrderQuery */ statusList?: string; /** * Id of a market. * @type {number} * @memberof OrderModelsOrderQuery */ marketId?: number; /** * Name of a payment method. * @type {string} * @memberof OrderModelsOrderQuery */ paymentName?: string; /** * Id of a parcel group. * @type {number} * @memberof OrderModelsOrderQuery */ parcelGroupId?: number; /** * The id of a customer. * @type {number} * @memberof OrderModelsOrderQuery */ customerId?: number; /** * The email of a customer. * @type {string} * @memberof OrderModelsOrderQuery */ email?: string; /** * Comma separated list of child-collections to also include in the query result. * Possible values are: * rows * paymentdetails * shippingdetails * refunds * @type {string} * @memberof OrderModelsOrderQuery */ include?: string; /** * This status can be used by an external system to change the status of an order, such as failed or done. * Predefined statuses are: * 0 = None * 10 = New * 20 = Processing * 30 = Failed * 40 = Done * @type {number} * @memberof OrderModelsOrderQuery */ externalOrderStatus?: number; /** * If true, will combine all order rows that are part of a container into a single container row. * @type {boolean} * @memberof OrderModelsOrderQuery */ combineProductContainerRows?: boolean; /** * The packing place to get orders from. * @type {number} * @memberof OrderModelsOrderQuery */ packingLocationId?: number; } /** * Check if a given object implements the OrderModelsOrderQuery interface. */ export declare function instanceOfOrderModelsOrderQuery(value: object): boolean; export declare function OrderModelsOrderQueryFromJSON(json: any): OrderModelsOrderQuery; export declare function OrderModelsOrderQueryFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderModelsOrderQuery; export declare function OrderModelsOrderQueryToJSON(value?: OrderModelsOrderQuery | null): any;