Get pickup group details

This action will return a specific pickup group configured in the given unit.

Try this request in your browser

/api/ /pickup_groups/info

Headers

X-Auth-App
X-Auth-Token
X-Auth-Secret
X-Auth-Extension
X-Auth-Password
X-Proxy-Auth-Token
X-Proxy-Auth-Secret

Parameters

id String

Structures

Include extended attributes?
Include expansions? 

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/pickup_groups/info

Access

Must be authenticated as a user or API token. If not authorised, a AccessDenied error will be returned.

Parameters

Parameter Type Default

id Required

The ID of the pickup group

 String null

Errors

Error Attributes

PickupGroupNotFound

No pickup group was found given the ID provided

  • id

    The provided ID

NoAccessToPickupGroup

Your authenticated identity is not permitted to access this pickup group

Response Data

This action will return a pickup group structure.

You'll receive all extended data with this structure, by default. You can change this behaviour by passing true or false in the _full parameter on the request. By default, you'll receive all expansions for the structure. You remove any/all of them by providing an array of new expansion names in the _expansions parameter on the request.