Jump to

• Request
• Response
• Examples

Get all reservations

get

/fscmRestApi/resources/11.13.18.05/inventoryReservations

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: Find inventory reservations.
    Finder Variables:
    • ReservationId; integer; Value that uniquely identifies the reservation.
• 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:
  

  • DemandProjectId; integer; Value that uniquely identifies the project for the demand document.
  • DemandProjectNumber; string; Number that identifies the project for the demand document.
  • DemandSourceHeaderId; integer; Value that uniquely identifies the demand document.
  • DemandSourceHeaderNumber; string; Document that specifies demand details for the item that the warehouse will reserve in inventory.
  • DemandSourceLineId; integer; Value that uniquely identifies the demand line.
  • DemandSourceLineNumber; string; Value that uniquely identifies the line number in the demand document.
  • DemandSourceName; string; Name of the source that requests the demand.
  • DemandSourceType; string; Type of document that requests the inventory reservation. A list of accepted values is defined in the lookup type INV_RESERVATION_SOURCE_TYPES. Values include User Defined, Transfer Order Return, Sales Order, Shipment Request, Account, Movement Request, Account Alias, Transfer order, or Cycle Count.
  • DemandSourceTypeId; integer; Value that uniquely identifies the type of document that requests the inventory reservation.
  • DemandTaskId; integer; Value that uniquely identifies the task corresponding to a project for the demand document.
  • DemandTaskNumber; string; Number that identifies the task corresponding to a project for the demand document.
  • InventoryItemId; integer; Value that uniquely identifies the item in inventory that the warehouse reserves to fulfill the item.
  • ItemNumber; string; Number that identifies the inventory item.
  • 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.
  • LotNumber; string; Number that identifies an item or group of items. Applies when the warehouse places the item under lot control.
  • OperationSequenceNumber; string; Sequence number of a specific operation as defined in a work order.
  • OrderInterfaceStatus; string; Contains one of the following values: Y or N. If Y, then the sales order or the transfer order demand is interfaced to inventory or shipping. If N, then the sales order or the transfer order demand is awaiting to be interfaced to inventory or shipping. This attribute does not have a default value. This attribute is associated with a feature that requires opt in.
  • OrganizationCode; string; Abbreviation that identifies the warehouse organization that reserves inventory to fulfill the item.
  • OrganizationId; integer; Value that uniquely identifies the warehouse organization that reserves inventory to fulfill the item.
  • 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.
  • RequirementDate; string; Date when the customer requires the item.
  • ReservationId; integer; Value that uniquely identifies the reservation.
  • ReservationQuantity; number; Reservation quantity expressed in the primary unit of measure.
  • ReservationUOMCode; string; Abbreviation that identifies the unit of measure that the user chooses when placing the reservation.
  • ReservationUnitOfMeasure; string; Unit of measure that the user chooses when placing a reservation.
  • Revision; string; Revision of the item. Applies when the warehouse places the item under revision control.
  • 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.
  • ShipToCustomer; string; Customer who receives the item.
  • ShipToPartyId; integer; Value that uniquely identifies the party that receives the item.
  • SourceFulfillmentLineId; integer; Value that order orchestration uses to uniquely identify the reservation.
  • SourceFulfillmentLineNumber; string; Number that identifies a line corresponding to a source fulfillment line.
  • 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 uniquely identifies the supply document.
  • SupplySourceHeaderNumber; string; Document that specifies supply details for the item.
  • SupplySourceLineId; integer; Value that uniquely identifies the line in the supply document.
  • SupplySourceLineNumber; string; Line number in the supply document.
  • SupplySourceType; 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.
  • SupplySourceTypeId; integer; Value that uniquely identifies the type of the supply document.
  • 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.
  • WorkOrderProductId; integer; Value that uniquely identifies the finished item that needs to be manufactured.
  • WorkOrderProductNumber; string; Number that identifies the finished item that needs to be manufactured.
• 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 : inventoryReservations

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/inventoryReservations-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 inventoryReservations-item-response

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

Type: object

Show Source

• DemandProjectId: integer
  Value that uniquely identifies the project for the demand document.
• DemandProjectNumber: string
  Number that identifies the project for the demand document.
• DemandSourceHeaderId: integer (int64)
  Value that uniquely identifies the demand document.
• DemandSourceHeaderNumber: string
  Document that specifies demand details for the item that the warehouse will reserve in inventory.
• DemandSourceLineId: integer (int64)
  Value that uniquely identifies the demand line.
• DemandSourceLineNumber: string
  Value that uniquely identifies the line number in the demand document.
• DemandSourceName: string
  Title: Demand Document Name

  Maximum Length: 30

  Name of the source that requests the demand.
• DemandSourceType: string
  Type of document that requests the inventory reservation. A list of accepted values is defined in the lookup type INV_RESERVATION_SOURCE_TYPES. Values include User Defined, Transfer Order Return, Sales Order, Shipment Request, Account, Movement Request, Account Alias, Transfer order, or Cycle Count.
• DemandSourceTypeId: integer (int64)
  Value that uniquely identifies the type of document that requests the inventory reservation.
• DemandTaskId: integer
  Value that uniquely identifies the task corresponding to a project for the demand document.
• DemandTaskNumber: string
  Number that identifies the task corresponding to a project for the demand document.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the item in inventory that the warehouse reserves to fulfill the item.
• ItemNumber: string
  Number that identifies the inventory item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• 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 (int64)
  Title: Locator

  Value that uniquely identifies the locator for the reservation.
• 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.
• OperationSequenceNumber: string
  Sequence number of a specific operation as defined in a work order.
• OrderInterfaceStatus: string
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the sales order or the transfer order demand is interfaced to inventory or shipping. If N, then the sales order or the transfer order demand is awaiting to be interfaced to inventory or shipping. This attribute does not have a default value. This attribute is associated with a feature that requires opt in.
• OrganizationCode: string
  Abbreviation that identifies the warehouse organization that reserves inventory to fulfill the item.
• OrganizationId: integer (int64)
  Value that uniquely identifies the warehouse organization that reserves inventory to fulfill the item.
• PrimaryReservationQuantity: number
  Title: Reserved Quantity

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

  Abbreviation that identifies the primary unit of measure.
• RequirementDate: string (date)
  Date when the customer requires the item.
• ReservationId: integer (int64)
  Value that uniquely identifies the reservation.
• ReservationQuantity: number
  Title: Reserved Quantity

  Reservation quantity expressed in the primary unit of measure.
• ReservationUnitOfMeasure: string
  Unit of measure that the user chooses when placing a reservation.
• 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 places the item under revision control.
• SecondaryReservationQuantity: number
  Title: Secondary Reserved Quantity

  Reservation quantity expressed in the secondary unit of measure.
• SecondaryUnitOfMeasure: string
  Secondary unit of measure of the item.
• SecondaryUOMCode: string
  Title: Secondary UOM

  Maximum Length: 3

  Abbreviation that identifies the secondary unit of measure.
• serials: array Serials
  Title: Serials

  The Serials resource manages serial numbers for reservations that reserve the on-hand supply. You can use it to create, read, update, or delete serials for a reservation.
• ShipToCustomer: string
  Read Only: true

  Customer who receives the item.
• ShipToPartyId: integer (int64)
  Title: Customer

  Value that uniquely identifies the party that receives the item.
• SourceFulfillmentLineId: integer (int64)
  Value that order orchestration uses to uniquely identify the reservation.
• SourceFulfillmentLineNumber: string
  Number that identifies a line corresponding to a source fulfillment line.
• SubinventoryCode: string
  Maximum Length: 10

  Name of the subinventory that the warehouse uses to make the reservation.
• SubinventoryId: integer
  Value that uniquely identifies the subinventory that the warehouse uses to reserve the item.
• 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 (int64)
  Value that uniquely identifies the supply document.
• SupplySourceHeaderNumber: string
  Document that specifies supply details for the item.
• SupplySourceLineId: integer (int64)
  Value that uniquely identifies the line in the supply document.
• SupplySourceLineNumber: string
  Line number in the supply document.
• SupplySourceType: 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.
• SupplySourceTypeId: integer (int64)
  Value that uniquely identifies the type of the supply document.
• 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.
• WorkOrderProductId: integer
  Read Only: true

  Value that uniquely identifies the finished item that needs to be manufactured.
• WorkOrderProductNumber: string
  Read Only: true

  Number that identifies the finished item that needs to be manufactured.

{
    "type":"object",
    "properties":{
        "DemandProjectNumber":{
            "type":"string",
            "description":"Number that identifies the project for the demand document.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyTaskNumber":{
            "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 order orchestration uses to uniquely identify the reservation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SecondaryUnitOfMeasure":{
            "type":"string",
            "description":"Secondary unit of measure of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task corresponding to a project for the supply document.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SupplySourceTypeId"
                ]
            },
            "x-queryable":true
        },
        "ShipToPartyId":{
            "title":"Customer",
            "type":"integer",
            "description":"Value that uniquely identifies the party that receives the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrderProductId":{
            "type":"integer",
            "description":"Value that uniquely identifies the finished item that needs to be manufactured.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandSourceName":{
            "title":"Demand Document Name",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the source that requests the demand.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandSourceTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of document that requests the inventory reservation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Locator":{
            "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-queryable":true
        },
        "DemandSourceHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReservationUnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure that the user chooses when placing a 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"
            }
        },
        "DemandProjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the project for the demand document.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyProjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the project for the supply document.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SupplySourceTypeId"
                ]
            },
            "x-queryable":true
        },
        "WorkOrderProductNumber":{
            "type":"string",
            "description":"Number that identifies the finished item that needs to be manufactured.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandSourceHeaderNumber":{
            "type":"string",
            "description":"Document that specifies demand details for the item that the warehouse will reserve in inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item in inventory that the warehouse reserves to fulfill the item.",
            "format":"int64",
            "nullable":false,
            "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
        },
        "SupplySourceLineNumber":{
            "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 places the item under revision control.",
            "nullable":true,
            "x-queryable":true
        },
        "ReservationQuantity":{
            "title":"Reserved Quantity",
            "type":"number",
            "description":"Reservation quantity expressed in the primary unit of measure.",
            "nullable":false,
            "x-queryable":true
        },
        "SupplySourceTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of the supply document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"string",
            "description":"Sequence number of a specific operation as defined in a work order.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToCustomer":{
            "type":"string",
            "description":"Customer who receives the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "serials":{
            "title":"Serials",
            "type":"array",
            "description":"The Serials resource manages serial numbers for reservations that reserve the on-hand supply. You can use it to create, read, update, or delete serials for a reservation.",
            "items":{
                "$ref":"#/components/schemas/inventoryReservations-serials-item-response"
            }
        },
        "OrderInterfaceStatus":{
            "maxLength":"1",
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then the sales order or the transfer order demand is interfaced to inventory or shipping. If N, then the sales order or the transfer order demand is awaiting to be interfaced to inventory or shipping. This attribute does not have a default value. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyProjectNumber":{
            "type":"string",
            "description":"Number that identifies the project for the supply document.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandSourceLineNumber":{
            "type":"string",
            "description":"Value that uniquely identifies the line number in the demand document.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplySourceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the line in the supply document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the warehouse organization that reserves inventory to fulfill the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DemandTaskNumber":{
            "type":"string",
            "description":"Number that identifies the task corresponding to a project for the demand document.",
            "nullable":true,
            "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
        },
        "SubinventoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the subinventory that the warehouse uses to reserve the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            }
        },
        "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":{
            "type":"string",
            "description":"Date when the customer requires the item.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "type":"string",
            "description":"Number that identifies the inventory item.",
            "nullable":true,
            "x-queryable":true
        },
        "ReservationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reservation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DemandSourceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand line.",
            "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
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the warehouse organization that reserves inventory to fulfill the item.",
            "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-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId"
                ]
            },
            "x-queryable":true
        },
        "DemandSourceType":{
            "type":"string",
            "description":"Type of document that requests the inventory reservation. A list of accepted values is defined in the lookup type INV_RESERVATION_SOURCE_TYPES. Values include User Defined, Transfer Order Return, Sales Order, Shipment Request, Account, Movement Request, Account Alias, Transfer order, or Cycle Count.",
            "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
        },
        "SupplySourceHeaderNumber":{
            "type":"string",
            "description":"Document that specifies supply details for the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplySourceType":{
            "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
        },
        "PrimaryUnitOfMeasure":{
            "type":"string",
            "description":"Primary unit of measure of the item.",
            "nullable":true,
            "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":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceFulfillmentLineNumber":{
            "type":"string",
            "description":"Number that identifies a line corresponding to a source fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task corresponding to a project for the demand document.",
            "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 : Serials

Type: array

Title: Serials

The Serials resource manages serial numbers for reservations that reserve the on-hand supply. You can use it to create, read, update, or delete serials for a reservation.

Show Source

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

{
    "title":"Serials",
    "type":"array",
    "description":"The Serials resource manages serial numbers for reservations that reserve the on-hand supply. You can use it to create, read, update, or delete serials for a reservation.",
    "items":{
        "$ref":"#/components/schemas/inventoryReservations-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 : inventoryReservations-serials-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SerialNumber: string
  Maximum Length: 80

  Serial number that identifies the item that this reservation uses. Applies when the warehouse places the item under serial control.

{
    "type":"object",
    "properties":{
        "SerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Serial number that identifies the item that this reservation uses. Applies when the warehouse places the item under serial control.",
            "nullable":false,
            "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"
    }
}

Back to Top

Examples

This example describes how to get all reservations.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/?q=InventoryItemId=663997;OrganizationId=207;DemandSourceType='Sales order';SupplySourceType='On hand';DemandProjectNumber='zBI_Projinv-03'"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"items": [
	{
		"ReservationId": 2634085,
		"OrganizationId": 207,
		"OrganizationCode": "M1",
		"InventoryItemId": 663997,
		"ItemNumber": "VC110",
		"DemandSourceTypeId": 2,
		"DemandSourceType": "Sales order",
		"DemandSourceHeaderId": 502091,
		"DemandSourceHeaderNumber": "SG-SO-91219-10",
		"DemandSourceName": null,
		"DemandSourceLineId": 3774397,
		"DemandSourceLineNumber": "4",
		"SourceFulfillmentLineId": 1004,
		"SupplySourceTypeId": 13,
		"SupplySourceType": "On hand",
		"SupplySourceHeaderId": null,
		"SupplySourceHeaderNumber": null,
		"SupplySourceLineId": null,
		"SupplySourceLineNumber": null,
		"Revision": null,
		"SubinventoryCode": null,
		"SubinventoryId": null,
		"LotNumber": null,
		"LocatorId": null,
		"Locator": null,
		"PrimaryReservationQuantity": 1,
		"PrimaryUOMCode": "Ea",
		"PrimaryUnitOfMeasure": "Each",
		"SecondaryReservationQuantity": null,
		"SecondaryUOMCode": null,
		"SecondaryUnitOfMeasure": null,
		"ReservationQuantity": 1,
		"ReservationUOMCode": "Ea",
		"ReservationUnitOfMeasure": "Each",
		"ShipToCustomer": null,
		"ShipToPartyId": null,
		"RequirementDate": "2019-12-09",
		"SupplyProjectId": 100000015107659,
		"SupplyTaskId": 100000015107691,
		"DemandProjectId": 100000015107659,
		"DemandTaskId": 100000015107691,
		"DemandProjectNumber": "zBI_Projinv-03",
		"DemandTaskNumber": "1.1",
		"SupplyProjectNumber": "zBI_Projinv-03",
		"SupplyTaskNumber": "1.1",
		"SourceFulfillmentLineNumber": "4",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inventoryReservations/2634085",
			"name": "inventoryReservations",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inventoryReservations/2634085",
			"name": "inventoryReservations",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inventoryReservations/2634085/child/serials",
			"name": "serials",
			"kind": "collection"
		}
		]
	},
	{
		"ReservationId": 2634096,
		"OrganizationId": 207,
		"OrganizationCode": "M1",
		"InventoryItemId": 663997,
		"ItemNumber": "VC110",
		"DemandSourceTypeId": 2,
		"DemandSourceType": "Sales order",
		"DemandSourceHeaderId": 502092,
		"DemandSourceHeaderNumber": "SG-SO-91219-11",
		"DemandSourceName": null,
		"DemandSourceLineId": 3774401,
		"DemandSourceLineNumber": "4",
		"SourceFulfillmentLineId": null,
		"SupplySourceTypeId": 13,
		"SupplySourceType": "On hand",
		"SupplySourceHeaderId": null,
		"SupplySourceHeaderNumber": null,
		"SupplySourceLineId": null,
		"SupplySourceLineNumber": null,
		"Revision": "A",
		"SubinventoryCode": "Stores",
		"SubinventoryId": 4738,
		"LotNumber": "SGL7",
		"LocatorId": null,
		"Locator": null,
		"PrimaryReservationQuantity": 4,
		"PrimaryUOMCode": "Ea",
		"PrimaryUnitOfMeasure": "Each",
		"SecondaryReservationQuantity": null,
		"SecondaryUOMCode": null,
		"SecondaryUnitOfMeasure": null,
		"ReservationQuantity": 4,
		"ReservationUOMCode": "Ea",
		"ReservationUnitOfMeasure": "Each",
		"ShipToCustomer": null,
		"ShipToPartyId": null,
		"RequirementDate": "2019-12-09",
		"SupplyProjectId": 100000015107659,
		"SupplyTaskId": 100000015107691,
		"DemandProjectId": 100000015107659,
		"DemandTaskId": 100000015107691,
		"DemandProjectNumber": "zBI_Projinv-03",
		"DemandTaskNumber": "1.1",
		"SupplyProjectNumber": "zBI_Projinv-03",
		"SupplyTaskNumber": "1.1",
		"SourceFulfillmentLineNumber": null,
		"links": [
		...
		]
	}
	

Back to Top