Headers

• request-id string

  Unique identifier for the API request. Example: f7ecf495-ca1c-4468-a6c2-6ee3f723fa00

Path parameters

• consignmentId string Required

  The identifier of the Consignment

Query parameters

• limit string

  Number of items to return. Default: 10. Maximum: 10000

• nextToken string

  Pagination token to get next page of items

Responses

• 200 application/json

  200 response

  Hide response attributes Show response attributes object

  • total integer(int32)

    The total number of items in all pages of results

    Minimum value is 0, maximum value is 1000000.

  • nextToken string

    Pagination token

    Maximum length is 5000. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

  • items array[object] Required
    Hide items attributes Show items attributes object

    • trackingRef string Required

      The tracking reference that identifies the Piece in the user system

      Maximum length is 500.

    • inFacilities array[object]

      Not more than 10000 elements.

      Hide inFacilities attributes Show inFacilities attributes object

      • hasExited boolean

        Indicate whether the item has exited the Facility

      • facilityId string(uuid) Required

        Unique identifier of the Facility. Example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'

        Maximum length is 36. Format should match the following pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$.

      • enteredOn string(date-time) Required

        Date that the item entered the Facility. Example: '2023-07-21T17:32:28Z'

        Maximum length is 20. Format should match the following pattern: ^[0-9TZ:-]*$.

      • facilityName string Required

        The name of the Facility

        Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

      • exitedOn string(date-time)

        Date that the item exited the Facility. Example: '2023-07-21T17:32:28Z'

        Maximum length is 20. Format should match the following pattern: ^[0-9TZ:-]*$.

      • userFacilityId string

        A facility identifier relevant to the user

        Maximum length is 500.

    • consignmentId string(uuid) Required

      Unique identifier of the Consignment. Example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'

      Maximum length is 36. Format should match the following pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$.

    • id string Required

      Unique identifier of the Piece. Example: '00Es43YBJfNRXNSvLmni'

      Maximum length is 20. Format should match the following pattern: ^[-_A-Za-z0-9]*$.

    • label object

      Additional properties are NOT allowed.

      Hide label attributes Show label attributes object

      • bleId integer(int32) Required

        Label BLE identifier. Example: 123

        Minimum value is 0, maximum value is 2147483647.

      • nfcId string Required

        Label NFC identifier, used when creating an Asset and linking a Label at the same time. Example: '0000007B'

        Maximum length is 20. Format should match the following pattern: ^[a-zA-Z0-9]*$.

      • addedOn string(date-time) Required

        Date that the Label was linked to the Asset, in UTC. Example: '2019-07-21T17:32:28Z'

        Maximum length is 20. Format should match the following pattern: ^[0-9TZ:-]*$.

    • createdOn string(date-time)

      Date that the item was created, in UTC. Example: '2019-07-21T17:32:28Z'

      Maximum length is 20. Format should match the following pattern: ^[0-9TZ:-]*$.

    • workspaceId string(uuid) Required

      Unique identifier of the workspace. Example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'

      Maximum length is 36. Format should match the following pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$.

• 401 application/json

  Unauthorized

  Hide response attribute Show response attribute object

  • errors array[object] Required
    Hide errors attributes Show errors attributes object

    • code string

      An application-specific error code, expressed as a string value

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • id string

      A unique identifier for this particular occurrence of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • detail string

      A human-readable explanation specific to this occurrence of the problem

      Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • title string

      A short, human-readable summary of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • status string

      The HTTP status code applicable to this problem, expressed as a string value

      Maximum length is 3. Format should match the following pattern: ^[0-9]*$.

• 403 application/json

  Forbidden

  Hide response attribute Show response attribute object

  • errors array[object] Required
    Hide errors attributes Show errors attributes object

    • code string

      An application-specific error code, expressed as a string value

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • id string

      A unique identifier for this particular occurrence of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • detail string

      A human-readable explanation specific to this occurrence of the problem

      Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • title string

      A short, human-readable summary of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • status string

      The HTTP status code applicable to this problem, expressed as a string value

      Maximum length is 3. Format should match the following pattern: ^[0-9]*$.

• 404 application/json

  Consignment not found

  Hide response attribute Show response attribute object

  • errors array[object] Required
    Hide errors attributes Show errors attributes object

    • code string

      An application-specific error code, expressed as a string value

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • id string

      A unique identifier for this particular occurrence of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • detail string

      A human-readable explanation specific to this occurrence of the problem

      Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • title string

      A short, human-readable summary of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • status string

      The HTTP status code applicable to this problem, expressed as a string value

      Maximum length is 3. Format should match the following pattern: ^[0-9]*$.

• 429 application/json

  Too Many Requests

  Hide response attribute Show response attribute object

  • errors array[object] Required
    Hide errors attributes Show errors attributes object

    • code string

      An application-specific error code, expressed as a string value

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • id string

      A unique identifier for this particular occurrence of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • detail string

      A human-readable explanation specific to this occurrence of the problem

      Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • title string

      A short, human-readable summary of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • status string

      The HTTP status code applicable to this problem, expressed as a string value

      Maximum length is 3. Format should match the following pattern: ^[0-9]*$.