Skip to content

Pickup groups

List all pickup groups

This method allows you to retrieve a list of all pickup groups within your unit.

URL

/api/v2/pickup_groups/list

Supported Paramaters

There are no supported parameters for this method.

Example JSON

{
    "status":"success",
    "time":0.0,
    "flags":{},
    "data":
    [
        {
            "id":298,
            "name":"Test",
            "created_at":"2015-08-13T09:57:07.000Z",
            "updated_at":"2015-08-13T09:57:07.000Z"
        }
    ]
}

Pickup group properties

This method allows you to retrieve information on particular pickup group in your account.

URL

/api/v2/pickup_groups/info

Supported Parameters

  • id - the ID of the pickup group you wish to view (required)

Example JSON

{
    "status":"success",
    "time":0.0,
    "flags":{},
    "data":
        {
            "id":298,
            "name":"Test",
            "created_at":"2015-08-13T09:57:07.000Z",
            "updated_at":"2015-08-13T09:57:07.000Z"
        }
}