NAV
bash PHP

Info

Welcome to wellnessstores.com API reference. Get Postman Collection

1. How to get keys

Get Your api Keys from Settings > Integrations > API Settings

Create / Update Key's


  1. Check the Screenshot attached above
  2. Generate Api keys
  3. Copy publick and Secret keys which are used for calls
  4. API Base URL is https://shop.wellnessstores.com/apis/public

2. Products

Get and Create Products.

List of Products

Get List of all products

Example request:

	
		curl --location '{base_url}/api/external/products' \
--header 'Accept: application/json' \
--header 'X-Public-Key: {public_key}' \
--header 'X-Private-Key: {secret_key}'
	


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{base_url}/api/external/products?page=1',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Accept: application/json',
    'X-Public-Key: {public_key}',
    'X-Private-Key: {secret_key}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Example response (200):

{
    "success": true,
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 204,
                "name": "Sample Product",
                "sku": "SKU-12345",
                "slug": "sample-product-j28u3w",
                "full_name": null,
                "price": "99.99",
                "cost_price": null,
                "wholesale_price": "99.99",
                "retail_price": null,
                "rating": "0.0",
                "reviews_count": 0,
                "badge": null,
                "expiry": null,
                "in_stock": true,
                "stock_count": 100,
                "min_order": null,
                "discount": 0,
                "fast_shipping": false,
                "description": "Optional description",
                "key_features": [
                    "Feature A",
                    "Feature B"
                ],
                "variations": {
                    "Size": {
                        "label": "Size",
                        "options": [
                            "S",
                            "M",
                            "L"
                        ]
                    },
                    "Color": {
                        "label": "Color",
                        "options": [
                            "Red",
                            "Blue"
                        ]
                    }
                },
                "shipping": null,
                "business_info": null,
                "category_id": 8,
                "brand": null,
                "seller_id": 1,
                "is_active": true,
                "status": 0,
                "featured": false,
                "rfq": false,
                "created_at": "2025-09-01T07:35:11.000000Z",
                "updated_at": "2025-09-01T07:35:11.000000Z",
                "deleted_at": null,
                "category": {
                    "id": 8,
                    "name": "Electronics",
                    "slug": "electronics",
                    "description": "Auto-created category",
                    "image": null,
                    "is_active": true,
                    "created_at": "2025-07-30T11:45:18.000000Z",
                    "updated_at": "2025-07-30T11:45:18.000000Z"
                },
                "images": [
                    {
                        "id": 452,
                        "product_id": 204,
                        "image_path": "https://example.com/image1.jpg",
                        "alt_text": null,
                        "sort_order": 0,
                        "is_primary": false,
                        "created_at": "2025-09-01T07:35:12.000000Z",
                        "updated_at": "2025-09-01T07:35:12.000000Z"
                    },
                    {
                        "id": 453,
                        "product_id": 204,
                        "image_path": "https://example.com/image2.jpg",
                        "alt_text": null,
                        "sort_order": 1,
                        "is_primary": false,
                        "created_at": "2025-09-01T07:35:12.000000Z",
                        "updated_at": "2025-09-01T07:35:12.000000Z"
                    }
                ],
                "specifications": [
                    {
                        "id": 815,
                        "product_id": 204,
                        "key": "Color",
                        "value": "Black",
                        "sort_order": 0,
                        "created_at": "2025-09-01T07:35:12.000000Z",
                        "updated_at": "2025-09-01T07:35:12.000000Z"
                    },
                    {
                        "id": 816,
                        "product_id": 204,
                        "key": "Weight",
                        "value": "1.2kg",
                        "sort_order": 0,
                        "created_at": "2025-09-01T07:35:12.000000Z",
                        "updated_at": "2025-09-01T07:35:12.000000Z"
                    }
                ],
                "pricing_tiers": [
                    {
                        "id": 585,
                        "product_id": 204,
                        "label": "Bulk 10+",
                        "min_quantity": 10,
                        "max_quantity": null,
                        "price": null,
                        "discount": 5,
                        "sort_order": 0,
                        "created_at": "2025-09-01T07:35:12.000000Z",
                        "updated_at": "2025-09-01T07:35:12.000000Z"
                    },
                    {
                        "id": 586,
                        "product_id": 204,
                        "label": "Bulk 50+",
                        "min_quantity": 50,
                        "max_quantity": null,
                        "price": null,
                        "discount": 10,
                        "sort_order": 1,
                        "created_at": "2025-09-01T07:35:12.000000Z",
                        "updated_at": "2025-09-01T07:35:12.000000Z"
                    }
                ],
                "variants": [
                    {
                        "id": 1621,
                        "product_id": 204,
                        "sku": "SKU-12345-M-Red",
                        "price": "109.99",
                        "inventory": 20,
                        "min_qty": 1,
                        "options": {
                            "Size": "M",
                            "Color": "Red"
                        },
                        "created_at": "2025-09-01T07:35:12.000000Z",
                        "updated_at": "2025-09-01T07:35:12.000000Z"
                    },
                    {
                        "id": 1622,
                        "product_id": 204,
                        "sku": "SKU-12345-L-Blue",
                        "price": "119.99",
                        "inventory": 15,
                        "min_qty": 1,
                        "options": {
                            "Size": "L",
                            "Color": "Blue"
                        },
                        "created_at": "2025-09-01T07:35:12.000000Z",
                        "updated_at": "2025-09-01T07:35:12.000000Z"
                    }
                ],
                "hasTieredPricing": 1
            }
        ],
        "first_page_url": "http://127.0.0.1:8000/api/external/products?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://127.0.0.1:8000/api/external/products?page=1",
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "http://127.0.0.1:8000/api/external/products?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "http://127.0.0.1:8000/api/external/products",
        "per_page": 50,
        "prev_page_url": null,
        "to": 9,
        "total": 9
    }
}

Example response (401):

{
    "success": false,
    "message": "API keys are required. Please provide X-Public-Key and X-Private-Key headers."
}

HTTP Request

GET /api/external/products

Query Parameters

Parameter Status Description
page not required Page number to get further records.

Product by SKU

Get Product by SKU

Example request:

	
		curl --location '{base_url}/api/external/products/{sku}' \
--header 'Accept: application/json' \
--header 'X-Public-Key: {public_key}' \
--header 'X-Private-Key: {secret_key}'
	


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{base_url}/api/external/products/{sku}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Accept: application/json',
    'X-Public-Key: {public_key}',
    'X-Private-Key: {secret_key}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Example response (200):

{
    "success": true,
    "data": {
        "id": 204,
        "name": "Sample Product",
        "sku": "SKU-12345",
        "slug": "sample-product-j28u3w",
        "full_name": null,
        "price": "99.99",
        "cost_price": null,
        "wholesale_price": "99.99",
        "retail_price": null,
        "rating": "0.0",
        "reviews_count": 0,
        "badge": null,
        "expiry": null,
        "in_stock": true,
        "stock_count": 100,
        "min_order": null,
        "discount": 0,
        "fast_shipping": false,
        "description": "Optional description",
        "key_features": [
            "Feature A",
            "Feature B"
        ],
        "variations": [
            {
                "id": 342,
                "product_id": 204,
                "type": "Size",
                "label": "Size",
                "options": [
                    "S",
                    "M",
                    "L"
                ],
                "price_modifiers": {
                    "L": 0,
                    "M": 0,
                    "S": 0
                },
                "sort_order": 0,
                "created_at": "2025-09-01T07:35:11.000000Z",
                "updated_at": "2025-09-01T07:35:11.000000Z"
            },
            {
                "id": 343,
                "product_id": 204,
                "type": "Color",
                "label": "Color",
                "options": [
                    "Red",
                    "Blue"
                ],
                "price_modifiers": {
                    "Red": 0,
                    "Blue": 0
                },
                "sort_order": 1,
                "created_at": "2025-09-01T07:35:11.000000Z",
                "updated_at": "2025-09-01T07:35:11.000000Z"
            }
        ],
        "shipping": null,
        "business_info": null,
        "category_id": 8,
        "brand": null,
        "seller_id": 1,
        "is_active": true,
        "status": 0,
        "featured": false,
        "rfq": false,
        "created_at": "2025-09-01T07:35:11.000000Z",
        "updated_at": "2025-09-01T07:35:11.000000Z",
        "deleted_at": null,
        "category": {
            "id": 8,
            "name": "Electronics",
            "slug": "electronics",
            "description": "Auto-created category",
            "image": null,
            "is_active": true,
            "created_at": "2025-07-30T11:45:18.000000Z",
            "updated_at": "2025-07-30T11:45:18.000000Z"
        },
        "images": [
            {
                "id": 452,
                "product_id": 204,
                "image_path": "https://example.com/image1.jpg",
                "alt_text": null,
                "sort_order": 0,
                "is_primary": false,
                "created_at": "2025-09-01T07:35:12.000000Z",
                "updated_at": "2025-09-01T07:35:12.000000Z"
            },
            {
                "id": 453,
                "product_id": 204,
                "image_path": "https://example.com/image2.jpg",
                "alt_text": null,
                "sort_order": 1,
                "is_primary": false,
                "created_at": "2025-09-01T07:35:12.000000Z",
                "updated_at": "2025-09-01T07:35:12.000000Z"
            }
        ],
        "specifications": [
            {
                "id": 815,
                "product_id": 204,
                "key": "Color",
                "value": "Black",
                "sort_order": 0,
                "created_at": "2025-09-01T07:35:12.000000Z",
                "updated_at": "2025-09-01T07:35:12.000000Z"
            },
            {
                "id": 816,
                "product_id": 204,
                "key": "Weight",
                "value": "1.2kg",
                "sort_order": 0,
                "created_at": "2025-09-01T07:35:12.000000Z",
                "updated_at": "2025-09-01T07:35:12.000000Z"
            }
        ],
        "pricing_tiers": [
            {
                "id": 585,
                "product_id": 204,
                "label": "Bulk 10+",
                "min_quantity": 10,
                "max_quantity": null,
                "price": null,
                "discount": 5,
                "sort_order": 0,
                "created_at": "2025-09-01T07:35:12.000000Z",
                "updated_at": "2025-09-01T07:35:12.000000Z"
            },
            {
                "id": 586,
                "product_id": 204,
                "label": "Bulk 50+",
                "min_quantity": 50,
                "max_quantity": null,
                "price": null,
                "discount": 10,
                "sort_order": 1,
                "created_at": "2025-09-01T07:35:12.000000Z",
                "updated_at": "2025-09-01T07:35:12.000000Z"
            }
        ],
        "variants": [
            {
                "id": 1621,
                "product_id": 204,
                "sku": "SKU-12345-M-Red",
                "price": "109.99",
                "inventory": 20,
                "min_qty": 1,
                "options": {
                    "Size": "M",
                    "Color": "Red"
                },
                "created_at": "2025-09-01T07:35:12.000000Z",
                "updated_at": "2025-09-01T07:35:12.000000Z"
            },
            {
                "id": 1622,
                "product_id": 204,
                "sku": "SKU-12345-L-Blue",
                "price": "119.99",
                "inventory": 15,
                "min_qty": 1,
                "options": {
                    "Size": "L",
                    "Color": "Blue"
                },
                "created_at": "2025-09-01T07:35:12.000000Z",
                "updated_at": "2025-09-01T07:35:12.000000Z"
            }
        ],
        "hasTieredPricing": 1
    }
}

Example response (401):

{
    "success": false,
    "message": "API keys are required. Please provide X-Public-Key and X-Private-Key headers."
}

HTTP Request

GET /api/external/products/{sku}

Query Parameters

Parameter Status Description
sku required SKU of product to get details.

Create and Update

Create and update product

Example request:

	
		curl --location '{base_url}/api/external/products' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-Public-Key: {public_key}' \
--header 'X-Private-Key: {secret_key}' \
--data '{
    "sku": "SKU-12345",
    "name": "Sample Product",
    "price": 99.99,
    "description": "Optional description",
    "stock_count": 100,
    "category_name": "Electronics",
    "images": ["https://example.com/image1.jpg", "https://example.com/image2.jpg"],
    "key_features": ["Feature A", "Feature B"],
    "is_active": true,
    "featured": false,
    "rfq": false,
    "specifications": [
      {"name": "Color", "value": "Black"},
      {"name": "Weight", "value": "1.2kg"}
    ],
    "variations": [
      {"name": "Size", "options": ["S","M","L"]},
      {"name": "Color", "options": ["Red","Blue"]}
    ],
    "variants": [
      {"optionValues": ["M","Red"], "stock": 20, "price": 109.99, "minQty": 1},
      {"optionValues": ["L","Blue"], "stock": 15, "price": 119.99, "minQty": 1}
    ],
    "tiered_pricing": [
      {"name": "Bulk 10+", "minQuantity": 10, "discountPercentage": 5},
      {"name": "Bulk 50+", "minQuantity": 50, "discountPercentage": 10}
    ]
  }'
	


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{base_url}/api/external/products',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "sku": "SKU-12345",
    "name": "Sample Product",
    "price": 99.99,
    "description": "Optional description",
    "stock_count": 100,
    "category_name": "Electronics",
    "images": ["https://example.com/image1.jpg", "https://example.com/image2.jpg"],
    "key_features": ["Feature A", "Feature B"],
    "is_active": true,
    "featured": false,
    "rfq": false,
    "specifications": [
      {"name": "Color", "value": "Black"},
      {"name": "Weight", "value": "1.2kg"}
    ],
    "variations": [
      {"name": "Size", "options": ["S","M","L"]},
      {"name": "Color", "options": ["Red","Blue"]}
    ],
    "variants": [
      {"optionValues": ["M","Red"], "stock": 20, "price": 109.99, "minQty": 1},
      {"optionValues": ["L","Blue"], "stock": 15, "price": 119.99, "minQty": 1}
    ],
    "tiered_pricing": [
      {"name": "Bulk 10+", "minQuantity": 10, "discountPercentage": 5},
      {"name": "Bulk 50+", "minQuantity": 50, "discountPercentage": 10}
    ]
  }',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Accept: application/json',
    'X-Public-Key: {public_key}',
    'X-Private-Key: {secret_key}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Example response (200):

{
    "success": true,
    "message": "Product created successfully",
    "data": {
        "id": 204,
        "sku": "SKU-12345",
        "name": "Sample Product",
        "action": "created"
    }
}

Example response (401):

{
    "success": false,
    "message": "API keys are required. Please provide X-Public-Key and X-Private-Key headers."
}

HTTP Request

POST /api/external/products

Query Parameters

Parameter Status Description
sku required sku of product.
name required name of product.
price required price of product.
description not required description of product.
stock_count required stock_count of product.
category_name required category_name of product.
images not required images of product. (Array)
key_features not required key_features of product. (Array)
is_active required is_active of product.
rfq not required rfq of product.
specifications not required specifications of product. (Array)
variations not required variations of product. (Array)
variants not required variants of product. (Array)
tiered_pricing required tiered_pricing of product. (Array)

3. Orders

Get and create orders.

List of Orders

Get List of all Orders

Example request:

	
		curl --location '{base_url}/api/external/orders' \
--header 'Accept: application/json' \
--header 'X-Public-Key: {public_key}' \
--header 'X-Private-Key: {secret_key}'
	



$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{base_url}/api/external/orders',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Accept: application/json',
    'X-Public-Key: pk_AI40wWNkoE4NqkSFzk5rHzRktqXSTnnC',
    'X-Private-Key: {secret_key}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Example response (200):

{
    "success": true,
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 23,
                "order_id": 17,
                "total": "99.00",
                "status": "pending",
                "shipping_method": "Standard Shipping",
                "shipping_cost": "12.99",
                "tracking_number": null,
                "shipping_company": null,
                "created_at": "2025-09-01T08:27:37.000000Z",
                "updated_at": "2025-09-01T08:27:37.000000Z",
                "customer": {
                    "name": "QA Test",
                    "email": "qa@uptivityapps.co.uk",
                    "phone": "4335345345"
                },
                "shipping_address": {
                    "business_name": "Grow more",
                    "contact_name": "QA Test",
                    "street_address": "7701 S MANITOWOC AVE OAK CREEK",
                    "apartment": null,
                    "city": "CREEK",
                    "state": "WI",
                    "zip": "53154-2151",
                    "delivery_instructions": null
                },
                "items_count": 1,
                "items": [
                    {
                        "id": 26,
                        "order_id": 17,
                        "product_id": 152,
                        "seller_id": 1,
                        "quantity": 3,
                        "price": "33.00",
                        "pricing_applied": null,
                        "subtotal": "99.00",
                        "tax_rate": "0.0800",
                        "tax_total": "7.92",
                        "product_name": "Test Import Product 1",
                        "product_image_url": "https://justsellcustomers.s3.amazonaws.com/wellnessmarketplace/products/5TQ1Q9y9m5peYtdiQ0gSnaz1q5nLEIeTfdIIqFy2.png",
                        "variation": "Size: Small, Flavor: Grapes",
                        "created_at": "2025-09-01T08:27:37.000000Z",
                        "updated_at": "2025-09-01T08:27:37.000000Z",
                        "deleted_at": null
                    }
                ],
                "status_history": [
                    {
                        "status": "pending",
                        "note": "Order placed",
                        "changed_at": "2025-09-01 08:27:37"
                    }
                ]
            }
        ],
        "first_page_url": "http://127.0.0.1:8000/api/external/orders?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://127.0.0.1:8000/api/external/orders?page=1",
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "http://127.0.0.1:8000/api/external/orders?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "http://127.0.0.1:8000/api/external/orders",
        "per_page": 50,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    }
}

Example response (401):

{
    "success": false,
    "message": "API keys are required. Please provide X-Public-Key and X-Private-Key headers."
}

HTTP Request

GET /api/external/products

Query Parameters

Parameter Status Description
page not required Page number to get further records.

Order by ID

Get order by ID

Example request:

	
	curl --location '{base_url}/api/external/orders/{id}' \
--header 'Accept: application/json' \
--header 'X-Public-Key: {public_key}' \
--header 'X-Private-Key: {secret_key}'
	
	



$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{base_url}/api/external/orders/{id}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Accept: application/json',
    'X-Public-Key: {public_key}',
    'X-Private-Key: {secret_key}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Example response (200):

{
    "success": true,
    "data": {
        "id": 23,
        "order_id": 17,
        "total": "99.00",
        "status": "pending",
        "shipping_method": "Standard Shipping",
        "shipping_cost": "12.99",
        "tracking_number": null,
        "shipping_company": null,
        "created_at": "2025-09-01T08:27:37.000000Z",
        "updated_at": "2025-09-01T08:27:37.000000Z",
        "customer": {
            "name": "QA Test",
            "email": "qa@uptivityapps.co.uk",
            "phone": "4335345345"
        },
        "shipping_address": {
            "business_name": "Grow more",
            "contact_name": "QA Test",
            "street_address": "7701 S MANITOWOC AVE OAK CREEK",
            "apartment": null,
            "city": "CREEK",
            "state": "WI",
            "zip": "53154-2151",
            "delivery_instructions": null
        },
        "billing_address": {
            "same_as_shipping": 1,
            "business_name": "Grow more",
            "contact_name": "QA Test",
            "email": "qa@uptivityapps.co.uk",
            "street_address": "7701 S MANITOWOC AVE OAK CREEK",
            "apartment": null,
            "city": "CREEK",
            "state": "WI",
            "zip": "53154-2151"
        },
        "items": [
            {
                "id": 26,
                "order_id": 17,
                "product_id": 152,
                "seller_id": 1,
                "quantity": 3,
                "price": "33.00",
                "pricing_applied": null,
                "subtotal": "99.00",
                "tax_rate": "0.0800",
                "tax_total": "7.92",
                "product_name": "Test Import Product 1",
                "product_image_url": "https://justsellcustomers.s3.amazonaws.com/wellnessmarketplace/products/5TQ1Q9y9m5peYtdiQ0gSnaz1q5nLEIeTfdIIqFy2.png",
                "variation": "Size: Small, Flavor: Grapes",
                "created_at": "2025-09-01T08:27:37.000000Z",
                "updated_at": "2025-09-01T08:27:37.000000Z",
                "deleted_at": null
            }
        ],
        "status_history": [
            {
                "status": "pending",
                "note": "Order placed",
                "changed_at": "2025-09-01 08:27:37"
            }
        ]
    }
}

Example response (401):

{
    "success": false,
    "message": "API keys are required. Please provide X-Public-Key and X-Private-Key headers."
}

HTTP Request

GET /api/external/orders/{id}

Query Parameters

Parameter Status Description
id required ID of product to get details.
bash PHP