Type	Description
ContentType	string	obtained from the HTTP "Content-Type" header
Content	Object	obtained from the HTTP payload

Sample content-type: application/hal+json

Copy to clipboard

copied

{
  "contentType": "str",
  "content": {}
}

	Type	Description
TransformId	int
Receivers	IEnumerable<Inventory.Models.ImportFileParseReceiver>
Receiver	Inventory.Models.ReceiverCreate	object parsed from one import file entry more...
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
ImportChannelIdentifier	Generic.Models.ChannelIdentifier	reference to the channel thrpough with this receiver was imported
Name	string
Id	int
TransactionEntryType	Common.Enum.TransactionEntryType	if not set, API will set it to Ftp if FtpIdentifier specified; otherwise API cannot distinquish between "manual" entry vs. automated, so a UI caller should set to either ManualWarehouseUser or ManualCustomerUser and automated processes should set to Api
	Common.Enum.TransactionEntryType	the agent creating the transaction
	- 0: DoangHair	unknown
	- 1: ManualWarehouseUser
	- 2: ManualCustomerUser
	- 3: Ftp
	- 4: Api
ImportModuleId	int? ...	usually used only for import
ExportModuleIds	string	usually set only by import
IsReturn	bool	true: adds SavedElement to flag receiver as a return -- yuh, it's hoaky
DeferNotification	bool	true: notification of creation is deferred until receiver is completed
ReceiveItems	IList<Inventory.Models.ReceiveItem>	line items
ReadOnly	Inventory.Models.ReceiveItemReadOnly	provided when GETting, ignored when POSTing new or PUTting existing single receive item, required when PUTting list of receive items
ReceiveItemId	int	when PUTting a receiver or a receive item list, zero to create a new receiver item, otherwise it identifies an existing receive item
FullyShippedDate	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
ExpectedQty	decimal? ...	when a ReceiveAgainst receiver is converted to a normal receiver, ExpectedQty is automatically copied from PrimaryQty; otherwise the ExpectedQty is null
InventoryLevels	Inventory.Models.InventoryLevels	from StockStatus
OnHand	decimal	in the warehouse
Available	decimal	in the warehouse but not allocated to any order
SecondaryAvailable	decimal? ...
OnHoldDate	DateTime? ...	The date the receive item was most recently placed on hol
OnHoldUserIdentifier	Generic.Models.UserIdentifier	the user who most recently place the receive item on hold
Name	string
Id	int
FacilityIdentifier	Generic.Models.FacilityIdentifier	the facility where the receive item was received
Name	string
Id	int
ReferenceNumber	string	The Reference number of the receipt containing this receiveItem
TransactionID	int	The Transaction ID containing this receiveItem
ItemIdentifier	Generic.Models.ItemIdentifier
Sku	string
Id	int
Qualifier	string	item qualifer; null is interpreted same as empty string
ExternalId	string	connection of this receive item to the same receive item on some other system
Qty	decimal? ...	primary inventory quantity received; if not specified, must specify SecondaryQty from which Qty will be calculated
SecondaryQty	decimal? ...	if not specified and Item.Options.SecondaryUnit defined will be calculated from Qty; error if specified and Item.Options.SecondaryUnit null
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? ...
WeightImperial	decimal? ...	total weight of receive item, imperial; if specified and metric not specified, business logic computes metric more...
WeightMetric	decimal? ...	total weight of receive item, metric; if specified and imperial not specified, business logic computes imperial; see WeightImperial for further explanation
OnHold	bool	If true, this receive item is not available for allocation
OnHoldReason	string	the reason the receive item was placed on hold; required if OnHold is true
SavedElements	IEnumerable<Generic.Models.SavedElement>
Name	string
Value	string
CondensedSEs	string	a condensed string of the saved Elements, used as a groupBy value
Links	IList<WebApi.Hal.Link>
	- edit	The containing receiver.
	- /rels/inventory/receiver	The containing receiver.
	- /rels/inventory/adjustment	The containing adjustment.
	- /rels/inventory/assembly	The assembly.
	- /rels/customers/item
	- /rels/customers/itemsummary
	- /rels/properties/location
	- /rels/inventory/pallet
	- /rels/customers/customer
	- /rels/properties/facility
	- /rels/properties/contact
ReferenceNum	string	required
PoNum	string
ExternalId	string	connection of this receiver to the same receiver on some other system
ReceiptAdviceNumber	string	Number of document from which this receiver was created
ArrivalDate	DateTime? ...	maps to ProcessDate; at confirm time this can't be in the future; if the caller wishes, based on whatever user permission the caller wants to dream up, the caller should validate it isn't prior to period freeze date caller could regard ThreePlSettingType.AutoSetArrivalDate in conjunction with permissions to decide whether to set to today and not allow user to touch
ScannedArrivalDate	DateTime? ...	Represents the scanned arrival time of a receiver, used for tracking Dock to Stock time
ExpectedDate	DateTime? ...
Notes	string
Billing	Generic.Models.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
ShipTo	Generic.Models.OrderContactInfo	of questionable use; certain parsers, such as EDI943, map import file content to a receiver shipto???
	Generic.Models.OrderContactInfo	in GETs: the contact; in POSTs or PUTs: identifies existing contact or properties of new contact more...
SameAs	Common.Enum.ContactType? ...	PUT or POST: to use same Contact as another contact on the same order; GET: always null more...
	- 0: ShipTo
	- 1: SoldTo
	- 2: BillTo
RetailerId	int? ...	DEPRECATED, will be removed from model: for ShipTo, use RetailerInfo; for SoldTo and BillTo, ignored
IsQuickLookup	bool
ContactId	int? ...	for identifying: if known specify only this; other fields are ignored
CompanyName	string
Name	string
Title	string
Address1	string
Address2	string
City	string
State	string
Zip	string
Country	string
PhoneNumber	string
Fax	string
EmailAddress	string
Dept	string
IsAddressResidential	bool
Code	string	for identifying: if known specify only this; if other fields also specified it is not used to identify
AddressStatus	Common.Enum.AddressStatusType	confirmation status
	- 0: Unconfirmed
	- 1: Confirmed
	- 2: UserAccepted
ScacCode	string
Carrier	string
BillOfLading	string
DoorNumber	string
TrackingNumber	string
TrailerNumber	string
SealNumber	string
CapacityTypeIdentifier	Generic.Models.CapacityTypeIdentifier
Name	string
Id	int
NumUnits1	decimal? ...
Unit1Identifier	Generic.Models.UnitOfMeasureIdentifier
Name	string
Id	int
NumUnits2	decimal? ...
Unit2Identifier	Generic.Models.UnitOfMeasureIdentifier
Name	string
Id	int
TotalWeight	decimal? ...
TotalVolume	decimal? ...
SavedElements	IEnumerable<Generic.Models.SavedElement>
Name	string
Value	string
ListException	Generic.Models.Exceptions.ListException	container of WmsExceptionBase-derived exceptions occuring during actions on lists, such as import or mass ops
Message	string
Faults	IList<Generic.Models.Exceptions.ListEntryFault>
EntryNumber	int	1-indexed position in the source list
EntryInfo	string	optional info about the entry in the source list, such as id, sku, ref#, etc.
WmsException	Generic.Models.Exceptions.WmsExceptionBase	for more details at runtime see which WmsExceptionBase-derived exception it is
ErrorCode	string	could have been a number, but is a short string for human readability; not to be localized
Hint	string	helpful word or two if the thrower happens to know more things; not to be localized
Message	string
InnerException	System.Exception
Links	IList<WebApi.Hal.Link>
	- /rels/inventory/import	create receivers
FileFormat	Common.Enum.InputParserFormatType
	- 0: EDI
	- 1: TabDelim
	- 2: XML
	- 3: Unknown

Sample accept: application/hal+json

{
  "fileFormat": 0,
  "transformId": 1,
  "receivers": [
    {
      "receiver": {
        "customerIdentifier": {
          "externalId": "str",
          "name": "str",
          "id": 3
        },
        "facilityIdentifier": {
          "name": "str",
          "id": 2
        },
        "warehouseTransactionSourceEnum": 0,
        "importChannelIdentifier": {
          "name": "str",
          "id": 2
        },
        "transactionEntryType": 0,
        "importModuleId": 1,
        "exportModuleIds": "str",
        "isReturn": true,
        "deferNotification": true,
        "receiveItems": [
          {
            "readOnly": {
              "receiveItemId": 1,
              "fullyShippedDate": "2016-12-25T23:00:00",
              "unitIdentifier": {
                "name": "str",
                "id": 2
              },
              "secondaryUnitIdentifier": {
                "name": "str",
                "id": 2
              },
              "expectedQty": 1.0,
              "inventoryLevels": {
                "onHand": 1.0,
                "available": 2.0,
                "secondaryAvailable": 1.0
              },
              "onHoldDate": "2016-12-25T23:00:00",
              "onHoldUserIdentifier": {
                "name": "str",
                "id": 2
              },
              "facilityIdentifier": {
                "name": "str",
                "id": 2
              },
              "referenceNumber": "str",
              "transactionID": 3,
              "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",
            "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
              }
            },
            "weightImperial": 1.0,
            "weightMetric": 1.0,
            "onHold": true,
            "onHoldReason": "str",
            "savedElements": [
              {
                "name": "str",
                "value": "str"
              }
            ],
            "condensedSEs": "str",
            "_links": null
          }
        ],
        "referenceNum": "str",
        "poNum": "str",
        "externalId": "str",
        "receiptAdviceNumber": "str",
        "arrivalDate": "2016-12-25T23:00:00",
        "scannedArrivalDate": "2016-12-25T23:00:00",
        "expectedDate": "2016-12-25T23:00:00",
        "notes": "str",
        "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
                      }
                    }
                  ]
                }
              ]
            }
          ]
        },
        "shipTo": {
          "sameAs": 0,
          "retailerId": 1,
          "isQuickLookup": true,
          "contactId": 1,
          "companyName": "str",
          "name": "str",
          "title": "str",
          "address1": "str",
          "address2": "str",
          "city": "str",
          "state": "str",
          "zip": "str",
          "country": "str",
          "phoneNumber": "str",
          "fax": "str",
          "emailAddress": "str",
          "dept": "str",
          "isAddressResidential": true,
          "code": "str",
          "addressStatus": 0
        },
        "scacCode": "str",
        "carrier": "str",
        "billOfLading": "str",
        "doorNumber": "str",
        "trackingNumber": "str",
        "trailerNumber": "str",
        "sealNumber": "str",
        "capacityTypeIdentifier": {
          "name": "str",
          "id": 2
        },
        "numUnits1": 1.0,
        "unit1Identifier": {
          "name": "str",
          "id": 2
        },
        "numUnits2": 1.0,
        "unit2Identifier": {
          "name": "str",
          "id": 2
        },
        "totalWeight": 1.0,
        "totalVolume": 1.0,
        "savedElements": [
          {
            "name": "str",
            "value": "str"
          }
        ],
        "_links": null
      }
    }
  ],
  "listException": {
    "message": "ListException: Faults [{EntryNumber 1, }]",
    "faults": [
      {
        "entryNumber": 1,
        "entryInfo": "str"
      }
    ],
    "data": {},
    "helpLink": "str",
    "source": "str",
    "hResult": 3
  }
}