API docs by Redocly

API Documentation (0.0.1)

Download OpenAPI specification:

Description of documentation

accounts

accounts_auth_email_change_confirm_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_auth_email_change_request_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_auth_google_login_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_auth_login_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_auth_password_change_partial_update

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_auth_password_reset_confirm_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_auth_password_reset_request_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_auth_phone_change_confirm_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_auth_phone_change_request_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_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:
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_auth_verifications_confirm_create

Authorizations:
basicAuthcookieAuthjwtAuthNone
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_auth_verifications_send_create

Authorizations:
basicAuthcookieAuthjwtAuthNone
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_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

Responses

Request samples

Content type
{
  • "fcm_token": "string",
  • "label": "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"
}

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
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
name
required
string [ 1 .. 255 ] characters
address
string or null <uuid>
business
string or null <uuid>

Responses

Request samples

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

Response samples

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

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",
  • "current_user_role": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "address": "acc2de7d-9959-4ca0-9dda-9b7ef1cd4c6c",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

business_branches_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this branch.

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

Responses

Request samples

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

Response samples

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

business_branches_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this branch.

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

Responses

Request samples

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

Response samples

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

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",
  • "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",
  • "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",
  • "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",
  • "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_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",
  • "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",
  • "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",
  • "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",
  • "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",
  • "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",
  • "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",
  • "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",
  • "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",
  • "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",
  • "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",
  • "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_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": "string",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

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_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"
}

financials

financials_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": [
    ]
}

financials_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>

Responses

Request samples

Content type
{
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "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",
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

financials_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"
}

financials_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>

Responses

Request samples

Content type
{
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "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",
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

financials_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>

Responses

Request samples

Content type
{
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "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",
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

financials_business_payment_methods_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this business payment method.

Responses

financials_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": [
    ]
}

financials_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>

Responses

Request samples

Content type
{
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "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",
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

financials_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"
}

financials_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>

Responses

Request samples

Content type
{
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "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",
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

financials_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>

Responses

Request samples

Content type
{
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "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",
  • "label": "string",
  • "identifier": "string",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330"
}

financials_payment_methods_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this business payment method.

Responses

financials_transactions_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{}

financials_transactions_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
type
required
string (TypeEnum)
Enum: "SALE" "EXPENSE" "DEBT" "REFUND"
  • SALE - Sale
  • EXPENSE - Expense
  • DEBT - Debt
  • REFUND - Refund
total_paid_amount
required
string <decimal> ^-?\d{0,8}(?:\.\d{0,2})?$
total_left_amount
required
string <decimal> ^-?\d{0,8}(?:\.\d{0,2})?$
order
string or null <uuid>

Responses

Request samples

Content type
{
  • "type": "SALE",
  • "total_paid_amount": "string",
  • "total_left_amount": "string",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce"
}

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",
  • "type": "SALE",
  • "total_paid_amount": "string",
  • "total_left_amount": "string",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce"
}

financials_transactions_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this transaction.

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",
  • "type": "SALE",
  • "total_paid_amount": "string",
  • "total_left_amount": "string",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce"
}

inventories

inventories_groups_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
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
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
group
string or null <uuid>
business
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",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "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",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "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",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "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
group
string or null <uuid>
business
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",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "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",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "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
group
string or null <uuid>
business
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",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "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",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "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
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_variants_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
name
required
string [ 1 .. 255 ] characters
quantity
required
integer [ 0 .. 2147483647 ]
selling_price
required
string <decimal> ^-?\d{0,10}(?:\.\d{0,2})?$
batch_number
required
string [ 1 .. 255 ] characters
sku
required
string [ 1 .. 255 ] characters
expire_date
string or null <date>
man_date
string or null <date>
is_default
boolean
is_returnable
boolean
is_visible_online
boolean
receive_online_orders
boolean
notify_below
required
integer <int64> [ 0 .. 9223372036854776000 ]
item
required
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "quantity": 2147483647,
  • "selling_price": "string",
  • "batch_number": "string",
  • "sku": "string",
  • "expire_date": "2019-08-24",
  • "man_date": "2019-08-24",
  • "is_default": true,
  • "is_returnable": true,
  • "is_visible_online": true,
  • "receive_online_orders": true,
  • "notify_below": 9223372036854776000,
  • "item": "5953ca74-944e-4941-87b8-f4f42ef3ae12"
}

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",
  • "quantity": 2147483647,
  • "selling_price": "string",
  • "batch_number": "string",
  • "sku": "string",
  • "expire_date": "2019-08-24",
  • "man_date": "2019-08-24",
  • "is_default": true,
  • "is_returnable": true,
  • "is_visible_online": true,
  • "receive_online_orders": true,
  • "notify_below": 9223372036854776000,
  • "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",
  • "quantity": 2147483647,
  • "selling_price": "string",
  • "batch_number": "string",
  • "sku": "string",
  • "expire_date": "2019-08-24",
  • "man_date": "2019-08-24",
  • "is_default": true,
  • "is_returnable": true,
  • "is_visible_online": true,
  • "receive_online_orders": true,
  • "notify_below": 9223372036854776000,
  • "item": "5953ca74-944e-4941-87b8-f4f42ef3ae12"
}

inventories_items_variants_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
quantity
required
integer [ 0 .. 2147483647 ]
selling_price
required
string <decimal> ^-?\d{0,10}(?:\.\d{0,2})?$
batch_number
required
string [ 1 .. 255 ] characters
sku
required
string [ 1 .. 255 ] characters
expire_date
string or null <date>
man_date
string or null <date>
is_default
boolean
is_returnable
boolean
is_visible_online
boolean
receive_online_orders
boolean
notify_below
required
integer <int64> [ 0 .. 9223372036854776000 ]
item
required
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "quantity": 2147483647,
  • "selling_price": "string",
  • "batch_number": "string",
  • "sku": "string",
  • "expire_date": "2019-08-24",
  • "man_date": "2019-08-24",
  • "is_default": true,
  • "is_returnable": true,
  • "is_visible_online": true,
  • "receive_online_orders": true,
  • "notify_below": 9223372036854776000,
  • "item": "5953ca74-944e-4941-87b8-f4f42ef3ae12"
}

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",
  • "quantity": 2147483647,
  • "selling_price": "string",
  • "batch_number": "string",
  • "sku": "string",
  • "expire_date": "2019-08-24",
  • "man_date": "2019-08-24",
  • "is_default": true,
  • "is_returnable": true,
  • "is_visible_online": true,
  • "receive_online_orders": true,
  • "notify_below": 9223372036854776000,
  • "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:
name
string [ 1 .. 255 ] characters
quantity
integer [ 0 .. 2147483647 ]
selling_price
string <decimal> ^-?\d{0,10}(?:\.\d{0,2})?$
batch_number
string [ 1 .. 255 ] characters
sku
string [ 1 .. 255 ] characters
expire_date
string or null <date>
man_date
string or null <date>
is_default
boolean
is_returnable
boolean
is_visible_online
boolean
receive_online_orders
boolean
notify_below
integer <int64> [ 0 .. 9223372036854776000 ]
item
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "quantity": 2147483647,
  • "selling_price": "string",
  • "batch_number": "string",
  • "sku": "string",
  • "expire_date": "2019-08-24",
  • "man_date": "2019-08-24",
  • "is_default": true,
  • "is_returnable": true,
  • "is_visible_online": true,
  • "receive_online_orders": true,
  • "notify_below": 9223372036854776000,
  • "item": "5953ca74-944e-4941-87b8-f4f42ef3ae12"
}

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",
  • "quantity": 2147483647,
  • "selling_price": "string",
  • "batch_number": "string",
  • "sku": "string",
  • "expire_date": "2019-08-24",
  • "man_date": "2019-08-24",
  • "is_default": true,
  • "is_returnable": true,
  • "is_visible_online": true,
  • "receive_online_orders": true,
  • "notify_below": 9223372036854776000,
  • "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_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>
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",
  • "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",
  • "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",
  • "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>
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",
  • "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",
  • "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>
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",
  • "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",
  • "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_pricings_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{}

inventories_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_pricings_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this pricing.

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",
  • "price": 9223372036854776000,
  • "min_selling_quota": 9223372036854776000,
  • "item_variant": "50e3cff1-7840-46e0-8a27-e64fada2bf75"
}

inventories_pricings_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this pricing.

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_pricings_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this pricing.

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_pricings_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this pricing.

Responses

inventories_supplied_items_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
quantity
required
integer [ 0 .. 2147483647 ]
purchase_price
required
string <decimal> ^-?\d{0,10}(?:\.\d{0,2})?$
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
required
string <uuid>
business
required
string <uuid>
supplier
string or null <uuid>
supply
required
string <uuid>

Responses

Request samples

Content type
{
  • "quantity": 2147483647,
  • "purchase_price": "string",
  • "batch_number": "string",
  • "product_number": "string",
  • "expire_date": "2019-08-24",
  • "man_date": "2019-08-24",
  • "item": "5953ca74-944e-4941-87b8-f4f42ef3ae12",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "supplier": "acc345c7-457d-43bb-ac95-81572c2199bb",
  • "supply": "e9d6a0f2-def8-468d-8f13-287d9fa75962"
}

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,
  • "purchase_price": "string",
  • "batch_number": "string",
  • "product_number": "string",
  • "expire_date": "2019-08-24",
  • "man_date": "2019-08-24",
  • "item": "5953ca74-944e-4941-87b8-f4f42ef3ae12",
  • "business": "78adf8f8-64d1-4555-9415-6c98fdd48330",
  • "supplier": "acc345c7-457d-43bb-ac95-81572c2199bb",
  • "supply": "e9d6a0f2-def8-468d-8f13-287d9fa75962"
}

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 (SuppliedItemRequest)
label
required
string [ 1 .. 255 ] characters
branch
required
string <uuid>

Responses

Request samples

Content type
{
  • "item": {
    },
  • "label": "string",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65"
}

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",
  • "branch": "7c628a07-d557-4cd4-9105-51f9aade2c65"
}

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