bwdk_api

BwdkApi - JavaScript client for bwdk_api

مستندات فروشندگان در سرویس خرید با دیجی‌کالا

این پلتفرم برای فروشندگان (مرچنت‌ها) جهت یکپارچه‌سازی خدمات پرداخت و تجارت الکترونیکی با سیستم خرید با دیجی‌کالا. شامل مدیریت سفارشات، ارسال، و احراز هویت فروشندگان است.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.21.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install bwdk_api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your bwdk_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var BwdkApi = require('bwdk_api');

var defaultClient = BwdkApi.ApiClient.instance;
// Configure API key authorization: MerchantAPIKeyAuth
var MerchantAPIKeyAuth = defaultClient.authentications['MerchantAPIKeyAuth'];
MerchantAPIKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//MerchantAPIKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new BwdkApi.MerchantOrdersApi()
var orderCreate = new BwdkApi.OrderCreate(); // {OrderCreate} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.orderApiV1CreateOrderCreate(orderCreate, callback);

Documentation for API Endpoints

All URIs are relative to https://bwdk-backend.digify.shop

Class	Method	HTTP request	Description
BwdkApi.MerchantOrdersApi	orderApiV1CreateOrderCreate	POST /order/api/v1/create-order/	ساخت سفارش
BwdkApi.MerchantOrdersApi	orderApiV1ManagerList	GET /order/api/v1/manager/	لیست سفارشات
BwdkApi.MerchantOrdersApi	orderApiV1ManagerPaidList	GET /order/api/v1/manager/paid/	سفارش پرداخت‌شده و تایید‌نشده
BwdkApi.MerchantOrdersApi	orderApiV1ManagerRefundCreate	POST /order/api/v1/manager/{order_uuid}/refund/	بازگشت سفارش
BwdkApi.MerchantOrdersApi	orderApiV1ManagerRetrieve	GET /order/api/v1/manager/{order_uuid}/	دریافت سفارش
BwdkApi.MerchantOrdersApi	orderApiV1ManagerUpdateStatusUpdate	PUT /order/api/v1/manager/{order_uuid}/update-status/	Update Order Status
BwdkApi.MerchantOrdersApi	orderApiV1ManagerVerifyCreate	POST /order/api/v1/manager/{order_uuid}/verify/	تایید سفارش
BwdkApi.MerchantWalletApi	walletsApiV1WalletBalanceRetrieve	GET /wallets/api/v1/wallet-balance/	Get Wallet Balance
BwdkApi.OrderShippingApi	orderApiV1ManagerCancelShipmentCreate	POST /order/api/v1/manager/{order_uuid}/cancel-shipment/	Cancel Shipment
BwdkApi.OrderShippingApi	orderApiV1ManagerChangeShippingMethodUpdate	PUT /order/api/v1/manager/{order_uuid}/change-shipping-method/	Change Shipping Method
BwdkApi.OrderShippingApi	orderApiV1ManagerReviveShipmentCreate	POST /order/api/v1/manager/{order_uuid}/revive-shipment/	Revive Shipment
BwdkApi.SellerProfileManagementApi	merchantApiV1AuthStatusRetrieve	GET /merchant/api/v1/auth/status/	وضعیت لاگین بودن

Documentation for Models

• BwdkApi.AuthStatusResponse
• BwdkApi.BusinessAddress
• BwdkApi.DeliveryTimeRangeDisplay
• BwdkApi.ErrorEnum
• BwdkApi.GatewayTypeEnum
• BwdkApi.Merchant
• BwdkApi.MerchantOrderCancelShipmentResponse
• BwdkApi.MerchantOrderRefundResponse
• BwdkApi.MerchantOrderReviveShipmentResponse
• BwdkApi.MerchantPaidOrderList
• BwdkApi.NullEnum
• BwdkApi.Option
• BwdkApi.OrderCreate
• BwdkApi.OrderCreateResponse
• BwdkApi.OrderDetail
• BwdkApi.OrderError
• BwdkApi.OrderItemCreate
• BwdkApi.OrderStatusEnum
• BwdkApi.OrderUser
• BwdkApi.Packing
• BwdkApi.PaginatedMerchantPaidOrderListList
• BwdkApi.PaginatedOrderDetailList
• BwdkApi.PaymentOrder
• BwdkApi.RefundOrder
• BwdkApi.ReviveShipment
• BwdkApi.ShippingMethod
• BwdkApi.ShippingTypeEnum
• BwdkApi.TypeNameEnum
• BwdkApi.UpdateOrderStatus
• BwdkApi.VerifyOrder
• BwdkApi.WalletBalance

Documentation for Authorization

Authentication schemes defined for the API:

MerchantAPIKeyAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header