Zikkio - Universal eCommerce Data API

API

Our API are extremely powerful

You can make many many types of request to a connected ecommerce platform.

Create Product

Create simple or configurable products defining stock level, brand, category and many other information.
List Products

List all products or filter them using SKU, ID, EAN and many other fields.
Create Order

Create an order with all necessary information like customer info, shipping cost and delivery address, order amount, taxes and many other information.
List Orders

List all orders in a specific timeframe or list them all paginated.

                                    $client = new http\Client;
$request = new http\Client\Request;

$body = new http\Message\Body;
$body->append('{
    "merchant_account_number": "XXXX-XXXX-XXXX-XXXX",
    "products":[
        {
            "product_type":"simple",
            "sku":"2873-8833JUSAA",
            "ean":"7384756152318",
            "title":"Nike Air Max 2017 Running Shoes",
            "categories_ids":["18"],
            "price":171.12,
            "special_price":80.12,
            "cost":130.23,
            "brand":"Nike",
            "visibility":"visible",
            "description":"Simple description product",
            "weight":1,
            "qty":11,
            "status":"available",
            "tags":[],
            "images":[
                {
                    "src":"https:\\/\\/images.cdn.com\\/imgs\\/products\\/images\\/23456789.jpg",
                    "is_default":true
                },
                {
                    "src":"https:\\/\\/images.cdn.com\\/imgs\\/products\\/images\\/987654321.jpg",
                    "is_default":false
                }
            ],
            "variants":[]
        }
    ]
}');

$request->setRequestUrl('https://sandbox-api.zikkio.com/v1/products');
$request->setRequestMethod('POST');
$request->setBody($body);

$request->setHeaders([
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer abcdefg123456789'
]);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

                                                    {
    "status": 1,
    "message": "Success",
    "data": [
        {
            "id": 1,
            "title": "ApiCarts Simple Product",
            "description": "Simple description product",
            "sku": "2873-8833JUSAA",
            "barcode": "7384756152318",
            "public_url": "https:\/\/platform.zikkio.com\/index.php\/catalog\/product\/view\/id\/1",
            "edit_url": null,
            "product_type": "simple",
            "enable": "available",
            "price": 12,
            "brand": "ApiCarts",
            "special_price": null,
            "cost": 12,
            "visibility": "visible",
            "qty": 123,
            "weight": 22,
            "categories": [
                {
                    "id": 3,
                    "name": "Default Category",
                    "image": null
                }
            ],
            "images": [
                {
                    "id": 1,
                    "src": "https:\/\/platform.zikkio.com\/media\/catalog\/product\/a\/s\/ergergerg.jpg"
                },
                {
                    "id": null,
                    "src": "https:\/\/platform.zikkio.com\/media\/catalog\/product\/a\/s\/asiefwdg34t4hno.jpg",
                    "is_default": true
                }
            ],
            "tax_id": 2,
            "brand_id": 5,
            "variants": []
        }
    ]
}

View API docs

                                    $client = new http\Client;
$request = new http\Client\Request;

$body = new http\Message\Body;
$body->append('{
	"merchant_account_number": "XXXX-XXXX-XXXX-XXXX",
	"limit_per_page": 4,
	"pages": 1
}');

$request->setRequestUrl('https://sandbox-api.zikkio.com/v1/products');
$request->setRequestMethod('GET');
$request->setBody($body);

$request->setHeaders([
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer 1HqLyjWDarjtT1zdp7dc7'
]);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

                                                    {
  "status": 1,
  "message": "Success",
  "data": [
    {
      "id": 1,
      "title": "Test Simple Product 1",
      "description": null,
      "sku": "Test Simple Product 1",
      "barcode": "0708056062316",
      "public_url": "https:\/\/platform.zikkio.com\/index.php\/catalog\/product\/view\/id\/1",
      "edit_url": null,
      "product_type": "simple",
      "enable": "available",
      "price": 12,
      "brand": "Ecommerce.it",
      "special_price": null,
      "cost": 12,
      "visibility": "visible",
      "qty": 123,
      "weight": 22,
      "categories": [
        {
          "id": 3,
          "name": "ApiDrop",
          "image": null
        }
      ],
      "images": [
        {
          "id": 1,
          "src": "https:\/\/platform.zikkio.com\/media\/catalog\/product\/a\/s\/asino.jpg"
        },
        {
          "id": null,
          "src": "https:\/\/platform.zikkio.com\/media\/catalog\/product\/a\/s\/asino.jpg",
          "is_default": true
        }
      ],
      "tax_id": 2,
      "brand_id": 5,
      "variants": []
    },
    {
      "id": 2,
      "title": "Test Simple Product 2",
      "description": null,
      "sku": "AD123ABC",
      "barcode": "88381859158",
      "public_url": "https:\/\/platform.zikkio.com\/index.php\/catalog\/product\/view\/id\/2",
      "edit_url": null,
      "product_type": "simple",
      "enable": "available",
      "price": 94,
      "brand": "ApiCarts",
      "special_price": null,
      "cost": 94,
      "visibility": "visible",
      "qty": 500,
      "weight": 50,
      "categories": [
        {
          "id": 2,
          "name": "Default Category",
          "image": null
        }
      ],
      "images": [
        {
          "id": 2,
          "src": "https:\/\/platform.zikkio.com\/media\/catalog\/product\/8\/8\/88381859158.jpg"
        },
        {
          "id": null,
          "src": "https:\/\/platform.zikkio.com\/media\/catalog\/product\/8\/8\/88381859158.jpg",
          "is_default": true
        }
      ],
      "tax_id": 2,
      "brand_id": 6,
      "variants": []
    }
  ]
}

View API docs

                                    $client = new http\Client;
$request = new http\Client\Request;

$body = new http\Message\Body;
$body->append('{
    "merchant_account_number":"XXXX-XXXX-XXXX-XXXX",
    "order":[
        {
            "internal_id": "000000001",
            "status": "pending",
            "customer": {
              "first_name": "Demo",
              "last_name": "Customer",
              "email": "democustomer_order@email.com"
            },
            "shipping_address": {
              "first_name": "Demo",
              "last_name": "Customer",
              "company": "Demo Company",
              "country": null,
              "country_code": "IT",
              "address": "Via Demo18",
              "city": "Rome",
              "region": "Rome",
              "region_code": "NA",
              "postcode": "80100",
              "email": "democustomer_order@email.com",
              "phone": "3332323123",
              "vat": "IT123456789"
            },
            "billing_address": {
              "first_name": "Demo",
              "last_name": "Customer",
              "company": "Demo Company",
              "country": null,
              "country_code": "IT",
              "address": "Via Demo18",
              "city": "Rome",
              "region": "Rome",
              "region_code": "NA",
              "postcode": "80100",
              "email": "democustomer_order@email.com",
              "phone": "3332323123",
              "vat": "IT123456789"
            },
            "products": [
              {
                "id": 1,
                "sku": "Test Simple 1",
                "name": "Test Simple 1",
                "price_incl_tax": 12,
                "qty": 2
              }
            ],
            "shipping_rate_id" : 18,
            "currency": "USD",
            "total": 24,
            "tax_id":22,
            "shipping_cost": 10,
            "tax_amount": 2
          }
    ]
}');

$request->setRequestUrl('https://sandbox-api.zikkio.com/v1/order');
$request->setRequestMethod('POST');
$request->setBody($body);

$request->setHeaders([
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer abcdefg123456789'
]);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

                                                    {
  "status": 1,
  "message": "Success",
  "data": [
    {
      "id": "000000123",
      "internal_id": "000000001",
      "status": "pending",
      "total": 24,
      "created_at": "2021-09-02 18:18:18",
      "updated_at": "2021-09-02 18:18:18"
    }
  ]
}

View API docs

                                    $client = new http\Client;
$request = new http\Client\Request;

$body = new http\Message\Body;
$body->append('{
	"merchant_account_number": "XXXX-XXXX-XXXX-XXXX",
	"updated_after": false
}');

$request->setRequestUrl('https://sandbox-api.zikkio.com/v1/orders');
$request->setRequestMethod('GET');
$request->setBody($body);

$request->setHeaders([
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer abcdefg123456789'
]);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

                                                    {
  "status": 1,
  "message": "Success",
  "data": [
    {
      "id": "000000001",
      "internal_id": "000000001",
      "status": "pending",
      "customer": {
        "first_name": "Demo",
        "last_name": "Customer",
        "email": "democustomer_order@email.com"
      },
      "shipping_address": {
        "first_name": "Demo",
        "last_name": "Customer",
        "company": "Demo Company",
        "country": null,
        "country_code": "IT",
        "address": "Via Demo18",
        "city": "Rome",
        "region": "Rome",
        "region_code": "NA",
        "postcode": "80100",
        "email": "democustomer_order@email.com",
        "phone": "3332323123"
      },
      "products": [
        {
          "id": 1,
          "sku": "Test Simple 1",
          "name": "Test Simple 1",
          "price_incl_tax": 12,
          "qty": 2
        }
      ],
      "currency": "USD",
      "total": 34,
      "created_at": "2021-09-02 10:10:51",
      "updated_at": "2021-09-02 10:10:51"
    }
  ]
}