Cloudsto.re AOD–WooCommerce 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 WooCommerce directly from the AOD client and online orders from WooCommerce are automatically sent to AOD fulfilment stations, print ready.

Accessing the API

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

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

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

WooCommerce REST API V3

To use the latest version of the REST API you must be using:

• WooCommerce 3.5+.
• WordPress 4.4+.
• Pretty permalinks in “Settings > Permalinks” so that the custom endpoints are supported. Ensure the first rewriting option is set to “Posts name”. Default permalinks will not work.
• Enable access for the API over HTTPS.

WooCommerce API Keys

Pre-generated keys are used to authenticate use of the REST API endpoints. New keys can be generated through the WordPress admin interface. To create or manage keys for a specific WordPress user, go to WooCommerce > Settings > Advanced > REST API.

Click the “Add Key” button. In the next screen, add a description and select the WordPress user you would like to generate the key for. Use of the REST API with the generated keys will conform to that user’s WordPress roles and capabilities.

Choose the level of access for this REST API key, which should be Read/Write access. Then click the “Generate API Key” button and Woo-commerce will generate REST API keys for the selected user.

Now that keys have been generated, you should see two new keys, a QRCode, and a Revoke API Key button. These two keys are your Consumer Key and Consumer Secret.  Make a note of theses two keys as you will need them for the next section to activate the store on Cloudstore Console.

If the WordPress user associated with an API key is deleted, the API key will cease to function. API keys are not transferred to other users.

Cloudstore Connect

In Cloudstore Console go to Integration/WooCommerce section and press Add button to connect your new Woo-commerce store. Enter store URL as the name and enter the consumer key and secret from the previous section here under API Key and Secret. Press Add to complete the process.

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

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Store" : "printsto.re",
}

Parameters

Response

{
   "Count":4,
   "Categories":[
     {
      "id" : "78950924400",
      "name" : "Front Page",
     },
     {
      "id" : "80449798256",
      "name" : "Trending",
     },
     {
       "id" : "138639638614",
       "name" : "Top Seller",
     },
     {
      "id" : "80448356464",
      "name" : "Sale",
     }            
   ]
}

Parameters

JQuery Example

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

cURL Example

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

This endpoint can be connected to WooCommerce 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" : "printsto.re",
}

Parameters

Response

{
   "Count":2,
   "Options":[
     {
      "Attribute" : "Size",
      "AttributeID" : 2,
      "Option" :  "50x50",
      "Template" : "Square-MD",
      },
      {
       "Attribute" :  "Finish",
       "AttributeID" : 4,
       "Option" : "Matte",
       "Media" : "Factory Queue 1"
      }            
    ]
}

Parameters

Examples

$.ajax({
    url: "https://api.cloudsto.re/ecom/woocommerce/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/woocommerce/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