Create ship confirm rules

post

/fscmRestApi/resources/11.13.18.05/shipConfirmRules

Request

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.
  • 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
Request Body - application/json ()
Root Schema : schema
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.
  • 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.
  • 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: 255
    Indicates the name of the job set to generate reports during shipment confirmation.
  • 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.
  • 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.
  • 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

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: 255
    Indicates the name of the job set to generate reports during shipment confirmation.
  • 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