Jump to

• Request
• Response

Create items

post

/fscmRestApi/resources/11.13.18.05/shippingPackingUnits/{PackingUnitHistoryId}/child/packingUnitItems

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=

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "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-packingUnitItems-item-response

Type: object

Show Source

• AvailableToTransact: number
  Read Only: true

  Quantity available to transact for the item in the LPN.
• CountryOfOriginCount: integer
  Read Only: true

  Number of unique 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 container 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 that identifies the content 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 LPN.
• LocatorName: string
  Read Only: true

  Maximum Length: 2000

  Concatenated name of the inventory locator for the LPN.
• 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.
• 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 unique projects associated with items in the LPN.
• RevisionControlCode: number
  Read Only: true

  Abbreviation that identifies the revision control of the item.
• 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

  Code that identifies the packing unit 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.

{
    "type":"object",
    "properties":{
        "PrimaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the primary unit of measure of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryOfOriginCount":{
            "type":"integer",
            "description":"Number of unique 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
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item locator for the LPN.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectCount":{
            "type":"integer",
            "description":"Number of unique projects associated with items in the LPN.",
            "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
        },
        "TotalSecondaryQuantity":{
            "type":"number",
            "description":"Total quantity of the item in 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":"Code that identifies the packing unit subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the container item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocatorName":{
            "maxLength":2000,
            "type":"string",
            "description":"Concatenated name of the inventory locator for the LPN.",
            "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
        },
        "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
        },
        "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
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the content 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
        },
        "TotalQuantity":{
            "type":"number",
            "description":"Total quantity of the item.",
            "nullable":true,
            "readOnly":true,
            "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":"Abbreviation that identifies the secondary 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"
            }
        },
        "RevisionControlCode":{
            "type":"number",
            "description":"Abbreviation that identifies the revision control of the item.",
            "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
        },
        "PrimaryUOMName":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the primary unit of measure of the item.",
            "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