API docs by Redocly

API Documentation (0.0.1)

Download OpenAPI specification:

Description of documentation

accounts

accounts_auth_delete_account_confirm_delete_destroy

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

accounts_auth_delete_account_get_user_detail_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
{
  • "detail": "string"
}

accounts_auth_delete_account_send_code_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
code
required
string non-empty
email
string non-empty
phone_number
string non-empty

Responses

Request samples

Content type
{
  • "code": "string",
  • "email": "string",
  • "phone_number": "string"
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

accounts_auth_delete_account_verify_code_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
code
required
string non-empty
email
string non-empty
phone_number
string non-empty

Responses

Request samples

Content type
{
  • "code": "string",
  • "email": "string",
  • "phone_number": "string"
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

accounts_auth_email_change_confirm_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
code
required
string non-empty
change_request
required
string <uuid>
password
required
string non-empty

Responses

Request samples

Content type
{
  • "code": "string",
  • "change_request": "fb46d17c-eb92-40a3-9539-f2488ef62285",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

accounts_auth_email_change_request_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
new_email
required
string non-empty

Responses

Request samples

Content type
{
  • "new_email": "string"
}

Response samples

Content type
application/json
{
  • "detail": "string",
  • "change_request_id": "f90819c3-6f40-44d9-9518-d77c485c0c12"
}

accounts_auth_google_login_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
id_token
required
string non-empty

Responses

Request samples

Content type
{
  • "id_token": "string"
}

Response samples

Content type
application/json
{
  • "access": "string",
  • "refresh": "string",
  • "user": {
    },
  • "actions": [
    ]
}

accounts_auth_login_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
password
required
string non-empty
email
string non-empty
phone_number
string non-empty

Responses

Request samples

Content type
{
  • "password": "string",
  • "email": "string",
  • "phone_number": "string"
}

Response samples

Content type
application/json
{
  • "access": "string",
  • "refresh": "string",
  • "user": {
    },
  • "actions": [
    ]
}

accounts_auth_password_change_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
old_password
string non-empty
new_password
string non-empty

Responses

Request samples

Content type
{
  • "old_password": "string",
  • "new_password": "string"
}

Response samples

Content type
application/json
{
  • "status": "string"
}

accounts_auth_password_reset_confirm_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
code
required
string non-empty
new_password
required
string non-empty
email
string non-empty
phone_number
string non-empty

Responses

Request samples

Content type
{
  • "code": "string",
  • "new_password": "string",
  • "email": "string",
  • "phone_number": "string"
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

accounts_auth_password_reset_request_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
email
string non-empty
phone_number
string non-empty

Responses

Request samples

Content type
{
  • "email": "string",
  • "phone_number": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "detail": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

accounts_auth_phone_change_confirm_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
code
required
string non-empty
change_request
required
string <uuid>
password
required
string non-empty

Responses

Request samples

Content type
{
  • "code": "string",
  • "change_request": "fb46d17c-eb92-40a3-9539-f2488ef62285",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

accounts_auth_phone_change_request_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
new_phone
required
string non-empty

Responses

Request samples

Content type
{
  • "new_phone": "string"
}

Response samples

Content type
application/json
{
  • "detail": "string",
  • "change_request_id": "f90819c3-6f40-44d9-9518-d77c485c0c12"
}

accounts_auth_refresh_login_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
refresh
required
string non-empty

Responses

Request samples

Content type
{
  • "refresh": "string"
}

Response samples

Content type
application/json
{
  • "access": "string",
  • "refresh": "string"
}

accounts_auth_register_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
password
required
string [ 1 .. 255 ] characters
first_name
string <= 150 characters
last_name
string <= 150 characters
email
string or null <email> <= 254 characters
phone_number
string or null <= 15 characters ^(9|7)\d{8}$

Responses

Request samples

Content type
{
  • "password": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "phone_number": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "first_name": "string",
  • "last_name": "string",
  • "is_active": true,
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "is_email_verified": true,
  • "is_phone_verified": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

accounts_auth_verifications_confirm_create

Authorizations:
basicAuthcookieAuthjwtAuthNone
Request Body schema:
required
code
required
string non-empty
phone_number
string non-empty
email
string non-empty

Responses

Request samples

Content type
{
  • "code": "string",
  • "phone_number": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "access": "string",
  • "refresh": "string",
  • "user": {
    },
  • "actions": [
    ]
}

accounts_auth_verifications_send_create

Authorizations:
basicAuthcookieAuthjwtAuthNone
Request Body schema:
email
string non-empty
phone_number
string non-empty

Responses

Request samples

Content type
{
  • "email": "string",
  • "phone_number": "string"
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

accounts_token_verify_create

Takes a token and indicates if it is valid. This view provides no information about a token's fitness for a particular use.

Authorizations:
None
Request Body schema:
required
token
required
string non-empty

Responses

Request samples

Content type
{
  • "token": "string"
}

accounts_user_devices_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
fcm_token
required
string [ 1 .. 255 ] characters
label
required
string [ 1 .. 255 ] characters
name
string [ 1 .. 255 ] characters
device_id
string [ 1 .. 255 ] characters
os
string [ 1 .. 255 ] characters
manufacturer
string [ 1 .. 255 ] characters
app_version
string [ 1 .. 255 ] characters
app_build_number
string [ 1 .. 255 ] characters
app_version_code
string [ 1 .. 255 ] characters

Responses

Request samples

Content type
{
  • "fcm_token": "string",
  • "label": "string",
  • "name": "string",
  • "device_id": "string",
  • "os": "string",
  • "manufacturer": "string",
  • "app_version": "string",
  • "app_build_number": "string",
  • "app_version_code": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "fcm_token": "string",
  • "label": "string",
  • "name": "string",
  • "device_id": "string",
  • "os": "string",
  • "manufacturer": "string",
  • "app_version": "string",
  • "app_build_number": "string",
  • "app_version_code": "string"
}

accounts_users_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

accounts_users_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
first_name
string <= 150 characters
last_name
string <= 150 characters
is_active
boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

date_joined
string <date-time>
email
string or null <email> <= 254 characters
phone_number
string or null <= 15 characters ^(9|7)\d{8}$
is_email_verified
boolean
is_phone_verified
boolean

Responses

Request samples

Content type
{
  • "first_name": "string",
  • "last_name": "string",
  • "is_active": true,
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "is_email_verified": true,
  • "is_phone_verified": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "first_name": "string",
  • "last_name": "string",
  • "is_active": true,
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "is_email_verified": true,
  • "is_phone_verified": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

accounts_users_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this user.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "first_name": "string",
  • "last_name": "string",
  • "is_active": true,
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "is_email_verified": true,
  • "is_phone_verified": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

accounts_users_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this user.

Request Body schema:
first_name
string <= 150 characters
last_name
string <= 150 characters
is_active
boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

date_joined
string <date-time>
email
string or null <email> <= 254 characters
phone_number
string or null <= 15 characters ^(9|7)\d{8}$
is_email_verified
boolean
is_phone_verified
boolean

Responses

Request samples

Content type
{
  • "first_name": "string",
  • "last_name": "string",
  • "is_active": true,
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "is_email_verified": true,
  • "is_phone_verified": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "first_name": "string",
  • "last_name": "string",
  • "is_active": true,
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "is_email_verified": true,
  • "is_phone_verified": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

accounts_users_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this user.

Request Body schema:
first_name
string <= 150 characters
last_name
string <= 150 characters
is_active
boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

date_joined
string <date-time>
email
string or null <email> <= 254 characters
phone_number
string or null <= 15 characters ^(9|7)\d{8}$
is_email_verified
boolean
is_phone_verified
boolean

Responses

Request samples

Content type
{
  • "first_name": "string",
  • "last_name": "string",
  • "is_active": true,
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "is_email_verified": true,
  • "is_phone_verified": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "first_name": "string",
  • "last_name": "string",
  • "is_active": true,
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "is_email_verified": true,
  • "is_phone_verified": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

accounts_users_delete_destroy

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

accounts_users_me_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "first_name": "string",
  • "last_name": "string",
  • "is_active": true,
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "is_email_verified": true,
  • "is_phone_verified": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

business

business_addresses_list

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

business_addresses_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
lat
required
number <double>
lng
required
number <double>
plus_code
string or null
sublocality
string or null [ 1 .. 255 ] characters
locality
string or null [ 1 .. 255 ] characters
admin_2
string or null [ 1 .. 255 ] characters
admin_1
required
string [ 1 .. 255 ] characters
country
required
string [ 1 .. 255 ] characters

Responses

Request samples

Content type
{
  • "lat": 0.1,
  • "lng": 0.1,
  • "plus_code": "string",
  • "sublocality": "string",
  • "locality": "string",
  • "admin_2": "string",
  • "admin_1": "string",
  • "country": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "lat": 0.1,
  • "lng": 0.1,
  • "plus_code": "string",
  • "sublocality": "string",
  • "locality": "string",
  • "admin_2": "string",
  • "admin_1": "string",
  • "country": "string"
}

business_addresses_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this address.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "lat": 0.1,
  • "lng": 0.1,
  • "plus_code": "string",
  • "sublocality": "string",
  • "locality": "string",
  • "admin_2": "string",
  • "admin_1": "string",
  • "country": "string"
}

business_addresses_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this address.

Request Body schema:
required
lat
required
number <double>
lng
required
number <double>
plus_code
string or null
sublocality
string or null [ 1 .. 255 ] characters
locality
string or null [ 1 .. 255 ] characters
admin_2
string or null [ 1 .. 255 ] characters
admin_1
required
string [ 1 .. 255 ] characters
country
required
string [ 1 .. 255 ] characters

Responses

Request samples

Content type
{
  • "lat": 0.1,
  • "lng": 0.1,
  • "plus_code": "string",
  • "sublocality": "string",
  • "locality": "string",
  • "admin_2": "string",
  • "admin_1": "string",
  • "country": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "lat": 0.1,
  • "lng": 0.1,
  • "plus_code": "string",
  • "sublocality": "string",
  • "locality": "string",
  • "admin_2": "string",
  • "admin_1": "string",
  • "country": "string"
}

business_addresses_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this address.

Request Body schema:
lat
number <double>
lng
number <double>
plus_code
string or null
sublocality
string or null [ 1 .. 255 ] characters
locality
string or null [ 1 .. 255 ] characters
admin_2
string or null [ 1 .. 255 ] characters
admin_1
string [ 1 .. 255 ] characters
country
string [ 1 .. 255 ] characters

Responses

Request samples

Content type
{
  • "lat": 0.1,
  • "lng": 0.1,
  • "plus_code": "string",
  • "sublocality": "string",
  • "locality": "string",
  • "admin_2": "string",
  • "admin_1": "string",
  • "country": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "lat": 0.1,
  • "lng": 0.1,
  • "plus_code": "string",
  • "sublocality": "string",
  • "locality": "string",
  • "admin_2": "string",
  • "admin_1": "string",
  • "country": "string"
}

business_addresses_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this address.

Responses

business_branches_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
business_id
string <uuid>

Filter by business ID

page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

business_branches_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
business
required
string <uuid>
name
required
string [ 1 .. 255 ] characters
address
string or null <uuid>

Responses

Request samples

Content type
{
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "name": "string",
  • "address": "acc2de7d-9959-4ca0-9dda-9b7ef1cd4c6c"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "address": "acc2de7d-9959-4ca0-9dda-9b7ef1cd4c6c"
}

business_branches_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this branch.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "address": "acc2de7d-9959-4ca0-9dda-9b7ef1cd4c6c"
}

business_branches_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this branch.

Request Body schema:
required
business
required
string <uuid>
name
required
string [ 1 .. 255 ] characters
address
string or null <uuid>

Responses

Request samples

Content type
{
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "name": "string",
  • "address": "acc2de7d-9959-4ca0-9dda-9b7ef1cd4c6c"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "address": "acc2de7d-9959-4ca0-9dda-9b7ef1cd4c6c"
}

business_branches_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this branch.

Request Body schema:
business
string <uuid>
name
string [ 1 .. 255 ] characters
address
string or null <uuid>

Responses

Request samples

Content type
{
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "name": "string",
  • "address": "acc2de7d-9959-4ca0-9dda-9b7ef1cd4c6c"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "address": "acc2de7d-9959-4ca0-9dda-9b7ef1cd4c6c"
}

business_branches_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this branch.

Responses

business_businesses_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
business_type
string

Filter by business type

categories
string <uuid>

Filter by category IDs separated by commas

owner
string <uuid>

Filter by owner ID

page
integer

A page number within the paginated result set.

search
string

Search by business name

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

business_businesses_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
required
object (AddressRequest)
name
required
string [ 1 .. 255 ] characters
business_type
required
string (BusinessTypeEnum)
Enum: "retail" "whole_sale" "manufacturing" "service"
  • retail - Retail
  • whole_sale - Wholesale
  • manufacturing - Manufacturing
  • service - Service
background_image
string or null non-empty
categories
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "address": {
    },
  • "name": "string",
  • "business_type": "retail",
  • "background_image": "string",
  • "categories": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "address": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "business_type": "retail",
  • "is_verified": true,
  • "is_active": true,
  • "background_image": "string",
  • "categories": [
    ]
}

business_businesses_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this business.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "address": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "business_type": "retail",
  • "is_verified": true,
  • "is_active": true,
  • "background_image": "string",
  • "categories": [
    ]
}

business_businesses_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this business.

Request Body schema:
required
required
object (AddressRequest)
name
required
string [ 1 .. 255 ] characters
business_type
required
string (BusinessTypeEnum)
Enum: "retail" "whole_sale" "manufacturing" "service"
  • retail - Retail
  • whole_sale - Wholesale
  • manufacturing - Manufacturing
  • service - Service
background_image
string or null non-empty
categories
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "address": {
    },
  • "name": "string",
  • "business_type": "retail",
  • "background_image": "string",
  • "categories": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "address": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "business_type": "retail",
  • "is_verified": true,
  • "is_active": true,
  • "background_image": "string",
  • "categories": [
    ]
}

business_businesses_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this business.

Request Body schema:
object (AddressRequest)
name
string [ 1 .. 255 ] characters
business_type
string (BusinessTypeEnum)
Enum: "retail" "whole_sale" "manufacturing" "service"
  • retail - Retail
  • whole_sale - Wholesale
  • manufacturing - Manufacturing
  • service - Service
background_image
string or null non-empty
categories
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "address": {
    },
  • "name": "string",
  • "business_type": "retail",
  • "background_image": "string",
  • "categories": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "address": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "business_type": "retail",
  • "is_verified": true,
  • "is_active": true,
  • "background_image": "string",
  • "categories": [
    ]
}

business_businesses_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this business.

Responses

business_businessimage_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{}

business_categories_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{}

business_categories_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this category.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "is_active": true,
  • "industry": "9762546f-eb45-4b24-96f0-c16241af5507",
  • "image": "string"
}

business_employees_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

business_employees_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
user
string or null <uuid>
business
string or null <uuid>
role
string or null <uuid>
branch
string or null <uuid>

Responses

Request samples

Content type
{
  • "user": "76f62a58-5404-486d-9afc-07bded328704",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user": "76f62a58-5404-486d-9afc-07bded328704",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65"
}

business_employees_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this employee.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user": "76f62a58-5404-486d-9afc-07bded328704",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65"
}

business_employees_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this employee.

Request Body schema:
user
string or null <uuid>
business
string or null <uuid>
role
string or null <uuid>
branch
string or null <uuid>

Responses

Request samples

Content type
{
  • "user": "76f62a58-5404-486d-9afc-07bded328704",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user": "76f62a58-5404-486d-9afc-07bded328704",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65"
}

business_employees_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this employee.

Request Body schema:
user
string or null <uuid>
business
string or null <uuid>
role
string or null <uuid>
branch
string or null <uuid>

Responses

Request samples

Content type
{
  • "user": "76f62a58-5404-486d-9afc-07bded328704",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user": "76f62a58-5404-486d-9afc-07bded328704",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65"
}

business_employees_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this employee.

Responses

business_employees_invitations_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

business_employees_invitations_create

Create a new employee invitation.

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
email
string or null <email> <= 254 characters
phone_number
string or null <= 255 characters
role
required
string <uuid>
branch
string or null <uuid>
business
required
string <uuid>

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "phone_number": "string",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "status": "pending",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

business_employees_invitations_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this employee invitation.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "status": "pending",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

business_employees_invitations_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this employee invitation.

Request Body schema:
required
email
string or null <email> <= 254 characters
phone_number
string or null <= 255 characters
role
required
string <uuid>
branch
string or null <uuid>
business
required
string <uuid>

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "phone_number": "string",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "status": "pending",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

business_employees_invitations_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this employee invitation.

Request Body schema:
email
string or null <email> <= 254 characters
phone_number
string or null <= 255 characters
role
string <uuid>
branch
string or null <uuid>
business
string <uuid>

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "phone_number": "string",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "status": "pending",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

business_employees_invitations_destroy

Revoke an employee invitation.

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this employee invitation.

Responses

business_employees_invitations_resend_create

Resend an employee invitation. Only business owners/admins can resend invitations.

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this employee invitation.

Request Body schema:
required
email
string or null <email> <= 254 characters
phone_number
string or null <= 255 characters
role
required
string <uuid>
branch
string or null <uuid>
business
required
string <uuid>

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "phone_number": "string",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "status": "pending",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

business_employees_invitations_status_partial_update

Update the status of an employee invitation. Only the invited user can update their invitation status.

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this employee invitation.

Request Body schema:
status
string (EmployeeInvitationStatusStatusEnum)
Enum: "pending" "accepted" "rejected" "expired" "revoked"
  • pending - pending
  • accepted - accepted
  • rejected - rejected
  • expired - expired
  • revoked - revoked

Responses

Request samples

Content type
{
  • "status": "pending"
}

Response samples

Content type
application/json
{
  • "status": "pending"
}

business_employees_invitations_mine_retrieve

List pending invitations for the current user.

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "status": "pending",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

business_employees_invitations_stats_retrieve

Get invitation statistics for a business.

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "status": "pending",
  • "role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

business_industries_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{}

business_permissions_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
branch_id
string <uuid>

Filter by branch ID

business_id
string <uuid>

Filter by business ID

Responses

business_roles_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{}

business_roles_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this role.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "permissions": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "role_name": "owner",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

chat

List user's conversations

Get all conversations where the authenticated user is a participant

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
business_id
string <uuid>

Filter conversations by business

conversation_type
string

Filter by conversation type (direct, group, business_wide)

page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

Create a new conversation

Create a new conversation with specified participants

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
title
string <= 255 characters

Optional title for group conversations

conversation_type
string (ConversationTypeEnum)
Enum: "direct" "group" "business"
  • direct - Direct Message
  • group - Group Chat
  • business - Business
business
required
string <uuid>

Business context for the conversation

participant_user_ids
required
Array of strings <uuid> [ items <uuid > ]

List of user IDs to add as participants

Responses

Request samples

Content type
Example
{
  • "title": "",
  • "conversation_type": "direct",
  • "business": "uuid-here",
  • "participant_user_ids": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "title": "",
  • "conversation_type": "direct",
  • "business": "uuid-here",
  • "participant_user_ids": [
    ]
}

chat_conversations_retrieve

ViewSet for managing conversations between business employees

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "conversation_type": "direct",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  • "created_by_name": "string",
  • "is_active": true,
  • "last_message_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "participants": [
    ],
  • "messages": "string"
}

chat_conversations_update

ViewSet for managing conversations between business employees

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string
Request Body schema:
required
title
string <= 255 characters

Optional title for group conversations

conversation_type
string (ConversationTypeEnum)
Enum: "direct" "group" "business"
  • direct - Direct Message
  • group - Group Chat
  • business - Business
business
required
string <uuid>

Business context for the conversation

created_by
string or null <uuid>
is_active
boolean

Responses

Request samples

Content type
{
  • "title": "string",
  • "conversation_type": "direct",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "conversation_type": "direct",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  • "created_by_name": "string",
  • "is_active": true,
  • "last_message_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "participants": [
    ],
  • "messages": "string"
}

chat_conversations_partial_update

ViewSet for managing conversations between business employees

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string
Request Body schema:
title
string <= 255 characters

Optional title for group conversations

conversation_type
string (ConversationTypeEnum)
Enum: "direct" "group" "business"
  • direct - Direct Message
  • group - Group Chat
  • business - Business
business
string <uuid>

Business context for the conversation

created_by
string or null <uuid>
is_active
boolean

Responses

Request samples

Content type
{
  • "title": "string",
  • "conversation_type": "direct",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "conversation_type": "direct",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  • "created_by_name": "string",
  • "is_active": true,
  • "last_message_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "participants": [
    ],
  • "messages": "string"
}

chat_conversations_destroy

ViewSet for managing conversations between business employees

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string

Responses

Add participants to conversation

Add new participants to an existing conversation

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string
Request Body schema:
required
title
string <= 255 characters

Optional title for group conversations

conversation_type
string (ConversationTypeEnum)
Enum: "direct" "group" "business"
  • direct - Direct Message
  • group - Group Chat
  • business - Business
business
required
string <uuid>

Business context for the conversation

created_by
string or null <uuid>
is_active
boolean

Responses

Request samples

Content type
{
  • "title": "string",
  • "conversation_type": "direct",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "conversation_type": "direct",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  • "created_by_name": "string",
  • "is_active": true,
  • "last_message_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "participants": [
    ],
  • "messages": "string"
}

Leave conversation

Remove current user from the conversation

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string
Request Body schema:
required
title
string <= 255 characters

Optional title for group conversations

conversation_type
string (ConversationTypeEnum)
Enum: "direct" "group" "business"
  • direct - Direct Message
  • group - Group Chat
  • business - Business
business
required
string <uuid>

Business context for the conversation

created_by
string or null <uuid>
is_active
boolean

Responses

Request samples

Content type
{
  • "title": "string",
  • "conversation_type": "direct",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "conversation_type": "direct",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  • "created_by_name": "string",
  • "is_active": true,
  • "last_message_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "participants": [
    ],
  • "messages": "string"
}

Mark conversation as read

Mark all messages in conversation as read

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string
Request Body schema:
required
title
string <= 255 characters

Optional title for group conversations

conversation_type
string (ConversationTypeEnum)
Enum: "direct" "group" "business"
  • direct - Direct Message
  • group - Group Chat
  • business - Business
business
required
string <uuid>

Business context for the conversation

created_by
string or null <uuid>
is_active
boolean

Responses

Request samples

Content type
{
  • "title": "string",
  • "conversation_type": "direct",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "conversation_type": "direct",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  • "created_by_name": "string",
  • "is_active": true,
  • "last_message_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "participants": [
    ],
  • "messages": "string"
}

chat_invitations_list

ViewSet for managing conversation invitations

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

chat_invitations_create

ViewSet for managing conversation invitations

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
conversation
required
string <uuid>
invited_by
required
string <uuid>
invited_user
required
string <uuid>
invited_employee
required
string <uuid>
status
string (ConversationInvitationStatusEnum)
Enum: "pending" "accepted" "declined" "expired"
  • pending - Pending
  • accepted - Accepted
  • declined - Declined
  • expired - Expired
message
string

Optional invitation message

expires_at
string or null <date-time>

Responses

Request samples

Content type
{
  • "conversation": "a2d9c3ee-03b3-403a-b1c2-42b286bec1aa",
  • "invited_by": "0fdabe0c-eb7c-440a-96d2-2c65906c3777",
  • "invited_user": "50fd75ce-7075-416d-8fd0-25125cf07e3c",
  • "invited_employee": "676d4ab5-d67c-4679-83b8-41e30319c60c",
  • "status": "pending",
  • "message": "string",
  • "expires_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "conversation": "a2d9c3ee-03b3-403a-b1c2-42b286bec1aa",
  • "conversation_title": "string",
  • "invited_by": "0fdabe0c-eb7c-440a-96d2-2c65906c3777",
  • "invited_by_name": "string",
  • "invited_user": "50fd75ce-7075-416d-8fd0-25125cf07e3c",
  • "invited_user_name": "string",
  • "invited_employee": "676d4ab5-d67c-4679-83b8-41e30319c60c",
  • "status": "pending",
  • "message": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "responded_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

chat_invitations_retrieve

ViewSet for managing conversation invitations

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "conversation": "a2d9c3ee-03b3-403a-b1c2-42b286bec1aa",
  • "conversation_title": "string",
  • "invited_by": "0fdabe0c-eb7c-440a-96d2-2c65906c3777",
  • "invited_by_name": "string",
  • "invited_user": "50fd75ce-7075-416d-8fd0-25125cf07e3c",
  • "invited_user_name": "string",
  • "invited_employee": "676d4ab5-d67c-4679-83b8-41e30319c60c",
  • "status": "pending",
  • "message": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "responded_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

chat_invitations_update

ViewSet for managing conversation invitations

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string
Request Body schema:
required
conversation
required
string <uuid>
invited_by
required
string <uuid>
invited_user
required
string <uuid>
invited_employee
required
string <uuid>
status
string (ConversationInvitationStatusEnum)
Enum: "pending" "accepted" "declined" "expired"
  • pending - Pending
  • accepted - Accepted
  • declined - Declined
  • expired - Expired
message
string

Optional invitation message

expires_at
string or null <date-time>

Responses

Request samples

Content type
{
  • "conversation": "a2d9c3ee-03b3-403a-b1c2-42b286bec1aa",
  • "invited_by": "0fdabe0c-eb7c-440a-96d2-2c65906c3777",
  • "invited_user": "50fd75ce-7075-416d-8fd0-25125cf07e3c",
  • "invited_employee": "676d4ab5-d67c-4679-83b8-41e30319c60c",
  • "status": "pending",
  • "message": "string",
  • "expires_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "conversation": "a2d9c3ee-03b3-403a-b1c2-42b286bec1aa",
  • "conversation_title": "string",
  • "invited_by": "0fdabe0c-eb7c-440a-96d2-2c65906c3777",
  • "invited_by_name": "string",
  • "invited_user": "50fd75ce-7075-416d-8fd0-25125cf07e3c",
  • "invited_user_name": "string",
  • "invited_employee": "676d4ab5-d67c-4679-83b8-41e30319c60c",
  • "status": "pending",
  • "message": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "responded_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

chat_invitations_partial_update

ViewSet for managing conversation invitations

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string
Request Body schema:
conversation
string <uuid>
invited_by
string <uuid>
invited_user
string <uuid>
invited_employee
string <uuid>
status
string (ConversationInvitationStatusEnum)
Enum: "pending" "accepted" "declined" "expired"
  • pending - Pending
  • accepted - Accepted
  • declined - Declined
  • expired - Expired
message
string

Optional invitation message

expires_at
string or null <date-time>

Responses

Request samples

Content type
{
  • "conversation": "a2d9c3ee-03b3-403a-b1c2-42b286bec1aa",
  • "invited_by": "0fdabe0c-eb7c-440a-96d2-2c65906c3777",
  • "invited_user": "50fd75ce-7075-416d-8fd0-25125cf07e3c",
  • "invited_employee": "676d4ab5-d67c-4679-83b8-41e30319c60c",
  • "status": "pending",
  • "message": "string",
  • "expires_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "conversation": "a2d9c3ee-03b3-403a-b1c2-42b286bec1aa",
  • "conversation_title": "string",
  • "invited_by": "0fdabe0c-eb7c-440a-96d2-2c65906c3777",
  • "invited_by_name": "string",
  • "invited_user": "50fd75ce-7075-416d-8fd0-25125cf07e3c",
  • "invited_user_name": "string",
  • "invited_employee": "676d4ab5-d67c-4679-83b8-41e30319c60c",
  • "status": "pending",
  • "message": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "responded_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

chat_invitations_destroy

ViewSet for managing conversation invitations

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string

Responses

Accept invitation

Accept a conversation invitation

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string
Request Body schema:
required
conversation
required
string <uuid>
invited_by
required
string <uuid>
invited_user
required
string <uuid>
invited_employee
required
string <uuid>
status
string (ConversationInvitationStatusEnum)
Enum: "pending" "accepted" "declined" "expired"
  • pending - Pending
  • accepted - Accepted
  • declined - Declined
  • expired - Expired
message
string

Optional invitation message

expires_at
string or null <date-time>

Responses

Request samples

Content type
{
  • "conversation": "a2d9c3ee-03b3-403a-b1c2-42b286bec1aa",
  • "invited_by": "0fdabe0c-eb7c-440a-96d2-2c65906c3777",
  • "invited_user": "50fd75ce-7075-416d-8fd0-25125cf07e3c",
  • "invited_employee": "676d4ab5-d67c-4679-83b8-41e30319c60c",
  • "status": "pending",
  • "message": "string",
  • "expires_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "conversation": "a2d9c3ee-03b3-403a-b1c2-42b286bec1aa",
  • "conversation_title": "string",
  • "invited_by": "0fdabe0c-eb7c-440a-96d2-2c65906c3777",
  • "invited_by_name": "string",
  • "invited_user": "50fd75ce-7075-416d-8fd0-25125cf07e3c",
  • "invited_user_name": "string",
  • "invited_employee": "676d4ab5-d67c-4679-83b8-41e30319c60c",
  • "status": "pending",
  • "message": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "responded_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

Decline invitation

Decline a conversation invitation

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string
Request Body schema:
required
conversation
required
string <uuid>
invited_by
required
string <uuid>
invited_user
required
string <uuid>
invited_employee
required
string <uuid>
status
string (ConversationInvitationStatusEnum)
Enum: "pending" "accepted" "declined" "expired"
  • pending - Pending
  • accepted - Accepted
  • declined - Declined
  • expired - Expired
message
string

Optional invitation message

expires_at
string or null <date-time>

Responses

Request samples

Content type
{
  • "conversation": "a2d9c3ee-03b3-403a-b1c2-42b286bec1aa",
  • "invited_by": "0fdabe0c-eb7c-440a-96d2-2c65906c3777",
  • "invited_user": "50fd75ce-7075-416d-8fd0-25125cf07e3c",
  • "invited_employee": "676d4ab5-d67c-4679-83b8-41e30319c60c",
  • "status": "pending",
  • "message": "string",
  • "expires_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "conversation": "a2d9c3ee-03b3-403a-b1c2-42b286bec1aa",
  • "conversation_title": "string",
  • "invited_by": "0fdabe0c-eb7c-440a-96d2-2c65906c3777",
  • "invited_by_name": "string",
  • "invited_user": "50fd75ce-7075-416d-8fd0-25125cf07e3c",
  • "invited_user_name": "string",
  • "invited_employee": "676d4ab5-d67c-4679-83b8-41e30319c60c",
  • "status": "pending",
  • "message": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "responded_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

List messages

Get messages for conversations where user is a participant

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
conversation_id
string <uuid>

Filter messages by conversation

page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

Send a message

Send a new message in a conversation

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
conversation
required
string <uuid>
content
required
string non-empty

Message content

message_type
string (MessageTypeEnum)
Enum: "text" "image" "file" "system"
  • text - Text
  • image - Image
  • file - File
  • system - System Message
attachment
string or null non-empty
reply_to
string or null <uuid>

Responses

Request samples

Content type
Example
{
  • "conversation": "uuid-here",
  • "content": "Hello everyone!",
  • "message_type": "text"
}

Response samples

Content type
application/json
Example
{
  • "conversation": "uuid-here",
  • "content": "Hello everyone!",
  • "message_type": "text"
}

chat_messages_retrieve

ViewSet for managing messages within conversations

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "conversation": "a2d9c3ee-03b3-403a-b1c2-42b286bec1aa",
  • "sender": {
    },
  • "sender_employee": {
    },
  • "content": "string",
  • "message_type": "text",
  • "attachment": "string",
  • "reply_to": "string",
  • "replies_count": "string",
  • "is_edited": true,
  • "edited_at": "2019-08-24T14:15:22Z",
  • "is_deleted": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "statuses": [
    ]
}

Delete message

Delete a message (only sender can delete)

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string

Responses

Edit message

Edit an existing message (only sender can edit)

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string
Request Body schema:
conversation
string <uuid>
content
string non-empty

Message content

message_type
string (MessageTypeEnum)
Enum: "text" "image" "file" "system"
  • text - Text
  • image - Image
  • file - File
  • system - System Message
attachment
string or null non-empty

Responses

Request samples

Content type
{
  • "conversation": "a2d9c3ee-03b3-403a-b1c2-42b286bec1aa",
  • "content": "string",
  • "message_type": "text",
  • "attachment": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "conversation": "a2d9c3ee-03b3-403a-b1c2-42b286bec1aa",
  • "sender": {
    },
  • "sender_employee": {
    },
  • "content": "string",
  • "message_type": "text",
  • "attachment": "string",
  • "reply_to": "string",
  • "replies_count": "string",
  • "is_edited": true,
  • "edited_at": "2019-08-24T14:15:22Z",
  • "is_deleted": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "statuses": [
    ]
}

chat_participants_list

ViewSet for viewing conversation participants

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

chat_participants_retrieve

ViewSet for viewing conversation participants

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user": {
    },
  • "employee": {
    },
  • "role": "member",
  • "joined_at": "2019-08-24T14:15:22Z",
  • "last_read_at": "2019-08-24T14:15:22Z",
  • "is_muted": true,
  • "is_active": true
}

crms

crms_customers_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{}

crms_customers_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
email
required
string <email> [ 1 .. 254 ] characters
full_name
required
string [ 1 .. 255 ] characters
business
required
string <uuid>
phone_number
string <= 15 characters ^(9|7)\d{8}$

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "full_name": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "phone_number": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "full_name": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "phone_number": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

crms_customers_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this customer.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "full_name": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "phone_number": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

crms_customers_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this customer.

Request Body schema:
required
email
required
string <email> [ 1 .. 254 ] characters
full_name
required
string [ 1 .. 255 ] characters
business
required
string <uuid>
phone_number
string <= 15 characters ^(9|7)\d{8}$

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "full_name": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "phone_number": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "full_name": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "phone_number": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

crms_customers_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this customer.

Request Body schema:
email
string <email> [ 1 .. 254 ] characters
full_name
string [ 1 .. 255 ] characters
business
string <uuid>
phone_number
string <= 15 characters ^(9|7)\d{8}$

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "full_name": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "phone_number": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "full_name": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "phone_number": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

crms_customers_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this customer.

Responses

files

files_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{}

files_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
file
required
string <binary>
purpose
required
string (PurposeEnum)
Enum: "PROFILE_PICTURE" "ITEM" "RECEIPT" "CHAT" "REPORT" "INVOICE" "OTHER"
  • PROFILE_PICTURE - Profile Picture
  • ITEM - Item
  • RECEIPT - Receipt
  • CHAT - Chat
  • REPORT - Report
  • INVOICE - Invoice
  • OTHER - Other

Responses

Request samples

Content type
{
  • "file": "string",
  • "purpose": "PROFILE_PICTURE"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "file": "http://example.com",
  • "purpose": "PROFILE_PICTURE"
}

files_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this file model.

Responses

files_file_metas_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{}

files_file_metas_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
key
required
string [ 1 .. 255 ] characters

Responses

Request samples

Content type
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "content_length": 0,
  • "content_type": "string",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "meta_data": null
}

files_file_metas_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string

Responses

files_upload_signed_url_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
hash
required
string [ 1 .. 255 ] characters
size
required
integer [ 10 .. 6000 ]
ext
required
string
Enum: "png" "jpg" "heic" "jpeg" "gif" "pdf" "mp4" "mkv" "avi"
  • png - png
  • jpg - jpg
  • heic - heic
  • jpeg - jpeg
  • gif - gif
  • pdf - pdf
  • mp4 - mp4
  • mkv - mkv
  • avi - avi

Responses

Request samples

Content type
{
  • "hash": "string",
  • "size": 10,
  • "ext": "png"
}

Response samples

Content type
application/json
{
  • "size": 10,
  • "id": "string",
  • "signed_url": "string"
}

finances

finances_business_payment_methods_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

finances_business_payment_methods_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
label
required
string [ 1 .. 255 ] characters
identifier
required
string [ 1 .. 255 ] characters
payment
string or null <uuid>
business
required
string <uuid>
branch
string or null <uuid>

Responses

Request samples

Content type
{
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65"
}

finances_business_payment_methods_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this business payment method.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65"
}

finances_business_payment_methods_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this business payment method.

Request Body schema:
required
label
required
string [ 1 .. 255 ] characters
identifier
required
string [ 1 .. 255 ] characters
payment
string or null <uuid>
business
required
string <uuid>
branch
string or null <uuid>

Responses

Request samples

Content type
{
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65"
}

finances_business_payment_methods_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this business payment method.

Request Body schema:
label
string [ 1 .. 255 ] characters
identifier
string [ 1 .. 255 ] characters
payment
string or null <uuid>
business
string <uuid>
branch
string or null <uuid>

Responses

Request samples

Content type
{
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65"
}

finances_business_payment_methods_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this business payment method.

Responses

finances_payment_methods_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{}

finances_transactions_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

inventories

inventories_groups_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
business
string <uuid>
description
string
name
string
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{}

inventories_groups_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
name
required
string [ 1 .. 255 ] characters
description
required
string non-empty
business
required
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

inventories_groups_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this group.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

inventories_groups_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this group.

Request Body schema:
required
name
required
string [ 1 .. 255 ] characters
description
required
string non-empty
business
required
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

inventories_groups_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this group.

Request Body schema:
name
string [ 1 .. 255 ] characters
description
string non-empty
business
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

inventories_groups_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this group.

Responses

inventories_items_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
branch
string <uuid>
business
string <uuid>
categories
Array of strings <uuid> [ items <uuid > ]
description
string
group
string <uuid>
inventory_unit
string
name
string
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

inventories_items_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
name
required
string [ 1 .. 255 ] characters
description
required
string non-empty
min_selling_quota
integer <int64> [ 0 .. 9223372036854776000 ]
inventory_unit
required
string [ 1 .. 255 ] characters
quantity
integer [ 0 .. 2147483647 ]
notify_below
integer [ 0 .. 2147483647 ]
receive_online_orders
boolean
is_active
boolean
is_returnable
boolean
is_visible_online
boolean
group
string or null <uuid>
business
required
string <uuid>
branch
required
string <uuid>
categories
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "min_selling_quota": 9223372036854776000,
  • "inventory_unit": "string",
  • "quantity": 2147483647,
  • "notify_below": 2147483647,
  • "receive_online_orders": true,
  • "is_active": true,
  • "is_returnable": true,
  • "is_visible_online": true,
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "categories": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "min_selling_quota": 9223372036854776000,
  • "inventory_unit": "string",
  • "quantity": 2147483647,
  • "notify_below": 2147483647,
  • "receive_online_orders": true,
  • "is_active": true,
  • "is_returnable": true,
  • "is_visible_online": true,
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "categories": [
    ]
}

inventories_items_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this item.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "min_selling_quota": 9223372036854776000,
  • "inventory_unit": "string",
  • "quantity": 2147483647,
  • "notify_below": 2147483647,
  • "receive_online_orders": true,
  • "is_active": true,
  • "is_returnable": true,
  • "is_visible_online": true,
  • "group": {
    },
  • "business": {
    },
  • "branch": {
    },
  • "categories": [
    ]
}

inventories_items_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this item.

Request Body schema:
required
name
required
string [ 1 .. 255 ] characters
description
required
string non-empty
min_selling_quota
integer <int64> [ 0 .. 9223372036854776000 ]
inventory_unit
required
string [ 1 .. 255 ] characters
quantity
integer [ 0 .. 2147483647 ]
notify_below
integer [ 0 .. 2147483647 ]
receive_online_orders
boolean
is_active
boolean
is_returnable
boolean
is_visible_online
boolean
group
string or null <uuid>
business
required
string <uuid>
branch
required
string <uuid>
categories
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "min_selling_quota": 9223372036854776000,
  • "inventory_unit": "string",
  • "quantity": 2147483647,
  • "notify_below": 2147483647,
  • "receive_online_orders": true,
  • "is_active": true,
  • "is_returnable": true,
  • "is_visible_online": true,
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "categories": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "min_selling_quota": 9223372036854776000,
  • "inventory_unit": "string",
  • "quantity": 2147483647,
  • "notify_below": 2147483647,
  • "receive_online_orders": true,
  • "is_active": true,
  • "is_returnable": true,
  • "is_visible_online": true,
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "categories": [
    ]
}

inventories_items_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this item.

Request Body schema:
name
string [ 1 .. 255 ] characters
description
string non-empty
min_selling_quota
integer <int64> [ 0 .. 9223372036854776000 ]
inventory_unit
string [ 1 .. 255 ] characters
quantity
integer [ 0 .. 2147483647 ]
notify_below
integer [ 0 .. 2147483647 ]
receive_online_orders
boolean
is_active
boolean
is_returnable
boolean
is_visible_online
boolean
group
string or null <uuid>
business
string <uuid>
branch
string <uuid>
categories
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "min_selling_quota": 9223372036854776000,
  • "inventory_unit": "string",
  • "quantity": 2147483647,
  • "notify_below": 2147483647,
  • "receive_online_orders": true,
  • "is_active": true,
  • "is_returnable": true,
  • "is_visible_online": true,
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "categories": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "min_selling_quota": 9223372036854776000,
  • "inventory_unit": "string",
  • "quantity": 2147483647,
  • "notify_below": 2147483647,
  • "receive_online_orders": true,
  • "is_active": true,
  • "is_returnable": true,
  • "is_visible_online": true,
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "categories": [
    ]
}

inventories_items_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this item.

Responses

inventories_items_variants_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
item
string <uuid>
item__categories
string <uuid>
item__description
string
item__group
string <uuid>
item__group__name
string
item__name
string
name
string
page
integer

A page number within the paginated result set.

selling_price_max
number or null <double> [ 1 .. 10000000000 )
selling_price_min
number or null <double> [ 1 .. 10000000000 )
sku
string

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

inventories_items_variants_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
Array of objects (InnerPropertyRequest)
Array of objects (InnerPricingRequest)
name
required
string [ 1 .. 255 ] characters
quantity
integer [ 0 .. 2147483647 ]
sku
required
string [ 1 .. 255 ] characters
is_default
boolean
item
required
string <uuid>

Responses

Request samples

Content type
{
  • "properties": [
    ],
  • "pricings": [
    ],
  • "name": "string",
  • "quantity": 2147483647,
  • "sku": "string",
  • "is_default": true,
  • "item": "5953ca74-944e-4941-87b8-f4f42ef3ae12"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "properties": [
    ],
  • "pricings": [
    ],
  • "item_details": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "selling_price": -9999999999,
  • "quantity": 2147483647,
  • "sku": "string",
  • "is_default": true,
  • "item": "5953ca74-944e-4941-87b8-f4f42ef3ae12"
}

inventories_items_variants_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this item variant.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "selling_price": 1,
  • "quantity": 2147483647,
  • "sku": "string",
  • "is_default": true,
  • "item": {
    }
}

inventories_items_variants_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this item variant.

Request Body schema:
required
Array of objects (InnerPropertyRequest)
Array of objects (InnerPricingRequest)
name
required
string [ 1 .. 255 ] characters
quantity
integer [ 0 .. 2147483647 ]
sku
required
string [ 1 .. 255 ] characters
is_default
boolean
item
required
string <uuid>

Responses

Request samples

Content type
{
  • "properties": [
    ],
  • "pricings": [
    ],
  • "name": "string",
  • "quantity": 2147483647,
  • "sku": "string",
  • "is_default": true,
  • "item": "5953ca74-944e-4941-87b8-f4f42ef3ae12"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "properties": [
    ],
  • "pricings": [
    ],
  • "item_details": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "selling_price": -9999999999,
  • "quantity": 2147483647,
  • "sku": "string",
  • "is_default": true,
  • "item": "5953ca74-944e-4941-87b8-f4f42ef3ae12"
}

inventories_items_variants_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this item variant.

Request Body schema:
Array of objects (InnerPropertyRequest)
Array of objects (InnerPricingRequest)
name
string [ 1 .. 255 ] characters
quantity
integer [ 0 .. 2147483647 ]
sku
string [ 1 .. 255 ] characters
is_default
boolean
item
string <uuid>

Responses

Request samples

Content type
{
  • "properties": [
    ],
  • "pricings": [
    ],
  • "name": "string",
  • "quantity": 2147483647,
  • "sku": "string",
  • "is_default": true,
  • "item": "5953ca74-944e-4941-87b8-f4f42ef3ae12"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "properties": [
    ],
  • "pricings": [
    ],
  • "item_details": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "selling_price": -9999999999,
  • "quantity": 2147483647,
  • "sku": "string",
  • "is_default": true,
  • "item": "5953ca74-944e-4941-87b8-f4f42ef3ae12"
}

inventories_items_variants_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this item variant.

Responses

inventories_items_variants_pricings_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
price
required
integer <int64> [ 0 .. 9223372036854776000 ]
min_selling_quota
required
integer <int64> [ 0 .. 9223372036854776000 ]
item_variant
required
string <uuid>

Responses

Request samples

Content type
{
  • "price": 9223372036854776000,
  • "min_selling_quota": 9223372036854776000,
  • "item_variant": "50e3cff1-7840-46e0-8a27-e64fada2bf75"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "price": 9223372036854776000,
  • "min_selling_quota": 9223372036854776000,
  • "item_variant": "50e3cff1-7840-46e0-8a27-e64fada2bf75"
}

inventories_items_variants_pricings_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this item variant.

Request Body schema:
required
price
required
integer <int64> [ 0 .. 9223372036854776000 ]
min_selling_quota
required
integer <int64> [ 0 .. 9223372036854776000 ]
item_variant
required
string <uuid>

Responses

Request samples

Content type
{
  • "price": 9223372036854776000,
  • "min_selling_quota": 9223372036854776000,
  • "item_variant": "50e3cff1-7840-46e0-8a27-e64fada2bf75"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "price": 9223372036854776000,
  • "min_selling_quota": 9223372036854776000,
  • "item_variant": "50e3cff1-7840-46e0-8a27-e64fada2bf75"
}

inventories_items_variants_pricings_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this item variant.

Request Body schema:
price
integer <int64> [ 0 .. 9223372036854776000 ]
min_selling_quota
integer <int64> [ 0 .. 9223372036854776000 ]
item_variant
string <uuid>

Responses

Request samples

Content type
{
  • "price": 9223372036854776000,
  • "min_selling_quota": 9223372036854776000,
  • "item_variant": "50e3cff1-7840-46e0-8a27-e64fada2bf75"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "price": 9223372036854776000,
  • "min_selling_quota": 9223372036854776000,
  • "item_variant": "50e3cff1-7840-46e0-8a27-e64fada2bf75"
}

inventories_items_variants_pricings_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this item variant.

Responses

inventories_items_variants_properties_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
name
required
string [ 1 .. 255 ] characters
value
required
string [ 1 .. 255 ] characters
item_variant
required
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "value": "string",
  • "item_variant": "50e3cff1-7840-46e0-8a27-e64fada2bf75"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "value": "string",
  • "item_variant": "50e3cff1-7840-46e0-8a27-e64fada2bf75"
}

inventories_items_variants_properties_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this item variant.

Request Body schema:
required
name
required
string [ 1 .. 255 ] characters
value
required
string [ 1 .. 255 ] characters
item_variant
required
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "value": "string",
  • "item_variant": "50e3cff1-7840-46e0-8a27-e64fada2bf75"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "value": "string",
  • "item_variant": "50e3cff1-7840-46e0-8a27-e64fada2bf75"
}

inventories_items_variants_properties_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this item variant.

Request Body schema:
name
string [ 1 .. 255 ] characters
value
string [ 1 .. 255 ] characters
item_variant
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "value": "string",
  • "item_variant": "50e3cff1-7840-46e0-8a27-e64fada2bf75"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "value": "string",
  • "item_variant": "50e3cff1-7840-46e0-8a27-e64fada2bf75"
}

inventories_items_variants_properties_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this item variant.

Responses

inventories_movement_items_list

ViewSet for individual movement items

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

inventories_movement_items_create

ViewSet for individual movement items

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
quantity_requested
required
integer [ 0 .. 2147483647 ]
quantity_shipped
integer [ 0 .. 2147483647 ]
quantity_received
integer [ 0 .. 2147483647 ]
notes
string
movement
required
string <uuid>
variant
required
string <uuid>
supplied_item
required
string <uuid>

Responses

Request samples

Content type
{
  • "quantity_requested": 2147483647,
  • "quantity_shipped": 2147483647,
  • "quantity_received": 2147483647,
  • "notes": "string",
  • "movement": "7127e853-6eab-467a-a246-61a03f5a76db",
  • "variant": "142a232c-9f85-422c-a086-4c1a6a9a07f1",
  • "supplied_item": "e52bbc4f-d4b2-41ad-aa0a-e48d1d9588a6"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "supplied_item_details": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "quantity_requested": 2147483647,
  • "quantity_shipped": 2147483647,
  • "quantity_received": 2147483647,
  • "notes": "string",
  • "movement": "7127e853-6eab-467a-a246-61a03f5a76db",
  • "variant": "142a232c-9f85-422c-a086-4c1a6a9a07f1",
  • "supplied_item": "e52bbc4f-d4b2-41ad-aa0a-e48d1d9588a6"
}

inventories_movement_items_retrieve

ViewSet for individual movement items

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this inventory movement item.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "supplied_item_details": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "quantity_requested": 2147483647,
  • "quantity_shipped": 2147483647,
  • "quantity_received": 2147483647,
  • "notes": "string",
  • "movement": "7127e853-6eab-467a-a246-61a03f5a76db",
  • "variant": "142a232c-9f85-422c-a086-4c1a6a9a07f1",
  • "supplied_item": "e52bbc4f-d4b2-41ad-aa0a-e48d1d9588a6"
}

inventories_movement_items_update

ViewSet for individual movement items

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this inventory movement item.

Request Body schema:
required
quantity_requested
required
integer [ 0 .. 2147483647 ]
quantity_shipped
integer [ 0 .. 2147483647 ]
quantity_received
integer [ 0 .. 2147483647 ]
notes
string
movement
required
string <uuid>
variant
required
string <uuid>
supplied_item
required
string <uuid>

Responses

Request samples

Content type
{
  • "quantity_requested": 2147483647,
  • "quantity_shipped": 2147483647,
  • "quantity_received": 2147483647,
  • "notes": "string",
  • "movement": "7127e853-6eab-467a-a246-61a03f5a76db",
  • "variant": "142a232c-9f85-422c-a086-4c1a6a9a07f1",
  • "supplied_item": "e52bbc4f-d4b2-41ad-aa0a-e48d1d9588a6"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "supplied_item_details": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "quantity_requested": 2147483647,
  • "quantity_shipped": 2147483647,
  • "quantity_received": 2147483647,
  • "notes": "string",
  • "movement": "7127e853-6eab-467a-a246-61a03f5a76db",
  • "variant": "142a232c-9f85-422c-a086-4c1a6a9a07f1",
  • "supplied_item": "e52bbc4f-d4b2-41ad-aa0a-e48d1d9588a6"
}

inventories_movement_items_partial_update

ViewSet for individual movement items

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this inventory movement item.

Request Body schema:
quantity_requested
integer [ 0 .. 2147483647 ]
quantity_shipped
integer [ 0 .. 2147483647 ]
quantity_received
integer [ 0 .. 2147483647 ]
notes
string
movement
string <uuid>
variant
string <uuid>
supplied_item
string <uuid>

Responses

Request samples

Content type
{
  • "quantity_requested": 2147483647,
  • "quantity_shipped": 2147483647,
  • "quantity_received": 2147483647,
  • "notes": "string",
  • "movement": "7127e853-6eab-467a-a246-61a03f5a76db",
  • "variant": "142a232c-9f85-422c-a086-4c1a6a9a07f1",
  • "supplied_item": "e52bbc4f-d4b2-41ad-aa0a-e48d1d9588a6"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "supplied_item_details": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "quantity_requested": 2147483647,
  • "quantity_shipped": 2147483647,
  • "quantity_received": 2147483647,
  • "notes": "string",
  • "movement": "7127e853-6eab-467a-a246-61a03f5a76db",
  • "variant": "142a232c-9f85-422c-a086-4c1a6a9a07f1",
  • "supplied_item": "e52bbc4f-d4b2-41ad-aa0a-e48d1d9588a6"
}

inventories_movement_items_destroy

ViewSet for individual movement items

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this inventory movement item.

Responses

inventories_movements_list

ViewSet for managing inventory movements between branches

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

inventories_movements_create

ViewSet for managing inventory movements between branches

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
from_branch
required
string <uuid>
to_branch
required
string <uuid>
notes
string
required
Array of objects

Responses

Request samples

Content type
{
  • "from_branch": "3b260f01-53f1-4633-bb06-1415bb422479",
  • "to_branch": "a2e16236-0920-4e56-855e-19184448c915",
  • "notes": "string",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "from_branch": "3b260f01-53f1-4633-bb06-1415bb422479",
  • "to_branch": "a2e16236-0920-4e56-855e-19184448c915",
  • "notes": "string"
}

inventories_movements_retrieve

ViewSet for managing inventory movements between branches

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this inventory movement.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "movement_items": [
    ],
  • "from_branch_name": "string",
  • "to_branch_name": "string",
  • "requested_by_name": "string",
  • "status_display": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "movement_number": "string",
  • "status": "pending",
  • "notes": "string",
  • "approved_at": "2019-08-24T14:15:22Z",
  • "shipped_at": "2019-08-24T14:15:22Z",
  • "received_at": "2019-08-24T14:15:22Z",
  • "from_branch": "3b260f01-53f1-4633-bb06-1415bb422479",
  • "to_branch": "a2e16236-0920-4e56-855e-19184448c915",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826",
  • "approved_by": "02030314-b162-4b4d-8af1-88eabdcc615d",
  • "shipped_by": "8fbd1fa6-cc4f-452e-9658-18ef16c93e60",
  • "received_by": "bddb0072-16e3-43f3-b441-8926c9706607"
}

inventories_movements_update

ViewSet for managing inventory movements between branches

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this inventory movement.

Request Body schema:
required
status
string (InventoryMovementStatusEnum)
Enum: "pending" "approved" "shipped" "received" "cancelled"
  • pending - Pending
  • approved - Approved
  • shipped - Shipped
  • received - Received
  • cancelled - Cancelled
notes
string
from_branch
required
string <uuid>
to_branch
required
string <uuid>
business
required
string <uuid>
requested_by
string or null <uuid>

Responses

Request samples

Content type
{
  • "status": "pending",
  • "notes": "string",
  • "from_branch": "3b260f01-53f1-4633-bb06-1415bb422479",
  • "to_branch": "a2e16236-0920-4e56-855e-19184448c915",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "movement_items": [
    ],
  • "from_branch_name": "string",
  • "to_branch_name": "string",
  • "requested_by_name": "string",
  • "status_display": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "movement_number": "string",
  • "status": "pending",
  • "notes": "string",
  • "approved_at": "2019-08-24T14:15:22Z",
  • "shipped_at": "2019-08-24T14:15:22Z",
  • "received_at": "2019-08-24T14:15:22Z",
  • "from_branch": "3b260f01-53f1-4633-bb06-1415bb422479",
  • "to_branch": "a2e16236-0920-4e56-855e-19184448c915",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826",
  • "approved_by": "02030314-b162-4b4d-8af1-88eabdcc615d",
  • "shipped_by": "8fbd1fa6-cc4f-452e-9658-18ef16c93e60",
  • "received_by": "bddb0072-16e3-43f3-b441-8926c9706607"
}

inventories_movements_partial_update

ViewSet for managing inventory movements between branches

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this inventory movement.

Request Body schema:
status
string (InventoryMovementStatusEnum)
Enum: "pending" "approved" "shipped" "received" "cancelled"
  • pending - Pending
  • approved - Approved
  • shipped - Shipped
  • received - Received
  • cancelled - Cancelled
notes
string
from_branch
string <uuid>
to_branch
string <uuid>
business
string <uuid>
requested_by
string or null <uuid>

Responses

Request samples

Content type
{
  • "status": "pending",
  • "notes": "string",
  • "from_branch": "3b260f01-53f1-4633-bb06-1415bb422479",
  • "to_branch": "a2e16236-0920-4e56-855e-19184448c915",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "movement_items": [
    ],
  • "from_branch_name": "string",
  • "to_branch_name": "string",
  • "requested_by_name": "string",
  • "status_display": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "movement_number": "string",
  • "status": "pending",
  • "notes": "string",
  • "approved_at": "2019-08-24T14:15:22Z",
  • "shipped_at": "2019-08-24T14:15:22Z",
  • "received_at": "2019-08-24T14:15:22Z",
  • "from_branch": "3b260f01-53f1-4633-bb06-1415bb422479",
  • "to_branch": "a2e16236-0920-4e56-855e-19184448c915",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826",
  • "approved_by": "02030314-b162-4b4d-8af1-88eabdcc615d",
  • "shipped_by": "8fbd1fa6-cc4f-452e-9658-18ef16c93e60",
  • "received_by": "bddb0072-16e3-43f3-b441-8926c9706607"
}

inventories_movements_destroy

ViewSet for managing inventory movements between branches

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this inventory movement.

Responses

inventories_movements_approve_create

Approve a pending inventory movement

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this inventory movement.

Request Body schema:
required
status
string (InventoryMovementStatusEnum)
Enum: "pending" "approved" "shipped" "received" "cancelled"
  • pending - Pending
  • approved - Approved
  • shipped - Shipped
  • received - Received
  • cancelled - Cancelled
notes
string
from_branch
required
string <uuid>
to_branch
required
string <uuid>
business
required
string <uuid>
requested_by
string or null <uuid>

Responses

Request samples

Content type
{
  • "status": "pending",
  • "notes": "string",
  • "from_branch": "3b260f01-53f1-4633-bb06-1415bb422479",
  • "to_branch": "a2e16236-0920-4e56-855e-19184448c915",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "movement_items": [
    ],
  • "from_branch_name": "string",
  • "to_branch_name": "string",
  • "requested_by_name": "string",
  • "status_display": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "movement_number": "string",
  • "status": "pending",
  • "notes": "string",
  • "approved_at": "2019-08-24T14:15:22Z",
  • "shipped_at": "2019-08-24T14:15:22Z",
  • "received_at": "2019-08-24T14:15:22Z",
  • "from_branch": "3b260f01-53f1-4633-bb06-1415bb422479",
  • "to_branch": "a2e16236-0920-4e56-855e-19184448c915",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826",
  • "approved_by": "02030314-b162-4b4d-8af1-88eabdcc615d",
  • "shipped_by": "8fbd1fa6-cc4f-452e-9658-18ef16c93e60",
  • "received_by": "bddb0072-16e3-43f3-b441-8926c9706607"
}

inventories_movements_cancel_create

Cancel a movement (only if pending or approved)

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this inventory movement.

Request Body schema:
required
status
string (InventoryMovementStatusEnum)
Enum: "pending" "approved" "shipped" "received" "cancelled"
  • pending - Pending
  • approved - Approved
  • shipped - Shipped
  • received - Received
  • cancelled - Cancelled
notes
string
from_branch
required
string <uuid>
to_branch
required
string <uuid>
business
required
string <uuid>
requested_by
string or null <uuid>

Responses

Request samples

Content type
{
  • "status": "pending",
  • "notes": "string",
  • "from_branch": "3b260f01-53f1-4633-bb06-1415bb422479",
  • "to_branch": "a2e16236-0920-4e56-855e-19184448c915",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "movement_items": [
    ],
  • "from_branch_name": "string",
  • "to_branch_name": "string",
  • "requested_by_name": "string",
  • "status_display": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "movement_number": "string",
  • "status": "pending",
  • "notes": "string",
  • "approved_at": "2019-08-24T14:15:22Z",
  • "shipped_at": "2019-08-24T14:15:22Z",
  • "received_at": "2019-08-24T14:15:22Z",
  • "from_branch": "3b260f01-53f1-4633-bb06-1415bb422479",
  • "to_branch": "a2e16236-0920-4e56-855e-19184448c915",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826",
  • "approved_by": "02030314-b162-4b4d-8af1-88eabdcc615d",
  • "shipped_by": "8fbd1fa6-cc4f-452e-9658-18ef16c93e60",
  • "received_by": "bddb0072-16e3-43f3-b441-8926c9706607"
}

inventories_movements_receive_create

Mark movement as received and add inventory to destination

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this inventory movement.

Request Body schema:
required
status
string (InventoryMovementStatusEnum)
Enum: "pending" "approved" "shipped" "received" "cancelled"
  • pending - Pending
  • approved - Approved
  • shipped - Shipped
  • received - Received
  • cancelled - Cancelled
notes
string
from_branch
required
string <uuid>
to_branch
required
string <uuid>
business
required
string <uuid>
requested_by
string or null <uuid>

Responses

Request samples

Content type
{
  • "status": "pending",
  • "notes": "string",
  • "from_branch": "3b260f01-53f1-4633-bb06-1415bb422479",
  • "to_branch": "a2e16236-0920-4e56-855e-19184448c915",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "movement_items": [
    ],
  • "from_branch_name": "string",
  • "to_branch_name": "string",
  • "requested_by_name": "string",
  • "status_display": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "movement_number": "string",
  • "status": "pending",
  • "notes": "string",
  • "approved_at": "2019-08-24T14:15:22Z",
  • "shipped_at": "2019-08-24T14:15:22Z",
  • "received_at": "2019-08-24T14:15:22Z",
  • "from_branch": "3b260f01-53f1-4633-bb06-1415bb422479",
  • "to_branch": "a2e16236-0920-4e56-855e-19184448c915",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826",
  • "approved_by": "02030314-b162-4b4d-8af1-88eabdcc615d",
  • "shipped_by": "8fbd1fa6-cc4f-452e-9658-18ef16c93e60",
  • "received_by": "bddb0072-16e3-43f3-b441-8926c9706607"
}

inventories_movements_ship_create

Mark movement as shipped and reduce inventory from source

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this inventory movement.

Request Body schema:
required
status
string (InventoryMovementStatusEnum)
Enum: "pending" "approved" "shipped" "received" "cancelled"
  • pending - Pending
  • approved - Approved
  • shipped - Shipped
  • received - Received
  • cancelled - Cancelled
notes
string
from_branch
required
string <uuid>
to_branch
required
string <uuid>
business
required
string <uuid>
requested_by
string or null <uuid>

Responses

Request samples

Content type
{
  • "status": "pending",
  • "notes": "string",
  • "from_branch": "3b260f01-53f1-4633-bb06-1415bb422479",
  • "to_branch": "a2e16236-0920-4e56-855e-19184448c915",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "movement_items": [
    ],
  • "from_branch_name": "string",
  • "to_branch_name": "string",
  • "requested_by_name": "string",
  • "status_display": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "movement_number": "string",
  • "status": "pending",
  • "notes": "string",
  • "approved_at": "2019-08-24T14:15:22Z",
  • "shipped_at": "2019-08-24T14:15:22Z",
  • "received_at": "2019-08-24T14:15:22Z",
  • "from_branch": "3b260f01-53f1-4633-bb06-1415bb422479",
  • "to_branch": "a2e16236-0920-4e56-855e-19184448c915",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826",
  • "approved_by": "02030314-b162-4b4d-8af1-88eabdcc615d",
  • "shipped_by": "8fbd1fa6-cc4f-452e-9658-18ef16c93e60",
  • "received_by": "bddb0072-16e3-43f3-b441-8926c9706607"
}

inventories_supplied_items_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
quantity
required
integer [ 0 .. 2147483647 ]
initial_quantity
integer [ 0 .. 2147483647 ]
purchase_price
required
number <double> [ 1 .. 10000000000 )
selling_price
required
number <double> [ 1 .. 10000000000 )
is_returnable
boolean
is_visible_online
boolean
notify_below
integer [ 0 .. 2147483647 ]
batch_number
required
string [ 1 .. 255 ] characters
product_number
required
string [ 1 .. 255 ] characters
expire_date
string or null <date>
man_date
string or null <date>
item
string or null <uuid>
variant
required
string <uuid>
supply
required
string <uuid>
business
required
string <uuid>

Responses

Request samples

Content type
{
  • "quantity": 2147483647,
  • "initial_quantity": 2147483647,
  • "purchase_price": 1,
  • "selling_price": 1,
  • "is_returnable": true,
  • "is_visible_online": true,
  • "notify_below": 2147483647,
  • "batch_number": "string",
  • "product_number": "string",
  • "expire_date": "2019-08-24",
  • "man_date": "2019-08-24",
  • "item": "5953ca74-944e-4941-87b8-f4f42ef3ae12",
  • "variant": "142a232c-9f85-422c-a086-4c1a6a9a07f1",
  • "supply": "e9d6a0f2-def8-468d-8f13-287d9fa75962",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "quantity": 2147483647,
  • "initial_quantity": 2147483647,
  • "purchase_price": 1,
  • "selling_price": 1,
  • "is_returnable": true,
  • "is_visible_online": true,
  • "notify_below": 2147483647,
  • "batch_number": "string",
  • "product_number": "string",
  • "expire_date": "2019-08-24",
  • "man_date": "2019-08-24",
  • "item": "5953ca74-944e-4941-87b8-f4f42ef3ae12",
  • "variant": "142a232c-9f85-422c-a086-4c1a6a9a07f1",
  • "supply": "e9d6a0f2-def8-468d-8f13-287d9fa75962",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

inventories_suppliers_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
business
string <uuid>
email
string
name
string
page
integer

A page number within the paginated result set.

phone_number
string

Responses

Response samples

Content type
application/json
{}

inventories_suppliers_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
name
required
string [ 1 .. 255 ] characters
email
required
string <email> [ 1 .. 254 ] characters
phone_number
string <= 15 characters ^(9|7)\d{8}$
business
required
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "email": "user@example.com",
  • "phone_number": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

inventories_supplies_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

inventories_supplies_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
object (SuppliedItemInSupplyRequest)
label
required
string [ 1 .. 255 ] characters
no_of_items
integer [ 0 .. 2147483647 ]
total_cost
number <double> [ 1 .. 10000000000 )
branch
required
string <uuid>
business
required
string or null <uuid>
supplier
string or null <uuid>
payment_method
string or null <uuid>

Responses

Request samples

Content type
{
  • "item": {
    },
  • "label": "string",
  • "no_of_items": 2147483647,
  • "total_cost": 1,
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "supplier": "acc345c7-457d-43bb-ac95-81572c2199bb",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "item": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "label": "string",
  • "no_of_items": 2147483647,
  • "total_cost": 1,
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "supplier": "acc345c7-457d-43bb-ac95-81572c2199bb",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

inventories_supplies_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this Supply.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "supplied_items": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "label": "string",
  • "no_of_items": 2147483647,
  • "total_cost": 1,
  • "branch": {
    },
  • "business": {
    },
  • "supplier": {
    },
  • "payment_method": {
    }
}

markets

markets_businesses_retrieve

Business information for marketplace

Authorizations:
basicAuthcookieAuthjwtAuthNone

Responses

markets_businesses_retrieve_2

Business information for marketplace

Authorizations:
basicAuthcookieAuthjwtAuthNone
path Parameters
id
required
string <uuid>

A UUID string identifying this business.

Responses

markets_businesses_products_retrieve

Get products for a specific business

Authorizations:
basicAuthcookieAuthjwtAuthNone
path Parameters
id
required
string <uuid>

A UUID string identifying this business.

Responses

markets_categories_list

Category management for marketplace with product counts and filtering

Authorizations:
basicAuthcookieAuthjwtAuthNone
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

search
string

A search term.

Responses

Response samples

Content type
application/json
{}

markets_categories_retrieve

Category management for marketplace with product counts and filtering

Authorizations:
basicAuthcookieAuthjwtAuthNone
path Parameters
id
required
string <uuid>

A UUID string identifying this category.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "industry": "string",
  • "image": "string",
  • "product_count": "string",
  • "is_active": true
}

markets_categories_tree_retrieve

Get categories organized by industry

Authorizations:
basicAuthcookieAuthjwtAuthNone

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "industry": "string",
  • "image": "string",
  • "product_count": "string",
  • "is_active": true
}

markets_products_list

List marketplace products with comprehensive filtering options

Authorizations:
basicAuthcookieAuthjwtAuthNone
query Parameters
business_types
Array of strings

Filter by business types

businesses
Array of strings

Filter by business IDs

categories
Array of strings

Filter by category IDs

expire_date_from
string <date>

Filter by expiry date from

expire_date_to
string <date>

Filter by expiry date to

in_stock_only
boolean

Show only in-stock items

industries
Array of strings

Filter by industry IDs

max_price
number <double>

Maximum price filter

min_price
number <double>

Minimum price filter

min_quantity
integer

Minimum quantity filter

ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

properties
string

Filter by properties (format: name:value,name2:value2)

q
string

Advanced search query

search
string

A search term.

verified_only
boolean

Show only verified businesses

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

markets_products_retrieve

Comprehensive marketplace product endpoints with advanced filtering and search Focus on ItemVariant as the main marketplace product entity

Authorizations:
basicAuthcookieAuthjwtAuthNone
path Parameters
id
required
string <uuid>

A UUID string identifying this item variant.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "selling_price": 1,
  • "quantity": 2147483647,
  • "sku": "string",
  • "is_default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "item_name": "string",
  • "item_description": "string",
  • "item_images": "string",
  • "inventory_unit": "string",
  • "business": {
    },
  • "categories": [
    ],
  • "properties": [
    ],
  • "pricings": [
    ],
  • "is_in_stock": "string",
  • "stock_status": "string",
  • "discount_percentage": "string",
  • "average_rating": "string",
  • "is_available_online": "string"
}

markets_products_similar_retrieve

Get similar products based on category and properties

Authorizations:
basicAuthcookieAuthjwtAuthNone
path Parameters
id
required
string <uuid>

A UUID string identifying this item variant.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "selling_price": 1,
  • "quantity": 2147483647,
  • "sku": "string",
  • "is_default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "item_name": "string",
  • "item_description": "string",
  • "item_images": "string",
  • "inventory_unit": "string",
  • "business": {
    },
  • "categories": [
    ],
  • "properties": [
    ],
  • "pricings": [
    ],
  • "is_in_stock": "string",
  • "stock_status": "string",
  • "discount_percentage": "string",
  • "average_rating": "string",
  • "is_available_online": "string"
}

markets_products_advanced_search_create

Advanced search with multiple criteria

Authorizations:
basicAuthcookieAuthjwtAuthNone
Request Body schema:
required
name
required
string [ 1 .. 255 ] characters
selling_price
number or null <double> [ 1 .. 10000000000 )
quantity
integer [ 0 .. 2147483647 ]
sku
required
string [ 1 .. 255 ] characters
is_default
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "selling_price": 1,
  • "quantity": 2147483647,
  • "sku": "string",
  • "is_default": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "selling_price": 1,
  • "quantity": 2147483647,
  • "sku": "string",
  • "is_default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "item_name": "string",
  • "item_description": "string",
  • "item_images": "string",
  • "inventory_unit": "string",
  • "business": {
    },
  • "categories": [
    ],
  • "properties": [
    ],
  • "pricings": [
    ],
  • "is_in_stock": "string",
  • "stock_status": "string",
  • "discount_percentage": "string",
  • "average_rating": "string",
  • "is_available_online": "string"
}

markets_products_low_stock_retrieve

Get products with low stock (for businesses to manage inventory)

Authorizations:
basicAuthcookieAuthjwtAuthNone

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "selling_price": 1,
  • "quantity": 2147483647,
  • "sku": "string",
  • "is_default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "item_name": "string",
  • "item_description": "string",
  • "item_images": "string",
  • "inventory_unit": "string",
  • "business": {
    },
  • "categories": [
    ],
  • "properties": [
    ],
  • "pricings": [
    ],
  • "is_in_stock": "string",
  • "stock_status": "string",
  • "discount_percentage": "string",
  • "average_rating": "string",
  • "is_available_online": "string"
}

markets_stats_categories_stats_retrieve

Get statistics by category

Authorizations:
basicAuthcookieAuthjwtAuthNone

Responses

markets_stats_overview_retrieve

Get marketplace overview statistics

Authorizations:
basicAuthcookieAuthjwtAuthNone

Responses

notifications

notifications_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
created_at
string <date-time>
delivery_method
string
Enum: "all" "email" "push" "sms"
  • email - Email
  • push - Push
  • sms - SMS
  • all - All
notification_type
string
Enum: "error" "info" "success" "warning"
  • info - Info
  • warning - Warning
  • error - Error
  • success - Success
page
integer

A page number within the paginated result set.

timestamp
string <date>

Responses

Response samples

Content type
application/json
{}

notifications_mark_as_read_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
notification_ids
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "notification_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "notification_ids": [
    ]
}

orders

Get home dashboard statistics

Returns best seller, sales distribution, and summary statistics for the dashboard

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
branch
string <uuid>

Branch ID (UUID). Can also use 'branch_id'

business
string <uuid>

Business ID (UUID). Can also use 'business_id'

end_date
string <date>

End date for custom_range (format: YYYY-MM-DD)

sales-distribution-range
string

Range for sales distribution: this_week, this_month, this_year, custom_range

start_date
string <date>

Start date for custom_range (format: YYYY-MM-DD)

summary-range
string

Range for summary stats: today, this_week, this_month, this_year

Responses

Response samples

Content type
application/json
{
  • "bestSeller": {
    },
  • "salesDistribution": {
    },
  • "summary": {
    }
}

orders_orders_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
branch
string <uuid>
business
string <uuid>
page
integer

A page number within the paginated result set.

status
string
Enum: "CANCELLED" "COMPLETED" "CONFIRMED" "DELIVERED" "ON_HOLD" "PAID" "PARTIALLY_PAID" "PENDING" "PROCESSING" "REFUNDED" "RETURNED" "SHIPPED"
  • PENDING - Pending
  • PROCESSING - Processing
  • CONFIRMED - Confirmed
  • SHIPPED - Shipped
  • DELIVERED - Delivered
  • COMPLETED - Completed
  • PARTIALLY_PAID - Partially Paid
  • PAID - Paid
  • ON_HOLD - On Hold
  • CANCELLED - Cancelled
  • REFUNDED - Refunded
  • RETURNED - Returned

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

orders_orders_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
required
Array of objects (InternalOrderItemRequest)
total_payable
number <double> ( -100000000 .. 100000000 )
status
string (StatusC09Enum)
Enum: "PENDING" "PROCESSING" "CONFIRMED" "SHIPPED" "DELIVERED" "COMPLETED" "PARTIALLY_PAID" "PAID" "ON_HOLD" "CANCELLED" "REFUNDED" "RETURNED"
  • PENDING - Pending
  • PROCESSING - Processing
  • CONFIRMED - Confirmed
  • SHIPPED - Shipped
  • DELIVERED - Delivered
  • COMPLETED - Completed
  • PARTIALLY_PAID - Partially Paid
  • PAID - Paid
  • ON_HOLD - On Hold
  • CANCELLED - Cancelled
  • REFUNDED - Refunded
  • RETURNED - Returned
additional_info
any or null
customer
string or null <uuid>
payment_method
string or null <uuid>

Responses

Request samples

Content type
{
  • "item_variants": [
    ],
  • "total_payable": -99999999,
  • "status": "PENDING",
  • "additional_info": null,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customer_name": "string",
  • "employee_name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "total_payable": -99999999,
  • "status": "PENDING",
  • "additional_info": null,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

orders_orders_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this order.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "items": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "total_payable": -99999999,
  • "status": "PENDING",
  • "additional_info": null,
  • "customer": {
    },
  • "employee": {
    },
  • "payment_method": {
    },
  • "business": {
    },
  • "branch": {
    }
}

orders_orders_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this order.

Request Body schema:
Array of objects (InternalOrderItemRequest)
total_payable
number <double> ( -100000000 .. 100000000 )
status
string (StatusC09Enum)
Enum: "PENDING" "PROCESSING" "CONFIRMED" "SHIPPED" "DELIVERED" "COMPLETED" "PARTIALLY_PAID" "PAID" "ON_HOLD" "CANCELLED" "REFUNDED" "RETURNED"
  • PENDING - Pending
  • PROCESSING - Processing
  • CONFIRMED - Confirmed
  • SHIPPED - Shipped
  • DELIVERED - Delivered
  • COMPLETED - Completed
  • PARTIALLY_PAID - Partially Paid
  • PAID - Paid
  • ON_HOLD - On Hold
  • CANCELLED - Cancelled
  • REFUNDED - Refunded
  • RETURNED - Returned
additional_info
any or null
customer
string or null <uuid>
payment_method
string or null <uuid>

Responses

Request samples

Content type
{
  • "item_variants": [
    ],
  • "total_payable": -99999999,
  • "status": "PENDING",
  • "additional_info": null,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customer_name": "string",
  • "employee_name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "total_payable": -99999999,
  • "status": "PENDING",
  • "additional_info": null,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

orders_orders_checkout_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this order.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customer_name": "string",
  • "employee_name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "total_payable": -99999999,
  • "status": "PENDING",
  • "additional_info": null,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

schema

schema_retrieve

OpenApi3 schema for this API. Format can be selected via content negotiation.

  • YAML: application/vnd.oai.openapi
  • JSON: application/vnd.oai.openapi+json
Authorizations:
basicAuthcookieAuthjwtAuthNone
query Parameters
format
string
Enum: "json" "yaml"
lang
string
Enum: "af" "ar" "ar-dz" "ast" "az" "be" "bg" "bn" "br" "bs" "ca" "ckb" "cs" "cy" "da" "de" "dsb" "el" "en" "en-au" "en-gb" "eo" "es" "es-ar" "es-co" "es-mx" "es-ni" "es-ve" "et" "eu" "fa" "fi" "fr" "fy" "ga" "gd" "gl" "he" "hi" "hr" "hsb" "hu" "hy" "ia" "id" "ig" "io" "is" "it" "ja" "ka" "kab" "kk" "km" "kn" "ko" "ky" "lb" "lt" "lv" "mk" "ml" "mn" "mr" "ms" "my" "nb" "ne" "nl" "nn" "os" "pa" "pl" "pt" "pt-br" "ro" "ru" "sk" "sl" "sq" "sr" "sr-latn" "sv" "sw" "ta" "te" "tg" "th" "tk" "tr" "tt" "udm" "ug" "uk" "ur" "uz" "vi" "zh-hans" "zh-hant"

Responses

Response samples

Content type
No sample