Jump to

• Request
• Response

Get shipping parameters for all inventory organizations

get

/fscmRestApi/resources/11.13.18.05/shippingParameters

Request

Query Parameters

• expand: string
  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).
• fields: string
  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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the shipping parameters with the specified primary key.
    Finder Variables
    • OrganizationId; integer; Value that uniquely identifies the inventory organization.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • OrganizationCode; string; Abbreviation that identifies the inventory organization.
  • OrganizationId; integer; Value that uniquely identifies the inventory organization.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : shippingParameters

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/shippingParameters-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object shippingParameters-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/shippingParameters-item-response"
    }
}

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 : shippingParameters-item-response

Type: object

Show Source

• AllowFutureShipDateFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then future ship dates can be entered when the shipment is confirmed. If false, then future ship dates can't be entered when the shipment is confirmed. The default value is false.
• AppendingLimit: string
  Read Only: true

  Maximum Length: 255

  Value that indicates the point at which the system should stop adding shipment lines to a shipment. A list of accepted values is defined in the lookup type WSH_APPENDING_LIMIT.
• AppendingLimitCode: string
  Read Only: true

  Maximum Length: 1

  Abbreviation that identifies the value that indicates the point at which the system should stop adding shipment lines to a shipment. A list of accepted values is defined in the lookup type WSH_APPENDING_LIMIT.
• AutomaticallyPackFlag: boolean
  Read Only: true

  Contains one of the following values: true or false. If true, then shipment lines are packed automatically. If false, then shipment lines aren't packed automatically. The default value is false.
• BOLDocumentSequenceCategory: string
  Read Only: true

  Maximum Length: 30

  Value that specifies the document sequence category to use for the bill of lading.
• CarrierManifestFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then shipments can be sent to the carrier manifesting system so that this system can confirm the shipment. If false, then shipments can't be sent to the carrier manifesting system.
• CIDocumentSequenceCategory: string
  Read Only: true

  Maximum Length: 30

  Value that specifies the document sequence category to use for the commercial invoice.
• ConsolidateBoLinesFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the split backordered shipment lines are consolidated. If false, then the split backordered shipment lines aren't consolidated.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the shipping parameter.
• CreateShipmentsFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then released shipment lines are automatically assigned to a shipment during pick release. If false, then released shipment lines aren't automatically assigned to a shipment during pick release. The default value is false.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the shipping parameter.
• Currency: string
  Read Only: true

  Maximum Length: 255

  Name of the default currency.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the default currency.
• DeferInventoryInterfaceFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then shipping details aren't interfaced with Inventory and Order Management when the shipment is confirmed and closed. The Manage Shipment Interface scheduled process must be manually submitted to interface the shipping details. If false, then shipping details aren't interfaced when the shipment is confirmed and closed.
• DeferInventoryOnlineProcessingFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then inventory interface records inserted for updating shipping details with Inventory aren't processed automatically. The Create Inventory Transactions scheduled process must be manually submitted to process the inventory interface records. If false, then inventory interface records aren't processed automatically.
• EnforcePackingFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then shipment lines must be packed before confirming the shipment. If false, then shipment lines aren't required to be packed.
• EnforceShipMethodFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then shipping method is required for confirming the shipment. If false, then shipping method isn't required.
• EnforceShipSetFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then shipment set will be honored during pick release, and the shipment lines part of the shipment set won't be partially released. If false, then shipment set won't be honored during pick release.
• ExpressPickFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then express pick is enabled during the pick release process, which will stage the shipment line without movement request line creation, allocation, and pick confirmation. If false, then express pick isn't enabled during the pick release.
• GroupByCustomerFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then customer is used as one of the attributes to group shipment lines into shipments. If false, then customer isn't used as a grouping attribute.
• GroupByFOBFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then FOB is used as one of the attributes to group shipment lines into shipments. If false, then FOB isn't used as a grouping attribute.
• GroupByFreightTermsFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then freight term will be used as one of the attributes to group shipment lines into shipments. If false, then freight term won't be used as a grouping attribute.
• GroupByShipMethodFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then shipping method is used as one of the attributes to group shipment lines into shipments. If false, then shipping method isn't used as a grouping attribute.
• InvInterfaceBatchSize: number
  Read Only: true

  Value that specifies the batch size for the inventory interface.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the shipping parameter.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the shipping parameter.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 20

  Abbreviation that identifies the inventory organization.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory organization.
• OverShipTolerance: number
  Read Only: true

  Value that specifies the overshipment percentage to be set on the shipment lines of the transfer orders.
• PackingSlipStatusRequiredFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then packing slip status must be printed on the packing slip. If false, then packing slip status isn't required to be printed.
• PackingUnitCapacityMethod: string
  Read Only: true

  Maximum Length: 255

  Value that indicates how to calculate the capacity of the packing unit while packing. A list of accepted values is defined in the lookup WSH_PERCENT_FILL_FLAG.
• PackingUnitCapacityMethodCode: string
  Read Only: true

  Maximum Length: 1

  Abbreviation that indicates how to calculate the capacity of the packing unit while packing. A list of accepted values is defined in the lookup type WSH_PERCENT_FILL_FLAG.
• PackSlipDocumentSequenceCategory: string
  Read Only: true

  Maximum Length: 30

  Value that specifies the document sequence category to use for the packing slip.
• PickReleaseBatchSize: number
  Read Only: true

  Value that specifies the batch size for the pick release.
• PickReleaseChildProcessNumber: number
  Read Only: true

  Value that specifies the number of child processes that are run when a pick release process is submitted.
• PickSlipGroupingRule: string
  Read Only: true

  Maximum Length: 255

  Value of the criteria to determine the grouping of picks into pick slips.
• PickSlipGroupingRuleId: integer (int64)
  Read Only: true

  Value that uniquely identifies the criteria to determine the grouping of picks into pick slips.
• PickSlipLines: number
  Read Only: true

  Value that specifies the maximum number of pick slip lines to print on each pick slip.
• PortugalOptInFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the Portugal shipping flow is enabled. If false, then the Portugal shipping flow isn't enabled.
• PrintPickSlipMode: string
  Read Only: true

  Maximum Length: 255

  Value that specifies when the pick slips are printed during pick release. A list of accepted values is defined in the lookup WSH_PRINT_PICK_SLIP.
• PrintPickSlipModeCode: string
  Read Only: true

  Maximum Length: 1

  Abbreviation that specifies when the pick slips are printed during pick release. A list of accepted values is defined in the lookup type WSH_PRINT_PICK_SLIP.
• ProcessGsrImmediateFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the Generate Shipment Request scheduled process is used to process the shipment line, and then the event is published. If false, then the Generate Shipment Request scheduled process isn't used to process the shipment line.
• PublishTransactionalEventsFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the shipping transaction event for backordered quantities is always published. If false, then the shipping transaction event for backordered quantities is only published for transportation planned shipment lines.
• QuickShipEnabledFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then shipment lines can be shipped without pick release and pick confirm. If false, then shipment lines must be pick released.
• QuickShipLocator: string
  Read Only: true

  Maximum Length: 255

  Name of the default locator that's used for consuming material during the quick ship process.
• QuickShipLocatorId: integer (int64)
  Read Only: true

  Value that uniquely identifies the default locator that's used for consuming material during the quick ship process.
• QuickShipSubinventory: string
  Read Only: true

  Maximum Length: 10

  Value that identifies the default subinventory that's used for consuming material during the quick ship process.
• ReleaseSequenceRule: string
  Read Only: true

  Maximum Length: 255

  Value that determines the sequencing of shipment lines for a pick release.
• ReleaseSequenceRuleId: integer (int64)
  Read Only: true

  Value that uniquely identifies the sequencing of shipment lines for pick release or generating shipment requests.
• ShipConfirmRule: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the rules used on the shipment lines and shipment during ship confirmation.
• ShipConfirmRuleId: integer (int64)
  Read Only: true

  Value that uniquely identifies the ship confirm rule.
• ShipmentCreationCriteria: string
  Read Only: true

  Maximum Length: 255

  Value that determines the criteria for grouping shipment lines into shipments. A list of accepted values is defined in the lookup type WSH_AC_DEL_CRITERIA.
• ShipmentCreationCriteriaCode: string
  Read Only: true

  Maximum Length: 1

  Abbreviation that identifies the criteria for grouping shipment lines into shipments during pick release. A list of accepted values is defined in the lookup type WSH_AC_DEL_CRITERIA.
• ShipmentDescriptionRequiredFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then transportation reason must be printed on the packing slip. If false, then transportation reason isn't required to be printed.
• ShipOnFiscalDocumentApprovalFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the shipment is automatically confirmed and closed when the fiscal document is approved. If false, then the shipment isn't automatically confirmed and closed.
• ShippingToleranceBehavior: string
  Read Only: true

  Maximum Length: 255

  Value that determines if the shipment line will be closed when the shipped quantity meets the requested quantity or under tolerance quantity. A list of accepted values is defined in the lookup ORA_WSH_SHP_TOL_BEHAVIORS.
• ShippingToleranceBehaviorCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that determines if the shipment line will be closed when the shipped quantity meets the requested quantity or under tolerance quantity. A list of accepted values is defined in the lookup type ORA_WSH_SHP_TOL_BEHAVIORS.
• ShipSetBehavior: string
  Read Only: true

  Maximum Length: 255

  Value that indicates the system's behavior when the shipment set is broken during shipment confirmation. A list of accepted values is defined in the lookup WSH_EXCEPTION_BEHAVIOR.
• ShipSetBehaviorCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that indicates the system's behavior when the shipment set is broken during shipment confirmation. A list of accepted values is defined in the lookup type WSH_EXCEPTION_BEHAVIOR.
• StagedReturnToWmsFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the shipment lines created for returning goods to the supplier or customer are interfaced with an external execution system through the outbound shipment request process. If false, then the shipment lines aren't interfaced with an external execution system.
• StagingLocator: string
  Read Only: true

  Maximum Length: 255

  Name of the default locator where picked lines are staged.
• StagingLocatorId: integer (int64)
  Read Only: true

  Value that uniquely identifies the default locator where picked lines are staged.
• StagingSubinventory: string
  Read Only: true

  Maximum Length: 10

  Value that identifies the default subinventory where picked lines are staged.
• TradeComplianceMethod: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the method used for the line to be screened for trade compliance during pick release. A list of accepted values is defined in the lookup ORA_WSH_TRD_COMP_SCRN_MTHD.
• TradeComplianceMethodCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the method used for the line to be screened for trade compliance during pick release. A list of accepted values is defined in the lookup type ORA_WSH_TRD_COMP_SCRN_MTHD.
• TransportationReasonRequiredFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then shipment description must be printed on the packing slip. If false, then shipment description isn't required to be printed.
• UnderShipTolerance: number
  Read Only: true

  Value that specifies the undershipment percentage to be set on the shipment lines of the transfer orders.
• VolumeUOMClass: string
  Read Only: true

  Maximum Length: 255

  Value that specifies the default UOM class to be used for volume validations.
• VolumeUOMClassCode: string
  Read Only: true

  Maximum Length: 10

  Abbreviation that specifies the default UOM class to be used for volume validations.
• WeightUOMClass: string
  Read Only: true

  Maximum Length: 255

  Value that specifies the default UOM class to be used for weight validations.
• WeightUOMClassCode: string
  Read Only: true

  Maximum Length: 10

  Abbreviation that specifies the default UOM class to be used for weight validations.
• WmsItemSubstitutionFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then item substitution is allowed while sending the lines to an external system. If false, then item substitution isn't allowed.
• WmsReservationBehavior: string
  Read Only: true

  Maximum Length: 255

  Value that determines if the application sends fully reserved, partially reserved, or all shipment lines to external systems. A list of accepted values is defined in the lookup ORA_WSH_RSV_WMS_BEHAVIOR.
• WmsReservationBehaviourCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that determines if the application sends fully reserved, partially reserved, or all shipment lines to external systems. A list of accepted values is defined in the lookup type ORA_WSH_RSV_WMS_BEHAVIOR.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the shipping parameter.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ConsolidateBoLinesFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the split backordered shipment lines are consolidated. If false, then the split backordered shipment lines aren't consolidated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AllowFutureShipDateFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then future ship dates can be entered when the shipment is confirmed. If false, then future ship dates can't be entered when the shipment is confirmed. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AppendingLimitCode":{
            "maxLength":"1",
            "type":"string",
            "description":"Abbreviation that identifies the value that indicates the point at which the system should stop adding shipment lines to a shipment. A list of accepted values is defined in the lookup type WSH_APPENDING_LIMIT.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OverShipTolerance":{
            "type":"number",
            "description":"Value that specifies the overshipment percentage to be set on the shipment lines of the transfer orders.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeferInventoryInterfaceFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then shipping details aren't interfaced with Inventory and Order Management when the shipment is confirmed and closed. The Manage Shipment Interface scheduled process must be manually submitted to interface the shipping details. If false, then shipping details aren't interfaced when the shipment is confirmed and closed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShippingToleranceBehaviorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that determines if the shipment line will be closed when the shipped quantity meets the requested quantity or under tolerance quantity. A list of accepted values is defined in the lookup type ORA_WSH_SHP_TOL_BEHAVIORS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WmsReservationBehavior":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines if the application sends fully reserved, partially reserved, or all shipment lines to external systems. A list of accepted values is defined in the lookup ORA_WSH_RSV_WMS_BEHAVIOR.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeferInventoryOnlineProcessingFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then inventory interface records inserted for updating shipping details with Inventory aren't processed automatically. The Create Inventory Transactions scheduled process must be manually submitted to process the inventory interface records. If false, then inventory interface records aren't processed automatically.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UnderShipTolerance":{
            "type":"number",
            "description":"Value that specifies the undershipment percentage to be set on the shipment lines of the transfer orders.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the default currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "GroupByShipMethodFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then shipping method is used as one of the attributes to group shipment lines into shipments. If false, then shipping method isn't used as a grouping attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "GroupByFreightTermsFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then freight term will be used as one of the attributes to group shipment lines into shipments. If false, then freight term won't be used as a grouping attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PackSlipDocumentSequenceCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that specifies the document sequence category to use for the packing slip.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Currency":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the default currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PackingUnitCapacityMethod":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates how to calculate the capacity of the packing unit while packing. A list of accepted values is defined in the lookup WSH_PERCENT_FILL_FLAG.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "VolumeUOMClassCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Abbreviation that specifies the default UOM class to be used for volume validations.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CIDocumentSequenceCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that specifies the document sequence category to use for the commercial invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PackingUnitCapacityMethodCode":{
            "maxLength":"1",
            "type":"string",
            "description":"Abbreviation that indicates how to calculate the capacity of the packing unit while packing. A list of accepted values is defined in the lookup type WSH_PERCENT_FILL_FLAG.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the shipping parameter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipmentDescriptionRequiredFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then transportation reason must be printed on the packing slip. If false, then transportation reason isn't required to be printed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the shipping parameter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipOnFiscalDocumentApprovalFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the shipment is automatically confirmed and closed when the fiscal document is approved. If false, then the shipment isn't automatically confirmed and closed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PickSlipGroupingRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the criteria to determine the grouping of picks into pick slips.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PickReleaseChildProcessNumber":{
            "type":"number",
            "description":"Value that specifies the number of child processes that are run when a pick release process is submitted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TradeComplianceMethod":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the method used for the line to be screened for trade compliance during pick release. A list of accepted values is defined in the lookup ORA_WSH_TRD_COMP_SCRN_MTHD.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "GroupByCustomerFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then customer is used as one of the attributes to group shipment lines into shipments. If false, then customer isn't used as a grouping attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipSetBehaviorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that indicates the system's behavior when the shipment set is broken during shipment confirmation. A list of accepted values is defined in the lookup type WSH_EXCEPTION_BEHAVIOR.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PortugalOptInFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the Portugal shipping flow is enabled. If false, then the Portugal shipping flow isn't enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BOLDocumentSequenceCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that specifies the document sequence category to use for the bill of lading.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReleaseSequenceRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sequencing of shipment lines for pick release or generating shipment requests.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ShipConfirmRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship confirm rule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "WeightUOMClass":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that specifies the default UOM class to be used for weight validations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreateShipmentsFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then released shipment lines are automatically assigned to a shipment during pick release. If false, then released shipment lines aren't automatically assigned to a shipment during pick release. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WeightUOMClassCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Abbreviation that specifies the default UOM class to be used for weight validations.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipConfirmRule":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the rules used on the shipment lines and shipment during ship confirmation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipmentCreationCriteria":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines the criteria for grouping shipment lines into shipments. A list of accepted values is defined in the lookup type WSH_AC_DEL_CRITERIA.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PublishTransactionalEventsFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the shipping transaction event for backordered quantities is always published. If false, then the shipping transaction event for backordered quantities is only published for transportation planned shipment lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QuickShipSubinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Value that identifies the default subinventory that's used for consuming material during the quick ship process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StagingLocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the default locator where picked lines are staged.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StagedReturnToWmsFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the shipment lines created for returning goods to the supplier or customer are interfaced with an external execution system through the outbound shipment request process. If false, then the shipment lines aren't interfaced with an external execution system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PickSlipLines":{
            "type":"number",
            "description":"Value that specifies the maximum number of pick slip lines to print on each pick slip.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AutomaticallyPackFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then shipment lines are packed automatically. If false, then shipment lines aren't packed automatically. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QuickShipEnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then shipment lines can be shipped without pick release and pick confirm. If false, then shipment lines must be pick released.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrintPickSlipMode":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that specifies when the pick slips are printed during pick release. A list of accepted values is defined in the lookup WSH_PRINT_PICK_SLIP.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProcessGsrImmediateFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the Generate Shipment Request scheduled process is used to process the shipment line, and then the event is published. If false, then the Generate Shipment Request scheduled process isn't used to process the shipment line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrganizationCode":{
            "maxLength":"20",
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleaseSequenceRule":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines the sequencing of shipment lines for a pick release.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "VolumeUOMClass":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that specifies the default UOM class to be used for volume validations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnforceShipSetFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then shipment set will be honored during pick release, and the shipment lines part of the shipment set won't be partially released. If false, then shipment set won't be honored during pick release.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PickSlipGroupingRule":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the criteria to determine the grouping of picks into pick slips.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ExpressPickFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then express pick is enabled during the pick release process, which will stage the shipment line without movement request line creation, allocation, and pick confirmation. If false, then express pick isn't enabled during the pick release.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TradeComplianceMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the method used for the line to be screened for trade compliance during pick release. A list of accepted values is defined in the lookup type ORA_WSH_TRD_COMP_SCRN_MTHD.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipmentCreationCriteriaCode":{
            "maxLength":"1",
            "type":"string",
            "description":"Abbreviation that identifies the criteria for grouping shipment lines into shipments during pick release. A list of accepted values is defined in the lookup type WSH_AC_DEL_CRITERIA.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StagingSubinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Value that identifies the default subinventory where picked lines are staged.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EnforceShipMethodFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then shipping method is required for confirming the shipment. If false, then shipping method isn't required.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WmsItemSubstitutionFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then item substitution is allowed while sending the lines to an external system. If false, then item substitution isn't allowed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StagingLocator":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the default locator where picked lines are staged.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CarrierManifestFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then shipments can be sent to the carrier manifesting system so that this system can confirm the shipment. If false, then shipments can't be sent to the carrier manifesting system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipSetBehavior":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the system's behavior when the shipment set is broken during shipment confirmation. A list of accepted values is defined in the lookup WSH_EXCEPTION_BEHAVIOR.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QuickShipLocator":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the default locator that's used for consuming material during the quick ship process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "GroupByFOBFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then FOB is used as one of the attributes to group shipment lines into shipments. If false, then FOB isn't used as a grouping attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InvInterfaceBatchSize":{
            "type":"number",
            "description":"Value that specifies the batch size for the inventory interface.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QuickShipLocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the default locator that's used for consuming material during the quick ship process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ShippingToleranceBehavior":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines if the shipment line will be closed when the shipped quantity meets the requested quantity or under tolerance quantity. A list of accepted values is defined in the lookup ORA_WSH_SHP_TOL_BEHAVIORS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnforcePackingFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then shipment lines must be packed before confirming the shipment. If false, then shipment lines aren't required to be packed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrintPickSlipModeCode":{
            "maxLength":"1",
            "type":"string",
            "description":"Abbreviation that specifies when the pick slips are printed during pick release. A list of accepted values is defined in the lookup type WSH_PRINT_PICK_SLIP.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TransportationReasonRequiredFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then shipment description must be printed on the packing slip. If false, then shipment description isn't required to be printed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PickReleaseBatchSize":{
            "type":"number",
            "description":"Value that specifies the batch size for the pick release.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the shipping parameter.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PackingSlipStatusRequiredFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then packing slip status must be printed on the packing slip. If false, then packing slip status isn't required to be printed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WmsReservationBehaviourCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that determines if the application sends fully reserved, partially reserved, or all shipment lines to external systems. A list of accepted values is defined in the lookup type ORA_WSH_RSV_WMS_BEHAVIOR.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AppendingLimit":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the point at which the system should stop adding shipment lines to a shipment. A list of accepted values is defined in the lookup type WSH_APPENDING_LIMIT.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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