REL documentation
inventory moverequests (http://api.3plcentral.com/rels/inventory/moverequests)
Resource:
Collection: of moverequest
C# Rel Const:
Rels.InventorySvc.MoveRequests
URI template:
moverequests{?pgsiz,pgnum,rql,sort}
Obtain URI from:
Billboard
Get a list of MoveRequests
Success status: 200
Name Data Type Description
pgsiz int max records to return per response; use "next" or "prev" link to paginate
pgnum int considering pgsiz, returns the pgnum-th page, 1-indexed
rql string see RQL documentation
sort string see RQL documentation
Type Description
TotalResults int
ResourceList IList<Inventory.Models.MoveRequest>
ReadOnly Inventory.Models.MoveRequestReadOnly
MoveRequestId int
ReceiveItemId int
ItemTraits Generic.Models.ItemTraits unique identifying characteristics of an item in a location
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
Qualifier string
LotNumber string
SerialNumber string
Cost decimal? ...
ExpirationDate DateTime? ...
PalletIdentifier Generic.Models.PalletIdentifier
NameKey Generic.Models.PalletNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
CostUsageLevel Common.Enum.UsageLevel
- 0: Disallow
- 1: Allow
- 2: Require
ExpirationUsageLevel Common.Enum.UsageLevel
- 0: Disallow
- 1: Allow
- 2: Require
LotUsageLevel Common.Enum.UsageLevel
- 0: Disallow
- 1: Allow
- 2: Require
SerialUsageLevel Common.Enum.SerialNumberUsageLevel
- 0: Disallow
- 1: Allow
- 2: AllowUnique
- 3: Require
- 4: RequireUnique
Qty decimal
SourceLocation Generic.Models.LocationIdentifier
NameKey Generic.Models.LocationNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
DestinationLocationIdentifier Generic.Models.LocationIdentifier
NameKey Generic.Models.LocationNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
CreationDateUtc DateTime
CreatedByUserIdentifier Generic.Models.UserIdentifier
Name string
Id int
AssignedDateUtc DateTime? ...
MovedDateUtc DateTime? ...
UnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
SecondaryUnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
LocationSort Order.Models.LocationSort
Field1 string
Field2 string
Field3 string
Field4 string
PackageUnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
SkuDescription string
Priority Byte
MoverUserIdentifier Generic.Models.UserIdentifier
Name string
Id int
Links IList<WebApi.Hal.Link>
- /rels/inventory/select Rel for moveRequestSelectEvent
- /rels/inventory/deselect Rel for moveRequestDeselectEvent
Links IList<WebApi.Hal.Link>
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/inventory/moverequest": [
      {
        "readOnly": {
          "moveRequestId": 1,
          "receiveItemId": 2,
          "itemTraits": {
            "itemIdentifier": {
              "sku": "str",
              "id": 2
            },
            "qualifier": "str",
            "lotNumber": "str",
            "serialNumber": "str",
            "cost": 1.0,
            "expirationDate": "2016-12-25T23:00:00",
            "palletIdentifier": {
              "nameKey": {
                "facilityIdentifier": {
                  "name": "str",
                  "id": 2
                },
                "name": "str"
              },
              "id": 1
            }
          },
          "costUsageLevel": 0,
          "expirationUsageLevel": 0,
          "lotUsageLevel": 0,
          "serialUsageLevel": 0,
          "qty": 3.0,
          "sourceLocation": {
            "nameKey": {
              "facilityIdentifier": {
                "name": "str",
                "id": 2
              },
              "name": "str"
            },
            "id": 1
          },
          "destinationLocationIdentifier": {
            "nameKey": {
              "facilityIdentifier": {
                "name": "str",
                "id": 2
              },
              "name": "str"
            },
            "id": 1
          },
          "creationDateUtc": "2016-12-25T23:00:00",
          "createdByUserIdentifier": {
            "name": "str",
            "id": 2
          },
          "assignedDateUtc": "2016-12-25T23:00:00",
          "movedDateUtc": "2016-12-25T23:00:00",
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "secondaryUnitIdentifier": {
            "name": "str",
            "id": 2
          },
          "locationSort": {
            "field1": "str",
            "field2": "str",
            "field3": "str",
            "field4": "str"
          },
          "packageUnitIdentifier": {
            "name": "str",
            "id": 2
          },
          "customerIdentifier": {
            "externalId": "str",
            "name": "str",
            "id": 3
          },
          "skuDescription": "str"
        },
        "priority": 64,
        "moverUserIdentifier": {
          "name": "str",
          "id": 2
        }
      }
    ]
  }
}
Add a MoveRequest
Success status: 200; ETag response header supplied
none
Type Description
ReceiveItemId int
Qty decimal
DestinationLocationIdentifier Generic.Models.LocationIdentifier
NameKey Generic.Models.LocationNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
Priority Byte
Sample content-type: application/hal+json
 
{
  "receiveItemId": 1,
  "qty": 2.0,
  "destinationLocationIdentifier": {
    "nameKey": {
      "facilityIdentifier": {
        "name": "str",
        "id": 2
      },
      "name": "str"
    },
    "id": 1
  },
  "priority": 64
}
Type Description
ReadOnly Inventory.Models.MoveRequestReadOnly
MoveRequestId int
ReceiveItemId int
ItemTraits Generic.Models.ItemTraits unique identifying characteristics of an item in a location
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
Qualifier string
LotNumber string
SerialNumber string
Cost decimal? ...
ExpirationDate DateTime? ...
PalletIdentifier Generic.Models.PalletIdentifier
NameKey Generic.Models.PalletNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
CostUsageLevel Common.Enum.UsageLevel
- 0: Disallow
- 1: Allow
- 2: Require
ExpirationUsageLevel Common.Enum.UsageLevel
- 0: Disallow
- 1: Allow
- 2: Require
LotUsageLevel Common.Enum.UsageLevel
- 0: Disallow
- 1: Allow
- 2: Require
SerialUsageLevel Common.Enum.SerialNumberUsageLevel
- 0: Disallow
- 1: Allow
- 2: AllowUnique
- 3: Require
- 4: RequireUnique
Qty decimal
SourceLocation Generic.Models.LocationIdentifier
NameKey Generic.Models.LocationNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
DestinationLocationIdentifier Generic.Models.LocationIdentifier
NameKey Generic.Models.LocationNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
CreationDateUtc DateTime
CreatedByUserIdentifier Generic.Models.UserIdentifier
Name string
Id int
AssignedDateUtc DateTime? ...
MovedDateUtc DateTime? ...
UnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
SecondaryUnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
LocationSort Order.Models.LocationSort
Field1 string
Field2 string
Field3 string
Field4 string
PackageUnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
SkuDescription string
Priority Byte
MoverUserIdentifier Generic.Models.UserIdentifier
Name string
Id int
Links IList<WebApi.Hal.Link>
- /rels/inventory/select Rel for moveRequestSelectEvent
- /rels/inventory/deselect Rel for moveRequestDeselectEvent
Sample accept: application/hal+json
{
  "readOnly": {
    "moveRequestId": 1,
    "receiveItemId": 2,
    "itemTraits": {
      "itemIdentifier": {
        "sku": "str",
        "id": 2
      },
      "qualifier": "str",
      "lotNumber": "str",
      "serialNumber": "str",
      "cost": 1.0,
      "expirationDate": "2016-12-25T23:00:00",
      "palletIdentifier": {
        "nameKey": {
          "facilityIdentifier": {
            "name": "str",
            "id": 2
          },
          "name": "str"
        },
        "id": 1
      }
    },
    "costUsageLevel": 0,
    "expirationUsageLevel": 0,
    "lotUsageLevel": 0,
    "serialUsageLevel": 0,
    "qty": 3.0,
    "sourceLocation": {
      "nameKey": {
        "facilityIdentifier": {
          "name": "str",
          "id": 2
        },
        "name": "str"
      },
      "id": 1
    },
    "destinationLocationIdentifier": {
      "nameKey": {
        "facilityIdentifier": {
          "name": "str",
          "id": 2
        },
        "name": "str"
      },
      "id": 1
    },
    "creationDateUtc": "2016-12-25T23:00:00",
    "createdByUserIdentifier": {
      "name": "str",
      "id": 2
    },
    "assignedDateUtc": "2016-12-25T23:00:00",
    "movedDateUtc": "2016-12-25T23:00:00",
    "unitIdentifier": {
      "name": "str",
      "id": 2
    },
    "secondaryUnitIdentifier": {
      "name": "str",
      "id": 2
    },
    "locationSort": {
      "field1": "str",
      "field2": "str",
      "field3": "str",
      "field4": "str"
    },
    "packageUnitIdentifier": {
      "name": "str",
      "id": 2
    },
    "customerIdentifier": {
      "externalId": "str",
      "name": "str",
      "id": 3
    },
    "skuDescription": "str"
  },
  "priority": 64,
  "moverUserIdentifier": {
    "name": "str",
    "id": 2
  }
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.