1. Home
  2. Ecommerce Rest Api
  3. WordPress WooCommerce
  4. Products

Products

Prerequisites

  • WooCommerce API Keys: You need Consumer Key and Consumer Secret.
  • Base URL: Replace https://yourstore.com with your actual WooCommerce store URL.
  • Authorization: Basic Auth with your Consumer Key and Consumer Secret.

Authorization Setup in Postman

  1. Go to the Authorization tab.
  2. Select Type: Basic Auth.
  3. Username: Enter your Consumer Key.
  4. Password: Enter your Consumer Secret.

1. List Products

  • URL: https://yourstore.com/wp-json/wc/v3/products
  • Method: GET
  • Headers:
    • Authorization: Basic Auth

Example in Postman:

  1. Set method to GET.
  2. Enter URL: https://yourstore.com/wp-json/wc/v3/products
  3. Go to the Authorization tab and set Type to Basic Auth.
  4. Enter Consumer Key and Consumer Secret.
  5. Send the request.

2. Retrieve a Product

  • URL: https://yourstore.com/wp-json/wc/v3/products/{id}
  • Method: GET
  • Headers:
    • Authorization: Basic Auth
  • Replace {id} with the actual product ID.

Example in Postman:

  1. Set method to GET.
  2. Enter URL: https://yourstore.com/wp-json/wc/v3/products/{id}
  3. Go to the Authorization tab and set Type to Basic Auth.
  4. Enter Consumer Key and Consumer Secret.
  5. Send the request.

3. Create a Product

  • URL: https://yourstore.com/wp-json/wc/v3/products
  • Method: POST
  • Headers:
    • Authorization: Basic Auth
  • Body: JSON with product data.

Example JSON Body:

{
  "name": "Sample Product",
  "type": "simple",
  "regular_price": "19.99",
  "description": "This is a sample product",
  "categories": [
    {
      "id": 9
    }
  ]
}

Example in Postman:

  1. Set method to POST.
  2. Enter URL: https://yourstore.com/wp-json/wc/v3/products
  3. Go to the Authorization tab and set Type to Basic Auth.
  4. Enter Consumer Key and Consumer Secret.
  5. Go to the Body tab, select raw, choose JSON from the dropdown, and paste the example JSON body.
  6. Send the request.

4. Update a Product

  • URL: https://yourstore.com/wp-json/wc/v3/products/{id}
  • Method: PUT
  • Headers:
    • Authorization: Basic Auth
  • Body: JSON with updated product data.
  • Replace {id} with the actual product ID.

Example JSON Body:

{
  "name": "Updated Product Name",
  "regular_price": "24.99"
}

Example in Postman:

  1. Set method to PUT.
  2. Enter URL: https://yourstore.com/wp-json/wc/v3/products/{id}
  3. Go to the Authorization tab and set Type to Basic Auth.
  4. Enter Consumer Key and Consumer Secret.
  5. Go to the Body tab, select raw, choose JSON from the dropdown, and paste the example JSON body.
  6. Send the request.

5. Delete a Product

  • URL: https://yourstore.com/wp-json/wc/v3/products/{id}
  • Method: DELETE
  • Headers:
    • Authorization: Basic Auth
  • Replace {id} with the actual product ID.

Example in Postman:

  1. Set method to DELETE.
  2. Enter URL: https://yourstore.com/wp-json/wc/v3/products/{id}
  3. Go to the Authorization tab and set Type to Basic Auth.
  4. Enter Consumer Key and Consumer Secret.
  5. Send the request.

6. Batch Update Products

  • URL: https://yourstore.com/wp-json/wc/v3/products/batch
  • Method: POST
  • Headers:
    • Authorization: Basic Auth
  • Body: JSON with batch operations.

Example JSON Body:

{
  "update": [
    {
      "id": 1,
      "name": "Updated Product 1"
    },
    {
      "id": 2,
      "regular_price": "29.99"
    }
  ]
}

Example in Postman:

  1. Set method to POST.
  2. Enter URL: https://yourstore.com/wp-json/wc/v3/products/batch
  3. Go to the Authorization tab and set Type to Basic Auth.
  4. Enter Consumer Key and Consumer Secret.
  5. Go to the Body tab, select raw, choose JSON from the dropdown, and paste the example JSON body.
  6. Send the request.

By following these instructions, you can test each WooCommerce products endpoint in Postman. Each request should include the necessary Authorization header configured through Basic Auth with your Consumer Key and Consumer Secret.

How can we help?