OBJT - ASRS LPN - Events 2.0.0

Operations

• SUB objt/device/{tenant}/{site}/ASRS_LPN/event

  Messages sent from ASRS to Objective

  Accepts one of the following messages:

  • #0ASRS LPN Store Transport NotificationStoreTransportNotificationMessage

    This message is sent by ASRS to Objective to trigger a store transport operation. Objective will respond by sending a Store Transport Request to ASRS or rejecting the request (if no destination was determined for the corresponding task)

    Payload

    Expand all

    object

    uid: StoreTransportNotificationPayload

    device

    required

    string

    Device ID of the ASRS (set at ASRS Communication Settings)

    event

    required

    string

    Identifies the event that needs to be handled by Objective

    Const:"STORE_TRANSPORT_TRIGGER"

    data

    Expand all

    required

    object

    The data required for the STORE_TRANSPORT_TRIGGER event

    lpnKey

    required

    string

    ID of LPN. When not specified 'first' LPN on location is taken.

    asrsId

    required

    string

    ASRS ID of the from warehouse location.

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

    {
      "device": "ASRS_LPN",
      "event": "STORE_TRANSPORT_TRIGGER",
      "data": {
        "lpnKey": "string",
        "asrsId": "string"
      }
    }
    

    This example has been generated automatically.

  • #1ASRS LPN Store Transport Reject NotificationStoreTransportRejectNotificationMessage

    This message is sent by ASRS to Objective to notify Objective that an lpn was rejected Objective will respond by terminating all tasks on the LPN and if the LPN is still present in the ASRS, a move task will be created to evacuate it and a Reject Transport Request is sent to ASRS.

    Payload

    Expand all

    object

    uid: StoreTransportRejectNotificationPayload

    device

    required

    string

    Device ID of the ASRS (set at ASRS Communication Settings)

    event

    required

    string

    Identifies the event that needs to be handled by Objective

    Const:"STORE_TRANSPORT_REJECT_TRIGGER"

    data

    Expand all

    required

    object

    The data required for the STORE_TRANSPORT_REJECT_TRIGGER event

    lpnKey

    required

    string

    ID of LPN. When not specified first LPN on location is taken.

    asrsId

    required

    string

    ASRS ID of the from warehouse location.

    terminateReasonId

    required

    string

    ID of the task terminate reason to use when tasks are terminated.

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

    {
      "device": "ASRS_LPN",
      "event": "STORE_TRANSPORT_REJECT_TRIGGER",
      "data": {
        "lpnKey": "string",
        "asrsId": "string",
        "terminateReasonId": "string"
      }
    }
    

    This example has been generated automatically.

  • #2ASRS LPN Transport Request AllocationRetrieveTransportAllocationMessage

    This message is sent by ASRS to Objective as a response to the RetrieveTransportRequestMessage. ASRS specifies the LPN keys of the reserved inventory. This message can be published incrementally in case ASRS does not reserve the request as a whole. This message is only supported for LPN Pick and Replenish tasks, as a result Objective will swap the allocations for the tasks with the lpns provided by ASRS. In case swapping is not possible the task is deallocated.

    Payload

    Expand all

    object

    uid: RetrieveTransportAllocationPayload

    device

    required

    string

    Device ID of the ASRS (set at ASRS Communication Settings)

    event

    required

    string

    Identifies the event that needs to be handled by Objective

    Const:"TRANSPORT_REQUEST_ALLOCATION"

    data

    Expand all

    required

    object

    The data required for the TRANSPORT_REQUEST_ALLOCATION event

    transportRequestKey

    required

    string

    ID of the transport order

    specificTransportRequestLines

    Expand all

    array<object>

    lineKey

    required

    string

    Name of transport line within transport request.

    lpnKey

    required

    string

    ID of LPN.

    dtsOccurred

    string

    format: date-timeuid: DtsOccurredPayload

    Date and time when the event occured.

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

    {
      "device": "ASRS_LPN",
      "event": "TRANSPORT_REQUEST_ALLOCATION",
      "data": {
        "transportRequestKey": "TR1234567890",
        "specificTransportRequestLines": [
          {
            "lineKey": "string",
            "lpnKey": "string"
          }
        ],
        "dtsOccurred": "2019-08-24T14:15:22Z"
      }
    }
    

    This example has been generated automatically.

  • #3ASRS LPN Move NotificationMoveNotificationMessage

    This message is sent by ASRS to Objective to notify Objective that the LPN is moved to a new location. When an LPN has a task associated and the provided location matches：to, target or stage location. Objective will complete the task to specified location, otherwise the LPN will be moved, leaving the task untouched.

    Payload

    Expand all

    object

    uid: MoveNotificationPayload

    device

    required

    string

    Device ID of the ASRS (set at ASRS Communication Settings)

    event

    required

    string

    Identifies the event that needs to be handled by Objective

    Const:"MOVE_NOTIFICATION"

    data

    Expand all

    required

    object

    The data required for the MOVE_NOTIFICATION event

    lpnKey

    required

    string

    ID of LPN. When not specified first LPN on location is taken.

    asrsId

    required

    string

    ASRS ID of the from warehouse location.

    userFields

    Expand all

    object

    uid: UserFieldDTO

    text

    Expand all

    array<object>

    key

    required

    string

    Key of the user text field.

    title

    string

    Title of the user text field.

    value

    string

    Value of the user text field.

    numeric

    Expand all

    array<object>

    key

    required

    string

    Key of the user number field.

    title

    string

    Title of the user number field.

    value

    number

    format: double

    Value of the user number field.

    flag

    Expand all

    array<object>

    key

    required

    string

    Key of the user flag field.

    title

    string

    Title of the user flag field.

    value

    boolean

    Value of the user flag field.

    date

    Expand all

    array<object>

    key

    required

    string

    Key of the user date field.

    title

    string

    Title of the user date field.

    value

    string

    format: date-time

    Value of the user date field.

    Additional properties are allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

    {
      "device": "ASRS_LPN",
      "event": "MOVE_NOTIFICATION",
      "data": {
        "lpnKey": "string",
        "asrsId": "string",
        "userFields": {
          "text": [
            {
              "key": "string",
              "title": "string",
              "value": "string"
            }
          ],
          "numeric": [
            {
              "key": "string",
              "title": "string",
              "value": 0.1
            }
          ],
          "flag": [
            {
              "key": "string",
              "title": "string",
              "value": true
            }
          ],
          "date": [
            {
              "key": "string",
              "title": "string",
              "value": "2019-08-24T14:15:22Z"
            }
          ]
        }
      }
    }
    

    This example has been generated automatically.

  • #4ASRS LPN Transport Cancel NotificationTransportCancelNotificationMessage

    ASRS notifies Objective when it cancelled a request. Any related tasks to the tranport order will be aborted.

    Payload

    Expand all

    object

    uid: TransportCancelNotificationPayload

    device

    required

    string

    Device ID of the ASRS (set at ASRS Communication Settings)

    event

    required

    string

    Identifies the event that needs to be handled by Objective

    Const:"TRANSPORT_CANCELED_NOTIFICATION"

    data

    Expand all

    required

    object

    The data required for the TRANSPORT_CANCELED_NOTIFICATION event

    transportRequestKey

    required

    string

    ID of the transport order

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

    {
      "device": "ASRS_LPN",
      "event": "TRANSPORT_CANCELED_NOTIFICATION",
      "data": {
        "transportRequestKey": "string"
      }
    }
    

    This example has been generated automatically.

  • #5ASRS LPN DimensionsLPNDimensionsMessage

    This message is sent by ASRS to Objective to notify Objective with the dimensions of an LPN. Can be used to store contour controle data. Objective will update the LPN with the provided dimensions.

    Payload

    Expand all

    object

    uid: LPNDimensionsPayload

    device

    required

    string

    Device ID of the ASRS (set at ASRS Communication Settings)

    event

    required

    string

    Identifies the event that needs to be handled by Objective

    Const:"LPN_DIMENSIONS"

    data

    Expand all

    required

    object

    The data required for the LPN_DIMENSIONS event

    lpnKey

    string

    ID of LPN. When not specified first LPN on location is taken.

    asrsId

    string

    ASRS ID of warehouse location.

    widthValue

    number

    format: double

    The new value for the width of the LPN, expressed in given uom or default uom if no uom given.

    widthUomKey

    string

    Name of the UOM. When not specified default uom of the dimension is used.

    depthValue

    number

    format: double

    The new value for the depth of the LPN, expressed in given uom or default uom if no uom given.

    depthUomKey

    string

    Name of the UOM. When not specified default uom of the dimension is used.

    heightValue

    number

    format: double

    The new value for the height of the LPN, expressed in given uom or default uom if no uom given.

    heightUomKey

    string

    Name of the UOM. When not specified default uom of the dimension is used.

    volumeValue

    number

    format: double

    The new value for the volume of the LPN, expressed in given uom or default uom if no uom given.

    volumeUomKey

    string

    Name of the UOM. When not specified default uom of the dimension is used.

    grossWeightValue

    number

    format: double

    The new value for the gross weight of the LPN, expressed in given uom or default uom if no uom given.

    grossWeighUomKey

    string

    Name of the UOM. When not specified default uom of the dimension is used.

    cubics

    number

    format: double

    The new value for the cubics of the LPN.

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

    {
      "device": "ASRS_LPN",
      "event": "LPN_DIMENSIONS",
      "data": {
        "lpnKey": "string",
        "asrsId": "string",
        "widthValue": 0,
        "widthUomKey": "string",
        "depthValue": 0,
        "depthUomKey": "string",
        "heightValue": 0,
        "heightUomKey": "string",
        "volumeValue": 0,
        "volumeUomKey": "string",
        "grossWeightValue": 0,
        "grossWeighUomKey": "string",
        "cubics": 0
      }
    }
    

    This example has been generated automatically.

• PUB objt/device/{tenant}/{site}/ASRS_LPN/command

  Messages sent from Objective to ASRS

  Accepts one of the following messages:

  • #0Store Transport RequestStoreTransportRequestMessage

    This message is sent by Objective to ASRS when inventory is dropped on an ASRS stage in so the ASRS can handle the storage.

    Payload

    Expand all

    object

    uid: StoreTransportRequestPayload

    device

    required

    string

    Device ID of the ASRS (set at ASRS Communication Settings)

    command

    required

    string

    Identifies the command that needs to be handled by the ASRS

    Const:"STORE_TRANSPORT_COMMAND"

    parameters

    Expand all

    required

    object

    The data required for the STORE_TRANSPORT_COMMAND command

    transportRequestKey

    required

    string

    ID of the transport order

    transportRequestName

    string

    Name of the transport order

    priority

    string

    Priority of the task related to the first transport request line

    fromLocation

    Expand all

    object

    uid: LocationPayload

    locationKey

    required

    string

    Full name of warehouse location.

    fullName

    required

    string

    Full name of warehouse location.

    asrsId

    string

    ASRS ID of warehouse location.

    id

    string

    ID of warehouse location.

    Additional properties are allowed.

    toLocation

    Expand all

    object

    uid: LocationPayload

    locationKey

    required

    string

    Full name of warehouse location.

    fullName

    required

    string

    Full name of warehouse location.

    asrsId

    string

    ASRS ID of warehouse location.

    id

    string

    ID of warehouse location.

    Additional properties are allowed.

    specificTransportRequestLines

    Expand all

    object

    uid: SpecificTransportRequestLinePayload

    lineKey

    required

    string

    Name of transport line within transport request.

    lpn

    Expand all

    required

    object

    uid: LPNPayload

    lpnKey

    required

    string

    Name of the LPN.

    containerType

    Expand all

    required

    object

    uid: ContainerTypePayload

    key

    required

    string

    Name of the container type.

    name

    required

    string

    Name of the container type.

    id

    string

    ID of the container type.

    description

    string

    Description of the container type.

    Additional properties are allowed.

    packagingKey

    string

    Name of the packaging

    dimensions

    Expand all

    object

    uid: DimensionPayload

    width

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    depth

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    height

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    volume

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    grossWeight

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    cubics

    number

    format: double

    Cubics.

    Additional properties are allowed.

    type

    string

    Is the LPN in lpnKey a nest or not

    Allowed values:
    • "LPN"
    • "NEST_LPN"

    lpnInventoryDetails

    Expand all

    array<object>

    item

    Expand all

    required

    object

    uid: ItemPayload

    itemKey

    required

    string

    Name of the item.

    name

    required

    string

    Name of the item.

    id

    string

    ID of the item.

    category

    string

    Category of the item.

    abcLPN

    string

    ABC LPN Classification.

    abcSKU

    string

    ABC LPN Classification.

    Additional properties are allowed.

    uomKey

    required

    string

    ID of the uom in which quantity is expressed.

    qcKey

    string

    Name of the quality control status. Only filled in when item is quality controlled.

    quantity

    required

    number

    format: double

    Inventory quantity.

    lotID

    string

    ID of lot. Only filled in when item is lot controlled.

    subLotID

    string

    ID of lot. Only filled in when item is sub-lot controlled.

    dtsLotProduction

    string

    format: date-time

    Date and time when the lot was produced.

    dtsLotBestBefore

    string

    format: date-time

    Date and time containing best before of lot.

    inventoryCode1

    string

    InventorCode1 of the inventory

    inventoryCode2

    string

    InventorCode2 of the inventory

    inventoryCode3

    string

    InventorCode3 of the inventory

    inventoryCode4

    string

    InventorCode4 of the inventory

    inventoryCode5

    string

    InventorCode5 of the inventory

    owner

    Expand all

    object

    uid: InventoryOwnerPayload

    ownerKey

    required

    string

    ID of the inventory owner to be used in combination with type.

    type

    required

    string

    The type of order

    Allowed values:
    • "PRODUCTION"
    • "REPACK"
    • "OUTBOUND"

    Additional properties are allowed.

    nestLPNInventoryDetails

    Expand all

    array<object>

    lpnKey

    required

    string

    Name of the LPN.

    containerType

    Expand all

    required

    object

    uid: ContainerTypePayload

    key

    required

    string

    Name of the container type.

    name

    required

    string

    Name of the container type.

    id

    string

    ID of the container type.

    description

    string

    Description of the container type.

    Additional properties are allowed.

    packagingKey

    string

    Name of the packaging

    dimensions

    Expand all

    object

    uid: DimensionPayload

    width

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    depth

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    height

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    volume

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    grossWeight

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    cubics

    number

    format: double

    Cubics.

    Additional properties are allowed.

    userFields

    Expand all

    object

    uid: UserFieldDTO

    text

    Expand all

    array<object>

    key

    required

    string

    Key of the user text field.

    title

    string

    Title of the user text field.

    value

    string

    Value of the user text field.

    numeric

    Expand all

    array<object>

    key

    required

    string

    Key of the user number field.

    title

    string

    Title of the user number field.

    value

    number

    format: double

    Value of the user number field.

    flag

    Expand all

    array<object>

    key

    required

    string

    Key of the user flag field.

    title

    string

    Title of the user flag field.

    value

    boolean

    Value of the user flag field.

    date

    Expand all

    array<object>

    key

    required

    string

    Key of the user date field.

    title

    string

    Title of the user date field.

    value

    string

    format: date-time

    Value of the user date field.

    Additional properties are allowed.

    isMixed

    boolean

    Is the LPN mixed.

    isFull

    boolean

    Is the LPN full.

    fullProgress

    number

    format: double

    If the LPN is full, the progress of it.

    lpnInventoryDetails

    Expand all

    array<object>

    item

    Expand all

    required

    object

    uid: ItemPayload

    itemKey

    required

    string

    Name of the item.

    name

    required

    string

    Name of the item.

    id

    string

    ID of the item.

    category

    string

    Category of the item.

    abcLPN

    string

    ABC LPN Classification.

    abcSKU

    string

    ABC LPN Classification.

    Additional properties are allowed.

    uomKey

    required

    string

    ID of the uom in which quantity is expressed.

    qcKey

    string

    Name of the quality control status. Only filled in when item is quality controlled.

    quantity

    required

    number

    format: double

    Inventory quantity.

    lotID

    string

    ID of lot. Only filled in when item is lot controlled.

    subLotID

    string

    ID of lot. Only filled in when item is sub-lot controlled.

    dtsLotProduction

    string

    format: date-time

    Date and time when the lot was produced.

    dtsLotBestBefore

    string

    format: date-time

    Date and time containing best before of lot.

    inventoryCode1

    string

    InventorCode1 of the inventory

    inventoryCode2

    string

    InventorCode2 of the inventory

    inventoryCode3

    string

    InventorCode3 of the inventory

    inventoryCode4

    string

    InventorCode4 of the inventory

    inventoryCode5

    string

    InventorCode5 of the inventory

    owner

    Expand all

    object

    uid: InventoryOwnerPayload

    ownerKey

    required

    string

    ID of the inventory owner to be used in combination with type.

    type

    required

    string

    The type of order

    Allowed values:
    • "PRODUCTION"
    • "REPACK"
    • "OUTBOUND"

    Additional properties are allowed.

    userFields

    Expand all

    object

    uid: UserFieldDTO

    text

    Expand all

    array<object>

    key

    required

    string

    Key of the user text field.

    title

    string

    Title of the user text field.

    value

    string

    Value of the user text field.

    numeric

    Expand all

    array<object>

    key

    required

    string

    Key of the user number field.

    title

    string

    Title of the user number field.

    value

    number

    format: double

    Value of the user number field.

    flag

    Expand all

    array<object>

    key

    required

    string

    Key of the user flag field.

    title

    string

    Title of the user flag field.

    value

    boolean

    Value of the user flag field.

    date

    Expand all

    array<object>

    key

    required

    string

    Key of the user date field.

    title

    string

    Title of the user date field.

    value

    string

    format: date-time

    Value of the user date field.

    Additional properties are allowed.

    isMixed

    boolean

    Is the LPN mixed.

    isFull

    boolean

    Is the LPN full.

    fullProgress

    number

    format: double

    If the LPN is full, the progress of it.

    Additional properties are allowed.

    orderReference

    Expand all

    object

    uid: OrderReferencePayload

    orderKey

    required

    string

    ID of the associated order(s) within Objective.

    type

    required

    string

    The type of order

    Allowed values:
    • "PRODUCTION"
    • "OUTBOUND"
    • "RECEIPT"
    • "RETURN"
    • "SHIP"
    • "MOVE"

    Additional properties are allowed.

    Additional properties are allowed.

    dtsCreated

    string

    format: date-timeuid: DtsCreatedPayload

    Date and time when the request was created.

    dtsOccured

    string

    format: date-timeuid: DtsOccurredPayload

    Date and time when the event occured.

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

    {
      "device": "ASRS_LPN",
      "command": "STORE_TRANSPORT_COMMAND",
      "parameters": {
        "transportRequestKey": "ITEM_A",
        "transportRequestName": "string",
        "priority": 1,
        "fromLocation": {
          "locationKey": "string",
          "fullName": "string",
          "asrsId": "string",
          "id": "string"
        },
        "toLocation": {
          "locationKey": "string",
          "fullName": "string",
          "asrsId": "string",
          "id": "string"
        },
        "specificTransportRequestLines": {
          "lineKey": "string",
          "lpn": {
            "lpnKey": "string",
            "containerType": {
              "key": "string",
              "name": "string",
              "id": "string",
              "description": "string"
            },
            "packagingKey": "string",
            "dimensions": {
              "width": {
                "value": 0,
                "uomKey": "string"
              },
              "depth": {
                "value": 0,
                "uomKey": "string"
              },
              "height": {
                "value": 0,
                "uomKey": "string"
              },
              "volume": {
                "value": 0,
                "uomKey": "string"
              },
              "grossWeight": {
                "value": 0,
                "uomKey": "string"
              },
              "cubics": 0
            },
            "type": "LPN",
            "lpnInventoryDetails": [
              {
                "item": {
                  "itemKey": "string",
                  "name": "string",
                  "id": "string",
                  "category": "string",
                  "abcLPN": "string",
                  "abcSKU": "string"
                },
                "uomKey": "string",
                "qcKey": "string",
                "quantity": 0,
                "lotID": "string",
                "subLotID": "string",
                "dtsLotProduction": "2019-08-24T14:15:22Z",
                "dtsLotBestBefore": "2019-08-24T14:15:22Z",
                "inventoryCode1": "string",
                "inventoryCode2": "string",
                "inventoryCode3": "string",
                "inventoryCode4": "string",
                "inventoryCode5": "string",
                "owner": {
                  "ownerKey": "string",
                  "type": "PRODUCTION"
                }
              }
            ],
            "nestLPNInventoryDetails": [
              {
                "lpnKey": "string",
                "containerType": {
                  "key": "string",
                  "name": "string",
                  "id": "string",
                  "description": "string"
                },
                "packagingKey": "string",
                "dimensions": {
                  "width": {
                    "value": 0,
                    "uomKey": "string"
                  },
                  "depth": {
                    "value": 0,
                    "uomKey": "string"
                  },
                  "height": {
                    "value": 0,
                    "uomKey": "string"
                  },
                  "volume": {
                    "value": 0,
                    "uomKey": "string"
                  },
                  "grossWeight": {
                    "value": 0,
                    "uomKey": "string"
                  },
                  "cubics": 0
                },
                "userFields": {
                  "text": [
                    {
                      "key": "string",
                      "title": "string",
                      "value": "string"
                    }
                  ],
                  "numeric": [
                    {
                      "key": "string",
                      "title": "string",
                      "value": 0.1
                    }
                  ],
                  "flag": [
                    {
                      "key": "string",
                      "title": "string",
                      "value": true
                    }
                  ],
                  "date": [
                    {
                      "key": "string",
                      "title": "string",
                      "value": "2019-08-24T14:15:22Z"
                    }
                  ]
                },
                "isMixed": true,
                "isFull": true,
                "fullProgress": 0.1,
                "lpnInventoryDetails": [
                  {
                    "item": {
                      "itemKey": "string",
                      "name": "string",
                      "id": "string",
                      "category": "string",
                      "abcLPN": "string",
                      "abcSKU": "string"
                    },
                    "uomKey": "string",
                    "qcKey": "string",
                    "quantity": 0,
                    "lotID": "string",
                    "subLotID": "string",
                    "dtsLotProduction": "2019-08-24T14:15:22Z",
                    "dtsLotBestBefore": "2019-08-24T14:15:22Z",
                    "inventoryCode1": "string",
                    "inventoryCode2": "string",
                    "inventoryCode3": "string",
                    "inventoryCode4": "string",
                    "inventoryCode5": "string",
                    "owner": {
                      "ownerKey": "string",
                      "type": "PRODUCTION"
                    }
                  }
                ]
              }
            ],
            "userFields": {
              "text": [
                {
                  "key": "string",
                  "title": "string",
                  "value": "string"
                }
              ],
              "numeric": [
                {
                  "key": "string",
                  "title": "string",
                  "value": 0.1
                }
              ],
              "flag": [
                {
                  "key": "string",
                  "title": "string",
                  "value": true
                }
              ],
              "date": [
                {
                  "key": "string",
                  "title": "string",
                  "value": "2019-08-24T14:15:22Z"
                }
              ]
            },
            "isMixed": true,
            "isFull": true,
            "fullProgress": 0.1
          },
          "orderReference": {
            "orderKey": "string",
            "type": "PRODUCTION"
          }
        },
        "dtsCreated": "2019-08-24T14:15:22Z",
        "dtsOccured": "2019-08-24T14:15:22Z"
      }
    }
    

    This example has been generated automatically.

  • #1ASRS LPN Reject Transport RequestRejectTransportRequestMessage

    This message is sent by Objective to ASRS as a possible response to the StoreTransportNotificationMessage in case no destination could be determined. This message is always sent as a response to the StoreTransportRejectNotificationMessage.

    Payload

    Expand all

    object

    uid: RejectTransportRequestPayload

    device

    required

    string

    Device ID of the ASRS (set at ASRS Communication Settings)

    event

    required

    string

    Identifies the event that needs to be handled by Objective

    Const:"REJECT_TRANSPORT_COMMAND"

    parameters

    Expand all

    required

    object

    The data required for the REJECT_TRANSPORT_COMMAND event

    transportRequestKey

    required

    string

    ID of the transport order

    transportRequestName

    string

    Name of the transport order

    priority

    required

    string

    Priority of the task related to the first transport request line

    fromLocation

    Expand all

    required

    object

    uid: LocationPayload

    locationKey

    required

    string

    Full name of warehouse location.

    fullName

    required

    string

    Full name of warehouse location.

    asrsId

    string

    ASRS ID of warehouse location.

    id

    string

    ID of warehouse location.

    Additional properties are allowed.

    toLocation

    Expand all

    required

    object

    uid: LocationPayload

    locationKey

    required

    string

    Full name of warehouse location.

    fullName

    required

    string

    Full name of warehouse location.

    asrsId

    string

    ASRS ID of warehouse location.

    id

    string

    ID of warehouse location.

    Additional properties are allowed.

    specificTransportRequestLines

    Expand all

    array<object>

    lineKey

    required

    string

    Name of transport line within transport request.

    lpn

    Expand all

    required

    object

    uid: LPNPayload

    lpnKey

    required

    string

    Name of the LPN.

    containerType

    Expand all

    required

    object

    uid: ContainerTypePayload

    key

    required

    string

    Name of the container type.

    name

    required

    string

    Name of the container type.

    id

    string

    ID of the container type.

    description

    string

    Description of the container type.

    Additional properties are allowed.

    packagingKey

    string

    Name of the packaging

    dimensions

    Expand all

    object

    uid: DimensionPayload

    width

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    depth

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    height

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    volume

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    grossWeight

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    cubics

    number

    format: double

    Cubics.

    Additional properties are allowed.

    type

    string

    Is the LPN in lpnKey a nest or not

    Allowed values:
    • "LPN"
    • "NEST_LPN"

    lpnInventoryDetails

    Expand all

    array<object>

    item

    Expand all

    required

    object

    uid: ItemPayload

    itemKey

    required

    string

    Name of the item.

    name

    required

    string

    Name of the item.

    id

    string

    ID of the item.

    category

    string

    Category of the item.

    abcLPN

    string

    ABC LPN Classification.

    abcSKU

    string

    ABC LPN Classification.

    Additional properties are allowed.

    uomKey

    required

    string

    ID of the uom in which quantity is expressed.

    qcKey

    string

    Name of the quality control status. Only filled in when item is quality controlled.

    quantity

    required

    number

    format: double

    Inventory quantity.

    lotID

    string

    ID of lot. Only filled in when item is lot controlled.

    subLotID

    string

    ID of lot. Only filled in when item is sub-lot controlled.

    dtsLotProduction

    string

    format: date-time

    Date and time when the lot was produced.

    dtsLotBestBefore

    string

    format: date-time

    Date and time containing best before of lot.

    inventoryCode1

    string

    InventorCode1 of the inventory

    inventoryCode2

    string

    InventorCode2 of the inventory

    inventoryCode3

    string

    InventorCode3 of the inventory

    inventoryCode4

    string

    InventorCode4 of the inventory

    inventoryCode5

    string

    InventorCode5 of the inventory

    owner

    Expand all

    object

    uid: InventoryOwnerPayload

    ownerKey

    required

    string

    ID of the inventory owner to be used in combination with type.

    type

    required

    string

    The type of order

    Allowed values:
    • "PRODUCTION"
    • "REPACK"
    • "OUTBOUND"

    Additional properties are allowed.

    nestLPNInventoryDetails

    Expand all

    array<object>

    lpnKey

    required

    string

    Name of the LPN.

    containerType

    Expand all

    required

    object

    uid: ContainerTypePayload

    key

    required

    string

    Name of the container type.

    name

    required

    string

    Name of the container type.

    id

    string

    ID of the container type.

    description

    string

    Description of the container type.

    Additional properties are allowed.

    packagingKey

    string

    Name of the packaging

    dimensions

    Expand all

    object

    uid: DimensionPayload

    width

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    depth

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    height

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    volume

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    grossWeight

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    cubics

    number

    format: double

    Cubics.

    Additional properties are allowed.

    userFields

    Expand all

    object

    uid: UserFieldDTO

    text

    Expand all

    array<object>

    key

    required

    string

    Key of the user text field.

    title

    string

    Title of the user text field.

    value

    string

    Value of the user text field.

    numeric

    Expand all

    array<object>

    key

    required

    string

    Key of the user number field.

    title

    string

    Title of the user number field.

    value

    number

    format: double

    Value of the user number field.

    flag

    Expand all

    array<object>

    key

    required

    string

    Key of the user flag field.

    title

    string

    Title of the user flag field.

    value

    boolean

    Value of the user flag field.

    date

    Expand all

    array<object>

    key

    required

    string

    Key of the user date field.

    title

    string

    Title of the user date field.

    value

    string

    format: date-time

    Value of the user date field.

    Additional properties are allowed.

    isMixed

    boolean

    Is the LPN mixed.

    isFull

    boolean

    Is the LPN full.

    fullProgress

    number

    format: double

    If the LPN is full, the progress of it.

    lpnInventoryDetails

    Expand all

    array<object>

    item

    Expand all

    required

    object

    uid: ItemPayload

    itemKey

    required

    string

    Name of the item.

    name

    required

    string

    Name of the item.

    id

    string

    ID of the item.

    category

    string

    Category of the item.

    abcLPN

    string

    ABC LPN Classification.

    abcSKU

    string

    ABC LPN Classification.

    Additional properties are allowed.

    uomKey

    required

    string

    ID of the uom in which quantity is expressed.

    qcKey

    string

    Name of the quality control status. Only filled in when item is quality controlled.

    quantity

    required

    number

    format: double

    Inventory quantity.

    lotID

    string

    ID of lot. Only filled in when item is lot controlled.

    subLotID

    string

    ID of lot. Only filled in when item is sub-lot controlled.

    dtsLotProduction

    string

    format: date-time

    Date and time when the lot was produced.

    dtsLotBestBefore

    string

    format: date-time

    Date and time containing best before of lot.

    inventoryCode1

    string

    InventorCode1 of the inventory

    inventoryCode2

    string

    InventorCode2 of the inventory

    inventoryCode3

    string

    InventorCode3 of the inventory

    inventoryCode4

    string

    InventorCode4 of the inventory

    inventoryCode5

    string

    InventorCode5 of the inventory

    owner

    Expand all

    object

    uid: InventoryOwnerPayload

    ownerKey

    required

    string

    ID of the inventory owner to be used in combination with type.

    type

    required

    string

    The type of order

    Allowed values:
    • "PRODUCTION"
    • "REPACK"
    • "OUTBOUND"

    Additional properties are allowed.

    userFields

    Expand all

    object

    uid: UserFieldDTO

    text

    Expand all

    array<object>

    key

    required

    string

    Key of the user text field.

    title

    string

    Title of the user text field.

    value

    string

    Value of the user text field.

    numeric

    Expand all

    array<object>

    key

    required

    string

    Key of the user number field.

    title

    string

    Title of the user number field.

    value

    number

    format: double

    Value of the user number field.

    flag

    Expand all

    array<object>

    key

    required

    string

    Key of the user flag field.

    title

    string

    Title of the user flag field.

    value

    boolean

    Value of the user flag field.

    date

    Expand all

    array<object>

    key

    required

    string

    Key of the user date field.

    title

    string

    Title of the user date field.

    value

    string

    format: date-time

    Value of the user date field.

    Additional properties are allowed.

    isMixed

    boolean

    Is the LPN mixed.

    isFull

    boolean

    Is the LPN full.

    fullProgress

    number

    format: double

    If the LPN is full, the progress of it.

    Additional properties are allowed.

    orderReference

    Expand all

    object

    uid: OrderReferencePayload

    orderKey

    required

    string

    ID of the associated order(s) within Objective.

    type

    required

    string

    The type of order

    Allowed values:
    • "PRODUCTION"
    • "OUTBOUND"
    • "RECEIPT"
    • "RETURN"
    • "SHIP"
    • "MOVE"

    Additional properties are allowed.

    dtsCreated

    string

    format: date-timeuid: DtsCreatedPayload

    Date and time when the request was created.

    dtsOccured

    string

    format: date-timeuid: DtsOccurredPayload

    Date and time when the event occured.

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

    {
      "device": "ASRS_LPN",
      "event": "REJECT_TRANSPORT_COMMAND",
      "parameters": {
        "transportRequestKey": "TR1234567890",
        "transportRequestName": "string",
        "priority": 1,
        "fromLocation": {
          "locationKey": "string",
          "fullName": "string",
          "asrsId": "string",
          "id": "string"
        },
        "toLocation": {
          "locationKey": "string",
          "fullName": "string",
          "asrsId": "string",
          "id": "string"
        },
        "specificTransportRequestLines": [
          {
            "lineKey": "string",
            "lpn": {
              "lpnKey": "string",
              "containerType": {
                "key": "string",
                "name": "string",
                "id": "string",
                "description": "string"
              },
              "packagingKey": "string",
              "dimensions": {
                "width": {
                  "value": 0,
                  "uomKey": "string"
                },
                "depth": {
                  "value": 0,
                  "uomKey": "string"
                },
                "height": {
                  "value": 0,
                  "uomKey": "string"
                },
                "volume": {
                  "value": 0,
                  "uomKey": "string"
                },
                "grossWeight": {
                  "value": 0,
                  "uomKey": "string"
                },
                "cubics": 0
              },
              "type": "LPN",
              "lpnInventoryDetails": [
                {
                  "item": {
                    "itemKey": "string",
                    "name": "string",
                    "id": "string",
                    "category": "string",
                    "abcLPN": "string",
                    "abcSKU": "string"
                  },
                  "uomKey": "string",
                  "qcKey": "string",
                  "quantity": 0,
                  "lotID": "string",
                  "subLotID": "string",
                  "dtsLotProduction": "2019-08-24T14:15:22Z",
                  "dtsLotBestBefore": "2019-08-24T14:15:22Z",
                  "inventoryCode1": "string",
                  "inventoryCode2": "string",
                  "inventoryCode3": "string",
                  "inventoryCode4": "string",
                  "inventoryCode5": "string",
                  "owner": {
                    "ownerKey": "string",
                    "type": "PRODUCTION"
                  }
                }
              ],
              "nestLPNInventoryDetails": [
                {
                  "lpnKey": "string",
                  "containerType": {
                    "key": "string",
                    "name": "string",
                    "id": "string",
                    "description": "string"
                  },
                  "packagingKey": "string",
                  "dimensions": {
                    "width": {
                      "value": 0,
                      "uomKey": "string"
                    },
                    "depth": {
                      "value": 0,
                      "uomKey": "string"
                    },
                    "height": {
                      "value": 0,
                      "uomKey": "string"
                    },
                    "volume": {
                      "value": 0,
                      "uomKey": "string"
                    },
                    "grossWeight": {
                      "value": 0,
                      "uomKey": "string"
                    },
                    "cubics": 0
                  },
                  "userFields": {
                    "text": [
                      {
                        "key": "string",
                        "title": "string",
                        "value": "string"
                      }
                    ],
                    "numeric": [
                      {
                        "key": "string",
                        "title": "string",
                        "value": 0.1
                      }
                    ],
                    "flag": [
                      {
                        "key": "string",
                        "title": "string",
                        "value": true
                      }
                    ],
                    "date": [
                      {
                        "key": "string",
                        "title": "string",
                        "value": "2019-08-24T14:15:22Z"
                      }
                    ]
                  },
                  "isMixed": true,
                  "isFull": true,
                  "fullProgress": 0.1,
                  "lpnInventoryDetails": [
                    {
                      "item": {
                        "itemKey": "string",
                        "name": "string",
                        "id": "string",
                        "category": "string",
                        "abcLPN": "string",
                        "abcSKU": "string"
                      },
                      "uomKey": "string",
                      "qcKey": "string",
                      "quantity": 0,
                      "lotID": "string",
                      "subLotID": "string",
                      "dtsLotProduction": "2019-08-24T14:15:22Z",
                      "dtsLotBestBefore": "2019-08-24T14:15:22Z",
                      "inventoryCode1": "string",
                      "inventoryCode2": "string",
                      "inventoryCode3": "string",
                      "inventoryCode4": "string",
                      "inventoryCode5": "string",
                      "owner": {
                        "ownerKey": "string",
                        "type": "PRODUCTION"
                      }
                    }
                  ]
                }
              ],
              "userFields": {
                "text": [
                  {
                    "key": "string",
                    "title": "string",
                    "value": "string"
                  }
                ],
                "numeric": [
                  {
                    "key": "string",
                    "title": "string",
                    "value": 0.1
                  }
                ],
                "flag": [
                  {
                    "key": "string",
                    "title": "string",
                    "value": true
                  }
                ],
                "date": [
                  {
                    "key": "string",
                    "title": "string",
                    "value": "2019-08-24T14:15:22Z"
                  }
                ]
              },
              "isMixed": true,
              "isFull": true,
              "fullProgress": 0.1
            },
            "orderReference": {
              "orderKey": "string",
              "type": "PRODUCTION"
            }
          }
        ],
        "dtsCreated": "2019-08-24T14:15:22Z",
        "dtsOccured": "2019-08-24T14:15:22Z"
      }
    }
    

    This example has been generated automatically.

  • #2ASRS LPN Retrieve Transport RequestRetrieveTransportRequestMessage

    This message is sent by Objective to ASRS to retrieve inventory from the ASRS.

    Payload

    Expand all

    object

    uid: RetrieveTransportRequestPayload

    device

    required

    string

    Device ID of the ASRS (set at ASRS Communication Settings)

    event

    required

    string

    Identifies the event that needs to be handled by Objective

    Const:"RETRIEVE_TRANSPORT_COMMAND"

    parameters

    Expand all

    required

    object

    The data required for the RETRIEVE_TRANSPORT_COMMAND event

    transportRequestKey

    required

    string

    ID of the transport order

    transportRequestName

    string

    Name of the transport order

    priority

    required

    string

    Priority of the task related to the first transport request line

    fromLocation

    Expand all

    required

    object

    uid: LocationPayload

    locationKey

    required

    string

    Full name of warehouse location.

    fullName

    required

    string

    Full name of warehouse location.

    asrsId

    string

    ASRS ID of warehouse location.

    id

    string

    ID of warehouse location.

    Additional properties are allowed.

    toLocation

    Expand all

    required

    object

    uid: LocationPayload

    locationKey

    required

    string

    Full name of warehouse location.

    fullName

    required

    string

    Full name of warehouse location.

    asrsId

    string

    ASRS ID of warehouse location.

    id

    string

    ID of warehouse location.

    Additional properties are allowed.

    specificTransportRequestLines

    Expand all

    array<object>

    lineKey

    required

    string

    Name of transport line within transport request.

    lpn

    Expand all

    required

    object

    uid: LPNPayload

    lpnKey

    required

    string

    Name of the LPN.

    containerType

    Expand all

    required

    object

    uid: ContainerTypePayload

    key

    required

    string

    Name of the container type.

    name

    required

    string

    Name of the container type.

    id

    string

    ID of the container type.

    description

    string

    Description of the container type.

    Additional properties are allowed.

    packagingKey

    string

    Name of the packaging

    dimensions

    Expand all

    object

    uid: DimensionPayload

    width

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    depth

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    height

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    volume

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    grossWeight

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    cubics

    number

    format: double

    Cubics.

    Additional properties are allowed.

    type

    string

    Is the LPN in lpnKey a nest or not

    Allowed values:
    • "LPN"
    • "NEST_LPN"

    lpnInventoryDetails

    Expand all

    array<object>

    item

    Expand all

    required

    object

    uid: ItemPayload

    itemKey

    required

    string

    Name of the item.

    name

    required

    string

    Name of the item.

    id

    string

    ID of the item.

    category

    string

    Category of the item.

    abcLPN

    string

    ABC LPN Classification.

    abcSKU

    string

    ABC LPN Classification.

    Additional properties are allowed.

    uomKey

    required

    string

    ID of the uom in which quantity is expressed.

    qcKey

    string

    Name of the quality control status. Only filled in when item is quality controlled.

    quantity

    required

    number

    format: double

    Inventory quantity.

    lotID

    string

    ID of lot. Only filled in when item is lot controlled.

    subLotID

    string

    ID of lot. Only filled in when item is sub-lot controlled.

    dtsLotProduction

    string

    format: date-time

    Date and time when the lot was produced.

    dtsLotBestBefore

    string

    format: date-time

    Date and time containing best before of lot.

    inventoryCode1

    string

    InventorCode1 of the inventory

    inventoryCode2

    string

    InventorCode2 of the inventory

    inventoryCode3

    string

    InventorCode3 of the inventory

    inventoryCode4

    string

    InventorCode4 of the inventory

    inventoryCode5

    string

    InventorCode5 of the inventory

    owner

    Expand all

    object

    uid: InventoryOwnerPayload

    ownerKey

    required

    string

    ID of the inventory owner to be used in combination with type.

    type

    required

    string

    The type of order

    Allowed values:
    • "PRODUCTION"
    • "REPACK"
    • "OUTBOUND"

    Additional properties are allowed.

    nestLPNInventoryDetails

    Expand all

    array<object>

    lpnKey

    required

    string

    Name of the LPN.

    containerType

    Expand all

    required

    object

    uid: ContainerTypePayload

    key

    required

    string

    Name of the container type.

    name

    required

    string

    Name of the container type.

    id

    string

    ID of the container type.

    description

    string

    Description of the container type.

    Additional properties are allowed.

    packagingKey

    string

    Name of the packaging

    dimensions

    Expand all

    object

    uid: DimensionPayload

    width

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    depth

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    height

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    volume

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    grossWeight

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    cubics

    number

    format: double

    Cubics.

    Additional properties are allowed.

    userFields

    Expand all

    object

    uid: UserFieldDTO

    text

    Expand all

    array<object>

    key

    required

    string

    Key of the user text field.

    title

    string

    Title of the user text field.

    value

    string

    Value of the user text field.

    numeric

    Expand all

    array<object>

    key

    required

    string

    Key of the user number field.

    title

    string

    Title of the user number field.

    value

    number

    format: double

    Value of the user number field.

    flag

    Expand all

    array<object>

    key

    required

    string

    Key of the user flag field.

    title

    string

    Title of the user flag field.

    value

    boolean

    Value of the user flag field.

    date

    Expand all

    array<object>

    key

    required

    string

    Key of the user date field.

    title

    string

    Title of the user date field.

    value

    string

    format: date-time

    Value of the user date field.

    Additional properties are allowed.

    isMixed

    boolean

    Is the LPN mixed.

    isFull

    boolean

    Is the LPN full.

    fullProgress

    number

    format: double

    If the LPN is full, the progress of it.

    lpnInventoryDetails

    Expand all

    array<object>

    item

    Expand all

    required

    object

    uid: ItemPayload

    itemKey

    required

    string

    Name of the item.

    name

    required

    string

    Name of the item.

    id

    string

    ID of the item.

    category

    string

    Category of the item.

    abcLPN

    string

    ABC LPN Classification.

    abcSKU

    string

    ABC LPN Classification.

    Additional properties are allowed.

    uomKey

    required

    string

    ID of the uom in which quantity is expressed.

    qcKey

    string

    Name of the quality control status. Only filled in when item is quality controlled.

    quantity

    required

    number

    format: double

    Inventory quantity.

    lotID

    string

    ID of lot. Only filled in when item is lot controlled.

    subLotID

    string

    ID of lot. Only filled in when item is sub-lot controlled.

    dtsLotProduction

    string

    format: date-time

    Date and time when the lot was produced.

    dtsLotBestBefore

    string

    format: date-time

    Date and time containing best before of lot.

    inventoryCode1

    string

    InventorCode1 of the inventory

    inventoryCode2

    string

    InventorCode2 of the inventory

    inventoryCode3

    string

    InventorCode3 of the inventory

    inventoryCode4

    string

    InventorCode4 of the inventory

    inventoryCode5

    string

    InventorCode5 of the inventory

    owner

    Expand all

    object

    uid: InventoryOwnerPayload

    ownerKey

    required

    string

    ID of the inventory owner to be used in combination with type.

    type

    required

    string

    The type of order

    Allowed values:
    • "PRODUCTION"
    • "REPACK"
    • "OUTBOUND"

    Additional properties are allowed.

    userFields

    Expand all

    object

    uid: UserFieldDTO

    text

    Expand all

    array<object>

    key

    required

    string

    Key of the user text field.

    title

    string

    Title of the user text field.

    value

    string

    Value of the user text field.

    numeric

    Expand all

    array<object>

    key

    required

    string

    Key of the user number field.

    title

    string

    Title of the user number field.

    value

    number

    format: double

    Value of the user number field.

    flag

    Expand all

    array<object>

    key

    required

    string

    Key of the user flag field.

    title

    string

    Title of the user flag field.

    value

    boolean

    Value of the user flag field.

    date

    Expand all

    array<object>

    key

    required

    string

    Key of the user date field.

    title

    string

    Title of the user date field.

    value

    string

    format: date-time

    Value of the user date field.

    Additional properties are allowed.

    isMixed

    boolean

    Is the LPN mixed.

    isFull

    boolean

    Is the LPN full.

    fullProgress

    number

    format: double

    If the LPN is full, the progress of it.

    Additional properties are allowed.

    orderReference

    Expand all

    object

    uid: OrderReferencePayload

    orderKey

    required

    string

    ID of the associated order(s) within Objective.

    type

    required

    string

    The type of order

    Allowed values:
    • "PRODUCTION"
    • "OUTBOUND"
    • "RECEIPT"
    • "RETURN"
    • "SHIP"
    • "MOVE"

    Additional properties are allowed.

    dtsCreated

    string

    format: date-timeuid: DtsCreatedPayload

    Date and time when the request was created.

    dtsOccured

    string

    format: date-timeuid: DtsOccurredPayload

    Date and time when the event occured.

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

    {
      "device": "ASRS_LPN",
      "event": "RETRIEVE_TRANSPORT_COMMAND",
      "parameters": {
        "transportRequestKey": "TR1234567890",
        "transportRequestName": "string",
        "priority": 1,
        "fromLocation": {
          "locationKey": "string",
          "fullName": "string",
          "asrsId": "string",
          "id": "string"
        },
        "toLocation": {
          "locationKey": "string",
          "fullName": "string",
          "asrsId": "string",
          "id": "string"
        },
        "specificTransportRequestLines": [
          {
            "lineKey": "string",
            "lpn": {
              "lpnKey": "string",
              "containerType": {
                "key": "string",
                "name": "string",
                "id": "string",
                "description": "string"
              },
              "packagingKey": "string",
              "dimensions": {
                "width": {
                  "value": 0,
                  "uomKey": "string"
                },
                "depth": {
                  "value": 0,
                  "uomKey": "string"
                },
                "height": {
                  "value": 0,
                  "uomKey": "string"
                },
                "volume": {
                  "value": 0,
                  "uomKey": "string"
                },
                "grossWeight": {
                  "value": 0,
                  "uomKey": "string"
                },
                "cubics": 0
              },
              "type": "LPN",
              "lpnInventoryDetails": [
                {
                  "item": {
                    "itemKey": "string",
                    "name": "string",
                    "id": "string",
                    "category": "string",
                    "abcLPN": "string",
                    "abcSKU": "string"
                  },
                  "uomKey": "string",
                  "qcKey": "string",
                  "quantity": 0,
                  "lotID": "string",
                  "subLotID": "string",
                  "dtsLotProduction": "2019-08-24T14:15:22Z",
                  "dtsLotBestBefore": "2019-08-24T14:15:22Z",
                  "inventoryCode1": "string",
                  "inventoryCode2": "string",
                  "inventoryCode3": "string",
                  "inventoryCode4": "string",
                  "inventoryCode5": "string",
                  "owner": {
                    "ownerKey": "string",
                    "type": "PRODUCTION"
                  }
                }
              ],
              "nestLPNInventoryDetails": [
                {
                  "lpnKey": "string",
                  "containerType": {
                    "key": "string",
                    "name": "string",
                    "id": "string",
                    "description": "string"
                  },
                  "packagingKey": "string",
                  "dimensions": {
                    "width": {
                      "value": 0,
                      "uomKey": "string"
                    },
                    "depth": {
                      "value": 0,
                      "uomKey": "string"
                    },
                    "height": {
                      "value": 0,
                      "uomKey": "string"
                    },
                    "volume": {
                      "value": 0,
                      "uomKey": "string"
                    },
                    "grossWeight": {
                      "value": 0,
                      "uomKey": "string"
                    },
                    "cubics": 0
                  },
                  "userFields": {
                    "text": [
                      {
                        "key": "string",
                        "title": "string",
                        "value": "string"
                      }
                    ],
                    "numeric": [
                      {
                        "key": "string",
                        "title": "string",
                        "value": 0.1
                      }
                    ],
                    "flag": [
                      {
                        "key": "string",
                        "title": "string",
                        "value": true
                      }
                    ],
                    "date": [
                      {
                        "key": "string",
                        "title": "string",
                        "value": "2019-08-24T14:15:22Z"
                      }
                    ]
                  },
                  "isMixed": true,
                  "isFull": true,
                  "fullProgress": 0.1,
                  "lpnInventoryDetails": [
                    {
                      "item": {
                        "itemKey": "string",
                        "name": "string",
                        "id": "string",
                        "category": "string",
                        "abcLPN": "string",
                        "abcSKU": "string"
                      },
                      "uomKey": "string",
                      "qcKey": "string",
                      "quantity": 0,
                      "lotID": "string",
                      "subLotID": "string",
                      "dtsLotProduction": "2019-08-24T14:15:22Z",
                      "dtsLotBestBefore": "2019-08-24T14:15:22Z",
                      "inventoryCode1": "string",
                      "inventoryCode2": "string",
                      "inventoryCode3": "string",
                      "inventoryCode4": "string",
                      "inventoryCode5": "string",
                      "owner": {
                        "ownerKey": "string",
                        "type": "PRODUCTION"
                      }
                    }
                  ]
                }
              ],
              "userFields": {
                "text": [
                  {
                    "key": "string",
                    "title": "string",
                    "value": "string"
                  }
                ],
                "numeric": [
                  {
                    "key": "string",
                    "title": "string",
                    "value": 0.1
                  }
                ],
                "flag": [
                  {
                    "key": "string",
                    "title": "string",
                    "value": true
                  }
                ],
                "date": [
                  {
                    "key": "string",
                    "title": "string",
                    "value": "2019-08-24T14:15:22Z"
                  }
                ]
              },
              "isMixed": true,
              "isFull": true,
              "fullProgress": 0.1
            },
            "orderReference": {
              "orderKey": "string",
              "type": "PRODUCTION"
            }
          }
        ],
        "dtsCreated": "2019-08-24T14:15:22Z",
        "dtsOccured": "2019-08-24T14:15:22Z"
      }
    }
    

    This example has been generated automatically.

  • #3ASRS LPN Move Transport RequestMoveTransportRequestMessage

    This message is sent by Objective to ASRS to move inventory within ASRS to the specified location.

    Payload

    Expand all

    object

    uid: MoveTransportRequestPayload

    device

    required

    string

    Device ID of the ASRS (set at ASRS Communication Settings)

    event

    required

    string

    Identifies the event that needs to be handled by Objective

    Const:"MOVE_COMMAND"

    parameters

    Expand all

    required

    object

    The data required for the MOVE_COMMAND event

    transportRequestKey

    required

    string

    ID of the transport order

    transportRequestName

    string

    Name of the transport order

    priority

    required

    string

    Priority of the task related to the first transport request line

    fromLocation

    Expand all

    required

    object

    uid: LocationPayload

    locationKey

    required

    string

    Full name of warehouse location.

    fullName

    required

    string

    Full name of warehouse location.

    asrsId

    string

    ASRS ID of warehouse location.

    id

    string

    ID of warehouse location.

    Additional properties are allowed.

    toLocation

    Expand all

    required

    object

    uid: LocationPayload

    locationKey

    required

    string

    Full name of warehouse location.

    fullName

    required

    string

    Full name of warehouse location.

    asrsId

    string

    ASRS ID of warehouse location.

    id

    string

    ID of warehouse location.

    Additional properties are allowed.

    specificTransportRequestLines

    Expand all

    array<object>

    lineKey

    required

    string

    Name of transport line within transport request.

    lpn

    Expand all

    required

    object

    uid: LPNPayload

    lpnKey

    required

    string

    Name of the LPN.

    containerType

    Expand all

    required

    object

    uid: ContainerTypePayload

    key

    required

    string

    Name of the container type.

    name

    required

    string

    Name of the container type.

    id

    string

    ID of the container type.

    description

    string

    Description of the container type.

    Additional properties are allowed.

    packagingKey

    string

    Name of the packaging

    dimensions

    Expand all

    object

    uid: DimensionPayload

    width

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    depth

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    height

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    volume

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    grossWeight

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    cubics

    number

    format: double

    Cubics.

    Additional properties are allowed.

    type

    string

    Is the LPN in lpnKey a nest or not

    Allowed values:
    • "LPN"
    • "NEST_LPN"

    lpnInventoryDetails

    Expand all

    array<object>

    item

    Expand all

    required

    object

    uid: ItemPayload

    itemKey

    required

    string

    Name of the item.

    name

    required

    string

    Name of the item.

    id

    string

    ID of the item.

    category

    string

    Category of the item.

    abcLPN

    string

    ABC LPN Classification.

    abcSKU

    string

    ABC LPN Classification.

    Additional properties are allowed.

    uomKey

    required

    string

    ID of the uom in which quantity is expressed.

    qcKey

    string

    Name of the quality control status. Only filled in when item is quality controlled.

    quantity

    required

    number

    format: double

    Inventory quantity.

    lotID

    string

    ID of lot. Only filled in when item is lot controlled.

    subLotID

    string

    ID of lot. Only filled in when item is sub-lot controlled.

    dtsLotProduction

    string

    format: date-time

    Date and time when the lot was produced.

    dtsLotBestBefore

    string

    format: date-time

    Date and time containing best before of lot.

    inventoryCode1

    string

    InventorCode1 of the inventory

    inventoryCode2

    string

    InventorCode2 of the inventory

    inventoryCode3

    string

    InventorCode3 of the inventory

    inventoryCode4

    string

    InventorCode4 of the inventory

    inventoryCode5

    string

    InventorCode5 of the inventory

    owner

    Expand all

    object

    uid: InventoryOwnerPayload

    ownerKey

    required

    string

    ID of the inventory owner to be used in combination with type.

    type

    required

    string

    The type of order

    Allowed values:
    • "PRODUCTION"
    • "REPACK"
    • "OUTBOUND"

    Additional properties are allowed.

    nestLPNInventoryDetails

    Expand all

    array<object>

    lpnKey

    required

    string

    Name of the LPN.

    containerType

    Expand all

    required

    object

    uid: ContainerTypePayload

    key

    required

    string

    Name of the container type.

    name

    required

    string

    Name of the container type.

    id

    string

    ID of the container type.

    description

    string

    Description of the container type.

    Additional properties are allowed.

    packagingKey

    string

    Name of the packaging

    dimensions

    Expand all

    object

    uid: DimensionPayload

    width

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    depth

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    height

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    volume

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    grossWeight

    Expand all

    object

    uid: DimensionValuePayload

    value

    required

    number

    format: double

    Dimension value.

    uomKey

    required

    string

    Name of the UOM.

    Additional properties are allowed.

    cubics

    number

    format: double

    Cubics.

    Additional properties are allowed.

    userFields

    Expand all

    object

    uid: UserFieldDTO

    text

    Expand all

    array<object>

    key

    required

    string

    Key of the user text field.

    title

    string

    Title of the user text field.

    value

    string

    Value of the user text field.

    numeric

    Expand all

    array<object>

    key

    required

    string

    Key of the user number field.

    title

    string

    Title of the user number field.

    value

    number

    format: double

    Value of the user number field.

    flag

    Expand all

    array<object>

    key

    required

    string

    Key of the user flag field.

    title

    string

    Title of the user flag field.

    value

    boolean

    Value of the user flag field.

    date

    Expand all

    array<object>

    key

    required

    string

    Key of the user date field.

    title

    string

    Title of the user date field.

    value

    string

    format: date-time

    Value of the user date field.

    Additional properties are allowed.

    isMixed

    boolean

    Is the LPN mixed.

    isFull

    boolean

    Is the LPN full.

    fullProgress

    number

    format: double

    If the LPN is full, the progress of it.

    lpnInventoryDetails

    Expand all

    array<object>

    item

    Expand all

    required

    object

    uid: ItemPayload

    itemKey

    required

    string

    Name of the item.

    name

    required

    string

    Name of the item.

    id

    string

    ID of the item.

    category

    string

    Category of the item.

    abcLPN

    string

    ABC LPN Classification.

    abcSKU

    string

    ABC LPN Classification.

    Additional properties are allowed.

    uomKey

    required

    string

    ID of the uom in which quantity is expressed.

    qcKey

    string

    Name of the quality control status. Only filled in when item is quality controlled.

    quantity

    required

    number

    format: double

    Inventory quantity.

    lotID

    string

    ID of lot. Only filled in when item is lot controlled.

    subLotID

    string

    ID of lot. Only filled in when item is sub-lot controlled.

    dtsLotProduction

    string

    format: date-time

    Date and time when the lot was produced.

    dtsLotBestBefore

    string

    format: date-time

    Date and time containing best before of lot.

    inventoryCode1

    string

    InventorCode1 of the inventory

    inventoryCode2

    string

    InventorCode2 of the inventory

    inventoryCode3

    string

    InventorCode3 of the inventory

    inventoryCode4

    string

    InventorCode4 of the inventory

    inventoryCode5

    string

    InventorCode5 of the inventory

    owner

    Expand all

    object

    uid: InventoryOwnerPayload

    ownerKey

    required

    string

    ID of the inventory owner to be used in combination with type.

    type

    required

    string

    The type of order

    Allowed values:
    • "PRODUCTION"
    • "REPACK"
    • "OUTBOUND"

    Additional properties are allowed.

    userFields

    Expand all

    object

    uid: UserFieldDTO

    text

    Expand all

    array<object>

    key

    required

    string

    Key of the user text field.

    title

    string

    Title of the user text field.

    value

    string

    Value of the user text field.

    numeric

    Expand all

    array<object>

    key

    required

    string

    Key of the user number field.

    title

    string

    Title of the user number field.

    value

    number

    format: double

    Value of the user number field.

    flag

    Expand all

    array<object>

    key

    required

    string

    Key of the user flag field.

    title

    string

    Title of the user flag field.

    value

    boolean

    Value of the user flag field.

    date

    Expand all

    array<object>

    key

    required

    string

    Key of the user date field.

    title

    string

    Title of the user date field.

    value

    string

    format: date-time

    Value of the user date field.

    Additional properties are allowed.

    isMixed

    boolean

    Is the LPN mixed.

    isFull

    boolean

    Is the LPN full.

    fullProgress

    number

    format: double

    If the LPN is full, the progress of it.

    Additional properties are allowed.

    orderReference

    Expand all

    object

    uid: OrderReferencePayload

    orderKey

    required

    string

    ID of the associated order(s) within Objective.

    type

    required

    string

    The type of order

    Allowed values:
    • "PRODUCTION"
    • "OUTBOUND"
    • "RECEIPT"
    • "RETURN"
    • "SHIP"
    • "MOVE"

    Additional properties are allowed.

    dtsCreated

    string

    format: date-timeuid: DtsCreatedPayload

    Date and time when the request was created.

    dtsOccured

    string

    format: date-timeuid: DtsOccurredPayload

    Date and time when the event occured.

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

    {
      "device": "ASRS_LPN",
      "event": "MOVE_COMMAND",
      "parameters": {
        "transportRequestKey": "TR1234567890",
        "transportRequestName": "string",
        "priority": 1,
        "fromLocation": {
          "locationKey": "string",
          "fullName": "string",
          "asrsId": "string",
          "id": "string"
        },
        "toLocation": {
          "locationKey": "string",
          "fullName": "string",
          "asrsId": "string",
          "id": "string"
        },
        "specificTransportRequestLines": [
          {
            "lineKey": "string",
            "lpn": {
              "lpnKey": "string",
              "containerType": {
                "key": "string",
                "name": "string",
                "id": "string",
                "description": "string"
              },
              "packagingKey": "string",
              "dimensions": {
                "width": {
                  "value": 0,
                  "uomKey": "string"
                },
                "depth": {
                  "value": 0,
                  "uomKey": "string"
                },
                "height": {
                  "value": 0,
                  "uomKey": "string"
                },
                "volume": {
                  "value": 0,
                  "uomKey": "string"
                },
                "grossWeight": {
                  "value": 0,
                  "uomKey": "string"
                },
                "cubics": 0
              },
              "type": "LPN",
              "lpnInventoryDetails": [
                {
                  "item": {
                    "itemKey": "string",
                    "name": "string",
                    "id": "string",
                    "category": "string",
                    "abcLPN": "string",
                    "abcSKU": "string"
                  },
                  "uomKey": "string",
                  "qcKey": "string",
                  "quantity": 0,
                  "lotID": "string",
                  "subLotID": "string",
                  "dtsLotProduction": "2019-08-24T14:15:22Z",
                  "dtsLotBestBefore": "2019-08-24T14:15:22Z",
                  "inventoryCode1": "string",
                  "inventoryCode2": "string",
                  "inventoryCode3": "string",
                  "inventoryCode4": "string",
                  "inventoryCode5": "string",
                  "owner": {
                    "ownerKey": "string",
                    "type": "PRODUCTION"
                  }
                }
              ],
              "nestLPNInventoryDetails": [
                {
                  "lpnKey": "string",
                  "containerType": {
                    "key": "string",
                    "name": "string",
                    "id": "string",
                    "description": "string"
                  },
                  "packagingKey": "string",
                  "dimensions": {
                    "width": {
                      "value": 0,
                      "uomKey": "string"
                    },
                    "depth": {
                      "value": 0,
                      "uomKey": "string"
                    },
                    "height": {
                      "value": 0,
                      "uomKey": "string"
                    },
                    "volume": {
                      "value": 0,
                      "uomKey": "string"
                    },
                    "grossWeight": {
                      "value": 0,
                      "uomKey": "string"
                    },
                    "cubics": 0
                  },
                  "userFields": {
                    "text": [
                      {
                        "key": "string",
                        "title": "string",
                        "value": "string"
                      }
                    ],
                    "numeric": [
                      {
                        "key": "string",
                        "title": "string",
                        "value": 0.1
                      }
                    ],
                    "flag": [
                      {
                        "key": "string",
                        "title": "string",
                        "value": true
                      }
                    ],
                    "date": [
                      {
                        "key": "string",
                        "title": "string",
                        "value": "2019-08-24T14:15:22Z"
                      }
                    ]
                  },
                  "isMixed": true,
                  "isFull": true,
                  "fullProgress": 0.1,
                  "lpnInventoryDetails": [
                    {
                      "item": {
                        "itemKey": "string",
                        "name": "string",
                        "id": "string",
                        "category": "string",
                        "abcLPN": "string",
                        "abcSKU": "string"
                      },
                      "uomKey": "string",
                      "qcKey": "string",
                      "quantity": 0,
                      "lotID": "string",
                      "subLotID": "string",
                      "dtsLotProduction": "2019-08-24T14:15:22Z",
                      "dtsLotBestBefore": "2019-08-24T14:15:22Z",
                      "inventoryCode1": "string",
                      "inventoryCode2": "string",
                      "inventoryCode3": "string",
                      "inventoryCode4": "string",
                      "inventoryCode5": "string",
                      "owner": {
                        "ownerKey": "string",
                        "type": "PRODUCTION"
                      }
                    }
                  ]
                }
              ],
              "userFields": {
                "text": [
                  {
                    "key": "string",
                    "title": "string",
                    "value": "string"
                  }
                ],
                "numeric": [
                  {
                    "key": "string",
                    "title": "string",
                    "value": 0.1
                  }
                ],
                "flag": [
                  {
                    "key": "string",
                    "title": "string",
                    "value": true
                  }
                ],
                "date": [
                  {
                    "key": "string",
                    "title": "string",
                    "value": "2019-08-24T14:15:22Z"
                  }
                ]
              },
              "isMixed": true,
              "isFull": true,
              "fullProgress": 0.1
            },
            "orderReference": {
              "orderKey": "string",
              "type": "PRODUCTION"
            }
          }
        ],
        "dtsCreated": "2019-08-24T14:15:22Z",
        "dtsOccured": "2019-08-24T14:15:22Z"
      }
    }
    

    This example has been generated automatically.

  • #4Cancel Transport RequestCancelTransportRequestMessage

    This message is sent by Objective to ASRS when someone aborts a TransportOrder in the Supervisor.

    Payload

    Expand all

    object

    uid: CancelTransportRequestPayload

    device

    required

    string

    Device ID of the ASRS (set at ASRS Communication Settings)

    command

    required

    string

    Identifies the command that needs to be handled by the ASRS

    Const:"CANCEL_COMMAND"

    parameters

    Expand all

    required

    object

    The data required for the CANCEL_COMMAND command

    transportRequestKey

    required

    string

    ID of the transport order

    dtsCreated

    string

    format: date-timeuid: DtsCreatedPayload

    Date and time when the request was created.

    dtsOccured

    string

    format: date-timeuid: DtsOccurredPayload

    Date and time when the event occured.

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

    {
      "device": "ASRS_LPN",
      "command": "CANCEL_COMMAND",
      "parameters": {
        "transportRequestKey": "ATR0000000001",
        "dtsCreated": "2019-08-24T14:15:22Z",
        "dtsOccured": "2019-08-24T14:15:22Z"
      }
    }
    

    This example has been generated automatically.