inventory assemblies (http://api.3plcentral.com/rels/inventory/assemblies)
Resource:
Collection: of assembly
C# Rel Const:
Rels.InventorySvc.Assemblies
URI template:
assemblies{?pgsiz,pgnum,rql,sort,skulist,skucontains}
Obtain URI from:
get a list of adjustments
Success status: 200
Name Data Type Description
pgsiz int 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
skulist string
skucontains string
Type Description
TotalResults int
ResourceList IList<Inventory.Models.Assembly>
ReadOnly Inventory.Models.AssemblyReadOnly
AssemblyId int
ReferenceNum string
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
ProcessDate DateTime? ...
InvoiceExportedDate DateTime? ...
InvoiceDeliveredDate DateTime? ...
ExpectedDate DateTime? ... Transaction Due Date
CustomerDeactivated bool
FullyAllocated bool
HasAllocations bool
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
WarehouseTransactionSourceType Common.Enum.WarehouseTransactionSourceType? ... how the transaction entered the system
- 0: Unknown
- 1: UiManual
- 2: UiImport
- 3: AutomatedImport
- 4: ExternalSoapApi
- 5: QuickBooksSoapApi
- 6: AutomatedSystemCharge
- 7: RestApi
TransactionEntryType Common.Enum.TransactionEntryType? ... the agent creating the transaction
- 0: DoangHair unknown
- 1: ManualWarehouseUser
- 2: ManualCustomerUser
- 3: Ftp
- 4: Api
ImportChannelIdentifier Generic.Models.ChannelIdentifier reference to the channel trhough which this order was imported
Name string
Id int
CreationDate DateTime? ...
CreatedByIdentifier Generic.Models.UserIdentifier
Name string
Id int
LastModifiedDate DateTime? ...
LastModifiedByIdentifier Generic.Models.UserIdentifier
Name string
Id int
Status Common.Enum.WarehouseTransactionApiStatus For GET of orders and receivers, the value is reliable. For rql for orders, this property is reliable only for "Canceled" status; otherwise use the IsClosed property.
- 0: Open Has not yet been confirmed
- 1: Closed Has been confirmed
- 2: Canceled Has been canceled
Description string
Notes string
InvoiceNumber string
Qty decimal primary inventory quantity assembled
LotNumber string item must be enabled for lot numbers to use this field
SerialNumber string item must be enabled for serial numbers to use this field
ExpirationDate DateTime? ... item must be enabled for expiration dates to use this field
Cost decimal? ... item must be enabled for cost to use this field
SupplierIdentifier Generic.Models.ContactIdentifier customer must be enabled for suppliers to use this field
Name string
Id int
LocationInfo Inventory.Models.LocationInfo customer must be enabled for locations to use this field
Inventory.Models.LocationInfo in GETs: the location; in POSTs or PUTs: identifies existing location or properties of new location more...
LocationId int? ... for identifying: if known specify only this; other fields are ignored
Display string specify either Display or RawField1..n but not both
RawField1 string "Raw" means as the user envisions it without the internal magnitude notation applied for sorting
RawField2 string
RawField3 string
RawField4 string
PalletInfo Inventory.Models.PalletInfo customer must be enabled for movable units to use this field
Inventory.Models.PalletInfo in GETs: the movable unit; in POSTs or PUTs: identifies existing movable unit or properties of new movable unit more...
PalletId int? ... for identifying: if known specify only this; other fields are ignored
Label string for identifying: if known but PalletId unknown, specify label, other fields ignored; for creating: new unique label or leave blank for system to generate unique label number
SplitOverCapacityOnCreate bool? ... if true will use PalletInfo as template to create multiples and splits associated receive items accordingly
QtyOverrideOnSplit decimal? ... when creating and SplitOverCapacityOnCreate is true, overrides the Item.Options.Pallets.Qty otherwise used to create multiples
PalletTypeIdentifier Generic.Models.PalletTypeIdentifier required when creating new movable unit
Name string
Id int
Metric Generic.Models.Dimension optional when creating; if only Metric specified, Imperial is calculated
Length decimal? ...
Width decimal? ...
Height decimal? ...
Weight decimal? ...
Imperial Generic.Models.Dimension optional when creating; if only Imperial specified, Metric is calculated
Length decimal? ...
Width decimal? ...
Height decimal? ...
Weight decimal? ...
Billing Generic.Models.Billing PUT: set to null to make no changes to billing
BillingCharges ICollection<Generic.Models.BillingCharge> PUT: set to NULL or empty to delete all charges
ChargeType Common.Enum.PriceCalcFieldType charge type
- 1: Handling
- 2: Storage
- 3: PrepaidFreight
- 4: ThirdPartyFreight
- 5: SpecialCharges
- 6: Materials
- 7: AutoCalcStorage used internally for sys-gen'ed charges
- 8: AutoCalcHandling used internally for sys-gen'ed charges
- 8: MAXVAL ignore, not a real value
Subtotal decimal
Details ICollection<Generic.Models.BillingChargeDetail>
WarehouseTransactionPriceCalcId int
NumUnits decimal
ChargeLabel string
UnitDescription string
ChargePerUnit decimal
GlAcctNum string
Sku string
PtItem string
PtItemDescription string
PtArAcct string
SystemGenerated bool
TaxCode string Empty on GET. If present on POST or PUT, may create or update a "matching" PriceCalcRate record to be used while generating invoices
RecurringChargeDetails IEnumerable<Generic.Models.RecurringChargeDetail> On GET of charge Adjustments only
RecurringBillingDetailId int
ReceiveItemId int
OnHandAtBillTime decimal
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
Qualifier string
LotNumber string
SerialNumber string
ExpirationDate DateTime? ...
Cost decimal? ...
SupplierIdentifier Generic.Models.ContactIdentifier
Name string
Id int
LocationIdentifier Generic.Models.LocationIdentifier
NameKey Generic.Models.LocationNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
PalletIdentifier Generic.Models.PalletIdentifier
NameKey Generic.Models.PalletNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
SavedElements IEnumerable<Generic.Models.SavedElement>
Name string
Value string
AssemblyItems 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
{
  "totalResults": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/inventory/assembly": [
      {
        "readOnly": {
          "assemblyId": 1,
          "referenceNum": "str",
          "itemIdentifier": {
            "sku": "str",
            "id": 2
          },
          "processDate": "2016-12-25T23:00:00",
          "invoiceExportedDate": "2016-12-25T23:00:00",
          "invoiceDeliveredDate": "2016-12-25T23:00:00",
          "expectedDate": "2016-12-25T23:00:00",
          "customerDeactivated": true,
          "fullyAllocated": true,
          "hasAllocations": true,
          "customerIdentifier": {
            "externalId": "str",
            "name": "str",
            "id": 3
          },
          "facilityIdentifier": {
            "name": "str",
            "id": 2
          },
          "warehouseTransactionSourceType": 0,
          "transactionEntryType": 0,
          "importChannelIdentifier": {
            "name": "str",
            "id": 2
          },
          "creationDate": "2016-12-25T23:00:00",
          "createdByIdentifier": {
            "name": "str",
            "id": 2
          },
          "lastModifiedDate": "2016-12-25T23:00:00",
          "lastModifiedByIdentifier": {
            "name": "str",
            "id": 2
          },
          "status": 0
        },
        "description": "str",
        "notes": "str",
        "invoiceNumber": "str",
        "qty": 5.0,
        "lotNumber": "str",
        "serialNumber": "str",
        "expirationDate": "2016-12-25T23:00:00",
        "cost": 1.0,
        "supplierIdentifier": {
          "name": "str",
          "id": 2
        },
        "locationInfo": {
          "locationId": 1,
          "display": "str",
          "rawField1": "str",
          "rawField2": "str",
          "rawField3": "str",
          "rawField4": "str"
        },
        "palletInfo": {
          "palletId": 1,
          "label": "str",
          "splitOverCapacityOnCreate": true,
          "qtyOverrideOnSplit": 1.0,
          "palletTypeIdentifier": {
            "name": "str",
            "id": 2
          },
          "metric": {
            "length": 1.0,
            "width": 1.0,
            "height": 1.0,
            "weight": 1.0
          },
          "imperial": {
            "length": 1.0,
            "width": 1.0,
            "height": 1.0,
            "weight": 1.0
          }
        },
        "billing": {
          "billingCharges": [
            {
              "chargeType": 1,
              "subtotal": 1.0,
              "details": [
                {
                  "warehouseTransactionPriceCalcId": 1,
                  "numUnits": 2.0,
                  "chargeLabel": "str",
                  "unitDescription": "str",
                  "chargePerUnit": 5.0,
                  "glAcctNum": "str",
                  "sku": "str",
                  "ptItem": "str",
                  "ptItemDescription": "str",
                  "ptArAcct": "str",
                  "systemGenerated": true,
                  "taxCode": "str",
                  "recurringChargeDetails": [
                    {
                      "recurringBillingDetailId": 1,
                      "receiveItemId": 2,
                      "onHandAtBillTime": 3.0,
                      "itemIdentifier": {
                        "sku": "str",
                        "id": 2
                      },
                      "qualifier": "str",
                      "lotNumber": "str",
                      "serialNumber": "str",
                      "expirationDate": "2016-12-25T23:00:00",
                      "cost": 1.0,
                      "supplierIdentifier": {
                        "name": "str",
                        "id": 2
                      },
                      "locationIdentifier": {
                        "nameKey": {
                          "facilityIdentifier": {
                            "name": "str",
                            "id": 2
                          },
                          "name": "str"
                        },
                        "id": 1
                      },
                      "palletIdentifier": {
                        "nameKey": {
                          "facilityIdentifier": {
                            "name": "str",
                            "id": 2
                          },
                          "name": "str"
                        },
                        "id": 1
                      }
                    }
                  ]
                }
              ]
            }
          ]
        },
        "savedElements": [
          {
            "name": "str",
            "value": "str"
          }
        ],
        "_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
                }
              ]
            }
          ]
        }
      }
    ]
  }
}
Create a single assembly.
Success status: 201; ETag response header supplied
none
Type Description
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
WarehouseTransactionSourceEnum Common.Enum.WarehouseTransactionSourceType how the transaction entered the system
- 0: Unknown
- 1: UiManual
- 2: UiImport
- 3: AutomatedImport
- 4: ExternalSoapApi
- 5: QuickBooksSoapApi
- 6: AutomatedSystemCharge
- 7: RestApi
TransactionEntryTypeEnum Common.Enum.TransactionEntryType the agent creating the transaction
- 0: DoangHair unknown
- 1: ManualWarehouseUser
- 2: ManualCustomerUser
- 3: Ftp
- 4: Api
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
ReferenceNum string Transaction Reference Number
ExpectedDate DateTime? ... Transaction Due Date
AssemblyItemTrackByOptions Inventory.Models.AssemblyTrackByOptions
IgnoreAll bool
IgnoreCustomerSupplierUsageLevel bool
IgnoreCostUsageLevel bool
IgnoreExpirationDateUsageLevel bool
IgnoreLotNumberUsageLevel bool
IgnoreSerialNumberUsageLevel bool
IgnoreLocationUsageLevel bool
IgnoreMovableUnitsUsageLevel bool
Description string
Notes string
InvoiceNumber string
Qty decimal primary inventory quantity assembled
LotNumber string item must be enabled for lot numbers to use this field
SerialNumber string item must be enabled for serial numbers to use this field
ExpirationDate DateTime? ... item must be enabled for expiration dates to use this field
Cost decimal? ... item must be enabled for cost to use this field
SupplierIdentifier Generic.Models.ContactIdentifier customer must be enabled for suppliers to use this field
Name string
Id int
LocationInfo Inventory.Models.LocationInfo customer must be enabled for locations to use this field
Inventory.Models.LocationInfo in GETs: the location; in POSTs or PUTs: identifies existing location or properties of new location more...
LocationId int? ... for identifying: if known specify only this; other fields are ignored
Display string specify either Display or RawField1..n but not both
RawField1 string "Raw" means as the user envisions it without the internal magnitude notation applied for sorting
RawField2 string
RawField3 string
RawField4 string
PalletInfo Inventory.Models.PalletInfo customer must be enabled for movable units to use this field
Inventory.Models.PalletInfo in GETs: the movable unit; in POSTs or PUTs: identifies existing movable unit or properties of new movable unit more...
PalletId int? ... for identifying: if known specify only this; other fields are ignored
Label string for identifying: if known but PalletId unknown, specify label, other fields ignored; for creating: new unique label or leave blank for system to generate unique label number
SplitOverCapacityOnCreate bool? ... if true will use PalletInfo as template to create multiples and splits associated receive items accordingly
QtyOverrideOnSplit decimal? ... when creating and SplitOverCapacityOnCreate is true, overrides the Item.Options.Pallets.Qty otherwise used to create multiples
PalletTypeIdentifier Generic.Models.PalletTypeIdentifier required when creating new movable unit
Name string
Id int
Metric Generic.Models.Dimension optional when creating; if only Metric specified, Imperial is calculated
Length decimal? ...
Width decimal? ...
Height decimal? ...
Weight decimal? ...
Imperial Generic.Models.Dimension optional when creating; if only Imperial specified, Metric is calculated
Length decimal? ...
Width decimal? ...
Height decimal? ...
Weight decimal? ...
Billing Generic.Models.Billing PUT: set to null to make no changes to billing
BillingCharges ICollection<Generic.Models.BillingCharge> PUT: set to NULL or empty to delete all charges
ChargeType Common.Enum.PriceCalcFieldType charge type
- 1: Handling
- 2: Storage
- 3: PrepaidFreight
- 4: ThirdPartyFreight
- 5: SpecialCharges
- 6: Materials
- 7: AutoCalcStorage used internally for sys-gen'ed charges
- 8: AutoCalcHandling used internally for sys-gen'ed charges
- 8: MAXVAL ignore, not a real value
Subtotal decimal
Details ICollection<Generic.Models.BillingChargeDetail>
WarehouseTransactionPriceCalcId int
NumUnits decimal
ChargeLabel string
UnitDescription string
ChargePerUnit decimal
GlAcctNum string
Sku string
PtItem string
PtItemDescription string
PtArAcct string
SystemGenerated bool
TaxCode string Empty on GET. If present on POST or PUT, may create or update a "matching" PriceCalcRate record to be used while generating invoices
RecurringChargeDetails IEnumerable<Generic.Models.RecurringChargeDetail> On GET of charge Adjustments only
RecurringBillingDetailId int
ReceiveItemId int
OnHandAtBillTime decimal
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
Qualifier string
LotNumber string
SerialNumber string
ExpirationDate DateTime? ...
Cost decimal? ...
SupplierIdentifier Generic.Models.ContactIdentifier
Name string
Id int
LocationIdentifier Generic.Models.LocationIdentifier
NameKey Generic.Models.LocationNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
PalletIdentifier Generic.Models.PalletIdentifier
NameKey Generic.Models.PalletNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
SavedElements IEnumerable<Generic.Models.SavedElement>
Name string
Value string
AssemblyItems 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 content-type: application/hal+json
{
  "customerIdentifier": {
    "externalId": "str",
    "name": "str",
    "id": 3
  },
  "facilityIdentifier": {
    "name": "str",
    "id": 2
  },
  "warehouseTransactionSourceEnum": 0,
  "transactionEntryTypeEnum": 0,
  "itemIdentifier": {
    "sku": "str",
    "id": 2
  },
  "referenceNum": "str",
  "expectedDate": "2016-12-25T23:00:00",
  "assemblyItemTrackByOptions": {
    "ignoreAll": true,
    "ignoreCustomerSupplierUsageLevel": true,
    "ignoreCostUsageLevel": true,
    "ignoreExpirationDateUsageLevel": true,
    "ignoreLotNumberUsageLevel": true,
    "ignoreSerialNumberUsageLevel": true,
    "ignoreLocationUsageLevel": true,
    "ignoreMovableUnitsUsageLevel": true
  },
  "description": "str",
  "notes": "str",
  "invoiceNumber": "str",
  "qty": 5.0,
  "lotNumber": "str",
  "serialNumber": "str",
  "expirationDate": "2016-12-25T23:00:00",
  "cost": 1.0,
  "supplierIdentifier": {
    "name": "str",
    "id": 2
  },
  "locationInfo": {
    "locationId": 1,
    "display": "str",
    "rawField1": "str",
    "rawField2": "str",
    "rawField3": "str",
    "rawField4": "str"
  },
  "palletInfo": {
    "palletId": 1,
    "label": "str",
    "splitOverCapacityOnCreate": true,
    "qtyOverrideOnSplit": 1.0,
    "palletTypeIdentifier": {
      "name": "str",
      "id": 2
    },
    "metric": {
      "length": 1.0,
      "width": 1.0,
      "height": 1.0,
      "weight": 1.0
    },
    "imperial": {
      "length": 1.0,
      "width": 1.0,
      "height": 1.0,
      "weight": 1.0
    }
  },
  "billing": {
    "billingCharges": [
      {
        "chargeType": 1,
        "subtotal": 1.0,
        "details": [
          {
            "warehouseTransactionPriceCalcId": 1,
            "numUnits": 2.0,
            "chargeLabel": "str",
            "unitDescription": "str",
            "chargePerUnit": 5.0,
            "glAcctNum": "str",
            "sku": "str",
            "ptItem": "str",
            "ptItemDescription": "str",
            "ptArAcct": "str",
            "systemGenerated": true,
            "taxCode": "str",
            "recurringChargeDetails": [
              {
                "recurringBillingDetailId": 1,
                "receiveItemId": 2,
                "onHandAtBillTime": 3.0,
                "itemIdentifier": {
                  "sku": "str",
                  "id": 2
                },
                "qualifier": "str",
                "lotNumber": "str",
                "serialNumber": "str",
                "expirationDate": "2016-12-25T23:00:00",
                "cost": 1.0,
                "supplierIdentifier": {
                  "name": "str",
                  "id": 2
                },
                "locationIdentifier": {
                  "nameKey": {
                    "facilityIdentifier": {
                      "name": "str",
                      "id": 2
                    },
                    "name": "str"
                  },
                  "id": 1
                },
                "palletIdentifier": {
                  "nameKey": {
                    "facilityIdentifier": {
                      "name": "str",
                      "id": 2
                    },
                    "name": "str"
                  },
                  "id": 1
                }
              }
            ]
          }
        ]
      }
    ]
  },
  "savedElements": [
    {
      "name": "str",
      "value": "str"
    }
  ],
  "_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
          }
        ]
      }
    ]
  }
}
Type Description
ReadOnly Inventory.Models.AssemblyReadOnly
AssemblyId int
ReferenceNum string
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
ProcessDate DateTime? ...
InvoiceExportedDate DateTime? ...
InvoiceDeliveredDate DateTime? ...
ExpectedDate DateTime? ... Transaction Due Date
CustomerDeactivated bool
FullyAllocated bool
HasAllocations bool
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
WarehouseTransactionSourceType Common.Enum.WarehouseTransactionSourceType? ... how the transaction entered the system
- 0: Unknown
- 1: UiManual
- 2: UiImport
- 3: AutomatedImport
- 4: ExternalSoapApi
- 5: QuickBooksSoapApi
- 6: AutomatedSystemCharge
- 7: RestApi
TransactionEntryType Common.Enum.TransactionEntryType? ... the agent creating the transaction
- 0: DoangHair unknown
- 1: ManualWarehouseUser
- 2: ManualCustomerUser
- 3: Ftp
- 4: Api
ImportChannelIdentifier Generic.Models.ChannelIdentifier reference to the channel trhough which this order was imported
Name string
Id int
CreationDate DateTime? ...
CreatedByIdentifier Generic.Models.UserIdentifier
Name string
Id int
LastModifiedDate DateTime? ...
LastModifiedByIdentifier Generic.Models.UserIdentifier
Name string
Id int
Status Common.Enum.WarehouseTransactionApiStatus For GET of orders and receivers, the value is reliable. For rql for orders, this property is reliable only for "Canceled" status; otherwise use the IsClosed property.
- 0: Open Has not yet been confirmed
- 1: Closed Has been confirmed
- 2: Canceled Has been canceled
Description string
Notes string
InvoiceNumber string
Qty decimal primary inventory quantity assembled
LotNumber string item must be enabled for lot numbers to use this field
SerialNumber string item must be enabled for serial numbers to use this field
ExpirationDate DateTime? ... item must be enabled for expiration dates to use this field
Cost decimal? ... item must be enabled for cost to use this field
SupplierIdentifier Generic.Models.ContactIdentifier customer must be enabled for suppliers to use this field
Name string
Id int
LocationInfo Inventory.Models.LocationInfo customer must be enabled for locations to use this field
Inventory.Models.LocationInfo in GETs: the location; in POSTs or PUTs: identifies existing location or properties of new location more...
LocationId int? ... for identifying: if known specify only this; other fields are ignored
Display string specify either Display or RawField1..n but not both
RawField1 string "Raw" means as the user envisions it without the internal magnitude notation applied for sorting
RawField2 string
RawField3 string
RawField4 string
PalletInfo Inventory.Models.PalletInfo customer must be enabled for movable units to use this field
Inventory.Models.PalletInfo in GETs: the movable unit; in POSTs or PUTs: identifies existing movable unit or properties of new movable unit more...
PalletId int? ... for identifying: if known specify only this; other fields are ignored
Label string for identifying: if known but PalletId unknown, specify label, other fields ignored; for creating: new unique label or leave blank for system to generate unique label number
SplitOverCapacityOnCreate bool? ... if true will use PalletInfo as template to create multiples and splits associated receive items accordingly
QtyOverrideOnSplit decimal? ... when creating and SplitOverCapacityOnCreate is true, overrides the Item.Options.Pallets.Qty otherwise used to create multiples
PalletTypeIdentifier Generic.Models.PalletTypeIdentifier required when creating new movable unit
Name string
Id int
Metric Generic.Models.Dimension optional when creating; if only Metric specified, Imperial is calculated
Length decimal? ...
Width decimal? ...
Height decimal? ...
Weight decimal? ...
Imperial Generic.Models.Dimension optional when creating; if only Imperial specified, Metric is calculated
Length decimal? ...
Width decimal? ...
Height decimal? ...
Weight decimal? ...
Billing Generic.Models.Billing PUT: set to null to make no changes to billing
BillingCharges ICollection<Generic.Models.BillingCharge> PUT: set to NULL or empty to delete all charges
ChargeType Common.Enum.PriceCalcFieldType charge type
- 1: Handling
- 2: Storage
- 3: PrepaidFreight
- 4: ThirdPartyFreight
- 5: SpecialCharges
- 6: Materials
- 7: AutoCalcStorage used internally for sys-gen'ed charges
- 8: AutoCalcHandling used internally for sys-gen'ed charges
- 8: MAXVAL ignore, not a real value
Subtotal decimal
Details ICollection<Generic.Models.BillingChargeDetail>
WarehouseTransactionPriceCalcId int
NumUnits decimal
ChargeLabel string
UnitDescription string
ChargePerUnit decimal
GlAcctNum string
Sku string
PtItem string
PtItemDescription string
PtArAcct string
SystemGenerated bool
TaxCode string Empty on GET. If present on POST or PUT, may create or update a "matching" PriceCalcRate record to be used while generating invoices
RecurringChargeDetails IEnumerable<Generic.Models.RecurringChargeDetail> On GET of charge Adjustments only
RecurringBillingDetailId int
ReceiveItemId int
OnHandAtBillTime decimal
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
Qualifier string
LotNumber string
SerialNumber string
ExpirationDate DateTime? ...
Cost decimal? ...
SupplierIdentifier Generic.Models.ContactIdentifier
Name string
Id int
LocationIdentifier Generic.Models.LocationIdentifier
NameKey Generic.Models.LocationNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
PalletIdentifier Generic.Models.PalletIdentifier
NameKey Generic.Models.PalletNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
SavedElements IEnumerable<Generic.Models.SavedElement>
Name string
Value string
AssemblyItems 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
{
  "readOnly": {
    "assemblyId": 1,
    "referenceNum": "str",
    "itemIdentifier": {
      "sku": "str",
      "id": 2
    },
    "processDate": "2016-12-25T23:00:00",
    "invoiceExportedDate": "2016-12-25T23:00:00",
    "invoiceDeliveredDate": "2016-12-25T23:00:00",
    "expectedDate": "2016-12-25T23:00:00",
    "customerDeactivated": true,
    "fullyAllocated": true,
    "hasAllocations": true,
    "customerIdentifier": {
      "externalId": "str",
      "name": "str",
      "id": 3
    },
    "facilityIdentifier": {
      "name": "str",
      "id": 2
    },
    "warehouseTransactionSourceType": 0,
    "transactionEntryType": 0,
    "importChannelIdentifier": {
      "name": "str",
      "id": 2
    },
    "creationDate": "2016-12-25T23:00:00",
    "createdByIdentifier": {
      "name": "str",
      "id": 2
    },
    "lastModifiedDate": "2016-12-25T23:00:00",
    "lastModifiedByIdentifier": {
      "name": "str",
      "id": 2
    },
    "status": 0
  },
  "description": "str",
  "notes": "str",
  "invoiceNumber": "str",
  "qty": 5.0,
  "lotNumber": "str",
  "serialNumber": "str",
  "expirationDate": "2016-12-25T23:00:00",
  "cost": 1.0,
  "supplierIdentifier": {
    "name": "str",
    "id": 2
  },
  "locationInfo": {
    "locationId": 1,
    "display": "str",
    "rawField1": "str",
    "rawField2": "str",
    "rawField3": "str",
    "rawField4": "str"
  },
  "palletInfo": {
    "palletId": 1,
    "label": "str",
    "splitOverCapacityOnCreate": true,
    "qtyOverrideOnSplit": 1.0,
    "palletTypeIdentifier": {
      "name": "str",
      "id": 2
    },
    "metric": {
      "length": 1.0,
      "width": 1.0,
      "height": 1.0,
      "weight": 1.0
    },
    "imperial": {
      "length": 1.0,
      "width": 1.0,
      "height": 1.0,
      "weight": 1.0
    }
  },
  "billing": {
    "billingCharges": [
      {
        "chargeType": 1,
        "subtotal": 1.0,
        "details": [
          {
            "warehouseTransactionPriceCalcId": 1,
            "numUnits": 2.0,
            "chargeLabel": "str",
            "unitDescription": "str",
            "chargePerUnit": 5.0,
            "glAcctNum": "str",
            "sku": "str",
            "ptItem": "str",
            "ptItemDescription": "str",
            "ptArAcct": "str",
            "systemGenerated": true,
            "taxCode": "str",
            "recurringChargeDetails": [
              {
                "recurringBillingDetailId": 1,
                "receiveItemId": 2,
                "onHandAtBillTime": 3.0,
                "itemIdentifier": {
                  "sku": "str",
                  "id": 2
                },
                "qualifier": "str",
                "lotNumber": "str",
                "serialNumber": "str",
                "expirationDate": "2016-12-25T23:00:00",
                "cost": 1.0,
                "supplierIdentifier": {
                  "name": "str",
                  "id": 2
                },
                "locationIdentifier": {
                  "nameKey": {
                    "facilityIdentifier": {
                      "name": "str",
                      "id": 2
                    },
                    "name": "str"
                  },
                  "id": 1
                },
                "palletIdentifier": {
                  "nameKey": {
                    "facilityIdentifier": {
                      "name": "str",
                      "id": 2
                    },
                    "name": "str"
                  },
                  "id": 1
                }
              }
            ]
          }
        ]
      }
    ]
  },
  "savedElements": [
    {
      "name": "str",
      "value": "str"
    }
  ],
  "_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.