Exchange Object

id integer: int64

The unique identifier for the object.

type
string

The exchange type (PICKUP/DROPOFF/ACTIVATION).

dateCreated
date-time

The timestamp of the exchange authorization, in ISO 8601 format without milliseconds.

user
object

The user who is performing the exchange.

key
object

The key for which the exchange is being performed.

location
object

The location at which the exchange is being performed.

completed
boolean

If true, the exchange has successfully completed.

cancelled
boolean

If true, the exchange has failed or timed out.

released
boolean

If true, the SmartBox has confirmed a successful bin release. A drop off is completed when the release is authorized, so it is possible for completed to be true and released to be false while waiting for confirmation.

expansion
boolean

If true, the bin involved in the exchange is contained in an expansion unit. This can be useful for displaying instructions to users.

error
string

If an exchange fails during interaction with the SmartBox, one of the errors from below might be included.

Errors

OWNER_ONLY

The location does not support exchanges performed by users other than the network owner.

WRONG_LOCATION

The user has attempted to complete an exchange at the wrong location.

INVALID_FOB

The scanned fob can not be used to complete the activation.