Jump to

• Request
• Response

Get one packing unit content

get

/fscmRestApi/resources/11.13.18.05/shippingPackingUnits/{PackingUnitHistoryId}/child/nestedPackingUnits/{PackingUnitHistoryId2}/child/contents/{PackingUnitContentId}

Request

Path Parameters

• PackingUnitContentId(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=
• 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=
• PackingUnitHistoryId2(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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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

Type: object

Show Source

• contentInventoryAttributes: array Inventory Tracking Attributes
  Title: Inventory Tracking Attributes

  Set of named attributes (project, task, and country of origin) and user-configurable attributes used to track the inventory on hand.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the content item.
• ItemDescription: string
  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: 255

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

  The link relations associated with the resource instance.
• LotControlCode: integer
  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.
• LotExpirationDate: string (date)
  Read Only: true

  Lot number of the container item, if container item is under lot control.
• LotNumber: string
  Maximum Length: 80

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

  Maximum Length: 255

  Abbreviation that identifies the organization of the LPN.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization of the LPN.
• PackingUnitContentId: integer (int64)
  Value that uniquely identifies the LPN content.
• PrimaryQuantity: number
  Read Only: true

  Primary quantity of the item.
• Quantity: number
  Quantity of the content item.
• Revision: string
  Maximum Length: 18

  Revision of the container item.
• SecondaryQuantity: number
  Quantity of the content item in the item's secondary unit of measure.
• SecondaryUOMCode: string
  Maximum Length: 3

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

  Maximum Length: 255

  Name of the secondary unit of measure of the content item.
• SerialNumberControlCode: integer
  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.
• serials: array LPN Serial Numbers
  Title: LPN Serial Numbers

  Alphanumeric identifier assigned to an individual unit of an item in the LPN.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure of the content item.
• UOMName: string
  Read Only: true

  Maximum Length: 255

  Name of the unit of measure of the content item.

{
    "type":"object",
    "properties":{
        "PrimaryQuantity":{
            "type":"number",
            "description":"Primary quantity of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "contentInventoryAttributes":{
            "title":"Inventory Tracking Attributes",
            "type":"array",
            "description":"Set of named attributes (project, task, and country of origin) and user-configurable attributes used to track the inventory on hand.",
            "items":{
                "$ref":"#/components/schemas/shippingPackingUnits-nestedPackingUnits-contents-contentInventoryAttributes-item-response"
            }
        },
        "serials":{
            "title":"LPN Serial Numbers",
            "type":"array",
            "description":"Alphanumeric identifier assigned to an individual unit of an item in the LPN.",
            "items":{
                "$ref":"#/components/schemas/shippingPackingUnits-nestedPackingUnits-contents-serials-item-response"
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the content item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the content item.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization of the LPN.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SerialNumberControlCode":{
            "type":"integer",
            "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
        },
        "LotExpirationDate":{
            "type":"string",
            "description":"Lot number of the container item, if container item is under lot control.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the content item.",
            "nullable":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
        },
        "LotControlCode":{
            "type":"integer",
            "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":false
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the secondary unit of measure of the content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryQuantity":{
            "type":"number",
            "description":"Quantity of the content item in the item's secondary unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "Revision":{
            "maxLength":18,
            "type":"string",
            "description":"Revision of the container item.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure of the content item.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization of the LPN.",
            "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"
            }
        },
        "PackingUnitContentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the LPN content.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UOMName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the unit of measure of the content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure of the content item.",
            "nullable":true,
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Lot number of the container item, if container item is under lot control.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Inventory Tracking Attributes

Type: array

Title: Inventory Tracking Attributes

Set of named attributes (project, task, and country of origin) and user-configurable attributes used to track the inventory on hand.

Show Source

• Array of: object shippingPackingUnits-nestedPackingUnits-contents-contentInventoryAttributes-item-response

{
    "title":"Inventory Tracking Attributes",
    "type":"array",
    "description":"Set of named attributes (project, task, and country of origin) and user-configurable attributes used to track the inventory on hand.",
    "items":{
        "$ref":"#/components/schemas/shippingPackingUnits-nestedPackingUnits-contents-contentInventoryAttributes-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 Serial Numbers

Type: array

Title: LPN Serial Numbers

Alphanumeric identifier assigned to an individual unit of an item in the LPN.

Show Source

• Array of: object shippingPackingUnits-nestedPackingUnits-contents-serials-item-response

{
    "title":"LPN Serial Numbers",
    "type":"array",
    "description":"Alphanumeric identifier assigned to an individual unit of an item in the LPN.",
    "items":{
        "$ref":"#/components/schemas/shippingPackingUnits-nestedPackingUnits-contents-serials-item-response"
    }
}

Nested Schema : shippingPackingUnits-nestedPackingUnits-contents-contentInventoryAttributes-item-response

Type: object

Show Source

• Country: string
  Read Only: true

  Maximum Length: 80

  Name of the country of origin.
• CountryOfOriginCode: string
  Read Only: true

  Maximum Length: 2

  Abbreviation that identifies the country of origin.
• InventoryItemId: integer
  Read Only: true

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

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

  Maximum Length: 80

  Value that identifies the lot or batch of the content item.
• 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.
• 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.
• 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
        },
        "ProjectNumber":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the project.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the content item.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "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
        },
        "Country":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the country of origin.",
            "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"
            }
        },
        "LotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the lot or batch of the content 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."
        }
    }
}

Nested Schema : shippingPackingUnits-nestedPackingUnits-contents-serials-item-response

Type: object

Show Source

• CurrentOrganizationId: integer (int64)
  Read Only: true

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

  Maximum Length: 30

  Abbreviation that identifies the current status of the serial number of the content item.
• CurrentStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  Description of the current status of the serial number of the content item.
• InventoryItemId: integer (int64)
  Read Only: true

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

  Maximum Length: 80

  Value that identifies the lot or batch of the content item.
• PackingUnitId: integer (int64)
  Read Only: true

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

  Maximum Length: 18

  Revision of the item.
• SerialNumber: string
  Read Only: true

  Maximum Length: 80

  Serial number of the container item, if container item is under serial control.

{
    "type":"object",
    "properties":{
        "CurrentStatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Description of the current status of the serial number of the content item.",
            "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
        },
        "SerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Serial number of the container item, if container item is under serial control.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Revision":{
            "maxLength":18,
            "type":"string",
            "description":"Revision of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the current status of the serial number of the content item.",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "LotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the lot or batch of the content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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"
    }
}

Links

contentInventoryAttributes

Operation: /fscmRestApi/resources/11.13.18.05/shippingPackingUnits/{PackingUnitHistoryId}/child/nestedPackingUnits/{PackingUnitHistoryId2}/child/contents/{PackingUnitContentId}/child/contentInventoryAttributes

Parameters:

• PackingUnitContentId2: $request.path.PackingUnitContentId2
• PackingUnitHistoryId: $request.path.PackingUnitHistoryId
• PackingUnitHistoryId2: $request.path.PackingUnitHistoryId2

Set of named attributes (project, task, and country of origin) and user-configurable attributes used to track the inventory on hand.

serials

Operation: /fscmRestApi/resources/11.13.18.05/shippingPackingUnits/{PackingUnitHistoryId}/child/nestedPackingUnits/{PackingUnitHistoryId2}/child/contents/{PackingUnitContentId}/child/serials

Parameters:

• PackingUnitContentId2: $request.path.PackingUnitContentId2
• PackingUnitHistoryId: $request.path.PackingUnitHistoryId
• PackingUnitHistoryId2: $request.path.PackingUnitHistoryId2

Alphanumeric identifier assigned to an individual unit of an item in the LPN.

Back to Top