setono/peak-wms-php-sdk

Consume the Peak WMS API with this PHP SDK

v1.0.0 2024-11-18 14:05 UTC

Requires

• php: >=8.1
• cuyz/valinor: ^1.10
• php-http/discovery: ^1.14
• psr/http-client: ^1.0
• psr/http-client-implementation: ^1
• psr/http-factory: ^1.0
• psr/http-factory-implementation: ^1
• psr/http-message: ^1.0
• psr/log: ^1.1 || ^2.0 || ^3.0

Requires (Dev)

• infection/infection: ^0.27.11
• kriswallsmith/buzz: ^1.2
• nyholm/psr7: ^1.8
• phpspec/prophecy-phpunit: ^2.0
• phpunit/phpunit: ^9.6
• psalm/plugin-phpunit: ^0.18
• setono/code-quality-pack: ^2.7.2

MIT

• Joachim Løvgaard

README

Consume the Peak WMS API in PHP.

Installation

composer require setono/peak-wms-php-sdk

Usage

Create sales order

<?php
use Setono\PeakWMS\Client\Client;
use Setono\PeakWMS\DataTransferObject\Address;
use Setono\PeakWMS\DataTransferObject\SalesOrder\OrderLine\SalesOrderLine;
use Setono\PeakWMS\DataTransferObject\SalesOrder\SalesOrder;

$client = new Client('your_api_key');

$salesOrder = new SalesOrder(
    orderId: 'order_in_your_store',
    forwarderProductId: 'usually_your_shipping_method_id',
    orderNumber: 'order_number_in_your_store',
    billingAddress: new Address(
        customerName: 'John Doe',
        address1: 'Hobrovej 1',
        postalCode: '9000',
        city: 'Aalborg',
        country: 'DK',
        email: '[e-mail]',
        phone: '33762234',
    ),
);

$salesOrder->orderLines[] = new SalesOrderLine(
    orderLineId: 'order_line_id_in_your_store',
    quantityRequested: 1,
    productId: 'BLUE_TSHIRT-L',
);
$client->salesOrder()->create($salesOrder);

Production usage

Internally this library uses the CuyZ/Valinor library which is particularly well suited for turning API responses into DTOs. However, this library has some overhead and works best with a cache enabled.

When you instantiate the Client use the opportunity to set a cache:

<?php

use CuyZ\Valinor\Cache\FileSystemCache;
use Setono\PeakWMS\Client\Client;

require_once '../vendor/autoload.php';

$cache = new FileSystemCache('path/to/cache-directory');
$client = new Client('API_KEY');
$client->getMapperBuilder()->withCache($cache);

You can read more about it here: Valinor: Performance and caching.