Jump to

• Request
• Response

Get an On-Hand quantity detail at the summary level

get

/fscmRestApi/resources/11.13.18.05/inventoryOutboundItemQuantitiesSummaries/{OnhandSummaryId}

Request

Path Parameters

• OnhandSummaryId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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:
  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.

Body ()

Root Schema : inventoryOutboundItemQuantitiesSummaries-item-response

Type: object

Show Source

• CountryOfOrigin: string
  Read Only: true

  Maximum Length: 80

  Value that identifies the country of manufacture used to categorize inventory transactions.
• CountryOfOriginCode: string
  Read Only: true

  Maximum Length: 2

  Value that identifies the code of the country of manufacture used to categorize inventory transactions.
• InventoryItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Any part, material, product, or service that's unique compared to other items by the nature of its attributes in the product data hub.
• links: array Links
  Title: Links

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

  Value that uniquely identifies the locator.
• LocatorName: string
  Read Only: true

  Maximum Length: 2000

  Concatenated segments from the Inventory Locator Key Flexfield.
• LotControl: string
  Read Only: true

  Maximum Length: 80

  Value that specifies the lot control of an item.
• LotControlCode: number
  Read Only: true

  Value that specifies the lot control code of an item.
• LotGrade: string
  Read Only: true

  Maximum Length: 150

  Value that identifies the grade of the inventory lot.
• LotNumber: string
  Read Only: true

  Maximum Length: 80

  Value that identifies an inventory lot.
• OnhandSummaryId: integer (int64)
  Read Only: true

  Value that uniquely identifies the On-Hand summary record.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Value that identifies the inventory organization code.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory organization.
• OwningEntityId: integer (int64)
  Read Only: true

  Value that uniquely identifies the owning entity.
• OwningEntityName: string
  Read Only: true

  Maximum Length: 240

  Name of the owning entity (supplier site) who owns the items involved in the transactions that may trigger ownership change.
• OwningType: string
  Read Only: true

  Maximum Length: 30

  Owning type identifies the entity type that owns this quantity in the context of consignment. The valid values are found in the lookup type INV_OWNING_TYPES. The record is considered consigned only if the OWNING_TYPE is populated.
• OwningTypeName: string
  Read Only: true

  Maximum Length: 240

  Owning type identifies the entity name that owns this quantity in the context of consignment. The valid values are found in the lookup type INV_OWNING_TYPES. The record is considered consigned only if the OWNING_TYPE is populated.
• PrimaryUOM: string
  Read Only: true

  Maximum Length: 255

  Value identifies the principal unit of measure in which an item's quantity is managed.
• PrimaryUOMCode: string
  Read Only: true

  Maximum Length: 3

  Value identifies the code of the principal unit of measure in which an item's quantity is managed.
• ProjectId: integer (int64)
  Read Only: true

  Value that uniquely identifies the project used to categorize inventory transactions.
• ProjectNumber: string
  Read Only: true

  Maximum Length: 25

  Value identifies the inventory project.
• Quantity: number
  Read Only: true

  Value that specifies the quantity in the primary unit of measure.
• Revision: string
  Read Only: true

  Maximum Length: 18

  Value that identifies the revision of an item if it's under revision control.
• RevisionQuantityControl: string
  Read Only: true

  Maximum Length: 3

  Value that identifies the revision control of an item.
• RevisionQuantityControlCode: number
  Read Only: true

  Value that identifies the revision control code of an item.
• SecondaryUOM: string
  Read Only: true

  Maximum Length: 255

  Value that indicates the secondary unit of measure through which the item can be transacted.
• SecondaryUOMCode: string
  Read Only: true

  Maximum Length: 3

  Value that indicates the secondary unit of measure code through which the item can be transacted.
• SecondaryUOMQuantity: number
  Read Only: true

  Value that specifies the converted transaction quantity in the units of the secondary unit of measure.
• SerialControl: string
  Read Only: true

  Maximum Length: 80

  Value that identifies the serial control of an item.
• SerialNumberControlCode: number
  Read Only: true

  Value that identifies the serial control code of an item.
• serials: array On Hand Quantity Details of the Serials
  Title: On Hand Quantity Details of the Serials

  On-Hand quantities details of the serials.
• SubinventoryCode: string
  Read Only: true

  Maximum Length: 10

  Value that indicates the name of the subinventory.
• TaskId: integer (int64)
  Read Only: true

  Value that uniquely identifies the task used to categorize inventory transactions.
• TaskNumber: string
  Read Only: true

  Maximum Length: 100

  Value that identifies the inventory task.

{
    "type":"object",
    "properties":{
        "serials":{
            "title":"On Hand Quantity Details of the Serials",
            "type":"array",
            "description":"On-Hand quantities details of the serials.",
            "items":{
                "$ref":"#/components/schemas/inventoryOutboundItemQuantitiesSummaries-serials-item-response"
            }
        },
        "TaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task used to categorize inventory transactions.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SecondaryUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the secondary unit of measure through which the item can be transacted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Value identifies the principal unit of measure in which an item's quantity is managed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryOfOrigin":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the country of manufacture used to categorize inventory transactions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SerialNumberControlCode":{
            "type":"number",
            "description":"Value that identifies the serial control code of an item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SerialControl":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the serial control of an item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubinventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Value that indicates the name of the subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocatorName":{
            "maxLength":2000,
            "type":"string",
            "description":"Concatenated segments from the Inventory Locator Key Flexfield.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Any part, material, product, or service that's unique compared to other items by the nature of its attributes in the product data hub.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Value that indicates the secondary unit of measure code through which the item can be transacted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Value that identifies the inventory organization code.",
            "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"
            }
        },
        "LotGrade":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the grade of the inventory lot.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningTypeName":{
            "maxLength":240,
            "type":"string",
            "description":"Owning type identifies the entity name that owns this quantity in the context of consignment. The valid values are found in the lookup type INV_OWNING_TYPES. The record is considered consigned only if the OWNING_TYPE is populated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the owning entity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LotControl":{
            "maxLength":80,
            "type":"string",
            "description":"Value that specifies the lot control of an item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies an inventory lot.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Value identifies the code of the principal unit of measure in which an item's quantity is managed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningEntityName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the owning entity (supplier site) who owns the items involved in the transactions that may trigger ownership change.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectNumber":{
            "maxLength":25,
            "type":"string",
            "description":"Value identifies the inventory project.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwningType":{
            "maxLength":30,
            "type":"string",
            "description":"Owning type identifies the entity type that owns this quantity in the context of consignment. The valid values are found in the lookup type INV_OWNING_TYPES. The record is considered consigned only if the OWNING_TYPE is populated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the project used to categorize inventory transactions.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskNumber":{
            "maxLength":100,
            "type":"string",
            "description":"Value that identifies the inventory task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Value that specifies the quantity in the primary unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LotControlCode":{
            "type":"number",
            "description":"Value that specifies the lot control code of an item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryOfOriginCode":{
            "maxLength":2,
            "type":"string",
            "description":"Value that identifies the code of the country of manufacture used to categorize inventory transactions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Revision":{
            "maxLength":18,
            "type":"string",
            "description":"Value that identifies the revision of an item if it's under revision control.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RevisionQuantityControl":{
            "maxLength":3,
            "type":"string",
            "description":"Value that identifies the revision control of an item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMQuantity":{
            "type":"number",
            "description":"Value that specifies the converted transaction quantity in the units of the secondary unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OnhandSummaryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the On-Hand summary record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevisionQuantityControlCode":{
            "type":"number",
            "description":"Value that identifies the revision control code of an 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 : On Hand Quantity Details of the Serials

Type: array

Title: On Hand Quantity Details of the Serials

On-Hand quantities details of the serials.

Show Source

• Array of: object inventoryOutboundItemQuantitiesSummaries-serials-item-response

{
    "title":"On Hand Quantity Details of the Serials",
    "type":"array",
    "description":"On-Hand quantities details of the serials.",
    "items":{
        "$ref":"#/components/schemas/inventoryOutboundItemQuantitiesSummaries-serials-item-response"
    }
}

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."
        }
    }
}

Nested Schema : inventoryOutboundItemQuantitiesSummaries-serials-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SerialNumber: string
  Read Only: true

  Maximum Length: 80

  Number that uniquely identifies a single quantity of the item in inventory.

{
    "type":"object",
    "properties":{
        "SerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies a single quantity of the item in inventory.",
            "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"
            }
        }
    }
}

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"
    }
}

Links

serials

Operation: /fscmRestApi/resources/11.13.18.05/inventoryOutboundItemQuantitiesSummaries/{OnhandSummaryId}/child/serials

Parameters:

• OnhandSummaryId: $request.path.OnhandSummaryId

On-Hand quantities details of the serials.

Back to Top