Jump to

• Request
• Response

Update a packing unit

patch

/fscmRestApi/resources/11.13.18.05/shipmentTransactionRequests/{TransactionId}/child/shipments/{DeliveryInterfaceId}/child/outerPackingUnits/{LPNInterfaceId}/child/innerPackingUnits/{LPNInterfaceId3}/child/innerPackingUnits/{LPNInterfaceId5}

Request

Path Parameters

• DeliveryInterfaceId(required): integer(int64)
  Value that uniquely identifies the candidate shipment.
• LPNInterfaceId(required): integer(int64)
  Value that uniquely identifies the candidate packing unit.
• LPNInterfaceId3(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=
• LPNInterfaceId5(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=
• TransactionId(required): integer(int64)
  Value that uniquely identifies the shipment transaction request.

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

• FOBCode: string
  Maximum Length: 30

  Abbreviation that identifies ownership of the items that are in-transit. A list of accepted values is defined in the lookup type FOB.
• GrossWeight: number
  Weight of the packing unit including contents.
• GrossWeightUOM: string
  Maximum Length: 25

  Unit of measure of the gross weight of the packing unit.
• GrossWeightUOMCode: string
  Maximum Length: 3

  Code that identifies the unit of measure of the gross weight of the packing unit.
• MasterSerialNumber: string
  Maximum Length: 80

  Master serial number that identifies the packing unit.
• PackingUnitType: string
  Maximum Length: 300

  Item defining characteristics of a packing unit.
• SealNumber: string
  Maximum Length: 30

  Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport.
• TareWeight: number
  Weight of the container that contains the packing unit.
• TareWeightUOM: string
  Maximum Length: 25

  Unit of measure that the tare weight uses for the packing unit.
• TareWeightUOMCode: string
  Maximum Length: 3

  Code that identifies the unit of measure that the tare weight uses for the packing unit.
• TrackingNumber: string
  Maximum Length: 30

  Tracking number of the packing unit.
• Volume: number
  Volume of material that the packing unit can hold.
• VolumeUOM: string
  Maximum Length: 25

  Unit of measure that the container volume uses for the packing unit.
• VolumeUOMCode: string
  Maximum Length: 3

  Code that identifies the unit of measure that the container volume uses for the packing unit.

{
    "type":"object",
    "properties":{
        "TareWeight":{
            "type":"number",
            "description":"Weight of the container that contains the packing unit.",
            "nullable":true,
            "x-queryable":false
        },
        "GrossWeightUOM":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure of the gross weight of the packing unit.",
            "nullable":true,
            "x-queryable":false
        },
        "FOBCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies ownership of the items that are in-transit. A list of accepted values is defined in the lookup type FOB.",
            "nullable":true,
            "x-queryable":false
        },
        "TareWeightUOM":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure that the tare weight uses for the packing unit.",
            "nullable":true,
            "x-queryable":false
        },
        "TrackingNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Tracking number of the packing unit.",
            "nullable":true,
            "x-queryable":false
        },
        "GrossWeight":{
            "type":"number",
            "description":"Weight of the packing unit including contents.",
            "nullable":true,
            "x-queryable":false
        },
        "SealNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport.",
            "nullable":true,
            "x-queryable":false
        },
        "VolumeUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Code that identifies the unit of measure that the container volume uses for the packing unit.",
            "nullable":true
        },
        "TareWeightUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Code that identifies the unit of measure that the tare weight uses for the packing unit.",
            "nullable":true
        },
        "MasterSerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Master serial number that identifies the packing unit.",
            "nullable":true,
            "x-queryable":false
        },
        "VolumeUOM":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure that the container volume uses for the packing unit.",
            "nullable":true,
            "x-queryable":false
        },
        "GrossWeightUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Code that identifies the unit of measure of the gross weight of the packing unit.",
            "nullable":true
        },
        "PackingUnitType":{
            "maxLength":"300",
            "type":"string",
            "description":"Item defining characteristics of a packing unit.",
            "nullable":true,
            "x-queryable":false
        },
        "Volume":{
            "type":"number",
            "description":"Volume of material that the packing unit can hold.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-innerPackingUnits-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the candidate packing unit.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the candidate packing unit.
• FOBCode: string
  Maximum Length: 30

  Abbreviation that identifies ownership of the items that are in-transit. A list of accepted values is defined in the lookup type FOB.
• GrossWeight: number
  Weight of the packing unit including contents.
• GrossWeightUOM: string
  Maximum Length: 25

  Unit of measure of the gross weight of the packing unit.
• GrossWeightUOMCode: string
  Maximum Length: 3

  Code that identifies the unit of measure of the gross weight of the packing unit.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the candidate packing unit.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the candidate packing unit.
• links: array Links
  Title: Links

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

  Value that uniquely identifies the candidate packing unit.
• MasterSerialNumber: string
  Maximum Length: 80

  Master serial number that identifies the packing unit.
• PackingUnit: string
  Maximum Length: 30

  Name of the packing unit.
• PackingUnitType: string
  Maximum Length: 300

  Item defining characteristics of a packing unit.
• SealNumber: string
  Maximum Length: 30

  Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport.
• TareWeight: number
  Weight of the container that contains the packing unit.
• TareWeightUOM: string
  Maximum Length: 25

  Unit of measure that the tare weight uses for the packing unit.
• TareWeightUOMCode: string
  Maximum Length: 3

  Code that identifies the unit of measure that the tare weight uses for the packing unit.
• TrackingNumber: string
  Maximum Length: 30

  Tracking number of the packing unit.
• Volume: number
  Volume of material that the packing unit can hold.
• VolumeUOM: string
  Maximum Length: 25

  Unit of measure that the container volume uses for the packing unit.
• VolumeUOMCode: string
  Maximum Length: 3

  Code that identifies the unit of measure that the container volume uses for the packing unit.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the candidate packing unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TareWeight":{
            "type":"number",
            "description":"Weight of the container that contains the packing unit.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the candidate packing unit.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "GrossWeightUOM":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure of the gross weight of the packing unit.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the candidate packing unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "FOBCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies ownership of the items that are in-transit. A list of accepted values is defined in the lookup type FOB.",
            "nullable":true,
            "x-queryable":false
        },
        "TareWeightUOM":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure that the tare weight uses for the packing unit.",
            "nullable":true,
            "x-queryable":false
        },
        "TrackingNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Tracking number of the packing unit.",
            "nullable":true,
            "x-queryable":false
        },
        "GrossWeight":{
            "type":"number",
            "description":"Weight of the packing unit including contents.",
            "nullable":true,
            "x-queryable":false
        },
        "SealNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport.",
            "nullable":true,
            "x-queryable":false
        },
        "LPNInterfaceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the candidate packing unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "VolumeUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Code that identifies the unit of measure that the container volume uses for the packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "TareWeightUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Code that identifies the unit of measure that the tare weight uses for the packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "MasterSerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Master serial number that identifies the packing unit.",
            "nullable":true,
            "x-queryable":false
        },
        "VolumeUOM":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure that the container volume uses for the packing unit.",
            "nullable":true,
            "x-queryable":false
        },
        "GrossWeightUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Code that identifies the unit of measure of the gross weight of the packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "PackingUnitType":{
            "maxLength":"300",
            "type":"string",
            "description":"Item defining characteristics of a packing unit.",
            "nullable":true,
            "x-queryable":false
        },
        "Volume":{
            "type":"number",
            "description":"Volume of material that the packing unit can hold.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PackingUnit":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the candidate packing unit.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":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"
    }
}

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