1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Ship Confirm Rules

Get one ship confirm rule

get

/fscmRestApi/resources/11.13.18.05/shipConfirmRules/{ShipConfirmRuleId}

Request

Path Parameters
  • 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=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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.

There's no request body for this operation.

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 : shipConfirmRules-item-response
Type: object
Show Source
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 64
    User who created the ship confirm rule.
  • 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.
  • Read Only: true
    Date when the user created the ship confirm rule.
  • 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.
  • Title: Description
    Maximum Length: 240
    Description of the ship confirm rule.
  • Title: End Date
    Date when the ship confirm rule becomes inactive.
  • Title: Start Date
    Date when the ship confirm rule becomes active.
  • Maximum Length: 4000
    Indicates the name of the job set to generate reports during shipment confirmation.
  • Maximum Length: 800
    Indicates the package name of the job set to generate reports during shipment confirmation.
  • Read Only: true
    Date when the user most recently updated the ship confirm rule.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the ship confirm rule.
  • Links
  • 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.
  • Status that's set for the packing slip during shipment confirmation when the shipment isn't set to close automatically.
  • Read Only: true
    Name of the ship confirm rule.
  • Title: Name
    Maximum Length: 30
    Value that uniquely identifies the ship confirm rule.
  • Maximum Length: 30
    Abbreviation that identifies the shipping method.
  • Title: Override Shipping Method
    Maximum Length: 255
    Value that indicates the shipping method to use during shipment confirmation.
  • 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.
  • 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.
  • 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.
  • 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.
Back to Top

Examples

This example describes how to get one ship confirm rule.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/shipConfirmRules/ShipConfirmRuleId"

For example, the following command gets the ship confirm rule for the ship confirm rule identifier 1.

curl -u username:password "https://servername/fscmRestApi/resources/version/shipConfirmRules/1?onlyData=true"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "CloseShipmentFlag": true,
    "DeferInterfaceFlag": false,
    "ActionCode": "S",
    "CreatedBy": "1000148",
    "CreationDate": "2003-06-20T13:03:54+00:00",
    "Description": null,
    "EffectiveEndDate": null,
    "EffectiveStartDate": "2003-06-20T00:00:00+00:00",
    "JobSetName": "WshShipConfirmDocumentJobSet",
    "JobSetPackageName": "/oracle/apps/ess/scm/shipping/shipConfirm/deliveries/",
    "LastUpdateDate": "2017-11-28T14:48:07+00:00",
    "LastUpdatedBy": "FUSION",
    "PackSlipStatusMeaning": null,
    "PackingSlipStatus": null,
    "ShipConfirmRuleId": 1,
    "ShipConfirmRuleName": "Auto Ship",
    "ShipMethodCode": null,
    "ShipMethodName": null,
    "ShipQuantityNotSpecifiedOption": "S",
    "ShipQuantityNotSpecifiedOptionMeaning": "Ship requested quantities",
    "ShipWith": "S",
    "ShipWithMeaning": "Ship quantities",
    "CreateShipmentStageFlag": true
}
Back to Top