Type	Description
PackageInsertId	int	readonly
Name	string	required, must be unique as an alternate lookup field
Barcode	string	must be unique as an alternate lookup field
Description	string	optional, describe package insert
CustomerIdentifier	Generic.Models.CustomerIdentifier	required, defines customer
ExternalId	string
Name	string
Id	int
ItemIdentifier	Generic.Models.ItemIdentifier	optional, defines which item should be added to an order as an insert. Omit if the insert is not an inventory item
Sku	string
Id	int
DisplayOnPackingList	bool	optional, default false, define it will be displayed on packing list
InsertQtyMatchesItemQty	bool	optional, default false, define if insert qty should match item qty
LifespanStartDate	DateTime? ...	optional, used to define filter to when the package insert rule starts
LifespanEndDate	DateTime? ...	optional, used to define filter to when the package insert rule ends
Country	string	optional, used to define filter to where the package insert rule applies
State	string	optional, used to define filter to where the package insert rule applies
OrderSource	string	optional, used to define filter to where the package insert rule applies
IgnoreForEdi	bool	required, default false, defines if the package insert will be ignored for edi's
PackageInsertFacilities	IList<Property.Models.PackageInsertFacility>
FacilityIdentifier	Generic.Models.FacilityIdentifier	required, defines facility containing this insert
Name	string
Id	int
CurrentQuantity	decimal? ...	optional, defines current quantity
MinQuantity	decimal? ...	optional, defines min quantity to generate alerts
UserIdentifier	Generic.Models.UserIdentifier	optional, UserLoginID that will receive the alerts.
Name	string
Id	int
AlertRecipient	int? ...
PackageName	string
PackageInsertItems	IEnumerable<Generic.Models.ItemIdentifier>
Sku	string
Id	int

Sample content-type: application/hal+json

Copy to clipboard

copied

{
  "packageInsertId": 1,
  "name": "str",
  "barcode": "str",
  "description": "str",
  "customerIdentifier": {
    "externalId": "str",
    "name": "str",
    "id": 3
  },
  "itemIdentifier": {
    "sku": "str",
    "id": 2
  },
  "displayOnPackingList": true,
  "insertQtyMatchesItemQty": true,
  "lifespanStartDate": "2016-12-25T23:00:00",
  "lifespanEndDate": "2016-12-25T23:00:00",
  "country": "str",
  "state": "str",
  "orderSource": "str",
  "ignoreForEdi": true,
  "packageInsertItems": [
    {
      "sku": "str",
      "id": 2
    }
  ],
  "_embedded": {
    "item": [
      {
        "facilityIdentifier": {
          "name": "str",
          "id": 2
        },
        "currentQuantity": 1.0,
        "minQuantity": 1.0,
        "userIdentifier": {
          "name": "str",
          "id": 2
        },
        "alertRecipient": 1,
        "packageName": "str"
      }
    ]
  }
}

	Type	Description
PackageInsertId	int	readonly
Name	string	required, must be unique as an alternate lookup field
Barcode	string	must be unique as an alternate lookup field
Description	string	optional, describe package insert
CustomerIdentifier	Generic.Models.CustomerIdentifier	required, defines customer
ExternalId	string
Name	string
Id	int
ItemIdentifier	Generic.Models.ItemIdentifier	optional, defines which item should be added to an order as an insert. Omit if the insert is not an inventory item
Sku	string
Id	int
DisplayOnPackingList	bool	optional, default false, define it will be displayed on packing list
InsertQtyMatchesItemQty	bool	optional, default false, define if insert qty should match item qty
LifespanStartDate	DateTime? ...	optional, used to define filter to when the package insert rule starts
LifespanEndDate	DateTime? ...	optional, used to define filter to when the package insert rule ends
Country	string	optional, used to define filter to where the package insert rule applies
State	string	optional, used to define filter to where the package insert rule applies
OrderSource	string	optional, used to define filter to where the package insert rule applies
IgnoreForEdi	bool	required, default false, defines if the package insert will be ignored for edi's
PackageInsertFacilities	IList<Property.Models.PackageInsertFacility>
FacilityIdentifier	Generic.Models.FacilityIdentifier	required, defines facility containing this insert
Name	string
Id	int
CurrentQuantity	decimal? ...	optional, defines current quantity
MinQuantity	decimal? ...	optional, defines min quantity to generate alerts
UserIdentifier	Generic.Models.UserIdentifier	optional, UserLoginID that will receive the alerts.
Name	string
Id	int
AlertRecipient	int? ...
PackageName	string
PackageInsertItems	IEnumerable<Generic.Models.ItemIdentifier>
Sku	string
Id	int
Links	IList<WebApi.Hal.Link>
	- edit

Sample accept: application/hal+json

{
  "packageInsertId": 1,
  "name": "str",
  "barcode": "str",
  "description": "str",
  "customerIdentifier": {
    "externalId": "str",
    "name": "str",
    "id": 3
  },
  "itemIdentifier": {
    "sku": "str",
    "id": 2
  },
  "displayOnPackingList": true,
  "insertQtyMatchesItemQty": true,
  "lifespanStartDate": "2016-12-25T23:00:00",
  "lifespanEndDate": "2016-12-25T23:00:00",
  "country": "str",
  "state": "str",
  "orderSource": "str",
  "ignoreForEdi": true,
  "packageInsertItems": [
    {
      "sku": "str",
      "id": 2
    }
  ],
  "_embedded": {
    "item": [
      {
        "facilityIdentifier": {
          "name": "str",
          "id": 2
        },
        "currentQuantity": 1.0,
        "minQuantity": 1.0,
        "userIdentifier": {
          "name": "str",
          "id": 2
        },
        "alertRecipient": 1,
        "packageName": "str"
      }
    ]
  }
}