Rel doc - Rel

GET

Success status: 200; ETag response header supplied

Params
Response body (Order.Models.OrderItemList)

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<Order.Models.OrderItem>
ReadOnly	Order.Models.OrderItemReadOnly
OrderItemId	int
FullyAllocated	bool
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
Allocations	IEnumerable<Order.Models.Allocation>	supplied on GET {get;set;} ignored on PUT, POST
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? ...
Bin	string	supplied on GET, ignored on PUT, POST; use pick operations to set; cleared when shipped or packaged
IsInsert	bool
MaxToAllocateFromPickLine	decimal? ...	Represents the max amount of an item that will be allocated from a pickline location for replenishment
ItemIdentifier	Generic.Models.ItemIdentifier
Sku	string
Id	int
Qualifier	string
ExternalId	string	connection of this order item to the same order item on some other system
Qty	decimal? ...	primary inventory quantity ordered; if not specified, must specify SecondaryQty more...
SecondaryQty	decimal? ...	optional secondary quantity ordered; if not specified, must specify Qty more...
LotNumber	string	if present, used to allocate matching inventory
SerialNumber	string	if present, used to allocate matching inventory
ExpirationDate	DateTime? ...	if present, used to allocate matching inventory
WeightImperial	decimal? ...	ship weight of order item, imperial; if specified and metric not specified, business logic computes metric more...
WeightMetric	decimal? ...	ship weight of order item, metric; if specified and imperial not specified, business logic computes imperial; see WeightImperial for further explanation
Notes	string
FulfillInvSalePrice	decimal? ...
FulfillInvDiscountPct	decimal? ...
FulfillInvDiscountAmt	decimal? ...
FulfillInvNote	string
SavedElements	IEnumerable<Generic.Models.SavedElement>
Name	string
Value	string
ProposedAllocations	IEnumerable<Generic.Models.ProposedAllocation>	empty on GET; may be supplied on PUT, POST
	Generic.Models.ProposedAllocation	A manual allocation.
ReceiveItemId	int
Qty	decimal
OrderItemInPackages	IEnumerable<Order.Models.OrderItemInPackage>	declares the package arrangement, which gets translated into real packages, during order creation; empty on GET; ignored on PUT; may be supplied on POST
PackageNumber	int	use the same number on multiple OrderItemInPackages to add package content to the same package
Quantity	decimal	how much of the orderitem to pack into this package content; must be a positive number
PackageDefIdentifier	Generic.Models.PackageDefIdentifier	the package definition to apply to any package created as a result of this OrderItemInPackage
Name	string
Id	int
IsInsert	bool
Links	IList<WebApi.Hal.Link>
	- edit
	- /rels/customers/item	The ordered item.
	- /rels/customers/itemsummary	The ordered item summary, sufficient for editing order item.
	- /rels/orders/order	The containing order.
	- /rels/orders/itemallocate	Operator to allocate this item.
	- /rels/orders/itemdeallocate	Operator to deallocate this item.
Links	IList<WebApi.Hal.Link>
	- edit
	- /rels/orders/order	The containing order.

Sample accept: application/hal+json

{
  "_embedded": {
    "http://api.3plCentral.com/rels/orders/item": [
      {
        "readOnly": {
          "orderItemId": 1,
          "fullyAllocated": true,
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "secondaryUnitIdentifier": {
            "name": "str",
            "id": 2
          },
          "estimatedQty": 1.0,
          "estimatedSecondaryQty": 1.0,
          "originalPrimaryQty": 1.0,
          "isOrderQtySecondary": true,
          "allocations": [
            {
              "receiveItemId": 1,
              "qty": 2.0,
              "properlyPickedPrimary": 3.0,
              "properlyPickedSecondary": 4.0,
              "loadedOut": true,
              "rowVersion": "str",
              "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
              }
            }
          ],
          "bin": "str",
          "isInsert": true,
          "maxToAllocateFromPickLine": 1.0,
          "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",
        "weightImperial": 1.0,
        "weightMetric": 1.0,
        "notes": "str",
        "fulfillInvSalePrice": 1.0,
        "fulfillInvDiscountPct": 1.0,
        "fulfillInvDiscountAmt": 1.0,
        "fulfillInvNote": "str",
        "savedElements": [
          {
            "name": "str",
            "value": "str"
          }
        ],
        "proposedAllocations": [
          {
            "receiveItemId": 1,
            "qty": 2.0
          }
        ],
        "orderItemInPackages": [
          {
            "packageNumber": 1,
            "quantity": 2.0,
            "packageDefIdentifier": {
              "name": "str",
              "id": 2
            }
          }
        ],
        "isInsert": true
      }
    ]
  }
}

POST

/orders/{id}/items

If-Match request header required; Success status: 201; ETag response header supplied

Name (* = required)	Data Type	Description
id *	int

	Type	Description
ReadOnly	Order.Models.OrderItemReadOnly
OrderItemId	int
FullyAllocated	bool
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
Allocations	IEnumerable<Order.Models.Allocation>	supplied on GET {get;set;} ignored on PUT, POST
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? ...
Bin	string	supplied on GET, ignored on PUT, POST; use pick operations to set; cleared when shipped or packaged
IsInsert	bool
MaxToAllocateFromPickLine	decimal? ...	Represents the max amount of an item that will be allocated from a pickline location for replenishment
ItemIdentifier	Generic.Models.ItemIdentifier
Sku	string
Id	int
Qualifier	string
ExternalId	string	connection of this order item to the same order item on some other system
Qty	decimal? ...	primary inventory quantity ordered; if not specified, must specify SecondaryQty more...
SecondaryQty	decimal? ...	optional secondary quantity ordered; if not specified, must specify Qty more...
LotNumber	string	if present, used to allocate matching inventory
SerialNumber	string	if present, used to allocate matching inventory
ExpirationDate	DateTime? ...	if present, used to allocate matching inventory
WeightImperial	decimal? ...	ship weight of order item, imperial; if specified and metric not specified, business logic computes metric more...
WeightMetric	decimal? ...	ship weight of order item, metric; if specified and imperial not specified, business logic computes imperial; see WeightImperial for further explanation
Notes	string
FulfillInvSalePrice	decimal? ...
FulfillInvDiscountPct	decimal? ...
FulfillInvDiscountAmt	decimal? ...
FulfillInvNote	string
SavedElements	IEnumerable<Generic.Models.SavedElement>
Name	string
Value	string
ProposedAllocations	IEnumerable<Generic.Models.ProposedAllocation>	empty on GET; may be supplied on PUT, POST
	Generic.Models.ProposedAllocation	A manual allocation.
ReceiveItemId	int
Qty	decimal
OrderItemInPackages	IEnumerable<Order.Models.OrderItemInPackage>	declares the package arrangement, which gets translated into real packages, during order creation; empty on GET; ignored on PUT; may be supplied on POST
PackageNumber	int	use the same number on multiple OrderItemInPackages to add package content to the same package
Quantity	decimal	how much of the orderitem to pack into this package content; must be a positive number
PackageDefIdentifier	Generic.Models.PackageDefIdentifier	the package definition to apply to any package created as a result of this OrderItemInPackage
Name	string
Id	int
IsInsert	bool

Sample content-type: application/hal+json

{
  "readOnly": {
    "orderItemId": 1,
    "fullyAllocated": true,
    "unitIdentifier": {
      "name": "str",
      "id": 2
    },
    "secondaryUnitIdentifier": {
      "name": "str",
      "id": 2
    },
    "estimatedQty": 1.0,
    "estimatedSecondaryQty": 1.0,
    "originalPrimaryQty": 1.0,
    "isOrderQtySecondary": true,
    "allocations": [
      {
        "receiveItemId": 1,
        "qty": 2.0,
        "properlyPickedPrimary": 3.0,
        "properlyPickedSecondary": 4.0,
        "loadedOut": true,
        "rowVersion": "str",
        "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
        }
      }
    ],
    "bin": "str",
    "isInsert": true,
    "maxToAllocateFromPickLine": 1.0,
    "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",
  "weightImperial": 1.0,
  "weightMetric": 1.0,
  "notes": "str",
  "fulfillInvSalePrice": 1.0,
  "fulfillInvDiscountPct": 1.0,
  "fulfillInvDiscountAmt": 1.0,
  "fulfillInvNote": "str",
  "savedElements": [
    {
      "name": "str",
      "value": "str"
    }
  ],
  "proposedAllocations": [
    {
      "receiveItemId": 1,
      "qty": 2.0
    }
  ],
  "orderItemInPackages": [
    {
      "packageNumber": 1,
      "quantity": 2.0,
      "packageDefIdentifier": {
        "name": "str",
        "id": 2
      }
    }
  ],
  "isInsert": true
}

returns list because an alias sku might expand to more than one order item

	Type	Description
ResourceList	IList<Order.Models.OrderItem>
ReadOnly	Order.Models.OrderItemReadOnly
OrderItemId	int
FullyAllocated	bool
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
Allocations	IEnumerable<Order.Models.Allocation>	supplied on GET {get;set;} ignored on PUT, POST
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? ...
Bin	string	supplied on GET, ignored on PUT, POST; use pick operations to set; cleared when shipped or packaged
IsInsert	bool
MaxToAllocateFromPickLine	decimal? ...	Represents the max amount of an item that will be allocated from a pickline location for replenishment
ItemIdentifier	Generic.Models.ItemIdentifier
Sku	string
Id	int
Qualifier	string
ExternalId	string	connection of this order item to the same order item on some other system
Qty	decimal? ...	primary inventory quantity ordered; if not specified, must specify SecondaryQty more...
SecondaryQty	decimal? ...	optional secondary quantity ordered; if not specified, must specify Qty more...
LotNumber	string	if present, used to allocate matching inventory
SerialNumber	string	if present, used to allocate matching inventory
ExpirationDate	DateTime? ...	if present, used to allocate matching inventory
WeightImperial	decimal? ...	ship weight of order item, imperial; if specified and metric not specified, business logic computes metric more...
WeightMetric	decimal? ...	ship weight of order item, metric; if specified and imperial not specified, business logic computes imperial; see WeightImperial for further explanation
Notes	string
FulfillInvSalePrice	decimal? ...
FulfillInvDiscountPct	decimal? ...
FulfillInvDiscountAmt	decimal? ...
FulfillInvNote	string
SavedElements	IEnumerable<Generic.Models.SavedElement>
Name	string
Value	string
ProposedAllocations	IEnumerable<Generic.Models.ProposedAllocation>	empty on GET; may be supplied on PUT, POST
	Generic.Models.ProposedAllocation	A manual allocation.
ReceiveItemId	int
Qty	decimal
OrderItemInPackages	IEnumerable<Order.Models.OrderItemInPackage>	declares the package arrangement, which gets translated into real packages, during order creation; empty on GET; ignored on PUT; may be supplied on POST
PackageNumber	int	use the same number on multiple OrderItemInPackages to add package content to the same package
Quantity	decimal	how much of the orderitem to pack into this package content; must be a positive number
PackageDefIdentifier	Generic.Models.PackageDefIdentifier	the package definition to apply to any package created as a result of this OrderItemInPackage
Name	string
Id	int
IsInsert	bool
Links	IList<WebApi.Hal.Link>
	- edit
	- /rels/customers/item	The ordered item.
	- /rels/customers/itemsummary	The ordered item summary, sufficient for editing order item.
	- /rels/orders/order	The containing order.
	- /rels/orders/itemallocate	Operator to allocate this item.
	- /rels/orders/itemdeallocate	Operator to deallocate this item.
Links	IList<WebApi.Hal.Link>
	- edit
	- /rels/orders/order	The containing order.

Sample accept: application/hal+json

{
  "_embedded": {
    "http://api.3plCentral.com/rels/orders/item": [
      {
        "readOnly": {
          "orderItemId": 1,
          "fullyAllocated": true,
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "secondaryUnitIdentifier": {
            "name": "str",
            "id": 2
          },
          "estimatedQty": 1.0,
          "estimatedSecondaryQty": 1.0,
          "originalPrimaryQty": 1.0,
          "isOrderQtySecondary": true,
          "allocations": [
            {
              "receiveItemId": 1,
              "qty": 2.0,
              "properlyPickedPrimary": 3.0,
              "properlyPickedSecondary": 4.0,
              "loadedOut": true,
              "rowVersion": "str",
              "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
              }
            }
          ],
          "bin": "str",
          "isInsert": true,
          "maxToAllocateFromPickLine": 1.0,
          "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",
        "weightImperial": 1.0,
        "weightMetric": 1.0,
        "notes": "str",
        "fulfillInvSalePrice": 1.0,
        "fulfillInvDiscountPct": 1.0,
        "fulfillInvDiscountAmt": 1.0,
        "fulfillInvNote": "str",
        "savedElements": [
          {
            "name": "str",
            "value": "str"
          }
        ],
        "proposedAllocations": [
          {
            "receiveItemId": 1,
            "qty": 2.0
          }
        ],
        "orderItemInPackages": [
          {
            "packageNumber": 1,
            "quantity": 2.0,
            "packageDefIdentifier": {
              "name": "str",
              "id": 2
            }
          }
        ],
        "isInsert": true
      }
    ]
  }
}

PUT

/orders/{id}/items

If-Match request header required; Success status: 200; ETag response header supplied

Name (* = required)	Data Type	Description
id *	int

	Type	Description
ResourceList	IList<Order.Models.OrderItem>
ReadOnly	Order.Models.OrderItemReadOnly
OrderItemId	int
FullyAllocated	bool
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
Allocations	IEnumerable<Order.Models.Allocation>	supplied on GET {get;set;} ignored on PUT, POST
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? ...
Bin	string	supplied on GET, ignored on PUT, POST; use pick operations to set; cleared when shipped or packaged
IsInsert	bool
MaxToAllocateFromPickLine	decimal? ...	Represents the max amount of an item that will be allocated from a pickline location for replenishment
ItemIdentifier	Generic.Models.ItemIdentifier
Sku	string
Id	int
Qualifier	string
ExternalId	string	connection of this order item to the same order item on some other system
Qty	decimal? ...	primary inventory quantity ordered; if not specified, must specify SecondaryQty more...
SecondaryQty	decimal? ...	optional secondary quantity ordered; if not specified, must specify Qty more...
LotNumber	string	if present, used to allocate matching inventory
SerialNumber	string	if present, used to allocate matching inventory
ExpirationDate	DateTime? ...	if present, used to allocate matching inventory
WeightImperial	decimal? ...	ship weight of order item, imperial; if specified and metric not specified, business logic computes metric more...
WeightMetric	decimal? ...	ship weight of order item, metric; if specified and imperial not specified, business logic computes imperial; see WeightImperial for further explanation
Notes	string
FulfillInvSalePrice	decimal? ...
FulfillInvDiscountPct	decimal? ...
FulfillInvDiscountAmt	decimal? ...
FulfillInvNote	string
SavedElements	IEnumerable<Generic.Models.SavedElement>
Name	string
Value	string
ProposedAllocations	IEnumerable<Generic.Models.ProposedAllocation>	empty on GET; may be supplied on PUT, POST
	Generic.Models.ProposedAllocation	A manual allocation.
ReceiveItemId	int
Qty	decimal
OrderItemInPackages	IEnumerable<Order.Models.OrderItemInPackage>	declares the package arrangement, which gets translated into real packages, during order creation; empty on GET; ignored on PUT; may be supplied on POST
PackageNumber	int	use the same number on multiple OrderItemInPackages to add package content to the same package
Quantity	decimal	how much of the orderitem to pack into this package content; must be a positive number
PackageDefIdentifier	Generic.Models.PackageDefIdentifier	the package definition to apply to any package created as a result of this OrderItemInPackage
Name	string
Id	int
IsInsert	bool
Links	IList<WebApi.Hal.Link>
	- edit
	- /rels/customers/item	The ordered item.
	- /rels/customers/itemsummary	The ordered item summary, sufficient for editing order item.
	- /rels/orders/order	The containing order.
	- /rels/orders/itemallocate	Operator to allocate this item.
	- /rels/orders/itemdeallocate	Operator to deallocate this item.

Sample content-type: application/hal+json

{
  "_embedded": {
    "http://api.3plCentral.com/rels/orders/item": [
      {
        "readOnly": {
          "orderItemId": 1,
          "fullyAllocated": true,
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "secondaryUnitIdentifier": {
            "name": "str",
            "id": 2
          },
          "estimatedQty": 1.0,
          "estimatedSecondaryQty": 1.0,
          "originalPrimaryQty": 1.0,
          "isOrderQtySecondary": true,
          "allocations": [
            {
              "receiveItemId": 1,
              "qty": 2.0,
              "properlyPickedPrimary": 3.0,
              "properlyPickedSecondary": 4.0,
              "loadedOut": true,
              "rowVersion": "str",
              "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
              }
            }
          ],
          "bin": "str",
          "isInsert": true,
          "maxToAllocateFromPickLine": 1.0,
          "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",
        "weightImperial": 1.0,
        "weightMetric": 1.0,
        "notes": "str",
        "fulfillInvSalePrice": 1.0,
        "fulfillInvDiscountPct": 1.0,
        "fulfillInvDiscountAmt": 1.0,
        "fulfillInvNote": "str",
        "savedElements": [
          {
            "name": "str",
            "value": "str"
          }
        ],
        "proposedAllocations": [
          {
            "receiveItemId": 1,
            "qty": 2.0
          }
        ],
        "orderItemInPackages": [
          {
            "packageNumber": 1,
            "quantity": 2.0,
            "packageDefIdentifier": {
              "name": "str",
              "id": 2
            }
          }
        ],
        "isInsert": true
      }
    ]
  }
}

	Type	Description
ResourceList	IList<Order.Models.OrderItem>
ReadOnly	Order.Models.OrderItemReadOnly
OrderItemId	int
FullyAllocated	bool
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
Allocations	IEnumerable<Order.Models.Allocation>	supplied on GET {get;set;} ignored on PUT, POST
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? ...
Bin	string	supplied on GET, ignored on PUT, POST; use pick operations to set; cleared when shipped or packaged
IsInsert	bool
MaxToAllocateFromPickLine	decimal? ...	Represents the max amount of an item that will be allocated from a pickline location for replenishment
ItemIdentifier	Generic.Models.ItemIdentifier
Sku	string
Id	int
Qualifier	string
ExternalId	string	connection of this order item to the same order item on some other system
Qty	decimal? ...	primary inventory quantity ordered; if not specified, must specify SecondaryQty more...
SecondaryQty	decimal? ...	optional secondary quantity ordered; if not specified, must specify Qty more...
LotNumber	string	if present, used to allocate matching inventory
SerialNumber	string	if present, used to allocate matching inventory
ExpirationDate	DateTime? ...	if present, used to allocate matching inventory
WeightImperial	decimal? ...	ship weight of order item, imperial; if specified and metric not specified, business logic computes metric more...
WeightMetric	decimal? ...	ship weight of order item, metric; if specified and imperial not specified, business logic computes imperial; see WeightImperial for further explanation
Notes	string
FulfillInvSalePrice	decimal? ...
FulfillInvDiscountPct	decimal? ...
FulfillInvDiscountAmt	decimal? ...
FulfillInvNote	string
SavedElements	IEnumerable<Generic.Models.SavedElement>
Name	string
Value	string
ProposedAllocations	IEnumerable<Generic.Models.ProposedAllocation>	empty on GET; may be supplied on PUT, POST
	Generic.Models.ProposedAllocation	A manual allocation.
ReceiveItemId	int
Qty	decimal
OrderItemInPackages	IEnumerable<Order.Models.OrderItemInPackage>	declares the package arrangement, which gets translated into real packages, during order creation; empty on GET; ignored on PUT; may be supplied on POST
PackageNumber	int	use the same number on multiple OrderItemInPackages to add package content to the same package
Quantity	decimal	how much of the orderitem to pack into this package content; must be a positive number
PackageDefIdentifier	Generic.Models.PackageDefIdentifier	the package definition to apply to any package created as a result of this OrderItemInPackage
Name	string
Id	int
IsInsert	bool
Links	IList<WebApi.Hal.Link>
	- edit
	- /rels/customers/item	The ordered item.
	- /rels/customers/itemsummary	The ordered item summary, sufficient for editing order item.
	- /rels/orders/order	The containing order.
	- /rels/orders/itemallocate	Operator to allocate this item.
	- /rels/orders/itemdeallocate	Operator to deallocate this item.
Links	IList<WebApi.Hal.Link>
	- edit
	- /rels/orders/order	The containing order.

Sample accept: application/hal+json

{
  "_embedded": {
    "http://api.3plCentral.com/rels/orders/item": [
      {
        "readOnly": {
          "orderItemId": 1,
          "fullyAllocated": true,
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "secondaryUnitIdentifier": {
            "name": "str",
            "id": 2
          },
          "estimatedQty": 1.0,
          "estimatedSecondaryQty": 1.0,
          "originalPrimaryQty": 1.0,
          "isOrderQtySecondary": true,
          "allocations": [
            {
              "receiveItemId": 1,
              "qty": 2.0,
              "properlyPickedPrimary": 3.0,
              "properlyPickedSecondary": 4.0,
              "loadedOut": true,
              "rowVersion": "str",
              "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
              }
            }
          ],
          "bin": "str",
          "isInsert": true,
          "maxToAllocateFromPickLine": 1.0,
          "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",
        "weightImperial": 1.0,
        "weightMetric": 1.0,
        "notes": "str",
        "fulfillInvSalePrice": 1.0,
        "fulfillInvDiscountPct": 1.0,
        "fulfillInvDiscountAmt": 1.0,
        "fulfillInvNote": "str",
        "savedElements": [
          {
            "name": "str",
            "value": "str"
          }
        ],
        "proposedAllocations": [
          {
            "receiveItemId": 1,
            "qty": 2.0
          }
        ],
        "orderItemInPackages": [
          {
            "packageNumber": 1,
            "quantity": 2.0,
            "packageDefIdentifier": {
              "name": "str",
              "id": 2
            }
          }
        ],
        "isInsert": true
      }
    ]
  }
}

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.