Jump to

• Request
• Response
• Examples

Update one serial

patch

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/lines/{linesUniqID}/child/lotSerials/{LotSerialId}

Request

Path Parameters

• LotSerialId(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=
• OrderKey(required): string
  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=
• linesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Order Lines resource and used to uniquely identify an instance of Order Lines. The client should not generate the hash key value. Instead, the client should query on the Order Lines collection resource in order to navigate to a specific instance of Order Lines to get the hash key.

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

• DeletedFlag: boolean
  Contains one of the following values: true or false. If true, then lot and serial lines are deleted during the patch or upsert operation. If false, then lot and serial lines aren't deleted. This is a transient attribute. Use this attribute only on an order line that includes an inventory transaction. This attribute doesn't have a default value.
• ItemRevisionNumber: string
  Title: Revision Number

  Maximum Length: 120

  Value that identifies the item revision.
• ItemSerialNumberFrom: string
  Title: From Serial Number

  Maximum Length: 120

  Starting serial number of a range of serial numbers.
• ItemSerialNumberTo: string
  Title: To Serial Number

  Maximum Length: 120

  Ending serial number of a range of serial numbers.
• Locator: string
  Concatenated segments for the locator flexfields from where the item is shipped from or received into.
• LocatorId: integer (int64)
  Locator where the application ships or receives the item.
• LotNumber: string
  Title: Lot Number

  Maximum Length: 320

  Identifies the quantity for the item.
• Quantity: number
  Quantity of lots and serials.

{
    "type":"object",
    "properties":{
        "DeletedFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then lot and serial lines are deleted during the patch or upsert operation. If false, then lot and serial lines aren't deleted. This is a transient attribute. Use this attribute only on an order line that includes an inventory transaction. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ItemRevisionNumber":{
            "title":"Revision Number",
            "maxLength":120,
            "type":"string",
            "description":"Value that identifies the item revision.",
            "nullable":true
        },
        "ItemSerialNumberFrom":{
            "title":"From Serial Number",
            "maxLength":120,
            "type":"string",
            "description":"Starting serial number of a range of serial numbers.",
            "nullable":true
        },
        "ItemSerialNumberTo":{
            "title":"To Serial Number",
            "maxLength":120,
            "type":"string",
            "description":"Ending serial number of a range of serial numbers.",
            "nullable":true
        },
        "Locator":{
            "type":"string",
            "description":"Concatenated segments for the locator flexfields from where the item is shipped from or received into.",
            "nullable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Locator where the application ships or receives the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":320,
            "type":"string",
            "description":"Identifies the quantity for the item.",
            "nullable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of lots and serials.",
            "nullable":true
        }
    }
}

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 : salesOrdersForOrderHub-lines-lotSerials-item-response

Type: object

Show Source

• DeletedFlag: boolean
  Contains one of the following values: true or false. If true, then lot and serial lines are deleted during the patch or upsert operation. If false, then lot and serial lines aren't deleted. This is a transient attribute. Use this attribute only on an order line that includes an inventory transaction. This attribute doesn't have a default value.
• ItemRevisionNumber: string
  Title: Revision Number

  Maximum Length: 120

  Value that identifies the item revision.
• ItemSerialNumberFrom: string
  Title: From Serial Number

  Maximum Length: 120

  Starting serial number of a range of serial numbers.
• ItemSerialNumberTo: string
  Title: To Serial Number

  Maximum Length: 120

  Ending serial number of a range of serial numbers.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Locator: string
  Concatenated segments for the locator flexfields from where the item is shipped from or received into.
• LocatorId: integer (int64)
  Locator where the application ships or receives the item.
• LotNumber: string
  Title: Lot Number

  Maximum Length: 320

  Identifies the quantity for the item.
• LotSerialId: integer (int64)
  Read Only: true

  Value that uniquely identifies the lot and serial.
• Quantity: number
  Quantity of lots and serials.
• SecondaryQuantity: number
  Read Only: true

  Quantity of the lot for the item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item.
• SourceLotSerialId: string
  Maximum Length: 50

  Value that uniquely identifies the lot and serial. The source application assigns this value.

{
    "type":"object",
    "properties":{
        "DeletedFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then lot and serial lines are deleted during the patch or upsert operation. If false, then lot and serial lines aren't deleted. This is a transient attribute. Use this attribute only on an order line that includes an inventory transaction. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ItemRevisionNumber":{
            "title":"Revision Number",
            "maxLength":120,
            "type":"string",
            "description":"Value that identifies the item revision.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemSerialNumberFrom":{
            "title":"From Serial Number",
            "maxLength":120,
            "type":"string",
            "description":"Starting serial number of a range of serial numbers.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemSerialNumberTo":{
            "title":"To Serial Number",
            "maxLength":120,
            "type":"string",
            "description":"Ending serial number of a range of serial numbers.",
            "nullable":true,
            "x-queryable":true
        },
        "Locator":{
            "type":"string",
            "description":"Concatenated segments for the locator flexfields from where the item is shipped from or received into.",
            "nullable":true,
            "x-queryable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Locator where the application ships or receives the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":320,
            "type":"string",
            "description":"Identifies the quantity for the item.",
            "nullable":true,
            "x-queryable":true
        },
        "LotSerialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the lot and serial.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of lots and serials.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryQuantity":{
            "type":"number",
            "description":"Quantity of the lot for the item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceLotSerialId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the lot and serial. The source application assigns this value.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Examples

This example describes how to update one serial.

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/salesOrdersForOrderHub/OrderKey/child/lines/linesUniqID/child/lotSerials/LotSerialId"

For example, use the following command:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_unref_return_lotserial_01/child/lines/00020000000EACED00057708000110F085167F110000000EACED00057708000110F085167F12/child/lotSerials/300100187750163"

Example 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.

You can achieve the same result with Create sales orders using the upsert-mode header parameter. Refer to the examples in the Create sales orders section to see how to update child resource in the existing order.

{ 
	"ItemSerialNumberFrom":"FROM10",
	"ItemSerialNumberTo":"TO10",
	"LocatorId":110,
	"LotNumber":"LOT10"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{}

Back to Top