Building the API client library requires Maven to be installed.
To install the API client library to your local Maven repository, simply execute:
mvn install
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn deploy
Refer to the official documentation for more information.
Add this dependency to your project's POM:
<dependency>
<groupId>org.openapitools</groupId>
<artifactId>openapi-android-client</artifactId>
<version>1.0.0</version>
<scope>compile</scope>
</dependency>
Add this dependency to your project's build file:
compile "org.openapitools:openapi-android-client:1.0.0"
At first generate the JAR by executing:
mvn package
Then manually install the following JARs:
- target/openapi-android-client-1.0.0.jar
- target/lib/*.jar
Please follow the installation instruction and execute the following Java code:
import org.openapitools.client.api.BrandApi;
public class BrandApiExample {
public static void main(String[] args) {
BrandApi apiInstance = new BrandApi();
BrandModelsWriteBrand brand = new BrandModelsWriteBrand(); // BrandModelsWriteBrand | The brand to create.
try {
EnvelopeBrandModelsReadBrand result = apiInstance.createBrand(brand);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BrandApi#createBrand");
e.printStackTrace();
}
}
}
All URIs are relative to https://mgmtapi.geins.io
Class | Method | HTTP request | Description |
---|---|---|---|
BrandApi | createBrand | POST /API/Brand | Create a new brand |
BrandApi | getBrandById | GET /API/Brand/{id} | Get a specific brand |
BrandApi | queryBrands | POST /API/Brand/Query | Query brands |
BrandApi | updateBrand | PUT /API/Brand/{id} | Updates a brand |
CategoryApi | createCategory | POST /API/Category | Create a new category |
CategoryApi | getCategoryById | GET /API/Category/{id} | Get a specific category |
CategoryApi | queryCategories | POST /API/Category/Query | Query categories |
CategoryApi | updateCategory | PUT /API/Category/{id} | Update a category |
MarketApi | getMarketById | GET /API/Market/{marketId} | Get a specific market |
MarketApi | listMarkets | GET /API/Market/List | Gets a list of all markets |
OrderApi | addCommentToOrder | POST /API/Order/{id}/Comment | Adds a comment to the order |
OrderApi | createOrder | POST /API/Order | Post a new order |
OrderApi | createOrderId | POST /API/Order/Id | Create a new order id |
OrderApi | deleteOrder | DELETE /API/Order/{id} | Deletes or deactivates an order |
OrderApi | getCaptureById | GET /API/Order/Capture/{captureId} | Get Capture by Id |
OrderApi | getOrderById | GET /API/Order/{id}/{include} | Get an instance of a order |
OrderApi | getOrderStatuses | GET /API/Order/Statuses | Get a list of available order statuses |
OrderApi | getRefundById | GET /API/Order/Refund/{refundId} | Get Refund by Id |
OrderApi | partialUpdateOfOrder | PATCH /API/Order/{id} | Partial update of an order |
OrderApi | queryOrders | POST /API/Order/Query | Query the order repository |
OrderApi | setCaptureAsProcessed | POST /API/Order/Capture/SetAsProcessed | Set a capture as processed (= captured) |
OrderApi | setPaymentAsPayed | POST /API/Order/PaymentDetail/{paymentDetailId}/SetAsPayed | Set Payment Detail as payed |
OrderApi | setRefundAsProcessed | POST /API/Order/Refund/SetAsProcessed | Set a refund as processed (= settled) |
OrderApi | updateOrderStatus | POST /API/Order/{id}/Status/{status}/{transactionId}/{secondaryTransactionId} | Update order status |
OrderApi | updateTransactionData | POST /API/Order/{id}/TransactionData | Updates transaction data on an order |
OrderApi | validateOrder | POST /API/Order/ValidateCreation | Validates order data for order creation. |
PageAreaApi | createOrUpdateAPageArea | POST /API/PageArea | Create or update a page area |
PageAreaApi | createOrUpdatePageAreaFamily | POST /API/PageAreaFamily | Create or update a page area family |
PageAreaApi | getPageArea | GET /API/PageArea/{name} | Get a specific page area |
PageAreaApi | getPageAreaFamily | GET /API/PageAreaFamily/{familyId} | Get a specific page area family |
PageAreaApi | listPageAreaFamilies | GET /API/PageAreaFamily/List | Gets a list of all page area families, including nested data |
PaymentApi | queryPaymentOptions | POST /API/Payment/Query | Query payment options |
PriceListApi | listPriceLists | GET /API/PriceList/List | Get all price list definitions |
PriceListApi | updatePricelistPrices | PUT /API/PriceList/Price | Updates price list prices |
ProductApi | addAvailabilityMonitor | POST /API/Product/MonitorAvailability | Add a product availability monitor |
ProductApi | addCategoryToProduct | PUT /API/Product/{productId}/Category | Adds a category relation to a product |
ProductApi | addImageToProduct | PUT /API/Product/{productId}/Image/{imageName} | Adds an image relation to a product |
ProductApi | addRelatedProductsToProduct | PUT /API/Product/{productId}/Related | Add related products to a product |
ProductApi | batchUpdateProductItems | PUT /API/Product/Items | Updates product items in batch |
ProductApi | batchUpdateStockValues | PUT /API/Product/Stock | Update stock values for multiple product items |
ProductApi | createProduct | POST /API/Product | Create a new product |
ProductApi | createProductItems | POST /API/Product/{productId}/Item | Create a new product item |
ProductApi | getProductById | GET /API/Product/{productId} | Get a specific product |
ProductApi | getProductItemById | GET /API/Product/Item/{itemId} | Get a specific product item |
ProductApi | linkRelatedProductsByRelationId | PUT /API/Product/{productId}/Related/{relationTypeId} | Add related products to a product using a fixed relation type |
ProductApi | listAllProductItemsPaged | GET /API/Product/Items/{page} | Get all product items with pagination |
ProductApi | listFeeds | GET /API/Product/Feeds | Gets a list of all feeds |
ProductApi | listProductItems | GET /API/Product/Items | Get all product items |
ProductApi | listProductRelationTypes | GET /API/Product/RelationTypes | Gets a list of product relation types |
ProductApi | queryProducts | POST /API/Product/Query | Query products |
ProductApi | queryProductsPaged | POST /API/Product/Query/{page} | Query products with pagination |
ProductApi | queryStock | POST /API/Product/Stock/Query | Query stock |
ProductApi | updateProduct | PUT /API/Product/{productId} | Updates a product |
ProductApi | updateProductItem | PUT /API/Product/Item/{itemId} | Updates a product item |
ProductParameterApi | batchReplaceProductParameterValues | POST /API/ProductParameter/Values | Replace multiple product parameter values |
ProductParameterApi | batchUpdateProductParameterValues | PUT /API/ProductParameter/Values | Update multiple product parameter values |
ProductParameterApi | createOrUpdateProductParameterValue | POST /API/ProductParameter/Value | Create or update a new product parameter value |
ProductParameterApi | createProductParameter | POST /API/ProductParameter | Create a new product parameter |
ProductParameterApi | createProductParameterGroup | POST /API/ProductParameter/Group | Create a new product parameter group |
ProductParameterApi | createProductParameterPredefinedValue | POST /API/ProductParameter/PredefinedValue | Create a new predefined value for a product parameter |
ProductParameterApi | getProductParameterById | GET /API/ProductParameter/{id} | Get a specific product parameter |
ProductParameterApi | getProductParameterGroupById | GET /API/ProductParameter/Group/{id} | Get a specific product parameter group |
ProductParameterApi | getProductParameterPredefinedValue | GET /API/ProductParameter/PredefinedValue/{id} | Get a specific predefined value for a product parameter |
ProductParameterApi | getProductParameterValue | GET /API/ProductParameter/Value/{id} | Get a specific product parameter value |
ProductParameterApi | updateProductParameter | PUT /API/ProductParameter/{id} | Updates a product parameter |
ProductParameterApi | updateProductParameterGroup | PUT /API/ProductParameter/Group/{id} | Update a product parameter group |
ShippingApi | createParcelGroup | POST /API/Shipping/ParcelGroup | Create a new parcel group |
ShippingApi | queryShippingOptions | POST /API/Shipping/Query | Query shipping options |
SupplierApi | createSupplier | POST /API/Supplier | Create a new supplier |
SupplierApi | getSupplierById | GET /API/Supplier/{id} | Get a specific supplier |
SupplierApi | querySuppliers | POST /API/Supplier/Query | Query suppliers |
SupplierApi | updateSupplier | PUT /API/Supplier/{id} | Updates a supplier |
UserApi | createUserProfile | POST /API/User | Create user profile |
UserApi | deleteUserProfile | DELETE /API/User/email | Delete user profile |
UserApi | getUserProfile | POST /API/User/Query | Get a specific user profile |
UserApi | updateUserProfile | PUT /API/User | Update user profile |
VariantApi | addProductToVariantGroup | PUT /API/VariantGroup/{groupId}/{productId} | Adds a product to an existing group |
VariantApi | addProductToVariantGroupByProductId | PUT /API/Variant/{productId1}/{productId2} | Adds a product to an existing group |
VariantApi | createVariantGroup | POST /API/VariantGroup | Create a new variant group |
VariantApi | createVariantGroupWithProduct | POST /API/Variant/{productId}/VariantGroup | Create a new group for the provided product id |
VariantApi | deleteVariantGroup | DELETE /API/VariantGroup/{groupId} | Delete an entire variant group |
VariantApi | deleteVariantGroupByProductId | DELETE /API/Variant/{productId}/VariantGroup | Delete an entire variant group |
VariantApi | getVariantGroup | GET /API/VariantGroup/{groupId} | Get a specific variant group |
VariantApi | getVariantGroupByProductId | GET /API/Variant/{productId}/VariantGroup | Get the variant group for the provided id |
VariantApi | getVariantLabels | GET /API/Variant/Labels | Get all valid variant labels |
VariantApi | removeProductFromVariantGroup | DELETE /API/Variant/{productId} | Remove a product from its variant group |
VariantApi | updateVariant | PUT /API/Variant/{productId} | Adds the variant details for the product with the provided ID |
VariantApi | updateVariantGroup | PUT /API/VariantGroup/{groupId} | Updates the settings of a group |
- APIOrderOrderComment
- APIOrderTransactionData
- BrandModelsBrandQuery
- BrandModelsReadBrand
- BrandModelsWriteBrand
- CategoryModelsCategoryQuery
- CategoryModelsReadCategory
- CategoryModelsWriteCategory
- ContainerRestrictionSetupContainerRestrictionConfiguration
- Envelope
- EnvelopeBrandModelsReadBrand
- EnvelopeCategoryModelsReadCategory
- EnvelopeInt
- EnvelopeListProductModelsReadFeed
- EnvelopeListProductModelsReadProduct
- EnvelopeListProductModelsReadProductItem
- EnvelopeListProductModelsReadRelationType
- EnvelopeMarketModelsMarket
- EnvelopePageAreaModelsReadPageArea
- EnvelopePageAreaModelsReadPageAreaFamily
- EnvelopeProductModelsReadProduct
- EnvelopeProductModelsReadProductItem
- EnvelopeProductParameterModelsReadProductParameter
- EnvelopeProductParameterModelsReadProductParameterGroup
- EnvelopeProductParameterModelsReadProductParameterPredefinedValue
- EnvelopeProductParameterModelsReadProductParameterValue
- EnvelopeString
- EnvelopeSupplierModelsReadSupplier
- EnvelopeUserModelsReadUserProfile
- EnvelopeVariantModelsReadVariant
- EnvelopeVariantModelsReadVariantGroup
- MarketModelsMarket
- OrderCapture
- OrderCaptureRow
- OrderCheckoutOrder
- OrderCheckoutOrderRow
- OrderFreightClass
- OrderModelsAddress
- OrderModelsOrder
- OrderModelsOrderQuery
- OrderModelsOrderRow
- OrderModelsOrderStatus
- OrderModelsOrderUpdate
- OrderModelsPaymentDetail
- OrderModelsRefund
- OrderModelsShippingDetail
- OrderProcessedCapture
- OrderProcessedRefund
- OrderRefund
- OrderRefundRow
- OrderValidateOrderCreationRequest
- OrderValidateOrderCreationRequestStockItem
- PageAreaModelsReadPageArea
- PageAreaModelsReadPageAreaFamily
- PageAreaModelsReadPageWidget
- PageAreaModelsReadPageWidgetContainer
- PageAreaModelsWritePageArea
- PageAreaModelsWritePageAreaFamily
- PageResult
- PageWidgetLazyLoadSetupLazyLoadCollectionConfiguration
- PageWidgetLazyLoadSetupLazyLoadConfiguration
- PaymentModelsPaymentOption
- PaymentModelsPaymentOptionQuery
- PriceListModelsPriceList
- PriceListModelsPriceListPriceResponse
- PriceListModelsReadPriceListPrice
- PriceListModelsWritePriceListPrice
- ProductModelsMonitorSku
- ProductModelsProductCategory
- ProductModelsProductQuery
- ProductModelsReadFeed
- ProductModelsReadFeedMembership
- ProductModelsReadImage
- ProductModelsReadProduct
- ProductModelsReadProductItem
- ProductModelsReadProductItemStock
- ProductModelsReadProductUrl
- ProductModelsReadRelatedProduct
- ProductModelsReadRelationType
- ProductModelsReadShippingFee
- ProductModelsRelatedProductEnvelope
- ProductModelsStockEnvelope
- ProductModelsWriteProduct
- ProductModelsWriteProductItem
- ProductModelsWriteProductItemStock
- ProductModelsWriteRelatedProduct
- ProductParameterModelsReadProductParameter
- ProductParameterModelsReadProductParameterGroup
- ProductParameterModelsReadProductParameterPredefinedValue
- ProductParameterModelsReadProductParameterValue
- ProductParameterModelsWriteProductParameter
- ProductParameterModelsWriteProductParameterGroup
- ProductParameterModelsWriteProductParameterPredefinedValue
- ProductParameterModelsWriteProductParameterValue
- ProductParameterModelsWriteProductParameterValueBatch
- ProductProductItemEnvelope
- SharedModelsLocalizableContent
- ShippingModelsParcelGroupOptions
- ShippingModelsShippingOption
- ShippingModelsShippingQuery
- ShippingModelsShippingSubOption
- SupplierModelsReadSupplier
- SupplierModelsSupplierQuery
- SupplierModelsWriteSupplier
- SystemNullableValidationConfiguration
- UserModelsReadUserProfile
- UserModelsUserProfileQuery
- UserModelsWriteUserProfile
- VariantModelsReadVariant
- VariantModelsReadVariantGroup
- VariantModelsWriteVariant
- VariantModelsWriteVariantGroup
- WidgetRestrictionSetupWidgetRestrictionConfiguration
Authentication schemes defined for the API:
-
Type: API key
-
API key parameter name: x-apikey
-
Location: HTTP header
- Type: HTTP basic authentication
It's recommended to create an instance of ApiClient
per thread in a multithreaded environment to avoid any potential issues.