Gulf POS API Documentation

POST oauth/token

Authorize a client to access the user's account.

Headers

Name	Value
`Content-Type`	`application/json`
`Accept`	`application/json`

Example request

curl --request POST \
    "https://gulfpos.com/oauth/token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/oauth/token"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/oauth/token';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/oauth/token'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST oauth/token/refresh

Get a fresh transient token cookie for the authenticated user.

Headers

Name	Value
`Content-Type`	`application/json`
`Accept`	`application/json`

Example request

curl --request POST \
    "https://gulfpos.com/oauth/token/refresh" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/oauth/token/refresh"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/oauth/token/refresh';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/oauth/token/refresh'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/business-location

List business locations

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/business-location" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/business-location"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/business-location';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/business-location'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "business_id": 1,
            "location_id": null,
            "name": "Awesome Shop",
            "landmark": "Linking Street",
            "country": "USA",
            "state": "Arizona",
            "city": "Phoenix",
            "zip_code": "85001",
            "invoice_scheme_id": 1,
            "invoice_layout_id": 1,
            "selling_price_group_id": null,
            "print_receipt_on_invoice": 1,
            "receipt_printer_type": "browser",
            "printer_id": null,
            "mobile": null,
            "alternate_number": null,
            "email": null,
            "website": null,
            "featured_products": [
                "5",
                "71"
            ],
            "is_active": 1,
            "payment_methods": [
                {
                    "name": "cash",
                    "label": "Cash",
                    "account_id": "1"
                },
                {
                    "name": "card",
                    "label": "Card",
                    "account_id": null
                },
                {
                    "name": "cheque",
                    "label": "Cheque",
                    "account_id": null
                },
                {
                    "name": "bank_transfer",
                    "label": "Bank Transfer",
                    "account_id": null
                },
                {
                    "name": "other",
                    "label": "Other",
                    "account_id": null
                },
                {
                    "name": "custom_pay_1",
                    "label": "Custom Payment 1",
                    "account_id": null
                },
                {
                    "name": "custom_pay_2",
                    "label": "Custom Payment 2",
                    "account_id": null
                },
                {
                    "name": "custom_pay_3",
                    "label": "Custom Payment 3",
                    "account_id": null
                }
            ],
            "custom_field1": null,
            "custom_field2": null,
            "custom_field3": null,
            "custom_field4": null,
            "deleted_at": null,
            "created_at": "2018-01-04 02:15:20",
            "updated_at": "2020-06-05 00:56:54"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/business-location/{id}

Get the specified business location

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the business location. Example: `architecto`
`location`	string	required	comma separated ids of the business location Example: `1`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/business-location/architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/business-location/architecto"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/business-location/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/business-location/architecto'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "business_id": 1,
            "location_id": null,
            "name": "Awesome Shop",
            "landmark": "Linking Street",
            "country": "USA",
            "state": "Arizona",
            "city": "Phoenix",
            "zip_code": "85001",
            "invoice_scheme_id": 1,
            "invoice_layout_id": 1,
            "selling_price_group_id": null,
            "print_receipt_on_invoice": 1,
            "receipt_printer_type": "browser",
            "printer_id": null,
            "mobile": null,
            "alternate_number": null,
            "email": null,
            "website": null,
            "featured_products": [
                "5",
                "71"
            ],
            "is_active": 1,
            "payment_methods": [
                {
                    "name": "cash",
                    "label": "Cash",
                    "account_id": "1"
                },
                {
                    "name": "card",
                    "label": "Card",
                    "account_id": null
                },
                {
                    "name": "cheque",
                    "label": "Cheque",
                    "account_id": null
                },
                {
                    "name": "bank_transfer",
                    "label": "Bank Transfer",
                    "account_id": null
                },
                {
                    "name": "other",
                    "label": "Other",
                    "account_id": null
                },
                {
                    "name": "custom_pay_1",
                    "label": "Custom Payment 1",
                    "account_id": null
                },
                {
                    "name": "custom_pay_2",
                    "label": "Custom Payment 2",
                    "account_id": null
                },
                {
                    "name": "custom_pay_3",
                    "label": "Custom Payment 3",
                    "account_id": null
                }
            ],
            "custom_field1": null,
            "custom_field2": null,
            "custom_field3": null,
            "custom_field4": null,
            "deleted_at": null,
            "created_at": "2018-01-04 02:15:20",
            "updated_at": "2020-06-05 00:56:54"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/business-details

Get business details

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/business-details" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/business-details"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/business-details';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/business-details'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": {
        "id": 1,
        "name": "Awesome Shop",
        "currency_id": 2,
        "start_date": "2018-01-01",
        "tax_number_1": "3412569900",
        "tax_label_1": "GSTIN",
        "tax_number_2": null,
        "tax_label_2": null,
        "default_sales_tax": null,
        "default_profit_percent": 25,
        "owner_id": 1,
        "time_zone": "America/Phoenix",
        "fy_start_month": 1,
        "accounting_method": "fifo",
        "default_sales_discount": "10.00",
        "sell_price_tax": "includes",
        "logo": null,
        "sku_prefix": "AS",
        "enable_product_expiry": 0,
        "expiry_type": "add_expiry",
        "on_product_expiry": "keep_selling",
        "stop_selling_before": 0,
        "enable_tooltip": 1,
        "purchase_in_diff_currency": 0,
        "purchase_currency_id": null,
        "p_exchange_rate": "1.000",
        "transaction_edit_days": 30,
        "stock_expiry_alert_days": 30,
        "keyboard_shortcuts": {
            "pos": {
                "express_checkout": "shift+e",
                "pay_n_ckeckout": "shift+p",
                "draft": "shift+d",
                "cancel": "shift+c",
                "recent_product_quantity": "f2",
                "weighing_scale": null,
                "edit_discount": "shift+i",
                "edit_order_tax": "shift+t",
                "add_payment_row": "shift+r",
                "finalize_payment": "shift+f",
                "add_new_product": "f4"
            }
        },
        "pos_settings": {
            "amount_rounding_method": null,
            "disable_pay_checkout": 0,
            "disable_draft": 0,
            "disable_express_checkout": 0,
            "hide_product_suggestion": 0,
            "hide_recent_trans": 0,
            "disable_discount": 0,
            "disable_order_tax": 0,
            "is_pos_subtotal_editable": 0
        },
        "weighing_scale_setting": {
            "label_prefix": null,
            "product_sku_length": "4",
            "qty_length": "3",
            "qty_length_decimal": "2"
        },
        "manufacturing_settings": null,
        "essentials_settings": null,
        "ecom_settings": null,
        "woocommerce_wh_oc_secret": null,
        "woocommerce_wh_ou_secret": null,
        "woocommerce_wh_od_secret": null,
        "woocommerce_wh_or_secret": null,
        "enable_brand": 1,
        "enable_category": 1,
        "enable_sub_category": 1,
        "enable_price_tax": 1,
        "enable_purchase_status": 1,
        "enable_lot_number": 0,
        "default_unit": null,
        "enable_sub_units": 0,
        "enable_racks": 0,
        "enable_row": 0,
        "enable_position": 0,
        "enable_editing_product_from_purchase": 1,
        "sales_cmsn_agnt": null,
        "item_addition_method": 1,
        "enable_inline_tax": 1,
        "currency_symbol_placement": "before",
        "enabled_modules": [
            "purchases",
            "add_sale",
            "pos_sale",
            "stock_transfers",
            "stock_adjustment",
            "expenses",
            "account",
            "tables",
            "modifiers",
            "service_staff",
            "booking",
            "kitchen",
            "subscription",
            "types_of_service"
        ],
        "date_format": "m/d/Y",
        "time_format": "24",
        "ref_no_prefixes": {
            "purchase": "PO",
            "purchase_return": null,
            "stock_transfer": "ST",
            "stock_adjustment": "SA",
            "sell_return": "CN",
            "expense": "EP",
            "contacts": "CO",
            "purchase_payment": "PP",
            "sell_payment": "SP",
            "expense_payment": null,
            "business_location": "BL",
            "username": null,
            "subscription": null
        },
        "theme_color": null,
        "created_by": null,
        "enable_rp": 0,
        "rp_name": null,
        "amount_for_unit_rp": "1.0000",
        "min_order_total_for_rp": "1.0000",
        "max_rp_per_order": null,
        "redeem_amount_per_unit_rp": "1.0000",
        "min_order_total_for_redeem": "1.0000",
        "min_redeem_point": null,
        "max_redeem_point": null,
        "rp_expiry_period": null,
        "rp_expiry_type": "year",
        "repair_settings": null,
        "email_settings": {
            "mail_driver": "smtp",
            "mail_host": null,
            "mail_port": null,
            "mail_username": null,
            "mail_password": null,
            "mail_encryption": null,
            "mail_from_address": null,
            "mail_from_name": null
        },
        "sms_settings": {
            "url": null,
            "send_to_param_name": "to",
            "msg_param_name": "text",
            "request_method": "post",
            "param_1": null,
            "param_val_1": null,
            "param_2": null,
            "param_val_2": null,
            "param_3": null,
            "param_val_3": null,
            "param_4": null,
            "param_val_4": null,
            "param_5": null,
            "param_val_5": null,
            "param_6": null,
            "param_val_6": null,
            "param_7": null,
            "param_val_7": null,
            "param_8": null,
            "param_val_8": null,
            "param_9": null,
            "param_val_9": null,
            "param_10": null,
            "param_val_10": null
        },
        "custom_labels": {
            "payments": {
                "custom_pay_1": null,
                "custom_pay_2": null,
                "custom_pay_3": null
            },
            "contact": {
                "custom_field_1": null,
                "custom_field_2": null,
                "custom_field_3": null,
                "custom_field_4": null
            },
            "product": {
                "custom_field_1": null,
                "custom_field_2": null,
                "custom_field_3": null,
                "custom_field_4": null
            },
            "location": {
                "custom_field_1": null,
                "custom_field_2": null,
                "custom_field_3": null,
                "custom_field_4": null
            },
            "user": {
                "custom_field_1": null,
                "custom_field_2": null,
                "custom_field_3": null,
                "custom_field_4": null
            },
            "purchase": {
                "custom_field_1": null,
                "custom_field_2": null,
                "custom_field_3": null,
                "custom_field_4": null
            },
            "sell": {
                "custom_field_1": null,
                "custom_field_2": null,
                "custom_field_3": null,
                "custom_field_4": null
            },
            "types_of_service": {
                "custom_field_1": null,
                "custom_field_2": null,
                "custom_field_3": null,
                "custom_field_4": null
            }
        },
        "common_settings": {
            "default_datatable_page_entries": "25"
        },
        "is_active": 1,
        "created_at": "2018-01-04 02:15:19",
        "updated_at": "2020-06-04 22:33:01",
        "locations": [
            {
                "id": 1,
                "business_id": 1,
                "location_id": null,
                "name": "Awesome Shop",
                "landmark": "Linking Street",
                "country": "USA",
                "state": "Arizona",
                "city": "Phoenix",
                "zip_code": "85001",
                "invoice_scheme_id": 1,
                "invoice_layout_id": 1,
                "selling_price_group_id": null,
                "print_receipt_on_invoice": 1,
                "receipt_printer_type": "browser",
                "printer_id": null,
                "mobile": null,
                "alternate_number": null,
                "email": null,
                "website": null,
                "featured_products": [
                    "5",
                    "71"
                ],
                "is_active": 1,
                "default_payment_accounts": {
                    "cash": {
                        "is_enabled": "1",
                        "account": null
                    },
                    "card": {
                        "is_enabled": "1",
                        "account": null
                    },
                    "cheque": {
                        "is_enabled": "1",
                        "account": null
                    },
                    "bank_transfer": {
                        "is_enabled": "1",
                        "account": null
                    },
                    "other": {
                        "is_enabled": "1",
                        "account": null
                    },
                    "custom_pay_1": {
                        "is_enabled": "1",
                        "account": null
                    },
                    "custom_pay_2": {
                        "is_enabled": "1",
                        "account": null
                    },
                    "custom_pay_3": {
                        "is_enabled": "1",
                        "account": null
                    }
                },
                "custom_field1": null,
                "custom_field2": null,
                "custom_field3": null,
                "custom_field4": null,
                "deleted_at": null,
                "created_at": "2018-01-04 02:15:20",
                "updated_at": "2020-06-05 00:56:54"
            }
        ],
        "currency": {
            "id": 2,
            "country": "America",
            "currency": "Dollars",
            "code": "USD",
            "symbol": "$",
            "thousand_separator": ",",
            "decimal_separator": ".",
            "created_at": null,
            "updated_at": null
        },
        "printers": [],
        "currency_precision": 2,
        "quantity_precision": 2
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/get-location

Get location details from coordinates

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Body Parameters

lat decimal

Lattitude of the location Example: 41.40338

lon decimal

Longitude of the location Example: 2.17403

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/get-location" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lat\": \"41.40338\",
    \"lon\": \"2.17403\"
}"

const url = new URL(
    "https://gulfpos.com/connector/api/get-location"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lat": "41.40338",
    "lon": "2.17403"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/get-location';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'lat' => '41.40338',
            'lon' => '2.17403',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/get-location'
payload = {
    "lat": "41.40338",
    "lon": "2.17403"
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response

Response 200

{
    "address": "Radhanath Mullick Ln, Tiretta Bazaar, Bow Bazaar, Kolkata, West Bengal, 700 073, India"
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/contactapi

List contact

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Query Parameters

Name	Type	Status	Description
`type`	string	required	Type of contact (supplier, customer) Example: `architecto`
`name`	string	optional	Search term for contact name Example: `architecto`
`biz_name`	string	optional	Search term for contact's business name Example: `architecto`
`mobile_num`	integer	optional	Search term for contact's mobile number Example: `16`
`contact_id`	string	optional	Search term for contact's contact_id. Ex(CO0005) Example: `architecto`
`order_by`	string	optional	Column name to sort the result, Column: name, supplier_business_name Example: `architecto`
`direction`	string	optional	Direction to sort the result, Direction: desc, asc Example: `architecto`
`per_page`	integer	optional	Total records per page. default: 10, Set -1 for no pagination Example: `10`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/contactapi?type=architecto&name=architecto&biz_name=architecto&mobile_num=16&contact_id=architecto&order_by=architecto&direction=architecto&per_page=10" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/contactapi"
);

const params = {
    "type": "architecto",
    "name": "architecto",
    "biz_name": "architecto",
    "mobile_num": "16",
    "contact_id": "architecto",
    "order_by": "architecto",
    "direction": "architecto",
    "per_page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/contactapi';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'type' => 'architecto',
            'name' => 'architecto',
            'biz_name' => 'architecto',
            'mobile_num' => '16',
            'contact_id' => 'architecto',
            'order_by' => 'architecto',
            'direction' => 'architecto',
            'per_page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/contactapi'
params = {
  'type': 'architecto',
  'name': 'architecto',
  'biz_name': 'architecto',
  'mobile_num': '16',
  'contact_id': 'architecto',
  'order_by': 'architecto',
  'direction': 'architecto',
  'per_page': '10',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 2,
            "business_id": 1,
            "type": "supplier",
            "supplier_business_name": "Alpha Clothings",
            "name": "Michael",
            "prefix": null,
            "first_name": "Michael",
            "middle_name": null,
            "last_name": null,
            "email": null,
            "contact_id": "CO0001",
            "contact_status": "active",
            "tax_number": "4590091535",
            "city": "Phoenix",
            "state": "Arizona",
            "country": "USA",
            "address_line_1": "Linking Street",
            "address_line_2": null,
            "zip_code": null,
            "dob": null,
            "mobile": "(378) 400-1234",
            "landline": null,
            "alternate_number": null,
            "pay_term_number": 15,
            "pay_term_type": "days",
            "credit_limit": null,
            "created_by": 1,
            "balance": "0.0000",
            "total_rp": 0,
            "total_rp_used": 0,
            "total_rp_expired": 0,
            "is_default": 0,
            "shipping_address": null,
            "position": null,
            "customer_group_id": null,
            "crm_source": null,
            "crm_life_stage": null,
            "custom_field1": null,
            "custom_field2": null,
            "custom_field3": null,
            "custom_field4": null,
            "custom_field5": null,
            "custom_field6": null,
            "custom_field7": null,
            "custom_field8": null,
            "custom_field9": null,
            "custom_field10": null,
            "deleted_at": null,
            "created_at": "2018-01-03 20:59:38",
            "updated_at": "2018-06-11 22:21:03",
            "remember_token": null,
            "password": null
        },
        {
            "id": 3,
            "business_id": 1,
            "type": "supplier",
            "supplier_business_name": "Manhattan Clothing Ltd.",
            "name": "Philip",
            "prefix": null,
            "first_name": "Philip",
            "middle_name": null,
            "last_name": null,
            "email": null,
            "contact_id": "CO0003",
            "contact_status": "active",
            "tax_number": "54869310093",
            "city": "Phoenix",
            "state": "Arizona",
            "country": "USA",
            "address_line_1": "Linking Street",
            "address_line_2": null,
            "zip_code": null,
            "dob": null,
            "mobile": "(378) 400-1234",
            "landline": null,
            "alternate_number": null,
            "pay_term_number": 15,
            "pay_term_type": "days",
            "credit_limit": null,
            "created_by": 1,
            "balance": "0.0000",
            "total_rp": 0,
            "total_rp_used": 0,
            "total_rp_expired": 0,
            "is_default": 0,
            "shipping_address": null,
            "position": null,
            "customer_group_id": null,
            "crm_source": null,
            "crm_life_stage": null,
            "custom_field1": null,
            "custom_field2": null,
            "custom_field3": null,
            "custom_field4": null,
            "custom_field5": null,
            "custom_field6": null,
            "custom_field7": null,
            "custom_field8": null,
            "custom_field9": null,
            "custom_field10": null,
            "deleted_at": null,
            "created_at": "2018-01-03 21:00:55",
            "updated_at": "2018-06-11 22:21:36",
            "remember_token": null,
            "password": null
        },
        {
            "id": 5,
            "business_id": 1,
            "type": "supplier",
            "supplier_business_name": "Digital Ocean",
            "name": "Mike McCubbin",
            "prefix": null,
            "first_name": "Mike McCubbin",
            "middle_name": null,
            "last_name": null,
            "email": null,
            "contact_id": "CN0004",
            "contact_status": "active",
            "tax_number": "52965489001",
            "city": "Phoenix",
            "state": "Arizona",
            "country": "USA",
            "address_line_1": "Linking Street",
            "address_line_2": null,
            "zip_code": null,
            "dob": null,
            "mobile": "(378) 400-1234",
            "landline": null,
            "alternate_number": null,
            "pay_term_number": 30,
            "pay_term_type": "days",
            "credit_limit": null,
            "created_by": 1,
            "balance": "0.0000",
            "total_rp": 0,
            "total_rp_used": 0,
            "total_rp_expired": 0,
            "is_default": 0,
            "shipping_address": null,
            "position": null,
            "customer_group_id": null,
            "crm_source": null,
            "crm_life_stage": null,
            "custom_field1": null,
            "custom_field2": null,
            "custom_field3": null,
            "custom_field4": null,
            "custom_field5": null,
            "custom_field6": null,
            "custom_field7": null,
            "custom_field8": null,
            "custom_field9": null,
            "custom_field10": null,
            "deleted_at": null,
            "created_at": "2018-01-06 06:53:22",
            "updated_at": "2018-06-11 22:21:47",
            "remember_token": null,
            "password": null
        },
        {
            "id": 6,
            "business_id": 1,
            "type": "supplier",
            "supplier_business_name": "Univer Suppliers",
            "name": "Jackson Hill",
            "prefix": null,
            "first_name": "Jackson Hill",
            "middle_name": null,
            "last_name": null,
            "email": null,
            "contact_id": "CO0002",
            "contact_status": "active",
            "tax_number": "5459000655",
            "city": "Phoenix",
            "state": "Arizona",
            "country": "USA",
            "address_line_1": "Linking Street",
            "address_line_2": null,
            "zip_code": null,
            "dob": null,
            "mobile": "(378) 400-1234",
            "landline": null,
            "alternate_number": null,
            "pay_term_number": 45,
            "pay_term_type": "days",
            "credit_limit": null,
            "created_by": 1,
            "balance": "0.0000",
            "total_rp": 0,
            "total_rp_used": 0,
            "total_rp_expired": 0,
            "is_default": 0,
            "shipping_address": null,
            "position": null,
            "customer_group_id": null,
            "crm_source": null,
            "crm_life_stage": null,
            "custom_field1": null,
            "custom_field2": null,
            "custom_field3": null,
            "custom_field4": null,
            "custom_field5": null,
            "custom_field6": null,
            "custom_field7": null,
            "custom_field8": null,
            "custom_field9": null,
            "custom_field10": null,
            "deleted_at": null,
            "created_at": "2018-01-06 06:55:09",
            "updated_at": "2018-06-11 22:21:18",
            "remember_token": null,
            "password": null
        }
    ],
    "links": {
        "first": "http://local.pos.com/connector/api/contactapi?page=1",
        "last": "http://local.pos.com/connector/api/contactapi?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://local.pos.com/connector/api/contactapi",
        "per_page": "10",
        "to": 4,
        "total": 4
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Query Parameters

type *

name

biz_name

mobile_num

contact_id

order_by

direction

per_page

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST connector/api/contactapi

Create contact

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Body Parameters

type string

Type of contact (supplier, customer, both, lead) Example: customer

supplier_business_name string

Required if type is supplier Example: architecto

prefix string

Prefix for the name of the contact Example: architecto

first_name string

Name of the contact Example: architecto

middle_name string

Example: architecto

last_name string

Example: architecto

tax_number string

Example: 8787fefef

pay_term_number number

Example: 3

pay_term_type string

(months ,days) Example: months

mobile string

Example: 4578691009

landline string

Example: 5487-8454-4145

alternate_number string

Example: 841847541222

address_line_1 string

Example: architecto

address_line_2 string

Example: architecto

city string

Example: architecto

state string

Example: architecto

country string

Example: architecto

zip_code string

Example: architecto

customer_group_id string

Example: architecto

contact_id string

Example: architecto

dob string

Fromat: Y-m-d Example: 2000-06-13

custom_field1 string

Example: architecto

custom_field2 string

Example: architecto

custom_field3 string

Example: architecto

custom_field4 string

Example: architecto

email string

Example: gbailey@example.net

shipping_address string

Example: architecto

position string

Example: architecto

opening_balance number

Example: 0

source_id integer

Id of the source. Applicable only if the type is lead Example: 16

life_stage_id integer

Id of the Life stage. Applicable only if the type is lead Example: 16

assigned_to string[]

Ids of the users the lead is assigned to. Applicable only if the type is lead

Example request

curl --request POST \
    "https://gulfpos.com/connector/api/contactapi" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"customer\",
    \"supplier_business_name\": \"architecto\",
    \"prefix\": \"architecto\",
    \"first_name\": \"architecto\",
    \"middle_name\": \"architecto\",
    \"last_name\": \"architecto\",
    \"tax_number\": \"8787fefef\",
    \"pay_term_number\": 3,
    \"pay_term_type\": \"months\",
    \"mobile\": \"4578691009\",
    \"landline\": \"5487-8454-4145\",
    \"alternate_number\": \"841847541222\",
    \"address_line_1\": \"architecto\",
    \"address_line_2\": \"architecto\",
    \"city\": \"architecto\",
    \"state\": \"architecto\",
    \"country\": \"architecto\",
    \"zip_code\": \"architecto\",
    \"customer_group_id\": \"architecto\",
    \"contact_id\": \"architecto\",
    \"dob\": \"2000-06-13\",
    \"custom_field1\": \"architecto\",
    \"custom_field2\": \"architecto\",
    \"custom_field3\": \"architecto\",
    \"custom_field4\": \"architecto\",
    \"email\": \"gbailey@example.net\",
    \"shipping_address\": \"architecto\",
    \"position\": \"architecto\",
    \"opening_balance\": 0,
    \"source_id\": 16,
    \"life_stage_id\": 16,
    \"assigned_to\": [
        \"architecto\"
    ]
}"

const url = new URL(
    "https://gulfpos.com/connector/api/contactapi"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "customer",
    "supplier_business_name": "architecto",
    "prefix": "architecto",
    "first_name": "architecto",
    "middle_name": "architecto",
    "last_name": "architecto",
    "tax_number": "8787fefef",
    "pay_term_number": 3,
    "pay_term_type": "months",
    "mobile": "4578691009",
    "landline": "5487-8454-4145",
    "alternate_number": "841847541222",
    "address_line_1": "architecto",
    "address_line_2": "architecto",
    "city": "architecto",
    "state": "architecto",
    "country": "architecto",
    "zip_code": "architecto",
    "customer_group_id": "architecto",
    "contact_id": "architecto",
    "dob": "2000-06-13",
    "custom_field1": "architecto",
    "custom_field2": "architecto",
    "custom_field3": "architecto",
    "custom_field4": "architecto",
    "email": "gbailey@example.net",
    "shipping_address": "architecto",
    "position": "architecto",
    "opening_balance": 0,
    "source_id": 16,
    "life_stage_id": 16,
    "assigned_to": [
        "architecto"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/contactapi';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => 'customer',
            'supplier_business_name' => 'architecto',
            'prefix' => 'architecto',
            'first_name' => 'architecto',
            'middle_name' => 'architecto',
            'last_name' => 'architecto',
            'tax_number' => '8787fefef',
            'pay_term_number' => 3.0,
            'pay_term_type' => 'months',
            'mobile' => '4578691009',
            'landline' => '5487-8454-4145',
            'alternate_number' => '841847541222',
            'address_line_1' => 'architecto',
            'address_line_2' => 'architecto',
            'city' => 'architecto',
            'state' => 'architecto',
            'country' => 'architecto',
            'zip_code' => 'architecto',
            'customer_group_id' => 'architecto',
            'contact_id' => 'architecto',
            'dob' => '2000-06-13',
            'custom_field1' => 'architecto',
            'custom_field2' => 'architecto',
            'custom_field3' => 'architecto',
            'custom_field4' => 'architecto',
            'email' => 'gbailey@example.net',
            'shipping_address' => 'architecto',
            'position' => 'architecto',
            'opening_balance' => 0.0,
            'source_id' => 16,
            'life_stage_id' => 16,
            'assigned_to' => ['architecto'],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/contactapi'
payload = {
    "type": "customer",
    "supplier_business_name": "architecto",
    "prefix": "architecto",
    "first_name": "architecto",
    "middle_name": "architecto",
    "last_name": "architecto",
    "tax_number": "8787fefef",
    "pay_term_number": 3,
    "pay_term_type": "months",
    "mobile": "4578691009",
    "landline": "5487-8454-4145",
    "alternate_number": "841847541222",
    "address_line_1": "architecto",
    "address_line_2": "architecto",
    "city": "architecto",
    "state": "architecto",
    "country": "architecto",
    "zip_code": "architecto",
    "customer_group_id": "architecto",
    "contact_id": "architecto",
    "dob": "2000-06-13",
    "custom_field1": "architecto",
    "custom_field2": "architecto",
    "custom_field3": "architecto",
    "custom_field4": "architecto",
    "email": "gbailey@example.net",
    "shipping_address": "architecto",
    "position": "architecto",
    "opening_balance": 0,
    "source_id": 16,
    "life_stage_id": 16,
    "assigned_to": [
        "architecto"
    ]
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response

Response 200

{
    "data": {
        "type": "customer",
        "name": "test customer",
        "tax_number": "75879BHF",
        "mobile": "7878825008",
        "business_id": 1,
        "created_by": 9,
        "credit_limit": null,
        "contact_id": "CO0007",
        "updated_at": "2020-06-04 21:59:21",
        "created_at": "2020-06-04 21:59:21",
        "id": 17
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Body Parameters

type string

Type of contact (supplier, customer, both, lead) Example: customer

supplier_business_name string

Required if type is supplier Example: architecto

prefix string optional

Prefix for the name of the contact Example: architecto

first_name string

Name of the contact Example: architecto

middle_name string optional

Example: architecto

last_name string optional

Example: architecto

tax_number string optional

Example: 8787fefef

pay_term_number number optional

Example: 3

pay_term_type string optional

(months ,days) Example: months

mobile string

Example: 4578691009

landline string optional

Example: 5487-8454-4145

alternate_number string optional

Example: 841847541222

address_line_1 string optional

Example: architecto

address_line_2 string optional

Example: architecto

city string optional

Example: architecto

state string optional

Example: architecto

country string optional

Example: architecto

zip_code string optional

Example: architecto

customer_group_id string optional

Example: architecto

contact_id string optional

Example: architecto

dob string optional

Fromat: Y-m-d Example: 2000-06-13

custom_field1 string optional

Example: architecto

custom_field2 string optional

Example: architecto

custom_field3 string optional

Example: architecto

custom_field4 string optional

Example: architecto

email string optional

Example: gbailey@example.net

shipping_address string optional

Example: architecto

position string optional

Example: architecto

opening_balance number optional

Example: 0

source_id integer optional

Id of the source. Applicable only if the type is lead Example: 16

life_stage_id integer optional

Id of the Life stage. Applicable only if the type is lead Example: 16

assigned_to string[] optional

Ids of the users the lead is assigned to. Applicable only if the type is lead

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/contactapi/{id}

Get the specified contact

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the contactapi. Example: `architecto`
`contact`	string	required	comma separated ids of contacts Example: `2`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/contactapi/architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/contactapi/architecto"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/contactapi/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/contactapi/architecto'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "business_id": 1,
            "type": "customer",
            "supplier_business_name": null,
            "name": " Walk-In Customer  ",
            "prefix": null,
            "first_name": "Walk-In Customer",
            "middle_name": null,
            "last_name": null,
            "email": "walkin@test.com",
            "contact_id": "CO0005",
            "contact_status": "active",
            "tax_number": null,
            "city": "Phoenix",
            "state": "Arizona",
            "country": "USA",
            "address_line_1": "Linking Street",
            "address_line_2": null,
            "zip_code": "85001",
            "dob": null,
            "mobile": "(378) 400-1234",
            "landline": null,
            "alternate_number": null,
            "pay_term_number": null,
            "pay_term_type": null,
            "credit_limit": "0.0000",
            "created_by": 1,
            "balance": "0.0000",
            "total_rp": 0,
            "total_rp_used": 0,
            "total_rp_expired": 0,
            "is_default": 1,
            "shipping_address": null,
            "position": null,
            "customer_group_id": null,
            "crm_source": null,
            "crm_life_stage": null,
            "custom_field1": null,
            "custom_field2": null,
            "custom_field3": null,
            "custom_field4": null,
            "deleted_at": null,
            "created_at": "2018-01-03 20:45:20",
            "updated_at": "2020-08-10 10:26:45",
            "remember_token": null,
            "password": null,
            "customer_group": null,
            "opening_balance": "0.0000",
            "opening_balance_paid": "0.0000",
            "total_purchase": "0.0000",
            "purchase_paid": "0.0000",
            "total_purchase_return": "0.0000",
            "purchase_return_paid": "0.0000",
            "total_invoice": "2050.0000",
            "invoice_received": "1987.5000",
            "total_sell_return": "0.0000",
            "sell_return_paid": "0.0000",
            "purchase_due": 0,
            "sell_due": 62.5,
            "purchase_return_due": 0,
            "sell_return_due": 0
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

PUT PATCH connector/api/contactapi/{id}

Update contact

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the contactapi. Example: `architecto`
`contact`	string	required	id of the contact to be updated Example: `17`

Body Parameters

type string

Type of contact (supplier, customer, both) Example: customer

supplier_business_name string

required* Required if type is supplier Example: architecto

prefix string

Prefix for the name of the contact Example: architecto

first_name string

Name of the contact Example: architecto

middle_name string

Example: architecto

last_name string

Example: architecto

tax_number string

Example: 488744dwd

pay_term_number number

Example: 3

pay_term_type string

(months ,days) Example: months

mobile string

Example: 8795461009

landline string

Example: 65484-848-848

alternate_number string

Example: 9898795220

address_line_1 string

Example: architecto

address_line_2 string

Example: architecto

city string

Example: architecto

state string

Example: architecto

country string

Example: architecto

zip_code string

Example: architecto

customer_group_id string

Example: architecto

contact_id string

Example: architecto

dob string

Fromat: Y-m-d Example: 2000-06-13

custom_field1 string

Example: architecto

custom_field2 string

Example: architecto

custom_field3 string

Example: architecto

custom_field4 string

Example: architecto

email string

Example: gbailey@example.net

shipping_address string

Example: architecto

position string

Example: architecto

opening_balance number

Example: 10.3

source_id integer

Id of the source. Applicable only if the type is lead Example: 16

life_stage_id integer

Id of the Life stage. Applicable only if the type is lead Example: 16

assigned_to string[]

Ids of the users the lead is assigned to. Applicable only if the type is lead

Example request

curl --request PUT \
    "https://gulfpos.com/connector/api/contactapi/architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"customer\",
    \"supplier_business_name\": \"architecto\",
    \"prefix\": \"architecto\",
    \"first_name\": \"architecto\",
    \"middle_name\": \"architecto\",
    \"last_name\": \"architecto\",
    \"tax_number\": \"488744dwd\",
    \"pay_term_number\": 3,
    \"pay_term_type\": \"months\",
    \"mobile\": \"8795461009\",
    \"landline\": \"65484-848-848\",
    \"alternate_number\": \"9898795220\",
    \"address_line_1\": \"architecto\",
    \"address_line_2\": \"architecto\",
    \"city\": \"architecto\",
    \"state\": \"architecto\",
    \"country\": \"architecto\",
    \"zip_code\": \"architecto\",
    \"customer_group_id\": \"architecto\",
    \"contact_id\": \"architecto\",
    \"dob\": \"2000-06-13\",
    \"custom_field1\": \"architecto\",
    \"custom_field2\": \"architecto\",
    \"custom_field3\": \"architecto\",
    \"custom_field4\": \"architecto\",
    \"email\": \"gbailey@example.net\",
    \"shipping_address\": \"architecto\",
    \"position\": \"architecto\",
    \"opening_balance\": 10.3,
    \"source_id\": 16,
    \"life_stage_id\": 16,
    \"assigned_to\": [
        \"architecto\"
    ]
}"

const url = new URL(
    "https://gulfpos.com/connector/api/contactapi/architecto"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "customer",
    "supplier_business_name": "architecto",
    "prefix": "architecto",
    "first_name": "architecto",
    "middle_name": "architecto",
    "last_name": "architecto",
    "tax_number": "488744dwd",
    "pay_term_number": 3,
    "pay_term_type": "months",
    "mobile": "8795461009",
    "landline": "65484-848-848",
    "alternate_number": "9898795220",
    "address_line_1": "architecto",
    "address_line_2": "architecto",
    "city": "architecto",
    "state": "architecto",
    "country": "architecto",
    "zip_code": "architecto",
    "customer_group_id": "architecto",
    "contact_id": "architecto",
    "dob": "2000-06-13",
    "custom_field1": "architecto",
    "custom_field2": "architecto",
    "custom_field3": "architecto",
    "custom_field4": "architecto",
    "email": "gbailey@example.net",
    "shipping_address": "architecto",
    "position": "architecto",
    "opening_balance": 10.3,
    "source_id": 16,
    "life_stage_id": 16,
    "assigned_to": [
        "architecto"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/contactapi/architecto';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => 'customer',
            'supplier_business_name' => 'architecto',
            'prefix' => 'architecto',
            'first_name' => 'architecto',
            'middle_name' => 'architecto',
            'last_name' => 'architecto',
            'tax_number' => '488744dwd',
            'pay_term_number' => 3.0,
            'pay_term_type' => 'months',
            'mobile' => '8795461009',
            'landline' => '65484-848-848',
            'alternate_number' => '9898795220',
            'address_line_1' => 'architecto',
            'address_line_2' => 'architecto',
            'city' => 'architecto',
            'state' => 'architecto',
            'country' => 'architecto',
            'zip_code' => 'architecto',
            'customer_group_id' => 'architecto',
            'contact_id' => 'architecto',
            'dob' => '2000-06-13',
            'custom_field1' => 'architecto',
            'custom_field2' => 'architecto',
            'custom_field3' => 'architecto',
            'custom_field4' => 'architecto',
            'email' => 'gbailey@example.net',
            'shipping_address' => 'architecto',
            'position' => 'architecto',
            'opening_balance' => 10.3,
            'source_id' => 16,
            'life_stage_id' => 16,
            'assigned_to' => ['architecto'],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/contactapi/architecto'
payload = {
    "type": "customer",
    "supplier_business_name": "architecto",
    "prefix": "architecto",
    "first_name": "architecto",
    "middle_name": "architecto",
    "last_name": "architecto",
    "tax_number": "488744dwd",
    "pay_term_number": 3,
    "pay_term_type": "months",
    "mobile": "8795461009",
    "landline": "65484-848-848",
    "alternate_number": "9898795220",
    "address_line_1": "architecto",
    "address_line_2": "architecto",
    "city": "architecto",
    "state": "architecto",
    "country": "architecto",
    "zip_code": "architecto",
    "customer_group_id": "architecto",
    "contact_id": "architecto",
    "dob": "2000-06-13",
    "custom_field1": "architecto",
    "custom_field2": "architecto",
    "custom_field3": "architecto",
    "custom_field4": "architecto",
    "email": "gbailey@example.net",
    "shipping_address": "architecto",
    "position": "architecto",
    "opening_balance": 10.3,
    "source_id": 16,
    "life_stage_id": 16,
    "assigned_to": [
        "architecto"
    ]
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response

Response 200

{
    "data": {
        "id": 21,
        "business_id": 1,
        "type": "customer",
        "supplier_business_name": null,
        "name": "created from api",
        "prefix": null,
        "first_name": "created from api",
        "middle_name": null,
        "last_name": null,
        "email": null,
        "contact_id": "CO0009",
        "contact_status": "active",
        "tax_number": null,
        "city": null,
        "state": null,
        "country": null,
        "address_line_1": "test address",
        "address_line_2": null,
        "zip_code": "54878787",
        "dob": "2000-06-13",
        "mobile": "8754154872154",
        "landline": null,
        "alternate_number": null,
        "pay_term_number": null,
        "pay_term_type": null,
        "credit_limit": null,
        "created_by": 1,
        "balance": "0.0000",
        "total_rp": 0,
        "total_rp_used": 0,
        "total_rp_expired": 0,
        "is_default": 0,
        "shipping_address": null,
        "position": null,
        "customer_group_id": null,
        "crm_source": null,
        "crm_life_stage": null,
        "custom_field1": null,
        "custom_field2": null,
        "custom_field3": null,
        "custom_field4": null,
        "deleted_at": null,
        "created_at": "2020-08-10 10:41:42",
        "updated_at": "2020-08-10 10:41:42",
        "remember_token": null,
        "password": null
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

URL Parameters

id *

contact *

Body Parameters

type string optional

Type of contact (supplier, customer, both) Example: customer

supplier_business_name string optional

required* Required if type is supplier Example: architecto

prefix string optional

Prefix for the name of the contact Example: architecto

first_name string

Name of the contact Example: architecto

middle_name string optional

Example: architecto

last_name string optional

Example: architecto

tax_number string optional

Example: 488744dwd

pay_term_number number optional

Example: 3

pay_term_type string optional

(months ,days) Example: months

mobile string

Example: 8795461009

landline string optional

Example: 65484-848-848

alternate_number string optional

Example: 9898795220

address_line_1 string optional

Example: architecto

address_line_2 string optional

Example: architecto

city string optional

Example: architecto

state string optional

Example: architecto

country string optional

Example: architecto

zip_code string optional

Example: architecto

customer_group_id string optional

Example: architecto

contact_id string optional

Example: architecto

dob string optional

Fromat: Y-m-d Example: 2000-06-13

custom_field1 string optional

Example: architecto

custom_field2 string optional

Example: architecto

custom_field3 string optional

Example: architecto

custom_field4 string optional

Example: architecto

email string optional

Example: gbailey@example.net

shipping_address string optional

Example: architecto

position string optional

Example: architecto

opening_balance number optional

Example: 10.3

source_id integer optional

Id of the source. Applicable only if the type is lead Example: 16

life_stage_id integer optional

Id of the Life stage. Applicable only if the type is lead Example: 16

assigned_to string[] optional

Ids of the users the lead is assigned to. Applicable only if the type is lead

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST connector/api/contactapi-payment

Contact payment

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Body Parameters

contact_id integer

id of the contact Example: 17

amount number

amount of the payment Example: 453.13

method string

payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') Example: cash

paid_on string

transaction date format:Y-m-d H:i:s, Example: 2020-07-22 15:48:29

account_id integer

account id Example: 16

card_number string

Example: architecto

card_holder_name string

Example: architecto

card_transaction_number string

Example: architecto

card_type string

Example: architecto

card_month string

Example: architecto

card_year string

Example: architecto

card_security string

Example: architecto

transaction_no_1 string

Example: architecto

transaction_no_2 string

Example: architecto

transaction_no_3 string

Example: architecto

cheque_number string

Example: architecto

bank_account_number string

Example: architecto

note string

payment note Example: architecto

Example request

curl --request POST \
    "https://gulfpos.com/connector/api/contactapi-payment" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contact_id\": 17,
    \"amount\": 453.13,
    \"method\": \"cash\",
    \"paid_on\": \"2020-07-22 15:48:29\",
    \"account_id\": 16,
    \"card_number\": \"architecto\",
    \"card_holder_name\": \"architecto\",
    \"card_transaction_number\": \"architecto\",
    \"card_type\": \"architecto\",
    \"card_month\": \"architecto\",
    \"card_year\": \"architecto\",
    \"card_security\": \"architecto\",
    \"transaction_no_1\": \"architecto\",
    \"transaction_no_2\": \"architecto\",
    \"transaction_no_3\": \"architecto\",
    \"cheque_number\": \"architecto\",
    \"bank_account_number\": \"architecto\",
    \"note\": \"architecto\"
}"

const url = new URL(
    "https://gulfpos.com/connector/api/contactapi-payment"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "contact_id": 17,
    "amount": 453.13,
    "method": "cash",
    "paid_on": "2020-07-22 15:48:29",
    "account_id": 16,
    "card_number": "architecto",
    "card_holder_name": "architecto",
    "card_transaction_number": "architecto",
    "card_type": "architecto",
    "card_month": "architecto",
    "card_year": "architecto",
    "card_security": "architecto",
    "transaction_no_1": "architecto",
    "transaction_no_2": "architecto",
    "transaction_no_3": "architecto",
    "cheque_number": "architecto",
    "bank_account_number": "architecto",
    "note": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/contactapi-payment';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'contact_id' => 17,
            'amount' => 453.13,
            'method' => 'cash',
            'paid_on' => '2020-07-22 15:48:29',
            'account_id' => 16,
            'card_number' => 'architecto',
            'card_holder_name' => 'architecto',
            'card_transaction_number' => 'architecto',
            'card_type' => 'architecto',
            'card_month' => 'architecto',
            'card_year' => 'architecto',
            'card_security' => 'architecto',
            'transaction_no_1' => 'architecto',
            'transaction_no_2' => 'architecto',
            'transaction_no_3' => 'architecto',
            'cheque_number' => 'architecto',
            'bank_account_number' => 'architecto',
            'note' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/contactapi-payment'
payload = {
    "contact_id": 17,
    "amount": 453.13,
    "method": "cash",
    "paid_on": "2020-07-22 15:48:29",
    "account_id": 16,
    "card_number": "architecto",
    "card_holder_name": "architecto",
    "card_transaction_number": "architecto",
    "card_type": "architecto",
    "card_month": "architecto",
    "card_year": "architecto",
    "card_security": "architecto",
    "transaction_no_1": "architecto",
    "transaction_no_2": "architecto",
    "transaction_no_3": "architecto",
    "cheque_number": "architecto",
    "bank_account_number": "architecto",
    "note": "architecto"
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response

Response 200

{
    "data": {
        "amount": "20",
        "method": "cash",
        "paid_on": "2020-07-22 15:48:29",
        "created_by": 1,
        "payment_for": "19",
        "business_id": 1,
        "is_advance": 1,
        "payment_ref_no": "SP2020/0127",
        "document": null,
        "updated_at": "2020-07-22 15:48:29",
        "created_at": "2020-07-22 15:48:29",
        "id": 215
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Body Parameters

contact_id integer

id of the contact Example: 17

amount number

amount of the payment Example: 453.13

method string optional

payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') Example: cash

paid_on string optional

transaction date format:Y-m-d H:i:s, Example: 2020-07-22 15:48:29

account_id integer optional

account id Example: 16

card_number string optional

Example: architecto

card_holder_name string optional

Example: architecto

card_transaction_number string optional

Example: architecto

card_type string optional

Example: architecto

card_month string optional

Example: architecto

card_year string optional

Example: architecto

card_security string optional

Example: architecto

transaction_no_1 string optional

Example: architecto

transaction_no_2 string optional

Example: architecto

transaction_no_3 string optional

Example: architecto

cheque_number string optional

Example: architecto

bank_account_number string optional

Example: architecto

note string optional

payment note Example: architecto

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/new_contactapi

New List contact

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Query Parameters

Name	Type	Status	Description
`type`	string	required	Type of contact (supplier, customer) Example: `architecto`
`customer_group_id`	string	optional	id of the customer group Example: `architecto`
`custom_field_1`	string	optional	Custom field 1 of the contact Example: `architecto`
`contact_ids`	string	optional	comma separated ids of contacts Example: `2,3`
`name`	string	optional	Search term for contact name Example: `architecto`
`biz_name`	string	optional	Search term for contact's business name Example: `architecto`
`mobile_num`	integer	optional	Search term for contact's mobile number Example: `16`
`contact_id`	string	optional	Search term for contact's contact_id. Ex(CO0005) Example: `architecto`
`order_by`	string	optional	Column name to sort the result, Column: name, supplier_business_name Example: `architecto`
`direction`	string	optional	Direction to sort the result, Direction: desc, asc Example: `architecto`
`per_page`	integer	optional	Total records per page. default: 10, Set -1 for no pagination Example: `10`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/new_contactapi?type=architecto&customer_group_id=architecto&custom_field_1=architecto&contact_ids=2%2C3&name=architecto&biz_name=architecto&mobile_num=16&contact_id=architecto&order_by=architecto&direction=architecto&per_page=10" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/new_contactapi"
);

const params = {
    "type": "architecto",
    "customer_group_id": "architecto",
    "custom_field_1": "architecto",
    "contact_ids": "2,3",
    "name": "architecto",
    "biz_name": "architecto",
    "mobile_num": "16",
    "contact_id": "architecto",
    "order_by": "architecto",
    "direction": "architecto",
    "per_page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/new_contactapi';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'type' => 'architecto',
            'customer_group_id' => 'architecto',
            'custom_field_1' => 'architecto',
            'contact_ids' => '2,3',
            'name' => 'architecto',
            'biz_name' => 'architecto',
            'mobile_num' => '16',
            'contact_id' => 'architecto',
            'order_by' => 'architecto',
            'direction' => 'architecto',
            'per_page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/new_contactapi'
params = {
  'type': 'architecto',
  'customer_group_id': 'architecto',
  'custom_field_1': 'architecto',
  'contact_ids': '2,3',
  'name': 'architecto',
  'biz_name': 'architecto',
  'mobile_num': '16',
  'contact_id': 'architecto',
  'order_by': 'architecto',
  'direction': 'architecto',
  'per_page': '10',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 18,
            "business_id": 1,
            "type": "customer",
            "name": "Mr. Rohit Kumar Agrawalla",
            "prefix": "Mr.",
            "first_name": "Rohit",
            "middle_name": "Kumar",
            "last_name": "Agrawalla",
            "email": null,
            "contact_status": "active",
            "mobile": "8596859647",
            "credit_limit": null,
            "converted_by": null,
            "converted_on": null,
            "balance": "40.0000",
            "total_rp": 0,
            "total_rp_used": 0,
            "total_rp_expired": 0,
            "customer_group_id": 1,
            "crm_source": null,
            "crm_life_stage": null,
            "custom_field1": null,
            "custom_field2": null,
            "custom_field3": null,
            "custom_field4": null,
            "custom_field5": null,
            "custom_field6": null,
            "custom_field7": null,
            "custom_field8": null,
            "custom_field9": null,
            "custom_field10": null,
            "remember_token": null,
            "password": null
        }
    ],
    "links": {
        "first": "http://local.pos.com/connector/api/new_contactapi?customer_group_id=1&page=1",
        "last": "http://local.pos.com/connector/api/new_contactapi?customer_group_id=1&page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://local.pos.com/connector/api/new_contactapi",
        "per_page": 10,
        "to": 1,
        "total": 1
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Query Parameters

type *

customer_group_id

custom_field_1

contact_ids

name

biz_name

mobile_num

contact_id

order_by

direction

per_page

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/product

List products

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Query Parameters

Name	Type	Status	Description
`order_by`	string	optional	Values: product_name or newest Example: `architecto`
`order_direction`	string	optional	Values: asc or desc Example: `architecto`
`brand_id`	string	optional	comma separated ids of one or multiple brands Example: `architecto`
`category_id`	string	optional	comma separated ids of one or multiple category Example: `architecto`
`sub_category_id`	string	optional	comma separated ids of one or multiple sub-category Example: `architecto`
`location_id`	string	optional	Example: `1`
`selling_price_group`	string	optional	(1, 0) Example: `architecto`
`send_lot_detail`	string	optional	Send lot details in each variation location details(1, 0) Example: `architecto`
`name`	string	optional	Search term for product name Example: `architecto`
`sku`	string	optional	Search term for product sku Example: `architecto`
`per_page`	integer	optional	Total records per page. default: 10, Set -1 for no pagination Example: `10`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/product?order_by=architecto&order_direction=architecto&brand_id=architecto&category_id=architecto&sub_category_id=architecto&location_id=1&selling_price_group=architecto&send_lot_detail=architecto&name=architecto&sku=architecto&per_page=10" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/product"
);

const params = {
    "order_by": "architecto",
    "order_direction": "architecto",
    "brand_id": "architecto",
    "category_id": "architecto",
    "sub_category_id": "architecto",
    "location_id": "1",
    "selling_price_group": "architecto",
    "send_lot_detail": "architecto",
    "name": "architecto",
    "sku": "architecto",
    "per_page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/product';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'order_by' => 'architecto',
            'order_direction' => 'architecto',
            'brand_id' => 'architecto',
            'category_id' => 'architecto',
            'sub_category_id' => 'architecto',
            'location_id' => '1',
            'selling_price_group' => 'architecto',
            'send_lot_detail' => 'architecto',
            'name' => 'architecto',
            'sku' => 'architecto',
            'per_page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/product'
params = {
  'order_by': 'architecto',
  'order_direction': 'architecto',
  'brand_id': 'architecto',
  'category_id': 'architecto',
  'sub_category_id': 'architecto',
  'location_id': '1',
  'selling_price_group': 'architecto',
  'send_lot_detail': 'architecto',
  'name': 'architecto',
  'sku': 'architecto',
  'per_page': '10',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "name": "Men's Reverse Fleece Crew",
            "business_id": 1,
            "type": "single",
            "sub_unit_ids": null,
            "enable_stock": 1,
            "alert_quantity": "5.0000",
            "sku": "AS0001",
            "barcode_type": "C128",
            "expiry_period": null,
            "expiry_period_type": null,
            "enable_sr_no": 0,
            "weight": null,
            "product_custom_field1": null,
            "product_custom_field2": null,
            "product_custom_field3": null,
            "product_custom_field4": null,
            "image": null,
            "woocommerce_media_id": null,
            "product_description": null,
            "created_by": 1,
            "warranty_id": null,
            "is_inactive": 0,
            "repair_model_id": null,
            "not_for_selling": 0,
            "ecom_shipping_class_id": null,
            "ecom_active_in_store": 1,
            "woocommerce_product_id": 356,
            "woocommerce_disable_sync": 0,
            "image_url": "http://local.pos.com/img/default.png",
            "product_variations": [
                {
                    "id": 1,
                    "variation_template_id": null,
                    "name": "DUMMY",
                    "product_id": 1,
                    "is_dummy": 1,
                    "created_at": "2018-01-03 21:29:08",
                    "updated_at": "2018-01-03 21:29:08",
                    "variations": [
                        {
                            "id": 1,
                            "name": "DUMMY",
                            "product_id": 1,
                            "sub_sku": "AS0001",
                            "product_variation_id": 1,
                            "woocommerce_variation_id": null,
                            "variation_value_id": null,
                            "default_purchase_price": "130.0000",
                            "dpp_inc_tax": "143.0000",
                            "profit_percent": "0.0000",
                            "default_sell_price": "130.0000",
                            "sell_price_inc_tax": "143.0000",
                            "created_at": "2018-01-03 21:29:08",
                            "updated_at": "2020-06-09 00:23:22",
                            "deleted_at": null,
                            "combo_variations": null,
                            "variation_location_details": [
                                {
                                    "id": 56,
                                    "product_id": 1,
                                    "product_variation_id": 1,
                                    "variation_id": 1,
                                    "location_id": 1,
                                    "qty_available": "20.0000",
                                    "created_at": "2020-06-08 23:46:40",
                                    "updated_at": "2020-06-08 23:46:40"
                                }
                            ],
                            "media": [
                                {
                                    "id": 1,
                                    "business_id": 1,
                                    "file_name": "1591686466_978227300_nn.jpeg",
                                    "description": null,
                                    "uploaded_by": 9,
                                    "model_type": "App\\Variation",
                                    "woocommerce_media_id": null,
                                    "model_id": 1,
                                    "created_at": "2020-06-09 00:07:46",
                                    "updated_at": "2020-06-09 00:07:46",
                                    "display_name": "nn.jpeg",
                                    "display_url": "http://local.pos.com/uploads/media/1591686466_978227300_nn.jpeg"
                                }
                            ],
                            "discounts": [
                                {
                                    "id": 2,
                                    "name": "FLAT 10%",
                                    "business_id": 1,
                                    "brand_id": null,
                                    "category_id": null,
                                    "location_id": 1,
                                    "priority": 2,
                                    "discount_type": "fixed",
                                    "discount_amount": "5.0000",
                                    "starts_at": "2021-09-01 11:45:00",
                                    "ends_at": "2021-09-30 11:45:00",
                                    "is_active": 1,
                                    "spg": null,
                                    "applicable_in_cg": 1,
                                    "created_at": "2021-09-01 11:46:00",
                                    "updated_at": "2021-09-01 12:12:55",
                                    "formated_starts_at": " 11:45",
                                    "formated_ends_at": " 11:45"
                                }
                            ],
                            "selling_price_group": [
                                {
                                    "id": 2,
                                    "variation_id": 1,
                                    "price_group_id": 1,
                                    "price_inc_tax": "140.0000",
                                    "created_at": "2020-06-09 00:23:31",
                                    "updated_at": "2020-06-09 00:23:31"
                                }
                            ]
                        }
                    ]
                }
            ],
            "brand": {
                "id": 1,
                "business_id": 1,
                "name": "Levis",
                "description": null,
                "created_by": 1,
                "deleted_at": null,
                "created_at": "2018-01-03 21:19:47",
                "updated_at": "2018-01-03 21:19:47"
            },
            "unit": {
                "id": 1,
                "business_id": 1,
                "actual_name": "Pieces",
                "short_name": "Pc(s)",
                "allow_decimal": 0,
                "base_unit_id": null,
                "base_unit_multiplier": null,
                "created_by": 1,
                "deleted_at": null,
                "created_at": "2018-01-03 15:15:20",
                "updated_at": "2018-01-03 15:15:20"
            },
            "category": {
                "id": 1,
                "name": "Men's",
                "business_id": 1,
                "short_code": null,
                "parent_id": 0,
                "created_by": 1,
                "category_type": "product",
                "description": null,
                "slug": null,
                "woocommerce_cat_id": null,
                "deleted_at": null,
                "created_at": "2018-01-03 21:06:34",
                "updated_at": "2018-01-03 21:06:34"
            },
            "sub_category": {
                "id": 5,
                "name": "Shirts",
                "business_id": 1,
                "short_code": null,
                "parent_id": 1,
                "created_by": 1,
                "category_type": "product",
                "description": null,
                "slug": null,
                "woocommerce_cat_id": null,
                "deleted_at": null,
                "created_at": "2018-01-03 21:08:18",
                "updated_at": "2018-01-03 21:08:18"
            },
            "product_tax": {
                "id": 1,
                "business_id": 1,
                "name": "VAT@10%",
                "amount": 10,
                "is_tax_group": 0,
                "created_by": 1,
                "woocommerce_tax_rate_id": null,
                "deleted_at": null,
                "created_at": "2018-01-04 02:40:07",
                "updated_at": "2018-01-04 02:40:07"
            },
            "product_locations": [
                {
                    "id": 1,
                    "business_id": 1,
                    "location_id": null,
                    "name": "Awesome Shop",
                    "landmark": "Linking Street",
                    "country": "USA",
                    "state": "Arizona",
                    "city": "Phoenix",
                    "zip_code": "85001",
                    "invoice_scheme_id": 1,
                    "invoice_layout_id": 1,
                    "selling_price_group_id": null,
                    "print_receipt_on_invoice": 1,
                    "receipt_printer_type": "browser",
                    "printer_id": null,
                    "mobile": null,
                    "alternate_number": null,
                    "email": null,
                    "website": null,
                    "featured_products": [
                        "5",
                        "71"
                    ],
                    "is_active": 1,
                    "default_payment_accounts": "{\"cash\":{\"is_enabled\":\"1\",\"account\":\"1\"},\"card\":{\"is_enabled\":\"1\",\"account\":\"3\"},\"cheque\":{\"is_enabled\":\"1\",\"account\":\"2\"},\"bank_transfer\":{\"is_enabled\":\"1\",\"account\":\"1\"},\"other\":{\"is_enabled\":\"1\",\"account\":\"3\"},\"custom_pay_1\":{\"is_enabled\":\"1\",\"account\":\"1\"},\"custom_pay_2\":{\"is_enabled\":\"1\",\"account\":\"2\"},\"custom_pay_3\":{\"is_enabled\":\"1\",\"account\":\"3\"}}",
                    "custom_field1": null,
                    "custom_field2": null,
                    "custom_field3": null,
                    "custom_field4": null,
                    "deleted_at": null,
                    "created_at": "2018-01-04 02:15:20",
                    "updated_at": "2020-06-09 01:07:05",
                    "pivot": {
                        "product_id": 2,
                        "location_id": 1
                    }
                }
            ]
        }
    ],
    "links": {
        "first": "http://local.pos.com/connector/api/product?page=1",
        "last": "http://local.pos.com/connector/api/product?page=32",
        "prev": null,
        "next": "http://local.pos.com/connector/api/product?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "http://local.pos.com/connector/api/product",
        "per_page": 10,
        "to": 10
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Query Parameters

order_by

order_direction

brand_id

category_id

sub_category_id

location_id

selling_price_group

send_lot_detail

name

sku

per_page

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST connector/api/product

Create product

REQUIRES AUTHENTICATION

Creates a product with its variations, locations, optional rack details, media, module fields, and opening stock. User must have the product.create permission. If opening_stock is sent, user must also have the product.opening_stock permission.

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`multipart/form-data`
`Accept`	`application/json`

Body Parameters

name string

Product name. Example: Test product

alternative_name string

Product alternative name. Example: Producto de prueba

brand_id integer

Brand id. Example: 1

unit_id integer

Unit id. Example: 1

category_id integer

Product category id. Example: 1

sub_category_id integer

Product sub-category id. Example: 2

tax integer

Tax rate id. Example: 1

tax_type string

Tax type: inclusive or exclusive. Example: exclusive

type string

Product type: single, variable or combo. Example: single

barcode_type string

Barcode type. Example: C128

sku string

Product SKU. Leave empty to auto generate. Example: architecto

enable_stock integer

Enable stock management: 1 or 0. Example: 1

alert_quantity numeric

Stock alert quantity. Example: 5

not_for_selling integer

Not for selling: 1 or 0. Example: 0

enable_sr_no integer

Enable IMEI/serial number: 1 or 0. Example: 0

weight string

Product weight. Example: 1.25

product_description string

Product description. Example: Created from connector API

product_custom_field1 string

Custom field 1. Example: Shelf A

product_custom_field2 string

Custom field 2. Example: Batch 2026

product_custom_field3 string

Custom field 3. Example: Online

product_custom_field4 string

Custom field 4. Example: Imported

product_locations string[]

Product location ids to assign, for example [1, 2].

product_racks string[]

Rack/row/position details keyed by location id. Send values like location 1 => rack R1, row A, position P1.

image file

Product image upload. Example: /tmp/php9ptr58j017tleVL0kaA

product_brochure file

Product brochure/media upload. Example: /tmp/phpnfpummbpmp6i44O9mlr

single_dpp numeric

Required when type is single. Default purchase price excluding tax. Example: 100

single_dpp_inc_tax numeric

Required when type is single. Default purchase price including tax. Example: 100

profit_percent numeric

Required when type is single. Profit margin percentage. Example: 25

single_dsp numeric

Required when type is single. Default selling price excluding tax. Example: 125

single_dsp_inc_tax numeric

Required when type is single. Default selling price including tax. Example: 125

product_variation string[]

Required when type is variable. Variation groups and variation rows.

* object

name string

Variation group/template name. Example: Color

variation_template_id integer

Existing variation template id. Example: 1

opening_stock_location integer

Location id for inline variable opening stock. Example: 1

variations string[]

Variation rows.

* object

value string

Variation value/name. Example: Red

sub_sku string

Variation SKU. Leave empty to auto generate. Example: SKU-RED

default_purchase_price numeric

Variation purchase price excluding tax. Example: 100

dpp_inc_tax numeric

Variation purchase price including tax. Example: 100

profit_percent numeric

Variation profit margin percentage. Example: 25

default_sell_price numeric

Variation selling price excluding tax. Example: 125

sell_price_inc_tax numeric

Variation selling price including tax. Example: 125

opening_stock numeric

Inline opening stock quantity for this variation. Example: 10

opening_stock_exp_date string

Inline opening stock expiry date (Y-m-d, d-m-Y, or m-d-Y). Example: 31-12-2026

lot_number string

Inline opening stock lot number. Example: LOT-1

composition_variation_id string[]

Required when type is combo. Component variation ids, for example [10, 11].

quantity string[]

Required when type is combo. Component quantities matching composition_variation_id, for example [2, 1].

unit string[]

Required when type is combo. Component unit ids matching composition_variation_id, for example [1, 1].

item_level_purchase_price_total numeric

Required when type is combo. Combo purchase price excluding tax. Example: 200

purchase_price_inc_tax numeric

Required when type is combo. Combo purchase price including tax. Example: 200

selling_price numeric

Required when type is combo. Combo selling price excluding tax. Example: 250

selling_price_inc_tax numeric

Required when type is combo. Combo selling price including tax. Example: 250

opening_stock string[]

Optional opening stock keyed by location id. For single/combo products, each location value contains quantity and purchase_price. For variable products, each location value must be keyed by variation sub_sku/name or contain rows with sub_sku/variation_name.

Example request

curl --request POST \
    "https://gulfpos.com/connector/api/product" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=Test product"\
    --form "alternative_name=Producto de prueba"\
    --form "brand_id=1"\
    --form "unit_id=1"\
    --form "category_id=1"\
    --form "sub_category_id=2"\
    --form "tax=1"\
    --form "tax_type=exclusive"\
    --form "type=single"\
    --form "barcode_type=C128"\
    --form "sku=architecto"\
    --form "enable_stock=1"\
    --form "alert_quantity=5"\
    --form "not_for_selling=0"\
    --form "enable_sr_no=0"\
    --form "weight=1.25"\
    --form "product_description=Created from connector API"\
    --form "product_custom_field1=Shelf A"\
    --form "product_custom_field2=Batch 2026"\
    --form "product_custom_field3=Online"\
    --form "product_custom_field4=Imported"\
    --form "product_locations[]=architecto"\
    --form "product_racks[]=architecto"\
    --form "single_dpp=100"\
    --form "single_dpp_inc_tax=100"\
    --form "profit_percent=25"\
    --form "single_dsp=125"\
    --form "single_dsp_inc_tax=125"\
    --form "product_variation[]=architecto"\
    --form "composition_variation_id[]=architecto"\
    --form "quantity[]=architecto"\
    --form "unit[]=architecto"\
    --form "item_level_purchase_price_total=200"\
    --form "purchase_price_inc_tax=200"\
    --form "selling_price=250"\
    --form "selling_price_inc_tax=250"\
    --form "opening_stock[]=architecto"\
    --form "image=@/tmp/php9ptr58j017tleVL0kaA" \
    --form "product_brochure=@/tmp/phpnfpummbpmp6i44O9mlr"

const url = new URL(
    "https://gulfpos.com/connector/api/product"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'Test product');
body.append('alternative_name', 'Producto de prueba');
body.append('brand_id', '1');
body.append('unit_id', '1');
body.append('category_id', '1');
body.append('sub_category_id', '2');
body.append('tax', '1');
body.append('tax_type', 'exclusive');
body.append('type', 'single');
body.append('barcode_type', 'C128');
body.append('sku', 'architecto');
body.append('enable_stock', '1');
body.append('alert_quantity', '5');
body.append('not_for_selling', '0');
body.append('enable_sr_no', '0');
body.append('weight', '1.25');
body.append('product_description', 'Created from connector API');
body.append('product_custom_field1', 'Shelf A');
body.append('product_custom_field2', 'Batch 2026');
body.append('product_custom_field3', 'Online');
body.append('product_custom_field4', 'Imported');
body.append('product_locations[]', 'architecto');
body.append('product_racks[]', 'architecto');
body.append('single_dpp', '100');
body.append('single_dpp_inc_tax', '100');
body.append('profit_percent', '25');
body.append('single_dsp', '125');
body.append('single_dsp_inc_tax', '125');
body.append('product_variation[]', 'architecto');
body.append('composition_variation_id[]', 'architecto');
body.append('quantity[]', 'architecto');
body.append('unit[]', 'architecto');
body.append('item_level_purchase_price_total', '200');
body.append('purchase_price_inc_tax', '200');
body.append('selling_price', '250');
body.append('selling_price_inc_tax', '250');
body.append('opening_stock[]', 'architecto');
body.append('image', document.querySelector('input[name="image"]').files[0]);
body.append('product_brochure', document.querySelector('input[name="product_brochure"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/product';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'Test product'
            ],
            [
                'name' => 'alternative_name',
                'contents' => 'Producto de prueba'
            ],
            [
                'name' => 'brand_id',
                'contents' => '1'
            ],
            [
                'name' => 'unit_id',
                'contents' => '1'
            ],
            [
                'name' => 'category_id',
                'contents' => '1'
            ],
            [
                'name' => 'sub_category_id',
                'contents' => '2'
            ],
            [
                'name' => 'tax',
                'contents' => '1'
            ],
            [
                'name' => 'tax_type',
                'contents' => 'exclusive'
            ],
            [
                'name' => 'type',
                'contents' => 'single'
            ],
            [
                'name' => 'barcode_type',
                'contents' => 'C128'
            ],
            [
                'name' => 'sku',
                'contents' => 'architecto'
            ],
            [
                'name' => 'enable_stock',
                'contents' => '1'
            ],
            [
                'name' => 'alert_quantity',
                'contents' => '5'
            ],
            [
                'name' => 'not_for_selling',
                'contents' => '0'
            ],
            [
                'name' => 'enable_sr_no',
                'contents' => '0'
            ],
            [
                'name' => 'weight',
                'contents' => '1.25'
            ],
            [
                'name' => 'product_description',
                'contents' => 'Created from connector API'
            ],
            [
                'name' => 'product_custom_field1',
                'contents' => 'Shelf A'
            ],
            [
                'name' => 'product_custom_field2',
                'contents' => 'Batch 2026'
            ],
            [
                'name' => 'product_custom_field3',
                'contents' => 'Online'
            ],
            [
                'name' => 'product_custom_field4',
                'contents' => 'Imported'
            ],
            [
                'name' => 'product_locations[]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'product_racks[]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'single_dpp',
                'contents' => '100'
            ],
            [
                'name' => 'single_dpp_inc_tax',
                'contents' => '100'
            ],
            [
                'name' => 'profit_percent',
                'contents' => '25'
            ],
            [
                'name' => 'single_dsp',
                'contents' => '125'
            ],
            [
                'name' => 'single_dsp_inc_tax',
                'contents' => '125'
            ],
            [
                'name' => 'product_variation[]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'composition_variation_id[]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'quantity[]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'unit[]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'item_level_purchase_price_total',
                'contents' => '200'
            ],
            [
                'name' => 'purchase_price_inc_tax',
                'contents' => '200'
            ],
            [
                'name' => 'selling_price',
                'contents' => '250'
            ],
            [
                'name' => 'selling_price_inc_tax',
                'contents' => '250'
            ],
            [
                'name' => 'opening_stock[]',
                'contents' => 'architecto'
            ],
            [
                'name' => 'image',
                'contents' => fopen('/tmp/php9ptr58j017tleVL0kaA', 'r')
            ],
            [
                'name' => 'product_brochure',
                'contents' => fopen('/tmp/phpnfpummbpmp6i44O9mlr', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/product'
files = {
  'name': (None, 'Test product'),
  'alternative_name': (None, 'Producto de prueba'),
  'brand_id': (None, '1'),
  'unit_id': (None, '1'),
  'category_id': (None, '1'),
  'sub_category_id': (None, '2'),
  'tax': (None, '1'),
  'tax_type': (None, 'exclusive'),
  'type': (None, 'single'),
  'barcode_type': (None, 'C128'),
  'sku': (None, 'architecto'),
  'enable_stock': (None, '1'),
  'alert_quantity': (None, '5'),
  'not_for_selling': (None, '0'),
  'enable_sr_no': (None, '0'),
  'weight': (None, '1.25'),
  'product_description': (None, 'Created from connector API'),
  'product_custom_field1': (None, 'Shelf A'),
  'product_custom_field2': (None, 'Batch 2026'),
  'product_custom_field3': (None, 'Online'),
  'product_custom_field4': (None, 'Imported'),
  'product_locations[]': (None, 'architecto'),
  'product_racks[]': (None, 'architecto'),
  'single_dpp': (None, '100'),
  'single_dpp_inc_tax': (None, '100'),
  'profit_percent': (None, '25'),
  'single_dsp': (None, '125'),
  'single_dsp_inc_tax': (None, '125'),
  'product_variation[]': (None, 'architecto'),
  'composition_variation_id[]': (None, 'architecto'),
  'quantity[]': (None, 'architecto'),
  'unit[]': (None, 'architecto'),
  'item_level_purchase_price_total': (None, '200'),
  'purchase_price_inc_tax': (None, '200'),
  'selling_price': (None, '250'),
  'selling_price_inc_tax': (None, '250'),
  'opening_stock[]': (None, 'architecto'),
  'image': open('/tmp/php9ptr58j017tleVL0kaA', 'rb'),
  'product_brochure': open('/tmp/phpnfpummbpmp6i44O9mlr', 'rb')}
payload = {
    "name": "Test product",
    "alternative_name": "Producto de prueba",
    "brand_id": 1,
    "unit_id": 1,
    "category_id": 1,
    "sub_category_id": 2,
    "tax": 1,
    "tax_type": "exclusive",
    "type": "single",
    "barcode_type": "C128",
    "sku": "architecto",
    "enable_stock": 1,
    "alert_quantity": "5",
    "not_for_selling": 0,
    "enable_sr_no": 0,
    "weight": "1.25",
    "product_description": "Created from connector API",
    "product_custom_field1": "Shelf A",
    "product_custom_field2": "Batch 2026",
    "product_custom_field3": "Online",
    "product_custom_field4": "Imported",
    "product_locations": [
        "architecto"
    ],
    "product_racks": [
        "architecto"
    ],
    "single_dpp": "100",
    "single_dpp_inc_tax": "100",
    "profit_percent": "25",
    "single_dsp": "125",
    "single_dsp_inc_tax": "125",
    "product_variation": [
        "architecto"
    ],
    "composition_variation_id": [
        "architecto"
    ],
    "quantity": [
        "architecto"
    ],
    "unit": [
        "architecto"
    ],
    "item_level_purchase_price_total": "200",
    "purchase_price_inc_tax": "200",
    "selling_price": "250",
    "selling_price_inc_tax": "250",
    "opening_stock": [
        "architecto"
    ]
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, files=files)
response.json()

Example response

Response 201

{
    "data": {
        "id": 101,
        "name": "Test product",
        "business_id": 1,
        "type": "single",
        "enable_stock": 1,
        "sku": "AS0101",
        "barcode_type": "C128",
        "product_variations": [
            {
                "name": "DUMMY",
                "variations": [
                    {
                        "name": "DUMMY",
                        "sub_sku": "AS0101",
                        "default_purchase_price": "100.0000",
                        "sell_price_inc_tax": "125.0000",
                        "variation_location_details": [
                            {
                                "location_id": 1,
                                "qty_available": "10.0000"
                            }
                        ]
                    }
                ]
            }
        ],
        "product_locations": [
            {
                "id": 1,
                "name": "Main Location"
            }
        ]
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Body Parameters

name string

Product name. Example: Test product

alternative_name string optional

Product alternative name. Example: Producto de prueba

brand_id integer optional

Brand id. Example: 1

unit_id integer

Unit id. Example: 1

category_id integer optional

Product category id. Example: 1

sub_category_id integer optional

Product sub-category id. Example: 2

tax integer optional

Tax rate id. Example: 1

tax_type string optional

Tax type: inclusive or exclusive. Example: exclusive

type string

Product type: single, variable or combo. Example: single

barcode_type string

Barcode type. Example: C128

sku string optional

Product SKU. Leave empty to auto generate. Example: architecto

enable_stock integer optional

Enable stock management: 1 or 0. Example: 1

alert_quantity numeric optional

Stock alert quantity. Example: 5

not_for_selling integer optional

Not for selling: 1 or 0. Example: 0

enable_sr_no integer optional

Enable IMEI/serial number: 1 or 0. Example: 0

weight string optional

Product weight. Example: 1.25

product_description string optional

Product description. Example: Created from connector API

product_custom_field1 string optional

Custom field 1. Example: Shelf A

product_custom_field2 string optional

Custom field 2. Example: Batch 2026

product_custom_field3 string optional

Custom field 3. Example: Online

product_custom_field4 string optional

Custom field 4. Example: Imported

product_locations string[] optional

Product location ids to assign, for example [1, 2].

product_racks string[] optional

Rack/row/position details keyed by location id. Send values like location 1 => rack R1, row A, position P1.

image file optional

Product image upload. Example: /tmp/php9ptr58j017tleVL0kaA

product_brochure file optional

Product brochure/media upload. Example: /tmp/phpnfpummbpmp6i44O9mlr

single_dpp numeric optional

Required when type is single. Default purchase price excluding tax. Example: 100

single_dpp_inc_tax numeric optional

Required when type is single. Default purchase price including tax. Example: 100

profit_percent numeric optional

Required when type is single. Profit margin percentage. Example: 25

single_dsp numeric optional

Required when type is single. Default selling price excluding tax. Example: 125

single_dsp_inc_tax numeric optional

Required when type is single. Default selling price including tax. Example: 125

product_variation string[] optional

Required when type is variable. Variation groups and variation rows.

* object optional

name string optional

Variation group/template name. Example: Color

variation_template_id integer optional

Existing variation template id. Example: 1

opening_stock_location integer optional

Location id for inline variable opening stock. Example: 1

variations string[] optional

Variation rows.

* object optional

value string optional

Variation value/name. Example: Red

sub_sku string optional

Variation SKU. Leave empty to auto generate. Example: SKU-RED

default_purchase_price numeric optional

Variation purchase price excluding tax. Example: 100

dpp_inc_tax numeric optional

Variation purchase price including tax. Example: 100

profit_percent numeric optional

Variation profit margin percentage. Example: 25

default_sell_price numeric optional

Variation selling price excluding tax. Example: 125

sell_price_inc_tax numeric optional

Variation selling price including tax. Example: 125

opening_stock numeric optional

Inline opening stock quantity for this variation. Example: 10

opening_stock_exp_date string optional

Inline opening stock expiry date (Y-m-d, d-m-Y, or m-d-Y). Example: 31-12-2026

lot_number string optional

Inline opening stock lot number. Example: LOT-1

composition_variation_id string[] optional

Required when type is combo. Component variation ids, for example [10, 11].

quantity string[] optional

Required when type is combo. Component quantities matching composition_variation_id, for example [2, 1].

unit string[] optional

Required when type is combo. Component unit ids matching composition_variation_id, for example [1, 1].

item_level_purchase_price_total numeric optional

Required when type is combo. Combo purchase price excluding tax. Example: 200

purchase_price_inc_tax numeric optional

Required when type is combo. Combo purchase price including tax. Example: 200

selling_price numeric optional

Required when type is combo. Combo selling price excluding tax. Example: 250

selling_price_inc_tax numeric optional

Required when type is combo. Combo selling price including tax. Example: 250

opening_stock string[] optional

Optional opening stock keyed by location id. For single/combo products, each location value contains quantity and purchase_price. For variable products, each location value must be keyed by variation sub_sku/name or contain rows with sub_sku/variation_name.

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/product/{id}

Get the specified product

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the product. Example: `architecto`
`product`	string	required	comma separated ids of products Example: `1`

Query Parameters

Name	Type	Status	Description
`selling_price_group`	string	optional	(1, 0) Example: `architecto`
`send_lot_detail`	string	optional	Send lot details in each variation location details(1, 0) Example: `architecto`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/product/architecto?selling_price_group=architecto&send_lot_detail=architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/product/architecto"
);

const params = {
    "selling_price_group": "architecto",
    "send_lot_detail": "architecto",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/product/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'selling_price_group' => 'architecto',
            'send_lot_detail' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/product/architecto'
params = {
  'selling_price_group': 'architecto',
  'send_lot_detail': 'architecto',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "name": "Men's Reverse Fleece Crew",
            "business_id": 1,
            "type": "single",
            "sub_unit_ids": null,
            "enable_stock": 1,
            "alert_quantity": "5.0000",
            "sku": "AS0001",
            "barcode_type": "C128",
            "expiry_period": null,
            "expiry_period_type": null,
            "enable_sr_no": 0,
            "weight": null,
            "product_custom_field1": null,
            "product_custom_field2": null,
            "product_custom_field3": null,
            "product_custom_field4": null,
            "image": null,
            "woocommerce_media_id": null,
            "product_description": null,
            "created_by": 1,
            "warranty_id": null,
            "is_inactive": 0,
            "repair_model_id": null,
            "not_for_selling": 0,
            "ecom_shipping_class_id": null,
            "ecom_active_in_store": 1,
            "woocommerce_product_id": 356,
            "woocommerce_disable_sync": 0,
            "image_url": "http://local.pos.com/img/default.png",
            "product_variations": [
                {
                    "id": 1,
                    "variation_template_id": null,
                    "name": "DUMMY",
                    "product_id": 1,
                    "is_dummy": 1,
                    "created_at": "2018-01-03 21:29:08",
                    "updated_at": "2018-01-03 21:29:08",
                    "variations": [
                        {
                            "id": 1,
                            "name": "DUMMY",
                            "product_id": 1,
                            "sub_sku": "AS0001",
                            "product_variation_id": 1,
                            "woocommerce_variation_id": null,
                            "variation_value_id": null,
                            "default_purchase_price": "130.0000",
                            "dpp_inc_tax": "143.0000",
                            "profit_percent": "0.0000",
                            "default_sell_price": "130.0000",
                            "sell_price_inc_tax": "143.0000",
                            "created_at": "2018-01-03 21:29:08",
                            "updated_at": "2020-06-09 00:23:22",
                            "deleted_at": null,
                            "combo_variations": null,
                            "variation_location_details": [
                                {
                                    "id": 56,
                                    "product_id": 1,
                                    "product_variation_id": 1,
                                    "variation_id": 1,
                                    "location_id": 1,
                                    "qty_available": "20.0000",
                                    "created_at": "2020-06-08 23:46:40",
                                    "updated_at": "2020-06-08 23:46:40"
                                }
                            ],
                            "media": [
                                {
                                    "id": 1,
                                    "business_id": 1,
                                    "file_name": "1591686466_978227300_nn.jpeg",
                                    "description": null,
                                    "uploaded_by": 9,
                                    "model_type": "App\\Variation",
                                    "woocommerce_media_id": null,
                                    "model_id": 1,
                                    "created_at": "2020-06-09 00:07:46",
                                    "updated_at": "2020-06-09 00:07:46",
                                    "display_name": "nn.jpeg",
                                    "display_url": "http://local.pos.com/uploads/media/1591686466_978227300_nn.jpeg"
                                }
                            ],
                            "discounts": [
                                {
                                    "id": 2,
                                    "name": "FLAT 10%",
                                    "business_id": 1,
                                    "brand_id": null,
                                    "category_id": null,
                                    "location_id": 1,
                                    "priority": 2,
                                    "discount_type": "fixed",
                                    "discount_amount": "5.0000",
                                    "starts_at": "2021-09-01 11:45:00",
                                    "ends_at": "2021-09-30 11:45:00",
                                    "is_active": 1,
                                    "spg": null,
                                    "applicable_in_cg": 1,
                                    "created_at": "2021-09-01 11:46:00",
                                    "updated_at": "2021-09-01 12:12:55",
                                    "formated_starts_at": " 11:45",
                                    "formated_ends_at": " 11:45"
                                }
                            ],
                            "selling_price_group": [
                                {
                                    "id": 2,
                                    "variation_id": 1,
                                    "price_group_id": 1,
                                    "price_inc_tax": "140.0000",
                                    "created_at": "2020-06-09 00:23:31",
                                    "updated_at": "2020-06-09 00:23:31"
                                }
                            ]
                        }
                    ]
                }
            ],
            "brand": {
                "id": 1,
                "business_id": 1,
                "name": "Levis",
                "description": null,
                "created_by": 1,
                "deleted_at": null,
                "created_at": "2018-01-03 21:19:47",
                "updated_at": "2018-01-03 21:19:47"
            },
            "unit": {
                "id": 1,
                "business_id": 1,
                "actual_name": "Pieces",
                "short_name": "Pc(s)",
                "allow_decimal": 0,
                "base_unit_id": null,
                "base_unit_multiplier": null,
                "created_by": 1,
                "deleted_at": null,
                "created_at": "2018-01-03 15:15:20",
                "updated_at": "2018-01-03 15:15:20"
            },
            "category": {
                "id": 1,
                "name": "Men's",
                "business_id": 1,
                "short_code": null,
                "parent_id": 0,
                "created_by": 1,
                "category_type": "product",
                "description": null,
                "slug": null,
                "woocommerce_cat_id": null,
                "deleted_at": null,
                "created_at": "2018-01-03 21:06:34",
                "updated_at": "2018-01-03 21:06:34"
            },
            "sub_category": {
                "id": 5,
                "name": "Shirts",
                "business_id": 1,
                "short_code": null,
                "parent_id": 1,
                "created_by": 1,
                "category_type": "product",
                "description": null,
                "slug": null,
                "woocommerce_cat_id": null,
                "deleted_at": null,
                "created_at": "2018-01-03 21:08:18",
                "updated_at": "2018-01-03 21:08:18"
            },
            "product_tax": {
                "id": 1,
                "business_id": 1,
                "name": "VAT@10%",
                "amount": 10,
                "is_tax_group": 0,
                "created_by": 1,
                "woocommerce_tax_rate_id": null,
                "deleted_at": null,
                "created_at": "2018-01-04 02:40:07",
                "updated_at": "2018-01-04 02:40:07"
            },
            "product_locations": [
                {
                    "id": 1,
                    "business_id": 1,
                    "location_id": null,
                    "name": "Awesome Shop",
                    "landmark": "Linking Street",
                    "country": "USA",
                    "state": "Arizona",
                    "city": "Phoenix",
                    "zip_code": "85001",
                    "invoice_scheme_id": 1,
                    "invoice_layout_id": 1,
                    "selling_price_group_id": null,
                    "print_receipt_on_invoice": 1,
                    "receipt_printer_type": "browser",
                    "printer_id": null,
                    "mobile": null,
                    "alternate_number": null,
                    "email": null,
                    "website": null,
                    "featured_products": [
                        "5",
                        "71"
                    ],
                    "is_active": 1,
                    "default_payment_accounts": "{\"cash\":{\"is_enabled\":\"1\",\"account\":\"1\"},\"card\":{\"is_enabled\":\"1\",\"account\":\"3\"},\"cheque\":{\"is_enabled\":\"1\",\"account\":\"2\"},\"bank_transfer\":{\"is_enabled\":\"1\",\"account\":\"1\"},\"other\":{\"is_enabled\":\"1\",\"account\":\"3\"},\"custom_pay_1\":{\"is_enabled\":\"1\",\"account\":\"1\"},\"custom_pay_2\":{\"is_enabled\":\"1\",\"account\":\"2\"},\"custom_pay_3\":{\"is_enabled\":\"1\",\"account\":\"3\"}}",
                    "custom_field1": null,
                    "custom_field2": null,
                    "custom_field3": null,
                    "custom_field4": null,
                    "deleted_at": null,
                    "created_at": "2018-01-04 02:15:20",
                    "updated_at": "2020-06-09 01:07:05",
                    "pivot": {
                        "product_id": 2,
                        "location_id": 1
                    }
                }
            ]
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

URL Parameters

id *

product *

Query Parameters

selling_price_group

send_lot_detail

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/selling-price-group

List Selling Price Group

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/selling-price-group" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/selling-price-group"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/selling-price-group';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/selling-price-group'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "name": "Retail",
            "description": null,
            "business_id": 1,
            "is_active": 1,
            "deleted_at": null,
            "created_at": "2020-10-21 04:30:06",
            "updated_at": "2020-11-16 18:23:15"
        },
        {
            "id": 2,
            "name": "Wholesale",
            "description": null,
            "business_id": 1,
            "is_active": 1,
            "deleted_at": null,
            "created_at": "2020-10-21 04:30:21",
            "updated_at": "2020-11-16 18:23:00"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/variation/{id?}

List Variations

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	optional	comma separated ids of variations Example: `2`

Query Parameters

Name	Type	Status	Description
`product_id`	string	optional	Filter by comma separated products ids Example: `architecto`
`location_id`	string	optional	Example: `1`
`brand_id`	string	optional	Example: `architecto`
`category_id`	string	optional	Example: `architecto`
`sub_category_id`	string	optional	Example: `architecto`
`not_for_selling`	string	optional	Values: 0 or 1 Example: `architecto`
`name`	string	optional	Search term for product name Example: `architecto`
`sku`	string	optional	Search term for product sku Example: `architecto`
`per_page`	integer	optional	Total records per page. default: 10, Set -1 for no pagination Example: `10`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/variation/2?product_id=architecto&location_id=1&brand_id=architecto&category_id=architecto&sub_category_id=architecto&not_for_selling=architecto&name=architecto&sku=architecto&per_page=10" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/variation/2"
);

const params = {
    "product_id": "architecto",
    "location_id": "1",
    "brand_id": "architecto",
    "category_id": "architecto",
    "sub_category_id": "architecto",
    "not_for_selling": "architecto",
    "name": "architecto",
    "sku": "architecto",
    "per_page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/variation/2';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'product_id' => 'architecto',
            'location_id' => '1',
            'brand_id' => 'architecto',
            'category_id' => 'architecto',
            'sub_category_id' => 'architecto',
            'not_for_selling' => 'architecto',
            'name' => 'architecto',
            'sku' => 'architecto',
            'per_page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/variation/2'
params = {
  'product_id': 'architecto',
  'location_id': '1',
  'brand_id': 'architecto',
  'category_id': 'architecto',
  'sub_category_id': 'architecto',
  'not_for_selling': 'architecto',
  'name': 'architecto',
  'sku': 'architecto',
  'per_page': '10',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": [
        {
            "variation_id": 1,
            "variation_name": "",
            "sub_sku": "AS0001",
            "product_id": 1,
            "product_name": "Men's Reverse Fleece Crew",
            "sku": "AS0001",
            "type": "single",
            "business_id": 1,
            "barcode_type": "C128",
            "expiry_period": null,
            "expiry_period_type": null,
            "enable_sr_no": 0,
            "weight": null,
            "product_custom_field1": null,
            "product_custom_field2": null,
            "product_custom_field3": null,
            "product_custom_field4": null,
            "product_image": "1528728059_fleece_crew.jpg",
            "product_description": null,
            "warranty_id": null,
            "brand_id": 1,
            "brand_name": "Levis",
            "unit_id": 1,
            "enable_stock": 1,
            "not_for_selling": 0,
            "unit_name": "Pc(s)",
            "unit_allow_decimal": 0,
            "category_id": 1,
            "category": "Men's",
            "sub_category_id": 5,
            "sub_category": "Shirts",
            "tax_id": 1,
            "tax_type": "exclusive",
            "tax_name": "VAT@10%",
            "tax_amount": 10,
            "product_variation_id": 1,
            "default_purchase_price": "130.0000",
            "dpp_inc_tax": "143.0000",
            "profit_percent": "0.0000",
            "default_sell_price": "130.0000",
            "sell_price_inc_tax": "143.0000",
            "product_variation_name": "",
            "variation_location_details": [],
            "media": [],
            "selling_price_group": [],
            "product_image_url": "http://local.pos.com/uploads/img/1528728059_fleece_crew.jpg",
            "product_locations": [
                {
                    "id": 1,
                    "business_id": 1,
                    "location_id": null,
                    "name": "Awesome Shop",
                    "landmark": "Linking Street",
                    "country": "USA",
                    "state": "Arizona",
                    "city": "Phoenix",
                    "zip_code": "85001",
                    "invoice_scheme_id": 1,
                    "invoice_layout_id": 1,
                    "selling_price_group_id": null,
                    "print_receipt_on_invoice": 1,
                    "receipt_printer_type": "browser",
                    "printer_id": null,
                    "mobile": null,
                    "alternate_number": null,
                    "email": null,
                    "website": null,
                    "featured_products": null,
                    "is_active": 1,
                    "default_payment_accounts": "",
                    "custom_field1": null,
                    "custom_field2": null,
                    "custom_field3": null,
                    "custom_field4": null,
                    "deleted_at": null,
                    "created_at": "2018-01-04 02:15:20",
                    "updated_at": "2019-12-11 04:53:39",
                    "pivot": {
                        "product_id": 1,
                        "location_id": 1
                    }
                }
            ]
        },
        {
            "variation_id": 2,
            "variation_name": "28",
            "sub_sku": "AS0002-1",
            "product_id": 2,
            "product_name": "Levis Men's Slimmy Fit Jeans",
            "sku": "AS0002",
            "type": "variable",
            "business_id": 1,
            "barcode_type": "C128",
            "expiry_period": null,
            "expiry_period_type": null,
            "enable_sr_no": 0,
            "weight": null,
            "product_custom_field1": null,
            "product_custom_field2": null,
            "product_custom_field3": null,
            "product_custom_field4": null,
            "product_image": "1528727964_levis_jeans.jpg",
            "product_description": null,
            "warranty_id": null,
            "brand_id": 1,
            "brand_name": "Levis",
            "unit_id": 1,
            "enable_stock": 1,
            "not_for_selling": 0,
            "unit_name": "Pc(s)",
            "unit_allow_decimal": 0,
            "category_id": 1,
            "category": "Men's",
            "sub_category_id": 4,
            "sub_category": "Jeans",
            "tax_id": 1,
            "tax_type": "exclusive",
            "tax_name": "VAT@10%",
            "tax_amount": 10,
            "product_variation_id": 2,
            "default_purchase_price": "70.0000",
            "dpp_inc_tax": "77.0000",
            "profit_percent": "0.0000",
            "default_sell_price": "70.0000",
            "sell_price_inc_tax": "77.0000",
            "product_variation_name": "Waist Size",
            "variation_location_details": [
                {
                    "id": 1,
                    "product_id": 2,
                    "product_variation_id": 2,
                    "variation_id": 2,
                    "location_id": 1,
                    "qty_available": "50.0000",
                    "created_at": "2018-01-06 06:57:11",
                    "updated_at": "2020-08-04 04:11:27"
                }
            ],
            "media": [
                {
                    "id": 1,
                    "business_id": 1,
                    "file_name": "1596701997_743693452_test.jpg",
                    "description": null,
                    "uploaded_by": 9,
                    "model_type": "App\\Variation",
                    "woocommerce_media_id": null,
                    "model_id": 2,
                    "created_at": "2020-08-06 13:49:57",
                    "updated_at": "2020-08-06 13:49:57",
                    "display_name": "test.jpg",
                    "display_url": "http://local.pos.com/uploads/media/1596701997_743693452_test.jpg"
                }
            ],
            "selling_price_group": [],
            "product_image_url": "http://local.pos.com/uploads/img/1528727964_levis_jeans.jpg",
            "product_locations": [
                {
                    "id": 1,
                    "business_id": 1,
                    "location_id": null,
                    "name": "Awesome Shop",
                    "landmark": "Linking Street",
                    "country": "USA",
                    "state": "Arizona",
                    "city": "Phoenix",
                    "zip_code": "85001",
                    "invoice_scheme_id": 1,
                    "invoice_layout_id": 1,
                    "selling_price_group_id": null,
                    "print_receipt_on_invoice": 1,
                    "receipt_printer_type": "browser",
                    "printer_id": null,
                    "mobile": null,
                    "alternate_number": null,
                    "email": null,
                    "website": null,
                    "featured_products": null,
                    "is_active": 1,
                    "default_payment_accounts": "",
                    "custom_field1": null,
                    "custom_field2": null,
                    "custom_field3": null,
                    "custom_field4": null,
                    "deleted_at": null,
                    "created_at": "2018-01-04 02:15:20",
                    "updated_at": "2019-12-11 04:53:39",
                    "pivot": {
                        "product_id": 2,
                        "location_id": 1
                    }
                }
            ],
            "discounts": [
                {
                    "id": 2,
                    "name": "FLAT 10%",
                    "business_id": 1,
                    "brand_id": null,
                    "category_id": null,
                    "location_id": 1,
                    "priority": 2,
                    "discount_type": "fixed",
                    "discount_amount": "5.0000",
                    "starts_at": "2021-09-01 11:45:00",
                    "ends_at": "2021-09-30 11:45:00",
                    "is_active": 1,
                    "spg": null,
                    "applicable_in_cg": 1,
                    "created_at": "2021-09-01 11:46:00",
                    "updated_at": "2021-09-01 12:12:55",
                    "formated_starts_at": " 11:45",
                    "formated_ends_at": " 11:45"
                }
            ]
        }
    ],
    "links": {
        "first": "http://local.pos.com/connector/api/variation?page=1",
        "last": null,
        "prev": null,
        "next": "http://local.pos.com/connector/api/variation?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "http://local.pos.com/connector/api/variation",
        "per_page": "2",
        "to": 2
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

URL Parameters

id

Query Parameters

product_id

location_id

brand_id

category_id

sub_category_id

not_for_selling

name

sku

per_page

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/new_product

New List products

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Query Parameters

Name	Type	Status	Description
`order_by`	string	optional	Values: product_name or newest Example: `architecto`
`order_direction`	string	optional	Values: asc or desc Example: `architecto`
`location_custom_field_1`	string	optional	Custom field 1 of the location Example: `architecto`
`category_id`	string	optional	comma separated ids of one or multiple category Example: `architecto`
`sub_category_id`	string	optional	comma separated ids of one or multiple sub-category Example: `architecto`
`location_id`	string	optional	Example: `1`
`not_for_sell`	string	optional	(1, 0) Example: `architecto`
`send_lot_detail`	string	optional	Send lot details in each variation location details(1, 0) Example: `architecto`
`name`	string	optional	Search term for product name Example: `architecto`
`sku`	string	optional	Search term for product sku Example: `architecto`
`product_ids`	string	optional	comma separated ids of products Example: `1,2`
`per_page`	integer	optional	Total records per page. default: 10, Set -1 for no pagination Example: `10`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/new_product?order_by=architecto&order_direction=architecto&location_custom_field_1=architecto&category_id=architecto&sub_category_id=architecto&location_id=1&not_for_sell=architecto&send_lot_detail=architecto&name=architecto&sku=architecto&product_ids=1%2C2&per_page=10" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/new_product"
);

const params = {
    "order_by": "architecto",
    "order_direction": "architecto",
    "location_custom_field_1": "architecto",
    "category_id": "architecto",
    "sub_category_id": "architecto",
    "location_id": "1",
    "not_for_sell": "architecto",
    "send_lot_detail": "architecto",
    "name": "architecto",
    "sku": "architecto",
    "product_ids": "1,2",
    "per_page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/new_product';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'order_by' => 'architecto',
            'order_direction' => 'architecto',
            'location_custom_field_1' => 'architecto',
            'category_id' => 'architecto',
            'sub_category_id' => 'architecto',
            'location_id' => '1',
            'not_for_sell' => 'architecto',
            'send_lot_detail' => 'architecto',
            'name' => 'architecto',
            'sku' => 'architecto',
            'product_ids' => '1,2',
            'per_page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/new_product'
params = {
  'order_by': 'architecto',
  'order_direction': 'architecto',
  'location_custom_field_1': 'architecto',
  'category_id': 'architecto',
  'sub_category_id': 'architecto',
  'location_id': '1',
  'not_for_sell': 'architecto',
  'send_lot_detail': 'architecto',
  'name': 'architecto',
  'sku': 'architecto',
  'product_ids': '1,2',
  'per_page': '10',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 2,
            "name": "Levis Men's Slimmy Fit Jeans",
            "business_id": 1,
            "type": "variable",
            "exemption_type_id": null,
            "enable_stock": 1,
            "sku": "AS0002",
            "product_custom_field1": null,
            "product_custom_field2": null,
            "product_custom_field3": null,
            "product_custom_field4": null,
            "woocommerce_media_id": null,
            "product_description": null,
            "is_inactive": 0,
            "repair_model_id": null,
            "not_for_selling": 0,
            "ecom_shipping_class_id": null,
            "ecom_active_in_store": 1,
            "woocommerce_product_id": 627,
            "woocommerce_disable_sync": 0,
            "image_url": "http://local.pos.com/uploads/img/1528727964_levis_jeans.jpg",
            "product_variations": [
                {
                    "id": 2,
                    "variation_template_id": 5,
                    "name": "Waist Size",
                    "product_id": 2,
                    "is_dummy": 0,
                    "variations": [
                        {
                            "id": 2,
                            "name": "28",
                            "product_id": 2,
                            "sub_sku": "AS0002-1",
                            "product_variation_id": 2,
                            "woocommerce_variation_id": 658,
                            "default_purchase_price": "70.0000",
                            "dpp_inc_tax": "77.0000",
                            "default_sell_price": "70.0000",
                            "sell_price_inc_tax": "77.0000",
                            "combo_variations": null,
                            "variation_location_details": [
                                {
                                    "id": 1,
                                    "product_id": 2,
                                    "product_variation_id": 2,
                                    "variation_id": 2,
                                    "location_id": 1,
                                    "qty_available": "71.0000"
                                }
                            ],
                            "media": [],
                            "discounts": []
                        },
                        {
                            "id": 3,
                            "name": "30",
                            "product_id": 2,
                            "sub_sku": "AS0002-2",
                            "product_variation_id": 2,
                            "woocommerce_variation_id": 659,
                            "default_purchase_price": "70.0000",
                            "dpp_inc_tax": "77.0000",
                            "default_sell_price": "70.0000",
                            "sell_price_inc_tax": "77.0000",
                            "combo_variations": null,
                            "variation_location_details": [
                                {
                                    "id": 2,
                                    "product_id": 2,
                                    "product_variation_id": 2,
                                    "variation_id": 3,
                                    "location_id": 1,
                                    "qty_available": "89.0000"
                                }
                            ],
                            "media": [],
                            "discounts": []
                        },
                        {
                            "id": 4,
                            "name": "32",
                            "product_id": 2,
                            "sub_sku": "AS0002-3",
                            "product_variation_id": 2,
                            "woocommerce_variation_id": 660,
                            "default_purchase_price": "70.0000",
                            "dpp_inc_tax": "77.0000",
                            "default_sell_price": "70.0000",
                            "sell_price_inc_tax": "77.0000",
                            "combo_variations": null,
                            "variation_location_details": [
                                {
                                    "id": 3,
                                    "product_id": 2,
                                    "product_variation_id": 2,
                                    "variation_id": 4,
                                    "location_id": 1,
                                    "qty_available": "127.0000"
                                },
                                {
                                    "id": 1371,
                                    "product_id": 2,
                                    "product_variation_id": 2,
                                    "variation_id": 4,
                                    "location_id": 7,
                                    "qty_available": "-1.0000"
                                }
                            ],
                            "media": [],
                            "discounts": []
                        },
                        {
                            "id": 5,
                            "name": "34",
                            "product_id": 2,
                            "sub_sku": "AS0002-4",
                            "product_variation_id": 2,
                            "woocommerce_variation_id": 661,
                            "default_purchase_price": "72.0000",
                            "dpp_inc_tax": "79.2000",
                            "default_sell_price": "72.0000",
                            "sell_price_inc_tax": "79.2000",
                            "combo_variations": null,
                            "variation_location_details": [
                                {
                                    "id": 4,
                                    "product_id": 2,
                                    "product_variation_id": 2,
                                    "variation_id": 5,
                                    "location_id": 1,
                                    "qty_available": "128.0000"
                                }
                            ],
                            "media": [],
                            "discounts": []
                        },
                        {
                            "id": 6,
                            "name": "36",
                            "product_id": 2,
                            "sub_sku": "AS0002-5",
                            "product_variation_id": 2,
                            "woocommerce_variation_id": 662,
                            "default_purchase_price": "72.0000",
                            "dpp_inc_tax": "79.2000",
                            "default_sell_price": "72.0000",
                            "sell_price_inc_tax": "79.2000",
                            "combo_variations": null,
                            "variation_location_details": [
                                {
                                    "id": 5,
                                    "product_id": 2,
                                    "product_variation_id": 2,
                                    "variation_id": 6,
                                    "location_id": 1,
                                    "qty_available": "99.0000"
                                }
                            ],
                            "media": [],
                            "discounts": []
                        }
                    ]
                }
            ],
            "brand": {
                "id": 1,
                "business_id": 1,
                "name": "Levis",
                "description": null,
                "created_by": 1,
                "use_for_repair": 1,
                "deleted_at": null,
                "created_at": "2018-01-03 21:19:47",
                "updated_at": "2018-01-03 21:19:47"
            },
            "unit": {
                "id": 1,
                "business_id": 1,
                "actual_name": "Pieces",
                "short_name": "Pc(s)",
                "allow_decimal": 0,
                "base_unit_id": null,
                "base_unit_multiplier": null
            },
            "category": {
                "id": 1,
                "name": "Men's",
                "business_id": 1,
                "short_code": "sfefef",
                "parent_id": 0,
                "category_type": "product",
                "description": null,
                "slug": null,
                "woocommerce_cat_id": null
            },
            "sub_category": {
                "id": 4,
                "name": "Jeans",
                "business_id": 1,
                "short_code": null,
                "parent_id": 1,
                "category_type": "product",
                "description": null,
                "slug": null,
                "woocommerce_cat_id": null
            },
            "product_tax": {
                "id": 1,
                "business_id": 1,
                "name": "VAT@10%",
                "amount": 10,
                "is_tax_group": 0,
                "for_tax_group": 0,
                "created_by": 1,
                "woocommerce_tax_rate_id": null,
                "deleted_at": null,
                "created_at": "2018-01-04 02:40:07",
                "updated_at": "2018-01-04 02:40:07"
            },
            "product_locations": [
                {
                    "id": 1,
                    "business_id": 1,
                    "name": "Location 1",
                    "custom_field1": "gdgdgd88",
                    "custom_field2": null,
                    "custom_field3": null,
                    "custom_field4": null
                }
            ]
        }
    ],
    "links": {
        "first": "http://local.pos.com/connector/api/new_product?per_page=1&page=1",
        "last": "http://local.pos.com/connector/api/new_product?per_page=1&page=1088",
        "prev": null,
        "next": "http://local.pos.com/connector/api/new_product?per_page=1&page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1088,
        "path": "http://local.pos.com/connector/api/new_product",
        "per_page": "1",
        "to": 1,
        "total": 1088
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Query Parameters

order_by

order_direction

location_custom_field_1

category_id

sub_category_id

location_id

not_for_sell

send_lot_detail

name

sku

product_ids

per_page

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/taxonomy

List taxonomy

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Query Parameters

Name	Type	Status	Description
`type`	string	optional	Type of taxonomy (product, device, hrm_department) Example: `architecto`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/taxonomy?type=architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/taxonomy"
);

const params = {
    "type": "architecto",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/taxonomy';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'type' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/taxonomy'
params = {
  'type': 'architecto',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "name": "Men's",
            "business_id": 1,
            "short_code": null,
            "parent_id": 0,
            "created_by": 1,
            "category_type": "product",
            "description": null,
            "slug": null,
            "woocommerce_cat_id": null,
            "deleted_at": null,
            "created_at": "2018-01-03 21:06:34",
            "updated_at": "2018-01-03 21:06:34",
            "sub_categories": [
                {
                    "id": 4,
                    "name": "Jeans",
                    "business_id": 1,
                    "short_code": null,
                    "parent_id": 1,
                    "created_by": 1,
                    "category_type": "product",
                    "description": null,
                    "slug": null,
                    "woocommerce_cat_id": null,
                    "deleted_at": null,
                    "created_at": "2018-01-03 21:07:34",
                    "updated_at": "2018-01-03 21:07:34"
                },
                {
                    "id": 5,
                    "name": "Shirts",
                    "business_id": 1,
                    "short_code": null,
                    "parent_id": 1,
                    "created_by": 1,
                    "category_type": "product",
                    "description": null,
                    "slug": null,
                    "woocommerce_cat_id": null,
                    "deleted_at": null,
                    "created_at": "2018-01-03 21:08:18",
                    "updated_at": "2018-01-03 21:08:18"
                }
            ]
        },
        {
            "id": 21,
            "name": "Food & Grocery",
            "business_id": 1,
            "short_code": null,
            "parent_id": 0,
            "created_by": 1,
            "category_type": "product",
            "description": null,
            "slug": null,
            "woocommerce_cat_id": null,
            "deleted_at": null,
            "created_at": "2018-01-06 05:31:35",
            "updated_at": "2018-01-06 05:31:35",
            "sub_categories": []
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/taxonomy/{id}

Get the specified taxonomy

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the taxonomy. Example: `architecto`
`taxonomy`	string	required	comma separated ids of product categories Example: `1`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/taxonomy/architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/taxonomy/architecto"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/taxonomy/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/taxonomy/architecto'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "name": "Men's",
            "business_id": 1,
            "short_code": null,
            "parent_id": 0,
            "created_by": 1,
            "category_type": "product",
            "description": null,
            "slug": null,
            "woocommerce_cat_id": null,
            "deleted_at": null,
            "created_at": "2018-01-03 21:06:34",
            "updated_at": "2018-01-03 21:06:34",
            "sub_categories": [
                {
                    "id": 4,
                    "name": "Jeans",
                    "business_id": 1,
                    "short_code": null,
                    "parent_id": 1,
                    "created_by": 1,
                    "category_type": "product",
                    "description": null,
                    "slug": null,
                    "woocommerce_cat_id": null,
                    "deleted_at": null,
                    "created_at": "2018-01-03 21:07:34",
                    "updated_at": "2018-01-03 21:07:34"
                },
                {
                    "id": 5,
                    "name": "Shirts",
                    "business_id": 1,
                    "short_code": null,
                    "parent_id": 1,
                    "created_by": 1,
                    "category_type": "product",
                    "description": null,
                    "slug": null,
                    "woocommerce_cat_id": null,
                    "deleted_at": null,
                    "created_at": "2018-01-03 21:08:18",
                    "updated_at": "2018-01-03 21:08:18"
                }
            ]
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/brand

List brands

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/brand" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/brand"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/brand';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/brand'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "business_id": 1,
            "name": "Levis",
            "description": null,
            "created_by": 1,
            "deleted_at": null,
            "created_at": "2018-01-03 21:19:47",
            "updated_at": "2018-01-03 21:19:47"
        },
        {
            "id": 2,
            "business_id": 1,
            "name": "Espirit",
            "description": null,
            "created_by": 1,
            "deleted_at": null,
            "created_at": "2018-01-03 21:19:58",
            "updated_at": "2018-01-03 21:19:58"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/brand/{id}

Get the specified brand

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the brand. Example: `architecto`
`brand`	string	required	comma separated ids of the brands Example: `1`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/brand/architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/brand/architecto"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/brand/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/brand/architecto'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "business_id": 1,
            "name": "Levis",
            "description": null,
            "created_by": 1,
            "deleted_at": null,
            "created_at": "2018-01-03 21:19:47",
            "updated_at": "2018-01-03 21:19:47"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/unit

List units

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/unit" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/unit"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/unit';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/unit'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "business_id": 1,
            "actual_name": "Pieces",
            "short_name": "Pc(s)",
            "allow_decimal": 0,
            "base_unit_id": null,
            "base_unit_multiplier": null,
            "created_by": 1,
            "deleted_at": null,
            "created_at": "2018-01-03 15:15:20",
            "updated_at": "2018-01-03 15:15:20",
            "base_unit": null
        },
        {
            "id": 2,
            "business_id": 1,
            "actual_name": "Packets",
            "short_name": "packets",
            "allow_decimal": 0,
            "base_unit_id": null,
            "base_unit_multiplier": null,
            "created_by": 1,
            "deleted_at": null,
            "created_at": "2018-01-06 01:07:01",
            "updated_at": "2018-01-06 01:08:36",
            "base_unit": null
        },
        {
            "id": 15,
            "business_id": 1,
            "actual_name": "Dozen",
            "short_name": "dz",
            "allow_decimal": 0,
            "base_unit_id": 1,
            "base_unit_multiplier": "12.0000",
            "created_by": 9,
            "deleted_at": null,
            "created_at": "2020-07-20 13:11:09",
            "updated_at": "2020-07-20 13:11:09",
            "base_unit": {
                "id": 1,
                "business_id": 1,
                "actual_name": "Pieces",
                "short_name": "Pc(s)",
                "allow_decimal": 0,
                "base_unit_id": null,
                "base_unit_multiplier": null,
                "created_by": 1,
                "deleted_at": null,
                "created_at": "2018-01-03 15:15:20",
                "updated_at": "2018-01-03 15:15:20"
            }
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/unit/{id}

Get the specified unit

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the unit. Example: `architecto`
`unit`	string	required	comma separated ids of the units Example: `1`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/unit/architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/unit/architecto"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/unit/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/unit/architecto'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "business_id": 1,
            "actual_name": "Pieces",
            "short_name": "Pc(s)",
            "allow_decimal": 0,
            "base_unit_id": null,
            "base_unit_multiplier": null,
            "created_by": 1,
            "deleted_at": null,
            "created_at": "2018-01-03 15:15:20",
            "updated_at": "2018-01-03 15:15:20",
            "base_unit": null
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/tax

List taxes

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/tax" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/tax"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/tax';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/tax'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "business_id": 1,
            "name": "VAT@10%",
            "amount": 10,
            "is_tax_group": 0,
            "created_by": 1,
            "woocommerce_tax_rate_id": null,
            "deleted_at": null,
            "created_at": "2018-01-04 02:40:07",
            "updated_at": "2018-01-04 02:40:07"
        },
        {
            "id": 2,
            "business_id": 1,
            "name": "CGST@10%",
            "amount": 10,
            "is_tax_group": 0,
            "created_by": 1,
            "woocommerce_tax_rate_id": null,
            "deleted_at": null,
            "created_at": "2018-01-04 02:40:55",
            "updated_at": "2018-01-04 02:40:55"
        },
        {
            "id": 3,
            "business_id": 1,
            "name": "SGST@8%",
            "amount": 8,
            "is_tax_group": 0,
            "created_by": 1,
            "woocommerce_tax_rate_id": null,
            "deleted_at": null,
            "created_at": "2018-01-04 02:41:13",
            "updated_at": "2018-01-04 02:41:13"
        },
        {
            "id": 4,
            "business_id": 1,
            "name": "GST@18%",
            "amount": 18,
            "is_tax_group": 1,
            "created_by": 1,
            "woocommerce_tax_rate_id": null,
            "deleted_at": null,
            "created_at": "2018-01-04 02:42:19",
            "updated_at": "2018-01-04 02:42:19"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/tax/{id}

Get the specified tax

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the tax. Example: `architecto`
`tax`	string	required	comma separated ids of required taxes Example: `1`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/tax/architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/tax/architecto"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/tax/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/tax/architecto'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "business_id": 1,
            "name": "VAT@10%",
            "amount": 10,
            "is_tax_group": 0,
            "created_by": 1,
            "woocommerce_tax_rate_id": null,
            "deleted_at": null,
            "created_at": "2018-01-04 02:40:07",
            "updated_at": "2018-01-04 02:40:07"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/types-of-service

List types of service

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/types-of-service" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/types-of-service"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/types-of-service';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/types-of-service'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "name": "Home Delivery",
            "description": null,
            "business_id": 1,
            "location_price_group": {
                "1": "0"
            },
            "packing_charge": "10.0000",
            "packing_charge_type": "fixed",
            "enable_custom_fields": 0,
            "created_at": "2020-06-04 22:41:13",
            "updated_at": "2020-06-04 22:41:13"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/types-of-service/{id}

Get the specified types of service

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the types of service. Example: `architecto`
`types_of_service`	string	required	comma separated ids of required types of services Example: `1`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/types-of-service/architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/types-of-service/architecto"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/types-of-service/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/types-of-service/architecto'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "name": "Home Delivery",
            "description": null,
            "business_id": 1,
            "location_price_group": {
                "1": "0"
            },
            "packing_charge": "10.0000",
            "packing_charge_type": "fixed",
            "enable_custom_fields": 0,
            "created_at": "2020-06-04 22:41:13",
            "updated_at": "2020-06-04 22:41:13"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/table

List tables

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Query Parameters

Name	Type	Status	Description
`location_id`	integer	optional	id of the location Example: `1`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/table?location_id=1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/table"
);

const params = {
    "location_id": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/table';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'location_id' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/table'
params = {
  'location_id': '1',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 5,
            "business_id": 1,
            "location_id": 1,
            "name": "Table 1",
            "description": null,
            "created_by": 9,
            "deleted_at": null,
            "created_at": "2020-06-04 22:36:37",
            "updated_at": "2020-06-04 22:36:37"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/table/{id}

Show the specified table

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the table. Example: `architecto`
`table`	string	required	comma separated ids of required tables Example: `5`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/table/architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/table/architecto"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/table/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/table/architecto'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 5,
            "business_id": 1,
            "location_id": 1,
            "name": "Table 1",
            "description": null,
            "created_by": 9,
            "deleted_at": null,
            "created_at": "2020-06-04 22:36:37",
            "updated_at": "2020-06-04 22:36:37"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/sell

List sells

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Query Parameters

Name	Type	Status	Description
`location_id`	string	optional	id of the location Example: `1`
`contact_id`	string	optional	id of the customer Example: `architecto`
`status`	string	optional	Sell status. Available values final, draft, quotation, proforma Example: `final`
`payment_status`	string	optional	Comma separated values of payment statuses. Available values due, partial, paid, overdue Example: `due,partial`
`start_date`	string	optional	format:Y-m-d Example: `2018-06-25`
`end_date`	string	optional	format:Y-m-d Example: `2018-06-25`
`user_id`	string	optional	id of the user who created the sale Example: `architecto`
`service_staff_id`	string	optional	id of the service staff assigned with the sale Example: `architecto`
`shipping_status`	string	optional	Shipping Status of the sale ('ordered', 'packed', 'shipped', 'delivered', 'cancelled') Example: `ordered`
`source`	string	optional	Source of the sale Example: `architecto`
`only_subscriptions`	string	optional	Filter only subcription invoices (1, 0) Example: `architecto`
`send_purchase_details`	string	optional	Get purchase details of each sell line (1, 0) Example: `architecto`
`order_by_date`	string	optional	Sort sell list by date ('asc', 'desc') Example: `desc`
`per_page`	integer	optional	Total records per page. default: 10, Set -1 for no pagination Example: `10`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/sell?location_id=1&contact_id=architecto&status=final&payment_status=due%2Cpartial&start_date=2018-06-25&end_date=2018-06-25&user_id=architecto&service_staff_id=architecto&shipping_status=ordered&source=architecto&only_subscriptions=architecto&send_purchase_details=architecto&order_by_date=desc&per_page=10" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/sell"
);

const params = {
    "location_id": "1",
    "contact_id": "architecto",
    "status": "final",
    "payment_status": "due,partial",
    "start_date": "2018-06-25",
    "end_date": "2018-06-25",
    "user_id": "architecto",
    "service_staff_id": "architecto",
    "shipping_status": "ordered",
    "source": "architecto",
    "only_subscriptions": "architecto",
    "send_purchase_details": "architecto",
    "order_by_date": "desc",
    "per_page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/sell';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'location_id' => '1',
            'contact_id' => 'architecto',
            'status' => 'final',
            'payment_status' => 'due,partial',
            'start_date' => '2018-06-25',
            'end_date' => '2018-06-25',
            'user_id' => 'architecto',
            'service_staff_id' => 'architecto',
            'shipping_status' => 'ordered',
            'source' => 'architecto',
            'only_subscriptions' => 'architecto',
            'send_purchase_details' => 'architecto',
            'order_by_date' => 'desc',
            'per_page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/sell'
params = {
  'location_id': '1',
  'contact_id': 'architecto',
  'status': 'final',
  'payment_status': 'due,partial',
  'start_date': '2018-06-25',
  'end_date': '2018-06-25',
  'user_id': 'architecto',
  'service_staff_id': 'architecto',
  'shipping_status': 'ordered',
  'source': 'architecto',
  'only_subscriptions': 'architecto',
  'send_purchase_details': 'architecto',
  'order_by_date': 'desc',
  'per_page': '10',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 6,
            "business_id": 1,
            "location_id": 1,
            "res_table_id": null,
            "res_waiter_id": null,
            "res_order_status": null,
            "type": "sell",
            "sub_type": null,
            "status": "final",
            "is_quotation": 0,
            "payment_status": "paid",
            "adjustment_type": null,
            "contact_id": 4,
            "customer_group_id": null,
            "invoice_no": "AS0001",
            "ref_no": "",
            "source": null,
            "subscription_no": null,
            "subscription_repeat_on": null,
            "transaction_date": "2018-04-10 13:23:21",
            "total_before_tax": "770.0000",
            "tax_id": null,
            "tax_amount": "0.0000",
            "discount_type": "percentage",
            "discount_amount": "0.0000",
            "rp_redeemed": 0,
            "rp_redeemed_amount": "0.0000",
            "shipping_details": null,
            "shipping_address": null,
            "shipping_status": null,
            "delivered_to": null,
            "shipping_charges": "0.0000",
            "additional_notes": null,
            "staff_note": null,
            "round_off_amount": "0.0000",
            "final_total": "770.0000",
            "expense_category_id": null,
            "expense_for": null,
            "commission_agent": null,
            "document": null,
            "is_direct_sale": 0,
            "is_suspend": 0,
            "exchange_rate": "1.000",
            "total_amount_recovered": null,
            "transfer_parent_id": null,
            "return_parent_id": null,
            "opening_stock_product_id": null,
            "created_by": 1,
            "import_batch": null,
            "import_time": null,
            "types_of_service_id": null,
            "packing_charge": null,
            "packing_charge_type": null,
            "service_custom_field_1": null,
            "service_custom_field_2": null,
            "service_custom_field_3": null,
            "service_custom_field_4": null,
            "mfg_parent_production_purchase_id": null,
            "mfg_wasted_units": null,
            "mfg_production_cost": "0.0000",
            "mfg_is_final": 0,
            "is_created_from_api": 0,
            "essentials_duration": "0.00",
            "essentials_duration_unit": null,
            "essentials_amount_per_unit_duration": "0.0000",
            "essentials_allowances": null,
            "essentials_deductions": null,
            "rp_earned": 0,
            "repair_completed_on": null,
            "repair_warranty_id": null,
            "repair_brand_id": null,
            "repair_status_id": null,
            "repair_model_id": null,
            "repair_defects": null,
            "repair_serial_no": null,
            "repair_updates_email": 0,
            "repair_updates_sms": 0,
            "repair_checklist": null,
            "repair_security_pwd": null,
            "repair_security_pattern": null,
            "repair_due_date": null,
            "repair_device_id": null,
            "order_addresses": null,
            "is_recurring": 0,
            "recur_interval": null,
            "recur_interval_type": null,
            "recur_repetitions": null,
            "recur_stopped_on": null,
            "recur_parent_id": null,
            "invoice_token": null,
            "pay_term_number": null,
            "pay_term_type": null,
            "pjt_project_id": null,
            "pjt_title": null,
            "woocommerce_order_id": null,
            "selling_price_group_id": null,
            "created_at": "2018-01-06 07:06:11",
            "updated_at": "2018-01-06 07:06:11",
            "sell_lines": [
                {
                    "id": 1,
                    "transaction_id": 6,
                    "product_id": 2,
                    "variation_id": 3,
                    "quantity": 10,
                    "mfg_waste_percent": "0.0000",
                    "quantity_returned": "0.0000",
                    "unit_price_before_discount": "70.0000",
                    "unit_price": "70.0000",
                    "line_discount_type": null,
                    "line_discount_amount": "0.0000",
                    "unit_price_inc_tax": "77.0000",
                    "item_tax": "7.0000",
                    "tax_id": 1,
                    "discount_id": null,
                    "lot_no_line_id": null,
                    "sell_line_note": null,
                    "res_service_staff_id": null,
                    "res_line_order_status": null,
                    "woocommerce_line_items_id": null,
                    "parent_sell_line_id": null,
                    "children_type": "",
                    "sub_unit_id": null,
                    "created_at": "2018-01-06 07:06:11",
                    "updated_at": "2018-01-06 07:06:11"
                }
            ],
            "payment_lines": [
                {
                    "id": 1,
                    "transaction_id": 6,
                    "business_id": null,
                    "is_return": 0,
                    "amount": "770.0000",
                    "method": "cash",
                    "transaction_no": null,
                    "card_transaction_number": null,
                    "card_number": null,
                    "card_type": "visa",
                    "card_holder_name": null,
                    "card_month": null,
                    "card_year": null,
                    "card_security": null,
                    "cheque_number": null,
                    "bank_account_number": null,
                    "paid_on": "2018-01-09 17:30:35",
                    "created_by": 1,
                    "payment_for": null,
                    "parent_id": null,
                    "note": null,
                    "document": null,
                    "payment_ref_no": null,
                    "account_id": null,
                    "created_at": "2018-01-06 01:36:11",
                    "updated_at": "2018-01-06 01:36:11"
                }
            ],
            "invoice_url": "http://local.pos.com/invoice/6dfd77eb80f4976b456128e7f1311c9f",
            "payment_link": "http://local.pos.com/pay/6dfd77eb80f4976b456128e7f1311c9f"
        }
    ],
    "links": {
        "first": "http://local.pos.com/connector/api/sell?page=1",
        "last": "http://local.pos.com/connector/api/sell?page=6",
        "prev": null,
        "next": "http://local.pos.com/connector/api/sell?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "http://local.pos.com/connector/api/sell",
        "per_page": 10,
        "to": 10
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Query Parameters

location_id

contact_id

status

payment_status

start_date

end_date

user_id

service_staff_id

shipping_status

source

only_subscriptions

send_purchase_details

order_by_date

per_page

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST connector/api/sell

Create sell

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Body Parameters

sells object

* object

location_id integer

id of the business location Example: 1

contact_id integer

id of the customer Example: 16

transaction_date string

transaction date format:Y-m-d H:i:s, Example: 2020-07-22 15:48:29

invoice_no string

Invoice number Example: architecto

source string

Source of the invoice Example: api, phone, woocommerce

status string

sale status (final, draft) Example: final

sub_status string

sale sub status ("quotation" for quotation and "proforma" for proforma invoice)

is_quotation boolean

Is sell quotation (0, 1), If 1 status should be draft Example: true

tax_rate_id integer

id of the tax rate applicable to the sale Example: 16

discount_amount number

discount amount applicable to the sale Example: 10

discount_type string

type of the discount amount (fixed, percentage) Example: fixed

sale_note string

Example: architecto

staff_note string

Example: architecto

commission_agent integer

commission agent id Example: 16

shipping_details string

shipping details Example: Express Delivery

shipping_address string

shipping address Example: architecto

shipping_status string

('ordered', 'packed', 'shipped', 'delivered', 'cancelled') Example: ordered

delivered_to string

Name of the person recieved the consignment Example: 'Mr robin'

shipping_charges number

shipping amount Example: 10

packing_charge number

packing charge Example: 10

exchange_rate number

exchange rate for the currency used Example: 1

selling_price_group_id integer

id of the selling price group Example: 16

pay_term_number integer

pay term value Example: 3

pay_term_type string

type of the pay term value ('days', 'months') Example: months

is_suspend boolean

Is suspended sale (0, 1) Example: false

is_recurring integer

whether the invoice is recurring (0, 1) Example: 0

recur_interval integer

value of the interval invoice will be regenerated Example: 16

recur_interval_type string

type of the recur interval ('days', 'months', 'years') Example: months

subscription_repeat_on integer

day of the month on which invoice will be generated if recur interval type is months (1-30) Example: 15

subscription_no string

subscription number Example: architecto

recur_repetitions integer

total number of invoices to be generated Example: 16

rp_redeemed integer

reward points redeemed Example: 16

rp_redeemed_amount number

reward point redeemed amount after conversion Example: 13.5

types_of_service_id integer

types of service id Example: 16

service_custom_field_1 string

types of service custom field 1 Example: architecto

service_custom_field_2 string

types of service custom field 2 Example: architecto

service_custom_field_3 string

types of service custom field 3 Example: architecto

service_custom_field_4 string

types of service custom field 4 Example: architecto

service_custom_field_5 string

types of service custom field 5 Example: architecto

service_custom_field_6 string

types of service custom field 6 Example: architecto

round_off_amount number

round off amount on total payable Example: 4326.41688

table_id integer

id of the table Example: 16

service_staff_id integer

id of the service staff assigned to the sale Example: 16

change_return number

Excess paid amount Example: 0

products string[]

array of the products for the sale

* object

product_id integer

product id Example: 17

variation_id integer

variation id Example: 58

quantity number

quantity Example: 1

unit_price number

unit selling price Example: 437.5

tax_rate_id integer

tax rate id applicable on the product

discount_amount number

discount amount applicable on the product Example: 0

discount_type string

type of discount amount ('fixed', 'percentage') Example: percentage

sub_unit_id integer

sub unit id Example: 16

note string

note for the product Example: architecto

payments string[]

payment lines for the sale

* object

amount number

amount of the payment Example: 453.13

method string

payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') Example: cash

account_id integer

account id Example: 16

card_number string

Example: architecto

card_holder_name string

Example: architecto

card_transaction_number string

Example: architecto

card_type string

Example: architecto

card_month string

Example: architecto

card_year string

Example: architecto

card_security string

Example: architecto

transaction_no_1 string

Example: architecto

transaction_no_2 string

Example: architecto

transaction_no_3 string

Example: architecto

bank_account_number string

Example: architecto

note string

payment note Example: architecto

cheque_number string

Example: architecto

Example request

curl --request POST \
    "https://gulfpos.com/connector/api/sell" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

const url = new URL(
    "https://gulfpos.com/connector/api/sell"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/sell';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/sell'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 6,
            "business_id": 1,
            "location_id": 1,
            "res_table_id": null,
            "res_waiter_id": null,
            "res_order_status": null,
            "type": "sell",
            "sub_type": null,
            "status": "final",
            "is_quotation": 0,
            "payment_status": "paid",
            "adjustment_type": null,
            "contact_id": 4,
            "customer_group_id": null,
            "invoice_no": "AS0001",
            "ref_no": "",
            "source": null,
            "subscription_no": null,
            "subscription_repeat_on": null,
            "transaction_date": "2018-04-10 13:23:21",
            "total_before_tax": "770.0000",
            "tax_id": null,
            "tax_amount": "0.0000",
            "discount_type": "percentage",
            "discount_amount": "0.0000",
            "rp_redeemed": 0,
            "rp_redeemed_amount": "0.0000",
            "shipping_details": null,
            "shipping_address": null,
            "shipping_status": null,
            "delivered_to": null,
            "shipping_charges": "0.0000",
            "additional_notes": null,
            "staff_note": null,
            "round_off_amount": "0.0000",
            "final_total": "770.0000",
            "expense_category_id": null,
            "expense_for": null,
            "commission_agent": null,
            "document": null,
            "is_direct_sale": 0,
            "is_suspend": 0,
            "exchange_rate": "1.000",
            "total_amount_recovered": null,
            "transfer_parent_id": null,
            "return_parent_id": null,
            "opening_stock_product_id": null,
            "created_by": 1,
            "import_batch": null,
            "import_time": null,
            "types_of_service_id": null,
            "packing_charge": null,
            "packing_charge_type": null,
            "service_custom_field_1": null,
            "service_custom_field_2": null,
            "service_custom_field_3": null,
            "service_custom_field_4": null,
            "mfg_parent_production_purchase_id": null,
            "mfg_wasted_units": null,
            "mfg_production_cost": "0.0000",
            "mfg_is_final": 0,
            "is_created_from_api": 0,
            "essentials_duration": "0.00",
            "essentials_duration_unit": null,
            "essentials_amount_per_unit_duration": "0.0000",
            "essentials_allowances": null,
            "essentials_deductions": null,
            "rp_earned": 0,
            "repair_completed_on": null,
            "repair_warranty_id": null,
            "repair_brand_id": null,
            "repair_status_id": null,
            "repair_model_id": null,
            "repair_defects": null,
            "repair_serial_no": null,
            "repair_updates_email": 0,
            "repair_updates_sms": 0,
            "repair_checklist": null,
            "repair_security_pwd": null,
            "repair_security_pattern": null,
            "repair_due_date": null,
            "repair_device_id": null,
            "order_addresses": null,
            "is_recurring": 0,
            "recur_interval": null,
            "recur_interval_type": null,
            "recur_repetitions": null,
            "recur_stopped_on": null,
            "recur_parent_id": null,
            "invoice_token": null,
            "pay_term_number": null,
            "pay_term_type": null,
            "pjt_project_id": null,
            "pjt_title": null,
            "woocommerce_order_id": null,
            "selling_price_group_id": null,
            "created_at": "2018-01-06 07:06:11",
            "updated_at": "2018-01-06 07:06:11",
            "invoice_url": "http://local.pos.com/invoice/6dfd77eb80f4976b456128e7f1311c9f",
            "payment_link": "http://local.pos.com/pay/6dfd77eb80f4976b456128e7f1311c9f",
            "sell_lines": [
                {
                    "id": 1,
                    "transaction_id": 6,
                    "product_id": 2,
                    "variation_id": 3,
                    "quantity": 10,
                    "mfg_waste_percent": "0.0000",
                    "quantity_returned": "0.0000",
                    "unit_price_before_discount": "70.0000",
                    "unit_price": "70.0000",
                    "line_discount_type": null,
                    "line_discount_amount": "0.0000",
                    "unit_price_inc_tax": "77.0000",
                    "item_tax": "7.0000",
                    "tax_id": 1,
                    "discount_id": null,
                    "lot_no_line_id": null,
                    "sell_line_note": null,
                    "res_service_staff_id": null,
                    "res_line_order_status": null,
                    "woocommerce_line_items_id": null,
                    "parent_sell_line_id": null,
                    "children_type": "",
                    "sub_unit_id": null,
                    "created_at": "2018-01-06 07:06:11",
                    "updated_at": "2018-01-06 07:06:11"
                }
            ],
            "payment_lines": [
                {
                    "id": 1,
                    "transaction_id": 6,
                    "business_id": null,
                    "is_return": 0,
                    "amount": "770.0000",
                    "method": "cash",
                    "transaction_no": null,
                    "card_transaction_number": null,
                    "card_number": null,
                    "card_type": "visa",
                    "card_holder_name": null,
                    "card_month": null,
                    "card_year": null,
                    "card_security": null,
                    "cheque_number": null,
                    "bank_account_number": null,
                    "paid_on": "2018-01-09 17:30:35",
                    "created_by": 1,
                    "payment_for": null,
                    "parent_id": null,
                    "note": null,
                    "document": null,
                    "payment_ref_no": null,
                    "account_id": null,
                    "created_at": "2018-01-06 01:36:11",
                    "updated_at": "2018-01-06 01:36:11"
                }
            ]
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Body Parameters

sells object optional

* object optional

location_id integer

id of the business location Example: 1

contact_id integer

id of the customer Example: 16

transaction_date string optional

transaction date format:Y-m-d H:i:s, Example: 2020-07-22 15:48:29

invoice_no string optional

Invoice number Example: architecto

source string optional

Source of the invoice Example: api, phone, woocommerce

status string optional

sale status (final, draft) Example: final

sub_status string optional

sale sub status ("quotation" for quotation and "proforma" for proforma invoice)

is_quotation boolean optional true false

Is sell quotation (0, 1), If 1 status should be draft Example: true

tax_rate_id integer optional

id of the tax rate applicable to the sale Example: 16

discount_amount number optional

discount amount applicable to the sale Example: 10

discount_type string optional

type of the discount amount (fixed, percentage) Example: fixed

sale_note string optional

Example: architecto

staff_note string optional

Example: architecto

commission_agent integer optional

commission agent id Example: 16

shipping_details string optional

shipping details Example: Express Delivery

shipping_address string optional

shipping address Example: architecto

shipping_status string optional

('ordered', 'packed', 'shipped', 'delivered', 'cancelled') Example: ordered

delivered_to string optional

Name of the person recieved the consignment Example: 'Mr robin'

shipping_charges number optional

shipping amount Example: 10

packing_charge number optional

packing charge Example: 10

exchange_rate number optional

exchange rate for the currency used Example: 1

selling_price_group_id integer optional

id of the selling price group Example: 16

pay_term_number integer optional

pay term value Example: 3

pay_term_type string optional

type of the pay term value ('days', 'months') Example: months

is_suspend boolean optional true false

Is suspended sale (0, 1) Example: false

is_recurring integer optional

whether the invoice is recurring (0, 1) Example: 0

recur_interval integer optional

value of the interval invoice will be regenerated Example: 16

recur_interval_type string optional

type of the recur interval ('days', 'months', 'years') Example: months

subscription_repeat_on integer optional

day of the month on which invoice will be generated if recur interval type is months (1-30) Example: 15

subscription_no string optional

subscription number Example: architecto

recur_repetitions integer optional

total number of invoices to be generated Example: 16

rp_redeemed integer optional

reward points redeemed Example: 16

rp_redeemed_amount number optional

reward point redeemed amount after conversion Example: 13.5

types_of_service_id integer optional

types of service id Example: 16

service_custom_field_1 string optional

types of service custom field 1 Example: architecto

service_custom_field_2 string optional

types of service custom field 2 Example: architecto

service_custom_field_3 string optional

types of service custom field 3 Example: architecto

service_custom_field_4 string optional

types of service custom field 4 Example: architecto

service_custom_field_5 string optional

types of service custom field 5 Example: architecto

service_custom_field_6 string optional

types of service custom field 6 Example: architecto

round_off_amount number optional

round off amount on total payable Example: 4326.41688

table_id integer optional

id of the table Example: 16

service_staff_id integer optional

id of the service staff assigned to the sale Example: 16

change_return number optional

Excess paid amount Example: 0

products string[]

array of the products for the sale

* object optional

product_id integer

product id Example: 17

variation_id integer

variation id Example: 58

quantity number

quantity Example: 1

unit_price number optional

unit selling price Example: 437.5

tax_rate_id integer optional

tax rate id applicable on the product

discount_amount number optional

discount amount applicable on the product Example: 0

discount_type string optional

type of discount amount ('fixed', 'percentage') Example: percentage

sub_unit_id integer optional

sub unit id Example: 16

note string optional

note for the product Example: architecto

payments string[] optional

payment lines for the sale

* object optional

amount number

amount of the payment Example: 453.13

method string optional

payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') Example: cash

account_id integer optional

account id Example: 16

card_number string optional

Example: architecto

card_holder_name string optional

Example: architecto

card_transaction_number string optional

Example: architecto

card_type string optional

Example: architecto

card_month string optional

Example: architecto

card_year string optional

Example: architecto

card_security string optional

Example: architecto

transaction_no_1 string optional

Example: architecto

transaction_no_2 string optional

Example: architecto

transaction_no_3 string optional

Example: architecto

bank_account_number string optional

Example: architecto

note string optional

payment note Example: architecto

cheque_number string optional

Example: architecto

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/sell/{id}

Get the specified sell

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the sell. Example: `architecto`
`sell`	string	required	comma separated ids of the sells Example: `55`

Query Parameters

Name	Type	Status	Description
`send_purchase_details`	string	optional	Get purchase details of each sell line (1, 0) Example: `architecto`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/sell/architecto?send_purchase_details=architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/sell/architecto"
);

const params = {
    "send_purchase_details": "architecto",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/sell/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'send_purchase_details' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/sell/architecto'
params = {
  'send_purchase_details': 'architecto',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 55,
            "business_id": 1,
            "location_id": 1,
            "res_table_id": 5,
            "res_waiter_id": null,
            "res_order_status": null,
            "type": "sell",
            "sub_type": null,
            "status": "final",
            "is_quotation": 0,
            "payment_status": "paid",
            "adjustment_type": null,
            "contact_id": 1,
            "customer_group_id": null,
            "invoice_no": "AS0007",
            "ref_no": "",
            "source": null,
            "subscription_no": null,
            "subscription_repeat_on": null,
            "transaction_date": "2020-06-04 23:29:36",
            "total_before_tax": "437.5000",
            "tax_id": 1,
            "tax_amount": "39.3750",
            "discount_type": "percentage",
            "discount_amount": "10.0000",
            "rp_redeemed": 0,
            "rp_redeemed_amount": "0.0000",
            "shipping_details": "Express Delivery",
            "shipping_address": null,
            "shipping_status": "ordered",
            "delivered_to": "Mr Robin",
            "shipping_charges": "10.0000",
            "additional_notes": null,
            "staff_note": null,
            "round_off_amount": "0.0000",
            "final_total": "453.1300",
            "expense_category_id": null,
            "expense_for": null,
            "commission_agent": null,
            "document": null,
            "is_direct_sale": 0,
            "is_suspend": 0,
            "exchange_rate": "1.000",
            "total_amount_recovered": null,
            "transfer_parent_id": null,
            "return_parent_id": null,
            "opening_stock_product_id": null,
            "created_by": 9,
            "import_batch": null,
            "import_time": null,
            "types_of_service_id": 1,
            "packing_charge": "10.0000",
            "packing_charge_type": "fixed",
            "service_custom_field_1": null,
            "service_custom_field_2": null,
            "service_custom_field_3": null,
            "service_custom_field_4": null,
            "mfg_parent_production_purchase_id": null,
            "mfg_wasted_units": null,
            "mfg_production_cost": "0.0000",
            "mfg_is_final": 0,
            "is_created_from_api": 0,
            "essentials_duration": "0.00",
            "essentials_duration_unit": null,
            "essentials_amount_per_unit_duration": "0.0000",
            "essentials_allowances": null,
            "essentials_deductions": null,
            "rp_earned": 0,
            "repair_completed_on": null,
            "repair_warranty_id": null,
            "repair_brand_id": null,
            "repair_status_id": null,
            "repair_model_id": null,
            "repair_defects": null,
            "repair_serial_no": null,
            "repair_updates_email": 0,
            "repair_updates_sms": 0,
            "repair_checklist": null,
            "repair_security_pwd": null,
            "repair_security_pattern": null,
            "repair_due_date": null,
            "repair_device_id": null,
            "order_addresses": null,
            "is_recurring": 0,
            "recur_interval": null,
            "recur_interval_type": "days",
            "recur_repetitions": 0,
            "recur_stopped_on": null,
            "recur_parent_id": null,
            "invoice_token": null,
            "pay_term_number": null,
            "pay_term_type": null,
            "pjt_project_id": null,
            "pjt_title": null,
            "woocommerce_order_id": null,
            "selling_price_group_id": 0,
            "created_at": "2020-06-04 23:29:36",
            "updated_at": "2020-06-04 23:29:36",
            "sell_lines": [
                {
                    "id": 38,
                    "transaction_id": 55,
                    "product_id": 17,
                    "variation_id": 58,
                    "quantity": 1,
                    "mfg_waste_percent": "0.0000",
                    "quantity_returned": "0.0000",
                    "unit_price_before_discount": "437.5000",
                    "unit_price": "437.5000",
                    "line_discount_type": "fixed",
                    "line_discount_amount": "0.0000",
                    "unit_price_inc_tax": "437.5000",
                    "item_tax": "0.0000",
                    "tax_id": null,
                    "discount_id": null,
                    "lot_no_line_id": null,
                    "sell_line_note": "",
                    "res_service_staff_id": null,
                    "res_line_order_status": null,
                    "woocommerce_line_items_id": null,
                    "parent_sell_line_id": null,
                    "children_type": "",
                    "sub_unit_id": null,
                    "created_at": "2020-06-04 23:29:36",
                    "updated_at": "2020-06-04 23:29:36"
                }
            ],
            "payment_lines": [
                {
                    "id": 37,
                    "transaction_id": 55,
                    "business_id": 1,
                    "is_return": 0,
                    "amount": "453.1300",
                    "method": "cash",
                    "transaction_no": null,
                    "card_transaction_number": null,
                    "card_number": null,
                    "card_type": "credit",
                    "card_holder_name": null,
                    "card_month": null,
                    "card_year": null,
                    "card_security": null,
                    "cheque_number": null,
                    "bank_account_number": null,
                    "paid_on": "2020-06-04 23:29:36",
                    "created_by": 9,
                    "payment_for": 1,
                    "parent_id": null,
                    "note": null,
                    "document": null,
                    "payment_ref_no": "SP2020/0002",
                    "account_id": null,
                    "created_at": "2020-06-04 23:29:36",
                    "updated_at": "2020-06-04 23:29:36"
                }
            ],
            "invoice_url": "http://local.pos.com/invoice/6dfd77eb80f4976b456128e7f1311c9f",
            "payment_link": "http://local.pos.com/pay/6dfd77eb80f4976b456128e7f1311c9f"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

PUT PATCH connector/api/sell/{id}

Update sell

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the sell. Example: `architecto`
`sell`	string	required	id of sell to update Example: `6`

Body Parameters

contact_id integer

id of the customer Example: 16

transaction_date string

transaction date format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

status string

sale status (final, draft) Example: final

sub_status string

sale sub status ("quotation" for quotation and "proforma" for proforma invoice)

is_quotation boolean

Is sell quotation (0, 1), If 1 status should be draft Example: true

tax_rate_id integer

id of the tax rate applicable to the sale Example: 16

discount_amount number

discount amount applicable to the sale Example: 10

discount_type string

type of the discount amount (fixed, percentage) Example: fixed

sale_note string

Example: architecto

source string

Source of the invoice Example: architecto

staff_note string

Example: architecto

is_suspend boolean

Is suspended sale (0, 1) Example: false

commission_agent integer

commission agent id Example: 16

shipping_details string

shipping details Example: Express Delivery

shipping_address string

shipping address Example: architecto

shipping_status string

('ordered', 'packed', 'shipped', 'delivered', 'cancelled') Example: ordered

delivered_to string

Name of the person recieved the consignment Example: Mr Robin

shipping_charges number

shipping amount Example: 10

packing_charge number

packing charge Example: 10

exchange_rate number

exchange rate for the currency used Example: 1

selling_price_group_id integer

id of the selling price group Example: 16

pay_term_number integer

pay term value Example: 16

pay_term_type string

type of the pay term value ('days', 'months') Example: months

is_recurring integer

whether the invoice is recurring (0, 1) Example: 0

recur_interval integer

value of the interval invoice will be regenerated Example: 16

recur_interval_type string

type of the recur interval ('days', 'months', 'years') Example: days

subscription_repeat_on integer

day of the month on which invoice will be generated if recur interval type is months (1-30) Example: 7

subscription_no string

subscription number Example: architecto

recur_repetitions integer

total number of invoices to be generated Example: 16

rp_redeemed integer

reward points redeemed Example: 16

rp_redeemed_amount number

reward point redeemed amount after conversion Example: 13.5

types_of_service_id integer

types of service id Example: 16

service_custom_field_1 string

types of service custom field 1 Example: architecto

service_custom_field_2 string

types of service custom field 2 Example: architecto

service_custom_field_3 string

types of service custom field 3 Example: architecto

service_custom_field_4 string

types of service custom field 4 Example: architecto

service_custom_field_5 string

types of service custom field 5 Example: architecto

service_custom_field_6 string

types of service custom field 6 Example: architecto

round_off_amount number

round off amount on total payable Example: 4326.41688

table_id integer

id of the table Example: 16

service_staff_id integer

id of the service staff assigned to the sale Example: 16

change_return number

Excess paid amount Example: 0

change_return_id integer

id of the change return payment if exists Example: 16

products string[]

array of the products for the sale

* object

sell_line_id integer

sell line id for existing item only Example: 16

product_id integer

product id Example: 17

variation_id integer

variation id Example: 58

quantity number

quantity Example: 1

unit_price number

unit selling price Example: 437.5

tax_rate_id integer

tax rate id applicable on the product Example: 16

discount_amount number

discount amount applicable on the product Example: 0

discount_type string

type of discount amount ('fixed', 'percentage') Example: percentage

sub_unit_id integer

sub unit id Example: 16

note string

note for the product Example: architecto

payments string[]

payment lines for the sale

* object

payment_id integer

payment id for existing payment line Example: 16

amount number

amount of the payment Example: 453.13

method string

payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') Example: cash

account_id integer

account id Example: 16

card_number string

Example: architecto

card_holder_name string

Example: architecto

card_transaction_number string

Example: architecto

card_type string

Example: architecto

card_month string

Example: architecto

card_year string

Example: architecto

card_security string

Example: architecto

transaction_no_1 string

Example: architecto

transaction_no_2 string

Example: architecto

transaction_no_3 string

Example: architecto

note string

payment note Example: architecto

cheque_number string

Example: architecto

bank_account_number string

Example: architecto

Example request

curl --request PUT \
    "https://gulfpos.com/connector/api/sell/architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contact_id\": 16,
    \"transaction_date\": \"2020-5-7 15:20:22\",
    \"status\": \"final\",
    \"sub_status\": null,
    \"is_quotation\": true,
    \"tax_rate_id\": 16,
    \"discount_amount\": 10,
    \"discount_type\": \"fixed\",
    \"sale_note\": \"architecto\",
    \"source\": \"architecto\",
    \"staff_note\": \"architecto\",
    \"is_suspend\": false,
    \"commission_agent\": 16,
    \"shipping_details\": \"Express Delivery\",
    \"shipping_address\": \"architecto\",
    \"shipping_status\": \"ordered\",
    \"delivered_to\": \"Mr Robin\",
    \"shipping_charges\": 10,
    \"packing_charge\": 10,
    \"exchange_rate\": 1,
    \"selling_price_group_id\": 16,
    \"pay_term_number\": 16,
    \"pay_term_type\": \"months\",
    \"is_recurring\": 0,
    \"recur_interval\": 16,
    \"recur_interval_type\": \"days\",
    \"subscription_repeat_on\": 7,
    \"subscription_no\": \"architecto\",
    \"recur_repetitions\": 16,
    \"rp_redeemed\": 16,
    \"rp_redeemed_amount\": 13.5,
    \"types_of_service_id\": 16,
    \"service_custom_field_1\": \"architecto\",
    \"service_custom_field_2\": \"architecto\",
    \"service_custom_field_3\": \"architecto\",
    \"service_custom_field_4\": \"architecto\",
    \"service_custom_field_5\": \"architecto\",
    \"service_custom_field_6\": \"architecto\",
    \"round_off_amount\": 4326.41688,
    \"table_id\": 16,
    \"service_staff_id\": 16,
    \"change_return\": 0,
    \"change_return_id\": 16,
    \"products\": [
        \"architecto\"
    ],
    \"payments\": [
        \"architecto\"
    ]
}"

const url = new URL(
    "https://gulfpos.com/connector/api/sell/architecto"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "contact_id": 16,
    "transaction_date": "2020-5-7 15:20:22",
    "status": "final",
    "sub_status": null,
    "is_quotation": true,
    "tax_rate_id": 16,
    "discount_amount": 10,
    "discount_type": "fixed",
    "sale_note": "architecto",
    "source": "architecto",
    "staff_note": "architecto",
    "is_suspend": false,
    "commission_agent": 16,
    "shipping_details": "Express Delivery",
    "shipping_address": "architecto",
    "shipping_status": "ordered",
    "delivered_to": "Mr Robin",
    "shipping_charges": 10,
    "packing_charge": 10,
    "exchange_rate": 1,
    "selling_price_group_id": 16,
    "pay_term_number": 16,
    "pay_term_type": "months",
    "is_recurring": 0,
    "recur_interval": 16,
    "recur_interval_type": "days",
    "subscription_repeat_on": 7,
    "subscription_no": "architecto",
    "recur_repetitions": 16,
    "rp_redeemed": 16,
    "rp_redeemed_amount": 13.5,
    "types_of_service_id": 16,
    "service_custom_field_1": "architecto",
    "service_custom_field_2": "architecto",
    "service_custom_field_3": "architecto",
    "service_custom_field_4": "architecto",
    "service_custom_field_5": "architecto",
    "service_custom_field_6": "architecto",
    "round_off_amount": 4326.41688,
    "table_id": 16,
    "service_staff_id": 16,
    "change_return": 0,
    "change_return_id": 16,
    "products": [
        "architecto"
    ],
    "payments": [
        "architecto"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/sell/architecto';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'contact_id' => 16,
            'transaction_date' => '2020-5-7 15:20:22',
            'status' => 'final',
            'sub_status' => null,
            'is_quotation' => true,
            'tax_rate_id' => 16,
            'discount_amount' => 10.0,
            'discount_type' => 'fixed',
            'sale_note' => 'architecto',
            'source' => 'architecto',
            'staff_note' => 'architecto',
            'is_suspend' => false,
            'commission_agent' => 16,
            'shipping_details' => 'Express Delivery',
            'shipping_address' => 'architecto',
            'shipping_status' => 'ordered',
            'delivered_to' => 'Mr Robin',
            'shipping_charges' => 10.0,
            'packing_charge' => 10.0,
            'exchange_rate' => 1.0,
            'selling_price_group_id' => 16,
            'pay_term_number' => 16,
            'pay_term_type' => 'months',
            'is_recurring' => 0,
            'recur_interval' => 16,
            'recur_interval_type' => 'days',
            'subscription_repeat_on' => 7,
            'subscription_no' => 'architecto',
            'recur_repetitions' => 16,
            'rp_redeemed' => 16,
            'rp_redeemed_amount' => 13.5,
            'types_of_service_id' => 16,
            'service_custom_field_1' => 'architecto',
            'service_custom_field_2' => 'architecto',
            'service_custom_field_3' => 'architecto',
            'service_custom_field_4' => 'architecto',
            'service_custom_field_5' => 'architecto',
            'service_custom_field_6' => 'architecto',
            'round_off_amount' => 4326.41688,
            'table_id' => 16,
            'service_staff_id' => 16,
            'change_return' => 0.0,
            'change_return_id' => 16,
            'products' => ['architecto'],
            'payments' => ['architecto'],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/sell/architecto'
payload = {
    "contact_id": 16,
    "transaction_date": "2020-5-7 15:20:22",
    "status": "final",
    "sub_status": null,
    "is_quotation": true,
    "tax_rate_id": 16,
    "discount_amount": 10,
    "discount_type": "fixed",
    "sale_note": "architecto",
    "source": "architecto",
    "staff_note": "architecto",
    "is_suspend": false,
    "commission_agent": 16,
    "shipping_details": "Express Delivery",
    "shipping_address": "architecto",
    "shipping_status": "ordered",
    "delivered_to": "Mr Robin",
    "shipping_charges": 10,
    "packing_charge": 10,
    "exchange_rate": 1,
    "selling_price_group_id": 16,
    "pay_term_number": 16,
    "pay_term_type": "months",
    "is_recurring": 0,
    "recur_interval": 16,
    "recur_interval_type": "days",
    "subscription_repeat_on": 7,
    "subscription_no": "architecto",
    "recur_repetitions": 16,
    "rp_redeemed": 16,
    "rp_redeemed_amount": 13.5,
    "types_of_service_id": 16,
    "service_custom_field_1": "architecto",
    "service_custom_field_2": "architecto",
    "service_custom_field_3": "architecto",
    "service_custom_field_4": "architecto",
    "service_custom_field_5": "architecto",
    "service_custom_field_6": "architecto",
    "round_off_amount": 4326.41688,
    "table_id": 16,
    "service_staff_id": 16,
    "change_return": 0,
    "change_return_id": 16,
    "products": [
        "architecto"
    ],
    "payments": [
        "architecto"
    ]
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response

Response 200

{
    "id": 91,
    "business_id": 1,
    "location_id": 1,
    "res_table_id": null,
    "res_waiter_id": null,
    "res_order_status": null,
    "type": "sell",
    "sub_type": null,
    "status": "final",
    "is_quotation": 0,
    "payment_status": "paid",
    "adjustment_type": null,
    "contact_id": 1,
    "customer_group_id": 1,
    "invoice_no": "AS0020",
    "ref_no": "",
    "source": null,
    "subscription_no": null,
    "subscription_repeat_on": null,
    "transaction_date": "25-09-2020 15:22",
    "total_before_tax": 962.5,
    "tax_id": null,
    "tax_amount": 0,
    "discount_type": "fixed",
    "discount_amount": "19.5000",
    "rp_redeemed": 0,
    "rp_redeemed_amount": "0.0000",
    "shipping_details": null,
    "shipping_address": null,
    "shipping_status": null,
    "delivered_to": null,
    "shipping_charges": "0.0000",
    "additional_notes": null,
    "staff_note": null,
    "round_off_amount": "0.0000",
    "final_total": 943,
    "expense_category_id": null,
    "expense_for": null,
    "commission_agent": null,
    "document": null,
    "is_direct_sale": 0,
    "is_suspend": 0,
    "exchange_rate": "1.000",
    "total_amount_recovered": null,
    "transfer_parent_id": null,
    "return_parent_id": null,
    "opening_stock_product_id": null,
    "created_by": 9,
    "import_batch": null,
    "import_time": null,
    "types_of_service_id": null,
    "packing_charge": "0.0000",
    "packing_charge_type": null,
    "service_custom_field_1": null,
    "service_custom_field_2": null,
    "service_custom_field_3": null,
    "service_custom_field_4": null,
    "mfg_parent_production_purchase_id": null,
    "mfg_wasted_units": null,
    "mfg_production_cost": "0.0000",
    "mfg_production_cost_type": "percentage",
    "mfg_is_final": 0,
    "is_created_from_api": 0,
    "essentials_duration": "0.00",
    "essentials_duration_unit": null,
    "essentials_amount_per_unit_duration": "0.0000",
    "essentials_allowances": null,
    "essentials_deductions": null,
    "rp_earned": 0,
    "repair_completed_on": null,
    "repair_warranty_id": null,
    "repair_brand_id": null,
    "repair_status_id": null,
    "repair_model_id": null,
    "repair_job_sheet_id": null,
    "repair_defects": null,
    "repair_serial_no": null,
    "repair_checklist": null,
    "repair_security_pwd": null,
    "repair_security_pattern": null,
    "repair_due_date": null,
    "repair_device_id": null,
    "repair_updates_notif": 0,
    "order_addresses": null,
    "is_recurring": 0,
    "recur_interval": 1,
    "recur_interval_type": "days",
    "recur_repetitions": 0,
    "recur_stopped_on": null,
    "recur_parent_id": null,
    "invoice_token": null,
    "pay_term_number": null,
    "pay_term_type": null,
    "pjt_project_id": null,
    "pjt_title": null,
    "woocommerce_order_id": null,
    "selling_price_group_id": 0,
    "created_at": "2020-09-23 20:16:19",
    "updated_at": "2020-09-25 17:57:08",
    "payment_lines": [
        {
            "id": 55,
            "transaction_id": 91,
            "business_id": 1,
            "is_return": 0,
            "amount": "461.7500",
            "method": "cash",
            "transaction_no": null,
            "card_transaction_number": null,
            "card_number": null,
            "card_type": "credit",
            "card_holder_name": null,
            "card_month": null,
            "card_year": null,
            "card_security": null,
            "cheque_number": null,
            "bank_account_number": null,
            "paid_on": "2020-09-23 20:16:19",
            "created_by": 9,
            "is_advance": 0,
            "payment_for": 1,
            "parent_id": null,
            "note": null,
            "document": null,
            "payment_ref_no": "SP2020/0018",
            "account_id": null,
            "created_at": "2020-09-23 20:16:19",
            "updated_at": "2020-09-23 20:16:19"
        }
    ],
    "invoice_url": "http://local.pos.com/invoice/6dfd77eb80f4976b456128e7f1311c9f",
    "payment_link": "http://local.pos.com/pay/6dfd77eb80f4976b456128e7f1311c9f"
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

URL Parameters

id *

sell *

Body Parameters

contact_id integer optional

id of the customer Example: 16

transaction_date string optional

transaction date format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

status string optional

sale status (final, draft) Example: final

sub_status string optional

sale sub status ("quotation" for quotation and "proforma" for proforma invoice)

is_quotation boolean optional true false

Is sell quotation (0, 1), If 1 status should be draft Example: true

tax_rate_id integer optional

id of the tax rate applicable to the sale Example: 16

discount_amount number optional

discount amount applicable to the sale Example: 10

discount_type string optional

type of the discount amount (fixed, percentage) Example: fixed

sale_note string optional

Example: architecto

source string optional

Source of the invoice Example: architecto

staff_note string optional

Example: architecto

is_suspend boolean optional true false

Is suspended sale (0, 1) Example: false

commission_agent integer optional

commission agent id Example: 16

shipping_details string optional

shipping details Example: Express Delivery

shipping_address string optional

shipping address Example: architecto

shipping_status string optional

('ordered', 'packed', 'shipped', 'delivered', 'cancelled') Example: ordered

delivered_to string optional

Name of the person recieved the consignment Example: Mr Robin

shipping_charges number optional

shipping amount Example: 10

packing_charge number optional

packing charge Example: 10

exchange_rate number optional

exchange rate for the currency used Example: 1

selling_price_group_id integer optional

id of the selling price group Example: 16

pay_term_number integer optional

pay term value Example: 16

pay_term_type string optional

type of the pay term value ('days', 'months') Example: months

is_recurring integer optional

whether the invoice is recurring (0, 1) Example: 0

recur_interval integer optional

value of the interval invoice will be regenerated Example: 16

recur_interval_type string optional

type of the recur interval ('days', 'months', 'years') Example: days

subscription_repeat_on integer optional

day of the month on which invoice will be generated if recur interval type is months (1-30) Example: 7

subscription_no string optional

subscription number Example: architecto

recur_repetitions integer optional

total number of invoices to be generated Example: 16

rp_redeemed integer optional

reward points redeemed Example: 16

rp_redeemed_amount number optional

reward point redeemed amount after conversion Example: 13.5

types_of_service_id integer optional

types of service id Example: 16

service_custom_field_1 string optional

types of service custom field 1 Example: architecto

service_custom_field_2 string optional

types of service custom field 2 Example: architecto

service_custom_field_3 string optional

types of service custom field 3 Example: architecto

service_custom_field_4 string optional

types of service custom field 4 Example: architecto

service_custom_field_5 string optional

types of service custom field 5 Example: architecto

service_custom_field_6 string optional

types of service custom field 6 Example: architecto

round_off_amount number optional

round off amount on total payable Example: 4326.41688

table_id integer optional

id of the table Example: 16

service_staff_id integer optional

id of the service staff assigned to the sale Example: 16

change_return number optional

Excess paid amount Example: 0

change_return_id integer optional

id of the change return payment if exists Example: 16

products string[]

array of the products for the sale

* object optional

sell_line_id integer optional

sell line id for existing item only Example: 16

product_id integer optional

product id Example: 17

variation_id integer optional

variation id Example: 58

quantity number optional

quantity Example: 1

unit_price number optional

unit selling price Example: 437.5

tax_rate_id integer optional

tax rate id applicable on the product Example: 16

discount_amount number optional

discount amount applicable on the product Example: 0

discount_type string optional

type of discount amount ('fixed', 'percentage') Example: percentage

sub_unit_id integer optional

sub unit id Example: 16

note string optional

note for the product Example: architecto

payments string[] optional

payment lines for the sale

* object optional

payment_id integer optional

payment id for existing payment line Example: 16

amount number optional

amount of the payment Example: 453.13

method string optional

payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') Example: cash

account_id integer optional

account id Example: 16

card_number string optional

Example: architecto

card_holder_name string optional

Example: architecto

card_transaction_number string optional

Example: architecto

card_type string optional

Example: architecto

card_month string optional

Example: architecto

card_year string optional

Example: architecto

card_security string optional

Example: architecto

transaction_no_1 string optional

Example: architecto

transaction_no_2 string optional

Example: architecto

transaction_no_3 string optional

Example: architecto

note string optional

payment note Example: architecto

cheque_number string optional

Example: architecto

bank_account_number string optional

Example: architecto

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

DELETE connector/api/sell/{id}

Delete Sell

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the sell. Example: `architecto`
`sell`	string	required	id of the sell to be deleted Example: `architecto`

Example request

curl --request DELETE \
    "https://gulfpos.com/connector/api/sell/architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/sell/architecto"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/sell/architecto';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/sell/architecto'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST connector/api/sell-return

Add Sell Return

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Body Parameters

transaction_id integer

Id of the sell Example: 16

transaction_date string

transaction date format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

invoice_no string

Invoice number of the return Example: architecto

discount_amount number

discount amount applicable to the sale Example: 10

discount_type string

type of the discount amount (fixed, percentage) Example: fixed

products string[]

array of the products for the sale

* object

sell_line_id integer

sell line id Example: 16

quantity number

quantity to be returned from the sell line Example: 1

unit_price_inc_tax number

unit selling price of the returning item Example: 437.5

Example request

curl --request POST \
    "https://gulfpos.com/connector/api/sell-return" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"transaction_id\": 16,
    \"transaction_date\": \"2020-5-7 15:20:22\",
    \"invoice_no\": \"architecto\",
    \"discount_amount\": 10,
    \"discount_type\": \"fixed\",
    \"products\": [
        \"architecto\"
    ]
}"

const url = new URL(
    "https://gulfpos.com/connector/api/sell-return"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "transaction_id": 16,
    "transaction_date": "2020-5-7 15:20:22",
    "invoice_no": "architecto",
    "discount_amount": 10,
    "discount_type": "fixed",
    "products": [
        "architecto"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/sell-return';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'transaction_id' => 16,
            'transaction_date' => '2020-5-7 15:20:22',
            'invoice_no' => 'architecto',
            'discount_amount' => 10.0,
            'discount_type' => 'fixed',
            'products' => ['architecto'],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/sell-return'
payload = {
    "transaction_id": 16,
    "transaction_date": "2020-5-7 15:20:22",
    "invoice_no": "architecto",
    "discount_amount": 10,
    "discount_type": "fixed",
    "products": [
        "architecto"
    ]
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response

Response 200

{
    "id": 159,
    "business_id": 1,
    "location_id": 1,
    "res_table_id": null,
    "res_waiter_id": null,
    "res_order_status": null,
    "type": "sell_return",
    "sub_type": null,
    "status": "final",
    "is_quotation": 0,
    "payment_status": "paid",
    "adjustment_type": null,
    "contact_id": 1,
    "customer_group_id": null,
    "invoice_no": "CN2020/0005",
    "ref_no": null,
    "subscription_no": null,
    "subscription_repeat_on": null,
    "transaction_date": "2020-11-17 00:00:00",
    "total_before_tax": 3,
    "tax_id": null,
    "tax_amount": 0,
    "discount_type": "percentage",
    "discount_amount": 12,
    "rp_redeemed": 0,
    "rp_redeemed_amount": "0.0000",
    "shipping_details": null,
    "shipping_address": null,
    "shipping_status": null,
    "delivered_to": null,
    "shipping_charges": "0.0000",
    "additional_notes": null,
    "staff_note": null,
    "round_off_amount": "0.0000",
    "final_total": 2.64,
    "expense_category_id": null,
    "expense_for": null,
    "commission_agent": null,
    "document": null,
    "is_direct_sale": 0,
    "is_suspend": 0,
    "exchange_rate": "1.000",
    "total_amount_recovered": null,
    "transfer_parent_id": null,
    "return_parent_id": 157,
    "opening_stock_product_id": null,
    "created_by": 9,
    "import_batch": null,
    "import_time": null,
    "types_of_service_id": null,
    "packing_charge": null,
    "packing_charge_type": null,
    "service_custom_field_1": null,
    "service_custom_field_2": null,
    "service_custom_field_3": null,
    "service_custom_field_4": null,
    "mfg_parent_production_purchase_id": null,
    "mfg_wasted_units": null,
    "mfg_production_cost": "0.0000",
    "mfg_production_cost_type": "percentage",
    "mfg_is_final": 0,
    "is_created_from_api": 0,
    "essentials_duration": "0.00",
    "essentials_duration_unit": null,
    "essentials_amount_per_unit_duration": "0.0000",
    "essentials_allowances": null,
    "essentials_deductions": null,
    "rp_earned": 0,
    "repair_completed_on": null,
    "repair_warranty_id": null,
    "repair_brand_id": null,
    "repair_status_id": null,
    "repair_model_id": null,
    "repair_job_sheet_id": null,
    "repair_defects": null,
    "repair_serial_no": null,
    "repair_checklist": null,
    "repair_security_pwd": null,
    "repair_security_pattern": null,
    "repair_due_date": null,
    "repair_device_id": null,
    "repair_updates_notif": 0,
    "order_addresses": null,
    "is_recurring": 0,
    "recur_interval": null,
    "recur_interval_type": null,
    "recur_repetitions": null,
    "recur_stopped_on": null,
    "recur_parent_id": null,
    "invoice_token": null,
    "pay_term_number": null,
    "pay_term_type": null,
    "pjt_project_id": null,
    "pjt_title": null,
    "woocommerce_order_id": null,
    "selling_price_group_id": null,
    "created_at": "2020-11-17 12:05:11",
    "updated_at": "2020-11-17 13:22:09"
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Body Parameters

transaction_id integer

Id of the sell Example: 16

transaction_date string optional

transaction date format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

invoice_no string optional

Invoice number of the return Example: architecto

discount_amount number optional

discount amount applicable to the sale Example: 10

discount_type string optional

type of the discount amount (fixed, percentage) Example: fixed

products string[]

array of the products for the sale

* object optional

sell_line_id integer

sell line id Example: 16

quantity number

quantity to be returned from the sell line Example: 1

unit_price_inc_tax number

unit selling price of the returning item Example: 437.5

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/list-sell-return

List Sell Return

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`sell_id`	string	optional	Id of the sell for which return is added Example: `architecto`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/list-sell-return" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/list-sell-return"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/list-sell-return';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/list-sell-return'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 159,
            "business_id": 1,
            "location_id": 1,
            "res_table_id": null,
            "res_waiter_id": null,
            "res_order_status": null,
            "type": "sell_return",
            "sub_type": null,
            "status": "final",
            "is_quotation": 0,
            "payment_status": "partial",
            "adjustment_type": null,
            "contact_id": 1,
            "customer_group_id": null,
            "invoice_no": "CN2020/0005",
            "ref_no": null,
            "subscription_no": null,
            "subscription_repeat_on": null,
            "transaction_date": "2020-11-17 00:00:00",
            "total_before_tax": "3.0000",
            "tax_id": null,
            "tax_amount": "0.0000",
            "discount_type": "percentage",
            "discount_amount": "12.0000",
            "rp_redeemed": 0,
            "rp_redeemed_amount": "0.0000",
            "shipping_details": null,
            "shipping_address": null,
            "shipping_status": null,
            "delivered_to": null,
            "shipping_charges": "0.0000",
            "additional_notes": null,
            "staff_note": null,
            "round_off_amount": "0.0000",
            "final_total": "2.6400",
            "expense_category_id": null,
            "expense_for": null,
            "commission_agent": null,
            "document": null,
            "is_direct_sale": 0,
            "is_suspend": 0,
            "exchange_rate": "1.000",
            "total_amount_recovered": null,
            "transfer_parent_id": null,
            "return_parent_id": 157,
            "opening_stock_product_id": null,
            "created_by": 9,
            "import_batch": null,
            "import_time": null,
            "types_of_service_id": null,
            "packing_charge": null,
            "packing_charge_type": null,
            "service_custom_field_1": null,
            "service_custom_field_2": null,
            "service_custom_field_3": null,
            "service_custom_field_4": null,
            "mfg_parent_production_purchase_id": null,
            "mfg_wasted_units": null,
            "mfg_production_cost": "0.0000",
            "mfg_production_cost_type": "percentage",
            "mfg_is_final": 0,
            "is_created_from_api": 0,
            "essentials_duration": "0.00",
            "essentials_duration_unit": null,
            "essentials_amount_per_unit_duration": "0.0000",
            "essentials_allowances": null,
            "essentials_deductions": null,
            "rp_earned": 0,
            "repair_completed_on": null,
            "repair_warranty_id": null,
            "repair_brand_id": null,
            "repair_status_id": null,
            "repair_model_id": null,
            "repair_job_sheet_id": null,
            "repair_defects": null,
            "repair_serial_no": null,
            "repair_checklist": null,
            "repair_security_pwd": null,
            "repair_security_pattern": null,
            "repair_due_date": null,
            "repair_device_id": null,
            "repair_updates_notif": 0,
            "order_addresses": null,
            "is_recurring": 0,
            "recur_interval": null,
            "recur_interval_type": null,
            "recur_repetitions": null,
            "recur_stopped_on": null,
            "recur_parent_id": null,
            "invoice_token": null,
            "pay_term_number": null,
            "pay_term_type": null,
            "pjt_project_id": null,
            "pjt_title": null,
            "woocommerce_order_id": null,
            "selling_price_group_id": null,
            "created_at": "2020-11-17 12:05:11",
            "updated_at": "2020-11-17 13:22:09",
            "payment_lines": [
                {
                    "id": 126,
                    "transaction_id": 159,
                    "business_id": 1,
                    "is_return": 0,
                    "amount": "1.8000",
                    "method": "cash",
                    "transaction_no": null,
                    "card_transaction_number": null,
                    "card_number": null,
                    "card_type": "credit",
                    "card_holder_name": null,
                    "card_month": null,
                    "card_year": null,
                    "card_security": null,
                    "cheque_number": null,
                    "bank_account_number": null,
                    "paid_on": "2020-11-17 12:05:00",
                    "created_by": 9,
                    "is_advance": 0,
                    "payment_for": 1,
                    "parent_id": null,
                    "note": null,
                    "document": null,
                    "payment_ref_no": "SP2020/0078",
                    "account_id": null,
                    "created_at": "2020-11-17 12:05:58",
                    "updated_at": "2020-11-17 12:05:58"
                }
            ],
            "return_parent_sell": {
                "id": 157,
                "business_id": 1,
                "location_id": 1,
                "res_table_id": null,
                "res_waiter_id": null,
                "res_order_status": null,
                "type": "sell",
                "sub_type": null,
                "status": "final",
                "is_quotation": 0,
                "payment_status": "paid",
                "adjustment_type": null,
                "contact_id": 1,
                "customer_group_id": null,
                "invoice_no": "AS0073",
                "ref_no": "",
                "subscription_no": null,
                "subscription_repeat_on": null,
                "transaction_date": "2020-11-13 12:42:17",
                "total_before_tax": "6.2500",
                "tax_id": null,
                "tax_amount": "0.0000",
                "discount_type": "percentage",
                "discount_amount": "10.0000",
                "rp_redeemed": 0,
                "rp_redeemed_amount": "0.0000",
                "shipping_details": null,
                "shipping_address": null,
                "shipping_status": null,
                "delivered_to": null,
                "shipping_charges": "0.0000",
                "additional_notes": null,
                "staff_note": null,
                "round_off_amount": "0.0000",
                "final_total": "5.6300",
                "expense_category_id": null,
                "expense_for": null,
                "commission_agent": null,
                "document": null,
                "is_direct_sale": 0,
                "is_suspend": 0,
                "exchange_rate": "1.000",
                "total_amount_recovered": null,
                "transfer_parent_id": null,
                "return_parent_id": null,
                "opening_stock_product_id": null,
                "created_by": 9,
                "import_batch": null,
                "import_time": null,
                "types_of_service_id": null,
                "packing_charge": "0.0000",
                "packing_charge_type": null,
                "service_custom_field_1": null,
                "service_custom_field_2": null,
                "service_custom_field_3": null,
                "service_custom_field_4": null,
                "mfg_parent_production_purchase_id": null,
                "mfg_wasted_units": null,
                "mfg_production_cost": "0.0000",
                "mfg_production_cost_type": "percentage",
                "mfg_is_final": 0,
                "is_created_from_api": 0,
                "essentials_duration": "0.00",
                "essentials_duration_unit": null,
                "essentials_amount_per_unit_duration": "0.0000",
                "essentials_allowances": null,
                "essentials_deductions": null,
                "rp_earned": 0,
                "repair_completed_on": null,
                "repair_warranty_id": null,
                "repair_brand_id": null,
                "repair_status_id": null,
                "repair_model_id": null,
                "repair_job_sheet_id": null,
                "repair_defects": null,
                "repair_serial_no": null,
                "repair_checklist": null,
                "repair_security_pwd": null,
                "repair_security_pattern": null,
                "repair_due_date": null,
                "repair_device_id": null,
                "repair_updates_notif": 0,
                "order_addresses": null,
                "is_recurring": 0,
                "recur_interval": 1,
                "recur_interval_type": "days",
                "recur_repetitions": 0,
                "recur_stopped_on": null,
                "recur_parent_id": null,
                "invoice_token": null,
                "pay_term_number": null,
                "pay_term_type": null,
                "pjt_project_id": null,
                "pjt_title": null,
                "woocommerce_order_id": null,
                "selling_price_group_id": 0,
                "created_at": "2020-11-13 12:42:17",
                "updated_at": "2020-11-13 12:42:18",
                "sell_lines": [
                    {
                        "id": 139,
                        "transaction_id": 157,
                        "product_id": 157,
                        "variation_id": 205,
                        "quantity": 5,
                        "mfg_waste_percent": "0.0000",
                        "quantity_returned": "3.0000",
                        "unit_price_before_discount": "1.2500",
                        "unit_price": "1.2500",
                        "line_discount_type": "fixed",
                        "line_discount_amount": "0.0000",
                        "unit_price_inc_tax": "1.2500",
                        "item_tax": "0.0000",
                        "tax_id": null,
                        "discount_id": null,
                        "lot_no_line_id": null,
                        "sell_line_note": "",
                        "res_service_staff_id": null,
                        "res_line_order_status": null,
                        "woocommerce_line_items_id": null,
                        "parent_sell_line_id": null,
                        "children_type": "",
                        "sub_unit_id": null,
                        "created_at": "2020-11-13 12:42:17",
                        "updated_at": "2020-11-17 13:22:09"
                    }
                ]
            }
        }
    ],
    "links": {
        "first": "http://local.pos.com/connector/api/list-sell-return?sell_id=157&page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "http://local.pos.com/connector/api/list-sell-return",
        "per_page": 10,
        "to": 1
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST connector/api/update-shipping-status

Update shipping status

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Body Parameters

id integer

id of the sale Example: 16

shipping_status string

('ordered', 'packed', 'shipped', 'delivered', 'cancelled') Example: ordered

delivered_to string

Name of the consignee Example: architecto

Example request

curl --request POST \
    "https://gulfpos.com/connector/api/update-shipping-status" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 16,
    \"shipping_status\": \"ordered\",
    \"delivered_to\": \"architecto\"
}"

const url = new URL(
    "https://gulfpos.com/connector/api/update-shipping-status"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": 16,
    "shipping_status": "ordered",
    "delivered_to": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/update-shipping-status';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'id' => 16,
            'shipping_status' => 'ordered',
            'delivered_to' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/update-shipping-status'
payload = {
    "id": 16,
    "shipping_status": "ordered",
    "delivered_to": "architecto"
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/new_sell

New List sells

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Query Parameters

Name	Type	Status	Description
`location_id`	string	optional	id of the location Example: `1`
`contact_id`	string	optional	id of the customer Example: `architecto`
`payment_status`	string	optional	Comma separated values of payment statuses. Available values due, partial, paid, overdue Example: `due,partial`
`start_date`	string	optional	format:Y-m-d Example: `2018-06-25`
`end_date`	string	optional	format:Y-m-d Example: `2018-06-25`
`user_id`	string	optional	id of the user who created the sale Example: `architecto`
`service_staff_id`	string	optional	id of the service staff assigned with the sale Example: `architecto`
`shipping_status`	string	optional	Shipping Status of the sale ('ordered', 'packed', 'shipped', 'delivered', 'cancelled') Example: `ordered`
`source`	string	optional	Source of the sale Example: `architecto`
`customer_group_id`	string	optional	id of the customer group Example: `architecto`
`product_name`	string	optional	name of the product Example: `architecto`
`product_sku`	string	optional	sku of the product or variation Example: `architecto`
`product_custom_field_1`	string	optional	custome field 1 of the product Example: `architecto`
`location_custom_field_1`	string	optional	custome field 1 of the location Example: `architecto`
`location_invoice_scheme_prefix`	string	optional	Invoice scheme prefix of the location Example: `architecto`
`product_category_id`	string	optional	category id of the product Example: `architecto`
`product_sub_category_id`	string	optional	Sub category id of the product Example: `architecto`
`sell_ids`	string	optional	comma separated ids of the sells Example: `55,64`
`only_subscriptions`	string	optional	Filter only subcription invoices (1, 0) Example: `architecto`
`send_purchase_details`	string	optional	Get purchase details of each sell line (1, 0) Example: `architecto`
`order_by_date`	string	optional	Sort sell list by date ('asc', 'desc') Example: `desc`
`per_page`	integer	optional	Total records per page. default: 10, Set -1 for no pagination Example: `10`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/new_sell?location_id=1&contact_id=architecto&payment_status=due%2Cpartial&start_date=2018-06-25&end_date=2018-06-25&user_id=architecto&service_staff_id=architecto&shipping_status=ordered&source=architecto&customer_group_id=architecto&product_name=architecto&product_sku=architecto&product_custom_field_1=architecto&location_custom_field_1=architecto&location_invoice_scheme_prefix=architecto&product_category_id=architecto&product_sub_category_id=architecto&sell_ids=55%2C64&only_subscriptions=architecto&send_purchase_details=architecto&order_by_date=desc&per_page=10" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/new_sell"
);

const params = {
    "location_id": "1",
    "contact_id": "architecto",
    "payment_status": "due,partial",
    "start_date": "2018-06-25",
    "end_date": "2018-06-25",
    "user_id": "architecto",
    "service_staff_id": "architecto",
    "shipping_status": "ordered",
    "source": "architecto",
    "customer_group_id": "architecto",
    "product_name": "architecto",
    "product_sku": "architecto",
    "product_custom_field_1": "architecto",
    "location_custom_field_1": "architecto",
    "location_invoice_scheme_prefix": "architecto",
    "product_category_id": "architecto",
    "product_sub_category_id": "architecto",
    "sell_ids": "55,64",
    "only_subscriptions": "architecto",
    "send_purchase_details": "architecto",
    "order_by_date": "desc",
    "per_page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/new_sell';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'location_id' => '1',
            'contact_id' => 'architecto',
            'payment_status' => 'due,partial',
            'start_date' => '2018-06-25',
            'end_date' => '2018-06-25',
            'user_id' => 'architecto',
            'service_staff_id' => 'architecto',
            'shipping_status' => 'ordered',
            'source' => 'architecto',
            'customer_group_id' => 'architecto',
            'product_name' => 'architecto',
            'product_sku' => 'architecto',
            'product_custom_field_1' => 'architecto',
            'location_custom_field_1' => 'architecto',
            'location_invoice_scheme_prefix' => 'architecto',
            'product_category_id' => 'architecto',
            'product_sub_category_id' => 'architecto',
            'sell_ids' => '55,64',
            'only_subscriptions' => 'architecto',
            'send_purchase_details' => 'architecto',
            'order_by_date' => 'desc',
            'per_page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/new_sell'
params = {
  'location_id': '1',
  'contact_id': 'architecto',
  'payment_status': 'due,partial',
  'start_date': '2018-06-25',
  'end_date': '2018-06-25',
  'user_id': 'architecto',
  'service_staff_id': 'architecto',
  'shipping_status': 'ordered',
  'source': 'architecto',
  'customer_group_id': 'architecto',
  'product_name': 'architecto',
  'product_sku': 'architecto',
  'product_custom_field_1': 'architecto',
  'location_custom_field_1': 'architecto',
  'location_invoice_scheme_prefix': 'architecto',
  'product_category_id': 'architecto',
  'product_sub_category_id': 'architecto',
  'sell_ids': '55,64',
  'only_subscriptions': 'architecto',
  'send_purchase_details': 'architecto',
  'order_by_date': 'desc',
  'per_page': '10',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 6,
            "business_id": 1,
            "location_id": 1,
            "res_table_id": null,
            "type": "sell",
            "status": "final",
            "is_quotation": 0,
            "payment_status": "paid",
            "contact_id": 4,
            "customer_group_id": null,
            "invoice_no": "AS0001",
            "ref_no": "",
            "source": null,
            "unique_hash": null,
            "hash_control": null,
            "subscription_no": null,
            "subscription_repeat_on": null,
            "transaction_date": "2018-04-10 13:23:21",
            "total_before_tax": "770.0000",
            "tax_id": null,
            "tax_amount": "0.0000",
            "discount_type": "percentage",
            "discount_amount": "0.0000",
            "rp_redeemed": 0,
            "rp_redeemed_amount": "0.0000",
            "shipping_details": null,
            "shipping_address": null,
            "shipping_status": null,
            "delivered_to": null,
            "additional_notes": null,
            "staff_note": null,
            "round_off_amount": "0.0000",
            "final_total": "770.0000",
            "expense_sub_category_id": null,
            "is_direct_sale": 0,
            "is_suspend": 0,
            "total_amount_recovered": null,
            "crm_is_order_request": 0,
            "mfg_production_cost": "0.0000",
            "mfg_production_cost_type": "percentage",
            "mfg_is_final": 0,
            "is_created_from_api": 0,
            "essentials_duration": "0.00",
            "essentials_duration_unit": null,
            "essentials_amount_per_unit_duration": "0.0000",
            "essentials_allowances": null,
            "essentials_deductions": null,
            "repair_completed_on": null,
            "repair_warranty_id": null,
            "repair_brand_id": null,
            "repair_status_id": null,
            "repair_model_id": null,
            "repair_job_sheet_id": null,
            "repair_defects": null,
            "repair_serial_no": null,
            "repair_checklist": null,
            "repair_security_pwd": null,
            "repair_security_pattern": null,
            "repair_due_date": null,
            "repair_device_id": null,
            "repair_updates_notif": 0,
            "invoice_token": "00f79f7fd292225e8c303a6bf8626d06",
            "pjt_project_id": null,
            "pjt_title": null,
            "woocommerce_order_id": null,
            "selling_price_group_id": null,
            "created_at": "2018-01-06 07:06:11",
            "updated_at": "2021-10-23 11:42:13",
            "location_name": "Location 1",
            "location_custom_field1": "gdgdgd88",
            "location_invoice_scheme_prefix": "AS",
            "table_name": null,
            "table_description": null,
            "contact": "Harry",
            "customer_group_name": "grp 2",
            "sell_lines": [
                {
                    "id": 1,
                    "transaction_id": 6,
                    "product_id": 2,
                    "quantity": 10,
                    "quantity_returned": "0.0000",
                    "unit_price_before_discount": "70.0000",
                    "unit_price": "70.0000",
                    "line_discount_type": null,
                    "line_discount_amount": "0.0000",
                    "unit_price_inc_tax": "77.0000",
                    "item_tax": "7.0000",
                    "tax_id": 1,
                    "discount_id": null,
                    "lot_no_line_id": null,
                    "sell_line_note": null,
                    "woocommerce_line_items_id": null,
                    "children_type": "",
                    "created_at": "2018-01-06 07:06:11",
                    "updated_at": "2018-01-06 07:06:11",
                    "product_name": "Levis Men's Slimmy Fit Jeans",
                    "product_custom_field_1": null,
                    "product_type": "variable",
                    "product_sku": "AS0002",
                    "category": {
                        "id": 1,
                        "name": "Men's",
                        "business_id": 1,
                        "short_code": "sfefef",
                        "parent_id": 0,
                        "created_by": 1,
                        "category_type": "product",
                        "description": null,
                        "slug": null,
                        "woocommerce_cat_id": null
                    },
                    "sub_category": {
                        "id": 4,
                        "name": "Jeans",
                        "business_id": 1,
                        "short_code": null,
                        "parent_id": 1,
                        "created_by": 1,
                        "category_type": "product",
                        "description": null,
                        "slug": null,
                        "woocommerce_cat_id": null
                    },
                    "product_variations": {
                        "id": 3,
                        "name": "30",
                        "product_id": 2,
                        "sub_sku": "AS0002-2",
                        "product_variation_id": 2,
                        "default_purchase_price": "70.0000",
                        "dpp_inc_tax": "77.0000",
                        "default_sell_price": "70.0000",
                        "sell_price_inc_tax": "77.0000"
                    }
                }
            ],
            "payment_lines": [
                {
                    "id": 1,
                    "transaction_id": 6,
                    "business_id": null,
                    "is_return": 0,
                    "amount": "770.0000",
                    "method": "cash",
                    "card_type": "visa",
                    "paid_on": "2018-01-09 17:30:35",
                    "payment_ref_no": null
                }
            ],
            "invoice_url": "http://local.pos.com/invoice/00f79f7fd292225e8c303a6bf8626d06",
            "payment_link": ""
        }
    ],
    "links": {
        "first": "http://local.pos.com/connector/api/new_sell?per_page=1&page=1",
        "last": "http://local.pos.com/connector/api/new_sell?per_page=1&page=213",
        "prev": null,
        "next": "http://local.pos.com/connector/api/new_sell?per_page=1&page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 213,
        "path": "http://local.pos.com/connector/api/new_sell",
        "per_page": "1",
        "to": 1,
        "total": 213
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Query Parameters

location_id

contact_id

payment_status

start_date

end_date

user_id

service_staff_id

shipping_status

source

customer_group_id

product_name

product_sku

product_custom_field_1

location_custom_field_1

location_invoice_scheme_prefix

product_category_id

product_sub_category_id

sell_ids

only_subscriptions

send_purchase_details

order_by_date

per_page

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/expense

List expenses

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Query Parameters

Name	Type	Status	Description
`location_id`	string	optional	id of the location Example: `1`
`payment_status`	string	optional	payment status Example: `paid`
`start_date`	string	optional	format:Y-m-d Example: `2018-06-25`
`end_date`	string	optional	format:Y-m-d Example: `2018-06-25`
`expense_for`	string	optional	id of the user for which expense is created Example: `architecto`
`per_page`	integer	optional	Total records per page. default: 10, Set -1 for no pagination Example: `15`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/expense?location_id=1&payment_status=paid&start_date=2018-06-25&end_date=2018-06-25&expense_for=architecto&per_page=15" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/expense"
);

const params = {
    "location_id": "1",
    "payment_status": "paid",
    "start_date": "2018-06-25",
    "end_date": "2018-06-25",
    "expense_for": "architecto",
    "per_page": "15",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/expense';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'location_id' => '1',
            'payment_status' => 'paid',
            'start_date' => '2018-06-25',
            'end_date' => '2018-06-25',
            'expense_for' => 'architecto',
            'per_page' => '15',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/expense'
params = {
  'location_id': '1',
  'payment_status': 'paid',
  'start_date': '2018-06-25',
  'end_date': '2018-06-25',
  'expense_for': 'architecto',
  'per_page': '15',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 59,
            "business_id": 1,
            "location_id": 1,
            "payment_status": "due",
            "ref_no": "EP2020/0001",
            "transaction_date": "2020-07-03 12:58:00",
            "total_before_tax": "50.0000",
            "tax_id": null,
            "tax_amount": "0.0000",
            "final_total": "50.0000",
            "expense_category_id": null,
            "document": null,
            "created_by": 9,
            "is_recurring": 0,
            "recur_interval": null,
            "recur_interval_type": null,
            "recur_repetitions": null,
            "recur_stopped_on": null,
            "recur_parent_id": null,
            "created_at": "2020-07-03 12:58:23",
            "updated_at": "2020-07-03 12:58:24",
            "transaction_for": {
                "id": 1,
                "user_type": "user",
                "surname": "Mr",
                "first_name": "Admin",
                "last_name": null,
                "username": "admin",
                "email": "admin@example.com",
                "language": "en",
                "contact_no": null,
                "address": null,
                "business_id": 1,
                "max_sales_discount_percent": null,
                "allow_login": 1,
                "essentials_department_id": null,
                "essentials_designation_id": null,
                "status": "active",
                "crm_contact_id": null,
                "is_cmmsn_agnt": 0,
                "cmmsn_percent": "0.00",
                "selected_contacts": 0,
                "dob": null,
                "gender": null,
                "marital_status": null,
                "blood_group": null,
                "contact_number": null,
                "fb_link": null,
                "twitter_link": null,
                "social_media_1": null,
                "social_media_2": null,
                "permanent_address": null,
                "current_address": null,
                "guardian_name": null,
                "custom_field_1": null,
                "custom_field_2": null,
                "custom_field_3": null,
                "custom_field_4": null,
                "bank_details": null,
                "id_proof_name": null,
                "id_proof_number": null,
                "deleted_at": null,
                "created_at": "2018-01-04 02:15:19",
                "updated_at": "2018-01-04 02:15:19"
            }
        }
    ],
    "links": {
        "first": "http://local.pos.com/connector/api/expense?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "http://local.pos.com/connector/api/expense",
        "per_page": 10,
        "to": 1
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Query Parameters

location_id

payment_status

start_date

end_date

expense_for

per_page

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST connector/api/expense

Create expense / expense refund

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Body Parameters

location_id integer

id of the business location Example: 1

final_total number

Expense amount Example: 4326.41688

transaction_date string

transaction date format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

tax_rate_id integer

id of the tax rate applicable to the expense Example: 16

expense_for integer

id of the user for which expense is created Example: 16

contact_id integer

id of the contact(customer or supplier) for which expense is created Example: 16

expense_category_id integer

id of the expense category Example: 16

expense_sub_category_id integer

id of the expense sub-category Example: 16

additional_notes string

Example: architecto

is_refund integer

whether expense refund (0, 1) Example: 0

is_recurring integer

whether expense is recurring (0, 1) Example: 0

recur_interval integer

value of the interval expense will be regenerated Example: 16

recur_interval_type string

type of the recur interval ('days', 'months', 'years') Example: months

subscription_repeat_on integer

day of the month on which expense will be generated if recur interval type is months (1-30) Example: 15

subscription_no string

subscription number Example: architecto

recur_repetitions integer

total number of expense to be generated Example: 16

payment string[]

payment lines for the expense

* object

amount number

amount of the payment Example: 453.13

method string

payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') Example: cash

account_id integer

account id Example: 16

card_number string

Example: architecto

card_holder_name string

Example: architecto

card_transaction_number string

Example: architecto

card_type string

Example: architecto

card_month string

Example: architecto

card_year string

Example: architecto

card_security string

Example: architecto

transaction_no_1 string

Example: architecto

transaction_no_2 string

Example: architecto

transaction_no_3 string

Example: architecto

note string

payment note Example: architecto

cheque_number string

Example: architecto

Example request

curl --request POST \
    "https://gulfpos.com/connector/api/expense" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"location_id\": 1,
    \"final_total\": 4326.41688,
    \"transaction_date\": \"2020-5-7 15:20:22\",
    \"tax_rate_id\": 16,
    \"expense_for\": 16,
    \"contact_id\": 16,
    \"expense_category_id\": 16,
    \"expense_sub_category_id\": 16,
    \"additional_notes\": \"architecto\",
    \"is_refund\": 0,
    \"is_recurring\": 0,
    \"recur_interval\": 16,
    \"recur_interval_type\": \"months\",
    \"subscription_repeat_on\": 15,
    \"subscription_no\": \"architecto\",
    \"recur_repetitions\": 16,
    \"payment\": [
        \"architecto\"
    ]
}"

const url = new URL(
    "https://gulfpos.com/connector/api/expense"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "location_id": 1,
    "final_total": 4326.41688,
    "transaction_date": "2020-5-7 15:20:22",
    "tax_rate_id": 16,
    "expense_for": 16,
    "contact_id": 16,
    "expense_category_id": 16,
    "expense_sub_category_id": 16,
    "additional_notes": "architecto",
    "is_refund": 0,
    "is_recurring": 0,
    "recur_interval": 16,
    "recur_interval_type": "months",
    "subscription_repeat_on": 15,
    "subscription_no": "architecto",
    "recur_repetitions": 16,
    "payment": [
        "architecto"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/expense';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'location_id' => 1,
            'final_total' => 4326.41688,
            'transaction_date' => '2020-5-7 15:20:22',
            'tax_rate_id' => 16,
            'expense_for' => 16,
            'contact_id' => 16,
            'expense_category_id' => 16,
            'expense_sub_category_id' => 16,
            'additional_notes' => 'architecto',
            'is_refund' => 0,
            'is_recurring' => 0,
            'recur_interval' => 16,
            'recur_interval_type' => 'months',
            'subscription_repeat_on' => 15,
            'subscription_no' => 'architecto',
            'recur_repetitions' => 16,
            'payment' => ['architecto'],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/expense'
payload = {
    "location_id": 1,
    "final_total": 4326.41688,
    "transaction_date": "2020-5-7 15:20:22",
    "tax_rate_id": 16,
    "expense_for": 16,
    "contact_id": 16,
    "expense_category_id": 16,
    "expense_sub_category_id": 16,
    "additional_notes": "architecto",
    "is_refund": 0,
    "is_recurring": 0,
    "recur_interval": 16,
    "recur_interval_type": "months",
    "subscription_repeat_on": 15,
    "subscription_no": "architecto",
    "recur_repetitions": 16,
    "payment": [
        "architecto"
    ]
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response

Response 200

{
    "data": {
        "id": 75,
        "business_id": 1,
        "location_id": "1",
        "payment_status": "due",
        "ref_no": "EP2020/0013",
        "transaction_date": "2020-07-06T05:31:29.480975Z",
        "total_before_tax": "43",
        "tax_id": null,
        "tax_amount": 0,
        "final_total": "43",
        "expense_category_id": null,
        "document": null,
        "created_by": 1,
        "is_recurring": 0,
        "recur_interval": null,
        "recur_interval_type": null,
        "recur_repetitions": null,
        "recur_stopped_on": null,
        "recur_parent_id": null,
        "created_at": "2020-07-06 11:01:29",
        "updated_at": "2020-07-06 11:01:29",
        "expense_for": []
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Body Parameters

location_id integer

id of the business location Example: 1

final_total number

Expense amount Example: 4326.41688

transaction_date string optional

transaction date format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

tax_rate_id integer optional

id of the tax rate applicable to the expense Example: 16

expense_for integer optional

id of the user for which expense is created Example: 16

contact_id integer optional

id of the contact(customer or supplier) for which expense is created Example: 16

expense_category_id integer optional

id of the expense category Example: 16

expense_sub_category_id integer optional

id of the expense sub-category Example: 16

additional_notes string optional

Example: architecto

is_refund integer optional

whether expense refund (0, 1) Example: 0

is_recurring integer optional

whether expense is recurring (0, 1) Example: 0

recur_interval integer optional

value of the interval expense will be regenerated Example: 16

recur_interval_type string optional

type of the recur interval ('days', 'months', 'years') Example: months

subscription_repeat_on integer optional

day of the month on which expense will be generated if recur interval type is months (1-30) Example: 15

subscription_no string optional

subscription number Example: architecto

recur_repetitions integer optional

total number of expense to be generated Example: 16

payment string[] optional

payment lines for the expense

* object optional

amount number optional

amount of the payment Example: 453.13

method string optional

payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') Example: cash

account_id integer optional

account id Example: 16

card_number string optional

Example: architecto

card_holder_name string optional

Example: architecto

card_transaction_number string optional

Example: architecto

card_type string optional

Example: architecto

card_month string optional

Example: architecto

card_year string optional

Example: architecto

card_security string optional

Example: architecto

transaction_no_1 string optional

Example: architecto

transaction_no_2 string optional

Example: architecto

transaction_no_3 string optional

Example: architecto

note string optional

payment note Example: architecto

cheque_number string optional

Example: architecto

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/expense/{id}

Get the specified expense / expense refund

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the expense. Example: `architecto`
`expense`	string	required	comma separated ids of the expenses Example: `59`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/expense/architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/expense/architecto"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/expense/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/expense/architecto'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 59,
            "business_id": 1,
            "location_id": 1,
            "payment_status": "due",
            "ref_no": "EP2020/0001",
            "transaction_date": "2020-07-03 12:58:00",
            "total_before_tax": "50.0000",
            "tax_id": null,
            "tax_amount": "0.0000",
            "final_total": "50.0000",
            "expense_category_id": null,
            "document": null,
            "created_by": 9,
            "is_recurring": 0,
            "recur_interval": null,
            "recur_interval_type": null,
            "recur_repetitions": null,
            "recur_stopped_on": null,
            "recur_parent_id": null,
            "created_at": "2020-07-03 12:58:23",
            "updated_at": "2020-07-03 12:58:24",
            "transaction_for": {
                "id": 1,
                "user_type": "user",
                "surname": "Mr",
                "first_name": "Admin",
                "last_name": null,
                "username": "admin",
                "email": "admin@example.com",
                "language": "en",
                "contact_no": null,
                "address": null,
                "business_id": 1,
                "max_sales_discount_percent": null,
                "allow_login": 1,
                "essentials_department_id": null,
                "essentials_designation_id": null,
                "status": "active",
                "crm_contact_id": null,
                "is_cmmsn_agnt": 0,
                "cmmsn_percent": "0.00",
                "selected_contacts": 0,
                "dob": null,
                "gender": null,
                "marital_status": null,
                "blood_group": null,
                "contact_number": null,
                "fb_link": null,
                "twitter_link": null,
                "social_media_1": null,
                "social_media_2": null,
                "permanent_address": null,
                "current_address": null,
                "guardian_name": null,
                "custom_field_1": null,
                "custom_field_2": null,
                "custom_field_3": null,
                "custom_field_4": null,
                "bank_details": null,
                "id_proof_name": null,
                "id_proof_number": null,
                "deleted_at": null,
                "created_at": "2018-01-04 02:15:19",
                "updated_at": "2018-01-04 02:15:19"
            }
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

PUT PATCH connector/api/expense/{id}

Update expense / expense refund

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the expense. Example: `architecto`

Body Parameters

final_total number

Expense amount Example: 4326.41688

transaction_date string

transaction date format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

tax_rate_id integer

id of the tax rate applicable to the expense Example: 16

expense_for integer

id of the user for which expense is created Example: 16

contact_id integer

id of the contact(customer or supplier) for which expense is created Example: 16

expense_category_id integer

id of the expense category Example: 16

expense_sub_category_id integer

id of the expense sub-category Example: 16

additional_notes string

Example: architecto

is_recurring integer

whether expense is recurring (0, 1) Example: 0

recur_interval integer

value of the interval expense will be regenerated Example: 16

recur_interval_type string

type of the recur interval ('days', 'months', 'years') Example: months

subscription_repeat_on integer

day of the month on which expense will be generated if recur interval type is months (1-30) Example: 15

subscription_no string

subscription number Example: architecto

recur_repetitions integer

total number of expense to be generated Example: 16

payment string[]

payment lines for the expense

Example request

curl --request PUT \
    "https://gulfpos.com/connector/api/expense/architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"final_total\": 4326.41688,
    \"transaction_date\": \"2020-5-7 15:20:22\",
    \"tax_rate_id\": 16,
    \"expense_for\": 16,
    \"contact_id\": 16,
    \"expense_category_id\": 16,
    \"expense_sub_category_id\": 16,
    \"additional_notes\": \"architecto\",
    \"is_recurring\": 0,
    \"recur_interval\": 16,
    \"recur_interval_type\": \"months\",
    \"subscription_repeat_on\": 15,
    \"subscription_no\": \"architecto\",
    \"recur_repetitions\": 16,
    \"payment\": [
        \"architecto\"
    ]
}"

const url = new URL(
    "https://gulfpos.com/connector/api/expense/architecto"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "final_total": 4326.41688,
    "transaction_date": "2020-5-7 15:20:22",
    "tax_rate_id": 16,
    "expense_for": 16,
    "contact_id": 16,
    "expense_category_id": 16,
    "expense_sub_category_id": 16,
    "additional_notes": "architecto",
    "is_recurring": 0,
    "recur_interval": 16,
    "recur_interval_type": "months",
    "subscription_repeat_on": 15,
    "subscription_no": "architecto",
    "recur_repetitions": 16,
    "payment": [
        "architecto"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/expense/architecto';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'final_total' => 4326.41688,
            'transaction_date' => '2020-5-7 15:20:22',
            'tax_rate_id' => 16,
            'expense_for' => 16,
            'contact_id' => 16,
            'expense_category_id' => 16,
            'expense_sub_category_id' => 16,
            'additional_notes' => 'architecto',
            'is_recurring' => 0,
            'recur_interval' => 16,
            'recur_interval_type' => 'months',
            'subscription_repeat_on' => 15,
            'subscription_no' => 'architecto',
            'recur_repetitions' => 16,
            'payment' => ['architecto'],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/expense/architecto'
payload = {
    "final_total": 4326.41688,
    "transaction_date": "2020-5-7 15:20:22",
    "tax_rate_id": 16,
    "expense_for": 16,
    "contact_id": 16,
    "expense_category_id": 16,
    "expense_sub_category_id": 16,
    "additional_notes": "architecto",
    "is_recurring": 0,
    "recur_interval": 16,
    "recur_interval_type": "months",
    "subscription_repeat_on": 15,
    "subscription_no": "architecto",
    "recur_repetitions": 16,
    "payment": [
        "architecto"
    ]
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response

Response 200

{
    "data": {
        "id": 75,
        "business_id": 1,
        "location_id": "1",
        "payment_status": "due",
        "ref_no": "EP2020/0013",
        "transaction_date": "2020-07-06T05:31:29.480975Z",
        "total_before_tax": "43",
        "tax_id": null,
        "tax_amount": 0,
        "final_total": "43",
        "expense_category_id": null,
        "document": null,
        "created_by": 1,
        "is_recurring": 0,
        "recur_interval": null,
        "recur_interval_type": null,
        "recur_repetitions": null,
        "recur_stopped_on": null,
        "recur_parent_id": null,
        "created_at": "2020-07-06 11:01:29",
        "updated_at": "2020-07-06 11:01:29",
        "expense_for": []
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

URL Parameters

id *

Body Parameters

final_total number optional

Expense amount Example: 4326.41688

transaction_date string optional

transaction date format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

tax_rate_id integer optional

id of the tax rate applicable to the expense Example: 16

expense_for integer optional

id of the user for which expense is created Example: 16

contact_id integer optional

id of the contact(customer or supplier) for which expense is created Example: 16

expense_category_id integer optional

id of the expense category Example: 16

expense_sub_category_id integer optional

id of the expense sub-category Example: 16

additional_notes string optional

Example: architecto

is_recurring integer optional

whether expense is recurring (0, 1) Example: 0

recur_interval integer optional

value of the interval expense will be regenerated Example: 16

recur_interval_type string optional

type of the recur interval ('days', 'months', 'years') Example: months

subscription_repeat_on integer optional

day of the month on which expense will be generated if recur interval type is months (1-30) Example: 15

subscription_no string optional

subscription number Example: architecto

recur_repetitions integer optional

total number of expense to be generated Example: 16

payment string[] optional

payment lines for the expense

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/expense-refund

List expense refunds

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Query Parameters

Name	Type	Status	Description
`location_id`	string	optional	id of the location Example: `1`
`payment_status`	string	optional	payment status Example: `paid`
`start_date`	string	optional	format:Y-m-d Example: `2018-06-25`
`end_date`	string	optional	format:Y-m-d Example: `2018-06-25`
`expense_for`	string	optional	id of the user for which expense is created Example: `architecto`
`per_page`	integer	optional	Total records per page. default: 10, Set -1 for no pagination Example: `15`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/expense-refund?location_id=1&payment_status=paid&start_date=2018-06-25&end_date=2018-06-25&expense_for=architecto&per_page=15" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/expense-refund"
);

const params = {
    "location_id": "1",
    "payment_status": "paid",
    "start_date": "2018-06-25",
    "end_date": "2018-06-25",
    "expense_for": "architecto",
    "per_page": "15",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/expense-refund';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'location_id' => '1',
            'payment_status' => 'paid',
            'start_date' => '2018-06-25',
            'end_date' => '2018-06-25',
            'expense_for' => 'architecto',
            'per_page' => '15',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/expense-refund'
params = {
  'location_id': '1',
  'payment_status': 'paid',
  'start_date': '2018-06-25',
  'end_date': '2018-06-25',
  'expense_for': 'architecto',
  'per_page': '15',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 230,
            "business_id": 1,
            "location_id": 1,
            "payment_status": "partial",
            "ref_no": "refund",
            "transaction_date": "2020-12-15 11:16:00",
            "total_before_tax": "65.0000",
            "tax_id": null,
            "tax_amount": "0.0000",
            "final_total": "65.0000",
            "expense_category_id": null,
            "document": null,
            "created_by": 9,
            "created_at": "2020-12-15 11:46:56",
            "updated_at": "2020-12-15 12:47:30",
            "expense_for": []
        }
    ],
    "links": {
        "first": "http://local.pos.com/connector/api/expense-refund?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "http://local.pos.com/connector/api/expense-refund",
        "per_page": 15,
        "to": 1
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Query Parameters

location_id

payment_status

start_date

end_date

expense_for

per_page

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/expense-categories

List expense categories

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/expense-categories" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/expense-categories"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/expense-categories';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/expense-categories'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "name": "cat 1",
            "business_id": 1,
            "code": null,
            "parent_id": null,
            "deleted_at": null,
            "created_at": "2021-12-16 17:54:40",
            "updated_at": "2021-12-16 17:54:40",
            "sub_categories": [
                {
                    "id": 3,
                    "name": "sub cat 1",
                    "business_id": 1,
                    "code": null,
                    "parent_id": 1,
                    "deleted_at": null,
                    "created_at": "2021-12-16 18:12:07",
                    "updated_at": "2021-12-16 18:12:07"
                }
            ]
        },
        {
            "id": 7,
            "name": "cat 2",
            "business_id": 1,
            "code": null,
            "parent_id": null,
            "deleted_at": null,
            "created_at": "2021-12-17 10:36:13",
            "updated_at": "2021-12-17 10:36:13",
            "sub_categories": [
                {
                    "id": 8,
                    "name": "sub cat 2",
                    "business_id": 1,
                    "code": null,
                    "parent_id": 7,
                    "deleted_at": null,
                    "created_at": "2021-12-17 10:36:44",
                    "updated_at": "2021-12-17 10:36:44"
                }
            ]
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/cash-register

List Cash Registers

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Query Parameters

Name	Type	Status	Description
`status`	string	optional	status of the register (open, close) Example: `open`
`user_id`	string	optional	id of the user Example: `10`
`start_date`	string	optional	format:Y-m-d Example: `2018-06-25`
`end_date`	string	optional	format:Y-m-d Example: `2018-06-25`
`location_id`	string	optional	id of the location Example: `1`
`per_page`	integer	optional	Total records per page. default: 10, Set -1 for no pagination Example: `15`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/cash-register?status=open&user_id=10&start_date=2018-06-25&end_date=2018-06-25&location_id=1&per_page=15" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/cash-register"
);

const params = {
    "status": "open",
    "user_id": "10",
    "start_date": "2018-06-25",
    "end_date": "2018-06-25",
    "location_id": "1",
    "per_page": "15",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/cash-register';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'status' => 'open',
            'user_id' => '10',
            'start_date' => '2018-06-25',
            'end_date' => '2018-06-25',
            'location_id' => '1',
            'per_page' => '15',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/cash-register'
params = {
  'status': 'open',
  'user_id': '10',
  'start_date': '2018-06-25',
  'end_date': '2018-06-25',
  'location_id': '1',
  'per_page': '15',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "business_id": 1,
            "location_id": 1,
            "user_id": 9,
            "status": "open",
            "closed_at": null,
            "closing_amount": "0.0000",
            "total_card_slips": 0,
            "total_cheques": 0,
            "closing_note": null,
            "created_at": "2020-07-02 12:03:00",
            "updated_at": "2020-07-02 12:03:19",
            "cash_register_transactions": [
                {
                    "id": 1,
                    "cash_register_id": 1,
                    "amount": "0.0000",
                    "pay_method": "cash",
                    "type": "credit",
                    "transaction_type": "initial",
                    "transaction_id": null,
                    "created_at": "2018-07-13 07:39:34",
                    "updated_at": "2018-07-13 07:39:34"
                },
                {
                    "id": 2,
                    "cash_register_id": 1,
                    "amount": "42.5000",
                    "pay_method": "cash",
                    "type": "credit",
                    "transaction_type": "sell",
                    "transaction_id": 41,
                    "created_at": "2018-07-13 07:44:40",
                    "updated_at": "2018-07-13 07:44:40"
                }
            ]
        },
        {
            "id": 2,
            "business_id": 1,
            "location_id": 1,
            "user_id": 1,
            "status": "",
            "closed_at": "2020-07-02 12:03:00",
            "closing_amount": "0.0000",
            "total_card_slips": 0,
            "total_cheques": 0,
            "closing_note": null,
            "created_at": "2020-07-06 15:38:23",
            "updated_at": "2020-07-06 15:38:23",
            "cash_register_transactions": [
                {
                    "id": 19,
                    "cash_register_id": 2,
                    "amount": "10.0000",
                    "pay_method": "cash",
                    "type": "credit",
                    "transaction_type": "initial",
                    "transaction_id": null,
                    "created_at": "2020-07-06 15:38:23",
                    "updated_at": "2020-07-06 15:38:23"
                }
            ]
        }
    ],
    "links": {
        "first": "http://local.pos.com/connector/api/cash-register?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "http://local.pos.com/connector/api/cash-register",
        "per_page": 10,
        "to": 2
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Query Parameters

status

user_id

start_date

end_date

location_id

per_page

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST connector/api/cash-register

Create Cash Register

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Body Parameters

location_id integer

id of the business location Example: 1

initial_amount number

Initial amount Example: 4326.41688

created_at string

Register open datetime format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

closed_at string

Register closed datetime format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

status register

status (open, close) Example: close

closing_amount number

Closing amount Example: 4326.41688

total_card_slips integer

total number of card slips Example: 16

total_cheques integer

total number of checks Example: 16

closing_note string

Closing note Example: architecto

transaction_ids string

Comma separated ids of sells associated with the register Example: `1,2,3

response { "data": { "status": "closed", "location_id": "1", "closed_at": "2020-07-02 12:03:00", "business_id": 1, "user_id": 1, "updated_at": "2020-07-06 16:28:42", "created_at": "2020-07-06 16:28:42", "id": 3 } }`

Example request

curl --request POST \
    "https://gulfpos.com/connector/api/cash-register" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"location_id\": 1,
    \"initial_amount\": 4326.41688,
    \"created_at\": \"2020-5-7 15:20:22\",
    \"closed_at\": \"2020-5-7 15:20:22\",
    \"status\": \"close\",
    \"closing_amount\": 4326.41688,
    \"total_card_slips\": 16,
    \"total_cheques\": 16,
    \"closing_note\": \"architecto\",
    \"transaction_ids\": \"1,2,3\\n\\nresponse {\\n\\\"data\\\": {\\n\\\"status\\\": \\\"closed\\\",\\n\\\"location_id\\\": \\\"1\\\",\\n\\\"closed_at\\\": \\\"2020-07-02 12:03:00\\\",\\n\\\"business_id\\\": 1,\\n\\\"user_id\\\": 1,\\n\\\"updated_at\\\": \\\"2020-07-06 16:28:42\\\",\\n\\\"created_at\\\": \\\"2020-07-06 16:28:42\\\",\\n\\\"id\\\": 3\\n}\\n}\"
}"

const url = new URL(
    "https://gulfpos.com/connector/api/cash-register"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "location_id": 1,
    "initial_amount": 4326.41688,
    "created_at": "2020-5-7 15:20:22",
    "closed_at": "2020-5-7 15:20:22",
    "status": "close",
    "closing_amount": 4326.41688,
    "total_card_slips": 16,
    "total_cheques": 16,
    "closing_note": "architecto",
    "transaction_ids": "1,2,3\n\nresponse {\n\"data\": {\n\"status\": \"closed\",\n\"location_id\": \"1\",\n\"closed_at\": \"2020-07-02 12:03:00\",\n\"business_id\": 1,\n\"user_id\": 1,\n\"updated_at\": \"2020-07-06 16:28:42\",\n\"created_at\": \"2020-07-06 16:28:42\",\n\"id\": 3\n}\n}"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/cash-register';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'location_id' => 1,
            'initial_amount' => 4326.41688,
            'created_at' => '2020-5-7 15:20:22',
            'closed_at' => '2020-5-7 15:20:22',
            'status' => 'close',
            'closing_amount' => 4326.41688,
            'total_card_slips' => 16,
            'total_cheques' => 16,
            'closing_note' => 'architecto',
            'transaction_ids' => '1,2,3'."\n"
                ."\n"
                .'response {'."\n"
                .'"data": {'."\n"
                .'"status": "closed",'."\n"
                .'"location_id": "1",'."\n"
                .'"closed_at": "2020-07-02 12:03:00",'."\n"
                .'"business_id": 1,'."\n"
                .'"user_id": 1,'."\n"
                .'"updated_at": "2020-07-06 16:28:42",'."\n"
                .'"created_at": "2020-07-06 16:28:42",'."\n"
                .'"id": 3'."\n"
                .'}'."\n"
                .'}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/cash-register'
payload = {
    "location_id": 1,
    "initial_amount": 4326.41688,
    "created_at": "2020-5-7 15:20:22",
    "closed_at": "2020-5-7 15:20:22",
    "status": "close",
    "closing_amount": 4326.41688,
    "total_card_slips": 16,
    "total_cheques": 16,
    "closing_note": "architecto",
    "transaction_ids": "1,2,3\n\nresponse {\n\"data\": {\n\"status\": \"closed\",\n\"location_id\": \"1\",\n\"closed_at\": \"2020-07-02 12:03:00\",\n\"business_id\": 1,\n\"user_id\": 1,\n\"updated_at\": \"2020-07-06 16:28:42\",\n\"created_at\": \"2020-07-06 16:28:42\",\n\"id\": 3\n}\n}"
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Body Parameters

location_id integer

id of the business location Example: 1

initial_amount number optional

Initial amount Example: 4326.41688

created_at string optional

Register open datetime format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

closed_at string optional

Register closed datetime format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

status register optional

status (open, close) Example: close

closing_amount number optional

Closing amount Example: 4326.41688

total_card_slips integer optional

total number of card slips Example: 16

total_cheques integer optional

total number of checks Example: 16

closing_note string optional

Closing note Example: architecto

transaction_ids string optional

Comma separated ids of sells associated with the register Example: `1,2,3

response { "data": { "status": "closed", "location_id": "1", "closed_at": "2020-07-02 12:03:00", "business_id": 1, "user_id": 1, "updated_at": "2020-07-06 16:28:42", "created_at": "2020-07-06 16:28:42", "id": 3 } }`

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/cash-register/{id}

Get the specified Register

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the cash register. Example: `architecto`
`cash_register`	string	required	comma separated ids of the cash registers Example: `59`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/cash-register/architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/cash-register/architecto"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/cash-register/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/cash-register/architecto'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "business_id": 1,
            "location_id": 1,
            "user_id": 9,
            "status": "open",
            "closed_at": null,
            "closing_amount": "0.0000",
            "total_card_slips": 0,
            "total_cheques": 0,
            "closing_note": null,
            "created_at": "2020-07-02 12:03:00",
            "updated_at": "2020-07-02 12:03:19",
            "cash_register_transactions": [
                {
                    "id": 1,
                    "cash_register_id": 1,
                    "amount": "0.0000",
                    "pay_method": "cash",
                    "type": "credit",
                    "transaction_type": "initial",
                    "transaction_id": null,
                    "created_at": "2018-07-13 07:39:34",
                    "updated_at": "2018-07-13 07:39:34"
                },
                {
                    "id": 2,
                    "cash_register_id": 1,
                    "amount": "42.5000",
                    "pay_method": "cash",
                    "type": "credit",
                    "transaction_type": "sell",
                    "transaction_id": 41,
                    "created_at": "2018-07-13 07:44:40",
                    "updated_at": "2018-07-13 07:44:40"
                }
            ]
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

PUT PATCH connector/api/cash-register/{id}

Close the specified Cash Register

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the cash register. Example: `architecto`
`cash_register`	string	required	id of the cash register Example: `3`

Body Parameters

closing_amount number

Closing cash amount Example: 4326.41

total_card_slips integer

Total number of card slips Example: 0

total_cheques integer

Total number of cheques Example: 0

closing_note string

Closing note Example: End of day

Example request

curl --request PUT \
    "https://gulfpos.com/connector/api/cash-register/architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"closing_amount\": 4326.41,
    \"total_card_slips\": 0,
    \"total_cheques\": 0,
    \"closing_note\": \"End of day\"
}"

const url = new URL(
    "https://gulfpos.com/connector/api/cash-register/architecto"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "closing_amount": 4326.41,
    "total_card_slips": 0,
    "total_cheques": 0,
    "closing_note": "End of day"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/cash-register/architecto';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'closing_amount' => 4326.41,
            'total_card_slips' => 0,
            'total_cheques' => 0,
            'closing_note' => 'End of day',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/cash-register/architecto'
payload = {
    "closing_amount": 4326.41,
    "total_card_slips": 0,
    "total_cheques": 0,
    "closing_note": "End of day"
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

URL Parameters

id *

cash_register *

Body Parameters

closing_amount number optional

Closing cash amount Example: 4326.41

total_card_slips integer optional

Total number of card slips Example: 0

total_cheques integer optional

Total number of cheques Example: 0

closing_note string optional

Closing note Example: End of day

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/payment-accounts

List payment accounts

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/payment-accounts" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/payment-accounts"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/payment-accounts';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/payment-accounts'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "business_id": 1,
            "name": "Test Account",
            "account_number": "8746888847455",
            "account_type_id": 0,
            "note": null,
            "created_by": 9,
            "is_closed": 0,
            "deleted_at": null,
            "created_at": "2020-06-04 21:34:21",
            "updated_at": "2020-06-04 21:34:21"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/payment-methods

List payment methods

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/payment-methods" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/payment-methods"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/payment-methods';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/payment-methods'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "cash": "Cash",
    "card": "Card",
    "cheque": "Cheque",
    "bank_transfer": "Bank Transfer",
    "other": "Other",
    "custom_pay_1": "Custom Payment 1",
    "custom_pay_2": "Custom Payment 2",
    "custom_pay_3": "Custom Payment 3"
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/user/loggedin

Get the loggedin user details.

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/user/loggedin" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/user/loggedin"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/user/loggedin';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/user/loggedin'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": {
        "id": 1,
        "user_type": "user",
        "surname": "Mr",
        "first_name": "Admin",
        "last_name": null,
        "username": "admin",
        "email": "admin@example.com",
        "language": "en",
        "contact_no": null,
        "address": null,
        "business_id": 1,
        "max_sales_discount_percent": null,
        "allow_login": 1,
        "essentials_department_id": null,
        "essentials_designation_id": null,
        "status": "active",
        "crm_contact_id": null,
        "is_cmmsn_agnt": 0,
        "cmmsn_percent": "0.00",
        "selected_contacts": 0,
        "dob": null,
        "gender": null,
        "marital_status": null,
        "blood_group": null,
        "contact_number": null,
        "fb_link": null,
        "twitter_link": null,
        "social_media_1": null,
        "social_media_2": null,
        "permanent_address": null,
        "current_address": null,
        "guardian_name": null,
        "custom_field_1": null,
        "custom_field_2": null,
        "custom_field_3": null,
        "custom_field_4": null,
        "bank_details": null,
        "id_proof_name": null,
        "id_proof_number": null,
        "deleted_at": null,
        "created_at": "2018-01-04 02:15:19",
        "updated_at": "2018-01-04 02:15:19"
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/subscription

Get the current subscription status for the authenticated user's business.

REQUIRES AUTHENTICATION

Returns is_active=true when no Superadmin module is installed (unlimited access assumed).

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/subscription" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/subscription"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/subscription';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/subscription'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 401

Show Response Headers

cache-control: no-cache, private
content-type: application/json

{
    "message": "Unauthenticated."
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST connector/api/user-registration

Register User

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Body Parameters

username string

minimum 5 characters Example: architecto

email string

Example: gbailey@example.net

user_type string

'user_customer' for contact/customer login & 'user' for general user Example: architecto

surname string

prefix like Mr, Mrs,Dr Example: architecto

first_name string

Example: architecto

last_name string

Example: architecto

is_active string

'active', 'inactive', 'terminated' Example: architecto

crm_contact_id integer

if user_type is 'user_customer' then required Example: 16

allow_login boolean

1 to allow login & 0 to disable login Example: false

password string

minimum 6 characters & required if 'allow_login' is 1 Example: |]|{+-

role integer

id of role to be assigned to user & required if user_type is 'user' Example: 16

access_all_locations boolean

1 if user has access all location else 0 & required if user_type is 'user' Example: false

location_permissions string[]

array of location ids to be assigned to user & required if user_type is 'user' and 'access_all_locations' is 0

cmmsn_percent decimal

Example: architecto

max_sales_discount_percent decimal

Example: architecto

selected_contacts boolean

1 or 0 Example: false

selected_contact_ids string[]

array of contact ids & required if 'selected_contacts' is 1

dob date

dob of user in "Y-m-d" format Ex: 1997-10-29 Example: architecto

gender string

if user is 'male', 'female', 'others' Example: architecto

marital_status string

if user is 'married', 'unmarried', 'divorced' Example: architecto

blood_group string

Example: architecto

contact_number string

Example: architecto

alt_number string

Example: architecto

family_number string

Example: architecto

fb_link string

Example: architecto

twitter_link string

Example: architecto

social_media_1 string

Example: architecto

social_media_2 string

Example: architecto

custom_field_1 string

Example: architecto

custom_field_2 string

Example: architecto

custom_field_3 string

Example: architecto

custom_field_4 string

Example: architecto

guardian_name string

Example: architecto

id_proof_name string

ID proof of user like Adhar No. Example: architecto

id_proof_number string

Id Number like adhar number Example: architecto

permanent_address string

Example: architecto

current_address string

Example: architecto

bank_details object

* object

account_holder_name string

Example: architecto

account_number string

Example: architecto

bank_name string

Example: architecto

bank_code string

Example: architecto

branch string

Example: architecto

tax_payer_id string

Example: architecto

Example request

curl --request POST \
    "https://gulfpos.com/connector/api/user-registration" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"architecto\",
    \"email\": \"gbailey@example.net\",
    \"user_type\": \"architecto\",
    \"surname\": \"architecto\",
    \"first_name\": \"architecto\",
    \"last_name\": \"architecto\",
    \"is_active\": \"architecto\",
    \"crm_contact_id\": 16,
    \"allow_login\": false,
    \"password\": \"|]|{+-\",
    \"role\": 16,
    \"access_all_locations\": false,
    \"location_permissions\": [
        \"architecto\"
    ],
    \"cmmsn_percent\": \"architecto\",
    \"max_sales_discount_percent\": \"architecto\",
    \"selected_contacts\": false,
    \"selected_contact_ids\": [
        \"architecto\"
    ],
    \"dob\": \"architecto\",
    \"gender\": \"architecto\",
    \"marital_status\": \"architecto\",
    \"blood_group\": \"architecto\",
    \"contact_number\": \"architecto\",
    \"alt_number\": \"architecto\",
    \"family_number\": \"architecto\",
    \"fb_link\": \"architecto\",
    \"twitter_link\": \"architecto\",
    \"social_media_1\": \"architecto\",
    \"social_media_2\": \"architecto\",
    \"custom_field_1\": \"architecto\",
    \"custom_field_2\": \"architecto\",
    \"custom_field_3\": \"architecto\",
    \"custom_field_4\": \"architecto\",
    \"guardian_name\": \"architecto\",
    \"id_proof_name\": \"architecto\",
    \"id_proof_number\": \"architecto\",
    \"permanent_address\": \"architecto\",
    \"current_address\": \"architecto\"
}"

const url = new URL(
    "https://gulfpos.com/connector/api/user-registration"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "username": "architecto",
    "email": "gbailey@example.net",
    "user_type": "architecto",
    "surname": "architecto",
    "first_name": "architecto",
    "last_name": "architecto",
    "is_active": "architecto",
    "crm_contact_id": 16,
    "allow_login": false,
    "password": "|]|{+-",
    "role": 16,
    "access_all_locations": false,
    "location_permissions": [
        "architecto"
    ],
    "cmmsn_percent": "architecto",
    "max_sales_discount_percent": "architecto",
    "selected_contacts": false,
    "selected_contact_ids": [
        "architecto"
    ],
    "dob": "architecto",
    "gender": "architecto",
    "marital_status": "architecto",
    "blood_group": "architecto",
    "contact_number": "architecto",
    "alt_number": "architecto",
    "family_number": "architecto",
    "fb_link": "architecto",
    "twitter_link": "architecto",
    "social_media_1": "architecto",
    "social_media_2": "architecto",
    "custom_field_1": "architecto",
    "custom_field_2": "architecto",
    "custom_field_3": "architecto",
    "custom_field_4": "architecto",
    "guardian_name": "architecto",
    "id_proof_name": "architecto",
    "id_proof_number": "architecto",
    "permanent_address": "architecto",
    "current_address": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/user-registration';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'username' => 'architecto',
            'email' => 'gbailey@example.net',
            'user_type' => 'architecto',
            'surname' => 'architecto',
            'first_name' => 'architecto',
            'last_name' => 'architecto',
            'is_active' => 'architecto',
            'crm_contact_id' => 16,
            'allow_login' => false,
            'password' => '|]|{+-',
            'role' => 16,
            'access_all_locations' => false,
            'location_permissions' => ['architecto'],
            'cmmsn_percent' => 'architecto',
            'max_sales_discount_percent' => 'architecto',
            'selected_contacts' => false,
            'selected_contact_ids' => ['architecto'],
            'dob' => 'architecto',
            'gender' => 'architecto',
            'marital_status' => 'architecto',
            'blood_group' => 'architecto',
            'contact_number' => 'architecto',
            'alt_number' => 'architecto',
            'family_number' => 'architecto',
            'fb_link' => 'architecto',
            'twitter_link' => 'architecto',
            'social_media_1' => 'architecto',
            'social_media_2' => 'architecto',
            'custom_field_1' => 'architecto',
            'custom_field_2' => 'architecto',
            'custom_field_3' => 'architecto',
            'custom_field_4' => 'architecto',
            'guardian_name' => 'architecto',
            'id_proof_name' => 'architecto',
            'id_proof_number' => 'architecto',
            'permanent_address' => 'architecto',
            'current_address' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/user-registration'
payload = {
    "username": "architecto",
    "email": "gbailey@example.net",
    "user_type": "architecto",
    "surname": "architecto",
    "first_name": "architecto",
    "last_name": "architecto",
    "is_active": "architecto",
    "crm_contact_id": 16,
    "allow_login": false,
    "password": "|]|{+-",
    "role": 16,
    "access_all_locations": false,
    "location_permissions": [
        "architecto"
    ],
    "cmmsn_percent": "architecto",
    "max_sales_discount_percent": "architecto",
    "selected_contacts": false,
    "selected_contact_ids": [
        "architecto"
    ],
    "dob": "architecto",
    "gender": "architecto",
    "marital_status": "architecto",
    "blood_group": "architecto",
    "contact_number": "architecto",
    "alt_number": "architecto",
    "family_number": "architecto",
    "fb_link": "architecto",
    "twitter_link": "architecto",
    "social_media_1": "architecto",
    "social_media_2": "architecto",
    "custom_field_1": "architecto",
    "custom_field_2": "architecto",
    "custom_field_3": "architecto",
    "custom_field_4": "architecto",
    "guardian_name": "architecto",
    "id_proof_name": "architecto",
    "id_proof_number": "architecto",
    "permanent_address": "architecto",
    "current_address": "architecto"
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response

Response 200

{
    "success": 1,
    "msg": "User added successfully",
    "user": {
        "surname": "Mr",
        "first_name": "Test",
        "last_name": "kumar",
        "email": "test@example.com",
        "user_type": "user_customer",
        "crm_contact_id": "2",
        "allow_login": 1,
        "username": "0017",
        "cmmsn_percent": "25",
        "max_sales_discount_percent": "52",
        "dob": "1997-10-12",
        "gender": "male",
        "marital_status": "unmarried",
        "blood_group": "0+",
        "contact_number": "4578451245",
        "alt_number": "7474747474",
        "family_number": "7474147414",
        "fb_link": "fb.com/username",
        "twitter_link": "twitter.com/username",
        "social_media_1": "test",
        "social_media_2": "test",
        "custom_field_1": "test",
        "custom_field_2": "test",
        "custom_field_3": "test",
        "custom_field_4": "test",
        "guardian_name": "test",
        "id_proof_name": "uid",
        "id_proof_number": "747845120124",
        "permanent_address": "test permanent adrress",
        "current_address": "test current address",
        "bank_details": "{\"account_holder_name\":\"test\",\"account_number\":\"test\",\"bank_name\":\"test\",\"bank_code\":\"test\",\"branch\":\"test\",\"tax_payer_id\":\"test\"}",
        "selected_contacts": "1",
        "status": "active",
        "business_id": 1,
        "updated_at": "2021-08-12 18:03:58",
        "created_at": "2021-08-12 18:03:58",
        "id": 140
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Body Parameters

username string optional

minimum 5 characters Example: architecto

email string

Example: gbailey@example.net

user_type string

'user_customer' for contact/customer login & 'user' for general user Example: architecto

surname string optional

prefix like Mr, Mrs,Dr Example: architecto

first_name string

Example: architecto

last_name string optional

Example: architecto

is_active string

'active', 'inactive', 'terminated' Example: architecto

crm_contact_id integer optional

if user_type is 'user_customer' then required Example: 16

allow_login boolean optional true false

1 to allow login & 0 to disable login Example: false

password string optional

minimum 6 characters & required if 'allow_login' is 1 Example: |]|{+-

role integer optional

id of role to be assigned to user & required if user_type is 'user' Example: 16

access_all_locations boolean optional true false

1 if user has access all location else 0 & required if user_type is 'user' Example: false

location_permissions string[] optional

array of location ids to be assigned to user & required if user_type is 'user' and 'access_all_locations' is 0

cmmsn_percent decimal optional

Example: architecto

max_sales_discount_percent decimal optional

Example: architecto

selected_contacts boolean optional true false

1 or 0 Example: false

selected_contact_ids string[] optional

array of contact ids & required if 'selected_contacts' is 1

dob date optional

dob of user in "Y-m-d" format Ex: 1997-10-29 Example: architecto

gender string optional

if user is 'male', 'female', 'others' Example: architecto

marital_status string optional

if user is 'married', 'unmarried', 'divorced' Example: architecto

blood_group string optional

Example: architecto

contact_number string optional

Example: architecto

alt_number string optional

Example: architecto

family_number string optional

Example: architecto

fb_link string optional

Example: architecto

twitter_link string optional

Example: architecto

social_media_1 string optional

Example: architecto

social_media_2 string optional

Example: architecto

custom_field_1 string optional

Example: architecto

custom_field_2 string optional

Example: architecto

custom_field_3 string optional

Example: architecto

custom_field_4 string optional

Example: architecto

guardian_name string optional

Example: architecto

id_proof_name string optional

ID proof of user like Adhar No. Example: architecto

id_proof_number string optional

Id Number like adhar number Example: architecto

permanent_address string optional

Example: architecto

current_address string optional

Example: architecto

bank_details object optional

* object optional

account_holder_name string optional

Example: architecto

account_number string optional

Example: architecto

bank_name string optional

Example: architecto

bank_code string optional

Example: architecto

branch string optional

Example: architecto

tax_payer_id string optional

Example: architecto

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/user

List users

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Query Parameters

Name	Type	Status	Description
`service_staff`	boolean	optional	Filter service staffs from users list (0, 1)

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/user?service_staff=" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/user"
);

const params = {
    "service_staff": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/user';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'service_staff' => '0',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/user'
params = {
  'service_staff': '0',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "user_type": "user",
            "surname": "Mr",
            "first_name": "Admin",
            "last_name": null,
            "username": "admin",
            "email": "admin@example.com",
            "language": "en",
            "contact_no": null,
            "address": null,
            "business_id": 1,
            "max_sales_discount_percent": null,
            "allow_login": 1,
            "essentials_department_id": null,
            "essentials_designation_id": null,
            "status": "active",
            "crm_contact_id": null,
            "is_cmmsn_agnt": 0,
            "cmmsn_percent": "0.00",
            "selected_contacts": 0,
            "dob": null,
            "gender": null,
            "marital_status": null,
            "blood_group": null,
            "contact_number": null,
            "fb_link": null,
            "twitter_link": null,
            "social_media_1": null,
            "social_media_2": null,
            "permanent_address": null,
            "current_address": null,
            "guardian_name": null,
            "custom_field_1": null,
            "custom_field_2": null,
            "custom_field_3": null,
            "custom_field_4": null,
            "bank_details": null,
            "id_proof_name": null,
            "id_proof_number": null,
            "deleted_at": null,
            "created_at": "2018-01-04 02:15:19",
            "updated_at": "2018-01-04 02:15:19"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/user/{id}

Get the specified user

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`id`	string	required	The ID of the user. Example: `architecto`
`user`	string	required	comma separated ids of the required users Example: `1`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/user/architecto" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/user/architecto"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/user/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/user/architecto'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 1,
            "user_type": "user",
            "surname": "Mr",
            "first_name": "Admin",
            "last_name": null,
            "username": "admin",
            "email": "admin@example.com",
            "language": "en",
            "contact_no": null,
            "address": null,
            "business_id": 1,
            "max_sales_discount_percent": null,
            "allow_login": 1,
            "essentials_department_id": null,
            "essentials_designation_id": null,
            "status": "active",
            "crm_contact_id": null,
            "is_cmmsn_agnt": 0,
            "cmmsn_percent": "0.00",
            "selected_contacts": 0,
            "dob": null,
            "gender": null,
            "marital_status": null,
            "blood_group": null,
            "contact_number": null,
            "fb_link": null,
            "twitter_link": null,
            "social_media_1": null,
            "social_media_2": null,
            "permanent_address": null,
            "current_address": null,
            "guardian_name": null,
            "custom_field_1": null,
            "custom_field_2": null,
            "custom_field_3": null,
            "custom_field_4": null,
            "bank_details": null,
            "id_proof_name": null,
            "id_proof_number": null,
            "deleted_at": null,
            "created_at": "2018-01-04 02:15:19",
            "updated_at": "2018-01-04 02:15:19"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST connector/api/update-password

Update user password.

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Body Parameters

current_password string

Current password of the user Example: architecto

new_password string

New password of the user Example: architecto

Example request

curl --request POST \
    "https://gulfpos.com/connector/api/update-password" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"current_password\": \"architecto\",
    \"new_password\": \"architecto\"
}"

const url = new URL(
    "https://gulfpos.com/connector/api/update-password"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "current_password": "architecto",
    "new_password": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/update-password';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'current_password' => 'architecto',
            'new_password' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/update-password'
payload = {
    "current_password": "architecto",
    "new_password": "architecto"
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response

Response 200

{
    "success": 1,
    "msg": "Password updated successfully"
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST connector/api/forget-password

Recover forgotten password.

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Body Parameters

email string

Users email id Example: gbailey@example.net

Example request

curl --request POST \
    "https://gulfpos.com/connector/api/forget-password" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"gbailey@example.net\"
}"

const url = new URL(
    "https://gulfpos.com/connector/api/forget-password"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "gbailey@example.net"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/forget-password';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => 'gbailey@example.net',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/forget-password'
payload = {
    "email": "gbailey@example.net"
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response

Response 200

{
    "success": 1,
    "msg": "New password sent to user@example.com successfully"
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/get-attendance/{user_id}

Get Attendance

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

URL Parameters

Name	Type	Status	Description
`user_id`	string	required	id of the user Example: `1`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/get-attendance/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/get-attendance/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/get-attendance/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/get-attendance/1'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": {
        "id": 4,
        "user_id": 1,
        "business_id": 1,
        "clock_in_time": "2020-09-12 13:13:00",
        "clock_out_time": "2020-09-12 13:15:00",
        "essentials_shift_id": 3,
        "ip_address": null,
        "clock_in_note": "test clock in from api",
        "clock_out_note": "test clock out from api",
        "created_at": "2020-09-12 13:14:39",
        "updated_at": "2020-09-12 13:15:39"
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST connector/api/clock-in

Clock In

REQUIRES AUTHENTICATION

[User must have "essentials.allow_users_for_attendance_from_api" permission to Clock in]

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Body Parameters

user_id integer

id of the user Example: 1

clock_in_time string

Clock in time.If not given current date time will be used Fromat: Y-m-d H:i:s Example: 2000-06-13 13:13:00

clock_in_note string

Clock in note. Example: architecto

ip_address string

IP address. Example: architecto

latitude string

Latitude of the clock in location. Example: architecto

longitude string

Longitude of the clock in location. Example: architecto

Example request

curl --request POST \
    "https://gulfpos.com/connector/api/clock-in" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 1,
    \"clock_in_time\": \"2000-06-13 13:13:00\",
    \"clock_in_note\": \"architecto\",
    \"ip_address\": \"architecto\",
    \"latitude\": \"architecto\",
    \"longitude\": \"architecto\"
}"

const url = new URL(
    "https://gulfpos.com/connector/api/clock-in"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 1,
    "clock_in_time": "2000-06-13 13:13:00",
    "clock_in_note": "architecto",
    "ip_address": "architecto",
    "latitude": "architecto",
    "longitude": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/clock-in';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'user_id' => 1,
            'clock_in_time' => '2000-06-13 13:13:00',
            'clock_in_note' => 'architecto',
            'ip_address' => 'architecto',
            'latitude' => 'architecto',
            'longitude' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/clock-in'
payload = {
    "user_id": 1,
    "clock_in_time": "2000-06-13 13:13:00",
    "clock_in_note": "architecto",
    "ip_address": "architecto",
    "latitude": "architecto",
    "longitude": "architecto"
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response

Response 200

{
    "success": true,
    "msg": "Clocked In successfully",
    "type": "clock_in"
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST connector/api/clock-out

Clock Out

REQUIRES AUTHENTICATION

[User must have "essentials.allow_users_for_attendance_from_api" permission to Clock out]

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Body Parameters

user_id integer

id of the user Example: 1

clock_out_time string

Clock out time.If not given current date time will be used Fromat: Y-m-d H:i:s Example: 2000-06-13 13:13:00

clock_out_note string

Clock out note. Example: architecto

latitude string

Latitude of the clock out location. Example: architecto

longitude string

Longitude of the clock out location. Example: architecto

Example request

curl --request POST \
    "https://gulfpos.com/connector/api/clock-out" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 1,
    \"clock_out_time\": \"2000-06-13 13:13:00\",
    \"clock_out_note\": \"architecto\",
    \"latitude\": \"architecto\",
    \"longitude\": \"architecto\"
}"

const url = new URL(
    "https://gulfpos.com/connector/api/clock-out"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 1,
    "clock_out_time": "2000-06-13 13:13:00",
    "clock_out_note": "architecto",
    "latitude": "architecto",
    "longitude": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/clock-out';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'user_id' => 1,
            'clock_out_time' => '2000-06-13 13:13:00',
            'clock_out_note' => 'architecto',
            'latitude' => 'architecto',
            'longitude' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/clock-out'
payload = {
    "user_id": 1,
    "clock_out_time": "2000-06-13 13:13:00",
    "clock_out_note": "architecto",
    "latitude": "architecto",
    "longitude": "architecto"
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response

Response 200

{
    "success": true,
    "msg": "Clocked Out successfully",
    "type": "clock_out"
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/holidays

List Holidays

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Query Parameters

Name	Type	Status	Description
`location_id`	string	optional	id of the location Example: `1`
`start_date`	string	optional	format:Y-m-d Example: `2020-06-25`
`end_date`	string	optional	format:Y-m-d Example: `2020-06-25`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/holidays?location_id=1&start_date=2020-06-25&end_date=2020-06-25" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/holidays"
);

const params = {
    "location_id": "1",
    "start_date": "2020-06-25",
    "end_date": "2020-06-25",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/holidays';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'location_id' => '1',
            'start_date' => '2020-06-25',
            'end_date' => '2020-06-25',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/holidays'
params = {
  'location_id': '1',
  'start_date': '2020-06-25',
  'end_date': '2020-06-25',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": [
        {
            "id": 2,
            "name": "Independence Day",
            "start_date": "2020-08-15",
            "end_date": "2020-09-15",
            "business_id": 1,
            "location_id": null,
            "note": "test holiday",
            "created_at": "2020-09-15 11:25:56",
            "updated_at": "2020-09-15 11:25:56"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/profit-loss-report

Get profit and loss report

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Query Parameters

Name	Type	Status	Description
`location_id`	string	optional	optional id of the location Example: `1`
`start_date`	string	optional	optional format:Y-m-d Example: `2018-06-25`
`end_date`	string	optional	optional format:Y-m-d Example: `2018-06-25`
`user_id`	string	optional	optional id of the user Example: `1`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/profit-loss-report?location_id=1&start_date=2018-06-25&end_date=2018-06-25&user_id=1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/profit-loss-report"
);

const params = {
    "location_id": "1",
    "start_date": "2018-06-25",
    "end_date": "2018-06-25",
    "user_id": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/profit-loss-report';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'location_id' => '1',
            'start_date' => '2018-06-25',
            'end_date' => '2018-06-25',
            'user_id' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/profit-loss-report'
params = {
  'location_id': '1',
  'start_date': '2018-06-25',
  'end_date': '2018-06-25',
  'user_id': '1',
}
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response

Response 200

{
    "data": {
        "total_purchase_shipping_charge": 0,
        "total_sell_shipping_charge": 0,
        "total_transfer_shipping_charges": "0.0000",
        "opening_stock": 0,
        "closing_stock": "386859.00000000",
        "total_purchase": 386936,
        "total_purchase_discount": "0.000000000000",
        "total_purchase_return": "0.0000",
        "total_sell": 9764.5,
        "total_sell_discount": "11.550000000000",
        "total_sell_return": "0.0000",
        "total_sell_round_off": "0.0000",
        "total_expense": "0.0000",
        "total_adjustment": "0.0000",
        "total_recovered": "0.0000",
        "total_reward_amount": "0.0000",
        "left_side_module_data": [
            {
                "value": "0.0000",
                "label": "Total Payroll",
                "add_to_net_profit": true
            },
            {
                "value": 0,
                "label": "Total Production Cost",
                "add_to_net_profit": true
            }
        ],
        "right_side_module_data": [],
        "net_profit": 9675.95,
        "gross_profit": -11.55,
        "total_sell_by_subtype": []
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Headers

Authorization

Content-Type

Accept

Query Parameters

location_id

start_date

end_date

user_id

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/product-stock-report

Get product current stock

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/product-stock-report" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/product-stock-report"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/product-stock-report';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/product-stock-report'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "total_sold": null,
            "total_transfered": null,
            "total_adjusted": null,
            "stock_price": null,
            "stock": null,
            "sku": "AS0001",
            "product": "Men's Reverse Fleece Crew",
            "type": "single",
            "product_id": 1,
            "unit": "Pc(s)",
            "enable_stock": 1,
            "unit_price": "143.0000",
            "product_variation": "DUMMY",
            "variation_name": "DUMMY",
            "location_name": null,
            "location_id": null,
            "variation_id": 1
        },
        {
            "total_sold": "50.0000",
            "total_transfered": null,
            "total_adjusted": null,
            "stock_price": "3850.00000000",
            "stock": "50.0000",
            "sku": "AS0002-1",
            "product": "Levis Men's Slimmy Fit Jeans",
            "type": "variable",
            "product_id": 2,
            "unit": "Pc(s)",
            "enable_stock": 1,
            "unit_price": "77.0000",
            "product_variation": "Waist Size",
            "variation_name": "28",
            "location_name": "Awesome Shop",
            "location_id": 1,
            "variation_id": 2
        },
        {
            "total_sold": "60.0000",
            "total_transfered": null,
            "total_adjusted": null,
            "stock_price": "6930.00000000",
            "stock": "90.0000",
            "sku": "AS0002-2",
            "product": "Levis Men's Slimmy Fit Jeans",
            "type": "variable",
            "product_id": 2,
            "unit": "Pc(s)",
            "enable_stock": 1,
            "unit_price": "77.0000",
            "product_variation": "Waist Size",
            "variation_name": "30",
            "location_name": "Awesome Shop",
            "location_id": 1,
            "variation_id": 3
        }
    ],
    "links": {
        "first": "http://local.pos.com/connector/api/product-stock-report?page=1",
        "last": "http://local.pos.com/connector/api/product-stock-report?page=22",
        "prev": null,
        "next": "http://local.pos.com/connector/api/product-stock-report?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 22,
        "path": "http://local.pos.com/connector/api/product-stock-report",
        "per_page": 3,
        "to": 3,
        "total": 66
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET connector/api/notifications

Get notifications

REQUIRES AUTHENTICATION

Headers

Name	Value
`Authorization`	`Bearer {access_token}`
`Content-Type`	`application/json`
`Accept`	`application/json`

Example request

curl --request GET \
    --get "https://gulfpos.com/connector/api/notifications" \
    --header "Authorization: Bearer {access_token}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://gulfpos.com/connector/api/notifications"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://gulfpos.com/connector/api/notifications';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {access_token}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://gulfpos.com/connector/api/notifications'
headers = {
  'Authorization': 'Bearer {access_token}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response

Response 200

{
    "data": [
        {
            "msg": "Payroll for August/2020 added by Mr. Super Admin. Reference No. 2020/0002",
            "icon_class": "fas fa-money-bill-alt bg-green",
            "link": "http://local.pos.com/hrm/payroll",
            "read_at": null,
            "created_at": "3 hours ago"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Response

Request failed with error



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Generate Access Token

Introduction

Authenticating requests

Authentication

Authorize a client to access the user's account.

Headers

Example request

Interactive API Testing

Get a fresh transient token cookie for the authenticated user.

Headers

Example request

Interactive API Testing

Business Locations

List business locations

Headers

Example request

Example response

Interactive API Testing

Get the specified business location

Headers

URL Parameters

Example request

Example response

Interactive API Testing

Get business details

Headers

Example request

Example response

Interactive API Testing

Get location details from coordinates

Headers

Body Parameters

Example request

Example response

Interactive API Testing

Contacts

List contact

Headers

Query Parameters

Example request

Example response

Interactive API Testing

Create contact

Headers

Body Parameters

Example request

Example response

Interactive API Testing

Get the specified contact

Headers

URL Parameters

Example request

Example response

Interactive API Testing

Update contact

Headers

URL Parameters

Body Parameters

Example request

Example response

Interactive API Testing

Contact payment

Headers

Body Parameters

Example request

Example response

Interactive API Testing

New List contact

Headers

Query Parameters

Example request

Example response

Interactive API Testing

Products

List products

Headers

Query Parameters

Example request

Example response

Interactive API Testing