Retrieve All Settings: /settings
GET
https://dev-api.exsited.com/api/v3/settings
Try It Out
Purpose
This endpoint retrieves the system-wide configuration and settings for the organization. It returns details about the organization profile, general preferences, field-level settings, warehouses, charging/billing/pricing periods, payment terms, event/communication profiles, taxes, currencies, and other configurations that control how the platform behaves.
Use Case
- To display or verify an organization’s profile details (e.g., name, address, logo, industry).
- To configure or audit general business rules for accounts, items, orders, purchases, security, dashboards, portals, and inventory.
- To fetch field-level metadata (e.g., required fields for accounts or contacts).
- To list financial & transactional settings (e.g., taxes, currencies, accounting codes, payment processors).
- To sync application behavior with organization-specific settings when integrating external systems.
Path Parameters
This endpoint does not require path parameters.
Query Parameters
This endpoint does not accept query parameters.
Request Body
This endpoint does not require a request body.
Response
The response is a JSON object containing a nested structure of organization details, general settings, field settings, warehouse configurations, time and billing periods, event/communication profiles, invoice/payment terms, processors, taxes, and currencies. It provides both business-facing information (example: organization name, address, contact info, industry) and system-level configurations (example: session timeout, account rules, item pricing rules, dashboards, transaction defaults). This allows clients and integrators to dynamically configure their user interfaces, workflows, and validations according to the retrieved organization settings
Response Body
JSON
{
"settings": {
"organisation": {
"name": "JOY DEV",
"description": "",
"image_uri": "https://dev.exsited.com/resources/organization-logo/1/a09f58b2-1db3-43df-b4dc-0c379b1d550f.jpg",
"email_address": "joyweb500@gmail.com",
"business_id_1": "",
"business_id_2": "",
"business_id_3": "",
"business_id_4": "",
"business_id_5": "",
"address_line_1": "9 yarra Street",
"address_line_2": "",
"post_code": "3000",
"city": "Melbourne",
"state": "Victoria",
"country": "Australia",
"phone_full": "",
"mobile_full": "",
"fax_full": "",
"website": "",
"industry": "Commercial Services"
},
"general_settings": {
"date_and_time": {
"time_zone": "(GMT+10:00) Australia/Melbourne",
"date_format": "19/8/2025",
"time_format": "05:32 PM",
"first_day_of_week": "Monday"
},
"account": {
"account_grouping": {
"enabled": "true",
"default_group": ""
},
"creation_of_subsidiary_account": {
"enabled": "true",
"default_subsidiary_account": ""
},
"account_management": {
"enabled": "true",
"default_manager": ""
},
"referral_tracking_at_account_level": {
"enabled": "true",
"default_referral_tracking": ""
},
"sales_rep_tracking_at_account_level": {
"enabled": "true",
"default_sales_rep_tracking": ""
},
"enable_workflow_approval_for_account": "false",
"require_name_to_be_unique": "true",
"require_email_address_for_account": "true",
"require_email_address_for_account_to_be_unique": "true",
"require_email_address_for_contact_to_be_unique": "false",
"billing_contact": {
"enabled": "true",
"type": "Contact 1",
"display_name": "Billing Contact",
"require_email_address_for_billing_contact": "false"
},
"shipping_contact": {
"enabled": "true",
"type": "Contact 2",
"display_name": "Shipping Contact",
"require_email_address_for_shipping_contact": "false"
},
"additional_contact_1": {
"enabled": "true",
"type": "Contact 3",
"display_name": "Additional Contact 1",
"require_email_address_for_additional_contact_1": "false"
},
"additional_contact_2": {
"enabled": "true",
"type": "Contact 4",
"display_name": "Additional Contact 2",
"require_email_address_for_additional_contact_2": "false"
},
"additional_contact_3": {
"enabled": "true",
"type": "Contact 5",
"display_name": "Additional Contact 3",
"require_email_address_for_additional_contact_3": "false"
}
},
"item": {
"enable_variation_based_item": "true",
"enable_gift_certificate_based_item": "true",
"require_name_to_be_unique": "true",
"enable_variation": "true",
"item_grouping": {
"enabled": "true",
"default_group": ""
},
"item_management": {
"enabled": "true",
"default_manager": ""
},
"use_volume_pricing": {
"all_units_fixed_pricing": "true",
"incremental_fixed_pricing": "true",
"all_units_per_unit_pricing": "true",
"incremental_per_unit_pricing": "true"
},
"enable_pricing_profile": "true",
"enable_workflow_approval_for_item": "false",
"enable_sales": "true",
"available_charge_types": {
"one_off": "true",
"recurring": "true",
"metered": "true"
},
"use_pricing_level": "true",
"use_scheduling_of_future_pricing": "true",
"charging_period_can_vary_from_billing_period": "true",
"charging_start_date_can_vary_from_billing_start_date": "true",
"pricing_period_can_vary_from_charging_period": {
"enabled": "true",
"default_pricing_period": ""
},
"sale_price_entered_is_inclusive_of_tax": {
"enabled": "true",
"tax_included_in_sales_price_is_based_on": "Sales Tax"
},
"available_pricing_methods": {
"standard": "true",
"discount_based": "true",
"markup_based": "true"
},
"enable_purchase": "true",
"enable_supplier_management": "true",
"purchase_price_entered_is_inclusive_of_tax": {
"enabled": "true",
"tax": ""
},
"enable_inventory_management": "true",
"enable_warehouse_management": "true",
"use_global_warehouse": "false",
"inventory_adjustment_rules": {
"quantity_available_for_sale_determination": [
"QUANTITY_ON_HAND",
"QUANTITY_PROMISED",
"QUANTITY_ON_ORDER",
"QUANTITY_ON_RETURN",
"QUANTITY_ON_PURCHASE_RETURN"
],
"quantity_available_for_sale": "Quantity Available"
}
},
"order": {
"order_management": {
"enabled": "true",
"default_manager": ""
},
"referral_tracking_at_order_level": {
"enabled": "true",
"default_referral_tracking": ""
},
"sales_rep_tracking_at_order_level": {
"enabled": "true",
"default_sales_rep_tracking": ""
},
"inventory_is_adjusted_when": "Item fulfillment is shipped",
"use_global_warehouse": "false",
"enable_quote": "true",
"enable_order_backdating": "true",
"enable_last_sale_price_look_up_for_an_account": "true",
"allow_name_to_be_changed_in_order": "true",
"allow_unit_price_to_be_changed_in_order": "true",
"displayed_price_is_inclusive_of_tax": "true"
},
"transaction": {
"default_accounting_codes": {
"account_receivable": "Account Receivable",
"cash_and_cash_equivalent": "Cash and Cash Equivalent",
"inventory": "Inventory",
"sales_revenue": "Sales Revenue",
"tax": "Tax",
"credit_note_payable": "Credit Note Payable",
"rounding": "Rounding",
"account_payable": "Account Payable",
"cost_of_goods_sold": "Cost of Goods Sold",
"deduction": "Deduction",
"event_charge": "Event Charge",
"payment_surcharge": "Payment Surcharge"
},
"enable_creation_of_automatic_payment_surcharge": "false",
"create_negative_charge_to_accommodate_adjustment_required_for_order_cancel_or_change": "false",
"update_current_invoice_to_include_charge_adjustments": "true",
"enable_discount_profile": "true",
"displayed_price_is_inclusive_of_tax": "true",
"available_mediums_for_communication_preference": {
"email": {
"enabled": "true",
"default": "true"
},
"postal_mail": {
"enabled": "true",
"default": "false"
},
"text_message": {
"enabled": "true",
"default": "false"
},
"voice_mail": {
"enabled": "true",
"default": "false"
}
},
"disable_notification_for_invoice_with_charges_of_zero_amount": "true",
"allow_modification_of_following_invoice_fields": {
"billing_period": "true",
"charge_period": "true",
"issue_date": "true",
"due_date": "true"
},
"allow_modification_of_following_payment_fields": {
"payment_date": "true",
"payment_processor": "true",
"payment_reference": "true"
},
"allow_modification_of_following_credit_note_fields": {
"refundable": "true",
"credit_note_date": "true"
},
"allow_modification_of_following_refund_fields": {
"refund_date": "true",
"refund_reference": "true"
}
},
"purchase": {
"use_global_warehouse": "false",
"enable_workflow_approval_for_purchase_order": "false",
"enable_workflow_approval_for_purchase_invoice": "false",
"enable_workflow_approval_for_purchase_payment": "false",
"enable_workflow_approval_for_purchase_credit_note": "false",
"enable_workflow_approval_for_purchase_refund": "false",
"inventory_is_adjusted_when": "Item receive is created",
"allow_modification_of_following_purchase_invoice_fields": {
"issue_date": "true",
"due_date": "true"
},
"allow_modification_of_following_purchase_payment_fields": {
"payment_date": "true",
"payment_processor": "true",
"payment_reference": "true"
},
"allow_modification_of_following_purchase_credit_note_fields": {
"refundable": "true"
},
"allow_modification_of_following_purchase_refund_fields": {
"refund_date": "true",
"refund_reference": "true"
}
},
"display_settings": {},
"security_settings": {
"session_timeout": {
"enabled": "true",
"timeout": "2"
},
"enable_tfa": "false",
"allow_support_login": "false"
},
"dashboards": {
"accounting": { "enabled": "true", "default": "false" },
"executive": { "enabled": "true", "default": "false" },
"finance": { "enabled": "true", "default": "false" },
"production": { "enabled": "true", "default": "false" },
"sales": { "enabled": "true", "default": "false" }
},
"inventory": {
"enable_inventory_management": "false"
},
"portal": {
"enable_portal_login": "true",
"enable_portal_login_for": "Account",
"customer_portal_url": "https://00000000.autobill-portal.com",
"set_password_invitation_can_be_sent_by_operator": "true",
"password_can_be_specified_by_operator": "true"
}
},
"field_settings": {
"account": {
"fields": [
{
"name": "name",
"display_name": "Name",
"enabled": "true",
"change_enabled": "false",
"required": "true",
"change_required": "false",
"social_media_type": "",
"default": ""
},
{
"name": "displayName",
"display_name": "Display Name",
"enabled": "true",
"change_enabled": "true",
"required": "false",
"change_required": "false",
"social_media_type": "",
"default": ""
}
]
}
}
},
"warehouses": [
{
"uuid": "69713aa2-6329-4bf7-a465-3ba75a477f84",
"status": "ACTIVE",
"default": "false",
"name": "Default Warehouse",
"display_name": "Default Warehouse",
"description": "",
"country": "Australia",
"state": "",
"city": "",
"post_code": ""
}
],
"charging_periods": [
{
"uuid": "7754b80b-1fbd-4155-9f0b-5e164dcbd100",
"status": "ACTIVE",
"name": "1 Day",
"display_name": "1 Day",
"description": "",
"time_period": "1 Day",
"display_order": "0"
}
],
"pricing_periods": [
{
"uuid": "3de0ecb5-5c4a-419e-9c4f-55f7d9800b0c",
"status": "ACTIVE",
"name": "1 Day",
"display_name": "1 Day",
"description": "",
"time_period": "1 Day",
"display_order": "0"
}
],
"billing_periods": [
{
"uuid": "40554136-d745-4b3f-8cd0-579427f262a2",
"status": "ACTIVE",
"name": "1 Day",
"display_name": "1 Day",
"description": "",
"time_period": "1 Day",
"display_order": "0"
}
],
"time_periods": [
{
"uuid": "40d468b8-71e5-4abc-8540-f58ac043c555",
"status": "ACTIVE",
"name": "1 Day",
"display_name": "1 Day",
"description": "",
"duration": { "period": "DAILY", "count": "1" },
"display_order": "0"
}
],
"payment_terms": [
{
"uuid": "b4eba373-bcce-4553-ae6d-ee8dd0ffb94f",
"status": "ACTIVE",
"name": "Due on Receipt",
"display_name": "Due on Receipt",
"description": "",
"duration": { "period": "DAILY", "count": 0 },
"display_order": "0"
}
],
"event_profiles": [
{
"uuid": "309b750f-d765-40b1-967e-7b4268faf864",
"status": "ACTIVE",
"default": "true",
"name": "AutoBill Event Profile",
"display_name": "AutoBill Event Profile",
"descriptions": "",
"communication_profile": "DEFAULT"
}
],
"communication_profiles": [
{
"uuid": "82b045e0-93bb-4077-b433-b04758a7400e",
"status": "ACTIVE",
"default": "true",
"name": "AutoBill Communication Profile",
"display_name": "AutoBill Communication Profile",
"descriptions": "Default communication profile"
}
],
"invoice_terms": [
{
"uuid": "e19cd861-a8f7-4137-9f26-91f2df394cd9",
"status": "ACTIVE",
"name": "Billing Start Date",
"display_name": "Billing Start Date",
"description": "",
"duration": { "period": "DAILY", "count": 0 },
"display_order": "0"
}
],
"payment_processors": [
{
"uuid": "8936b558-fdd4-420a-a84f-aa98f94c030a",
"status": "ACTIVE",
"default": "false",
"name": "Bank Deposit",
"display_name": "Bank Deposit",
"description": "",
"provider": "Offline",
"currency": "AUD"
}
],
"taxes": [
{
"uuid": "5e1260e9-8aa2-45fd-8638-ce04f24f8c53",
"status": "ACTIVE",
"name": "Australia",
"country": "Australia",
"configuration": "AUS",
"code": "GST",
"rate": "10.000000"
}
],
"currencies": [
{
"uuid": "b57ec9eb-76aa-4655-9784-8ab253bd265c",
"status": "ACTIVE",
"name": "AED",
"display_name": "UAE Dirham",
"country": "United Arab Emirates",
"symbol": "د.إ",
"currency_code": "AED",
"precision": 2,
"rounding": "NEAREST",
"cash_rounding_interval": "0.05"
}
]
}| Attribute | Type | Description |
|---|---|---|
| settings | Object | Contains system configuration including organisation, general, field settings. |
| warehouses | Array | List of warehouse configurations. |
| charging_periods | Array | Defines charging cycles. |
| pricing_periods | Array | Defines pricing cycles. |
| billing_periods | Array | Defines billing cycles. |
| time_periods | Array | Defines custom time periods. |
| payment_terms | Array | Defines terms of payment. |
| event_profiles | Array | Profiles for handling events. |
| communication_profiles | Array | Profiles for managing communication. |
| invoice_terms | Array | Defines invoice rules. |
| payment_processors | Array | Available payment methods. |
| taxes | Array | Tax configurations. |
| currencies | Array | Currency configurations with precision/rounding. |
Retrieve Taxes From Settings: /settings/taxes
GET
https://dev-api.exsited.com/api/v3/settings/taxes
Try It Out
Purpose
This API endpoint retrieves the list of all tax configurations set up in the system, including details like country, tax code, configuration, status, and rate. It is useful for applications that need to display, calculate, or manage tax information programmatically.
Use Case
- Fetch all active or inactive tax entries for billing or reporting.
- Integrate tax information into invoicing, accounting, or order management systems.
- Display applicable tax codes and rates in user-facing portals or admin dashboards.
Path Parameters
This endpoint does not require path parameters.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Optional. Number of records to return per page. Default is 20. |
| offset | integer | Optional. Number of records to skip for pagination. Default is 0. |
Request Body
This endpoint does not require a request body.
Response
The response returns a JSON object containing a taxes array, which lists each tax configuration with details such as uuid, status, name, country, configuration, code, and rate. It also includes a pagination object that indicates the total number of tax records, the limit and offset for pagination, and URLs for the previous and next pages of results. This response allows applications to retrieve complete tax information and handle pagination efficiently.
Response Body
JSON
{
"taxes": [
{
"uuid": "5e1260e9-8aa2-45fd-8638-ce04f24f8c53",
"status": "ACTIVE",
"name": "Australia",
"country": "Australia",
"configuration": "AUS",
"code": "GST",
"rate": "10.000000"
},
{
"uuid": "c2c87040-6d89-442f-a6c0-8266f695175d",
"status": "ACTIVE",
"name": "Ireland",
"country": "Ireland",
"configuration": "IRL",
"code": "VAT",
"rate": "23.000000"
},
{
"uuid": "84e7cb53-3a76-4b16-89c2-a94dfc816e9b",
"status": "ACTIVE",
"name": "Japan",
"country": "Japan",
"configuration": "JPN",
"code": "Tax",
"rate": "8.000000"
},
{
"uuid": "7b6415b9-a5b9-42aa-875c-dbe75a88c747",
"status": "ACTIVE",
"name": "New Zealand",
"country": "New Zealand",
"configuration": "NZL",
"code": "GST",
"rate": "15.000000"
},
{
"uuid": "c7e1b011-d114-405f-9028-5b3dea397608",
"status": "ACTIVE",
"name": "Papua New Guinea",
"country": "Papua New Guinea",
"configuration": "PNG",
"code": "GST",
"rate": "10.000000"
},
{
"uuid": "533c145a-1990-4065-924d-53282a3abb61",
"status": "ACTIVE",
"name": "Singapore",
"country": "Singapore",
"configuration": "SGP",
"code": "GST",
"rate": "7.000000"
},
{
"uuid": "380a20ac-45d0-45b6-a93f-5d324a6e2c0b",
"status": "ACTIVE",
"name": "United Kingdom",
"country": "United Kingdom",
"configuration": "GBR",
"code": "VAT",
"rate": "20.000000"
},
{
"uuid": "d39f6d15-83bb-4a4e-87c4-d94541a41dfc",
"status": "ACTIVE",
"name": "Canada",
"country": "Canada",
"configuration": "CAN",
"code": "GST",
"rate": "5.000000"
},
{
"uuid": "bb7bcae4-ccec-498d-bd6f-4b14afe47913",
"status": "ACTIVE",
"name": "Canada",
"country": "Canada",
"configuration": "CAN",
"code": "GST + PST",
"rate": "12.000000"
},
{
"uuid": "7d77a2cf-cf46-4693-b05b-ee9d41814110",
"status": "ACTIVE",
"name": "Canada",
"country": "Canada",
"configuration": "CAN",
"code": "GST + PST",
"rate": "13.000000"
},
{
"uuid": "0fb77105-4a56-4f47-b512-6cbba64d61ad",
"status": "ACTIVE",
"name": "Canada",
"country": "Canada",
"configuration": "CAN",
"code": "HST",
"rate": "15.000000"
},
{
"uuid": "df299297-7566-46cd-b97e-1a7b68bbc1c3",
"status": "ACTIVE",
"name": "Canada",
"country": "Canada",
"configuration": "CAN",
"code": "HST",
"rate": "15.000000"
},
{
"uuid": "22eab04d-2497-4277-95e6-1fb01fb5f5a3",
"status": "ACTIVE",
"name": "Canada",
"country": "Canada",
"configuration": "CAN",
"code": "GST",
"rate": "5.000000"
},
{
"uuid": "1f839301-91ed-4cb4-bd57-f38b7350a9c3",
"status": "ACTIVE",
"name": "Canada",
"country": "Canada",
"configuration": "CAN",
"code": "HST",
"rate": "15.000000"
},
{
"uuid": "b973a2b0-ec3c-4d38-993f-9f207b7b41d9",
"status": "ACTIVE",
"name": "Canada",
"country": "Canada",
"configuration": "CAN",
"code": "GST",
"rate": "5.000000"
},
{
"uuid": "b77ade87-024d-4602-b3b3-36cc3414dc41",
"status": "ACTIVE",
"name": "Canada",
"country": "Canada",
"configuration": "CAN",
"code": "HST",
"rate": "13.000000"
},
{
"uuid": "959d4952-8312-4725-aab4-3db1d6a7ba97",
"status": "ACTIVE",
"name": "Canada",
"country": "Canada",
"configuration": "CAN",
"code": "HST",
"rate": "15.000000"
},
{
"uuid": "678bd5ea-1632-4ee4-9a9e-4d3942275431",
"status": "ACTIVE",
"name": "Canada",
"country": "Canada",
"configuration": "CAN",
"code": "GST + QST",
"rate": "14.975000"
},
{
"uuid": "7195822c-631a-40a6-944f-4f54cb22f0a5",
"status": "ACTIVE",
"name": "Canada",
"country": "Canada",
"configuration": "CAN",
"code": "GST + PST",
"rate": "11.000000"
},
{
"uuid": "d4b6932c-56f4-40b8-a226-3809ea0a7462",
"status": "ACTIVE",
"name": "Canada",
"country": "Canada",
"configuration": "CAN",
"code": "GST",
"rate": "5.000000"
}
],
"pagination": {
"records": 23,
"limit": 20,
"offset": 0,
"previous_page": "",
"next_page": "https://dev-api.exsited.com/api/v2/settings/taxes?limit=20&offset=20"
}
}| Attribute | Type | Description |
|---|---|---|
| uuid | string | Unique identifier of the tax configuration |
| status | string | Current status of the tax |
| name | string | Name of the tax |
| country | string | Country associated with the tax |
| configuration | string | Tax configuration code |
| code | string | Tax code used for billing |
| rate | string | Tax rate as a decimal number |
Retrieve Payment Processors From Settings: /settings/payment_processors
GET
https://dev-api.exsited.com/api/v3/settings/payment_processors
Try It Out
Purpose
This API endpoint retrieves all configured payment processors in the system, including details like provider, currency, status, and default setting. It is useful for listing available payment methods for billing, invoicing, or payment collection.
Use Case
- Display available payment methods in invoices or customer portals.
- Fetch and manage payment processor configurations for internal administration.
- Integrate payment options into order or billing workflows programmatically.
Path Parameters
This endpoint does not require path parameters.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Optional. Number of records per page (pagination). Default is 20. |
| offset | integer | Optional. Number of records to skip for pagination. Default is 0. |
Request Body
This endpoint does not require a request body.
Response
The response returns a JSON object with a payment_processors array containing each processor’s details, including uuid, status, default flag, name, display_name, description, provider, and currency. This allows applications to retrieve and display available payment methods for different currencies and providers. The response is a flat structure without nested arrays beyond the first layer, making it easy to iterate over the list of processors.
Response Body
JSON
{
"payment_processors": [
{
"uuid": "8936b558-fdd4-420a-a84f-aa98f94c030a",
"status": "ACTIVE",
"default": "false",
"name": "Bank Deposit",
"display_name": "Bank Deposit",
"description": "",
"provider": "Offline",
"currency": "AUD"
},
{
"uuid": "a4337c7e-fb1a-4b28-8097-cac5e90a74d2",
"status": "ACTIVE",
"default": "true",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "AUD"
},
{
"uuid": "6880740e-a3d2-4d7c-800d-a7da8995e2cf",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "USD"
},
{
"uuid": "711df445-5bf6-4472-b9cd-a875d140dbb0",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "EUR"
},
{
"uuid": "f5664383-6d81-498c-a0f8-c2a099b52b1d",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "GBP"
},
{
"uuid": "efe8cb16-8626-4ff1-919f-80a7d19891a5",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "NZD"
},
{
"uuid": "722f8872-a221-4929-b16e-a76227384ee3",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "SGD"
},
{
"uuid": "1f46622c-4d49-4dce-99eb-9a7358a5d4b0",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "AED"
},
{
"uuid": "88a23a17-d465-49ba-9b33-e3df5c1bad98",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "ZAR"
},
{
"uuid": "d3aa0499-d9b1-4fa1-b964-ed27314c7ae5",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "SAR"
},
{
"uuid": "d39579d7-ab47-404c-ba73-fad56d555cd6",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "BDT"
},
{
"uuid": "ce52cc36-1d5e-429b-a361-e9dc258823c1",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "ARS"
},
{
"uuid": "0e6f93ba-6a44-4ab7-8483-2645b769436d",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "AFN"
},
{
"uuid": "055dd0a7-9e7b-42a7-9e7e-e6096615d4f0",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "ALL"
},
{
"uuid": "ed005457-aa0a-4235-8bf4-9e60bb1ebd07",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "AMD"
},
{
"uuid": "cd5875e0-54a9-4717-b7ae-910c0b21df62",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "AOA"
},
{
"uuid": "dd4a044a-52d5-4d25-8309-6e2107d00a3c",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "AWG"
},
{
"uuid": "6469bceb-5dfb-41f4-b8a1-19fb9452532d",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "CAD"
},
{
"uuid": "478bcca1-1f12-4c17-919a-bc96c87ff046",
"status": "ACTIVE",
"default": "false",
"name": "Cash",
"display_name": "Cash",
"description": "",
"provider": "Offline",
"currency": "CNY"
},
{
"uuid": "b4a10a26-d73e-4705-9de3-5e88528a19cd",
"status": "ACTIVE",
"default": "false",
"name": "Cheque",
"display_name": "Cheque",
"description": "",
"provider": "Offline",
"currency": "AUD"
},
{
"uuid": "9ecc8b4e-8009-4ecd-af85-0fe42ffd3293",
"status": "ACTIVE",
"default": "false",
"name": "Offline DD - AAgdom",
"display_name": "Offline DD - AAgdom",
"description": "",
"provider": "Offline Direct Debit",
"currency": "AUD"
},
{
"uuid": "a28f1bbd-c9d7-4b15-94a6-310efc587065",
"status": "ACTIVE",
"default": "false",
"name": "Offline Direct Debit JG",
"display_name": "Offline Direct Debit JG",
"description": "",
"provider": "Offline Direct Debit",
"currency": "AUD"
},
{
"uuid": "26c5b541-6b5d-4bbf-be54-6dc51dc4df6e",
"status": "ACTIVE",
"default": "false",
"name": "Offline Direct Debit JM",
"display_name": "Offline Direct Debit JM",
"description": "",
"provider": "Offline Direct Debit",
"currency": "AUD"
},
{
"uuid": "6e257611-5ccc-414a-8a3a-cac497221469",
"status": "ACTIVE",
"default": "false",
"name": "Offline Direct Debit NH",
"display_name": "Offline Direct Debit NH",
"description": "",
"provider": "Offline Direct Debit",
"currency": "AUD"
},
{
"uuid": "1108979d-5476-4b6b-8f6a-fdc45f22a61d",
"status": "ACTIVE",
"default": "false",
"name": "SecurePay - AUD",
"display_name": "SecurePay - AUD",
"description": "",
"provider": "SecurePay",
"currency": "AUD"
},
{
"uuid": "5a4ddd43-4025-481a-865d-ffcd0cf1bec2",
"status": "ACTIVE",
"default": "false",
"name": "Stripe",
"display_name": "Stripe",
"description": "",
"provider": "Stripe",
"currency": "AUD"
},
{
"uuid": "4d6060a4-db84-4893-8237-8aa3d4bf6aca",
"status": "ACTIVE",
"default": "false",
"name": "Test Account NG (Offline Direct Debit)",
"display_name": "Test Account NG (Offline Direct Debit)",
"description": "",
"provider": "Offline Direct Debit",
"currency": "AUD"
}
]
}| Attribute | Type | Description |
|---|---|---|
| uuid | string | Unique identifier of the payment processor |
| status | string | Status of the processor |
| default | string | Indicates whether this processor is the default method (true/false) |
| name | string | Name of the payment processor |
| display_name | string | Display name of the payment processor |
| description | string | Optional description of the processor |
| provider | string | Payment provider type |
| currency | string | Currency code supported by this processor |
Retrieve Currencies From Settings: /settings/currencies
GET
https://dev-api.exsited.com/api/v3/settings/currencies
Try It Out
Purpose
This API endpoint retrieves all configured currencies in the system, including details such as currency code, symbol, country, rounding rules, and precision. It is useful for displaying supported currencies in invoices, payments, or reports.
Use Case
- Display available currencies for payments or invoices.
- Retrieve currency configuration for multi-currency financial processing.
- Support user selection of currency in applications and forms.
Path Parameters
This endpoint does not require path parameters.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Optional. Number of records per page (pagination). Default is 20. |
| offset | integer | Optional. Number of records to skip for pagination. Default is 0. |
Request Body
This endpoint does not require a request body.
Response
The response returns a JSON object containing a currencies array. Each currency object includes the currency uuid, status, name, display_name, country, symbol, currency_code, precision, rounding method (rounding), and cash_rounding_interval. This allows applications to display and process currency amounts accurately, apply rounding rules, and support multiple countries and currencies in financial transactions. Pagination information is included to support fetching large currency lists efficiently.
Response Body
JSON
{
"currencies": [
{
"uuid": "4f444464-defa-4180-a18e-e2bf4b5a84a1",
"status": "ACTIVE",
"name": "AUD",
"display_name": "AUD",
"country": "Australia",
"symbol": "$",
"currency_code": "AUD",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.05"
},
{
"uuid": "574cea65-7ea4-484d-951b-f70897fcd92b",
"status": "ACTIVE",
"name": "USD",
"display_name": "USD",
"country": "United States",
"symbol": "$",
"currency_code": "USD",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.01"
},
{
"uuid": "adbb0fd3-e57b-4a07-a366-9f35f9114b8a",
"status": "ACTIVE",
"name": "EUR",
"display_name": "EUR",
"country": "Portugal",
"symbol": "€",
"currency_code": "EUR",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.05"
},
{
"uuid": "4dcba135-c63f-4f46-93a7-5629746ca100",
"status": "ACTIVE",
"name": "GBP",
"display_name": "GBP",
"country": "United Kingdom",
"symbol": "£",
"currency_code": "GBP",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.01"
},
{
"uuid": "52ea5890-6b15-425f-bcc8-9ba5923e4044",
"status": "ACTIVE",
"name": "NZD",
"display_name": "NZD",
"country": "New Zealand",
"symbol": "$",
"currency_code": "NZD",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.1"
},
{
"uuid": "87cff079-f4c1-4953-a6f6-060af81517f3",
"status": "ACTIVE",
"name": "SGD",
"display_name": "SGD",
"country": "Singapore",
"symbol": "$",
"currency_code": "SGD",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.05"
},
{
"uuid": "b57ec9eb-76aa-4655-9784-8ab253bd265c",
"status": "ACTIVE",
"name": "AED",
"display_name": "AED",
"country": "United Arab Emirates",
"symbol": "د.إ",
"currency_code": "AED",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.05"
},
{
"uuid": "f0938a55-57e8-4258-a52b-62fb10176ff1",
"status": "ACTIVE",
"name": "ZAR",
"display_name": "ZAR",
"country": "South Africa",
"symbol": "R",
"currency_code": "ZAR",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.05"
},
{
"uuid": "07f054bc-2b15-4dc7-b2b9-8aabbbf3f464",
"status": "ACTIVE",
"name": "SAR",
"display_name": "SAR",
"country": "Saudi Arabia",
"symbol": "ر.س",
"currency_code": "SAR",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.05"
},
{
"uuid": "5e37a64c-60ed-48fe-8c30-bc6ca450ed34",
"status": "ACTIVE",
"name": "BDT",
"display_name": "BDT",
"country": "Bangladesh",
"symbol": "৳",
"currency_code": "BDT",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.05"
},
{
"uuid": "a63afa07-45b1-4c37-9480-a9c9406602e4",
"status": "ACTIVE",
"name": "ARS",
"display_name": "ARS",
"country": "Argentina",
"symbol": "$",
"currency_code": "ARS",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.05"
},
{
"uuid": "d0eff7c7-848c-41dc-967d-a0575a01fa18",
"status": "ACTIVE",
"name": "AFN",
"display_name": "AFN",
"country": "Afghanistan",
"symbol": "Af",
"currency_code": "AFN",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.05"
},
{
"uuid": "0c813026-8d24-4a85-ad01-d7daf296950e",
"status": "ACTIVE",
"name": "ALL",
"display_name": "ALL",
"country": "Albania",
"symbol": "L",
"currency_code": "ALL",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.05"
},
{
"uuid": "0c377856-593a-4ce7-9360-0cf9b24d65f0",
"status": "ACTIVE",
"name": "AMD",
"display_name": "AMD",
"country": "Armenia",
"symbol": "Դ",
"currency_code": "AMD",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.05"
},
{
"uuid": "bc9e1e1f-354f-4364-862c-d94e538ccee1",
"status": "ACTIVE",
"name": "AOA",
"display_name": "AOA",
"country": "Angola",
"symbol": "Kz",
"currency_code": "AOA",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.05"
},
{
"uuid": "d06bc699-ef8e-4c7c-9ad6-36c1b1505ebc",
"status": "ACTIVE",
"name": "AWG",
"display_name": "AWG",
"country": "Aruba",
"symbol": "ƒ",
"currency_code": "AWG",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.05"
},
{
"uuid": "c8534388-8db0-479a-b188-78b59650d7e8",
"status": "ACTIVE",
"name": "CAD",
"display_name": "CAD",
"country": "Canada",
"symbol": "$",
"currency_code": "CAD",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.05"
},
{
"uuid": "6e9afe9f-ec67-433d-b9bc-1a7716bc3113",
"status": "ACTIVE",
"name": "CNY",
"display_name": "CNY",
"country": "China",
"symbol": "¥",
"currency_code": "CNY",
"precision": "2",
"rounding": "NEAREST",
"cash_rounding_interval": "0.05"
}
],
"pagination": {
"records": 18,
"limit": 20,
"offset": 0,
"previous_page": "",
"next_page": "NULL"
}
}| Attribute | Type | Description |
|---|---|---|
| uuid | string | Unique identifier of the currency |
| status | string | Status of the currency |
| name | string | ISO code or short name of the currency |
| display_name | string | Display name of the currency |
| country | string | Country associated with the currency |
| symbol | string | Symbol of the currency |
| currency_code | string | Currency code (ISO 4217) |
| precision | string | Decimal precision used for this currency |
| rounding | string | Rounding method applied |
| cash_rounding_interval | string | Smallest cash rounding interval for physical transactions |
Retrieve Item Groups From Settings: /settings/item_groups
GET
https://dev-api.exsited.com/api/v3/settings/item_groups
Try It Out
Purpose
This API retrieves all item groups configured in the system. Item groups are used to categorize and organize items into logical collections for easier management, reporting, and billing configuration.
Use Case
- Fetch all available item groups for displaying in UI dropdowns, catalogs, or management dashboards.
- Retrieve item group details such as name, description, display name, and billing preferences for business rules or reporting.
- Enable administrators or integrators to sync and manage item groups across external systems
Path Parameters
This endpoint does not require path parameters.
Query Parameters
This endpoint does not accept query parameters.
Request Body
This endpoint does not require a request body.
Response
The response returns an object containing an array of item_group records. Each record represents a defined item group in the system. Attributes include identifiers (uuid), status (ACTIVE or INACTIVE), descriptive fields (name, display_name, description, image_uri, manager), and configuration data (custom_attribute). Additionally, the response includes billing_preferences, which detail invoice, billing, and payment configuration associated with that item group. This allows clients to retrieve both organizational and billing-related configurations for each item group in one API call.
Response Body
JSON
{
"item_group": [
{
"uuid": "e6b0b77d-e3fc-47e8-9cf2-a993efb6dfc3",
"status": "ACTIVE",
"name": "Default Group",
"display_name": "Default Group",
"description": "",
"image_uri": "",
"manager": "",
"custom_attribute": [],
"billing_preferences": {
"communication_profile": "",
"invoice_mode": "",
"invoice_term": "",
"billing_period": "",
"billing_start_date": "",
"billing_start_day_of_month": "",
"payment_processor": "",
"payment_mode": "",
"payment_term": "",
"payment_term_alignment": ""
}
}
]
}| Attribute | Type | Description |
|---|---|---|
| uuid | string | Unique identifier of the item group |
| status | string | Status of the group (e.g., ACTIVE, INACTIVE) |
| name | string | Internal name of the group |
| display_name | string | Display name shown in UI or reports |
| description | string | Description of the group (optional) |
| image_uri | string | URI of the image/logo representing the group |
| manager | string | Name or identifier of the manager responsible for the group |
| custom_attribute | array | List of custom attributes associated with this group |
| billing_preferences | object | Billing configuration preferences for the item group |
Retrieve Pricing Levels From Settings: /settings/pricing_levels
GET
https://dev-api.exsited.com/api/v3/settings/pricing_levels
Try It Out
Purpose
This API retrieves all pricing levels configured in the system. Pricing levels are used to define tiered pricing structures (example: Bronze, Silver, Gold, Diamond) that can be assigned to customers or accounts to control pricing strategies.
Use Case
- Retrieve available pricing levels to display in UI dropdowns, order forms, or account setup screens.
- Sync pricing level details with external systems (example: ERP, CRM).
- Manage and report on pricing levels associated with customers and items.
Path Parameters
This endpoint does not require path parameters.
Query Parameters
This endpoint does not accept query parameters.
Request Body
This endpoint does not require a request body.
Response
The response contains a list of pricing levels available in the system, along with pagination details. Each pricing level includes attributes such as its unique identifier (uuid), current status (ACTIVE or INACTIVE), internal system name (name), display name (display_name), and a description. The pagination object provides metadata about the dataset, including the total number of records returned, pagination limits, offsets, and navigation information (previous_page and next_page).
Response Body
JSON
{
"pricing_levels": [
{
"uuid": "9f830c21-f34e-49f9-8d15-656a988fb310",
"status": "ACTIVE",
"name": "Diamond",
"display_name": "Diamond",
"description": ""
}
],
"pagination": {
"records": 1,
"limit": 20,
"offset": 0,
"previous_page": "",
"next_page": "NULL"
}
}| Attribute | Type | Description |
|---|---|---|
| uuid | string | Unique identifier of the pricing level. |
| status | string | Status of the pricing level (ACTIVE, INACTIVE). |
| name | string | Internal system name of the pricing level. |
| display_name | string | Display name shown in the UI or reports. |
| description | string | Description of the pricing level (optional). |
Retrieve Discount Profiles From Settings: /settings/discount_profiles
GET
https://dev-api.exsited.com/api/v3/settings/discount_profiles
Try It Out
Purpose
This API retrieves all discount profiles configured in the system. Discount profiles define rules and configurations for applying discounts to accounts, orders, or invoices.
Use Case
- Retrieve available discount profiles for applying promotional discounts in checkout or invoicing.
- Sync discount configurations with external systems (ERP, CRM, POS).
- Validate discount availability based on start/end dates, usage limits, and discount type.
Path Parameters
This endpoint does not require path parameters.
Query Parameters
This endpoint does not accept query parameters.
Request Body
This endpoint does not require a request body.
Response
The response provides a list of discount profiles along with pagination details. Each discount profile contains its unique identifier (uuid), status (ACTIVE or INACTIVE), internal system name, display name, and description. Additionally, it defines accounting information (accounting_code), invoice note, discount configuration such as type (discount_type), fixed discount value (fixed), and usage restrictions (maximum_use, maximum_use_per_account, maximum_use_per_order). Time-bound details (discount_start_time, discount_end_time) ensure discounts are only applied within specified validity periods. The field requires_redemption_code indicates whether a special code is required for redemption. Pagination metadata is included to navigate through multiple pages of discount profiles.
Response Body
JSON
{
"discount_profiles": [
{
"uuid": "d86cf04b-9537-456f-b5fe-b9e68ecc1ee3",
"status": "ACTIVE",
"name": "Profile_one",
"display_name": "Profile_one",
"description": "",
"invoice_note": "",
"accounting_code": "Compensation",
"discount_start_time": "2025-08-20T19:37:00Z",
"discount_end_time": "2025-08-21T19:38:00Z",
"discount_type": "Fixed",
"fixed": "20.000000",
"maximum_use": "20",
"total_usage_count": "0",
"maximum_use_per_account": "10",
"maximum_use_per_order": "10",
"requires_redemption_code": "false"
}
],
"pagination": {
"records": 1,
"limit": 20,
"offset": 0,
"previous_page": "",
"next_page": "NULL"
}
}| Attribute | Type | Description |
|---|---|---|
| uuid | string | Unique identifier of the discount profile. |
| status | string | Current status of the discount profile (ACTIVE, INACTIVE). |
| name | string | Internal system name of the discount profile. |
| display_name | string | Display name shown in the UI. |
| description | string | Description of the discount profile (optional). |
| invoice_note | string | Note to be displayed on invoices when this discount is applied. |
| accounting_code | string | Accounting code associated with this discount. |
| discount_start_time | string (datetime) | Start date and time when the discount becomes valid (ISO 8601). |
| discount_end_time | string (datetime) | End date and time when the discount expires (ISO 8601). |
| discount_type | string | Type of discount (Fixed, Percentage). |
| fixed | string (decimal) | Fixed discount amount if the type is Fixed. |
| maximum_use | string (number) | Maximum total usage count allowed for this discount profile. |
| total_usage_count | string (number) | Current total number of times the discount has been used. |
| maximum_use_per_account | string (number) | Maximum number of times the discount can be used per account. |
| maximum_use_per_order | string (number) | Maximum number of times the discount can be applied per order. |
| requires_redemption_code | string (boolean) | Indicates if a redemption code is required (true/false). |
Retrieve Shipping Profiles From Settings: /settings/shipping-profiles
GET
https://dev-api.exsited.com/api/v3/settings/shipping-profiles
Try It Out
Purpose
This API retrieves all shipping profiles configured in the system. A shipping profile defines shipping methods, integration details, tax configurations, and accounting codes associated with shipping charges.
Use Case
- Retrieve all available shipping profiles for order processing.
- Validate shipping methods during checkout workflows.
- Integrate external shipping APIs (example: Australia Post, FedEx, DHL).
- Apply correct tax and accounting codes to shipping charges.
Path Parameters
This endpoint does not require path parameters.
Query Parameters
This endpoint does not accept query parameters.
Request Body
This endpoint does not require a request body.
Response
The response returns a list of shipping profiles along with pagination details. Each shipping profile contains its unique identifier (uuid), status (ACTIVE or INACTIVE), internal system name (name), display name (display_name), description, and optional invoice note. The type field defines whether the shipping profile is system-based or API-integrated. The integration field specifies the shipping carrier or integration name (e.g., Australia Post Sandbox). Tax handling is controlled via is_tax_exempt and is_tax_inclusive. A nested tax_configuration object provides tax details including uuid, tax code, tax rate, and API link reference. The accounting_code field is used to map shipping charges to accounting systems. Pagination metadata allows navigation across multiple result pages.
Response Body
JSON
{
"shipping_profiles": [
{
"uuid": "8d9f9fcc-8b97-4da5-96c7-d212c6574622",
"status": "ACTIVE",
"name": "eParcel",
"display_name": "eParcel",
"description": "",
"invoice_note": "",
"type": "API",
"integration": "Australia Post SandBox",
"is_tax_exempt": "false",
"is_tax_inclusive": "true",
"tax_configuration": {
"uuid": "5e1260e9-8aa2-45fd-8638-ce04f24f8c53",
"code": "GST",
"rate": 10.0000,
"link": "https://dev-api.exsited.com/api/v3/settings/taxes/5e1260e9-8aa2-45fd-8638-ce04f24f8c53"
},
"accounting_code": "Shipping"
}
],
"pagination": {
"records": 1,
"limit": 20,
"offset": 0,
"previous_page": "",
"next_page": "NULL"
}
}| Attribute | Type | Description |
|---|---|---|
| uuid | string | Unique identifier of the shipping profile. |
| status | string | Current status of the shipping profile (ACTIVE, INACTIVE). |
| name | string | Internal system name of the shipping profile. |
| display_name | string | Display name of the shipping profile. |
| description | string | Description of the shipping profile. |
| invoice_note | string | Optional note to be displayed on invoices when this shipping profile is used. |
| type | string | Type of shipping profile ( API, Manual). |
| integration | string | Shipping carrier or integration name (example: Australia Post). |
| is_tax_exempt | string (boolean) | Indicates whether shipping charges are tax-exempt (true/false). |
| is_tax_inclusive | string (boolean) | Indicates whether shipping charges include tax (true/false). |
| tax_configuration | object | Nested object containing tax configuration details for this shipping profile. |
| accounting_code | string | Accounting code assigned to shipping charges. |
Retrieve Warehouses From Settings: /settings/warehouses
GET
https://dev-api.exsited.com/api/v3/settings/warehouses
Try It Out
Purpose
This API retrieves a list of warehouses configured in the system. A warehouse represents a physical or virtual storage location where inventory is held.
Use Case
- Fetch all available warehouse locations for inventory tracking.
- Identify the default warehouse used for fulfillment.
- Map products to specific warehouses for multi-location inventory management.
- Display warehouse details (example: city, state, country, post code) in order and logistics workflows.
Path Parameters
This endpoint does not require path parameters.
Query Parameters
This endpoint does not accept query parameters.
Request Body
This endpoint does not require a request body.
Response
The response returns an array of warehouses along with pagination details. Each warehouse contains a unique identifier (uuid), operational status (ACTIVE or INACTIVE), a flag indicating whether it is the default warehouse (default), system name, user-facing display_name, optional description, and address information (country, state, city, and post_code). The pagination object provides metadata to navigate through results when multiple warehouses exist.
Response Body
JSON
{
"warehouses": [
{
"uuid": "69713aa2-6329-4bf7-a465-3ba75a477f84",
"status": "ACTIVE",
"default": "false",
"name": "Default Warehouse",
"display_name": "Default Warehouse",
"description": "",
"country": "Australia",
"state": "",
"city": "",
"post_code": ""
},
{
"uuid": "56135d12-99b1-4c7e-8aac-e1e94452957a",
"status": "ACTIVE",
"default": "false",
"name": "EA Resi",
"display_name": "EA Resi",
"description": "",
"country": "Australia",
"state": "Northern Territory",
"city": "Aherrenge",
"post_code": "0872"
},
{
"uuid": "9ac2b3d9-82c7-4240-b510-7e7665efbc5b",
"status": "ACTIVE",
"default": "false",
"name": "J & G Logistics",
"display_name": "J & G Logistics",
"description": "",
"country": "Australia",
"state": "New South Wales",
"city": "Aarons Pass",
"post_code": "2850"
},
{
"uuid": "76739db9-bc05-494b-8fa7-c899454dbe86",
"status": "ACTIVE",
"default": "true",
"name": "Primary Location",
"display_name": "Primary Location",
"description": "",
"country": "Australia",
"state": "Australian Capital Territory",
"city": "Barton",
"post_code": "2600"
},
{
"uuid": "6290686a-cf45-4d0a-a122-dc196f4fbc3d",
"status": "ACTIVE",
"default": "false",
"name": "Venue",
"display_name": "Venue",
"description": "",
"country": "Australia",
"state": "Australian Capital Territory",
"city": "Australian National University",
"post_code": "0200"
}
],
"pagination": {
"records": 5,
"limit": 20,
"offset": 0,
"previous_page": "",
"next_page": "NULL"
}
}| Attribute | Type | Description |
|---|---|---|
| uuid | string | Unique identifier of the warehouse. |
| status | string | Current status of the warehouse (ACTIVE, INACTIVE). |
| default | string (boolean) | Indicates if this warehouse is the default one (true/false). |
| name | string | Internal system name of the warehouse. |
| display_name | string | Display name of the warehouse. |
| description | string | Description of the warehouse. |
| country | string | Country where the warehouse is located. |
| state | string | State or region of the warehouse location. |
| city | string | City where the warehouse is located. |
| post_code | string | Postal code of the warehouse location. |
Retrieve Specific Warehouse Details From Settings: /settings/warehouses/{W_UUID}
GET
https://dev-api.exsited.com/api/v3/settings/warehouses/{W_UUID}
Try It Out
Purpose
This endpoint retrieves detailed information about a specific warehouse. Warehouses are essential for managing stock, shipments, and fulfillment processes. Each warehouse has its own identifying information, including location details.
Use Case
- To fetch the details of a specific warehouse for inventory or order fulfillment.
- To display warehouse details in admin dashboards or logistics portals.
- To validate if a given warehouse exists before assigning stock or shipments.
- To integrate warehouse data with external logistics or ERP systems.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
W_UUID |
String | The unique identifier (UUID) of the warehouse to retrieve. |
Query Parameters
This endpoint does not accept query parameters.
Request Body
This endpoint does not require a request body.
Response
The response provides detailed information about a single warehouse, including its UUID, status, whether it is the default warehouse, and its identifying details (name, display name, description). It also includes address components such as country, state, city, and postal code. This allows precise mapping of stock locations and shipping origin points in logistics workflows.
Response Body
JSON
{
"warehouse": {
"uuid": "56135d12-99b1-4c7e-8aac-e1e94452957a",
"status": "ACTIVE",
"default": "false",
"name": "EA Resi",
"display_name": "EA Resi",
"description": "",
"country": "Australia",
"state": "Northern Territory",
"city": "Aherrenge",
"post_code": "0872"
}
}| Attribute | Type | Description |
|---|---|---|
warehouse |
Object | Contains details of the requested warehouse. |
uuid |
String | Unique identifier of the warehouse. |
status |
String | Status of the warehouse (example: ACTIVE, INACTIVE). |
default |
String | Indicates if this is the default warehouse (true / false). |
name |
String | Internal name of the warehouse. |
display_name |
String | User-friendly display name of the warehouse. |
description |
String | Additional description or notes about the warehouse. |
country |
String | Country where the warehouse is located. |
state |
String | State/region of the warehouse location. |
city |
String | City where the warehouse is located. |
post_code |
String | Postal code of the warehouse address. |
Retrieve Variations From Settings: /settings/variations
GET
https://dev-api.exsited.com/api/v3/settings/variations
Try It Out
Purpose
The Variations API provides a way to manage product variations. Each variation contains a set of options that can be assigned to products for inventory management, sales, and fulfillment.
Use Case
- Retrieve all available variations for configuring product catalogs.
- Display variation attributes on product detail pages.
- Manage inventory by distinguishing products based on variation options.
- Integrate variation data with external systems.
- Allow filtering and selection of products by their attributes in customer-facing applications.
Path Parameters
This endpoint does not require path parameters.
Query Parameters
This endpoint does not accept query parameters.
Request Body
This endpoint does not require a request body.
Response
The response returns a list of variations and pagination details. Each variation includes a unique identifier (uuid), current operational status (ACTIVE or INACTIVE), a system name (name), user-facing display name (display_name), and a description. A variation contains an array of options, where each option has its own uuid and name. Options represent specific selectable values of a variation (example: “Red” for the “Color” variation). The pagination object provides metadata such as the total number of records, limit per page, offset, and navigation links (previous_page and next_page) for handling large datasets.
Response Body
JSON
{
"variations": [
{
"uuid": "e40573a2-9cd0-49ce-bdce-3ec6f493dc2d",
"status": "ACTIVE",
"name": "COLOR",
"display_name": "COLOR",
"description": "",
"options": [
{
"name": "Black",
"uuid": "954621b9-d292-4865-8ee1-54b2b8902979"
},
{
"name": "Red",
"uuid": "363a7147-32d0-4681-bf84-48891aa29fdb"
},
{
"name": "White",
"uuid": "703cbcca-96f9-4574-acc7-b4780199cbec"
}
]
},
{
"uuid": "b68a94fb-f666-4a40-88a6-39460336352a",
"status": "ACTIVE",
"name": "dimention4",
"display_name": "dimention4",
"description": "Bryan Adams - (Everything I Do) I Do It For You",
"options": [
{
"name": "Megular",
"uuid": "6bc69ee6-bddf-4b48-9f02-f5d26b552bb4"
},
{
"name": "Mobab",
"uuid": "35233839-68b8-4738-b820-494d73be8c44"
},
{
"name": "Qremium",
"uuid": "c286caeb-a91b-4766-8d35-acebecd0973d"
}
]
},
{
"uuid": "f3a3aeb2-f879-471c-9b4d-687578e96442",
"status": "ACTIVE",
"name": "dimention5",
"display_name": "dimention5",
"description": "Bryan Adams",
"options": [
{
"name": "Premium",
"uuid": "639912f9-b64e-4327-8764-03082e81c597"
},
{
"name": "Regular",
"uuid": "78154131-02ba-4e46-ba9a-d97d91ea7cce"
}
]
}
],
"pagination": {
"records": 3,
"limit": 20,
"offset": 0,
"previous_page": "",
"next_page": "NULL"
}
}| Attribute | Type | Description |
|---|---|---|
| uuid | string | Unique identifier of the variation. |
| status | string | Status of the variation (ACTIVE, INACTIVE). |
| name | string | Internal system name of the variation. |
| display_name | string | Human-readable display name of the variation. |
| description | string | Description or notes about the variation. |
| options | array | List of selectable options for this variation. |
Retrieve Specific Variation Details From Settings: /settings/variations/{V_UUID}
GET
https://dev-api.exsited.com/api/v3/settings/variations/{V_UUID}
Try It Out
Purpose
This endpoint retrieves detailed information about a specific product variation, including its name, display name, description, status, and associated options. It is useful when you need to fetch variation details for a specific product setup.
Use Case
- Fetching detailed configuration of a single variation.
- Displaying variation options on product detail pages.
- Validating variation settings before associating them with products or inventory.
- Integrating with external systems where specific variation UUIDs need to be resolved into human-readable options.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
V_UUID |
String | The unique identifier (UUID) of the variation to retrieve. |
Query Parameters
This endpoint does not accept query parameters.
Request Body
This endpoint does not require a request body.
Response
The response provides complete details of a single variation object. It includes the variation’s UUID, status, internal and display names, description, and its associated list of options. Each option contains its own UUID and display name, enabling clients to map products to specific variation values. This is particularly useful in multi-variant products where options such as color, size, or dimensions must be retrieved dynamically.
Response Body
JSON
{
"variation": {
"uuid": "b68a94fb-f666-4a40-88a6-39460336352a",
"status": "ACTIVE",
"name": "dimention4",
"display_name": "dimention4",
"description": "Bryan Adams - (Everything I Do) I Do It For You",
"options": [
{
"name": "Megular",
"uuid": "6bc69ee6-bddf-4b48-9f02-f5d26b552bb4"
},
{
"name": "Mobab",
"uuid": "35233839-68b8-4738-b820-494d73be8c44"
},
{
"name": "Qremium",
"uuid": "c286caeb-a91b-4766-8d35-acebecd0973d"
}
]
}
}| Attribute | Type | Description |
|---|---|---|
variation |
Object | Contains the details of the requested variation. |
uuid |
String | Unique identifier of the variation. |
status |
String | Current status of the variation (example: ACTIVE, INACTIVE). |
name |
String | Internal name of the variation (used for system references). |
display_name |
String | User-friendly name of the variation displayed in UI. |
description |
String | Additional information or notes about the variation. |
options |
Array | List of available options within this variation. |
options[].name |
String | Display name of the variation option. |
options[].uuid |
String | Unique identifier of the variation option. |