LogoLogo
  • 🏃‍♀️ Get started
    • Create your first integration
      • Step 1 - Creating your Source & Destination System keys
        • Shopify Key
        • FTP Key
      • Step 2 - Select a Source Function
      • Step 3 - Select a Destination Function
      • Step 4 - Select a Transformation
      • Step 5 - Put it all together to create a Stream
      • Step 6 - Run your stream
    • Go-live best practice
  • 🏄🏻‍♀️ Integration Tutorials
    • Shopify with Descartes Peoplevox
    • Shopify with FTP
      • Shopify with FTP
      • Shopify with FTP (Part 2)
    • Shopify with ReBOUND
    • WooCommerce
      • WooCommerce with FTP
    • NetSuite
  • 🏗️ Creating streams
    • Intro
    • Streams
      • Web hook installation
      • Web hook support
        • DEAR Systems
        • Descartes Peoplevox
        • Shopify
    • Systems
      • System library
        • DEAR Systems
        • Email
        • FTP
        • Descartes Peoplevox
        • Magento 1.x
        • Magento 2.x
        • ParcelLab
        • ReBOUND
        • Shopify
        • WooCommerce
    • Keys
      • Key library
        • Shopify private apps
        • Netsuite
        • FTP and sFTP
        • oAuth
    • Sources
    • Transformations
      • Public Transformations
      • Private Transformations
      • Customising a Public Transformation
      • Write a custom transformation
        • Transformation Library
        • Example 1 - Sales Order
        • Example 2 - Shipment
    • Destinations
      • Aggregated Events
    • Data uploads
    • Lookup table
  • 🔧 Editing streams
    • Updating source and destinations
    • Deleting a stream
  • 🎛️ Monitoring streams
    • Job Statuses
    • Event Statuses
    • Resending data
      • Replicate Job
      • Replicate Event
      • Replicate Event without Event in Control Panel
    • Reporting
      • Jobs
      • Events
      • Entities
    • Alerts
  • ⚙️ Administration
    • Login and security
      • Two factor authentication (2FA) setup
        • Signup to HighCohesion without QR scan
    • Creating an organisation
    • Billing Information
    • Creating a user
    • Roles & Permissions
  • 💁🏽 Help and support
    • Glossary of platform terminology
    • Security standards
    • Data retention policy
    • Contact us
Powered by GitBook
On this page
  • Tutorials
  • Functions
  • GetCoupons
  • GetCustomers
  • GetOrders
  • GetProducts
  • PostCustomer
  • PostProduct
  • PostOrder
  • PostShipment
  • Settings
  • Web hooks

Was this helpful?

  1. 🏗️ Creating streams
  2. Systems
  3. System library

WooCommerce

Functions and settings available for the WooCommerce endpoint

PreviousShopifyNextKeys

Last updated 3 years ago

Was this helpful?

Tutorials

:

Functions

The following list of functions are available in the WooCommerce system:

GetCoupons

Function for retrieving coupon information from WooCommerce via the REST API. For more details on the schema that is returned from WooCommerce and filters that are available please see the documentation at:

This function is has the following filters that are commonly used:

Filter

Example

Description

after

filter_after = "CURRENT -15 minutes"

Used to filter coupons that have been created/updated in the previous 15 minutes.

GetCustomers

Function for retrieving customer data from WooCommerce via the REST API. For more details on the schema that is returned from WooCommerce and filters that are available please see the documentation at:

This function has the following filters that are commonly used:

Filter

Example

Description

after

filter_after = "CURRENT -15 minutes"

Used to filter customers that have been created/updated in the previous 15 minutes.

GetOrders

Filter

Example

Description

after

filter_after = "CURRENT -15 minutes"

Used to filter orders that have been created in the previous 15 minutes.

To reduce bandwidth and speed up your integration, consider using WooCommerce web hooks that work natively with the HighCohesion system.

GetProducts

This function is has the following settings available:

Filter

Example

Description

after

filter_after = "CURRENT -15 minutes"

Used to filter products that have been created in the previous 15 minutes.

PostCustomer

PostProduct

The following settings are available for this function:

Setting

Values

Description

allow_product_search

true / false

If set to true the function will allow the lookup of existing product when the id has not been set in the payload. As default the system will attempt to match the slug

search_key

Valid search key from the WooCommerce product API.

Defaults to slug, can optionally be set to sku or attribute_term

PostOrder

Setting

Values

Description

allow_order_update

true / false

If set to true the function will allow the update of existing orders when the id has been set in the payload out.

PostShipment

Shipments require the Order ID to successfully post. However the HighCohesion system will accept either an order_id field or an order_number field in the payload out. If you provide the order number field, the function will attempt to lookup the order id before it posts to shipment information.

There are no additional settings for this function.

Functions lists are expanding weekly, this list was accurate at the date of publishing.

Settings

The following settings below are optional for WooCommerce integrations.

Web hooks

WooCommerce web hooks work natively with the HighCohesion system and can be easily setup via the WooCommerce settings area in Wordpress. Follow the steps below to setup the most common Sales Orders web hook, from WooCommerce to HighCohesion:

  • Login to your Wordpress system and click on the WooCommerce > Settings link from the left hand navigation.

  • Once on the settings page, click on the "Advanced" tab at the top of the page.

  • Next click on the "Webhooks" link at the top, just below the tabs.

  • Now the web hooks page is shown, click the purple button that says "Create new web hook".

  • On the new web hook form, enter the following information:

    • Name - Give the web hook notification a name, e.g. Sales orders to HighCohesion.

    • Status - Set to Active

    • Topic - Select the top that you want to be notified about, in this examples "Order Create"

    • Secret - Leave blank

    • API Version - Select the version required, most select V3.

  • Once complete, now press save and the WooCommerce system will be setup to send HighCohesion notifications when new records are created.

Function for retrieving sales orders from WooCommerce via the REST API. This function is has the following filters that are commonly used. Please also review the filters in the official WooCommerce () documentation which can also be used in the same filter_ prefixed way in the HighCohesion control panel.

Function for retrieving products from WooCommerce via the REST API. For more details on the schema that is returned from WooCommerce and filters that are available please see the documentation at:

Allows the creation and update of customer records in the WooCommerce system. For details on the WooCommerce customer schema, please visit:

Allows the creation and update of products inside of the WooCommerce system. Public transformation files are available in the HighCohesion control panel. For details on the WooCommerce product schema, please visit:

Allows the creation and update of orders inside of the WooCommerce system. For details on the WooCommerce customer schema, please visit:

Allows the creation of shipment tracking records against sales orders inside of the WooCommerce system. For details on the WooCommerce customer schema, please visit:

Delivery URL - Set this to your web hook URL for your stream, (see )

For a guide on how to generate your HighCohesion web hook URL, please .

WooCommerce integration setup tutorials
WooCommerce to FTP integration
https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-coupons
https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-customers
https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-orders
https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-products
https://woocommerce.github.io/woocommerce-rest-api-docs/#create-a-customer
https://woocommerce.github.io/woocommerce-rest-api-docs/#create-a-product
https://woocommerce.github.io/woocommerce-rest-api-docs/#create-an-order
https://docs.woocommerce.com/document/shipment-tracking/#section-9
how to create one here
click on this link
The WooCommerce web hooks screen.
Example web hook form in WooCommerce