| Name
|
Data Type | Description |
| pgsiz
|
int |
must be positive; limit 1000, specifying more is an error; default 100;
max records to return per response; use "next" or "prev" link to paginate
|
| pgnum
|
int |
specify 0 to return model with only the TotalResults property populated;
considering pgsiz, returns the pgnum-th page, 1-indexed
|
| rql
|
string |
see RQL documentation
|
| sort
|
string |
see RQL documentation
|
| skulist
|
string |
comma-delim list of skus, match any receiver with a line item for any given sku |
| skucontains
|
string |
single partial sku, match any receiver with a line item for given partial sku |
|
Type |
Description |
| TotalResults |
int
|
|
| ResourceList |
IList<Inventory.Models.ReceiverDigest>
|
|
| CustomerDeactivated |
bool
|
|
| CreationDate |
DateTime?
|
Date the receiver record was created
|
| ArrivalDate |
DateTime?
|
Before confirmation, this is the date the record 'should' be confirmed; after confirmation is it the confirmation date
|
| ExpectedDate |
DateTime?
|
|
| ReferenceNum |
string
|
Unique for each customer
|
| PoNum |
string
|
If purchase orders are enabled, this is the PurchaseOrderNumber of the related purchase order.
|
| ReceiptAdviceNumber |
string
|
Used by the system to group receivers for purposes of giving receipt advices
|
| Notes |
string
|
|
| TrailerNumber |
string
|
Number of the trailer, if any, on which the goods arrived
|
| ItemInfos |
IEnumerable<Inventory.Models.ItemInfo>
|
|
| ReceiveItemId |
int
|
|
| ItemIdentifier |
Generic.Models.ItemIdentifier
|
|
| Sku |
string
|
|
| Id |
int
|
|
| OrigQtyPrimary |
decimal
|
|
| Available |
decimal
|
|
| OnHold |
bool
|
|
| ConfirmAsnSentDate |
DateTime?
|
|
| DeferNotification |
bool
|
true means the receiver is incomplete and notification of arrival should not yet be given
|
| ReceiptAdviceSent |
bool
|
If false, use embedded link to mark for sending.
|
| CanComplete |
bool
|
true if the receiver can be completed
|
| CanCancel |
bool
|
true if the receiver can be canceled
|
| CanMarkForRa |
bool
|
true if the receiver can be marked to send receipt advice
|
| CanMarkSentRa |
bool
|
true if the receiver can be marked receipt advice sent
|
| IsReturn |
bool
|
true if the receiver is flagged as a return.
|
| ReceiverId |
int
|
|
| CustomerIdentifier |
Generic.Models.CustomerIdentifier
|
|
| ExternalId |
string
|
|
| Name |
string
|
|
| Id |
int
|
|
| FacilityIdentifier |
Generic.Models.FacilityIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| Status |
Common.Enum.WarehouseTransactionApiStatus
|
|
|
- 0: Open |
Has not yet been confirmed |
|
- 1: Closed |
Has been confirmed |
|
- 2: Canceled |
Has been canceled |
| CanConfirm |
bool
|
true if the receiver can be confirmed
|
| CanUnconfirm |
bool
|
true if the receiver can be unconfirmed
|
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
/rels/inventory/receiver
|
The full receiver. |
|
-
/rels/customers/customer
|
|
|
-
/rels/properties/facility
|
|
|
-
/rels/inventory/receiveritems
|
|
|
-
/rels/inventory/receiverfilesummaries
|
Info on files attached to receiver. |
|
-
/rels/orders/ordersallocate
|
Operator to allocate orders for goods this receiver received into inventory. |
|
-
/rels/orders/summaries
|
The orders allocated against this receiver. |
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
next |
|
|
-
prev |
|
Sample accept: application/hal+json
{
"totalResults": 1,
"_embedded": {
"item": [
{
"customerDeactivated": true,
"creationDate": "2016-12-25T23:00:00",
"arrivalDate": "2016-12-25T23:00:00",
"expectedDate": "2016-12-25T23:00:00",
"referenceNum": "str",
"poNum": "str",
"receiptAdviceNumber": "str",
"notes": "str",
"trailerNumber": "str",
"itemInfos": [
{
"receiveItemId": 1,
"itemIdentifier": {
"sku": "str",
"id": 2
},
"origQtyPrimary": 2.0,
"available": 3.0,
"onHold": true
}
],
"confirmAsnSentDate": "2016-12-25T23:00:00",
"deferNotification": true,
"receiptAdviceSent": true,
"canComplete": true,
"canCancel": true,
"canMarkForRa": true,
"canMarkSentRa": true,
"isReturn": true,
"receiverId": 14,
"customerIdentifier": {
"externalId": "str",
"name": "str",
"id": 3
},
"facilityIdentifier": {
"name": "str",
"id": 2
},
"status": 0,
"canConfirm": true,
"canUnconfirm": true
}
]
}
}
REL documentation