Update one ship confirm rule
patch
/fscmRestApi/resources/11.13.18.05/shipConfirmRules/{ShipConfirmRuleId}
Request
Path Parameters
-
ShipConfirmRuleId(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:
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
Root Schema : schema
Type:
Show Source
object-
ActionCode: string
Maximum Length:
1Value that indicates whether requested or shipped quantities are used as the source for shipped quantities and options applied during shipment confirmation if the source is shipped quantity and shipped quantity isn't manually entered for a staged line or lines. A list of acceptable values is defined in the lookup WSH_SCR_SHIP_QTY and WSH_SCR_SHIP_UNSPEC_QTY. -
CloseShipmentFlag: boolean
Title:
Close shipmentMaximum Length:1Contains one of the following values: true or false. If true, then the shipment confirmation closes the shipment. If false, then the shipment confirmation doesn't close the shipment. This attribute doesn't have a default value. -
CreateShipmentStageFlag: boolean
Title:
Create shipment for remaining staged quantitiesMaximum Length:1Contains one of the following values: true or false. If true, then the shipment confirmation creates a new shipment for the remaining staged quantity. If false, then the shipment confirmation doesn't create a shipment for the remaining staged quantity. This attribute doesn't have a default value. -
DeferInterfaceFlag: boolean
Title:
Defer sending inventory updates to integrated applicationsMaximum Length:1Contains one of the following values: true or false. If true, then the shipment details won't be interfaced with Inventory and Order Management when the shipment is closed. If false, then the shipment details will be interfaced when the shipment is closed. This attribute doesn't have a default value. -
Description: string
Title:
DescriptionMaximum Length:240Description of the ship confirm rule. -
EffectiveEndDate: string
(date-time)
Title:
End DateDate when the ship confirm rule becomes inactive. -
EffectiveStartDate: string
(date-time)
Title:
Start DateDate when the ship confirm rule becomes active. -
JobSetDisplayName: string
Maximum Length:
255Indicates the name of the job set to generate reports during shipment confirmation. -
JobSetName: string
Maximum Length:
4000Indicates the name of the job set to generate reports during shipment confirmation. -
JobSetPackageName: string
Maximum Length:
800Indicates the package name of the job set to generate reports during shipment confirmation. -
PackingSlipStatus: string
Maximum Length:
1Default Value:FAbbreviation of the status that's set for the packing slip during shipment confirmation when the shipment isn't set to close automatically. A list of acceptable values is defined in the lookup ORA_WSH_PACK_STATUS. -
PackSlipStatusMeaning: string
Status that's set for the packing slip during shipment confirmation when the shipment isn't set to close automatically.
-
ShipConfirmRuleName: string
Title:
NameMaximum Length:30Value that uniquely identifies the ship confirm rule. -
ShipMethodCode: string
Maximum Length:
30Abbreviation that identifies the shipping method. -
ShipMethodName: string
Title:
Override Shipping MethodMaximum Length:255Value that indicates the shipping method to use during shipment confirmation. -
ShipQuantityNotSpecifiedOption: string
Title:
Options if Shipped Quantities Aren't Manually EnteredAbbreviation that indicates the option applied during shipment confirmation if the shipped quantity isn't manually entered for a staged line or lines. A list of acceptable values is defined in the lookup WSH_SCR_SHIP_UNSPEC_QTY. -
ShipQuantityNotSpecifiedOptionMeaning: string
Title:
Options if Shipped Quantities Aren't Manually EnteredValue that indicates the option applied during shipment confirmation if the shipped quantity isn't manually entered for a staged line or lines. A list of acceptable values is defined in the lookup WSH_SCR_SHIP_UNSPEC_QTY. -
ShipWith: string
Title:
Ship WithAbbreviation that indicates whether requested or shipped quantities are used as the source for shipped quantities during shipment confirmation. A list of acceptable values is defined in the lookup WSH_SCR_SHIP_QTY. -
ShipWithMeaning: string
Title:
Ship WithValue that indicates whether requested or shipped quantities are used as the source for shipped quantities during shipment confirmation. A list of acceptable values is defined in the lookup WSH_SCR_SHIP_QTY.
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.
Root Schema : shipConfirmRules-item-response
Type:
Show Source
object-
ActionCode: string
Maximum Length:
1Value that indicates whether requested or shipped quantities are used as the source for shipped quantities and options applied during shipment confirmation if the source is shipped quantity and shipped quantity isn't manually entered for a staged line or lines. A list of acceptable values is defined in the lookup WSH_SCR_SHIP_QTY and WSH_SCR_SHIP_UNSPEC_QTY. -
CloseShipmentFlag: boolean
Title:
Close shipmentMaximum Length:1Contains one of the following values: true or false. If true, then the shipment confirmation closes the shipment. If false, then the shipment confirmation doesn't close the shipment. This attribute doesn't have a default value. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the ship confirm rule. -
CreateShipmentStageFlag: boolean
Title:
Create shipment for remaining staged quantitiesMaximum Length:1Contains one of the following values: true or false. If true, then the shipment confirmation creates a new shipment for the remaining staged quantity. If false, then the shipment confirmation doesn't create a shipment for the remaining staged quantity. This attribute doesn't have a default value. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the ship confirm rule. -
DeferInterfaceFlag: boolean
Title:
Defer sending inventory updates to integrated applicationsMaximum Length:1Contains one of the following values: true or false. If true, then the shipment details won't be interfaced with Inventory and Order Management when the shipment is closed. If false, then the shipment details will be interfaced when the shipment is closed. This attribute doesn't have a default value. -
Description: string
Title:
DescriptionMaximum Length:240Description of the ship confirm rule. -
EffectiveEndDate: string
(date-time)
Title:
End DateDate when the ship confirm rule becomes inactive. -
EffectiveStartDate: string
(date-time)
Title:
Start DateDate when the ship confirm rule becomes active. -
JobSetDisplayName: string
Maximum Length:
255Indicates the name of the job set to generate reports during shipment confirmation. -
JobSetName: string
Maximum Length:
4000Indicates the name of the job set to generate reports during shipment confirmation. -
JobSetPackageName: string
Maximum Length:
800Indicates the package name of the job set to generate reports during shipment confirmation. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the ship confirm rule. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the ship confirm rule. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PackingSlipStatus: string
Maximum Length:
1Default Value:FAbbreviation of the status that's set for the packing slip during shipment confirmation when the shipment isn't set to close automatically. A list of acceptable values is defined in the lookup ORA_WSH_PACK_STATUS. -
PackSlipStatusMeaning: string
Status that's set for the packing slip during shipment confirmation when the shipment isn't set to close automatically.
-
ShipConfirmRuleId: integer
(int64)
Read Only:
trueName of the ship confirm rule. -
ShipConfirmRuleName: string
Title:
NameMaximum Length:30Value that uniquely identifies the ship confirm rule. -
ShipMethodCode: string
Maximum Length:
30Abbreviation that identifies the shipping method. -
ShipMethodName: string
Title:
Override Shipping MethodMaximum Length:255Value that indicates the shipping method to use during shipment confirmation. -
ShipQuantityNotSpecifiedOption: string
Title:
Options if Shipped Quantities Aren't Manually EnteredAbbreviation that indicates the option applied during shipment confirmation if the shipped quantity isn't manually entered for a staged line or lines. A list of acceptable values is defined in the lookup WSH_SCR_SHIP_UNSPEC_QTY. -
ShipQuantityNotSpecifiedOptionMeaning: string
Title:
Options if Shipped Quantities Aren't Manually EnteredValue that indicates the option applied during shipment confirmation if the shipped quantity isn't manually entered for a staged line or lines. A list of acceptable values is defined in the lookup WSH_SCR_SHIP_UNSPEC_QTY. -
ShipWith: string
Title:
Ship WithAbbreviation that indicates whether requested or shipped quantities are used as the source for shipped quantities during shipment confirmation. A list of acceptable values is defined in the lookup WSH_SCR_SHIP_QTY. -
ShipWithMeaning: string
Title:
Ship WithValue that indicates whether requested or shipped quantities are used as the source for shipped quantities during shipment confirmation. A list of acceptable values is defined in the lookup WSH_SCR_SHIP_QTY.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.