Jump to

• Request
• Response
• Examples

Create all reservations

post

/fscmRestApi/resources/11.13.18.05/inventoryReservations

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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(required): 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(required): 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.
• 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(required): 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(required): 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.
• 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(required): 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.

{
    "required":[
        "DemandSourceTypeId",
        "InventoryItemId",
        "OrganizationId",
        "ReservationQuantity",
        "SupplySourceTypeId"
    ],
    "type":"object",
    "properties":{
        "DemandProjectNumber":{
            "type":"string",
            "description":"Number that identifies the project for the demand document.",
            "nullable":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-post-request"
            }
        },
        "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
        },
        "SupplyTaskNumber":{
            "type":"string",
            "description":"Number that identifies the task corresponding to a project for the supply document.",
            "nullable":true
        },
        "SourceFulfillmentLineId":{
            "type":"integer",
            "description":"Value that order orchestration uses to uniquely identify the reservation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SecondaryUnitOfMeasure":{
            "type":"string",
            "description":"Secondary unit of measure of the item.",
            "nullable":true
        },
        "SupplyProjectNumber":{
            "type":"string",
            "description":"Number that identifies the project for the supply document.",
            "nullable":true
        },
        "DemandSourceLineNumber":{
            "type":"string",
            "description":"Value that uniquely identifies the line number in the demand document.",
            "nullable":true
        },
        "SupplySourceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the line in the supply document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SupplyTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task corresponding to a project for the supply document.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SupplySourceTypeId"
                ]
            }
        },
        "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
            }
        },
        "ShipToPartyId":{
            "title":"Customer",
            "type":"integer",
            "description":"Value that uniquely identifies the party that receives the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DemandTaskNumber":{
            "type":"string",
            "description":"Number that identifies the task corresponding to a project for the demand document.",
            "nullable":true
        },
        "SubinventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Name of the subinventory that the warehouse uses to make the reservation.",
            "nullable":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
        },
        "DemandSourceName":{
            "title":"Demand Document Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of the source that requests the demand.",
            "nullable":true
        },
        "RequirementDate":{
            "type":"string",
            "description":"Date when the customer requires the item.",
            "format":"date",
            "nullable":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
            }
        },
        "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
        },
        "ItemNumber":{
            "type":"string",
            "description":"Number that identifies the inventory item.",
            "nullable":true
        },
        "DemandSourceHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReservationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reservation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "DemandSourceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReservationUnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure that the user chooses when placing a reservation.",
            "nullable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure.",
            "nullable":true
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the warehouse organization that reserves inventory to fulfill the item.",
            "nullable":true
        },
        "DemandProjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the project for the demand document.",
            "nullable":true
        },
        "SupplyProjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the project for the supply document.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SupplySourceTypeId"
                ]
            }
        },
        "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
        },
        "PrimaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the primary unit of measure.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId"
                ]
            }
        },
        "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
        },
        "DemandSourceHeaderNumber":{
            "type":"string",
            "description":"Document that specifies demand details for the item that the warehouse will reserve in inventory.",
            "nullable":true
        },
        "PrimaryReservationQuantity":{
            "title":"Reserved Quantity",
            "type":"number",
            "description":"Reserved quantity expressed in the primary unit of measure of the item.",
            "nullable":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
            }
        },
        "LocatorId":{
            "title":"Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the locator for the reservation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SupplySourceHeaderNumber":{
            "type":"string",
            "description":"Document that specifies supply details for the item.",
            "nullable":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
        },
        "PrimaryUnitOfMeasure":{
            "type":"string",
            "description":"Primary unit of measure of the item.",
            "nullable":true
        },
        "SupplySourceLineNumber":{
            "type":"string",
            "description":"Line number in the supply document.",
            "nullable":true
        },
        "SecondaryReservationQuantity":{
            "title":"Secondary Reserved Quantity",
            "type":"number",
            "description":"Reservation quantity expressed in the secondary unit of measure.",
            "nullable":true
        },
        "SupplySourceHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Revision":{
            "maxLength":18,
            "type":"string",
            "description":"Revision of the item. Applies when the warehouse places the item under revision control.",
            "nullable":true
        },
        "SourceFulfillmentLineNumber":{
            "type":"string",
            "description":"Number that identifies a line corresponding to a source fulfillment line.",
            "nullable":true
        },
        "ReservationQuantity":{
            "title":"Reserved Quantity",
            "type":"number",
            "description":"Reservation quantity expressed in the primary unit of measure.",
            "nullable":false
        },
        "SupplySourceTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of the supply document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OperationSequenceNumber":{
            "type":"string",
            "description":"Sequence number of a specific operation as defined in a work order.",
            "nullable":true
        },
        "DemandTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task corresponding to a project for the demand document.",
            "nullable":true
        }
    }
}

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-post-request

{
    "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-post-request"
    }
}

Nested Schema : inventoryReservations-serials-item-post-request

Type: object

Show Source

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

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : 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"
    }
}

Links

serials

Operation: /fscmRestApi/resources/11.13.18.05/inventoryReservations/{ReservationId}/child/serials

Parameters:

• ReservationId: $request.path.ReservationId

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.

Back to Top

Examples

This example describes how to create a reservation.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/inventoryReservations"

Example 1

This example describes how to create multiple reservations in a single input payload and reserve on-hand supply to a user-defined demand and an account alias demand.

Example 1 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
    "parts": [
        {
            "id": "part1",
            "path": "/inventoryReservations",
            "operation": "create",
            "payload": {
                "ItemNumber": "INV-311",
                "OrganizationId": 207,
                "DemandSourceType": "User Defined",
                "DemandSourceName": "RES1",
                "SupplySourceType": "On hand",
                "ReservationUnitOfMeasure": "Each",
                "SubinventoryCode": "Stores",
                "ReservationQuantity": 1,
                "serials": [
                    {
                        "SerialNumber": "140223013"
                    }
                ]
            }
        },
        {
            "id": "part2",
            "path": "/inventoryReservations",
            "operation": "create",
            "payload": {
                "ItemNumber": "INV-311",
                "OrganizationId": 207,
                "DemandSourceType": "Account alias",
                "DemandSourceHeaderNumber": "PUP_ACC1",
                "SupplySourceType": "On hand",
                "ReservationUnitOfMeasure": "Each",
                "SubinventoryCode": "Stores",
                "ReservationQuantity": 1,
                "serials": [
                    {
                        "SerialNumber": "140223014"
                    }
                ]
            }
        }
    ]
}

Example 1 Response Body

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

{
    "parts": [
        {
            "id": "part1",
            "path": "https://servername/fscmRestApi/resources/version/inventoryReservations",
            "operation": "create",
            "payload": {
                "ReservationId": 300100576819065,
                "OrganizationId": 207,
                "OrganizationCode": "M1",
                "InventoryItemId": 300100576778273,
                "ItemNumber": "INV-311",
                "DemandSourceTypeId": 13,
                "DemandSourceType": "User Defined",
                "DemandSourceHeaderId": null,
                "DemandSourceHeaderNumber": null,
                "DemandSourceName": "RES1",
                "DemandSourceLineId": null,
                "DemandSourceLineNumber": null,
                "SourceFulfillmentLineId": null,
                "SupplySourceTypeId": 13,
                "SupplySourceType": "On hand",
                "SupplySourceHeaderId": null,
                "SupplySourceHeaderNumber": null,
                "SupplySourceLineId": null,
                "SupplySourceLineNumber": null,
                "Revision": null,
                "SubinventoryCode": "Stores",
                "SubinventoryId": 4738,
                "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": "2023-02-14",
                "SupplyProjectId": null,
                "SupplyTaskId": null,
                "DemandProjectId": null,
                "DemandTaskId": null,
                "DemandProjectNumber": null,
                "DemandTaskNumber": null,
                "SupplyProjectNumber": null,
                "SupplyTaskNumber": null,
                "SourceFulfillmentLineNumber": null,
                "OperationSequenceNumber": null,
                "WorkOrderProductId": null,
                "WorkOrderProductNumber": null,
                "OrderInterfaceStatus": "Y",
                "serials": [
                    {
                        "SerialNumber": "140223013",
                        "links": [
                            {
                                "rel": "self",
                                "href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100576819065/child/serials/00030000000EACED00057708000110F09C469821000000093134303232333031330000000EACED0005770800000000000000CF",
                                "name": "serials",
                                "kind": "item"
                            },
                            {
                                "rel": "canonical",
                                "href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100576819065/child/serials/00030000000EACED00057708000110F09C469821000000093134303232333031330000000EACED0005770800000000000000CF",
                                "name": "serials",
                                "kind": "item"
                            },
                            {
                                "rel": "parent",
                                "href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100576819065",
                                "name": "inventoryReservations",
                                "kind": "item"
                            }
                        ]
                    }
                ],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100576819065",
                        "name": "inventoryReservations",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100576819065",
                        "name": "inventoryReservations",
                        "kind": "item"
                    },
                    {
                        "rel": "child",
                        "href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100576819065/child/serials",
                        "name": "serials",
                        "kind": "collection"
                    }
                ]
            }
        },
        {
            "id": "part2",
            "path": "https://servername/fscmRestApi/resources/version/inventoryReservations",
            "operation": "create",
            "payload": {
                "ReservationId": 300100576819066,
                "OrganizationId": 207,
                "OrganizationCode": "M1",
                "InventoryItemId": 300100576778273,
                "ItemNumber": "INV-311",
                "DemandSourceTypeId": 6,
                "DemandSourceType": "Account alias",
                "DemandSourceHeaderId": 175,
                "DemandSourceHeaderNumber": "PUP_ACC1",
                "DemandSourceName": null,
                "DemandSourceLineId": null,
                "DemandSourceLineNumber": null,
                "SourceFulfillmentLineId": null,
                "SupplySourceTypeId": 13,
                "SupplySourceType": "On hand",
                "SupplySourceHeaderId": null,
                "SupplySourceHeaderNumber": null,
                "SupplySourceLineId": null,
                "SupplySourceLineNumber": null,
                "Revision": null,
                "SubinventoryCode": "Stores",
                "SubinventoryId": 4738,
                "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": "2023-02-14",
                "SupplyProjectId": null,
                "SupplyTaskId": null,
                "DemandProjectId": null,
                "DemandTaskId": null,
                "DemandProjectNumber": null,
                "DemandTaskNumber": null,
                "SupplyProjectNumber": null,
                "SupplyTaskNumber": null,
                "SourceFulfillmentLineNumber": null,
                "OperationSequenceNumber": null,
                "WorkOrderProductId": null,
                "WorkOrderProductNumber": null,
                "OrderInterfaceStatus": "Y",
                "serials": [
                    {
                        "SerialNumber": "140223014",
                        "links": [
                            {
                                "rel": "self",
                                "href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100576819066/child/serials/00030000000EACED00057708000110F09C469821000000093134303232333031340000000EACED0005770800000000000000CF",
                                "name": "serials",
                                "kind": "item"
                            },
                            {
                                "rel": "canonical",
                                "href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100576819066/child/serials/00030000000EACED00057708000110F09C469821000000093134303232333031340000000EACED0005770800000000000000CF",
                                "name": "serials",
                                "kind": "item"
                            },
                            {
                                "rel": "parent",
                                "href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100576819066",
                                "name": "inventoryReservations",
                                "kind": "item"
                            }
                        ]
                    }
                ],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100576819066",
                        "name": "inventoryReservations",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100576819066",
                        "name": "inventoryReservations",
                        "kind": "item"
                    },
                    {
                        "rel": "child",
                        "href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100576819066/child/serials",
                        "name": "serials",
                        "kind": "collection"
                    }
                ]
            }
        }
    ]
}

Example 2

This example describes how to create reservations for a sales order, which isn't interfaced to shipping, to a purchase order.

Example 2 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
    "ItemNumber": "INV-310",
    "OrganizationId": 207,
    "DemandSourceType": "Sales Order",
    "DemandSourceHeaderNumber": "522658",
    "DemandSourceLineNumber": "300100576827327",
    "SupplySourceType": "Purchase order",
    "SupplySourceHeaderNumber": "1006777",
    "SupplySourceLineNumber": "1",
    "ReservationUnitOfMeasure": "Each",
    "ReservationQuantity": 10
}

Example 2 Response Body

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

{
  "ReservationId" : 300100576830685,
  "OrganizationId" : 207,
  "OrganizationCode" : "M1",
  "InventoryItemId" : 300100576778208,
  "ItemNumber" : "INV-310",
  "DemandSourceTypeId" : 2,
  "DemandSourceType" : "Sales Order",
  "DemandSourceHeaderId" : 650709,
  "DemandSourceHeaderNumber" : "522658",
  "DemandSourceName" : null,
  "DemandSourceLineId" : 300100576827327,
  "DemandSourceLineNumber" : "300100576827327",
  "SourceFulfillmentLineId" : 300100576827327,
  "SupplySourceTypeId" : 1,
  "SupplySourceType" : "Purchase order",
  "SupplySourceHeaderId" : 300100576827529,
  "SupplySourceHeaderNumber" : "1006777",
  "SupplySourceLineId" : 300100576829619,
  "SupplySourceLineNumber" : "1",
  "Revision" : null,
  "SubinventoryCode" : null,
  "SubinventoryId" : null,
  "LotNumber" : null,
  "LocatorId" : null,
  "Locator" : null,
  "PrimaryReservationQuantity" : 10,
  "PrimaryUOMCode" : "Ea",
  "PrimaryUnitOfMeasure" : "Each",
  "SecondaryReservationQuantity" : null,
  "SecondaryUOMCode" : null,
  "SecondaryUnitOfMeasure" : null,
  "ReservationQuantity" : 10,
  "ReservationUOMCode" : "Ea",
  "ReservationUnitOfMeasure" : "Each",
  "ShipToCustomer" : null,
  "ShipToPartyId" : null,
  "RequirementDate" : "2023-02-14",
  "SupplyProjectId" : null,
  "SupplyTaskId" : null,
  "DemandProjectId" : null,
  "DemandTaskId" : null,
  "DemandProjectNumber" : null,
  "DemandTaskNumber" : null,
  "SupplyProjectNumber" : null,
  "SupplyTaskNumber" : null,
  "SourceFulfillmentLineNumber" : null,
  "OperationSequenceNumber" : null,
  "WorkOrderProductId" : null,
  "WorkOrderProductNumber" : null,
  "OrderInterfaceStatus" : "N",
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/inventoryReservations/300100576830685",
    "name" : "inventoryReservations",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/inventoryReservations/300100576830685",
    "name" : "inventoryReservations",
    "kind" : "item"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/inventoryReservations/300100576830685/child/serials",
    "name" : "serials",
    "kind" : "collection"
  } ]
}

Example 3

This example describes how to reserve a specific serial number for a user-defined demand.

Example 3 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"InventoryItemId":300100036689391,
	"OrganizationId":207,
	"DemandSourceType":  "User Defined",
	"DemandSourceName": "PUP_ACC",
	"SupplySourceType":"On hand",
	"ReservationUnitOfMeasure":"Each",
	"SubinventoryCode": "ABCSUB01",
	"ReservationQuantity":1,
	"serials": [ {
		"SerialNumber": "PS6501"
	}]
}

Example 3 Response Body

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

{
	"ReservationId": 300100187201924,
	"OrganizationId": 207,
	"OrganizationCode": "M1",
	"InventoryItemId": 300100036689391,
	"ItemNumber": "MFG-SER-COMP1",
	"DemandSourceTypeId": 13,
	"DemandSourceType": "User Defined",
	"DemandSourceHeaderId": null,
	"DemandSourceHeaderNumber": null,
	"DemandSourceName": "PUP_ACC",
	"DemandSourceLineId": null,
	"DemandSourceLineNumber": null,
	"SourceFulfillmentLineId": null,
	"SupplySourceTypeId": 13,
	"SupplySourceType": "On hand",
	"SupplySourceHeaderId": null,
	"SupplySourceHeaderNumber": null,
	"SupplySourceLineId": null,
	"SupplySourceLineNumber": null,
	"Revision": null,
	"SubinventoryCode": "ABCSUB01",
	"SubinventoryId": 5161,
	"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-10",
	"SupplyProjectId": null,
	"SupplyTaskId": null,
	"DemandProjectId": null,
	"DemandTaskId": null,
	"DemandProjectNumber": null,
	"DemandTaskNumber": null,
	"SupplyProjectNumber": null,
	"SupplyTaskNumber": null,
	"SourceFulfillmentLineNumber": null,
	"serials": [
	{
		"SerialNumber": "PS6501",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100187201924/child/serials/00030000000EACED00057708000110F07C157DEF000000065053363530310000000EACED0005770800000000000000CF",
			"name": "serials",
			"kind": "item"
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100187201924/child/serials/00030000000EACED00057708000110F07C157DEF000000065053363530310000000EACED0005770800000000000000CF",
			"name": "serials",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100187201924",
			"name": "inventoryReservations",
			"kind": "item"
		}
		]
	}
	],
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100187201924",
		"name": "inventoryReservations",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100187201924",
		"name": "inventoryReservations",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100187201924/child/serials",
		"name": "serials",
		"kind": "collection"
	}
	]
}

Example 4

This example describes how to reserve project on-hand supply to an account alias demand.

Example 4 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"ItemNumber":"AS54888",
	"OrganizationId":207,
	"DemandSourceType":  "Account alias",
	"DemandSourceHeaderNumber": "PUP_ACC",
	"DemandSourceLineNumber":null ,
	"SupplySourceType":"On hand",
	"ReservationUnitOfMeasure":"Each",
	"ReservationQuantity":2,
	"SupplyProjectId":2255,
	"SupplyTaskId":3039
}

Example 4 Response Body

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

{
	"ReservationId": 300100187185978,
	"OrganizationId": 207,
	"OrganizationCode": "M1",
	"InventoryItemId": 149,
	"ItemNumber": "AS54888",
	"DemandSourceTypeId": 6,
	"DemandSourceType": "Account alias",
	"DemandSourceHeaderId": 173,
	"DemandSourceHeaderNumber": "PUP_ACC",
	"DemandSourceName": null,
	"DemandSourceLineId": null,
	"DemandSourceLineNumber": null,
	"SourceFulfillmentLineId": null,
	"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": 2,
	"PrimaryUOMCode": "Ea",
	"PrimaryUnitOfMeasure": "Each",
	"SecondaryReservationQuantity": null,
	"SecondaryUOMCode": null,
	"SecondaryUnitOfMeasure": null,
	"ReservationQuantity": 2,
	"ReservationUOMCode": "Ea",
	"ReservationUnitOfMeasure": "Each",
	"ShipToCustomer": null,
	"ShipToPartyId": null,
	"RequirementDate": "2019-12-10",
	"SupplyProjectId": 2255,
	"SupplyTaskId": 3039,
	"DemandProjectId": null,
	"DemandTaskId": null,
	"DemandProjectNumber": null,
	"DemandTaskNumber": null,
	"SupplyProjectNumber": "ABC",
	"SupplyTaskNumber": "1.1",
	"SourceFulfillmentLineNumber": null,
	"links": [
	...
}

Example 5

This example describes how to reserve on-hand supply to a sales order demand.

Example 5 Request Body

The following example includes the contents of the request body in JSON format to reserve against a sales order. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{ 
	"OrganizationId": 207, 
	"OrganizationCode": null, 
	"InventoryItemId": 149, 
	"ItemNumber": null, 
	"DemandSourceTypeId": 2, 
	"DemandSourceType": null, 
	"DemandSourceHeaderId": 1212021, 
	"DemandSourceHeaderNumber": null, 
	"DemandSourceName": null, 
	"DemandSourceLineId": 1, 
	"DemandSourceLineNumber": null, 
	"SourceFulfillmentLineId": null, 
	"SupplySourceTypeId": 13, 
	"SupplySourceType": "On hand", 
	"SupplySourceHeaderId": null, 
	"SupplySourceHeaderNumber": null, 
	"SupplySourceLineId": null, 
	"SupplySourceLineNumber": null, 
	"Revision": null, 
	"SubinventoryCode": "FGI", 
	"SubinventoryId": null, 
	"LotNumber": null, 
	"LocatorId": null, 
	"Locator": null, 
	"PrimaryUOMCode": null, 
	"PrimaryUnitOfMeasure": null, 
	"ReservationQuantity": 1, 
	"ReservationUOMCode": "Ea", 
	"ReservationUnitOfMeasure": null, 
	"RequirementDate": "2021-09-03" 
}

Example 5 Response Body

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

{ 
	"ReservationId": 300100187245415, 
	"OrganizationId": 207, 
	"OrganizationCode": "M1", 
	"InventoryItemId": 149, 
	"ItemNumber": "AS54888", 
	"DemandSourceTypeId": 2, 
	"DemandSourceType": "Sales order", 
	"DemandSourceHeaderId": 1212021, 
	"DemandSourceHeaderNumber": null, 
	"DemandSourceName": null, 
	"DemandSourceLineId": 1, 
	"DemandSourceLineNumber": null, 
	"SourceFulfillmentLineId": null, 
	"SupplySourceTypeId": 13, 
	"SupplySourceType": "On hand", 
	"SupplySourceHeaderId": null, 
	"SupplySourceHeaderNumber": null, 
	"SupplySourceLineId": null, 
	"SupplySourceLineNumber": null, 
	"Revision": null, 
	"SubinventoryCode": "FGI", 
	"SubinventoryId": 4745, 
	"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": "2021-09-03", 
	"SupplyProjectId": null, 
	"SupplyTaskId": null, 
	"DemandProjectId": null, 
	"DemandTaskId": null, 
	"DemandProjectNumber": null, 
	"DemandTaskNumber": null, 
	"SupplyProjectNumber": null, 
	"SupplyTaskNumber": null, 
	"SourceFulfillmentLineNumber": null, 
	"OperationSequenceNumber": null, 
	"WorkOrderProductId": null, 
	"WorkOrderProductNumber": null, 
	"OrderInterfaceStatus": null, 
	"links": [ 
	{ 
		"rel": "self", 
		"href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100187245415", 
		"name": "inventoryReservations", 
		"kind": "item", 
		"properties": { 
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" 
		} 
	}, 
	{ 
		"rel": "canonical", 
		"href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100187245415", 
		"name": "inventoryReservations", 
		"kind": "item" 
	}, 
	{ 
		"rel": "child", 
		"href": "https://servername/fscmRestApi/resources/version/inventoryReservations/300100187245415/child/serials", 
		"name": "serials", 
		"kind": "collection" 
	} 
	] 
}

Back to Top