Update one packing unit

patch

/fscmRestApi/resources/11.13.18.05/packingUnits/{PackingUnitId}

Request

Path Parameters
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages the attachments associated with the packing unit resource.
Show Source
Nested Schema : Contents
Type: array
Title: Contents
The Contents resource manages the operations on packing unit contents.
Show Source
Nested Schema : Nested Packing Units
Type: array
Title: Nested Packing Units
The Nested Packing Units resources manages the operations on nested packing units.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The Notes resource gets comments, information, or instructions for packing units.
Show Source
Nested Schema : Flexfields for Packing Units
Type: array
Title: Flexfields for Packing Units
The Flexfields for Packing Units resource manages the descriptive flexfields for packing units.
Show Source
Nested Schema : packingUnits-attachments-item-patch-request
Type: object
Show Source
Nested Schema : packingUnits-contents-item-patch-request
Type: object
Show Source
Nested Schema : serials
Type: array
Show Source
Nested Schema : packingUnits-contents-serials-item-patch-request
Type: object
Show Source
Nested Schema : packingUnits-nestedPackingUnits-item-patch-request
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : contents
Type: array
Show Source
Nested Schema : nestedPackingUnits
Type: array
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The note objects resource is used to view the note objects.
Show Source
Nested Schema : packingUnitDFFs
Type: array
Show Source
Nested Schema : packingUnits-nestedPackingUnits-attachments-item-patch-request
Type: object
Show Source
Nested Schema : packingUnits-nestedPackingUnits-contents-item-patch-request
Type: object
Show Source
Nested Schema : serials
Type: array
Show Source
Nested Schema : packingUnits-nestedPackingUnits-contents-serials-item-patch-request
Type: object
Show Source
Nested Schema : packingUnits-nestedPackingUnits-nestedPackingUnits-item-patch-request
Type: object
Show Source
Nested Schema : packingUnits-nestedPackingUnits-notes-item-patch-request
Type: object
Show Source
  • Title: Contact Relationship ID
    Value that uniquely identifies the relationship. This attribute is not currently used by the packingUnits resource.
  • Title: Corporate Currency Code
    Maximum Length: 15
    Abbreviation that identifies the corporate currency. This attribute is not currently used by the packingUnits resource.
  • Title: Creator Party ID
    Value that uniquely identifies the creator of the note.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    Type of currency conversion rate. This attribute is not currently used by the packingUnits resource.
  • Title: Currency
    Maximum Length: 15
    Abbreviation that identifies the currency. This attribute is not currently used by the packingUnits resource.
  • Title: Title
    Maximum Length: 500
    The title of the note entered by the user.
  • Title: Note
    Text of the actual note.
  • Title: Type
    Maximum Length: 30
    Abbreviation that identifies the categorization of the note type.
  • Title: Related Object
    Maximum Length: 64
    Value that uniquely identifies the packing unit.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    Abbreviation that identifies the visibility level of the note.
Nested Schema : schema
Type: object
Show Source
Nested Schema : packingUnits-notes-item-patch-request
Type: object
Show Source
  • Title: Contact Relationship ID
    Value that uniquely identifies the relationship. This attribute is not currently used by the packingUnits resource.
  • Title: Corporate Currency Code
    Maximum Length: 15
    Abbreviation that identifies the corporate currency. This attribute is not currently used by the packingUnits resource.
  • Title: Creator Party ID
    Value that uniquely identifies the creator of the note.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    Type of currency conversion rate. This attribute is not currently used by the packingUnits resource.
  • Title: Currency
    Maximum Length: 15
    Abbreviation that identifies the currency. This attribute is not currently used by the packingUnits resource.
  • Title: Title
    Maximum Length: 500
    The title of the note entered by the user.
  • Title: Note
    Text of the actual note.
  • Title: Type
    Maximum Length: 30
    Abbreviation that identifies the categorization of the note type.
  • Title: Related Object
    Maximum Length: 64
    Value that uniquely identifies the packing unit.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    Abbreviation that identifies the visibility level of the note.
Nested Schema : packingUnits-packingUnitDFFs-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages the attachments associated with the packing unit resource.
Show Source
Nested Schema : Contents
Type: array
Title: Contents
The Contents resource manages the operations on packing unit contents.
Show Source
Nested Schema : Nested Packing Units
Type: array
Title: Nested Packing Units
The Nested Packing Units resources manages the operations on nested packing units.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The Notes resource gets comments, information, or instructions for packing units.
Show Source
Nested Schema : Flexfields for Packing Units
Type: array
Title: Flexfields for Packing Units
The Flexfields for Packing Units resource manages the descriptive flexfields for packing units.
Show Source
Nested Schema : packingUnits-attachments-item-response
Type: object
Show Source
Nested Schema : packingUnits-contents-item-response
Type: object
Show Source
Nested Schema : Serials
Type: array
Title: Serials
The Serials resource manages the operations on serials.
Show Source
Nested Schema : packingUnits-contents-serials-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the current status of the serial number of the content item.
  • Read Only: true
    Maximum Length: 80
    Description of the current status of the serial number of the content item.
  • Links
  • Read Only: true
    Maximum Length: 80
    Serial number of the container item, if container item is under serial control.
Nested Schema : packingUnits-nestedPackingUnits-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages the attachments associated with the packing unit resource.
Show Source
Nested Schema : Contents
Type: array
Title: Contents
The Contents resource manages the operations on packing unit contents.
Show Source
Nested Schema : Nested Packing Units
Type: array
Title: Nested Packing Units
The Nested Packing Units resources manages the operations on nested packing units.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The Notes resource gets comments, information, or instructions for packing units.
Show Source
Nested Schema : Flexfields for Packing Units
Type: array
Title: Flexfields for Packing Units
The Flexfields for Packing Units resource manages the descriptive flexfields for packing units.
Show Source
Nested Schema : packingUnits-nestedPackingUnits-attachments-item-response
Type: object
Show Source
Nested Schema : packingUnits-nestedPackingUnits-contents-item-response
Type: object
Show Source
Nested Schema : Serials
Type: array
Title: Serials
The Serials resource manages the operations on serials.
Show Source
Nested Schema : packingUnits-nestedPackingUnits-contents-serials-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the current status of the serial number of the content item.
  • Read Only: true
    Maximum Length: 80
    Description of the current status of the serial number of the content item.
  • Links
  • Read Only: true
    Maximum Length: 80
    Serial number of the container item, if container item is under serial control.
Nested Schema : packingUnits-nestedPackingUnits-nestedPackingUnits-item-response
Type: object
Show Source
Nested Schema : packingUnits-nestedPackingUnits-notes-item-response
Type: object
Show Source
  • Title: Contact Relationship ID
    Value that uniquely identifies the relationship. This attribute is not currently used by the packingUnits resource.
  • Title: Corporate Currency Code
    Maximum Length: 15
    Abbreviation that identifies the corporate currency. This attribute is not currently used by the packingUnits resource.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the note.
  • Title: Creation Date
    Read Only: true
    Date when the user created the note record.
  • Title: Creator Party ID
    Value that uniquely identifies the creator of the note.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    Type of currency conversion rate. This attribute is not currently used by the packingUnits resource.
  • Title: Currency
    Maximum Length: 15
    Abbreviation that identifies the currency. This attribute is not currently used by the packingUnits resource.
  • Title: Delete Indicator
    Read Only: true
    Contains one of the following values: true or false. If true, then the note can be deleted. If false, then the note can be deleted. The default value is true.
  • Title: Primary Email
    Read Only: true
    Maximum Length: 320
    The email address of the user who created the note.
  • Title: Primary Address
    Read Only: true
    The address of the user who created the note.
  • Title: Primary Phone
    Read Only: true
    The phone number of the user who created the note.
  • Title: Last Update Date
    Read Only: true
    Date when the user most recently updated the note data.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who most recently updated the note record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    Login of the user who most recently updated the note record.
  • Links
  • Title: Note ID
    Read Only: true
    Value that uniquely identifies the note.
  • Maximum Length: 30
    The alternate unique identifier of the note. A user key that's system generated or from an external system.
  • Title: Title
    Maximum Length: 500
    The title of the note entered by the user.
  • Title: Note
    Text of the actual note.
  • Title: Type
    Maximum Length: 30
    Abbreviation that identifies the categorization of the note type.
  • Title: Parent Note ID
    Value that uniquely identifies the parent note.
  • Title: Party ID
    Read Only: true
    Value that uniquely identifies the party to which the note is associated.
  • Title: Author
    Read Only: true
    Maximum Length: 360
    Name of the user who created the record.
  • Title: Related Object Type
    Maximum Length: 30
    Abbreviation that identifies the object as defined in the OBJECTS metadata which is associated with the note. The object identifier is SHIPPING_LPN for packing units.
  • Title: Related Object
    Maximum Length: 64
    Value that uniquely identifies the packing unit.
  • Title: Update Indicator
    Read Only: true
    Contains one of the following values: true or false. If true, then the note can be updated. If false, then the note cannot be updated. The default value is true.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    Abbreviation that identifies the visibility level of the note.
Nested Schema : packingUnits-nestedPackingUnits-packingUnitDFFs-item-response
Type: object
Show Source
Nested Schema : packingUnits-notes-item-response
Type: object
Show Source
  • Title: Contact Relationship ID
    Value that uniquely identifies the relationship. This attribute is not currently used by the packingUnits resource.
  • Title: Corporate Currency Code
    Maximum Length: 15
    Abbreviation that identifies the corporate currency. This attribute is not currently used by the packingUnits resource.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the note.
  • Title: Creation Date
    Read Only: true
    Date when the user created the note record.
  • Title: Creator Party ID
    Value that uniquely identifies the creator of the note.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    Type of currency conversion rate. This attribute is not currently used by the packingUnits resource.
  • Title: Currency
    Maximum Length: 15
    Abbreviation that identifies the currency. This attribute is not currently used by the packingUnits resource.
  • Title: Delete Indicator
    Read Only: true
    Contains one of the following values: true or false. If true, then the note can be deleted. If false, then the note can be deleted. The default value is true.
  • Title: Primary Email
    Read Only: true
    Maximum Length: 320
    The email address of the user who created the note.
  • Title: Primary Address
    Read Only: true
    The address of the user who created the note.
  • Title: Primary Phone
    Read Only: true
    The phone number of the user who created the note.
  • Title: Last Update Date
    Read Only: true
    Date when the user most recently updated the note data.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who most recently updated the note record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    Login of the user who most recently updated the note record.
  • Links
  • Title: Note ID
    Read Only: true
    Value that uniquely identifies the note.
  • Maximum Length: 30
    The alternate unique identifier of the note. A user key that's system generated or from an external system.
  • Title: Title
    Maximum Length: 500
    The title of the note entered by the user.
  • Title: Note
    Text of the actual note.
  • Title: Type
    Maximum Length: 30
    Abbreviation that identifies the categorization of the note type.
  • Title: Parent Note ID
    Value that uniquely identifies the parent note.
  • Title: Party ID
    Read Only: true
    Value that uniquely identifies the party to which the note is associated.
  • Title: Author
    Read Only: true
    Maximum Length: 360
    Name of the user who created the record.
  • Title: Related Object Type
    Maximum Length: 30
    Abbreviation that identifies the object as defined in the OBJECTS metadata which is associated with the note. The object identifier is SHIPPING_LPN for packing units.
  • Title: Related Object
    Maximum Length: 64
    Value that uniquely identifies the packing unit.
  • Title: Update Indicator
    Read Only: true
    Contains one of the following values: true or false. If true, then the note can be updated. If false, then the note cannot be updated. The default value is true.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    Abbreviation that identifies the visibility level of the note.
Nested Schema : packingUnits-packingUnitDFFs-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to update one packing unit.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/packingUnits/PackingUnitId"

Example 1 cURL Command

Use the following cURL command to submit a request on the REST resource to update packing unit with weights/volumes.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/packingUnits/PackingUnitId"

Example 1 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
"GrossWeight": 151.7,
"TareWeight": 1.3,
"NetWeight": 150.4,
"ContainerVolume": 11
}

Example 2 cURL Command

Use the following cURL command to submit a request on the REST resource to update packing unit with weight and descriptive flex fields.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/packingUnits/PackingUnitId"

Example 2 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

 {
"GrossWeight": "1" ,
"packingUnitDFFs": [
{
"LPNId": 300100129350100,
"gs1": "UGS2S2",
"gs2": "14",
"gs3": "GSS16",
"__FLEX_Context": "LPNCSegs",
"lpncseg1":"VAL12",
"lpncseg2":"182",
"lpncseg3":"2017-03-12",
"lpncseg4":"2017-03-12T00:00:00.000-00:00"
}
]
}

Example 3 cURL Command

Use the following cURL command to submit a request on the REST resource to update packing unit with container item number.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/packingUnits/PackingUnitId"

Example 3 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

   {
"ContainerItemNumber" : "LOG-C2"
                   }

Back to Top