Jump to

• Request
• Response

Update one item

patch

/fscmRestApi/resources/11.13.18.05/packingUnits/{PackingUnitId}/child/packingUnitItems/{packingUnitItemsUniqID}

Request

Path Parameters

• PackingUnitId(required): integer(int64)
  Value that uniquely identifies the packing unit.
• packingUnitItemsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- InventoryItemId, LPNId and OrganizationId ---for the Packing Unit Items resource and used to uniquely identify an instance of Packing Unit Items. The client should not generate the hash key value. Instead, the client should query on the Packing Unit Items collection resource with a filter on the primary key values in order to navigate to a specific instance of Packing Unit Items.
  
  For example: packingUnitItems?q=InventoryItemId=<value1>;LPNId=<value2>;OrganizationId=<value3>

Header Parameters

• Metadata-Context: string
  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: string
  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

• packingUnitItemLots: array LPN Lots
  Title: LPN Lots

  List of lots of an item in the LPN.

{
    "type":"object",
    "properties":{
        "packingUnitItemLots":{
            "title":"LPN Lots",
            "type":"array",
            "description":"List of lots of an item in the LPN.",
            "items":{
                "$ref":"#/components/schemas/packingUnits-packingUnitItems-packingUnitItemLots-item-patch-request"
            }
        }
    }
}

Nested Schema : LPN Lots

Type: array

Title: LPN Lots

List of lots of an item in the LPN.

Show Source

• Array of: object packingUnits-packingUnitItems-packingUnitItemLots-item-patch-request

{
    "title":"LPN Lots",
    "type":"array",
    "description":"List of lots of an item in the LPN.",
    "items":{
        "$ref":"#/components/schemas/packingUnits-packingUnitItems-packingUnitItemLots-item-patch-request"
    }
}

Nested Schema : packingUnits-packingUnitItems-packingUnitItemLots-item-patch-request

Type: object

Show Source

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

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 : packingUnits-packingUnitItems-item-response

Type: object

Show Source

• AvailableToTransact: number
  Read Only: true

  Quantity available for transaction in the packing unit.
• CountryOfOriginCount: integer
  Read Only: true

  Number of distinct countries of origin associated with items in the LPN.
• InventoryItemId: integer
  Read Only: true

  Value that uniquely identifies the item.
• ItemDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the content item.
• ItemImage: string
  Read Only: true

  Maximum Length: 4000

  Value that provides a reference to the item's image.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number or name that identifies the item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocatorId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item locator for the packing unit.
• LocatorName: string
  Read Only: true

  Maximum Length: 2000

  Name of the locator.
• LotControlCode: number
  Read Only: true

  Value that identifies whether the item is lot-controlled. A list of accepted values is defined in the lookup type EGP_LOT_CONTROL_CODE_TYPE.
• LPNId: integer (int64)
  Read Only: true

  Value that uniquely identifies the license plate number.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization.
• OwningTypeName: string
  Read Only: true

  Maximum Length: 9

  Type of owner of the financial liability for consigned inventory. Contains one of the following values: Supplier site: The owning party is the supplier site Inventory organization: The owning party is the inventory organization.
• packingUnitItemLots: array LPN Lots
  Title: LPN Lots

  List of lots of an item in the LPN.
• PrimaryUOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the primary unit of measure of the item.
• PrimaryUOMName: string
  Read Only: true

  Maximum Length: 25

  Name of the primary unit of measure of the item.
• ProjectCount: integer
  Read Only: true

  Number of distinct projects associated with items in the LPN.
• RevisionControlCode: number
  Read Only: true

  Abbreviation that identifies the revision control of the item.
• SecondaryDefaultIndicator: string
  Read Only: true

  Maximum Length: 30

  Value that indicates how the conversion between primary and secondary units of measure is handled. Valid values are Default, Fixed, and No Default. The value of Defaulting Control depends on the value of the Tracking Unit of Measure attribute. If the Tracking Unit of Measure is Primary and Secondary, then the Defaulting Control can be provided. Otherwise, the Defaulting Control can't be provided. A list of accepted values is defined in the lookup type EGP_DEFAULTING. Review the value for this attribute in the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is Fixed.
• SecondaryUOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the secondary unit of measure of the item.
• SecondaryUOMName: string
  Read Only: true

  Maximum Length: 25

  Name of the secondary unit of measure of the item.
• SerialNumberControlCode: number
  Read Only: true

  Value that identifies if the item is serial-controlled. A list of accepted values is defined in the lookup type EGP_SERIAL_NUMBER_CONTROL_TYPE.
• SubinventoryCode: string
  Read Only: true

  Maximum Length: 10

  Name of the subinventory.
• TotalQuantity: number
  Read Only: true

  Total quantity of the item.
• TotalSecondaryQuantity: number
  Read Only: true

  Total quantity of the item in secondary unit of measure of the item.
• TrackingUnitOfMeasure: string
  Read Only: true

  Maximum Length: 30

  Unit of measure of the item.

{
    "type":"object",
    "properties":{
        "AvailableToTransact":{
            "type":"number",
            "description":"Quantity available for transaction in the packing unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryOfOriginCount":{
            "type":"integer",
            "description":"Number of distinct countries of origin associated with items in the LPN.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemImage":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that provides a reference to the item's image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number or name that identifies the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LPNId":{
            "type":"integer",
            "description":"Value that uniquely identifies the license plate number.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item locator for the packing unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocatorName":{
            "maxLength":2000,
            "type":"string",
            "description":"Name of the locator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LotControlCode":{
            "type":"number",
            "description":"Value that identifies whether the item is lot-controlled. A list of accepted values is defined in the lookup type EGP_LOT_CONTROL_CODE_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwningTypeName":{
            "maxLength":9,
            "type":"string",
            "description":"Type of owner of the financial liability for consigned inventory. Contains one of the following values:\nSupplier site: The owning party is the supplier site\nInventory organization: The owning party is the inventory organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the primary unit of measure of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryUOMName":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the primary unit of measure of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectCount":{
            "type":"integer",
            "description":"Number of distinct projects associated with items in the LPN.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RevisionControlCode":{
            "type":"number",
            "description":"Abbreviation that identifies the revision control of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryDefaultIndicator":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates how the conversion between primary and secondary units of measure is handled. Valid values are Default, Fixed, and No Default. The value of Defaulting Control depends on the value of the Tracking Unit of Measure attribute. If the Tracking Unit of Measure is Primary and Secondary, then the Defaulting Control can be provided. Otherwise, the Defaulting Control can't be provided. A list of accepted values is defined in the lookup type EGP_DEFAULTING. Review the value for this attribute in the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is Fixed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMName":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the secondary unit of measure of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SerialNumberControlCode":{
            "type":"number",
            "description":"Value that identifies if the item is serial-controlled. A list of accepted values is defined in the lookup type EGP_SERIAL_NUMBER_CONTROL_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubinventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Name of the subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalQuantity":{
            "type":"number",
            "description":"Total quantity of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalSecondaryQuantity":{
            "type":"number",
            "description":"Total quantity of the item in secondary unit of measure of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TrackingUnitOfMeasure":{
            "maxLength":30,
            "type":"string",
            "description":"Unit of measure of the item.",
            "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"
            }
        },
        "packingUnitItemLots":{
            "title":"LPN Lots",
            "type":"array",
            "description":"List of lots of an item in the LPN.",
            "items":{
                "$ref":"#/components/schemas/packingUnits-packingUnitItems-packingUnitItemLots-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 : LPN Lots

Type: array

Title: LPN Lots

List of lots of an item in the LPN.

Show Source

• Array of: object packingUnits-packingUnitItems-packingUnitItemLots-item-response

{
    "title":"LPN Lots",
    "type":"array",
    "description":"List of lots of an item in the LPN.",
    "items":{
        "$ref":"#/components/schemas/packingUnits-packingUnitItems-packingUnitItemLots-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 : packingUnits-packingUnitItems-packingUnitItemLots-item-response

Type: object

Show Source

• CountryOfOriginCount: number
  Read Only: true

  Number of distinct countries of origin associated with items in the LPN.
• ExpirationDate: string (date)
  Read Only: true

  Expiration date of the lot.
• InventoryItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that identifies the item.
• links: array Links
  Title: Links

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

  Maximum Length: 80

  Lot number of the container item, if the container item is under lot control.
• OrganizationId: integer
  Read Only: true

  Value that uniquely identifies the organization.
• OwningTypeName: string
  Read Only: true

  Maximum Length: 9

  Type of owner of the financial liability for consigned inventory.
• PackingUnitId: integer (int64)
  Read Only: true

  Value that uniquely identifies the license plate number.
• PrimaryUnitOfMeasure: string
  Read Only: true

  Maximum Length: 4000

  Name of the primary unit of measure of the item.
• PrimaryUOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the primary unit of measure of the item.
• ProjectCount: number
  Read Only: true

  Number of distinct projects associated with items in the LPN.
• Quantity: number
  Read Only: true

  On-hand quantity of the lot.

{
    "type":"object",
    "properties":{
        "CountryOfOriginCount":{
            "type":"number",
            "description":"Number of distinct countries of origin associated with items in the LPN.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Expiration date of the lot.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Lot number of the container item, if the container item is under lot control.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningTypeName":{
            "maxLength":9,
            "type":"string",
            "description":"Type of owner of the financial liability for consigned inventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PackingUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the license plate number.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the primary unit of measure of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryUnitOfMeasure":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the primary unit of measure of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectCount":{
            "type":"number",
            "description":"Number of distinct projects associated with items in the LPN.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"On-hand quantity of the lot.",
            "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

packingUnitItemLots

Operation: /fscmRestApi/resources/11.13.18.05/packingUnits/{PackingUnitId}/child/packingUnitItems/{packingUnitItemsUniqID}/child/packingUnitItemLots

Parameters:

• PackingUnitId: $request.path.PackingUnitId
• packingUnitItemsUniqID: $request.path.packingUnitItemsUniqID

List of lots of an item in the LPN.

Back to Top