Skip to main content

WooCommerce

WooCommerce is an open-source e-commerce platform powered by WordPress. It allows companies of all sizes to simply create an online store. You can use WooCommerce to fetch commercial information about your users who have an e-commerce business.

This provider supports these data types:

Connect your WooCommerce account to the Qard API​

To retrieve your user commercial data, you will have to:

1. Enable WooCommerce provider​

(PUT) /api/v6/providers/woocommerce
{
    "enable": true
}

2. Settings WooCommerce provider:​

(PUT) /api/v6/providers/woocommerce/settings
{
  "auto_connect": (true|false)
}

3. Create a data connection:​

(POST) /api/v6/users/{userId}/data-connections
{
  "provider_name": "woocommerce",
  "requested_data_types": [
      "COMMERCE_LOCATION",
      "COMMERCE_CUSTOMER",
      "COMMERCE_PRODUCT",
      "COMMERCE_ORDER"
  ]
}

4. Create a synchronization​

After finishing the connection process by your user, and after validating that the data connection status is CONNECTED you can run a new synchronization.

(POST) /api/v6/users/{userId}/sync
{
  "data_types": [
      "COMMERCE_LOCATION",
      "COMMERCE_CUSTOMER",
      "COMMERCE_PRODUCT",
      "COMMERCE_ORDER"
  ]
}

To verify that you are receiving your user's commerce data, check out these endpoints:

  • GET /api/v6/users/{userId}/commerce-locations
  • GET /api/v6/users/{userId}/commerce-customers
  • GET /api/v6/users/{userId}/commerce-products
  • GET /api/v6/users/{userId}/commerce-orders