/api/v1/facilities/{facilityId}/routing/loads (GET)

GET

/api/v1/facilities/{facilityId}/routing/loads

curl --request GET \
  --url 'https://example.com/api/v1/facilities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/routing/loads?Status=Open' \
  --header 'Authorization: Bearer <token>'

Authorizations

• Bearer

Parameters

Path Parameters

facilityId

required

string format: uuid

Query Parameters

Status

string

Allowed values: Open Closed

DockDoorId

string format: uuid

Page

integer format: int32

PageSize

integer format: int32

Sort

string

Responses

200

OK

object

items

required

Array<object>

object

id

required

string format: uuid

facilityId

required

string format: uuid

dockDoor

required

object

id

required

string format: uuid

code

required

string

trailerNumber

required

string

carrierCode

required

string

nullable

status

required

string

Allowed values: Open Closed

containers

required

Array<object>

object

containerCode

required

string

journeyId

required

string format: uuid

shipmentId

required

string format: uuid

nullable

orderId

required

string format: uuid

nullable

loadedAt

required

string format: date-time

shipments

required

Array<object>

object

shipmentId

required

string format: uuid

orderId

required

string format: uuid

nullable

shipStatus

required

string

Allowed values: Pending Requested Shipped ShipFailed

errorCode

required

string

nullable

openedAt

required

string format: date-time

closedAt

required

string format: date-time

nullable

updatedAt

required

string format: date-time

page

required

integer format: int32

pageSize

required

integer format: int32

totalCount

required

integer format: int32

object

items

required

Array<object>

object

id

required

string format: uuid

facilityId

required

string format: uuid

dockDoor

required

object

id

required

string format: uuid

code

required

string

trailerNumber

required

string

carrierCode

required

string

nullable

status

required

string

Allowed values: Open Closed

containers

required

Array<object>

object

containerCode

required

string

journeyId

required

string format: uuid

shipmentId

required

string format: uuid

nullable

orderId

required

string format: uuid

nullable

loadedAt

required

string format: date-time

shipments

required

Array<object>

object

shipmentId

required

string format: uuid

orderId

required

string format: uuid

nullable

shipStatus

required

string

Allowed values: Pending Requested Shipped ShipFailed

errorCode

required

string

nullable

openedAt

required

string format: date-time

closedAt

required

string format: date-time

nullable

updatedAt

required

string format: date-time

page

required

integer format: int32

pageSize

required

integer format: int32

totalCount

required

integer format: int32

Example

{
  "items": [
    {
      "status": "Open",
      "shipments": [
        {
          "shipStatus": "Pending"
        }
      ]
    }
  ]
}

object

items

required

Array<object>

object

id

required

string format: uuid

facilityId

required

string format: uuid

dockDoor

required

object

id

required

string format: uuid

code

required

string

trailerNumber

required

string

carrierCode

required

string

nullable

status

required

string

Allowed values: Open Closed

containers

required

Array<object>

object

containerCode

required

string

journeyId

required

string format: uuid

shipmentId

required

string format: uuid

nullable

orderId

required

string format: uuid

nullable

loadedAt

required

string format: date-time

shipments

required

Array<object>

object

shipmentId

required

string format: uuid

orderId

required

string format: uuid

nullable

shipStatus

required

string

Allowed values: Pending Requested Shipped ShipFailed

errorCode

required

string

nullable

openedAt

required

string format: date-time

closedAt

required

string format: date-time

nullable

updatedAt

required

string format: date-time

page

required

integer format: int32

pageSize

required

integer format: int32

totalCount

required

integer format: int32

Example

{
  "items": [
    {
      "status": "Open",
      "shipments": [
        {
          "shipStatus": "Pending"
        }
      ]
    }
  ]
}

400

Bad Request

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}