Get all availability options

get

/fscmRestApi/resources/11.13.18.05/orderPromises/{UniqueOrderId}/child/AlternateOptions

Request

Path Parameters
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
  • 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 alternate availability options according to the fulfillment line identifier.
      Finder Variables:
      • FulfillmentLineId; string; Value that uniquley identifies a fulfillment line.
      • OptionRank; string; Value that uniquley identifies alternate availability.
      • SplitLineIdentifier; string; Value that uniquely identifies the fulfillment line split.
      • UniqueOrderId; string; Value that uniquely identifies the order.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • CarrierCalendar; string; Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site.
    • ConfigItem; string; Value that identifies the unique configuration item corresponding to the configuration sent for promising. This attribute is applicable only in the case of assemble to order demands.
    • DestinationOrg; string; Abbreviation that identifies the organization that represents the destination of supply for a transfer of supply.
    • DestinationReceivingCalendar; string; Value that indicates the receiving calendar for the customer or destination organization in case of an internal order.
    • ExpectedArrivalDate; string; Date when the fulfillment line is expected to be available at the customer ship-to site.
    • ExpectedAvailabilityOnRequestedDate; number; Number that indicates the available to promise inventory quantity on the requested date.
    • ExpectedAvailableItem; string; Value that identifies the item that is expected to be used for satisfying the customer demand. This attribute can be either the requested item or substitute of the requested item.
    • ExpectedAvailableQuantity; number; Number that indicates the quantity of the material that can be promised on the expected shipment date. In the case of splits, this quantity can be less than the requested quantity.
    • ExpectedAvailableQuantityUOM; string; Value that identifies the unit of measure used to represent the available quantity.
    • ExpectedCarrier; string; Value that identifies the suggested carrier from the ship-from organization to the customer ship-to site.
    • ExpectedDemandClass; string; Value that identifies the demand class that the order is associated with.
    • ExpectedDropShipSupplier; string; Value that identifies the suggested drop ship supplier.
    • ExpectedDropShipSupplierSite; string; Value that identifies the suggested drop ship supplier site. This attribute indicates the drop ship supplier location from where material is shipped to the customer ship-to site.
    • ExpectedDropShipSupplierSourceSystem; string; Value that identifies the source system to which the drop ship supplier and the supplier belong.
    • ExpectedMargin; number; Number that indicates the expected margin for the fulfillment line or availability option. Margin is calculated as the difference between the revenue and fulfillment cost associated with the availability option.
    • ExpectedMode; string; Value that identifies the suggested transport mode from the source inventory organization to destination inventory organization.
    • ExpectedPickDate; string; Date when the shipment is expected to be picked at the pickup organization by the customer.
    • ExpectedService; string; Value that represents the expected service level used for shipping from the ship-from organization to the customer ship-to site for the fulfillment line or availability option.
    • ExpectedSetArrivalDate; string; A date attribute that indicates the date on which the set of fulfillment lines are expected to arrive at the customer ship-to site.
    • ExpectedSetShipDate; string; A date attribute that indicates the date on which the set of fulfillment lines are expected to be shipped together from the shipping organization.
    • ExpectedShipDate; string; Date when the requested item line is expected to be shipped from the ship-from organization to the customer ship-to site.
    • ExpectedShipFromOrg; string; Value that indicates the expected shipping organization to the customer ship-to site for the fulfillment line or availability option.
    • ExpectedShippingCost; number; Number that indicates the expected shipping cost associated with the fulfillment line or availability option.
    • ExpectedTotalFulfilmentCost; integer; Number that indicates the total expected cost associated with the fulfillment line or availability option.
    • FillRate; number; Percentage of quantity that can be promised on the requested date.
    • FulfillmentLineId; string; Value that uniquely identifies the fulfillment line.
    • InstanceNumber; string; Value that identifies the source system from which the order promising service request originated.
    • InternalOrderType; string; Value that indicates the type of internal order. Valid values are TO, ISO, and SO.
    • InternalSupplyIdentifier; string; Number that identifies the source document for the internal order fulfillment line request.
    • LineFillRate; number; Number that indicates the percentage of quantity that can be promised by the requested date.
    • NumberOfATPItems; integer; Number of items for which the available to promise inventory was used in the availability option.
    • NumberOfCTPItems; integer; Number of items for which the capable to promise supply was used in the availability option.
    • NumberOfSplits; integer; Number of split lines generated for the fulfillment line.
    • NumberOfSubstitutions; integer; Number of end item substitutions generated for the fulfillment line.
    • OptionRank; string; Number that represents the unique identifier for the fulfillment line availability option.
    • OptionSummary; string; Summary of how the current set availability option is different from the default availability option.
    • ParentSplitLineIdentifier; string; Value that indicates the parent of the split fulfillment line. This attribute is generated only in case of an order that was split.
    • ParentfulfillIdentifier; string; Value that indicates the immediate parent of the fulfillment line. This attribute is applicable only for configured to order items.
    • Party; string; Value that indicates the party representing the customer.
    • Partysite; string; Value that indicates the party site corresponding to the customer ship-to site.
    • Price; number; Price per unit associated with the availability option.
    • Profit; number; Projected profit generated by this split line item.
    • PromisingStatus; string; Contains one of the following values: true or false. If true, then the request can be completely met by the requested arrival date. If false, then can't be met. This attribute doesn't have a default value.
    • PromisingType; string; Type of promise. This attribute can represent either ship date or arrival date based promising.
    • RequestedDate; string; Date when the material is requested to be available. Depending on the request type this attribute represents the requested ship date or the request arrival date.
    • RequestedItem; string; Value that uniquely identifies the item that is being requested.
    • SalesOrderNumber; string; Value that uniquely identifies the sales order for which the fulfillment line is created.
    • SetName; string; This column indicates the Set Name of the fulfillment lines.
    • SourcingRule; string; Value that identifies the sourcing rule that was used.
    • SplitLineIdentifier; string; Value that uniquely identifies the fulfillment line split. A unique number is generated in case of an order that was split.
    • TotalMargin; number; Total margin for the fulfillment line or availability option.
    • TotalPrice; number; Total price for the fulfillment line or availability option.
    • TotalProfit; number; Total profit for the fulfillment line or availability option.
    • TotalValue; number; Total value for the fulfillment line or availability option.
    • UniqueOrderId; string; Value that uniquely identifies the order for the request.
    • Value; number; Value associated with the fulfillment line availability response.
  • 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
  • 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 : orderPromises-AlternateOptions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : orderPromises-AlternateOptions-item-response
Type: object
Show Source
Nested Schema : Pegging Details
Type: array
Title: Pegging Details
The Pegging Details resource manages the supply and demand peggings for a given fulfillment line.
Show Source
Nested Schema : orderPromises-AlternateOptions-PeggingDetails-item-response
Type: object
Show Source
Back to Top