v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Store Tasks

Returns the details of store tasks such as task title, description, status, and updates.

get/store/tasks

Query parameters

type_value'ASSOCIATE' | 'MANAGER'

Type of staff details to return.

all'sms' | 'email' | 'call' | 'none'

Type of task to return.

assoc_idinteger

Unique ID of the associate to return the list of tasks assigned to that specific associate.

customer_idinteger

Unique ID of the customer to get the list of tasks created for that specific customer.

start_datestring date

Returns the list of tasks created between the dates set on start_date and end_date. If only start_date is mentioned then the list of tasks created on or after that specified date is returned.

end_datestring date

Returns the list of tasks created between the dates set on start_date and end_date. If only end_date is passed, the list of tasks created on or before the specified date is returned.

countinteger

Limits the number of tasks to be returned. For example, if count=10 then the details of only 10 tasks are returned.

format'xml' | 'json'

Format of the response object.

Response

200

Example response

{
  "response": {
    "status": {
      "success": "true",
      "code": "200",
      "message": "SUCCESS"
    },
    "store": {
      "tasks": {
        "task": [
          {
            "type": "CUSTOMER/CASHIER",
            "associate_id": "123",
            "customer_id": "124",
            "store_id": "125",
            "status": "OPEN"
          }
        ]
      }
    }
  }
}