StorefrontClient

Your own storefront on a shop's catalog, carts and shopper accounts, through the Storefront API, from your PHP server. Checkout, payment and orders stay on Store Hugs: a cart ends in a link to the shop's own checkout page.

Get started

1. Turn it on. In the Store Hugs panel, open Shop Settings → Integration API and set your site's address, which checkout links back to.

2. Make a secret key (sk_live_…). It works only from servers and is shown once; keep it in your server's secrets. Pass each shopper's IP as shopperIp, so limits count each shopper rather than your server.

3. Install the SDK:

   composer require storehugs/integration
   

4. Make a client for the shopper's request:

   use StoreHugs\Integration\StorefrontClient;
   
   $storefront = new StorefrontClient(
       host: 'shop.example.com',
       key: getenv('STOREHUGS_SECRET_KEY'),
       shopperIp: $request->ip(),
       locale: 'ar',
   );
   

5. Sell: list products, fill a cart, and redirect to its checkout link.

   $products = $storefront->products->list(['perPage' => 12])['data'];
   $cart = $storefront->createCart();
   $session = $storefront->cart($cart['cartToken']);
   
   $session->addItem($products[0]['id'], 2);
   $link = $session->checkout(['returnPath' => '/thanks']);
   
   return redirect()->away($link['checkoutUrl']);
   

   Keep $cart['cartToken'] (in the shopper's session or a cookie) to come back to the cart.

Constructor

Models and methods

Each page describes every method in full: its parameters, the fields it sends and gets back, its refusals and an example.