Create ship confirm rules
post
/fscmRestApi/resources/11.13.18.05/shipConfirmRules
Request
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.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActionCode: string
Maximum Length:
1
Value 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 shipment
Maximum Length:1
Contains 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 quantities
Maximum Length:1
Contains 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 applications
Maximum Length:1
Contains 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:
Description
Maximum Length:240
Description of the ship confirm rule. -
EffectiveEndDate: string
(date-time)
Title:
End Date
Date when the ship confirm rule becomes inactive. -
EffectiveStartDate: string
(date-time)
Title:
Start Date
Date when the ship confirm rule becomes active. -
JobSetDisplayName: string
Maximum Length:
255
Indicates the name of the job set to generate reports during shipment confirmation. -
JobSetName: string
Maximum Length:
4000
Indicates the name of the job set to generate reports during shipment confirmation. -
JobSetPackageName: string
Maximum Length:
800
Indicates the package name of the job set to generate reports during shipment confirmation. -
PackingSlipStatus: string
Maximum Length:
1
Default Value:F
Abbreviation 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:
Name
Maximum Length:30
Value that uniquely identifies the ship confirm rule. -
ShipMethodCode: string
Maximum Length:
30
Abbreviation that identifies the shipping method. -
ShipMethodName: string
Title:
Override Shipping Method
Maximum Length:255
Value that indicates the shipping method to use during shipment confirmation. -
ShipQuantityNotSpecifiedOption: string
Title:
Options if Shipped Quantities Aren't Manually Entered
Abbreviation 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 Entered
Value 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 With
Abbreviation 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 With
Value 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:
1
Value 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 shipment
Maximum Length:1
Contains 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:
true
Maximum Length:64
User who created the ship confirm rule. -
CreateShipmentStageFlag: boolean
Title:
Create shipment for remaining staged quantities
Maximum Length:1
Contains 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:
true
Date when the user created the ship confirm rule. -
DeferInterfaceFlag: boolean
Title:
Defer sending inventory updates to integrated applications
Maximum Length:1
Contains 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:
Description
Maximum Length:240
Description of the ship confirm rule. -
EffectiveEndDate: string
(date-time)
Title:
End Date
Date when the ship confirm rule becomes inactive. -
EffectiveStartDate: string
(date-time)
Title:
Start Date
Date when the ship confirm rule becomes active. -
JobSetDisplayName: string
Maximum Length:
255
Indicates the name of the job set to generate reports during shipment confirmation. -
JobSetName: string
Maximum Length:
4000
Indicates the name of the job set to generate reports during shipment confirmation. -
JobSetPackageName: string
Maximum Length:
800
Indicates the package name of the job set to generate reports during shipment confirmation. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the ship confirm rule. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the ship confirm rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PackingSlipStatus: string
Maximum Length:
1
Default Value:F
Abbreviation 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:
true
Name of the ship confirm rule. -
ShipConfirmRuleName: string
Title:
Name
Maximum Length:30
Value that uniquely identifies the ship confirm rule. -
ShipMethodCode: string
Maximum Length:
30
Abbreviation that identifies the shipping method. -
ShipMethodName: string
Title:
Override Shipping Method
Maximum Length:255
Value that indicates the shipping method to use during shipment confirmation. -
ShipQuantityNotSpecifiedOption: string
Title:
Options if Shipped Quantities Aren't Manually Entered
Abbreviation 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 Entered
Value 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 With
Abbreviation 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 With
Value 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.