@geins/sdk-api-mgmt-javascript NPM

Introduction

Javascript ApiClient for Geins Managemet API

Geins Management API is an RESTful api to power your applications who manages 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.

Getting started

Once you have created an account, you can start using the Management API by creating an API key. You can create as many API keys as you need. Each API key is connected to a specific account so you can keep track of operations and manage keys. You can find your API key in the geins merchant center.

Fast track

Use one of our SDKs to get started quickly. The SDKs are available for the most popular programming languages and frameworks.

Installation

For Node.js

Install it via:

npm install @geins/sdk-api-mgmt-javascript --save

Getting Started

Please follow the installation instruction and execute the following JS code:

var GeinsManagementApiSdkJs = require('@geins/sdk-api-mgmt-javascript');

var defaultClient = GeinsManagementApiSdkJs.ApiClient.instance;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['x-apikey'] = "Token"
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new GeinsManagementApiSdkJs.BrandApi()
var brand = new GeinsManagementApiSdkJs.BrandModelsWriteBrand(); // {BrandModelsWriteBrand} The brand to create.
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createBrand(brand, callback);

API Endpoints

All URIs are relative to https://mgmtapi.geins.io

Class	Method	HTTP request	Description
GeinsSdkApiMgmtJavascript.BrandApi	createBrand	POST /API/Brand	Create brand
GeinsSdkApiMgmtJavascript.BrandApi	getBrand	GET /API/Brand/{id}	Get brand
GeinsSdkApiMgmtJavascript.BrandApi	queryBrands	POST /API/Brand/Query	Query brands
GeinsSdkApiMgmtJavascript.BrandApi	updateBrand	PUT /API/Brand/{id}	Update brand
GeinsSdkApiMgmtJavascript.CategoryApi	createCategory	POST /API/Category	Create category
GeinsSdkApiMgmtJavascript.CategoryApi	getCategory	GET /API/Category/{id}	Get category
GeinsSdkApiMgmtJavascript.CategoryApi	queryCategories	POST /API/Category/Query	Query categories
GeinsSdkApiMgmtJavascript.CategoryApi	updateCategory	PUT /API/Category/{id}	Update category
GeinsSdkApiMgmtJavascript.MarketApi	getMarket	GET /API/Market/{marketId}	Get market
GeinsSdkApiMgmtJavascript.MarketApi	listMarkets	GET /API/Market/List	List markets
GeinsSdkApiMgmtJavascript.OrderApi	addOrderComment	POST /API/Order/{id}/Comment	Add order comment
GeinsSdkApiMgmtJavascript.OrderApi	cancelOrderRow	DELETE /API/Order/{orderId}/OrderRow/{orderRowId}	Cancel order row
GeinsSdkApiMgmtJavascript.OrderApi	countOrders	GET /API/Order/Count/{email}	Count orders
GeinsSdkApiMgmtJavascript.OrderApi	createOrder	POST /API/Order	Create order
GeinsSdkApiMgmtJavascript.OrderApi	createOrderId	POST /API/Order/Id	Create order id
GeinsSdkApiMgmtJavascript.OrderApi	deleteOrder	DELETE /API/Order/{id}	Delete order
GeinsSdkApiMgmtJavascript.OrderApi	getCapture	GET /API/Order/Capture/{captureId}	Get capture
GeinsSdkApiMgmtJavascript.OrderApi	getOrderId	GET /API/Order/{id}/{include}	Get order (id)
GeinsSdkApiMgmtJavascript.OrderApi	getOrderPublicId	GET /API/OrderByPublicId/{publicId}/{include}	Get order (public id)
GeinsSdkApiMgmtJavascript.OrderApi	getOrderStatuses	GET /API/Order/Statuses	Get order statuses
GeinsSdkApiMgmtJavascript.OrderApi	partialUpdateOfOrder	PATCH /API/Order/{id}	Partial update of an order
GeinsSdkApiMgmtJavascript.OrderApi	queryOrders	POST /API/Order/Query	Query orders
GeinsSdkApiMgmtJavascript.OrderApi	setCaptureAsProcessed	POST /API/Order/Capture/SetAsProcessed	Set capture as processed
GeinsSdkApiMgmtJavascript.OrderApi	setPaymentAsPaid	POST /API/Order/PaymentDetail/{paymentDetailId}/SetAsPaid	Set payment as paid
GeinsSdkApiMgmtJavascript.OrderApi	updateOrderStatus	POST /API/Order/{id}/Status/{status}/{transactionId}/{secondaryTransactionId}	Update order status
GeinsSdkApiMgmtJavascript.OrderApi	updateTransactionData	POST /API/Order/{id}/TransactionData	Update transaction data
GeinsSdkApiMgmtJavascript.OrderApi	validateOrder	POST /API/Order/ValidateCreation	Validate order
GeinsSdkApiMgmtJavascript.PageAreaApi	createUpdatePageArea	POST /API/PageArea	Create/update page area
GeinsSdkApiMgmtJavascript.PageAreaApi	createUpdatePageAreaFamily	POST /API/PageAreaFamily	Create/update page area family
GeinsSdkApiMgmtJavascript.PageAreaApi	getPageArea	GET /API/PageArea/{name}	Get page area
GeinsSdkApiMgmtJavascript.PageAreaApi	getPageAreaFamily	GET /API/PageAreaFamily/{familyId}	Get page area family
GeinsSdkApiMgmtJavascript.PageAreaApi	listPageAreaFamilies	GET /API/PageAreaFamily/List	List page area families
GeinsSdkApiMgmtJavascript.PaymentApi	queryPaymentOptions	POST /API/Payment/Query	Query payment options
GeinsSdkApiMgmtJavascript.PriceListApi	listPriceLists	GET /API/PriceList/List	List price lists
GeinsSdkApiMgmtJavascript.PriceListApi	updatePriceListPrices	PUT /API/PriceList/Price	Update price list prices
GeinsSdkApiMgmtJavascript.ProductApi	addAvailabilityMonitor	POST /API/Product/MonitorAvailability	Add availability monitor
GeinsSdkApiMgmtJavascript.ProductApi	addCategoryToProduct	PUT /API/Product/{productId}/Category	Add category to product
GeinsSdkApiMgmtJavascript.ProductApi	addRelatedProductsToProduct	PUT /API/Product/{productId}/Related	Add related products to a product
GeinsSdkApiMgmtJavascript.ProductApi	createProduct	POST /API/Product	Create product
GeinsSdkApiMgmtJavascript.ProductApi	createProductItem	POST /API/Product/{productId}/Item	Create product item
GeinsSdkApiMgmtJavascript.ProductApi	deleteProduct	DELETE /API/Product/{productId}	Delete product
GeinsSdkApiMgmtJavascript.ProductApi	getProduct	GET /API/Product/{productId}	Get product
GeinsSdkApiMgmtJavascript.ProductApi	getProductItem	GET /API/Product/Item/{itemId}	Get product item
GeinsSdkApiMgmtJavascript.ProductApi	linkRelatedProducts	PUT /API/Product/{productId}/Related/{relationTypeId}	Link related products
GeinsSdkApiMgmtJavascript.ProductApi	listFeeds	GET /API/Product/Feeds	List feeds
GeinsSdkApiMgmtJavascript.ProductApi	listProductItems	GET /API/Product/Items	List product items
GeinsSdkApiMgmtJavascript.ProductApi	listProductItemsPaged	GET /API/Product/Items/{page}	List product items (paged)
GeinsSdkApiMgmtJavascript.ProductApi	listProductRelationTypes	GET /API/Product/RelationTypes	List product relation types
GeinsSdkApiMgmtJavascript.ProductApi	queryProducts	POST /API/Product/Query	Query products
GeinsSdkApiMgmtJavascript.ProductApi	queryProductsPaged	POST /API/Product/Query/{page}	Query products (paged)
GeinsSdkApiMgmtJavascript.ProductApi	queryStock	POST /API/Product/Stock/Query	Query stock
GeinsSdkApiMgmtJavascript.ProductApi	unlinkRelatedProductsViaRelation	PUT /API/Product/{productId}/UnlinkRelated/{relationTypeId}	Unlink related products (via relation).
GeinsSdkApiMgmtJavascript.ProductApi	updateProduct	PUT /API/Product/{productId}	Update product
GeinsSdkApiMgmtJavascript.ProductApi	updateProductItem	PUT /API/Product/Item/{itemId}	Update product item
GeinsSdkApiMgmtJavascript.ProductApi	updateProductItemsBatch	PUT /API/Product/Items	Update product items (batch)
GeinsSdkApiMgmtJavascript.ProductApi	updateStockBatch	PUT /API/Product/Stock	Update stock (batch)
GeinsSdkApiMgmtJavascript.ProductImageApi	addProductImage	POST /API/Product/{productId}/Image/{imageName}	Add product image
GeinsSdkApiMgmtJavascript.ProductImageApi	addUpdateProductImage	PUT /API/Product/{productId}/Image/{imageName}	Add/update product image
GeinsSdkApiMgmtJavascript.ProductImageApi	deleteProductImage	DELETE /API/Product/{productId}/Image/{imageName}	Delete product image
GeinsSdkApiMgmtJavascript.ProductParameterApi	createOrUpdateProductParameterValue	POST /API/ProductParameter/Value	Create/update product parameter value
GeinsSdkApiMgmtJavascript.ProductParameterApi	createProductParameter	POST /API/ProductParameter	Create product parameter
GeinsSdkApiMgmtJavascript.ProductParameterApi	createProductParameterGroup	POST /API/ProductParameter/Group	Create product parameter group
GeinsSdkApiMgmtJavascript.ProductParameterApi	createProductParameterPredefinedValue	POST /API/ProductParameter/PredefinedValue	Create product parameter predefined value
GeinsSdkApiMgmtJavascript.ProductParameterApi	getProductParameter	GET /API/ProductParameter/{id}	Get product parameter
GeinsSdkApiMgmtJavascript.ProductParameterApi	getProductParameterGroup	GET /API/ProductParameter/Group/{id}	Get product parameter group
GeinsSdkApiMgmtJavascript.ProductParameterApi	getProductParameterPredefinedValue	GET /API/ProductParameter/PredefinedValue/{id}	Get product parameter predefined value
GeinsSdkApiMgmtJavascript.ProductParameterApi	getProductParameterValue	GET /API/ProductParameter/Value/{id}	Get product parameter value
GeinsSdkApiMgmtJavascript.ProductParameterApi	replaceProductParameterValuesBatch	POST /API/ProductParameter/Values	Replace product parameter values (batch)
GeinsSdkApiMgmtJavascript.ProductParameterApi	updateProductParameter	PUT /API/ProductParameter/{id}	Update product parameter
GeinsSdkApiMgmtJavascript.ProductParameterApi	updateProductParameterGroup	PUT /API/ProductParameter/Group/{id}	Update product parameter group
GeinsSdkApiMgmtJavascript.ProductParameterApi	updateProductParameterValuesBatch	PUT /API/ProductParameter/Values	Update product parameter values (batch)
GeinsSdkApiMgmtJavascript.RefundApi	createRefund	POST /API/Order/{orderId}/Refund	Creates refund
GeinsSdkApiMgmtJavascript.RefundApi	deleteRefundRow	DELETE /API/Order/{orderId}/Refund/{refundId}/RefundRow/{refundRowId}	Delete refund row
GeinsSdkApiMgmtJavascript.RefundApi	getRefund	GET /API/Order/{orderId}/Refund/{refundId}	Get refund
GeinsSdkApiMgmtJavascript.RefundApi	listRefunds	GET /API/Order/{orderId}/Refund/List	List refunds
GeinsSdkApiMgmtJavascript.RefundApi	queryRefunds	POST /API/Refund/Query	Query refunds
GeinsSdkApiMgmtJavascript.RefundApi	setRefundApproval	POST /API/Order/{orderId}/Refund/{refundId}/SetApproval	Set refund approval
GeinsSdkApiMgmtJavascript.RefundApi	setRefundAsProcessed	POST /API/Order/{orderId}/Refund/{refundId}/SetAsProcessed	Set refund as processed
GeinsSdkApiMgmtJavascript.RefundApi	setRefundAsSettled	POST /API/Order/{orderId}/Refund/{refundId}/SetAsSettled	Set refund as settled
GeinsSdkApiMgmtJavascript.RefundApi	setRefundRowAsSettled	POST /API/Order/{orderId}/Refund/{refundId}/RefundRow/{refundRowId}/SetAsSettled	Set refund row as settled
GeinsSdkApiMgmtJavascript.ReturnApi	createReturn	POST /API/Order/{orderId}/Return	Create return
GeinsSdkApiMgmtJavascript.ReturnApi	getReturn	GET /API/Order/{orderId}/Return/{returnId}	Get return
GeinsSdkApiMgmtJavascript.ReturnApi	listReturnCodes	GET /API/ReturnCode/List	List return codes
GeinsSdkApiMgmtJavascript.ReturnApi	listReturns	GET /API/Order/{orderId}/Return/List	List returns
GeinsSdkApiMgmtJavascript.ShippingApi	captureParcelGroup	PUT /API/Shipping/ParcelGroup/{parcelGroupId}/Capture	Capture parcel group
GeinsSdkApiMgmtJavascript.ShippingApi	createParcelGroup	POST /API/Shipping/ParcelGroup	Create parcel group
GeinsSdkApiMgmtJavascript.ShippingApi	deliverParcelGroup	PUT /API/Shipping/ParcelGroup/{parcelGroupId}/Deliver	Deliver parcel group
GeinsSdkApiMgmtJavascript.ShippingApi	queryParcelGroups	POST /API/Shipping/ParcelGroup/Query	Query parcel groups
GeinsSdkApiMgmtJavascript.ShippingApi	queryShippingOptions	POST /API/Shipping/Query	Query shipping options
GeinsSdkApiMgmtJavascript.SupplierApi	createSupplier	POST /API/Supplier	Create supplier
GeinsSdkApiMgmtJavascript.SupplierApi	getSupplier	GET /API/Supplier/{id}	Get supplier
GeinsSdkApiMgmtJavascript.SupplierApi	querySuppliers	POST /API/Supplier/Query	Query suppliers
GeinsSdkApiMgmtJavascript.SupplierApi	updateSupplier	PUT /API/Supplier/{id}	Update supplier
GeinsSdkApiMgmtJavascript.UserApi	addUserBalance	POST /API/User/{userId}/Balance	Add user balance
GeinsSdkApiMgmtJavascript.UserApi	createUserProfile	POST /API/User	Create user profile
GeinsSdkApiMgmtJavascript.UserApi	deleteUserProfileEmail	DELETE /API/User/{email}	Delete user profile (email)
GeinsSdkApiMgmtJavascript.UserApi	deleteUserProfileId	DELETE /API/User/{userId}	Delete user profile (id)
GeinsSdkApiMgmtJavascript.UserApi	getUserBalance	GET /API/User/{userId}/Balance/{currency}	Get user balance
GeinsSdkApiMgmtJavascript.UserApi	getUserBalanceTransactions	GET /API/User/{userId}/BalanceTransaction/List/{currency}	Get user balance transactions
GeinsSdkApiMgmtJavascript.UserApi	getUserBalanceTypes	GET /API/BalanceType/List	Get user balance types
GeinsSdkApiMgmtJavascript.UserApi	getUserProfileEmail	GET /API/User/{email}	Get user profile (email)
GeinsSdkApiMgmtJavascript.UserApi	getUserProfileId	GET /API/User/{userId}	Get user profile (id)
GeinsSdkApiMgmtJavascript.UserApi	queryUserProfiles	POST /API/User/Query/{page}	Query user profiles
GeinsSdkApiMgmtJavascript.UserApi	updateUserProfile	PATCH /API/User/{userId}	Update user profile
GeinsSdkApiMgmtJavascript.VariantApi	addProductToVariantGroup	PUT /API/VariantGroup/{groupId}/{productId}	Add product to variant group
GeinsSdkApiMgmtJavascript.VariantApi	addProductToVariantGroupProduct	PUT /API/Variant/{productId1}/{productId2}	Add product to variant group (product)
GeinsSdkApiMgmtJavascript.VariantApi	createVariantGroup	POST /API/VariantGroup	Create variant group
GeinsSdkApiMgmtJavascript.VariantApi	createVariantGroupProduct	POST /API/Variant/{productId}/VariantGroup	Create variant group (product)
GeinsSdkApiMgmtJavascript.VariantApi	deleteVariantGroupGroupId	DELETE /API/VariantGroup/{groupId}	Delete variant group (group id)
GeinsSdkApiMgmtJavascript.VariantApi	deleteVariantGroupProductId	DELETE /API/Variant/{productId}/VariantGroup	Delete variant group (product id)
GeinsSdkApiMgmtJavascript.VariantApi	getVariantGroupGroupId	GET /API/VariantGroup/{groupId}	Get variant group (group id)
GeinsSdkApiMgmtJavascript.VariantApi	getVariantGroupProductId	GET /API/Variant/{productId}/VariantGroup	Get variant group (product id)
GeinsSdkApiMgmtJavascript.VariantApi	getVariantLabels	GET /API/Variant/Labels	Get variant labels
GeinsSdkApiMgmtJavascript.VariantApi	removeProductFromVariantGroup	DELETE /API/Variant/{productId}	Remove product from variant group
GeinsSdkApiMgmtJavascript.VariantApi	updateVariant	PUT /API/Variant/{productId}	Update variant
GeinsSdkApiMgmtJavascript.VariantApi	updateVariantGroup	PUT /API/VariantGroup/{groupId}	Update variant group
GeinsSdkApiMgmtJavascript.WebhookApi	createWebhook	POST /API/Webhook	Create webhook
GeinsSdkApiMgmtJavascript.WebhookApi	deleteWebhook	DELETE /API/Webhook/{webhookId}	Delete webhook
GeinsSdkApiMgmtJavascript.WebhookApi	getWebhook	GET /API/Webhook/{webhookId}	Get webhook
GeinsSdkApiMgmtJavascript.WebhookApi	listWebhooks	GET /API/Webhook/List	List webhooks
GeinsSdkApiMgmtJavascript.WebhookApi	updateWebhook	PUT /API/Webhook/{webhookId}	Update webhook