inventory allocation (http://api.3plcentral.com/rels/inventory/allocation)
Resource:
an allocation of inventory
C# Rel Const:
Rels.InventorySvc.Allocation
URI template:
allocations/{oiid}/{riid}
Obtain URI from:
Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
oiid * int
riid * int
Type Description
OrderItemId int
ReceiveItemId int
Qty decimal? ...
ProperlyPickedPrimary decimal? ...
ProperlyPickedSecondary decimal? ...
LoadedOut bool
Detail Order.Models.AllocationDetail null unless requested by including AllocationsWithDetail in OrderItemChildren
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
LocationIdentifier Generic.Models.LocationIdentifier
NameKey Generic.Models.LocationNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
LocationSort Order.Models.LocationSort
Field1 string
Field2 string
Field3 string
Field4 string
SavedElements IEnumerable<Generic.Models.SavedElement>
Name string
Value string
PickPath int? ...
Sample accept: application/hal+json
{
  "orderItemId": 1,
  "receiveItemId": 2,
  "qty": 1.0,
  "properlyPickedPrimary": 1.0,
  "properlyPickedSecondary": 1.0,
  "loadedOut": true,
  "detail": {
    "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
      }
    },
    "locationIdentifier": {
      "nameKey": {
        "facilityIdentifier": {
          "name": "str",
          "id": 2
        },
        "name": "str"
      },
      "id": 1
    },
    "locationSort": {
      "field1": "str",
      "field2": "str",
      "field3": "str",
      "field4": "str"
    },
    "savedElements": [
      {
        "name": "str",
        "value": "str"
      }
    ],
    "pickPath": 1
  }
}

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.