Jump to

• Request
• Response
• Examples

Create locators

post

/fscmRestApi/resources/11.13.18.05/subinventories/{subinventoriesUniqID}/child/locators/{InventoryLocationId}/child/itemLocators

Request

Path Parameters

• InventoryLocationId(required): integer(int64)
  Value that uniquely identifies the locator.
• subinventoriesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- OrganizationId and SecondaryInventoryName ---for the Subinventories resource and used to uniquely identify an instance of Subinventories. The client should not generate the hash key value. Instead, the client should query on the Subinventories collection resource with a filter on the primary key values in order to navigate to a specific instance of Subinventories.
  
  For example: subinventories?q=OrganizationId=<value1>;SecondaryInventoryName=<value2>

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

• 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 isn't a default value for this attribute.
• DefaultCountType: string
  Maximum Length: 255

  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 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.
• ItemNumber: string
  Maximum Length: 255

  Name of the inventory item.
• LastReplenishedDate: string (date-time)
  Date when the item was last replenished for a locator during par counting.
• LocatorId: integer (int64)
  Title: Locator

  Value that uniquely identifies the locator.
• LocatorName: string
  Maximum Length: 255

  Name of the locator that references the locator item.
• OrganizationCode: string
  Maximum Length: 255

  Abbreviation that identifies the organization that references the item locator.
• 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 item locator.
• 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 doesn't allow the count. This tolerance prevents data entry mistakes when counting, and prevents ordering too much quantity for the replenishment request.
• SubinventoryCode: string
  Maximum Length: 10

  Abbreviation that identifies the subinventory.

{
    "type":"object",
    "properties":{
        "ParLevel":{
            "title":"PAR Level",
            "type":"number",
            "description":"Level that the application uses during periodic-automatic replenishment for the item locator.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            }
        },
        "DefaultCountType":{
            "maxLength":"255",
            "type":"string",
            "description":"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 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"
                ]
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the Item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LocatorId":{
            "title":"Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastReplenishedDate":{
            "type":"string",
            "description":"Date when the item was last replenished for a locator during par counting.",
            "format":"date-time",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"edit",
                "precision":"18"
            }
        },
        "SubinventoryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Abbreviation that identifies the subinventory.",
            "nullable":false
        },
        "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"
                ]
            }
        },
        "LocatorName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the  locator that references the locator item.",
            "nullable":true
        },
        "ItemNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the inventory item.",
            "nullable":true
        },
        "ParUOMMeasure":{
            "title":"PAR Level UOM",
            "type":"string",
            "description":"Unit of measure to use for quantities during periodic-automatic replenishment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "ParUOMCode",
                    "SubinventoryCode"
                ]
            }
        },
        "OrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the organization that references the item locator.",
            "nullable":true
        },
        "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 doesn't allow the count. This tolerance prevents data entry mistakes when counting, and prevents ordering too much 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 isn't a default value for this attribute.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : subinventories-locators-itemLocators-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 isn't a default value for this attribute.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the item locator record.
• DefaultCountType: string
  Maximum Length: 255

  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 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.
• LastReplenishedDate: string (date-time)
  Date when the item was last replenished for a locator during par counting.
• 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 item locator.
• LocatorName: string
  Maximum Length: 255

  Name of the locator that references the locator item.
• OrganizationCode: string
  Maximum Length: 255

  Abbreviation that identifies the organization that references the item locator.
• 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 item locator.
• 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 doesn't allow the count. This tolerance prevents data entry mistakes when counting, and prevents ordering too much 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 item locator 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 item locator.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        },
        "DefaultCountType":{
            "maxLength":"255",
            "type":"string",
            "description":"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 Order par.",
            "nullable":true,
            "x-queryable":true
        },
        "LocatorItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item locator.",
            "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
        },
        "LastReplenishedDate":{
            "type":"string",
            "description":"Date when the item was last replenished for a locator during par counting.",
            "format":"date-time",
            "nullable":true,
            "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
        },
        "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-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "ParUOMCode",
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the organization that references the item locator.",
            "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 doesn't allow the count. This tolerance prevents data entry mistakes when counting, and prevents ordering too much 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 isn't a 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 : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to create item locators in one locator in one subinventory.

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.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/subinventories/subinventoriesUniqID/child/locators/locatorsUniqID/child/itemLocators"

For example, the following command creates item locators in locator 3139 in subinventory 00020000000EACED0005770800000000000000CF000000084142435355423031:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/3139/child/itemLocators"

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 creates.

{
  "ItemNumber" : "MFG-SER-LOT-REV-LOC-COMP1",
  "ParLevel" : null,
  "ParMaximumQuantity" : null,
  "ParUOMMeasure" : null
}

Example Response Body

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

{
    "InventoryItemId": 300100039626658,
    "SubinventoryCode": "ABCSUB01",
    "ItemNumber": "MFG-SER-LOT-REV-LOC-COMP1",
    "ParLevel": null,
    "ParMaximumQuantity": null,
    "ParUOMMeasure": "Each",
    "CountRequired": null,
    "DefaultCountTypeCode": "2",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/3139/child/itemLocators/300100132043100",
            "name": "itemLocators",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/3139/child/itemLocators/300100132043100",
            "name": "itemLocators",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/3139",
            "name": "locators",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/3139/child/itemLocators/300100132043100/lov/DefaultCountTypeCodeLov",
            "name": "DefaultCountTypeCodeLov",
            "kind": "collection"
        }
    ]
}

Back to Top