README.en_US.md

SkyHub - PHP SDK

This is the official SDK (Software Developmen Kit) from SkyHub, built in PHP, which you can use to integrate your platform to our system.

See right below how easy is to use it:

<?php

    /**
     * First you need to require the composer autoload file into your script.
     */ 
    require_once './vendor/autoload.php';

    /**
     * These credentials you must request to SkyHub Support team.
     */ 
    $email   = '[email protected]';
    $apiKey  = 'ddRTGUrf_bho17FooTjC';

    /** @var \SkyHub\Api $api */
    $api = new SkyHub\Api($email, $apiKey);
    
    /** @var \SkyHub\Api\Handler\Request\Catalog\Product\AttributeHandler $requestHandler */
    $requestHandler = $api->productAttribute();
    
    /**
     * Create an Attribute
     * @var SkyHub\Api\Handler\Response\HandlerInterface $response
     */
    $response = $requestHandler->create('color', 'Color', [
        'Blue',
        'White',
        'Green',
        'Yellow'
    ]);
    
    if ($response->success()) {
        echo 'SUCCESS!';
    }

Wiki

1. System Requirements
2. Credentials
3. Installation and Setup
4. Using the SDK
   1. Using the API
   2. Catalog
      1. Product Attributes
      2. Products
      3. Categories
   3. Orders
      1. Consulting Orders
      2. Working With Order Queues
      3. Invoicing an Order
      4. Canceling an Order
      5. Adding an Order Tracking Number
      6. Setting an Order as Delivered
      7. Getting Order Tags
      8. Orders With Shipment Issues (Exceptions)
   4. Shipment
      1. PLP

Contributing with the code

Your contribution is always welcome! Please read the contribution documentation.

Authors

Tiago Sampaio

Bruno Gemelli

Support

For support requests please send an e-mail to the following address:

[email protected]

Read in Another Language

• Português do Brasil

Licence

SkyHub PHP SDK is a project started into B2W Digital office and distributed as an Open Source Software in March of 2018.

The code base in this distribution is licenced under OSL 3.0.

The Open Software License 3.0 (OSL-3.0).

For complete licence information please read LICENSE.txt or contact [email protected] to request a copy of it.