Jump to

• Request
• Response

Query for existing inventory reservation interface records

get

/fscmRestApi/resources/11.13.18.05/inventoryStagedReservations

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: Uniquely identifies a reservation request.
    Finder Variables:
    • ReservationBatchId; integer; Identifies a group of reservation requests.
    • ReservationInterfaceId; integer; Identifies a unique reservation request.
• 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:
  

  • DemandSourceHeaderId; integer; Value that identifies the header number for source of demand.
  • DemandSourceHeaderNumber; string; Identifies the header number for source of demand.
  • DemandSourceLineId; integer; Value that identifies the line number for demand source.
  • DemandSourceLineNumber; string; Identifies the line number for demand source.
  • DemandSourceName; string; Identifies the user defined demand.
  • DemandSourceTypeId; integer; Value that identifies the type of demand. Valid values are 2, 3, 6, 8,and 13. 2 indicates Sales Order, 3 indicates Account, 6 indicates Account Alias, 8 indicates Transfer Order and 13 indicates User defined.
  • DemandSourceTypeName; string; Identifies the type of demand. Valid values are Sales Order, Account, Account Alias, Transfer Order, and User defined.
  • ErrorCode; number; Error code returned by the reservations interface manager.
  • ErrorExplanation; string; Indicates the error message code for the record in the error.
  • ErrorExplanationCode; string; Provides the error explanation code for the record in the error.
  • InventoryItemId; integer; Value that uniquely identifies the inventory item.
  • ItemNumber; string; Identifies the inventory item number.
  • Locator; string; Abbreviation that identifies the subinventory that the warehouse uses to reserve inventory for the item. It is typically a physical area in the subinventory, such as a row, aisle, bin, or shelf, that stores the item.
  • LocatorId; integer; Value that uniquely identifies the locator for the reservation.
  • LockCode; string; Value that identifies if the record is locked to prevent the record from being picked by another reservation interface process. Valid values are 1 and 2. 1 indicates that the record is locked and 2 indicates that the record is available for a lock to be placed on it. The default value is 2.
  • LotNumber; string; Number that identifies an item or group of items. Applies when the warehouse places the item under lot control.
  • OrganizationCode; string; Organization for which the reservation is created.
  • OrganizationId; integer; Value that uniquely identifies the organization for which the reservation is created.
  • OrganizationName; string; Identifies organization name in which reservation function is performed
  • PrimaryReservationQuantity; number; Reserved quantity expressed in the primary unit of measure of the item.
  • PrimaryUOMCode; string; Abbreviation that identifies the primary unit of measure.
  • PrimaryUnitOfMeasure; string; Primary unit of measure of the item.
  • ProcessMode; string; Mode in which interface record has to be processed. It has values : Online,Concurrent,Background. Value that identifies the mode of the processing the inventory attribute transaction request lines. It has values : Online,Concurrent,Background. Valid values include 1, 2, and 3. 1 indicates online, 2 indicates concurrent, and 3 indicates background. 1 indicates that the records are inserted in the Inventory Reservations interface with the transaction mode as 1. This invokes Manage Reservations Interface scheduled process to process the records in the reservation interface. 2 indicates that the records are inserted in the Inventory Reservations interface with transaction mode as 2. This invokes Manage Reservations Interface to process the records in the reservation interface. 3 indicates that the records are inserted in the Inventory Reservations interface with transaction mode as 3. User needs to invoke the Manage Reservations Interface scheduled process manually to process the records in the reservation interface.
  • RequirementDate; string; Indicates the requirement date for the reservation.
  • ReservationActionCode; string; Value that identifies the reservation action that needs to be performed. Valis values are 1, 2, 3, and 4. 1 indicates Create, 2 indicates Update, 3 indicates Delete, and 4 indicates Transfer.
  • ReservationBatchId; integer; Value that identifies a reservation batch.
  • ReservationInterfaceId; integer; Value that identifies a unique reservation record.
  • ReservationQuantity; number; Identifies the quantity to be reserved in reservation UOM code.
  • ReservationUOMCode; string; Abbreviation that identifies the unit of measure that the user chooses when placing the reservation.
  • ReservationUnitOfMeasure; string; Identifies the unit of measure for the reservation record.
  • Revision; string; Revision of the item. Applies when the warehouse enables the item for revision control.
  • RowStatusCode; string; Indicates the status of the request. Valid values are 1 and 3. 1 indicates Active, and 3 indicates Error.
  • SecondaryReservationQuantity; number; Reservation quantity expressed in the secondary unit of measure.
  • SecondaryUOMCode; string; Abbreviation that identifies the secondary unit of measure.
  • SecondaryUnitOfMeasure; string; Secondary unit of measure of the item.
  • SourceFulfillmentLineId; integer; Value that identifies the source fulfillment line for sales order demand.
  • SubinventoryCode; string; Name of the subinventory that the warehouse uses to make the reservation.
  • SupplyProjectId; integer; Value that uniquely identifies the project for the supply document.
  • SupplyProjectNumber; string; Number that identifies the project for the supply document.
  • SupplySourceHeaderId; integer; Value that identifies the supply document.
  • SupplySourceHeaderNumber; string; Identifies the supply document.
  • SupplySourceLineId; integer; Value that identifies the line number in the supply document.
  • SupplySourceLineNumber; string; Line number in the supply document.
  • SupplySourceTypeId; integer; Value that uniquely identifies the type of the supply document.
  • SupplySourceTypeName; string; Type of the supply document. A list of accepted values is defined in the lookup type INV_RESERVATION_SUPPLY_SRC_TYP. Values include Purchase Order, On Hand, Requisition, Transfer Order Return, Work Order, or Transfer Order.
  • SupplyTaskId; integer; Value that uniquely identifies the task corresponding to a project for the supply document.
  • SupplyTaskNumber; string; Number that identifies the task corresponding to a project for the supply document.
  • ToDemandSourceHeaderId; integer; Value that identifies the header number for destination source of demand to update or transfer the reservation.
  • ToDemandSourceHeaderNumber; string; Identifies the header number for destination source of demand to update or transfer the reservation.
  • ToDemandSourceLineId; integer; Value that identifies the line number corresponding to a header number for destination source of demand to update or transfer the reservation.
  • ToDemandSourceLineNumber; string; Identifies the line number corresponding to a header number for destination source of demand to update or transfer the reservation.
  • ToDemandSourceName; string; Identifies the header number for source of demand to update or transfer the reservation.
  • ToDemandSourceTypeId; integer; Identifies the destination demand source type name to update or transfer the reservation. Valid values are 2, 3, 6, 8,and 13. 2 indicates Sales Order, 3 indicates Account, 6 indicates Account Alias, 8 indicates Transfer Order and 13 indicates User defined.
  • ToDemandSourceTypeName; string; Identifies the destination demand source type name to update or transfer the reservation. Valid values are Sales Order, Account, Account Alias, Transfer Order, and User defined.
  • ToLocator; string; Identifies the destination locator to update or transfer the reservation.
  • ToLocatorId; integer; Value that identifies the destination locator to update or transfer the reservation.
  • ToLotNumber; string; Identifies the lot number to update or transfer the reservation.
  • ToOrganizationId; integer; Value that identifies the organization name to which the reservation is updated or transferred.
  • ToOrganizationName; string; Identifies the organization name to which the reservation is updated or transferred.
  • ToRevision; string; Identifies the destination revision for a revision controlled reserved item.
  • ToSubinventoryCode; string; Identifies the destination subinventory to update or transfer the reservation.
  • ToSupplyProjectId; integer; Number that identifis the destination supply project to update or transfer the reservation.
  • ToSupplyProjectNumber; string; Name of the destination supply project to update or transfer the reservation.
  • ToSupplySourceHeaderId; integer; Value that identifies the header number for a destination supply source to update or transfer the reservation.
  • ToSupplySourceHeaderNumber; string; Identifies the header number for a destination supply source to update or transfer the reservation.
  • ToSupplySourceLineId; integer; Value that identifies the line number corresponding to a header number for a destination supply source to update or transfer the reservation.
  • ToSupplySourceLineNumber; string; Identifies the line number corresponding to a header number for a destination supply source to update or transfer the reservation.
  • ToSupplySourceTypeId; integer; Value that identifies the destination supply source nameto update or transfer the reservation.
  • ToSupplySourceTypeName; string; Identifies the destination supply source name to update or transfer the reservation.
  • ToSupplyTaskId; integer; Value that identifies the destination task used to update and transfer the reservation.
  • ToSupplyTaskNumber; string; Identifies the destination task used to update and transfer the reservation.
• 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:
  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 : inventoryStagedReservations

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/inventoryStagedReservations-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object inventoryStagedReservations-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/inventoryStagedReservations-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 : inventoryStagedReservations-item-response

Type: object

Show Source

• DemandSourceHeaderId: integer (int64)
  Title: Demand Document Number

  Value that identifies the header number for source of demand.
• DemandSourceHeaderNumber: string
  Maximum Length: 150

  Identifies the header number for source of demand.
• DemandSourceLineId: integer (int64)
  Title: Demand Document Line

  Value that identifies the line number for demand source.
• DemandSourceLineNumber: string
  Maximum Length: 150

  Identifies the line number for demand source.
• DemandSourceName: string
  Title: Demand Document Name

  Maximum Length: 30

  Identifies the user defined demand.
• DemandSourceTypeId: integer (int64)
  Title: Demand Document Type ID

  Value that identifies the type of demand. Valid values are 2, 3, 6, 8,and 13. 2 indicates Sales Order, 3 indicates Account, 6 indicates Account Alias, 8 indicates Transfer Order and 13 indicates User defined.
• DemandSourceTypeName: string
  Maximum Length: 80

  Identifies the type of demand. Valid values are Sales Order, Account, Account Alias, Transfer Order, and User defined.
• ErrorCode: number
  Title: Error

  Error code returned by the reservations interface manager.
• ErrorExplanation: string
  Title: Error Explanation

  Maximum Length: 240

  Indicates the error message code for the record in the error.
• ErrorExplanationCode: string
  Maximum Length: 240

  Provides the error explanation code for the record in the error.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item.
• ItemNumber: string
  Maximum Length: 300

  Identifies the inventory item number.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Locator: string
  Maximum Length: 255

  Abbreviation that identifies the subinventory that the warehouse uses to reserve inventory for the item. It is typically a physical area in the subinventory, such as a row, aisle, bin, or shelf, that stores the item.
• LocatorId: integer (int64)
  Title: Locator

  Value that uniquely identifies the locator for the reservation.
• LockCode: string
  Title: Locked

  Maximum Length: 30

  Default Value: 2

  Value that identifies if the record is locked to prevent the record from being picked by another reservation interface process. Valid values are 1 and 2. 1 indicates that the record is locked and 2 indicates that the record is available for a lock to be placed on it. The default value is 2.
• LotNumber: string
  Title: Lot

  Maximum Length: 80

  Number that identifies an item or group of items. Applies when the warehouse places the item under lot control.
• OrganizationCode: string
  Maximum Length: 18

  Organization for which the reservation is created.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization for which the reservation is created.
• OrganizationName: string
  Maximum Length: 240

  Identifies organization name in which reservation function is performed
• PrimaryReservationQuantity: number
  Title: Reserved Quantity

  Reserved quantity expressed in the primary unit of measure of the item.
• PrimaryUnitOfMeasure: string
  Maximum Length: 25

  Primary unit of measure of the item.
• PrimaryUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the primary unit of measure.
• ProcessMode: string
  Maximum Length: 255

  Mode in which interface record has to be processed. It has values : Online,Concurrent,Background. Value that identifies the mode of the processing the inventory attribute transaction request lines. It has values : Online,Concurrent,Background. Valid values include 1, 2, and 3. 1 indicates online, 2 indicates concurrent, and 3 indicates background. 1 indicates that the records are inserted in the Inventory Reservations interface with the transaction mode as 1. This invokes Manage Reservations Interface scheduled process to process the records in the reservation interface. 2 indicates that the records are inserted in the Inventory Reservations interface with transaction mode as 2. This invokes Manage Reservations Interface to process the records in the reservation interface. 3 indicates that the records are inserted in the Inventory Reservations interface with transaction mode as 3. User needs to invoke the Manage Reservations Interface scheduled process manually to process the records in the reservation interface.
• ProcessModeCode: string
  Value that identifies the process mode to be used to process the interface records. Valid values are 1, 2, and 3. 1 indicates online mode of processing, 2 indicates concurrent mode, and 3 indicates background mode.
• RequirementDate: string (date)
  Title: Due Date

  Indicates the requirement date for the reservation.
• ReservationActionCode: string
  Title: Reservation Action

  Maximum Length: 30

  Value that identifies the reservation action that needs to be performed. Valis values are 1, 2, 3, and 4. 1 indicates Create, 2 indicates Update, 3 indicates Delete, and 4 indicates Transfer.
• ReservationBatchId: integer (int64)
  Title: Reservation Batch ID

  Value that identifies a reservation batch.
• ReservationInterfaceId: integer (int64)
  Value that identifies a unique reservation record.
• ReservationQuantity: number
  Title: Reserved Quantity

  Identifies the quantity to be reserved in reservation UOM code.
• ReservationUnitOfMeasure: string
  Maximum Length: 25

  Identifies the unit of measure for the reservation record.
• ReservationUOMCode: string
  Title: Reservation UOM

  Maximum Length: 3

  Abbreviation that identifies the unit of measure that the user chooses when placing the reservation.
• Revision: string
  Maximum Length: 18

  Revision of the item. Applies when the warehouse enables the item for revision control.
• RowStatusCode: string
  Title: Row Status

  Maximum Length: 30

  Indicates the status of the request. Valid values are 1 and 3. 1 indicates Active, and 3 indicates Error.
• SecondaryReservationQuantity: number
  Title: Secondary Reserved Quantity

  Reservation quantity expressed in the secondary unit of measure.
• SecondaryUnitOfMeasure: string
  Maximum Length: 25

  Secondary unit of measure of the item.
• SecondaryUOMCode: string
  Title: Secondary UOM

  Maximum Length: 3

  Abbreviation that identifies the secondary unit of measure.
• SourceFulfillmentLineId: integer (int64)
  Value that identifies the source fulfillment line for sales order demand.
• SubinventoryCode: string
  Maximum Length: 10

  Name of the subinventory that the warehouse uses to make the reservation.
• SupplyProjectId: integer (int64)
  Value that uniquely identifies the project for the supply document.
• SupplyProjectNumber: string
  Maximum Length: 25

  Number that identifies the project for the supply document.
• SupplySourceHeaderId: integer (int64)
  Title: Supply Document Number

  Value that identifies the supply document.
• SupplySourceHeaderNumber: string
  Maximum Length: 150

  Identifies the supply document.
• SupplySourceLineId: integer (int64)
  Title: Supply Document Line

  Value that identifies the line number in the supply document.
• SupplySourceLineNumber: string
  Maximum Length: 150

  Line number in the supply document.
• SupplySourceTypeId: integer (int64)
  Title: Supply Document Type

  Value that uniquely identifies the type of the supply document.
• SupplySourceTypeName: string
  Maximum Length: 80

  Type of the supply document. A list of accepted values is defined in the lookup type INV_RESERVATION_SUPPLY_SRC_TYP. Values include Purchase Order, On Hand, Requisition, Transfer Order Return, Work Order, or Transfer Order.
• SupplyTaskId: integer (int64)
  Value that uniquely identifies the task corresponding to a project for the supply document.
• SupplyTaskNumber: string
  Maximum Length: 100

  Number that identifies the task corresponding to a project for the supply document.
• ToDemandSourceHeaderId: integer (int64)
  Title: To Demand Document Number

  Value that identifies the header number for destination source of demand to update or transfer the reservation.
• ToDemandSourceHeaderNumber: string
  Maximum Length: 150

  Identifies the header number for destination source of demand to update or transfer the reservation.
• ToDemandSourceLineId: integer (int64)
  Title: To Demand Document Line ID

  Value that identifies the line number corresponding to a header number for destination source of demand to update or transfer the reservation.
• ToDemandSourceLineNumber: string
  Maximum Length: 150

  Identifies the line number corresponding to a header number for destination source of demand to update or transfer the reservation.
• ToDemandSourceName: string
  Title: To Demand Document Name

  Maximum Length: 30

  Identifies the header number for source of demand to update or transfer the reservation.
• ToDemandSourceTypeId: integer (int64)
  Title: To Demand Document Type

  Identifies the destination demand source type name to update or transfer the reservation. Valid values are 2, 3, 6, 8,and 13. 2 indicates Sales Order, 3 indicates Account, 6 indicates Account Alias, 8 indicates Transfer Order and 13 indicates User defined.
• ToDemandSourceTypeName: string
  Maximum Length: 80

  Identifies the destination demand source type name to update or transfer the reservation. Valid values are Sales Order, Account, Account Alias, Transfer Order, and User defined.
• ToLocator: string
  Maximum Length: 255

  Identifies the destination locator to update or transfer the reservation.
• ToLocatorId: integer (int64)
  Title: To Locator

  Value that identifies the destination locator to update or transfer the reservation.
• ToLotNumber: string
  Title: To Lot

  Maximum Length: 80

  Identifies the lot number to update or transfer the reservation.
• ToOrganizationId: integer (int64)
  Title: To Organization

  Value that identifies the organization name to which the reservation is updated or transferred.
• ToOrganizationName: string
  Maximum Length: 240

  Identifies the organization name to which the reservation is updated or transferred.
• ToRevision: string
  Title: To Revision

  Maximum Length: 18

  Identifies the destination revision for a revision controlled reserved item.
• ToSubinventoryCode: string
  Title: To Subinventory

  Maximum Length: 10

  Identifies the destination subinventory to update or transfer the reservation.
• ToSupplyProjectId: integer (int64)
  Number that identifis the destination supply project to update or transfer the reservation.
• ToSupplyProjectNumber: string
  Maximum Length: 25

  Name of the destination supply project to update or transfer the reservation.
• ToSupplySourceHeaderId: integer (int64)
  Title: To Supply Document Number

  Value that identifies the header number for a destination supply source to update or transfer the reservation.
• ToSupplySourceHeaderNumber: string
  Maximum Length: 150

  Identifies the header number for a destination supply source to update or transfer the reservation.
• ToSupplySourceLineId: integer (int64)
  Title: To Supply Document Line

  Value that identifies the line number corresponding to a header number for a destination supply source to update or transfer the reservation.
• ToSupplySourceLineNumber: string
  Maximum Length: 150

  Identifies the line number corresponding to a header number for a destination supply source to update or transfer the reservation.
• ToSupplySourceTypeId: integer (int64)
  Title: To Supply Document Type

  Value that identifies the destination supply source nameto update or transfer the reservation.
• ToSupplySourceTypeName: string
  Maximum Length: 80

  Identifies the destination supply source name to update or transfer the reservation.
• ToSupplyTaskId: integer (int64)
  Value that identifies the destination task used to update and transfer the reservation.
• ToSupplyTaskNumber: string
  Maximum Length: 100

  Identifies the destination task used to update and transfer the reservation.

{
    "type":"object",
    "properties":{
        "ToLocator":{
            "maxLength":"255",
            "type":"string",
            "description":"Identifies the destination locator to update or transfer the reservation.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ToLocatorId"
                ]
            },
            "x-queryable":true
        },
        "ToRevision":{
            "title":"To Revision",
            "maxLength":"18",
            "type":"string",
            "description":"Identifies the destination revision for a revision controlled reserved item.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyTaskNumber":{
            "maxLength":"100",
            "type":"string",
            "description":"Number that identifies the task corresponding to a project for the supply document.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceFulfillmentLineId":{
            "type":"integer",
            "description":"Value that identifies the source fulfillment line for sales order demand.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SecondaryUnitOfMeasure":{
            "maxLength":"25",
            "type":"string",
            "description":"Secondary unit of measure of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ToDemandSourceName":{
            "title":"To Demand Document Name",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the header number for source of demand to update or transfer the reservation.",
            "nullable":true,
            "x-queryable":true
        },
        "ToDemandSourceHeaderNumber":{
            "maxLength":"150",
            "type":"string",
            "description":"Identifies the header number for destination source of demand to update or transfer the reservation.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task corresponding to a project for the supply document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReservationInterfaceId":{
            "type":"integer",
            "description":"Value that identifies a unique reservation record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ToLocatorId":{
            "title":"To Locator",
            "type":"integer",
            "description":"Value that identifies the destination locator to update or transfer the reservation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DemandSourceName":{
            "title":"Demand Document Name",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the user defined demand.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandSourceTypeId":{
            "title":"Demand Document Type ID",
            "type":"integer",
            "description":"Value that identifies the type of demand.  Valid values are 2, 3, 6, 8,and 13. 2 indicates Sales Order, 3  indicates Account, 6 indicates Account Alias, 8 indicates Transfer Order and 13 indicates User defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Locator":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the subinventory that the warehouse uses to reserve inventory for the item. It is typically a physical area in the subinventory, such as a row, aisle, bin, or shelf, that stores the item.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LocatorId"
                ]
            },
            "x-queryable":true
        },
        "DemandSourceHeaderId":{
            "title":"Demand Document Number",
            "type":"integer",
            "description":"Value that identifies the header number for source of demand. ",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReservationUnitOfMeasure":{
            "maxLength":"25",
            "type":"string",
            "description":"Identifies the unit of measure for the reservation record.",
            "nullable":true,
            "x-queryable":true
        },
        "ToDemandSourceLineNumber":{
            "maxLength":"150",
            "type":"string",
            "description":"Identifies the line number corresponding to a header number for destination source of demand to update or transfer the reservation.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SupplyProjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the project for the supply document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ToSupplyTaskNumber":{
            "maxLength":"100",
            "type":"string",
            "description":"Identifies the destination task used to update and transfer the reservation.",
            "nullable":true,
            "x-queryable":true
        },
        "ToSupplyProjectId":{
            "type":"integer",
            "description":"Number that identifis the destination supply project to update or transfer the reservation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DemandSourceHeaderNumber":{
            "maxLength":"150",
            "type":"string",
            "description":"Identifies the header number for source of demand. ",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorExplanation":{
            "title":"Error Explanation",
            "maxLength":"240",
            "type":"string",
            "description":"Indicates the error message code for the record in the error.",
            "nullable":true,
            "x-queryable":true
        },
        "ReservationActionCode":{
            "title":"Reservation Action",
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the reservation action that needs to be performed. Valis values are 1, 2, 3, and 4. 1 indicates Create, 2  indicates Update, 3 indicates Delete, and 4 indicates Transfer.",
            "nullable":false,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LocatorId":{
            "title":"Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the locator for the reservation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DemandSourceTypeName":{
            "maxLength":"80",
            "type":"string",
            "description":"Identifies the type of demand.  Valid values are Sales Order, Account, Account Alias, Transfer Order, and User defined.",
            "nullable":true,
            "x-queryable":true
        },
        "ToOrganizationId":{
            "title":"To Organization",
            "type":"integer",
            "description":"Value that identifies the organization name to which the reservation  is updated or transferred.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ToSupplySourceLineId":{
            "title":"To Supply Document Line",
            "type":"integer",
            "description":"Value that identifies the line number corresponding to a header number for a destination supply source to update or transfer the reservation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProcessModeCode":{
            "type":"string",
            "description":"Value that identifies the process mode to be used to process the interface records. Valid values are 1, 2, and 3. 1 indicates online mode of processing, 2 indicates concurrent mode, and 3 indicates background mode.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplySourceLineNumber":{
            "maxLength":"150",
            "type":"string",
            "description":"Line number in the supply document.",
            "nullable":true,
            "x-queryable":true
        },
        "Revision":{
            "maxLength":"18",
            "type":"string",
            "description":"Revision of the item. Applies when the warehouse enables the item for revision control.",
            "nullable":true,
            "x-queryable":true
        },
        "ToDemandSourceTypeId":{
            "title":"To Demand Document Type",
            "type":"integer",
            "description":"Identifies the destination demand source type name  to update or transfer the reservation. Valid values are 2, 3, 6, 8,and 13. 2 indicates Sales Order, 3  indicates Account, 6 indicates Account Alias, 8 indicates Transfer Order and 13 indicates User defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReservationQuantity":{
            "title":"Reserved Quantity",
            "type":"number",
            "description":"Identifies the quantity to be reserved in reservation UOM code.",
            "nullable":false,
            "x-queryable":true
        },
        "ToSupplySourceTypeName":{
            "maxLength":"80",
            "type":"string",
            "description":"Identifies the destination supply source name to update or transfer the reservation.",
            "nullable":true,
            "x-queryable":true
        },
        "ToSupplySourceHeaderNumber":{
            "maxLength":"150",
            "type":"string",
            "description":"Identifies the header number for a destination supply source to update or transfer the reservation.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplySourceTypeId":{
            "title":"Supply Document Type",
            "type":"integer",
            "description":"Value that uniquely identifies the type of the supply document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ToSupplySourceHeaderId":{
            "title":"To Supply Document Number",
            "type":"integer",
            "description":"Value that identifies the header number for a destination supply source to update or transfer the reservation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RowStatusCode":{
            "title":"Row Status",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the status of the request. Valid values are 1 and 3. 1 indicates Active, and 3 indicates Error.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorExplanationCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Provides the error explanation code for the record in the error.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":"240",
            "type":"string",
            "description":"Identifies organization name in which reservation function is performed",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyProjectNumber":{
            "maxLength":"25",
            "type":"string",
            "description":"Number that identifies the project for the supply document.",
            "nullable":true,
            "x-queryable":true
        },
        "ReservationBatchId":{
            "title":"Reservation Batch ID",
            "type":"integer",
            "description":"Value that identifies a reservation batch.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DemandSourceLineNumber":{
            "maxLength":"150",
            "type":"string",
            "description":"Identifies the line number for demand source.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplySourceLineId":{
            "title":"Supply Document Line",
            "type":"integer",
            "description":"Value that identifies the line number in the supply document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ToDemandSourceLineId":{
            "title":"To Demand Document Line ID",
            "type":"integer",
            "description":"Value that identifies the line number corresponding to a header number for destination source of demand to update or transfer the reservation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization for which the reservation is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubinventoryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory that the warehouse uses to make the reservation.",
            "nullable":true,
            "x-queryable":true
        },
        "ReservationUOMCode":{
            "title":"Reservation UOM",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the user chooses when placing the reservation.",
            "nullable":true,
            "x-queryable":true
        },
        "RequirementDate":{
            "title":"Due Date",
            "type":"string",
            "description":"Indicates the requirement date for the reservation.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Identifies the inventory item number.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandSourceLineId":{
            "title":"Demand Document Line",
            "type":"integer",
            "description":"Value that identifies the line number for demand source.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "ToSupplySourceTypeId":{
            "title":"To Supply Document Type",
            "type":"integer",
            "description":"Value that identifies the destination supply source nameto update or transfer the reservation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ToSupplySourceLineNumber":{
            "maxLength":"150",
            "type":"string",
            "description":"Identifies the line number corresponding to a header number for a destination supply source to update or transfer the reservation.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Organization for which the reservation is created.",
            "nullable":true,
            "x-queryable":true
        },
        "ToOrganizationName":{
            "maxLength":"240",
            "type":"string",
            "description":"Identifies the organization name to which the reservation  is updated or transferred.",
            "nullable":true,
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot",
            "maxLength":"80",
            "type":"string",
            "description":"Number that identifies an item or group of items. Applies when the warehouse places the item under lot control.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the primary unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryReservationQuantity":{
            "title":"Reserved Quantity",
            "type":"number",
            "description":"Reserved quantity expressed in the primary unit of measure of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplySourceTypeName":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of the supply document. A list of accepted values is defined in the lookup type INV_RESERVATION_SUPPLY_SRC_TYP. Values include Purchase Order, On Hand, Requisition, Transfer Order Return, Work Order, or Transfer Order.",
            "nullable":true,
            "x-queryable":true
        },
        "ToDemandSourceHeaderId":{
            "title":"To Demand Document Number",
            "type":"integer",
            "description":"Value that identifies the header number for destination source of demand to update or transfer  the reservation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProcessMode":{
            "maxLength":"255",
            "type":"string",
            "description":"Mode in which interface record has to be processed. It has values : Online,Concurrent,Background.\nValue that identifies the mode of the processing the inventory attribute transaction request lines. It has values : Online,Concurrent,Background. Valid values include 1, 2, and 3. 1 indicates online, 2 indicates concurrent, and 3 indicates background.\n1 indicates that the records are inserted in the Inventory Reservations interface with the transaction mode as 1. This invokes Manage Reservations Interface scheduled process to process the records in the reservation interface.\n2 indicates that the records are inserted in the Inventory Reservations interface with transaction mode as 2. This invokes Manage Reservations Interface to process the records in the reservation interface.\n3 indicates that the records are inserted in the Inventory Reservations interface with transaction mode as 3. User needs to invoke the Manage Reservations Interface scheduled process manually to process the records in the reservation interface.",
            "nullable":true,
            "x-queryable":true
        },
        "ToSupplyProjectNumber":{
            "maxLength":"25",
            "type":"string",
            "description":"Name of the destination supply project to update or transfer the reservation.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplySourceHeaderNumber":{
            "maxLength":"150",
            "type":"string",
            "description":"Identifies the supply document.",
            "nullable":true,
            "x-queryable":true
        },
        "ToSubinventoryCode":{
            "title":"To Subinventory",
            "maxLength":"10",
            "type":"string",
            "description":"Identifies the destination subinventory to update or transfer the reservation.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryUnitOfMeasure":{
            "maxLength":"25",
            "type":"string",
            "description":"Primary unit of measure of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ToSupplyTaskId":{
            "type":"integer",
            "description":"Value that identifies the destination task used to update and transfer the reservation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SecondaryReservationQuantity":{
            "title":"Secondary Reserved Quantity",
            "type":"number",
            "description":"Reservation quantity expressed in the secondary unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplySourceHeaderId":{
            "title":"Supply Document Number",
            "type":"integer",
            "description":"Value that identifies the supply document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ToDemandSourceTypeName":{
            "maxLength":"80",
            "type":"string",
            "description":"Identifies the destination demand source type name to update or transfer the reservation. Valid values are Sales Order, Account, Account Alias, Transfer Order, and User defined.",
            "nullable":true,
            "x-queryable":true
        },
        "LockCode":{
            "title":"Locked",
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies if the record is locked to prevent the record from being picked by another reservation interface process. Valid values are 1 and 2.  1 indicates that the record is locked and 2 indicates that the record is available for a lock to be placed on it. The default value is 2.",
            "nullable":false,
            "default":"2",
            "x-queryable":true
        },
        "ToLotNumber":{
            "title":"To Lot",
            "maxLength":"80",
            "type":"string",
            "description":"Identifies the lot number to update or transfer the reservation.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorCode":{
            "title":"Error",
            "type":"number",
            "description":"Error code returned by the reservations interface manager.",
            "nullable":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