Shopgate Developer Center
Introduction
Guides
Tutorials
References
Support
Login
No results found.
ENGAGE
HOCs
Hooks
Tracking Events
Extensions
Plugin API
System Information
ping
POST
get_settings
POST
set_settings
POST
get_log_file
POST
clear_log_file
POST
clear_cache
POST
Stock
Cart
Order
Customer
Export
Merchant API
POST

ping

Returns information about the framework and server used.

Query parameters

action
string

Requested method

required
default : ping
example : ping
shop_number
string

Your shop number.

required
example : 11413
trace_id
string

Unique request trace ID.

required
example : sma-9412

Response

application/json
array[object]
error
integer

Error code 0 means no error.

required
error_text
string or null

Error text; null means no error.

required
shopgate_library_version
string

Shopgate Library version. Example: “2.5.0”

required
plugin_version
string

Plugin version. Example: “2.5.3”

required
trace_id
string

Request trace-ID, needed as reference for contact. Example: “sma-4f99573d74ae1”

required
pong
string

Response to ping request.

1 validation + required
configuration
object
shop_info
object
plugins_installed
array[object]

Error Codes

Code Description
2 cannot open/create logfile(s)
10 invalid value in configuration
11 error reading or writing configuration
20 no action specified
21 unknown action requested
22 disabled action requested
23 wrong response format
83 database error
100 no connection to server
101 Unknown action
102 error code received from merchant API
120 authentication failed
999 Unknown error

Example

{
  "error": 0,
  "error_text": null,
  "shopgate_library_version": "2.1.0",
  "plugin_version": "2.1.0",
  "trace_id": "sma-4069",
  "pong": "OK",
  "configuration": {
    "api_url": "https://api.shopgate.com/merchant/",
    "customer_number": "XXXXXX",
    "apikey": "XXXXXX",
    "enable_add_order": true,
    "enable_check_cart": true,
    "enable_check_stock": true,
    "enable_clear_cache": true,
    "enable_clear_log_file": true,
    "enable_get_categories": true,
    "enable_get_categories_csv": true,
    "enable_get_customer": true,
    "enable_get_items": true,
    "enable_get_items_csv": true,
    "enable_get_log_file": true,
    "enable_get_orders": true,
    "enable_get_reviews": true,
    "enable_get_reviews_csv": true,
    "enable_get_settings": true,
    "enable_mobile_website": true,
    "enable_ping": true,
    "enable_redeem_coupons": true,
    "enable_register_customer": true,
    "enable_set_settings": true,
    "enable_update_order": true,
    "supported_fields_check_cart": [
      "external_coupons",
      "shipping_methods",
      "items",
      "payment_methods"
    ],
    "supported_fields_get_settings": [
      "tax",
      "customer_groups"
    ],
    "supported_methods_cron": [
      "set_shipping_completed",
      "cancel_orders"
    ],
    "supported_response_types": {
      "get_categories": [
        "xml",
        "csv"
      ],
      "get_items": [
        "xml"
      ],
      "get_reviews": [
        "csv"
      ]
    }
  },
  "plugin_info": {
    "shopsystem_version": "2.3.8",
    "shopsystem_edition": "community"
  },
  "shop_info": {
    "category_count": 125,
    "item_count": 846,
    "review_count": 312,
    "media_count": 478,
    "plugins_installed": [
      {
        "name": "Skrill Moneybookers Payment Module",
        "id": "Phoenix_Moneybookers",
        "version": "1.6.0.0",
        "is_active": "true"
      },
      {
        "name": "Cash on Delivery Payment Module",
        "id": "Phoenix_CashOnDelivery",
        "version": "1.0.8",
        "is_active": "true"
      }
    ]
  }
}