Jump to

• Request
• Response
• Examples

Get all subinventories

get

/fscmRestApi/resources/11.13.18.05/activeSubinventories

Request

Query Parameters

• 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: Finds active subinventories acceding to organization and subinventory name.
    Finder Variables:
    • OrganizationId; integer; Value that uniquely identifies the organization.
    • SecondaryInventoryName; string; Name of the subinventory.
  • findHistoricalTransactions: Finds historic transactions.
    Finder Variables:
    • bindOrgId; integer; Value that uniquely identifies the organization.
    • bindSubinventory; string; Name of the subinventory.
  • findInterfacedShippingTransactions: Finds shipping transactions that are yet to be processed.
    Finder Variables:
    • bindOrgId; integer; Value that uniquely identifies the organization.
    • bindSubinventory; string; Name of the subinventory.
  • findItemSubinventories: Finds active subinventories for which the item is assigned to the subinventory.
    Finder Variables:
    • bindItemId; integer; Value that uniquely identifies the item.
  • findOnhand: Finds on-hand inventory.
    Finder Variables:
    • bindOrgId; integer; Value that uniquely identifies the organization.
    • bindSubinventory; string; Name of the subinventory.
  • findPendingTransactions: Finds pending inventory transactions.
    Finder Variables:
    • bindOrgId; integer; Value that uniquely identifies the organization.
    • bindSubinventory; string; Name of the subinventory.
    • bindTransactionActionId; string; Value that uniquely identifies the transaction action.
    • bindTransactionSourceTypeId; integer; Value that uniquely identifies the transaction source type.
    • bindTransactionTypeId; integer; Value that uniquely identifies the transaction type.
  • findPickOrShipConfirmedTransactions: Finds shipping transactions that are in Staged or Released to Warehouse statuses.
    Finder Variables:
    • bindOrgId; integer; Value that uniquely identifies the organization.
    • bindSubinventory; string; Name of the subinventory.
  • findRestrictedSubinventories: Finds subinventories that the warehouse can use to fulfill the item and meet the requirements of the transaction type.
    Finder Variables:
    • bindItemId; integer; Value that uniquely identifies the item.
    • bindTransactionTypeId; integer; Value that uniquely identifies the transaction type.
  • findStagedTransactions: Finds staged inventory transactions.
    Finder Variables:
    • bindOrgId; integer; Value that uniquely identifies the organization.
    • bindSubinventory; string; Name of the subinventory.
    • bindTransactionSourceTypeId; integer; Value that uniquely identifies the transaction source type.
• 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:
  

  • AllowReservations; string; Value that determines whether or not the warehouse can reserve the inventory in the subinventory. Contains one of the following values: Yes or No. If Yes, then the warehouse can reserve the inventory in the subinventory. If No, then the warehouse cannot reserve the inventory in the subinventory. There is no default value for this attribute.
  • AssetInventory; string; Value that determines whether or not to consider the inventory in the subinventory as assets. Contains one of the following values: Yes or No. If Yes, then consider the inventory in the subinventory as assets. If No, then do not consider the inventory in the subinventory as assets.
  • AssetInventoryCode; integer; Abbreviation that determines whether or not to consider the inventory in the subinventory as assets. Contains one of the following values: 1 or 2. If 1, then consider the inventory in the subinventory as assets. If 2, then do not consider the inventory in the subinventory as assets. The default value is 1.
  • Depreciable; string; Value that determines whether or not the inventory in the subinventory is depreciable. Contains one of the following values: Yes or No. If Yes, then the inventory in the subinventory is depreciable. If No, then the inventory in the subinventory is not depreciable.
  • DepreciableCode; integer; Abbreviation that determines whether or not the inventory in the subinventory is depreciable. Contains one of the following values: 1 or 2. If 1, then the inventory in the subinventory is depreciable. If 2, then the inventory in the subinventory is not depreciable. The default value is 2.
  • Description; string; Description of the subinventory.
  • DisableDate; string; Date when the subinventory is disabled.
  • IncludeInATP; string; Value that determines whether or not to include the inventory when calculating the inventory that is available to promise. Contains one of the following values: Yes or No. If Yes, then include inventory in the available to promise calculation. If No, then do not include inventory in the available to promise calculation. There is no default value for this attribute.
  • InventoryATPCode; integer; Abbreviation that determines whether or not to include the inventory when calculating the inventory that is available to promise. Contains one of the following values: 1 or 2. If 1, then include inventory in the available to promise calculation. If 2, then do not include inventory in the available to promise calculation. There is no default value for this attribute.
  • LocationId; integer; Value that uniquely identifies the location.
  • LocationName; string; Name of the location.
  • LocatorType; string; Type of stock locator control that the subinventory uses. A list of accepted values is defined in the lookup type INV_SUB_LOCATOR_CONTROL.
  • LocatorTypeCode; string; Abbreviation that identifies the type of stock locator control that the subinventory uses. A list of accepted values is defined in the lookup type INV_SUB_LOCATOR_CONTROL. The default value is 1.
  • Nettable; string; Value that determines whether or not the inventory is nettable. Contains one of the following values: Yes or No. If Yes, then inventory is nettable. If No, then inventory is not nettable. There is no default value for this attribute.
  • NettableCode; integer; Abbreviation that determines whether or not the inventory is nettable. Contains one of the following values: 1 or 2. If 1, then inventory is nettable. If 2, then inventory is not nettable. There is no default value for this attribute.
  • OrganizationCode; string; Abbreviation that identifies the organization.
  • OrganizationId; integer; Value that uniquely identifies the organization.
  • OrganizationName; string; Name of the organization.
  • PickingOrder; integer; Sequence to use when picking the item from this subinventory.
  • PostprocessingLeadTime; integer; Postprocessing lead time to use when sourcing the item.
  • PreprocessingLeadTime; integer; Preprocessing lead time to use when sourcing the item.
  • ProcessingLeadTime; integer; Processing lead time to use when sourcing the item.
  • QuantityTracked; string; Value that determines whether or not to track the on-hand quantity for the item in the subinventory. Contains one of the following values: Yes or No. If Yes, then track the on-hand quantity for the item in the subinventory. If No, then do not track the on-hand quantity for the item in the subinventory.
  • QuantityTrackedCode; integer; Abbreviation that determines whether or not the warehouse tracks the on-hand quantity for the item in the subinventory. Contains one of the following values: 1 or 2. If 1, then the warehouse tracks the on-hand quantity for the item in the subinventory. If 2, then the warehouse does not track the on-hand quantity for the item in the subinventory. The default value is 1.
  • ReservableType; integer; Abbreviation that determines whether or not the warehouse can reserve the inventory in the subinventory. Contains one of the following values: 1 or 2. If 1, then the warehouse can reserve the inventory in the subinventory. If 2, then the warehouse cannot reserve the inventory in the subinventory. There is no default value for this attribute.
  • SecondaryInventoryName; string; Name of the subinventory.
  • SourceOrganizationCode; string; Abbreviation that identifies the organization to use when sourcing the item.
  • SourceOrganizationId; integer; Value that uniquely identifies the organization to use when sourcing the item.
  • SourceOrganizationName; string; Name of the organization to use when sourcing the item.
  • SourceSubinventory; string; Subinventory to use when sourcing the item.
  • SourceType; string; Sourcing type to use when replenishing the item in the subinventory. A list of accepted values is defined in the lookup type INV_SOURCE_TYPES.
  • SourceTypeCode; string; Abbreviation that identifies the sourcing type to use for replenishment in the subinventory. A list of accepted values is defined in the lookup type INV_SOURCE_TYPES. The default value is 2.
  • StatusCode; string; Name of the status.
  • StatusId; integer; Value that uniquely identifies the status.
  • SubinventoryId; integer; Value that uniquely identifies the subinventory.
  • SubinventoryType; string; Value that identifies the type of subinventory. A list of accepted values is defined in the lookup type INV_SUB_TYPE.
  • SubinventoryTypeCode; string; Abbreviation that identifies the type of subinventory. A list of accepted values is defined in the lookup type INV_SUB_TYPE. There is no default value for this attribute.
• 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".

Header Parameters

• 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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : activeSubinventories

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/activeSubinventories-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"LOV",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object activeSubinventories-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/activeSubinventories-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : activeSubinventories-item-response

Type: object

Show Source

• AllowReservations: string
  Read Only: true

  Maximum Length: 80

  Value that determines whether or not the warehouse can reserve the inventory in the subinventory. Contains one of the following values: Yes or No. If Yes, then the warehouse can reserve the inventory in the subinventory. If No, then the warehouse cannot reserve the inventory in the subinventory. There is no default value for this attribute.
• AssetInventory: string
  Read Only: true

  Maximum Length: 80

  Value that determines whether or not to consider the inventory in the subinventory as assets. Contains one of the following values: Yes or No. If Yes, then consider the inventory in the subinventory as assets. If No, then do not consider the inventory in the subinventory as assets.
• AssetInventoryCode: integer (int32)
  Read Only: true

  Abbreviation that determines whether or not to consider the inventory in the subinventory as assets. Contains one of the following values: 1 or 2. If 1, then consider the inventory in the subinventory as assets. If 2, then do not consider the inventory in the subinventory as assets. The default value is 1.
• Depreciable: string
  Read Only: true

  Maximum Length: 80

  Value that determines whether or not the inventory in the subinventory is depreciable. Contains one of the following values: Yes or No. If Yes, then the inventory in the subinventory is depreciable. If No, then the inventory in the subinventory is not depreciable.
• DepreciableCode: integer (int32)
  Read Only: true

  Abbreviation that determines whether or not the inventory in the subinventory is depreciable. Contains one of the following values: 1 or 2. If 1, then the inventory in the subinventory is depreciable. If 2, then the inventory in the subinventory is not depreciable. The default value is 2.
• Description: string
  Read Only: true

  Maximum Length: 50

  Description of the subinventory.
• DisableDate: string (date)
  Read Only: true

  Date when the subinventory is disabled.
• IncludeInATP: string
  Read Only: true

  Maximum Length: 80

  Value that determines whether or not to include the inventory when calculating the inventory that is available to promise. Contains one of the following values: Yes or No. If Yes, then include inventory in the available to promise calculation. If No, then do not include inventory in the available to promise calculation. There is no default value for this attribute.
• InventoryATPCode: integer (int32)
  Read Only: true

  Abbreviation that determines whether or not to include the inventory when calculating the inventory that is available to promise. Contains one of the following values: 1 or 2. If 1, then include inventory in the available to promise calculation. If 2, then do not include inventory in the available to promise calculation. There is no default value for this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the location.
• LocationName: string
  Read Only: true

  Maximum Length: 240

  Name of the location.
• LocatorType: string
  Read Only: true

  Maximum Length: 80

  Type of stock locator control that the subinventory uses. A list of accepted values is defined in the lookup type INV_SUB_LOCATOR_CONTROL.
• LocatorTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of stock locator control that the subinventory uses. A list of accepted values is defined in the lookup type INV_SUB_LOCATOR_CONTROL. The default value is 1.
• Nettable: string
  Read Only: true

  Maximum Length: 80

  Value that determines whether or not the inventory is nettable. Contains one of the following values: Yes or No. If Yes, then inventory is nettable. If No, then inventory is not nettable. There is no default value for this attribute.
• NettableCode: integer (int32)
  Read Only: true

  Abbreviation that determines whether or not the inventory is nettable. Contains one of the following values: 1 or 2. If 1, then inventory is nettable. If 2, then inventory is not nettable. There is no default value for this attribute.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the organization.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization.
• OrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the organization.
• PickingOrder: integer
  Read Only: true

  Sequence to use when picking the item from this subinventory.
• PostprocessingLeadTime: integer
  Read Only: true

  Postprocessing lead time to use when sourcing the item.
• PreprocessingLeadTime: integer
  Read Only: true

  Preprocessing lead time to use when sourcing the item.
• ProcessingLeadTime: integer
  Read Only: true

  Processing lead time to use when sourcing the item.
• QuantityTracked: string
  Read Only: true

  Maximum Length: 80

  Value that determines whether or not to track the on-hand quantity for the item in the subinventory. Contains one of the following values: Yes or No. If Yes, then track the on-hand quantity for the item in the subinventory. If No, then do not track the on-hand quantity for the item in the subinventory.
• QuantityTrackedCode: integer (int32)
  Read Only: true

  Abbreviation that determines whether or not the warehouse tracks the on-hand quantity for the item in the subinventory. Contains one of the following values: 1 or 2. If 1, then the warehouse tracks the on-hand quantity for the item in the subinventory. If 2, then the warehouse does not track the on-hand quantity for the item in the subinventory. The default value is 1.
• ReservableType: integer (int32)
  Read Only: true

  Abbreviation that determines whether or not the warehouse can reserve the inventory in the subinventory. Contains one of the following values: 1 or 2. If 1, then the warehouse can reserve the inventory in the subinventory. If 2, then the warehouse cannot reserve the inventory in the subinventory. There is no default value for this attribute.
• SecondaryInventoryName: string
  Read Only: true

  Maximum Length: 10

  Name of the subinventory.
• SourceOrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the organization to use when sourcing the item.
• SourceOrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization to use when sourcing the item.
• SourceOrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the organization to use when sourcing the item.
• SourceSubinventory: string
  Read Only: true

  Maximum Length: 10

  Subinventory to use when sourcing the item.
• SourceType: string
  Read Only: true

  Maximum Length: 80

  Sourcing type to use when replenishing the item in the subinventory. A list of accepted values is defined in the lookup type INV_SOURCE_TYPES.
• SourceTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the sourcing type to use for replenishment in the subinventory. A list of accepted values is defined in the lookup type INV_SOURCE_TYPES. The default value is 2.
• StatusCode: string
  Read Only: true

  Maximum Length: 80

  Name of the status.
• StatusId: integer (int64)
  Read Only: true

  Value that uniquely identifies the status.
• SubinventoryId: integer (int64)
  Read Only: true

  Value that uniquely identifies the subinventory.
• SubinventoryType: string
  Read Only: true

  Maximum Length: 80

  Value that identifies the type of subinventory. A list of accepted values is defined in the lookup type INV_SUB_TYPE.
• SubinventoryTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of subinventory. A list of accepted values is defined in the lookup type INV_SUB_TYPE. There is no default value for this attribute.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Nettable":{
            "maxLength":80,
            "type":"string",
            "description":"Value that determines whether or not the inventory is nettable. Contains one of the following values: Yes or No. If Yes, then inventory is nettable.  If No, then inventory is not nettable. There is no default value for this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":50,
            "type":"string",
            "description":"Description of the subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceType":{
            "maxLength":80,
            "type":"string",
            "description":"Sourcing type to use when replenishing the item in the subinventory. A list of accepted values is defined in the lookup type INV_SOURCE_TYPES.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization to use when sourcing the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Depreciable":{
            "maxLength":80,
            "type":"string",
            "description":"Value that determines whether or not the inventory in the subinventory is depreciable. Contains one of the following values: Yes or No. If Yes, then the inventory in the subinventory is depreciable. If No, then the inventory in the subinventory is not depreciable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the sourcing type to use for replenishment in the subinventory. A list of accepted values is defined in the lookup type INV_SOURCE_TYPES. The default value is 2.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeInATP":{
            "maxLength":80,
            "type":"string",
            "description":"Value that determines whether or not to include the inventory when calculating the inventory that is available to promise. Contains one of the following values: Yes or No. If Yes, then include inventory in the available to promise calculation. If No, then do not include inventory in the available to promise calculation. There is no default value for this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubinventoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the subinventory.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetInventory":{
            "maxLength":80,
            "type":"string",
            "description":"Value that determines whether or not to consider the inventory in the subinventory as assets. Contains one of the following values: Yes or No. If Yes, then consider the inventory in the subinventory as assets. If No, then do not consider the inventory in the subinventory as assets.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubinventoryTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of subinventory. A list of accepted values is defined in the lookup type INV_SUB_TYPE. There is no default value for this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DisableDate":{
            "type":"string",
            "description":"Date when the subinventory is disabled.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryATPCode":{
            "type":"integer",
            "description":"Abbreviation that determines whether or not to include the inventory when calculating the inventory that is available to promise. Contains one of the following values: 1 or 2. If 1, then include inventory in the available to promise calculation. If 2, then do not include inventory in the available to promise calculation. There is no default value for this attribute.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SubinventoryType":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the type of subinventory. A list of accepted values is defined in the lookup type INV_SUB_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowReservations":{
            "maxLength":80,
            "type":"string",
            "description":"Value that determines whether or not the warehouse can reserve the inventory in the subinventory. Contains one of the following values: Yes or No. If Yes, then the warehouse can reserve the inventory in the subinventory. If No, then the warehouse cannot reserve the inventory in the subinventory. There is no default value for this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuantityTrackedCode":{
            "type":"integer",
            "description":"Abbreviation that determines whether or not the warehouse tracks the on-hand quantity for the item in the subinventory. Contains one of the following values: 1 or 2. If 1, then the warehouse tracks the on-hand quantity for the item in the subinventory. If 2, then the warehouse does not track the on-hand quantity for the item in the subinventory. The default value is 1.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ProcessingLeadTime":{
            "type":"integer",
            "description":"Processing lead time to use when sourcing the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryInventoryName":{
            "maxLength":10,
            "type":"string",
            "description":"Name of the subinventory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization to use when sourcing the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocatorType":{
            "maxLength":80,
            "type":"string",
            "description":"Type of stock locator control that the subinventory uses. A list of accepted values is defined in the lookup type INV_SUB_LOCATOR_CONTROL.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PickingOrder":{
            "type":"integer",
            "description":"Sequence to use when picking the item from this subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetInventoryCode":{
            "type":"integer",
            "description":"Abbreviation that determines whether or not to consider the inventory in the subinventory as assets. Contains one of the following values: 1 or 2. If 1, then consider the inventory in the subinventory as assets. If 2, then do not consider the inventory in the subinventory as assets. The default value is 1.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SourceSubinventory":{
            "maxLength":10,
            "type":"string",
            "description":"Subinventory to use when sourcing the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocatorTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of stock locator control that the subinventory uses. A list of accepted values is defined in the lookup type INV_SUB_LOCATOR_CONTROL. The default value is 1.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReservableType":{
            "type":"integer",
            "description":"Abbreviation that determines whether or not the warehouse can reserve the inventory in the subinventory. Contains one of the following values: 1 or 2. If 1, then the warehouse can reserve the inventory in the subinventory. If 2, then the warehouse cannot reserve the inventory in the subinventory. There is no default value for this attribute.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreprocessingLeadTime":{
            "type":"integer",
            "description":"Preprocessing lead time to use when sourcing the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NettableCode":{
            "type":"integer",
            "description":"Abbreviation that determines whether or not the inventory is nettable. Contains one of the following values: 1 or 2. If 1, then inventory is nettable.  If 2, then inventory is not nettable. There is no default value for this attribute.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "QuantityTracked":{
            "maxLength":80,
            "type":"string",
            "description":"Value that determines whether or not to track the on-hand quantity for the item in the subinventory. Contains one of the following values: Yes or No. If Yes, then track the on-hand quantity for the item in the subinventory. If No, then do not track the on-hand quantity for the item in the subinventory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization to use when sourcing the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepreciableCode":{
            "type":"integer",
            "description":"Abbreviation that determines whether or not the inventory in the subinventory is depreciable. Contains one of the following values: 1 or 2. If 1, then the inventory in the subinventory is depreciable. If 2, then the inventory in the subinventory is not depreciable. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "StatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the status.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PostprocessingLeadTime":{
            "type":"integer",
            "description":"Postprocessing lead time to use when sourcing the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to get all active subinventories.

Example cURL Command

Use the following cURL command to submit a request on the REST resource. This example gets all active subinventories for transaction type 2:

curl -u username:password "https://servername/fscmRestApi/resources/version/activeSubinventories?onlyData=true&finder=findRestrictedSubinventories;bindTransactionTypeId=2"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "items" : [ {
    "SubinventoryId" : 300100002756496,
    "SecondaryInventoryName" : "SLC_SRC",
    "OrganizationId" : 207,
    "OrganizationCode" : "M1",
    "OrganizationName" : "Tall Manufacturing\t\t",
    "Description" : "Source sub",
    "DisableDate" : null,
    "InventoryATPCode" : 1,
    "IncludeInATP" : "Yes",
    "NettableCode" : 1,
    "Nettable" : "Yes",
    "ReservableType" : 1,
    "AllowReservations" : "Yes",
    "LocatorTypeCode" : "2",
    "LocatorType" : "Previously defined",
    "PickingOrder" : null,
    "QuantityTrackedCode" : 1,
    "QuantityTracked" : "Yes",
    "AssetInventoryCode" : 1,
    "AssetInventory" : "Yes",
    "SourceTypeCode" : "2",
    "SourceType" : "Supplier",
    "SourceSubinventory" : null,
    "SourceOrganizationId" : null,
    "SourceOrganizationCode" : null,
    "SourceOrganizationName" : null,
    "PreprocessingLeadTime" : null,
    "ProcessingLeadTime" : null,
    "PostprocessingLeadTime" : null,
    "LocationId" : null,
    "LocationName" : null,
    "DepreciableCode" : 2,
    "Depreciable" : "No",
    "StatusId" : 1,
    "StatusCode" : "Active",
    "SubinventoryTypeCode" : "1",
    "SubinventoryType" : "Storage"
  } ],
  "count" : 1,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/activeSubinventories",
    "name" : "activeSubinventories",
    "kind" : "collection"
  } ]
}

Back to Top