Documentation Powered by Redocly

Posiflora API (2022_16-v2)

Download OpenAPI specification:Download

Support: support@posiflora.com

Auth API

Create session

Creates new session and return access and refresh tokens.

query Parameters
include
Array of strings
Items Enum: "worker" "worker.position" "worker.user" "worker.user.roles" "worker.user.roles.permissions"

Comma-separated list of related resources that should be included into response

Request Body schema: application/vnd.api+json

Create access token request

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}

Refresh session

Refresh session and returns new access token.

query Parameters
include
Array of strings
Items Enum: "worker" "worker.position" "worker.user" "worker.user.roles" "worker.user.roles.permissions"

Comma-separated list of related resources that should be included into response

Request Body schema: application/vnd.api+json

Refresh session request

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}

Customers API

Get customers list

Returns list of customers according to specified params.

Authorizations:
BearerAuth
query Parameters
from
string <date-time>

Filter by customer update date. If specified return customers updated after specified time.

search
string

Search filter. Search customers by name, phone or bonus card number.

filter[idBonus]
string

Filter by bonus group.

filter[createdBy]
string

Filter by worker who registered customer.

filter[ordersCount][from]
integer <int32>

Filter by order number (min value).

filter[ordersCount][to]
integer <int32>

Filter by orders number (max value).

filter[discount]
string

Filter by discount group.

filter[moreBonus]
integer <int32>

Filter by bonuses amount (min value).

filter[lessBonus]
integer <int32>

Filter by bonuses amount (max value).

filter[moreAvg]
integer <int32>

Filter by average check (min value).

filter[lessAvg]
integer <int32>

Filter by average check (max value).

filter[create][from]
string <date>

Filter by customer registration date (start date).

filter[create][to]
string <date>

Filter by customer registration date (end date).

filter[birthday][from]
string <date>

Filter by customer birthday (start date).

filter[birthday][to]
string <date>

Filter by customer birthday (end date).

filter[buy][from]
string <date>

Filter by date of buys of customers (start date).

filter[buy][to]
string <date>

Filter by date of buys of customers (end date).

filter[notBuy][from]
string <date>

Filter buy customers who does not made any orders (start date)

filter[notBuy][to]
string <date>

Filter buy customers who does not made any orders (end date)

filter[celebrations]
string

Filter by customer celebrations (comma separated array of celebration IDS).

filter[preferences]
string

Filter by customer preferences (comma separated array of preference IDS).

filter[sources]
string

Filter by customer sources (comma separated array of customer source IDS).

filter[isPerson]
boolean

Filter by 'individual' customers.

filter[event][from]
string <date>

Filter by customer events (start date).

filter[event][to]
string <date>

Filter by customer events (end date).

filter[gender]
string
Enum: "male" "female"

Filter by gender.

filter[createdAt][from]
string <date>

Filter by created at (start date)

filter[createdAt][to]
string <date>

Filter by created at (end date)

filter[updatedAt][from]
string <date>

Filter by updated at (start date)

filter[updatedAt][to]
string <date>

Filter by updated at (start date)

filter[revision]
integer <int32>

Filter by customer revision (min value).

include
Array of strings
Items Enum: "person" "bonusGroup" "bonusGroup.rules" "discountGroups" "discountGroups.rules" "customerSources" "customerPreferences" "customerEvents" "createdBy"

Available entity includes.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}

Create customer

Creates new customer.

Authorizations:
BearerAuth
query Parameters
include
Array of strings
Items Enum: "person" "bonusGroup" "bonusGroup.rules" "discountGroups" "discountGroups.rules" "customerSources" "customerPreferences" "customerEvents" "createdBy"

Available entity includes.

Request Body schema: application/vnd.api+json

Customer data

object

Customer resource

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Bulk update customers

Update several customers data

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Bulk update customer data

Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Get customer

Returns information about customer with specified ID.

Authorizations:
BearerAuth
path Parameters
id
required
string

Customer ID

query Parameters
include
Array of strings
Items Enum: "person" "bonusGroup" "bonusGroup.rules" "discountGroups" "discountGroups.rules" "customerSources" "customerPreferences" "customerEvents" "createdBy"

Available entity includes.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": {
    }
}

Update customer

Updates customer with specified ID.

Authorizations:
BearerAuth
path Parameters
id
required
string

Customer ID

query Parameters
include
Array of strings
Items Enum: "person" "bonusGroup" "bonusGroup.rules" "discountGroups" "discountGroups.rules" "customerSources" "customerPreferences" "customerEvents" "createdBy"

Available entity includes.

Request Body schema: application/vnd.api+json

Update customer data

object

Customer resource

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": {
    }
}

Customer bonus history

Returns history for customer bonuses.

Authorizations:
BearerAuth
path Parameters
id
required
string

Customer ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Bulk attach discount group to customers

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Discount groups data

Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Filter phone numbers by their presence in the Customer table

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Phone numbers data

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Customers import API

Import customers

Imports customer from a custom csv file.

Authorizations:
BearerAuth
Request Body schema: multipart/form-data

Import data

file
string <binary>

file

format
string
Default: "csv"
Enum: "csv" "xls" "xlsx" "ods"

File format

delimiter
string
Default: ","

Columns delimiter

ignoreFirst
integer
Default: 1
Enum: 0 1

Responses

Request samples

Content type
multipart/form-data
{
  "file": "(binary)",
  "format": "csv",
  "delimiter": ",",
  "ignoreFirst": 1
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get imports list

List of created imports.

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Get import

Get import info.

Authorizations:
BearerAuth
path Parameters
id
required
string

Import ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete import

Delete import.

Authorizations:
BearerAuth
path Parameters
id
required
string

Import ID

Responses

Response samples

Content type
application/vnd.api+json
{ }

Validate import

Map fields from file to customers fields.

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Validation import data

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Customer Stats API

Get customer stats

Get customers stats during specific period.

Authorizations:
BearerAuth
path Parameters
id
required
string

Customer ID

query Parameters
filter[startDate]
string <date>

Filter by date (start date)

filter[endDate]
string <date>

Filter by date (end date)

filter[format]
string
Enum: "year" "month" "week" "day"

Group by period

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Get stats for all customers

Get stats during specific period for all customers.

Authorizations:
BearerAuth
query Parameters
filter[rangeFrom]
string <date>

Filter by date (start date)

filter[rangeTo]
string <date>

Filter by date (end date)

filter[range]
string
Enum: "year" "month" "week" "day"

Group by period

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Customer preferences API

Get customer preferences list

Returns list of customers preferences.

Authorizations:
BearerAuth
query Parameters
filter[onlyActive]
boolean

Filter by active custom preferences (show deleted or not).

filter[revision]
integer <int32>

Filter by customer preferences revision (min value).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create customer preference

Creates new customer preference.

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Create customer preference

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete customer preferences

Delete customer preferences

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Delete customer preference data

Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{ }

Update customer preference

Updates customer preference.

Authorizations:
BearerAuth
path Parameters
id
required
string

Customer preference ID

Request Body schema: application/vnd.api+json

Update customer preference

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Customer Sources API

Get customer sources list

Returns list of customers sources.

Authorizations:
BearerAuth
query Parameters
filter[disabled]
boolean

Filter by active custom preferences (show deleted or not).

filter[revision]
integer <int32>

Filter by customer preferences revision (min value).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create customer source

Creates new customer source.

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Create customer source

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete customer sources

Delete customer sources

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Update customer source

Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{ }

Update customer source

Updates customer source.

Authorizations:
BearerAuth
path Parameters
id
required
string

Customer source ID

Request Body schema: application/vnd.api+json

Customer data

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Customer Celebrations API

Get customer celebrations list

Returns list of customers celebrations.

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ],
  • "included": [
    ]
}

Create customer celebration

Creates new customer celebration.

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Customer celebration data

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete customer celebration

Deletes customer celebration.

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Delete customer celebration data

Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{ }

Get customer celebration

Get info about customer celebration.

Authorizations:
BearerAuth
path Parameters
id
required
string

Celebration ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update customer celebration

Updates customer celebration.

Authorizations:
BearerAuth
path Parameters
id
required
string

Celebration ID

Request Body schema: application/vnd.api+json

Update customer celebration data

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get customers celebrations dates

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Customer Events API

Get customer events

Authorizations:
BearerAuth
query Parameters
filter[customer]
string <date>

Filter by customer

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create customer event

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Create customer event data

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete customer events

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Delete customer event data

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{ }

Get customer event

Authorizations:
BearerAuth
path Parameters
id
required
string

Customer event ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update customer event

Authorizations:
BearerAuth
path Parameters
id
required
string

Customer event ID

Request Body schema: application/vnd.api+json

Update customer event data

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Inventory Items API

Inventory items list

Get list of inventory items

Authorizations:
BearerAuth
query Parameters
filter[dataSource]
string
Enum: "catalog" "both"

Data source for retrieving data. Null - api, both - api and catalog

filter[id]
Array of strings

Filter by inventory items

filter[globalId]
string

Filter by uuid

search
string

Filter by search term

filter[categories]
Array of strings

Filter by categories

recursive
boolean

Recursive output

type
string
Enum: "item" "service"

Filter by type

from
string <date-time>

Filter by date time from

filter[store]
string

Filter by store ID

filter[storePrice]
string

Filter by store price ID

filter[sold][from]
string <date-time>

Filter by sold items from date

filter[sold][to]
string <date-time>

Filter by sold items to date

filter[available]
boolean

Return only items which have entries in InventItemLocationSumTrans and quantity > 0. Cannot be used simultaneously with nonzeroBalances filter

filter[balances][nonzero]
boolean

Filter by nonzero balances on warehouse. False - everything, true - everything except zero balances. Cannot be used simultaneously with available filter

filter[hasTransactions]
boolean

Return only items which have transactions

filter[hasActivePrices]
boolean

Return only items which have active price at any store or by specified store

public
boolean

Return only items which have "public" flag is enabled

filter[onWindow]
boolean
Default: false

Return only retail items

filter[exclude][journal]
string

Exclude inventory items from specified journal

filter[vendors]
Array of integers <int32> [ items <int32 > ]

Filter by vendors

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create inventory item

Creates new inventory item.

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Inventory Item data

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Bulk Update Inventory Items

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Bulk Update Inventory Item data

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Delete Inventory Items

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Delete inventory items

Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{ }

Update Inventory Item

Authorizations:
BearerAuth
path Parameters
id
required
string

Inventory item ID

Request Body schema: application/vnd.api+json

Update Inventory Item data

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Inventory Item Info

Authorizations:
BearerAuth
path Parameters
id
required
string

Inventory item ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Set Inventory Item Price

Authorizations:
BearerAuth
path Parameters
id
required
string

Inventory item ID

Request Body schema: application/vnd.api+json

Update Inventory Item data

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Activate/Deactivate Inventory Item Price

Authorizations:
BearerAuth
path Parameters
id
required
string

Inventory item ID

Request Body schema: application/vnd.api+json

Update Inventory Item data

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Set Inventory Item Price Bulk

Authorizations:
BearerAuth
path Parameters
id
required
string

Inventory item ID

Request Body schema: application/vnd.api+json

Update Inventory Item data

Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Inventory items price dynamics

Get analytics data of price dynamics

Authorizations:
BearerAuth
path Parameters
id
required
string

Inventory item ID

price
required
string

Price inventory item ID

query Parameters
filter[sold][startDate]
string <date-time>

Start date

filter[sold][endDate]
string <date-time>

End date

filter[format]
string
Enum: "year" "month" "week" "day"

Group by date range

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}

Inventory items price stats by store

Get stats for price by store

Authorizations:
BearerAuth
path Parameters
id
required
string

Inventory item ID

price
required
string

Price inventory item ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get warehouse movements for item and store

Authorizations:
BearerAuth
path Parameters
id
required
string

Item ID

storeId
required
string

Store ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Search for net costs

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Net costs request data

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Search for last costs

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Last costs request data

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Categories API

Categories list

Get list of inventory items

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create new category

Creates new category

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Create category request

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}

Delete category

Authorizations:
BearerAuth
path Parameters
id
required
string

Category ID

Responses

Response samples

Content type
application/vnd.api+json
{ }

Update category

Authorizations:
BearerAuth
path Parameters
id
required
string

Category ID

Request Body schema: application/vnd.api+json

Update category request

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}

Catalog API

Get catalog by category

Authorizations:
BearerAuth
path Parameters
category
required
string

Category ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Get catalog categories

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Get catalog category

Authorizations:
BearerAuth
path Parameters
category
required
string

Category ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get item from catalog

Authorizations:
BearerAuth
path Parameters
id
required
string

Item ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Export catalog category

Authorizations:
BearerAuth
path Parameters
category
required
string

Category ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Orders API

Get order list

Returns list of orders according to specified params.

Authorizations:
BearerAuth
query Parameters
filter[customer]
string

Filter by customer id.

filter[modifiedAt][from]
string <date-time>

Filter by modifiedAt (start date)

filter[modifiedAt][to]
string <date-time>

Filter by modifiedAt (end date)

filter[dueTime][from]
string <date-time>

Filter by due time (start date)

filter[dueTime][to]
string <date-time>

Filter by due time (end date)

filter[createdAt][from]
string <date-time>

Filter by createdAt (start date)

filter[createdAt][to]
string <date-time>

Filter by createdAt (end date)

filter[updatedAt][from]
string <date-time>

Filter by updatedAt (start date)

filter[updatedAt][to]
string <date-time>

Filter by updatedAt (end date)

filter[statuses]
Array of strings
Items Enum: "new" "done" "canceled" "returned" "courier" "assembled" "notAccepted"

Filter by order status

filter[stores]
Array of strings

Filter by store ids

filter[sources]
Array of strings

Filter by source ids

filter[sources]
Array of strings
Items Enum: "discount" "markup"

Filter by orders with discounts and\or markup

filter[postedBy]
Array of strings

Filter by user who closed the order

filter[createdBy]
Array of strings

Filter by user who created the order

filter[items]
Array of strings

Filter by items

search
string

Search by client name, order number, phone or card number

filter[delivery]
boolean

Filter by delivery

filter[fiscalized]
boolean

Filter by fiscalized

filter[amount][min]
number <float>

Order amount from

filter[amount][max]
number <float>

Order amount from

filter[bonuses]
boolean

Filter orders paid by bonuses

filter[paymentMethods]
Array of strings

Filter by order payments that paid by specified payment methods

filter[onlyExternal]
boolean

Select only external orders

filter[externalSystem]
string

Filter external orders by Synced System ID which belongs to

filter[excludedSessions]
Array of integers

Exclude external orders which created during specified sync sessions

addMetaStatuses
boolean

Include statuses statistic to response meta

filter[postedAt][from]
string <date-time>

Filter by postedAt (start date)

filter[postedAt][to]
string <date-time>

Filter by postedAt (end date)

filter[paymentPostedAt][from]
string <date-time>

Orders with payments which postedAt more than specified date

filter[paymentPostedAt][to]
string <date-time>

Orders with payments which postedAt less than specified date

filter[docNo]
Array of strings

Filter by document numbers

filter[couriers]
Array of strings

Filter by couriers

filter[withoutCouriers]
boolean
Default: false

Filter by orders without couriers

filter[florists]
Array of strings

Filter by florists

filter[withoutFlorists]
boolean
Default: false

Filter by orders without florists

filter[shift]
string

Filter by specific shift

filter[fiscalShift]
string

Filter by specific fiscal shift

filter[withReturned]
boolean
Default: false

Include returned orders

filter[revision]
integer <int32>

Filter by revision

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create new order

Creates new order.

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Create order body

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get order info by id

Authorizations:
BearerAuth
path Parameters
id
required
string

Order ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update order

Update order data

Authorizations:
BearerAuth
path Parameters
id
required
string

Order ID

Request Body schema: application/vnd.api+json

Create order body

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Fiscalize order

Authorizations:
BearerAuth
path Parameters
id
required
string

Order ID

Request Body schema: application/vnd.api+json

Fiscal order

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update order delivery status

Authorizations:
BearerAuth
path Parameters
id
required
string

Order ID

Request Body schema: application/vnd.api+json

Update order delivery status body

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Return order

Authorizations:
BearerAuth
path Parameters
id
required
string

Order ID

Request Body schema: application/vnd.api+json

Return order

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create order payment

Authorizations:
BearerAuth
path Parameters
id
required
string

Order ID

Request Body schema: application/vnd.api+json

Create order payment body

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}

Separate bouquet from order and transfer to showcase

Authorizations:
BearerAuth
path Parameters
id
required
string

Order ID

bouquetId
required
string

Bouquet ID

Request Body schema: application/vnd.api+json

Separate bouqet from order request data

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update payment by ID

Authorizations:
BearerAuth
path Parameters
id
required
string

Payment ID

Request Body schema: application/vnd.api+json

Update order payment body

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get payments list

Returns list of payments.

Authorizations:
BearerAuth
query Parameters
filter[type]
string
Enum: "payment" "return" "change"

Filter by type.

filter[paymentMethod]
string

Filter by payment method id.

filter[shift]
string

Filter by shift id.

filter[fiscalShift]
string

Filter by fiscal shift id.

filter[createdBy]
string

Filter by person who created payment.

filter[postedBy]
string

Filter by person who finished payment.

filter[order]
string

Filter by order id.

filter[fiscalizedAt][from]
string

Filter by date when payment was fiscalized (start date).

filter[fiscalizedAt][to]
string

Filter by date when payment was fiscalized (end date).

filter[amountFrom]
string <float>

Filter by amount min.

filter[amountTo]
string <float>

Filter by amount max.

filter[bonusesAmountFrom]
string <float>

Filter by bonuses min.

filter[bonusesAmountTo]
string <float>

Filter by bonuses max.

filter[fiscalized]
boolean

Filter by fiscalized.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Bouquets API

Bouquets list

Get list of bouquets

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create new Bouquets

Creates new Bouquets

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Create bouquet request

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Delete bouquet

Authorizations:
BearerAuth
path Parameters
id
required
string

Bouquet ID

Responses

Response samples

Content type
application/vnd.api+json
{ }

Update bouquet

Authorizations:
BearerAuth
path Parameters
id
required
string

Bouquet ID

Request Body schema: application/vnd.api+json

Update bouquet request

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Orders Analytics

Shipment revenue

Authorizations:
BearerAuth
query Parameters
filter[customer]
string

Filter by customer id.

filter[modifiedAt][from]
string <date-time>

Filter by modifiedAt (start date)

filter[modifiedAt][to]
string <date-time>

Filter by modifiedAt (end date)

filter[dueTime][from]
string <date-time>

Filter by due time (start date)

filter[dueTime][to]
string <date-time>

Filter by due time (end date)

filter[createdAt][from]
string <date-time>

Filter by createdAt (start date)

filter[createdAt][to]
string <date-time>

Filter by createdAt (end date)

filter[updatedAt][from]
string <date-time>

Filter by updatedAt (start date)

filter[updatedAt][to]
string <date-time>

Filter by updatedAt (end date)

filter[statuses]
Array of strings
Items Enum: "new" "done" "canceled" "returned" "courier" "assembled" "notAccepted"

Filter by order status

filter[stores]
Array of strings

Filter by store ids

filter[sources]
Array of strings

Filter by source ids

filter[sources]
Array of strings
Items Enum: "discount" "markup"

Filter by orders with discounts and\or markup

filter[postedBy]
Array of strings

Filter by user who closed the order

filter[createdBy]
Array of strings

Filter by user who created the order

filter[items]
Array of strings

Filter by items

search
string

Search by client name, order number, phone or card number

filter[delivery]
boolean

Filter by delivery

filter[fiscalized]
boolean

Filter by fiscalized

filter[amount][min]
number <float>

Order amount from

filter[amount][max]
number <float>

Order amount from

filter[bonuses]
boolean

Filter orders paid by bonuses

filter[paymentMethods]
Array of strings

Filter by order payments that paid by specified payment methods

filter[onlyExternal]
boolean

Select only external orders

filter[externalSystem]
string

Filter external orders by Synced System ID which belongs to

filter[excludedSessions]
Array of integers

Exclude external orders which created during specified sync sessions

addMetaStatuses
boolean

Include statuses statistic to response meta

filter[postedAt][from]
string <date-time>

Filter by postedAt (start date)

filter[postedAt][to]
string <date-time>

Filter by postedAt (end date)

filter[paymentPostedAt][from]
string <date-time>

Orders with payments which postedAt more than specified date

filter[paymentPostedAt][to]
string <date-time>

Orders with payments which postedAt less than specified date

filter[docNo]
Array of strings

Filter by document numbers

filter[couriers]
Array of strings

Filter by couriers

filter[withoutCouriers]
boolean
Default: false

Filter by orders without couriers

filter[florists]
Array of strings

Filter by florists

filter[withoutFlorists]
boolean
Default: false

Filter by orders without florists

filter[shift]
string

Filter by specific shift

filter[fiscalShift]
string

Filter by specific fiscal shift

filter[withReturned]
boolean
Default: false

Include returned orders

filter[revision]
integer <int32>

Filter by revision

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Marginality

Authorizations:
BearerAuth
query Parameters
filter[customer]
string

Filter by customer id.

filter[modifiedAt][from]
string <date-time>

Filter by modifiedAt (start date)

filter[modifiedAt][to]
string <date-time>

Filter by modifiedAt (end date)

filter[dueTime][from]
string <date-time>

Filter by due time (start date)

filter[dueTime][to]
string <date-time>

Filter by due time (end date)

filter[createdAt][from]
string <date-time>

Filter by createdAt (start date)

filter[createdAt][to]
string <date-time>

Filter by createdAt (end date)

filter[updatedAt][from]
string <date-time>

Filter by updatedAt (start date)

filter[updatedAt][to]
string <date-time>

Filter by updatedAt (end date)

filter[statuses]
Array of strings
Items Enum: "new" "done" "canceled" "returned" "courier" "assembled" "notAccepted"

Filter by order status

filter[stores]
Array of strings

Filter by store ids

filter[sources]
Array of strings

Filter by source ids

filter[sources]
Array of strings
Items Enum: "discount" "markup"

Filter by orders with discounts and\or markup

filter[postedBy]
Array of strings

Filter by user who closed the order

filter[createdBy]
Array of strings

Filter by user who created the order

filter[items]
Array of strings

Filter by items

search
string

Search by client name, order number, phone or card number

filter[delivery]
boolean

Filter by delivery

filter[fiscalized]
boolean

Filter by fiscalized

filter[amount][min]
number <float>

Order amount from

filter[amount][max]
number <float>

Order amount from

filter[bonuses]
boolean

Filter orders paid by bonuses

filter[paymentMethods]
Array of strings

Filter by order payments that paid by specified payment methods

filter[onlyExternal]
boolean

Select only external orders

filter[externalSystem]
string

Filter external orders by Synced System ID which belongs to

filter[excludedSessions]
Array of integers

Exclude external orders which created during specified sync sessions

addMetaStatuses
boolean

Include statuses statistic to response meta

filter[postedAt][from]
string <date-time>

Filter by postedAt (start date)

filter[postedAt][to]
string <date-time>

Filter by postedAt (end date)

filter[paymentPostedAt][from]
string <date-time>

Orders with payments which postedAt more than specified date

filter[paymentPostedAt][to]
string <date-time>

Orders with payments which postedAt less than specified date

filter[docNo]
Array of strings

Filter by document numbers

filter[couriers]
Array of strings

Filter by couriers

filter[withoutCouriers]
boolean
Default: false

Filter by orders without couriers

filter[florists]
Array of strings

Filter by florists

filter[withoutFlorists]
boolean
Default: false

Filter by orders without florists

filter[shift]
string

Filter by specific shift

filter[fiscalShift]
string

Filter by specific fiscal shift

filter[withReturned]
boolean
Default: false

Include returned orders

filter[revision]
integer <int32>

Filter by revision

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Bonuses subtract

Authorizations:
BearerAuth
query Parameters
filter[customer]
string

Filter by customer id.

filter[modifiedAt][from]
string <date-time>

Filter by modifiedAt (start date)

filter[modifiedAt][to]
string <date-time>

Filter by modifiedAt (end date)

filter[dueTime][from]
string <date-time>

Filter by due time (start date)

filter[dueTime][to]
string <date-time>

Filter by due time (end date)

filter[createdAt][from]
string <date-time>

Filter by createdAt (start date)

filter[createdAt][to]
string <date-time>

Filter by createdAt (end date)

filter[updatedAt][from]
string <date-time>

Filter by updatedAt (start date)

filter[updatedAt][to]
string <date-time>

Filter by updatedAt (end date)

filter[statuses]
Array of strings
Items Enum: "new" "done" "canceled" "returned" "courier" "assembled" "notAccepted"

Filter by order status

filter[stores]
Array of strings

Filter by store ids

filter[sources]
Array of strings

Filter by source ids

filter[sources]
Array of strings
Items Enum: "discount" "markup"

Filter by orders with discounts and\or markup

filter[postedBy]
Array of strings

Filter by user who closed the order

filter[createdBy]
Array of strings

Filter by user who created the order

filter[items]
Array of strings

Filter by items

search
string

Search by client name, order number, phone or card number

filter[delivery]
boolean

Filter by delivery

filter[fiscalized]
boolean

Filter by fiscalized

filter[amount][min]
number <float>

Order amount from

filter[amount][max]
number <float>

Order amount from

filter[bonuses]
boolean

Filter orders paid by bonuses

filter[paymentMethods]
Array of strings

Filter by order payments that paid by specified payment methods

filter[onlyExternal]
boolean

Select only external orders

filter[externalSystem]
string

Filter external orders by Synced System ID which belongs to

filter[excludedSessions]
Array of integers

Exclude external orders which created during specified sync sessions

addMetaStatuses
boolean

Include statuses statistic to response meta

filter[postedAt][from]
string <date-time>

Filter by postedAt (start date)

filter[postedAt][to]
string <date-time>

Filter by postedAt (end date)

filter[paymentPostedAt][from]
string <date-time>

Orders with payments which postedAt more than specified date

filter[paymentPostedAt][to]
string <date-time>

Orders with payments which postedAt less than specified date

filter[docNo]
Array of strings

Filter by document numbers

filter[couriers]
Array of strings

Filter by couriers

filter[withoutCouriers]
boolean
Default: false

Filter by orders without couriers

filter[florists]
Array of strings

Filter by florists

filter[withoutFlorists]
boolean
Default: false

Filter by orders without florists

filter[shift]
string

Filter by specific shift

filter[fiscalShift]
string

Filter by specific fiscal shift

filter[withReturned]
boolean
Default: false

Include returned orders

filter[revision]
integer <int32>

Filter by revision

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Bonuses accrued

Authorizations:
BearerAuth
query Parameters
filter[customer]
string

Filter by customer id.

filter[modifiedAt][from]
string <date-time>

Filter by modifiedAt (start date)

filter[modifiedAt][to]
string <date-time>

Filter by modifiedAt (end date)

filter[dueTime][from]
string <date-time>

Filter by due time (start date)

filter[dueTime][to]
string <date-time>

Filter by due time (end date)

filter[createdAt][from]
string <date-time>

Filter by createdAt (start date)

filter[createdAt][to]
string <date-time>

Filter by createdAt (end date)

filter[updatedAt][from]
string <date-time>

Filter by updatedAt (start date)

filter[updatedAt][to]
string <date-time>

Filter by updatedAt (end date)

filter[statuses]
Array of strings
Items Enum: "new" "done" "canceled" "returned" "courier" "assembled" "notAccepted"

Filter by order status

filter[stores]
Array of strings

Filter by store ids

filter[sources]
Array of strings

Filter by source ids

filter[sources]
Array of strings
Items Enum: "discount" "markup"

Filter by orders with discounts and\or markup

filter[postedBy]
Array of strings

Filter by user who closed the order

filter[createdBy]
Array of strings

Filter by user who created the order

filter[items]
Array of strings

Filter by items

search
string

Search by client name, order number, phone or card number

filter[delivery]
boolean

Filter by delivery

filter[fiscalized]
boolean

Filter by fiscalized

filter[amount][min]
number <float>

Order amount from

filter[amount][max]
number <float>

Order amount from

filter[bonuses]
boolean

Filter orders paid by bonuses

filter[paymentMethods]
Array of strings

Filter by order payments that paid by specified payment methods

filter[onlyExternal]
boolean

Select only external orders

filter[externalSystem]
string

Filter external orders by Synced System ID which belongs to

filter[excludedSessions]
Array of integers

Exclude external orders which created during specified sync sessions

addMetaStatuses
boolean

Include statuses statistic to response meta

filter[postedAt][from]
string <date-time>

Filter by postedAt (start date)

filter[postedAt][to]
string <date-time>

Filter by postedAt (end date)

filter[paymentPostedAt][from]
string <date-time>

Orders with payments which postedAt more than specified date

filter[paymentPostedAt][to]
string <date-time>

Orders with payments which postedAt less than specified date

filter[docNo]
Array of strings

Filter by document numbers

filter[couriers]
Array of strings

Filter by couriers

filter[withoutCouriers]
boolean
Default: false

Filter by orders without couriers

filter[florists]
Array of strings

Filter by florists

filter[withoutFlorists]
boolean
Default: false

Filter by orders without florists

filter[shift]
string

Filter by specific shift

filter[fiscalShift]
string

Filter by specific fiscal shift

filter[withReturned]
boolean
Default: false

Include returned orders

filter[revision]
integer <int32>

Filter by revision

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Total discount

Authorizations:
BearerAuth
query Parameters
filter[customer]
string

Filter by customer id.

filter[modifiedAt][from]
string <date-time>

Filter by modifiedAt (start date)

filter[modifiedAt][to]
string <date-time>

Filter by modifiedAt (end date)

filter[dueTime][from]
string <date-time>

Filter by due time (start date)

filter[dueTime][to]
string <date-time>

Filter by due time (end date)

filter[createdAt][from]
string <date-time>

Filter by createdAt (start date)

filter[createdAt][to]
string <date-time>

Filter by createdAt (end date)

filter[updatedAt][from]
string <date-time>

Filter by updatedAt (start date)

filter[updatedAt][to]
string <date-time>

Filter by updatedAt (end date)

filter[statuses]
Array of strings
Items Enum: "new" "done" "canceled" "returned" "courier" "assembled" "notAccepted"

Filter by order status

filter[stores]
Array of strings

Filter by store ids

filter[sources]
Array of strings

Filter by source ids

filter[sources]
Array of strings
Items Enum: "discount" "markup"

Filter by orders with discounts and\or markup

filter[postedBy]
Array of strings

Filter by user who closed the order

filter[createdBy]
Array of strings

Filter by user who created the order

filter[items]
Array of strings

Filter by items

search
string

Search by client name, order number, phone or card number

filter[delivery]
boolean

Filter by delivery

filter[fiscalized]
boolean

Filter by fiscalized

filter[amount][min]
number <float>

Order amount from

filter[amount][max]
number <float>

Order amount from

filter[bonuses]
boolean

Filter orders paid by bonuses

filter[paymentMethods]
Array of strings

Filter by order payments that paid by specified payment methods

filter[onlyExternal]
boolean

Select only external orders

filter[externalSystem]
string

Filter external orders by Synced System ID which belongs to

filter[excludedSessions]
Array of integers

Exclude external orders which created during specified sync sessions

addMetaStatuses
boolean

Include statuses statistic to response meta

filter[postedAt][from]
string <date-time>

Filter by postedAt (start date)

filter[postedAt][to]
string <date-time>

Filter by postedAt (end date)

filter[paymentPostedAt][from]
string <date-time>

Orders with payments which postedAt more than specified date

filter[paymentPostedAt][to]
string <date-time>

Orders with payments which postedAt less than specified date

filter[docNo]
Array of strings

Filter by document numbers

filter[couriers]
Array of strings

Filter by couriers

filter[withoutCouriers]
boolean
Default: false

Filter by orders without couriers

filter[florists]
Array of strings

Filter by florists

filter[withoutFlorists]
boolean
Default: false

Filter by orders without florists

filter[shift]
string

Filter by specific shift

filter[fiscalShift]
string

Filter by specific fiscal shift

filter[withReturned]
boolean
Default: false

Include returned orders

filter[revision]
integer <int32>

Filter by revision

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Returned

Authorizations:
BearerAuth
query Parameters
filter[customer]
string

Filter by customer id.

filter[modifiedAt][from]
string <date-time>

Filter by modifiedAt (start date)

filter[modifiedAt][to]
string <date-time>

Filter by modifiedAt (end date)

filter[dueTime][from]
string <date-time>

Filter by due time (start date)

filter[dueTime][to]
string <date-time>

Filter by due time (end date)

filter[createdAt][from]
string <date-time>

Filter by createdAt (start date)

filter[createdAt][to]
string <date-time>

Filter by createdAt (end date)

filter[updatedAt][from]
string <date-time>

Filter by updatedAt (start date)

filter[updatedAt][to]
string <date-time>

Filter by updatedAt (end date)

filter[statuses]
Array of strings
Items Enum: "new" "done" "canceled" "returned" "courier" "assembled" "notAccepted"

Filter by order status

filter[stores]
Array of strings

Filter by store ids

filter[sources]
Array of strings

Filter by source ids

filter[sources]
Array of strings
Items Enum: "discount" "markup"

Filter by orders with discounts and\or markup

filter[postedBy]
Array of strings

Filter by user who closed the order

filter[createdBy]
Array of strings

Filter by user who created the order

filter[items]
Array of strings

Filter by items

search
string

Search by client name, order number, phone or card number

filter[delivery]
boolean

Filter by delivery

filter[fiscalized]
boolean

Filter by fiscalized

filter[amount][min]
number <float>

Order amount from

filter[amount][max]
number <float>

Order amount from

filter[bonuses]
boolean

Filter orders paid by bonuses

filter[paymentMethods]
Array of strings

Filter by order payments that paid by specified payment methods

filter[onlyExternal]
boolean

Select only external orders

filter[externalSystem]
string

Filter external orders by Synced System ID which belongs to

filter[excludedSessions]
Array of integers

Exclude external orders which created during specified sync sessions

addMetaStatuses
boolean

Include statuses statistic to response meta

filter[postedAt][from]
string <date-time>

Filter by postedAt (start date)

filter[postedAt][to]
string <date-time>

Filter by postedAt (end date)

filter[paymentPostedAt][from]
string <date-time>

Orders with payments which postedAt more than specified date

filter[paymentPostedAt][to]
string <date-time>

Orders with payments which postedAt less than specified date

filter[docNo]
Array of strings

Filter by document numbers

filter[couriers]
Array of strings

Filter by couriers

filter[withoutCouriers]
boolean
Default: false

Filter by orders without couriers

filter[florists]
Array of strings

Filter by florists

filter[withoutFlorists]
boolean
Default: false

Filter by orders without florists

filter[shift]
string

Filter by specific shift

filter[fiscalShift]
string

Filter by specific fiscal shift

filter[withReturned]
boolean
Default: false

Include returned orders

filter[revision]
integer <int32>

Filter by revision

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Orders Tags API

List order tags

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create new order tag

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Create order tag body

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete order tag

Authorizations:
BearerAuth
path Parameters
id
required
string

Order tag ID

Responses

Response samples

Content type
application/vnd.api+json
{ }

Discount reasons API

List discount reasons

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create new discount reason

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Create discount reason body

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete discount reason

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Delete discount reason body

Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{ }

Get discount reason

Authorizations:
BearerAuth
path Parameters
id
required
integer

Discount reason ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update discount reason

Authorizations:
BearerAuth
path Parameters
id
required
integer

Discount reason ID

Request Body schema: application/vnd.api+json

Update discount reason body

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Cash reasons API

List cash reasons

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create new cash reason

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Create cash reason body

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get cash reason

Authorizations:
BearerAuth
path Parameters
id
required
string

Cash reason ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update/Delete cash reason

Authorizations:
BearerAuth
path Parameters
id
required
string

Cash reason ID

Request Body schema: application/vnd.api+json

Update cash reason body

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Orders Sources API

List order sources

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create new order source

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Create order source body

Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Update order sources

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Update order source body

Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Delete order sources

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Delete order source body

Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{ }

Get order source

Authorizations:
BearerAuth
path Parameters
id
required
string

Order source ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Bonus group API

List bonus groups

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create new bonus group

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Create bonus group body

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete bonus groups

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Delete bonus groups body

Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{ }

Get bonus group

Authorizations:
BearerAuth
path Parameters
id
required
integer

Bonus group ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update bonus group

Authorizations:
BearerAuth
path Parameters
id
required
integer

Bonus group ID

Request Body schema: application/vnd.api+json

Update cash reason body

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get bonus group changes history

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Discount group API

List discount groups

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create new discount group

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Create discount group body

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete discount groups

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Delete discount groups body

Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{ }

Get discount group

Authorizations:
BearerAuth
path Parameters
id
required
integer

Discount group ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update discount group

Authorizations:
BearerAuth
path Parameters
id
required
integer

Discount group ID

Request Body schema: application/vnd.api+json

Update discount group body

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Workers API

List workers

Authorizations:
BearerAuth
query Parameters
filter[stores]
Array of strings

Filter by stores id.

search
string

Parameter search on person first name, last name, middle or position title.

dismissed
boolean
Default: false

Return dismissed workers

filter[users]
Array of strings

Filter by users ids

activeOnly
boolean
Default: false

Filter by only active workers

revision
integer <int32>

Filter by workers revision

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create new worker

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Create worker request

object

Worker

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Disable\Enable worker

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Update worker status request

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Delete workers

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Delete workers request

Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{ }

Get worker

Authorizations:
BearerAuth
path Parameters
id
required
string

Worker ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update worker

Authorizations:
BearerAuth
path Parameters
id
required
string

Worker ID

Request Body schema: application/vnd.api+json

Update worker request

object

Worker

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Movement acts API

List movement acts

Authorizations:
BearerAuth
query Parameters
filter[startDate]
string

Start date for filter by act date

filter[endDate]
string

End date for filter by act date

filter[from]
string

Filter by "from" store

filter[to]
string

Filter by "to" store

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create movement act

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Create movement act

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get movement act

Authorizations:
BearerAuth
path Parameters
id
required
string

Movement act ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update movement act

Authorizations:
BearerAuth
path Parameters
id
required
string

Movement act ID

Request Body schema: application/vnd.api+json

Update movement act

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Reports API

List report types

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Get report type

Authorizations:
BearerAuth
path Parameters
id
required
string

Report type ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

List reports

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create report

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Create report body

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete report

Authorizations:
BearerAuth
Request Body schema: application/vnd.api+json

Delete reports body

Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{ }

Get report

Authorizations:
BearerAuth
path Parameters
id
required
string

Report ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update report

Authorizations:
BearerAuth
path Parameters
id
required
string

Report ID

Request Body schema: application/vnd.api+json

Update report body

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Rerun report

Authorizations:
BearerAuth
path Parameters
id
required
string

Report ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Store Stats API

General store stats

Authorizations:
BearerAuth
query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

filter[stores]
Array of strings

Filter by stores

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Workers store stats

Authorizations:
BearerAuth
query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

filter[stores]
Array of strings

Filter by stores

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Revenue store stats

Authorizations:
BearerAuth
query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

filter[stores]
Array of strings

Filter by stores

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Payments revenue store stats

Authorizations:
BearerAuth
query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

filter[stores]
Array of strings

Filter by stores

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Profit store stats

Authorizations:
BearerAuth
query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

filter[stores]
Array of strings

Filter by stores

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Payments store stats

Authorizations:
BearerAuth
query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

filter[stores]
Array of strings

Filter by stores

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Sources store stats

Authorizations:
BearerAuth
query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

filter[stores]
Array of strings

Filter by stores

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Debts store stats

Authorizations:
BearerAuth
query Parameters
filter[range]
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

filter[stores]
required
Array of strings

Filter by stores

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Stores API

Warehouse base store stats

Authorizations:
BearerAuth
query Parameters
filter[stores][]
required
Array of strings

Store IDs

filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Warehouses top items store stats

Authorizations:
BearerAuth
query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[reason]
string

Filter by reason write off

filter[stores][]
required
Array of strings

Store IDs

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Warehouse write off store stats

Authorizations:
BearerAuth
query Parameters
filter[stores][]
required
Array of strings

Store IDs

filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Warehouse packing invoice stats

Authorizations:
BearerAuth
query Parameters
filter[stores][]
required
Array of strings

Store IDs

filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

List Stores

Authorizations:
BearerAuth
query Parameters
search
string

Search by title.

filter[id]
Array of strings

Filter by ids.

externalLinkId
string

Filter by external link ID

loadAll
boolean
Default: false
filter[revision]
integer <int32>

Filter by revision

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Get Store

Authorizations:
BearerAuth
path Parameters
id
required
string

Store ID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

General store stats

Authorizations:
BearerAuth
path Parameters
id
required
string

Store ID

query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Workers store stats

Authorizations:
BearerAuth
path Parameters
id
required
string

Store ID

query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Payments store stats

Authorizations:
BearerAuth
path Parameters
id
required
string

Store ID

query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Sources store stats

Authorizations:
BearerAuth
path Parameters
id
required
string

Store ID

query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Warehouses store stats

Authorizations:
BearerAuth
path Parameters
id
required
string

Store ID

query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Debts store stats

Authorizations:
BearerAuth
path Parameters
id
required
string

Store ID

query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Revenue store stats

Authorizations:
BearerAuth
path Parameters
id
required
string

Store ID

query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Payments revenue store stats

Authorizations:
BearerAuth
path Parameters
id
required
string

Store ID

query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Profit store stats

Authorizations:
BearerAuth
path Parameters
id
required
string

Store ID

query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Showcase store stats

Authorizations:
BearerAuth
path Parameters
id
required
string

Store ID

query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Showcase days store stats

Authorizations:
BearerAuth
path Parameters
id
required
string

Store ID

query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": {
    }
}

Showcase price store stats

Authorizations:
BearerAuth
path Parameters
id
required
string

Store ID

query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}

Showcase top flowers store stats

Authorizations:
BearerAuth
path Parameters
id
required
string

Store ID

query Parameters
filter[range]
required
string
Enum: "day" "week" "month" "year" "custom"

Date range for stats.

filter[rangeFrom]
string <date-time>

Used when filter[range] 'custom' specified

filter[rangeTo]
string <date-time>

Used when filter[range] 'custom' specified

filter[categories]
Array of strings

Filter by categories

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ]
}