REL documentation
inventory receiveitems (http://api.3plcentral.com/rels/inventory/receiveitems)
Resource:
the collection of receive items independent of any receiver
C# Rel Const:
Rels.InventorySvc.ReceiveItems
URI template:
receivers/items{?pgsiz,pgnum,rql,sort,detail,includeInventoryLevels}
Obtain URI from:
Billboard
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
detail Common.Enum.ReceiveItemChildren
- None
- SavedElements
- All
includeInventoryLevels bool
Type Description
TotalResults int
ResourceList IList<Inventory.Models.ReceiveItem>
ReadOnly Inventory.Models.ReceiveItemReadOnly provided when GETting, ignored when POSTing new or PUTting existing single receive item, required when PUTting list of receive items
ReceiveItemId int when PUTting a receiver or a receive item list, zero to create a new receiver item, otherwise it identifies an existing receive item
FullyShippedDate DateTime? ...
UnitIdentifier Generic.Models.UnitOfMeasureIdentifier for convenience, referenced item's primary inventory unit
Name string
Id int
SecondaryUnitIdentifier Generic.Models.UnitOfMeasureIdentifier for convenience, referenced item's secondary inventory unit if defined
Name string
Id int
ExpectedQty decimal? ... when a ReceiveAgainst receiver is converted to a normal receiver, ExpectedQty is automatically copied from PrimaryQty; otherwise the ExpectedQty is null
InventoryLevels Inventory.Models.InventoryLevels from StockStatus
OnHand decimal in the warehouse
Available decimal in the warehouse but not allocated to any order
SecondaryAvailable decimal? ...
OnHoldDate DateTime? ... The date the receive item was most recently placed on hol
OnHoldUserIdentifier Generic.Models.UserIdentifier the user who most recently place the receive item on hold
Name string
Id int
FacilityIdentifier Generic.Models.FacilityIdentifier the facility where the receive item was received
Name string
Id int
ReferenceNumber string The Reference number of the receipt containing this receiveItem
TransactionID int The Transaction ID containing this receiveItem
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
Qualifier string item qualifer; null is interpreted same as empty string
ExternalId string connection of this receive item to the same receive item on some other system
Qty decimal? ... primary inventory quantity received; if not specified, must specify SecondaryQty from which Qty will be calculated
SecondaryQty decimal? ... if not specified and Item.Options.SecondaryUnit defined will be calculated from Qty; error if specified and Item.Options.SecondaryUnit null
LotNumber string item must be enabled for lot numbers to use this field
SerialNumber string item must be enabled for serial numbers to use this field
ExpirationDate DateTime? ... item must be enabled for expiration dates to use this field
Cost decimal? ... item must be enabled for cost to use this field
SupplierIdentifier Generic.Models.ContactIdentifier customer must be enabled for suppliers to use this field
Name string
Id int
LocationInfo Inventory.Models.LocationInfo customer must be enabled for locations to use this field
Inventory.Models.LocationInfo in GETs: the location; in POSTs or PUTs: identifies existing location or properties of new location more...
LocationId int? ... for identifying: if known specify only this; other fields are ignored
Display string specify either Display or RawField1..n but not both
RawField1 string "Raw" means as the user envisions it without the internal magnitude notation applied for sorting
RawField2 string
RawField3 string
RawField4 string
PalletInfo Inventory.Models.PalletInfo customer must be enabled for movable units to use this field
Inventory.Models.PalletInfo in GETs: the movable unit; in POSTs or PUTs: identifies existing movable unit or properties of new movable unit more...
PalletId int? ... for identifying: if known specify only this; other fields are ignored
Label string for identifying: if known but PalletId unknown, specify label, other fields ignored; for creating: new unique label or leave blank for system to generate unique label number
SplitOverCapacityOnCreate bool? ... if true will use PalletInfo as template to create multiples and splits associated receive items accordingly
QtyOverrideOnSplit decimal? ... when creating and SplitOverCapacityOnCreate is true, overrides the Item.Options.Pallets.Qty otherwise used to create multiples
PalletTypeIdentifier Generic.Models.PalletTypeIdentifier required when creating new movable unit
Name string
Id int
Metric Generic.Models.Dimension optional when creating; if only Metric specified, Imperial is calculated
Length decimal? ...
Width decimal? ...
Height decimal? ...
Weight decimal? ...
Imperial Generic.Models.Dimension optional when creating; if only Imperial specified, Metric is calculated
Length decimal? ...
Width decimal? ...
Height decimal? ...
Weight decimal? ...
WeightImperial decimal? ... total weight of receive item, imperial; if specified and metric not specified, business logic computes metric more...
WeightMetric decimal? ... total weight of receive item, metric; if specified and imperial not specified, business logic computes imperial; see WeightImperial for further explanation
OnHold bool If true, this receive item is not available for allocation
OnHoldReason string the reason the receive item was placed on hold; required if OnHold is true
SavedElements IEnumerable<Generic.Models.SavedElement>
Name string
Value string
CondensedSEs string a condensed string of the saved Elements, used as a groupBy value
Links IList<WebApi.Hal.Link>
- edit The containing receiver.
- /rels/inventory/receiver The containing receiver.
- /rels/inventory/adjustment The containing adjustment.
- /rels/inventory/assembly The assembly.
- /rels/customers/item
- /rels/customers/itemsummary
- /rels/properties/location
- /rels/inventory/pallet
- /rels/customers/customer
- /rels/properties/facility
- /rels/properties/contact
Links IList<WebApi.Hal.Link>
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/inventory/receiveritem": [
      {
        "readOnly": {
          "receiveItemId": 1,
          "fullyShippedDate": "2016-12-25T23:00:00",
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "secondaryUnitIdentifier": {
            "name": "str",
            "id": 2
          },
          "expectedQty": 1.0,
          "inventoryLevels": {
            "onHand": 1.0,
            "available": 2.0,
            "secondaryAvailable": 1.0
          },
          "onHoldDate": "2016-12-25T23:00:00",
          "onHoldUserIdentifier": {
            "name": "str",
            "id": 2
          },
          "facilityIdentifier": {
            "name": "str",
            "id": 2
          },
          "referenceNumber": "str",
          "transactionID": 3,
          "rowVersion": "str"
        },
        "itemIdentifier": {
          "sku": "str",
          "id": 2
        },
        "qualifier": "str",
        "externalId": "str",
        "qty": 1.0,
        "secondaryQty": 1.0,
        "lotNumber": "str",
        "serialNumber": "str",
        "expirationDate": "2016-12-25T23:00:00",
        "cost": 1.0,
        "supplierIdentifier": {
          "name": "str",
          "id": 2
        },
        "locationInfo": {
          "locationId": 1,
          "display": "str",
          "rawField1": "str",
          "rawField2": "str",
          "rawField3": "str",
          "rawField4": "str"
        },
        "palletInfo": {
          "palletId": 1,
          "label": "str",
          "splitOverCapacityOnCreate": true,
          "qtyOverrideOnSplit": 1.0,
          "palletTypeIdentifier": {
            "name": "str",
            "id": 2
          },
          "metric": {
            "length": 1.0,
            "width": 1.0,
            "height": 1.0,
            "weight": 1.0
          },
          "imperial": {
            "length": 1.0,
            "width": 1.0,
            "height": 1.0,
            "weight": 1.0
          }
        },
        "weightImperial": 1.0,
        "weightMetric": 1.0,
        "onHold": true,
        "onHoldReason": "str",
        "savedElements": [
          {
            "name": "str",
            "value": "str"
          }
        ],
        "condensedSEs": "str"
      }
    ]
  }
}

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.