Get all deliveries

get

/fscmRestApi/resources/11.13.18.05/receivingReceiptDeliveries

Request

Query Parameters
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds the receiving receipt delivery according to the primary key.
      Finder Variables
      • ReceiptDeliveryId; integer; Receiving receipt lines that are available to correct.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AdhocDeliveryIndicator; string; Abbreviation that identifies if the current delivery is receipt-based or not. Valid values are Y and N. The default value is N.
    • AdhocLocationName; string; Destination for a delivery that's not based on a receipt.
    • AdhocReceiverName; string; Name of the person specified for a delivery that's not based on a receipt.
    • DeliverToLocation; string; Number that uniquely identifies the advance shipment notice.
    • DeliverToLocationId; integer; Value that uniquely identifies the expense deliver-to location.
    • DeliverToPersonId; integer; Value that uniquely identifies the deliver-to person or the requester.
    • DeliverToPersonName; string; Name of the deliver-to person or the requester.
    • DeliveredByPersonId; integer; Value that uniquely identifies the person who completed the current receiving receipt delivery.
    • DeliveredByPersonName; string; Name of the person who completed the current receiving receipt delivery.
    • DeliveryCartId; integer; Value that uniquely identifies the receiving delivery cart.
    • DeliveryCartName; string; Name that uniquely identifies the receiving delivery cart.
    • DeliveryNumber; string; Number that uniquely identifies the receiving receipt delivery.
    • DeliveryStatus; string; Value that represents the status of the receiving receipt delivery.
    • DeliveryStatusCode; string; Abbreviation that identifies the destination for the receiving receipt delivery. The value INVENTORY means that the delivery is for a par location. The value EXPENSE means that the delivery is intended for an expense location.
    • DestinationTypeCode; string; Abbreviation that identifies the destination for the receiving receipt delivery. The value INVENTORY means that the delivery is for a par location. The value EXPENSE means that the delivery is intended for an expense location.
    • DocumentNumber; string; Number that identifies the document for the current receiving receipt delivery. When the source document code is PO, this attribute is the purchase order number. When the source document code is TRANSFER ORDER, this attribute is the transfer order number.
    • LPNId; integer; Value that uniquely identifies the LPN.
    • LicensePlateNumber; string; Number that uniquely identifies the LPN.
    • Locator; string; Name of the destination locator for the current receiving receipt delivery.
    • LocatorId; integer; Value that uniquely identifies the destination locator for the current receiving receipt delivery.
    • NonEmployeeReceivedByName; string; Name of the nonemployee who received the delivery.
    • OrganizationCode; string; Abbreviation that uniquely identifies the receiving organization in which the delivery is created.
    • OrganizationId; integer; Value that uniquely identifies the inventory organization that the user has selected.
    • PARSubinventoryLocation; string; Name of the location corresponding to the par subinventory.
    • PARSubinventoryLocationId; integer; Unique identifier of the location associated with the destination periodic automatic replenishment (PAR) subinventory.
    • PODistributionId; integer; Value that uniquely identifies the purchase order distribution.
    • ParentTransactionId; integer; Value that uniquely identifies the parent receiving transaction that created the current receiving receipt delivery.
    • ReceiptDeliveryId; integer; Value that uniquely identifies the receiving receipt delivery.
    • ReceiptNumber; string; Number that identifies the receipt as part of which the current receiving receipt delivery is created.
    • ReceivedByName; string; Name of the person who received the receipt delivery.
    • ReceivedByPersonId; integer; Value that uniquely identifies the person that has received the current receiving receipt delivery.
    • ReceivedByPersonName; string; Name of the employee who received the delivery.
    • RequisitionNumber; string; Number that identifies the requisition that the application used to create the purchase order or the transfer order for the current receiving receipt delivery.
    • ShipmentHeaderId; integer; Value that uniquely identifies the receipt header as part of which the current receiving receipt delivery is created.
    • ShipmentLineId; integer; Value that uniquely identifies the receipt line as part of which the current receiving receipt delivery is created.
    • SourceDocumentCode; string; Abbreviation that identifies the source document type for the current receiving receipt delivery. Valid values include PO (purchase order) and TRANSFER ORDER.
    • Subinventory; string; Name of the destination subinventory for the current receiving receipt delivery.
    • SubinventoryName; string; Name of the destination subinventory for the current receiving receipt delivery.
    • TaskName; string; Name that uniquely identifies the task assigned to the delivery.
    • ToOrganizationId; integer; Value that uniquely identifies the receiving organization in which the delivery is created.
    • TransferOrderDistributionId; integer; Value that uniquely identifies the transfer order distribution.
    • ZoneTaskId; integer; Value that uniquely identifies the task assigned to the delivery.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : receivingReceiptDeliveries
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : receivingReceiptDeliveries-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : receivingReceiptDeliveries-Attachments-item-response
Type: object
Show Source
Back to Top