REL documentation
inventory resources, including receivers, adjustments, assemblies, purchase orders, count schedules, and available inventory lists
| Rel (/rels/inventory/ + ) | On Billboard | Description |
|---|---|---|
| adjustments | ||
| adjustment | yes | adjustment of item quantities in a facility and associated charges |
| adjustmentcharges | yes | Collection: of adjustment |
| adjustmentreverser | reverse the item quantity changes and charges from an adjustment | |
| adjustments | yes | Collection: of adjustment |
| proposedallocations | yes | a proposed allocations for an inventory reduction adjustment |
| assemblies | ||
| assemblies | yes | Collection: of assembly |
| assembliescancel | yes | GroupOperator: of assemblycancel |
| assembliesconfirm | yes | GroupOperator: of assemblyconfirm |
| assembly | yes | realization of a kit |
| assemblycancel | yes | Operator: cancel assembly |
| assemblyconfirm | yes | Operator: confirm an assembly, customer is done specifying assembly and assembly item info |
| assembly items | ||
| item | yes | order line item: sku and quantity info |
| items | yes | Collection: of item |
| audits | ||
| audit | a task to count inventory in a subset of locations within a facility | |
| auditadjust | adjust inventory counts based on an audit | |
| auditcount | a count for one location and sku of an audit, including actual and expected quantities | |
| auditcounts | Collection: of auditcount | |
| auditevent | create an audit event | |
| auditlocationcounts | collection of counts for one location of an audit | |
| audits | Collection: of audit | |
| auditstatechange | transition an audit's status to a different state | |
| auditswap | Swap quantity between inventory records to reflect a physical inventory count | |
| empty | mark location as empty and counted | |
| files | ||
| adjustmentfile | file attached to an adjustment | |
| adjustmentfiles | Collection: of adjustmentfile | |
| adjustmentfilesummaries | info about files attached to an adjustment | |
| assemblyfile | file attached to an assembly | |
| assemblyfiles | Collection: of assemblyfile | |
| assemblyfilesummaries | info about files attached to an assembly | |
| receiverfile | file attached to a receiver | |
| receiverfiles | Collection: of receiverfile | |
| receiverfilesummaries | info about files attached to a receiver | |
| import/export | ||
| assemblyfileimport | yes | Operator: see assemblyfileparse, assemblyimport |
| assemblyfileimportasync | yes | Async: assemblyfileimport |
| assemblyfileimportasyncstatus | Status: of assemblyfileimportasync | |
| assemblyfileparse | yes | Operator: parse assembly import file |
| assemblyimport | yes | GroupOperator: of assemblies; create a group of assemblies |
| assemblyimportasync | yes | Async: assemblyimport |
| assemblyimportasyncstatus | Status: of assemblyimportasync | |
| export | yes | GroupOperator: create an export file for a group of receivers |
| fileimport | yes | Operator: see fileparse, import |
| fileimportasync | yes | Async: fileimport |
| fileimportasyncstatus | Status: of fileimportasync | |
| fileparse | yes | Operator: parse receiver import file |
| import | yes | GroupOperator: of receivers; create a group of receivers |
| importasync | yes | Async: import |
| importasyncstatus | Status: of importasync | |
| multiexport | yes | create a group of export files for a receiver |
| movers and shakers | ||
| clusterdeleter | yes | Delete a cluster of moverequests |
| deselect | record a move request deselect | |
| locationclearer | yes | Delete all moverrequests for a destination |
| masscompleter | yes | Complete multiple moverequests |
| mover | yes | move of inventory to a different location |
| moverequest | a request to move inventory to a different location | |
| moverequests | yes | Collection: of moverequest |
| moverequestsforlocation | Collection: of moverequestsforlocation | |
| moverequestsgenerator | yes | Operator: To generate move requests for replenishment |
| moverequestsummaries | yes | Collection: of moverequestsummary |
| select | record a move request select | |
| shaker | yes | change trackbys and saved elements on inventory |
| stockmoved | yes | Operator: react to available inventory being moved |
| other actions | ||
| allocation | an allocation of inventory | |
| inventoryitem | yes | an inventory increase |
| inventoryreduction | yes | an inventory decrease |
| purchase orders | ||
| purchaseorder | expectation of receipt of items | |
| purchaseorderindex | yes | PO index in the list of POs |
| purchaseorders | yes | Collection: of purchaseorder |
| receiver items | ||
| pallet | specific instance of a received pallet, bag or other such unit | |
| pallets | yes | Collection: of pallet |
| receiveitems | yes | the collection of receive items independent of any receiver |
| receiveritem | receiver line item: sku and quantity info | |
| receiveritems | Collection: of receiveritem | |
| receiver lists | ||
| digestbriefs | yes | skinny receiver digests |
| receiverdigests | yes | receiver partial info |
| receiverdigestsasync | yes | Async: receiverdigests |
| receiverdigestsasyncdata | receiver partial info - obtained asynchronously | |
| receiverdigestsasyncstatus | Status: of receiverdigestsasync | |
| receiversummaries | yes | receiver short synopsis |
| receivers | ||
| asnconverter | Operator: convert asn to receiver so actual quantities can be entered | |
| finisher | Operator: see receiver finished | |
| itemprocessor | Operator: see receive item processed | |
| pauser | Operator: see receiver puased | |
| raasnarrival | Operator: see receiver started | |
| receiver | receipt of items into a facility | |
| receiverautocharges | Operator: add automatic charges (AutoCalcHandling and scripted charges) | |
| receivercancel | Operator: cancel receiver | |
| receivercomplete | Operator: complete receiver, customer is done specifying receiver and receive item info | |
| receiverconfirm | Operator: confirm receiver, placing its items into inventory | |
| receiverlocate | Operator: assign receiver items a location based on directed putaway setup | |
| receiverramark | Operator: mark receiver to send Receipt Advice | |
| receiverrasent | Operator: mark receiver Receipt Advice sent | |
| receiverunconfirm | Operator: unconfirm receiver, removing its items from inventory | |
| relocator | move all items on a movable unit to a new location before confirmation | |
| resumer | Operator: see receiver resumed | |
| savedelements | receiver saved elements | |
| starter | Operator: see receiver started | |
| receivers | yes | Collection: of receiver |
| receiversautocharges | yes | GroupOperator: add automatic charges (AutoCalcHandling and scripted charges) |
| receiverscancel | yes | GroupOperator: of receivercancel |
| receiversconfirm | yes | GroupOperator: of receiverconfirm |
| receiversconfirmasync | yes | Async: receiversconfirm |
| receiversconfirmasyncstatus | Status: of receiversconfirmasync | |
| receiversramark | yes | GroupOperator: of receiverramark |
| receiversrasent | yes | GroupOperator: of receiverrasent |
| receiversunconfirm | yes | GroupOperator: of receiverunconfirm |
| stock status | ||
| currentlocations | yes | current inventory locations |
| inventory | yes | inventory for management purposes |
| inventoryasync | yes | Async: inventory |
| inventoryasyncdata | inventory for management purposes - obtained asynchronously | |
| inventoryasyncstatus | Status: of inventoryasync | |
| inventorybriefs | yes | skinny inventory |
| inventoryexpiring | yes | inventory expiring |
| inventoryheldreallocate | yes | GroupOperator: hold/release inventory |
| inventoryhold | yes | GroupOperator: hold/release inventory |
| itemminimum | minimum reached item | |
| locationminimum | minimum reached location | |
| locations | locations plus contents, including empty locations | |
| stockdetails | yes | item trackbys, availability, by receive item |
| stocksummaries | yes | item availability |
| stocksummariesfororder | yes | item availability for order |
| transfers | ||
| c2ctransfers | yes | transfer of inventory to different customer |
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.