2.0.0 • Published 2 years ago

@geins/sdk-api-mgmt-javascript v2.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

NPM Package NPM Downloads

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

ClassMethodHTTP requestDescription
GeinsSdkApiMgmtJavascript.BrandApicreateBrandPOST /API/BrandCreate brand
GeinsSdkApiMgmtJavascript.BrandApigetBrandGET /API/Brand/{id}Get brand
GeinsSdkApiMgmtJavascript.BrandApiqueryBrandsPOST /API/Brand/QueryQuery brands
GeinsSdkApiMgmtJavascript.BrandApiupdateBrandPUT /API/Brand/{id}Update brand
GeinsSdkApiMgmtJavascript.CategoryApicreateCategoryPOST /API/CategoryCreate category
GeinsSdkApiMgmtJavascript.CategoryApigetCategoryGET /API/Category/{id}Get category
GeinsSdkApiMgmtJavascript.CategoryApiqueryCategoriesPOST /API/Category/QueryQuery categories
GeinsSdkApiMgmtJavascript.CategoryApiupdateCategoryPUT /API/Category/{id}Update category
GeinsSdkApiMgmtJavascript.MarketApigetMarketGET /API/Market/{marketId}Get market
GeinsSdkApiMgmtJavascript.MarketApilistMarketsGET /API/Market/ListList markets
GeinsSdkApiMgmtJavascript.OrderApiaddOrderCommentPOST /API/Order/{id}/CommentAdd order comment
GeinsSdkApiMgmtJavascript.OrderApicancelOrderRowDELETE /API/Order/{orderId}/OrderRow/{orderRowId}Cancel order row
GeinsSdkApiMgmtJavascript.OrderApicountOrdersGET /API/Order/Count/{email}Count orders
GeinsSdkApiMgmtJavascript.OrderApicreateOrderPOST /API/OrderCreate order
GeinsSdkApiMgmtJavascript.OrderApicreateOrderIdPOST /API/Order/IdCreate order id
GeinsSdkApiMgmtJavascript.OrderApideleteOrderDELETE /API/Order/{id}Delete order
GeinsSdkApiMgmtJavascript.OrderApigetCaptureGET /API/Order/Capture/{captureId}Get capture
GeinsSdkApiMgmtJavascript.OrderApigetOrderIdGET /API/Order/{id}/{include}Get order (id)
GeinsSdkApiMgmtJavascript.OrderApigetOrderPublicIdGET /API/OrderByPublicId/{publicId}/{include}Get order (public id)
GeinsSdkApiMgmtJavascript.OrderApigetOrderStatusesGET /API/Order/StatusesGet order statuses
GeinsSdkApiMgmtJavascript.OrderApipartialUpdateOfOrderPATCH /API/Order/{id}Partial update of an order
GeinsSdkApiMgmtJavascript.OrderApiqueryOrdersPOST /API/Order/QueryQuery orders
GeinsSdkApiMgmtJavascript.OrderApisetCaptureAsProcessedPOST /API/Order/Capture/SetAsProcessedSet capture as processed
GeinsSdkApiMgmtJavascript.OrderApisetPaymentAsPaidPOST /API/Order/PaymentDetail/{paymentDetailId}/SetAsPaidSet payment as paid
GeinsSdkApiMgmtJavascript.OrderApiupdateOrderStatusPOST /API/Order/{id}/Status/{status}/{transactionId}/{secondaryTransactionId}Update order status
GeinsSdkApiMgmtJavascript.OrderApiupdateTransactionDataPOST /API/Order/{id}/TransactionDataUpdate transaction data
GeinsSdkApiMgmtJavascript.OrderApivalidateOrderPOST /API/Order/ValidateCreationValidate order
GeinsSdkApiMgmtJavascript.PageAreaApicreateUpdatePageAreaPOST /API/PageAreaCreate/update page area
GeinsSdkApiMgmtJavascript.PageAreaApicreateUpdatePageAreaFamilyPOST /API/PageAreaFamilyCreate/update page area family
GeinsSdkApiMgmtJavascript.PageAreaApigetPageAreaGET /API/PageArea/{name}Get page area
GeinsSdkApiMgmtJavascript.PageAreaApigetPageAreaFamilyGET /API/PageAreaFamily/{familyId}Get page area family
GeinsSdkApiMgmtJavascript.PageAreaApilistPageAreaFamiliesGET /API/PageAreaFamily/ListList page area families
GeinsSdkApiMgmtJavascript.PaymentApiqueryPaymentOptionsPOST /API/Payment/QueryQuery payment options
GeinsSdkApiMgmtJavascript.PriceListApilistPriceListsGET /API/PriceList/ListList price lists
GeinsSdkApiMgmtJavascript.PriceListApiupdatePriceListPricesPUT /API/PriceList/PriceUpdate price list prices
GeinsSdkApiMgmtJavascript.ProductApiaddAvailabilityMonitorPOST /API/Product/MonitorAvailabilityAdd availability monitor
GeinsSdkApiMgmtJavascript.ProductApiaddCategoryToProductPUT /API/Product/{productId}/CategoryAdd category to product
GeinsSdkApiMgmtJavascript.ProductApiaddRelatedProductsToProductPUT /API/Product/{productId}/RelatedAdd related products to a product
GeinsSdkApiMgmtJavascript.ProductApicreateProductPOST /API/ProductCreate product
GeinsSdkApiMgmtJavascript.ProductApicreateProductItemPOST /API/Product/{productId}/ItemCreate product item
GeinsSdkApiMgmtJavascript.ProductApideleteProductDELETE /API/Product/{productId}Delete product
GeinsSdkApiMgmtJavascript.ProductApigetProductGET /API/Product/{productId}Get product
GeinsSdkApiMgmtJavascript.ProductApigetProductItemGET /API/Product/Item/{itemId}Get product item
GeinsSdkApiMgmtJavascript.ProductApilinkRelatedProductsPUT /API/Product/{productId}/Related/{relationTypeId}Link related products
GeinsSdkApiMgmtJavascript.ProductApilistFeedsGET /API/Product/FeedsList feeds
GeinsSdkApiMgmtJavascript.ProductApilistProductItemsGET /API/Product/ItemsList product items
GeinsSdkApiMgmtJavascript.ProductApilistProductItemsPagedGET /API/Product/Items/{page}List product items (paged)
GeinsSdkApiMgmtJavascript.ProductApilistProductRelationTypesGET /API/Product/RelationTypesList product relation types
GeinsSdkApiMgmtJavascript.ProductApiqueryProductsPOST /API/Product/QueryQuery products
GeinsSdkApiMgmtJavascript.ProductApiqueryProductsPagedPOST /API/Product/Query/{page}Query products (paged)
GeinsSdkApiMgmtJavascript.ProductApiqueryStockPOST /API/Product/Stock/QueryQuery stock
GeinsSdkApiMgmtJavascript.ProductApiunlinkRelatedProductsViaRelationPUT /API/Product/{productId}/UnlinkRelated/{relationTypeId}Unlink related products (via relation).
GeinsSdkApiMgmtJavascript.ProductApiupdateProductPUT /API/Product/{productId}Update product
GeinsSdkApiMgmtJavascript.ProductApiupdateProductItemPUT /API/Product/Item/{itemId}Update product item
GeinsSdkApiMgmtJavascript.ProductApiupdateProductItemsBatchPUT /API/Product/ItemsUpdate product items (batch)
GeinsSdkApiMgmtJavascript.ProductApiupdateStockBatchPUT /API/Product/StockUpdate stock (batch)
GeinsSdkApiMgmtJavascript.ProductImageApiaddProductImagePOST /API/Product/{productId}/Image/{imageName}Add product image
GeinsSdkApiMgmtJavascript.ProductImageApiaddUpdateProductImagePUT /API/Product/{productId}/Image/{imageName}Add/update product image
GeinsSdkApiMgmtJavascript.ProductImageApideleteProductImageDELETE /API/Product/{productId}/Image/{imageName}Delete product image
GeinsSdkApiMgmtJavascript.ProductParameterApicreateOrUpdateProductParameterValuePOST /API/ProductParameter/ValueCreate/update product parameter value
GeinsSdkApiMgmtJavascript.ProductParameterApicreateProductParameterPOST /API/ProductParameterCreate product parameter
GeinsSdkApiMgmtJavascript.ProductParameterApicreateProductParameterGroupPOST /API/ProductParameter/GroupCreate product parameter group
GeinsSdkApiMgmtJavascript.ProductParameterApicreateProductParameterPredefinedValuePOST /API/ProductParameter/PredefinedValueCreate product parameter predefined value
GeinsSdkApiMgmtJavascript.ProductParameterApigetProductParameterGET /API/ProductParameter/{id}Get product parameter
GeinsSdkApiMgmtJavascript.ProductParameterApigetProductParameterGroupGET /API/ProductParameter/Group/{id}Get product parameter group
GeinsSdkApiMgmtJavascript.ProductParameterApigetProductParameterPredefinedValueGET /API/ProductParameter/PredefinedValue/{id}Get product parameter predefined value
GeinsSdkApiMgmtJavascript.ProductParameterApigetProductParameterValueGET /API/ProductParameter/Value/{id}Get product parameter value
GeinsSdkApiMgmtJavascript.ProductParameterApireplaceProductParameterValuesBatchPOST /API/ProductParameter/ValuesReplace product parameter values (batch)
GeinsSdkApiMgmtJavascript.ProductParameterApiupdateProductParameterPUT /API/ProductParameter/{id}Update product parameter
GeinsSdkApiMgmtJavascript.ProductParameterApiupdateProductParameterGroupPUT /API/ProductParameter/Group/{id}Update product parameter group
GeinsSdkApiMgmtJavascript.ProductParameterApiupdateProductParameterValuesBatchPUT /API/ProductParameter/ValuesUpdate product parameter values (batch)
GeinsSdkApiMgmtJavascript.RefundApicreateRefundPOST /API/Order/{orderId}/RefundCreates refund
GeinsSdkApiMgmtJavascript.RefundApideleteRefundRowDELETE /API/Order/{orderId}/Refund/{refundId}/RefundRow/{refundRowId}Delete refund row
GeinsSdkApiMgmtJavascript.RefundApigetRefundGET /API/Order/{orderId}/Refund/{refundId}Get refund
GeinsSdkApiMgmtJavascript.RefundApilistRefundsGET /API/Order/{orderId}/Refund/ListList refunds
GeinsSdkApiMgmtJavascript.RefundApiqueryRefundsPOST /API/Refund/QueryQuery refunds
GeinsSdkApiMgmtJavascript.RefundApisetRefundApprovalPOST /API/Order/{orderId}/Refund/{refundId}/SetApprovalSet refund approval
GeinsSdkApiMgmtJavascript.RefundApisetRefundAsProcessedPOST /API/Order/{orderId}/Refund/{refundId}/SetAsProcessedSet refund as processed
GeinsSdkApiMgmtJavascript.RefundApisetRefundAsSettledPOST /API/Order/{orderId}/Refund/{refundId}/SetAsSettledSet refund as settled
GeinsSdkApiMgmtJavascript.RefundApisetRefundRowAsSettledPOST /API/Order/{orderId}/Refund/{refundId}/RefundRow/{refundRowId}/SetAsSettledSet refund row as settled
GeinsSdkApiMgmtJavascript.ReturnApicreateReturnPOST /API/Order/{orderId}/ReturnCreate return
GeinsSdkApiMgmtJavascript.ReturnApigetReturnGET /API/Order/{orderId}/Return/{returnId}Get return
GeinsSdkApiMgmtJavascript.ReturnApilistReturnCodesGET /API/ReturnCode/ListList return codes
GeinsSdkApiMgmtJavascript.ReturnApilistReturnsGET /API/Order/{orderId}/Return/ListList returns
GeinsSdkApiMgmtJavascript.ShippingApicaptureParcelGroupPUT /API/Shipping/ParcelGroup/{parcelGroupId}/CaptureCapture parcel group
GeinsSdkApiMgmtJavascript.ShippingApicreateParcelGroupPOST /API/Shipping/ParcelGroupCreate parcel group
GeinsSdkApiMgmtJavascript.ShippingApideliverParcelGroupPUT /API/Shipping/ParcelGroup/{parcelGroupId}/DeliverDeliver parcel group
GeinsSdkApiMgmtJavascript.ShippingApiqueryParcelGroupsPOST /API/Shipping/ParcelGroup/QueryQuery parcel groups
GeinsSdkApiMgmtJavascript.ShippingApiqueryShippingOptionsPOST /API/Shipping/QueryQuery shipping options
GeinsSdkApiMgmtJavascript.SupplierApicreateSupplierPOST /API/SupplierCreate supplier
GeinsSdkApiMgmtJavascript.SupplierApigetSupplierGET /API/Supplier/{id}Get supplier
GeinsSdkApiMgmtJavascript.SupplierApiquerySuppliersPOST /API/Supplier/QueryQuery suppliers
GeinsSdkApiMgmtJavascript.SupplierApiupdateSupplierPUT /API/Supplier/{id}Update supplier
GeinsSdkApiMgmtJavascript.UserApiaddUserBalancePOST /API/User/{userId}/BalanceAdd user balance
GeinsSdkApiMgmtJavascript.UserApicreateUserProfilePOST /API/UserCreate user profile
GeinsSdkApiMgmtJavascript.UserApideleteUserProfileEmailDELETE /API/User/{email}Delete user profile (email)
GeinsSdkApiMgmtJavascript.UserApideleteUserProfileIdDELETE /API/User/{userId}Delete user profile (id)
GeinsSdkApiMgmtJavascript.UserApigetUserBalanceGET /API/User/{userId}/Balance/{currency}Get user balance
GeinsSdkApiMgmtJavascript.UserApigetUserBalanceTransactionsGET /API/User/{userId}/BalanceTransaction/List/{currency}Get user balance transactions
GeinsSdkApiMgmtJavascript.UserApigetUserBalanceTypesGET /API/BalanceType/ListGet user balance types
GeinsSdkApiMgmtJavascript.UserApigetUserProfileEmailGET /API/User/{email}Get user profile (email)
GeinsSdkApiMgmtJavascript.UserApigetUserProfileIdGET /API/User/{userId}Get user profile (id)
GeinsSdkApiMgmtJavascript.UserApiqueryUserProfilesPOST /API/User/Query/{page}Query user profiles
GeinsSdkApiMgmtJavascript.UserApiupdateUserProfilePATCH /API/User/{userId}Update user profile
GeinsSdkApiMgmtJavascript.VariantApiaddProductToVariantGroupPUT /API/VariantGroup/{groupId}/{productId}Add product to variant group
GeinsSdkApiMgmtJavascript.VariantApiaddProductToVariantGroupProductPUT /API/Variant/{productId1}/{productId2}Add product to variant group (product)
GeinsSdkApiMgmtJavascript.VariantApicreateVariantGroupPOST /API/VariantGroupCreate variant group
GeinsSdkApiMgmtJavascript.VariantApicreateVariantGroupProductPOST /API/Variant/{productId}/VariantGroupCreate variant group (product)
GeinsSdkApiMgmtJavascript.VariantApideleteVariantGroupGroupIdDELETE /API/VariantGroup/{groupId}Delete variant group (group id)
GeinsSdkApiMgmtJavascript.VariantApideleteVariantGroupProductIdDELETE /API/Variant/{productId}/VariantGroupDelete variant group (product id)
GeinsSdkApiMgmtJavascript.VariantApigetVariantGroupGroupIdGET /API/VariantGroup/{groupId}Get variant group (group id)
GeinsSdkApiMgmtJavascript.VariantApigetVariantGroupProductIdGET /API/Variant/{productId}/VariantGroupGet variant group (product id)
GeinsSdkApiMgmtJavascript.VariantApigetVariantLabelsGET /API/Variant/LabelsGet variant labels
GeinsSdkApiMgmtJavascript.VariantApiremoveProductFromVariantGroupDELETE /API/Variant/{productId}Remove product from variant group
GeinsSdkApiMgmtJavascript.VariantApiupdateVariantPUT /API/Variant/{productId}Update variant
GeinsSdkApiMgmtJavascript.VariantApiupdateVariantGroupPUT /API/VariantGroup/{groupId}Update variant group
GeinsSdkApiMgmtJavascript.WebhookApicreateWebhookPOST /API/WebhookCreate webhook
GeinsSdkApiMgmtJavascript.WebhookApideleteWebhookDELETE /API/Webhook/{webhookId}Delete webhook
GeinsSdkApiMgmtJavascript.WebhookApigetWebhookGET /API/Webhook/{webhookId}Get webhook
GeinsSdkApiMgmtJavascript.WebhookApilistWebhooksGET /API/Webhook/ListList webhooks
GeinsSdkApiMgmtJavascript.WebhookApiupdateWebhookPUT /API/Webhook/{webhookId}Update webhook

Models

Authorization

apiKey

  • Type: API key
  • API key parameter name: X-ApiKey
  • Location: HTTP header

basicAuth

  • Type: HTTP basic authentication
2.0.0

2 years ago

1.7.5

2 years ago

1.7.4

2 years ago

1.7.3

2 years ago

1.7.2

2 years ago

1.7.1

2 years ago