Stores¶

List All Stores¶

To get a list of stores, send a GET request to /api/stores/:

GET /api/stores/

This request returns the list of stores with their details.

GET /api/stores/?items_per_page=1

{
 "stores": [
    {
     "company_id": "1",
     "lang_code": "en",
     "email": "simtech@example.com",
     "company": "Simtech",
     "timestamp": "1269610461",
     "status": "A",
     "storefront": "localhost",
     "secure_storefront": "localhost",
     "average_rating": null,
     "company_thread_ids": "1_0"
    }
 ],
 "params": [0]
}

Get a Specific Store¶

To get the details of a specific store, send a GET request to /api/stores/<company_id>/. For example:

GET /api/stores/1

Create a Store¶

Send a POST request to /api/stores/:

POST /api/stores/

Pass the following fields with store details in the HTTP request body in accordance with the Content-Type. Required fields are marked with *:

• company*—the name of the store.

• storefront*—the URL of the store.

  Important

  The storefront field must have a unique value for each store.

• secure_storefront—the secure URL of the store.

There are other parameters that aren’t returned by CS-Cart REST API, but can be used:

• redirect_customer—determines whether customers can be redirected from this store to a different store depending on their IP address:

  • Y—customers can be redirected.
  • N—customers can’t be redirected.

  Hint

  For geolocation, we use GeoLite2 databases created by MaxMind, available from https://www.maxmind.com.

• entry_page—determines the pages of the store which should take the customer to the global entry page:

  • all_pages—customers will be taken to the global entry page from any page of the store.
  • none—customers won’t be taken to the global entry page from any page of the store.
  • index—customers will be taken to the global entry page from the index page of the store.

  Important

  The entry_page field applies only if redirect_customer is N.

• countries_list—the list of countries assigned to the store; if one of your other stores supports redirection, customers from these countries will be redirected here from that store:

  {
   ...
   "countries_list": [
          "DZ",
          "AS",
          "AQ",
          "AG",
          "AR"
      ],
   ...
  }
  

• clone_from—the ID of the store to clone data from.

• clone—an object with various store attributes that must be cloned, with Y values:

  {
   ...
   "clone_from": "1",
   "clone": {
      "layouts": "Y",
      "settings": "Y",
      "profile_fields": "Y",
      "pages": "Y",
      "promotions": "Y",
      "shippings": "Y",
      "payments": "Y",
      "product_filters": "Y",
      "product_features": "Y",
      "sitemap": "Y",
      "static_data_clone": "Y",
      "products": "Y",
      "categories": "Y"
   }
  }
  

{
 "company": "Example Company",
 "storefront": "example.com",
 "redirect_customer": "Y",
 "entry_page": "none",
 "countries_list": [
      "DZ", "AS", "AQ", "AG", "AR"
 ]
}

{
 "company": "Example Company 2",
 "storefront": "example2.com",
 "secure_storefront": "example2.com",
 "clone_from": "1",
 "clone": {
    "layouts": "Y",
    "settings": "Y",
    "products": "Y",
    "categories": "Y"
  }
}

Update a Store¶

To update an existing store, send the PUT request to /api/stores/<company_id>/. For example:

PUT /api/stores/2/

Pass the fields with the store details in the HTTP request body in accordance with the passed Content-Type. None of the fields are required.

• company—the name of the store.

• storefront—the URL of the store.

  Important

  The storefront field must have a unique value for each store.

• secure_storefront—the secure URL of the store.

• timestamp—the UNIX time when the store was created.

You can use the PUT request to add information about the company, which isn’t returned by GET requests, such as:

• company_name—the name of the company.

• company_address—the address of the company.

• company_city—the city of the company.

• company_country—the country of the company. Must be specified as the code (for example, US).

  Hint

  You can find those codes under Administration → Shipping & taxes → Countries.

• company_state—the state of the company. Can be specified as a code.

  Hint

  You can find those codes under Administration → Shipping & taxes → States.

• company_zipcode—the zipcode of the company.

• company_phone—the primary phone number of the company.

• company_phone_2—the second phone number of the company.

• company_fax—the fax number of the company.

• company_website—the website of the company.

• company_start_year—the year when the company started working.

• company_users_department—the email address of the user department.

• company_site_administrator—the email address of the site administrator.

• company_orders_department—the email address of the order department.

• company_support_department—the email address of the help/support department.

• company_newsletter_email—the reply-to/newsletter email address.

{
 "company": "Example",
 "storefront": "example.com/store",
 "secure_storefront": "example.com/store",
 "countries_list": [
      "GB", "US"
 ],
 "company_name": "My new company",
 "company_address": "41 Avenue",
 "company_city": "New York",
 "company_country": "US",
 "company_state": "NY",
 "company_zipcode": "10001",
 "company_phone": "1234-123-12345",
 "company_phone_2": "",
 "company_fax": "",
 "company_website": "example.com",
 "company_start_year": "2005",
 "company_users_department": "users@example.com",
 "company_site_administrator": "admin@example.com",
 "company_orders_department": "orders@example.com",
 "company_support_department": "support@example.com",
 "company_newsletter_email": "news@example.com"
}

Delete a Store¶

To delete a store, send the DELETE request to /api/stores/<company_id>/. For example:

DELETE /api/stores/2

This request will delete a store with company_id=2.