Exchange Object

FieldTypeDescription
idinteger (int64)The unique identifier for the object.
typestringThe exchange type (PICKUP, DROPOFF, ACTIVATION).
dateCreateddate-timeThe timestamp of the exchange authorization, in ISO 8601 format without milliseconds.
userobjectThe user who is performing the exchange.
keyobjectThe key for which the exchange is being performed.
locationobjectThe location at which the exchange is being performed.
completedbooleanIf true, the exchange has successfully completed.
cancelledbooleanIf true, the exchange has failed or timed out.
releasedbooleanIf true, the SmartBox has confirmed a successful bin release. A drop-off is completed when the release is authorized. It is possible for completed to be true and released to be false while waiting for confirmation.
expansionbooleanIf true, the bin involved in the exchange is contained in an expansion unit. Useful for displaying additional user instructions.
errorstringIf an exchange fails during interaction with the SmartBox, an error code will be included.

Error

CodeDescription
OWNER_ONLYThe location does not support exchanges performed by users other than the network owner.
WRONG_LOCATIONThe user has attempted to complete an exchange at the wrong location.
INVALID_FOBThe scanned fob cannot be used to complete the activation.