REST API for Oracle Fusion Cloud SCM

Update one locator item

patch

/fscmRestApi/resources/11.13.18.05/locatorItems/{LocatorItemId}

Request

Path Parameters

LocatorItemId(required): integer(int64)

Value that uniquely identifies the locator item.

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.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

CountRequired: string

Title: Count Required

Maximum Length: 1

Contains one of the following values. 1: The application requires counting during periodic automatic replenishment for the item in the locator. 2: The application doesn't require this counting. There is no default value for this attribute.
DefaultCountType: string

Maximum Length: 255

Type of periodic automatic replenishment. A list of accepted values is defined in the lookup type INV_DEFAULT_REPLEN_COUNT_TYPE. The default value is Order par.
DefaultCountTypeCode: string

Title: Replenishment Count Type

Maximum Length: 30

Abbreviation that identifies the type of periodic automatic replenishment. A list of accepted values is defined in the lookup type INV_DEFAULT_REPLEN_COUNT_TYPE. The default value is 4.
onhandQuantity: array On-Hand Quantities

Title: On-Hand Quantities

The On-Hand Quantities resource provides the on-hand quantities for the items associated with a locator in a subinventory in their primary unit of measure.
ParLevel: number

Title: PAR Level

Level that the application uses during periodic automatic replenishment for the locator item.
ParMaximumQuantity: number

Title: PAR Maximum Quantity

Maximum quantity to use during periodic automatic replenishment.
ParUOMCode: string

Maximum Length: 3

Code that identifies the unit of measure to use for quantities during periodic automatic replenishment.
ParUOMMeasure: string

Title: PAR Level UOM

Unit of measure to use for quantities during periodic automatic replenishment.
QuantityCountTolerance: number

Title: Count Tolerance Percentage

Count tolerance percent to use before the application stops the count. This tolerance prevents data-entry mistakes when counting, and prevents ordering of more than necessary quantity for the replenishment request.

{
    "type":"object",
    "properties":{
        "ParLevel":{
            "title":"PAR Level",
            "type":"number",
            "description":"Level that the application uses during periodic automatic replenishment for the locator item.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            }
        },
        "DefaultCountType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of periodic automatic replenishment. A list of accepted values is defined in the lookup type INV_DEFAULT_REPLEN_COUNT_TYPE. The default value is Order par.",
            "nullable":true
        },
        "ParMaximumQuantity":{
            "title":"PAR Maximum Quantity",
            "type":"number",
            "description":"Maximum quantity to use during periodic automatic replenishment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            }
        },
        "ParUOMMeasure":{
            "title":"PAR Level UOM",
            "type":"string",
            "description":"Unit of measure to use for quantities during periodic automatic replenishment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "ParUOMCode",
                    "SubinventoryCode"
                ]
            }
        },
        "ParUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Code that identifies the unit of measure to use for quantities during periodic automatic replenishment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            }
        },
        "QuantityCountTolerance":{
            "title":"Count Tolerance Percentage",
            "type":"number",
            "description":"Count tolerance percent to use before the application stops the count. This tolerance prevents data-entry mistakes when counting, and prevents ordering of more than necessary quantity for the replenishment request.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            }
        },
        "CountRequired":{
            "title":"Count Required",
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values. 1: The application requires counting during periodic automatic replenishment for the item in the locator. 2: The application doesn't require this counting. There is no default value for this attribute.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            }
        },
        "DefaultCountTypeCode":{
            "title":"Replenishment Count Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of periodic automatic replenishment. A list of accepted values is defined in the lookup type INV_DEFAULT_REPLEN_COUNT_TYPE. The default value is 4.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"INV_DEFAULT_REPLEN_COUNT_TYPE",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0",
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            }
        },
        "onhandQuantity":{
            "title":"On-Hand Quantities",
            "type":"array",
            "description":"The On-Hand Quantities resource provides the on-hand quantities for the items associated with a locator in a subinventory in their primary unit of measure.",
            "items":{
                "$ref":"#/components/schemas/locatorItems-onhandQuantity-item-patch-request"
            }
        }
    }
}

Nested Schema : On-Hand Quantities

Type: array

Title: On-Hand Quantities

The On-Hand Quantities resource provides the on-hand quantities for the items associated with a locator in a subinventory in their primary unit of measure.

Show Source

Array of: object locatorItems-onhandQuantity-item-patch-request

{
    "title":"On-Hand Quantities",
    "type":"array",
    "description":"The On-Hand Quantities resource provides the on-hand quantities for the items associated with a locator in a subinventory in their primary unit of measure.",
    "items":{
        "$ref":"#/components/schemas/locatorItems-onhandQuantity-item-patch-request"
    }
}

Nested Schema : locatorItems-onhandQuantity-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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.

Root Schema : locatorItems-item-response

Type: object

Show Source

CountRequired: string

Title: Count Required

Maximum Length: 1

Contains one of the following values. 1: The application requires counting during periodic automatic replenishment for the item in the locator. 2: The application doesn't require this counting. There is no default value for this attribute.
CreationDate: string (date-time)

Read Only: true

Date when the user created the locator item record.
DefaultCountType: string

Maximum Length: 255

Type of periodic automatic replenishment. A list of accepted values is defined in the lookup type INV_DEFAULT_REPLEN_COUNT_TYPE. The default value is Order par.
DefaultCountTypeCode: string

Title: Replenishment Count Type

Maximum Length: 30

Abbreviation that identifies the type of periodic automatic replenishment. A list of accepted values is defined in the lookup type INV_DEFAULT_REPLEN_COUNT_TYPE. The default value is 4.
InventoryItemId: integer (int64)

Value that uniquely identifies the item.
ItemDescription: string

Title: Item Description

Read Only: true

Maximum Length: 240

Value that identifies the description of the item associated with a locator in a subinventory.
ItemNumber: string

Maximum Length: 255

Name of the inventory item.
ItemPrimaryImageURL: string

Title: Primary Image URL

Read Only: true

Maximum Length: 4000

Value that provides a reference to the image of the item for which the count sequence is generated.
links: array Links

Title: Links

The link relations associated with the resource instance.
LocatorDescription: string

Title: Description

Read Only: true

Maximum Length: 50

Description of the locator that references the locator item.
LocatorId: integer (int64)

Title: Locator

Value that uniquely identifies the locator.
LocatorItemId: integer (int64)

Read Only: true

Value that uniquely identifies the locator item.
LocatorName: string

Maximum Length: 255

Name of the locator that references the locator item.
onhandQuantity: array On-Hand Quantities

Title: On-Hand Quantities

The On-Hand Quantities resource provides the on-hand quantities for the items associated with a locator in a subinventory in their primary unit of measure.
OrganizationCode: string

Maximum Length: 255

Abbreviation that identifies the organization that references the locator item.
OrganizationId: integer (int64)

Value that uniquely identifies the inventory organization.
ParLevel: number

Title: PAR Level

Level that the application uses during periodic automatic replenishment for the locator item.
ParMaximumQuantity: number

Title: PAR Maximum Quantity

Maximum quantity to use during periodic automatic replenishment.
ParUOMCode: string

Maximum Length: 3

Code that identifies the unit of measure to use for quantities during periodic automatic replenishment.
ParUOMMeasure: string

Title: PAR Level UOM

Unit of measure to use for quantities during periodic automatic replenishment.
QuantityCountTolerance: number

Title: Count Tolerance Percentage

Count tolerance percent to use before the application stops the count. This tolerance prevents data-entry mistakes when counting, and prevents ordering of more than necessary quantity for the replenishment request.
SubinventoryCode: string

Maximum Length: 10

Abbreviation that identifies the subinventory.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the locator item record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParLevel":{
            "title":"PAR Level",
            "type":"number",
            "description":"Level that the application uses during periodic automatic replenishment for the locator item.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        },
        "DefaultCountType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of periodic automatic replenishment. A list of accepted values is defined in the lookup type INV_DEFAULT_REPLEN_COUNT_TYPE. The default value is Order par.",
            "nullable":true,
            "x-queryable":true
        },
        "LocatorItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ParMaximumQuantity":{
            "title":"PAR Maximum Quantity",
            "type":"number",
            "description":"Maximum quantity to use during periodic automatic replenishment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies 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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocatorDescription":{
            "title":"Description",
            "maxLength":50,
            "type":"string",
            "description":"Description of the locator that references the locator item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"edit",
                "precision":18
            },
            "x-queryable":true
        },
        "SubinventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the subinventory.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies the description of the item associated with a locator in a subinventory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultCountTypeCode":{
            "title":"Replenishment Count Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of periodic automatic replenishment. A list of accepted values is defined in the lookup type INV_DEFAULT_REPLEN_COUNT_TYPE. The default value is 4.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"INV_DEFAULT_REPLEN_COUNT_TYPE",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0",
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        },
        "LocatorName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the locator that references the locator item.",
            "nullable":true,
            "x-queryable":true
        },
        "onhandQuantity":{
            "title":"On-Hand Quantities",
            "type":"array",
            "description":"The On-Hand Quantities resource provides the on-hand quantities for the items associated with a locator in a subinventory in their primary unit of measure.",
            "items":{
                "$ref":"#/components/schemas/locatorItems-onhandQuantity-item-response"
            }
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the inventory item.",
            "nullable":true,
            "x-queryable":true
        },
        "ParUOMMeasure":{
            "title":"PAR Level UOM",
            "type":"string",
            "description":"Unit of measure to use for quantities during periodic automatic replenishment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "ParUOMCode",
                    "SubinventoryCode"
                ]
            }
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization that references the locator item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Code that identifies the unit of measure to use for quantities during periodic automatic replenishment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        },
        "ItemPrimaryImageURL":{
            "title":"Primary Image URL",
            "maxLength":4000,
            "type":"string",
            "description":"Value that provides a reference to the image of the item for which the count sequence is generated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuantityCountTolerance":{
            "title":"Count Tolerance Percentage",
            "type":"number",
            "description":"Count tolerance percent to use before the application stops the count. This tolerance prevents data-entry mistakes when counting, and prevents ordering of more than necessary quantity for the replenishment request.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        },
        "CountRequired":{
            "title":"Count Required",
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values. 1: The application requires counting during periodic automatic replenishment for the item in the locator. 2: The application doesn't require this counting. There is no default value for this attribute.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : On-Hand Quantities

Type: array

Title: On-Hand Quantities

The On-Hand Quantities resource provides the on-hand quantities for the items associated with a locator in a subinventory in their primary unit of measure.

Show Source

Array of: object locatorItems-onhandQuantity-item-response

{
    "title":"On-Hand Quantities",
    "type":"array",
    "description":"The On-Hand Quantities resource provides the on-hand quantities for the items associated with a locator in a subinventory in their primary unit of measure.",
    "items":{
        "$ref":"#/components/schemas/locatorItems-onhandQuantity-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 : locatorItems-onhandQuantity-item-response

Type: object

Show Source

links: array Links

Title: Links

The link relations associated with the resource instance.
PrimaryOnhandQuantity: number

Read Only: true

Value that identifies the on-hand quantity for an item in a subinventory in its primary unit of measure.
PrimaryUnitOfMeasure: string

Read Only: true

Maximum Length: 25

Value that identifies the unit of measure for an item associated with a subinventory.
PrimaryUOMCode: string

Read Only: true

Maximum Length: 3

Value that identifies the unit of measure code for an item associated with a subinventory.

{
    "type":"object",
    "properties":{
        "PrimaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Value that identifies the unit of measure code for an item associated with a subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryUnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Value that identifies the unit of measure for an item associated with a subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryOnhandQuantity":{
            "type":"number",
            "description":"Value that identifies the on-hand quantity for an item in a subinventory in its primary unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Links

onhandQuantity

Operation: /fscmRestApi/resources/11.13.18.05/locatorItems/{LocatorItemId}/child/onhandQuantity

Parameters:

LocatorItemId: $request.path.LocatorItemId

The On-Hand Quantities resource provides the on-hand quantities for the items associated with a locator in a subinventory in their primary unit of measure.

Examples

This example describes how to update one locator item.

Example cURL Command

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

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

Example 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 updates.

{
    "ParLevel": 10,
    "ParMaximumQuantity": 100,
    "ParUOMCode": "Ea",
    "ParUOMMeasure": "Each",
    "CountRequired": "1",
    "DefaultCountTypeCode": "1"
}

Example Response Body

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

{
    "InventoryItemId": 663913,
    "LocatorItemId": 300100568127374,
    "OrganizationId": 207,
    "OrganizationCode": "M1",
    "LocatorId": 300100568126095,
    "LocatorName": "1.1.1",
    "SubinventoryCode": "AALOCSUB1",
    "ItemNumber": "INV-100",
    "ParLevel": 10,
    "ParMaximumQuantity": 100,
    "ParUOMCode": "Ea",
    "ParUOMMeasure": "Each",
    "CountRequired": "1",
    "DefaultCountTypeCode": "1"
    "QuantityCountTolerance": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/locatorItems/300100568127374",
            "name": "locatorItems",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/locatorItems/300100568127374",
            "name": "locatorItems",
            "kind": "item"
        }
    ]
}