Jump to

• Request
• Response

Update quantities for one packing unit

patch

/fscmRestApi/resources/11.13.18.05/shippingPackingUnits/{PackingUnitHistoryId}/child/packingUnitQuantities/{packingUnitQuantitiesUniqID}

Request

Path Parameters

• PackingUnitHistoryId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• packingUnitQuantitiesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LPNId, InventoryItemId, OrganizationId, Revision, LotNumber, ProjectId, TaskId and CountryOfOriginCode ---for the LPN Quantities resource and used to uniquely identify an instance of LPN Quantities. The client should not generate the hash key value. Instead, the client should query on the LPN Quantities collection resource with a filter on the primary key values in order to navigate to a specific instance of LPN Quantities.
  
  For example: packingUnitQuantities?q=LPNId=<value1>;InventoryItemId=<value2>;OrganizationId=<value3>;Revision=<value4>;LotNumber=<value5>;ProjectId=<value6>;TaskId=<value7>;CountryOfOriginCode=<value8>

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

{
    "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 : shippingPackingUnits-packingUnitQuantities-item-response

Type: object

Show Source

• AvailableToTransact: number
  Read Only: true

  Quantity available to transact for the item in the LPN.
• BusinessUnitId: integer (int64)
  Read Only: true

  Value that uniquely identifies the business unit.
• CountryOfOriginCode: string
  Read Only: true

  Maximum Length: 2

  Abbreviation that identifies the country of origin.
• CountryOfOriginName: string
  Read Only: true

  Maximum Length: 80

  Name of the country of origin.
• InventoryItemId: integer (int64)
  Read Only: true

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

  Maximum Length: 300

  Number or name that identifies the item.
• LicensePlateNumber: string
  Read Only: true

  Maximum Length: 30

  Name of the license plate number.
• links: array Links
  Title: Links

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

  Value that uniquely identifies the locator.
• 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.
• LotGrade: string
  Read Only: true

  Maximum Length: 150

  Abbreviation that identifies the grade associated with the lot of the item.
• LotNumber: string
  Read Only: true

  Maximum Length: 80

  Value that identifies the lot or batch of the item.
• LPNId: integer
  Read Only: true

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

  Number that identifies the object version.
• OnhandSummaryId: integer (int64)
  Read Only: true

  Value that uniquely identifies an on hand summary.
• OnhandSummaryKey: string
  Read Only: true

  Maximum Length: 1000

  Value that indicates the on hand summary.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the organization.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization.
• OwningEntityId: integer (int64)
  Read Only: true

  Value that uniquely identifies the owning party that's financially responsible for consigned inventory.
• OwningEntityName: string
  Read Only: true

  Maximum Length: 240

  Owning party that's financially responsible for consigned inventory.
• OwningType: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of owner of the financial liability for consigned inventory.
• OwningTypeName: string
  Read Only: true

  Maximum Length: 240

  Type of owner of the financial liability for consigned inventory.
• PrimaryUOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the primary unit of measure of the item.
• ProjectId: integer (int64)
  Read Only: true

  Value that uniquely identifies the project.
• ProjectNumber: string
  Read Only: true

  Maximum Length: 25

  Name of the project.
• Quantity: number
  Read Only: true

  Quantity of the content item.
• Revision: string
  Read Only: true

  Maximum Length: 18

  Revision of the content item.
• RevisionControlCode: number
  Read Only: true

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

  Maximum Length: 3

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

  Quantity of the item in 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.
• StockingUOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure in which the item is stocked in a subinventory.
• StockingUOMQuantity: number
  Read Only: true

  Quantity of the item in its stocking unit of measure.
• SubinventoryCode: string
  Read Only: true

  Maximum Length: 10

  Name of the subinventory.
• TaskId: integer (int64)
  Read Only: true

  Value that uniquely identifies the task.
• TaskNumber: string
  Read Only: true

  Maximum Length: 100

  Name of the task.

{
    "type":"object",
    "properties":{
        "TaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "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
        },
        "LocatorName":{
            "maxLength":2000,
            "type":"string",
            "description":"Name of the locator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OnhandSummaryKey":{
            "maxLength":1000,
            "type":"string",
            "description":"Value that indicates the on hand summary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LPNId":{
            "type":"integer",
            "description":"Value that uniquely identifies the license plate number.",
            "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
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the object version.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AvailableToTransact":{
            "type":"number",
            "description":"Quantity available to transact for the item in the LPN.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Name of the secondary unit of measure of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "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"
            }
        },
        "LotGrade":{
            "maxLength":150,
            "type":"string",
            "description":"Abbreviation that identifies the grade associated with the lot of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningTypeName":{
            "maxLength":240,
            "type":"string",
            "description":"Type of owner of the financial liability for consigned inventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the owning party that's financially responsible for consigned inventory.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the lot or batch of the item.",
            "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
        },
        "OwningEntityName":{
            "maxLength":240,
            "type":"string",
            "description":"Owning party that's financially responsible for consigned inventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectNumber":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the project.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryOfOriginName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the country of origin.",
            "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
        },
        "OwningType":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of owner of the financial liability for consigned inventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the project.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskNumber":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicensePlateNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the license plate number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StockingUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure in which the item is stocked in a subinventory.",
            "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
        },
        "CountryOfOriginCode":{
            "maxLength":2,
            "type":"string",
            "description":"Abbreviation that identifies the country of origin.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Revision":{
            "maxLength":18,
            "type":"string",
            "description":"Revision of the content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMQuantity":{
            "type":"number",
            "description":"Quantity of the item in secondary unit of measure of the item.",
            "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
        },
        "OnhandSummaryId":{
            "type":"integer",
            "description":"Value that uniquely identifies an on hand summary.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StockingUOMQuantity":{
            "type":"number",
            "description":"Quantity of the item in its stocking unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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