GShop RESTFull web services
API docs by Redocly

GShop - API specification (1.0.5)

Download OpenAPI specification:

E-mail: info@rhubbit.com

GShop - RESTFull web services

>> EXTERNAL DOC: RESTFull web services best practise

rpc / channel / sync

channel sync command

rpc channel sync command handler

Authorizations:
(apiKeyAuthbearerAuth)
header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON RPC object request

One of
jsonrpc
required
string
Default: "2.0"

A String specifying the version of the JSON-RPC protocol. MUST be exactly "2.0".

(string or null) or (integer or null)

An identifier established by the Client that MUST contain a String, Number, or NULL value if included. If it is not included it is assumed to be a notification.

method
required
string
Enum: "create" "update" "delete"

A String containing the name of the method to be invoked.

required
object or null

A Structured value that holds the parameter values to be used during the invocation of the method. This member MAY be omitted if the method does not required input.

Responses

Request samples

Content type
application/json
Example
{
  • "jsonrpc": "2.0",
  • "id": "AK34Ty",
  • "method": "create",
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "jsonrpc": "2.0",
  • "id": "AK34Ty",
  • "result": {
    }
}

device

Services related to manage device entity

create device

create new device to set device vendor Id (mandatory in PUSH notification protocol) or other statistical relevant params

Authorizations:
apiKeyAuth
header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with device entity data

type
required
string
Enum: "smartphone" "tablet" "desktop"

connected device type

os
required
string
Enum: "android" "ios" "windows" "linux" "macos"

device os macro category beetween android/ios

os_version
required
string

device os version number

language
string
Default: "en"

two characters string languages identifier (eg. it, en, ...)

enable_notification
boolean
Default: true

flag to enable or disable push notification

notification_token
string

unique firebase notification token genarated form Google/Apple

vendor_id
required
string

unique vendor device token genarated form Google/Apple

app_version
string

client application version

Responses

Request samples

Content type
application/json
{
  • "type": "smartphone",
  • "os": "android",
  • "os_version": 23,
  • "language": "it",
  • "enable_notification": true,
  • "notification_token": "dWPEVGJjGNA:APA91bEzLWfVOzbS6btIqDe70Yb7hL...",
  • "vendor_id": "dWPEVGJjGNA:APA91bEzLWfVOzbS6btIqDe70Yb7hL...",
  • "app_version": "1.0.0"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "Device",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "smartphone",
  • "os": "android",
  • "os_version": 23,
  • "language": "it",
  • "enable_notification": true,
  • "notification_token": "dWPEVGJjGNA:APA91bEzLWfVOzbS6btIqDe70Yb7hL...",
  • "vendor_id": "dWPEVGJjGNA:APA91bEzLWfVOzbS6btIqDe70Yb7hL...",
  • "app_version": "1.0.0",
  • "token": {
    }
}

get device

get specific device by id checking if request contains valid token or there's not logged user to device

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "Device",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "smartphone",
  • "os": "android",
  • "os_version": 23,
  • "language": "it",
  • "enable_notification": true,
  • "notification_token": "dWPEVGJjGNA:APA91bEzLWfVOzbS6btIqDe70Yb7hL...",
  • "vendor_id": "dWPEVGJjGNA:APA91bEzLWfVOzbS6btIqDe70Yb7hL...",
  • "app_version": "1.0.0",
  • "token": {
    }
}

update device

update device data to refresh device vendor Id (mandatory in PUSH notification protocol) or other statistical relevant params

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with device entity data

type
required
string
Enum: "smartphone" "tablet" "desktop"

connected device type

os
required
string
Enum: "android" "ios" "windows" "linux" "macos"

device os macro category beetween android/ios

os_version
required
string

device os version number

language
string
Default: "en"

two characters string languages identifier (eg. it, en, ...)

enable_notification
boolean
Default: true

flag to enable or disable push notification

notification_token
string

unique firebase notification token genarated form Google/Apple

vendor_id
required
string

unique vendor device token genarated form Google/Apple

app_version
string

client application version

Responses

Request samples

Content type
application/json
{
  • "type": "smartphone",
  • "os": "android",
  • "os_version": 23,
  • "language": "it",
  • "enable_notification": true,
  • "notification_token": "dWPEVGJjGNA:APA91bEzLWfVOzbS6btIqDe70Yb7hL...",
  • "vendor_id": "dWPEVGJjGNA:APA91bEzLWfVOzbS6btIqDe70Yb7hL...",
  • "app_version": "1.0.0"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "Device",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "smartphone",
  • "os": "android",
  • "os_version": 23,
  • "language": "it",
  • "enable_notification": true,
  • "notification_token": "dWPEVGJjGNA:APA91bEzLWfVOzbS6btIqDe70Yb7hL...",
  • "vendor_id": "dWPEVGJjGNA:APA91bEzLWfVOzbS6btIqDe70Yb7hL...",
  • "app_version": "1.0.0",
  • "token": {
    }
}

delete device

remove definitively device, tipically if the app will be uninstall or if APN/GCM push notification service return an error

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "code": 3211,
  • "message": "Bad Request"
}

device / log

get device logs

Returns the full list of DeviceLog entities.

Authorizations:
(apiKeyAuthbearerAuth)
query Parameters
q
string
Example: q=test filter string

Urlencode search string to filter list of entities.

sort
Array of strings[ items^\D(.*):(ASC|DESC)$ ]
Example: sort=field1:ASC|field2:DESC

Pipe delimited list with attributes to sort

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create device log

if device log has been enabled on the server, it stores the new DeviceLog entity, otherwise it responds with an error message with status 400 (Bad Request). The entity sent in body must contain at least one of the fields between message and attachment_path. If the entity contains an attachment, use a "multipart/form-data" content-type header otherwise a "application/json" content-type header

Authorizations:
apiKeyAuth(apiKeyAuthbearerAuth)
header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema:
required

A JSON object with DeviceLog entity data

type
required
string
Enum: "INFO" "WARN" "ERROR"

log type definition, INFO = generic logged information, WARN = something could be a problem or not, ERROR = an important problem/error to solve

app_version
string

client application version in use

message
string

log message to store

attachment
required
object <binary>

file attached to device log

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "INFO",
  • "api_version": "1.0.0",
  • "app_version": "1.0.0",
  • "username": "your@email.com",
  • "message": "string",
  • "attachment_name": "string",
  • "attachment_url": "string"
}

identity

Services related to manage user identity (username / pa)

authenticate and login

check username / password couple and if valid log in user and return success response otherwise return one of this error:

  • 400 Device already in use

  • 403 Invalid username or password

  • 404 Invalid device

  • 412 expired - Account expired

  • 412 locked - Please wait, admin has not yet enabled your account

  • 412 enabled - Account not yet confirmed

Authorizations:
apiKeyAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with username and password

username
required
string

valid username (email or phone number)

password
required
string or null

valid password

Responses

Request samples

Content type
application/json
{
  • "username": "username@email.it",
  • "password": "myPassword1234!",
  • "new_password": null
}

Response samples

Content type
application/json
{
  • "signature": "valid-jwt-signature",
  • "refresh": "one-time-refresh-token"
}

logout

disconnect user identified by the signature in the header

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "code": 3211,
  • "message": "Bad Request"
}

password recovery / update

if JSON in the request body contains only the username a new password will be generated otherwise by sending username, password and new_password, after a credentials check, the user's identity will be updated

Authorizations:
apiKeyAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with valid username

username
required
string

valid username (email or phone number)

Responses

Request samples

Content type
application/json
{
  • "username": "username@email.it",
  • "password": null,
  • "new_password": null
}

Response samples

Content type
application/json
{
  • "code": 3211,
  • "message": "Bad Request"
}

refresh token

Get new JWT token via refresh token or an error response like this:

  • 400 Invalid refresh token

  • 404 Invalid device

  • 410 Expired refresh token

Authorizations:
apiKeyAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with valid refresh token

token
string

valid refresh token

Responses

Request samples

Content type
application/json
{
  • "token": "v4l1d-4lph4num3r1c-r3fr3sh-t0k3n"
}

Response samples

Content type
application/json
{
  • "signature": "valid-jwt-signature",
  • "refresh": "one-time-refresh-token"
}

identity / confirmation

confirm user account

confirms user account with confirmation code received by email or send new confirmation code if required with a valid email address related to a disabled identity

Authorizations:
apiKeyAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with confirmation code

code
string

account confirmation code (null if email field evalued)

email
string <email>

account email to check if new confirmation code has been requested (null if code field evalued)

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "email": "your@email.com"
}

Response samples

Content type
application/json
{
  • "code": 3211,
  • "message": "Bad Request"
}

user

Services related to manage user entity

get users

Returns the full list of user entities.

Authorizations:
(apiKeyAuthbearerAuth)
query Parameters
q
string
Example: q=test filter string

Urlencode search string to filter list of entities.

sort
Array of strings[ items^\D(.*):(ASC|DESC)$ ]
Example: sort=field1:ASC|field2:DESC

Pipe delimited list with attributes to sort

object (LHSStringPayload)
Example: easy_truck_code[value]=1234GD

LHS Brackets filter on easy_truck_code field

object (LHSStringPayload)
Example: email[value]=abc@email.com

LHS Brackets filter on email field

object (LHSNumberPayload)
Example: role_id[value]=3

LHS Brackets filter on role_id field

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Range
required
string
Example: {unit}={from}-{to}

Tell the server if you want a paged resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create user

create user entity with data sent in request body

Authorizations:
apiKeyAuth
header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with user entity data

role_id
integer

ID of the user role (1=SUPERADMIN, 2=ADMIN, 3=MEMBER, 4=GUEST).

avatar_media_id
integer

ID of the user avatar related to media object prevently uploaded.

first_name
string
last_name
string
email
required
string <email>
phone_country
string
phone
string
password
required
string <password>

password used to identify the user (required in POST request)

privacy
required
boolean
terms
required
boolean
locked
boolean

value is TRUE if admin ban this account, you can only set this flag to unlock banned user, use DELETE /user/:id to lock it

Responses

Request samples

Content type
application/json
{
  • "role_id": 4,
  • "avatar_media_id": 50,
  • "first_name": "John",
  • "last_name": "Smith",
  • "email": "your@email.com",
  • "phone_country": "+39",
  • "phone": "3285564324",
  • "password": "qwerTy1234!",
  • "privacy": true,
  • "terms": true,
  • "locked": false
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "role": {
    },
  • "avatar_media": {},
  • "first_name": "John",
  • "last_name": "Smith",
  • "email": "your@email.com",
  • "phone_country": "+39",
  • "phone": "3285564324",
  • "privacy": true,
  • "terms": true,
  • "enabled": true,
  • "locked": false
}

get user

get specific user by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "role": {
    },
  • "avatar_media": {},
  • "first_name": "John",
  • "last_name": "Smith",
  • "email": "your@email.com",
  • "phone_country": "+39",
  • "phone": "3285564324",
  • "privacy": true,
  • "terms": true,
  • "enabled": true,
  • "locked": false
}

update user

update user data with new ones sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with user entity data

role_id
integer

ID of the user role (1=SUPERADMIN, 2=ADMIN, 3=MEMBER, 4=GUEST).

avatar_media_id
integer

ID of the user avatar related to media object prevently uploaded.

first_name
string
last_name
string
email
required
string <email>
phone_country
string
phone
string
password
string <password>

password used to identify the user (required in POST request)

privacy
required
boolean
terms
required
boolean
locked
boolean

value is TRUE if admin ban this account, you can only set this flag to unlock banned user, use DELETE /user/:id to lock it

Responses

Request samples

Content type
application/json
{
  • "role_id": 4,
  • "avatar_media_id": 50,
  • "first_name": "John",
  • "last_name": "Smith",
  • "email": "your@email.com",
  • "phone_country": "+39",
  • "phone": "3285564324",
  • "password": "qwerTy1234!",
  • "privacy": true,
  • "terms": true,
  • "locked": false
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "role": {
    },
  • "avatar_media": {},
  • "first_name": "John",
  • "last_name": "Smith",
  • "email": "your@email.com",
  • "phone_country": "+39",
  • "phone": "3285564324",
  • "privacy": true,
  • "terms": true,
  • "enabled": true,
  • "locked": false
}

ban user

ban user locking the account

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "code": 3211,
  • "message": "Bad Request"
}

media

Services related to manage media instance

get list of gallery media

Returns the paged list of gallery media entities.

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

query Parameters
q
string
Example: q=test filter string

Urlencode search string to filter list of entities.

sort
Array of strings[ items^\D(.*):(ASC|DESC)$ ]
Example: sort=field1:ASC|field2:DESC

Pipe delimited list with attributes to sort

mode
string
Default: "AND"
Enum: "AND" "OR"
Example: mode=OR

Filter mode operator

object (LHSNumberPayload)

LHS Brackets filter on weight field

object (LHSStringPayload)

LHS Brackets filter on type field

object (LHSStringPayload)

LHS Brackets filter on mime_type field

object (LHSStringPayload)

LHS Brackets filter on title field

object (LHSStringPayload)

LHS Brackets filter on description field

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Range
string
Example: {unit}={from}-{to}

Tell the server if you want a paged resource

Responses

Response samples

Content type
application/json
[]

upload gallery media

Upload new gallery media and relate it with gallery selected by gallery ID.

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: multipart/form-data

Upload resource content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: multipart/form-data

Multipart from request with a single binary attribute reserve to media uploading and a cover flag

media
required
object <binary>
weight
number <integer>

The weight define the priority between listed media

title
string

The media file original title.

description
string or null

The media file alternative description.

mime_type
string

The media mime-type, sending different value from default uploaded media mime_type force the server to try a type conversion.

Responses

Response samples

Content type
application/json
{}

update media gallery list

update media gallery with all media entities in input

Authorizations:
(apiKeyAuthbearerAuth)
header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with content media entities data

required
Array of objects (Media)

The array of entities.

Responses

Request samples

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

Response samples

Content type
application/json
{}

get gallery media by id

get specific media metadata by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{}

update gallery media

Update gallery media and relate it with gallery selected by gallery ID.

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: multipart/form-data

Upload resource content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json

An object with archived media entity data in input

weight
number <integer>

The weight define the priority between listed media

title
string

The media file original title.

description
string or null

The media file alternative description.

mime_type
string

The media mime-type, sending different value from default uploaded media mime_type force the server to try a type conversion.

Responses

Request samples

Content type
application/json
{
  • "weight": 10,
  • "title": "string",
  • "description": "string",
  • "mime_type": "string"
}

Response samples

Content type
application/json
{}

delete gallery media

delete specific media by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "code": 3211,
  • "message": "Bad Request"
}

get media galleries

Returns the full list of media gallery entities.

Authorizations:
(apiKeyAuthbearerAuth)
query Parameters
q
string
Example: q=test filter string

Urlencode search string to filter list of entities.

sort
Array of strings[ items^\D(.*):(ASC|DESC)$ ]
Example: sort=field1:ASC|field2:DESC

Pipe delimited list with attributes to sort

object (LHSStringPayload)

LHS Brackets filter on title field

object (LHSStringPayload)

LHS Brackets filter on description field

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Range
required
string
Example: {unit}={from}-{to}

Tell the server if you want a paged resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create new media gallery

create new media gallery

Authorizations:
(apiKeyAuthbearerAuth)
header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with content media gallery entity data

weight
number <integer>

The weight define the priority between listed media

title
string or null

The media gallery title.

description
string or null

The media gallery description.

Responses

Request samples

Content type
application/json
{
  • "weight": 10,
  • "title": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "weight": 10,
  • "title": "string",
  • "description": "string"
}

get media gallery

get specific media gallery by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "weight": 10,
  • "title": "string",
  • "description": "string"
}

update media gallery

update media gallery data with new ones sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with media gallery entity data

weight
number <integer>

The weight define the priority between listed media

title
string or null

The media gallery title.

description
string or null

The media gallery description.

Responses

Request samples

Content type
application/json
{
  • "weight": 10,
  • "title": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "weight": 10,
  • "title": "string",
  • "description": "string"
}

delete media gallery

delete media gallery by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "code": 3211,
  • "message": "Bad Request"
}

user / media

get list of user media

Returns the full or paged list of user media entities.

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

query Parameters
q
string
Example: q=test filter string

Urlencode search string to filter list of entities.

sort
Array of strings[ items^\D(.*):(ASC|DESC)$ ]
Example: sort=field1:ASC|field2:DESC

Pipe delimited list with attributes to sort

mode
string
Default: "AND"
Enum: "AND" "OR"
Example: mode=OR

Filter mode operator

object (LHSNumberPayload)

LHS Brackets filter on media.id field

object (LHSStringPayload)

LHS Brackets filter on media.title field

object (LHSStringPayload)

LHS Brackets filter on media.title field

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Range
string
Example: {unit}={from}-{to}

Tell the server if you want a paged resource

Responses

Response samples

Content type
application/json
[]

upload user media

Upload new user media and relate it with user selected by user ID.

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: multipart/form-data

Upload resource content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: multipart/form-data
required

Multipart from request with a single binary attribute reserve to media uploading and a cover flag

weight
number <integer>

The weight define the priority between listed media

title
string

The media file original title.

description
string or null

The media file alternative description.

mime_type
string

The media mime-type, sending different value from default uploaded media mime_type force the server to try a type conversion.

media
required
object <binary>

Responses

Response samples

Content type
application/json
{}

get user media by id

get specific media metadata by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{}

update user media

Update user media info.

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: multipart/form-data

Upload resource content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with Media entity data

weight
number <integer>

The weight define the priority between listed media

title
string

The media file original title.

description
string or null

The media file alternative description.

mime_type
string

The media mime-type, sending different value from default uploaded media mime_type force the server to try a type conversion.

Responses

Request samples

Content type
application/json
{
  • "weight": 10,
  • "title": "string",
  • "description": "string",
  • "mime_type": "string"
}

Response samples

Content type
application/json
{}

delete user media

delete specific media by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "code": 3211,
  • "message": "Bad Request"
}

mark / brand

get mark brands

Returns the full list of MarkBrand entities.

Authorizations:
(apiKeyAuthbearerAuth)
query Parameters
q
string
Example: q=test filter string

Urlencode search string to filter list of entities.

sort
Array of strings[ items^\D(.*):(ASC|DESC)$ ]
Example: sort=field1:ASC|field2:DESC

Pipe delimited list with attributes to sort

object (LHSDatetimePayload)
Example: created_at[value]=2019-08-24T14:15:22Z

LHS Brackets filter on created_at field

object (LHSDatetimePayload)
Example: updated_at[value]=2019-08-24T14:15:22Z

LHS Brackets filter on updated_at field

object (LHSStringPayload)
Example: code[value]=ba03

LHS Brackets filter on code field

object (LHSStringPayload)
Example: description[value]=ba03

LHS Brackets filter on description field

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create mark brand

create MarkBrand entity with data sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with MarkBrand entity data

code
required
string
description
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "12345A",
  • "description": "brand description"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "12345A",
  • "description": "brand description"
}

get mark brand

get specific MarkBrand by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "12345A",
  • "description": "brand description"
}

update mark brand

update MarkBrand data with new ones sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with MarkBrand entity data

code
required
string
description
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "12345A",
  • "description": "brand description"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "12345A",
  • "description": "brand description"
}

remove mark brand

remove definitively MarkBrand entity by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "code": 3211,
  • "message": "Bad Request"
}

mark / category

get mark categories

Returns the full list of MarkCategory entities.

Authorizations:
(apiKeyAuthbearerAuth)
query Parameters
q
string
Example: q=test filter string

Urlencode search string to filter list of entities.

sort
Array of strings[ items^\D(.*):(ASC|DESC)$ ]
Example: sort=field1:ASC|field2:DESC

Pipe delimited list with attributes to sort

object (LHSDatetimePayload)
Example: created_at[value]=2019-08-24T14:15:22Z

LHS Brackets filter on created_at field

object (LHSDatetimePayload)
Example: updated_at[value]=2019-08-24T14:15:22Z

LHS Brackets filter on updated_at field

object (LHSStringPayload)
Example: code[value]=ba03

LHS Brackets filter on code field

object (LHSStringPayload)
Example: description[value]=ba03

LHS Brackets filter on description field

object (LHSStringPayload)
Example: department[value]=ba03

LHS Brackets filter on department field

object (LHSBooleanPayload)
Example: exportable[value]=true

LHS Brackets filter on exportable field

object (LHSNumberPayload)
Example: parent_category_id[value]=ba03

LHS Brackets filter on parent_category_id field

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create mark category

create MarkCategory entity with data sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with MarkCategory entity data

code
required
string
description
required
string
department
string or null
exportable
boolean
parent_category_id
integer or null

Responses

Request samples

Content type
application/json
{
  • "code": "12345A",
  • "description": "category description",
  • "department": "department01",
  • "exportable": true,
  • "parent_category_id": 12
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "12345A",
  • "description": "category description",
  • "department": "department01",
  • "exportable": true,
  • "parent_category_id": 12
}

get mark category

get specific MarkCategory by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "12345A",
  • "description": "category description",
  • "department": "department01",
  • "exportable": true,
  • "parent_category_id": 12
}

update mark category

update MarkCategory data with new ones sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with MarkCategory entity data

code
required
string
description
required
string
department
string or null
exportable
boolean
parent_category_id
integer or null

Responses

Request samples

Content type
application/json
{
  • "code": "12345A",
  • "description": "category description",
  • "department": "department01",
  • "exportable": true,
  • "parent_category_id": 12
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "12345A",
  • "description": "category description",
  • "department": "department01",
  • "exportable": true,
  • "parent_category_id": 12
}

remove mark category

remove definitively MarkCategory entity by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "code": 3211,
  • "message": "Bad Request"
}

mark / product

get mark products

Returns the paged list of MarkProduct entities.

Authorizations:
(apiKeyAuthbearerAuth)
query Parameters
q
string
Example: q=test filter string

Urlencode search string to filter list of entities.

sort
Array of strings[ items^\D(.*):(ASC|DESC)$ ]
Example: sort=field1:ASC|field2:DESC

Pipe delimited list with attributes to sort

object (LHSDatetimePayload)
Example: created_at[value]=2019-08-24T14:15:22Z

LHS Brackets filter on created_at field

object (LHSDatetimePayload)
Example: updated_at[value]=2019-08-24T14:15:22Z

LHS Brackets filter on updated_at field

object (LHSStringPayload)
Example: type[value]=retail

LHS Brackets filter on type field

object (LHSStringPayload)
Example: sku[value]=1234

LHS Brackets filter on sku field

object (LHSNumberPayload)
Example: lot[value]=1234

LHS Brackets filter on lot field

object (LHSStringPayload)
Example: code[value]=abc

LHS Brackets filter on code field

object (LHSStringPayload)
Example: customer_code[value]=abc

LHS Brackets filter on customer_code field

object (LHSStringPayload)
Example: supplier_code[value]=abc

LHS Brackets filter on supplier_code field

object (LHSStringPayload)
Example: description[value]=ba03

LHS Brackets filter on description field

object (LHSStringPayload)
Example: short_description[value]=ba03

LHS Brackets filter on short_description field

object (LHSStringPayload)
Example: status[value]=ba03

LHS Brackets filter on status field

object (LHSStringPayload)
Example: tax_lot[value]=ba03

LHS Brackets filter on tax_lot field

object (LHSStringPayload)
Example: old_tax_lot[value]=ba03

LHS Brackets filter on old_tax_lot field

object (LHSNumberPayload)
Example: mark_category_id[value]=2

LHS Brackets filter on mark_category_id field

object (LHSNumberPayload)
Example: mark_brand_id[value]=2

LHS Brackets filter on mark_brand_id field

object (LHSStringPayload)
Example: name[value]=ba03

LHS Brackets filter on name field

object (LHSStringPayload)
Example: reference[value]=XYZ

LHS Brackets filter on reference field

object (LHSStringPayload)
Example: status[value]=XYZ

LHS Brackets filter on status field

object (LHSStringPayload)
Example: shopify[value]=XYZ

LHS Brackets filter on shopify field

object (LHSNumberPayload)
Example: cost[value]=100

LHS Brackets filter on cost field

object (LHSNumberPayload)
Example: net_price[value]=100

LHS Brackets filter on net_price field

object (LHSNumberPayload)
Example: vat_price[value]=100

LHS Brackets filter on vat_price field

object (LHSNumberPayload)
Example: second_price[value]=100

LHS Brackets filter on second_price field

object (LHSDatetimePayload)
Example: sell_date[value]=2019-08-24T14:15:22Z

LHS Brackets filter on sell_date field

object (LHSDatetimePayload)
Example: delivery_date[value]=2019-08-24T14:15:22Z

LHS Brackets filter on delivery_date field

object (LHSDatetimePayload)
Example: purchase_date[value]=2019-08-24T14:15:22Z

LHS Brackets filter on purchase_date field

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create mark product

create MarkProduct entity with data sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with MarkProduct entity data

sku
required
string
mark_category_id
integer or null
mark_brand_id
integer or null
media_gallery_id
integer or null

a valid media gallery id with public media

name
string or null
reference
string or null
short_description
string or null
description
string or null
measurement_unit
string or null
net_price
number or null
vat_price
number or null
second_price
number or null
cost
number
qty
number
mark_customer_id
integer

a valid customer id

mark_supplier_id
integer

a valid supplier id

repair_media_gallery_id
integer

a valid media gallery id with private media

type
required
string
Enum: "repair" "revision" "retail"

type of the product, only if set as 'retail' product will be synchronized with official website

code
string or null

non-unique code attribute

category_code
string

category code attribute

supplier_code
string or null

unique supplier code attribute

customer_code
string or null

unique customer code attribute

purchase_date
string or null <date>

purchase date attribute

purchase_taxable
number or null

purchase taxable attribute

purchase_vat
number or null

purchase vat attribute

delivery_date
string or null <date>

delivery date attribute

sell_date
string or null <date>

sell date attribute

sell_price
number or null

sell price attribute

promo_price
number or null

promo price attribute

repair_notes
string or null

repair notes attribute

lot
number or null

lot attribute

tax_lot
string or null

tax lot attribute

old_tax_lot
string or null

old tax lot attribute

vat_code
string or null

vat_code attribute

returned
boolean

returned flag

selected
boolean

selected flag

updated
boolean

updated flag

draft
boolean

draft flag

warehouse_location
string or null

warehouse location attribute

status
string or null
Enum: "available" "booked" "ddt" "sold" "return" "forced_booked" "forced_ddt" "forced_sold" "forced_return"

status attribute

shopify
string
Enum: "DRAFT" "PUBLISHED"

shopify status attribute

year
string or null

year attribute

set
string or null

set attribute

set_code
string or null

set code attribute

diameter
string or null

diameter attribute

number
string or null

number attribute

bracelet
string or null

bracelet attribute

bracelet_code
string or null

bracelet code attribute

bracelet_number
string or null

bracelet number attribute

case
string or null

case attribute

indexes
string or null

indexes attribute

indexes_code
string or null

indexes code attribute

movement
string or null

movement attribute

movement_code
string or null

movement code attribute

dial
string or null

dial attribute

dial_code
string or null

dial code attribute

glass
string or null

glass attribute

glass_code
string or null

glass code attribute

buckle
string or null

buckle attribute

buckle_code
string or null

buckle code attribute

links_number
integer or null

links number attribute

caliber
string or null

caliber attribute

clasp
string or null

clasp attribute

end_links
string or null

end links attribute

case_back
string or null

case back attribute

sales_channel
string or null

sales channel attribute

Responses

Request samples

Content type
application/json
{
  • "sku": "12345",
  • "mark_category_id": 12,
  • "mark_brand_id": 12,
  • "media_gallery_id": 1,
  • "name": "product name",
  • "reference": "XYZ",
  • "short_description": "product text",
  • "description": "product long description text",
  • "measurement_unit": "string",
  • "net_price": 100,
  • "vat_price": 120,
  • "second_price": 115,
  • "cost": 75,
  • "qty": 150,
  • "mark_customer_id": 1,
  • "mark_supplier_id": 1,
  • "repair_media_gallery_id": 1,
  • "type": "repair",
  • "code": "string",
  • "category_code": "string",
  • "supplier_code": "string",
  • "customer_code": "string",
  • "purchase_date": "2019-08-24",
  • "purchase_taxable": 0,
  • "purchase_vat": 0,
  • "delivery_date": "2019-08-24",
  • "sell_date": "2019-08-24",
  • "sell_price": 0,
  • "promo_price": 0,
  • "repair_notes": "string",
  • "lot": 0,
  • "tax_lot": "string",
  • "old_tax_lot": "string",
  • "vat_code": "string",
  • "returned": true,
  • "selected": true,
  • "updated": true,
  • "draft": true,
  • "warehouse_location": "string",
  • "status": "available",
  • "shopify": "DRAFT",
  • "year": "string",
  • "set": "string",
  • "set_code": "string",
  • "diameter": "string",
  • "number": "string",
  • "bracelet": "string",
  • "bracelet_code": "string",
  • "bracelet_number": "string",
  • "case": "string",
  • "indexes": "string",
  • "indexes_code": "string",
  • "movement": "string",
  • "movement_code": "string",
  • "dial": "string",
  • "dial_code": "string",
  • "glass": "string",
  • "glass_code": "string",
  • "buckle": "string",
  • "buckle_code": "string",
  • "links_number": 0,
  • "caliber": "string",
  • "clasp": "string",
  • "end_links": "string",
  • "case_back": "string",
  • "sales_channel": "string"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "sku": "12345",
  • "mark_category": {
    },
  • "mark_brand": {
    },
  • "media_gallery_id": 1,
  • "name": "product name",
  • "reference": "XYZ",
  • "short_description": "product text",
  • "description": "product long description text",
  • "measurement_unit": "string",
  • "net_price": 100,
  • "vat_price": 120,
  • "second_price": 115,
  • "cost": 75,
  • "qty": 150,
  • "mark_customer": {
    },
  • "mark_supplier": {
    },
  • "repair_media_gallery_id": 1,
  • "channel_sync": {
    },
  • "queue_event": {
    },
  • "type": "repair",
  • "code": "string",
  • "category_code": "string",
  • "supplier_code": "string",
  • "customer_code": "string",
  • "purchase_date": "2019-08-24",
  • "purchase_taxable": 0,
  • "purchase_vat": 0,
  • "delivery_date": "2019-08-24",
  • "sell_date": "2019-08-24",
  • "sell_price": 0,
  • "promo_price": 0,
  • "repair_notes": "string",
  • "lot": 0,
  • "tax_lot": "string",
  • "old_tax_lot": "string",
  • "vat_code": "string",
  • "returned": true,
  • "selected": true,
  • "updated": true,
  • "draft": true,
  • "warehouse_location": "string",
  • "status": "available",
  • "shopify": "DRAFT",
  • "year": "string",
  • "set": "string",
  • "set_code": "string",
  • "diameter": "string",
  • "number": "string",
  • "bracelet": "string",
  • "bracelet_code": "string",
  • "bracelet_number": "string",
  • "case": "string",
  • "indexes": "string",
  • "indexes_code": "string",
  • "movement": "string",
  • "movement_code": "string",
  • "dial": "string",
  • "dial_code": "string",
  • "glass": "string",
  • "glass_code": "string",
  • "buckle": "string",
  • "buckle_code": "string",
  • "links_number": 0,
  • "caliber": "string",
  • "clasp": "string",
  • "end_links": "string",
  • "case_back": "string",
  • "sales_channel": "string"
}

get mark product

get specific MarkProduct by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "sku": "12345",
  • "mark_category": {
    },
  • "mark_brand": {
    },
  • "media_gallery_id": 1,
  • "name": "product name",
  • "reference": "XYZ",
  • "short_description": "product text",
  • "description": "product long description text",
  • "measurement_unit": "string",
  • "net_price": 100,
  • "vat_price": 120,
  • "second_price": 115,
  • "cost": 75,
  • "qty": 150,
  • "mark_customer": {
    },
  • "mark_supplier": {
    },
  • "repair_media_gallery_id": 1,
  • "channel_sync": {
    },
  • "queue_event": {
    },
  • "type": "repair",
  • "code": "string",
  • "category_code": "string",
  • "supplier_code": "string",
  • "customer_code": "string",
  • "purchase_date": "2019-08-24",
  • "purchase_taxable": 0,
  • "purchase_vat": 0,
  • "delivery_date": "2019-08-24",
  • "sell_date": "2019-08-24",
  • "sell_price": 0,
  • "promo_price": 0,
  • "repair_notes": "string",
  • "lot": 0,
  • "tax_lot": "string",
  • "old_tax_lot": "string",
  • "vat_code": "string",
  • "returned": true,
  • "selected": true,
  • "updated": true,
  • "draft": true,
  • "warehouse_location": "string",
  • "status": "available",
  • "shopify": "DRAFT",
  • "year": "string",
  • "set": "string",
  • "set_code": "string",
  • "diameter": "string",
  • "number": "string",
  • "bracelet": "string",
  • "bracelet_code": "string",
  • "bracelet_number": "string",
  • "case": "string",
  • "indexes": "string",
  • "indexes_code": "string",
  • "movement": "string",
  • "movement_code": "string",
  • "dial": "string",
  • "dial_code": "string",
  • "glass": "string",
  • "glass_code": "string",
  • "buckle": "string",
  • "buckle_code": "string",
  • "links_number": 0,
  • "caliber": "string",
  • "clasp": "string",
  • "end_links": "string",
  • "case_back": "string",
  • "sales_channel": "string"
}

update mark product

update MarkProduct data with new ones sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with MarkProduct entity data

sku
required
string
mark_category_id
integer or null
mark_brand_id
integer or null
media_gallery_id
integer or null

a valid media gallery id with public media

name
string or null
reference
string or null
short_description
string or null
description
string or null
measurement_unit
string or null
net_price
number or null
vat_price
number or null
second_price
number or null
cost
number
qty
number
mark_customer_id
integer

a valid customer id

mark_supplier_id
integer

a valid supplier id

repair_media_gallery_id
integer

a valid media gallery id with private media

type
required
string
Enum: "repair" "revision" "retail"

type of the product, only if set as 'retail' product will be synchronized with official website

code
string or null

non-unique code attribute

category_code
string

category code attribute

supplier_code
string or null

unique supplier code attribute

customer_code
string or null

unique customer code attribute

purchase_date
string or null <date>

purchase date attribute

purchase_taxable
number or null

purchase taxable attribute

purchase_vat
number or null

purchase vat attribute

delivery_date
string or null <date>

delivery date attribute

sell_date
string or null <date>

sell date attribute

sell_price
number or null

sell price attribute

promo_price
number or null

promo price attribute

repair_notes
string or null

repair notes attribute

lot
number or null

lot attribute

tax_lot
string or null

tax lot attribute

old_tax_lot
string or null

old tax lot attribute

vat_code
string or null

vat_code attribute

returned
boolean

returned flag

selected
boolean

selected flag

updated
boolean

updated flag

draft
boolean

draft flag

warehouse_location
string or null

warehouse location attribute

status
string or null
Enum: "available" "booked" "ddt" "sold" "return" "forced_booked" "forced_ddt" "forced_sold" "forced_return"

status attribute

shopify
string
Enum: "DRAFT" "PUBLISHED"

shopify status attribute

year
string or null

year attribute

set
string or null

set attribute

set_code
string or null

set code attribute

diameter
string or null

diameter attribute

number
string or null

number attribute

bracelet
string or null

bracelet attribute

bracelet_code
string or null

bracelet code attribute

bracelet_number
string or null

bracelet number attribute

case
string or null

case attribute

indexes
string or null

indexes attribute

indexes_code
string or null

indexes code attribute

movement
string or null

movement attribute

movement_code
string or null

movement code attribute

dial
string or null

dial attribute

dial_code
string or null

dial code attribute

glass
string or null

glass attribute

glass_code
string or null

glass code attribute

buckle
string or null

buckle attribute

buckle_code
string or null

buckle code attribute

links_number
integer or null

links number attribute

caliber
string or null

caliber attribute

clasp
string or null

clasp attribute

end_links
string or null

end links attribute

case_back
string or null

case back attribute

sales_channel
string or null

sales channel attribute

Responses

Request samples

Content type
application/json
{
  • "sku": "12345",
  • "mark_category_id": 12,
  • "mark_brand_id": 12,
  • "media_gallery_id": 1,
  • "name": "product name",
  • "reference": "XYZ",
  • "short_description": "product text",
  • "description": "product long description text",
  • "measurement_unit": "string",
  • "net_price": 100,
  • "vat_price": 120,
  • "second_price": 115,
  • "cost": 75,
  • "qty": 150,
  • "mark_customer_id": 1,
  • "mark_supplier_id": 1,
  • "repair_media_gallery_id": 1,
  • "type": "repair",
  • "code": "string",
  • "category_code": "string",
  • "supplier_code": "string",
  • "customer_code": "string",
  • "purchase_date": "2019-08-24",
  • "purchase_taxable": 0,
  • "purchase_vat": 0,
  • "delivery_date": "2019-08-24",
  • "sell_date": "2019-08-24",
  • "sell_price": 0,
  • "promo_price": 0,
  • "repair_notes": "string",
  • "lot": 0,
  • "tax_lot": "string",
  • "old_tax_lot": "string",
  • "vat_code": "string",
  • "returned": true,
  • "selected": true,
  • "updated": true,
  • "draft": true,
  • "warehouse_location": "string",
  • "status": "available",
  • "shopify": "DRAFT",
  • "year": "string",
  • "set": "string",
  • "set_code": "string",
  • "diameter": "string",
  • "number": "string",
  • "bracelet": "string",
  • "bracelet_code": "string",
  • "bracelet_number": "string",
  • "case": "string",
  • "indexes": "string",
  • "indexes_code": "string",
  • "movement": "string",
  • "movement_code": "string",
  • "dial": "string",
  • "dial_code": "string",
  • "glass": "string",
  • "glass_code": "string",
  • "buckle": "string",
  • "buckle_code": "string",
  • "links_number": 0,
  • "caliber": "string",
  • "clasp": "string",
  • "end_links": "string",
  • "case_back": "string",
  • "sales_channel": "string"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "sku": "12345",
  • "mark_category": {
    },
  • "mark_brand": {
    },
  • "media_gallery_id": 1,
  • "name": "product name",
  • "reference": "XYZ",
  • "short_description": "product text",
  • "description": "product long description text",
  • "measurement_unit": "string",
  • "net_price": 100,
  • "vat_price": 120,
  • "second_price": 115,
  • "cost": 75,
  • "qty": 150,
  • "mark_customer": {
    },
  • "mark_supplier": {
    },
  • "repair_media_gallery_id": 1,
  • "channel_sync": {
    },
  • "queue_event": {
    },
  • "type": "repair",
  • "code": "string",
  • "category_code": "string",
  • "supplier_code": "string",
  • "customer_code": "string",
  • "purchase_date": "2019-08-24",
  • "purchase_taxable": 0,
  • "purchase_vat": 0,
  • "delivery_date": "2019-08-24",
  • "sell_date": "2019-08-24",
  • "sell_price": 0,
  • "promo_price": 0,
  • "repair_notes": "string",
  • "lot": 0,
  • "tax_lot": "string",
  • "old_tax_lot": "string",
  • "vat_code": "string",
  • "returned": true,
  • "selected": true,
  • "updated": true,
  • "draft": true,
  • "warehouse_location": "string",
  • "status": "available",
  • "shopify": "DRAFT",
  • "year": "string",
  • "set": "string",
  • "set_code": "string",
  • "diameter": "string",
  • "number": "string",
  • "bracelet": "string",
  • "bracelet_code": "string",
  • "bracelet_number": "string",
  • "case": "string",
  • "indexes": "string",
  • "indexes_code": "string",
  • "movement": "string",
  • "movement_code": "string",
  • "dial": "string",
  • "dial_code": "string",
  • "glass": "string",
  • "glass_code": "string",
  • "buckle": "string",
  • "buckle_code": "string",
  • "links_number": 0,
  • "caliber": "string",
  • "clasp": "string",
  • "end_links": "string",
  • "case_back": "string",
  • "sales_channel": "string"
}

remove mark product

remove definitively MarkProduct entity by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "code": 3211,
  • "message": "Bad Request"
}

mark / variant

get mark variants

Returns the full list of MarkVariant entities.

Authorizations:
(apiKeyAuthbearerAuth)
query Parameters
q
string
Example: q=test filter string

Urlencode search string to filter list of entities.

sort
Array of strings[ items^\D(.*):(ASC|DESC)$ ]
Example: sort=field1:ASC|field2:DESC

Pipe delimited list with attributes to sort

object (LHSDatetimePayload)
Example: created_at[value]=2019-08-24T14:15:22Z

LHS Brackets filter on created_at field

object (LHSDatetimePayload)
Example: updated_at[value]=2019-08-24T14:15:22Z

LHS Brackets filter on updated_at field

object (LHSStringPayload)
Example: barcode[value]=ba03

LHS Brackets filter on barcode field

object (LHSStringPayload)
Example: label[value]=ba03

LHS Brackets filter on label field

object (LHSNumberPayload)
Example: price[value]=100

LHS Brackets filter on price field

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create mark variant

create MarkVariant entity with data sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with MarkVariant entity data

barcode
required
string
label
string or null
price
number or null

Responses

Request samples

Content type
application/json
{
  • "barcode": "12345A",
  • "label": "variant label",
  • "price": 120
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "barcode": "12345A",
  • "label": "variant label",
  • "price": 120
}

get mark variant

get specific MarkVariant by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "barcode": "12345A",
  • "label": "variant label",
  • "price": 120
}

update mark variant

update MarkVariant data with new ones sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with MarkVariant entity data

barcode
required
string
label
string or null
price
number or null

Responses

Request samples

Content type
application/json
{
  • "barcode": "12345A",
  • "label": "variant label",
  • "price": 120
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "barcode": "12345A",
  • "label": "variant label",
  • "price": 120
}

remove mark variant

remove definitively MarkVariant entity by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "code": 3211,
  • "message": "Bad Request"
}

mark / customer

get list of customer

Returns paged list of customer entities.

Authorizations:
(apiKeyAuthbearerAuth)
query Parameters
q
string
Example: q=test filter string

Urlencode search string to filter list of entities.

sort
Array of strings[ items^\D(.*):(ASC|DESC)$ ]
Example: sort=field1:ASC|field2:DESC

Pipe delimited list with attributes to sort

object (LHSDatetimePayload)
Example: created_at[value]=2019-08-24T14:15:22Z

LHS Brackets filter on created_at field

object (LHSDatetimePayload)
Example: updated_at[value]=2019-08-24T14:15:22Z

LHS Brackets filter on updated_at field

object (LHSStringPayload)
Example: type[value]=I

LHS Brackets filter on type field

object (LHSStringPayload)
Example: code[value]=H725

LHS Brackets filter on code field

object (LHSStringPayload)
Example: barcode[value]=H725

LHS Brackets filter on barcode field

object (LHSStringPayload)
Example: vat_number[value]=07616040726

LHS Brackets filter on vat_number field

object (LHSStringPayload)
Example: tax_id[value]=H725

LHS Brackets filter on tax_id field

object (LHSStringPayload)
Example: company_name[value]=Rhubbit

LHS Brackets filter on company_name field

object (LHSStringPayload)
Example: group[value]=H725

LHS Brackets filter on group field

object (LHSStringPayload)
Example: department[value]=Travel

LHS Brackets filter on department field

object (LHSStringPayload)
Example: mnemo[value]=Nick

LHS Brackets filter on mnemo field

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Range
required
string
Example: {unit}={from}-{to}

Tell the server if you want a paged resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create customer

create MarkCustomer entity with data sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with MarkCustomer entity data

type
string or null
Enum: "O" "R" "S" "I" "D"

the type of customer:

  • O: Omaggio
  • R: Reverse charge
  • S: Split payment
  • I: Esigibilità immediata
  • D: esigibilità differita'
mark_sales_agent_id
integer or null

a valid sales agent id

code
required
string

the unique code to identify the customer

barcode
string or null

the unique barcode to identify the customer

tax_id
string or null

the tax_id of the customer

vat_number
string or null

the customer vat number

sdi_code
string or null

the customer sdi code

mnemo
string or null

the customer mnemonic alias

company_name
required
string

the company name of the customer

company_name2
string or null

the company name of the customer part 2

company_name3
string or null

the company name of the customer part 3

bank_account
string or null

the bank account of the customer

iban
string or null

the iban of the customer

abi
string or null

the abi banck code of the customer

cab
string or null

the vab banck code of the customer

pec
string or null

the pec email to contact the customer

email
string or null

the main email to contact the customer

phone
string or null

the phone number of the customer

phone2
string or null

the second phone number of the customer

website
string or null

the main website of the customer

zone
string or null

the zone of the customer

city
string or null

the city of the customer

country
string or null

the country of the customer

country_iso_code
string or null

the country iso code of the customer

province
string or null

the province of the customer

address
string or null

the address of the customer

zip_code
string or null

the zip code of the customer

invoice_address
string or null

the invoice address of the customer

destination_address
string or null

the invoice address of the customer

allow_in_statement
boolean

flag that defines whether or not to include in the bank statement

group
string or null

the group of the customer

department
string or null

the department of the customer

porto
string or null
Enum: "franco" "assegnato"

the shipping porto of customer

shipping_cost
number or null

the shipping cost reserved to the customer

dde_shipping_cost
number or null

the shipping cost assigned of the customer

invoice_warning
string or null

warning text shown during customer invoice registration

order_warning
string or null

warning text shown during customer order registration

Responses

Request samples

Content type
application/json
{
  • "type": "I",
  • "mark_sales_agent_id": 1,
  • "code": "A1202",
  • "barcode": "A1202",
  • "tax_id": "07616040726",
  • "vat_number": "07616040726",
  • "sdi_code": "KRRH6B9",
  • "mnemo": "string",
  • "company_name": "Deodato",
  • "company_name2": "Deodato",
  • "company_name3": "Deodato",
  • "bank_account": "string",
  • "iban": "IT29A0538704002011047516578",
  • "abi": "string",
  • "cab": "string",
  • "pec": "assistenza@deodato.com",
  • "email": "assistenza@deodato.com",
  • "phone": "0802342323",
  • "phone2": "0802342323",
  • "website": "https://www.websitename.it",
  • "zone": "string",
  • "city": "Bari",
  • "country": "Italia",
  • "country_iso_code": "IT",
  • "province": "BA",
  • "address": "via argiro 20",
  • "zip_code": "70123",
  • "invoice_address": "via argiro 28, 70123",
  • "destination_address": "via argiro 28, 70123",
  • "allow_in_statement": true,
  • "group": "string",
  • "department": "string",
  • "porto": "franco",
  • "shipping_cost": 10000,
  • "dde_shipping_cost": 10000,
  • "invoice_warning": "string",
  • "order_warning": "string"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "I",
  • "mark_sales_agent": {
    },
  • "code": "A1202",
  • "barcode": "A1202",
  • "tax_id": "07616040726",
  • "vat_number": "07616040726",
  • "sdi_code": "KRRH6B9",
  • "mnemo": "string",
  • "company_name": "Deodato",
  • "company_name2": "Deodato",
  • "company_name3": "Deodato",
  • "bank_account": "string",
  • "iban": "IT29A0538704002011047516578",
  • "abi": "string",
  • "cab": "string",
  • "pec": "assistenza@deodato.com",
  • "email": "assistenza@deodato.com",
  • "phone": "0802342323",
  • "phone2": "0802342323",
  • "website": "https://www.websitename.it",
  • "zone": "string",
  • "city": "Bari",
  • "country": "Italia",
  • "country_iso_code": "IT",
  • "province": "BA",
  • "address": "via argiro 20",
  • "zip_code": "70123",
  • "invoice_address": "via argiro 28, 70123",
  • "destination_address": "via argiro 28, 70123",
  • "allow_in_statement": true,
  • "group": "string",
  • "department": "string",
  • "porto": "franco",
  • "shipping_cost": 10000,
  • "dde_shipping_cost": 10000,
  • "invoice_warning": "string",
  • "order_warning": "string"
}

get a customer

get specific MarkCustomer by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "I",
  • "mark_sales_agent": {
    },
  • "code": "A1202",
  • "barcode": "A1202",
  • "tax_id": "07616040726",
  • "vat_number": "07616040726",
  • "sdi_code": "KRRH6B9",
  • "mnemo": "string",
  • "company_name": "Deodato",
  • "company_name2": "Deodato",
  • "company_name3": "Deodato",
  • "bank_account": "string",
  • "iban": "IT29A0538704002011047516578",
  • "abi": "string",
  • "cab": "string",
  • "pec": "assistenza@deodato.com",
  • "email": "assistenza@deodato.com",
  • "phone": "0802342323",
  • "phone2": "0802342323",
  • "website": "https://www.websitename.it",
  • "zone": "string",
  • "city": "Bari",
  • "country": "Italia",
  • "country_iso_code": "IT",
  • "province": "BA",
  • "address": "via argiro 20",
  • "zip_code": "70123",
  • "invoice_address": "via argiro 28, 70123",
  • "destination_address": "via argiro 28, 70123",
  • "allow_in_statement": true,
  • "group": "string",
  • "department": "string",
  • "porto": "franco",
  • "shipping_cost": 10000,
  • "dde_shipping_cost": 10000,
  • "invoice_warning": "string",
  • "order_warning": "string"
}

update customer

update MarkCustomer data with new ones sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with MarkCustomer entity data

type
string or null
Enum: "O" "R" "S" "I" "D"

the type of customer:

  • O: Omaggio
  • R: Reverse charge
  • S: Split payment
  • I: Esigibilità immediata
  • D: esigibilità differita'
mark_sales_agent_id
integer or null

a valid sales agent id

code
required
string

the unique code to identify the customer

barcode
string or null

the unique barcode to identify the customer

tax_id
string or null

the tax_id of the customer

vat_number
string or null

the customer vat number

sdi_code
string or null

the customer sdi code

mnemo
string or null

the customer mnemonic alias

company_name
required
string

the company name of the customer

company_name2
string or null

the company name of the customer part 2

company_name3
string or null

the company name of the customer part 3

bank_account
string or null

the bank account of the customer

iban
string or null

the iban of the customer

abi
string or null

the abi banck code of the customer

cab
string or null

the vab banck code of the customer

pec
string or null

the pec email to contact the customer

email
string or null

the main email to contact the customer

phone
string or null

the phone number of the customer

phone2
string or null

the second phone number of the customer

website
string or null

the main website of the customer

zone
string or null

the zone of the customer

city
string or null

the city of the customer

country
string or null

the country of the customer

country_iso_code
string or null

the country iso code of the customer

province
string or null

the province of the customer

address
string or null

the address of the customer

zip_code
string or null

the zip code of the customer

invoice_address
string or null

the invoice address of the customer

destination_address
string or null

the invoice address of the customer

allow_in_statement
boolean

flag that defines whether or not to include in the bank statement

group
string or null

the group of the customer

department
string or null

the department of the customer

porto
string or null
Enum: "franco" "assegnato"

the shipping porto of customer

shipping_cost
number or null

the shipping cost reserved to the customer

dde_shipping_cost
number or null

the shipping cost assigned of the customer

invoice_warning
string or null

warning text shown during customer invoice registration

order_warning
string or null

warning text shown during customer order registration

Responses

Request samples

Content type
application/json
{
  • "type": "I",
  • "mark_sales_agent_id": 1,
  • "code": "A1202",
  • "barcode": "A1202",
  • "tax_id": "07616040726",
  • "vat_number": "07616040726",
  • "sdi_code": "KRRH6B9",
  • "mnemo": "string",
  • "company_name": "Deodato",
  • "company_name2": "Deodato",
  • "company_name3": "Deodato",
  • "bank_account": "string",
  • "iban": "IT29A0538704002011047516578",
  • "abi": "string",
  • "cab": "string",
  • "pec": "assistenza@deodato.com",
  • "email": "assistenza@deodato.com",
  • "phone": "0802342323",
  • "phone2": "0802342323",
  • "website": "https://www.websitename.it",
  • "zone": "string",
  • "city": "Bari",
  • "country": "Italia",
  • "country_iso_code": "IT",
  • "province": "BA",
  • "address": "via argiro 20",
  • "zip_code": "70123",
  • "invoice_address": "via argiro 28, 70123",
  • "destination_address": "via argiro 28, 70123",
  • "allow_in_statement": true,
  • "group": "string",
  • "department": "string",
  • "porto": "franco",
  • "shipping_cost": 10000,
  • "dde_shipping_cost": 10000,
  • "invoice_warning": "string",
  • "order_warning": "string"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "I",
  • "mark_sales_agent": {
    },
  • "code": "A1202",
  • "barcode": "A1202",
  • "tax_id": "07616040726",
  • "vat_number": "07616040726",
  • "sdi_code": "KRRH6B9",
  • "mnemo": "string",
  • "company_name": "Deodato",
  • "company_name2": "Deodato",
  • "company_name3": "Deodato",
  • "bank_account": "string",
  • "iban": "IT29A0538704002011047516578",
  • "abi": "string",
  • "cab": "string",
  • "pec": "assistenza@deodato.com",
  • "email": "assistenza@deodato.com",
  • "phone": "0802342323",
  • "phone2": "0802342323",
  • "website": "https://www.websitename.it",
  • "zone": "string",
  • "city": "Bari",
  • "country": "Italia",
  • "country_iso_code": "IT",
  • "province": "BA",
  • "address": "via argiro 20",
  • "zip_code": "70123",
  • "invoice_address": "via argiro 28, 70123",
  • "destination_address": "via argiro 28, 70123",
  • "allow_in_statement": true,
  • "group": "string",
  • "department": "string",
  • "porto": "franco",
  • "shipping_cost": 10000,
  • "dde_shipping_cost": 10000,
  • "invoice_warning": "string",
  • "order_warning": "string"
}

remove customer

remove definitively MarkCustomer entity by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "code": 3211,
  • "message": "Bad Request"
}

mark / employee

get list of employee

Returns paged list of employee entities.

Authorizations:
(apiKeyAuthbearerAuth)
query Parameters
q
string
Example: q=test filter string

Urlencode search string to filter list of entities.

sort
Array of strings[ items^\D(.*):(ASC|DESC)$ ]
Example: sort=field1:ASC|field2:DESC

Pipe delimited list with attributes to sort

object (LHSDatetimePayload)
Example: created_at[value]=2019-08-24T14:15:22Z

LHS Brackets filter on created_at field

object (LHSDatetimePayload)
Example: updated_at[value]=2019-08-24T14:15:22Z

LHS Brackets filter on updated_at field

object (LHSStringPayload)
Example: code[value]=H725

LHS Brackets filter on code field

object (LHSStringPayload)
Example: tax_id[value]=H725

LHS Brackets filter on tax_id field

object (LHSStringPayload)
Example: firstname[value]=Mario

LHS Brackets filter on firstname field

object (LHSStringPayload)
Example: lastname[value]=Rossi

LHS Brackets filter on lastname field

object (LHSStringPayload)
Example: mnemo[value]=Nick

LHS Brackets filter on mnemo field

object (LHSStringPayload)
Example: job[value]=Developer

LHS Brackets filter on job field

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Range
required
string
Example: {unit}={from}-{to}

Tell the server if you want a paged resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create employee

create MarkEmployee entity with data sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with MarkEmployee entity data

code
required
string

the unique code to identify the employee

tax_id
string or null

the tax_id of the employee

mnemo
string or null

the employee mnemonic alias

firstname
required
string

the firstname of the employee

lastname
required
string

the lastname of the employee

job
string or null

the job of the employee

iban
string or null

the iban of the employee

pec
string or null

the pec email to contact the employee

email
string or null

the main email to contact the employee

phone
string or null

the phone number of the employee

phone2
string or null

the second phone number of the employee

website
string or null

the main website of the employee

city
string or null

the city of the employee

country
string or null

the country of the employee

country_iso_code
string or null

the country iso code of the employee

province
string or null

the province of the employee

address
string or null

the address of the employee

zip_code
string or null

the zip code of the employee

basic_salary
number or null

the basic salary of the employee

Responses

Request samples

Content type
application/json
{
  • "code": "A1202",
  • "tax_id": "RNNDN81H24A663R",
  • "mnemo": "string",
  • "firstname": "Mario",
  • "lastname": "Rossi",
  • "job": "Developer",
  • "iban": "IT29A0538704002011047516578",
  • "pec": "assistenza@deodato.com",
  • "email": "assistenza@deodato.com",
  • "phone": "0802342323",
  • "phone2": "0802342323",
  • "website": "https://www.websitename.it",
  • "city": "Bari",
  • "country": "Italia",
  • "country_iso_code": "IT",
  • "province": "BA",
  • "address": "via argiro 20",
  • "zip_code": "70123",
  • "basic_salary": 1700
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "A1202",
  • "tax_id": "RNNDN81H24A663R",
  • "mnemo": "string",
  • "firstname": "Mario",
  • "lastname": "Rossi",
  • "job": "Developer",
  • "iban": "IT29A0538704002011047516578",
  • "pec": "assistenza@deodato.com",
  • "email": "assistenza@deodato.com",
  • "phone": "0802342323",
  • "phone2": "0802342323",
  • "website": "https://www.websitename.it",
  • "city": "Bari",
  • "country": "Italia",
  • "country_iso_code": "IT",
  • "province": "BA",
  • "address": "via argiro 20",
  • "zip_code": "70123",
  • "basic_salary": 1700
}

get a employee

get specific MarkEmployee by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "A1202",
  • "tax_id": "RNNDN81H24A663R",
  • "mnemo": "string",
  • "firstname": "Mario",
  • "lastname": "Rossi",
  • "job": "Developer",
  • "iban": "IT29A0538704002011047516578",
  • "pec": "assistenza@deodato.com",
  • "email": "assistenza@deodato.com",
  • "phone": "0802342323",
  • "phone2": "0802342323",
  • "website": "https://www.websitename.it",
  • "city": "Bari",
  • "country": "Italia",
  • "country_iso_code": "IT",
  • "province": "BA",
  • "address": "via argiro 20",
  • "zip_code": "70123",
  • "basic_salary": 1700
}

update employee

update MarkEmployee data with new ones sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with MarkEmployee entity data

code
required
string

the unique code to identify the employee

tax_id
string or null

the tax_id of the employee

mnemo
string or null

the employee mnemonic alias

firstname
required
string

the firstname of the employee

lastname
required
string

the lastname of the employee

job
string or null

the job of the employee

iban
string or null

the iban of the employee

pec
string or null

the pec email to contact the employee

email
string or null

the main email to contact the employee

phone
string or null

the phone number of the employee

phone2
string or null

the second phone number of the employee

website
string or null

the main website of the employee

city
string or null

the city of the employee

country
string or null

the country of the employee

country_iso_code
string or null

the country iso code of the employee

province
string or null

the province of the employee

address
string or null

the address of the employee

zip_code
string or null

the zip code of the employee

basic_salary
number or null

the basic salary of the employee

Responses

Request samples

Content type
application/json
{
  • "code": "A1202",
  • "tax_id": "RNNDN81H24A663R",
  • "mnemo": "string",
  • "firstname": "Mario",
  • "lastname": "Rossi",
  • "job": "Developer",
  • "iban": "IT29A0538704002011047516578",
  • "pec": "assistenza@deodato.com",
  • "email": "assistenza@deodato.com",
  • "phone": "0802342323",
  • "phone2": "0802342323",
  • "website": "https://www.websitename.it",
  • "city": "Bari",
  • "country": "Italia",
  • "country_iso_code": "IT",
  • "province": "BA",
  • "address": "via argiro 20",
  • "zip_code": "70123",
  • "basic_salary": 1700
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "A1202",
  • "tax_id": "RNNDN81H24A663R",
  • "mnemo": "string",
  • "firstname": "Mario",
  • "lastname": "Rossi",
  • "job": "Developer",
  • "iban": "IT29A0538704002011047516578",
  • "pec": "assistenza@deodato.com",
  • "email": "assistenza@deodato.com",
  • "phone": "0802342323",
  • "phone2": "0802342323",
  • "website": "https://www.websitename.it",
  • "city": "Bari",
  • "country": "Italia",
  • "country_iso_code": "IT",
  • "province": "BA",
  • "address": "via argiro 20",
  • "zip_code": "70123",
  • "basic_salary": 1700
}

remove employee

remove definitively MarkEmployee entity by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "code": 3211,
  • "message": "Bad Request"
}

mark / sales agent

get list of sales agent

Returns paged list of sales agent entities.

Authorizations:
(apiKeyAuthbearerAuth)
query Parameters
q
string
Example: q=test filter string

Urlencode search string to filter list of entities.

sort
Array of strings[ items^\D(.*):(ASC|DESC)$ ]
Example: sort=field1:ASC|field2:DESC

Pipe delimited list with attributes to sort

object (LHSDatetimePayload)
Example: created_at[value]=2019-08-24T14:15:22Z

LHS Brackets filter on created_at field

object (LHSDatetimePayload)
Example: updated_at[value]=2019-08-24T14:15:22Z

LHS Brackets filter on updated_at field

object (LHSStringPayload)
Example: code[value]=H725

LHS Brackets filter on code field

object (LHSStringPayload)
Example: company_name[value]=H725

LHS Brackets filter on company_name field

object (LHSNumberPayload)
Example: fee[value]=7

LHS Brackets filter on fee field

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Range
required
string
Example: {unit}={from}-{to}

Tell the server if you want a paged resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create sales agent

create MarkSalesAgent entity with data sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with MarkSalesAgent entity data

code
required
string

the unique code to identify the sales agent

fee
required
number or null

the commissions reserved to the sales agent

company_name
string

the name of the sales agent

address
string or null

the address of the sales agent

Responses

Request samples

Content type
application/json
{
  • "code": "A1202",
  • "fee": 7,
  • "company_name": "Deodato",
  • "address": "via argiro 20, 70123, Bari"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "A1202",
  • "fee": 7,
  • "company_name": "Deodato",
  • "address": "via argiro 20, 70123, Bari"
}

get a sales agent

get specific MarkSalesAgent by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "A1202",
  • "fee": 7,
  • "company_name": "Deodato",
  • "address": "via argiro 20, 70123, Bari"
}

update sales agent

update MarkSalesAgent data with new ones sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with MarkSalesAgent entity data

code
required
string

the unique code to identify the sales agent

fee
required
number or null

the commissions reserved to the sales agent

company_name
string

the name of the sales agent

address
string or null

the address of the sales agent

Responses

Request samples

Content type
application/json
{
  • "code": "A1202",
  • "fee": 7,
  • "company_name": "Deodato",
  • "address": "via argiro 20, 70123, Bari"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "A1202",
  • "fee": 7,
  • "company_name": "Deodato",
  • "address": "via argiro 20, 70123, Bari"
}

remove sales agent

remove definitively MarkSalesAgent entity by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "code": 3211,
  • "message": "Bad Request"
}

mark / supplier

get list of supplier

Returns paged list of supplier entities.

Authorizations:
(apiKeyAuthbearerAuth)
query Parameters
q
string
Example: q=test filter string

Urlencode search string to filter list of entities.

sort
Array of strings[ items^\D(.*):(ASC|DESC)$ ]
Example: sort=field1:ASC|field2:DESC

Pipe delimited list with attributes to sort

object (LHSDatetimePayload)
Example: created_at[value]=2019-08-24T14:15:22Z

LHS Brackets filter on created_at field

object (LHSDatetimePayload)
Example: updated_at[value]=2019-08-24T14:15:22Z

LHS Brackets filter on updated_at field

object (LHSStringPayload)
Example: vat_number[value]=07616040726

LHS Brackets filter on vat_number field

object (LHSStringPayload)
Example: type[value]=Ricambi

LHS Brackets filter on type field

object (LHSStringPayload)
Example: code[value]=H725

LHS Brackets filter on code field

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Range
required
string
Example: {unit}={from}-{to}

Tell the server if you want a paged resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create supplier

create MarkSupplier entity with data sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with MarkSupplier entity data

code
required
string

the unique code to identify the supplier

vat_number
string or null

the company vat number

type
string or null

the type of supply

company_name
required
string

the name of the supplier

description
string or null

the description of the supplier

iban
string or null

the iban of the supplier

phone
string or null

the phone number of the supplier

address
string or null

the address of the supplier

email
string or null

the main email to contact the supplier

website
string or null

the main website of the supplier

Responses

Request samples

Content type
application/json
{
  • "code": "A1202",
  • "vat_number": "07616040726",
  • "type": "Ricambi",
  • "company_name": "Deodato",
  • "description": "gomme e ricambi auto",
  • "iban": "IT29A0538704002011047516578",
  • "phone": "0802342323",
  • "address": "via argiro 20, 70123, Bari",
  • "email": "assistenza@deodato.com",
  • "website": "https://www.websitename.it"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "A1202",
  • "vat_number": "07616040726",
  • "type": "Ricambi",
  • "company_name": "Deodato",
  • "description": "gomme e ricambi auto",
  • "iban": "IT29A0538704002011047516578",
  • "phone": "0802342323",
  • "address": "via argiro 20, 70123, Bari",
  • "email": "assistenza@deodato.com",
  • "website": "https://www.websitename.it"
}

get a supplier

get specific MarkSupplier by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "A1202",
  • "vat_number": "07616040726",
  • "type": "Ricambi",
  • "company_name": "Deodato",
  • "description": "gomme e ricambi auto",
  • "iban": "IT29A0538704002011047516578",
  • "phone": "0802342323",
  • "address": "via argiro 20, 70123, Bari",
  • "email": "assistenza@deodato.com",
  • "website": "https://www.websitename.it"
}

update supplier

update MarkSupplier data with new ones sent in request body

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Content-Type
required
string
Example: application/json

Content type

Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Request Body schema: application/json
required

A JSON object with MarkSupplier entity data

code
required
string

the unique code to identify the supplier

vat_number
string or null

the company vat number

type
string or null

the type of supply

company_name
required
string

the name of the supplier

description
string or null

the description of the supplier

iban
string or null

the iban of the supplier

phone
string or null

the phone number of the supplier

address
string or null

the address of the supplier

email
string or null

the main email to contact the supplier

website
string or null

the main website of the supplier

Responses

Request samples

Content type
application/json
{
  • "code": "A1202",
  • "vat_number": "07616040726",
  • "type": "Ricambi",
  • "company_name": "Deodato",
  • "description": "gomme e ricambi auto",
  • "iban": "IT29A0538704002011047516578",
  • "phone": "0802342323",
  • "address": "via argiro 20, 70123, Bari",
  • "email": "assistenza@deodato.com",
  • "website": "https://www.websitename.it"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "A1202",
  • "vat_number": "07616040726",
  • "type": "Ricambi",
  • "company_name": "Deodato",
  • "description": "gomme e ricambi auto",
  • "iban": "IT29A0538704002011047516578",
  • "phone": "0802342323",
  • "address": "via argiro 20, 70123, Bari",
  • "email": "assistenza@deodato.com",
  • "website": "https://www.websitename.it"
}

remove supplier

remove definitively MarkSupplier entity by id

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
id
required
integer <int64> >= 1
Example: 1

ID of the resurce to query

header Parameters
Accept-Lang
required
string
Example: it

The user selected language

Accept-Version
required
string
Example: 1.0.0

The API version you intend to query

Responses

Response samples

Content type
application/json
{
  • "code": 3211,
  • "message": "Bad Request"
}

MarkBrand

id
required
integer

The resource ID.

rel
required
string

The entity type.

created_at
required
string <date-time>

The date of the resource creation in ISO 8601 format.

updated_at
required
string <date-time>

The date of the last resource modification in ISO 8601 format.

code
required
string
description
required
string
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "12345A",
  • "description": "brand description"
}

MarkCategory

id
required
integer

The resource ID.

rel
required
string

The entity type.

created_at
required
string <date-time>

The date of the resource creation in ISO 8601 format.

updated_at
required
string <date-time>

The date of the last resource modification in ISO 8601 format.

code
required
string
description
required
string
department
string or null
exportable
boolean
parent_category_id
integer or null
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "12345A",
  • "description": "category description",
  • "department": "department01",
  • "exportable": true,
  • "parent_category_id": 12
}

MarkCustomer

id
required
integer

The resource ID.

rel
required
string

The entity type.

created_at
required
string <date-time>

The date of the resource creation in ISO 8601 format.

updated_at
required
string <date-time>

The date of the last resource modification in ISO 8601 format.

type
string or null
Enum: "O" "R" "S" "I" "D"

the type of customer:

  • O: Omaggio
  • R: Reverse charge
  • S: Split payment
  • I: Esigibilità immediata
  • D: esigibilità differita'
object (MarkSalesAgentSchema)
mark_sales_agent_id
integer or null

a valid sales agent id

code
required
string

the unique code to identify the customer

barcode
string or null

the unique barcode to identify the customer

tax_id
string or null

the tax_id of the customer

vat_number
string or null

the customer vat number

sdi_code
string or null

the customer sdi code

mnemo
string or null

the customer mnemonic alias

company_name
required
string

the company name of the customer

company_name2
string or null

the company name of the customer part 2

company_name3
string or null

the company name of the customer part 3

bank_account
string or null

the bank account of the customer

iban
string or null

the iban of the customer

abi
string or null

the abi banck code of the customer

cab
string or null

the vab banck code of the customer

pec
string or null

the pec email to contact the customer

email
string or null

the main email to contact the customer

phone
string or null

the phone number of the customer

phone2
string or null

the second phone number of the customer

website
string or null

the main website of the customer

zone
string or null

the zone of the customer

city
string or null

the city of the customer

country
string or null

the country of the customer

country_iso_code
string or null

the country iso code of the customer

province
string or null

the province of the customer

address
string or null

the address of the customer

zip_code
string or null

the zip code of the customer

invoice_address
string or null

the invoice address of the customer

destination_address
string or null

the invoice address of the customer

allow_in_statement
boolean

flag that defines whether or not to include in the bank statement

group
string or null

the group of the customer

department
string or null

the department of the customer

porto
string or null
Enum: "franco" "assegnato"

the shipping porto of customer

shipping_cost
number or null

the shipping cost reserved to the customer

dde_shipping_cost
number or null

the shipping cost assigned of the customer

invoice_warning
string or null

warning text shown during customer invoice registration

order_warning
string or null

warning text shown during customer order registration

{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "I",
  • "mark_sales_agent": {
    },
  • "code": "A1202",
  • "barcode": "A1202",
  • "tax_id": "07616040726",
  • "vat_number": "07616040726",
  • "sdi_code": "KRRH6B9",
  • "mnemo": "string",
  • "company_name": "Deodato",
  • "company_name2": "Deodato",
  • "company_name3": "Deodato",
  • "bank_account": "string",
  • "iban": "IT29A0538704002011047516578",
  • "abi": "string",
  • "cab": "string",
  • "pec": "assistenza@deodato.com",
  • "email": "assistenza@deodato.com",
  • "phone": "0802342323",
  • "phone2": "0802342323",
  • "website": "https://www.websitename.it",
  • "zone": "string",
  • "city": "Bari",
  • "country": "Italia",
  • "country_iso_code": "IT",
  • "province": "BA",
  • "address": "via argiro 20",
  • "zip_code": "70123",
  • "invoice_address": "via argiro 28, 70123",
  • "destination_address": "via argiro 28, 70123",
  • "allow_in_statement": true,
  • "group": "string",
  • "department": "string",
  • "porto": "franco",
  • "shipping_cost": 10000,
  • "dde_shipping_cost": 10000,
  • "invoice_warning": "string",
  • "order_warning": "string"
}

MarkEmployee

id
required
integer

The resource ID.

rel
required
string

The entity type.

created_at
required
string <date-time>

The date of the resource creation in ISO 8601 format.

updated_at
required
string <date-time>

The date of the last resource modification in ISO 8601 format.

code
required
string

the unique code to identify the employee

tax_id
string or null

the tax_id of the employee

mnemo
string or null

the employee mnemonic alias

firstname
required
string

the firstname of the employee

lastname
required
string

the lastname of the employee

job
string or null

the job of the employee

iban
string or null

the iban of the employee

pec
string or null

the pec email to contact the employee

email
string or null

the main email to contact the employee

phone
string or null

the phone number of the employee

phone2
string or null

the second phone number of the employee

website
string or null

the main website of the employee

city
string or null

the city of the employee

country
string or null

the country of the employee

country_iso_code
string or null

the country iso code of the employee

province
string or null

the province of the employee

address
string or null

the address of the employee

zip_code
string or null

the zip code of the employee

basic_salary
number or null

the basic salary of the employee

{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "A1202",
  • "tax_id": "RNNDN81H24A663R",
  • "mnemo": "string",
  • "firstname": "Mario",
  • "lastname": "Rossi",
  • "job": "Developer",
  • "iban": "IT29A0538704002011047516578",
  • "pec": "assistenza@deodato.com",
  • "email": "assistenza@deodato.com",
  • "phone": "0802342323",
  • "phone2": "0802342323",
  • "website": "https://www.websitename.it",
  • "city": "Bari",
  • "country": "Italia",
  • "country_iso_code": "IT",
  • "province": "BA",
  • "address": "via argiro 20",
  • "zip_code": "70123",
  • "basic_salary": 1700
}

MarkProduct

id
required
integer

The resource ID.

rel
required
string

The entity type.

created_at
required
string <date-time>

The date of the resource creation in ISO 8601 format.

updated_at
required
string <date-time>

The date of the last resource modification in ISO 8601 format.

sku
required
string
object (MarkCategorySchema)
mark_category_id
integer or null
object (MarkBrandSchema)
mark_brand_id
integer or null
media_gallery_id
integer or null

a valid media gallery id with public media

name
string or null
reference
string or null
short_description
string or null
description
string or null
measurement_unit
string or null
net_price
number or null
vat_price
number or null
second_price
number or null
cost
number
qty
number
object (MarkCustomerSchema)
mark_customer_id
integer

a valid customer id

object (MarkSupplierSchema)
mark_supplier_id
integer

a valid supplier id

repair_media_gallery_id
integer

a valid media gallery id with private media

object (ChannelSyncSchema)
object (QueueEventSchema)
type
required
string
Enum: "repair" "revision" "retail"

type of the product, only if set as 'retail' product will be synchronized with official website

code
string or null

non-unique code attribute

category_code
string

category code attribute

supplier_code
string or null

unique supplier code attribute

customer_code
string or null

unique customer code attribute

purchase_date
string or null <date>

purchase date attribute

purchase_taxable
number or null

purchase taxable attribute

purchase_vat
number or null

purchase vat attribute

delivery_date
string or null <date>

delivery date attribute

sell_date
string or null <date>

sell date attribute

sell_price
number or null

sell price attribute

promo_price
number or null

promo price attribute

repair_notes
string or null

repair notes attribute

lot
number or null

lot attribute

tax_lot
string or null

tax lot attribute

old_tax_lot
string or null

old tax lot attribute

vat_code
string or null

vat_code attribute

returned
boolean

returned flag

selected
boolean

selected flag

updated
boolean

updated flag

draft
boolean

draft flag

warehouse_location
string or null

warehouse location attribute

status
string or null
Enum: "available" "booked" "ddt" "sold" "return" "forced_booked" "forced_ddt" "forced_sold" "forced_return"

status attribute

shopify
string
Enum: "DRAFT" "PUBLISHED"

shopify status attribute

year
string or null

year attribute

set
string or null

set attribute

set_code
string or null

set code attribute

diameter
string or null

diameter attribute

number
string or null

number attribute

bracelet
string or null

bracelet attribute

bracelet_code
string or null

bracelet code attribute

bracelet_number
string or null

bracelet number attribute

case
string or null

case attribute

indexes
string or null

indexes attribute

indexes_code
string or null

indexes code attribute

movement
string or null

movement attribute

movement_code
string or null

movement code attribute

dial
string or null

dial attribute

dial_code
string or null

dial code attribute

glass
string or null

glass attribute

glass_code
string or null

glass code attribute

buckle
string or null

buckle attribute

buckle_code
string or null

buckle code attribute

links_number
integer or null

links number attribute

caliber
string or null

caliber attribute

clasp
string or null

clasp attribute

end_links
string or null

end links attribute

case_back
string or null

case back attribute

sales_channel
string or null

sales channel attribute

{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "sku": "12345",
  • "mark_category": {
    },
  • "mark_brand": {
    },
  • "media_gallery_id": 1,
  • "name": "product name",
  • "reference": "XYZ",
  • "short_description": "product text",
  • "description": "product long description text",
  • "measurement_unit": "string",
  • "net_price": 100,
  • "vat_price": 120,
  • "second_price": 115,
  • "cost": 75,
  • "qty": 150,
  • "mark_customer": {
    },
  • "mark_supplier": {
    },
  • "repair_media_gallery_id": 1,
  • "channel_sync": {
    },
  • "queue_event": {
    },
  • "type": "repair",
  • "code": "string",
  • "category_code": "string",
  • "supplier_code": "string",
  • "customer_code": "string",
  • "purchase_date": "2019-08-24",
  • "purchase_taxable": 0,
  • "purchase_vat": 0,
  • "delivery_date": "2019-08-24",
  • "sell_date": "2019-08-24",
  • "sell_price": 0,
  • "promo_price": 0,
  • "repair_notes": "string",
  • "lot": 0,
  • "tax_lot": "string",
  • "old_tax_lot": "string",
  • "vat_code": "string",
  • "returned": true,
  • "selected": true,
  • "updated": true,
  • "draft": true,
  • "warehouse_location": "string",
  • "status": "available",
  • "shopify": "DRAFT",
  • "year": "string",
  • "set": "string",
  • "set_code": "string",
  • "diameter": "string",
  • "number": "string",
  • "bracelet": "string",
  • "bracelet_code": "string",
  • "bracelet_number": "string",
  • "case": "string",
  • "indexes": "string",
  • "indexes_code": "string",
  • "movement": "string",
  • "movement_code": "string",
  • "dial": "string",
  • "dial_code": "string",
  • "glass": "string",
  • "glass_code": "string",
  • "buckle": "string",
  • "buckle_code": "string",
  • "links_number": 0,
  • "caliber": "string",
  • "clasp": "string",
  • "end_links": "string",
  • "case_back": "string",
  • "sales_channel": "string"
}

MarkSalesAgent

id
required
integer

The resource ID.

rel
required
string

The entity type.

created_at
required
string <date-time>

The date of the resource creation in ISO 8601 format.

updated_at
required
string <date-time>

The date of the last resource modification in ISO 8601 format.

code
required
string

the unique code to identify the sales agent

fee
required
number or null

the commissions reserved to the sales agent

company_name
string

the name of the sales agent

address
string or null

the address of the sales agent

{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "A1202",
  • "fee": 7,
  • "company_name": "Deodato",
  • "address": "via argiro 20, 70123, Bari"
}

MarkSupplier

id
required
integer

The resource ID.

rel
required
string

The entity type.

created_at
required
string <date-time>

The date of the resource creation in ISO 8601 format.

updated_at
required
string <date-time>

The date of the last resource modification in ISO 8601 format.

code
required
string

the unique code to identify the supplier

vat_number
string or null

the company vat number

type
string or null

the type of supply

company_name
required
string

the name of the supplier

description
string or null

the description of the supplier

iban
string or null

the iban of the supplier

phone
string or null

the phone number of the supplier

address
string or null

the address of the supplier

email
string or null

the main email to contact the supplier

website
string or null

the main website of the supplier

{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "code": "A1202",
  • "vat_number": "07616040726",
  • "type": "Ricambi",
  • "company_name": "Deodato",
  • "description": "gomme e ricambi auto",
  • "iban": "IT29A0538704002011047516578",
  • "phone": "0802342323",
  • "address": "via argiro 20, 70123, Bari",
  • "email": "assistenza@deodato.com",
  • "website": "https://www.websitename.it"
}

MarkVariant

id
required
integer

The resource ID.

rel
required
string

The entity type.

created_at
required
string <date-time>

The date of the resource creation in ISO 8601 format.

updated_at
required
string <date-time>

The date of the last resource modification in ISO 8601 format.

barcode
required
string
label
string or null
price
number or null
{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "barcode": "12345A",
  • "label": "variant label",
  • "price": 120
}

Token

signature
required
string

The JWT generated signature.

refresh
string

The one time refresh token.

{
  • "signature": "valid-jwt-signature",
  • "refresh": "one-time-refresh-token"
}

Device

id
required
integer

The resource ID.

rel
required
string

The entity type.

created_at
required
string <date-time>

The date of the resource creation in ISO 8601 format.

updated_at
required
string <date-time>

The date of the last resource modification in ISO 8601 format.

type
required
string
Enum: "smartphone" "tablet" "desktop"

connected device type

os
required
string
Enum: "android" "ios" "windows" "linux" "macos"

device os macro category beetween android/ios

os_version
required
string

device os version number

language
string
Default: "en"

two characters string languages identifier (eg. it, en, ...)

enable_notification
boolean
Default: true

flag to enable or disable push notification

notification_token
string

unique firebase notification token genarated form Google/Apple

vendor_id
required
string

unique vendor device token genarated form Google/Apple

app_version
string

client application version

object
{
  • "id": 1,
  • "rel": "Device",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "smartphone",
  • "os": "android",
  • "os_version": 23,
  • "language": "it",
  • "enable_notification": true,
  • "notification_token": "dWPEVGJjGNA:APA91bEzLWfVOzbS6btIqDe70Yb7hL...",
  • "vendor_id": "dWPEVGJjGNA:APA91bEzLWfVOzbS6btIqDe70Yb7hL...",
  • "app_version": "1.0.0",
  • "token": {
    }
}

DeviceLog

id
required
integer

The resource ID.

rel
required
string

The entity type.

created_at
required
string <date-time>

The date of the resource creation in ISO 8601 format.

updated_at
required
string <date-time>

The date of the last resource modification in ISO 8601 format.

type
required
string
Enum: "INFO" "WARN" "ERROR"

log type definition, INFO = generic logged information, WARN = something could be a problem or not, ERROR = an important problem/error to solve

api_version
string

web service version in use

app_version
string

client application version in use

username
string

device logged username

message
string

log message to store

attachment_name
string

name of the file attached to the log

attachment_url
string

url of the log attachment

{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "INFO",
  • "api_version": "1.0.0",
  • "app_version": "1.0.0",
  • "username": "your@email.com",
  • "message": "string",
  • "attachment_name": "string",
  • "attachment_url": "string"
}

Identity

username
required
string

valid username (email or phone number)

password
string or null

valid password

new_password
string or null

valid new password used only in password update request

{
  • "username": "string"
}

IdentityConfirmation

code
string

account confirmation code (null if email field evalued)

email
string <email>

account email to check if new confirmation code has been requested (null if code field evalued)

{ }

Role

id
required
integer

The resource ID.

rel
required
string

The entity type.

weight
required
integer

progressive number used to order by roles via semantic prioritization values

label
required
string

role friendly name (eg. ADMIN, MEMBER, GUEST, ...)

description
string

short text describing role

{
  • "id": 1,
  • "rel": "string",
  • "weight": 20,
  • "label": "ADMIN",
  • "description": "string"
}

User

id
required
integer

The resource ID.

rel
required
string

The entity type.

created_at
required
string <date-time>

The date of the resource creation in ISO 8601 format.

updated_at
required
string <date-time>

The date of the last resource modification in ISO 8601 format.

role_id
integer

ID of the user role (1=SUPERADMIN, 2=ADMIN, 3=MEMBER, 4=GUEST).

object (RoleSchema)
avatar_media_id
integer

ID of the user avatar related to media object prevently uploaded.

object (Media)
first_name
string
last_name
string
email
required
string <email>
phone_country
string
phone
string
password
string <password>

password used to identify the user (required in POST request)

privacy
required
boolean
terms
required
boolean
enabled
boolean

value is TRUE if user comfirm his account

locked
boolean

value is TRUE if admin ban this account, you can only set this flag to unlock banned user, use DELETE /user/:id to lock it

{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "role": {
    },
  • "avatar_media": {},
  • "first_name": "John",
  • "last_name": "Smith",
  • "email": "your@email.com",
  • "phone_country": "+39",
  • "phone": "3285564324",
  • "privacy": true,
  • "terms": true,
  • "enabled": true,
  • "locked": false
}

Media

id
required
integer

The resource ID.

rel
required
string

The entity type.

created_at
required
string <date-time>

The date of the resource creation in ISO 8601 format.

updated_at
required
string <date-time>

The date of the last resource modification in ISO 8601 format.

type
required
string
Enum: "IMAGE" "DOCUMENT"

The logical media type.

weight
number <integer>

The weight define the priority between listed media

title
string

The media file original title.

description
string or null

The media file alternative description.

mime_type
string

The media mime-type, sending different value from default uploaded media mime_type force the server to try a type conversion.

extension
string

The media file original extension (gif, jpg, ...).

size
number <integer>

The size of file in KB

required
object

all remote media resource urls in CDN

object (ChannelSyncSchema)
object (QueueEventSchema)
{}

HypermediaPayload

id
integer

The resource ID.

rel
required
string

The name of the related resource.

href
required
string

The resource url tu query.

type
required
string
Default: "GET"
Enum: "GET" "POST" "PUT" "PATCH" "DELETE"

The selceted HTTP method to use in query.

{}

InvalidField

field
string

the error related unique field name

errors
Array of strings

list of related field error messages

{
  • "field": "string",
  • "errors": [
    ]
}

LHSBooleanPayload

eq
number [ 0 .. 1 ]
nq
number [ 0 .. 1 ]
{
  • "eq": 1,
  • "nq": 1
}

LHSNumberPayload

eq
number or null
nq
number or null
inside
number^\d+((?:\:\d+)+)$
outside
number^\d+((?:\:\d+)+)$
lt
number
lte
number
gt
number
gte
number
range
number^\d+:\d+$
{
  • "eq": 0,
  • "nq": 0,
  • "inside": 0,
  • "outside": 0,
  • "lt": 0,
  • "lte": 0,
  • "gt": 0,
  • "gte": 0,
  • "range": 0
}

LHSDatetimePayload

eq
string or null <date-time>
nq
string or null <date-time>
inside
string^\w+((?:\:\w+)+)$
outside
string^\w+((?:\:\w+)+)$
lt
string <date-time>
lte
string <date-time>
gt
string <date-time>
gte
string <date-time>
range
string^\w+:\w+$
{
  • "eq": "2019-08-24T14:15:22Z",
  • "nq": "2019-08-24T14:15:22Z",
  • "inside": "string",
  • "outside": "string",
  • "lt": "2019-08-24T14:15:22Z",
  • "lte": "2019-08-24T14:15:22Z",
  • "gt": "2019-08-24T14:15:22Z",
  • "gte": "2019-08-24T14:15:22Z",
  • "range": "string"
}

LHSStringPayload

eq
string or null
nq
string or null
inside
string^\w+((?:\:\w+)+)$
outside
string^\w+((?:\:\w+)+)$
like
string
lt
string
lte
string
gt
string
gte
string
regex
string
range
string^\w+:\w+$
{
  • "eq": "string",
  • "nq": "string",
  • "inside": "string",
  • "outside": "string",
  • "like": "string",
  • "lt": "string",
  • "lte": "string",
  • "gt": "string",
  • "gte": "string",
  • "regex": "string",
  • "range": "string"
}

SimplePayload

code
required
integer <integer>

number of exception code

message
required
string

simple text to describe response

{
  • "code": 1001,
  • "message": "string"
}

EntityPayload

id
required
integer

The resource ID.

rel
required
string

The entity type.

{
  • "id": 1,
  • "rel": "string"
}

EntitiesPayload

rel
required
string

The entity type.

entities
required
Array of arrays

The array of entities.

{
  • "rel": "string",
  • "entities": [ ]
}

TimestampablePayload

id
required
integer

The resource ID.

rel
required
string

The entity type.

created_at
required
string <date-time>

The date of the resource creation in ISO 8601 format.

updated_at
required
string <date-time>

The date of the last resource modification in ISO 8601 format.

{
  • "id": 1,
  • "rel": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}