README

要使用此包，首先您必须拥有一个Loyverse账户，其次您必须通过Loyverse本身创建一个API令牌。

文档
测试
贡献
安全漏洞
鸣谢
许可

文档

安装

要在您的项目中安装SDK，您需要通过composer要求该包

composer require pashkevich/loyverse-sdk

基本用法

您可以这样创建SDK的一个实例

$loyverse = new Pashkevich\Loyverse\Loyverse(PERSONAL_ACCESS_TOKEN_HERE);

使用Loyverse实例，您可以执行多个操作，以及检索Loyverse API提供的不同资源

$categories = $loyverse->categories();

这将为您提供一个您有权访问的类别数组，其中每个类别都由一个Pashkevich\Loyverse\Resources\Category实例表示，此实例具有多个公共属性，如$id、$name、$color等。

您还可以使用以下方式检索单个类别

$category = $loyverse->category(CATEGORY_ID_HERE);

对于此SDK支持的多项操作，您可能需要传递一些参数，例如在创建新的类别时

$category = $loyverse->createCategory([
    'name' => 'Fruits',
    'color' => 'ORANGE',
]);

这些参数将用于发送到Loyverse服务器的POST请求中，您可以在Loyverse官方API文档上找到有关每个操作所需参数的更多信息。

您还可以设置所需的超时值

$loyverse->setTimeout(120)->createCategory(array $data);

管理类别

$loyverse->categories(array $parameters);
$loyverse->category(string $categoryId);
$loyverse->createCategory(array $data);
$loyverse->deleteCategory(string $categoryId);

在Category实例上，您还可以调用

$category->update(array $data);
$category->delete();

管理客户

$loyverse->customers(array $parameters);
$loyverse->customer(string $customerId);
$loyverse->createCustomer(array $data);
$loyverse->deleteCustomer(string $customerId);

在Customer实例上，您还可以调用

$customer->update(array $data);
$customer->delete();

管理折扣

$loyverse->discounts(array $parameters);
$loyverse->discount(string $discountId);
$loyverse->createDiscount(array $data);
$loyverse->deleteDiscount(string $discountId);

在Discount实例上，您还可以调用

$discount->update(array $data);
$discount->delete();

管理员工

$loyverse->employees(array $parameters);
$loyverse->employee(string $employeeId);

管理库存

$loyverse->inventory(array $parameters);
$loyverse->updateInventory(array $data);

管理项目

$loyverse->items(array $parameters);
$loyverse->item(string $itemId);
$loyverse->createItem(array $data);
$loyverse->deleteItem(string $itemId);

在Item实例上，您还可以调用

$item->update(array $data);
$item->delete();

管理商家

$loyverse->merchant();

管理修饰符

$loyverse->modifiers(array $parameters);
$loyverse->modifier(string $modifierId);
$loyverse->createModifier(array $data);
$loyverse->deleteModifier(string $modifierId);

在Modifier实例上，您还可以调用

$modifier->update(array $data);
$modifier->delete();

管理支付类型

$loyverse->paymentTypes(array $parameters);
$loyverse->paymentType(string $paymentTypeId);

管理POS设备

$loyverse->posDevices(array $parameters);
$loyverse->posDevice(string $posDeviceId);
$loyverse->createPosDevice(array $data);
$loyverse->deletePosDevice(string $posDeviceId);

在PosDevice实例上，您还可以调用

$posDevice->update(array $data);
$posDevice->delete();

管理收据

$loyverse->receipts(array $parameters);
$loyverse->receipt(string $receiptNumber);
$loyverse->createReceipt(array $data);
$loyverse->createReceiptRefund(string $receiptNumber, array $data);

在Receipt实例上，您还可以调用

$receipt->refund(array $data);

管理班次

$loyverse->shifts(array $parameters);
$loyverse->shift(string $shiftId);

管理商店

$loyverse->stores(array $parameters);
$loyverse->store(string $storeId);

管理供应商

$loyverse->suppliers(array $parameters);
$loyverse->supplier(string $supplierId);
$loyverse->createSupplier(array $data);
$loyverse->deleteSupplier(string $supplierId);

在Supplier实例上，您还可以调用

$supplier->update(array $data);
$supplier->delete();

管理税费

$loyverse->taxes(array $parameters);
$loyverse->tax(string $taxId);
$loyverse->createTax(array $data);
$loyverse->deleteTax(string $taxId);

在Tax实例上，您还可以调用

$tax->update(array $data);
$tax->delete();

管理变体

$loyverse->variants(array $parameters);
$loyverse->variant(string $variantId);
$loyverse->createVariant(array $data);
$loyverse->deleteVariant(string $variantId);

在Variant实例上，您还可以调用

$variant->update(array $data);
$variant->delete();

管理Webhooks

$loyverse->webhooks(array $parameters);
$loyverse->webhook(string $webhookId);
$loyverse->createWebhook(array $data);
$loyverse->deleteWebhook(string $webhookId);

在Webhook实例上，您还可以调用

$webhook->update(array $data);
$webhook->delete();

测试

composer test

贡献

请参阅CONTRIBUTING以获取详细信息。

安全

如果您发现任何安全相关的问题，请通过电子邮件siarheipashkveich@gmail.com而不是使用问题跟踪器。

鸣谢

Sergey Pashkevich

许可

Loyverse SDK是开源软件，许可协议为MIT许可。

pashkevich / loyverse-sdk

维护者

详细信息