2.2.9.Store information

Qwindo needs to be able to request some store information. This store information will be shown to consumers in order to let them know where they are going to order their products.

An example request should look like:

https://www.store.com/index.php?identifier=stores

The GET value “identifier” is used to specify the type of request, in this case “stores” to request the store information.

Store request specification

Field
Description
Type
Required
Length
allowed_countries Array of countries the shop delivers to array yes
shipping_countries Array of countries the shop ships to (ISO 3166-1 ALPHA-2) array yes
languages Supported languages within the store.

Definition:

(string) require (valid locale in iso alpha2 code) (minlength: 2, maxlength: 2) : (object) required

{ 
      "en_US":{ 
         "metadata":{ 
            "title":"testtttttt",
            "keywords":[ 
               "Magento",
               "Varien",
               "E-commerce"
            ],
            "description":"Default Description"
         },
         "description":{ 
            "long":"long",
            "short":"short"
         },
         "usps":{ 
            "shipping":[ 
               "Sameday delivery",
               "Bezorging ook in de avond",
               "Bezorging ook op Zondag",
               "Vandoor voor 12:00 besteld, vanavond in huis",
               "Vandaag besteld, morgen in huis"
            ],
            "global":[ 
               "",
               "",
               "",
               "Alle producten op voorraad",
               "Bestel via Qwindo en krijg 10% korting"
            ],
            "stock":[ 
               "test stock",
               "voorraad binnen 2 dagen binn"
            ]
         }
      }
   }
object yes
stock_updates True or False, to enable stock update requests boolean yes
allowed_currencies Array of currencies that are supported within the webshop (ISO 4217) array of strings with valid codes of the currencies yes
including_tax True or False, based on pricing is including or excluding tax boolean yes
default_tax Object of a default tax rule. Definition:

{  
   "name":"Not Logged In - Taxable Goods",
   "rate":"21.0000",
   "id":"10"
}
Object yes
shipping_tax Object of a tax rule for the shipping methods Definition:

{  
   "id":"id",
   "name":"string",
   "rules":{  
      "NL":"21.0000",
      "ES":"8.0000"
   }
}
 Object yes
require_shipping True or False, based on shipping requirements. boolean yes
base_url Base url of the store string no 2000
logo URL to the store logo in 250×250 px png format string yes
order_push_url Url used to push the order to (if set order_notification this address will be used with parameters to get the shipping methods based on user data) string yes 2000
coc Chamber of Commerce number string no
email Store contact emailaddress string yes 128
contact_phone Store contact phonenumber string yes 45
address Store address string yes
housenumber Housenumber of the store string yes
zipcode Store zipcode string yes 45
city Store city string yes 128
country alpha2 isocode of the store country string yes 2
vat_nr V.A.T number string no 128
terms_and_conditions URL to the Terms and conditions of the store string yes 2000
faq URL to the FAQ of the store string no 2000
open Opening time of the store string yes 45
closed Closing time of the store string yes 45
days Object of the days the store is open.

Definition:

{

      ‘day name’: (bool) required

}

object yes
social URL’s to the used social channels of the store.

Definition:

{

      channel: (string) optional

}

 object no

rounding_policy

Can be set to: “UP, DOWN, CEILING, HALF_UP, HALF_DOWN, HALF_EVEN” string yes

Response

{  
   "shipping_countries":[  
      "NL"
   ],
   "allowed_countries":[  
      "NL"
   ],
   "languages":{  
      "en_US":{  
         "metadata":{  
            "title":"testtttttt",
            "keywords":[  
               "Magento",
               "Varien",
               "E-commerce"
            ],
            "description":"Default Description"
         },
         "description":{  
            "long":"long",
            "short":"short"
         },
         "usps":{  
            "shipping":[  
               "Sameday delivery",
               "Bezorging ook in de avond",
               "Bezorging ook op Zondag",
               "Vandoor voor 12:00 besteld, vanavond in huis",
               "Vandaag besteld, morgen in huis"
            ],
            "global":[  
               "",
               "",
               "",
               "Alle producten op voorraad",
               "Bestel via Qwindo en krijg 10% korting"
            ],
            "stock":[  
               "test stock",
               "voorraad binnen 2 dagen binn"
            ]
         }
      }
   },
   "allowed_currencies":[  
      "EUR",
      "VEF",
      "CHW"
   ],
   "stock_updates":true,
   "including_tax":false,
   "tax_calculation":"total",
   "default_tax":{  
      "name":"Not Logged In - Taxable Goods",
      "rate":"21.0000",
      "id":"10"
   },
   "shipping_tax":{  
      "id":"4",
      "name":"msp-shipping",
      "rules":{  
         "NL":"21.0000",
         "ES":"8.0000"
      }
   },
   "rounding_policy":"UP",
   "require_shipping":true,
   "base_url":"http:\/\/multisafepay-demo.com\/plugingroup\/development\/magento\/testing\/",
   "logo":"http:\/\/multisafepay-demo.com\/plugingroup\/development\/magento\/testing\/media\/theme\/default\/multisafepay.png",
   "order_push_url":"http:\/\/multisafepay-demo.com\/plugingroup\/development\/magento\/testing\/msp\/checkout\/notification\/",
   "email":"support@example.com",
   "contact_phone":"",
   "address":"test",
   "housenumber":"39c",
   "zipcode":"1111 aa",
   "city":"Amsterdam",
   "country":"NL",
   "vat_nr":"nlb01234555",
   "coc":"12345",
   "terms_and_conditions":"https:\/\/www.terms.nl",
   "faq":"http:\/\/wwww.faq.nl",
   "open":"08:00",
   "closed":"12:00",
   "days":{  
      "sunday":false,
      "monday":true,
      "tuesday":true,
      "wednesday":true,
      "thursday":true,
      "friday":false,
      "saturday":true
   },
   "social":{  
      "facebook":"http:\/\/www.facebook.com",
      "twitter":"http:\/\/www.twitter.com",
      "linkedin":"http:\/\/linkedin.com"
   }
}

Error Codes

Error Code
Error Description
Case DescriptionType
QW-1000 Identifier not set The feed url is called, including a feed identifier. This error must be returned when the identifier is not available.
QW-2000 You’re not allowed to request the product feed. The Feed has been disabled, or the authorisation failed
QW-3000 Signature error The Feed has been enabled, but the authorisation failed because of mismatching signatures.
QW-4000 Error generating the product feed There was en error generating the product data for the feed
QW-4001 There was an error generating the total products count Something went wrong generation the total products count
QW-4002 Product ID not set When requesting a specific product, the product ID is needed. When the product ID is not available, this error must be returned
QW-4003 Offset not set When requesting the product feed, an offset is provided.
QW-4004 Limit not set When requesting the product feed, a limit is provided
QW-5000 Error generating the shop data feed There was a problem generating the shop data feed.
QW-6000 Error generating the category data feed There was a problem generating the list of categories for the category feed
QW-7000 Error generating the stock data feed There was a problemen generating the stock request data feed
QW-8000 Error generating the shipping data feed There was a problem generating the list of shipping methods for the feed
QW-9000 Deprecated request The request is no longer supported
QW-10000 Order creation authentication failure There was an error with the authentication when the order was pushed to the store
QW-10001 Could not create or update the order There was an error while creating/updating the order after an order/update push to the store
QW-10002 Could not create or update the order: “custom store catched exception message” There was an error while creating/updating the order after an order/update push to the store where the store generated a unique error message.

Response JSON Structure


{  
   "id":"id",
   "name":"string",
   "rules":{  
     {"success": false, 
    "data": {
        "error_code": "QW-1000",
        "error": "Could not create or update the order",
    }
}
   }
}
Suggest Edit