Info

Base URL

# Base URL
https://api.rhinocrm.com.au (Production)
https://uat.rhinocrm.com.au/api (UAT)

Here are the domain URLS that can be used in your requests to the api. While testing please use the UAT domain provided below:

• Production: https://api.rhinocrm.com.au
• UAT: https://uat.rhinocrm.com.au/api

Request Requirements

Headers

# Headers
Accept: 'application/json'
x-consumer: '<provided by forteis>'
Authorization: '<provided by forteis>'

The following headers are required for all requests: Accept, x-consumer and Authorization

Form Data Parameters

# Send along the _method parameter for POST/PUT requests
_method = POST (for create requests)
_method = PUT  (for update requests)

All parameters for each request are listed in the following documentation and will need to be sent as form data.

• The _method parameter needs to be sent when calling a Create (POST /resource), Update (PUT /resource/) or Bulk Update (PUT /resource)
  • You will need to use the POST method for Update and Create requests.
  • You will also need to pass along an extra parameter called _method. Its value should correlate to what action you are trying to call.
    • Create: _method = POST
    • Update: _method = PUT
    • Bulk Update: _method = PUT
• Requests that allow updating or inserting bulk records will require array form inputs.

Responses

The Api will return the following HTTP Codes and data, depending on the request type and input you provide.

Request Type	Response
Index: GET /{resource}	Success 200 OK Records with pagination Server Error 500 Internal Server Error
Show: GET /{resource}/{id}	Success 200 OK Record Doesn’t exist 404 Not Found Server Error 500 Internal Server Error
Create: POST /{resource}	Success 201 Created Record Invalid Input 422 Unprocessable Entity Already Exists 400 Bad Request Server Error 500 Internal Server Error
Update: PUT /{resource}/{id}	Success 200 OK Record Invalid Input 422 Unprocessable Entity Doesn’t exist 404 Not Found Server Error 500 Internal Server Error
Bulk Update: PUT /{resource}	Success 200 OK Record Invalid Input 422 Unprocessable Entity Doesn’t exist 404 Not Found Server Error 500 Internal Server Error
Delete: DELETE /{resource}/{id}	Success 204 No Content Record Doesn’t exist 404 Not Found Failed to delete due to record being used by another resource 403 Forbidden Server Error 500 Internal Server Error

Responses with single records

    # GET /resource/{id} response
    200 OK
    {
        "usr_id": "957364F2-6840-DDF5-6F92-665A7EB92B18",
        "usr_tab_id": "731654F3-9453-8861-43E3-A2A311D00F7A",
        "usr_display_name": "James Thomson",
        "usr_name": "kari.c",
        "usr_email": null,
        "usr_last_sync_time": "0000-00-00 00:00:00",
        "usr_blacklisted": "false",
        "usr_current_version": "2.11",
        "usr_reportable": "false",
        "usr_progress_beer_target": 120,
        "usr_cycle_start": 1379289600000,
        "usr_cycle_interval": 4,
        "sta_name": "NSW",
        "usr_TS": "2016-08-17 15:56:13",
        "remember_token": null
    }    

After making one of the following requests and the response will return simple json with related fields (see RHS).

• GET /resource/{id}
• POST /resource
• PUT /resource/{id}

Responses with multiple records

    # GET /resource response
    200 OK
    {
        "total": 60,
        "per_page": "2",
        "current_page": 1,
        "last_page": 30,
        "next_page_url": "https://<base-url>/users?page=2",
        "prev_page_url": null,
        "from": 1,
        "to": 2,
        "data": [
        {
            "usr_id": "957364F2-6840-DDF5-6F92-665A7EB92B18",
            "usr_tab_id": "731654F3-9453-8861-43E3-A2A311D00F7A",
            "usr_display_name": "James Thomson",
            "usr_name": "kari.c",
            "usr_email": null,
            "usr_last_sync_time": "0000-00-00 00:00:00",
            "usr_blacklisted": "false",
            "usr_current_version": "2.11",
            "usr_reportable": "false",
            "usr_progress_beer_target": 120,
            "usr_cycle_start": 1379289600000,
            "usr_cycle_interval": 4,
            "sta_name": "NSW",
            "usr_TS": "2016-08-17 15:56:13",
            "remember_token": null
        },
        {
            "usr_id": "957364F2-8154-5EE2-CD56-A99903619133",
            "usr_tab_id": "2E9A7550-3929-39C5-CF94-B7E7A948C42F",
            "usr_display_name": "SA - Unallocated",
            "usr_name": "sa.-.u",
            "usr_email": null,
            "usr_last_sync_time": "0000-00-00 00:00:00",
            "usr_blacklisted": "false",
            "usr_current_version": "2.11",
            "usr_reportable": "false",
            "usr_progress_beer_target": 120,
            "usr_cycle_start": 1379289600000,
            "usr_cycle_interval": 4,
            "sta_name": "SA",
            "usr_TS": "2016-08-17 15:56:18",
            "remember_token": null
        }]
    }

After making a GET /resource call, the returned results are Paginated, you can pass along extra parameters to filter as required

• page
• per_page
• updated_after

Account-Agreement

Retrieve multiple

Example request:

curl "https://<base-url>/account-agreement" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="733142299" \
    -d "per_page"="341" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-agreement",
    "method": "GET",
    "data": {
        "page": 733142299,
        "per_page": 341,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-agreement

HEAD account-agreement

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/account-agreement" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "usr_id"="tempore" \
    -d "act_id"="tempore" \
    -d "signed_contract"="1" \
    -d "expiry_date"="2025:07:10" \
    -d "main_supplier"="1322501" \
    -d "secondary_supplier"="1322501" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-agreement",
    "method": "POST",
    "data": {
        "usr_id": "tempore",
        "act_id": "tempore",
        "signed_contract": true,
        "expiry_date": "2025:07:10",
        "main_supplier": 1322501,
        "secondary_supplier": 1322501
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST account-agreement

Parameters

Parameter	Type	Status	Description
usr_id	string	required	Valid user usr_id
act_id	string	required	Valid account act_id
signed_contract	boolean	optional
expiry_date	date	optional	Date format: Y:m:d
main_supplier	numeric	optional	Valid tap tap_id
secondary_supplier	numeric	optional	Valid tap tap_id

Retrieve

Example request:

curl "https://<base-url>/account-agreement/{account_agreement}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account_agreement"="3788" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-agreement/{account_agreement}",
    "method": "GET",
    "data": {
        "account_agreement": 3788
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-agreement/{account_agreement}

HEAD account-agreement/{account_agreement}

Parameters

Parameter	Type	Status	Description
account_agreement	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/account-agreement/{account_agreement}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "usr_id"="et" \
    -d "act_id"="et" \
    -d "signed_contract"="1" \
    -d "expiry_date"="2025:07:10" \
    -d "main_supplier"="96576" \
    -d "secondary_supplier"="96576" \
    -d "id"="et" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-agreement/{account_agreement}",
    "method": "PUT",
    "data": {
        "usr_id": "et",
        "act_id": "et",
        "signed_contract": true,
        "expiry_date": "2025:07:10",
        "main_supplier": 96576,
        "secondary_supplier": 96576,
        "id": "et"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT account-agreement/{account_agreement}

PATCH account-agreement/{account_agreement}

Parameters

Parameter	Type	Status	Description
usr_id	string	optional	Valid user usr_id
act_id	string	optional	Valid account act_id
signed_contract	boolean	optional
expiry_date	date	optional	Date format: Y:m:d
main_supplier	numeric	optional	Valid tap tap_id
secondary_supplier	numeric	optional	Valid tap tap_id
id	string	optional

Delete

Example request:

curl "https://<base-url>/account-agreement/{account_agreement}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-agreement/{account_agreement}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE account-agreement/{account_agreement}

Account-Cocktails

Retrieve multiple

Example request:

curl "https://<base-url>/account-cocktails" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1662956515" \
    -d "per_page"="775" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-cocktails",
    "method": "GET",
    "data": {
        "page": 1662956515,
        "per_page": 775,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-cocktails

HEAD account-cocktails

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Delete

Example request:

curl "https://<base-url>/account-cocktails/{account_cocktails}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-cocktails/{account_cocktails}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE account-cocktails/{account_cocktails}

Account-Contact-Positions

Retrieve multiple

Example request:

curl "https://<base-url>/account-contact-positions" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="2011161709" \
    -d "per_page"="937" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-contact-positions",
    "method": "GET",
    "data": {
        "page": 2011161709,
        "per_page": 937,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-contact-positions

HEAD account-contact-positions

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/account-contact-positions" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "cop_name"="aut" \
    -d "cop_order"="68109134" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-contact-positions",
    "method": "POST",
    "data": {
        "cop_name": "aut",
        "cop_order": 68109134
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST account-contact-positions

Parameters

Parameter	Type	Status	Description
cop_name	string	required	Maximum: 255
cop_order	integer	required

Retrieve

Example request:

curl "https://<base-url>/account-contact-positions/{account_contact_positions}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account_contact_positions"="354318" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-contact-positions/{account_contact_positions}",
    "method": "GET",
    "data": {
        "account_contact_positions": 354318
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-contact-positions/{account_contact_positions}

HEAD account-contact-positions/{account_contact_positions}

Parameters

Parameter	Type	Status	Description
account_contact_positions	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/account-contact-positions/{account_contact_positions}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account_contact_positions"="863" \
    -d "cop_name"="cupiditate" \
    -d "cop_order"="863" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-contact-positions/{account_contact_positions}",
    "method": "PUT",
    "data": {
        "account_contact_positions": 863,
        "cop_name": "cupiditate",
        "cop_order": 863
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT account-contact-positions/{account_contact_positions}

PATCH account-contact-positions/{account_contact_positions}

Parameters

Parameter	Type	Status	Description
account_contact_positions	numeric	required	Must have a length between 1 and 11
cop_name	string	required	Maximum: 255
cop_order	integer	required

Delete

Example request:

curl "https://<base-url>/account-contact-positions/{account_contact_positions}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-contact-positions/{account_contact_positions}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE account-contact-positions/{account_contact_positions}

Account-Contacts

Retrieve multiple

Example request:

curl "https://<base-url>/account-contacts" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="739700114" \
    -d "per_page"="344" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-contacts",
    "method": "GET",
    "data": {
        "page": 739700114,
        "per_page": 344,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-contacts

HEAD account-contacts

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/account-contacts" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "con_name"="13" \
    -d "con_telephone"="13" \
    -d "con_mobile"="13" \
    -d "con_email"="13" \
    -d "con_res"="67" \
    -d "con_primary"="TRUE" \
    -d "con_account_type"="On Premise" \
    -d "con_dob"="2025-07-10" \
    -d "con_editable"="true" \
    -d "act_id"="10" \
    -d "cop_id"="446" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-contacts",
    "method": "POST",
    "data": {
        "con_name": 13,
        "con_telephone": 13,
        "con_mobile": 13,
        "con_email": 13,
        "con_res": 67,
        "con_primary": "TRUE",
        "con_account_type": "On Premise",
        "con_dob": "2025-07-10",
        "con_editable": "true",
        "act_id": 10,
        "cop_id": 446
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST account-contacts

Parameters

Parameter	Type	Status	Description
con_name	string	required	Between: 1 and 50
con_telephone	string	optional	Between: 1 and 50
con_mobile	string	optional	Between: 1 and 50
con_email	email	optional	Between: 1 and 50
con_res	string	optional	Between: 1 and 255
con_primary	string	optional	TRUE or FALSE
con_account_type	string	optional	On Premise, Off Premise or Integrated
con_dob	date	optional	Date format: Y-m-d
con_editable	string	optional	true or false
act_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
cop_id	integer	optional	Valid contact_position cop_id

Retrieve

Example request:

curl "https://<base-url>/account-contacts/{account_contacts}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account_contacts"="21" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-contacts/{account_contacts}",
    "method": "GET",
    "data": {
        "account_contacts": 21
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-contacts/{account_contacts}

HEAD account-contacts/{account_contacts}

Parameters

Parameter	Type	Status	Description
account_contacts	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/account-contacts/{account_contacts}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account_contacts"="12" \
    -d "con_name"="17" \
    -d "con_telephone"="17" \
    -d "con_mobile"="17" \
    -d "con_email"="17" \
    -d "con_res"="85" \
    -d "con_primary"="TRUE" \
    -d "con_account_type"="On Premise" \
    -d "con_dob"="2025-07-10" \
    -d "con_editable"="true" \
    -d "act_id"="12" \
    -d "cop_id"="274" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-contacts/{account_contacts}",
    "method": "PUT",
    "data": {
        "account_contacts": 12,
        "con_name": 17,
        "con_telephone": 17,
        "con_mobile": 17,
        "con_email": 17,
        "con_res": 85,
        "con_primary": "TRUE",
        "con_account_type": "On Premise",
        "con_dob": "2025-07-10",
        "con_editable": "true",
        "act_id": 12,
        "cop_id": 274
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT account-contacts/{account_contacts}

PATCH account-contacts/{account_contacts}

Parameters

Parameter	Type	Status	Description
account_contacts	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
con_name	string	optional	Between: 1 and 50
con_telephone	string	optional	Between: 1 and 50
con_mobile	string	optional	Between: 1 and 50
con_email	email	optional	Between: 1 and 50
con_res	string	optional	Between: 1 and 255
con_primary	string	optional	TRUE or FALSE
con_account_type	string	optional	On Premise, Off Premise or Integrated
con_dob	date	optional	Date format: Y-m-d
con_editable	string	optional	true or false
act_id	string	optional	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
cop_id	integer	optional	Valid contact_position cop_id

Delete

Example request:

curl "https://<base-url>/account-contacts/{account_contacts}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-contacts/{account_contacts}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE account-contacts/{account_contacts}

Account-Deliveries

Retrieve multiple

Example request:

curl "https://<base-url>/account-deliveries" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1941294129" \
    -d "per_page"="904" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-deliveries",
    "method": "GET",
    "data": {
        "page": 1941294129,
        "per_page": 904,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-deliveries

HEAD account-deliveries

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/account-deliveries" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "act_id"="11" \
    -d "address_line_1"="74" \
    -d "address_line_2"="74" \
    -d "post_code"="2" \
    -d "suburb"="74" \
    -d "state"="quis" \
    -d "country"="74" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-deliveries",
    "method": "POST",
    "data": {
        "act_id": 11,
        "address_line_1": 74,
        "address_line_2": 74,
        "post_code": 2,
        "suburb": 74,
        "state": "quis",
        "country": 74
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST account-deliveries

Parameters

Parameter	Type	Status	Description
act_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
address_line_1	string	optional	Between: 1 and 255
address_line_2	string	optional	Between: 1 and 255
post_code	string	optional	Between: 1 and 5
suburb	string	optional	Between: 1 and 255
state	string	optional	Valid state sta_name
country	string	optional	Between: 1 and 255

Retrieve

Example request:

curl "https://<base-url>/account-deliveries/{account_deliveries}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account_deliveries"="0" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-deliveries/{account_deliveries}",
    "method": "GET",
    "data": {
        "account_deliveries": 0
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-deliveries/{account_deliveries}

HEAD account-deliveries/{account_deliveries}

Parameters

Parameter	Type	Status	Description
account_deliveries	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/account-deliveries/{account_deliveries}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account_deliveries"="654" \
    -d "act_id"="10" \
    -d "address_line_1"="71" \
    -d "address_line_2"="71" \
    -d "post_code"="2" \
    -d "suburb"="71" \
    -d "state"="ad" \
    -d "country"="71" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-deliveries/{account_deliveries}",
    "method": "PUT",
    "data": {
        "account_deliveries": 654,
        "act_id": 10,
        "address_line_1": 71,
        "address_line_2": 71,
        "post_code": 2,
        "suburb": 71,
        "state": "ad",
        "country": 71
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT account-deliveries/{account_deliveries}

PATCH account-deliveries/{account_deliveries}

Parameters

Parameter	Type	Status	Description
account_deliveries	numeric	required	Must have a length between 1 and 11
act_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
address_line_1	string	optional	Between: 1 and 255
address_line_2	string	optional	Between: 1 and 255
post_code	string	optional	Between: 1 and 5
suburb	string	optional	Between: 1 and 255
state	string	optional	Valid state sta_name
country	string	optional	Between: 1 and 255

Delete

Example request:

curl "https://<base-url>/account-deliveries/{account_deliveries}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-deliveries/{account_deliveries}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE account-deliveries/{account_deliveries}

Account-Objective-History

Retrieve multiple

Example request:

curl "https://<base-url>/account-objective-history" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="352367300" \
    -d "per_page"="164" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-objective-history",
    "method": "GET",
    "data": {
        "page": 352367300,
        "per_page": 164,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-objective-history

HEAD account-objective-history

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Delete

Example request:

curl "https://<base-url>/account-objective-history/{account_objective_history}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-objective-history/{account_objective_history}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE account-objective-history/{account_objective_history}

Account-Objectives

Retrieve multiple

Example request:

curl "https://<base-url>/account-objectives" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1742357754" \
    -d "per_page"="812" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-objectives",
    "method": "GET",
    "data": {
        "page": 1742357754,
        "per_page": 812,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-objectives

HEAD account-objectives

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/account-objectives" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "aob_name"="architecto" \
    -d "aob_date_completed"="2025:07:10" \
    -d "act_id"="3" \
    -d "cob_id"="4" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-objectives",
    "method": "POST",
    "data": {
        "aob_name": "architecto",
        "aob_date_completed": "2025:07:10",
        "act_id": 3,
        "cob_id": 4
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST account-objectives

Parameters

Parameter	Type	Status	Description
aob_name	string	required	Maximum: 255
aob_date_completed	date	optional	Date format: Y:m:d
act_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
cob_id	integer	optional	Valid company_objective cob_id

Retrieve

Example request:

curl "https://<base-url>/account-objectives/{account_objectives}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account_objectives"="3" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-objectives/{account_objectives}",
    "method": "GET",
    "data": {
        "account_objectives": 3
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-objectives/{account_objectives}

HEAD account-objectives/{account_objectives}

Parameters

Parameter	Type	Status	Description
account_objectives	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/account-objectives/{account_objectives}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account_objectives"="8" \
    -d "aob_name"="eius" \
    -d "aob_date_completed"="2025:07:10" \
    -d "act_id"="8" \
    -d "cob_id"="70" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-objectives/{account_objectives}",
    "method": "PUT",
    "data": {
        "account_objectives": 8,
        "aob_name": "eius",
        "aob_date_completed": "2025:07:10",
        "act_id": 8,
        "cob_id": 70
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT account-objectives/{account_objectives}

PATCH account-objectives/{account_objectives}

Parameters

Parameter	Type	Status	Description
account_objectives	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
aob_name	string	required	Maximum: 255
aob_date_completed	date	required	Date format: Y:m:d
act_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
cob_id	integer	required	Valid company_objective cob_id

Delete

Example request:

curl "https://<base-url>/account-objectives/{account_objectives}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-objectives/{account_objectives}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE account-objectives/{account_objectives}

Account-Territories

Delete

We will be deleting via account id's, if you provide account id, all of the terrirotories connected will be deleted

Example request:

curl "https://<base-url>/account-territories" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-territories",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE account-territories

Retrieve multiple

Example request:

curl "https://<base-url>/account-territories" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="259613010" \
    -d "per_page"="121" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-territories",
    "method": "GET",
    "data": {
        "page": 259613010,
        "per_page": 121,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-territories

HEAD account-territories

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve

Example request:

curl "https://<base-url>/account-territories/account/{account}/territory/{territory}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account"="8" \
    -d "territory"="55" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-territories/account/{account}/territory/{territory}",
    "method": "GET",
    "data": {
        "account": 8,
        "territory": 55
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-territories/account/{account}/territory/{territory}

HEAD account-territories/account/{account}/territory/{territory}

Parameters

Parameter	Type	Status	Description
account	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
territory	numeric	required	Must have a length between 1 and 11 Valid territory id

Retrieve by account

Example request:

curl "https://<base-url>/account-territories/account/{account}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account"="8" \
    -d "page"="466167782" \
    -d "per_page"="217" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-territories/account/{account}",
    "method": "GET",
    "data": {
        "account": 8,
        "page": 466167782,
        "per_page": 217,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-territories/account/{account}

HEAD account-territories/account/{account}

Parameters

Parameter	Type	Status	Description
account	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve by territory

Example request:

curl "https://<base-url>/account-territories/territory/{territory}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "territory"="3" \
    -d "page"="20214945" \
    -d "per_page"="9" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-territories/territory/{territory}",
    "method": "GET",
    "data": {
        "territory": 3,
        "page": 20214945,
        "per_page": 9,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-territories/territory/{territory}

HEAD account-territories/territory/{territory}

Parameters

Parameter	Type	Status	Description
territory	numeric	required	Must have a length between 1 and 11 Valid territory id
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Account-Wholesalers

Retrieve multiple

Example request:

curl "https://<base-url>/account-wholesalers" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1609947521" \
    -d "per_page"="750" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-wholesalers",
    "method": "GET",
    "data": {
        "page": 1609947521,
        "per_page": 750,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-wholesalers

HEAD account-wholesalers

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/account-wholesalers" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "act_id"="13" \
    -d "who_id"="5043" \
    -d "who_code"="7" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-wholesalers",
    "method": "POST",
    "data": {
        "act_id": 13,
        "who_id": 5043,
        "who_code": 7
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST account-wholesalers

Parameters

Parameter	Type	Status	Description
act_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
who_id	numeric	required	Must have a length between 1 and 11 Valid wholesaler who_id
who_code	string	optional	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 20

Retrieve

Example request:

curl "https://<base-url>/account-wholesalers/{account_wholesalers}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account_wholesalers"="34856012" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-wholesalers/{account_wholesalers}",
    "method": "GET",
    "data": {
        "account_wholesalers": 34856012
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET account-wholesalers/{account_wholesalers}

HEAD account-wholesalers/{account_wholesalers}

Parameters

Parameter	Type	Status	Description
account_wholesalers	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/account-wholesalers/{account_wholesalers}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account_wholesalers"="9" \
    -d "act_id"="1" \
    -d "who_id"="9" \
    -d "who_code"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-wholesalers/{account_wholesalers}",
    "method": "PUT",
    "data": {
        "account_wholesalers": 9,
        "act_id": 1,
        "who_id": 9,
        "who_code": 1
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT account-wholesalers/{account_wholesalers}

PATCH account-wholesalers/{account_wholesalers}

Parameters

Parameter	Type	Status	Description
account_wholesalers	numeric	required	Must have a length between 1 and 11
act_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
who_id	numeric	required	Must have a length between 1 and 11 Valid wholesaler who_id
who_code	string	optional	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 20

Delete

Example request:

curl "https://<base-url>/account-wholesalers/{account_wholesalers}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/account-wholesalers/{account_wholesalers}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE account-wholesalers/{account_wholesalers}

Accounts

Update multiple

Example request:

curl "https://<base-url>/accounts" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "upsert"="0" \
    -d "account[0][act_id]"="123" \
    -d "account[0][act_name]"="test account" \
    -d "account[0][act_serviced]"="TRUE" \
    -d "account[0][sta_name]"="NSW" \
    -d "account[0][usr_id]"="user_test_id" \
    -d "account[0][act_post_code]"="2565" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/accounts",
    "method": "PUT",
    "data": {
        "upsert": "0",
        "account[0][act_id]": "123",
        "account[0][act_name]": "test account",
        "account[0][act_serviced]": "TRUE",
        "account[0][sta_name]": "NSW",
        "account[0][usr_id]": "user_test_id",
        "account[0][act_post_code]": "2565"

},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT accounts

Parameters

Parameter	Type	Status	Description
upsert	string	required	1 or 0
account[*][act_id]	string	optional	Valid account act_id
account[*][act_name]	string	required	Maximum: 36
account[*][usr_id]	string	required	Valid user usr_id
account[*][act_serviced]	string	required	TRUE or FALSE
account[*][osg_id]	string	optional	Valid ownership_group osg_id
account[*][sta_name]	string	required	Valid state sta_name
account[*][act_address]	string	optional	Maximum: 255
account[*][act_suburb]	string	optional	Maximum: 255
account[*][act_post_code]	numeric	optional	Must have a length between 1 and 4
account[*][act_phone]	string	optional	Maximum: 255
account[*][act_email]	string	optional	Maximum: 100
account[*][who_id]	string	optional	Valid wholesaler who_id
account[*][who_id_2]	string	optional	Valid wholesaler who_id
account[*][ban_id]	string	optional	Valid banner ban_id
account[*][ban_id_2]	string	optional	Valid banner ban_id
account[*][act_wholesaler_no]	string	optional	Maximum: 20
account[*][act_wholesaler_no_2]	string	optional	Maximum: 20
account[*][act_account_balance]	numeric	optional
account[*][act_equipment_balance]	numeric	optional
account[*][act_keg_discount]	string	optional	Yes or No
account[*][act_pallet_rebate]	string	optional	Yes or No
account[*][act_credit_limit]	numeric	optional
account[*][gra_id]	string	optional	Valid grade gra_id
account[*][act_opening_hours]	string	optional	Maximum: 255
account[*][wholesaler]	array	optional
account[*][wholesaler][*][who_id]	numeric	required	Must have a length between 1 and 11 Valid wholesaler who_id
account[*][wholesaler][*][who_code]	string	optional	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 20
account[*][delivery]	array	optional
account[*][delivery][*][adl_id]	integer	optional	Valid account_delivery adl_id
account[*][delivery][*][address_line_1]	string	optional	Between: 1 and 255
account[*][delivery][*][address_line_2]	string	optional	Between: 1 and 255
account[*][delivery][*][post_code]	string	optional	Between: 1 and 5
account[*][delivery][*][suburb]	string	optional	Between: 1 and 255
account[*][delivery][*][state]	string	optional	Valid state sta_name
account[*][delivery][*][country]	string	optional	Between: 1 and 255

Delete

Example request:

curl "https://<base-url>/accounts-cascading-delete" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/accounts-cascading-delete",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE accounts-cascading-delete

Retrieve multiple

Example request:

curl "https://<base-url>/accounts" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="991352091" \
    -d "per_page"="462" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/accounts",
    "method": "GET",
    "data": {
        "page": 991352091,
        "per_page": 462,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "current_page": 1,
    "data": [
        {
            "id": 12345,
            "act_id": "b3e391c7-c814-4722-9872-7c46c9954210",
            "act_reference_id": "EG9475924",
            "act_name": "Example Account",
            "act_address": "19 Example Street",
            "act_address2": null,
            "act_serviced": "FALSE",
            "act_suburb": "INGLEBURN",
            "act_city": "SYDNEY",
            "act_country": "AUSTRALIA",
            "act_post_code": "2565",
            "act_phone": "85729604",
            "act_email": "example@example.com.au",
            "act_type": "Off Premise",
            "act_wholesaler_no": "1ABC111",
            "act_wholesaler_no_2": null,
            "act_account_balance": 0,
            "act_equipment_balance": null,
            "act_keg_discount": null,
            "act_pallet_rebate": null,
            "act_credit_balance": 0,
            "act_credit_limit": 1111,
            "act_credit_hold": "false",
            "act_opening_hours": null,
            "act_lln": null,
            "act_delivery_day": null,
            "act_simtac": "true",
            "act_latitude": null,
            "act_longitude": null,
            "act_additional_1": "Jane Doe",
            "act_additional_2": "example@example.com.au",
            "act_additional_3": "Notes Placed here",
            "act_additional_4": null,
            "act_display_state": null,
            "usr_id": "ebdd3ed1-becb-4c9e-ae21-fc275325c45f",
            "sta_name": "NSW",
            "ban_id": null,
            "ban_id_2": null,
            "osg_id": 1111,
            "who_id": 11111111,
            "who_id_2": null,
            "gra_id": null,
            "stage_id": null,
            "pct_id": null,
            "chn_id": 111,
            "cycle_id": null,
            "ots_id": 0,
            "act_TS": "20201-01-01 01:01:01",
            "website_address": null,
            "ack_email": null,
            "client_id": 1,
            "salesforce_id": null,
            "licensee": "REBATE",
            "delivery_comment": null,
            "warehouse_code": null,
            "licence_number": null,
            "pos_id": null,
            "account_status_id": 0,
            "act_created": "20201-01-01 01:01:01",
            "account_wholesalers": [
            ],
            "account_deliveries": [
            ]
        },
        {
            ..
        },
        {
            ..
        }
    ],
    "from": 1,
    "last_page": 18,
    "next_page_url": "https://api.rhinocrm.com.au/accounts?page=2",
    "path": "https://api.rhinocrm.com.au/accounts",
    "per_page": 50,
    "prev_page_url": null,
    "to": 50,
    "total": 1000
}

HTTP Request

GET accounts

HEAD accounts

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/accounts" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "act_reference_id"="minus" \
    -d "act_name"="minus" \
    -d "usr_id"="minus" \
    -d "act_serviced"="FALSE" \
    -d "act_type"="Integrated" \
    -d "osg_id"="minus" \
    -d "sta_name"="minus" \
    -d "act_address"="minus" \
    -d "act_suburb"="minus" \
    -d "act_city"="minus" \
    -d "act_country"="minus" \
    -d "act_post_code"="minus" \
    -d "act_phone"="minus" \
    -d "act_email"="minus" \
    -d "who_id"="minus" \
    -d "who_id_2"="minus" \
    -d "ban_id"="minus" \
    -d "ban_id_2"="minus" \
    -d "act_wholesaler_no"="minus" \
    -d "act_wholesaler_no_2"="minus" \
    -d "act_account_balance"="9042228" \
    -d "act_credit_balance"="9042228" \
    -d "act_equipment_balance"="9042228" \
    -d "act_keg_discount"="No" \
    -d "act_pallet_rebate"="No" \
    -d "act_credit_limit"="9042228" \
    -d "act_additional_1"="minus" \
    -d "act_additional_2"="minus" \
    -d "act_additional_3"="minus" \
    -d "act_additional_4"="minus" \
    -d "gra_id"="minus" \
    -d "cycle_id"="minus" \
    -d "act_opening_hours"="minus" \
    -d "wholesaler"="minus" \
    -d "delivery"="minus" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/accounts",
    "method": "POST",
    "data": {
        "act_reference_id": "minus",
        "act_name": "minus",
        "usr_id": "minus",
        "act_serviced": "FALSE",
        "act_type": "Integrated",
        "osg_id": "minus",
        "sta_name": "minus",
        "act_address": "minus",
        "act_suburb": "minus",
        "act_city": "minus",
        "act_country": "minus",
        "act_post_code": "minus",
        "act_phone": "minus",
        "act_email": "minus",
        "who_id": "minus",
        "who_id_2": "minus",
        "ban_id": "minus",
        "ban_id_2": "minus",
        "act_wholesaler_no": "minus",
        "act_wholesaler_no_2": "minus",
        "act_account_balance": 9042228,
        "act_credit_balance": 9042228,
        "act_equipment_balance": 9042228,
        "act_keg_discount": "No",
        "act_pallet_rebate": "No",
        "act_credit_limit": 9042228,
        "act_additional_1": "minus",
        "act_additional_2": "minus",
        "act_additional_3": "minus",
        "act_additional_4": "minus",
        "gra_id": "minus",
        "cycle_id": "minus",
        "act_opening_hours": "minus",
        "wholesaler": "minus",
        "delivery": "minus"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST accounts

Parameters

Parameter	Type	Status	Description
act_reference_id	string	optional	Maximum: 36
act_name	string	required	Maximum: 255
usr_id	string	required	Valid user usr_id
act_serviced	string	required	TRUE or FALSE
act_type	string	optional	On Premise, Off Premise or Integrated
osg_id	string	optional	Valid ownership_group osg_id
sta_name	string	required	Valid state sta_name
act_address	string	optional	Maximum: 255
act_suburb	string	optional	Maximum: 255
act_city	string	optional	Maximum: 255
act_country	string	optional	Maximum: 255
act_post_code	string	optional	Maximum: 10
act_phone	string	optional	Maximum: 255
act_email	string	optional	Maximum: 100
who_id	string	optional	Valid wholesaler who_id
who_id_2	string	optional	Valid wholesaler who_id
ban_id	string	optional	Valid banner ban_id
ban_id_2	string	optional	Valid banner ban_id
act_wholesaler_no	string	optional	Maximum: 20
act_wholesaler_no_2	string	optional	Maximum: 20
act_account_balance	numeric	optional
act_credit_balance	numeric	optional
act_equipment_balance	numeric	optional
act_keg_discount	string	optional	Yes or No
act_pallet_rebate	string	optional	Yes or No
act_credit_limit	numeric	optional
act_additional_1	string	optional	Maximum: 255
act_additional_2	string	optional	Maximum: 255
act_additional_3	string	optional	Maximum: 255
act_additional_4	string	optional	Maximum: 255
gra_id	string	optional	Valid grade gra_id
cycle_id	string	optional	Valid cycle id
act_opening_hours	string	optional	Maximum: 255
wholesaler[*][who_id]	numeric	required	Must have a length between 1 and 11 Valid wholesaler who_id
wholesaler[*][who_code]	string	optional	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 20
delivery[*][adl_id]	integer	required	Valid account_delivery adl_id
delivery[*][address_line_1]	string	optional	Between: 1 and 255
delivery[*][address_line_2]	string	optional	Between: 1 and 255
delivery[*][post_code]	string	optional	Between: 1 and 5
delivery[*][suburb]	string	optional	Between: 1 and 255
delivery[*][state]	string	optional	Valid state sta_name
delivery[*][country]	string	optional	Between: 1 and 255

Retrieve

Example request:

curl "https://<base-url>/accounts/{accounts}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "accounts"="9" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/accounts/{accounts}",
    "method": "GET",
    "data": {
        "accounts": 9
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "id": 12345,
    "act_id": "b3e391c7-c814-4722-9872-7c46c9954210",
    "act_reference_id": "EG9475924",
    "act_name": "Example Account",
    "act_address": "19 Example Street",
    "act_address2": null,
    "act_serviced": "FALSE",
    "act_suburb": "INGLEBURN",
    "act_city": "SYDNEY",
    "act_country": "AUSTRALIA",
    "act_post_code": "2565",
    "act_phone": "85729604",
    "act_email": "example@example.com.au",
    "act_type": "Off Premise",
    "act_wholesaler_no": "1ABC111",
    "act_wholesaler_no_2": null,
    "act_account_balance": 0,
    "act_equipment_balance": null,
    "act_keg_discount": null,
    "act_pallet_rebate": null,
    "act_credit_balance": 0,
    "act_credit_limit": 1111,
    "act_credit_hold": "false",
    "act_opening_hours": null,
    "act_lln": null,
    "act_delivery_day": null,
    "act_simtac": "true",
    "act_latitude": null,
    "act_longitude": null,
    "act_additional_1": "Jane Doe",
    "act_additional_2": "example@example.com.au",
    "act_additional_3": "Notes Placed here",
    "act_additional_4": null,
    "act_display_state": null,
    "usr_id": "ebdd3ed1-becb-4c9e-ae21-fc275325c45f",
    "sta_name": "NSW",
    "ban_id": null,
    "ban_id_2": null,
    "osg_id": 1111,
    "who_id": 11111111,
    "who_id_2": null,
    "gra_id": null,
    "stage_id": null,
    "pct_id": null,
    "chn_id": 111,
    "cycle_id": null,
    "ots_id": 0,
    "act_TS": "20201-01-01 01:01:01",
    "website_address": null,
    "ack_email": null,
    "client_id": 1,
    "salesforce_id": null,
    "licensee": "REBATE",
    "delivery_comment": null,
    "warehouse_code": null,
    "licence_number": null,
    "pos_id": null,
    "account_status_id": 0,
    "act_created": "20201-01-01 01:01:01",
    "account_wholesalers": [
    ],
    "account_deliveries": [
    ]
}

HTTP Request

GET accounts/{accounts}

HEAD accounts/{accounts}

Parameters

Parameter	Type	Status	Description
accounts	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/accounts/{accounts}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "accounts"="35" \
    -d "act_reference_id"="tenetur" \
    -d "act_name"="tenetur" \
    -d "usr_id"="tenetur" \
    -d "act_serviced"="FALSE" \
    -d "act_type"="Integrated" \
    -d "osg_id"="tenetur" \
    -d "sta_name"="tenetur" \
    -d "act_address"="tenetur" \
    -d "act_suburb"="tenetur" \
    -d "act_city"="tenetur" \
    -d "act_country"="tenetur" \
    -d "act_post_code"="tenetur" \
    -d "act_phone"="tenetur" \
    -d "act_email"="tenetur" \
    -d "who_id"="tenetur" \
    -d "who_id_2"="tenetur" \
    -d "ban_id"="tenetur" \
    -d "ban_id_2"="tenetur" \
    -d "act_wholesaler_no"="tenetur" \
    -d "act_wholesaler_no_2"="tenetur" \
    -d "act_account_balance"="439173062" \
    -d "act_credit_balance"="439173062" \
    -d "act_equipment_balance"="439173062" \
    -d "act_keg_discount"="No" \
    -d "act_pallet_rebate"="No" \
    -d "act_credit_limit"="439173062" \
    -d "act_additional_1"="tenetur" \
    -d "act_additional_2"="tenetur" \
    -d "act_additional_3"="tenetur" \
    -d "act_additional_4"="tenetur" \
    -d "gra_id"="tenetur" \
    -d "cycle_id"="tenetur" \
    -d "act_opening_hours"="tenetur" \
    -d "wholesaler"="tenetur" \
    -d "delivery"="tenetur" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/accounts/{accounts}",
    "method": "PUT",
    "data": {
        "accounts": 35,
        "act_reference_id": "tenetur",
        "act_name": "tenetur",
        "usr_id": "tenetur",
        "act_serviced": "FALSE",
        "act_type": "Integrated",
        "osg_id": "tenetur",
        "sta_name": "tenetur",
        "act_address": "tenetur",
        "act_suburb": "tenetur",
        "act_city": "tenetur",
        "act_country": "tenetur",
        "act_post_code": "tenetur",
        "act_phone": "tenetur",
        "act_email": "tenetur",
        "who_id": "tenetur",
        "who_id_2": "tenetur",
        "ban_id": "tenetur",
        "ban_id_2": "tenetur",
        "act_wholesaler_no": "tenetur",
        "act_wholesaler_no_2": "tenetur",
        "act_account_balance": 439173062,
        "act_credit_balance": 439173062,
        "act_equipment_balance": 439173062,
        "act_keg_discount": "No",
        "act_pallet_rebate": "No",
        "act_credit_limit": 439173062,
        "act_additional_1": "tenetur",
        "act_additional_2": "tenetur",
        "act_additional_3": "tenetur",
        "act_additional_4": "tenetur",
        "gra_id": "tenetur",
        "cycle_id": "tenetur",
        "act_opening_hours": "tenetur",
        "wholesaler": "tenetur",
        "delivery": "tenetur"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT accounts/{accounts}

PATCH accounts/{accounts}

Parameters

Parameter	Type	Status	Description
accounts	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
act_reference_id	string	optional	Maximum: 36
act_name	string	required	Maximum: 255
usr_id	string	required	Valid user usr_id
act_serviced	string	required	TRUE or FALSE
act_type	string	optional	On Premise, Off Premise or Integrated
osg_id	string	optional	Valid ownership_group osg_id
sta_name	string	required	Valid state sta_name
act_address	string	optional	Maximum: 255
act_suburb	string	optional	Maximum: 255
act_city	string	optional	Maximum: 255
act_country	string	optional	Maximum: 255
act_post_code	string	optional	Maximum: 10
act_phone	string	optional	Maximum: 255
act_email	string	optional	Maximum: 100
who_id	string	optional	Valid wholesaler who_id
who_id_2	string	optional	Valid wholesaler who_id
ban_id	string	optional	Valid banner ban_id
ban_id_2	string	optional	Valid banner ban_id
act_wholesaler_no	string	optional	Maximum: 20
act_wholesaler_no_2	string	optional	Maximum: 20
act_account_balance	numeric	optional
act_credit_balance	numeric	optional
act_equipment_balance	numeric	optional
act_keg_discount	string	optional	Yes or No
act_pallet_rebate	string	optional	Yes or No
act_credit_limit	numeric	optional
act_additional_1	string	optional	Maximum: 255
act_additional_2	string	optional	Maximum: 255
act_additional_3	string	optional	Maximum: 255
act_additional_4	string	optional	Maximum: 255
gra_id	string	optional	Valid grade gra_id
cycle_id	string	optional	Valid cycle id
act_opening_hours	string	optional	Maximum: 255
wholesaler[*][who_id]	numeric	required	Must have a length between 1 and 11 Valid wholesaler who_id
wholesaler[*][who_code]	string	optional	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 20
delivery[*][adl_id]	integer	required	Valid account_delivery adl_id
delivery[*][address_line_1]	string	optional	Between: 1 and 255
delivery[*][address_line_2]	string	optional	Between: 1 and 255
delivery[*][post_code]	string	optional	Between: 1 and 5
delivery[*][suburb]	string	optional	Between: 1 and 255
delivery[*][state]	string	optional	Valid state sta_name
delivery[*][country]	string	optional	Between: 1 and 255

Delete

Example request:

curl "https://<base-url>/accounts/{accounts}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/accounts/{accounts}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE accounts/{accounts}

Admin-Module-Groups

Retrieve multiple

Example request:

curl "https://<base-url>/admin-module-groups" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="48780629" \
    -d "per_page"="22" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/admin-module-groups",
    "method": "GET",
    "data": {
        "page": 48780629,
        "per_page": 22,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET admin-module-groups

HEAD admin-module-groups

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/admin-module-groups" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "admin_module_id"="629" \
    -d "module_group_id"="629" \
    -d "active"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/admin-module-groups",
    "method": "POST",
    "data": {
        "admin_module_id": 629,
        "module_group_id": 629,
        "active": "1"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST admin-module-groups

Parameters

Parameter	Type	Status	Description
admin_module_id	integer	required	Valid admin_module id
module_group_id	integer	required	Valid module_group id
active	integer	required	1 or 0

Retrieve

Example request:

curl "https://<base-url>/admin-module-groups/{admin_module_groups}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "admin_module_groups"="8" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/admin-module-groups/{admin_module_groups}",
    "method": "GET",
    "data": {
        "admin_module_groups": 8
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET admin-module-groups/{admin_module_groups}

HEAD admin-module-groups/{admin_module_groups}

Parameters

Parameter	Type	Status	Description
admin_module_groups	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/admin-module-groups/{admin_module_groups}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "admin_module_groups"="497" \
    -d "admin_module_id"="497" \
    -d "module_group_id"="497" \
    -d "active"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/admin-module-groups/{admin_module_groups}",
    "method": "PUT",
    "data": {
        "admin_module_groups": 497,
        "admin_module_id": 497,
        "module_group_id": 497,
        "active": "1"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT admin-module-groups/{admin_module_groups}

PATCH admin-module-groups/{admin_module_groups}

Parameters

Parameter	Type	Status	Description
admin_module_groups	numeric	required	Must have a length between 1 and 11
admin_module_id	integer	required	Valid admin_module id
module_group_id	integer	required	Valid module_group id
active	integer	required	1 or 0

Admin-Modules

Retrieve multiple

Example request:

curl "https://<base-url>/admin-modules" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1079259247" \
    -d "per_page"="503" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/admin-modules",
    "method": "GET",
    "data": {
        "page": 1079259247,
        "per_page": 503,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET admin-modules

HEAD admin-modules

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve

Example request:

curl "https://<base-url>/admin-modules/{admin_modules}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "admin_modules"="5764" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/admin-modules/{admin_modules}",
    "method": "GET",
    "data": {
        "admin_modules": 5764
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET admin-modules/{admin_modules}

HEAD admin-modules/{admin_modules}

Parameters

Parameter	Type	Status	Description
admin_modules	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/admin-modules/{admin_modules}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "admin_modules"="3466229" \
    -d "active"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/admin-modules/{admin_modules}",
    "method": "PUT",
    "data": {
        "admin_modules": 3466229,
        "active": "1"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT admin-modules/{admin_modules}

PATCH admin-modules/{admin_modules}

Parameters

Parameter	Type	Status	Description
admin_modules	numeric	required	Must have a length between 1 and 11
active	integer	required	0 or 1

Answers

Retrieve multiple

Example request:

curl "https://<base-url>/answers" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1642667218" \
    -d "per_page"="765" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/answers",
    "method": "GET",
    "data": {
        "page": 1642667218,
        "per_page": 765,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET answers

HEAD answers

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/answers" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "answer"="quis" \
    -d "question_id"="23" \
    -d "user_id"="quis" \
    -d "account_id"="11" \
    -d "call_id"="quis" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/answers",
    "method": "POST",
    "data": {
        "answer": "quis",
        "question_id": 23,
        "user_id": "quis",
        "account_id": 11,
        "call_id": "quis"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST answers

Parameters

Parameter	Type	Status	Description
answer	string	required	Maximum: 255
question_id	integer	required	Valid question id
user_id	string	required	Valid user usr_id
account_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
call_id	string	required	Valid jpcall cal_id

Retrieve

Example request:

curl "https://<base-url>/answers/{answers}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "answers"="29" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/answers/{answers}",
    "method": "GET",
    "data": {
        "answers": 29
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET answers/{answers}

HEAD answers/{answers}

Parameters

Parameter	Type	Status	Description
answers	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/answers/{answers}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "answers"="31" \
    -d "answer"="pariatur" \
    -d "question_id"="27844872" \
    -d "user_id"="pariatur" \
    -d "account_id"="31" \
    -d "call_id"="pariatur" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/answers/{answers}",
    "method": "PUT",
    "data": {
        "answers": 31,
        "answer": "pariatur",
        "question_id": 27844872,
        "user_id": "pariatur",
        "account_id": 31,
        "call_id": "pariatur"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT answers/{answers}

PATCH answers/{answers}

Parameters

Parameter	Type	Status	Description
answers	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
answer	string	required	Maximum: 255
question_id	integer	required	Valid question id
user_id	string	required	Valid user usr_id
account_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
call_id	string	required	Valid jpcall cal_id

Delete

Example request:

curl "https://<base-url>/answers/{answers}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/answers/{answers}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE answers/{answers}

Areas

Retrieve multiple

Example request:

curl "https://<base-url>/areas" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="7632615" \
    -d "per_page"="3" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/areas",
    "method": "GET",
    "data": {
        "page": 7632615,
        "per_page": 3,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET areas

HEAD areas

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/areas" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "are_name"="doloribus" \
    -d "are_short_name"="doloribus" \
    -d "are_order"="225934496" \
    -d "sac_id"="225934496" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/areas",
    "method": "POST",
    "data": {
        "are_name": "doloribus",
        "are_short_name": "doloribus",
        "are_order": 225934496,
        "sac_id": 225934496
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST areas

Parameters

Parameter	Type	Status	Description
are_name	string	required	Maximum: 255
are_short_name	string	required	Maximum: 100
are_order	integer	required
sac_id	integer	required	Valid selling_area_category sac_id

Retrieve

Example request:

curl "https://<base-url>/areas/{areas}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "areas"="44" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/areas/{areas}",
    "method": "GET",
    "data": {
        "areas": 44
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET areas/{areas}

HEAD areas/{areas}

Parameters

Parameter	Type	Status	Description
areas	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/areas/{areas}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "areas"="78" \
    -d "are_name"="eos" \
    -d "are_short_name"="eos" \
    -d "are_order"="78" \
    -d "sac_id"="78" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/areas/{areas}",
    "method": "PUT",
    "data": {
        "areas": 78,
        "are_name": "eos",
        "are_short_name": "eos",
        "are_order": 78,
        "sac_id": 78
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT areas/{areas}

PATCH areas/{areas}

Parameters

Parameter	Type	Status	Description
areas	numeric	required	Must have a length between 1 and 11
are_name	string	optional	Maximum: 255
are_short_name	string	optional	Maximum: 100
are_order	integer	optional
sac_id	integer	optional	Valid selling_area_category sac_id

Delete

Example request:

curl "https://<base-url>/areas/{areas}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/areas/{areas}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE areas/{areas}

Asset-Register-Types

Retrieve multiple

Example request:

curl "https://<base-url>/asset-register-types" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1956672795" \
    -d "per_page"="912" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-register-types",
    "method": "GET",
    "data": {
        "page": 1956672795,
        "per_page": 912,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET asset-register-types

HEAD asset-register-types

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/asset-register-types" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "art_name"="neque" \
    -d "art_active"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-register-types",
    "method": "POST",
    "data": {
        "art_name": "neque",
        "art_active": "1"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST asset-register-types

Parameters

Parameter	Type	Status	Description
art_name	string	required	Maximum: 255
art_active	integer	required	1 or 0

Retrieve

Example request:

curl "https://<base-url>/asset-register-types/{asset_register_types}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "asset_register_types"="45513" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-register-types/{asset_register_types}",
    "method": "GET",
    "data": {
        "asset_register_types": 45513
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET asset-register-types/{asset_register_types}

HEAD asset-register-types/{asset_register_types}

Parameters

Parameter	Type	Status	Description
asset_register_types	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/asset-register-types/{asset_register_types}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "art_name"="modi" \
    -d "art_active"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-register-types/{asset_register_types}",
    "method": "PUT",
    "data": {
        "art_name": "modi",
        "art_active": "1"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT asset-register-types/{asset_register_types}

PATCH asset-register-types/{asset_register_types}

Parameters

Parameter	Type	Status	Description
art_name	string	optional	Maximum: 255
art_active	integer	optional	1 or 0

Delete

Example request:

curl "https://<base-url>/asset-register-types/{asset_register_types}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-register-types/{asset_register_types}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE asset-register-types/{asset_register_types}

Asset-Register-Types-Selections

Retrieve multiple

Example request:

curl "https://<base-url>/asset-register-type-selections" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1790697174" \
    -d "per_page"="834" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-register-type-selections",
    "method": "GET",
    "data": {
        "page": 1790697174,
        "per_page": 834,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET asset-register-type-selections

HEAD asset-register-type-selections

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/asset-register-type-selections" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "asg_id"="31" \
    -d "art_id"="27305177" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-register-type-selections",
    "method": "POST",
    "data": {
        "asg_id": 31,
        "art_id": 27305177
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST asset-register-type-selections

Parameters

Parameter	Type	Status	Description
asg_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid asset_register asg_id
art_id	numeric	required	Must have a length between 1 and 11 Valid asset_register_type art_id

Retrieve

Example request:

curl "https://<base-url>/asset-register-type-selections/asset-register/{asset}/type/{type}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "asset"="5" \
    -d "type"="51" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-register-type-selections/asset-register/{asset}/type/{type}",
    "method": "GET",
    "data": {
        "asset": 5,
        "type": 51
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET asset-register-type-selections/asset-register/{asset}/type/{type}

HEAD asset-register-type-selections/asset-register/{asset}/type/{type}

Parameters

Parameter	Type	Status	Description
asset	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid asset_register asg_id
type	numeric	required	Must have a length between 1 and 11 Valid asset_register_type art_id

Retrieve by asset

Example request:

curl "https://<base-url>/asset-register-type-selections/asset-register/{asset}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "asset"="4" \
    -d "page"="205604264" \
    -d "per_page"="95" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-register-type-selections/asset-register/{asset}",
    "method": "GET",
    "data": {
        "asset": 4,
        "page": 205604264,
        "per_page": 95,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET asset-register-type-selections/asset-register/{asset}

HEAD asset-register-type-selections/asset-register/{asset}

Parameters

Parameter	Type	Status	Description
asset	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid asset_register asg_id
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve by type

Example request:

curl "https://<base-url>/asset-register-type-selections/type/{type}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "type"="6455148" \
    -d "page"="670137193" \
    -d "per_page"="732" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-register-type-selections/type/{type}",
    "method": "GET",
    "data": {
        "type": 6455148,
        "page": 670137193,
        "per_page": 732,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET asset-register-type-selections/type/{type}

HEAD asset-register-type-selections/type/{type}

Parameters

Parameter	Type	Status	Description
type	numeric	required	Must have a length between 1 and 11 Valid asset_register_type art_id
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Update

Example request:

curl "https://<base-url>/asset-register-type-selections/asset-register/{asset}/type/{type}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "asset"="9" \
    -d "type"="863" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-register-type-selections/asset-register/{asset}/type/{type}",
    "method": "PUT",
    "data": {
        "asset": 9,
        "type": 863
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT asset-register-type-selections/asset-register/{asset}/type/{type}

Parameters

Parameter	Type	Status	Description
asset	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid asset_register asg_id
type	numeric	required	Must have a length between 1 and 11 Valid asset_register_type art_id

Delete

Example request:

curl "https://<base-url>/asset-register-type-selections/asset-register/{asset}/type/{type}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-register-type-selections/asset-register/{asset}/type/{type}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE asset-register-type-selections/asset-register/{asset}/type/{type}

Asset-Registers

Retrieve multiple

Example request:

curl "https://<base-url>/asset-registers" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1691449740" \
    -d "per_page"="788" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-registers",
    "method": "GET",
    "data": {
        "page": 1691449740,
        "per_page": 788,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET asset-registers

HEAD asset-registers

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/asset-registers" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "asg_status"="Inactive" \
    -d "asg_date"="maxime" \
    -d "act_id"="maxime" \
    -d "pro_id"="4233595" \
    -d "bnd_id"="4233595" \
    -d "asg_opening_hours"="maxime" \
    -d "asg_address"="maxime" \
    -d "con_id"="maxime" \
    -d "asg_phone"="maxime" \
    -d "asg_email"="maxime" \
    -d "asg_delivery"="Pick Up" \
    -d "usr_id"="maxime" \
    -d "asg_notes"="maxime" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-registers",
    "method": "POST",
    "data": {
        "asg_status": "Inactive",
        "asg_date": "maxime",
        "act_id": "maxime",
        "pro_id": 4233595,
        "bnd_id": 4233595,
        "asg_opening_hours": "maxime",
        "asg_address": "maxime",
        "con_id": "maxime",
        "asg_phone": "maxime",
        "asg_email": "maxime",
        "asg_delivery": "Pick Up",
        "usr_id": "maxime",
        "asg_notes": "maxime"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST asset-registers

Parameters

Parameter	Type	Status	Description
asg_status	string	required	Active or Inactive
asg_date	string	required	Maximum: 10
act_id	string	required	Valid account act_id
pro_id	integer	required	Valid product pro_id
bnd_id	integer	required	Valid brand bnd_id
asg_opening_hours	string	required	Maximum: 255
asg_address	string	required	Maximum: 255
con_id	string	required	Valid contact con_id
asg_phone	string	required	Maximum: 255
asg_email	string	optional	Maximum: 255
asg_delivery	string	required	Drop Off or Pick Up
usr_id	string	required	Valid user usr_id
asg_notes	string	required

Retrieve

Example request:

curl "https://<base-url>/asset-registers/{asset_registers}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "asset_registers"="19" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-registers/{asset_registers}",
    "method": "GET",
    "data": {
        "asset_registers": 19
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET asset-registers/{asset_registers}

HEAD asset-registers/{asset_registers}

Parameters

Parameter	Type	Status	Description
asset_registers	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/asset-registers/{asset_registers}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "asg_status"="Active" \
    -d "asg_date"="dolorem" \
    -d "act_id"="dolorem" \
    -d "pro_id"="13" \
    -d "bnd_id"="13" \
    -d "asg_opening_hours"="dolorem" \
    -d "asg_address"="dolorem" \
    -d "con_id"="dolorem" \
    -d "asg_phone"="dolorem" \
    -d "asg_email"="dolorem" \
    -d "asg_delivery"="Drop Off" \
    -d "usr_id"="dolorem" \
    -d "asg_notes"="dolorem" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-registers/{asset_registers}",
    "method": "PUT",
    "data": {
        "asg_status": "Active",
        "asg_date": "dolorem",
        "act_id": "dolorem",
        "pro_id": 13,
        "bnd_id": 13,
        "asg_opening_hours": "dolorem",
        "asg_address": "dolorem",
        "con_id": "dolorem",
        "asg_phone": "dolorem",
        "asg_email": "dolorem",
        "asg_delivery": "Drop Off",
        "usr_id": "dolorem",
        "asg_notes": "dolorem"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT asset-registers/{asset_registers}

PATCH asset-registers/{asset_registers}

Parameters

Parameter	Type	Status	Description
asg_status	string	optional	Active or Inactive
asg_date	string	optional	Maximum: 10
act_id	string	optional	Valid account act_id
pro_id	integer	optional	Valid product pro_id
bnd_id	integer	optional	Valid brand bnd_id
asg_opening_hours	string	optional	Maximum: 255
asg_address	string	optional	Maximum: 255
con_id	string	optional	Valid contact con_id
asg_phone	string	optional	Maximum: 255
asg_email	string	optional	Maximum: 255
asg_delivery	string	optional	Drop Off or Pick Up
usr_id	string	optional	Valid user usr_id
asg_notes	string	optional

Delete

Example request:

curl "https://<base-url>/asset-registers/{asset_registers}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-registers/{asset_registers}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE asset-registers/{asset_registers}

Asset-Types

Retrieve multiple

Example request:

curl "https://<base-url>/asset-types" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="989957007" \
    -d "per_page"="461" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-types",
    "method": "GET",
    "data": {
        "page": 989957007,
        "per_page": 461,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET asset-types

HEAD asset-types

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve

Example request:

curl "https://<base-url>/asset-types/{asset_types}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "asset_types"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/asset-types/{asset_types}",
    "method": "GET",
    "data": {
        "asset_types": 1
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET asset-types/{asset_types}

HEAD asset-types/{asset_types}

Parameters

Parameter	Type	Status	Description
asset_types	numeric	required	Must have a length between 1 and 11

Assets

Retrieve multiple

Example request:

curl "https://<base-url>/assets" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="284303160" \
    -d "per_page"="132" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/assets",
    "method": "GET",
    "data": {
        "page": 284303160,
        "per_page": 132,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET assets

HEAD assets

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/assets" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "ass_name"="ut" \
    -d "ass_volume"="60769" \
    -d "ass_investment"="60769" \
    -d "ass_start_date"="2025:07:10" \
    -d "ass_end_date"="2025:07:10" \
    -d "ass_note"="ut" \
    -d "ass_achieved"="TRUE" \
    -d "ass_achieved_date"="2025:07:10" \
    -d "pro_id"="60769" \
    -d "act_id"="ut" \
    -d "osg_id"="ut" \
    -d "who_id"="ut" \
    -d "bnd_id"="60769" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/assets",
    "method": "POST",
    "data": {
        "ass_name": "ut",
        "ass_volume": 60769,
        "ass_investment": 60769,
        "ass_start_date": "2025:07:10",
        "ass_end_date": "2025:07:10",
        "ass_note": "ut",
        "ass_achieved": "TRUE",
        "ass_achieved_date": "2025:07:10",
        "pro_id": 60769,
        "act_id": "ut",
        "osg_id": "ut",
        "who_id": "ut",
        "bnd_id": 60769
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST assets

Parameters

Parameter	Type	Status	Description
ass_name	string	required	Maximum: 255 Valid asset_type name
ass_volume	numeric	optional
ass_investment	numeric	optional
ass_start_date	date	required	Date format: Y:m:d
ass_end_date	date	required	Date format: Y:m:d
ass_note	string	optional
ass_achieved	string	optional	FALSE or TRUE
ass_achieved_date	date	optional	Date format: Y:m:d
pro_id	integer	optional	Valid product pro_id
act_id	string	optional	Valid account act_id
osg_id	string	optional	Valid ownership_group osg_id
who_id	string	optional	Valid wholesaler who_id
bnd_id	integer	optional	Valid brand bnd_id

Retrieve

Example request:

curl "https://<base-url>/assets/{assets}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "assets"="17" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/assets/{assets}",
    "method": "GET",
    "data": {
        "assets": 17
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET assets/{assets}

HEAD assets/{assets}

Parameters

Parameter	Type	Status	Description
assets	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/assets/{assets}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "ass_name"="esse" \
    -d "ass_volume"="6921" \
    -d "ass_investment"="6921" \
    -d "ass_start_date"="2025:07:10" \
    -d "ass_end_date"="2025:07:10" \
    -d "ass_note"="esse" \
    -d "ass_achieved"="FALSE" \
    -d "ass_achieved_date"="2025:07:10" \
    -d "pro_id"="6921" \
    -d "act_id"="esse" \
    -d "osg_id"="esse" \
    -d "who_id"="esse" \
    -d "bnd_id"="6921" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/assets/{assets}",
    "method": "PUT",
    "data": {
        "ass_name": "esse",
        "ass_volume": 6921,
        "ass_investment": 6921,
        "ass_start_date": "2025:07:10",
        "ass_end_date": "2025:07:10",
        "ass_note": "esse",
        "ass_achieved": "FALSE",
        "ass_achieved_date": "2025:07:10",
        "pro_id": 6921,
        "act_id": "esse",
        "osg_id": "esse",
        "who_id": "esse",
        "bnd_id": 6921
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT assets/{assets}

PATCH assets/{assets}

Parameters

Parameter	Type	Status	Description
ass_name	string	optional	Maximum: 255 Valid asset_type name
ass_volume	numeric	optional
ass_investment	numeric	optional
ass_start_date	date	required	Date format: Y:m:d
ass_end_date	date	required	Date format: Y:m:d
ass_note	string	optional
ass_achieved	string	optional	FALSE or TRUE
ass_achieved_date	date	optional	Date format: Y:m:d
pro_id	integer	optional	Valid product pro_id
act_id	string	optional	Valid account act_id
osg_id	string	optional	Valid ownership_group osg_id
who_id	string	optional	Valid wholesaler who_id
bnd_id	integer	optional	Valid brand bnd_id

Delete

Example request:

curl "https://<base-url>/assets/{assets}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/assets/{assets}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE assets/{assets}

Banner-States

Retrieve multiple

Example request:

curl "https://<base-url>/banner-states" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="932194558" \
    -d "per_page"="434" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/banner-states",
    "method": "GET",
    "data": {
        "page": 932194558,
        "per_page": 434,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET banner-states

HEAD banner-states

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/banner-states" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "ban_id"="6054" \
    -d "sta_name"="molestiae" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/banner-states",
    "method": "POST",
    "data": {
        "ban_id": 6054,
        "sta_name": "molestiae"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST banner-states

Parameters

Parameter	Type	Status	Description
ban_id	numeric	required	Must have a length between 1 and 11 Valid banner ban_id
sta_name	string	required	Valid state sta_name

Retrieve

Example request:

curl "https://<base-url>/banner-states/banner/{banner}/state/{state}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "banner"="934793" \
    -d "state"="id" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/banner-states/banner/{banner}/state/{state}",
    "method": "GET",
    "data": {
        "banner": 934793,
        "state": "id"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET banner-states/banner/{banner}/state/{state}

HEAD banner-states/banner/{banner}/state/{state}

Parameters

Parameter	Type	Status	Description
banner	numeric	required	Must have a length between 1 and 11 Valid banner ban_id
state	string	required	Valid state sta_name

Retrieve by banner

Example request:

curl "https://<base-url>/banner-states/banner/{banner}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "banner"="40006" \
    -d "page"="956277976" \
    -d "per_page"="445" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/banner-states/banner/{banner}",
    "method": "GET",
    "data": {
        "banner": 40006,
        "page": 956277976,
        "per_page": 445,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET banner-states/banner/{banner}

HEAD banner-states/banner/{banner}

Parameters

Parameter	Type	Status	Description
banner	numeric	required	Must have a length between 1 and 11 Valid banner ban_id
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve by state

Example request:

curl "https://<base-url>/banner-states/state/{state}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "state"="quos" \
    -d "page"="1058518079" \
    -d "per_page"="493" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/banner-states/state/{state}",
    "method": "GET",
    "data": {
        "state": "quos",
        "page": 1058518079,
        "per_page": 493,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET banner-states/state/{state}

HEAD banner-states/state/{state}

Parameters

Parameter	Type	Status	Description
state	string	required	Valid state sta_name
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Update

Example request:

curl "https://<base-url>/banner-states/banner/{banner}/state/{state}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "banner"="446388" \
    -d "state"="dolorum" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/banner-states/banner/{banner}/state/{state}",
    "method": "PUT",
    "data": {
        "banner": 446388,
        "state": "dolorum"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT banner-states/banner/{banner}/state/{state}

Parameters

Parameter	Type	Status	Description
banner	numeric	required	Must have a length between 1 and 11 Valid banner ban_id
state	string	required	Valid state sta_name

Delete

Example request:

curl "https://<base-url>/banner-states/banner/{banner}/state/{state}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/banner-states/banner/{banner}/state/{state}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE banner-states/banner/{banner}/state/{state}

Banners

Retrieve multiple

Example request:

curl "https://<base-url>/banners" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1507802745" \
    -d "per_page"="702" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/banners",
    "method": "GET",
    "data": {
        "page": 1507802745,
        "per_page": 702,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET banners

HEAD banners

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/banners" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "ban_name"="asperiores" \
    -d "sta_name"="asperiores" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/banners",
    "method": "POST",
    "data": {
        "ban_name": "asperiores",
        "sta_name": "asperiores"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST banners

Parameters

Parameter	Type	Status	Description
ban_name	string	required	Maximum: 255
sta_name	string	required	Maximum: 3

Retrieve

Example request:

curl "https://<base-url>/banners/{banners}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "banners"="27641370" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/banners/{banners}",
    "method": "GET",
    "data": {
        "banners": 27641370
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET banners/{banners}

HEAD banners/{banners}

Parameters

Parameter	Type	Status	Description
banners	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/banners/{banners}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "banners"="7341" \
    -d "ban_name"="laboriosam" \
    -d "sta_name"="laboriosam" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/banners/{banners}",
    "method": "PUT",
    "data": {
        "banners": 7341,
        "ban_name": "laboriosam",
        "sta_name": "laboriosam"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT banners/{banners}

PATCH banners/{banners}

Parameters

Parameter	Type	Status	Description
banners	numeric	required	Must have a length between 1 and 11
ban_name	string	required	Maximum: 255
sta_name	string	required	Maximum: 3

Delete

Example request:

curl "https://<base-url>/banners/{banners}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/banners/{banners}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE banners/{banners}

Bonus-Types

Retrieve multiple

Example request:

curl "https://<base-url>/bonus-types" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1902825642" \
    -d "per_page"="886" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/bonus-types",
    "method": "GET",
    "data": {
        "page": 1902825642,
        "per_page": 886,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET bonus-types

HEAD bonus-types

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/bonus-types" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "name"="esse" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/bonus-types",
    "method": "POST",
    "data": {
        "name": "esse"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST bonus-types

Parameters

Parameter	Type	Status	Description
name	string	required	Maximum: 45

Retrieve

Example request:

curl "https://<base-url>/bonus-types/{bonus_types}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "bonus_types"="20686027" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/bonus-types/{bonus_types}",
    "method": "GET",
    "data": {
        "bonus_types": 20686027
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET bonus-types/{bonus_types}

HEAD bonus-types/{bonus_types}

Parameters

Parameter	Type	Status	Description
bonus_types	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/bonus-types/{bonus_types}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "bonus_types"="4" \
    -d "name"="ab" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/bonus-types/{bonus_types}",
    "method": "PUT",
    "data": {
        "bonus_types": 4,
        "name": "ab"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT bonus-types/{bonus_types}

PATCH bonus-types/{bonus_types}

Parameters

Parameter	Type	Status	Description
bonus_types	numeric	required	Must have a length between 1 and 11
name	string	optional	Maximum: 45

Delete

Example request:

curl "https://<base-url>/bonus-types/{bonus_types}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/bonus-types/{bonus_types}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE bonus-types/{bonus_types}

Brands

Retrieve multiple

Example request:

curl "https://<base-url>/brands" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="316978710" \
    -d "per_page"="147" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/brands",
    "method": "GET",
    "data": {
        "page": 316978710,
        "per_page": 147,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET brands

HEAD brands

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/brands" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "bnd_name"="debitis" \
    -d "is_active"="1" \
    -d "description"="debitis" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/brands",
    "method": "POST",
    "data": {
        "bnd_name": "debitis",
        "is_active": true,
        "description": "debitis"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST brands

Parameters

Parameter	Type	Status	Description
bnd_name	string	required	Maximum: 30
is_active	boolean	required
description	string	optional	Maximum: 255

Retrieve

Example request:

curl "https://<base-url>/brands/{brands}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "brands"="84441586" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/brands/{brands}",
    "method": "GET",
    "data": {
        "brands": 84441586
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET brands/{brands}

HEAD brands/{brands}

Parameters

Parameter	Type	Status	Description
brands	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/brands/{brands}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "brands"="527605734" \
    -d "is_active"="1" \
    -d "description"="recusandae" \
    -d "bnd_name"="recusandae" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/brands/{brands}",
    "method": "PUT",
    "data": {
        "brands": 527605734,
        "is_active": true,
        "description": "recusandae",
        "bnd_name": "recusandae"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT brands/{brands}

PATCH brands/{brands}

Parameters

Parameter	Type	Status	Description
brands	numeric	required	Must have a length between 1 and 11
is_active	boolean	required
description	string	optional	Maximum: 255
bnd_name	string	required	Maximum: 30

Call-Notes

Retrieve by account

Example request:

curl "https://<base-url>/call-notes/{account}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="2138841770" \
    -d "per_page"="996" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/call-notes/{account}",
    "method": "GET",
    "data": {
        "page": 2138841770,
        "per_page": 996,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET call-notes/{account}

HEAD call-notes/{account}

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve multiple

Example request:

curl "https://<base-url>/call-notes" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="142545138" \
    -d "per_page"="66" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/call-notes",
    "method": "GET",
    "data": {
        "page": 142545138,
        "per_page": 66,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET call-notes

HEAD call-notes

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/call-notes" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "his_info"="ratione" \
    -d "cal_id"="ratione" \
    -d "his_date"="2025:07:10" \
    -d "act_id"="ratione" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/call-notes",
    "method": "POST",
    "data": {
        "his_info": "ratione",
        "cal_id": "ratione",
        "his_date": "2025:07:10",
        "act_id": "ratione"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST call-notes

Parameters

Parameter	Type	Status	Description
his_info	string	required
cal_id	string	required	Valid jpcall cal_id
his_date	date	required	Date format: Y:m:d
act_id	string	required	Valid account act_id

Retrieve

Example request:

curl "https://<base-url>/call-notes/{call_notes}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "call_notes"="27" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/call-notes/{call_notes}",
    "method": "GET",
    "data": {
        "call_notes": 27
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET call-notes/{call_notes}

HEAD call-notes/{call_notes}

Parameters

Parameter	Type	Status	Description
call_notes	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/call-notes/{call_notes}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "call_notes"="30" \
    -d "his_info"="qui" \
    -d "cal_id"="qui" \
    -d "his_date"="2025:07:10" \
    -d "act_id"="qui" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/call-notes/{call_notes}",
    "method": "PUT",
    "data": {
        "call_notes": 30,
        "his_info": "qui",
        "cal_id": "qui",
        "his_date": "2025:07:10",
        "act_id": "qui"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT call-notes/{call_notes}

PATCH call-notes/{call_notes}

Parameters

Parameter	Type	Status	Description
call_notes	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
his_info	string	optional
cal_id	string	optional	Valid jpcall cal_id
his_date	date	optional	Date format: Y:m:d
act_id	string	optional	Valid account act_id

Call-Types

Retrieve multiple

Example request:

curl "https://<base-url>/call-types" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1323635148" \
    -d "per_page"="616" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/call-types",
    "method": "GET",
    "data": {
        "page": 1323635148,
        "per_page": 616,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET call-types

HEAD call-types

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve

Example request:

curl "https://<base-url>/call-types/{call_types}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "call_types"="17765378" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/call-types/{call_types}",
    "method": "GET",
    "data": {
        "call_types": 17765378
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET call-types/{call_types}

HEAD call-types/{call_types}

Parameters

Parameter	Type	Status	Description
call_types	numeric	required	Must have a length between 1 and 11

CallAudit

Retrieve multiple

Example request:

curl "https://<base-url>/call-audit" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="2125408525" \
    -d "per_page"="990" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/call-audit",
    "method": "GET",
    "data": {
        "page": 2125408525,
        "per_page": 990,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET call-audit

HEAD call-audit

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve

Example request:

curl "https://<base-url>/call-audit/{call_audit}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "calls"="4" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/call-audit/{call_audit}",
    "method": "GET",
    "data": {
        "calls": 4
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET call-audit/{call_audit}

HEAD call-audit/{call_audit}

Parameters

Parameter	Type	Status	Description
calls	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Calls

Retrieve multiple

Example request:

curl "https://<base-url>/calls" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="242598969" \
    -d "per_page"="113" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/calls",
    "method": "GET",
    "data": {
        "page": 242598969,
        "per_page": 113,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET calls

HEAD calls

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/calls" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "act_id"="explicabo" \
    -d "usr_id"="explicabo" \
    -d "cat_id"="7" \
    -d "cal_date"="2025:07:10" \
    -d "cal_time"="06:48" \
    -d "cal_position"="7" \
    -d "cal_status"="comp" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/calls",
    "method": "POST",
    "data": {
        "act_id": "explicabo",
        "usr_id": "explicabo",
        "cat_id": 7,
        "cal_date": "2025:07:10",
        "cal_time": "06:48",
        "cal_position": 7,
        "cal_status": "comp"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST calls

Parameters

Parameter	Type	Status	Description
act_id	string	required	Valid account act_id
usr_id	string	required	Valid user usr_id
cat_id	integer	required	Valid jpcall_type cat_id
cal_date	date	required	Date format: Y:m:d
cal_time	date	optional	Date format: H:i
cal_position	integer	required
cal_status	string	optional	comp or no

Retrieve

Example request:

curl "https://<base-url>/calls/{calls}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "calls"="8" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/calls/{calls}",
    "method": "GET",
    "data": {
        "calls": 8
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET calls/{calls}

HEAD calls/{calls}

Parameters

Parameter	Type	Status	Description
calls	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/calls/{calls}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "calls"="13" \
    -d "act_id"="aliquid" \
    -d "usr_id"="aliquid" \
    -d "cat_id"="6742" \
    -d "cal_date"="2025:07:10" \
    -d "cal_time"="06:48" \
    -d "cal_position"="6742" \
    -d "cal_status"="comp" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/calls/{calls}",
    "method": "PUT",
    "data": {
        "calls": 13,
        "act_id": "aliquid",
        "usr_id": "aliquid",
        "cat_id": 6742,
        "cal_date": "2025:07:10",
        "cal_time": "06:48",
        "cal_position": 6742,
        "cal_status": "comp"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT calls/{calls}

PATCH calls/{calls}

Parameters

Parameter	Type	Status	Description
calls	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
act_id	string	required	Valid account act_id
usr_id	string	required	Valid user usr_id
cat_id	integer	required	Valid jpcall_type cat_id
cal_date	date	required	Date format: Y:m:d
cal_time	date	optional	Date format: H:i
cal_position	integer	required
cal_status	string	optional	comp or no

Delete

Example request:

curl "https://<base-url>/calls/{calls}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/calls/{calls}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE calls/{calls}

Campaign-Question-Brands

Retrieve multiple

Example request:

curl "https://<base-url>/campaign-question-brands" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="581580574" \
    -d "per_page"="271" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/campaign-question-brands",
    "method": "GET",
    "data": {
        "page": 581580574,
        "per_page": 271,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET campaign-question-brands

HEAD campaign-question-brands

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/campaign-question-brands" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "marketing_campaign_question_id"="70622" \
    -d "brand_id"="70622" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/campaign-question-brands",
    "method": "POST",
    "data": {
        "marketing_campaign_question_id": 70622,
        "brand_id": 70622
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST campaign-question-brands

Parameters

Parameter	Type	Status	Description
marketing_campaign_question_id	integer	required	Valid marketing_campaign_question id
brand_id	integer	required	Valid brand bnd_id

Retrieve

Example request:

curl "https://<base-url>/campaign-question-brands/{campaign_question_brands}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "campaign_question_brands"="2" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/campaign-question-brands/{campaign_question_brands}",
    "method": "GET",
    "data": {
        "campaign_question_brands": 2
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET campaign-question-brands/{campaign_question_brands}

HEAD campaign-question-brands/{campaign_question_brands}

Parameters

Parameter	Type	Status	Description
campaign_question_brands	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/campaign-question-brands/{campaign_question_brands}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "campaign_question_brands"="411752175" \
    -d "marketing_campaign_question_id"="411752175" \
    -d "brand_id"="411752175" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/campaign-question-brands/{campaign_question_brands}",
    "method": "PUT",
    "data": {
        "campaign_question_brands": 411752175,
        "marketing_campaign_question_id": 411752175,
        "brand_id": 411752175
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT campaign-question-brands/{campaign_question_brands}

PATCH campaign-question-brands/{campaign_question_brands}

Parameters

Parameter	Type	Status	Description
campaign_question_brands	numeric	required	Must have a length between 1 and 11
marketing_campaign_question_id	integer	required	Valid marketing_campaign_question id
brand_id	integer	required	Valid brand bnd_id

Delete

Example request:

curl "https://<base-url>/campaign-question-brands/{campaign_question_brands}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/campaign-question-brands/{campaign_question_brands}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE campaign-question-brands/{campaign_question_brands}

Campaign-Questions

Retrieve multiple

Example request:

curl "https://<base-url>/campaign-questions" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1872887298" \
    -d "per_page"="873" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/campaign-questions",
    "method": "GET",
    "data": {
        "page": 1872887298,
        "per_page": 873,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET campaign-questions

HEAD campaign-questions

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/campaign-questions" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "marketing_campaign_id"="73791752" \
    -d "question_id"="73791752" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/campaign-questions",
    "method": "POST",
    "data": {
        "marketing_campaign_id": 73791752,
        "question_id": 73791752
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST campaign-questions

Parameters

Parameter	Type	Status	Description
marketing_campaign_id	integer	required	Valid marketing_campaign id
question_id	integer	required	Valid question id

Retrieve

Example request:

curl "https://<base-url>/campaign-questions/{campaign_questions}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "campaign_questions"="841" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/campaign-questions/{campaign_questions}",
    "method": "GET",
    "data": {
        "campaign_questions": 841
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET campaign-questions/{campaign_questions}

HEAD campaign-questions/{campaign_questions}

Parameters

Parameter	Type	Status	Description
campaign_questions	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/campaign-questions/{campaign_questions}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "campaign_questions"="8" \
    -d "marketing_campaign_id"="8" \
    -d "question_id"="8" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/campaign-questions/{campaign_questions}",
    "method": "PUT",
    "data": {
        "campaign_questions": 8,
        "marketing_campaign_id": 8,
        "question_id": 8
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT campaign-questions/{campaign_questions}

PATCH campaign-questions/{campaign_questions}

Parameters

Parameter	Type	Status	Description
campaign_questions	numeric	required	Must have a length between 1 and 11
marketing_campaign_id	integer	required	Valid marketing_campaign id
question_id	integer	required	Valid question id

Delete

Example request:

curl "https://<base-url>/campaign-questions/{campaign_questions}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/campaign-questions/{campaign_questions}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE campaign-questions/{campaign_questions}

Channels

Retrieve multiple

Example request:

curl "https://<base-url>/channels" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1311198759" \
    -d "per_page"="611" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/channels",
    "method": "GET",
    "data": {
        "page": 1311198759,
        "per_page": 611,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET channels

HEAD channels

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/channels" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "chn_name"="consequatur" \
    -d "chn_parent_id"="4" \
    -d "chn_type"="0" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/channels",
    "method": "POST",
    "data": {
        "chn_name": "consequatur",
        "chn_parent_id": 4,
        "chn_type": 0
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST channels

Parameters

Parameter	Type	Status	Description
chn_name	string	required	Maximum: 255
chn_parent_id	numeric	optional	Must have a length between 0 and 11
chn_type	integer	required	Minimum: 0 Maximum: 2

Retrieve

Example request:

curl "https://<base-url>/channels/{channels}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "channels"="76" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/channels/{channels}",
    "method": "GET",
    "data": {
        "channels": 76
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET channels/{channels}

HEAD channels/{channels}

Parameters

Parameter	Type	Status	Description
channels	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/channels/{channels}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "channels"="9817" \
    -d "chn_name"="quis" \
    -d "chn_parent_id"="9817" \
    -d "chn_type"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/channels/{channels}",
    "method": "PUT",
    "data": {
        "channels": 9817,
        "chn_name": "quis",
        "chn_parent_id": 9817,
        "chn_type": 1
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT channels/{channels}

PATCH channels/{channels}

Parameters

Parameter	Type	Status	Description
channels	numeric	required	Must have a length between 1 and 11
chn_name	string	required	Maximum: 255
chn_parent_id	numeric	optional	Must have a length between 0 and 11
chn_type	integer	required	Minimum: 0 Maximum: 2

Delete

Example request:

curl "https://<base-url>/channels/{channels}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/channels/{channels}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE channels/{channels}

Cocktails

Retrieve multiple

Example request:

curl "https://<base-url>/cocktails" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="391838260" \
    -d "per_page"="182" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/cocktails",
    "method": "GET",
    "data": {
        "page": 391838260,
        "per_page": 182,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET cocktails

HEAD cocktails

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/cocktails" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "ckt_name"="130" \
    -d "ckt_signature"="false" \
    -d "ckt_recipe"="130" \
    -d "ckt_note"="130" \
    -d "act_id"="19" \
    -d "bnd_id"="34654" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/cocktails",
    "method": "POST",
    "data": {
        "ckt_name": 130,
        "ckt_signature": "false",
        "ckt_recipe": 130,
        "ckt_note": 130,
        "act_id": 19,
        "bnd_id": 34654
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST cocktails

Parameters

Parameter	Type	Status	Description
ckt_name	string	required	Between: 1 and 255
ckt_signature	string	optional	true or false
ckt_recipe	string	optional	Between: 1 and 255
ckt_note	string	optional	Between: 1 and 255
act_id	string	optional	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
bnd_id	integer	required	Valid brand bnd_id

Retrieve

Example request:

curl "https://<base-url>/cocktails/{cocktails}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "cocktails"="12" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/cocktails/{cocktails}",
    "method": "GET",
    "data": {
        "cocktails": 12
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET cocktails/{cocktails}

HEAD cocktails/{cocktails}

Parameters

Parameter	Type	Status	Description
cocktails	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/cocktails/{cocktails}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "cocktails"="25" \
    -d "ckt_name"="175" \
    -d "ckt_signature"="false" \
    -d "ckt_recipe"="175" \
    -d "ckt_note"="175" \
    -d "act_id"="25" \
    -d "bnd_id"="502922" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/cocktails/{cocktails}",
    "method": "PUT",
    "data": {
        "cocktails": 25,
        "ckt_name": 175,
        "ckt_signature": "false",
        "ckt_recipe": 175,
        "ckt_note": 175,
        "act_id": 25,
        "bnd_id": 502922
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT cocktails/{cocktails}

PATCH cocktails/{cocktails}

Parameters

Parameter	Type	Status	Description
cocktails	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
ckt_name	string	optional	Between: 1 and 255
ckt_signature	string	optional	true or false
ckt_recipe	string	optional	Between: 1 and 255
ckt_note	string	optional	Between: 1 and 255
act_id	string	optional	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
bnd_id	integer	optional	Valid brand bnd_id

Delete

Example request:

curl "https://<base-url>/cocktails/{cocktails}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/cocktails/{cocktails}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE cocktails/{cocktails}

Company-Objectives

Retrieve multiple

Example request:

curl "https://<base-url>/company-objectives" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1071400355" \
    -d "per_page"="499" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/company-objectives",
    "method": "GET",
    "data": {
        "page": 1071400355,
        "per_page": 499,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET company-objectives

HEAD company-objectives

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/company-objectives" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "sta_name"="enim" \
    -d "cob_name"="enim" \
    -d "cob_start_date"="2025:07:10" \
    -d "cob_end_date"="2025:07:10" \
    -d "cob_type"="territory" \
    -d "cob_value"="enim" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/company-objectives",
    "method": "POST",
    "data": {
        "sta_name": "enim",
        "cob_name": "enim",
        "cob_start_date": "2025:07:10",
        "cob_end_date": "2025:07:10",
        "cob_type": "territory",
        "cob_value": "enim"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST company-objectives

Parameters

Parameter	Type	Status	Description
sta_name	string	required	Valid state sta_name
cob_name	string	required	Maximum: 255
cob_start_date	date	required	Date format: Y:m:d
cob_end_date	date	required	Date format: Y:m:d
cob_type	string	required	account, territory, banner or state
cob_value	string	required	Maximum: 255

Retrieve

Example request:

curl "https://<base-url>/company-objectives/{company_objectives}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "company_objectives"="210881" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/company-objectives/{company_objectives}",
    "method": "GET",
    "data": {
        "company_objectives": 210881
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET company-objectives/{company_objectives}

HEAD company-objectives/{company_objectives}

Parameters

Parameter	Type	Status	Description
company_objectives	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/company-objectives/{company_objectives}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "company_objectives"="7" \
    -d "sta_name"="sunt" \
    -d "cob_name"="sunt" \
    -d "cob_start_date"="2025:07:10" \
    -d "cob_end_date"="2025:07:10" \
    -d "cob_type"="account" \
    -d "cob_value"="sunt" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/company-objectives/{company_objectives}",
    "method": "PUT",
    "data": {
        "company_objectives": 7,
        "sta_name": "sunt",
        "cob_name": "sunt",
        "cob_start_date": "2025:07:10",
        "cob_end_date": "2025:07:10",
        "cob_type": "account",
        "cob_value": "sunt"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT company-objectives/{company_objectives}

PATCH company-objectives/{company_objectives}

Parameters

Parameter	Type	Status	Description
company_objectives	numeric	required	Must have a length between 1 and 11
sta_name	string	required	Valid state sta_name
cob_name	string	required	Maximum: 255
cob_start_date	date	required	Date format: Y:m:d
cob_end_date	date	required	Date format: Y:m:d
cob_type	string	required	account, territory, banner or state
cob_value	string	required	Maximum: 255

Delete

Example request:

curl "https://<base-url>/company-objectives/{company_objectives}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/company-objectives/{company_objectives}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE company-objectives/{company_objectives}

Cycles

Retrieve multiple

Example request:

curl "https://<base-url>/cycles" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="2135638434" \
    -d "per_page"="995" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/cycles",
    "method": "GET",
    "data": {
        "page": 2135638434,
        "per_page": 995,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET cycles

HEAD cycles

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/cycles" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "name"="eveniet" \
    -d "weeks"="713755235" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/cycles",
    "method": "POST",
    "data": {
        "name": "eveniet",
        "weeks": 713755235
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST cycles

Parameters

Parameter	Type	Status	Description
name	string	required	Maximum: 255
weeks	numeric	required

Retrieve

Example request:

curl "https://<base-url>/cycles/{cycles}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "cycles"="73" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/cycles/{cycles}",
    "method": "GET",
    "data": {
        "cycles": 73
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET cycles/{cycles}

HEAD cycles/{cycles}

Parameters

Parameter	Type	Status	Description
cycles	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/cycles/{cycles}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "cycles"="984" \
    -d "name"="exercitationem" \
    -d "weeks"="984" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/cycles/{cycles}",
    "method": "PUT",
    "data": {
        "cycles": 984,
        "name": "exercitationem",
        "weeks": 984
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT cycles/{cycles}

PATCH cycles/{cycles}

Parameters

Parameter	Type	Status	Description
cycles	numeric	required	Must have a length between 1 and 11
name	string	required	Maximum: 255
weeks	numeric	required

Delete

Example request:

curl "https://<base-url>/cycles/{cycles}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/cycles/{cycles}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE cycles/{cycles}

Data-Source-Types

Retrieve multiple

Example request:

curl "https://<base-url>/data-source-types" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="17871447" \
    -d "per_page"="8" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/data-source-types",
    "method": "GET",
    "data": {
        "page": 17871447,
        "per_page": 8,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET data-source-types

HEAD data-source-types

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/data-source-types" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "name"="fugiat" \
    -d "description"="fugiat" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/data-source-types",
    "method": "POST",
    "data": {
        "name": "fugiat",
        "description": "fugiat"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST data-source-types

Parameters

Parameter	Type	Status	Description
name	string	required	Maximum: 25
description	string	optional	Maximum: 500

Retrieve

Example request:

curl "https://<base-url>/data-source-types/{data_source_types}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "data_source_types"="4" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/data-source-types/{data_source_types}",
    "method": "GET",
    "data": {
        "data_source_types": 4
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET data-source-types/{data_source_types}

HEAD data-source-types/{data_source_types}

Parameters

Parameter	Type	Status	Description
data_source_types	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/data-source-types/{data_source_types}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "data_source_types"="747150" \
    -d "name"="laborum" \
    -d "description"="laborum" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/data-source-types/{data_source_types}",
    "method": "PUT",
    "data": {
        "data_source_types": 747150,
        "name": "laborum",
        "description": "laborum"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT data-source-types/{data_source_types}

PATCH data-source-types/{data_source_types}

Parameters

Parameter	Type	Status	Description
data_source_types	numeric	required	Must have a length between 1 and 11
name	string	required	Maximum: 25
description	string	optional	Maximum: 500

Distribution-Packaged-Audits

Retrieve multiple

Example request:

curl "https://<base-url>/distribution-packaged-audits" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1841909857" \
    -d "per_page"="858" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/distribution-packaged-audits",
    "method": "GET",
    "data": {
        "page": 1841909857,
        "per_page": 858,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET distribution-packaged-audits

HEAD distribution-packaged-audits

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/distribution-packaged-audits" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "dipa_start_date"="2025-07-10 06:48:05" \
    -d "dipa_end_date"="2025-07-10 06:48:05" \
    -d "dip_id"="ullam" \
    -d "dip_value"="true" \
    -d "pro_id"="535" \
    -d "sea_id"="ullam" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/distribution-packaged-audits",
    "method": "POST",
    "data": {
        "dipa_start_date": "2025-07-10 06:48:05",
        "dipa_end_date": "2025-07-10 06:48:05",
        "dip_id": "ullam",
        "dip_value": "true",
        "pro_id": 535,
        "sea_id": "ullam"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST distribution-packaged-audits

Parameters

Parameter	Type	Status	Description
dipa_start_date	date	required	Date format: Y-m-d H:i:s
dipa_end_date	date	required	Date format: Y-m-d H:i:s
dip_id	string	required	Valid distribution_packaged dip_id
dip_value	string	required	true
pro_id	integer	required	Valid product pro_id
sea_id	string	required	Valid selling_area sea_id

Retrieve

Example request:

curl "https://<base-url>/distribution-packaged-audits/{distribution_packaged_audits}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "distribution_packaged_audits"="2211891" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/distribution-packaged-audits/{distribution_packaged_audits}",
    "method": "GET",
    "data": {
        "distribution_packaged_audits": 2211891
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET distribution-packaged-audits/{distribution_packaged_audits}

HEAD distribution-packaged-audits/{distribution_packaged_audits}

Parameters

Parameter	Type	Status	Description
distribution_packaged_audits	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/distribution-packaged-audits/{distribution_packaged_audits}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "distribution_packaged_audits"="281409177" \
    -d "dipa_start_date"="2025-07-10 06:48:05" \
    -d "dipa_end_date"="2025-07-10 06:48:05" \
    -d "dip_id"="et" \
    -d "dip_value"="true" \
    -d "pro_id"="281409177" \
    -d "sea_id"="et" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/distribution-packaged-audits/{distribution_packaged_audits}",
    "method": "PUT",
    "data": {
        "distribution_packaged_audits": 281409177,
        "dipa_start_date": "2025-07-10 06:48:05",
        "dipa_end_date": "2025-07-10 06:48:05",
        "dip_id": "et",
        "dip_value": "true",
        "pro_id": 281409177,
        "sea_id": "et"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT distribution-packaged-audits/{distribution_packaged_audits}

PATCH distribution-packaged-audits/{distribution_packaged_audits}

Parameters

Parameter	Type	Status	Description
distribution_packaged_audits	numeric	required	Must have a length between 1 and 11
dipa_start_date	date	optional	Date format: Y-m-d H:i:s
dipa_end_date	date	optional	Date format: Y-m-d H:i:s
dip_id	string	required	Valid distribution_packaged dip_id
dip_value	string	optional	true
pro_id	integer	optional	Valid product pro_id
sea_id	string	optional	Valid selling_area sea_id

Distribution-Packages

Retrieve multiple

Example request:

curl "https://<base-url>/distribution-packages" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1777126603" \
    -d "per_page"="828" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/distribution-packages",
    "method": "GET",
    "data": {
        "page": 1777126603,
        "per_page": 828,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET distribution-packages

HEAD distribution-packages

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/distribution-packages" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "dip_value"="true" \
    -d "pro_id"="981684" \
    -d "sea_id"="cumque" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/distribution-packages",
    "method": "POST",
    "data": {
        "dip_value": "true",
        "pro_id": 981684,
        "sea_id": "cumque"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST distribution-packages

Parameters

Parameter	Type	Status	Description
dip_value	string	required	true
pro_id	integer	required	Valid product pro_id
sea_id	string	required	Valid selling_area sea_id

Retrieve

Example request:

curl "https://<base-url>/distribution-packages/{distribution_packages}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "distribution_packages"="12" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/distribution-packages/{distribution_packages}",
    "method": "GET",
    "data": {
        "distribution_packages": 12
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET distribution-packages/{distribution_packages}

HEAD distribution-packages/{distribution_packages}

Parameters

Parameter	Type	Status	Description
distribution_packages	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/distribution-packages/{distribution_packages}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "distribution_packages"="14" \
    -d "dip_value"="true" \
    -d "pro_id"="5691" \
    -d "sea_id"="autem" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/distribution-packages/{distribution_packages}",
    "method": "PUT",
    "data": {
        "distribution_packages": 14,
        "dip_value": "true",
        "pro_id": 5691,
        "sea_id": "autem"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT distribution-packages/{distribution_packages}

PATCH distribution-packages/{distribution_packages}

Parameters

Parameter	Type	Status	Description
distribution_packages	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
dip_value	string	optional	true
pro_id	integer	optional	Valid product pro_id
sea_id	string	optional	Valid selling_area sea_id

Delete

Example request:

curl "https://<base-url>/distribution-packages/{distribution_packages}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/distribution-packages/{distribution_packages}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE distribution-packages/{distribution_packages}

Gps

Retrieve multiple

Example request:

curl "https://<base-url>/gps" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="77455075" \
    -d "per_page"="36" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/gps",
    "method": "GET",
    "data": {
        "page": 77455075,
        "per_page": 36,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET gps

HEAD gps

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/gps" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "gps_latitude"="8" \
    -d "gps_longitude"="8" \
    -d "gps_time"="2025-07-10 06:48:05" \
    -d "usr_id"="aut" \
    -d "cal_id"="aut" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/gps",
    "method": "POST",
    "data": {
        "gps_latitude": 8,
        "gps_longitude": 8,
        "gps_time": "2025-07-10 06:48:05",
        "usr_id": "aut",
        "cal_id": "aut"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST gps

Parameters

Parameter	Type	Status	Description
gps_latitude	numeric	required
gps_longitude	numeric	required
gps_time	date	required	Date format: Y-m-d H:i:s
usr_id	string	required	Valid user usr_id
cal_id	string	required	Valid jpcall cal_id

Retrieve

Example request:

curl "https://<base-url>/gps/{gps}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "gps"="49711" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/gps/{gps}",
    "method": "GET",
    "data": {
        "gps": 49711
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET gps/{gps}

HEAD gps/{gps}

Parameters

Parameter	Type	Status	Description
gps	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/gps/{gps}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "gps"="529" \
    -d "gps_latitude"="529" \
    -d "gps_longitude"="529" \
    -d "gps_time"="2025-07-10 06:48:05" \
    -d "usr_id"="minima" \
    -d "cal_id"="minima" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/gps/{gps}",
    "method": "PUT",
    "data": {
        "gps": 529,
        "gps_latitude": 529,
        "gps_longitude": 529,
        "gps_time": "2025-07-10 06:48:05",
        "usr_id": "minima",
        "cal_id": "minima"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT gps/{gps}

PATCH gps/{gps}

Parameters

Parameter	Type	Status	Description
gps	numeric	required	Must have a length between 1 and 11
gps_latitude	numeric	required
gps_longitude	numeric	required
gps_time	date	required	Date format: Y-m-d H:i:s
usr_id	string	required	Valid user usr_id
cal_id	string	required	Valid jpcall cal_id

Grades

Retrieve multiple

Example request:

curl "https://<base-url>/grades" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1652833795" \
    -d "per_page"="770" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/grades",
    "method": "GET",
    "data": {
        "page": 1652833795,
        "per_page": 770,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET grades

HEAD grades

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/grades" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "gra_id"="ipsum" \
    -d "gra_standard_cycle"="65" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/grades",
    "method": "POST",
    "data": {
        "gra_id": "ipsum",
        "gra_standard_cycle": 65
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST grades

Parameters

Parameter	Type	Status	Description
gra_id	string	required	Maximum: 20
gra_standard_cycle	integer	required

Retrieve

Example request:

curl "https://<base-url>/grades/{grades}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "grades"="14" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/grades/{grades}",
    "method": "GET",
    "data": {
        "grades": 14
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET grades/{grades}

HEAD grades/{grades}

Parameters

Parameter	Type	Status	Description
grades	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 20

Update

Example request:

curl "https://<base-url>/grades/{grades}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "grades"="voluptatem" \
    -d "gra_standard_cycle"="91" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/grades/{grades}",
    "method": "PUT",
    "data": {
        "grades": "voluptatem",
        "gra_standard_cycle": 91
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT grades/{grades}

PATCH grades/{grades}

Parameters

Parameter	Type	Status	Description
grades	string	required	Maximum: 20
gra_standard_cycle	integer	required

Delete

Example request:

curl "https://<base-url>/grades/{grades}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/grades/{grades}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE grades/{grades}

Groups

Retrieve multiple

Example request:

curl "https://<base-url>/groups" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="170433446" \
    -d "per_page"="79" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/groups",
    "method": "GET",
    "data": {
        "page": 170433446,
        "per_page": 79,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET groups

HEAD groups

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/groups" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "name"="quis" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/groups",
    "method": "POST",
    "data": {
        "name": "quis"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST groups

Parameters

Parameter	Type	Status	Description
name	string	required	Maximum: 45

Retrieve

Example request:

curl "https://<base-url>/groups/{groups}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "groups"="489568958" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/groups/{groups}",
    "method": "GET",
    "data": {
        "groups": 489568958
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET groups/{groups}

HEAD groups/{groups}

Parameters

Parameter	Type	Status	Description
groups	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/groups/{groups}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "groups"="9461" \
    -d "name"="et" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/groups/{groups}",
    "method": "PUT",
    "data": {
        "groups": 9461,
        "name": "et"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT groups/{groups}

PATCH groups/{groups}

Parameters

Parameter	Type	Status	Description
groups	numeric	required	Must have a length between 1 and 11
name	string	required	Maximum: 45

Marketing-Activities

Retrieve multiple

Example request:

curl "https://<base-url>/marketing-activities" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1231959721" \
    -d "per_page"="574" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/marketing-activities",
    "method": "GET",
    "data": {
        "page": 1231959721,
        "per_page": 574,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET marketing-activities

HEAD marketing-activities

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/marketing-activities" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account_id"="16" \
    -d "brand_id"="4711" \
    -d "marketing_campaign_id"="4711" \
    -d "marketing_status_id"="4711" \
    -d "start_date"="2025-07-10 06:48:05" \
    -d "end_date"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/marketing-activities",
    "method": "POST",
    "data": {
        "account_id": 16,
        "brand_id": 4711,
        "marketing_campaign_id": 4711,
        "marketing_status_id": 4711,
        "start_date": "2025-07-10 06:48:05",
        "end_date": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST marketing-activities

Parameters

Parameter	Type	Status	Description
account_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
brand_id	integer	required	Valid brand bnd_id
marketing_campaign_id	integer	required	Valid marketing_campaign id
marketing_status_id	integer	required	Valid marketing_status id
start_date	date	required	Date format: Y-m-d H:i:s
end_date	date	required	Date format: Y-m-d H:i:s

Retrieve

Example request:

curl "https://<base-url>/marketing-activities/{marketing_activities}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "marketing-activities"="35" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/marketing-activities/{marketing_activities}",
    "method": "GET",
    "data": {
        "marketing-activities": 35
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET marketing-activities/{marketing_activities}

HEAD marketing-activities/{marketing_activities}

Parameters

Parameter	Type	Status	Description
marketing-activities	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/marketing-activities/{marketing_activities}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "marketing-activities"="31" \
    -d "account_id"="31" \
    -d "brand_id"="43340958" \
    -d "marketing_campaign_id"="43340958" \
    -d "marketing_status_id"="43340958" \
    -d "start_date"="2025-07-10 06:48:05" \
    -d "end_date"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/marketing-activities/{marketing_activities}",
    "method": "PUT",
    "data": {
        "marketing-activities": 31,
        "account_id": 31,
        "brand_id": 43340958,
        "marketing_campaign_id": 43340958,
        "marketing_status_id": 43340958,
        "start_date": "2025-07-10 06:48:05",
        "end_date": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT marketing-activities/{marketing_activities}

PATCH marketing-activities/{marketing_activities}

Parameters

Parameter	Type	Status	Description
marketing-activities	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
account_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
brand_id	integer	required	Valid brand bnd_id
marketing_campaign_id	integer	required	Valid marketing_campaign id
marketing_status_id	integer	required	Valid marketing_status id
start_date	date	required	Date format: Y-m-d H:i:s
end_date	date	required	Date format: Y-m-d H:i:s

Marketing-Campaigns

Retrieve multiple

Example request:

curl "https://<base-url>/marketing-campaigns" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="6230825" \
    -d "per_page"="2" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/marketing-campaigns",
    "method": "GET",
    "data": {
        "page": 6230825,
        "per_page": 2,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET marketing-campaigns

HEAD marketing-campaigns

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/marketing-campaigns" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "name"="delectus" \
    -d "brand_id"="33539007" \
    -d "active"="0" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/marketing-campaigns",
    "method": "POST",
    "data": {
        "name": "delectus",
        "brand_id": 33539007,
        "active": "0"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST marketing-campaigns

Parameters

Parameter	Type	Status	Description
name	string	required	Maximum: 255
brand_id	integer	required	Valid brand bnd_id
active	string	required	1 or 0

Retrieve

Example request:

curl "https://<base-url>/marketing-campaigns/{marketing_campaigns}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "marketing-campaigns"="877582" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/marketing-campaigns/{marketing_campaigns}",
    "method": "GET",
    "data": {
        "marketing-campaigns": 877582
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET marketing-campaigns/{marketing_campaigns}

HEAD marketing-campaigns/{marketing_campaigns}

Parameters

Parameter	Type	Status	Description
marketing-campaigns	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/marketing-campaigns/{marketing_campaigns}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "marketing-campaigns"="724" \
    -d "name"="ut" \
    -d "brand_id"="724" \
    -d "active"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/marketing-campaigns/{marketing_campaigns}",
    "method": "PUT",
    "data": {
        "marketing-campaigns": 724,
        "name": "ut",
        "brand_id": 724,
        "active": "1"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT marketing-campaigns/{marketing_campaigns}

PATCH marketing-campaigns/{marketing_campaigns}

Parameters

Parameter	Type	Status	Description
marketing-campaigns	numeric	required	Must have a length between 1 and 11
name	string	required	Maximum: 255
brand_id	integer	required	Valid brand bnd_id
active	string	required	1 or 0

Marketing-Statuses

Retrieve multiple

Example request:

curl "https://<base-url>/marketing-statuses" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="509217469" \
    -d "per_page"="237" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/marketing-statuses",
    "method": "GET",
    "data": {
        "page": 509217469,
        "per_page": 237,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET marketing-statuses

HEAD marketing-statuses

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/marketing-statuses" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "name"="esse" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/marketing-statuses",
    "method": "POST",
    "data": {
        "name": "esse"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST marketing-statuses

Parameters

Parameter	Type	Status	Description
name	string	required	Maximum: 255

Retrieve

Example request:

curl "https://<base-url>/marketing-statuses/{marketing_statuses}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "marketing-statuses"="278" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/marketing-statuses/{marketing_statuses}",
    "method": "GET",
    "data": {
        "marketing-statuses": 278
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET marketing-statuses/{marketing_statuses}

HEAD marketing-statuses/{marketing_statuses}

Parameters

Parameter	Type	Status	Description
marketing-statuses	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/marketing-statuses/{marketing_statuses}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "marketing-statuses"="8410" \
    -d "name"="vel" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/marketing-statuses/{marketing_statuses}",
    "method": "PUT",
    "data": {
        "marketing-statuses": 8410,
        "name": "vel"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT marketing-statuses/{marketing_statuses}

PATCH marketing-statuses/{marketing_statuses}

Parameters

Parameter	Type	Status	Description
marketing-statuses	numeric	required	Must have a length between 1 and 11
name	string	required	Maximum: 255

Delete

Example request:

curl "https://<base-url>/marketing-statuses/{marketing_statuses}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/marketing-statuses/{marketing_statuses}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE marketing-statuses/{marketing_statuses}

Modules

Modules are specifically used for the Android app only. Please use the Admin-Modules resource for the web version.

Retrieve multiple

Example request:

curl "https://<base-url>/modules" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="289387787" \
    -d "per_page"="134" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/modules",
    "method": "GET",
    "data": {
        "page": 289387787,
        "per_page": 134,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET modules

HEAD modules

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve

Example request:

curl "https://<base-url>/modules/{modules}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "modules"="890" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/modules/{modules}",
    "method": "GET",
    "data": {
        "modules": 890
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET modules/{modules}

HEAD modules/{modules}

Parameters

Parameter	Type	Status	Description
modules	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/modules/{modules}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "modules"="5214385" \
    -d "mod_activated"="FALSE" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/modules/{modules}",
    "method": "PUT",
    "data": {
        "modules": 5214385,
        "mod_activated": "FALSE"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT modules/{modules}

PATCH modules/{modules}

Parameters

Parameter	Type	Status	Description
modules	numeric	required	Must have a length between 1 and 11
mod_activated	string	required	TRUE or FALSE

On-Trade-Segmentations

Retrieve multiple

Example request:

curl "https://<base-url>/on-trade-segmentations" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="805026341" \
    -d "per_page"="375" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/on-trade-segmentations",
    "method": "GET",
    "data": {
        "page": 805026341,
        "per_page": 375,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET on-trade-segmentations

HEAD on-trade-segmentations

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/on-trade-segmentations" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "ots_name"="corporis" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/on-trade-segmentations",
    "method": "POST",
    "data": {
        "ots_name": "corporis"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST on-trade-segmentations

Parameters

Parameter	Type	Status	Description
ots_name	string	required	Maximum: 45

Retrieve

Example request:

curl "https://<base-url>/on-trade-segmentations/{on_trade_segmentations}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "on_trade_segmentations"="13207544" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/on-trade-segmentations/{on_trade_segmentations}",
    "method": "GET",
    "data": {
        "on_trade_segmentations": 13207544
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET on-trade-segmentations/{on_trade_segmentations}

HEAD on-trade-segmentations/{on_trade_segmentations}

Parameters

Parameter	Type	Status	Description
on_trade_segmentations	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/on-trade-segmentations/{on_trade_segmentations}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "on_trade_segmentations"="74" \
    -d "ots_name"="dolor" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/on-trade-segmentations/{on_trade_segmentations}",
    "method": "PUT",
    "data": {
        "on_trade_segmentations": 74,
        "ots_name": "dolor"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT on-trade-segmentations/{on_trade_segmentations}

PATCH on-trade-segmentations/{on_trade_segmentations}

Parameters

Parameter	Type	Status	Description
on_trade_segmentations	numeric	required	Must have a length between 1 and 11
ots_name	string	required	Maximum: 45

Delete

Example request:

curl "https://<base-url>/on-trade-segmentations/{on_trade_segmentations}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/on-trade-segmentations/{on_trade_segmentations}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE on-trade-segmentations/{on_trade_segmentations}

On-Trade-Segmentations-Product

Retrieve multiple

Example request:

curl "https://<base-url>/on-trade-segmentation-products" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="447432319" \
    -d "per_page"="208" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/on-trade-segmentation-products",
    "method": "GET",
    "data": {
        "page": 447432319,
        "per_page": 208,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET on-trade-segmentation-products

HEAD on-trade-segmentation-products

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/on-trade-segmentation-products" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "ots_id"="175086" \
    -d "pro_id"="175086" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/on-trade-segmentation-products",
    "method": "POST",
    "data": {
        "ots_id": 175086,
        "pro_id": 175086
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST on-trade-segmentation-products

Parameters

Parameter	Type	Status	Description
ots_id	integer	required	Valid on_trade_segmentation ots_id
pro_id	integer	required	Valid product pro_id

Retrieve

Example request:

curl "https://<base-url>/on-trade-segmentation-products/{on_trade_segmentation_products}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "on_trade_segmentation_products"="4" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/on-trade-segmentation-products/{on_trade_segmentation_products}",
    "method": "GET",
    "data": {
        "on_trade_segmentation_products": 4
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET on-trade-segmentation-products/{on_trade_segmentation_products}

HEAD on-trade-segmentation-products/{on_trade_segmentation_products}

Parameters

Parameter	Type	Status	Description
on_trade_segmentation_products	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/on-trade-segmentation-products/{on_trade_segmentation_products}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "on_trade_segmentation_products"="465946594" \
    -d "ots_id"="465946594" \
    -d "pro_id"="465946594" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/on-trade-segmentation-products/{on_trade_segmentation_products}",
    "method": "PUT",
    "data": {
        "on_trade_segmentation_products": 465946594,
        "ots_id": 465946594,
        "pro_id": 465946594
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT on-trade-segmentation-products/{on_trade_segmentation_products}

PATCH on-trade-segmentation-products/{on_trade_segmentation_products}

Parameters

Parameter	Type	Status	Description
on_trade_segmentation_products	numeric	required	Must have a length between 1 and 11
ots_id	integer	required
pro_id	integer	required

Delete

Example request:

curl "https://<base-url>/on-trade-segmentation-products/{on_trade_segmentation_products}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/on-trade-segmentation-products/{on_trade_segmentation_products}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE on-trade-segmentation-products/{on_trade_segmentation_products}

Order-Histories

Retrieve multiple

Example request:

curl "https://<base-url>/order-histories" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1619353114" \
    -d "per_page"="754" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/order-histories",
    "method": "GET",
    "data": {
        "page": 1619353114,
        "per_page": 754,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET order-histories

HEAD order-histories

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/order-histories" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "odh_quantity"="32" \
    -d "odh_type"="sed" \
    -d "odh_expiration"="sed" \
    -d "act_id"="8" \
    -d "pro_id"="32" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/order-histories",
    "method": "POST",
    "data": {
        "odh_quantity": 32,
        "odh_type": "sed",
        "odh_expiration": "sed",
        "act_id": 8,
        "pro_id": 32
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST order-histories

Parameters

Parameter	Type	Status	Description
odh_quantity	integer	required
odh_type	string	optional	Maximum: 45
odh_expiration	string	optional	Maximum: 10
act_id	string	optional	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
pro_id	integer	optional	Valid product pro_id

Retrieve

Example request:

curl "https://<base-url>/order-histories/{order_histories}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "order_histories"="9463686" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/order-histories/{order_histories}",
    "method": "GET",
    "data": {
        "order_histories": 9463686
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET order-histories/{order_histories}

HEAD order-histories/{order_histories}

Parameters

Parameter	Type	Status	Description
order_histories	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/order-histories/{order_histories}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "order_histories"="8" \
    -d "odh_quantity"="8" \
    -d "odh_type"="explicabo" \
    -d "odh_expiration"="explicabo" \
    -d "act_id"="4" \
    -d "pro_id"="8" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/order-histories/{order_histories}",
    "method": "PUT",
    "data": {
        "order_histories": 8,
        "odh_quantity": 8,
        "odh_type": "explicabo",
        "odh_expiration": "explicabo",
        "act_id": 4,
        "pro_id": 8
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT order-histories/{order_histories}

PATCH order-histories/{order_histories}

Parameters

Parameter	Type	Status	Description
order_histories	numeric	required	Must have a length between 1 and 11
odh_quantity	integer	optional
odh_type	string	optional	Maximum: 45
odh_expiration	string	optional	Maximum: 10
act_id	string	optional	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
pro_id	integer	optional	Valid product pro_id

Delete

Example request:

curl "https://<base-url>/order-histories/{order_histories}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/order-histories/{order_histories}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE order-histories/{order_histories}

Ownership-Groups

Retrieve multiple

Example request:

curl "https://<base-url>/ownership-groups" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1076636257" \
    -d "per_page"="501" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/ownership-groups",
    "method": "GET",
    "data": {
        "page": 1076636257,
        "per_page": 501,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET ownership-groups

HEAD ownership-groups

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/ownership-groups" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "osg_name"="nesciunt" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/ownership-groups",
    "method": "POST",
    "data": {
        "osg_name": "nesciunt"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST ownership-groups

Parameters

Parameter	Type	Status	Description
osg_name	string	required	Maximum: 50

Retrieve

Example request:

curl "https://<base-url>/ownership-groups/{ownership_groups}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "ownership_groups"="5679258" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/ownership-groups/{ownership_groups}",
    "method": "GET",
    "data": {
        "ownership_groups": 5679258
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET ownership-groups/{ownership_groups}

HEAD ownership-groups/{ownership_groups}

Parameters

Parameter	Type	Status	Description
ownership_groups	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/ownership-groups/{ownership_groups}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "ownership_groups"="10" \
    -d "osg_name"="sed" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/ownership-groups/{ownership_groups}",
    "method": "PUT",
    "data": {
        "ownership_groups": 10,
        "osg_name": "sed"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT ownership-groups/{ownership_groups}

PATCH ownership-groups/{ownership_groups}

Parameters

Parameter	Type	Status	Description
ownership_groups	numeric	required	Must have a length between 1 and 11
osg_name	string	required	Maximum: 50

Delete

Example request:

curl "https://<base-url>/ownership-groups/{ownership_groups}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/ownership-groups/{ownership_groups}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE ownership-groups/{ownership_groups}

Perfect-Answers

Retrieve multiple

Example request:

curl "https://<base-url>/perfect-answers" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="260282668" \
    -d "per_page"="121" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/perfect-answers",
    "method": "GET",
    "data": {
        "page": 260282668,
        "per_page": 121,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET perfect-answers

HEAD perfect-answers

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/perfect-answers" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "perfect_question_id"="431" \
    -d "account_id"="sit" \
    -d "answer"="0" \
    -d "product_id"="431" \
    -d "usr_id"="sit" \
    -d "points"="712127030" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/perfect-answers",
    "method": "POST",
    "data": {
        "perfect_question_id": 431,
        "account_id": "sit",
        "answer": "0",
        "product_id": 431,
        "usr_id": "sit",
        "points": 712127030
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST perfect-answers

Parameters

Parameter	Type	Status	Description
perfect_question_id	integer	required	Valid perfect_question id
account_id	string	required	Maximum: 36 Valid account act_id
answer	string	required	0 or 1
product_id	integer	optional	Valid product pro_id
usr_id	string	required	Maximum: 36 Valid user usr_id
points	integer	required	Minimum: 0

Retrieve

Example request:

curl "https://<base-url>/perfect-answers/{perfect_answers}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "perfect_answers"="57900" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/perfect-answers/{perfect_answers}",
    "method": "GET",
    "data": {
        "perfect_answers": 57900
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET perfect-answers/{perfect_answers}

HEAD perfect-answers/{perfect_answers}

Parameters

Parameter	Type	Status	Description
perfect_answers	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/perfect-answers/{perfect_answers}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "perfect_answers"="45009861" \
    -d "perfect_question_id"="45009861" \
    -d "account_id"="temporibus" \
    -d "answer"="1" \
    -d "product_id"="45009861" \
    -d "usr_id"="temporibus" \
    -d "points"="1693524768" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/perfect-answers/{perfect_answers}",
    "method": "PUT",
    "data": {
        "perfect_answers": 45009861,
        "perfect_question_id": 45009861,
        "account_id": "temporibus",
        "answer": "1",
        "product_id": 45009861,
        "usr_id": "temporibus",
        "points": 1693524768
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT perfect-answers/{perfect_answers}

PATCH perfect-answers/{perfect_answers}

Parameters

Parameter	Type	Status	Description
perfect_answers	numeric	required	Must have a length between 1 and 11
perfect_question_id	integer	optional	Valid perfect_question id
account_id	string	optional	Maximum: 36 Valid account act_id
answer	string	optional	0 or 1
product_id	integer	optional	Valid product pro_id
usr_id	string	optional	Maximum: 36 Valid user usr_id
points	integer	optional	Minimum: 0

Delete

Example request:

curl "https://<base-url>/perfect-answers/{perfect_answers}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/perfect-answers/{perfect_answers}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE perfect-answers/{perfect_answers}

Perfect-Categories

Retrieve multiple

Example request:

curl "https://<base-url>/perfect-categories" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1858336655" \
    -d "per_page"="866" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/perfect-categories",
    "method": "GET",
    "data": {
        "page": 1858336655,
        "per_page": 866,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET perfect-categories

HEAD perfect-categories

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/perfect-categories" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "category"="maiores" \
    -d "account_type"="2" \
    -d "parent_perfect_category_id"="547046613" \
    -d "order"="2117936452" \
    -d "visible"="0" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/perfect-categories",
    "method": "POST",
    "data": {
        "category": "maiores",
        "account_type": "2",
        "parent_perfect_category_id": 547046613,
        "order": 2117936452,
        "visible": "0"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST perfect-categories

Parameters

Parameter	Type	Status	Description
category	string	required	Maximum: 500
account_type	integer	required	1 or 2
parent_perfect_category_id	integer	optional	Valid perfect_category id
order	integer	required	Minimum: 1
visible	integer	required	1 or 0

Retrieve

Example request:

curl "https://<base-url>/perfect-categories/{perfect_categories}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "perfect_categories"="446353245" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/perfect-categories/{perfect_categories}",
    "method": "GET",
    "data": {
        "perfect_categories": 446353245
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET perfect-categories/{perfect_categories}

HEAD perfect-categories/{perfect_categories}

Parameters

Parameter	Type	Status	Description
perfect_categories	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/perfect-categories/{perfect_categories}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "perfect_categories"="7810" \
    -d "category"="laboriosam" \
    -d "account_type"="1" \
    -d "parent_perfect_category_id"="7810" \
    -d "order"="732957480" \
    -d "visible"="0" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/perfect-categories/{perfect_categories}",
    "method": "PUT",
    "data": {
        "perfect_categories": 7810,
        "category": "laboriosam",
        "account_type": "1",
        "parent_perfect_category_id": 7810,
        "order": 732957480,
        "visible": "0"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT perfect-categories/{perfect_categories}

PATCH perfect-categories/{perfect_categories}

Parameters

Parameter	Type	Status	Description
perfect_categories	numeric	required	Must have a length between 1 and 11
category	string	required	Maximum: 500
account_type	integer	optional	1 or 2
parent_perfect_category_id	integer	optional	Valid perfect_category id
order	integer	optional	Minimum: 1
visible	string	optional	0 or 1

Delete

Example request:

curl "https://<base-url>/perfect-categories/{perfect_categories}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/perfect-categories/{perfect_categories}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE perfect-categories/{perfect_categories}

Perfect-Questions

Retrieve multiple

Example request:

curl "https://<base-url>/perfect-questions" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="418283744" \
    -d "per_page"="194" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/perfect-questions",
    "method": "GET",
    "data": {
        "page": 418283744,
        "per_page": 194,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET perfect-questions

HEAD perfect-questions

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/perfect-questions" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "question"="quasi" \
    -d "perfect_category_id"="0" \
    -d "order"="152101194" \
    -d "points"="152101194" \
    -d "product_id"="0" \
    -d "multiple_answers_allowed"="0" \
    -d "product_selection_allowed"="0" \
    -d "visible"="0" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/perfect-questions",
    "method": "POST",
    "data": {
        "question": "quasi",
        "perfect_category_id": 0,
        "order": 152101194,
        "points": 152101194,
        "product_id": 0,
        "multiple_answers_allowed": "0",
        "product_selection_allowed": "0",
        "visible": "0"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST perfect-questions

Parameters

Parameter	Type	Status	Description
question	string	required	Maximum: 500
perfect_category_id	integer	required	Valid perfect_category id
order	integer	required	Minimum: 1
points	integer	required	Minimum: 0
product_id	integer	optional	Valid product pro_id
multiple_answers_allowed	string	required	0 or 1
product_selection_allowed	string	required	0 or 1
visible	string	required	0 or 1

Retrieve

Example request:

curl "https://<base-url>/perfect-questions/{perfect_questions}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "perfect_questions"="685" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/perfect-questions/{perfect_questions}",
    "method": "GET",
    "data": {
        "perfect_questions": 685
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET perfect-questions/{perfect_questions}

HEAD perfect-questions/{perfect_questions}

Parameters

Parameter	Type	Status	Description
perfect_questions	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/perfect-questions/{perfect_questions}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "perfect_questions"="1" \
    -d "question"="eaque" \
    -d "perfect_category_id"="1" \
    -d "order"="79021896" \
    -d "points"="79021896" \
    -d "product_id"="1" \
    -d "multiple_answers_allowed"="0" \
    -d "product_selection_allowed"="0" \
    -d "visible"="0" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/perfect-questions/{perfect_questions}",
    "method": "PUT",
    "data": {
        "perfect_questions": 1,
        "question": "eaque",
        "perfect_category_id": 1,
        "order": 79021896,
        "points": 79021896,
        "product_id": 1,
        "multiple_answers_allowed": "0",
        "product_selection_allowed": "0",
        "visible": "0"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT perfect-questions/{perfect_questions}

PATCH perfect-questions/{perfect_questions}

Parameters

Parameter	Type	Status	Description
perfect_questions	numeric	required	Must have a length between 1 and 11
question	string	optional	Maximum: 500
perfect_category_id	integer	optional	Valid perfect_category id
order	integer	optional	Minimum: 1
points	integer	optional	Minimum: 0
product_id	integer	optional	Valid product pro_id
multiple_answers_allowed	string	optional	0 or 1
product_selection_allowed	string	optional	0 or 1
visible	string	optional	0 or 1

Delete

Example request:

curl "https://<base-url>/perfect-questions/{perfect_questions}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/perfect-questions/{perfect_questions}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE perfect-questions/{perfect_questions}

Price-Types

Retrieve multiple

Example request:

curl "https://<base-url>/price-types" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="316804243" \
    -d "per_page"="147" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/price-types",
    "method": "GET",
    "data": {
        "page": 316804243,
        "per_page": 147,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET price-types

HEAD price-types

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/price-types" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "pct_name"="saepe" \
    -d "pct_order"="270224428" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/price-types",
    "method": "POST",
    "data": {
        "pct_name": "saepe",
        "pct_order": 270224428
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST price-types

Parameters

Parameter	Type	Status	Description
pct_name	string	required	Maximum: 255
pct_order	integer	required

Retrieve

Example request:

curl "https://<base-url>/price-types/{price_types}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "price_types"="6" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/price-types/{price_types}",
    "method": "GET",
    "data": {
        "price_types": 6
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET price-types/{price_types}

HEAD price-types/{price_types}

Parameters

Parameter	Type	Status	Description
price_types	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/price-types/{price_types}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "price_types"="1" \
    -d "pct_name"="vitae" \
    -d "pct_order"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/price-types/{price_types}",
    "method": "PUT",
    "data": {
        "price_types": 1,
        "pct_name": "vitae",
        "pct_order": 1
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT price-types/{price_types}

PATCH price-types/{price_types}

Parameters

Parameter	Type	Status	Description
price_types	numeric	required	Must have a length between 1 and 11
pct_name	string	optional	Maximum: 255
pct_order	integer	optional

Delete

Example request:

curl "https://<base-url>/price-types/{price_types}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/price-types/{price_types}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE price-types/{price_types}

Product-Pricings

Retrieve multiple

Example request:

curl "https://<base-url>/product-pricings" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="905175998" \
    -d "per_page"="421" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-pricings",
    "method": "GET",
    "data": {
        "page": 905175998,
        "per_page": 421,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET product-pricings

HEAD product-pricings

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/product-pricings" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "prp_price"="3572" \
    -d "pro_id"="3572" \
    -d "pct_id"="3572" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-pricings",
    "method": "POST",
    "data": {
        "prp_price": 3572,
        "pro_id": 3572,
        "pct_id": 3572
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST product-pricings

Parameters

Parameter	Type	Status	Description
prp_price	numeric	required
pro_id	integer	required	Valid product pro_id
pct_id	integer	required	Valid price_type pct_id

Retrieve

Example request:

curl "https://<base-url>/product-pricings/{product_pricings}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "product_pricings"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-pricings/{product_pricings}",
    "method": "GET",
    "data": {
        "product_pricings": 1
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET product-pricings/{product_pricings}

HEAD product-pricings/{product_pricings}

Parameters

Parameter	Type	Status	Description
product_pricings	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/product-pricings/{product_pricings}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "product_pricings"="702237294" \
    -d "prp_price"="702237294" \
    -d "pro_id"="702237294" \
    -d "pct_id"="702237294" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-pricings/{product_pricings}",
    "method": "PUT",
    "data": {
        "product_pricings": 702237294,
        "prp_price": 702237294,
        "pro_id": 702237294,
        "pct_id": 702237294
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT product-pricings/{product_pricings}

PATCH product-pricings/{product_pricings}

Parameters

Parameter	Type	Status	Description
product_pricings	numeric	required	Must have a length between 1 and 11
prp_price	numeric	optional
pro_id	integer	optional	Valid product pro_id
pct_id	integer	optional	Valid price_type pct_id

Delete

Example request:

curl "https://<base-url>/product-pricings/{product_pricings}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-pricings/{product_pricings}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE product-pricings/{product_pricings}

Product-States

Retrieve multiple

Example request:

curl "https://<base-url>/product-states" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1577823837" \
    -d "per_page"="735" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-states",
    "method": "GET",
    "data": {
        "page": 1577823837,
        "per_page": 735,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET product-states

HEAD product-states

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/product-states" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "pro_id"="721" \
    -d "sta_name"="ad" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-states",
    "method": "POST",
    "data": {
        "pro_id": 721,
        "sta_name": "ad"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST product-states

Parameters

Parameter	Type	Status	Description
pro_id	numeric	required	Must have a length between 1 and 11 Valid product pro_id
sta_name	string	required	Valid state sta_name

Retrieve

Example request:

curl "https://<base-url>/product-states/product/{product}/state/{state}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "product"="778617277" \
    -d "state"="eveniet" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-states/product/{product}/state/{state}",
    "method": "GET",
    "data": {
        "product": 778617277,
        "state": "eveniet"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET product-states/product/{product}/state/{state}

HEAD product-states/product/{product}/state/{state}

Parameters

Parameter	Type	Status	Description
product	numeric	required	Must have a length between 1 and 11 Valid product pro_id
state	string	required	Valid state sta_name

Retrieve by product

Example request:

curl "https://<base-url>/product-states/product/{product}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "product"="5264" \
    -d "page"="768350837" \
    -d "per_page"="358" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-states/product/{product}",
    "method": "GET",
    "data": {
        "product": 5264,
        "page": 768350837,
        "per_page": 358,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET product-states/product/{product}

HEAD product-states/product/{product}

Parameters

Parameter	Type	Status	Description
product	numeric	required	Must have a length between 1 and 11 Valid product pro_id
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve by state

Example request:

curl "https://<base-url>/product-states/state/{state}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "state"="eum" \
    -d "page"="825034838" \
    -d "per_page"="384" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-states/state/{state}",
    "method": "GET",
    "data": {
        "state": "eum",
        "page": 825034838,
        "per_page": 384,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET product-states/state/{state}

HEAD product-states/state/{state}

Parameters

Parameter	Type	Status	Description
state	string	required	Valid state sta_name
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Update

Example request:

curl "https://<base-url>/product-states/product/{product}/state/{state}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "product"="197" \
    -d "state"="ea" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-states/product/{product}/state/{state}",
    "method": "PUT",
    "data": {
        "product": 197,
        "state": "ea"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT product-states/product/{product}/state/{state}

Parameters

Parameter	Type	Status	Description
product	numeric	required	Must have a length between 1 and 11 Valid product pro_id
state	string	required	Valid state sta_name

Delete

Example request:

curl "https://<base-url>/product-states/product/{product}/state/{state}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-states/product/{product}/state/{state}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE product-states/product/{product}/state/{state}

Product-Unit-Of-Measures

Retrieve multiple

Example request:

curl "https://<base-url>/product-unit-of-measures" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="916232549" \
    -d "per_page"="427" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-unit-of-measures",
    "method": "GET",
    "data": {
        "page": 916232549,
        "per_page": 427,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET product-unit-of-measures

HEAD product-unit-of-measures

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/product-unit-of-measures" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "name"="accusantium" \
    -d "description"="accusantium" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-unit-of-measures",
    "method": "POST",
    "data": {
        "name": "accusantium",
        "description": "accusantium"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST product-unit-of-measures

Parameters

Parameter	Type	Status	Description
name	string	required	Maximum: 20
description	string	optional	Maximum: 255

Retrieve

Example request:

curl "https://<base-url>/product-unit-of-measures/{product_unit_of_measures}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "product_unit_of_measures"="2040400" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-unit-of-measures/{product_unit_of_measures}",
    "method": "GET",
    "data": {
        "product_unit_of_measures": 2040400
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET product-unit-of-measures/{product_unit_of_measures}

HEAD product-unit-of-measures/{product_unit_of_measures}

Parameters

Parameter	Type	Status	Description
product_unit_of_measures	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/product-unit-of-measures/{product_unit_of_measures}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "product_unit_of_measures"="844888787" \
    -d "name"="hic" \
    -d "description"="hic" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-unit-of-measures/{product_unit_of_measures}",
    "method": "PUT",
    "data": {
        "product_unit_of_measures": 844888787,
        "name": "hic",
        "description": "hic"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT product-unit-of-measures/{product_unit_of_measures}

PATCH product-unit-of-measures/{product_unit_of_measures}

Parameters

Parameter	Type	Status	Description
product_unit_of_measures	numeric	required	Must have a length between 1 and 11
name	string	required	Maximum: 20
description	string	optional	Maximum: 255

Delete

Example request:

curl "https://<base-url>/product-unit-of-measures/{product_unit_of_measures}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/product-unit-of-measures/{product_unit_of_measures}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE product-unit-of-measures/{product_unit_of_measures}

Products

Update multiple

Example request:

curl "https://<base-url>/products" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "upsert"="1" \
    -d "product"="modi" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/products",
    "method": "PUT",
    "data": {
        "upsert": "1",
        "product": "modi"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT products

Parameters

Parameter	Type	Status	Description
upsert	string	required	1 or 0
product	array	required	Minimum: 1 Maximum: 50

Retrieve multiple

Example request:

curl "https://<base-url>/products" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1206782538" \
    -d "per_page"="562" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/products",
    "method": "GET",
    "data": {
        "page": 1206782538,
        "per_page": 562,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET products

HEAD products

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/products" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "pro_description"="dolor" \
    -d "pro_short_name"="dolor" \
    -d "pro_order_value"="dolor" \
    -d "pro_order"="32672112" \
    -d "pro_additional_information_1"="dolor" \
    -d "pro_additional_information_2"="dolor" \
    -d "pro_additional_information_3"="dolor" \
    -d "pro_additional_information_4"="dolor" \
    -d "pro_additional_information_5"="dolor" \
    -d "pro_additional_information_6"="dolor" \
    -d "pro_additional_information_7"="dolor" \
    -d "pro_additional_information_8"="dolor" \
    -d "pro_additional_information_9"="dolor" \
    -d "pro_additional_information_10"="dolor" \
    -d "pro_simtac"="false" \
    -d "bnd_id"="32672112" \
    -d "siz_name"="dolor" \
    -d "tap_id"="32672112" \
    -d "tac_id"="32672112" \
    -d "is_active"="0" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/products",
    "method": "POST",
    "data": {
        "pro_description": "dolor",
        "pro_short_name": "dolor",
        "pro_order_value": "dolor",
        "pro_order": 32672112,
        "pro_additional_information_1": "dolor",
        "pro_additional_information_2": "dolor",
        "pro_additional_information_3": "dolor",
        "pro_additional_information_4": "dolor",
        "pro_additional_information_5": "dolor",
        "pro_additional_information_6": "dolor",
        "pro_additional_information_7": "dolor",
        "pro_additional_information_8": "dolor",
        "pro_additional_information_9": "dolor",
        "pro_additional_information_10": "dolor",
        "pro_simtac": "false",
        "bnd_id": 32672112,
        "siz_name": "dolor",
        "tap_id": 32672112,
        "tac_id": 32672112,
        "is_active": "0"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST products

Parameters

Parameter	Type	Status	Description
pro_description	string	required	Maximum: 50
pro_short_name	string	required	Maximum: 100
pro_order_value	string	optional	Maximum: 255
pro_order	integer	optional
pro_additional_information_1	string	optional	Maximum: 255
pro_additional_information_2	string	optional	Maximum: 255
pro_additional_information_3	string	optional	Maximum: 255
pro_additional_information_4	string	optional	Maximum: 255
pro_additional_information_5	string	optional	Maximum: 255
pro_additional_information_6	string	optional	Maximum: 255
pro_additional_information_7	string	optional	Maximum: 255
pro_additional_information_8	string	optional	Maximum: 255
pro_additional_information_9	string	optional	Maximum: 255
pro_additional_information_10	string	optional	Maximum: 255
pro_simtac	string	required	true or false
bnd_id	integer	required	Valid brand bnd_id
siz_name	string	required	Valid size siz_name
tap_id	integer	required	Valid tap tap_id
tac_id	integer	required	Valid tap_category tac_id
is_active	string	optional	1 or 0

Retrieve

Example request:

curl "https://<base-url>/products/{products}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "products"="704" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/products/{products}",
    "method": "GET",
    "data": {
        "products": 704
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET products/{products}

HEAD products/{products}

Parameters

Parameter	Type	Status	Description
products	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/products/{products}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "products"="7" \
    -d "pro_description"="ab" \
    -d "pro_short_name"="ab" \
    -d "pro_order_value"="ab" \
    -d "pro_order"="7" \
    -d "pro_additional_information_1"="ab" \
    -d "pro_additional_information_2"="ab" \
    -d "pro_additional_information_3"="ab" \
    -d "pro_additional_information_4"="ab" \
    -d "pro_additional_information_5"="ab" \
    -d "pro_additional_information_6"="ab" \
    -d "pro_additional_information_7"="ab" \
    -d "pro_additional_information_8"="ab" \
    -d "pro_additional_information_9"="ab" \
    -d "pro_additional_information_10"="ab" \
    -d "pro_simtac"="true" \
    -d "bnd_id"="7" \
    -d "siz_name"="ab" \
    -d "tap_id"="7" \
    -d "tac_id"="7" \
    -d "is_active"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/products/{products}",
    "method": "PUT",
    "data": {
        "products": 7,
        "pro_description": "ab",
        "pro_short_name": "ab",
        "pro_order_value": "ab",
        "pro_order": 7,
        "pro_additional_information_1": "ab",
        "pro_additional_information_2": "ab",
        "pro_additional_information_3": "ab",
        "pro_additional_information_4": "ab",
        "pro_additional_information_5": "ab",
        "pro_additional_information_6": "ab",
        "pro_additional_information_7": "ab",
        "pro_additional_information_8": "ab",
        "pro_additional_information_9": "ab",
        "pro_additional_information_10": "ab",
        "pro_simtac": "true",
        "bnd_id": 7,
        "siz_name": "ab",
        "tap_id": 7,
        "tac_id": 7,
        "is_active": "1"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT products/{products}

PATCH products/{products}

Parameters

Parameter	Type	Status	Description
products	numeric	required	Must have a length between 1 and 11
pro_description	string	optional	Maximum: 50
pro_short_name	string	optional	Maximum: 100
pro_order_value	string	optional	Maximum: 255
pro_order	integer	optional
pro_additional_information_1	string	optional	Maximum: 255
pro_additional_information_2	string	optional	Maximum: 255
pro_additional_information_3	string	optional	Maximum: 255
pro_additional_information_4	string	optional	Maximum: 255
pro_additional_information_5	string	optional	Maximum: 255
pro_additional_information_6	string	optional	Maximum: 255
pro_additional_information_7	string	optional	Maximum: 255
pro_additional_information_8	string	optional	Maximum: 255
pro_additional_information_9	string	optional	Maximum: 255
pro_additional_information_10	string	optional	Maximum: 255
pro_simtac	string	optional	true or false
bnd_id	integer	required	Valid brand bnd_id
siz_name	string	required	Valid size siz_name
tap_id	integer	required	Valid tap tap_id
tac_id	integer	required	Valid tap_category tac_id
is_active	string	optional	1 or 0

Promo

Retrieve

Example request:

curl "https://<base-url>/promo-selected-type/{promo}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1289717784" \
    -d "per_page"="601" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promo-selected-type/{promo}",
    "method": "GET",
    "data": {
        "page": 1289717784,
        "per_page": 601,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET promo-selected-type/{promo}

HEAD promo-selected-type/{promo}

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve multiple

Example request:

curl "https://<base-url>/promo" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1512878184" \
    -d "per_page"="705" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promo",
    "method": "GET",
    "data": {
        "page": 1512878184,
        "per_page": 705,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET promo

HEAD promo

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/promo" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "prm_id"="8" \
    -d "prm_start_date"="modi" \
    -d "prm_end_date"="modi" \
    -d "prm_type"="8" \
    -d "prm_note"="modi" \
    -d "act_id"="8" \
    -d "bnd_id"="8" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promo",
    "method": "POST",
    "data": {
        "prm_id": 8,
        "prm_start_date": "modi",
        "prm_end_date": "modi",
        "prm_type": 8,
        "prm_note": "modi",
        "act_id": 8,
        "bnd_id": 8
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST promo

Parameters

Parameter	Type	Status	Description
prm_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
prm_start_date	string	optional	Maximum: 255
prm_end_date	string	optional	Maximum: 255
prm_type	string	optional	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid brand bnd_id
prm_note	string	optional	Maximum: 255
act_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
bnd_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid brand bnd_id

Retrieve

Example request:

curl "https://<base-url>/promo/{promo}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "promo"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promo/{promo}",
    "method": "GET",
    "data": {
        "promo": 1
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET promo/{promo}

HEAD promo/{promo}

Parameters

Parameter	Type	Status	Description
promo	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/promo/{promo}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "prm_id"="15" \
    -d "prm_start_date"="iure" \
    -d "prm_end_date"="iure" \
    -d "prm_type"="15" \
    -d "prm_note"="iure" \
    -d "act_id"="15" \
    -d "bnd_id"="15" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promo/{promo}",
    "method": "PUT",
    "data": {
        "prm_id": 15,
        "prm_start_date": "iure",
        "prm_end_date": "iure",
        "prm_type": 15,
        "prm_note": "iure",
        "act_id": 15,
        "bnd_id": 15
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT promo/{promo}

PATCH promo/{promo}

Parameters

Parameter	Type	Status	Description
prm_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
prm_start_date	string	optional	Maximum: 255
prm_end_date	string	optional	Maximum: 255
prm_type	string	optional	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid brand bnd_id
prm_note	string	optional	Maximum: 255
act_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid account act_id
bnd_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid brand bnd_id

Retrieve multiple

Example request:

curl "https://<base-url>/promo-selected-type" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="124757764" \
    -d "per_page"="58" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promo-selected-type",
    "method": "GET",
    "data": {
        "page": 124757764,
        "per_page": 58,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET promo-selected-type

HEAD promo-selected-type

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve

Example request:

curl "https://<base-url>/promo-selected-type/{promo_selected_type}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "promo_selected_type"="27" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promo-selected-type/{promo_selected_type}",
    "method": "GET",
    "data": {
        "promo_selected_type": 27
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET promo-selected-type/{promo_selected_type}

HEAD promo-selected-type/{promo_selected_type}

Parameters

Parameter	Type	Status	Description
promo_selected_type	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Promo-Photos

Retrieve multiple

Example request:

curl "https://<base-url>/promo-photos" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="934354335" \
    -d "per_page"="435" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promo-photos",
    "method": "GET",
    "data": {
        "page": 934354335,
        "per_page": 435,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET promo-photos

HEAD promo-photos

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/promo-photos" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "prm_id"="36" \
    -d "usr_id"="voluptatibus" \
    -d "url"="voluptatibus" \
    -d "name"="voluptatibus" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promo-photos",
    "method": "POST",
    "data": {
        "prm_id": 36,
        "usr_id": "voluptatibus",
        "url": "voluptatibus",
        "name": "voluptatibus"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST promo-photos

Parameters

Parameter	Type	Status	Description
prm_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid promo prm_id
usr_id	string	required	Valid user usr_id
url	string	required
name	string	required	Maximum: 255

Retrieve

Example request:

curl "https://<base-url>/promo-photos/{promo_photos}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "promo_photos"="10" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promo-photos/{promo_photos}",
    "method": "GET",
    "data": {
        "promo_photos": 10
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET promo-photos/{promo_photos}

HEAD promo-photos/{promo_photos}

Parameters

Parameter	Type	Status	Description
promo_photos	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/promo-photos/{promo_photos}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "id"="30" \
    -d "prm_id"="30" \
    -d "usr_id"="30" \
    -d "url"="dolorem" \
    -d "name"="dolorem" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promo-photos/{promo_photos}",
    "method": "PUT",
    "data": {
        "id": 30,
        "prm_id": 30,
        "usr_id": 30,
        "url": "dolorem",
        "name": "dolorem"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT promo-photos/{promo_photos}

PATCH promo-photos/{promo_photos}

Parameters

Parameter	Type	Status	Description
id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
prm_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid promo prm_id
usr_id	string	required	Between: 1 and 36 Valid user usr_id
url	string	required
name	string	required	Maximum: 255

Promotional-Activities

Retrieve by group

Example request:

curl "https://<base-url>/promotional-activities/group/{group}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "group"="86" \
    -d "page"="333561689" \
    -d "per_page"="155" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promotional-activities/group/{group}",
    "method": "GET",
    "data": {
        "group": 86,
        "page": 333561689,
        "per_page": 155,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET promotional-activities/group/{group}

HEAD promotional-activities/group/{group}

Parameters

Parameter	Type	Status	Description
group	numeric	required	Must have a length between 1 and 11 Valid promotional pml_group_id
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve multiple

Example request:

curl "https://<base-url>/promotional-activities" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="927088106" \
    -d "per_page"="432" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promotional-activities",
    "method": "GET",
    "data": {
        "page": 927088106,
        "per_page": 432,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET promotional-activities

HEAD promotional-activities

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/promotional-activities" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "pml_group_id"="41643369" \
    -d "pml_activity"="qui" \
    -d "pml_buy_start_date"="2025:07:10" \
    -d "pml_buy_end_date"="2025:07:10" \
    -d "pml_sell_start_date"="2025:07:10" \
    -d "pml_sell_end_date"="2025:07:10" \
    -d "pml_discount"="41643369" \
    -d "pml_luc"="41643369" \
    -d "pml_rrp"="41643369" \
    -d "pml_valid"="0" \
    -d "pml_free_form"="qui" \
    -d "pml_note"="qui" \
    -d "sta_name"="qui" \
    -d "act_id"="qui" \
    -d "ban_id"="qui" \
    -d "osg_id"="qui" \
    -d "who_id"="qui" \
    -d "pro_id"="41643369" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promotional-activities",
    "method": "POST",
    "data": {
        "pml_group_id": 41643369,
        "pml_activity": "qui",
        "pml_buy_start_date": "2025:07:10",
        "pml_buy_end_date": "2025:07:10",
        "pml_sell_start_date": "2025:07:10",
        "pml_sell_end_date": "2025:07:10",
        "pml_discount": 41643369,
        "pml_luc": 41643369,
        "pml_rrp": 41643369,
        "pml_valid": "0",
        "pml_free_form": "qui",
        "pml_note": "qui",
        "sta_name": "qui",
        "act_id": "qui",
        "ban_id": "qui",
        "osg_id": "qui",
        "who_id": "qui",
        "pro_id": 41643369
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST promotional-activities

Parameters

Parameter	Type	Status	Description
pml_group_id	integer	optional
pml_activity	string	required	Valid activity_name pml_activity
pml_buy_start_date	date	required	Date format: Y:m:d
pml_buy_end_date	date	required	Date format: Y:m:d
pml_sell_start_date	date	required	Date format: Y:m:d
pml_sell_end_date	date	required	Date format: Y:m:d
pml_discount	numeric	required
pml_luc	numeric	required
pml_rrp	numeric	required
pml_valid	string	required	1 or 0
pml_free_form	string	required	Maximum: 255
pml_note	string	required	Maximum: 50
sta_name	string	required	Valid state sta_name
act_id	string	required	Valid account act_id
ban_id	string	required	Valid banner ban_id
osg_id	string	required	Valid ownership_group osg_id
who_id	string	required	Valid wholesaler who_id
pro_id	integer	optional	Valid product pro_id

Retrieve

Example request:

curl "https://<base-url>/promotional-activities/{promotional_activities}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "promotional_activities"="35" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promotional-activities/{promotional_activities}",
    "method": "GET",
    "data": {
        "promotional_activities": 35
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET promotional-activities/{promotional_activities}

HEAD promotional-activities/{promotional_activities}

Parameters

Parameter	Type	Status	Description
promotional_activities	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/promotional-activities/{promotional_activities}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "promotional_activities"="13" \
    -d "pml_group_id"="8083" \
    -d "pml_activity"="aliquid" \
    -d "pml_buy_start_date"="2025:07:10" \
    -d "pml_buy_end_date"="2025:07:10" \
    -d "pml_sell_start_date"="2025:07:10" \
    -d "pml_sell_end_date"="2025:07:10" \
    -d "pml_discount"="8083" \
    -d "pml_luc"="8083" \
    -d "pml_rrp"="8083" \
    -d "pml_valid"="1" \
    -d "pml_free_form"="aliquid" \
    -d "pml_note"="aliquid" \
    -d "sta_name"="aliquid" \
    -d "act_id"="aliquid" \
    -d "ban_id"="aliquid" \
    -d "osg_id"="aliquid" \
    -d "who_id"="aliquid" \
    -d "pro_id"="8083" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promotional-activities/{promotional_activities}",
    "method": "PUT",
    "data": {
        "promotional_activities": 13,
        "pml_group_id": 8083,
        "pml_activity": "aliquid",
        "pml_buy_start_date": "2025:07:10",
        "pml_buy_end_date": "2025:07:10",
        "pml_sell_start_date": "2025:07:10",
        "pml_sell_end_date": "2025:07:10",
        "pml_discount": 8083,
        "pml_luc": 8083,
        "pml_rrp": 8083,
        "pml_valid": "1",
        "pml_free_form": "aliquid",
        "pml_note": "aliquid",
        "sta_name": "aliquid",
        "act_id": "aliquid",
        "ban_id": "aliquid",
        "osg_id": "aliquid",
        "who_id": "aliquid",
        "pro_id": 8083
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT promotional-activities/{promotional_activities}

PATCH promotional-activities/{promotional_activities}

Parameters

Parameter	Type	Status	Description
promotional_activities	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
pml_group_id	integer	optional
pml_activity	string	required	Valid activity_name pml_activity
pml_buy_start_date	date	required	Date format: Y:m:d
pml_buy_end_date	date	required	Date format: Y:m:d
pml_sell_start_date	date	required	Date format: Y:m:d
pml_sell_end_date	date	required	Date format: Y:m:d
pml_discount	numeric	required
pml_luc	numeric	required
pml_rrp	numeric	required
pml_valid	string	required	1 or 0
pml_free_form	string	required	Maximum: 255
pml_note	string	required	Maximum: 50
sta_name	string	required	Valid state sta_name
act_id	string	required	Valid account act_id
ban_id	string	required	Valid banner ban_id
osg_id	string	required	Valid ownership_group osg_id
who_id	string	required	Valid wholesaler who_id
pro_id	integer	optional	Valid product pro_id

Delete

Example request:

curl "https://<base-url>/promotional-activities/{promotional_activities}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promotional-activities/{promotional_activities}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE promotional-activities/{promotional_activities}

Promotional-Activity-Names

Retrieve multiple

Example request:

curl "https://<base-url>/promotional-activity-names" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="315561932" \
    -d "per_page"="147" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promotional-activity-names",
    "method": "GET",
    "data": {
        "page": 315561932,
        "per_page": 147,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET promotional-activity-names

HEAD promotional-activity-names

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/promotional-activity-names" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "pml_activity"="praesentium" \
    -d "acn_name"="praesentium" \
    -d "activity_type"="praesentium" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promotional-activity-names",
    "method": "POST",
    "data": {
        "pml_activity": "praesentium",
        "acn_name": "praesentium",
        "activity_type": "praesentium"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST promotional-activity-names

Parameters

Parameter	Type	Status	Description
pml_activity	string	required	Maximum: 20
acn_name	string	required	Maximum: 255
activity_type	string	required	Valid activity_type id

Retrieve

Example request:

curl "https://<base-url>/promotional-activity-names/{promotional_activity_names}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "promotional_activity_names"="velit" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promotional-activity-names/{promotional_activity_names}",
    "method": "GET",
    "data": {
        "promotional_activity_names": "velit"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET promotional-activity-names/{promotional_activity_names}

HEAD promotional-activity-names/{promotional_activity_names}

Parameters

Parameter	Type	Status	Description
promotional_activity_names	string	required	Maximum: 20

Update

Example request:

curl "https://<base-url>/promotional-activity-names/{promotional_activity_names}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "promotional_activity_names"="molestiae" \
    -d "acn_name"="molestiae" \
    -d "activity_type"="molestiae" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promotional-activity-names/{promotional_activity_names}",
    "method": "PUT",
    "data": {
        "promotional_activity_names": "molestiae",
        "acn_name": "molestiae",
        "activity_type": "molestiae"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT promotional-activity-names/{promotional_activity_names}

PATCH promotional-activity-names/{promotional_activity_names}

Parameters

Parameter	Type	Status	Description
promotional_activity_names	string	required	Maximum: 20
acn_name	string	required	Maximum: 255
activity_type	string	required	Valid activity_type id

Delete

Example request:

curl "https://<base-url>/promotional-activity-names/{promotional_activity_names}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promotional-activity-names/{promotional_activity_names}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE promotional-activity-names/{promotional_activity_names}

Promotional-Activity-Types

Retrieve multiple

Example request:

curl "https://<base-url>/promotional-activity-types" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1951630163" \
    -d "per_page"="909" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promotional-activity-types",
    "method": "GET",
    "data": {
        "page": 1951630163,
        "per_page": 909,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET promotional-activity-types

HEAD promotional-activity-types

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/promotional-activity-types" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "type"="officia" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promotional-activity-types",
    "method": "POST",
    "data": {
        "type": "officia"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST promotional-activity-types

Parameters

Parameter	Type	Status	Description
type	string	required	Maximum: 255

Retrieve

Example request:

curl "https://<base-url>/promotional-activity-types/{promotional_activity_types}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "promotional_activity_types"="214" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promotional-activity-types/{promotional_activity_types}",
    "method": "GET",
    "data": {
        "promotional_activity_types": 214
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET promotional-activity-types/{promotional_activity_types}

HEAD promotional-activity-types/{promotional_activity_types}

Parameters

Parameter	Type	Status	Description
promotional_activity_types	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/promotional-activity-types/{promotional_activity_types}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "promotional_activity_types"="63444" \
    -d "type"="voluptatum" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promotional-activity-types/{promotional_activity_types}",
    "method": "PUT",
    "data": {
        "promotional_activity_types": 63444,
        "type": "voluptatum"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT promotional-activity-types/{promotional_activity_types}

PATCH promotional-activity-types/{promotional_activity_types}

Parameters

Parameter	Type	Status	Description
promotional_activity_types	numeric	required	Must have a length between 1 and 11
type	string	required	Maximum: 255

Delete

Example request:

curl "https://<base-url>/promotional-activity-types/{promotional_activity_types}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/promotional-activity-types/{promotional_activity_types}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE promotional-activity-types/{promotional_activity_types}

Questions

Retrieve multiple

Example request:

curl "https://<base-url>/questions" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1239198774" \
    -d "per_page"="577" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/questions",
    "method": "GET",
    "data": {
        "page": 1239198774,
        "per_page": 577,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET questions

HEAD questions

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/questions" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "reference_id_1"="fugiat" \
    -d "reference_id_2"="fugiat" \
    -d "question"="fugiat" \
    -d "premise_type"="2" \
    -d "response_type"="3" \
    -d "visible"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/questions",
    "method": "POST",
    "data": {
        "reference_id_1": "fugiat",
        "reference_id_2": "fugiat",
        "question": "fugiat",
        "premise_type": "2",
        "response_type": "3",
        "visible": "1"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST questions

Parameters

Parameter	Type	Status	Description
reference_id_1	string	optional	Maximum: 255
reference_id_2	string	optional	Maximum: 255
question	string	required	Maximum: 255
premise_type	string	required	1 or 2
response_type	string	required	1, 2 or 3
visible	string	required	0 or 1

questions/{questions}

Example request:

curl "https://<base-url>/questions/{questions}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "questions"="29" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/questions/{questions}",
    "method": "GET",
    "data": {
        "questions": 29
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET questions/{questions}

HEAD questions/{questions}

Parameters

Parameter	Type	Status	Description
questions	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/questions/{questions}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "questions"="2469" \
    -d "reference_id_1"="iure" \
    -d "reference_id_2"="iure" \
    -d "question"="iure" \
    -d "premise_type"="1" \
    -d "response_type"="2" \
    -d "visible"="0" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/questions/{questions}",
    "method": "PUT",
    "data": {
        "questions": 2469,
        "reference_id_1": "iure",
        "reference_id_2": "iure",
        "question": "iure",
        "premise_type": "1",
        "response_type": "2",
        "visible": "0"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT questions/{questions}

PATCH questions/{questions}

Parameters

Parameter	Type	Status	Description
questions	numeric	required	Must have a length between 1 and 11
reference_id_1	string	optional	Maximum: 255
reference_id_2	string	optional	Maximum: 255
question	string	required	Maximum: 255
premise_type	string	required	1 or 2
response_type	string	required	1, 2 or 3
visible	string	required	0 or 1

Delete

Example request:

curl "https://<base-url>/questions/{questions}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/questions/{questions}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE questions/{questions}

Sales

Update multiple

Example request:

curl "https://<base-url>/sales" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sales",
    "method": "PUT",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT sales

Retrieve multiple

Example request:

curl "https://<base-url>/sales" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="181668631" \
    -d "per_page"="84" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sales",
    "method": "GET",
    "data": {
        "page": 181668631,
        "per_page": 84,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET sales

HEAD sales

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/sales" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account_id"="numquam" \
    -d "product_id"="numquam" \
    -d "field"="numquam" \
    -d "value"="numquam" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sales",
    "method": "POST",
    "data": {
        "account_id": "numquam",
        "product_id": "numquam",
        "field": "numquam",
        "value": "numquam"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST sales

Parameters

Parameter	Type	Status	Description
account_id	string	required	Maximum: 45 Valid account act_id
product_id	string	required	Maximum: 45 Valid product pro_id
field	string	optional	Maximum: 45
value	string	optional	Maximum: 45

Retrieve

Example request:

curl "https://<base-url>/sales/{sales}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "sales"="8" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sales/{sales}",
    "method": "GET",
    "data": {
        "sales": 8
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET sales/{sales}

HEAD sales/{sales}

Parameters

Parameter	Type	Status	Description
sales	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/sales/{sales}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "sales"="788" \
    -d "account_id"="ut" \
    -d "product_id"="ut" \
    -d "field"="ut" \
    -d "value"="ut" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sales/{sales}",
    "method": "PUT",
    "data": {
        "sales": 788,
        "account_id": "ut",
        "product_id": "ut",
        "field": "ut",
        "value": "ut"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT sales/{sales}

PATCH sales/{sales}

Parameters

Parameter	Type	Status	Description
sales	numeric	required	Must have a length between 1 and 11
account_id	string	optional	Maximum: 45 Valid account act_id
product_id	string	optional	Maximum: 45 Valid product pro_id
field	string	optional	Maximum: 45
value	string	optional	Maximum: 45

Delete

Example request:

curl "https://<base-url>/sales/{sales}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sales/{sales}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE sales/{sales}

Sales-Data

Update multiple

Example request:

curl "https://<base-url>/sales-data" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "upsert"="1" \
    -d "sales[0][sad_this_month]"="Value" \
    -d "sales[0][sad_prior_month]"="Value" \
    -d "sales[0][sad_this_month_vary]"="Value" \
    -d "sales[0][sad_MQT]"="Value" \
    -d "sales[0][sad_prior_MQT]"="Value" \
    -d "sales[0][sad_MQT_vary]"="Value" \
    -d "sales[0][sad_MAT]"="Value" \
    -d "sales[0][sad_prior_MAT]"="Value" \
    -d "sales[0][sad_MAT_vary]"="Value" \
    -d "sales[0][sad_order]"="Value" \
    -d "sales[0][act_id]"="10" \
    -d "sales[0][pro_id]"="11" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sales-data",
    "method": "PUT",
    "data": {
        "upsert": "1"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT sales-data

Parameters

Parameter	Type	Status	Description
upsert	string	required	1 or 0

Retrieve multiple

Example request:

curl "https://<base-url>/sales-data" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1863382803" \
    -d "per_page"="868" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sales-data",
    "method": "GET",
    "data": {
        "page": 1863382803,
        "per_page": 868,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET sales-data

HEAD sales-data

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/sales-data" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "sad_this_month"="repellendus" \
    -d "sad_prior_month"="repellendus" \
    -d "sad_this_month_vary"="repellendus" \
    -d "sad_MQT"="repellendus" \
    -d "sad_prior_MQT"="repellendus" \
    -d "sad_MQT_vary"="repellendus" \
    -d "sad_MAT"="repellendus" \
    -d "sad_prior_MAT"="repellendus" \
    -d "sad_MAT_vary"="repellendus" \
    -d "sad_order"="86847937" \
    -d "act_id"="repellendus" \
    -d "pro_id"="86847937" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sales-data",
    "method": "POST",
    "data": {
        "sad_this_month": "repellendus",
        "sad_prior_month": "repellendus",
        "sad_this_month_vary": "repellendus",
        "sad_MQT": "repellendus",
        "sad_prior_MQT": "repellendus",
        "sad_MQT_vary": "repellendus",
        "sad_MAT": "repellendus",
        "sad_prior_MAT": "repellendus",
        "sad_MAT_vary": "repellendus",
        "sad_order": 86847937,
        "act_id": "repellendus",
        "pro_id": 86847937
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST sales-data

Parameters

Parameter	Type	Status	Description
sad_this_month	string	optional	Maximum: 20
sad_prior_month	string	optional	Maximum: 20
sad_this_month_vary	string	optional	Maximum: 20
sad_MQT	string	optional	Maximum: 20
sad_prior_MQT	string	optional	Maximum: 20
sad_MQT_vary	string	optional	Maximum: 20
sad_MAT	string	optional	Maximum: 20
sad_prior_MAT	string	optional	Maximum: 20
sad_MAT_vary	string	optional	Maximum: 20
sad_order	integer	optional
act_id	string	required	Maximum: 36 Valid account act_id
pro_id	integer	required	Valid product pro_id

Retrieve

Example request:

curl "https://<base-url>/sales-data/{sales_data}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "sales_data"="889" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sales-data/{sales_data}",
    "method": "GET",
    "data": {
        "sales_data": 889
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET sales-data/{sales_data}

HEAD sales-data/{sales_data}

Parameters

Parameter	Type	Status	Description
sales_data	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/sales-data/{sales_data}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "sales_data"="1071774" \
    -d "sad_this_month"="possimus" \
    -d "sad_prior_month"="possimus" \
    -d "sad_this_month_vary"="possimus" \
    -d "sad_MQT"="possimus" \
    -d "sad_prior_MQT"="possimus" \
    -d "sad_MQT_vary"="possimus" \
    -d "sad_MAT"="possimus" \
    -d "sad_prior_MAT"="possimus" \
    -d "sad_MAT_vary"="possimus" \
    -d "sad_order"="1071774" \
    -d "act_id"="possimus" \
    -d "pro_id"="1071774" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sales-data/{sales_data}",
    "method": "PUT",
    "data": {
        "sales_data": 1071774,
        "sad_this_month": "possimus",
        "sad_prior_month": "possimus",
        "sad_this_month_vary": "possimus",
        "sad_MQT": "possimus",
        "sad_prior_MQT": "possimus",
        "sad_MQT_vary": "possimus",
        "sad_MAT": "possimus",
        "sad_prior_MAT": "possimus",
        "sad_MAT_vary": "possimus",
        "sad_order": 1071774,
        "act_id": "possimus",
        "pro_id": 1071774
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT sales-data/{sales_data}

PATCH sales-data/{sales_data}

Parameters

Parameter	Type	Status	Description
sales_data	numeric	required	Must have a length between 1 and 11
sad_this_month	string	optional	Maximum: 20
sad_prior_month	string	optional	Maximum: 20
sad_this_month_vary	string	optional	Maximum: 20
sad_MQT	string	optional	Maximum: 20
sad_prior_MQT	string	optional	Maximum: 20
sad_MQT_vary	string	optional	Maximum: 20
sad_MAT	string	optional	Maximum: 20
sad_prior_MAT	string	optional	Maximum: 20
sad_MAT_vary	string	optional	Maximum: 20
sad_order	integer	optional
act_id	string	optional	Maximum: 36 Valid account act_id
pro_id	integer	optional	Valid product pro_id

Delete

Example request:

curl "https://<base-url>/sales-data/{sales_data}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sales-data/{sales_data}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE sales-data/{sales_data}

Selling-Area-Categories

Retrieve multiple

Example request:

curl "https://<base-url>/selling-area-categories" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1585068939" \
    -d "per_page"="738" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/selling-area-categories",
    "method": "GET",
    "data": {
        "page": 1585068939,
        "per_page": 738,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET selling-area-categories

HEAD selling-area-categories

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/selling-area-categories" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "sac_name"="laboriosam" \
    -d "sac_parent_id"="785" \
    -d "sac_act_type"="ON" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/selling-area-categories",
    "method": "POST",
    "data": {
        "sac_name": "laboriosam",
        "sac_parent_id": 785,
        "sac_act_type": "ON"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST selling-area-categories

Parameters

Parameter	Type	Status	Description
sac_name	string	required	Maximum: 255
sac_parent_id	integer	required	Valid selling_area_category sac_id
sac_act_type	string	required	ON or OFF

Retrieve

Example request:

curl "https://<base-url>/selling-area-categories/{selling_area_categories}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "selling_area_categories"="42183098" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/selling-area-categories/{selling_area_categories}",
    "method": "GET",
    "data": {
        "selling_area_categories": 42183098
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET selling-area-categories/{selling_area_categories}

HEAD selling-area-categories/{selling_area_categories}

Parameters

Parameter	Type	Status	Description
selling_area_categories	numeric	required	Must have a length between 1 and 10

Update

Example request:

curl "https://<base-url>/selling-area-categories/{selling_area_categories}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "selling_area_categories"="4" \
    -d "sac_name"="consequatur" \
    -d "sac_parent_id"="4" \
    -d "sac_act_type"="ON" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/selling-area-categories/{selling_area_categories}",
    "method": "PUT",
    "data": {
        "selling_area_categories": 4,
        "sac_name": "consequatur",
        "sac_parent_id": 4,
        "sac_act_type": "ON"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT selling-area-categories/{selling_area_categories}

PATCH selling-area-categories/{selling_area_categories}

Parameters

Parameter	Type	Status	Description
selling_area_categories	numeric	required	Must have a length between 1 and 10
sac_name	string	optional	Maximum: 255
sac_parent_id	integer	optional	Valid selling_area_category sac_id
sac_act_type	string	optional	ON or OFF

Delete

Example request:

curl "https://<base-url>/selling-area-categories/{selling_area_categories}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/selling-area-categories/{selling_area_categories}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE selling-area-categories/{selling_area_categories}

Selling-Areas

Retrieve

Example request:

curl "https://<base-url>/selling-areas/account/{account}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="785391768" \
    -d "per_page"="366" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/selling-areas/account/{account}",
    "method": "GET",
    "data": {
        "page": 785391768,
        "per_page": 366,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET selling-areas/account/{account}

HEAD selling-areas/account/{account}

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve multiple

Example request:

curl "https://<base-url>/selling-areas" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="27593887" \
    -d "per_page"="12" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/selling-areas",
    "method": "GET",
    "data": {
        "page": 27593887,
        "per_page": 12,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET selling-areas

HEAD selling-areas

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/selling-areas" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "sea_note"="rerum" \
    -d "act_id"="rerum" \
    -d "sea_total_tap"="10" \
    -d "sea_area_position"="10" \
    -d "are_id"="30334521" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/selling-areas",
    "method": "POST",
    "data": {
        "sea_note": "rerum",
        "act_id": "rerum",
        "sea_total_tap": 10,
        "sea_area_position": 10,
        "are_id": 30334521
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST selling-areas

Parameters

Parameter	Type	Status	Description
sea_note	string	required
act_id	string	required	Valid account act_id
sea_total_tap	integer	required	Maximum: 11
sea_area_position	integer	required	Maximum: 11
are_id	integer	required	Valid area are_id

Retrieve

Example request:

curl "https://<base-url>/selling-areas/{selling_areas}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "selling_areas"="18" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/selling-areas/{selling_areas}",
    "method": "GET",
    "data": {
        "selling_areas": 18
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET selling-areas/{selling_areas}

HEAD selling-areas/{selling_areas}

Parameters

Parameter	Type	Status	Description
selling_areas	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/selling-areas/{selling_areas}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "selling_areas"="32" \
    -d "sea_note"="et" \
    -d "act_id"="et" \
    -d "sea_total_tap"="10" \
    -d "sea_area_position"="10" \
    -d "are_id"="24649928" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/selling-areas/{selling_areas}",
    "method": "PUT",
    "data": {
        "selling_areas": 32,
        "sea_note": "et",
        "act_id": "et",
        "sea_total_tap": 10,
        "sea_area_position": 10,
        "are_id": 24649928
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT selling-areas/{selling_areas}

PATCH selling-areas/{selling_areas}

Parameters

Parameter	Type	Status	Description
selling_areas	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
sea_note	string	optional
act_id	string	optional	Valid account act_id
sea_total_tap	integer	optional	Maximum: 11
sea_area_position	integer	optional	Maximum: 11
are_id	integer	optional	Valid area are_id

Delete

Example request:

curl "https://<base-url>/selling-areas/{selling_areas}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/selling-areas/{selling_areas}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE selling-areas/{selling_areas}

Sizes

Retrieve multiple

Example request:

curl "https://<base-url>/sizes" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1785400757" \
    -d "per_page"="832" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sizes",
    "method": "GET",
    "data": {
        "page": 1785400757,
        "per_page": 832,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET sizes

HEAD sizes

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/sizes" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "siz_name"="magni" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sizes",
    "method": "POST",
    "data": {
        "siz_name": "magni"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST sizes

Parameters

Parameter	Type	Status	Description
siz_name	string	required	Maximum: 40

Retrieve

Example request:

curl "https://<base-url>/sizes/{sizes}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "sizes"="822" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sizes/{sizes}",
    "method": "GET",
    "data": {
        "sizes": 822
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET sizes/{sizes}

HEAD sizes/{sizes}

Parameters

Parameter	Type	Status	Description
sizes	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/sizes/{sizes}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "siz_name"="magnam" \
    -d "sizes"="983" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sizes/{sizes}",
    "method": "PUT",
    "data": {
        "siz_name": "magnam",
        "sizes": 983
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT sizes/{sizes}

PATCH sizes/{sizes}

Parameters

Parameter	Type	Status	Description
siz_name	string	required	Maximum: 40
sizes	numeric	required	Must have a length between 1 and 11

Delete

Example request:

curl "https://<base-url>/sizes/{sizes}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sizes/{sizes}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE sizes/{sizes}

States

Retrieve multiple

Example request:

curl "https://<base-url>/states" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="434405110" \
    -d "per_page"="202" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/states",
    "method": "GET",
    "data": {
        "page": 434405110,
        "per_page": 202,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET states

HEAD states

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/states" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "sta_name"="totam" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/states",
    "method": "POST",
    "data": {
        "sta_name": "totam"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST states

Parameters

Parameter	Type	Status	Description
sta_name	string	required	Maximum: 3

Retrieve

Example request:

curl "https://<base-url>/states/{states}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "states"="708750169" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/states/{states}",
    "method": "GET",
    "data": {
        "states": 708750169
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET states/{states}

HEAD states/{states}

Parameters

Parameter	Type	Status	Description
states	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/states/{states}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "states"="623506568" \
    -d "sta_name"="asperiores" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/states/{states}",
    "method": "PUT",
    "data": {
        "states": 623506568,
        "sta_name": "asperiores"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT states/{states}

PATCH states/{states}

Parameters

Parameter	Type	Status	Description
states	numeric	required	Must have a length between 1 and 11
sta_name	string	required	Maximum: 3

Sub-Selection-Answers

Retrieve multiple

Example request:

curl "https://<base-url>/sub-selection-answers" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="592177885" \
    -d "per_page"="276" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sub-selection-answers",
    "method": "GET",
    "data": {
        "page": 592177885,
        "per_page": 276,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET sub-selection-answers

HEAD sub-selection-answers

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/sub-selection-answers" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "answer_id"="31" \
    -d "answer"="at" \
    -d "sub_answer_type"="2" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sub-selection-answers",
    "method": "POST",
    "data": {
        "answer_id": 31,
        "answer": "at",
        "sub_answer_type": "2"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST sub-selection-answers

Parameters

Parameter	Type	Status	Description
answer_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid answer id
answer	string	required	Maximum: 255
sub_answer_type	string	required	1 or 2

Retrieve

Example request:

curl "https://<base-url>/sub-selection-answers/{sub_selection_answers}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sub-selection-answers/{sub_selection_answers}",
    "method": "GET",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET sub-selection-answers/{sub_selection_answers}

HEAD sub-selection-answers/{sub_selection_answers}

Update

Example request:

curl "https://<base-url>/sub-selection-answers/{sub_selection_answers}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "sub-selection-answers"="25" \
    -d "answer_id"="25" \
    -d "answer"="cum" \
    -d "sub_answer_type"="2" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sub-selection-answers/{sub_selection_answers}",
    "method": "PUT",
    "data": {
        "sub-selection-answers": 25,
        "answer_id": 25,
        "answer": "cum",
        "sub_answer_type": "2"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT sub-selection-answers/{sub_selection_answers}

PATCH sub-selection-answers/{sub_selection_answers}

Parameters

Parameter	Type	Status	Description
sub-selection-answers	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
answer_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid answer id
answer	string	required	Maximum: 255
sub_answer_type	string	required	1 or 2

Delete

Example request:

curl "https://<base-url>/sub-selection-answers/{sub_selection_answers}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/sub-selection-answers/{sub_selection_answers}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE sub-selection-answers/{sub_selection_answers}

Tap-Categories

Retrieve multiple

Example request:

curl "https://<base-url>/tap-categories" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="910326542" \
    -d "per_page"="424" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/tap-categories",
    "method": "GET",
    "data": {
        "page": 910326542,
        "per_page": 424,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET tap-categories

HEAD tap-categories

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/tap-categories" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "tac_name"="id" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/tap-categories",
    "method": "POST",
    "data": {
        "tac_name": "id"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST tap-categories

Parameters

Parameter	Type	Status	Description
tac_name	string	required	Maximum: 40

Retrieve

Example request:

curl "https://<base-url>/tap-categories/{tap_categories}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "tap_categories"="789738" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/tap-categories/{tap_categories}",
    "method": "GET",
    "data": {
        "tap_categories": 789738
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET tap-categories/{tap_categories}

HEAD tap-categories/{tap_categories}

Parameters

Parameter	Type	Status	Description
tap_categories	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/tap-categories/{tap_categories}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "tap_categories"="4" \
    -d "tac_name"="inventore" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/tap-categories/{tap_categories}",
    "method": "PUT",
    "data": {
        "tap_categories": 4,
        "tac_name": "inventore"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT tap-categories/{tap_categories}

PATCH tap-categories/{tap_categories}

Parameters

Parameter	Type	Status	Description
tap_categories	numeric	required	Must have a length between 1 and 11
tac_name	string	required	Maximum: 255

Delete

Example request:

curl "https://<base-url>/tap-categories/{tap_categories}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/tap-categories/{tap_categories}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE tap-categories/{tap_categories}

Tap-Type

Retrieve multiple

Example request:

curl "https://<base-url>/tap-type" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="330118491" \
    -d "per_page"="153" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/tap-type",
    "method": "GET",
    "data": {
        "page": 330118491,
        "per_page": 153,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET tap-type

HEAD tap-type

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/tap-type" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "name"="in" \
    -d "tap_type_name_id"="232942" \
    -d "visible"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/tap-type",
    "method": "POST",
    "data": {
        "name": "in",
        "tap_type_name_id": 232942,
        "visible": true
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST tap-type

Parameters

Parameter	Type	Status	Description
name	string	required	Maximum: 1000
tap_type_name_id	integer	required	Valid tap_type_name id
visible	boolean	required

Retrieve

Example request:

curl "https://<base-url>/tap-type/{tap_type}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/tap-type/{tap_type}",
    "method": "GET",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET tap-type/{tap_type}

HEAD tap-type/{tap_type}

Update

Example request:

curl "https://<base-url>/tap-type/{tap_type}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "name"="commodi" \
    -d "tap_type_name_id"="6638" \
    -d "visible"="1" \
    -d "id"="commodi" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/tap-type/{tap_type}",
    "method": "PUT",
    "data": {
        "name": "commodi",
        "tap_type_name_id": 6638,
        "visible": true,
        "id": "commodi"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT tap-type/{tap_type}

PATCH tap-type/{tap_type}

Parameters

Parameter	Type	Status	Description
name	string	required	Maximum: 255
tap_type_name_id	integer	optional	Valid tap_type_name id
visible	boolean	optional
id	string	optional

Delete

Example request:

curl "https://<base-url>/tap-type/{tap_type}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/tap-type/{tap_type}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE tap-type/{tap_type}

Tap-Type-Selection

Retrieve multiple

Example request:

curl "https://<base-url>/tap-type-selection" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="496266167" \
    -d "per_page"="231" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/tap-type-selection",
    "method": "GET",
    "data": {
        "page": 496266167,
        "per_page": 231,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET tap-type-selection

HEAD tap-type-selection

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/tap-type-selection" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account_agreement_id"="58843039" \
    -d "act_id"="repellendus" \
    -d "tap_type_id"="58843039" \
    -d "tap_id"="58843039" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/tap-type-selection",
    "method": "POST",
    "data": {
        "account_agreement_id": 58843039,
        "act_id": "repellendus",
        "tap_type_id": 58843039,
        "tap_id": 58843039
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST tap-type-selection

Parameters

Parameter	Type	Status	Description
account_agreement_id	integer	required	Valid account_agreement id
act_id	string	required	Valid account act_id
tap_type_id	integer	required	Valid tap_type id
tap_id	integer	optional	Valid tap tap_id

Retrieve

Example request:

curl "https://<base-url>/tap-type-selection/{tap_type_selection}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/tap-type-selection/{tap_type_selection}",
    "method": "GET",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET tap-type-selection/{tap_type_selection}

HEAD tap-type-selection/{tap_type_selection}

Update

Example request:

curl "https://<base-url>/tap-type-selection/{tap_type_selection}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "account_agreement_id"="780" \
    -d "act_id"="voluptatem" \
    -d "tap_type_id"="780" \
    -d "tap_id"="780" \
    -d "id"="voluptatem" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/tap-type-selection/{tap_type_selection}",
    "method": "PUT",
    "data": {
        "account_agreement_id": 780,
        "act_id": "voluptatem",
        "tap_type_id": 780,
        "tap_id": 780,
        "id": "voluptatem"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT tap-type-selection/{tap_type_selection}

PATCH tap-type-selection/{tap_type_selection}

Parameters

Parameter	Type	Status	Description
account_agreement_id	integer	optional	Valid account_agreement id
act_id	string	optional	Valid account act_id
tap_type_id	integer	optional	Valid tap_type id
tap_id	integer	optional	Valid tap tap_id
id	string	optional

Delete

Example request:

curl "https://<base-url>/tap-type-selection/{tap_type_selection}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/tap-type-selection/{tap_type_selection}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE tap-type-selection/{tap_type_selection}

Taps

Retrieve multiple

Example request:

curl "https://<base-url>/taps" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1877475310" \
    -d "per_page"="875" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/taps",
    "method": "GET",
    "data": {
        "page": 1877475310,
        "per_page": 875,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET taps

HEAD taps

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/taps" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "tap_name"="alias" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/taps",
    "method": "POST",
    "data": {
        "tap_name": "alias"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST taps

Parameters

Parameter	Type	Status	Description
tap_name	string	required	Maximum: 255

Retrieve

Example request:

curl "https://<base-url>/taps/{taps}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "taps"="694738003" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/taps/{taps}",
    "method": "GET",
    "data": {
        "taps": 694738003
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET taps/{taps}

HEAD taps/{taps}

Parameters

Parameter	Type	Status	Description
taps	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/taps/{taps}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "taps"="78778844" \
    -d "tap_name"="pariatur" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/taps/{taps}",
    "method": "PUT",
    "data": {
        "taps": 78778844,
        "tap_name": "pariatur"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT taps/{taps}

PATCH taps/{taps}

Parameters

Parameter	Type	Status	Description
taps	numeric	required	Must have a length between 1 and 11
tap_name	string	required	Maximum: 255

Delete

Example request:

curl "https://<base-url>/taps/{taps}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/taps/{taps}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE taps/{taps}

Territories

Retrieve multiple

Example request:

curl "https://<base-url>/territories" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="451868504" \
    -d "per_page"="210" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/territories",
    "method": "GET",
    "data": {
        "page": 451868504,
        "per_page": 210,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET territories

HEAD territories

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve

Example request:

curl "https://<base-url>/territories/{territories}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "territories"="841927" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/territories/{territories}",
    "method": "GET",
    "data": {
        "territories": 841927
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET territories/{territories}

HEAD territories/{territories}

Parameters

Parameter	Type	Status	Description
territories	numeric	required	Must have a length between 1 and 11

Trade-Promotion-Types

Retrieve multiple

Example request:

curl "https://<base-url>/trade-promotion-types" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="2056538398" \
    -d "per_page"="958" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/trade-promotion-types",
    "method": "GET",
    "data": {
        "page": 2056538398,
        "per_page": 958,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET trade-promotion-types

HEAD trade-promotion-types

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/trade-promotion-types" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "pmt_name"="aperiam" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/trade-promotion-types",
    "method": "POST",
    "data": {
        "pmt_name": "aperiam"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST trade-promotion-types

Parameters

Parameter	Type	Status	Description
pmt_name	string	required	Maximum: 45

Retrieve

Example request:

curl "https://<base-url>/trade-promotion-types/{trade_promotion_types}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "trade_promotion_types"="26" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/trade-promotion-types/{trade_promotion_types}",
    "method": "GET",
    "data": {
        "trade_promotion_types": 26
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET trade-promotion-types/{trade_promotion_types}

HEAD trade-promotion-types/{trade_promotion_types}

Parameters

Parameter	Type	Status	Description
trade_promotion_types	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/trade-promotion-types/{trade_promotion_types}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "trade_promotion_types"="3" \
    -d "pmt_name"="aperiam" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/trade-promotion-types/{trade_promotion_types}",
    "method": "PUT",
    "data": {
        "trade_promotion_types": 3,
        "pmt_name": "aperiam"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT trade-promotion-types/{trade_promotion_types}

PATCH trade-promotion-types/{trade_promotion_types}

Parameters

Parameter	Type	Status	Description
trade_promotion_types	numeric	required	Must have a length between 1 and 11
pmt_name	string	required	Maximum: 45

Turn-In-Order-Products

Retrieve by order

Example request:

curl "https://<base-url>/turn-in-order-products/turn-in-order/{order}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "order"="sunt" \
    -d "page"="1231882554" \
    -d "per_page"="574" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/turn-in-order-products/turn-in-order/{order}",
    "method": "GET",
    "data": {
        "order": "sunt",
        "page": 1231882554,
        "per_page": 574,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET turn-in-order-products/turn-in-order/{order}

HEAD turn-in-order-products/turn-in-order/{order}

Parameters

Parameter	Type	Status	Description
order	string	required	Valid turninorder tio_id
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve multiple

Example request:

curl "https://<base-url>/turn-in-order-products" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="428342507" \
    -d "per_page"="199" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/turn-in-order-products",
    "method": "GET",
    "data": {
        "page": 428342507,
        "per_page": 199,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET turn-in-order-products

HEAD turn-in-order-products

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/turn-in-order-products" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "tip_id"="19" \
    -d "tio_id"="molestias" \
    -d "pro_id"="molestias" \
    -d "tip_quantity"="4822" \
    -d "tip_sequence"="4822" \
    -d "tip_product_note"="molestias" \
    -d "uom"="4822" \
    -d "is_bonus"="0" \
    -d "bonus_type_id"="molestias" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/turn-in-order-products",
    "method": "POST",
    "data": {
        "tip_id": 19,
        "tio_id": "molestias",
        "pro_id": "molestias",
        "tip_quantity": 4822,
        "tip_sequence": 4822,
        "tip_product_note": "molestias",
        "uom": 4822,
        "is_bonus": "0",
        "bonus_type_id": "molestias"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST turn-in-order-products

Parameters

Parameter	Type	Status	Description
tip_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
tio_id	string	required	Valid turninorder tio_id
pro_id	string	required	Valid product pro_id
tip_quantity	integer	required
tip_sequence	integer	required
tip_product_note	string	optional	Maximum: 255
uom	integer	optional
is_bonus	string	required	1 or 0
bonus_type_id	string	required	Valid bonus_type bonus_type_id

Retrieve

Example request:

curl "https://<base-url>/turn-in-order-products/{turn_in_order_products}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "turn_in_order_products"="11" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/turn-in-order-products/{turn_in_order_products}",
    "method": "GET",
    "data": {
        "turn_in_order_products": 11
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET turn-in-order-products/{turn_in_order_products}

HEAD turn-in-order-products/{turn_in_order_products}

Parameters

Parameter	Type	Status	Description
turn_in_order_products	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/turn-in-order-products/{turn_in_order_products}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "turn_in_order_products"="30" \
    -d "tio_id"="vel" \
    -d "pro_id"="vel" \
    -d "tip_quantity"="17890579" \
    -d "tip_sequence"="17890579" \
    -d "tip_product_note"="vel" \
    -d "uom"="17890579" \
    -d "is_bonus"="0" \
    -d "bonus_type_id"="vel" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/turn-in-order-products/{turn_in_order_products}",
    "method": "PUT",
    "data": {
        "turn_in_order_products": 30,
        "tio_id": "vel",
        "pro_id": "vel",
        "tip_quantity": 17890579,
        "tip_sequence": 17890579,
        "tip_product_note": "vel",
        "uom": 17890579,
        "is_bonus": "0",
        "bonus_type_id": "vel"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT turn-in-order-products/{turn_in_order_products}

PATCH turn-in-order-products/{turn_in_order_products}

Parameters

Parameter	Type	Status	Description
turn_in_order_products	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
tio_id	string	optional	Valid turninorder tio_id
pro_id	string	optional	Valid product pro_id
tip_quantity	integer	optional
tip_sequence	integer	optional
tip_product_note	string	optional	Maximum: 255
uom	integer	optional
is_bonus	string	optional	1 or 0
bonus_type_id	string	optional	Valid bonus_type bonus_type_id

Delete

Example request:

curl "https://<base-url>/turn-in-order-products/{turn_in_order_products}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/turn-in-order-products/{turn_in_order_products}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE turn-in-order-products/{turn_in_order_products}

Turn-In-Orders

Retrieve by Exported

Example request:

curl "https://<base-url>/turn-in-orders/exported/{exported}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "exported"="FALSE" \
    -d "page"="1160922293" \
    -d "per_page"="541" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/turn-in-orders/exported/{exported}",
    "method": "GET",
    "data": {
        "exported": "FALSE",
        "page": 1160922293,
        "per_page": 541,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET turn-in-orders/exported/{exported}

HEAD turn-in-orders/exported/{exported}

Parameters

Parameter	Type	Status	Description
exported	string	required	TRUE or FALSE
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve multiple

Example request:

curl "https://<base-url>/turn-in-orders" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="297210840" \
    -d "per_page"="138" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/turn-in-orders",
    "method": "GET",
    "data": {
        "page": 297210840,
        "per_page": 138,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET turn-in-orders

HEAD turn-in-orders

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/turn-in-orders" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "tio_id"="2" \
    -d "act_id"="quae" \
    -d "usr_id"="quae" \
    -d "tio_date"="2025:07:10" \
    -d "tio_email_flag"="TRUE" \
    -d "tio_ponumber"="12" \
    -d "tio_note"="12" \
    -d "tio_delivery_date"="2025:07:10" \
    -d "tio_exported"="TRUE" \
    -d "tio_num_products"="8" \
    -d "who_id"="quae" \
    -d "who_code"="1" \
    -d "delivery_address_id"="quae" \
    -d "sent_to_server"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/turn-in-orders",
    "method": "POST",
    "data": {
        "tio_id": 2,
        "act_id": "quae",
        "usr_id": "quae",
        "tio_date": "2025:07:10",
        "tio_email_flag": "TRUE",
        "tio_ponumber": 12,
        "tio_note": 12,
        "tio_delivery_date": "2025:07:10",
        "tio_exported": "TRUE",
        "tio_num_products": 8,
        "who_id": "quae",
        "who_code": 1,
        "delivery_address_id": "quae",
        "sent_to_server": "1"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST turn-in-orders

Parameters

Parameter	Type	Status	Description
tio_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
act_id	string	required	Valid account act_id
usr_id	string	required	Valid user usr_id
tio_date	date	required	Date format: Y:m:d
tio_email_flag	string	required	TRUE or FALSE
tio_ponumber	string	required	Between: 1 and 255
tio_note	string	optional	Between: 1 and 255
tio_delivery_date	date	optional	Date format: Y:m:d
tio_exported	string	optional	TRUE or FALSE
tio_num_products	integer	optional
who_id	string	optional	Valid wholesaler who_id
who_code	string	optional	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 20
delivery_address_id	string	optional	Valid account_delivery adl_id
sent_to_server	string	optional	1 or 0

Retrieve

Example request:

curl "https://<base-url>/turn-in-orders/{turn_in_orders}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "turn_in_orders"="21" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/turn-in-orders/{turn_in_orders}",
    "method": "GET",
    "data": {
        "turn_in_orders": 21
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET turn-in-orders/{turn_in_orders}

HEAD turn-in-orders/{turn_in_orders}

Parameters

Parameter	Type	Status	Description
turn_in_orders	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/turn-in-orders/{turn_in_orders}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "turn_in_orders"="33" \
    -d "act_id"="repudiandae" \
    -d "usr_id"="repudiandae" \
    -d "tio_date"="2025:07:10" \
    -d "tio_email_flag"="FALSE" \
    -d "tio_ponumber"="234" \
    -d "tio_note"="234" \
    -d "tio_delivery_date"="2025:07:10" \
    -d "tio_exported"="FALSE" \
    -d "tio_num_products"="969547211" \
    -d "who_id"="repudiandae" \
    -d "who_code"="19" \
    -d "delivery_address_id"="repudiandae" \
    -d "sent_to_server"="0" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/turn-in-orders/{turn_in_orders}",
    "method": "PUT",
    "data": {
        "turn_in_orders": 33,
        "act_id": "repudiandae",
        "usr_id": "repudiandae",
        "tio_date": "2025:07:10",
        "tio_email_flag": "FALSE",
        "tio_ponumber": 234,
        "tio_note": 234,
        "tio_delivery_date": "2025:07:10",
        "tio_exported": "FALSE",
        "tio_num_products": 969547211,
        "who_id": "repudiandae",
        "who_code": 19,
        "delivery_address_id": "repudiandae",
        "sent_to_server": "0"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT turn-in-orders/{turn_in_orders}

PATCH turn-in-orders/{turn_in_orders}

Parameters

Parameter	Type	Status	Description
turn_in_orders	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
act_id	string	optional	Valid account act_id
usr_id	string	optional	Valid user usr_id
tio_date	date	optional	Date format: Y:m:d
tio_email_flag	string	optional	TRUE or FALSE
tio_ponumber	string	optional	Between: 1 and 255
tio_note	string	optional	Between: 1 and 255
tio_delivery_date	date	optional	Date format: Y:m:d
tio_exported	string	optional	TRUE or FALSE
tio_num_products	integer	optional
who_id	string	optional	Valid wholesaler who_id
who_code	string	optional	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 20
delivery_address_id	string	optional	Valid account_delivery adl_id
sent_to_server	string	optional	1 or 0

Delete

Example request:

curl "https://<base-url>/turn-in-orders/{turn_in_orders}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/turn-in-orders/{turn_in_orders}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE turn-in-orders/{turn_in_orders}

User-Admin-Modules

Allocate a specific admin-module to a user. This gives the user permission to access and view the admin-module on rhino online.

See the admin-modules resource for a list of all possible modules.

Retrieve multiple

Example request:

curl "https://<base-url>/user-admin-modules" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1791806685" \
    -d "per_page"="835" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-admin-modules",
    "method": "GET",
    "data": {
        "page": 1791806685,
        "per_page": 835,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET user-admin-modules

HEAD user-admin-modules

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/user-admin-modules" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "user_id"="11" \
    -d "admin_module_id"="330" \
    -d "active"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-admin-modules",
    "method": "POST",
    "data": {
        "user_id": 11,
        "admin_module_id": 330,
        "active": "1"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST user-admin-modules

Parameters

Parameter	Type	Status	Description
user_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid user usr_id
admin_module_id	integer	required	Valid admin_module id
active	integer	required	1 or 0

Retrieve

Example request:

curl "https://<base-url>/user-admin-modules/{user_admin_modules}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "user_admin_modules"="4758" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-admin-modules/{user_admin_modules}",
    "method": "GET",
    "data": {
        "user_admin_modules": 4758
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET user-admin-modules/{user_admin_modules}

HEAD user-admin-modules/{user_admin_modules}

Parameters

Parameter	Type	Status	Description
user_admin_modules	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/user-admin-modules/{user_admin_modules}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "user_admin_modules"="13" \
    -d "user_id"="5" \
    -d "admin_module_id"="13" \
    -d "active"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-admin-modules/{user_admin_modules}",
    "method": "PUT",
    "data": {
        "user_admin_modules": 13,
        "user_id": 5,
        "admin_module_id": 13,
        "active": "1"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT user-admin-modules/{user_admin_modules}

PATCH user-admin-modules/{user_admin_modules}

Parameters

Parameter	Type	Status	Description
user_admin_modules	numeric	required	Must have a length between 1 and 11
user_id	string	optional	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid user usr_id
admin_module_id	integer	optional	Valid admin_module id
active	integer	required	1 or 0

Delete

Example request:

curl "https://<base-url>/user-admin-modules/{user_admin_modules}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-admin-modules/{user_admin_modules}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE user-admin-modules/{user_admin_modules}

User-Modules

User-Modules are specifically used for the Android app only. Please use the User-Admin-Modules resource for the web version.

See the Modules resource for a list of all possible modules on the Android app.

Retrieve multiple

Example request:

curl "https://<base-url>/user-modules" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1250035313" \
    -d "per_page"="582" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-modules",
    "method": "GET",
    "data": {
        "page": 1250035313,
        "per_page": 582,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET user-modules

HEAD user-modules

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/user-modules" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "usr_id"="30" \
    -d "mod_id"="50435424" \
    -d "usm_activated"="false" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-modules",
    "method": "POST",
    "data": {
        "usr_id": 30,
        "mod_id": 50435424,
        "usm_activated": "false"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST user-modules

Parameters

Parameter	Type	Status	Description
usr_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid user usr_id
mod_id	integer	required	Valid module mod_id
usm_activated	string	optional	true or false

Retrieve

Example request:

curl "https://<base-url>/user-modules/{user_modules}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "user_modules"="581130893" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-modules/{user_modules}",
    "method": "GET",
    "data": {
        "user_modules": 581130893
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET user-modules/{user_modules}

HEAD user-modules/{user_modules}

Parameters

Parameter	Type	Status	Description
user_modules	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/user-modules/{user_modules}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "user_modules"="1494" \
    -d "usr_id"="13" \
    -d "mod_id"="1494" \
    -d "usm_activated"="true" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-modules/{user_modules}",
    "method": "PUT",
    "data": {
        "user_modules": 1494,
        "usr_id": 13,
        "mod_id": 1494,
        "usm_activated": "true"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT user-modules/{user_modules}

PATCH user-modules/{user_modules}

Parameters

Parameter	Type	Status	Description
user_modules	numeric	required	Must have a length between 1 and 11
usr_id	string	optional	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid user usr_id
mod_id	integer	optional	Valid module mod_id
usm_activated	string	optional	true or false

Delete

Example request:

curl "https://<base-url>/user-modules/{user_modules}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-modules/{user_modules}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE user-modules/{user_modules}

Retrieve

Example request:

curl "https://<base-url>/user-modules/user/{user}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "user"="35" \
    -d "page"="2039891558" \
    -d "per_page"="950" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-modules/user/{user}",
    "method": "GET",
    "data": {
        "user": 35,
        "page": 2039891558,
        "per_page": 950,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET user-modules/user/{user}

HEAD user-modules/user/{user}

Parameters

Parameter	Type	Status	Description
user	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid user usr_id
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve

Example request:

curl "https://<base-url>/user-modules/module/{module}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "module"="2419" \
    -d "page"="816912801" \
    -d "per_page"="380" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-modules/module/{module}",
    "method": "GET",
    "data": {
        "module": 2419,
        "page": 816912801,
        "per_page": 380,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET user-modules/module/{module}

HEAD user-modules/module/{module}

Parameters

Parameter	Type	Status	Description
module	numeric	required	Must have a length between 1 and 11 Valid module mod_id
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

User-Permissions

Allocate a permission level to a user, to restrict there access to all other users. This is useful when you do NOT want users to see each others calls, reports etc.

By default all users are given Territory Level permissions.

Possible values for permission_level

1 User Level. Only access there own records.
2 Territory Level. Only access records belonging to users within there own territory.
3 Admin Level. Access all records. 4 User/All Accounts Level. Dropdowns show logged in user, but can see all accounts. 5 User/State Accounts Level. Dropdowns show logged in user, but can see all accounts in there state. 6 User/Filtered Accounts Level. Dropdowns show logged in user, but can see accounts based on Permission_Filters. 7 User/Territory Accounts Level. Dropdowns show logged in user, but can see accounts in their territory. 8 Territory/Filtered Accounts Level. Dropdowns shows users in their own territory, can see accounts in their territory.

Retrieve multiple

Example request:

curl "https://<base-url>/user-permissions" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1311393392" \
    -d "per_page"="611" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-permissions",
    "method": "GET",
    "data": {
        "page": 1311393392,
        "per_page": 611,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET user-permissions

HEAD user-permissions

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/user-permissions" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "user_id"="17" \
    -d "permission_level"="5" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-permissions",
    "method": "POST",
    "data": {
        "user_id": 17,
        "permission_level": "5"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST user-permissions

Parameters

Parameter	Type	Status	Description
user_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid user usr_id
permission_level	integer	required	1, 2, 3, 4, 5, 6, 7, 8 or 9

Retrieve

Example request:

curl "https://<base-url>/user-permissions/{user_permissions}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "user_permissions"="580679232" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-permissions/{user_permissions}",
    "method": "GET",
    "data": {
        "user_permissions": 580679232
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET user-permissions/{user_permissions}

HEAD user-permissions/{user_permissions}

Parameters

Parameter	Type	Status	Description
user_permissions	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/user-permissions/{user_permissions}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "user_permissions"="6207308" \
    -d "user_id"="25" \
    -d "permission_level"="7" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-permissions/{user_permissions}",
    "method": "PUT",
    "data": {
        "user_permissions": 6207308,
        "user_id": 25,
        "permission_level": "7"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT user-permissions/{user_permissions}

PATCH user-permissions/{user_permissions}

Parameters

Parameter	Type	Status	Description
user_permissions	numeric	required	Must have a length between 1 and 11
user_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid user usr_id
permission_level	integer	required	1, 2, 3, 4, 5, 6, 7, 8 or 9

Delete

Example request:

curl "https://<base-url>/user-permissions/{user_permissions}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-permissions/{user_permissions}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE user-permissions/{user_permissions}

User-Territories

Retrieve multiple

Example request:

curl "https://<base-url>/user-territories" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="562409661" \
    -d "per_page"="262" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-territories",
    "method": "GET",
    "data": {
        "page": 562409661,
        "per_page": 262,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET user-territories

HEAD user-territories

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/user-territories" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "user_id"="5" \
    -d "territory_id"="49" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-territories",
    "method": "POST",
    "data": {
        "user_id": 5,
        "territory_id": 49
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST user-territories

Parameters

Parameter	Type	Status	Description
user_id	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid user usr_id
territory_id	numeric	required	Must have a length between 1 and 11 Valid territory id

Retrieve

Example request:

curl "https://<base-url>/user-territories/user/{user}/territory/{territory}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "user"="19" \
    -d "territory"="36912" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-territories/user/{user}/territory/{territory}",
    "method": "GET",
    "data": {
        "user": 19,
        "territory": 36912
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET user-territories/user/{user}/territory/{territory}

HEAD user-territories/user/{user}/territory/{territory}

Parameters

Parameter	Type	Status	Description
user	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid user usr_id
territory	numeric	required	Must have a length between 1 and 11 Valid territory id

Retrieve by user

Example request:

curl "https://<base-url>/user-territories/user/{user}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "user"="19" \
    -d "page"="1086894614" \
    -d "per_page"="506" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-territories/user/{user}",
    "method": "GET",
    "data": {
        "user": 19,
        "page": 1086894614,
        "per_page": 506,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET user-territories/user/{user}

HEAD user-territories/user/{user}

Parameters

Parameter	Type	Status	Description
user	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36 Valid user usr_id
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Retrieve by territory

Example request:

curl "https://<base-url>/user-territories/territory/{territory}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "territory"="3988" \
    -d "page"="754881691" \
    -d "per_page"="351" \
    -d "updated_after"="2025-07-10 06:48:05" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/user-territories/territory/{territory}",
    "method": "GET",
    "data": {
        "territory": 3988,
        "page": 754881691,
        "per_page": 351,
        "updated_after": "2025-07-10 06:48:05"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET user-territories/territory/{territory}

HEAD user-territories/territory/{territory}

Parameters

Parameter	Type	Status	Description
territory	numeric	required	Must have a length between 1 and 11 Valid territory id
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Users

Update multiple

Example request:

curl "https://<base-url>/users" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "user"="illum" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/users",
    "method": "PUT",
    "data": {
        "user": "illum"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT users

Parameters

Parameter	Type	Status	Description
user	array	required	Minimum: 1 Maximum: 50

Retrieve multiple

Example request:

curl "https://<base-url>/users" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1886160097" \
    -d "per_page"="879" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/users",
    "method": "GET",
    "data": {
        "page": 1886160097,
        "per_page": 879,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET users

HEAD users

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/users" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "username"="exercitationem" \
    -d "name"="exercitationem" \
    -d "code"="exercitationem" \
    -d "reference_id"="exercitationem" \
    -d "email"="lafayette.bartoletti@example.com" \
    -d "password"="exercitationem" \
    -d "password_type"="plain" \
    -d "state"="exercitationem" \
    -d "reportable"="true" \
    -d "tablet_access"="Enabled" \
    -d "admin_access"="Enabled" \
    -d "isActive"="1" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/users",
    "method": "POST",
    "data": {
        "username": "exercitationem",
        "name": "exercitationem",
        "code": "exercitationem",
        "reference_id": "exercitationem",
        "email": "lafayette.bartoletti@example.com",
        "password": "exercitationem",
        "password_type": "plain",
        "state": "exercitationem",
        "reportable": "true",
        "tablet_access": "Enabled",
        "admin_access": "Enabled",
        "isActive": "1"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST users

Parameters

Parameter	Type	Status	Description
username	string	required	Maximum: 255
name	string	required	Maximum: 255
code	string	required	Maximum: 255
reference_id	string	required	Maximum: 255
email	email	required	Maximum: 254
password	string	required	Maximum: 60
password_type	string	required	plain or ssha
state	string	required	Valid state sta_name
reportable	string	required	true or false
tablet_access	string	required	Enabled or Disabled
admin_access	string	required	Enabled or Disabled
isActive	string	required	1 or 0

Retrieve

Example request:

curl "https://<base-url>/users/{users}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "users"="13" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/users/{users}",
    "method": "GET",
    "data": {
        "users": 13
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET users/{users}

HEAD users/{users}

Parameters

Parameter	Type	Status	Description
users	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/users/{users}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "users"="28" \
    -d "username"="est" \
    -d "name"="est" \
    -d "code"="est" \
    -d "reference_id"="est" \
    -d "email"="ekris@example.net" \
    -d "password"="est" \
    -d "password_type"="ssha" \
    -d "state"="est" \
    -d "reportable"="false" \
    -d "tablet_access"="Disabled" \
    -d "admin_access"="Disabled" \
    -d "isActive"="0" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/users/{users}",
    "method": "PUT",
    "data": {
        "users": 28,
        "username": "est",
        "name": "est",
        "code": "est",
        "reference_id": "est",
        "email": "ekris@example.net",
        "password": "est",
        "password_type": "ssha",
        "state": "est",
        "reportable": "false",
        "tablet_access": "Disabled",
        "admin_access": "Disabled",
        "isActive": "0"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT users/{users}

PATCH users/{users}

Parameters

Parameter	Type	Status	Description
users	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
username	string	required	Maximum: 255
name	string	required	Maximum: 255
code	string	required	Maximum: 255
reference_id	string	required	Maximum: 255
email	email	required	Maximum: 254
password	string	required	Maximum: 60
password_type	string	required	plain or ssha
state	string	required	Valid state sta_name
reportable	string	required	true or false
tablet_access	string	required	Enabled or Disabled
admin_access	string	required	Enabled or Disabled
isActive	string	required	1 or 0

Delete

Example request:

curl "https://<base-url>/users/{users}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/users/{users}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE users/{users}

Weekly-Reports

Retrieve multiple

Example request:

curl "https://<base-url>/weekly-reports" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="365591149" \
    -d "per_page"="170" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/weekly-reports",
    "method": "GET",
    "data": {
        "page": 365591149,
        "per_page": 170,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET weekly-reports

HEAD weekly-reports

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/weekly-reports" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "rep_highlight"="omnis" \
    -d "rep_lowlight"="omnis" \
    -d "rep_new_distribution"="omnis" \
    -d "rep_lost_distribution"="omnis" \
    -d "rep_competitor_activity"="omnis" \
    -d "rep_week_ending"="2025:07:10" \
    -d "rep_submitted"="FALSE" \
    -d "usr_id"="omnis" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/weekly-reports",
    "method": "POST",
    "data": {
        "rep_highlight": "omnis",
        "rep_lowlight": "omnis",
        "rep_new_distribution": "omnis",
        "rep_lost_distribution": "omnis",
        "rep_competitor_activity": "omnis",
        "rep_week_ending": "2025:07:10",
        "rep_submitted": "FALSE",
        "usr_id": "omnis"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST weekly-reports

Parameters

Parameter	Type	Status	Description
rep_highlight	string	optional	Maximum: 500
rep_lowlight	string	optional	Maximum: 500
rep_new_distribution	string	optional	Maximum: 500
rep_lost_distribution	string	optional	Maximum: 500
rep_competitor_activity	string	optional	Maximum: 500
rep_week_ending	date	required	Date format: Y:m:d
rep_submitted	string	required	TRUE or FALSE
usr_id	string	required	Valid user usr_id

Retrieve

Example request:

curl "https://<base-url>/weekly-reports/{weekly_reports}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "weekly_reports"="6" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/weekly-reports/{weekly_reports}",
    "method": "GET",
    "data": {
        "weekly_reports": 6
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET weekly-reports/{weekly_reports}

HEAD weekly-reports/{weekly_reports}

Parameters

Parameter	Type	Status	Description
weekly_reports	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36

Update

Example request:

curl "https://<base-url>/weekly-reports/{weekly_reports}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "weekly_reports"="11" \
    -d "rep_highlight"="ullam" \
    -d "rep_lowlight"="ullam" \
    -d "rep_new_distribution"="ullam" \
    -d "rep_lost_distribution"="ullam" \
    -d "rep_competitor_activity"="ullam" \
    -d "rep_week_ending"="2025:07:10" \
    -d "rep_submitted"="TRUE" \
    -d "usr_id"="ullam" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/weekly-reports/{weekly_reports}",
    "method": "PUT",
    "data": {
        "weekly_reports": 11,
        "rep_highlight": "ullam",
        "rep_lowlight": "ullam",
        "rep_new_distribution": "ullam",
        "rep_lost_distribution": "ullam",
        "rep_competitor_activity": "ullam",
        "rep_week_ending": "2025:07:10",
        "rep_submitted": "TRUE",
        "usr_id": "ullam"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT weekly-reports/{weekly_reports}

PATCH weekly-reports/{weekly_reports}

Parameters

Parameter	Type	Status	Description
weekly_reports	string	required	Allowed: alpha-numeric characters, as well as dashes and underscores. Between: 1 and 36
rep_highlight	string	optional	Maximum: 500
rep_lowlight	string	optional	Maximum: 500
rep_new_distribution	string	optional	Maximum: 500
rep_lost_distribution	string	optional	Maximum: 500
rep_competitor_activity	string	optional	Maximum: 500
rep_week_ending	date	required	Date format: Y:m:d
rep_submitted	string	required	TRUE or FALSE
usr_id	string	required	Valid user usr_id

Delete

Example request:

curl "https://<base-url>/weekly-reports/{weekly_reports}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/weekly-reports/{weekly_reports}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE weekly-reports/{weekly_reports}

Wholesalers

Retrieve multiple

Example request:

curl "https://<base-url>/wholesalers" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "page"="1104125943" \
    -d "per_page"="514" \
    -d "updated_after"="2025-07-10 06:48:06" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/wholesalers",
    "method": "GET",
    "data": {
        "page": 1104125943,
        "per_page": 514,
        "updated_after": "2025-07-10 06:48:06"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET wholesalers

HEAD wholesalers

Parameters

Parameter	Type	Status	Description
page	integer	optional	Minimum: 1
per_page	integer	optional	Minimum: 1 Maximum: 1000
updated_after	date	optional	Date format: Y-m-d H:i:s

Store

Example request:

curl "https://<base-url>/wholesalers" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "who_name"="in" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/wholesalers",
    "method": "POST",
    "data": {
        "who_name": "in"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST wholesalers

Parameters

Parameter	Type	Status	Description
who_name	string	required	Maximum: 255

Retrieve

Example request:

curl "https://<base-url>/wholesalers/{wholesalers}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "wholesalers"="97" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/wholesalers/{wholesalers}",
    "method": "GET",
    "data": {
        "wholesalers": 97
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET wholesalers/{wholesalers}

HEAD wholesalers/{wholesalers}

Parameters

Parameter	Type	Status	Description
wholesalers	numeric	required	Must have a length between 1 and 11

Update

Example request:

curl "https://<base-url>/wholesalers/{wholesalers}" \
-H "Accept: application/json" \
-H "x-consumer: {provided by forteis}" \
-H "Authorization: {provided by forteis}" \
    -d "wholesalers"="67238" \
    -d "who_name"="totam" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/wholesalers/{wholesalers}",
    "method": "PUT",
    "data": {
        "wholesalers": 67238,
        "who_name": "totam"
},
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

PUT wholesalers/{wholesalers}

PATCH wholesalers/{wholesalers}

Parameters

Parameter	Type	Status	Description
wholesalers	numeric	required	Must have a length between 1 and 11
who_name	string	required	Maximum: 255

Delete

Example request:

curl "https://<base-url>/wholesalers/{wholesalers}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://<base-url>/wholesalers/{wholesalers}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json", 
        "Authorization": "{provided by forteis}", 
        "x-consumer": "{provided by forteis}"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

DELETE wholesalers/{wholesalers}