API docs V4
Navbar
API docs V4
Topics
Frontend API
Backend API
Guides

Introduction

Base URL

https://core.expozy.com/api

The Expozy API is organized around REST principles. It uses predictable resource-oriented URLs, standard HTTP verbs and response codes, and accepts and returns JSON-encoded request and response bodies.

Explore Expozy's API reference and templating documentation. You have access to everything from the Frontend API and Backend API.

Backend API

At the core of Expozy is the Backend API, available through REST. It provides data on products, customers, orders, inventory, fulfillment, and more.

Expozy offers a suite of APIs which allow developers to extend the platform's built-in features. These APIs allow partners to read and write merchant data, interoperate with other systems and platforms, and add new functionality to Expozy.

This documentation refers to Expozy's Frontend and Backend API.

Frontend API

Build the frontend of your website with Expozy's Frontend API and REST. It gives you the power and tools to bring your data to the live public.

Getting started

Example request headers

$ curl https://core.expozy.com/api/admin/ or https://core.expozy.com/api/
 -H "Authorization: Bearer BOHe5RUvSuN416YYaY"
    -H "Authentication: Basic AAABBBBCCCCC"

In order to use Expozy's APIs, you must include the authorization and authentication headers within your request. Authentication is required for all POST, PUT, DELETE, and some GET requests. Authorization is necessary if you are trying to access endpoints reserved for Admins. See below how to obtain them.

Authorization

To receive a token, you must log in with a username and a password. In this example, we will use the email [email protected] and the password gR&YUd5&14OK After successful login, the API will return a token that can be used to access restricted endpoints. The validity of the key is 30 days, after which you must generate a new one.

POST /login

$ curl https://core.expozy.com/api/login
  -d [email protected]
  -d password=gR&YUd5&14OK

Authentication

Before using the API, you need to create an Expozy account. On creation, you will automatically be assigned one within your Admin Panel. If you wish to integrate it with third-party plugins, you have to request it directly from the administrators.

Example response



{
    "user": {
        "data": {
            "id": "3883",
            "attributes": {
                "email": "[email protected]",
                "name": "Demo",
                "roleNames": "administrator"
            }
        }
    },
    "token": "3uYxE6kURJbra3Jf98"
}

Data filtering

$ curl -X GET https://core.expozy.com/api/admin/users/:id

You can use parameters for filtering on some of the methods provided by the API. For example, if you want to receive data for a specific user, simply add their ID to the path.

Throughout the documentation, keep in mind that :id must be replaced with the actual ID of the object.

$ curl -X GET https://core.expozy.com/api/categories?droplist=true

Other filters need to be specified via query parameters and their values are usually boolean, i.e., they only need to be true.

API Rate Limit

The rate limit is 5 calls per second per API user. An 'HTTP/ 429 Too Many Requests' error will be returned, when this limit is exceeded*.

*If the limit is exceeded, it is advisable to retry the requests which resulted in 'HTTP/ 429 Too Many Requests' with exponential backoff and max number of retries as the example bellow:

delay = retry counter * 500 milliseconds
1-st response 'HTTP/ 429 Too Many Requests'
set retry counter = 1
delay = 500 milliseconds

2-nd response 'HTTP/ 429 Too Many Requests'
set retry counter = 2
delay = 1000 milliseconds

...

N-th response 'HTTP/ 429 Too Many Requests'
set retry counter = N
delay = N*500 milliseconds

Web Application Firewall

The WAF analyses each request to Expozy's core in order to identify threats and every suspicious behavior is considered as such!

WAF bans every suspicious caller (IP) for 2 hours. If you are banned, please check your server logs for 403 HTTP errors. To avoid future bans you should carefully analyse your workflows and service behavior leading to error 403 and fix them accordingly.

Data Formats

TypeAllowed Values
IntegerInteger number from -9223372036854775808 to +9223372036854775807
StringDependent on the data table's limit. Check specifications for more detail.
BooleanTrue or False
FloatFloating point numbers (e.g. 1.23). Precision depends on table column. Used normally for prices.

Errors

Expozy uses standard HTTP status codes to indicate the success or failure of an API request. A code in the range of 2xx indicates success, a code in the range of 4xx indicates there was a problem with the arguments provided (e.g., authentication or a required field was missing), and a code in the range of 5xx indicates an error occurred with Expozy's servers.

Authorization errors

(Status codes 401 and 403)

401 Unauthorized and 403 Forbidden

{
    "errors": [
        "Login first!"
    ]
}

An authorization error occurs whenever the headers contain wrong, outdated, or missing information.

Common causes

  • Expired API key

    Your API key might have expired, and you may need to request a new one.

  • Wrong tokens

    You may have mistyped your tokens. Please confirm whether the authorization and authentication headers are correct.

  • Restricted access

    You may be trying to access a restricted endpoint without the proper authorization headers in the request.

Not Found Errors

(Status code 404)

404 Not Found

{
    "errors": [
        "Not found!"
    ]
}

Not Found errors occur whenever you are trying to access information that does not exist.

Common causes

  • Wrong ID parameter

    The ID path parameter may be typed wrong.

  • Deleted data

    You may be trying to access data that has been deleted or archived.

  • Unauthorized access

    You may be trying to access data reserved for admins.

Internal Server Errors

(Status code 500)

500 Internal Server Error

{
    "errors": [
        "Something happened!"
    ]
}

Internal server errors may occur whenever the server is experiencing a heavy load, but could also have other causes related to the communication between client and server.

Common causes

  • Server Maintenance

    Server may be down for maintenance. Please check again later.

  • Server under load

    You may have sent multiple requests in quick succession, or the server itself may be experiencing heavy load.

  • Network Failure

    The network may be experiencing a heavy load or something may be obstructing communication with the server.

Validation errors

A validation error is returned when a request could not be fulfilled due to one or more invalid input values.

Example validation error

{
    "errors": [
        "[name='title']": "Product title is not set!",
        ...
    ]
}

Error fields

  • errors

    An array containing a list of errors with the validation.

  • key

    A key corresponding to the field where the error occurred.

  • value

    A human-readable description of the error. In this case it is "Product title is not set!"

Handling errors

Expozy's API will return an error object in case of an invalid PUT, POST or DELETE or GETrequest, and throw in any other error case.

Shop

Delete an item from cart

Removes a product variation from the current cart and returns the updated cart.

DELETE /carts/:id

$ curl -X DELETE https://core.expozy.com/api/carts/:id

Parameters

  • id

    Variation ID

200 OK Example Response

{
  "status": "<integer>"
}

Remove product from wishlist

Deletes a product from the current user's wishlist.

DELETE /wishlist/:id

$ curl -X DELETE https://core.expozy.com/api/wishlist/:id

Parameters

  • id

    Product ID

200 OK Example Response

{
  "status": "<integer>"
}

Get products

Returns all products optionally filtered by given query parameters

GET /products

$ curl -X GET https://core.expozy.com/api/products?warehouse_id=<integer>&attr_val=<integer>&price_from=<float>&price_to=<float>&category_id=<integer>&category_id=<integer>&provider_id=<integer>&tag=<string>&tags=<string>&tags=<string>&search=<string>&admin_search=<string>&brands=<integer>&brands=<integer>&only_active=<string>&only_promo=<boolean>&promotions=<boolean>&deleted=<integer>&only_instock=<boolean>&only_featured=<boolean>&only_image=<boolean>&only_product_ids=<boolean>&only_membership_accessible=<boolean>&reverse_auction=<boolean>&related_id=<integer>&sort=<string>

Parameters

  • warehouse_id

    Filter data for products from this warehouse

  • attr_val

    Attribute value, e.g. 1, 2, 5

  • price_from

    Lower limit for price

  • price_to

    Lower limit for price

  • category_id

    Filter by category

  • category_id

    Filter by category

  • provider_id

    Provider

  • tag

    Tag

  • tags

    Tags

  • tags

    Tags

  • search

    Search query

  • admin_search

    Search query

  • brands

    Filter by brands (supply array of ints)

  • brands

    Filter by brands (supply array of ints)

  • only_active

    Filter only active products (ex. values: 0, 1)

  • only_promo

    Filter only promotional items

  • promotions

    Filter only promotional items

  • deleted

    Whether to return only deleted items

  • only_instock

    Filter only items in stock, true by default

  • only_featured

    Filter to featured items

  • only_image

    Filter only if product contains image

  • only_product_ids

    Filter to these product_ids

  • only_membership_accessible

    Filter to items accessible with membership

  • reverse_auction

    Filter to items present in reverse auction

  • related_id

    Filter items related to this ID

  • sort

    Sort type (allowed values: oldest, min_price, max_price, discount, title, order, boost

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get products (by ID)

Returns a product by ID (same as /product/{id}).

GET /api//products/:id

$ curl -X GET https://core.expozy.com/api/products/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get a product

Returns a product by ID

GET /product/:id

$ curl -X GET https://core.expozy.com/api/product/:id?slug=<string>

Parameters

  • id

    ID of the object

  • slug

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get brands

Returns all brands.

GET /api//brands

$ curl -X GET https://core.expozy.com/api/brands

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get brand

Returns a brand by ID.

GET /api//brands/:id

$ curl -X GET https://core.expozy.com/api/brands/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get a product category

Returns a category by ID.

GET /api//category/:id

$ curl -X GET https://core.expozy.com/api/category/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get product category

Same as /category/{id}.

GET /api//categories/:id

$ curl -X GET https://core.expozy.com/api/categories/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get product categories

Returns all categories or a category by ID

GET /categories

$ curl -X GET https://core.expozy.com/api/categories?droplist=&search=<string>&admin_search=<string>&only_active=<boolean>&only_products=<string>&product_ids=<integer>&product_ids=<integer>&product_id=<integer>&only_featured=<integer>&parent=<string>&only_image=<integer>&sort=<string>

Parameters

  • droplist

    Whether to return the categories as a tree

  • search

    What to search for, (Note: works best in Cyrillic)

  • admin_search

    What to search for, (Note: works best in Cyrillic)

  • only_active

    Return only active product categories

  • only_products

    Return only products

  • product_ids

    Return categories matching the list of product_ids

  • product_ids

    Return categories matching the list of product_ids

  • product_id

    Return the category matching this product_id

  • only_featured

    Return only featured categories/products (allowed values: 0, 1)

  • parent

    Return the category with this parent

  • only_image

    Return only categories with title image (allowed values: 0, 1)

  • sort

    Sort type, allowed values: 'oldest', 'products', 'title'

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get cart

Return the current cart. If not logged, a session authorization header is required.

GET /api//cart

$ curl -X GET https://core.expozy.com/api/cart

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get cart (alias)

Return the current cart.

GET /api//carts

$ curl -X GET https://core.expozy.com/api/carts

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Edit cart

Change the quantity of one or several items in the cart. Returns the current cart.

PUT /carts

$ curl -X PUT https://core.expozy.com/api/carts

Example Body

{
  "variation_id": "<integer>",
  "quantity": "<integer>",
  "qty": "<integer>",
  "warehouse_id": "<integer>",
  "shipping_from": "<string>",
  "shipping_to": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Add a product (or combo / timeslot) to cart

Adds a product, a combination, or a time slot to the cart. If not logged-in, a session Authorization header is required.

POST /carts

$ curl -X POST https://core.expozy.com/api/carts

Example Body

{
  "product_id": "<integer>",
  "quantity": "<integer>",
  "qty": "<integer>",
  "variation_id": "<integer>",
  "warehouse_id": "<integer>",
  "shipping_from": "<string>",
  "shipping_to": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Get order

Return an order specified by ID.

GET /api//order/:id

$ curl -X GET https://core.expozy.com/api/order/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get orders

Return all orders for the current user

GET /orders

$ curl -X GET https://core.expozy.com/api/orders?limit=

Parameters

  • status

    order status

  • limit

    Number of orders to display (default: 1000)

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Process order

Creates an order from the current cart.

POST /orders

$ curl -X POST https://core.expozy.com/api/orders

Example Body

{
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "post_code": "<string>",
  "terms": "<string>",
  "payment_method": "<string>",
  "invoice_zdds": "<boolean>",
  "wantInvoice": "<boolean>",
  "addressSpeedyOfis": "<string>",
  "addressEkontOfis": "<string>",
  "addressEcont": "<string>",
  "address": "<string>",
  "invoice_company": "<string>",
  "invoice_eik": "<string>",
  "invoice_city": "<string>",
  "invoice_address": "<string>",
  "invoice_phone": "<string>",
  "city": "<string>",
  "comment": "<string>",
  "address2": "<string>",
  "state": "<string>",
  "country": "<string>",
  "shipping_shop": "<string>",
  "country_id": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Same as /order/{id}

GET /orders/:id

$ curl -X GET https://core.expozy.com/api/orders/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get favourites

Return all favourites.

GET /api//favourites

$ curl -X GET https://core.expozy.com/api/favourites

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get favourites (alias)

Return all favourites.

GET /api//wishlist

$ curl -X GET https://core.expozy.com/api/wishlist

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Add to wishlist/favorites

Adds product to wishlist/favorite directory.

POST /wishlist

$ curl -X POST https://core.expozy.com/api/wishlist

Example Body

{
  "object_id": "<integer>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Download a product

Download a product by ID

GET /download

$ curl -X GET https://core.expozy.com/api/download?product_id=<integer>

Parameters

  • product_id

    ID of the object

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get providers

Return data for all providers or a provider by ID.

GET /providers

$ curl -X GET https://core.expozy.com/api/providers?category_id=<long>&user_id=<long>

Parameters

  • category_id

    Return data for the item corresponding to the ID.

  • user_id

    Return data for the item corresponding to the ID.

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get provider

Return data for a provider by ID.

GET /api//providers/:id

$ curl -X GET https://core.expozy.com/api/providers/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get invoice

Return data for an invoice by ID (current user only).

GET /api//invoices/:id

$ curl -X GET https://core.expozy.com/api/invoices/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

401 Unauthorized Example Response

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get product filters

Return data for all product filters optionally filtered by query parameters.

GET /product_filters

$ curl -X GET https://core.expozy.com/api/product_filters?category_id=<integer>&tag=<string>&tags=<string>&tags=<string>

Parameters

  • category_id

  • tag

  • tags

  • tags

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get BORICA form

Return BORICA form.

GET /borica

$ curl -X GET https://core.expozy.com/api/borica?link=<string>

Parameters

  • link

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get EPAY form

Return EPAY form.

GET /epay

$ curl -X GET https://core.expozy.com/api/epay?link=<string>

Parameters

  • link

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get myPOS form

Return myPOS form.

GET /mypos

$ curl -X GET https://core.expozy.com/api/mypos?link=<string>

Parameters

  • link

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get product attributes

Return attribute values for a product by ID.

GET /product_attributes

$ curl -X GET https://core.expozy.com/api/product_attributes?product_id=<integer>&attr_value_ids=<string>

Parameters

  • product_id

    ID of the product

  • attr_value_ids

    IDs of the attributes you wish to select, separated by commas(,)

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get product attribute

Return a product attribute by ID.

GET /api//product_attributes/:id

$ curl -X GET https://core.expozy.com/api/product_attributes/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get combinations

Return all combinations.

GET /api//combinations

$ curl -X GET https://core.expozy.com/api/combinations

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get combination

Return a combination by ID.

GET /api//combinations/:id

$ curl -X GET https://core.expozy.com/api/combinations/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get loyalty card data

Return loyalty card data by ID.

GET /api//loyalty_card/:id

$ curl -X GET https://core.expozy.com/api/loyalty_card/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get current user's loyalty card data

Return current user's loyalty card data.

GET /api//my_loyalty_card

$ curl -X GET https://core.expozy.com/api/my_loyalty_card

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Apply promocode to current cart

Apply promocode to current cart.

POST /promocode

$ curl -X POST https://core.expozy.com/api/promocode

Example Body

{
  "promocode": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Remove promocode from cart

Removes the applied promocode from the current cart.

DELETE /promocode

$ curl -X DELETE https://core.expozy.com/api/promocode

200 OK Example Response

{
  "status": "<integer>"
}

Create return request

Add an item for return.

POST /returns

$ curl -X POST https://core.expozy.com/api/returns

Example Body

{
  "option_id": "<integer>",
  "condition_id": "<integer>",
  "orders_items_id": "<integer>",
  "iban": "<string>",
  "iban_name": "<string>",
  "note": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Confirm payment

Confirm payment for order, deposit, experience or hotel reservation.

POST /payment_confirm

$ curl -X POST https://core.expozy.com/api/payment_confirm

Example Body

{
  "order_id": "<integer>",
  "hash": "<string>",
  "transaction_id": "<string>",
  "type": "<string>",
  "mypos": "<string>",
  "epay": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Apply coupon

Apply coupon.

PUT /coupons/:id

$ curl -X PUT https://core.expozy.com/api/coupons/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": "<integer>"
}

Apply promotion

Apply promotion.

PUT /promotions/:id

$ curl -X PUT https://core.expozy.com/api/promotions/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": "<integer>"
}

Empty the cart

Removes all items from the current cart and returns the updated cart.

DELETE /carts/empty

$ curl -X DELETE https://core.expozy.com/api/carts/empty

200 OK Example Response

{
  "status": "<integer>"
}

Remove all cart products

Removes all products from the current cart and returns the updated cart.

DELETE /carts/all

$ curl -X DELETE https://core.expozy.com/api/carts/all

200 OK Example Response

{
  "status": "<integer>"
}

Delete a cart combination

Removes a combination/bundle from the current cart and returns the updated cart.

DELETE /cart_combination/:id

$ curl -X DELETE https://core.expozy.com/api/cart_combination/:id

Parameters

  • id

    Combination ID

200 OK Example Response

{
  "status": "<integer>"
}

Get payment methods

Return enabled frontend payment methods.

GET /api//payment_methods

$ curl -X GET https://core.expozy.com/api/payment_methods

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

Download a digital product file

Downloads a digital product file for the current user.

GET /api//product_files/:id

$ curl -X GET https://core.expozy.com/api/product_files/:id

Parameters

  • id

200 OK Example Response

401 Unauthorized Example Response

Ads

Delete an ad (legacy path)

Legacy path for deleting an advertisement by ID.

DELETE /delete_advertisement/:id

$ curl -X DELETE https://core.expozy.com/api/delete_advertisement/:id

Parameters

  • id

    Ad ID

200 OK Example Response

{
  "status": "<integer>"
}

Delete an image from an ad

Deletes an image attached to an advertisement. Only the owner may delete.

DELETE /ads_images/:id

$ curl -X DELETE https://core.expozy.com/api/ads_images/:id

Parameters

  • id

    Ad image ID

200 OK Example Response

{
  "status": "<integer>"
}

Get ad data

Return data for an ad by ID.

GET /api//ads/:id

$ curl -X GET https://core.expozy.com/api/ads/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Edit an ad

Edit an ad's data. Supports image attachments (allowed formats: `JPG`,`PNG`,`GIF`,`WEBP`).

PUT /ads/:id

$ curl -X PUT https://core.expozy.com/api/ads/:id

Example Body

{
  "title": "<string>"
}

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": "<integer>"
}

Delete an ad

Deletes an advertisement by ID. Only the owner may delete.

DELETE /ads/:id

$ curl -X DELETE https://core.expozy.com/api/ads/:id

Parameters

  • id

    Ad ID

200 OK Example Response

{
  "status": "<integer>"
}

Get ad data

Return data for all ads.

GET /ads

$ curl -X GET https://core.expozy.com/api/ads?search=<string>&admin_search=<integer>&type=<integer>&status=<integer>&user=<integer>&category=<integer>&only_vip=<integer>&options=<string>

Parameters

  • search

    Keywords to search for

  • admin_search

  • type

  • status

  • user

  • category

  • only_vip

  • options

    Comma-delimited list of options, e.g. 1,2,3,4

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Create an advertisement

Add an ad. Supports image attachments (allowed formats: `JPG`,`PNG`,`GIF`,`WEBP`).

POST /ads

$ curl -X POST https://core.expozy.com/api/ads

Example Body

{
  "type_id": "<integer>",
  "title": "<string>",
  "fields": [
    "<string>",
    "<string>"
  ],
  "status_id": "<string>",
  "category_id": "<integer>",
  "subtitle": "<string>",
  "tags": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Get ad plan data

Return data for all ad plans.

GET /api//ads_plans

$ curl -X GET https://core.expozy.com/api/ads_plans

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get ad plan data

Return data for an ad plan by ID.

GET /api//ads_plans/:id

$ curl -X GET https://core.expozy.com/api/ads_plans/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get ad type data

Return data for all ad types.

GET /api//ads_types

$ curl -X GET https://core.expozy.com/api/ads_types

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get ad type data

Return data for an ad type by ID.

GET /api//ads_types/:id

$ curl -X GET https://core.expozy.com/api/ads_types/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get ad field data

Return data for all ad fields.

GET /ads_fields

$ curl -X GET https://core.expozy.com/api/ads_fields?type_id=<long>

Parameters

  • type_id

    Return data for this ad type.

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get ad field data

Return ad field by ID.

GET /api//ads_fields/:id

$ curl -X GET https://core.expozy.com/api/ads_fields/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get ad category data

Return data for all ad categories.

GET /api//ads_categories

$ curl -X GET https://core.expozy.com/api/ads_categories

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get ad category data

Return data for an ad category by ID.

GET /api//ads_categories/:id

$ curl -X GET https://core.expozy.com/api/ads_categories/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get ad wishlist data

Return data for the current ad wishlist (IDs only).

GET /api//ads_wishlist

$ curl -X GET https://core.expozy.com/api/ads_wishlist

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Edit an ad

Edit an ad's data.

PUT /edit_advertisement/:id

$ curl -X PUT https://core.expozy.com/api/edit_advertisement/:id

Example Body

{
  "title": "<string>",
  "body": "<string>",
  "slug": "<string>",
  "category_id": "<string>"
}

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": "<integer>"
}

Activate an ad

Activate an ad specified by ID in path.

PUT /activate_advertisement/:id

$ curl -X PUT https://core.expozy.com/api/activate_advertisement/:id

Example Body

{
  "months_num": "<string>",
  "body": "<string>"
}

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": "<integer>"
}

Create ad request

POST /ads_requests

$ curl -X POST https://core.expozy.com/api/ads_requests

Example Body

{
  "ads_id": "<integer>",
  "message": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Menu

Get current menu

Returns current menu.

GET /api//menu

$ curl -X GET https://core.expozy.com/api/menu

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Pages

Get pages possibly filtered

Returns all pages possibly filtered

GET /pages

$ curl -X GET https://core.expozy.com/api/pages?category_id=<integer>&search=<string>&admin_search=<string>

Parameters

  • category_id

    Filter by category

  • search

    Search query

  • admin_search

    Search query

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get page

Returns a page by ID.

GET /api//pages/:id

$ curl -X GET https://core.expozy.com/api/pages/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Create a page revision (admin)

POST /revisions

$ curl -X POST https://core.expozy.com/api/revisions

Example Body

{
  "page_id": "<integer>",
  "description": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Blog

Get blog posts

Returns all blog posts

GET /blogPosts

$ curl -X GET https://core.expozy.com/api/blogPosts?category_id=<integer>&search=<string>&admin_search=<string>&only_active=<boolean>&only_products=<string>&product_ids=<integer>&product_ids=<integer>&product_id=<integer>&only_featured=<integer>&parent=<string>&only_image=<integer>&sort=<string>

Parameters

  • category_id

    Filter by a category

  • search

    What to search for, (Note: works best in Cyrillic)

  • admin_search

    What to search for, (Note: works best in Cyrillic)

  • only_active

    Return only active product categories

  • only_products

    Return only products

  • product_ids

    Return categories matching the list of product_ids

  • product_ids

    Return categories matching the list of product_ids

  • product_id

    Return the category matching this product_id

  • only_featured

    Return only featured categories/products (allowed values: 0, 1)

  • parent

    Return the category with this parent

  • only_image

    Return only categories with title image (allowed values: 0, 1)

  • sort

    Sort type, allowed values: 'oldest', 'products', 'title'

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get blog post

Returns a blog post by ID.

GET /api//blogPosts/:id

$ curl -X GET https://core.expozy.com/api/blogPosts/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Update blog post HTML (admin)

Edit a blog post's data. Supports image attachments (allowed formats: `JPG`,`PNG`,`GIF`,`WEBP`).

PUT /blogPosts/:id

$ curl -X PUT https://core.expozy.com/api/blogPosts/:id

Example Body

{
  "title": "<string>",
  "html": "<string>",
  "seo-title": "<string>",
  "seo-description": "<string>",
  "lang": "<string>"
}

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>"
}

Get blog categories

Returns all blog categories

GET /blogCategories

$ curl -X GET https://core.expozy.com/api/blogCategories?category_id=<integer>&search=<string>&admin_search=<string>&only_active=<boolean>&only_products=<string>&product_ids=<integer>&product_ids=<integer>&product_id=<integer>&only_featured=<integer>&parent=<string>&only_image=<integer>&sort=<string>

Parameters

  • category_id

    Filter by a category

  • search

    What to search for, (Note: works best in Cyrillic)

  • admin_search

    What to search for, (Note: works best in Cyrillic)

  • only_active

    Return only active product categories

  • only_products

    Return only products

  • product_ids

    Return categories matching the list of product_ids

  • product_ids

    Return categories matching the list of product_ids

  • product_id

    Return the category matching this product_id

  • only_featured

    Return only featured categories/products (allowed values: 0, 1)

  • parent

    Return the category with this parent

  • only_image

    Return only categories with title image (allowed values: 0, 1)

  • sort

    Sort type, allowed values: 'oldest', 'products', 'title'

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get blog categories

Returns a category by ID

GET /blogCategories/:id

$ curl -X GET https://core.expozy.com/api/blogCategories/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Orders

Update order fields

Change an order's status or payment method.

PUT /orders/:id

$ curl -X PUT https://core.expozy.com/api/orders/:id

Example Body

{
  "order_status": "<integer>",
  "payment_method": "<integer>"
}

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "obj": {}
}

User

Get account data

Return account data for current user.

GET /api//accounts

$ curl -X GET https://core.expozy.com/api/accounts

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

401 Unauthorized Example Response

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Update my account profile

Change user data.

PUT /accounts

$ curl -X PUT https://core.expozy.com/api/accounts

Example Body

{
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<email>",
  "password": "<string>",
  "password-repeat": "<string>",
  "phone": "<string>",
  "country": "<string>",
  "city": "<string>",
  "address": "<string>",
  "address2": "<string>",
  "post_code": "<string>",
  "state": "<string>",
  "invoice_email": "<string>",
  "invoice_company": "<string>",
  "invoice_city": "<string>",
  "invoice_country": "<integer>",
  "invoice_mol": "<string>",
  "invoice_eik": "<string>",
  "invoice_address": "<string>",
  "invoice_phone": "<string>",
  "zdds": "<string>",
  "zdds_registed": "<string>",
  "newsletter": "<boolean>"
}

200 OK Example Response

{
  "status": "<integer>",
  "obj": {}
}

Get account data (alias)

Return account data for current user.

GET /api//users

$ curl -X GET https://core.expozy.com/api/users

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Update my account profile (alias)

Change user data.

PUT /users

$ curl -X PUT https://core.expozy.com/api/users

Example Body

{
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "password": "<string>",
  "password-repeat": "<string>",
  "phone": "<string>",
  "country": "<string>",
  "city": "<string>",
  "address": "<string>",
  "address2": "<string>",
  "post_code": "<string>",
  "state": "<string>",
  "invoice_email": "<string>",
  "invoice_company": "<string>",
  "invoice_city": "<string>",
  "invoice_country": "<string>",
  "invoice_mol": "<string>",
  "invoice_eik": "<string>",
  "invoice_address": "<string>",
  "invoice_phone": "<string>",
  "zdds": "<string>",
  "zdds_registed": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "obj": {}
}

Register user

Registers a new user.

POST /users

$ curl -X POST https://core.expozy.com/api/users

Example Body

{
  "email": "<email>",
  "password": "<string>",
  "password2": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Login

Login with email/password or a social provider (google, facebook, apple).

POST /login

$ curl -X POST https://core.expozy.com/api/login

Example Body

{
  "email": "<string>",
  "password": "<string>",
  "ip": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Request password reset

Post a request for password reset.

POST /forgot_password

$ curl -X POST https://core.expozy.com/api/forgot_password

Example Body

{
  "email": "<email>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Logout

Logs the user out of the system.

POST /logout

$ curl -X POST https://core.expozy.com/api/logout

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Update my company details

Update user's company.

PUT /company

$ curl -X PUT https://core.expozy.com/api/company

Example Body

{
  "name": "<string>",
  "vat": "<string>",
  "city": "<string>",
  "address": "<string>",
  "contact": "<string>",
  "phone": "<string>",
  "email": "<email>"
}

200 OK Example Response

{
  "status": "<integer>",
  "obj": {}
}

Update a specific address or set it as default

If `default` is true, marks this address as default; otherwise updates the address fields.

PUT /user_address/:id

$ curl -X PUT https://core.expozy.com/api/user_address/:id

Example Body

{
  "default": "<boolean>",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone": "<string>",
  "country_id": "<integer>",
  "city": "<string>",
  "post_code": "<string>",
  "address": "<string>",
  "address2": "<string>",
  "company": "<string>",
  "vat": "<string>"
}

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "obj": {}
}

Delete a user address

Deletes an address belonging to the current user.

DELETE /user_address/:id

$ curl -X DELETE https://core.expozy.com/api/user_address/:id

Parameters

  • id

    Address ID

200 OK Example Response

{
  "status": "<integer>"
}

Delete my account

Deletes the currently authenticated user's account.

DELETE /my_account

$ curl -X DELETE https://core.expozy.com/api/my_account

200 OK Example Response

{
  "status": "<integer>"
}

Delete user identity document

Deletes a user identity record if the current user has access.

DELETE /users_identity/:id

$ curl -X DELETE https://core.expozy.com/api/users_identity/:id

Parameters

  • id

    Identity record ID

200 OK Example Response

{
  "status": "<integer>"
}

Create or update a user address

POST /user_address

$ curl -X POST https://core.expozy.com/api/user_address

Example Body

{}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Verify or resend email verification code

POST /email_verification

$ curl -X POST https://core.expozy.com/api/email_verification

Example Body

{
  "resend": "<boolean>",
  "email": "<email>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Verify or resend SMS code

POST /sms_verification

$ curl -X POST https://core.expozy.com/api/sms_verification

Example Body

{
  "resend": "<boolean>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Couriers

Get shippings

Return all shippings

GET /shippings

$ curl -X GET https://core.expozy.com/api/shippings?only_active=

Parameters

  • only_active

    Display only active shipments

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get Speedy offices

Return Speedy offices.

GET /api//speedy

$ curl -X GET https://core.expozy.com/api/speedy

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get ECONT offices

Return ECONT offices.

GET /econt

$ curl -X GET https://core.expozy.com/api/econt

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Membership

Get memberships

Return all memberships.

GET /api//memberships

$ curl -X GET https://core.expozy.com/api/memberships

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get a membership

Return a membership by ID.

GET /api//memberships/:id

$ curl -X GET https://core.expozy.com/api/memberships/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Core

Get settings

Return site settings.

GET /api//settings

$ curl -X GET https://core.expozy.com/api/settings

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get web settings

Return all web settings.

GET /api//settings_web

$ curl -X GET https://core.expozy.com/api/settings_web

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Return search data for products and categories.

GET /search

$ curl -X GET https://core.expozy.com/api/search?search=<string>

Parameters

  • search

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Languages

Get languages

Return all languages.

GET /api//languages

$ curl -X GET https://core.expozy.com/api/languages

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Slider

Get sliders

Return all sliders or a slider by ID.

GET /sliders

$ curl -X GET https://core.expozy.com/api/sliders?region=<string>

Parameters

  • region

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get slider sections

Return front slider sections.

GET /api//slider_sections

$ curl -X GET https://core.expozy.com/api/slider_sections

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get slider

Return a slider by ID.

GET /api//sliders/:id

$ curl -X GET https://core.expozy.com/api/sliders/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

Currencies

Get currencies

Return all currencies or a currency by code or the default one. If `default` specified, will return the default currency. If `code` is specified, will return the currency corresponding to it.

GET /currencies

$ curl -X GET https://core.expozy.com/api/currencies?default=<boolean>&code=<string>&value=<integer>

Parameters

  • default

    Return default currency

  • code

    Return currency corresponding to this value

  • value

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get a currency

Return a currency by ID.

GET /api//currencies/:id

$ curl -X GET https://core.expozy.com/api/currencies/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Locations

Get countries

Return all countries.

GET /countries

$ curl -X GET https://core.expozy.com/api/countries?region=<string>

Parameters

  • region

    Region code, 'EU' can be used as a value

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get country

Return a country by ID.

GET /api//countries/:id

$ curl -X GET https://core.expozy.com/api/countries/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get regions

Return data for all regions.

GET /regions

$ curl -X GET https://core.expozy.com/api/regions?selected=<integer>

Parameters

  • selected

    Return data for a selected region's code

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get region

Return data for a region by ID.

GET /api//regions/:id

$ curl -X GET https://core.expozy.com/api/regions/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Comments

Get reviews/comments

Return all reviews/comments for a product by ID.

GET /reviews

$ curl -X GET https://core.expozy.com/api/reviews?product_id=<integer>&type=<integer>&LIMIT=<integer>&rating=<integer>

Parameters

  • product_id

  • type

  • LIMIT

  • rating

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Post a review/comment for a product

Post a new review/comment.

POST /reviews

$ curl -X POST https://core.expozy.com/api/reviews

Example Body

{
  "comment": "<string>",
  "product_id": "<integer>",
  "subject_id": "<string>",
  "rating": "<integer>",
  "subject": "<string>",
  "parent_id": "<integer>",
  "name": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Post a comment for a blog post

POST /blog_comments

$ curl -X POST https://core.expozy.com/api/blog_comments

Example Body

{
  "comment": "<string>",
  "subject_id": "<integer>",
  "parent_id": "<integer>",
  "name": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

QA

Get QA

Return all QA data for a product by ID.

GET /qa

$ curl -X GET https://core.expozy.com/api/qa?product_id=<integer>&status=<integer>

Parameters

  • product_id

  • status

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Post a QA entry (question/answer)

Add a QA.

POST /qa

$ curl -X POST https://core.expozy.com/api/qa

Example Body

{
  "product_id": "<integer>",
  "text": "<string>",
  "user_name": "<string>",
  "subject": "<string>",
  "parent_id": "<integer>",
  "user_id": "<integer>",
  "status": "<integer>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Get QA

Return all QA data for a product by ID.

GET /qa/:id

$ curl -X GET https://core.expozy.com/api/qa/:id?product_id=<integer>

Parameters

  • id

  • product_id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Warehouses

Get warehouse data

Return all warehouses with optional filters.

GET /warehouses

$ curl -X GET https://core.expozy.com/api/warehouses

Parameters

  • user_id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get warehouse data

Return a warehouse by ID.

GET /api//warehouses/:id

$ curl -X GET https://core.expozy.com/api/warehouses/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Cookies

Get cookies

Return cookies.

GET /api//cookie

$ curl -X GET https://core.expozy.com/api/cookie

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Messages

Get messages

Return data for all messages.

GET /messages

$ curl -X GET https://core.expozy.com/api/messages?only_new=<boolean>

Parameters

  • only_new

    Return only new messages

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Send a message

Send a new message.

POST /messages

$ curl -X POST https://core.expozy.com/api/messages

Example Body

{
  "text": "<string>",
  "to_user_id": "<integer>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Get messages

Return data for a single message or messages for a group discussion.

GET /messages/:id

$ curl -X GET https://core.expozy.com/api/messages/:id?grouped=<boolean>

Parameters

  • id

  • grouped

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Send a message to site admins.

Send a message to site admins.

POST /admin_contacts

$ curl -X POST https://core.expozy.com/api/admin_contacts

Example Body

{
  "receiver_id": "<integer>",
  "subject": "<string>",
  "message": "<string>",
  "subject_id": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Mark message(s) as seen

POST /messages_log

$ curl -X POST https://core.expozy.com/api/messages_log

Example Body

{
  "room_id": "<integer>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Contact form

POST /contacts

$ curl -X POST https://core.expozy.com/api/contacts

Example Body

{
  "message": "<string>",
  "subject": "<string>",
  "email": "<email>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Contact hub (new)

POST /contacts_new

$ curl -X POST https://core.expozy.com/api/contacts_new

Example Body

{
  "connection": "<string>",
  "payload": {
    "key_0": 2937.401743711949,
    "key_1": "string"
  }
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Banners

Get banners

Return data for all banners.

GET /banners

$ curl -X GET https://core.expozy.com/api/banners?popup=<integer>&page_id=<integer>

Parameters

  • popup

  • page_id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get banner

Return data for a banner by ID.

GET /api//banners/:id

$ curl -X GET https://core.expozy.com/api/banners/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Misc

Get partners

Return all partners.

GET /api//partners

$ curl -X GET https://core.expozy.com/api/partners

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get partner

Return a partner by ID.

GET /api//partners/:id

$ curl -X GET https://core.expozy.com/api/partners/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get timeslots

Returns data for warehouse timeslots.

GET /time_slots

$ curl -X GET https://core.expozy.com/api/time_slots?warehouse_id=<integer>&day=<integer>

Parameters

  • warehouse_id

  • day

    Filter to day hours

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Get timeslot

Returns a timeslot by ID.

GET /api//time_slots/:id

$ curl -X GET https://core.expozy.com/api/time_slots/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "obj": {}
}

400 Bad Request Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

404 Not Found Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "error": "<string>"
}

Blog do hits.

Does something.

POST /blogdoHits/:id

$ curl -X POST https://core.expozy.com/api/blogdoHits/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Newsletter

Subscribe to newsletter

Subscribes the user to newsletter.

POST /subscribe

$ curl -X POST https://core.expozy.com/api/subscribe

Example Body

{
  "email": "<email>",
  "newsletter-checkbox": "<boolean>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Unsubscribe from newsletter

Unsubscribes the user from the newsletter.

DELETE /subscribe

$ curl -X DELETE https://core.expozy.com/api/subscribe

200 OK Example Response

{
  "status": "<integer>"
}

Rentals

Update a rental (host)

POST /rentals/:id

$ curl -X POST https://core.expozy.com/api/rentals/:id

Example Body

{}

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Delete a rental

Deletes a rental owned by the current user.

DELETE /rentals/:id

$ curl -X DELETE https://core.expozy.com/api/rentals/:id

Parameters

  • id

    Rental ID

200 OK Example Response

{
  "status": "<integer>"
}

Delete a rental image

Deletes a rental image owned by the current user.

DELETE /rentals_images/:id

$ curl -X DELETE https://core.expozy.com/api/rentals_images/:id

Parameters

  • id

    Rental image ID

200 OK Example Response

{
  "status": "<integer>"
}

Delete a rental block

Deletes a blocked reservation (status BLOCKED) for a rental room owned by the user.

DELETE /rentals_block/:id

$ curl -X DELETE https://core.expozy.com/api/rentals_block/:id

Parameters

  • id

    Reservation (block) ID

200 OK Example Response

{
  "status": "<integer>"
}

Delete a rental season

Deletes a rental season if owned by the current user.

DELETE /rentals_seasons/:id

$ curl -X DELETE https://core.expozy.com/api/rentals_seasons/:id

Parameters

  • id

    Season ID

200 OK Example Response

{
  "status": "<integer>"
}

Delete a rental special price

Deletes a special price record if owned by the current user.

DELETE /rentals_special/:id

$ curl -X DELETE https://core.expozy.com/api/rentals_special/:id

Parameters

  • id

    Special price ID

200 OK Example Response

{
  "status": "<integer>"
}

Block a rental room for a period (host)

POST /rentals_block

$ curl -X POST https://core.expozy.com/api/rentals_block

Example Body

{
  "room_id": "<integer>",
  "date_start": "<string>",
  "date_end": "<string>",
  "note": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Create a rental (host)

POST /rentals

$ curl -X POST https://core.expozy.com/api/rentals

Example Body

{
  "type_id": "<integer>",
  "title": "<string>",
  "qty": "<integer>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Add rooms to a rental (host)

POST /rentals_rooms

$ curl -X POST https://core.expozy.com/api/rentals_rooms

Example Body

{
  "qty": "<integer>",
  "rental_id": "<integer>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Create reservation or calculate price

POST /reservations

$ curl -X POST https://core.expozy.com/api/reservations

Example Body

{
  "calculate": "<boolean>",
  "guests": "<integer>",
  "date_start": "<string>",
  "date_end": "<string>",
  "rental_id": "<integer>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Host confirm/decline reservation

POST /reservations_confirm

$ curl -X POST https://core.expozy.com/api/reservations_confirm

Example Body

{
  "reservation_id": "<integer>",
  "confirm": "<boolean>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Get reservation payment URL

POST /reservations_pay_url

$ curl -X POST https://core.expozy.com/api/reservations_pay_url

Example Body

{
  "reservation_id": "<integer>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Add rental rating

POST /rental_ratings

$ curl -X POST https://core.expozy.com/api/rental_ratings

Example Body

{
  "rental_id": "<integer>",
  "clean": "<integer>",
  "accuracy": "<integer>",
  "accommodation": "<integer>",
  "communication": "<integer>",
  "location": "<integer>",
  "price_quality": "<integer>",
  "comment": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Request reservation cancellation

POST /reservations_cancellation

$ curl -X POST https://core.expozy.com/api/reservations_cancellation

Example Body

{
  "reservation_id": "<integer>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Copy a rental (host)

POST /rentals_copy/:id

$ curl -X POST https://core.expozy.com/api/rentals_copy/:id

Parameters

  • id

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Set rental images order (host)

POST /rentals_image_order

$ curl -X POST https://core.expozy.com/api/rentals_image_order

Example Body

{
  "image_order": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Deposits

Create, continue or reinvest a deposit

POST /deposits

$ curl -X POST https://core.expozy.com/api/deposits

Example Body

{
  "continue": "<boolean>",
  "deposit_id": "<integer>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Marketplace

Create marketplace order

POST /marketplace_orders

$ curl -X POST https://core.expozy.com/api/marketplace_orders

Example Body

{}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Register marketplace seller

POST /marketplace_sellers

$ curl -X POST https://core.expozy.com/api/marketplace_sellers

Example Body

{
  "title": "<string>",
  "email": "<email>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Analytics

Releva tracking

POST /releva

$ curl -X POST https://core.expozy.com/api/releva

Example Body

{
  "page": "<string>",
  "product_id": "<integer>",
  "id": "<integer>",
  "relevaId": "<string>",
  "warehouse_id": "<integer>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Integrations

GitHub actions

POST /git

$ curl -X POST https://core.expozy.com/api/git

Example Body

{
  "github_token": "<string>",
  "github_route": "<string>",
  "owner": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Wallet

Create a withdraw request

POST /withdraws

$ curl -X POST https://core.expozy.com/api/withdraws

Example Body

{
  "dividents": "<boolean>",
  "amount": "<number>",
  "deposit_id": "<integer>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Meetings

Create a meeting

POST /meetings

$ curl -X POST https://core.expozy.com/api/meetings

Example Body

{
  "calendar_id": "<integer>",
  "timeSlot_id": "<integer>",
  "date_start": "<string>",
  "name": "<string>",
  "email": "<email>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Hotel

Calculate or create hotel reservations

POST /hotel_reservations

$ curl -X POST https://core.expozy.com/api/hotel_reservations

Example Body

{
  "daterange": "<string>",
  "feeding_id": "<integer>",
  "room_count": "<integer>",
  "room_guests": [
    "<integer>",
    "<integer>"
  ],
  "room_types": [
    "<integer>",
    "<integer>"
  ],
  "calculate": "<boolean>",
  "clients": "<string>",
  "payment_code": "<string>"
}

200 OK Example Response

{
  "status": "<integer>",
  "msg": "<string>",
  "message": "<string>"
}

Import PMS rooms (admin)

POST /hotel_rooms_pms

$ curl -X POST https://core.expozy.com/api/hotel_rooms_pms

200 OK Example Response

Shop

Get products data

Returns data for a product

GET /products/:id

$ curl -X GET https://core.expozy.com/api/admin/products/:id

Parameters

  • id

    ID for the selected project.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Modify a product by ID

Modify a product.

POST /products/:id

$ curl -X POST https://core.expozy.com/api/admin/products/:id

Example Body

{
  "title": "string",
  "ref_number": "string",
  "body": "string",
  "images": [
    {
      "value": "reference images not found in the OpenAPI spec"
    },
    {
      "value": "reference images not found in the OpenAPI spec"
    }
  ],
  "type": 5267,
  "slug": "string",
  "price": 5180.122163400771,
  "promoprice": 1375.4209401702733,
  "provider": {},
  "weight": "string",
  "length": "string",
  "bg": "string",
  "width": "string",
  "height": "string",
  "status": 7404,
  "seo_title": "string",
  "seo_tags": "string",
  "seo_description": "string",
  "model_info": "string",
  "label_info": "string",
  "focus": 3052,
  "started": "string",
  "expired": "string"
}

Parameters

  • id

    ID of the product being modified

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a product

Delete a product by ID, if `archive` is provided, the product will be archived instead.

DELETE /products/:id

$ curl -X DELETE https://core.expozy.com/api/admin/products/:id?archive=false

Parameters

  • id

    ID of the object

  • archive

    If `True`, archive; otherwise, delete.

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get product attributes data for this product attribute

GET /product_attributes/:id

$ curl -X GET https://core.expozy.com/api/admin/product_attributes/:id

Parameters

  • id

    Return data for the selected project.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete attributes for a product

Delete attributes for a product.

DELETE /product_attributes/:id

$ curl -X DELETE https://core.expozy.com/api/admin/product_attributes/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete images for a product

Delete images for a product.

DELETE /productImage/:id

$ curl -X DELETE https://core.expozy.com/api/admin/productImage/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete file for a product

Delete file for a product.

DELETE /productFile/:id

$ curl -X DELETE https://core.expozy.com/api/admin/productFile/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get order data

Returns an order specified by the ID.

GET /orders/:id

$ curl -X GET https://core.expozy.com/api/admin/orders/:id

Parameters

  • id

    Return data for the item corresponding to the ID.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete an order

Delete an order specified by ID.

DELETE /orders/:id

$ curl -X DELETE https://core.expozy.com/api/admin/orders/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get product category data

Get data for this product category

GET /product_categories/:id

$ curl -X GET https://core.expozy.com/api/admin/product_categories/:id

Parameters

  • id

    Return data for the selected project.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a product category or its image/icon

Delete a product category or the image/icon in one specified by ID.

DELETE /product_categories/:id

$ curl -X DELETE https://core.expozy.com/api/admin/product_categories/:id?image=true&icon=true

Parameters

  • id

    ID of the object

  • image

  • icon

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a product attribute

Delete a product attribute.

DELETE /products_attributes/:id

$ curl -X DELETE https://core.expozy.com/api/admin/products_attributes/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a product attribute's value

Delete a product attribute's value.

DELETE /products_attributes_values/:id

$ curl -X DELETE https://core.expozy.com/api/admin/products_attributes_values/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get promotions data for a given ID

GET /promotions/:id

$ curl -X GET https://core.expozy.com/api/admin/promotions/:id

Parameters

  • id

    Return data for the selected project.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a promotion

Delete a promotion specified by ID.

DELETE /promotions/:id

$ curl -X DELETE https://core.expozy.com/api/admin/promotions/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a loyalty level

Delete a loyalty level specified by ID.

DELETE /loyalty_levels/:id

$ curl -X DELETE https://core.expozy.com/api/admin/loyalty_levels/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get brands data.

Returns data for a brand with ID specified in the path.

GET /brands/:id

$ curl -X GET https://core.expozy.com/api/admin/brands/:id

Parameters

  • id

    If present, return data for this object.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a brand

Delete a brand specified by ID.

DELETE /brands/:id

$ curl -X DELETE https://core.expozy.com/api/admin/brands/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a brand's image

Delete a brand's image specified by ID.

DELETE /brand_image/:id

$ curl -X DELETE https://core.expozy.com/api/admin/brand_image/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get combinations

Returns data for a combination specified in path

GET /combinations/:id

$ curl -X GET https://core.expozy.com/api/admin/combinations/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a combination

Delete a combination specified by ID.

DELETE /combinations/:id

$ curl -X DELETE https://core.expozy.com/api/admin/combinations/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a combination image

Delete a combination image specified by ID.

DELETE /combinations_image/:id

$ curl -X DELETE https://core.expozy.com/api/admin/combinations_image/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get combinations

Returns data for a combination specified in path

GET /combination_categories/:id

$ curl -X GET https://core.expozy.com/api/admin/combination_categories/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a combination category or its image

Delete a combination category or its image specified by ID.

DELETE /combination_categories/:id

$ curl -X DELETE https://core.expozy.com/api/admin/combination_categories/:id?image=true

Parameters

  • id

    ID of the object

  • image

    Whether to only delete an image

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get products data

Return data for all products.

GET /products

$ curl -X GET https://core.expozy.com/api/admin/products?warehouse_id=2038&attr_val=2038&price_from=&price_to=&category_id=391&category_id=3066&provider_id=2038&tag=string&tags=string&tags=string&search=string&admin_search=string&brands=391&brands=3066&only_active=string&only_promo=true&promotions=true&deleted=2038&only_instock=true&only_featured=true&only_image=true&only_product_ids=true&only_membership_accessible=true&reverse_auction=true&related_id=2038&sort=string

Parameters

  • warehouse_id

    Filter data for products from this warehouse

  • attr_val

    Attribute value, e.g. 1, 2, 5

  • price_from

    Lower limit for price

  • price_to

    Lower limit for price

  • category_id

    Filter by category

  • category_id

    Filter by category

  • provider_id

    Provider

  • tag

    Tag (example: дрехи)

  • tags

    Tag (example: дрехи)

  • tags

    Tag (example: дрехи)

  • search

    Search query

  • admin_search

    Search query

  • brands

    Filter by brands (supply array of ints)

  • brands

    Filter by brands (supply array of ints)

  • only_active

    Filter only active products (ex. values: 0, 1)

  • only_promo

    Filter only promotional items

  • promotions

    Filter only promotional items

  • deleted

    Whether to return only deleted items

  • only_instock

    Filter only items in stock, true by default

  • only_featured

    Filter to featured items

  • only_image

    Filter only if product contains image

  • only_product_ids

    Filter to these product_ids

  • only_membership_accessible

    Filter to items accessible with membership

  • reverse_auction

    Filter to items present in reverse auction

  • related_id

    Filter items related to this ID

  • sort

    Sort type (allowed values: oldest, min_price, max_price, discount, title, order, boost

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Modify products

Modify products. Request bodies must be structured in a certain way and all of them are mutually exclusive. - If the body contains the key `massAction`, it also needs to contain product IDs to perform it on. - If it contains the key `unarchive`, the value corresponding to it must be the ID of the product you wish to unarchive. - If it contains the key `quickEdit`, look at the implementation for more detail.

POST /products

$ curl -X POST https://core.expozy.com/api/admin/products

Example Body

{
  "massAction": 1,
  "action": "active",
  "selected_products": [
    0,
    1,
    2
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get product categories data

If list is specified, will return a list with all product categories. If dropList is specified, spacer, level, parent_id and selected need to set, too. Otherwise, see the other parameters.

GET /product_categories

$ curl -X GET https://core.expozy.com/api/admin/product_categories?list=true&dropList=string&spacer=string&level=8682&parent_id=8682&selected=true&search=string&admin_search=string&only_active=true&only_products=string&product_ids=391&product_ids=3066&product_id=2038&only_featured=2038&parent=string&only_image=2038&sort=string

Parameters

  • list

    Return data in a sorted list.

  • dropList

    Return data in a sorted list based on the following optional parameters.

  • spacer

    Spacer

  • level

    Type

  • parent_id

    Id of parent

  • selected

    Selected

  • search

    What to search for, e.g. дрехи (Note: works best in Cyrillic)

  • admin_search

    What to search for, e.g. дрехи (Note: works best in Cyrillic)

  • only_active

    Return only active product categories

  • only_products

    Return only products

  • product_ids

    Return categories matching the list of product_ids

  • product_ids

    Return categories matching the list of product_ids

  • product_id

    Return the category matching this product_id

  • only_featured

    Return only featured categories/products (allowed values: 0, 1)

  • parent

    Return the category with this parent

  • only_image

    Return only categories with title image (allowed values: 0, 1)

  • sort

    Sort type, allowed values: 'oldest', 'products', 'title'

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a new product category

Add a new product category.

POST /product_categories

$ curl -X POST https://core.expozy.com/api/admin/product_categories

Example Body

{
  "sortItems": "string",
  "list": [
    {
      "id": 6401
    },
    {
      "id": 1462
    }
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get product attributes data

If ID specified, returns data for that product ID, otherwise data for all products.

GET /product_attributes

$ curl -X GET https://core.expozy.com/api/admin/product_attributes?product_id=8682

Parameters

  • product_id

    Return data for the selected product.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post product attributes

Post new product attributes.

POST /product_attributes

$ curl -X POST https://core.expozy.com/api/admin/product_attributes

Example Body

{
  "title": "string",
  "type": 986
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get product attributes values data

If ID specified, returns data for that product ID, otherwise data for all products.

GET /product_attributes_values

$ curl -X GET https://core.expozy.com/api/admin/product_attributes_values?attribute_id=8682&only_colors=8682&only_ids=5707&only_ids=498

Parameters

  • attribute_id

    Return attribute values for this attribute_id.

  • only_colors

    Return attribute values only for color attributes (allowed values: 0, 1).

  • only_ids

    Return data for these ids

  • only_ids

    Return data for these ids

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post product attributes

Post new product attributes.

POST /product_attributes_values

$ curl -X POST https://core.expozy.com/api/admin/product_attributes_values

Example Body

{
  "attribute_id": 9277,
  "value": "string",
  "color": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get product attributes values data

If ID specified, returns data for that product ID, otherwise data for all products.

GET /product_attributes_values/:id

$ curl -X GET https://core.expozy.com/api/admin/product_attributes_values/:id

Parameters

  • id

    Return data for the selected project.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get product types data

Returns product types.

GET /product_types

$ curl -X GET https://core.expozy.com/api/admin/product_types

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get product statuses

Returns all product statuses

GET /product_statuses

$ curl -X GET https://core.expozy.com/api/admin/product_statuses

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get promotion for the selected product

Returns the promotion for the product specified by the ID.

GET /product_promotion/:id

$ curl -X GET https://core.expozy.com/api/admin/product_promotion/:id

Parameters

  • id

    Return data for the item corresponding to the ID.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get promotions data

Get data for all promotions and some miscellaneous function.

GET /promotions

$ curl -X GET https://core.expozy.com/api/admin/promotions?sheme=true&generatePromocode=8682

Parameters

  • sheme

  • generatePromocode

    Generates a random promocode

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post promotions

Post new promotions.

POST /promotions

$ curl -X POST https://core.expozy.com/api/admin/promotions

Example Body

{
  "title": "string",
  "type": 4878,
  "promocode": "string",
  "discount_type": "string",
  "discount_type_amount": "string",
  "discount_type_percent": "string",
  "discount_subject": "string",
  "discount_subject_orders_over": "string",
  "discount_subject_product": "string",
  "discount_subject_category": "string",
  "discount_subject_collection": "string",
  "validity": 9665,
  "active": 4469
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get CSV data

Return all data in CSV format.

GET /product_csv

$ curl -X GET https://core.expozy.com/api/admin/product_csv

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get order statuses

Return all order types.

GET /order_statuses

$ curl -X GET https://core.expozy.com/api/admin/order_statuses

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get possible order payments

Return all payment gateways.

GET /order_payments

$ curl -X GET https://core.expozy.com/api/admin/order_payments

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get order data

Returns all orders and filter through specific query parameters.

GET /orders

$ curl -X GET https://core.expozy.com/api/admin/orders?user_id=8682&status=8682&statusDate=string

Parameters

  • user_id

    Get orders for this user.

  • status

    Get orders by status.

  • statusDate

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Modify orders

Modify orders

PUT /orders

$ curl -X PUT https://core.expozy.com/api/admin/orders

Example Body

{
  "id": 479,
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "phone": "string",
  "city": "string",
  "shipping_address": "string",
  "shipping_address2": "string",
  "tracking_number": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get POS order data

Returns all POS orders.

GET /pos_orders

$ curl -X GET https://core.expozy.com/api/admin/pos_orders

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get POS order data

Returns all POS orders or a POS order specified by the ID.

GET /pos_orders/:id

$ curl -X GET https://core.expozy.com/api/admin/pos_orders/:id

Parameters

  • id

    Return data for the item corresponding to the ID.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get revenue per clients

Returns revenue per client for all clients.

GET /revenue_clients

$ curl -X GET https://core.expozy.com/api/admin/revenue_clients

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get client with most orders

Returns client with most orders.

GET /most_orders_clients

$ curl -X GET https://core.expozy.com/api/admin/most_orders_clients

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get imports data.

Returns product imports data sorted in descending order of purchase date.

GET /imports

$ curl -X GET https://core.expozy.com/api/admin/imports

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get data for returned items.

Returns data for items returned by clients.

GET /returns

$ curl -X GET https://core.expozy.com/api/admin/returns

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post returns

Add or edit a return.

POST /returns

$ curl -X POST https://core.expozy.com/api/admin/returns

Example Body

{
  "id": 4694,
  "status": 3653,
  "date_paid": "string",
  "note": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get data for returned items.

Returns data for this return order.

GET /returns/:id

$ curl -X GET https://core.expozy.com/api/admin/returns/:id

Parameters

  • id

    Return data for the item corresponding to the ID.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get wallet tokens data.

Returns a wallet token specified with ID in path.

GET /wallet_tokens/:id

$ curl -X GET https://core.expozy.com/api/admin/wallet_tokens/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get wallet history data.

Returns history of a wallet specified with ID in path.

GET /wallet_history/:id

$ curl -X GET https://core.expozy.com/api/admin/wallet_history/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get wallet settings data.

Returns all wallet settings.

GET /wallet_settings

$ curl -X GET https://core.expozy.com/api/admin/wallet_settings

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get courier zones.

Returns the range of a courier specified with ID in query.

GET /courier_zones

$ curl -X GET https://core.expozy.com/api/admin/courier_zones?courier_id=8682

Parameters

  • courier_id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get invoices data.

Returns data for an invoice specified by ID.

GET /invoices/:id

$ curl -X GET https://core.expozy.com/api/admin/invoices/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get invoices data.

Returns data for an invoice template.

GET /invoice_template

$ curl -X GET https://core.expozy.com/api/admin/invoice_template?type=string&lng=string

Parameters

  • type

    Invoice type

  • lng

    Invoice language

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Convert price number into words.

Convert price number into words.

GET /to_slovom

$ curl -X GET https://core.expozy.com/api/admin/to_slovom?total=5580.890169877106

Parameters

  • total

    Bill total

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get report products data.

Returns report products data.

GET /report_products

$ curl -X GET https://core.expozy.com/api/admin/report_products

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get report products views.

Returns all report products views.

GET /report_products_views

$ curl -X GET https://core.expozy.com/api/admin/report_products_views

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get report orders.

Returns all report orders.

GET /report_orders

$ curl -X GET https://core.expozy.com/api/admin/report_orders

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get current SAAS plan.

GET /saas_plan

$ curl -X GET https://core.expozy.com/api/admin/saas_plan

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get loyalty level data.

Returns all loyalty level data or for an ID specified in the path.

GET /loyalty_levels

$ curl -X GET https://core.expozy.com/api/admin/loyalty_levels

Parameters

  • id

    If present, return data for this object.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a loyalty level

Add a loyalty level.

POST /loyalty_levels

$ curl -X POST https://core.expozy.com/api/admin/loyalty_levels

Example Body

{
  "title": "string",
  "amount": 2143.8248920607284
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get brands data.

Returns data for all brands.

GET /brands

$ curl -X GET https://core.expozy.com/api/admin/brands

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get combinations

Returns data for all combinations

GET /combinations

$ curl -X GET https://core.expozy.com/api/admin/combinations

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post combinations

Add combinations for a given product.

POST /combinations

$ curl -X POST https://core.expozy.com/api/admin/combinations

Example Body

{
  "title": "string",
  "status": 8115,
  "unit_id": 9163
}

200 OK Example Response

{
  "status": {},
  "obj": {}
}

Get combinations

Returns data for all combinations or a single one specified in path

GET /combination_categories

$ curl -X GET https://core.expozy.com/api/admin/combination_categories?list=true&dropList=string&spacer=string&level=8682&parent_id=8682&selected=true&search=string&admin_search=string&only_active=true&only_products=string&product_ids=391&product_ids=3066&product_id=2038&only_featured=2038&parent=string&only_image=2038&sort=string

Parameters

  • list

    Return data in a sorted list.

  • dropList

    Return data in a sorted list based on the following optional parameters.

  • spacer

    Spacer

  • level

    Type

  • parent_id

    Id of parent

  • selected

    Selected

  • search

    What to search for, e.g. дрехи (Note: works best in Cyrillic)

  • admin_search

    What to search for, e.g. дрехи (Note: works best in Cyrillic)

  • only_active

    Return only active product categories

  • only_products

    Return only products

  • product_ids

    Return categories matching the list of product_ids

  • product_ids

    Return categories matching the list of product_ids

  • product_id

    Return the category matching this product_id

  • only_featured

    Return only featured categories/products (allowed values: 0, 1)

  • parent

    Return the category with this parent

  • only_image

    Return only categories with title image (allowed values: 0, 1)

  • sort

    Sort type, allowed values: 'oldest', 'products', 'title'

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post or sort combinations categories

Add a new combination category (images allowed via file upload) or sort existing categories by posting a preferred order for the categories.

POST /combination_categories

$ curl -X POST https://core.expozy.com/api/admin/combination_categories

Example Body

{
  "sortItems": {},
  "list": [
    {
      "description": "Array of objects"
    },
    {
      "description": "Array of objects"
    }
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post products image order

Post products image order.

POST /products_img_order

$ curl -X POST https://core.expozy.com/api/admin/products_img_order

Example Body

{
  "processOrder": "string",
  "order": [
    "string",
    "string"
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post order invoice.

Create a new order invoice.

POST /orders_invoice

$ curl -X POST https://core.expozy.com/api/admin/orders_invoice

Example Body

{
  "invoice_order": 873
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post a new invoice template.

Add a new or update an existing invoice template.

POST /invoice_templates

$ curl -X POST https://core.expozy.com/api/admin/invoice_templates

Example Body

{
  "template_type": "string",
  "template": [
    {
      "title": "string",
      "body": "string"
    },
    {
      "title": "string",
      "body": "string"
    }
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post an invoice.

Add a new invoice

POST /invoice

$ curl -X POST https://core.expozy.com/api/admin/invoice

Example Body

{
  "send": "string",
  "invoice_id": 7719,
  "html": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post a new brand

Add a new brand. (can post images along).

POST /brand

$ curl -X POST https://core.expozy.com/api/admin/brand

Example Body

{
  "title": "string",
  "description": "string",
  "active": 6664,
  "provider": [
    {
      "provider_id": 8322
    },
    {
      "provider_id": 7842
    }
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Modify an order payment method

Modify an order payment method

PUT /order_payment_method

$ curl -X PUT https://core.expozy.com/api/admin/order_payment_method

Example Body

{
  "id": 4351,
  "payment_method": 2771
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Modify an order status

Modify an order status

PUT /order_status

$ curl -X PUT https://core.expozy.com/api/admin/order_status

Example Body

{
  "id": 9674,
  "status": 2967
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

List products under min qty (DataTable)

Requires `warehouse_id`. Internally sets `min_qty=1`.

GET /api/datatable/products_min_qty

$ curl -X GET /api/datatable/products_min_qty?warehouse_id=2038&start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • warehouse_id

    Warehouse ID

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List shop orders (DataTable)

Rows include `user_info`.

GET /api/datatable/shop_orders

$ curl -X GET /api/datatable/shop_orders?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List promotions (DataTable)

Rows include humanized `discount_subject`.

GET /api/datatable/promos

$ curl -X GET /api/datatable/promos?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List returns (DataTable)

Rows include `user_info`, `product`, and `condition`.

GET /api/datatable/returns

$ curl -X GET /api/datatable/returns?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List brands (DataTable)

GET /api/datatable/brands

$ curl -X GET /api/datatable/brands?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List loyalty levels (DataTable)

GET /api/datatable/loyalty_levels

$ curl -X GET /api/datatable/loyalty_levels?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List products (DataTable)

Rows include `product_type` and `status`.

GET /api/datatable/shop_products

$ curl -X GET /api/datatable/shop_products?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List promotion registrations (DataTable)

GET /api/datatable/promos_registration

$ curl -X GET /api/datatable/promos_registration?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Delete a combination image

Delete a combination image specified by ID.

DELETE /combinationImage/:id

$ curl -X DELETE https://core.expozy.com/api/admin/combinationImage/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete an order option

Delete an order option specified by ID.

DELETE /orders_options/:id

$ curl -X DELETE https://core.expozy.com/api/admin/orders_options/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post order options

Add or edit order options.

POST /orders_options

$ curl -X POST https://core.expozy.com/api/admin/orders_options

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post payment refund

Process a payment refund for an order.

POST /payment_refund

$ curl -X POST https://core.expozy.com/api/admin/payment_refund

Example Body

{
  "amount": 6375.016530812749,
  "order_id": 2204,
  "fibank": 4300
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Generate product description

Generate AI-powered product description.

POST /product_gen_description

$ curl -X POST https://core.expozy.com/api/admin/product_gen_description

Example Body

{
  "text": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Set product image order

Set the display order for product images.

POST /shop_products_img_order

$ curl -X POST https://core.expozy.com/api/admin/shop_products_img_order

Example Body

{
  "order": [
    "string",
    "string"
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post invoice items

Add or edit invoice items.

POST /invoices_items

$ curl -X POST https://core.expozy.com/api/admin/invoices_items

Example Body

{
  "items": [],
  "hotel": 7653
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post invoice payments

Add or edit invoice payments.

POST /invoices_payments

$ curl -X POST https://core.expozy.com/api/admin/invoices_payments

Example Body

{
  "invoice_id": 2148,
  "amount": 6862.697238936208,
  "date": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post invoice storno

Create invoice storno (cancellation).

POST /invoices_storno

$ curl -X POST https://core.expozy.com/api/admin/invoices_storno

Example Body

{
  "invoice_id": 9527
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post proforma invoices

Create or edit proforma invoices.

POST /proforms

$ curl -X POST https://core.expozy.com/api/admin/proforms

Example Body

{
  "invoice_company": "string",
  "invoice_eik": "string",
  "create_proform": 5699,
  "hotel": 3250,
  "reservationEvent_id": 8729,
  "reservation_id": 2990,
  "order_id": 9617
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post proforma invoice items

Add or edit proforma invoice items.

POST /proforms_items

$ curl -X POST https://core.expozy.com/api/admin/proforms_items

Example Body

{
  "items": [],
  "proform_id": 7561,
  "hotel": 3154
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post product import

Import products with external ID mapping.

POST /products_import_t

$ curl -X POST https://core.expozy.com/api/admin/products_import_t

Example Body

{
  "external_id": "string",
  "title": "string",
  "type": 309,
  "currency": "string",
  "price": 2898.981945971284
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post vouchers

Add or edit vouchers.

POST /vouchers

$ curl -X POST https://core.expozy.com/api/admin/vouchers

Example Body

{
  "amount": 4837.640970447869,
  "code": "string",
  "valid_until": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Admin

Process a product

Calls Product::process for the given product ID (requires admin or product access).

PUT /products/:id

$ curl -X PUT https://core.expozy.com/api/admin/products/:id

Example Body

{
  "key_0": "string",
  "key_1": 6894.966842278159
}

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

400 Bad Request Example Response

401 Unauthorized Example Response

403 Forbidden Example Response

Edit order buyer info

Edits first/last name, email, phone, address.

PUT /orders/:id

$ curl -X PUT https://core.expozy.com/api/admin/orders/:id

Example Body

{
  "first_name": "string",
  "last_name": "string",
  "email": "[email protected]",
  "phone": "string",
  "address": "string"
}

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

400 Bad Request Example Response

401 Unauthorized Example Response

403 Forbidden Example Response

Get banners data.

Returns a banner specified with ID in path.

GET /banners/:id

$ curl -X GET https://core.expozy.com/api/admin/banners/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get comments data.

Returns comments on a page/product specified with ID in path.

GET /comment/:id

$ curl -X GET https://core.expozy.com/api/admin/comment/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Edit QA item

PUT /qa/:id

$ curl -X PUT https://core.expozy.com/api/admin/qa/:id

Example Body

{
  "key_0": true,
  "key_1": true,
  "key_2": 7701
}

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

400 Bad Request Example Response

401 Unauthorized Example Response

403 Forbidden Example Response

Post new module request

Request a new module installation.

POST /modules_new

$ curl -X POST https://core.expozy.com/api/admin/modules_new

Example Body

{
  "id": 2948
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get dashboards data.

Returns all dashboards data.

GET /dashboards

$ curl -X GET https://core.expozy.com/api/admin/dashboards

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get data for integrations

Returns data for all integrations.

GET /integrations

$ curl -X GET https://core.expozy.com/api/admin/integrations

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get data for integrations

Returns data for an integration specified with ID.

GET /integrations/:id

$ curl -X GET https://core.expozy.com/api/admin/integrations/:id

Parameters

  • id

    Return data for the item corresponding to the ID.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get email templates data.

Returns all email templates.

GET /email_templates

$ curl -X GET https://core.expozy.com/api/admin/email_templates

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get email templates data.

Returns a template specified with ID.

GET /email_templates/:id

$ curl -X GET https://core.expozy.com/api/admin/email_templates/:id

Parameters

  • id

    Return data for the item corresponding to the ID.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get pos templates data.

Returns all POS templates.

GET /pos_templates

$ curl -X GET https://core.expozy.com/api/admin/pos_templates

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get pos templates data.

Returns a POS template specified with ID.

GET /pos_templates/:id

$ curl -X GET https://core.expozy.com/api/admin/pos_templates/:id

Parameters

  • id

    Return data for the item corresponding to the ID.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get admin gateways data.

Returns all admin gateways.

GET /gateways

$ curl -X GET https://core.expozy.com/api/admin/gateways

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a new gateway.

Create a new gateway.

POST /gateways

$ curl -X POST https://core.expozy.com/api/admin/gateways

Example Body

{
  "gateway_id": 7726,
  "title": "string",
  "name": "string",
  "value": 2781,
  "type": 5523
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get admin gateways data.

Returns a single gateway specified with ID in path.

GET /gateways/:id

$ curl -X GET https://core.expozy.com/api/admin/gateways/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post development configuration

Update development configuration settings.

POST /dev_config

$ curl -X POST https://core.expozy.com/api/admin/dev_config

Example Body

{
  "id": 8296,
  "module_status": 5696,
  "status_id": 2706
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get contacts

Returns contacts.

GET /contacts

$ curl -X GET https://core.expozy.com/api/admin/contacts

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post app notification templates

Add or edit app notification templates.

POST /appNotifyTemplates

$ curl -X POST https://core.expozy.com/api/admin/appNotifyTemplates

Example Body

{
  "title": "string",
  "subject": "string",
  "body": "string",
  "templateid": 3996
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Send email

Send an email from admin panel.

POST /send_mail

$ curl -X POST https://core.expozy.com/api/admin/send_mail

Example Body

{
  "email": "string",
  "subject": "string",
  "body": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Change order payment method

PUT /order_payment_method/:id

$ curl -X PUT https://core.expozy.com/api/admin/order_payment_method/:id

Example Body

{
  "payment_method": "string"
}

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

400 Bad Request Example Response

401 Unauthorized Example Response

403 Forbidden Example Response

Change order status

PUT /order_status/:id

$ curl -X PUT https://core.expozy.com/api/admin/order_status/:id

Example Body

{
  "status": "string"
}

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

400 Bad Request Example Response

401 Unauthorized Example Response

403 Forbidden Example Response

Change order payment status

PUT /order_payment_status/:id

$ curl -X PUT https://core.expozy.com/api/admin/order_payment_status/:id

Example Body

{
  "status": "string"
}

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

400 Bad Request Example Response

401 Unauthorized Example Response

403 Forbidden Example Response

Pages

Get pages data

Returns a page by ID.

GET /pages/:id

$ curl -X GET https://core.expozy.com/api/admin/pages/:id

Parameters

  • id

    ID of the page

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a new page.

Post a new page.

POST /pages/:id

$ curl -X POST https://core.expozy.com/api/admin/pages/:id

Example Body

{
  "title": "string",
  "body": "string",
  "site_id": "string",
  "seo_title": "string",
  "seo_tags": "string",
  "seo_description": "string",
  "active": 1947,
  "category_id": 8639,
  "description": "string",
  "slug": "string"
}

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a page

Delete a page specified by ID.

DELETE /pages/:id

$ curl -X DELETE https://core.expozy.com/api/admin/pages/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a page image

Delete an image for a page specified by ID.

DELETE /page_image/:id

$ curl -X DELETE https://core.expozy.com/api/admin/page_image/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a blog post file

Delete a file for a blog post specified by ID.

DELETE /blogPostsFile/:id

$ curl -X DELETE https://core.expozy.com/api/admin/blogPostsFile/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get pages categories data

Returns a page category by ID.

GET /pages_categories/:id

$ curl -X GET https://core.expozy.com/api/admin/pages_categories/:id

Parameters

  • id

    ID of the category

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a page category

Delete a page category specified by ID.

DELETE /pages_categories/:id

$ curl -X DELETE https://core.expozy.com/api/admin/pages_categories/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get pages data

Returns all pages. If 'list' is specified, returns a structured list.

GET /pages

$ curl -X GET https://core.expozy.com/api/admin/pages?list=false

Parameters

  • list

    List of pages

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Edit a page HTML

Edit a page HTML.

PUT /pages

$ curl -X PUT https://core.expozy.com/api/admin/pages

Example Body

{
  "id": 5774,
  "html": "string",
  "lang": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get pages categories data

Returns all page categories either in a list or a droplist depending on the query argument specified.

GET /pages_categories

$ curl -X GET https://core.expozy.com/api/admin/pages_categories?list=true&dropList=true

Parameters

  • list

    List of categories

  • dropList

    DropList of categories

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a new pages category

Add a new pages category.

POST /pages_categories

$ curl -X POST https://core.expozy.com/api/admin/pages_categories

Example Body

{
  "list": [
    {
      "id": 1195
    },
    {
      "id": 6160
    }
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

List pages (DataTable)

Rows include `editor_url` for each page.

GET /api/datatable/pages

$ curl -X GET /api/datatable/pages?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List page revisions (DataTable)

Rows include `user_info`.

GET /api/datatable/pages_revisions

$ curl -X GET /api/datatable/pages_revisions?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Blog

Get blog posts data

Returns a blog post by ID.

GET /blogPosts/:id

$ curl -X GET https://core.expozy.com/api/admin/blogPosts/:id?only_similar=true

Parameters

  • id

    ID of the object

  • only_similar

    Return similar blog posts to this ID

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a new blog post

Add a new blog post. Note: Images can also be sent along with the POST body.

POST /blogPosts/:id

$ curl -X POST https://core.expozy.com/api/admin/blogPosts/:id

Example Body

{
  "title": "string",
  "cid": 9271,
  "date_publish": "string",
  "html": "string",
  "site_id": 7019,
  "seo_title": "string",
  "seo_description": "string",
  "active": 5058,
  "main_article": "string",
  "slug": "string",
  "similar_blog_posts": [
    "string",
    "string"
  ],
  "related_blog_posts": [
    "string",
    "string"
  ]
}

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a blog post

Delete a blog post specified by ID.

DELETE /blogPosts/:id

$ curl -X DELETE https://core.expozy.com/api/admin/blogPosts/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Edit blog post HTML

PUT /blogPosts/:id

$ curl -X PUT https://core.expozy.com/api/admin/blogPosts/:id

Example Body

{
  "html": "string",
  "lang": "string"
}

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

400 Bad Request Example Response

401 Unauthorized Example Response

403 Forbidden Example Response

Delete a blog post image

Delete image for a blog post specified by ID.

DELETE /blogPostImage/:id

$ curl -X DELETE https://core.expozy.com/api/admin/blogPostImage/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get blog categories data

Returns a blog category by ID.

GET /blogCategories/:id

$ curl -X GET https://core.expozy.com/api/admin/blogCategories/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a blog category

Delete a blog category specified by ID.

DELETE /blogCategories/:id

$ curl -X DELETE https://core.expozy.com/api/admin/blogCategories/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get blog posts data

Returns all blog posts.

GET /blogPosts

$ curl -X GET https://core.expozy.com/api/admin/blogPosts

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Edit a blog post

Edit a blog post

PUT /blogPosts

$ curl -X PUT https://core.expozy.com/api/admin/blogPosts

Example Body

{
  "id": 5774,
  "html": "string",
  "lang": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get blog categories data

Returns all blog categories.

GET /blogCategories

$ curl -X GET https://core.expozy.com/api/admin/blogCategories

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a new blog category

Add a new blog category. Note: Images can also be sent along with the POST body.

POST /blogCategories

$ curl -X POST https://core.expozy.com/api/admin/blogCategories

Example Body

{
  "title": "string",
  "active": 7420,
  "slug": "string",
  "url": "string",
  "position": 8364,
  "id": 9014
}

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

List blog posts (DataTable)

Rows include `editor_url` for each post.

GET /api/datatable/blog

$ curl -X GET /api/datatable/blog?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List blog revisions (DataTable)

Rows include `user_info`.

GET /api/datatable/blog_revisions

$ curl -X GET /api/datatable/blog_revisions?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List Blog Generator RSS sources (DataTable)

Rows include attribute value titles as `attr_{key}`.

GET /api/datatable/blog_generator_rss

$ curl -X GET /api/datatable/blog_generator_rss?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Delete a blog RSS generator

Delete a blog RSS generator feed specified by ID.

DELETE /blogGeneratorRss/:id

$ curl -X DELETE https://core.expozy.com/api/admin/blogGeneratorRss/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post blog generator settings

Configure blog generator settings.

POST /blogGenerator

$ curl -X POST https://core.expozy.com/api/admin/blogGenerator

Example Body

{
  "api_key": "string",
  "organisation_id": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post blog generator RSS feed

Add RSS feed for blog generator.

POST /blogGeneratorRss

$ curl -X POST https://core.expozy.com/api/admin/blogGeneratorRss

Example Body

{
  "title": "string",
  "url": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

User

Delete logins for a user

Delete logins for a user specified by ID.

DELETE /users_login/:id

$ curl -X DELETE https://core.expozy.com/api/admin/users_login/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete bans for a user

Delete bans for a user specified by ID.

DELETE /users_bans/:id

$ curl -X DELETE https://core.expozy.com/api/admin/users_bans/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get a user

Returns a user by ID.

GET /users/:id

$ curl -X GET https://core.expozy.com/api/admin/users/:id

Parameters

  • id

    ID of the User

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete user

Delete a user specified by ID.

DELETE /users/:id

$ curl -X DELETE https://core.expozy.com/api/admin/users/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Same as /users

Returns all users or return a user by email.

GET /accounts

$ curl -X GET https://core.expozy.com/api/admin/accounts?email=

Parameters

  • email

    Email of the User

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Same as /users

Returns a user by ID.

GET /accounts/:id

$ curl -X GET https://core.expozy.com/api/admin/accounts/:id

Parameters

  • id

    ID of the User

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get a user

Returns all users or a user by email.

GET /users

$ curl -X GET https://core.expozy.com/api/admin/users?email=

Parameters

  • email

    Email of the User

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a user

Add a new user

POST /users

$ curl -X POST https://core.expozy.com/api/admin/users

Example Body

{
  "email": "[email protected]",
  "password": "user123",
  "first_name": "John",
  "last_name": "Smith",
  "userlevel": 9
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get data for all sellers.

Returns all sellers.

GET /sellers

$ curl -X GET https://core.expozy.com/api/admin/sellers

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get users for messages.

Returns users for messages.

GET /users_for_messages

$ curl -X GET https://core.expozy.com/api/admin/users_for_messages

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Gets user levels.

Returns users levels.

GET /user_levels

$ curl -X GET https://core.expozy.com/api/admin/user_levels

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get notify logs.

Returns notify header logs data.

GET /notify_logs

$ curl -X GET https://core.expozy.com/api/admin/notify_logs

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get the user's cart.

Returns user cart data for ID specified in the path.

GET /users_cart/:id

$ curl -X GET https://core.expozy.com/api/admin/users_cart/:id

Parameters

  • id

    Return data for this object.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get data for user groups

Return data for all user groups

GET /user_groups

$ curl -X GET https://core.expozy.com/api/admin/user_groups

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get data for user groups

Return data for a user group specified by ID

GET /user_groups/:id

$ curl -X GET https://core.expozy.com/api/admin/user_groups/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a request for resetting password.

Handles occasions where the user password has been lost. Providing `email` is mandatory.

POST /forgotten_pass

$ curl -X POST https://core.expozy.com/api/admin/forgotten_pass

Example Body

{
  "email": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete all user logins

Delete all user login records.

DELETE /users_login

$ curl -X DELETE https://core.expozy.com/api/admin/users_login

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete all user bans

Delete all banned user records.

DELETE /users_bans

$ curl -X DELETE https://core.expozy.com/api/admin/users_bans

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a user's spoken language

Delete a user's spoken language specified by ID.

DELETE /users_spoken_languages/:id

$ curl -X DELETE https://core.expozy.com/api/admin/users_spoken_languages/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Verify authentication token

Verify a user authentication token.

POST /token_verify

$ curl -X POST https://core.expozy.com/api/admin/token_verify

Example Body

{
  "token": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete user account

Request or confirm user account deletion.

POST /deleteUserAccount

$ curl -X POST https://core.expozy.com/api/admin/deleteUserAccount

Example Body

{
  "hash": "string",
  "site_name": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post user spoken languages

Add or edit user spoken languages.

POST /users_spoken_languages

$ curl -X POST https://core.expozy.com/api/admin/users_spoken_languages

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Menu

Delete menu

Delete a menu specified by ID.

DELETE /menu/:id

$ curl -X DELETE https://core.expozy.com/api/admin/menu/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post a menu

Add a new menu

POST /menu

$ curl -X POST https://core.expozy.com/api/admin/menu

Example Body

{
  "sorting": 1,
  "title": "New menu",
  "active": 1
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Admin Menu

Get admin menu data

Returns all admin menus or a menu by ID.

GET /admin_menu/:id

$ curl -X GET https://core.expozy.com/api/admin/admin_menu/:id

Parameters

  • id

    ID of the menu

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete admin menu

Delete an admin menu specified by ID.

DELETE /admin_menu/:id

$ curl -X DELETE https://core.expozy.com/api/admin/admin_menu/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get admin menu data

Returns all admin menus or a menu by HTML.

GET /admin_menu

$ curl -X GET https://core.expozy.com/api/admin/admin_menu?html=

Parameters

  • html

    HTML of the menu

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post admin menu.

Post a new admin menu or sort a list of your choice, JSON structure matters here. Level name key is not bound to just `level`.

POST /admin_menu

$ curl -X POST https://core.expozy.com/api/admin/admin_menu

Example Body

{
  "title": "string",
  "parent_id": 5074,
  "active": 1842,
  "icon": "string",
  "slug": "string",
  "active_divider": "string",
  "lvl": [
    {
      "level": "string"
    },
    {
      "level": "string"
    }
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Checks if the user is admin

Checks if the user is admin.

GET /admin_menu_access

$ curl -X GET https://core.expozy.com/api/admin/admin_menu_access?do=

Parameters

  • do

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post contacts

Add or edit a contact.

POST /contacts

$ curl -X POST https://core.expozy.com/api/admin/contacts

Example Body

{
  "email": "string",
  "phone": "string",
  "address": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post admin dashboard.

Post admin dashboard.

POST /dashboard

$ curl -X POST https://core.expozy.com/api/admin/dashboard

Example Body

{
  "status": "string",
  "sort": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Slider

Delete a slider

Delete a slider specified by ID.

DELETE /slider/:id

$ curl -X DELETE https://core.expozy.com/api/admin/slider/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a slide or slide image

Delete a slide or slide image specified by ID.

DELETE /slide/:id

$ curl -X DELETE https://core.expozy.com/api/admin/slide/:id?deleteImage=true

Parameters

  • id

    ID of the object

  • deleteImage

    Delete only the image

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a slider layout

Delete a slider layout specified by ID.

DELETE /slider_layout/:id

$ curl -X DELETE https://core.expozy.com/api/admin/slider_layout/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get slider layers data.

Returns all slider layers data.

GET /slider_layers/:id

$ curl -X GET https://core.expozy.com/api/admin/slider_layers/:id

Parameters

  • id

    Return data for the item corresponding to the ID.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get sliders data.

Returns all slider data.

GET /sliders

$ curl -X GET https://core.expozy.com/api/admin/sliders

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get sliders data.

Returns slider data for this ID.

GET /sliders/:id

$ curl -X GET https://core.expozy.com/api/admin/sliders/:id

Parameters

  • id

    Return data for the item corresponding to the ID.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get sliders data.

Returns slider data (special).

GET /slides

$ curl -X GET https://core.expozy.com/api/admin/slides?slider_id=8682

Parameters

  • slider_id

    Return data for the item corresponding to the ID.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get slider data for the given ID.

Returns slider data.

GET /slides/:id

$ curl -X GET https://core.expozy.com/api/admin/slides/:id

Parameters

  • id

    Return data for the item corresponding to the ID.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post slider

Post new slider.

POST /slider

$ curl -X POST https://core.expozy.com/api/admin/slider

Example Body

{
  "title": "string",
  "active": 9219
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post slider

Post new slider.

POST /slide

$ curl -X POST https://core.expozy.com/api/admin/slide

Example Body

{
  "title": "string",
  "active": 218,
  "slider_id": 4239,
  "button_text": "string",
  "button_url": "string",
  "text_color": "string",
  "text": "string",
  "id": 7316
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Modify slider layout

Post new slider.

POST /slider_layout

$ curl -X POST https://core.expozy.com/api/admin/slider_layout

Example Body

{
  "id": 5816,
  "type": "string",
  "type_button": "string",
  "button_url": "string",
  "button_text": "string",
  "value": "string",
  "text_color": "string",
  "text_font_size": "string",
  "text_font_weight": "string",
  "text_shadow": "string",
  "x": 2385,
  "y": 751,
  "slider_id": 9997,
  "slide_id": 8481,
  "text": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Providers

Get providers data

Returns all providers or a provider specified by the ID.

GET /providers/:id

$ curl -X GET https://core.expozy.com/api/admin/providers/:id

Parameters

  • id

    Return data for the item corresponding to the ID.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a provider or a provider image

Delete a provider or a provider's image specified by ID.

DELETE /providers/:id

$ curl -X DELETE https://core.expozy.com/api/admin/providers/:id?deleteImage=2038

Parameters

  • id

    ID of the provider

  • deleteImage

    ID of the image

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get provider data

Returns provider data within given parameters.

GET /providers

$ curl -X GET https://core.expozy.com/api/admin/providers?category_id=8682&user_id=8682

Parameters

  • category_id

    Return data for the item corresponding to the ID.

  • user_id

    Return data for the item corresponding to the ID.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a new provider.

Post a new provider.

POST /providers

$ curl -X POST https://core.expozy.com/api/admin/providers

Example Body

{
  "title": "string",
  "address": "string",
  "delivery": "string",
  "email": "string",
  "email_second": "string",
  "phone": "string",
  "phone_second": "string",
  "markup": 6058.400070852237,
  "markup_min": 7027,
  "shipping_price": 145.17011502078293,
  "shipping_price_free": 7551.645294274556
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Languages

Delete a language

Delete a language specified by ID.

DELETE /languages/:id

$ curl -X DELETE https://core.expozy.com/api/admin/languages/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get languages data

Returns the languages of a select project, otherwise returns all languages.

GET /languages

$ curl -X GET https://core.expozy.com/api/admin/languages?project_name=8682

Parameters

  • project_name

    Return the language for the selected project.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post languages.

Post new languages.

POST /languages

$ curl -X POST https://core.expozy.com/api/admin/languages

Example Body

{
  "title": "string",
  "code": "string",
  "id": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post email templates.

Create a new email template.

POST /email_templates

$ curl -X POST https://core.expozy.com/api/admin/email_templates

Example Body

{
  "name": "string",
  "subject": "string",
  "body": "string",
  "templateid": 203
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post translation operations

Perform bulk translation operations on content.

POST /translations

$ curl -X POST https://core.expozy.com/api/admin/translations

Example Body

{
  "target": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Banners

Delete a banner or a banner image

Delete a banner or the image of one specified by ID.

DELETE /banners/:id

$ curl -X DELETE https://core.expozy.com/api/admin/banners/:id?deleteImage=true

Parameters

  • id

    ID of the object

  • deleteImage

    Delete only the image

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post new banners.

Create new banners (supports images). Banner title must be unique.

POST /banners

$ curl -X POST https://core.expozy.com/api/admin/banners

Example Body

{
  "title": "string",
  "link": "string",
  "active": 8707,
  "popup": "string",
  "popup_timer": 9676
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Membership

Get membership types.

Returns a membership type specified with ID.

GET /membership_types/:id

$ curl -X GET https://core.expozy.com/api/admin/membership_types/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a membership type

Delete a membership type specified by ID.

DELETE /membership_types/:id

$ curl -X DELETE https://core.expozy.com/api/admin/membership_types/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a user membership

Terminate a user membership specified by ID.

DELETE /membership_user/:id

$ curl -X DELETE https://core.expozy.com/api/admin/membership_user/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get memberships data.

Returns a membership specified with ID in path.

GET /memberships/:id

$ curl -X GET https://core.expozy.com/api/admin/memberships/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a membership

Delete a membership specified by ID.

DELETE /memberships/:id

$ curl -X DELETE https://core.expozy.com/api/admin/memberships/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get membership types.

Returns all membership types.

GET /membership_types

$ curl -X GET https://core.expozy.com/api/admin/membership_types

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a membership type.

Creates a new membership type.

POST /membership_types

$ curl -X POST https://core.expozy.com/api/admin/membership_types

Example Body

{
  "type": "string",
  "title": "string",
  "active": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get memberships data.

Returns all memberships data.

GET /memberships

$ curl -X GET https://core.expozy.com/api/admin/memberships

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Updates a user with a membership.

Updates a user with a membership.

POST /membership_user

$ curl -X POST https://core.expozy.com/api/admin/membership_user

Example Body

{
  "user_id": 7243,
  "membership_id": 2953
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post a new membership.

Create a new membership.

POST /membership

$ curl -X POST https://core.expozy.com/api/admin/membership

Example Body

{
  "price": 6622.758972556176,
  "title": "string",
  "active": 9114,
  "membership_type": 8108,
  "provider_action": 9395,
  "product_type_action": 834
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

List memberships (DataTable)

GET /api/datatable/memberships

$ curl -X GET /api/datatable/memberships?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List membership users (DataTable)

Rows include `user_info` and `membership`.

GET /api/datatable/memberships_users

$ curl -X GET /api/datatable/memberships_users?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Warehouses

Get warehouses data.

Returns a warehouse specified with ID in path.

GET /warehouses/:id

$ curl -X GET https://core.expozy.com/api/admin/warehouses/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a warehouse

Delete a warehouse specified by ID.

DELETE /warehouses/:id

$ curl -X DELETE https://core.expozy.com/api/admin/warehouses/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get warehouses location data.

Returns the location of a warehouse specified with ID in path.

GET /wh_locations/:id

$ curl -X GET https://core.expozy.com/api/admin/wh_locations/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a warehouse location

Delete a warehouse location specified by ID.

DELETE /wh_locations/:id

$ curl -X DELETE https://core.expozy.com/api/admin/wh_locations/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a warehouse delivery status

Remove a warehouse delivery status specified by ID.

DELETE /wh_delivery_status/:id

$ curl -X DELETE https://core.expozy.com/api/admin/wh_delivery_status/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get warehouses rate types.

Returns the warehouse rate types of a warehouse specified with ID in path.

GET /wh_delivery_rate_types/:id

$ curl -X GET https://core.expozy.com/api/admin/wh_delivery_rate_types/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a warehouse delivery rate type

Delete a warehouse delivery rate type specified by ID.

DELETE /wh_delivery_rate_types/:id

$ curl -X DELETE https://core.expozy.com/api/admin/wh_delivery_rate_types/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get delivery rates of warehouse providers.

Returns the delivery rates of a provider specified with ID in path.

GET /wh_providers_delivery_rate/:id

$ curl -X GET https://core.expozy.com/api/admin/wh_providers_delivery_rate/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a warehouse provider's delivery rate

Delete a warehouse provider's delivery rate specified by ID.

DELETE /wh_providers_delivery_rate/:id

$ curl -X DELETE https://core.expozy.com/api/admin/wh_providers_delivery_rate/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get delivery rates of warehouses.

Returns the delivery rates of a warehouse specified with ID in path.

GET /wh_warehouses_delivery_rate/:id

$ curl -X GET https://core.expozy.com/api/admin/wh_warehouses_delivery_rate/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a warehouse's delivery rate

Delete a warehouse's delivery rate specified by ID.

DELETE /wh_warehouses_delivery_rate/:id

$ curl -X DELETE https://core.expozy.com/api/admin/wh_warehouses_delivery_rate/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete charging history

Delete charging history specified by ID.

DELETE /charging_history/:id

$ curl -X DELETE https://core.expozy.com/api/admin/charging_history/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get warehouse loading/charging data.

Returns loading/charging data for a warehouse specified with ID.

GET /wh_chargings/:id

$ curl -X GET https://core.expozy.com/api/admin/wh_chargings/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get warehouses data.

Returns all warehouses data.

GET /warehouses

$ curl -X GET https://core.expozy.com/api/admin/warehouses

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a new warehouse.

Creates a new warehouse object. Unless `id` is supplied, it will attempt to register the warehouse anew as a User.

POST /warehouses

$ curl -X POST https://core.expozy.com/api/admin/warehouses

Example Body

{
  "id": 972,
  "title": "string",
  "country_id": 6084,
  "email": "string",
  "password": "string",
  "region_id": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get warehouses location data.

Returns the location of all warehouses.

GET /wh_locations

$ curl -X GET https://core.expozy.com/api/admin/wh_locations

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a new warehouse location.

Not functional at the moment.

POST /wh_locations

$ curl -X POST https://core.expozy.com/api/admin/wh_locations

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get warehouses delivery statuses.

Returns the delivery status of all warehouses.

GET /wh_delivery_statuses

$ curl -X GET https://core.expozy.com/api/admin/wh_delivery_statuses

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get warehouses delivery statuses.

Returns the delivery status of a warehouse specified with ID in path.

GET /wh_delivery_statuses/:id

$ curl -X GET https://core.expozy.com/api/admin/wh_delivery_statuses/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get warehouses rate types.

Returns the warehouse rate types of all warehouses.

GET /wh_delivery_rate_types

$ curl -X GET https://core.expozy.com/api/admin/wh_delivery_rate_types

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get delivery rates of warehouse providers.

Returns the delivery rates of all providers.

GET /wh_providers_delivery_rate

$ curl -X GET https://core.expozy.com/api/admin/wh_providers_delivery_rate

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a new warehouse provider's delivery rate.

Post a new warehouse provider's delivery rate.

POST /wh_providers_delivery_rate

$ curl -X POST https://core.expozy.com/api/admin/wh_providers_delivery_rate

Example Body

{
  "provider": "string",
  "country_id": 9557,
  "weight": 4823.230379002972,
  "price": 628.29596720269,
  "type": 8694,
  "from": "string",
  "to": "string",
  "free_shipping": 2409
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get delivery rates of warehouses.

Returns the delivery rates of all warehouses.

GET /wh_warehouses_delivery_rate

$ curl -X GET https://core.expozy.com/api/admin/wh_warehouses_delivery_rate

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a new warehouse delivery rate.

Post a new warehouse delivery rate.

POST /wh_warehouses_delivery_rate

$ curl -X POST https://core.expozy.com/api/admin/wh_warehouses_delivery_rate

Example Body

{
  "warehouse": "string",
  "country_id": 2902,
  "weight": 3743.81733534185,
  "price": 1313.2217789834376,
  "type": 2943,
  "from": "string",
  "to": "string",
  "free_shipping": 3768
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post a new warehouse delivery status.

Post a new warehouse delivery status.

POST /wh_delivery_status

$ curl -X POST https://core.expozy.com/api/admin/wh_delivery_status

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post a new warehouse delivery rate type.

Post a new warehouse delivery rate type.

POST /wh_delivery_rate_type

$ curl -X POST https://core.expozy.com/api/admin/wh_delivery_rate_type

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post stock for a warehouse.

Update stock for a warehouse.

POST /wh_stock

$ curl -X POST https://core.expozy.com/api/admin/wh_stock

Example Body

{
  "price": 8902.19513062947,
  "warehouse_id": 4724,
  "data_id": 2357,
  "qty": 7510
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post stock for a warehouse.

Update stock for a warehouse.

POST /wh_charging

$ curl -X POST https://core.expozy.com/api/admin/wh_charging

Example Body

{
  "warehouse": "string",
  "provider": "string",
  "product": "string",
  "var_qty": [
    {
      "productId": 7496
    },
    {
      "productId": 9669
    }
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a warehouse rack

Delete a warehouse rack specified by ID.

DELETE /wh_racks/:id

$ curl -X DELETE https://core.expozy.com/api/admin/wh_racks/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a warehouse row

Delete a warehouse row specified by ID.

DELETE /wh_rows/:id

$ curl -X DELETE https://core.expozy.com/api/admin/wh_rows/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a warehouse supply request

Delete a warehouse supply request specified by ID.

DELETE /wh_supply_request/:id

$ curl -X DELETE https://core.expozy.com/api/admin/wh_supply_request/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post warehouse charging payment

Add or edit a warehouse charging payment.

POST /wh_charging_payment

$ curl -X POST https://core.expozy.com/api/admin/wh_charging_payment

Example Body

{
  "charging_id": 6834,
  "amount": 204.37617991656555,
  "date": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post warehouse charging documents

Add or edit warehouse charging documents.

POST /wh_charging_documents

$ curl -X POST https://core.expozy.com/api/admin/wh_charging_documents

Example Body

{
  "charging_id": 2490,
  "type_id": 9254,
  "number": "string",
  "date": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post warehouse racks

Add or edit warehouse racks.

POST /wh_racks

$ curl -X POST https://core.expozy.com/api/admin/wh_racks

Example Body

{
  "title": "string",
  "code": "string",
  "warehouse_id": 681
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post warehouse rows

Add or edit warehouse rows.

POST /wh_rows

$ curl -X POST https://core.expozy.com/api/admin/wh_rows

Example Body

{
  "code": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post warehouse returns

Add or edit warehouse returns.

POST /wh_returns

$ curl -X POST https://core.expozy.com/api/admin/wh_returns

Example Body

{
  "warehouse_id": 2130,
  "provider_id": 3349
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post warehouse supply request

Create warehouse supply request.

POST /wh_supply_request

$ curl -X POST https://core.expozy.com/api/admin/wh_supply_request

Example Body

{
  "warehouse_id": 7119,
  "provider_id": 7374,
  "items": []
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post warehouse inventory

Process warehouse inventory.

POST /wh_inventory

$ curl -X POST https://core.expozy.com/api/admin/wh_inventory

Example Body

{
  "warehouse_id": 2421,
  "items": []
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

POS

Delete a cart product

Delete a cart product specified by ID.

DELETE /pos_cart/:id

$ curl -X DELETE https://core.expozy.com/api/admin/pos_cart/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete all products in the cart.

Delete all products in the cart.

DELETE /pos_cart

$ curl -X DELETE https://core.expozy.com/api/admin/pos_cart

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a POS object

Delete a POS object specified by ID.

DELETE /pos_object/:id

$ curl -X DELETE https://core.expozy.com/api/admin/pos_object/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a POS client

Delete a POS client specified by ID.

DELETE /pos_client/:id

$ curl -X DELETE https://core.expozy.com/api/admin/pos_client/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post POS orders

Same as /pos_order endpoint.

POST /pos_orders

$ curl -X POST https://core.expozy.com/api/admin/pos_orders

Example Body

{
  "discount": 2036.1285897087455,
  "payment_method": "string",
  "plateno": 2228.0869322999665,
  "resto": 1721.6824737658264,
  "clientId": 5972
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post POS templates

Add POS templates.

POST /pos_templates

$ curl -X POST https://core.expozy.com/api/admin/pos_templates

Example Body

{
  "name": "string",
  "body": "string",
  "templateid": 7116,
  "help": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get POS current car.

Returns data for the current POS cart.

GET /pos_current_cart

$ curl -X GET https://core.expozy.com/api/admin/pos_current_cart

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get POS current cart values.

Returns data for the current POS cart value.

GET /pos_current_cart_values

$ curl -X GET https://core.expozy.com/api/admin/pos_current_cart_values

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get POS report payments.

Returns data for POS report payments.

GET /pos_get_report_payments

$ curl -X GET https://core.expozy.com/api/admin/pos_get_report_payments

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get POS client.

Returns data for POS client.

GET /pos_client

$ curl -X GET https://core.expozy.com/api/admin/pos_client

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a new POS client.

Add a new or update an existing POS (Point of Sale) client (if you just wish to update, please include your POS client ID.

POST /pos_client

$ curl -X POST https://core.expozy.com/api/admin/pos_client

Example Body

{
  "ime": "string",
  "familiq": "string",
  "telefon": "string",
  "bulstat": "string",
  "discount": "string",
  "grad": "string",
  "adres": "string",
  "id": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get POS cashier register data.

Returns data for POS cashier register.

GET /pos_kasa

$ curl -X GET https://core.expozy.com/api/admin/pos_kasa

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post POS kasa

Add or close a POS kasa (cash register).

POST /pos_kasa

$ curl -X POST https://core.expozy.com/api/admin/pos_kasa

Example Body

{
  "close": 7853
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get POS objects data.

Returns data for all POS objects.

GET /pos_objects

$ curl -X GET https://core.expozy.com/api/admin/pos_objects

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get POS objects data.

Returns data a POS object specified by ID.

GET /pos_objects/:id

$ curl -X GET https://core.expozy.com/api/admin/pos_objects/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get POS remark tags data.

Returns data for POS remark tags.

GET /pos_remark_tags

$ curl -X GET https://core.expozy.com/api/admin/pos_remark_tags

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get POS products by category.

Returns data for POS products by category.

GET /pos_products_by_category

$ curl -X GET https://core.expozy.com/api/admin/pos_products_by_category?categoryId=8682

Parameters

  • categoryId

    ID of the category

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Initialize products for POS.

Initializes products for POS.

GET /pos_init_products

$ curl -X GET https://core.expozy.com/api/admin/pos_init_products

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Populate POS products.

Populates data for POS products.

GET /pos_populate_products

$ curl -X GET https://core.expozy.com/api/admin/pos_populate_products

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Add product to POS cart.

Add product to POS cart.

POST /pos_add_to_cart

$ curl -X POST https://core.expozy.com/api/admin/pos_add_to_cart

Example Body

{
  "productId": 9330
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Process POS order

Process a POS order with payment details.

POST /pos_order

$ curl -X POST https://core.expozy.com/api/admin/pos_order

Example Body

{
  "discount": 2036.1285897087455,
  "payment_method": "string",
  "plateno": 2228.0869322999665,
  "resto": 1721.6824737658264,
  "clientId": 5972
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post a new POS object.

Add a new POS (Point of Sale) object.

POST /pos_object

$ curl -X POST https://core.expozy.com/api/admin/pos_object

Example Body

{
  "title": "string",
  "code": "string",
  "invoice_start": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post remark tags

Add remark tags.

POST /remark_tags

$ curl -X POST https://core.expozy.com/api/admin/remark_tags

Example Body

{
  "tags": [
    "string",
    "string"
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Increase product quantity

Increade product quantity

PUT /pos_increase_product_qty

$ curl -X PUT https://core.expozy.com/api/admin/pos_increase_product_qty

Example Body

{
  "product_id": 4184,
  "qty": 6748
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Apply discount

Apply discount on a Point of Sale

PUT /pos_apply_discount

$ curl -X PUT https://core.expozy.com/api/admin/pos_apply_discount

Example Body

{
  "discount": 5946
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Update cart values

Update cart values

PUT /pos_cart_values

$ curl -X PUT https://core.expozy.com/api/admin/pos_cart_values

Example Body

{
  "discount": 7404
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

List NPOS stations (DataTable)

GET /api/datatable/npos_stations

$ curl -X GET /api/datatable/npos_stations?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List POS objects (DataTable)

GET /api/datatable/hotel_pos_objects

$ curl -X GET /api/datatable/hotel_pos_objects?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List POS tables (DataTable)

Rows include `object` and `warehouse` info.

GET /api/datatable/npos_tables

$ curl -X GET /api/datatable/npos_tables?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List POS bills (DataTable)

Rows include `user` info.

GET /api/datatable/npos_bills

$ curl -X GET /api/datatable/npos_bills?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List fiscal printers (DataTable)

GET /api/datatable/fpPrinters

$ curl -X GET /api/datatable/fpPrinters?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Delete POS cart items

Delete POS cart items or entire cart.

DELETE /pos_carts/:id

$ curl -X DELETE https://core.expozy.com/api/admin/pos_carts/:id?clientId=string&deleteCart=true

Parameters

  • id

    ID of the object

  • clientId

    Client ID

  • deleteCart

    Delete entire cart

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a POS table

Delete a POS table specified by ID.

DELETE /pos_tables/:id

$ curl -X DELETE https://core.expozy.com/api/admin/pos_tables/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete or cancel a new POS bill

Delete or cancel a new POS bill, company, client, or voucher specified by ID.

DELETE /npos_bills/:id

$ curl -X DELETE https://core.expozy.com/api/admin/npos_bills/:id?company=true&client=true&voucher=true

Parameters

  • id

    ID of the object

  • company

    Delete company

  • client

    Delete client

  • voucher

    Delete voucher

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a new POS order item

Delete a new POS order item specified by ID.

DELETE /npos_order_items/:id

$ curl -X DELETE https://core.expozy.com/api/admin/npos_order_items/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a new POS cart item

Delete a new POS cart item specified by ID.

DELETE /npos_carts_items/:id

$ curl -X DELETE https://core.expozy.com/api/admin/npos_carts_items/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a new POS station

Delete a new POS station specified by ID.

DELETE /npos_stations/:id

$ curl -X DELETE https://core.expozy.com/api/admin/npos_stations/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Edit POS cart

Adds/changes a cart line for a variation.

PUT /pos_carts

$ curl -X PUT https://core.expozy.com/api/admin/pos_carts

Example Body

{
  "variation_id": 1736,
  "qty": 2725.665461200588,
  "clientId": "string"
}

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

400 Bad Request Example Response

401 Unauthorized Example Response

Post POS cart items

Add items to POS cart.

POST /pos_carts

$ curl -X POST https://core.expozy.com/api/admin/pos_carts

Example Body

{
  "product_id": 4511,
  "quantity": 9829,
  "qty": 1087,
  "variation_id": 3379
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post POS tables

Add or edit POS tables.

POST /pos_tables

$ curl -X POST https://core.expozy.com/api/admin/pos_tables

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Reverse Auction

Delete an auction

Delete an auction specified by ID.

DELETE /auction/:id

$ curl -X DELETE https://core.expozy.com/api/admin/auction/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete an auction step

Delete an auction step specified by ID.

DELETE /auction_step/:id

$ curl -X DELETE https://core.expozy.com/api/admin/auction_step/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get products from auctions.

Return auction products.

GET /auction

$ curl -X GET https://core.expozy.com/api/admin/auction

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a new auction.

Create a new auction for a given product.

POST /auction

$ curl -X POST https://core.expozy.com/api/admin/auction

Example Body

{
  "product_id": 5416
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get auctions steps.

Return auction steps.

GET /auction_steps

$ curl -X GET https://core.expozy.com/api/admin/auction_steps

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get auctions step.

Return auction step.

GET /auction_steps/:id

$ curl -X GET https://core.expozy.com/api/admin/auction_steps/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Add or edit an auction step.

Add or edit an auction step.

POST /auction_step

$ curl -X POST https://core.expozy.com/api/admin/auction_step

Example Body

{
  "title": 7052,
  "days": "string",
  "percent": "string",
  "id": 5522
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

TODO

Delete a TODO task

Delete a TODO task specified by ID.

DELETE /todo/:id

$ curl -X DELETE https://core.expozy.com/api/admin/todo/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get TODO list data.

Returns TODO list data.

GET /todo

$ curl -X GET https://core.expozy.com/api/admin/todo

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a new TODO task.

Create a new TODO task or update an existing one.

POST /todo

$ curl -X POST https://core.expozy.com/api/admin/todo

Example Body

{
  "body": "string",
  "finished": true
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Finish a TODO task.

Finish a TODO task.

POST /toggle_todo

$ curl -X POST https://core.expozy.com/api/admin/toggle_todo

Example Body

{
  "id": 2948
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Comments

Delete a comment

Delete a comment specified by ID.

DELETE /comment/:id

$ curl -X DELETE https://core.expozy.com/api/admin/comment/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Edit a comment or ban a commenter based on commentId.

Edit a comment or ban a commenter based on commentId.

POST /comments

$ curl -X POST https://core.expozy.com/api/admin/comments

Example Body

null

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Same as /comments

Edit a comment or ban a commenter based on commentId.

POST /reviews

$ curl -X POST https://core.expozy.com/api/admin/reviews

Example Body

null

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

List comments (DataTable)

GET /api/datatable/comments

$ curl -X GET /api/datatable/comments?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Currencies

Get currencies data.

Returns currencies data for a given ID.

GET /currencies/:id

$ curl -X GET https://core.expozy.com/api/admin/currencies/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a currency

Delete a currency specified by ID.

DELETE /currencies/:id

$ curl -X DELETE https://core.expozy.com/api/admin/currencies/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get currencies data.

Returns currencies data.

GET /currencies

$ curl -X GET https://core.expozy.com/api/admin/currencies?default=true&value=2038

Parameters

  • default

    If present, display the default currency

  • value

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a currency.

Add a new currency or update an existing one. If `default` or `auto_upd` are not specified, `value` must be included.

POST /currencies

$ curl -X POST https://core.expozy.com/api/admin/currencies

Example Body

{
  "code": "string",
  "symbol": "string",
  "default": "string",
  "auto_upd": "string",
  "value": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Units

Get units data.

Returns data for a single unit specified by ID.

GET /units/:id

$ curl -X GET https://core.expozy.com/api/admin/units/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a unit

Delete a unit specified by ID.

DELETE /units/:id

$ curl -X DELETE https://core.expozy.com/api/admin/units/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get units data.

Returns data for all units

GET /units

$ curl -X GET https://core.expozy.com/api/admin/units

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post units.

Add or edit shop units.

POST /units

$ curl -X POST https://core.expozy.com/api/admin/units

Example Body

{
  "id": 1716,
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Ads

Get ads data.

Returns ads data for an ID specified in the path.

GET /ads/:id

$ curl -X GET https://core.expozy.com/api/admin/ads/:id

Parameters

  • id

    If present, return data for this object.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete an ad

Delete an ad specified by ID.

DELETE /ads/:id

$ curl -X DELETE https://core.expozy.com/api/admin/ads/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get ads types.

Returns ads types for all ads or for an ID specified in the path.

GET /ads_types/:id

$ curl -X GET https://core.expozy.com/api/admin/ads_types/:id?ad_id=8682

Parameters

  • id

    If present, return data for this object.

  • ad_id

    If id is present in the path, restrict results for this ID

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete an ad type

Delete an ad type specified by ID.

DELETE /ads_types/:id

$ curl -X DELETE https://core.expozy.com/api/admin/ads_types/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get ads fields data.

Returns ads fields data for an ID specified in the path.

GET /ads_fields/:id

$ curl -X GET https://core.expozy.com/api/admin/ads_fields/:id

Parameters

  • id

    If present, return data for this object.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete an ad field or only an ad field option

Delete an ad field or only an ad field option specified by ID.

DELETE /ads_fields/:id

$ curl -X DELETE https://core.expozy.com/api/admin/ads_fields/:id?option=true

Parameters

  • id

    ID of the object

  • option

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get ads statuses data.

Returns ads statuses data for an ID specified in the path.

GET /ads_statuses/:id

$ curl -X GET https://core.expozy.com/api/admin/ads_statuses/:id

Parameters

  • id

    If present, return data for this object.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete an ad status

Delete an ad status specified by ID.

DELETE /ads_statuses/:id

$ curl -X DELETE https://core.expozy.com/api/admin/ads_statuses/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete an ad image

Delete an ad image specified by ID.

DELETE /ads_images/:id

$ curl -X DELETE https://core.expozy.com/api/admin/ads_images/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get ad plans.

Returns ad plans data for an ID specified in the path.

GET /ads_plans/:id

$ curl -X GET https://core.expozy.com/api/admin/ads_plans/:id

Parameters

  • id

    If present, return data for this object.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete an ad plan

Delete an ad plan specified by ID.

DELETE /ads_plans/:id

$ curl -X DELETE https://core.expozy.com/api/admin/ads_plans/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete an ad subscription

Delete an ad subscription specified by ID.

DELETE /ads_subscriptions/:id

$ curl -X DELETE https://core.expozy.com/api/admin/ads_subscriptions/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get ads dashboard statistics.

Returns ads dashboard statistics data for orders, pages or users as specified in query parameters. If not specified, defaults to pages. Query parameters are mutually exlcusive.

GET /dashboard_statistics

$ curl -X GET https://core.expozy.com/api/admin/dashboard_statistics?orders=true&pages=true&users=true

Parameters

  • orders

    If present, return order statistics

  • pages

    If present, return page statistics

  • users

    If present, return user statistics

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get ads types.

Returns ads types for all ads.

GET /ads_types

$ curl -X GET https://core.expozy.com/api/admin/ads_types

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post an ad type.

Add or edit an ad type.

POST /ads_types

$ curl -X POST https://core.expozy.com/api/admin/ads_types

Example Body

{
  "title": "string",
  "fields": [
    "string",
    "string"
  ],
  "required_fields": [
    "string",
    "string"
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get ads data.

Returns ads data for all ads filtered by query parameters.

GET /ads

$ curl -X GET https://core.expozy.com/api/admin/ads?search=string&admin_search=2038&type=2038&status=2038&user=2038&category=2038&only_vip=2038&options=string

Parameters

  • search

    Keywords to search for

  • admin_search

  • type

  • status

  • user

  • category

  • only_vip

  • options

    Comma-delimited list of options, e.g. 1,2,3,4

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post an ad.

Add or edit an ad, supports image upload.

POST /ads

$ curl -X POST https://core.expozy.com/api/admin/ads

Example Body

{
  "title": "string",
  "description": "string",
  "status_id": 5101,
  "type_id": 3033,
  "category_id": 6025,
  "subtitle": "string",
  "tags": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get ads fields data.

Returns ads fields data for all ads.

GET /ads_fields

$ curl -X GET https://core.expozy.com/api/admin/ads_fields?type_id=8682

Parameters

  • type_id

    Return data for this ad type.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post ad fields.

Add or edit ad fields.

POST /ads_fields

$ curl -X POST https://core.expozy.com/api/admin/ads_fields

Example Body

{
  "title": "string",
  "type": "string",
  "option": [
    "string",
    "string"
  ],
  "ex_option": [
    {
      "description": "Example must be replaced with the example field and the value corresponding to it must be the option",
      "type": "string"
    },
    {
      "description": "Example must be replaced with the example field and the value corresponding to it must be the option",
      "type": "string"
    }
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get ads fields types data.

Note: Not implemented. Returns ads fields types data for all ads or for an ID specified in the path.

GET /ads_fields_types

$ curl -X GET https://core.expozy.com/api/admin/ads_fields_types

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get ads statuses data.

Returns ads statuses data for all ads.

GET /ads_statuses

$ curl -X GET https://core.expozy.com/api/admin/ads_statuses

Parameters

  • id

    If present, return data for this object.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post an ad status

Add an ad status.

POST /ads_statuses

$ curl -X POST https://core.expozy.com/api/admin/ads_statuses

Example Body

{
  "title": "string",
  "ad_type": 9940
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get ads categories.

Returns ads categories data for all ads. If list is specified, group in a sorted list. If `dropList` is specified, group by according to the following 4 arguments that must be supplied.

GET /ads_categories

$ curl -X GET https://core.expozy.com/api/admin/ads_categories?list=true&dropList=string&spacer=string&level=8682&parent_id=8682&selected=true

Parameters

  • list

    Return data in a sorted list.

  • dropList

    Return data in a sorted list based on the following mandatory parameters.

  • spacer

    Spacer

  • level

    Type

  • parent_id

    Id of parent

  • selected

    Selected

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a new ad category

Add a new ad category.

POST /ads_categories

$ curl -X POST https://core.expozy.com/api/admin/ads_categories

Example Body

{
  "title": "string",
  "parent_id": 2066,
  "active": 4755,
  "slug": "string",
  "description": "string",
  "url": "string",
  "cat_paths": [
    "string",
    "string"
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get ads categories.

Returns ads categories data for an ID specified in the path.

GET /ads_categories/:id

$ curl -X GET https://core.expozy.com/api/admin/ads_categories/:id

Parameters

  • id

    Return data for the selected project.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete an ad category

Delete an ad category specified by ID.

DELETE /ads_categories/:id

$ curl -X DELETE https://core.expozy.com/api/admin/ads_categories/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get ad plans.

Returns ad plans data for all ad.

GET /ads_plans

$ curl -X GET https://core.expozy.com/api/admin/ads_plans

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post ad plans.

Add or edit ad plans.

POST /ads_plans

$ curl -X POST https://core.expozy.com/api/admin/ads_plans

Example Body

{
  "title": "string",
  "time": "string",
  "option": [
    "string",
    "string"
  ],
  "ex_option": [
    {
      "description": "Example must be replaced with the example field and the value corresponding to it must be the option",
      "type": "string"
    },
    {
      "description": "Example must be replaced with the example field and the value corresponding to it must be the option",
      "type": "string"
    }
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post an ad subscription.

Add an ad subscripion.

POST /ads_subscriptions

$ curl -X POST https://core.expozy.com/api/admin/ads_subscriptions

Example Body

{
  "ad_id": 8615,
  "plan_id": 4679
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

List ad fields (DataTable)

GET /api/datatable/ads_fields

$ curl -X GET /api/datatable/ads_fields?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List ads (DataTable)

GET /api/datatable/ads

$ curl -X GET /api/datatable/ads?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List ad statuses (DataTable)

GET /api/datatable/ads_statuses

$ curl -X GET /api/datatable/ads_statuses?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List ad subscriptions (DataTable)

Rows include `ads` reference.

GET /api/datatable/ads_subscriptions

$ curl -X GET /api/datatable/ads_subscriptions?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List ad types (DataTable)

GET /api/datatable/ads_types

$ curl -X GET /api/datatable/ads_types?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List ad plans (DataTable)

GET /api/datatable/ads_plans

$ curl -X GET /api/datatable/ads_plans?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Delete an ad field value

Delete an ad field value by ad ID and field ID.

DELETE /ads_fields_values

$ curl -X DELETE https://core.expozy.com/api/admin/ads_fields_values?ad_id=2038&field_id=2038

Parameters

  • ad_id

    Ad ID

  • field_id

    Field ID

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete an ad field option

Delete an ad field option specified by ID.

DELETE /ads_fields_options/:id

$ curl -X DELETE https://core.expozy.com/api/admin/ads_fields_options/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

QA

Get QA data.

Returns QA data for all shops.

GET /qa/:id

$ curl -X GET https://core.expozy.com/api/admin/qa/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a QA

Delete a QA entry specified by ID.

DELETE /qa/:id

$ curl -X DELETE https://core.expozy.com/api/admin/qa/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get QA data.

Returns QA data for all shops.

GET /qa

$ curl -X GET https://core.expozy.com/api/admin/qa?status=8682&visible=8682

Parameters

  • status

  • visible

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Edit a QA

Edit a QA

PUT /qa

$ curl -X PUT https://core.expozy.com/api/admin/qa

Example Body

{
  "id": 2948
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post a new QA.

Add or edit a QA.

POST /qa

$ curl -X POST https://core.expozy.com/api/admin/qa

Example Body

{
  "parent_id": 7292,
  "text": "string",
  "product_id": 7426,
  "id": 9971,
  "user_id": 5269,
  "user_name": "string",
  "date": "1992-09-05",
  "visible": 1541,
  "subject": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

List Q&A entries (DataTable)

GET /api/datatable/qa

$ curl -X GET /api/datatable/qa?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Database

Get regions data.

Returns region data for an ID specified in the path.

GET /regions/:id

$ curl -X GET https://core.expozy.com/api/admin/regions/:id

Parameters

  • id

    If present, return data for this object.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a region

Delete a region specified by ID.

DELETE /regions/:id

$ curl -X DELETE https://core.expozy.com/api/admin/regions/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get countries data.

Returns data for all countries.

GET /countries

$ curl -X GET https://core.expozy.com/api/admin/countries?region=string

Parameters

  • region

    Filter by countries, EU as value is allowed.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Update a country

Update a country data.

POST /countries

$ curl -X POST https://core.expozy.com/api/admin/countries

Example Body

{
  "vat": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get countries data.

Returns data for a country specified by ID in path.

GET /countries/:id

$ curl -X GET https://core.expozy.com/api/admin/countries/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get regions data.

Returns region data for all regions.

GET /regions

$ curl -X GET https://core.expozy.com/api/admin/regions

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a region

Add or update a region.

POST /regions

$ curl -X POST https://core.expozy.com/api/admin/regions

Example Body

{
  "title": "string",
  "percent": 4181,
  "show_vat": 4601
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post images

Post images.

POST /images

$ curl -X POST https://core.expozy.com/api/admin/images

Example Body

{
  "path": "string",
  "base64": "string",
  "vat": "string",
  "filename": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Misc

Get partner data.

Returns data for a partner with ID specified in the path.

GET /partners/:id

$ curl -X GET https://core.expozy.com/api/admin/partners/:id

Parameters

  • id

    Return data for this object.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a partner or a partner's image

Delete a partner or a partner's image specified by ID.

DELETE /partners/:id

$ curl -X DELETE https://core.expozy.com/api/admin/partners/:id?deleteImage=true

Parameters

  • id

    ID of the object

  • deleteImage

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get search replacement data.

Returns search replacement data with ID specified in path.

GET /search/:id

$ curl -X GET https://core.expozy.com/api/admin/search/:id

Parameters

  • id

    Return data for this object.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a search replacement

Delete a search replacement specified by ID.

DELETE /search/:id

$ curl -X DELETE https://core.expozy.com/api/admin/search/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get timeslots.

Returns data for timeslots associated with an ID specified in the path.

GET /timeslots/:id

$ curl -X GET https://core.expozy.com/api/admin/timeslots/:id

Parameters

  • id

    Return data for this object.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Delete a timeslot

Delete a timeslot specified by ID.

DELETE /timeslots/:id

$ curl -X DELETE https://core.expozy.com/api/admin/timeslots/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get partner data.

Returns data for all partners.

GET /partners

$ curl -X GET https://core.expozy.com/api/admin/partners

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post partner data

Add or edit partner data (supports image attachments).

POST /partners

$ curl -X POST https://core.expozy.com/api/admin/partners

Example Body

{
  "title": "string",
  "obj": {}
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get timeslots.

Returns data for warehouse timeslots.

GET /timeslots

$ curl -X GET https://core.expozy.com/api/admin/timeslots?warehouse_id=2038&day=2038

Parameters

  • warehouse_id

  • day

    Filter to day hours

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post timeslots for a warehouse

Add timeslot data for a warehouse.

POST /timeslots

$ curl -X POST https://core.expozy.com/api/admin/timeslots

Example Body

{
  "start": "string",
  "end": "string",
  "warehouse_id": 6881,
  "quantity": 8734,
  "price": 7794,
  "free_shipping": 6898,
  "day0": 4035,
  "day1": 393,
  "day2": 701,
  "day3": 920,
  "day4": 419,
  "day5": 5750,
  "day6": 3329
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Sort product items

Sort product items

POST /products_order

$ curl -X POST https://core.expozy.com/api/admin/products_order

Example Body

[
  {
    "": {
      "title": "product_id"
    }
  },
  {
    "": {
      "title": "product_id"
    }
  }
]

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post search data

Perform search with replacement

POST /search

$ curl -X POST https://core.expozy.com/api/admin/search

Example Body

{
  "original": [
    "string",
    "string"
  ],
  "replacement": [
    "string",
    "string"
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post timeslots for a warehouse

Add timeslot data for a warehouse.

POST /memberMailchimp

$ curl -X POST https://core.expozy.com/api/admin/memberMailchimp

Example Body

{
  "start": "string",
  "end": "string",
  "warehouse_id": 343,
  "quantity": 3726,
  "price": 7786,
  "free_shipping": 8112
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Core

Toggle a system message on and off

POST /system_messages/:id

$ curl -X POST https://core.expozy.com/api/admin/system_messages/:id

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a system message

Delete a system message specified by ID.

DELETE /system_messages/:id

$ curl -X DELETE https://core.expozy.com/api/admin/system_messages/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get settings data

Returns all or select few of the settings.

GET /settings

$ curl -X GET https://core.expozy.com/api/admin/settings?full=true

Parameters

  • full

    Return all settings, otherwise will return a shortened description.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post new app settings.

Create new app settings.

POST /settings

$ curl -X POST https://core.expozy.com/api/admin/settings

Example Body

{
  "site_name": "string",
  "site_url": "string",
  "site_email": "string",
  "commenting": "string",
  "facebook_page": "string",
  "facebook_appID": "string",
  "google_analytics": "string",
  "company": "string",
  "city": "string",
  "address": "string",
  "eik": "string",
  "code": "string",
  "results_perpage_products": "string",
  "results_perpage_posts": "string",
  "quantity_alert": "string",
  "google_ua": "string",
  "apikey": "string",
  "split_order": 6383,
  "maintenance_mode": 2125,
  "smtp_host": "string",
  "smtp_port": "string",
  "smtp_user": "string",
  "smtp_pass": "string",
  "smtp_from_address": "string",
  "price_with_vat": "string",
  "products_default_weight": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get web settings data

Returns all or select few of the settings.

GET /settings_web

$ curl -X GET https://core.expozy.com/api/admin/settings_web?full=true

Parameters

  • full

    Return all settings, otherwise will return a shortened description.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post web settings

Add or edit web settings data (can include logo and favicon in POST body).

POST /settings_web

$ curl -X POST https://core.expozy.com/api/admin/settings_web

Example Body

{
  "scripts": {
    "header": "string",
    "footer": "string"
  },
  "links": {
    "facebook": "string",
    "twitter": "string",
    "youtube": "string",
    "instagram": "string"
  }
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get modules settings data

Return modules settings data. Note: key is required.

GET /modules_settings

$ curl -X GET https://core.expozy.com/api/admin/modules_settings?key=8682

Parameters

  • key

    Return data for the item corresponding to the ID.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get modules

Returns modules

GET /modules

$ curl -X GET https://core.expozy.com/api/admin/modules

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get new modules

Returns modules

GET /modules_new

$ curl -X GET https://core.expozy.com/api/admin/modules_new

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get all return statuses.

Returns all product return statuses.

GET /return_statuses

$ curl -X GET https://core.expozy.com/api/admin/return_statuses

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get available data for couriers.

Returns all couriers or a courier specified by ID.

GET /couriers

$ curl -X GET https://core.expozy.com/api/admin/couriers

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get available data for couriers.

Returns a courier specified by ID.

GET /couriers/:id

$ curl -X GET https://core.expozy.com/api/admin/couriers/:id

Parameters

  • id

    Return data for the item corresponding to the ID.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post integrations.

Post integrations.

POST /integrations

$ curl -X POST https://core.expozy.com/api/admin/integrations

Example Body

{
  "code1": "string",
  "status": "string",
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get current dev config. Returns plugins for page specified by URL or defaults to returning menus.

GET /dev_config

$ curl -X GET https://core.expozy.com/api/admin/dev_config?page_url=8682

Parameters

  • page_url

    Get page plugins for this page.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get current site's SAAS status.

GET /saas

$ curl -X GET https://core.expozy.com/api/admin/saas

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get SAAS data for site.

Returns SAAS data for the site ID specified in the path.

GET /saas/:id

$ curl -X GET https://core.expozy.com/api/admin/saas/:id

Parameters

  • id

    If present, return data for this object.

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get system messages

GET /system_messages

$ curl -X GET https://core.expozy.com/api/admin/system_messages?unreaded=true

Parameters

  • unreaded

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get templates for system messages

GET /system_messages_templates

$ curl -X GET https://core.expozy.com/api/admin/system_messages_templates

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Get templates for system messages

GET /system_messages_templates/:id

$ curl -X GET https://core.expozy.com/api/admin/system_messages_templates/:id

Parameters

  • id

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Start SAAS setup

Start SAAS setup.

POST /saas_setup

$ curl -X POST https://core.expozy.com/api/admin/saas_setup

Example Body

{
  "first_name": "string",
  "last_name": "string",
  "address": "string",
  "code": "string",
  "city": "string",
  "country": "string",
  "phone": "string",
  "other_website": "string",
  "info": [
    "string",
    "string"
  ],
  "are-you-selling": "string",
  "how-do-you-want-to-sell": "string",
  "which-system-do-you-use-the-most": "string",
  "current-revenue": "string",
  "industry": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

List timeslots (DataTable)

GET /api/datatable/timeslots

$ curl -X GET /api/datatable/timeslots?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List admin logs (DataTable)

GET /api/datatable/logs

$ curl -X GET /api/datatable/logs?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List external request logs (DataTable)

GET /api/datatable/logs_request

$ curl -X GET /api/datatable/logs_request?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Post company information

Add or edit company information.

POST /company

$ curl -X POST https://core.expozy.com/api/admin/company

Example Body

{
  "name": "string",
  "address": "string",
  "city": "string",
  "country": "string",
  "vat": "string",
  "phone": "string",
  "email": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post frontend settings

Configure frontend settings.

POST /frontend

$ curl -X POST https://core.expozy.com/api/admin/frontend

Example Body

{
  "theme": "string",
  "layout": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get SAAS free status

Retrieve SAAS free tier status.

POST /saas_free

$ curl -X POST https://core.expozy.com/api/admin/saas_free

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post API keys

Add or edit API keys.

POST /keys

$ curl -X POST https://core.expozy.com/api/admin/keys

Example Body

{
  "key": "string",
  "description": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post other settings

Configure additional integration settings.

POST /settings_other

$ curl -X POST https://core.expozy.com/api/admin/settings_other

Example Body

{
  "xsender_apikey": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post revisions

Manage content revisions (restore, view, or create).

POST /revisions

$ curl -X POST https://core.expozy.com/api/admin/revisions

Example Body

{
  "revision_id": 1382,
  "restore": 1839
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Messages

Get messages data

Returns all messages or a message by ID.

GET /messages

$ curl -X GET https://core.expozy.com/api/admin/messages?only_new=true

Parameters

  • only_new

    Return only new messages

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a new message.

Send a new message or answer to an existing conversation (message `id` is required).

POST /messages

$ curl -X POST https://core.expozy.com/api/admin/messages

Example Body

{
  "receiver_id": 6218,
  "subject": "string",
  "message": "string",
  "id": 3032
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get message data

Returns a message by ID or the message history corresponding to the messages.

GET /messages/:id

$ curl -X GET https://core.expozy.com/api/admin/messages/:id?grouped=true

Parameters

  • id

    ID of the object

  • grouped

    Return grouped messages referencing the message

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Reply to a message.

Send a new message to an existing conversation.

POST /reply_message

$ curl -X POST https://core.expozy.com/api/admin/reply_message

Example Body

{
  "group_id": 2468,
  "message": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Cookies

Returns cookie data (banner, content, data, etc.)

GET /cookie

$ curl -X GET https://core.expozy.com/api/admin/cookie

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post cookies.

Edit cookies.

POST /cookie

$ curl -X POST https://core.expozy.com/api/admin/cookie

Example Body

{
  "position": "string",
  "layout": "string",
  "banner_color": "string",
  "banner_text_color": "string",
  "btn_color": "string",
  "btn_text_color": "string",
  "url_policy": "string",
  "message": "string",
  "btn_accept": "string",
  "policy_text": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Newsletter

Get newsletters data.

Returns data for all newsletters.

GET /newsletters

$ curl -X GET https://core.expozy.com/api/admin/newsletters?sort_by_user=true

Parameters

  • sort_by_user

    If present, sort by user

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a newsletter.

Add or edit a newsletter.

POST /newsletters

$ curl -X POST https://core.expozy.com/api/admin/newsletters

Example Body

{
  "title": "string",
  "send_to": 4651,
  "group_id": "string",
  "user_ids": "string",
  "body": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get newsletters data.

Returns data for a newsletter specified by ID.

GET /newsletters/:id

$ curl -X GET https://core.expozy.com/api/admin/newsletters/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

400 Bad Request Example Response

{
  "status": 837,
  "msg": "string"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post a newsletters group.

Add or edit a newsletters group.

POST /newslettersGroup

$ curl -X POST https://core.expozy.com/api/admin/newslettersGroup

Example Body

{
  "id": 5941,
  "name": "string",
  "email_ids": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

List newsletter email schemes (DataTable)

GET /api/datatable/newsletter_email

$ curl -X GET /api/datatable/newsletter_email?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List newsletter users (DataTable)

GET /api/datatable/newsletter_users

$ curl -X GET /api/datatable/newsletter_users?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Delete a newsletter user

Delete a newsletter user specified by ID.

DELETE /newsletter_users/:id

$ curl -X DELETE https://core.expozy.com/api/admin/newsletter_users/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Couriers

Get data for Econt.

Returns settings for Econt

GET /econt

$ curl -X GET https://core.expozy.com/api/admin/econt

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post ECONT settings

Add or edit ECONT settings.

POST /econt

$ curl -X POST https://core.expozy.com/api/admin/econt

Example Body

{
  "username": "string",
  "password": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Get data for Speedy.

Returns settings for Speedy

GET /speedy

$ curl -X GET https://core.expozy.com/api/admin/speedy

200 OK Example Response

{
  "description": "A JSON object or an array of objects"
}

404 Not Found Example Response

{
  "status": 837,
  "msg": "string"
}

Post Speedy settings

Add or edit Speedy settings.

POST /speedy

$ curl -X POST https://core.expozy.com/api/admin/speedy

Example Body

{
  "username": "string",
  "password": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post Sameday courier settings

Configure Sameday courier integration.

POST /sameday

$ curl -X POST https://core.expozy.com/api/admin/sameday

Example Body

{
  "username": "string",
  "password": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

CSV

Post a CSV preview

Post a CSV preview. (a CSV file).

POST /csv_preview

$ curl -X POST https://core.expozy.com/api/admin/csv_preview

Example Body

{
  "name": "filename.csv",
  "tmp_name": "temp_filename.csv"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post a CSV file

Import a CSV file.

POST /csvimport

$ curl -X POST https://core.expozy.com/api/admin/csvimport

Example Body

{
  "filename": "string",
  "rows": [
    "string",
    "string"
  ]
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post a CSV file

Import a CSV file.

POST /login

$ curl -X POST https://core.expozy.com/api/admin/login

Example Body

{
  "email": "string",
  "password": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Wallets

Post a new wallet.

Create a new wallet.

POST /wallets

$ curl -X POST https://core.expozy.com/api/admin/wallets

Example Body

{
  "user_id": 8234,
  "tokens": 7657
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post a new wallet setting.

Update wallet settings. Changes the wallet to be *active* for specific use cases: `active` can be one of `allprodcuts`, `amount`, `unit`, or `nothing`.

POST /wallets_settings

$ curl -X POST https://core.expozy.com/api/admin/wallets_settings

Example Body

{
  "status": 2947,
  "tokens": 5554,
  "active": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post user wallet

Update user wallet information.

POST /usersWallets/:id

$ curl -X POST https://core.expozy.com/api/admin/usersWallets/:id

Example Body

{
  "user_id": 1859
}

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post user wallet deposit

Add deposit to user wallet.

POST /usersWallets_deposit

$ curl -X POST https://core.expozy.com/api/admin/usersWallets_deposit

Example Body

{
  "user_id": 7205,
  "amount": 3201.0379377662625
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Talents

Post talents.

Add a new talent. CV with tag `cv` can be uploaded along with the request body

POST /talents

$ curl -X POST https://core.expozy.com/api/admin/talents

Example Body

{
  "name": "string",
  "position": "string",
  "stack": "string",
  "level": "string",
  "type": "string",
  "experience": "string",
  "internalId": "string",
  "active": 2331
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Billing

List invoices (DataTable)

Admin DataTable endpoints (read/list). All endpoints accept the common DataTable query params.

GET /api/datatable/invoice

$ curl -X GET /api/datatable/invoice?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List proforms (DataTable)

GET /api/datatable/proforms

$ curl -X GET /api/datatable/proforms?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List protocols (DataTable)

GET /api/datatable/protocols

$ curl -X GET /api/datatable/protocols?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List storno invoices (DataTable)

GET /api/datatable/storno

$ curl -X GET /api/datatable/storno?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Warehouse

List product movement (DataTable)

Rows include `warehouse_title`, `provider_title`, `product_title`, and `id_code`.

GET /api/datatable/product_movement

$ curl -X GET /api/datatable/product_movement?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List supply requests (DataTable)

GET /api/datatable/wh_supply_request

$ curl -X GET /api/datatable/wh_supply_request?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List inventory (DataTable)

GET /api/datatable/wh_inventory

$ curl -X GET /api/datatable/wh_inventory?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List warehouse racks (DataTable)

GET /api/datatable/wh_racks

$ curl -X GET /api/datatable/wh_racks?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List warehouse rows (DataTable)

GET /api/datatable/wh_rows

$ curl -X GET /api/datatable/wh_rows?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List warehouses (DataTable)

GET /api/datatable/wh_warehouse

$ curl -X GET /api/datatable/wh_warehouse?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List warehouse delivery statuses (DataTable)

GET /api/datatable/wh_delivery_status

$ curl -X GET /api/datatable/wh_delivery_status?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List warehouse delivery rates (DataTable)

Rows include resolved `warehouse` and `location` info.

GET /api/datatable/wh_warehouse_delivery_rate

$ curl -X GET /api/datatable/wh_warehouse_delivery_rate?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List provider delivery rates (DataTable)

Rows include resolved `provider` info.

GET /api/datatable/wh_provider_delivery_rate

$ curl -X GET /api/datatable/wh_provider_delivery_rate?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List supplies/chargings (DataTable)

GET /api/datatable/wh_supply

$ curl -X GET /api/datatable/wh_supply?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List stock (DataTable)

Reserved endpoint.

GET /api/datatable/wh_stock

$ curl -X GET /api/datatable/wh_stock?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List warehouse returns (DataTable)

GET /api/datatable/wh_returns

$ curl -X GET /api/datatable/wh_returns?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List warehouse locations (DataTable)

GET /api/datatable/wh_locations

$ curl -X GET /api/datatable/wh_locations?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Notifications

List app notification templates (DataTable)

GET /api/datatable/appNotifyTemplates

$ curl -X GET /api/datatable/appNotifyTemplates?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List system message templates (DataTable)

GET /api/datatable/messages_system_templates

$ curl -X GET /api/datatable/messages_system_templates?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List system notifications (DataTable)

GET /api/datatable/notifications

$ curl -X GET /api/datatable/notifications?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Contacts

List contacts (DataTable)

GET /api/datatable/contacts

$ curl -X GET /api/datatable/contacts?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Finance

List deposits (DataTable)

Rows include `user_info`.

GET /api/datatable/deposit

$ curl -X GET /api/datatable/deposit?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List deposit plans (DataTable)

GET /api/datatable/depositPlans

$ curl -X GET /api/datatable/depositPlans?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List withdraw requests (DataTable)

Rows include `user` info.

GET /api/datatable/withdraw

$ curl -X GET /api/datatable/withdraw?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List vouchers (DataTable)

GET /api/datatable/vouchers

$ curl -X GET /api/datatable/vouchers?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Delete a deposit

Delete a deposit specified by ID.

DELETE /deposits/:id

$ curl -X DELETE https://core.expozy.com/api/admin/deposits/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a deposit plan

Delete a deposit plan specified by ID.

DELETE /depositsPlans/:id

$ curl -X DELETE https://core.expozy.com/api/admin/depositsPlans/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a withdrawal

Delete a withdrawal specified by ID.

DELETE /withdraw/:id

$ curl -X DELETE https://core.expozy.com/api/admin/withdraw/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Mail

List email log (DataTable)

GET /api/datatable/emailLog

$ curl -X GET /api/datatable/emailLog?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Experience

List experience cancellation policies (DataTable)

GET /api/datatable/experience_cancellationPolicies

$ curl -X GET /api/datatable/experience_cancellationPolicies?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List experience provided items (DataTable)

GET /api/datatable/experience_items

$ curl -X GET /api/datatable/experience_items?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List experience payments (DataTable)

Rows include `user_info`.

GET /api/datatable/experience_payments

$ curl -X GET /api/datatable/experience_payments?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List experiences (Admin, DataTable)

Admin-only listing, includes `user_token`.

GET /api/datatable/experience

$ curl -X GET /api/datatable/experience?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List experience reservations (DataTable)

GET /api/datatable/experience_reservations

$ curl -X GET /api/datatable/experience_reservations?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List experience statuses (DataTable)

GET /api/datatable/experience_statuses

$ curl -X GET /api/datatable/experience_statuses?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List experience types (DataTable)

GET /api/datatable/experience_types

$ curl -X GET /api/datatable/experience_types?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Delete an experience type image

Delete an experience type image specified by ID.

DELETE /experience_type_images/:id

$ curl -X DELETE https://core.expozy.com/api/admin/experience_type_images/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete an experience type

Delete an experience type specified by ID.

DELETE /experience_types/:id

$ curl -X DELETE https://core.expozy.com/api/admin/experience_types/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post experience items

Add or edit experience provided items.

POST /experience_items

$ curl -X POST https://core.expozy.com/api/admin/experience_items

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post experience cancellation policies

Add or edit experience cancellation policies.

POST /experience_cancellationPolicies

$ curl -X POST https://core.expozy.com/api/admin/experience_cancellationPolicies

Example Body

{
  "title": "string",
  "description": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

FAQ

List FAQs (DataTable)

GET /api/datatable/faq

$ curl -X GET /api/datatable/faq?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Delete a FAQ entry

Delete a FAQ entry specified by ID.

DELETE /faq/:id

$ curl -X DELETE https://core.expozy.com/api/admin/faq/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post FAQ entries

Add or edit FAQ entries.

POST /faq

$ curl -X POST https://core.expozy.com/api/admin/faq

Example Body

{
  "question": "string",
  "answer": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Hotel

List hotel agents (DataTable)

Rows include `company` info.

GET /api/datatable/hotel_agents

$ curl -X GET /api/datatable/hotel_agents?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel cancellation policies (DataTable)

GET /api/datatable/hotel_cancellationPolicies

$ curl -X GET /api/datatable/hotel_cancellationPolicies?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel contracts (DataTable)

Rows include `agent` info.

GET /api/datatable/hotel_contracts

$ curl -X GET /api/datatable/hotel_contracts?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel ESTI registrations (DataTable)

Rows include computed `esti_nomer`, `passport_country_code`, price per night, and normalized `date_checkin/checkout`.

GET /api/datatable/hotel_esti

$ curl -X GET /api/datatable/hotel_esti?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel feedings (DataTable)

GET /api/datatable/hotel_feedings

$ curl -X GET /api/datatable/hotel_feedings?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel feeding types (DataTable)

GET /api/datatable/hotel_feedings_types

$ curl -X GET /api/datatable/hotel_feedings_types?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List housekeeping features (DataTable)

GET /api/datatable/hotel_housekeepingFeatures

$ curl -X GET /api/datatable/hotel_housekeepingFeatures?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel invoices (DataTable)

Rows include `operators` extracted from reservations.

GET /api/datatable/hotel_invoice

$ curl -X GET /api/datatable/hotel_invoice?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel reservation logs (DataTable)

Rows include prepared `show` text.

GET /api/datatable/hotel_logs

$ curl -X GET /api/datatable/hotel_logs?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel marketing channels (DataTable)

GET /api/datatable/hotel_marketingChannels

$ curl -X GET /api/datatable/hotel_marketingChannels?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel marketing sources (DataTable)

GET /api/datatable/hotel_marketingSource

$ curl -X GET /api/datatable/hotel_marketingSource?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel online blocks (DataTable)

GET /api/datatable/hotel_onlineBlock

$ curl -X GET /api/datatable/hotel_onlineBlock?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel payments (DataTable)

Rows include linked `room` info.

GET /api/datatable/hotel_payments

$ curl -X GET /api/datatable/hotel_payments?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel proforms (DataTable)

GET /api/datatable/hotel_proform

$ curl -X GET /api/datatable/hotel_proform?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List Quendoo import errors (DataTable)

Rows include `agent`, mapped `room`, and `bs_ota_booking_id`.

GET /api/datatable/hotel_quendo_errors

$ curl -X GET /api/datatable/hotel_quendo_errors?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel reservations (DataTable)

Rows include computed `for_paid`, `clean_text`, `event_title`, and HTML `buttons`.

GET /api/datatable/hotel_reservations

$ curl -X GET /api/datatable/hotel_reservations?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel reservation events (DataTable)

Rows include `company`, `agent`, and combined `period`.

GET /api/datatable/hotel_reservationsEvent

$ curl -X GET /api/datatable/hotel_reservationsEvent?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel restaurants (DataTable)

GET /api/datatable/hotel_restaurants

$ curl -X GET /api/datatable/hotel_restaurants?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel room types (DataTable)

GET /api/datatable/hotel_room_types

$ curl -X GET /api/datatable/hotel_room_types?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel room properties (DataTable)

GET /api/datatable/hotel_roomproperties

$ curl -X GET /api/datatable/hotel_roomproperties?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List room blocks (DataTable)

GET /api/datatable/hotel_rooms_block

$ curl -X GET /api/datatable/hotel_rooms_block?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel rooms (DataTable)

GET /api/datatable/hotel_rooms

$ curl -X GET /api/datatable/hotel_rooms?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel services (DataTable)

GET /api/datatable/hotel_services

$ curl -X GET /api/datatable/hotel_services?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel service groups (DataTable)

GET /api/datatable/hotel_servicesGroup

$ curl -X GET /api/datatable/hotel_servicesGroup?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List hotel storno invoices (DataTable)

GET /api/datatable/hotel_storno

$ curl -X GET /api/datatable/hotel_storno?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Reservations report (DataTable)

GET /api/datatable/hotel_reports_reservations

$ curl -X GET /api/datatable/hotel_reports_reservations?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Delete a hotel room type image

Delete a hotel room type image specified by ID.

DELETE /hotel_type_images/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_type_images/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a hotel room type

Delete a hotel room type specified by ID.

DELETE /hotel_types/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_types/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a hotel contract season

Delete a hotel contract season specified by ID.

DELETE /hotel_seasons/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_seasons/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a hotel contract

Delete a hotel contract specified by ID.

DELETE /hotel_contracts/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_contracts/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a hotel feeding

Delete a hotel feeding specified by ID.

DELETE /hotel_feedings/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_feedings/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a hotel service

Delete a hotel service specified by ID.

DELETE /hotel_services/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_services/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel cancellation policies

Update hotel cancellation policies.

POST /hotel_cancellationPolicies/:id

$ curl -X POST https://core.expozy.com/api/admin/hotel_cancellationPolicies/:id

Example Body

{
  "title": "string",
  "description": "string"
}

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a hotel cancellation policy

Delete a hotel cancellation policy specified by ID.

DELETE /hotel_cancellationPolicies/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_cancellationPolicies/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a hotel reservation

Delete a hotel reservation specified by ID.

DELETE /hotel_reservations/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_reservations/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a hotel services group

Delete a hotel services group specified by ID.

DELETE /hotel_servicesGroup/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_servicesGroup/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a hotel agent

Delete a hotel agent specified by ID.

DELETE /hotel_agents/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_agents/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete hotel room properties

Delete hotel room properties specified by ID.

DELETE /hotel_roomProperties/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_roomProperties/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a hotel online block

Delete a hotel online block specified by ID.

DELETE /hotel_onlineBlock/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_onlineBlock/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a hotel feeding type

Delete a hotel feeding type specified by ID.

DELETE /hotel_feedings_types/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_feedings_types/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a hotel contract age group

Delete a hotel contract age group specified by ID.

DELETE /hotel_age_groups/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_age_groups/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete hotel contract prices

Delete hotel contract prices specified by ID.

DELETE /hotel_contracts_in_prices/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_contracts_in_prices/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete hotel contract specific settings

Delete hotel contract specific settings specified by ID.

DELETE /hotel_contracts_in_specific/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_contracts_in_specific/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete hotel contract free nights

Delete hotel contract free nights specified by ID.

DELETE /hotel_contracts_in_freeNights/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_contracts_in_freeNights/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete hotel contract discounts

Delete hotel contract discounts specified by ID.

DELETE /hotel_contracts_in_discounts/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_contracts_in_discounts/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete hotel contract package services

Delete hotel contract package services specified by ID.

DELETE /hotel_contracts_in_packageServices/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_contracts_in_packageServices/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete hotel contract package holidays

Delete hotel contract package holidays specified by ID.

DELETE /hotel_contracts_in_packageHolidays/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_contracts_in_packageHolidays/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a hotel room block

Delete a hotel room block specified by ID.

DELETE /hotel_rooms_block/:id

$ curl -X DELETE https://core.expozy.com/api/admin/hotel_rooms_block/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel room types

Add or edit hotel room types.

POST /hotel_types

$ curl -X POST https://core.expozy.com/api/admin/hotel_types

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel rooms

Add or edit hotel rooms or toggle clean status.

POST /hotel_rooms

$ curl -X POST https://core.expozy.com/api/admin/hotel_rooms

Example Body

{
  "clean_toggle": 341
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel contracts

Add or edit hotel contracts.

POST /hotel_contracts

$ curl -X POST https://core.expozy.com/api/admin/hotel_contracts

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel feedings

Add or edit hotel feeding options.

POST /hotel_feedings

$ curl -X POST https://core.expozy.com/api/admin/hotel_feedings

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel feeding types

Add or edit hotel feeding types.

POST /hotel_feedings_types

$ curl -X POST https://core.expozy.com/api/admin/hotel_feedings_types

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel services

Add or edit hotel services.

POST /hotel_services

$ curl -X POST https://core.expozy.com/api/admin/hotel_services

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel reservation events

Add or manage hotel reservation events.

POST /hotel_reservations_event

$ curl -X POST https://core.expozy.com/api/admin/hotel_reservations_event

Example Body

{
  "reservationEvent_id": 1933,
  "activate_all": 304
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel reservations

Add or manage hotel reservations.

POST /hotel_reservations

$ curl -X POST https://core.expozy.com/api/admin/hotel_reservations

Example Body

{
  "reservation_id": 4954,
  "daily_price": 869
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel service groups

Add or edit hotel service groups.

POST /hotel_servicesGroup

$ curl -X POST https://core.expozy.com/api/admin/hotel_servicesGroup

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel agents

Add or edit hotel agents.

POST /hotel_agents

$ curl -X POST https://core.expozy.com/api/admin/hotel_agents

Example Body

{
  "title": "string",
  "email": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel clients

Add or edit hotel clients.

POST /hotel_clients

$ curl -X POST https://core.expozy.com/api/admin/hotel_clients

Example Body

{
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "phone": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel payments

Add or edit hotel reservation payments.

POST /hotel_payments

$ curl -X POST https://core.expozy.com/api/admin/hotel_payments

Example Body

{
  "id": 9460
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel room properties

Add or edit hotel room properties.

POST /hotel_roomProperties

$ curl -X POST https://core.expozy.com/api/admin/hotel_roomProperties

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel settings

Update hotel settings.

POST /hotel_settings

$ curl -X POST https://core.expozy.com/api/admin/hotel_settings

Example Body

{
  "web": 6737
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel housekeeping features

Add or edit hotel housekeeping features.

POST /hotel_housekeepingFeatures

$ curl -X POST https://core.expozy.com/api/admin/hotel_housekeepingFeatures

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel online block

Create online booking block period.

POST /hotel_onlineBlock

$ curl -X POST https://core.expozy.com/api/admin/hotel_onlineBlock

Example Body

{
  "date_start": "string",
  "date_end": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post Quendoo room types

Configure Quendoo channel manager room types.

POST /quendoo_types

$ curl -X POST https://core.expozy.com/api/admin/quendoo_types

Example Body

{
  "type_id": 5768,
  "quendoo_type_id": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post Quendoo agents mapping

Configure Quendoo agent mappings.

POST /quendoo_agents

$ curl -X POST https://core.expozy.com/api/admin/quendoo_agents

Example Body

{
  "agent_id": 714,
  "quendoo_agent_id": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post Quendoo import operations

Manage Quendoo import operations.

POST /quendoo_import

$ curl -X POST https://core.expozy.com/api/admin/quendoo_import

Example Body

{
  "compact": 9824
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post Quendoo settings

Configure Quendoo channel manager settings.

POST /quendoo_settings

$ curl -X POST https://core.expozy.com/api/admin/quendoo_settings

Example Body

{
  "api_key": "string",
  "hotel_id": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel restaurants

Add or edit hotel restaurants.

POST /hotel_restaurants

$ curl -X POST https://core.expozy.com/api/admin/hotel_restaurants

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel Expozy PMS mappings

Configure hotel Expozy PMS room type mappings.

POST /hotel_expozyPms

$ curl -X POST https://core.expozy.com/api/admin/hotel_expozyPms

Example Body

{
  "type_id": 3814,
  "expozy_type_id": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel data import

Import hotel data from CSV files.

POST /hotel_import

$ curl -X POST https://core.expozy.com/api/admin/hotel_import

Example Body

{
  "file": "string",
  "step": "1"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel marketing sources

Add or edit hotel marketing sources.

POST /hotel_marketingSource

$ curl -X POST https://core.expozy.com/api/admin/hotel_marketingSource

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel marketing channels

Add or edit hotel marketing channels.

POST /hotel_marketingChannels

$ curl -X POST https://core.expozy.com/api/admin/hotel_marketingChannels

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel age groups

Add or edit hotel contract age groups.

POST /hotel_age_groups

$ curl -X POST https://core.expozy.com/api/admin/hotel_age_groups

Example Body

{
  "title": "string",
  "age_max": 3261,
  "contract_id": 7501
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel seasons

Add or edit hotel contract seasons.

POST /hotel_seasons

$ curl -X POST https://core.expozy.com/api/admin/hotel_seasons

Example Body

{
  "title": "string",
  "periods": [],
  "contract_id": 2781
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel contract prices

Configure hotel contract pricing.

POST /hotel_contracts_in_prices

$ curl -X POST https://core.expozy.com/api/admin/hotel_contracts_in_prices

Example Body

{
  "type_id": 4947,
  "prices": [],
  "contract_id": 1685
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel contract feedings

Configure hotel contract feeding prices.

POST /hotel_contracts_in_feedings

$ curl -X POST https://core.expozy.com/api/admin/hotel_contracts_in_feedings

Example Body

{
  "feeding_id": 4260,
  "prices": [],
  "contract_id": 7931
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel contract specific conditions

Add specific conditions to hotel contracts.

POST /hotel_contracts_in_specific

$ curl -X POST https://core.expozy.com/api/admin/hotel_contracts_in_specific

Example Body

{
  "text": "string",
  "type_id": 7018,
  "contract_id": 9925
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel contract free nights

Configure free nights in hotel contracts.

POST /hotel_contracts_in_freeNights

$ curl -X POST https://core.expozy.com/api/admin/hotel_contracts_in_freeNights

Example Body

{
  "text": "string",
  "type_id": 7018,
  "contract_id": 9925
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel contract discounts

Configure discounts in hotel contracts.

POST /hotel_contracts_in_discounts

$ curl -X POST https://core.expozy.com/api/admin/hotel_contracts_in_discounts

Example Body

{
  "text": "string",
  "type_id": 7018,
  "contract_id": 9925
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel contract package services

Configure package services in hotel contracts.

POST /hotel_contracts_in_packageServices

$ curl -X POST https://core.expozy.com/api/admin/hotel_contracts_in_packageServices

Example Body

{
  "on_id": 495,
  "prices": [],
  "contract_id": 7152
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel contract package holidays

Configure package holidays in hotel contracts.

POST /hotel_contracts_in_packageHolidays

$ curl -X POST https://core.expozy.com/api/admin/hotel_contracts_in_packageHolidays

Example Body

{
  "for_id": 2150,
  "contract_id": 5711
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Send hotel confirmation email

Send hotel reservation confirmation email.

POST /hotel_email

$ curl -X POST https://core.expozy.com/api/admin/hotel_email

Example Body

{
  "email": "string",
  "reservation_id": 300
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post hotel room block

Block hotel rooms for specific period.

POST /hotel_rooms_block

$ curl -X POST https://core.expozy.com/api/admin/hotel_rooms_block

Example Body

{
  "room_id": 5983,
  "date_start": "string",
  "date_end": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Users

List user wallets (DataTable)

Rows include `user_info`.

GET /api/datatable/usersWallets

$ curl -X GET /api/datatable/usersWallets?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List user groups (DataTable)

GET /api/datatable/users_groups

$ curl -X GET /api/datatable/users_groups?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List users (DataTable)

Rows include resolved `level`.

GET /api/datatable/users

$ curl -X GET /api/datatable/users?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List user wallet transactions (DataTable)

GET /api/datatable/usersWallets_transactions

$ curl -X GET /api/datatable/usersWallets_transactions?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List user favorites (DataTable)

Rows include favorited `product`.

GET /api/datatable/users_favorites

$ curl -X GET /api/datatable/users_favorites?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List user spoken languages (DataTable)

GET /api/datatable/users_spokenLanguages

$ curl -X GET /api/datatable/users_spokenLanguages?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Marketplace

List marketplace sellers (DataTable)

GET /api/datatable/marketplace_sellers

$ curl -X GET /api/datatable/marketplace_sellers?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Delete a marketplace seller

Delete a marketplace seller specified by ID.

DELETE /marketplace_sellers/:id

$ curl -X DELETE https://core.expozy.com/api/admin/marketplace_sellers/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post marketplace sellers

Add or edit marketplace sellers.

POST /marketplace_sellers

$ curl -X POST https://core.expozy.com/api/admin/marketplace_sellers

Example Body

{
  "title": "string",
  "email": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Meetings

List meeting calendars (DataTable)

GET /api/datatable/meeting_calendars

$ curl -X GET /api/datatable/meeting_calendars?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Delete a meeting calendar

Delete a meeting calendar specified by ID.

DELETE /meeting_calendars/:id

$ curl -X DELETE https://core.expozy.com/api/admin/meeting_calendars/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post meeting calendars

Add or edit meeting calendars.

POST /meeting_calendars

$ curl -X POST https://core.expozy.com/api/admin/meeting_calendars

Example Body

{
  "title": "string",
  "interval": 4283,
  "link": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Partners

List partners (DataTable)

GET /api/datatable/partners

$ curl -X GET /api/datatable/partners?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Rental

List rental cancellation policies (DataTable)

GET /api/datatable/rental_cancellationPolicies

$ curl -X GET /api/datatable/rental_cancellationPolicies?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List rental charges (DataTable)

GET /api/datatable/rental_charges

$ curl -X GET /api/datatable/rental_charges?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List rental fields (DataTable)

Rows include `group` and `group_type`.

GET /api/datatable/rental_fields

$ curl -X GET /api/datatable/rental_fields?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List rental field groups (DataTable)

Rows include `group_type`.

GET /api/datatable/rental_fieldsGroups

$ curl -X GET /api/datatable/rental_fieldsGroups?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List rental hosts (DataTable)

GET /api/datatable/rental_hosts

$ curl -X GET /api/datatable/rental_hosts?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List rental payments (DataTable)

Rows include `user_info`.

GET /api/datatable/rental_payments

$ curl -X GET /api/datatable/rental_payments?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List rentals (DataTable)

Admin listing of rentals; rows include `user_token`.

GET /api/datatable/rental

$ curl -X GET /api/datatable/rental?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List rental reservations (DataTable)

Rows include `rental_title`, `rental_type`, and `host_amount`.

GET /api/datatable/rental_reservations

$ curl -X GET /api/datatable/rental_reservations?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List rental statuses (DataTable)

GET /api/datatable/rental_statuses

$ curl -X GET /api/datatable/rental_statuses?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List rental types (DataTable)

GET /api/datatable/rental_types

$ curl -X GET /api/datatable/rental_types?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Post rental status change

Change rental status.

POST /rental/:id

$ curl -X POST https://core.expozy.com/api/admin/rental/:id

Example Body

{
  "status_id": 2960
}

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a rental

Delete a rental specified by ID.

DELETE /rental/:id

$ curl -X DELETE https://core.expozy.com/api/admin/rental/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a rental type

Delete a rental type specified by ID.

DELETE /rental_types/:id

$ curl -X DELETE https://core.expozy.com/api/admin/rental_types/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a rental field or rental field option

Delete a rental field or rental field option specified by ID.

DELETE /rental_fields/:id

$ curl -X DELETE https://core.expozy.com/api/admin/rental_fields/:id?option=true

Parameters

  • id

    ID of the object

  • option

    Delete only the option

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a rental field value

Delete a rental field value by property ID and field ID.

DELETE /rental_fields_values

$ curl -X DELETE https://core.expozy.com/api/admin/rental_fields_values?ad_id=2038&field_id=2038

Parameters

  • ad_id

    Property ID

  • field_id

    Field ID

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a rental field option

Delete a rental field option specified by ID.

DELETE /rental_fields_options/:id

$ curl -X DELETE https://core.expozy.com/api/admin/rental_fields_options/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a rental status

Delete a rental status specified by ID.

DELETE /rental_statuses/:id

$ curl -X DELETE https://core.expozy.com/api/admin/rental_statuses/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a rental image

Delete a rental image specified by ID.

DELETE /rental_images/:id

$ curl -X DELETE https://core.expozy.com/api/admin/rental_images/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a rental charge

Delete a rental rates charge specified by ID.

DELETE /rental_charges/:id

$ curl -X DELETE https://core.expozy.com/api/admin/rental_charges/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a rental fields group

Delete a rental fields group specified by ID.

DELETE /rental_fields_groups/:id

$ curl -X DELETE https://core.expozy.com/api/admin/rental_fields_groups/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a rental type image

Delete a rental type image specified by ID.

DELETE /rental_type_images/:id

$ curl -X DELETE https://core.expozy.com/api/admin/rental_type_images/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post rental settings

Update rental settings.

POST /rental_settings

$ curl -X POST https://core.expozy.com/api/admin/rental_settings

Example Body

{
  "commission_host": 6864.813414703594,
  "commission_client": 9026.898036330418
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post rental types

Add or edit rental types.

POST /rental_types

$ curl -X POST https://core.expozy.com/api/admin/rental_types

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post rental fields

Add or edit rental fields.

POST /rental_fields

$ curl -X POST https://core.expozy.com/api/admin/rental_fields

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post rental statuses

Add or edit rental statuses.

POST /rental_statuses

$ curl -X POST https://core.expozy.com/api/admin/rental_statuses

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post rental field groups

Add or edit rental field groups.

POST /rental_fields_goups

$ curl -X POST https://core.expozy.com/api/admin/rental_fields_goups

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post rental charges

Add or edit rental charges.

POST /rental_charges

$ curl -X POST https://core.expozy.com/api/admin/rental_charges

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post rental cancellation policies

Update rental cancellation policies.

POST /rental_cancellationPolicies/:id

$ curl -X POST https://core.expozy.com/api/admin/rental_cancellationPolicies/:id

Example Body

{
  "title": "string",
  "description": "string"
}

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Search

List search events (DataTable)

Rows include `user_info`.

GET /api/datatable/search_all

$ curl -X GET /api/datatable/search_all?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List boosted search categories (DataTable)

GET /api/datatable/search_boostedCategories

$ curl -X GET /api/datatable/search_boostedCategories?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List boosted search products (DataTable)

GET /api/datatable/search_boostedProducts

$ curl -X GET /api/datatable/search_boostedProducts?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List searches with no results (DataTable)

GET /api/datatable/search_noResults

$ curl -X GET /api/datatable/search_noResults?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List search replacements (DataTable)

GET /api/datatable/search_replacement

$ curl -X GET /api/datatable/search_replacement?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

List searched words (DataTable)

GET /api/datatable/search_word

$ curl -X GET /api/datatable/search_word?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

SMS

List SMS templates (DataTable)

GET /api/datatable/sms_templates

$ curl -X GET /api/datatable/sms_templates?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Post SMS templates

Add or edit SMS templates.

POST /sms_templates

$ curl -X POST https://core.expozy.com/api/admin/sms_templates

Example Body

{
  "title": "string",
  "description": "string",
  "templateid": 4917
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Templates

List email templates (DataTable)

GET /api/datatable/templates

$ curl -X GET /api/datatable/templates?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Import

List Expozy import channels (DataTable)

GET /api/datatable/expozyImport

$ curl -X GET /api/datatable/expozyImport?start=6826&length=6337&search=string&order_by=string&order_dir=desc&filters=string

Parameters

  • start

    Offset for paging (DataTable).

  • length

    Page size (DataTable).

  • search

    Global search query.

  • order_by

    Order by column.

  • order_dir

    Order direction.

  • filters

    JSON-encoded filters.

200 OK Example Response

{
  "recordsTotal": 3165,
  "recordsFiltered": 1144,
  "start": 443,
  "length": 6457,
  "page": 8209,
  "pages": 160,
  "key_0": 8409,
  "key_1": "string"
}

Delete an Expozy import channel

Delete an Expozy import channel specified by ID.

DELETE /expozyImport/:id

$ curl -X DELETE https://core.expozy.com/api/admin/expozyImport/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a Quendoo import error

Delete a Quendoo import error specified by ID.

DELETE /quendoo_import/:id

$ curl -X DELETE https://core.expozy.com/api/admin/quendoo_import/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Revisions

Delete a revision

Delete a revision specified by ID.

DELETE /revisions/:id

$ curl -X DELETE https://core.expozy.com/api/admin/revisions/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Events

Delete an events email scheme

Delete an events email scheme specified by ID.

DELETE /events_emails/:id

$ curl -X DELETE https://core.expozy.com/api/admin/events_emails/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post event email templates

Add or edit event email templates.

POST /events_emails

$ curl -X POST https://core.expozy.com/api/admin/events_emails

Example Body

{
  "title": "string",
  "subject": "string",
  "body": "string",
  "event": 3570,
  "days": 1021
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Storage

Delete S3 files

Delete selected files from S3 storage.

DELETE /s3

$ curl -X DELETE https://core.expozy.com/api/admin/s3?selectedItems=string&selectedItems=string&folderPath=string

Parameters

  • selectedItems

    Array of selected items

  • selectedItems

    Array of selected items

  • folderPath

    Folder path

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

NPOS

Post new POS cart item updates

Update specific cart items in new POS system.

POST /npos_carts_items/:id

$ curl -X POST https://core.expozy.com/api/admin/npos_carts_items/:id

Example Body

{
  "discount": 9763,
  "percent": 6580.4997020462715
}

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post new POS order

Create a new POS order in the new POS system.

POST /npos_order

$ curl -X POST https://core.expozy.com/api/admin/npos_order

Example Body

{
  "table_id": 7644,
  "products_qty": [],
  "bill_id": 1481
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post new POS cart items

Add items to new POS cart or apply discounts.

POST /npos_carts

$ curl -X POST https://core.expozy.com/api/admin/npos_carts

Example Body

{
  "discount": 9763,
  "percent": 6580.4997020462715
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post new POS bill operations

Manage new POS bill operations including discounts, payments, and closures.

POST /npos_bill/:id

$ curl -X POST https://core.expozy.com/api/admin/npos_bill/:id

Example Body

{
  "discount": 9763,
  "percent": 6580.4997020462715
}

Parameters

  • id

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post new POS shift operations

Manage new POS shift operations (open/close).

POST /npos_shifts

$ curl -X POST https://core.expozy.com/api/admin/npos_shifts

Example Body

{
  "finish": 9057
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post new POS order item operations

Manage new POS order items (transfer, cancel).

POST /npos_order_items

$ curl -X POST https://core.expozy.com/api/admin/npos_order_items

Example Body

{
  "items": [],
  "transfer": 2798
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post new POS tables

Add or edit new POS tables.

POST /npos_tables

$ curl -X POST https://core.expozy.com/api/admin/npos_tables

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post new POS objects

Add or edit new POS objects.

POST /npos_objects

$ curl -X POST https://core.expozy.com/api/admin/npos_objects

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post new POS settings

Configure new POS system settings.

POST /npos_settings

$ curl -X POST https://core.expozy.com/api/admin/npos_settings

Example Body

{
  "setting_key": "string",
  "setting_value": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post new POS invoice

Create invoice for new POS bill.

POST /npos_invoice

$ curl -X POST https://core.expozy.com/api/admin/npos_invoice

Example Body

{
  "bill_id": 5041
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post new POS bill item operations

Cancel new POS bill items.

POST /npos_bill_items

$ curl -X POST https://core.expozy.com/api/admin/npos_bill_items

Example Body

{
  "cancel_id": 3581,
  "qty": 4868
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post new POS stations

Add or edit new POS stations.

POST /npos_stations

$ curl -X POST https://core.expozy.com/api/admin/npos_stations

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Invoice

Delete an invoice

Delete an invoice specified by ID.

DELETE /invoice/:id

$ curl -X DELETE https://core.expozy.com/api/admin/invoice/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete an invoice item

Delete an invoice item specified by ID.

DELETE /invoices_items/:id

$ curl -X DELETE https://core.expozy.com/api/admin/invoices_items/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete an invoice payment

Delete an invoice payment specified by ID.

DELETE /invoices_payments/:id

$ curl -X DELETE https://core.expozy.com/api/admin/invoices_payments/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Proform

Delete a proform

Delete a proform specified by ID.

DELETE /proforms/:id

$ curl -X DELETE https://core.expozy.com/api/admin/proforms/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Delete a proform item

Delete a proform item specified by ID.

DELETE /proforms_items/:id

$ curl -X DELETE https://core.expozy.com/api/admin/proforms_items/:id

Parameters

  • id

    ID of the object

200 OK Example Response

{
  "status": 1,
  "error": "string",
  "data": {
    "nullable": true
  }
}

Integrations

Post Releva integration settings

Configure Releva integration.

POST /releva

$ curl -X POST https://core.expozy.com/api/admin/releva

Example Body

{
  "access_token": "string",
  "secret_key": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post Releva pages

Add or edit Releva pages.

POST /releva_pages

$ curl -X POST https://core.expozy.com/api/admin/releva_pages

Example Body

{
  "title": "string",
  "token": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post HybridAuth configuration

Configure HybridAuth settings.

POST /hybridAuth

$ curl -X POST https://core.expozy.com/api/admin/hybridAuth

Example Body

{
  "provider": "string",
  "client_id": "string",
  "client_secret": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post OneSignal configuration

Configure OneSignal push notification settings.

POST /oneSignal

$ curl -X POST https://core.expozy.com/api/admin/oneSignal

Example Body

{
  "app_id": "string",
  "api_key": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post Expozy import operations

Manage Expozy import channels and synchronization.

POST /expozyImport

$ curl -X POST https://core.expozy.com/api/admin/expozyImport

Example Body

{
  "channel_id": 8774,
  "synch_cat": 5308
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Auction

Post auctions

Add or edit auctions.

POST /auctions

$ curl -X POST https://core.expozy.com/api/admin/auctions

Example Body

{
  "id": 8890,
  "title": "string",
  "description": "string",
  "start_price": 7199.735734927362,
  "date_start": "string",
  "date_end": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Surveys

Post surveys

Add or edit surveys.

POST /surveys

$ curl -X POST https://core.expozy.com/api/admin/surveys

Example Body

{
  "title": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Media

Generate AI image

Generate an image using AI based on description.

POST /generate_image

$ curl -X POST https://core.expozy.com/api/admin/generate_image

Example Body

{
  "description": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Deposits

Post deposit plans

Add or edit deposit plans.

POST /depositsPlans

$ curl -X POST https://core.expozy.com/api/admin/depositsPlans

Example Body

{
  "title": "string",
  "amount": 8283.668447578853,
  "percent_min": 3093.7162368194813,
  "percent_max": 3798.3152769805906
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post deposits

Add or edit deposits.

POST /deposits

$ curl -X POST https://core.expozy.com/api/admin/deposits

Example Body

{
  "amount": 3526.6342299154217,
  "plan_id": 2374,
  "user_id": 7730
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post withdrawal

Process a withdrawal request.

POST /withdraw

$ curl -X POST https://core.expozy.com/api/admin/withdraw

Example Body

{
  "user_id": 5313,
  "id": 752
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Fiscal

Post fiscal printer settings

Configure fiscal printer settings and operations.

POST /fpPrinters

$ curl -X POST https://core.expozy.com/api/admin/fpPrinters

Example Body

{
  "dailyreport_z": 4492
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Post fiscal printer VAT groups

Configure fiscal printer VAT groups.

POST /fpVats

$ curl -X POST https://core.expozy.com/api/admin/fpVats

Example Body

{
  "printerId": 4044,
  "group": "string"
}

200 OK Example Response

{
  "status": 1,
  "msg": "string",
  "error": "string",
  "data": {
    "nullable": true
  }
}

Totals

Get invoice totals

Returns aggregated totals for invoices. Accepts optional filters (e.g., date range).

GET /totals/invoice

$ curl -X GET https://core.expozy.com/api/admin/totals/invoice?date_from=1966-04-13&date_to=1966-04-13&status=string

Parameters

  • date_from

    Start date (Y-m-d)

  • date_to

    End date (Y-m-d)

  • status

    Status filter

200 OK Example Response

{
  "status": 0,
  "error": "string",
  "data": {}
}

400 Bad Request Example Response

401 Unauthorized Example Response

Get proform totals

Returns aggregated totals for proforms. Accepts optional filters (e.g., date range).

GET /totals/proforms

$ curl -X GET https://core.expozy.com/api/admin/totals/proforms?date_from=1966-04-13&date_to=1966-04-13&status=string

Parameters

  • date_from

    Start date (Y-m-d)

  • date_to

    End date (Y-m-d)

  • status

    Status filter

200 OK Example Response

{
  "status": 0,
  "error": "string",
  "data": {}
}

400 Bad Request Example Response

401 Unauthorized Example Response

Get protocol totals

Returns aggregated totals for protocols. Accepts optional filters (e.g., date range).

GET /totals/protocols

$ curl -X GET https://core.expozy.com/api/admin/totals/protocols?date_from=1966-04-13&date_to=1966-04-13&status=string

Parameters

  • date_from

    Start date (Y-m-d)

  • date_to

    End date (Y-m-d)

  • status

    Status filter

200 OK Example Response

{
  "status": 0,
  "error": "string",
  "data": {}
}

400 Bad Request Example Response

401 Unauthorized Example Response

Get storno totals

Returns aggregated totals for storno invoices. Accepts optional filters (e.g., date range).

GET /totals/storno

$ curl -X GET https://core.expozy.com/api/admin/totals/storno?date_from=1966-04-13&date_to=1966-04-13&status=string

Parameters

  • date_from

    Start date (Y-m-d)

  • date_to

    End date (Y-m-d)

  • status

    Status filter

200 OK Example Response

{
  "status": 0,
  "error": "string",
  "data": {}
}

400 Bad Request Example Response

401 Unauthorized Example Response

Get pages totals

Returns aggregated totals for pages. Accepts optional filters (e.g., date range).

GET /totals/pages

$ curl -X GET https://core.expozy.com/api/admin/totals/pages?date_from=1966-04-13&date_to=1966-04-13&status=string

Parameters

  • date_from

    Start date (Y-m-d)

  • date_to

    End date (Y-m-d)

  • status

    Status filter

200 OK Example Response

{
  "status": 0,
  "error": "string",
  "data": {}
}

400 Bad Request Example Response

401 Unauthorized Example Response

Expozy Structure

Expozy's admin structure is intended to provide a great starting point for both large and small projects. It's a combination of the API Core, the Admin Panel and your website's frontend.

Core

The Api Core is the place where all the control over the data in both admin panel and the website's frontend comes from, and it's highly opened for modifications.

It has a library of classes that determines the modules and all their methods. It also uses plugins and helpers for additional features.

The API methods that will be used in the Admin Panel and the Frontend are defined in the api folder in the specified subdirectory as a GET, POST, PUT or DELETE request.

Htaccess

.htaccess is a configuration file for use on web servers running the Apache Web Server software. These .htaccess files can be used to alter the configuration of the Apache Web Server software to enable/disable additional functionality and features that the Apache Web Server software has to offer.

Config

The configuration file is used to include global constants and initializations. For example, different path constants, localization settings, error logs directory, and so on. The Admin configuration file also gets the data for the current project and its database.

Datatables

DataTables is a plugin for the jQuery Javascript library. It is a highly flexible tool for filling HTML tables with data, and it's used with the Admin API in the admin panel.

Languages

The languages can be seen in the admin panel as a module where you can choose the languages your website is going to use. The modules that contain contents for the frontend (example: products, posts, pages) of the website can be edited in the admin panel while the chosen language is active. That will update the data that will be displayed as a translation for it. There are also language constants defined in json files that can be used.

Uploads

In the Core, you will also find the "uploads" folder which contains all the images uploaded to the server. It contains subfolders named with the projects' ID and a level deeper the images are sorted by modules.

curl