Hike

https://docs.hikeup.com/reference/
Admin
Hike is a REST API platform that enables developers to integrate applications with Hike or build...
Tokens:198,040
Snippets:416
Trust Score:9.9
Update:10 months ago
Show doc for...
Tokens:
Raw
### Get All Purchase Orders - Python Request Example

Source: https://docs.hikeup.com/reference/purchase-1

An example in Python demonstrating how to fetch all purchase orders using the 'requests' library. It sends a GET request to the API endpoint and prints the JSON response.

```python
import requests

url = "https://api.hikeup.com/api/v1/purchase/get_all"

headers = {
    "accept": "application/json"
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
    print(response.text)
```

--------------------------------

### Get All Offers - PHP Request

Source: https://docs.hikeup.com/reference/offers-1

This snippet provides a PHP example for fetching all offers, often using cURL functions. It details the GET request and the necessary headers.

```php
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.hikeup.com/api/v1/offers/get_all');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'accept: application/json'
]);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo $response;
}

c 
url_close($ch);
?>
```

--------------------------------

### GET /api/v1/customers/get_all

Source: https://docs.hikeup.com/reference/pagination

Retrieve a paginated list of all customers. Use the `page_size` parameter to control the number of results per page and `skip_count` to fetch subsequent pages.

```APIDOC
## GET /api/v1/customers/get_all

### Description
Retrieves a list of customers from the Hike API, with support for pagination. Allows specifying the number of results per page and the starting point for subsequent requests.

### Method
GET

### Endpoint
`/api/v1/customers/get_all`

### Parameters
#### Query Parameters
- **page_size** (integer) - Optional - Specifies the maximum number of results to return per page. Defaults to a system-defined limit if not provided.
- **skip_count** (integer) - Optional - Specifies the starting point for the next set of results. Used to fetch subsequent pages after the initial request.

### Request Example
```
--url 'https://api.hikeup.com/api/v1/customers/get_all?page_size=100&Skip_count=99'
```

### Response
#### Success Response (200)
- **customers** (array) - A list of customer objects.
- **next_page_link** (string) - A URL to the next page of results, if available. Contains `skip_count` parameter.

#### Response Example
```json
{
  "customers": [
    // ... customer objects ...
  ],
  "next_page_link": "/api/v1/customers/get_all?page_size=100&Skip_count=199"
}
```

### Note
If the response does not contain a `next_page_link`, it indicates that you have reached the end of the available results.
```

--------------------------------

### Get All Product Tags (PHP)

Source: https://docs.hikeup.com/reference/producttags-1

This PHP example shows how to fetch all product tags using cURL. It sets the request method to GET and includes the 'accept' header.

```php
<?php

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, 'https://api.hikeup.com/api/v1/product_tags/get_all');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('accept: application/json'));

$response = curl_exec($curl);

if (curl_errno($curl)) {
    echo 'Error:' . curl_error($curl);
} else {
    echo $response;
}

curl_close($curl);
?>
```

--------------------------------

### GET /api/v1/products/get_all

Source: https://docs.hikeup.com/reference/pagination

Retrieve a paginated list of all products in a Hike store. You can control the number of results per page using the `page_size` parameter.

```APIDOC
## GET /api/v1/products/get_all

### Description
Retrieves a list of products from the Hike API, with support for pagination to manage large datasets. Allows specifying the number of results per page.

### Method
GET

### Endpoint
`/api/v1/products/get_all`

### Parameters
#### Query Parameters
- **page_size** (integer) - Optional - Specifies the maximum number of results to return per page. Defaults to a system-defined limit if not provided.

### Request Example
```
--url 'https://api.hikeup.com/api/v1/products/get_all?page_size=100'
```

### Response
#### Success Response (200)
- **products** (array) - A list of product objects.
- **next_page_link** (string) - A URL to the next page of results, if available. Contains `skip_count` parameter.

#### Response Example
```json
{
  "products": [
    // ... product objects ...
  ],
  "next_page_link": "/api/v1/products/get_all?page_size=100&Skip_count=99"
}
```
```

--------------------------------

### Purchase Order Example Data

Source: https://docs.hikeup.com/reference/purchase_create-1

Provides an example of a purchase order object, including header information such as outlet ID, PO number, dates, supplier details, status, and tax/discount settings. It also includes an array of line items, with the first line item's details partially shown.

```json
{
  "outletId": 1,
  "poNumber": "Order - 16-10-2024-11-43-00",
  "poDate": "2024-10-16T11:43:00.8726162Z",
  "dueDate": "2024-10-18T11:43:00.8726162Z",
  "supplierId": 1,
  "refNumber": "PO-0001",
  "status": 1,
  "taxInclusive": true,
  "discountIsAsPercentage": false,
  "discountValue": 0,
  "totalDiscount": 0,
  "totalTax": 47.62,
  "totalShippingCost": 0,
  "shippingTaxAmount": 0,
  "roundingAmount": 0,
  "subTotal": 1000,
  "netAmount": 1000,
  "creationTime": "0001-01-01T00:00:00Z",
  "purchaseOrderLineItems": [
    {
      "purchaseItemType": 0
    }
  ],
  "id": {
    "format": "int32",
    "type": "integer"
  }
}
```

--------------------------------

### Get All Brands - Node.js Request

Source: https://docs.hikeup.com/reference/brand-1

This example shows how to fetch all brands using Node.js. It utilizes the 'axios' library to make a GET request to the HikeUp API endpoint for brands. Ensure 'axios' is installed (`npm install axios`).

```javascript
const axios = require('axios');

const options = {
  method: 'GET',
  url: 'https://api.hikeup.com/api/v1/brands/get_all',
  headers: {
    'accept': 'application/json'
  }
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});
```

--------------------------------

### Purchase Order Example Object

Source: https://docs.hikeup.com/reference/purchase_create-1

An example of a complete purchase order object, demonstrating the expected data format for creating or retrieving purchase orders. It includes header information and an array of line items.

```json
{
  "outletId": 1,
  "poNumber": "Order - 16-10-2024-11-43-00",
  "poDate": "2024-10-16T11:43:00.8726162Z",
  "dueDate": "2024-10-18T11:43:00.8726162Z",
  "supplierId": 1,
  "refNumber": "PO-0001",
  "status": 1,
  "taxInclusive": true,
  "discountIsAsPercentage": false,
  "discountValue": 0,
  "totalDiscount": 0,
  "totalTax": 47.62,
  "totalShippingCost": 0,
  "shippingTaxAmount": 0,
  "roundingAmount": 0,
  "subTotal": 1000,
  "netAmount": 1000,
  "creationTime": "0001-01-01T00:00:00Z",
  "purchaseOrderLineItems": [
    {
      "purchaseItemType": 0,
      "productId": 1,
      "sequence": 1,
      "title": "Demo Product 1",
      "quantity": 10,
      "receivedQty": 0,
      "price": 100,
      "priceExcludingTax": 0,
      "totalAmount": 1000,
      "taxId": 10,
      "taxRate": 5,
      "taxAmount": 47.65,
      "discountIsAsPercentage": false,
      "discountValue": 0,
      "discountAmount": 0,
      "effectiveAmount": 1000,
      "sku": "1001",
      "onHandStock": 8,
      "id": 0
    }
  ],
  "id": 0
}
```

--------------------------------

### Get All Purchase Orders - Node.js Request Example

Source: https://docs.hikeup.com/reference/purchase-1

Example of fetching all purchase orders using Node.js. This code utilizes the 'axios' library to make an HTTP GET request to the specified API endpoint.

```javascript
const axios = require('axios');

const options = {
  method: 'GET',
  url: 'https://api.hikeup.com/api/v1/purchase/get_all',
  headers: {
    'accept': 'application/json'
  }
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});
```

--------------------------------

### POST /websites/hikeup_reference/customers

Source: https://docs.hikeup.com/reference/customers_createorupdate-1

This endpoint is used to create a new customer.

```APIDOC
## POST /websites/hikeup_reference/customers

### Description
Creates a new customer using the provided request model.

### Method
POST

### Endpoint
/websites/hikeup_reference/customers

### Parameters
#### Request Body
- **customerRequestModel** (object) - Required - The model containing customer details.
  - **firstName** (string) - Required - The first name of the customer.
  - **lastName** (string) - Required - The last name of the customer.
  - **email** (string) - Required - The email address of the customer.
  - **phone** (string) - Optional - The phone number of the customer.
  - **isActive** (boolean) - Optional - Indicates if the customer is active. Defaults to true.
  - **id** (integer) - Output Only - The unique identifier for the customer.

### Request Example
```json
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "123-456-7890",
  "isActive": true
}
```

### Response
#### Success Response (200)
- **customerModel** (object) - The details of the created customer.
  - **firstName** (string) - The first name of the customer.
  - **lastName** (string) - The last name of the customer.
  - **email** (string) - The email address of the customer.
  - **phone** (string) - The phone number of the customer.
  - **isActive** (boolean) - Indicates if the customer is active.
  - **id** (integer) - The unique identifier for the customer.

#### Response Example
```json
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "123-456-7890",
  "isActive": true,
  "id": 1
}
```
```

--------------------------------

### Get All Suppliers - Python Request

Source: https://docs.hikeup.com/reference/suppliers-1

This Python snippet uses the 'requests' library to fetch all suppliers. It makes a GET request to the API endpoint with the specified 'accept' header. Ensure the 'requests' library is installed (`pip install requests`).

```python
import requests

url = 'https://api.hikeup.com/api/v1/suppliers/get_all'
headers = {'accept': 'application/json'}

try:
    response = requests.get(url, headers=headers)
    response.raise_for_status()  # Raise an exception for bad status codes
    print(response.json())
except requests.exceptions.RequestException as e:
    print(f'Error fetching suppliers: {e}')
```

--------------------------------

### Product Data Structure Example

Source: https://docs.hikeup.com/reference/product_getall-1

This JSON object represents a comprehensive product entry, including its outlet details, supplier information, attributes, and variants. It serves as a template for product data management within the HikeUp system.

```json
{
  "outlet_id": 1,
  "outlet_name": "Melbourne",
  "cost_price": 200,
  "markup": 0,
  "price_ex_tax": 200,
  "tax_id": 2,
  "tax_name": "GST",
  "tax_rate": 15,
  "price_inc_tax": 230,
  "avgCost_price": 0,
  "on_hand_inventory": 100,
  "inventory_to_receive": 0,
  "reserved_inventory": 0,
  "available_inventory": 200,
  "reorder_level": 0,
  "reorder_qty": 100,
  "visible_or_not": true
}
],
"product_suppliers": [
  {
    "supplier_id": 4,
    "supplier_name": "AB Dealer",
    "is_primary": false
  }
],
"product_attributes": [
  {
    "prod_attribute_id": 42,
    "master_attribute_id": 2,
    "attribute_name": "Size",
    "attribute_sequence": 1,
    "attribute_values": [
      {
        "productAttributeValueId": 91,
        "productAttributeId": 42,
        "attributeId": 2,
        "attributeValueId": 33,
        "value": "30"
      },
      {
        "productAttributeValueId": 92,
        "productAttributeId": 42,
        "attributeId": 2,
        "attributeValueId": 34,
        "value": "32"
      }
    ]
  }
],
"product_variants": [
  {
    "prod_variant_id": 221,
    "variant_name": "Demo Jeans / 30",
    "sku": "10096",
    "barcode": "BB27C5E8",
    "priced_by_outlet": false,
    "cost_price": 0,
    "markup": 0,
    "variant_sub_values": [
      {
        "variant_attribute_id": 42,
        "variant_sub_value_id": 91,
        "attribute_master_id": 2,
        "sub_values_master_id": 33,
        "variant_attribute_name": "Size",
        "variant_sub_value_name": "30",
        "display_order": 1
      }
    ],
    "variant_outlets": [
      {
        "outlet_id": 1,
        "outlet_name": "Melbourne",
        "cost_price": 200,
        "markup": 0,
        "price_ex_tax": 200,
        "tax_id": 2,
        "tax_name": "GST",
        "tax_rate": 15,
        "price_inc_tax": 230,
        "avgCost_price": 0,
        "on_hand_inventory": 100,
        "inventory_to_receive": 0,
        "reserved_inventory": 0,
        "available_inventory": 100,
        "reorder_level": 0,
        "reorder_qty": 100,
        "visible_or_not": true
      }
    ],
    "variant_images": [
      {
        "primary_pic_Id": 0,
        "is_primary": false
      }
    ]
  },
  {
    "prod_variant_id": 222,
    "variant_name": "Demo Jeans / 32",
    "sku": "10097",
    "barcode": "BB27C5E9",
    "priced_by_outlet": false,
    "cost_price": 0,
    "markup": 0,
    "variant_sub_values": [
      {
        "variant_attribute_id": 42,
        "variant_sub_value_id": 92,
        "attribute_master_id": 2,
        "sub_values_master_id": 34,
        "variant_attribute_name": "Size",
        "variant_sub_value_name": "32",
        "display_order": 1
      }
    ],
    "variant_outlets": [
      {
        "outlet_id": 1,
        "outlet_name": "Melbourne",
        "cost_price": 210,
        "markup": 0,
        "price_ex_tax": 210,
        "tax_id": 2,
        "tax_name": "GST",
        "tax_rate": 15,
        "price_inc_tax": 241.5,
        "avgCost_price": 0,
        "on_hand_inventory": 150,
        "inventory_to_receive": 0,
        "reserved_inventory": 0,
        "available_inventory": 150,
        "reorder_level": 0,
        "reorder_qty": 100,
        "visible_or_not": true
      }
    ],
    "variant_images": []
  }
]
}
```

--------------------------------

### Get All Suppliers - Node.js Request

Source: https://docs.hikeup.com/reference/suppliers-1

This Node.js snippet demonstrates how to fetch all suppliers using the 'axios' library. It makes a GET request to the API endpoint and handles the JSON response. Ensure 'axios' is installed (`npm install axios`).

```javascript
const axios = require('axios');

const getAllSuppliers = async () => {
  try {
    const response = await axios.get('https://api.hikeup.com/api/v1/suppliers/get_all', {
      headers: {
        'accept': 'application/json'
      }
    });
    return response.data;
  } catch (error) {
    console.error('Error fetching suppliers:', error);
    throw error;
  }
};

getAllSuppliers().then(data => console.log(data));
```

--------------------------------

### Product Data Structure Example

Source: https://docs.hikeup.com/reference/product_get-1

This snippet demonstrates the structure of a product object within the HikeUp API. It includes fields for product identification, measurements, pricing, and associated IDs for outlets and variants. The `isActive` flag indicates if the product is currently active.

```json
{
  "id": 1,
  "productId": 2,
  "measureProductId": 3,
  "name": "UOM Product",
  "sku": "UOMP",
  "barCode": "UOMP",
  "qty": 1,
  "discountIsAsPercentage": false,
  "discountValue": 0,
  "outletIds": [
    1,
    2,
    3
  ],
  "variantIds": [
    4,
    5,
    6
  ]
}
```

--------------------------------

### Get All Suppliers - Ruby Request

Source: https://docs.hikeup.com/reference/suppliers-1

This Ruby snippet utilizes the 'httparty' gem to perform a GET request for all suppliers. It sends the request to the specified API endpoint with the correct 'accept' header. Ensure 'httparty' is installed (`gem install httparty`).

```ruby
require 'httparty'

url = 'https://api.hikeup.com/api/v1/suppliers/get_all'

response = HTTParty.get(url, headers: { 'accept' => 'application/json' })

if response.success?
  puts response.parsed_response
else
  puts "Error: #{response.code} - #{response.message}"
end
```

--------------------------------

### POST /websites/hikeup_reference/customers

Source: https://docs.hikeup.com/reference/customers_createorupdate-1

Creates a new customer with the provided details. If billing or delivery address IDs are set to 0, new addresses will be created and included in the response.

```APIDOC
## POST /websites/hikeup_reference/customers

### Description
Creates a new customer. If `billing_address_id` or `delivery_address_id` is 0, new addresses are created and returned in the response.

### Method
POST

### Endpoint
`/websites/hikeup_reference/customers`

### Parameters
#### Query Parameters
None

#### Request Body
- **first_name** (string) - Required - Customer first name
- **email** (string) - Required - Customer's email address
- **last_name** (string) - Optional - Customer last name
- **company_name** (string) - Optional - Customer's business name
- **phone** (string) - Optional - Customer's primary phone number
- **customer_code** (string) - Optional - Customer code in Hike
- **billing_address_id** (integer) - Optional - Customer's delivery address record id, 0 to create a new address.
- **delivery_address_id** (integer) - Optional - Customer's billing Address record id, 0 to create a new address.
- **customer_group_id** (integer) - Optional - Customer group id
- **notes** (string) - Optional - Internal notes
- **loyalty_rewards_status** (boolean) - Optional - Has this customer signed up for loyalty rewards?
- **birth_date** (string) - Optional - Customer's birth date (ISO 8601 format)
- **gender** (integer) - Optional - Customer's gender
- **loyalty_balance** (number) - Optional - Customer's current loyalty balance

### Request Example
```json
{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "phone": "123-456-7890",
  "billing_address_id": 0,
  "delivery_address_id": 0
}
```

### Response
#### Success Response (201 Created)
- **id** (integer) - The unique identifier for the created customer.
- **first_name** (string) - Customer first name.
- **last_name** (string) - Customer last name.
- **email** (string) - Customer's email address.
- **phone** (string) - Customer's primary phone number.
- **billing_address** (object) - Details of the billing address.
- **delivery_address** (array) - List of delivery addresses.

#### Response Example
```json
{
  "id": 123,
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "phone": "123-456-7890",
  "billing_address": {
    "id": 101,
    "address1": "123 Main St",
    "city": "Anytown",
    "state": "CA",
    "country_code": "us",
    "country_name": "United States",
    "postcode": "90210"
  },
  "delivery_address": [
    {
      "id": 201,
      "addressId": 101,
      "address1": "123 Main St",
      "city": "Anytown",
      "state": "CA",
      "country_code": "us",
      "country_name": "United States",
      "postcode": "90210",
      "receiverName": "John Doe",
      "receiverCompanyName": "Doe Inc.",
      "receiverPhone": "(555) 123-4567"
    }
  ],
  "created_date": "2024-10-16T11:43:00.8101175Z",
  "last_modified": "2024-10-16T11:43:00.8101175Z",
  "customer_group": {
    "name": "Standard",
    "discount_status": false,
    "discount_percent": 0,
    "created_date": "2024-10-16T11:43:00.8101175Z",
    "last_modified": "2024-10-16T11:43:00.8101175Z",
    "isActive": true,
    "id": 1
  },
  "accepts_marketing": true,
  "customer_tags": [],
  "isActive": true
}
```

#### Error Response (400 Bad Request)
- **code** (integer) - Error code.
- **message** (string) - Error message.

#### Error Example
```json
{
  "code": 400,
  "message": "Invalid input: Email is required."
}
```
```

--------------------------------

### GET /api/v1/product_types/get_all

Source: https://docs.hikeup.com/reference/producttype-1

Retrieves all product types from the database. Supports pagination, filtering, and sorting.

```APIDOC
## GET /api/v1/product_types/get_all

### Description
This endpoint retrieves all product types from the database. It supports query parameters for pagination, filtering, and sorting to customize the results.

### Method
GET

### Endpoint
https://api.hikeup.com/api/v1/product_types/get_all

### Parameters
#### Query Parameters
- **page_size** (int32) - Required - Result count in each batch.
- **skip_count** (int32) - Required - This will depend on the batch size defined above.
- **filter** (string) - Optional - Filter by product type name.
- **sorting** (string) - Optional - Sort by any available field.

### Request Example
```json
{
  "example": "curl --request GET \
     --url https://api.hikeup.com/api/v1/product_types/get_all?page_size=10&skip_count=0&filter=exampleFilter&sorting=name \
     --header 'accept: application/json'"
}
```

### Response
#### Success Response (200)
- **The response body will contain a list of product types, each with its own set of fields.** (object) - Description of the product type object structure is not provided in the input.

#### Response Example
```json
{
  "example": "[Response body will be a JSON array of product type objects]"
}
```
```

--------------------------------

### Get All Brands - Python Request

Source: https://docs.hikeup.com/reference/brand-1

This Python script fetches all brands from the HikeUp API using the 'requests' library. It sends a GET request to the specified URL with the 'accept' header set to 'application/json'. Ensure 'requests' is installed (`pip install requests`).

```python
import requests

url = "https://api.hikeup.com/api/v1/brands/get_all"

headers = {
    "accept": "application/json"
}

response = requests.get(url, headers=headers)

print(response.json())
```

--------------------------------

### Create Product

Source: https://docs.hikeup.com/reference/product_createproduct-1

Allows for the creation of new products with detailed attributes, including variant information, pricing, inventory management, and SEO settings.

```APIDOC
## POST /products

### Description
Creates a new product with its associated details.

### Method
POST

### Endpoint
/products

### Parameters
#### Request Body
- **parentId** (integer) - Optional - Parent ID for variant products.
- **name** (string) - Required - Product name.
- **description** (string) - Optional - Product description.
- **sku** (string) - Required - Unique SKU number.
- **barcode** (string) - Optional - Unique barcode ID.
- **primary_image** (string) - Optional - UUID of the product's primary image.
- **brand_id** (integer) - Optional - Product's brand ID.
- **bran_name** (string) - Optional - Product's brand name.
- **season_id** (integer) - Optional - Season tag ID if it's a seasonal product.
- **season_name** (string) - Optional - Season tag name if it's a seasonal product.
- **supplier_code** (string) - Optional - Supplier code for integrated accounting software.
- **sales_code** (string) - Optional - Sales code for integrated accounting software.
- **purchase_code** (string) - Optional - Purchase code for integrated accounting software.
- **inventory_asset_acc_code** (string) - Optional - Inventory asset account code for integrated accounting software.
- **customField** (string) - Optional - Custom field for product details.
- **isPricingDifferentByOutlet** (boolean) - Optional - Indicates if pricing varies by outlet.
- **has_variants** (boolean) - Optional - Indicates if the product has variants.
- **track_inventory** (boolean) - Optional - Inventory tracking status (on/off).
- **continue_selling_no_inventory** (boolean) - Optional - Allows selling when inventory is zero or less.
- **additional_reward_points** (number) - Optional - Additional reward points awarded on purchase.
- **created_date_time** (string) - Optional - Record first created date (ISO 8601 format).
- **last_modified** (string) - Optional - Record last update date (ISO 8601 format).
- **seO_feature** (boolean) - Optional - Activate/disable meta title and description for SEO.
- **meta_title** (string) - Optional - Meta title for SEO.
- **meta_desc** (string) - Optional - Meta description for SEO.
- **meta_keywords** (string) - Optional - Meta keywords for SEO.
- **enable_unit_of_measure** (boolean) - Optional - Enable unit of measure for the product.

### Request Example
```json
{
  "name": "Example T-Shirt",
  "sku": "TSHIRT001",
  "description": "A comfortable cotton t-shirt.",
  "has_variants": true,
  "track_inventory": true,
  "meta_title": "Buy Example T-Shirt Online",
  "meta_desc": "High quality cotton t-shirt available in various sizes and colors."
}
```

### Response
#### Success Response (201 Created)
- **id** (string) - The unique identifier of the newly created product.
- **message** (string) - Confirmation message of successful creation.

#### Response Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "message": "Product created successfully."
}
```
```

--------------------------------

### Get All Brands - Ruby Request

Source: https://docs.hikeup.com/reference/brand-1

This Ruby code snippet illustrates how to retrieve all brands using the 'httparty' gem. It makes a GET request to the specified API endpoint, setting the 'accept' header to 'application/json'. Ensure 'httparty' is installed (`gem install httparty`).

```ruby
require 'httparty'

response = HTTParty.get('https://api.hikeup.com/api/v1/brands/get_all', 
  headers: { 'accept' => 'application/json' })

puts response.body
```

--------------------------------

### Get All Product Types - Python Request

Source: https://docs.hikeup.com/reference/producttype-1

This Python code snippet shows how to retrieve all product types using the 'requests' library. It sends a GET request to the API endpoint and parses the JSON response. Make sure to install the library (`pip install requests`).

```python
import requests

url = 'https://api.hikeup.com/api/v1/product_types/get_all'
headers = {'accept': 'application/json'}

try:
    response = requests.get(url, headers=headers)
    response.raise_for_status()  # Raise an exception for bad status codes
    product_types = response.json()
    print(product_types)
except requests.exceptions.RequestException as e:
    print(f"Error fetching product types: {e}")
```

--------------------------------

### Product General Information

Source: https://docs.hikeup.com/reference/product_createproduct-1

This snippet shows the basic information for a product, including its barcode, primary image, brand details, and inventory tracking flags. It also includes creation and modification timestamps.

```json
{
  "barcode": "D5A516A3",
  "primary_image": "8c7bc24a-cd0e-40d7-a5a2-1b299e0c36d3",
  "brand_id": 6,
  "bran_name": "denim",
  "isPricingDifferentByOutlet": false,
  "has_variants": true,
  "track_inventory": true,
  "continue_selling_no_inventory": false,
  "additional_reward_points": 10,
  "created_date_time": "2024-10-16T11:43:00.8569931Z",
  "last_modified": "2024-10-16T11:43:00.8569931Z",
  "seO_feature": false,
  "enable_unit_of_measure": false
}
```

--------------------------------

### Get All Product Types - Node.js Request

Source: https://docs.hikeup.com/reference/producttype-1

This Node.js code snippet shows how to fetch all product types using the 'node-fetch' library. It makes a GET request to the specified API endpoint and handles the JSON response. Ensure 'node-fetch' is installed (`npm install node-fetch`).

```javascript
import fetch from 'node-fetch';

const url = 'https://api.hikeup.com/api/v1/product_types/get_all';

async function getAllProductTypes() {
  try {
    const response = await fetch(url, {
      method: 'GET',
      headers: {
        'accept': 'application/json'
      }
    });
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    const data = await response.json();
    console.log(data);
  } catch (error) {
    console.error('Error fetching product types:', error);
  }
}

getAllProductTypes();
```

--------------------------------

### Get All Products using PHP

Source: https://docs.hikeup.com/reference/product-1

This PHP snippet shows how to fetch all products using cURL. It sets up the cURL request to the specified API endpoint with the appropriate headers and retrieves the JSON response.

```php
<?php

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, 'https://api.hikeup.com/api/v1/products/get_all');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('accept: application/json'));

$response = curl_exec($curl);

if (!$response) {
    die('Error: 
```

--------------------------------

### Get All Webhooks (PHP)

Source: https://docs.hikeup.com/reference/webhook-1

This PHP example utilizes cURL to fetch all webhooks from the database. It configures the cURL request to perform a GET operation with the correct headers.

```php
<?php

$url = "https://api.hikeup.com/api/v1/webhooks/get_all";

$ch = curl_init($url);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'accept: application/json'
));

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Curl error: ' . curl_error($ch);
} else {
    echo $response;
}

celsius_close($ch);
?>

```

--------------------------------

### Get All Users Request (PHP)

Source: https://docs.hikeup.com/reference/users-1

This PHP snippet provides an example of making an HTTP GET request to retrieve all user data. It shows the essential components for constructing the request.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hikeup.com/api/v1/users/get_all",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #" . $err;
} else {
  echo $response;
}

?>
```

--------------------------------

### HikeUp Product Variant Data Example (JSON)

Source: https://docs.hikeup.com/reference/product_by_sku-1

This JSON snippet illustrates the structure of a single product variant, including its name, SKU, barcode, sub-values (like size), and outlet-specific details such as cost price, tax information, and inventory counts. It shows how different sizes of the same product are represented and their availability at various outlets.

```json
{
  "variant_name": "Demo Jeans / 30",
  "sku": "10096",
  "barcode": "BB27C5E8",
  "priced_by_outlet": false,
  "cost_price": 0,
  "markup": 0,
  "variant_sub_values": [
    {
      "variant_attribute_id": 42,
      "variant_sub_value_id": 91,
      "attribute_master_id": 2,
      "sub_values_master_id": 33,
      "variant_attribute_name": "Size",
      "variant_sub_value_name": "30",
      "display_order": 1
    }
  ],
  "variant_outlets": [
    {
      "outlet_id": 1,
      "outlet_name": "Melbourne",
      "cost_price": 200,
      "markup": 0,
      "price_ex_tax": 200,
      "tax_id": 2,
      "tax_name": "GST",
      "tax_rate": 15,
      "price_inc_tax": 230,
      "avgCost_price": 0,
      "on_hand_inventory": 100,
      "inventory_to_receive": 0,
      "reserved_inventory": 0,
      "available_inventory": 100,
      "reorder_level": 0,
      "reorder_qty": 100,
      "visible_or_not": true
    }
  ],
  "variant_images": [
    {
      "primary_pic_Id": 0,
      "is_primary": false
    }
  ]
}
```

--------------------------------

### GET /api/products/{productId}

Source: https://docs.hikeup.com/reference/product_createproduct-1

Retrieve detailed information for a specific product, including its variants, inventory status, and images.

```APIDOC
## GET /api/products/{productId}

### Description
Retrieves detailed information for a specific product identified by its ID. This includes product details, variants, outlet-specific inventory, and associated images.

### Method
GET

### Endpoint
`/api/products/{productId}`

### Parameters
#### Path Parameters
- **productId** (integer) - Required - The unique identifier of the product.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **productId** (integer) - The unique identifier of the product.
- **productName** (string) - The name of the product.
- **description** (string) - A detailed description of the product.
- **brand** (string) - The brand of the product.
- **category** (string) - The category the product belongs to.
- **variants** (array) - An array of product variants.
  - **variantId** (integer) - The unique identifier of the variant.
  - **sku** (string) - The Stock Keeping Unit for the variant.
  - **variantName** (string) - The name of the variant.
  - **price** (number) - The price of the variant.
  - **outlet_inventory** (array) - Inventory details for each outlet.
    - **outletId** (integer) - The ID of the outlet.
    - **outletName** (string) - The name of the outlet.
    - **inventory_on_hand** (number) - The quantity of inventory currently on hand.
    - **inventory_ordered** (number) - The quantity of inventory ordered from the supplier.
    - **reserved_inventory** (number) - The quantity of inventory reserved for orders.
    - **available_inventory** (number) - The quantity of inventory available (on-hand minus reserved).
    - **reorder_level** (number) - The inventory level at which to reorder.
    - **reorder_qty** (number) - The quantity to reorder from the supplier.
    - **visible_or_not** (boolean) - Indicates if the product is active at this outlet.
  - **variant_images** (array) - All images associated with this variant.
    - **primary_pic_Id** (integer) - The ID of the primary image for the variant.
    - **image_url** (string) - The public URL of the image.
    - **primary_pic_name** (string) - The name of the primary image.
    - **50_thumbnail** (string) - URL for a 50x50 pixel thumbnail.
    - **240_thumbnail** (string) - URL for a 240x240 pixel thumbnail.
    - **500_thumbnail** (string) - URL for a 500x500 pixel thumbnail.
    - **is_primary** (boolean) - Indicates if this image is the primary image.
- **additional_images** (array) - Additional optional product images.
  - **primary_pic_Id** (integer) - The ID of the primary image.
  - **image_url** (string) - The public URL of the image.
  - **primary_pic_name** (string) - The name of the primary image.
  - **50_thumbnail** (string) - URL for a 50x50 pixel thumbnail.

#### Response Example
```json
{
  "productId": 123,
  "productName": "Example Product",
  "description": "A detailed description of the example product.",
  "brand": "Example Brand",
  "category": "Electronics",
  "variants": [
    {
      "variantId": 456,
      "sku": "EX-PROD-001",
      "variantName": "Red",
      "price": 99.99,
      "outlet_inventory": [
        {
          "outletId": 1,
          "outletName": "Main Store",
          "inventory_on_hand": 50,
          "inventory_ordered": 10,
          "reserved_inventory": 5,
          "available_inventory": 45,
          "reorder_level": 10,
          "reorder_qty": 20,
          "visible_or_not": true
        }
      ],
      "variant_images": [
        {
          "primary_pic_Id": 789,
          "image_url": "http://example.com/images/product.jpg",
          "primary_pic_name": "product.jpg",
          "50_thumbnail": "http://example.com/images/thumb_50_product.jpg",
          "240_thumbnail": "http://example.com/images/thumb_240_product.jpg",
          "500_thumbnail": "http://example.com/images/thumb_500_product.jpg",
          "is_primary": true
        }
      ]
    }
  ],
  "additional_images": [
    {
      "primary_pic_Id": 101,
      "image_url": "http://example.com/images/product_alt.jpg",
      "primary_pic_name": "product_alt.jpg",
      "50_thumbnail": "http://example.com/images/thumb_50_product_alt.jpg"
    }
  ]
}
```
```
Tokens:
Raw