Jump to

• Request
• Response
• Examples

Update one locator

patch

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

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 50

  Description of the locator.
• DisableDate: string (date)
  Title: End Date

  Date when the locator is disabled for use in the application.
• InventoryLocationType: string
  Title: Type

  Maximum Length: 30

  Value that identifies the locator type. A list of accepted values is defined in the lookup type INV_LOCATOR_TYPES.
• InventoryLocationTypeMeaning: string
  Maximum Length: 255

  Value of the locator type.
• itemLocators: array Item Locators
  Title: Item Locators

  The Item Locators resource manages operations on item locators.
• locatorsDFF: array Flexfields for Locators
  Title: Flexfields for Locators

  Descriptive flexfields that contain details about locators.
• locatorsKeyFlex: array Flexfields for Locator Keys
  Title: Flexfields for Locator Keys

  Flexfields that contain details about locator keys.
• MaterialStatusCode: string
  Maximum Length: 255

  Abbreviation that identifies the material status that references the locator.
• MaterialStatusId: integer (int64)
  Title: Status

  Value that uniquely identifies the material status that references the locator.
• PickingOrder: number
  Title: Picking Order

  Picking order for the locator.

{
    "type":"object",
    "properties":{
        "MaterialStatusCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the material status that references the locator.",
            "nullable":true
        },
        "PickingOrder":{
            "title":"Picking Order",
            "type":"number",
            "description":"Picking order for the locator.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the locator.",
            "nullable":true
        },
        "locatorsDFF":{
            "title":"Flexfields for Locators",
            "type":"array",
            "description":"Descriptive flexfields that contain details about locators.",
            "items":{
                "$ref":"#/components/schemas/subinventories-locators-locatorsDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "itemLocators":{
            "title":"Item Locators",
            "type":"array",
            "description":"The Item Locators resource manages operations on item locators.",
            "items":{
                "$ref":"#/components/schemas/subinventories-locators-itemLocators-item-patch-request"
            }
        },
        "InventoryLocationType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the locator type. A list of accepted values is defined in the lookup type INV_LOCATOR_TYPES.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MaterialStatusId":{
            "title":"Status",
            "type":"integer",
            "description":"Value that uniquely identifies the material status that references the locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DisableDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the locator is disabled for use in the application.",
            "format":"date",
            "nullable":true
        },
        "InventoryLocationTypeMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the locator type.",
            "nullable":true
        },
        "locatorsKeyFlex":{
            "title":"Flexfields for Locator Keys",
            "type":"array",
            "description":"Flexfields that contain details about locator keys.",
            "items":{
                "$ref":"#/components/schemas/subinventories-locators-locatorsKeyFlex-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Item Locators

Type: array

Title: Item Locators

The Item Locators resource manages operations on item locators.

Show Source

• Array of: object schema

{
    "title":"Item Locators",
    "type":"array",
    "description":"The Item Locators resource manages operations on item locators.",
    "items":{
        "$ref":"#/components/schemas/subinventories-locators-itemLocators-item-patch-request"
    }
}

Nested Schema : Flexfields for Locators

Type: array

Title: Flexfields for Locators

Descriptive flexfields that contain details about locators.

Show Source

• Array of: object subinventories-locators-locatorsDFF-item-patch-request

{
    "title":"Flexfields for Locators",
    "type":"array",
    "description":"Descriptive flexfields that contain details about locators.",
    "items":{
        "$ref":"#/components/schemas/subinventories-locators-locatorsDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Flexfields for Locator Keys

Type: array

Title: Flexfields for Locator Keys

Flexfields that contain details about locator keys.

Show Source

• Array of: object Discriminator: _STRUCTURE_INSTANCE_NUMBER
  Discriminator: { "propertyName":"_STRUCTURE_INSTANCE_NUMBER", "mapping":{ "1021":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-patch-request" } }

{
    "title":"Flexfields for Locator Keys",
    "type":"array",
    "description":"Flexfields that contain details about locator keys.",
    "items":{
        "$ref":"#/components/schemas/subinventories-locators-locatorsKeyFlex-item-patch-request"
    },
    "x-cardinality":"1"
}

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

{
    "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"
                ]
            }
        },
        "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"
                ]
            }
        },
        "LastReplenishedDate":{
            "type":"string",
            "description":"Date when the item was last replenished for a locator during par counting.",
            "format":"date-time",
            "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"
                ]
            }
        },
        "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"
                ]
            }
        }
    }
}

Nested Schema : subinventories-locators-locatorsDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30

  Context value of the locator that the descriptive flexfield references.
• __FLEX_Context_DisplayValue: string
  Title: Context

  Display value of the locator that the descriptive flexfield references.

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"Display value of the locator that the descriptive flexfield references.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":"30",
            "type":"string",
            "description":"Context value of the locator that the descriptive flexfield references.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : Discriminator: _STRUCTURE_INSTANCE_NUMBER

Type: object

Discriminator: _STRUCTURE_INSTANCE_NUMBER

Discriminator Values

• 1021

{
    "discriminator":{
        "propertyName":"_STRUCTURE_INSTANCE_NUMBER",
        "mapping":{
            "1021":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-patch-request"
        }
    ]
}

Match One Schema

Show Source

• 1021 - object oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-patch-request

{
    "discriminator":{
        "propertyName":"_STRUCTURE_INSTANCE_NUMBER",
        "mapping":{
            "1021":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-patch-request"
        }
    ]
}

Nested Schema : oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-patch-request

Type: object

Show Source

• EnabledFlag: string
  Maximum Length: 1

  Default Value: Y

  Contains one of the following values. Y: enable the locator. N: don't enable the locator. There's no default value for this attribute.
• EndDateActive: string (date)
  Date when the locator becomes inactive.
• StartDateActive: string (date)
  Date when the locator becomes active.

{
    "type":"object",
    "properties":{
        "StartDateActive":{
            "type":"string",
            "description":"Date when the locator becomes active.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "EndDateActive":{
            "type":"string",
            "description":"Date when the locator becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Contains one of the following values. Y: enable the locator. N: don't enable the locator. There's no default value for this attribute.",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        }
    }
}

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

Type: object

Show Source

• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the locator record.
• Description: string
  Title: Description

  Maximum Length: 50

  Description of the locator.
• DisableDate: string (date)
  Title: End Date

  Date when the locator is disabled for use in the application.
• InventoryLocationId: integer (int64)
  Title: Locator

  Value that uniquely identifies the locator.
• InventoryLocationType: string
  Title: Type

  Maximum Length: 30

  Value that identifies the locator type. A list of accepted values is defined in the lookup type INV_LOCATOR_TYPES.
• InventoryLocationTypeMeaning: string
  Maximum Length: 255

  Value of the locator type.
• itemLocators: array Item Locators
  Title: Item Locators

  The Item Locators resource manages operations on item locators.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocatorName: string
  Read Only: true

  Maximum Length: 255

  Name of the locator.
• locatorsDFF: array Flexfields for Locators
  Title: Flexfields for Locators

  Descriptive flexfields that contain details about locators.
• locatorsKeyFlex: array Flexfields for Locator Keys
  Title: Flexfields for Locator Keys

  Flexfields that contain details about locator keys.
• MaterialStatusCode: string
  Maximum Length: 255

  Abbreviation that identifies the material status that references the locator.
• MaterialStatusId: integer (int64)
  Title: Status

  Value that uniquely identifies the material status that references the locator.
• PickingOrder: number
  Title: Picking Order

  Picking order for the locator.
• StructureInstanceNumber: integer (int64)
  Title: Locator Structure

  Value that uniquely identifies the locator structure.
• SubinventoryCode: string
  Maximum Length: 10

  Abbreviation that identifies the subinventory name.

{
    "type":"object",
    "properties":{
        "MaterialStatusCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the material status that references the locator.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the locator record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PickingOrder":{
            "title":"Picking Order",
            "type":"number",
            "description":"Picking order for the locator.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the locator.",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Abbreviation that identifies the subinventory name.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryLocationId":{
            "title":"Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LocatorName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the locator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "locatorsDFF":{
            "title":"Flexfields for Locators",
            "type":"array",
            "description":"Descriptive flexfields that contain details about locators.",
            "items":{
                "$ref":"#/components/schemas/subinventories-locators-locatorsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "itemLocators":{
            "title":"Item Locators",
            "type":"array",
            "description":"The Item Locators resource manages operations on item locators.",
            "items":{
                "$ref":"#/components/schemas/subinventories-locators-itemLocators-item-response"
            }
        },
        "StructureInstanceNumber":{
            "title":"Locator Structure",
            "type":"integer",
            "description":"Value that uniquely identifies the locator structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "FND_ACFF_FlexfieldCode":"MTLL",
                "precision":"18",
                "FND_ACFF_ApplicationID":"401",
                "FND_ACFF_StructureLookupRequired":"false",
                "FND_ACFF_ModelID":"KFF_INV_MTLL_MTLL_INV_5FITEM_5FLOCATIONS",
                "FND_ACFF_ApplicationShortName":"INV"
            },
            "x-queryable":true
        },
        "InventoryLocationType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the locator type. A list of accepted values is defined in the lookup type INV_LOCATOR_TYPES.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MaterialStatusId":{
            "title":"Status",
            "type":"integer",
            "description":"Value that uniquely identifies the material status that references the locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DisableDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the locator is disabled for use in the application.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryLocationTypeMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the locator type.",
            "nullable":true,
            "x-queryable":true
        },
        "locatorsKeyFlex":{
            "title":"Flexfields for Locator Keys",
            "type":"array",
            "description":"Flexfields that contain details about locator keys.",
            "items":{
                "$ref":"#/components/schemas/subinventories-locators-locatorsKeyFlex-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Item Locators

Type: array

Title: Item Locators

The Item Locators resource manages operations on item locators.

Show Source

• Array of: object subinventories-locators-itemLocators-item-response

{
    "title":"Item Locators",
    "type":"array",
    "description":"The Item Locators resource manages operations on item locators.",
    "items":{
        "$ref":"#/components/schemas/subinventories-locators-itemLocators-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Flexfields for Locators

Type: array

Title: Flexfields for Locators

Descriptive flexfields that contain details about locators.

Show Source

• Array of: object subinventories-locators-locatorsDFF-item-response

{
    "title":"Flexfields for Locators",
    "type":"array",
    "description":"Descriptive flexfields that contain details about locators.",
    "items":{
        "$ref":"#/components/schemas/subinventories-locators-locatorsDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Flexfields for Locator Keys

Type: array

Title: Flexfields for Locator Keys

Flexfields that contain details about locator keys.

Show Source

• Array of: object Discriminator: _STRUCTURE_INSTANCE_NUMBER
  Discriminator: { "propertyName":"_STRUCTURE_INSTANCE_NUMBER", "mapping":{ "1021":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response" } }

{
    "title":"Flexfields for Locator Keys",
    "type":"array",
    "description":"Flexfields that contain details about locator keys.",
    "items":{
        "$ref":"#/components/schemas/subinventories-locators-locatorsKeyFlex-item-response"
    },
    "x-cardinality":"1"
}

Nested 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."
        }
    }
}

Nested Schema : subinventories-locators-locatorsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30

  Context value of the locator that the descriptive flexfield references.
• __FLEX_Context_DisplayValue: string
  Title: Context

  Display value of the locator that the descriptive flexfield references.
• InventoryLocationId: integer (int64)
  Title: Locator

  Value that uniquely identifies the locator.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InventoryLocationId":{
            "title":"Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"Display value of the locator that the descriptive flexfield references.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":"30",
            "type":"string",
            "description":"Context value of the locator that the descriptive flexfield references.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : Discriminator: _STRUCTURE_INSTANCE_NUMBER

Type: object

Discriminator: _STRUCTURE_INSTANCE_NUMBER

Discriminator Values

• 1021

{
    "discriminator":{
        "propertyName":"_STRUCTURE_INSTANCE_NUMBER",
        "mapping":{
            "1021":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response"
        }
    ]
}

Match One Schema

Show Source

• 1021 - object oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response

{
    "discriminator":{
        "propertyName":"_STRUCTURE_INSTANCE_NUMBER",
        "mapping":{
            "1021":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response"
        }
    ]
}

Nested Schema : oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response

Type: object

Show Source

• _INVENTORY_LOCATION_ID: integer (int64)
  Title: Locator

  Number that uniquely identifies the locator.
• _STRUCTURE_INSTANCE_NUMBER: integer (int64)
  Title: Locator Structure

  Default Value: 1021

  Value that uniquely identifies the locator structure for the subinventory when locator control is enabled for the subinventory.
• _SUBINVENTORY_ID: integer (int64)
  Value that uniquely identifies the subinventory.
• aisle: string
  Title: Aisle

  Maximum Length: 40
• bin: string
  Title: Bin

  Maximum Length: 40
• EnabledFlag: string
  Maximum Length: 1

  Default Value: Y

  Contains one of the following values. Y: enable the locator. N: don't enable the locator. There's no default value for this attribute.
• EndDateActive: string (date)
  Date when the locator becomes inactive.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• rack: string
  Title: Rack

  Maximum Length: 40
• row: string
  Title: Row

  Maximum Length: 40
• StartDateActive: string (date)
  Date when the locator becomes active.

{
    "type":"object",
    "properties":{
        "StartDateActive":{
            "type":"string",
            "description":"Date when the locator becomes active.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "EndDateActive":{
            "type":"string",
            "description":"Date when the locator becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "rack":{
            "title":"Rack",
            "maxLength":"40",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_Inventory Locator VS 10#FORMAT_ONLY",
                "FND_ACFF_OpenIdentifier":"rack",
                "FND_ACFF_QueryRequired":"Optional",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"10",
                "FND_ACFF_SegmentName":"Rack",
                "FND_ACFF_SegSeqNo":"3"
            }
        },
        "bin":{
            "title":"Bin",
            "maxLength":"40",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_Inventory Locator VS 10#FORMAT_ONLY",
                "FND_ACFF_OpenIdentifier":"bin",
                "FND_ACFF_QueryRequired":"Optional",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"10",
                "FND_ACFF_SegmentName":"Bin",
                "FND_ACFF_SegSeqNo":"4"
            }
        },
        "_INVENTORY_LOCATION_ID":{
            "title":"Locator",
            "type":"integer",
            "description":"Number that uniquely identifies the locator.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18",
                "FND_ACFF_JavaType":"java.lang.Long",
                "FND_ACFF_IsCCID":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "_SUBINVENTORY_ID":{
            "type":"integer",
            "description":"Value that uniquely identifies the subinventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18",
                "FND_ACFF_IsDataSetNumber":"true",
                "FND_ACFF_JavaType":"java.lang.Long"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "row":{
            "title":"Row",
            "maxLength":"40",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_Inventory Locator VS 10#FORMAT_ONLY",
                "FND_ACFF_OpenIdentifier":"row",
                "FND_ACFF_QueryRequired":"Optional",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"10",
                "FND_ACFF_SegmentName":"Row",
                "FND_ACFF_SegSeqNo":"2"
            }
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Contains one of the following values. Y: enable the locator. N: don't enable the locator. There's no default value for this attribute.",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "aisle":{
            "title":"Aisle",
            "maxLength":"40",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_Inventory Locator VS 10#FORMAT_ONLY",
                "FND_ACFF_OpenIdentifier":"aisle",
                "FND_ACFF_QueryRequired":"Optional",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"10",
                "FND_ACFF_SegmentName":"Aisle",
                "FND_ACFF_SegSeqNo":"1"
            }
        },
        "_STRUCTURE_INSTANCE_NUMBER":{
            "title":"Locator Structure",
            "type":"integer",
            "description":"Value that uniquely identifies the locator structure for the subinventory when locator control is enabled for the subinventory.",
            "format":"int64",
            "nullable":true,
            "default":"1021",
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18",
                "FND_ACFF_IsStructureID":"true",
                "FND_ACFF_JavaType":"java.lang.Long",
                "FND_ACFF_StructureLookupRequired":"false"
            }
        }
    }
}

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

itemLocators

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

Parameters:

• InventoryLocationId: $request.path.InventoryLocationId
• subinventoriesUniqID: $request.path.subinventoriesUniqID

The Item Locators resource manages operations on item locators.

locatorsDFF

Operation: /fscmRestApi/resources/11.13.18.05/subinventories/{subinventoriesUniqID}/child/locators/{InventoryLocationId}/child/locatorsDFF

Parameters:

• InventoryLocationId: $request.path.InventoryLocationId
• subinventoriesUniqID: $request.path.subinventoriesUniqID

Descriptive flexfields that contain details about locators.

locatorsKeyFlex

Operation: /fscmRestApi/resources/11.13.18.05/subinventories/{subinventoriesUniqID}/child/locators/{InventoryLocationId}/child/locatorsKeyFlex

Parameters:

• InventoryLocationId: $request.path.InventoryLocationId
• subinventoriesUniqID: $request.path.subinventoriesUniqID

Flexfields that contain details about locator keys.

Back to Top

Examples

This example describes how to update one locator in one subinventory.

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/subinventories/subinventoriesUniqID/child/locators/locatorsUniqID"

For example, the following command updates locator 300100132042551 in subinventory 00020000000EACED0005770800000000000000CF000000084142435355423031:

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

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.

{
    "Description": "Test Locator",
    "DisableDate": null,
    "InventoryLocationType": null,
    "PickingOrder": null,
    "MaterialStatusId": -3
}

Example Response Body

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

{
    "Description": "Test Locator",
    "DisableDate": null,
    "InventoryLocationType": null,
    "PickingOrder": null,
    "MaterialStatusId": -3,
    "StructureInstanceNumber": 101,
    "SubinventoryCode": "ABCSUB01",
    "MaterialStatusCode": "Raw Material",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551",
            "name": "locators",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551",
            "name": "locators",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031",
            "name": "subinventories",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551/lov/LocatorTypeLov",
            "name": "LocatorTypeLov",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551/lov/KeyFlexfieldStructureInstanceLov",
            "name": "KeyFlexfieldStructureInstanceLov",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551/child/itemLocators",
            "name": "itemLocators",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551/child/locatorsKeyFlex",
            "name": "locatorsKeyFlex",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551/child/locatorsDFF",
            "name": "locatorsDFF",
            "kind": "collection"
        }
    ]
}

Back to Top