onlineidentity/laravel-channable

Laravel 对 OnlineIdentity Channable API 连接器的包装

v1.0.0 2023-03-07 09:04 UTC

This package is auto-updated.

Last update: 2024-09-21 16:22:44 UTC


README

关于

此包围绕onlineidentity/channable创建包装,以便于在Laravel 框架中使用。

安装

composer require onlineidentity/laravel-channable

(可选) 使用 php artisan vendor:publish --tag=channable 发布配置文件

设置您的 .env 变量

CHANNABLE_API_TOKEN='{API_TOKEN}'
CHANNABLE_COMPANY_ID={COMPANY_ID}
CHANNABLE_PROJECT_ID={PROJECT_ID} #default, swappable after initialization

用法

#Examples

# app()->make();

$channable = app()->make('channable');

//Get all orders
$channable->orders()->allOrders();

$order_id = 12345678;
$channable->orders()->shipment($order_id, [
    'tracking_code' => '3S1234567890',
    'transporter' => 'POSTNL',
    'order_item_ids' => [
        1,
        2
    ]
]);

//Get all returns with queryParameters
$channable->returns()->allReturns(['limit' => 2, 'last_modified_after' => '2022-01-01']);

//update returns status
$return_id = 12345678;
$status_accepted = \OnlineIdentity\Enums\ReturnsType::ACCEPTED;
$channable->returns()->updateReturnStatus($return_id, $status_accepted);

# Using the facade

//get all orders
$orders = \OnlineIdentity\LaravelChannable\Facades\Channable::orders()->allOrders();

//change project id
\OnlineIdentity\LaravelChannable\Facades\Channable::setProjectId(123456);

\OnlineIdentity\LaravelChannable\Facades\Channable::orders()->shipment($order_id, [
    'tracking_code' => '3S1234567890',
    'transporter' => 'POSTNL',
    'order_item_ids' => [
        1,
        2
    ]);

有关更多详细信息和选项,请访问官方 channable 文档 https://api.channable.com/v1/docs