Skip to main content

WooCommerce

WooCommerce is an open-source e-commerce platform built on WordPress. Its REST API lets you programmatically manage store data such as products, orders, customers, coupons, and shipping and tax configuration. Nexla connects to the WooCommerce REST API to ingest this data into your flows and to write records back to your store.

WooCommerce icon

Power end-to-end data operations for your WooCommerce API with Nexla. Our bi-directional WooCommerce connector is purpose-built for WooCommerce, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to WooCommerce or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your WooCommerce workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a WooCommerce credential, you need your store's base URL and a REST API key pair (a Consumer Key and a Consumer Secret) generated from your WordPress admin. WooCommerce authenticates REST API requests over HTTPS using HTTP Basic Authentication, with the Consumer Key sent as the username and the Consumer Secret sent as the password.

To generate a WooCommerce REST API key pair, follow these steps:

  1. Sign in to your WordPress admin dashboard as a user with permission to manage WooCommerce settings.

  2. Confirm that your site uses a human-readable permalink structure. Navigate to Settings > Permalinks and select any option other than Plain. A non-default permalink structure is required for the WooCommerce REST API to function.

  3. Navigate to WooCommerce > Settings > Advanced > REST API.

  4. Click Add key (or Create an API key).

  5. Enter a Description that identifies the key's purpose (for example, "Nexla Integration").

  6. Select the User that the API key will act on behalf of from the dropdown menu.

  7. Choose a Permissions level based on your use case: Read for ingesting data into Nexla, Write for sending data to your store, or Read/Write for both.

  8. Click Generate API Key.

  9. Copy the generated Consumer Key and Consumer Secret and store them securely. The Consumer Secret is shown only once and cannot be retrieved again after you leave the page.

  10. Note your store's base URL (for example, https://mystore.com). Nexla uses this to construct the REST API base path, which follows the format https://mystore.com/wp-json/wc/v3/.

If a key is lost or compromised, revoke it from the same REST API settings screen and generate a new one. For more information, see the WooCommerce REST API documentation and the WooCommerce REST API technical reference.

Authenticate

Credentials required

HTTP Basic Authentication using WooCommerce REST API Consumer Key and Consumer Secret (Base64-encoded).

FieldRequiredSecretDescription
Username Or API KeyYesYesYour username or personal API Key
PasswordYesYesYour password
Store Base URLYesNoYour WooCommerce store base URL (e.g., https://mystore.com)

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. In the Username Or API Key field, enter the Consumer Key generated for your WooCommerce store. This value is sent as the username for HTTP Basic Authentication.

  4. In the Password field, enter the Consumer Secret generated for your WooCommerce store. This value is sent as the password for HTTP Basic Authentication and must be kept confidential.

  5. In the Store Base URL field, enter your store's base URL without a trailing path, for example https://mystore.com. Nexla uses this to construct the WooCommerce REST API base path.

    The Consumer Secret provides access to your WooCommerce store data based on the permissions selected when the key was created. If it is compromised, revoke the key in WooCommerce > Settings > Advanced > REST API and generate a new one.

    For detailed information about authentication, available resources, and response formats, see the WooCommerce REST API technical reference.

  6. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the WooCommerce connector tile, then select the credential that will be used to connect to the WooCommerce store, and click Next; or, create a new WooCommerce credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common WooCommerce endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Customers

Returns a list of all customers in the WooCommerce store. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Coupons

Returns a list of all coupons available in the WooCommerce store. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Orders

Returns a list of all orders in the WooCommerce store. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Order Notes

Returns a list of notes for a specific order in WooCommerce. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Payment Gateways

Returns a list of all payment gateways configured in the WooCommerce store. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Products

Returns a list of all products in the WooCommerce store. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Product Attributes

Returns a list of all product attributes defined in the WooCommerce store. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Product Attribute Terms

Returns a list of terms for a specific product attribute in WooCommerce. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Product Categories

Returns a list of all product categories in the WooCommerce store. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Product Reviews

Returns a list of all product reviews in the WooCommerce store. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Product Shipping Classes

Returns a list of all product shipping classes available in the store. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Product Tags

Returns a list of all product tags in the store. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Product Variations

Returns a list of all variations for a specific product. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Order Refunds

Returns a list of all refunds for a specific order. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Shipping Methods

Returns a list of all available shipping methods in the store. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Shipping Zone Locations

Returns a list of all locations configured for a specific shipping zone. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Shipping Zone Methods

Returns a list of all shipping methods configured for a specific shipping zone. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Shipping Zones

Returns a list of all shipping zones configured in the store. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List System Status Tools

Returns a list of system status tools and their information for the store. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Tax Classes

Returns a list of all tax classes available in the store. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

[Rest API] List Tax Rates

Returns a list of all tax rates configured in the WooCommerce store. Use this template when you need to bring this data into Nexla for analysis, reporting, or downstream integration.

  • This endpoint template reads records from your WooCommerce store using the WooCommerce REST API. Nexla paginates through the result set automatically and organizes the returned records into one or more Nexsets.

For detailed information about the response structure, query parameters, and pagination for this resource, see the WooCommerce REST API Documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

WooCommerce data sources can also be manually configured to ingest data from any valid WooCommerce REST API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new WooCommerce data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the WooCommerce destination, and select the Send to Destination option from the menu. Select the WooCommerce connector from the list of available destination connectors, then select the credential that will be used to connect to the WooCommerce store, and click Next; or, create a new WooCommerce credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common WooCommerce endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create Product

Create a new product in the WooCommerce store. Use this template when you need to write records from a Nexset to your WooCommerce store.

  • This endpoint template sends data as JSON in the request body to your WooCommerce store using the WooCommerce REST API. Each record from your Nexset is sent as a separate API request, and the request body must match the format expected by the WooCommerce API for this resource.

For detailed information about the request body format and available fields for this operation, see the WooCommerce REST API Documentation.

[Rest API] Update Product

Update an existing product in the WooCommerce store. Use this template when you need to write records from a Nexset to your WooCommerce store.

  • This endpoint template sends data as JSON in the request body to your WooCommerce store using the WooCommerce REST API. Each record from your Nexset is sent as a separate API request, and the request body must match the format expected by the WooCommerce API for this resource.

For detailed information about the request body format and available fields for this operation, see the WooCommerce REST API Documentation.

[Rest API] Delete Product

Delete an existing product from the WooCommerce store. Use this template when you need to write records from a Nexset to your WooCommerce store.

  • This endpoint template sends data as JSON in the request body to your WooCommerce store using the WooCommerce REST API. Each record from your Nexset is sent as a separate API request, and the request body must match the format expected by the WooCommerce API for this resource.

For detailed information about the request body format and available fields for this operation, see the WooCommerce REST API Documentation.

[Rest API] Create Order

Create a new order in the WooCommerce store. Use this template when you need to write records from a Nexset to your WooCommerce store.

  • This endpoint template sends data as JSON in the request body to your WooCommerce store using the WooCommerce REST API. Each record from your Nexset is sent as a separate API request, and the request body must match the format expected by the WooCommerce API for this resource.

For detailed information about the request body format and available fields for this operation, see the WooCommerce REST API Documentation.

[Rest API] Update Order

Update an existing order in the WooCommerce store. Use this template when you need to write records from a Nexset to your WooCommerce store.

  • This endpoint template sends data as JSON in the request body to your WooCommerce store using the WooCommerce REST API. Each record from your Nexset is sent as a separate API request, and the request body must match the format expected by the WooCommerce API for this resource.

For detailed information about the request body format and available fields for this operation, see the WooCommerce REST API Documentation.

[Rest API] Delete Order

Delete an existing order from the WooCommerce store. Use this template when you need to write records from a Nexset to your WooCommerce store.

  • This endpoint template sends data as JSON in the request body to your WooCommerce store using the WooCommerce REST API. Each record from your Nexset is sent as a separate API request, and the request body must match the format expected by the WooCommerce API for this resource.

For detailed information about the request body format and available fields for this operation, see the WooCommerce REST API Documentation.

Manual configuration

WooCommerce destinations can also be manually configured to send data to any valid WooCommerce REST API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

WooCommerce APIs expect JSON format for create and update operations. For update or delete operations, include the ID of the object to be modified in the endpoint path.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured WooCommerce endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the WooCommerce endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.