rznas / bwdk-sdk-php
<div dir="rtl" style="text-align: right;"> # مستندات فروشندگان در سرویس خرید با دیجیکالا این پلتفرم برای فروشندگان (مرچنتها) جهت یکپارچهسازی خدمات پرداخت و تجارت الکترونیکی با سیستم خرید با دیجیکالا. شامل مدیریت سفارشات، ارسال، و احراز هویت فروشندگان است. </div>
Requires
- php: ^8.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
README
مستندات فروشندگان در سرویس خرید با دیجیکالا
این پلتفرم برای فروشندگان (مرچنتها) جهت یکپارچهسازی خدمات پرداخت و تجارت الکترونیکی با سیستم خرید با دیجیکالا. شامل مدیریت سفارشات، ارسال، و احراز هویت فروشندگان است.
Installation & Usage
Requirements
PHP 8.1 and later.
Composer
To install the bindings via Composer, add the following to composer.json:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/rznas/bwdk-sdk-php.git"
}
],
"require": {
"rznas/bwdk-sdk-php": "*@dev"
}
}
Then run composer install
Manual Installation
Download the files and include autoload.php:
<?php require_once('/path/to/bwdk_sdk/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: MerchantAPIKeyAuth $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); $apiInstance = new OpenAPI\Client\Api\MerchantOrdersApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $order_create = new \OpenAPI\Client\Model\OrderCreate(); // \OpenAPI\Client\Model\OrderCreate try { $result = $apiInstance->orderApiV1CreateOrderCreate($order_create); print_r($result); } catch (Exception $e) { echo 'Exception when calling MerchantOrdersApi->orderApiV1CreateOrderCreate: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://bwdk-backend.digify.shop
| Class | Method | HTTP request | Description |
|---|---|---|---|
| MerchantOrdersApi | orderApiV1CreateOrderCreate | POST /order/api/v1/create-order/ | ساخت سفارش |
| MerchantOrdersApi | orderApiV1ManagerList | GET /order/api/v1/manager/ | لیست سفارشات |
| MerchantOrdersApi | orderApiV1ManagerPaidList | GET /order/api/v1/manager/paid/ | سفارش پرداختشده و تاییدنشده |
| MerchantOrdersApi | orderApiV1ManagerRefundCreate | POST /order/api/v1/manager/{order_uuid}/refund/ | بازگشت سفارش |
| MerchantOrdersApi | orderApiV1ManagerRetrieve | GET /order/api/v1/manager/{order_uuid}/ | دریافت سفارش |
| MerchantOrdersApi | orderApiV1ManagerUpdateStatusUpdate | PUT /order/api/v1/manager/{order_uuid}/update-status/ | Update Order Status |
| MerchantOrdersApi | orderApiV1ManagerVerifyCreate | POST /order/api/v1/manager/{order_uuid}/verify/ | تایید سفارش |
| MerchantWalletApi | walletsApiV1WalletBalanceRetrieve | GET /wallets/api/v1/wallet-balance/ | Get Wallet Balance |
| OrderShippingApi | orderApiV1ManagerCancelShipmentCreate | POST /order/api/v1/manager/{order_uuid}/cancel-shipment/ | Cancel Shipment |
| OrderShippingApi | orderApiV1ManagerChangeShippingMethodUpdate | PUT /order/api/v1/manager/{order_uuid}/change-shipping-method/ | Change Shipping Method |
| OrderShippingApi | orderApiV1ManagerReviveShipmentCreate | POST /order/api/v1/manager/{order_uuid}/revive-shipment/ | Revive Shipment |
| SellerProfileManagementApi | merchantApiV1AuthStatusRetrieve | GET /merchant/api/v1/auth/status/ | وضعیت لاگین بودن |
Models
- AuthStatusResponse
- BusinessAddress
- DeliveryTimeRangeDisplay
- ErrorEnum
- GatewayTypeEnum
- Merchant
- MerchantOrderCancelShipmentResponse
- MerchantOrderRefundResponse
- MerchantOrderReviveShipmentResponse
- MerchantPaidOrderList
- NullEnum
- Option
- OrderCreate
- OrderCreateResponse
- OrderDetail
- OrderError
- OrderItemCreate
- OrderStatusEnum
- OrderUser
- Packing
- PaginatedMerchantPaidOrderListList
- PaginatedOrderDetailList
- PaymentOrder
- RefundOrder
- ReviveShipment
- ShippingMethod
- ShippingTypeEnum
- TypeNameEnum
- UpdateOrderStatus
- VerifyOrder
- WalletBalance
Authorization
Authentication schemes defined for the API:
MerchantAPIKeyAuth
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
1.0.0- Generator version:
7.21.0
- Generator version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen