Cloudsto.re AOD–Shopify Integration enables the AOD customers to have a quick and easy online presence to sell via an eCommerce shop with minimum setup. The integration minimises any complexity on print fulfilment by creating a seamless end-to-end solution. AOD products can be added to Shopify directly from the AOD client and online orders from Shopify are automatically sent to AOD fulfilment stations, print ready.

Cloudsto.re has collaborated with Shopify to develop back-end service connections in order to offer a seamless integration. For a quick setup and to get Shopify free for 14 days, use the link below to signup:

Accessing the API

Make all requests to: https://api.cloudsto.re/ecom/shopify

For full details of Cloudsto.re API specification including Authentication, Request and return data formats refer to Core API documentation,

Multiple Shopify Stores can be integrated to one Cloudsto.re services account. First a store needs to be setup on Shopify site and each store registered with Cloudsto.re services for API services to be active. The following setup information and steps are required:

Shopify Store Signup

⇒ Sign up for a Shopify Store through the link below:

Shopify Signup

Shopify Public App

You can connect your Shopify Store to your Cloudstore Account via the Shopify App through the link below:

Shopify App

Shopify Private App

Shopify Private App is an alternative method for connecting your Shopify store to 
Cloudstore. If you have installed the Public App, there is no need to install this step.

⇒ Add a private app with following details and note the credentials required by next 
section (refer to Shopify Documentation for full guide):

♦ Private app name: cloudstore
♦ Emergency developer email: info@cloudsto.re

Grant Read/Write access for :
♦ Orders - View or manage orders, transactions and fulfilment
♦ Product listings - View or manage product or collection listings
♦ Products - View or manage products, variants and collections

⇒ Under Store settings, tap Notifications and Configure a webhook using the Shopify 
admin, setting the following parameters:
♦ Event : Order creation
♦ Callback URL : https://api.cloudsto.re/ecom/shopify/order
♦ Format : JSON

Cloudstore

⇒ Provide Cloudstore with the following required information on the Store created above, from Shopify admin section:

♦ Shop:  storename.myshopify.com
♦ Website:  www.storename.com
♦ Admin API key:  4768dd5cbaeb41784ed3ec3f17d380f4
♦ Admin API Password : 5e53d5247370bae0f1d55065c01ee4c4
♦ Admin API Shared Secret: 5ef327a8709d7af0c5f604ea8a5282be

Request a list of all collections for the given store accessible for this account.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Store" : "artstore.myshopify.com",
}

Parameters

Response

{
   "Count":4,
   "Collections":[
     {
      "ID" : "78950924400",
      "Title" : "Front Page",
     },
     {
      "ID" : "80449798256",
      "Title" : "Trending",
     },
     {
       "ID" : "138639638614",
       "Title" : "Top Seller",
     },
     {
      "ID" : "80448356464",
      "Title" : "Sale",
     }            
   ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/ecom/shopify/collections",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}),    
    success: function(response) {
          $.each(response.Collections, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/ecom/shopify/collections

This endpoint can be connected to Shopify order Webhook to receive Store orders. All orders for AOD products are then automatically packaged and sent to the printing station specified in the setup.

Request a list of all options for the given store accessible for this account

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Store" : "artstore.myshopify.com",
}

Parameters

Response

{
   "Count":2,
   "Options":[
     {
      "Name" : "Size",
      "Values" : [
         {
          "Option" : "100x100 cm",
          "Width" : 1000,
          "Height" : 1000
         },
         {
          "Option" : "50x50 cm",
          "Width" : 500,
          "Height" : 500
         }
       ]
      },
      {
       "Name" :  "Finish",
       "Values" : [
          {
           "Option" : "Print Only",
           "Media" : "Traditional Photo Paper 1440",
          },
          {
           "Option" : "Canvas",
           "Media" : "Canvas Rag Paper 720",
           "CanvasBorderSize" : 25
          }
        ]
      }            
    ]
}

Parameters

Examples

$.ajax({
    url: "https://api.cloudsto.re/ecom/shopify/options",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}),    
    success: function(response) {
          $.each(response.Options, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/ecom/shopify/options

Submit list of all options for the given store accessible for this account.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Store" : "artstore.myshopify.com",
  "Options" : [
       {
        "Option" : "100x100 cm",
        "Name" : "Size",
        "Width" : 1000,
        "Height" : 1000
       },
       {
        "Option" : "50x50 cm",
        "Name" : "Size",
        "Width" : 500,
        "Height" : 500        
       },
       {
        "Option" : "Print Only",
        "Name" : "Finish",
        "Media" : "Traditional Photo Paper 1440",
       },
       {
        "Option" : "Canvas",
        "Name" : "Finish",
        "Media" : "Canvas Rag Paper 720",
        "CanvasBorderSize" : 25,
        "CanvasBorderType" : "average"
       }
    ]
}

Parameters

Response

{
   "Count":2,
   "Options":[
     {
      "Name" : "Size",
      "Values" : [
         {
          "Option" : "100x100 cm",
          "Width" : 1000,
          "Height" : 1000
         },
         {
          "Option" : "50x50 cm",
          "Width" : 500,
          "Height" : 500
         }
       ]
      },
      {
       "Name" :  "Finish",
       "Values" : [
          {
           "Option" : "Print Only",
           "Media" : "Traditional Photo Paper 1440",
          },
          {
           "Option" : "Canvas",
           "Media" : "Canvas Rag Paper 720",
           "CanvasBorderSize" : 25
          }
        ]
      }            
    ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/ecom/shopify/options",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}),    
    success: function(response) {
          $.each(response.Options, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/ecom/shopify/options

Work with products on Shopify Store

Export a list of all products for the given store accessible for this account to a csv file ready for Import to Shopify.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Store" : "artstore.myshopify.com",
  "Locale" : "en",
  "Products" : [
    {
     "PublisherID" : "15", 
     "ImageID" : "4004", 
     "Title: : "Sunset in London", 
     "Vendor" : "Per Gudnitz",
     "SKU" : "PG-5643",
     "BodyHTML" : "<strong>Sunset by Hammersmith bridge</strong>"
     "ProductType" : "Photography",
     "Collection" : "Trending",
     "Published" : true,
     "Variants" : [
        { 
         "Option1" : "100x100 cm", 
         "Option2: : "Print Only", 
         "Price" : 120 
        }, 
        { 
         "Option1" : "50x50 cm", 
         "Option2" : "Print Only", 
         "Price" : 60, 
         "Position" : 1 
        }
      ]
    }
  ]
}

Parameters

Response

{
   "Name": "20190404_142704_268.csv",
   "Source": "https://s3.amazonaws.com/shopify/exports/artstore.myshopify.com/20190404_142704_268.csv"
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/ecom/shopify/products/export",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,"Products":[{"PublisherID":"15","ImageID":"4009"}]}),    
    success: function(response) {
          $.each(response.Variants, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA","Products":[{"PublisherID":"15","ImageID":"4009"}]}' \
      -X POST https://api.cloudsto.re/ecom/shopify/products/export

Submit a list of all products for the given store accessible for this account.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Store" : "artstore.myshopify.com",
  "Locale" : "en",
  "Products" : [
    {
     "PublisherID" : "15", 
     "ImageID" : "4004", 
     "Title: : "Sunset in London", 
     "Vendor" : "Per Gudnitz",
     "SKU" : "PG-5643",
     "BodyHTML" : "<strong>Sunset by Hammersmith bridge</strong>"
     "ProductType" : "Photography",
     "Collection" : ["80448356464"],
     "Published" : true,
     "Variants" : [
        { 
         "Option1" : "100x100 cm", 
         "Option2: : "Print Only", 
         "Price" : 120 
        }, 
        { 
         "Option1" : "50x50 cm", 
         "Option2" : "Print Only", 
         "Price" : 60, 
         "Position" : 1 
        }
      ]
    }
  ]
}

Parameters

Response

{
   "Count": 1,
   "Products":["2026704404566"]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/ecom/shopify/products/submit",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,"Products":[{"PublisherID":"15","ImageID":"4009"}]}),    
    success: function(response) {
          $.each(response.Variants, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA","Products":[{"PublisherID":"15","ImageID":"4009"}]}' \
      -X POST https://api.cloudsto.re/ecom/shopify/products/submit

Request a list of all stores accessible for this account.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
}

Parameters

Response

{
   "Count" : 2,
   "Stores" : [ "artstore.myshopify.com", "printstore.myshopify.com"]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/ecom/shopify/stores",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}),    
    success: function(response) {
          $.each(response.Stores, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/ecom/shopify/stores

Request information for a specific store accessible for this account.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Store" : "artstore.myshopify.com",
}

Parameters

Response

{
   "Count": 1,
   "Stores": ["https://artsto.re"]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/ecom/shopify/stores/info",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,"Store":"artstore.myshopify.com"}),    
    success: function(response) {
          $.each(response.Stores, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA", "Store" : "artstore.myshopify.com"}' \
      -X POST https://api.cloudsto.re/ecom/shopify/stores/info

Request a list of all variants for the given store accessible for this account.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Store" : "artstore.myshopify.com",
}

Parameters

Response

{
   "Count":4,
   "Variants":[
     {
      "Title" : "100x100 cm / Print Only",
      "Option1" : "100x100 cm",
      "Option2: : "Print Only",
      "Price" : 120
     },
     {
      "Title" : "100x100 cm / Canvas",
      "Option1" : "100x100 cm",
      "Option2" : "Canvas",
      "Price" : 160
     },
     {
       "Title" : "50x50 cm / Print Only",
       "Option1" : "50x50 cm",
       "Option2" : "Print Only",
       "Price" : 60,
       "Position" : 1
     },
     {
      "Title" : "50x50 cm / Canvas",
      "Option1" : "50x50 cm",
      "Option2" : "Canvas",
      "Price" : 100,
     }            
   ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/ecom/shopify/variants",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}),    
    success: function(response) {
          $.each(response.Variants, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/ecom/shopify/variants

Submit a list of all variants for the given store accessible for this account.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Store" : "artstore.myshopify.com",
  "Variants" : [
    {
     "Title" : "100x100 cm / Print Only", 
     "Option1" : "100x100 cm", 
     "Option2: : "Print Only", 
     "Price" : 120 
    }, 
    { 
     "Title" : "100x100 cm / Canvas", 
     "Option1" : "100x100 cm", 
     "Option2" : "Canvas", 
     "Price" : 160 
    }, 
    { 
     "Title" : "50x50 cm / Print Only", 
     "Option1" : "50x50 cm", 
     "Option2" : "Print Only", 
     "Price" : 60, 
     "Position" : 1 
    }, 
    { 
     "Title" : "50x50 cm / Canvas", 
     "Option1" : "50x50 cm", 
     "Option2" : "Canvas", 
     "Price" : 100
    }   
  ]
}

Parameters

Response

{
   "Count":4,
   "Variants":[
     {
      "Title" : "100x100 cm / Print Only",
      "Option1" : "100x100 cm",
      "Option2: : "Print Only",
      "Price" : 120
     },
     {
      "Title" : "100x100 cm / Canvas",
      "Option1" : "100x100 cm",
      "Option2" : "Canvas",
      "Price" : 160
     },
     {
       "Title" : "50x50 cm / Print Only",
       "Option1" : "50x50 cm",
       "Option2" : "Print Only",
       "Price" : 60,
       "Position" : 1
     },
     {
      "Title" : "50x50 cm / Canvas",
      "Option1" : "50x50 cm",
      "Option2" : "Canvas",
      "Price" : 100,
     }            
   ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/ecom/shopify/variants/submit",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}),    
    success: function(response) {
          $.each(response.Variants, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/ecom/shopify/variants/submit