inventory items (http://api.3plcentral.com/rels/inventory/items)
Resource:
Collection: of item
C# Rel Const:
Rels.InventorySvc.Items
URI template:
assemblies/{id}/items{?detail}
Obtain URI from:
Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int
detail Common.Enum.OrderItemChildren comma-delim list, for inclusion in response, default None; All = SavedElements,Allocations
- None
- SavedElements
- Allocations
- All
- AllocationsWithDetail
Type Description
ResourceList IList<Inventory.Models.AssemblyItem>
ReadOnly Inventory.Models.AssemblyItemReadOnly
OrderItemId int
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
Qualifier string
Qty decimal? ...
SecondaryQty decimal? ...
FullyAllocated bool
ExpirationDate 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
EstimatedQty decimal? ... if present, calculated from SecondaryQty and cannot confirm until Qty entered
EstimatedSecondaryQty decimal? ... if present, calculated from Qty and cannot confirm until SecondaryQty entered
OriginalPrimaryQty decimal? ... on a shorted order, specifies original quantity ordered; otherwise same as Qty
IsOrderQtySecondary bool if both Qty and SecondaryQty present, indicates whether at some point prior to shipping only SecondaryQty was present
Bin string supplied on GET, ignored on PUT, POST; use pick operations to set; cleared when shipped or packaged
Allocations IEnumerable<Inventory.Models.Allocation>
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? ...
LotNumber string if present, used to allocate matching inventory
SerialNumber string if present, used to allocate matching inventory
MovableUnitLabel string the MovableUnitLabel for new ReceiveItems
SplitLineByMovableUnit bool Split line by movable unit for receive items
MovableUnitNumber decimal? ... When creating and SplitLineByMovableUnit is true, overrides the Item.Options.Pallets.Qty otherwise used to create multiples
ProposedAllocations IEnumerable<Generic.Models.ProposedAllocation>
ReceiveItemId int
Qty decimal
Sample accept: application/hal+json
{
  "_embedded": {
    "http://api.3plCentral.com/rels/inventory/item": [
      {
        "readOnly": {
          "orderItemId": 1,
          "itemIdentifier": {
            "sku": "str",
            "id": 2
          },
          "qualifier": "str",
          "qty": 1.0,
          "secondaryQty": 1.0,
          "fullyAllocated": true,
          "expirationDate": "2016-12-25T23:00:00",
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "secondaryUnitIdentifier": {
            "name": "str",
            "id": 2
          },
          "estimatedQty": 1.0,
          "estimatedSecondaryQty": 1.0,
          "originalPrimaryQty": 1.0,
          "isOrderQtySecondary": true,
          "bin": "str",
          "rowVersion": "str",
          "allocations": [
            {
              "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
              },
              "_links": null
            }
          ]
        },
        "lotNumber": "str",
        "serialNumber": "str",
        "movableUnitLabel": "str",
        "splitLineByMovableUnit": true,
        "movableUnitNumber": 1.0,
        "proposedAllocations": [
          {
            "receiveItemId": 1,
            "qty": 2.0
          }
        ]
      }
    ]
  }
}

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.