customers itemsummaries (http://api.3plcentral.com/rels/customers/itemsummaries)
Resource:
Collection: of itemsummary
C# Rel Const:
Rels.CustomerSvc.ItemSummaries
URI template:
{id}/itemsummaries{?pgsiz,pgnum,rql,sort,orderid,receiverid,pickjobid,getDeactivated,isAssembly}
Obtain URI from:
Get a list of item summaries
Success status: 200; Response is cacheable
Name (* = required) Data Type Description
id * int customer id
pgsiz int must be positive; limit 100, specifying more is an error; default 0; 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
orderid int to get item summaries for a single order (incompatible with receiverid, pickjobid)
receiverid int to get item summaries for a single receiver (incompatible with orderid, pickjobid)
pickjobid int to get item summaries for a single pickjob (incompatible with orderid, receiverid)
getDeactivated bool to get item summaries with inactive items included (Ex. packing out remaining inacitve items in SmartScan)
isAssembly bool to get item summaries for assemblies
Type Description
TotalResults int
ResourceList IList<Customer.Models.ItemSummary>
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
ItemId int
Sku string
Upc string
Description string
Price decimal? ...
TrackBys Customer.Models.TrackBys
TrackLotNumber Common.Enum.UsageLevel
- 0: Disallow
- 1: Allow
- 2: Require
TrackSerialNumber Common.Enum.SerialNumberUsageLevel
- 0: Disallow
- 1: Allow
- 2: AllowUnique
- 3: Require
- 4: RequireUnique
TrackExpirationDate Common.Enum.UsageLevel
- 0: Disallow
- 1: Allow
- 2: Require
TrackCost Common.Enum.UsageLevel
- 0: Disallow
- 1: Allow
- 2: Require
OutboundMobileSerialization Common.Enum.OutboundMobileSerializationBehavior
- 0: Disabled
- 1: IgnoreQuantityMismatches
- 2: DisallowQuantityMismatches
AutoHoldExpirationDaysThreshold int? ...
IsPickLotNumberRequired bool
IsPickSerialNumberRequired bool
IsPickExpirationDateRequired bool
InventoryUnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
SecondaryUnit Customer.Models.SecondaryUnit
InventoryAlso bool
Upc string
UnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
InventoryUnitsPerUnit decimal
PackageUnit Customer.Models.PackageUnit
Imperial Customer.Models.DimensionNet
NetWeight decimal? ...
Length decimal? ...
Width decimal? ...
Height decimal? ...
Weight decimal? ...
Metric Customer.Models.DimensionNet
NetWeight decimal? ...
Length decimal? ...
Width decimal? ...
Height decimal? ...
Weight decimal? ...
Upc string
UnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
InventoryUnitsPerUnit decimal
Pallets Customer.Models.Pallets
TypeIdentifier Generic.Models.PalletTypeIdentifier
Name string
Id int
Tie decimal? ...
High decimal? ...
Qty decimal? ... the number of primary units of this item on a typical pallet
Imperial Generic.Models.Dimension
Length decimal? ...
Width decimal? ...
Height decimal? ...
Weight decimal? ...
Metric Generic.Models.Dimension
Length decimal? ...
Width decimal? ...
Height decimal? ...
Weight decimal? ...
Upc string
Qualifiers IList<Customer.Models.ItemQualifier>
Qualifier string
AutoHoldOnReceive bool
AutoHoldExpirationDaysThreshold int? ...
IsAssembly bool
MaterialNotes string
ClassificationIdentifier Generic.Models.ItemClassificationIdentifier
Name string
Id int
IsHazMat bool
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/customers/itemsummary": [
      {
        "customerIdentifier": {
          "externalId": "str",
          "name": "str",
          "id": 3
        },
        "itemId": 1,
        "sku": "str",
        "upc": "str",
        "description": "str",
        "price": 1.0,
        "trackBys": {
          "trackLotNumber": 0,
          "trackSerialNumber": 0,
          "trackExpirationDate": 0,
          "trackCost": 0,
          "outboundMobileSerialization": 0,
          "autoHoldExpirationDaysThreshold": 1,
          "isPickLotNumberRequired": true,
          "isPickSerialNumberRequired": true,
          "isPickExpirationDateRequired": true
        },
        "inventoryUnitIdentifier": {
          "name": "str",
          "id": 2
        },
        "secondaryUnit": {
          "inventoryAlso": true,
          "upc": "str",
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "inventoryUnitsPerUnit": 3.0
        },
        "packageUnit": {
          "imperial": {
            "netWeight": 1.0,
            "length": 1.0,
            "width": 1.0,
            "height": 1.0,
            "weight": 1.0
          },
          "metric": {
            "netWeight": 1.0,
            "length": 1.0,
            "width": 1.0,
            "height": 1.0,
            "weight": 1.0
          },
          "upc": "str",
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "inventoryUnitsPerUnit": 2.0
        },
        "pallets": {
          "typeIdentifier": {
            "name": "str",
            "id": 2
          },
          "tie": 1.0,
          "high": 1.0,
          "qty": 1.0,
          "imperial": {
            "length": 1.0,
            "width": 1.0,
            "height": 1.0,
            "weight": 1.0
          },
          "metric": {
            "length": 1.0,
            "width": 1.0,
            "height": 1.0,
            "weight": 1.0
          },
          "upc": "str"
        },
        "autoHoldOnReceive": true,
        "autoHoldExpirationDaysThreshold": 1,
        "isAssembly": true,
        "materialNotes": "str",
        "classificationIdentifier": {
          "name": "str",
          "id": 2
        },
        "isHazMat": true,
        "_embedded": {
          "item": [
            {
              "qualifier": "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.