README

Laravel client package used by UI APIs to call the Stellar Commerce Core/Base API.

Install

composer require stellarsecurity/stellarsecurity-commerce-laravel

Publish config

php artisan vendor:publish --tag=stellarsecurity-commerce-laravel-config

Env

STELLAR_COMMERCE_CORE_BASE_URL=http://127.0.0.1:8000
STELLAR_COMMERCE_CORE_API_PREFIX=/api/v1

STELLAR_COMMERCE_CORE_BASIC_AUTH_ENABLED=true
STELLAR_COMMERCE_CORE_BASIC_AUTH_USER=stellar
STELLAR_COMMERCE_CORE_BASIC_AUTH_PASS=CHANGE_THIS

# Optional. These are already the package defaults if omitted.
STELLAR_COMMERCE_CORE_TIMEOUT_SECONDS=30
STELLAR_COMMERCE_CORE_CONNECT_TIMEOUT_SECONDS=10
STELLAR_COMMERCE_CORE_RETRY_TIMES=5
STELLAR_COMMERCE_CORE_RETRY_SLEEP_MS=1000
STELLAR_COMMERCE_CORE_RETRY_MULTIPLIER=2
STELLAR_COMMERCE_CORE_RETRY_MAX_SLEEP_MS=10000

Important trust boundary

The UI API must not send money amounts like shipping/tax/discount. Those must be computed by the Commerce Core API.

Send:

• items
• shipping address (if physical)
• shipping_method (optional)
• coupon_code (optional)

Usage

use StellarSecurity\CommerceLaravel\Contracts\CommerceClientContract;
use StellarSecurity\CommerceLaravel\DTO\CheckCouponCodeRequest;
use StellarSecurity\CommerceLaravel\DTO\CreateOrderRequest;
use StellarSecurity\CommerceLaravel\DTO\OrderItem;

public function __construct(private CommerceClientContract $commerce) {}

$req = new CreateOrderRequest(
  idempotencyKey: (string) \Illuminate\Support\Str::uuid(),
  userId: null,
  buyerRef: (string) \Illuminate\Support\Str::uuid(),
  currency: 'EUR',
  items: [ new OrderItem($variantId, 1) ],
  shipping: null,
  shippingMethod: null,
  couponCode: null,
  meta: ['channel' => 'direct']
);

$result = $this->commerce->createOrder($req);

// Check a coupon code (exists + discount info)
$couponResult = $this->commerce->checkCouponCode(
  new CheckCouponCodeRequest(couponCode: 'TEST10')
);

Retry configuration

The client retries transient Commerce Core failures without requiring a queue. Configure the behaviour with environment variables: If these env variables are not present, the same safe defaults are used inside the client code.

STELLAR_COMMERCE_CORE_TIMEOUT_SECONDS=30
STELLAR_COMMERCE_CORE_CONNECT_TIMEOUT_SECONDS=10
STELLAR_COMMERCE_CORE_RETRY_TIMES=5
STELLAR_COMMERCE_CORE_RETRY_SLEEP_MS=1000
STELLAR_COMMERCE_CORE_RETRY_MULTIPLIER=2
STELLAR_COMMERCE_CORE_RETRY_MAX_SLEEP_MS=10000

Retries are attempted for connection errors and HTTP 408, 429, 500, 502, 503, and 504 responses.