Resource:Collection: of receiverC# Rel Const:Rels.InventorySvc.ReceiversURI template:receivers{?pgsiz,pgnum,rql,sort,detail,itemdetail,purchaseorderid,receivertype,deactivatedcustomers}Obtain URI from:
Get list of receivers.
Success status: 200
Name | Data Type | Description |
---|---|---|
pgsiz | int | must be positive; limit 500, specifying more is an error; default 100; 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 |
detail | Common.Enum.ReceiverChildren | comma-delim list, for inclusion in response, default None |
- None | ||
- ReceiveItems | ||
- BillingDetails | ||
- SavedElements | ||
- All | ||
- ProposedBilling | ||
itemdetail | Common.Enum.ReceiveItemChildren | comma-delim list, for inclusion in response, default None |
- None | ||
- SavedElements | ||
- All | ||
purchaseorderid | int | select receivers with PoNum same as given PurchaseOrder's PurchaseOrderNumber |
receivertype | Common.Enum.ReceiverType | 0 = Normal, 1 = Return, 2 = ASN (ReceiveAgainst), 3 = OnlyASNs, 4 = NoASNs |
deactivatedcustomers | bool |
Type | Description | |
---|---|---|
TotalResults | int | |
ResourceList | IList<Inventory.Models.Receiver> | |
ReadOnly | Inventory.Models.ReceiverReadOnly | |
ReceiverId | int | |
ReceiverType | Common.Enum.ReceiverType | on the db, a return is represented by a SavedElement, a ReceiveAgainst means stage = 2 |
- 0: Normal | yields receivers and converted ASNs | |
- 1: Return | yields returns | |
- 2: ReceiveAgainst | yields ASN candidates | |
- 3: OnlyASNs | yields ASN candidates, and converted ASNs Used in SmartScan workflow | |
- 4: AllButASNs | yields receivers and returns Used in SmartScan Workflow | |
DeferNotification | bool | nudge, nudge: WarehouseTransaction.Stage == 0 |
ReceiptAdviceSendInfo | Inventory.Models.ReceiptAdviceSendInfo | |
MarkInfo | Inventory.Models.MarkInfo | Used by the system to send a receipt advice |
Candidate | int | |
ChannelIdentifier | Generic.Models.ChannelIdentifier | |
Name | string | |
Id | int | |
TransformIds | string | |
SentInfo | Inventory.Models.SentInfo | Indicates if and when a receipt advice was sent |
Sent | bool | |
Date | DateTime? ... | |
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 | |
ReceiveItems | IList<Inventory.Models.ReceiveItem> | |
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 | |
Links | IList<WebApi.Hal.Link> | |
- edit | ||
- /rels/customers/customer | ||
- /rels/properties/facility | ||
- /rels/inventory/receiveritems | ||
- /rels/inventory/receiverfilesummaries | Info on files attached to receiver. | |
- /rels/inventory/receiverlocate | Operator to locate items using directed put-away settings. | |
- /rels/inventory/receiverconfirm | Operator to confirm the receiver. | |
- /rels/inventory/asnconverter | Operator to convert asn to receiver. | |
- /rels/inventory/receiverunconfirm | Operator to unconfirm the receiver; only present if 'detail' includes ReceiveItems and the receiver is confirmed but unallocated. | |
- /rels/orders/ordersallocate | Operator to allocate orders for goods this receiver received into inventory. | |
- /rels/orders/summaries | The orders allocated against this receiver. | |
- /rels/inventory/receivercomplete | Operator to complete the receiver. | |
- /rels/inventory/receivercancel | Operator to cancel the receiver. | |
- /rels/inventory/receiverramark | Operator to mark for Receipt Advice. | |
- /rels/inventory/receiverrasent | Operator to indicate Receipt Advice sent. | |
- /rels/inventory/savedelements | ||
- /rels/inventory/relocator | Operator to update a movable units location, before confirmation | |
- /rels/inventory/raasnarrival | Operator to send warehouse transaction event | |
- /rels/inventory/starter | Operator to send warehouse transaction event | |
- /rels/inventory/pauser | Operator to send warehouse transaction event | |
- /rels/inventory/resumer | Operator to send warehouse transaction event | |
- /rels/inventory/finisher | Operator to send warehouse transaction event | |
- /rels/inventory/itemprocessor | Operator to send warehouse transaction event | |
Links | IList<WebApi.Hal.Link> | |
- next | ||
- prev |
{ "totalResults": 1, "_embedded": { "http://api.3plCentral.com/rels/inventory/receiver": [ { "readOnly": { "receiverId": 1, "receiverType": 0, "deferNotification": true, "receiptAdviceSendInfo": { "markInfo": { "candidate": 1, "channelIdentifier": { "name": "str", "id": 2 }, "transformIds": "str" }, "sentInfo": { "sent": true, "date": "2016-12-25T23:00:00" } }, "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 }, "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" } ], "_embedded": { "http://api.3plCentral.com/rels/inventory/receiveritem": [ { "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" } ] } } ] } }
Create new receiver.
If customer is configured to create "Receive Against", each new receiver starts out as a ReceiveAgainst instead of a Receiver,
in which case it is upgraded to a receiver via appropriate link, at which point you can specify actual quantities.
Success status: 201; ETag response header supplied
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 | ||
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 |
Sample content-type: application/hal+json |
{ "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, "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" } ], "_embedded": { "http://api.3plCentral.com/rels/inventory/receiveritem": [ { "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" } ] } }
Type | Description | |
---|---|---|
ReadOnly | Inventory.Models.ReceiverReadOnly | |
ReceiverId | int | |
ReceiverType | Common.Enum.ReceiverType | on the db, a return is represented by a SavedElement, a ReceiveAgainst means stage = 2 |
- 0: Normal | yields receivers and converted ASNs | |
- 1: Return | yields returns | |
- 2: ReceiveAgainst | yields ASN candidates | |
- 3: OnlyASNs | yields ASN candidates, and converted ASNs Used in SmartScan workflow | |
- 4: AllButASNs | yields receivers and returns Used in SmartScan Workflow | |
DeferNotification | bool | nudge, nudge: WarehouseTransaction.Stage == 0 |
ReceiptAdviceSendInfo | Inventory.Models.ReceiptAdviceSendInfo | |
MarkInfo | Inventory.Models.MarkInfo | Used by the system to send a receipt advice |
Candidate | int | |
ChannelIdentifier | Generic.Models.ChannelIdentifier | |
Name | string | |
Id | int | |
TransformIds | string | |
SentInfo | Inventory.Models.SentInfo | Indicates if and when a receipt advice was sent |
Sent | bool | |
Date | DateTime? ... | |
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 | |
ReceiveItems | IList<Inventory.Models.ReceiveItem> | |
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 | |
Links | IList<WebApi.Hal.Link> | |
- edit | ||
- /rels/customers/customer | ||
- /rels/properties/facility | ||
- /rels/inventory/receiveritems | ||
- /rels/inventory/receiverfilesummaries | Info on files attached to receiver. | |
- /rels/inventory/receiverlocate | Operator to locate items using directed put-away settings. | |
- /rels/inventory/receiverconfirm | Operator to confirm the receiver. | |
- /rels/inventory/asnconverter | Operator to convert asn to receiver. | |
- /rels/inventory/receiverunconfirm | Operator to unconfirm the receiver; only present if 'detail' includes ReceiveItems and the receiver is confirmed but unallocated. | |
- /rels/orders/ordersallocate | Operator to allocate orders for goods this receiver received into inventory. | |
- /rels/orders/summaries | The orders allocated against this receiver. | |
- /rels/inventory/receivercomplete | Operator to complete the receiver. | |
- /rels/inventory/receivercancel | Operator to cancel the receiver. | |
- /rels/inventory/receiverramark | Operator to mark for Receipt Advice. | |
- /rels/inventory/receiverrasent | Operator to indicate Receipt Advice sent. | |
- /rels/inventory/savedelements | ||
- /rels/inventory/relocator | Operator to update a movable units location, before confirmation | |
- /rels/inventory/raasnarrival | Operator to send warehouse transaction event | |
- /rels/inventory/starter | Operator to send warehouse transaction event | |
- /rels/inventory/pauser | Operator to send warehouse transaction event | |
- /rels/inventory/resumer | Operator to send warehouse transaction event | |
- /rels/inventory/finisher | Operator to send warehouse transaction event | |
- /rels/inventory/itemprocessor | Operator to send warehouse transaction event |
{ "readOnly": { "receiverId": 1, "receiverType": 0, "deferNotification": true, "receiptAdviceSendInfo": { "markInfo": { "candidate": 1, "channelIdentifier": { "name": "str", "id": 2 }, "transformIds": "str" }, "sentInfo": { "sent": true, "date": "2016-12-25T23:00:00" } }, "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 }, "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" } ], "_embedded": { "http://api.3plCentral.com/rels/inventory/receiveritem": [ { "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" } ] } }
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.