Skip to main content

List Collect Task Groups

List Collect Task Groups

Query Parameters
per_page number

Define the number of items per page, default is 100

page number

Define the page number, default is 1

current_executed_date_between string

Filter by current executed date range, format: YYYY-MM-DD|YYYY-MM-DD

states string

Possible values: [SOLICITATION, PROGRAMMING, NOT_EXECUTION, WEIGHT_CONFIRMATION, JUSTIFICATION, CONFIRMATION]

Filter by current collect task states

Responses
200

Successful response with list of Collect Task Groups

Schema OPTIONAL
uuid string

Uuid of the register

route object,null OPTIONAL
uuid string

Uuid of the register

name string

Route name

driver_name string,null OPTIONAL

Driver name

place_code string,null OPTIONAL

The plate of the vehicle.

main_generation_point object
name string

Name of the grouping generation point

erp_code string,null OPTIONAL

Code ERP

internal_code string,null OPTIONAL

Internal code

lat string,null OPTIONAL

Latitude

lng string,null OPTIONAL

Longitude

collect_tasks object[]

List of related collect tasks

uuid string

Uuid of the register

erp_code string,null OPTIONAL

Code ERP

state string

Possible values: [SOLICITATION, PROGRAMMING, NOT_EXECUTION, WEIGHT_CONFIRMATION, JUSTIFICATION, CONFIRMATION]

Current state

waste_generation_point object
name string

Name of the grouping generation point

erp_code string,null OPTIONAL

Code ERP

internal_code string,null OPTIONAL

Internal code

lat string,null OPTIONAL

Latitude

lng string,null OPTIONAL

Longitude

solicitation_details object,null OPTIONAL

Details of when the task was originated by solicitation

responsible_name string,null OPTIONAL

Name of the responsible user

responsible_email string,null OPTIONAL

Email of the responsible user

is_urgent boolean

Task is marked as a priority

is_sporadic boolean

Task is marked as a sporadic

shift_work object,null OPTIONAL
uuid string

Uuid of the register

name string

Shift work name

current_executed_at date-time

Date and time the task was executed

items object[]

List of related items to collect tasks

quantity_input_method string

Possible values: [CAPACITY_PERCENTAGE, PACKING_COUNT, UNIT_MEASURE, JUST_CHECK]

Form of input the quantity at the time of execution

execution_mode string,null OPTIONAL

Possible values: [EXECUTED, CHECKED, COLLECTED, DELIVERED, NOT_EXECUTED]

Indicates whether the item was collected, delivered or simply checked

task_service string

Possible values: [COLLECT, DELIVERY, EXCHANGE, SHUTTLE]

Service type executed

waste object,null OPTIONAL

Information on collected waste

name string

Waste name

erp_code string,null OPTIONAL

Code ERP

internal_code string,null OPTIONAL

Internal code

waste_packing object

Packing delivered or collected together with the waste

uuid string

Uuid of the register

name string

Packing name

storage_waste_packing object,null OPTIONAL

Storage that the collected waste is accumulated

uuid string

Uuid of the register

name string

Storage name

observation string,null OPTIONAL

Observation by item

quantity number,null OPTIONAL

Quantity of the item

packing_quantity number,null OPTIONAL

Number of packings (delivery type)

solicitation_packing_quantity number,null OPTIONAL

Number of packings (delivery type) at the time of solicitation

max_capacity number,null OPTIONAL

Maximum capacity to be collected, when configured

minimum_quantity_to_collect number,null OPTIONAL

Minimum quantity to be collected, when configured

batch_details object[] OPTIONAL

List of related batches

hash string

Unique hash identifier

status string

Possible values: [OPEN, CLOSED, PENDING_WEIGHT_CONFIRMATION]

Batch status

waste object

Information on collected waste

name string

Waste name

erp_code string,null OPTIONAL

Code ERP

internal_code string,null OPTIONAL

Internal code

kg_quantity number

Quantity in KG of the bacth

quantity_input number

Quantity input according to quantity_input_method

quantity_input_method string

Possible values: [CAPACITY_PERCENTAGE, PACKING_COUNT, UNIT_MEASURE, JUST_CHECK]

Form of input the quantity at the time of execution

entry_traceabilities object[] OPTIONAL

Traceability of delivered packings

uuid string

Uuid of the register

waste_packing_code string

Packing code

exit_traceabilities object[] OPTIONAL

Traceability of collected packings

uuid string

Uuid of the register

waste_packing_code string

Packing code

custom_fields object[] OPTIONAL

List of custom fields

field_id string

Field identifier

field_name string

Field name

value string

Field response