Get all types
/fscmRestApi/resources/11.13.18.05/inventoryTransactionTypes
Request
-
expand: string
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).
-
fields: string
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 -
finder: string
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: Find inventory transaction types according to the primary key.
Finder Variables:- TransactionTypeId; integer; Value that uniquely identifies the transaction type.
- findByNameOrDescription: Find inventory transaction types that are active according to transaction type name or description.
Finder Variables:- bindTransactionTypeDescription; string; Description of the transaction type.
- bindTransactionTypeName; string; Name of the transaction type.
- PrimaryKey: Find inventory transaction types according to the primary key.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- TransactionAction; string; Name of the transaction action.
- TransactionActionId; string; Value that uniquely identifies the transaction action.
- TransactionSourceTypeDefinedBy; string; Indicates whether the user defined the transaction source type or the system defined the transaction source type.
- TransactionSourceTypeDefinedByCode; string; Contains one of the following values. Y: the user defined the transaction source type. N: the system defined the transaction source type. This attribute does not contain a default value.
- TransactionSourceTypeDescription; string; Description of the transaction source type.
- TransactionSourceTypeEndDate; string; Date when this transaction source type becomes inactive.
- TransactionSourceTypeId; integer; Value that uniquely identifies the transaction source type.
- TransactionSourceTypeName; string; Name of the transaction source type.
- TransactionSourceTypeStartDate; string; Date when this transaction source type becomes active.
- TransactionTypeDefinedBy; string; Indicates whether the user defined the transaction type or the system defined the transaction type.
- TransactionTypeDefinedByCode; string; Contains one of the following values. Y: the user defined the transaction type. N: the system defined the transaction type. This attribute does not contain a default value.
- TransactionTypeDescription; string; Description of the transaction type.
- TransactionTypeEndDate; string; Date when this transaction type becomes inactive.
- TransactionTypeId; integer; Value that uniquely identifies the transaction type.
- TransactionTypeName; string; Name of the transaction type.
- TransactionTypeStartDate; string; Date when this transaction type becomes active.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
-
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
- application/json
Default Response
-
Metadata-Context(required):
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".
-
REST-Framework-Version(required):
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.
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
array
Links
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionAction: string
Read Only:
true
Maximum Length:80
Name of the transaction action. -
TransactionActionId: string
Read Only:
true
Maximum Length:30
Value that uniquely identifies the transaction action. -
TransactionSourceTypeDefinedBy: string
Read Only:
true
Maximum Length:80
Indicates whether the user defined the transaction source type or the system defined the transaction source type. -
TransactionSourceTypeDefinedByCode: string
Read Only:
true
Maximum Length:1
Contains one of the following values. Y: the user defined the transaction source type. N: the system defined the transaction source type. This attribute does not contain a default value. -
TransactionSourceTypeDescription: string
Read Only:
true
Maximum Length:240
Description of the transaction source type. -
TransactionSourceTypeEndDate: string
(date)
Read Only:
true
Date when this transaction source type becomes inactive. -
TransactionSourceTypeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transaction source type. -
TransactionSourceTypeName: string
Read Only:
true
Maximum Length:80
Name of the transaction source type. -
TransactionSourceTypeStartDate: string
(date)
Read Only:
true
Date when this transaction source type becomes active. -
TransactionTypeDefinedBy: string
Read Only:
true
Maximum Length:80
Indicates whether the user defined the transaction type or the system defined the transaction type. -
TransactionTypeDefinedByCode: string
Read Only:
true
Maximum Length:1
Contains one of the following values. Y: the user defined the transaction type. N: the system defined the transaction type. This attribute does not contain a default value. -
TransactionTypeDescription: string
Read Only:
true
Maximum Length:240
Description of the transaction type. -
TransactionTypeEndDate: string
(date)
Read Only:
true
Date when this transaction type becomes inactive. -
TransactionTypeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transaction type. -
TransactionTypeName: string
Read Only:
true
Maximum Length:80
Name of the transaction type. -
TransactionTypeStartDate: string
(date)
Read Only:
true
Date when this transaction type becomes active.
array
Links
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This topic includes examples that describe how to get all transaction types from inventory.
Get All
The following query gets all inventory transaction types that the database contains.
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransactionTypes?onlyData=true
This query returns the following response.
{ "items" : [ { "TransactionTypeId" : 20002, "TransactionTypeName" : "Shipment Request Ship Confirm", "TransactionTypeDescription" : null, "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2001-05-30", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 28, "TransactionSourceTypeName" : "Shipment Request", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 20007, "TransactionTypeName" : "Receipt Advice Correction", "TransactionTypeDescription" : null, "TransactionActionId" : "29", "TransactionAction" : "Delivery adjustments", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2001-05-30", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 29, "TransactionSourceTypeName" : "Receipt Advice", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 20006, "TransactionTypeName" : "Receipt Advice Return", "TransactionTypeDescription" : null, "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2001-05-30", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 29, "TransactionSourceTypeName" : "Receipt Advice", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null } ], "count" : 3, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/logisticsApi/resources/version/inventoryTransactionTypes", "name" : "inventoryTransactionTypes", "kind" : "collection" } ] }
Get All According to String
The following query gets all inventory transaction types that start with the string Shipment in the TransactionTypeName.
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransctionTypes?onlyData=true&=TransactionTypeName LIKE Shipment%
This query returns the following response.
{ "items" : [ { "TransactionTypeId" : 20001, "TransactionTypeName" : "Shipment Request Staging Transfer", "TransactionTypeDescription" : null, "TransactionActionId" : "28", "TransactionAction" : "Staging transfer", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2001-05-30", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 28, "TransactionSourceTypeName" : "Shipment Request", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 20002, "TransactionTypeName" : "Shipment Request Ship Confirm", "TransactionTypeDescription" : null, "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2001-05-30", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 28, "TransactionSourceTypeName" : "Shipment Request", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 70, "TransactionTypeName" : "Shipment Receipt Adjustment", "TransactionTypeDescription" : "Adjustment to receipt of intransit delivery", "TransactionActionId" : "29", "TransactionAction" : "Delivery adjustments", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "1995-09-08", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 13, "TransactionSourceTypeName" : "Inventory", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null } ], "count" : 3, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/logisticsApi/resources/version/inventoryTransactionTypes", "name" : "inventoryTransactionTypes", "kind" : "collection" } ] }
Get All According to String in Description
The following query gets all inventory transaction types that include the text Issue in TransactionTypeDescription.
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransactionTypes?onlyData=true&=TransactionTypeDescription LIKE Issue%
This query returns the following response.
{ "items" : [ { "TransactionTypeId" : 267, "TransactionTypeName" : "Issue from Inventory", "TransactionTypeDescription" : "Issue from Inventory (Account Alias)", "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "Y", "TransactionTypeDefinedBy" : "User", "TransactionTypeStartDate" : "2003-11-04", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 6, "TransactionSourceTypeName" : "Account Alias", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 1, "TransactionTypeName" : "Account Issue", "TransactionTypeDescription" : "Issue material against an account", "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "1995-09-08", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 3, "TransactionSourceTypeName" : "Account", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 31, "TransactionTypeName" : "Account Alias Issue", "TransactionTypeDescription" : "Issue material against an account alias", "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "1995-09-08", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 6, "TransactionSourceTypeName" : "Account Alias", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null } ], "count" : 3, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/logisticsApi/resources/version/inventoryTransactionTypes", "name" : "inventoryTransactionTypes", "kind" : "collection" } ] }
Get All According to Transaction Action
The following query gets all inventory transaction types where TransactionAction is Issue from stores.
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransactionTypes?onlyData=true&=TransactionAction=Issue from stores
This query returns the following response.
{ "items" : [ { "TransactionTypeId" : 207, "TransactionTypeName" : "Omnicell Transfer", "TransactionTypeDescription" : "Omnicell Transfer", "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "Y", "TransactionTypeDefinedBy" : "User", "TransactionTypeStartDate" : "2002-04-23", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 4, "TransactionSourceTypeName" : "Movement Request", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1999-12-18", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 100000012016116, "TransactionTypeName" : "ZINV_TXNTYPE0001", "TransactionTypeDescription" : "Logistics_Inv_Specific Txn Type0001", "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "Y", "TransactionTypeDefinedBy" : "User", "TransactionTypeStartDate" : "2010-08-24", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 100000012016105, "TransactionSourceTypeName" : "ZINV_TXNSRC0001", "TransactionSourceTypeDescription" : "Logistics_Inv_Specific Txn Source", "TransactionSourceTypeDefinedByCode" : "Y", "TransactionSourceTypeDefinedBy" : "User", "TransactionSourceTypeStartDate" : "2009-08-24", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 100000012016117, "TransactionTypeName" : "ZINVTXNTYPE0001", "TransactionTypeDescription" : "Logistics_Inv_Specific Txn Type", "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "Y", "TransactionTypeDefinedBy" : "User", "TransactionTypeStartDate" : "2009-08-24", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 100000012016105, "TransactionSourceTypeName" : "ZINV_TXNSRC0001", "TransactionSourceTypeDescription" : "Logistics_Inv_Specific Txn Source", "TransactionSourceTypeDefinedByCode" : "Y", "TransactionSourceTypeDefinedBy" : "User", "TransactionSourceTypeStartDate" : "2009-08-24", "TransactionSourceTypeEndDate" : null }, { } ], "count" : 3, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/logisticsApi/resources/version/inventoryTransactionTypes", "name" : "inventoryTransactionTypes", "kind" : "collection" } ] }
Get All When You Know the Transaction Action ID
The following query gets all inventory transaction types where the TransactionActionId is 1. Note that you set up each transaction action as part of FND_LOOKUPS, where LOOKUP_TYPE is INV_TRANSACTION_ACTION.
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransactionTypes?onlyData=true&=TransactionActionId=1
This query returns the following response.
{ "items" : [ { "TransactionTypeId" : 207, "TransactionTypeName" : "Omnicell Transfer", "TransactionTypeDescription" : "Omnicell Transfer", "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "Y", "TransactionTypeDefinedBy" : "User", "TransactionTypeStartDate" : "2002-04-23", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 4, "TransactionSourceTypeName" : "Movement Request", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1999-12-18", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 100000012016116, "TransactionTypeName" : "ZINV_TXNTYPE0001", "TransactionTypeDescription" : "Logistics_Inv_Specific Txn Type0001", "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "Y", "TransactionTypeDefinedBy" : "User", "TransactionTypeStartDate" : "2010-08-24", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 100000012016105, "TransactionSourceTypeName" : "ZINV_TXNSRC0001", "TransactionSourceTypeDescription" : "Logistics_Inv_Specific Txn Source", "TransactionSourceTypeDefinedByCode" : "Y", "TransactionSourceTypeDefinedBy" : "User", "TransactionSourceTypeStartDate" : "2009-08-24", "TransactionSourceTypeEndDate" : null }, { } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/logisticsApi/resources/version/inventoryTransactionTypes", "name" : "inventoryTransactionTypes", "kind" : "collection" } ] }
Get All Transaction Types That the System Defines
The following query gets all inventory transaction types that the system defines.
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransactionTypes?onlyData=true&=TransactionTypeDefinedBy=System
You could also use the following query to get the same data.
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransactionTypes?onlyData=true&=TransactionTypeDefinedByCode=N
Each of these queries return the following response.
{ "items" : [ { "TransactionTypeId" : 1001, "TransactionTypeName" : "Deduct Sample Qty", "TransactionTypeDescription" : "Deduct Sample Qty", "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2006-02-23", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 13, "TransactionSourceTypeName" : "Inventory", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 1004, "TransactionTypeName" : "Lot Conversion Increase", "TransactionTypeDescription" : null, "TransactionActionId" : "27", "TransactionAction" : "Receipt into stores", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2004-06-22", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 13, "TransactionSourceTypeName" : "Inventory", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 10008, "TransactionTypeName" : "COGS Recognition", "TransactionTypeDescription" : null, "TransactionActionId" : "36", "TransactionAction" : "Cogs recognition", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2005-06-01", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 2, "TransactionSourceTypeName" : "Sales Order", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 79, "TransactionTypeName" : "Lot Grade Change", "TransactionTypeDescription" : "Change the lot grade of a lot of material", "TransactionActionId" : "58", "TransactionAction" : "Lot grade change", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2001-05-30", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 13, "TransactionSourceTypeName" : "Inventory", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null }, { } ], "count" : 4, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/logisticsApi/resources/version/inventoryTransactionTypes", "name" : "inventoryTransactionTypes", "kind" : "collection" } ] }
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransctionTypes?onlyData=true&=TransactionSourceTypeDefinedBy=User
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransactionTypes?onlyData=true&=TransactionSourceTypeDefinedByCode=Y
Get All Transaction Types According to Date
The following query gets all inventory transaction types where TransactionTypeStartDate occurs after 2011-10-24.
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransctionTypes?onlyData=true&=TransactionTypeStartDate>=2011-10-24
This query returns the following response.
{ "items" : [ { "TransactionTypeId" : 61, "TransactionTypeName" : "Transfer Order Interorganization Receipt", "TransactionTypeDescription" : null, "TransactionActionId" : "12", "TransactionAction" : "In-transit receipt", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2011-11-24", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 8, "TransactionSourceTypeName" : "Transfer Order", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "2011-11-24", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 29, "TransactionTypeName" : "Transfer Order Intraorganization Receipt", "TransactionTypeDescription" : null, "TransactionActionId" : "16", "TransactionAction" : "Intraorganization in-transit receipt", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2011-11-24", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 8, "TransactionSourceTypeName" : "Transfer Order", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "2011-11-24", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 34, "TransactionTypeName" : "Transfer Order Issue", "TransactionTypeDescription" : null, "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2011-11-24", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 8, "TransactionSourceTypeName" : "Transfer Order", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "2011-11-24", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 50, "TransactionTypeName" : "Transfer Order Intraorganization Transfer", "TransactionTypeDescription" : null, "TransactionActionId" : "2", "TransactionAction" : "Subinventory transfer", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2011-11-24", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 8, "TransactionSourceTypeName" : "Transfer Order", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "2011-11-24", "TransactionSourceTypeEndDate" : null } ], "count" : 4, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/logisticsApi/resources/version/inventoryTransactionTypes", "name" : "inventoryTransactionTypes", "kind" : "collection" } ] }
Get All Transaction Types That Contain an End Date
The following query gets all inventory transaction types where TransactionTypeEndDate is not null.
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransactionTypes?onlyData=true&=TransactionTypeEndDate is not null
This query returns the following response.
{ "items" : [ { "TransactionTypeId" : 100000012016118, "TransactionTypeName" : "ZINV_TXNTYPE0002", "TransactionTypeDescription" : "Logistics_Inv_Specific Txn Type0002", "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "Y", "TransactionTypeDefinedBy" : "User", "TransactionTypeStartDate" : null, "TransactionTypeEndDate" : "2030-08-24", "TransactionSourceTypeId" : 100000012016108, "TransactionSourceTypeName" : "ZINV_TXNSRC0002", "TransactionSourceTypeDescription" : "Logistics_Inv_Specific Txn Source0002", "TransactionSourceTypeDefinedByCode" : "Y", "TransactionSourceTypeDefinedBy" : "User", "TransactionSourceTypeStartDate" : null, "TransactionSourceTypeEndDate" : "2030-08-24" }, { "TransactionTypeId" : 100000012016119, "TransactionTypeName" : "ZINV_TXNTYPEDEL0002", "TransactionTypeDescription" : "Logistics_Inv_Specific Txn Type for Delete flow", "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "Y", "TransactionTypeDefinedBy" : "User", "TransactionTypeStartDate" : null, "TransactionTypeEndDate" : "2030-08-24", "TransactionSourceTypeId" : 100000012016109, "TransactionSourceTypeName" : "ZINV_TXNSRCDEL0003", "TransactionSourceTypeDescription" : "Logistics_Inv_Specific Txn Source for delete flow", "TransactionSourceTypeDefinedByCode" : "Y", "TransactionSourceTypeDefinedBy" : "User", "TransactionSourceTypeStartDate" : null, "TransactionSourceTypeEndDate" : null } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/logisticsApi/resources/version/inventoryTransactionTypes", "name" : "inventoryTransactionTypes", "kind" : "collection" } ] }
Get All Transaction Types According to Source Type
The following query gets all shipment requests.
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransactionTypes?onlyData=true&=TransactionSourceTypeName=Shipment Request
This query returns the following response.
{ "items" : [ { "TransactionTypeId" : 20001, "TransactionTypeName" : "Shipment Request Staging Transfer", "TransactionTypeDescription" : null, "TransactionActionId" : "28", "TransactionAction" : "Staging transfer", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2001-05-30", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 28, "TransactionSourceTypeName" : "Shipment Request", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 20002, "TransactionTypeName" : "Shipment Request Ship Confirm", "TransactionTypeDescription" : null, "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2001-05-30", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 28, "TransactionSourceTypeName" : "Shipment Request", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/logisticsApi/resources/version/inventoryTransactionTypes", "name" : "inventoryTransactionTypes", "kind" : "collection" } ] }
Get All Transaction Types When You Know the Source Type ID
The following query gets all inventory transaction types where TransactionSourceTypeId is 28.
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransctionTypes?onlyData=true&=TransactionSourceTypeId=28
This query returns the following response.
{ "items" : [ { "TransactionTypeId" : 20002, "TransactionTypeName" : "Shipment Request Ship Confirm", "TransactionTypeDescription" : null, "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2001-05-30", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 28, "TransactionSourceTypeName" : "Shipment Request", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 20001, "TransactionTypeName" : "Shipment Request Staging Transfer", "TransactionTypeDescription" : null, "TransactionActionId" : "28", "TransactionAction" : "Staging transfer", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2001-05-30", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 28, "TransactionSourceTypeName" : "Shipment Request", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/logisticsApi/resources/version/inventoryTransactionTypes", "name" : "inventoryTransactionTypes", "kind" : "collection" } ] }
More Examples
The following cURL commands include more examples you can use with this resource.
cURL Command | Description |
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransctionTypes?onlyData=true&=TransactionTypeName LIKE Issue% OR LIKE %from% |
Get all inventory transaction types that include the text Issue or from in the TransactionTypeName. |
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransactionTypes?onlyData=true&=TransactionSourceTypeDescription LIKE Logistics_Inv_Specific% |
Get all inventory transaction types where TransactionSourceTypeDescription starts with the text Logistics_Inv_Specific. For example, this query will return a record where TransactionSourceTypeDescription contains Logistics_Inv_Specific Txn Type for Delete flow. |
Using Row Finders
Bind Variable | Usage` | Data Type | Condition |
bindTransactionTypeName | Selectively Required | String | Starts With |
bindTransactionTypeDescription | Selectively Required | String | Starts With |
- You must pass a search string to at least one of the variables.
- The search string is not case sensitive. For example, if the search string is ABC, then ABC, abc, Abc, aBC, aBc, and so on will match.
Using Row Finders with a String
The following query gets all inventory transaction types that start with the text Shipment in the inventory transaction name.
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransactionTypes?onlyData=true&finder=findByNameOrDescription;bindTransactionTypeName=SHIPMENT"
This query returns the following response.
}, { "TransactionTypeId" : 20002, "TransactionTypeName" : "Shipment Request Ship Confirm", "TransactionTypeDescription" : null, "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "2001-05-30", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 28, "TransactionSourceTypeName" : "Shipment Request", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 70, "TransactionTypeName" : "Shipment Receipt Adjustment", "TransactionTypeDescription" : "Adjustment to receipt of intransit delivery", "TransactionActionId" : "29", "TransactionAction" : "Delivery adjustments", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "1995-09-08", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 13, "TransactionSourceTypeName" : "Inventory", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null } ], "count" : 3, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/inventoryTransactionTypes", "name" : "inventoryTransactionTypes", "kind" : "collection" } ] }
Using Row Finders with More Than One String
The following query gets all inventory transaction types where TransactionTypeName contains the text Account or TransactionTypeDescription contains the text Receive.
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransctionTypes?onlyData=true&=findByNameOrDescription;bindTransactionTypeName=Account,bindTransactionTypeDescription=Receive
This query returns the following response.
{ "items" : [ { "TransactionTypeId" : 1, "TransactionTypeName" : "Account Issue", "TransactionTypeDescription" : "Issue material against an account", "TransactionActionId" : "1", "TransactionAction" : "Issue from stores", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "1995-09-08", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 3, "TransactionSourceTypeName" : "Account", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 15, "TransactionTypeName" : "RMA Receipt", "TransactionTypeDescription" : "Receive material based on a return material authorization", "TransactionActionId" : "27", "TransactionAction" : "Receipt into stores", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "1995-09-08", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 12, "TransactionSourceTypeName" : "RMA", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/logisticsApi/resources/version/inventoryTransactionTypes", "name" : "inventoryTransactionTypes", "kind" : "collection" } ] }
Using Row Finders to Get All Receive Transactions
The following query gets all inventory transaction types where TransactionTypeDescription is Receive.
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryTransctionTypes?onlyData=true&=findByNameOrDescription;bindTransactionTypeDescription=Receive
This query returns the following response.
{ "items" : [ { "TransactionTypeId" : 15, "TransactionTypeName" : "RMA Receipt", "TransactionTypeDescription" : "Receive material based on a return material authorization", "TransactionActionId" : "27", "TransactionAction" : "Receipt into stores", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "1995-09-08", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 12, "TransactionSourceTypeName" : "RMA", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null }, { "TransactionTypeId" : 18, "TransactionTypeName" : "Purchase Order Receipt", "TransactionTypeDescription" : "Receive material against a purchase order", "TransactionActionId" : "27", "TransactionAction" : "Receipt into stores", "TransactionTypeDefinedByCode" : "N", "TransactionTypeDefinedBy" : "System", "TransactionTypeStartDate" : "1995-09-08", "TransactionTypeEndDate" : null, "TransactionSourceTypeId" : 1, "TransactionSourceTypeName" : "Purchase Order", "TransactionSourceTypeDescription" : null, "TransactionSourceTypeDefinedByCode" : "N", "TransactionSourceTypeDefinedBy" : "System", "TransactionSourceTypeStartDate" : "1995-09-08", "TransactionSourceTypeEndDate" : null } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/logisticsApi/resources/version/inventoryTransactionTypes", "name" : "inventoryTransactionTypes", "kind" : "collection" } ] }