Jump to

• Request
• Response

POST action not supported

post

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

Request

Path Parameters

• UniqueOrderId(required): string
  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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CarrierCalendar: string
  Maximum Length: 255

  Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site.
• ConfigItem: string
  Maximum Length: 255

  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
  Maximum Length: 255

  Abbreviation that identifies the organization that represents the destination of supply for a transfer of supply.
• DestinationReceivingCalendar: string
  Maximum Length: 255

  Value that indicates the receiving calendar for the customer or destination organization in case of an internal order.
• ExpectedArrivalDate: string (date-time)
  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
  Maximum Length: 255

  Value that identifies the item that's 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
  Maximum Length: 255

  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
  Maximum Length: 255

  Value that identifies the suggested drop ship supplier.
• ExpectedDropShipSupplierSite: string
  Maximum Length: 255

  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
  Maximum Length: 255

  Source application used by the drop ship supplier to promise the fulfillment line.
• 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-time)
  Date when the item is expected to be picked at the ship-from organization.
• 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.
• ExpectedShipDate: string (date-time)
  Date when the requested item line is expected to be shipped from the ship-from organization to the customer ship-to site.
• ExpectedShipFromOrg: string
  Maximum Length: 255

  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 (int64)
  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
  Maximum Length: 255

  Value that uniquely identifies the fulfillment line.
• InstanceNumber: string
  Maximum Length: 255

  Value that identifies the source system from which the order promising service request originated.
• InternalOrderType: string
  Maximum Length: 255

  Value that indicates the type of internal order. Valid values are TO, ISO, and SO.
• InternalSupplyIdentifier: string
  Maximum Length: 255

  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
  Maximum Length: 255

  Number that represents the unique identifier for the fulfillment line availability option.
• OptionSummary: string
  Maximum Length: 255

  Summary of how the current set availability option is different from the default availability option.
• ParentfulfillIdentifier: string
  Maximum Length: 255

  Value that indicates the immediate parent of the fulfillment line. This attribute is applicable only for configured to order items.
• ParentSplitLineIdentifier: string
  Maximum Length: 255

  Value that indicates the parent of the split fulfillment line. This attribute is generated only in case of an order that was split.
• Party: string
  Maximum Length: 255

  Value that indicates the party representing the customer.
• Partysite: string
  Maximum Length: 255

  Value that indicates the party site corresponding to the customer ship-to site.
• PeggingDetails: array Pegging Details
  Title: Pegging Details

  The Pegging Details resource manages the supply and demand pegging for a given fulfillment line.
• Price: number
  Price per unit associated with the availability option.
• Profit: number
  Projected profit generated by this split line item.
• PromisingStatus: string
  Maximum Length: 255

  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
  Maximum Length: 255

  Type of promise. This attribute can represent either ship date or arrival date based promising.
• RequestedDate: string (date-time)
  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
  Maximum Length: 255

  Value that uniquely identifies the item that's being requested.
• SalesOrderNumber: string
  Maximum Length: 255

  Value that uniquely identifies the sales order for which the fulfillment line is created.
• SourcingRule: string
  Maximum Length: 255

  Value that identifies the sourcing rule that was used.
• SplitLineIdentifier: string
  Maximum Length: 255

  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
  Maximum Length: 255

  Value that uniquely identifies the order for the request.
• Value: number
  Value associated with the fulfillment line availability response.

{
    "type":"object",
    "properties":{
        "Partysite":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the party site corresponding to the customer ship-to site.",
            "nullable":true
        },
        "DestinationReceivingCalendar":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the receiving calendar for the customer or destination organization in case of an internal order.",
            "nullable":true
        },
        "InstanceNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the source system from which the order promising service request originated.",
            "nullable":true
        },
        "SourcingRule":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the sourcing rule that was used.",
            "nullable":true
        },
        "OptionSummary":{
            "maxLength":255,
            "type":"string",
            "description":"Summary of how the current set availability option is different from the default availability option.",
            "nullable":true
        },
        "ExpectedMode":{
            "type":"string",
            "description":"Value that identifies the suggested transport mode from the source inventory organization to destination inventory organization.",
            "nullable":true
        },
        "RequestedItem":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the item that's being requested.",
            "nullable":true
        },
        "ExpectedDropShipSupplierSite":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ExpectedService":{
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "TotalValue":{
            "type":"number",
            "description":"Total value for the fulfillment line or availability option.",
            "nullable":true
        },
        "NumberOfSplits":{
            "type":"integer",
            "description":"Number of split lines generated for the fulfillment line.",
            "nullable":true
        },
        "RequestedDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true
        },
        "Profit":{
            "type":"number",
            "description":"Projected profit generated by this split line item.",
            "nullable":true
        },
        "ExpectedArrivalDate":{
            "type":"string",
            "description":"Date when the fulfillment line is expected to be available at the customer ship-to site.",
            "format":"date-time",
            "nullable":true
        },
        "DestinationOrg":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization that represents the destination of supply for a transfer of supply.",
            "nullable":true
        },
        "UniqueOrderId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the order for the request.",
            "nullable":true
        },
        "SplitLineIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the fulfillment line split. A unique number is generated in case of an order that was split.",
            "nullable":true
        },
        "SalesOrderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the sales order for which the fulfillment line is created.",
            "nullable":true
        },
        "PromisingStatus":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "Price":{
            "type":"number",
            "description":"Price per unit associated with the availability option.",
            "nullable":true
        },
        "FulfillmentLineId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the fulfillment line.",
            "nullable":true
        },
        "Value":{
            "type":"number",
            "description":"Value associated with the fulfillment line availability response.",
            "nullable":true
        },
        "TotalMargin":{
            "type":"number",
            "description":"Total margin for the fulfillment line or availability option.",
            "nullable":true
        },
        "InternalOrderType":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the type of internal order. Valid values are TO, ISO, and SO.",
            "nullable":true
        },
        "ExpectedAvailableQuantity":{
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "ExpectedAvailableQuantityUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the unit of measure used to represent the available quantity.",
            "nullable":true
        },
        "NumberOfATPItems":{
            "type":"integer",
            "description":"Number of items for which the available to promise inventory was used in the availability option.",
            "nullable":true
        },
        "NumberOfCTPItems":{
            "type":"integer",
            "description":"Number of items for which the capable to promise supply was used in the availability option.",
            "nullable":true
        },
        "ExpectedAvailabilityOnRequestedDate":{
            "type":"number",
            "description":"Number that indicates the available to promise inventory quantity on the requested date.",
            "nullable":true
        },
        "FillRate":{
            "type":"number",
            "description":"Percentage of quantity that can be promised on the requested date.",
            "nullable":true
        },
        "InternalSupplyIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the source document for the internal order fulfillment line request.",
            "nullable":true
        },
        "ExpectedShippingCost":{
            "type":"number",
            "description":"Number that indicates the expected shipping cost associated with the fulfillment line or availability option.",
            "nullable":true
        },
        "ConfigItem":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ExpectedPickDate":{
            "type":"string",
            "description":"Date when the item is expected to be picked at the ship-from organization.",
            "format":"date-time",
            "nullable":true
        },
        "LineFillRate":{
            "type":"number",
            "description":"Number that indicates the percentage of quantity that can be promised by the requested date.",
            "nullable":true
        },
        "ExpectedDemandClass":{
            "type":"string",
            "description":"Value that identifies the demand class that the order is associated with.",
            "nullable":true
        },
        "OptionRank":{
            "maxLength":255,
            "type":"string",
            "description":"Number that represents the unique identifier for the fulfillment line availability option.",
            "nullable":true
        },
        "CarrierCalendar":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site.",
            "nullable":true
        },
        "Party":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the party representing the customer.",
            "nullable":true
        },
        "PeggingDetails":{
            "title":"Pegging Details",
            "type":"array",
            "description":"The Pegging Details resource manages the supply and demand pegging for a given fulfillment line.",
            "items":{
                "$ref":"#/components/schemas/orderPromises-AlternateOptions-PeggingDetails-item-post-request"
            }
        },
        "ParentSplitLineIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the parent of the split fulfillment line. This attribute is generated only in case of an order that was split.",
            "nullable":true
        },
        "ExpectedDropShipSupplier":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the suggested drop ship supplier.",
            "nullable":true
        },
        "TotalProfit":{
            "type":"number",
            "description":"Total profit for the fulfillment line or availability option.",
            "nullable":true
        },
        "ExpectedMargin":{
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "ExpectedDropShipSupplierSourceSystem":{
            "maxLength":255,
            "type":"string",
            "description":"Source application used by the drop ship supplier to promise the fulfillment line.",
            "nullable":true
        },
        "ExpectedTotalFulfilmentCost":{
            "type":"integer",
            "description":"Number that indicates the total expected cost associated with the fulfillment line or availability option.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            }
        },
        "ExpectedShipDate":{
            "type":"string",
            "description":"Date when the requested item line is expected to be shipped from the ship-from organization to the customer ship-to site.",
            "format":"date-time",
            "nullable":true
        },
        "ExpectedAvailableItem":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the item that's expected to be used for satisfying the customer demand. This attribute can be either the requested item or substitute of the requested item.",
            "nullable":true
        },
        "NumberOfSubstitutions":{
            "type":"integer",
            "description":"Number of end item substitutions generated for the fulfillment line.",
            "nullable":true
        },
        "ExpectedCarrier":{
            "type":"string",
            "description":"Value that identifies the suggested carrier from the ship-from organization to the customer ship-to site.",
            "nullable":true
        },
        "TotalPrice":{
            "type":"number",
            "description":"Total price for the fulfillment line or availability option.",
            "nullable":true
        },
        "PromisingType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of promise. This attribute can represent either ship date or arrival date based promising.",
            "nullable":true
        },
        "ExpectedShipFromOrg":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the expected shipping organization to the customer ship-to site for the fulfillment line or availability option.",
            "nullable":true
        },
        "ParentfulfillIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the immediate parent of the fulfillment line. This attribute is applicable only for configured to order items.",
            "nullable":true
        }
    }
}

Nested Schema : Pegging Details

Type: array

Title: Pegging Details

The Pegging Details resource manages the supply and demand pegging for a given fulfillment line.

Show Source

• Array of: object schema

{
    "title":"Pegging Details",
    "type":"array",
    "description":"The Pegging Details resource manages the supply and demand pegging for a given fulfillment line.",
    "items":{
        "$ref":"#/components/schemas/orderPromises-AlternateOptions-PeggingDetails-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AllocationRule: string
  Maximum Length: 255

  Value that identifies the allocation rule applicable to the demand class associated with the order.
• AlternateResource: string
  Maximum Length: 255

  Contains one of the following values: true or false. If true, then an alternate resources is considered. If false, then an alternate resources isn't considered. This attribute doesn't have a default value.
• ArrivalDate: string (date-time)
  Date when the purchased supply will be available at the destination organization.
• ATPCost: integer (int64)
  Number that indicates the cost associated with the available-to-promise inventory used for promising the fulfillment line.
• ATPmode: string
  Maximum Length: 255

  Value that indicates the mode of order promising used to promise the order. Valid values are infinite, lead-time, and supply chain search.
• AvailabilityOption: string
  Maximum Length: 38

  Value that identifies an availability option.
• AvailableItem: string
  Maximum Length: 255

  Value that uniquely identifies the item that's available.
• BackToBackFlag: boolean
  Contains one of the following values: true or false. If true, then the item is a back to back enabled item. If false, then the item isn't a back to back enabled item. This attribute doesn't have a default value.
• BOMCode: string
  Maximum Length: 255

  Abbreviation that identifies the bill of material used in the capable to promise calculations for the fulfillment line request.
• CarrierCalendar: string
  Maximum Length: 255

  Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site.
• ConsumptionDate: string (date-time)
  Date when resource availability information needs to be returned.
• DemandClass: string
  Maximum Length: 255

  Value that identifies the demand class that the order is associated with.
• DepartmentId: string
  Maximum Length: 255

  Value that identifies the department or work center to which a resource belongs.
• DestinationOrgId: string
  Maximum Length: 255

  Value that uniquely identifies the organization that represents the destination of supply for the transfer of supply.
• DropshipSupplier: string
  Maximum Length: 255

  Name of the drop ship supplier that ships items directly to the customer.
• DropshipSupplierSite: string
  Maximum Length: 255

  Name of the drop ship supplier site that ships items directly to the customer.
• EndDate: string (date-time)
  Date when manufacturing ends for the item.
• ExpectedCarrier: string
  Maximum Length: 255

  Value that identifies the suggested carrier from the source inventory organization to destination inventory organization.
• ExpectedMode: string
  Maximum Length: 255

  Value that identifies the mode of transport for shipping the material from the source inventory organization to the destination inventory organization, suggested by order promising.
• ExpectedService: string
  Maximum Length: 255

  Value that identifies the suggested service level used for shipping the material from the source inventory organization to destination inventory organization.
• FixedLeadTime: string
  Maximum Length: 255

  Number of days of manufacturing lead time that's independent of the order quantity.
• FulfillmentlineId: string
  Maximum Length: 38

  Value that indicates the unique order identifier for the request.
• Item: string
  Maximum Length: 255

  Value that uniquely identifies the item that's requested.
• LeadTime: string
  Maximum Length: 255

  Value that indicates the number of days of lead time.
• LineId: integer (int64)
  Value that uniquely identifies the order line.
• ManufacturingCalendar: string
  Maximum Length: 255

  Calendar that's associated with the manufacturing operations at an organization.
• OptionRank: integer (int64)
  Number that indicates the rank of the availability option.
• OrgId: string
  Maximum Length: 255

  Value that uniquely identifies the organization associated with the item.
• PeggedATPType: string
  Maximum Length: 255

  Type of the supply.
• PeggingdocId: string
  Maximum Length: 255

  Value that uniquely identifies the supply and demand pegging.
• PostprocessingLeadTime: string
  Maximum Length: 255

  Number of days required to make an item available in inventory from the time it received.
• PreprocessingLeadTime: string
  Maximum Length: 255

  Number of days required to release a purchase order or create a job from the time the requirement is identified.
• ProcessingLeadTime: string
  Maximum Length: 255

  Number of days required to procure or manufacture an item.
• Quantity: integer (int64)
  Number that indicates the quantity of the available item.
• QuantityUOM: string
  Maximum Length: 255

  Value that indicates the unit of measure used for quantity.
• ReceivingCalendar: string
  Maximum Length: 255

  Value that identifies the receiving calendar used for receiving the material at the inventory organization or customer ship-to site.
• RequiredDate: string (date-time)
  Date when the material is required.
• RequiredQuantity: number
  Number that indicates the quantity required for promising the fulfillment line.
• ResourceCalendar: string
  Maximum Length: 255

  Value that identifies the calendar of the resource for which the availability is to be determined.
• ResourceId: string
  Maximum Length: 255

  Value that identifies the manufacturing resource.
• RoutingCode: string
  Maximum Length: 255

  Abbreviation that identifies the routing used in the capable to promise calculations for the fulfillment line request.
• ShipDate: string (date-time)
  Date when the supply will be shipped from the supplier site or source organization.
• ShippingCalendar: string
  Maximum Length: 255

  Value that identifies the shipping calendar used for shipping the material from supplier site to the inventory organization or the customer ship-to site.
• SourceOrgId: string
  Maximum Length: 255

  Value that uniquely identifies the organization that's the source of supply.
• StartDate: string (date-time)
  Date when manufacturing is expected to start for the item.
• SupplierId: string
  Maximum Length: 255

  Value that uniquely identifies the item supplier from whom supply is procured.
• SupplierSiteId: string
  Maximum Length: 255

  Value that uniquely identifies the item supplier site from which supply is procured.
• TransitLeadTime: string
  Maximum Length: 255

  Number of days required for transporting the requested item from source organization to the destination organization.
• UniqueOrderId: string
  Maximum Length: 38

  Value that uniquely identifies the fulfillment line.
• VariableLeadTime: string
  Maximum Length: 255

  Number that indicates the portion of manufacturing lead time that's dependent on order quantity.

{
    "type":"object",
    "properties":{
        "AllocationRule":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the allocation rule applicable to the demand class associated with the order.",
            "nullable":true
        },
        "ExpectedMode":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the mode of transport for shipping the material from the source inventory organization to the destination inventory organization, suggested by order promising.",
            "nullable":true
        },
        "ExpectedService":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the suggested service level used for shipping the material from the source inventory organization to destination inventory organization.",
            "nullable":true
        },
        "ReceivingCalendar":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the receiving calendar used for receiving the material at the inventory organization or customer ship-to site.",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when manufacturing is expected to start for the item.",
            "format":"date-time",
            "nullable":true
        },
        "Item":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the item that's requested.",
            "nullable":true
        },
        "PeggingdocId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the supply and demand pegging.",
            "nullable":true
        },
        "RequiredDate":{
            "type":"string",
            "description":"Date when the material is required.",
            "format":"date-time",
            "nullable":true
        },
        "ShippingCalendar":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the shipping calendar used for shipping the material from supplier site to the inventory organization or the customer ship-to site.",
            "nullable":true
        },
        "UniqueOrderId":{
            "maxLength":38,
            "type":"string",
            "description":"Value that uniquely identifies the fulfillment line.",
            "nullable":true
        },
        "PeggedATPType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of the supply.",
            "nullable":true
        },
        "BOMCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the bill of material used in the capable to promise calculations for the fulfillment line request.",
            "nullable":true
        },
        "ShipDate":{
            "type":"string",
            "description":"Date when the supply will be shipped from the supplier site or source organization.",
            "format":"date-time",
            "nullable":true
        },
        "PreprocessingLeadTime":{
            "maxLength":255,
            "type":"string",
            "description":"Number of days required to release a purchase order or create a job from the time the requirement is identified.",
            "nullable":true
        },
        "SupplierId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the item supplier from whom supply is procured.",
            "nullable":true
        },
        "ConsumptionDate":{
            "type":"string",
            "description":"Date when resource availability information needs to be returned.",
            "format":"date-time",
            "nullable":true
        },
        "AlternateResource":{
            "maxLength":255,
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then an alternate resources is considered. If false, then an alternate resources isn't considered. This attribute doesn't have a default value.",
            "nullable":true
        },
        "LeadTime":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the number of days of lead time.",
            "nullable":true
        },
        "ATPCost":{
            "type":"integer",
            "description":"Number that indicates the cost associated with the available-to-promise inventory used for promising the fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            }
        },
        "FulfillmentlineId":{
            "maxLength":38,
            "type":"string",
            "description":"Value that indicates the unique order identifier for the request.",
            "nullable":true
        },
        "PostprocessingLeadTime":{
            "maxLength":255,
            "type":"string",
            "description":"Number of days required to make an item available in inventory from the time it received.",
            "nullable":true
        },
        "ATPmode":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the mode of order promising used to promise the order. Valid values are infinite, lead-time, and supply chain search.",
            "nullable":true
        },
        "FixedLeadTime":{
            "maxLength":255,
            "type":"string",
            "description":"Number of days of manufacturing lead time that's independent of the order quantity.",
            "nullable":true
        },
        "OptionRank":{
            "type":"integer",
            "description":"Number that indicates the rank of the availability option.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":38
            }
        },
        "CarrierCalendar":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site.",
            "nullable":true
        },
        "RequiredQuantity":{
            "type":"number",
            "description":"Number that indicates the quantity required for promising the fulfillment line.",
            "nullable":true
        },
        "BackToBackFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the item is a back to back enabled item. If false, then the item isn't a back to back enabled item. This attribute doesn't have a default value.",
            "nullable":true
        },
        "SupplierSiteId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the item supplier site from which supply is procured.",
            "nullable":true
        },
        "DropshipSupplierSite":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the drop ship supplier site that ships items directly to the customer.",
            "nullable":true
        },
        "DropshipSupplier":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the drop ship supplier that ships items directly to the customer.",
            "nullable":true
        },
        "ProcessingLeadTime":{
            "maxLength":255,
            "type":"string",
            "description":"Number of days required to procure or manufacture an item.",
            "nullable":true
        },
        "QuantityUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the unit of measure used for quantity.",
            "nullable":true
        },
        "VariableLeadTime":{
            "maxLength":255,
            "type":"string",
            "description":"Number that indicates the portion of manufacturing lead time that's dependent on order quantity.",
            "nullable":true
        },
        "SourceOrgId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the organization that's the source of supply.",
            "nullable":true
        },
        "ManufacturingCalendar":{
            "maxLength":255,
            "type":"string",
            "description":"Calendar that's associated with the manufacturing operations at an organization.",
            "nullable":true
        },
        "AvailableItem":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the item that's available.",
            "nullable":true
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the order line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":38
            }
        },
        "RoutingCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the routing used in the capable to promise calculations for the fulfillment line request.",
            "nullable":true
        },
        "TransitLeadTime":{
            "maxLength":255,
            "type":"string",
            "description":"Number of days required for transporting the requested item from source organization to the destination organization.",
            "nullable":true
        },
        "AvailabilityOption":{
            "maxLength":38,
            "type":"string",
            "description":"Value that identifies an availability option.",
            "nullable":true
        },
        "Quantity":{
            "type":"integer",
            "description":"Number that indicates the quantity of the available item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":38
            }
        },
        "DestinationOrgId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the organization that represents the destination of supply for the transfer of supply.",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when manufacturing ends for the item.",
            "format":"date-time",
            "nullable":true
        },
        "DemandClass":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the demand class that the order is associated with.",
            "nullable":true
        },
        "ResourceCalendar":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the calendar of the resource for which the availability is to be determined.",
            "nullable":true
        },
        "OrgId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the organization associated with the item.",
            "nullable":true
        },
        "ExpectedCarrier":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the suggested carrier from the source inventory organization to destination inventory organization.",
            "nullable":true
        },
        "ArrivalDate":{
            "type":"string",
            "description":"Date when the purchased supply will be available at the destination organization.",
            "format":"date-time",
            "nullable":true
        },
        "ResourceId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the manufacturing resource.",
            "nullable":true
        },
        "DepartmentId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the department or work center to which a resource belongs.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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-item-response

Type: object

Show Source

• CarrierCalendar: string
  Maximum Length: 255

  Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site.
• ConfigItem: string
  Maximum Length: 255

  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
  Maximum Length: 255

  Abbreviation that identifies the organization that represents the destination of supply for a transfer of supply.
• DestinationReceivingCalendar: string
  Maximum Length: 255

  Value that indicates the receiving calendar for the customer or destination organization in case of an internal order.
• ExpectedArrivalDate: string (date-time)
  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
  Maximum Length: 255

  Value that identifies the item that's 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
  Maximum Length: 255

  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
  Maximum Length: 255

  Value that identifies the suggested drop ship supplier.
• ExpectedDropShipSupplierSite: string
  Maximum Length: 255

  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
  Maximum Length: 255

  Source application used by the drop ship supplier to promise the fulfillment line.
• 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-time)
  Date when the item is expected to be picked at the ship-from organization.
• 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.
• ExpectedShipDate: string (date-time)
  Date when the requested item line is expected to be shipped from the ship-from organization to the customer ship-to site.
• ExpectedShipFromOrg: string
  Maximum Length: 255

  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 (int64)
  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
  Maximum Length: 255

  Value that uniquely identifies the fulfillment line.
• InstanceNumber: string
  Maximum Length: 255

  Value that identifies the source system from which the order promising service request originated.
• InternalOrderType: string
  Maximum Length: 255

  Value that indicates the type of internal order. Valid values are TO, ISO, and SO.
• InternalSupplyIdentifier: string
  Maximum Length: 255

  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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• 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
  Maximum Length: 255

  Number that represents the unique identifier for the fulfillment line availability option.
• OptionSummary: string
  Maximum Length: 255

  Summary of how the current set availability option is different from the default availability option.
• ParentfulfillIdentifier: string
  Maximum Length: 255

  Value that indicates the immediate parent of the fulfillment line. This attribute is applicable only for configured to order items.
• ParentSplitLineIdentifier: string
  Maximum Length: 255

  Value that indicates the parent of the split fulfillment line. This attribute is generated only in case of an order that was split.
• Party: string
  Maximum Length: 255

  Value that indicates the party representing the customer.
• Partysite: string
  Maximum Length: 255

  Value that indicates the party site corresponding to the customer ship-to site.
• PeggingDetails: array Pegging Details
  Title: Pegging Details

  The Pegging Details resource manages the supply and demand pegging for a given fulfillment line.
• Price: number
  Price per unit associated with the availability option.
• Profit: number
  Projected profit generated by this split line item.
• PromisingStatus: string
  Maximum Length: 255

  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
  Maximum Length: 255

  Type of promise. This attribute can represent either ship date or arrival date based promising.
• RequestedDate: string (date-time)
  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
  Maximum Length: 255

  Value that uniquely identifies the item that's being requested.
• SalesOrderNumber: string
  Maximum Length: 255

  Value that uniquely identifies the sales order for which the fulfillment line is created.
• SourcingRule: string
  Maximum Length: 255

  Value that identifies the sourcing rule that was used.
• SplitLineIdentifier: string
  Maximum Length: 255

  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
  Maximum Length: 255

  Value that uniquely identifies the order for the request.
• Value: number
  Value associated with the fulfillment line availability response.

{
    "type":"object",
    "properties":{
        "Partysite":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the party site corresponding to the customer ship-to site.",
            "nullable":true,
            "x-queryable":true
        },
        "DestinationReceivingCalendar":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the receiving calendar for the customer or destination organization in case of an internal order.",
            "nullable":true,
            "x-queryable":true
        },
        "InstanceNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the source system from which the order promising service request originated.",
            "nullable":true,
            "x-queryable":true
        },
        "SourcingRule":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the sourcing rule that was used.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionSummary":{
            "maxLength":255,
            "type":"string",
            "description":"Summary of how the current set availability option is different from the default availability option.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedMode":{
            "type":"string",
            "description":"Value that identifies the suggested transport mode from the source inventory organization to destination inventory organization.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestedItem":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the item that's being requested.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedDropShipSupplierSite":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedService":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalValue":{
            "type":"number",
            "description":"Total value for the fulfillment line or availability option.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfSplits":{
            "type":"integer",
            "description":"Number of split lines generated for the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequestedDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Profit":{
            "type":"number",
            "description":"Projected profit generated by this split line item.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedArrivalDate":{
            "type":"string",
            "description":"Date when the fulfillment line is expected to be available at the customer ship-to site.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DestinationOrg":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization that represents the destination of supply for a transfer of supply.",
            "nullable":true,
            "x-queryable":true
        },
        "UniqueOrderId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the order for the request.",
            "nullable":true,
            "x-queryable":true
        },
        "SplitLineIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the fulfillment line split. A unique number is generated in case of an order that was split.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the sales order for which the fulfillment line is created.",
            "nullable":true,
            "x-queryable":true
        },
        "PromisingStatus":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Price":{
            "type":"number",
            "description":"Price per unit associated with the availability option.",
            "nullable":true,
            "x-queryable":true
        },
        "FulfillmentLineId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "type":"number",
            "description":"Value associated with the fulfillment line availability response.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalMargin":{
            "type":"number",
            "description":"Total margin for the fulfillment line or availability option.",
            "nullable":true,
            "x-queryable":true
        },
        "InternalOrderType":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the type of internal order. Valid values are TO, ISO, and SO.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedAvailableQuantity":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedAvailableQuantityUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the unit of measure used to represent the available quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfATPItems":{
            "type":"integer",
            "description":"Number of items for which the available to promise inventory was used in the availability option.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfCTPItems":{
            "type":"integer",
            "description":"Number of items for which the capable to promise supply was used in the availability option.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedAvailabilityOnRequestedDate":{
            "type":"number",
            "description":"Number that indicates the available to promise inventory quantity on the requested date.",
            "nullable":true,
            "x-queryable":true
        },
        "FillRate":{
            "type":"number",
            "description":"Percentage of quantity that can be promised on the requested date.",
            "nullable":true,
            "x-queryable":true
        },
        "InternalSupplyIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the source document for the internal order fulfillment line request.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedShippingCost":{
            "type":"number",
            "description":"Number that indicates the expected shipping cost associated with the fulfillment line or availability option.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfigItem":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedPickDate":{
            "type":"string",
            "description":"Date when the item is expected to be picked at the ship-from organization.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LineFillRate":{
            "type":"number",
            "description":"Number that indicates the percentage of quantity that can be promised by the requested date.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedDemandClass":{
            "type":"string",
            "description":"Value that identifies the demand class that the order is associated with.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionRank":{
            "maxLength":255,
            "type":"string",
            "description":"Number that represents the unique identifier for the fulfillment line availability option.",
            "nullable":true,
            "x-queryable":true
        },
        "CarrierCalendar":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site.",
            "nullable":true,
            "x-queryable":true
        },
        "Party":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the party representing the customer.",
            "nullable":true,
            "x-queryable":true
        },
        "PeggingDetails":{
            "title":"Pegging Details",
            "type":"array",
            "description":"The Pegging Details resource manages the supply and demand pegging for a given fulfillment line.",
            "items":{
                "$ref":"#/components/schemas/orderPromises-AlternateOptions-PeggingDetails-item-response"
            }
        },
        "ParentSplitLineIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the parent of the split fulfillment line. This attribute is generated only in case of an order that was split.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedDropShipSupplier":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the suggested drop ship supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalProfit":{
            "type":"number",
            "description":"Total profit for the fulfillment line or availability option.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedMargin":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedDropShipSupplierSourceSystem":{
            "maxLength":255,
            "type":"string",
            "description":"Source application used by the drop ship supplier to promise the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedTotalFulfilmentCost":{
            "type":"integer",
            "description":"Number that indicates the total expected cost associated with the fulfillment line or availability option.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "ExpectedShipDate":{
            "type":"string",
            "description":"Date when the requested item line is expected to be shipped from the ship-from organization to the customer ship-to site.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedAvailableItem":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the item that's expected to be used for satisfying the customer demand. This attribute can be either the requested item or substitute of the requested item.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfSubstitutions":{
            "type":"integer",
            "description":"Number of end item substitutions generated for the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedCarrier":{
            "type":"string",
            "description":"Value that identifies the suggested carrier from the ship-from organization to the customer ship-to site.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalPrice":{
            "type":"number",
            "description":"Total price for the fulfillment line or availability option.",
            "nullable":true,
            "x-queryable":true
        },
        "PromisingType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of promise. This attribute can represent either ship date or arrival date based promising.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedShipFromOrg":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the expected shipping organization to the customer ship-to site for the fulfillment line or availability option.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentfulfillIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the immediate parent of the fulfillment line. This attribute is applicable only for configured to order items.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : Pegging Details

Type: array

Title: Pegging Details

The Pegging Details resource manages the supply and demand pegging for a given fulfillment line.

Show Source

• Array of: object orderPromises-AlternateOptions-PeggingDetails-item-response

{
    "title":"Pegging Details",
    "type":"array",
    "description":"The Pegging Details resource manages the supply and demand pegging for a given fulfillment line.",
    "items":{
        "$ref":"#/components/schemas/orderPromises-AlternateOptions-PeggingDetails-item-response"
    }
}

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."
        }
    }
}

Nested Schema : orderPromises-AlternateOptions-PeggingDetails-item-response

Type: object

Show Source

• AllocationRule: string
  Maximum Length: 255

  Value that identifies the allocation rule applicable to the demand class associated with the order.
• AlternateResource: string
  Maximum Length: 255

  Contains one of the following values: true or false. If true, then an alternate resources is considered. If false, then an alternate resources isn't considered. This attribute doesn't have a default value.
• ArrivalDate: string (date-time)
  Date when the purchased supply will be available at the destination organization.
• ATPCost: integer (int64)
  Number that indicates the cost associated with the available-to-promise inventory used for promising the fulfillment line.
• ATPmode: string
  Maximum Length: 255

  Value that indicates the mode of order promising used to promise the order. Valid values are infinite, lead-time, and supply chain search.
• AvailabilityOption: string
  Maximum Length: 38

  Value that identifies an availability option.
• AvailableItem: string
  Maximum Length: 255

  Value that uniquely identifies the item that's available.
• BackToBackFlag: boolean
  Contains one of the following values: true or false. If true, then the item is a back to back enabled item. If false, then the item isn't a back to back enabled item. This attribute doesn't have a default value.
• BOMCode: string
  Maximum Length: 255

  Abbreviation that identifies the bill of material used in the capable to promise calculations for the fulfillment line request.
• CarrierCalendar: string
  Maximum Length: 255

  Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site.
• ConsumptionDate: string (date-time)
  Date when resource availability information needs to be returned.
• DemandClass: string
  Maximum Length: 255

  Value that identifies the demand class that the order is associated with.
• DepartmentId: string
  Maximum Length: 255

  Value that identifies the department or work center to which a resource belongs.
• DestinationOrgId: string
  Maximum Length: 255

  Value that uniquely identifies the organization that represents the destination of supply for the transfer of supply.
• DropshipSupplier: string
  Maximum Length: 255

  Name of the drop ship supplier that ships items directly to the customer.
• DropshipSupplierSite: string
  Maximum Length: 255

  Name of the drop ship supplier site that ships items directly to the customer.
• EndDate: string (date-time)
  Date when manufacturing ends for the item.
• ExpectedCarrier: string
  Maximum Length: 255

  Value that identifies the suggested carrier from the source inventory organization to destination inventory organization.
• ExpectedMode: string
  Maximum Length: 255

  Value that identifies the mode of transport for shipping the material from the source inventory organization to the destination inventory organization, suggested by order promising.
• ExpectedService: string
  Maximum Length: 255

  Value that identifies the suggested service level used for shipping the material from the source inventory organization to destination inventory organization.
• FixedLeadTime: string
  Maximum Length: 255

  Number of days of manufacturing lead time that's independent of the order quantity.
• FulfillmentlineId: string
  Maximum Length: 38

  Value that indicates the unique order identifier for the request.
• Item: string
  Maximum Length: 255

  Value that uniquely identifies the item that's requested.
• LeadTime: string
  Maximum Length: 255

  Value that indicates the number of days of lead time.
• LineId: integer (int64)
  Value that uniquely identifies the order line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManufacturingCalendar: string
  Maximum Length: 255

  Calendar that's associated with the manufacturing operations at an organization.
• OptionRank: integer (int64)
  Number that indicates the rank of the availability option.
• OrgId: string
  Maximum Length: 255

  Value that uniquely identifies the organization associated with the item.
• PeggedATPType: string
  Maximum Length: 255

  Type of the supply.
• PeggingdocId: string
  Maximum Length: 255

  Value that uniquely identifies the supply and demand pegging.
• PostprocessingLeadTime: string
  Maximum Length: 255

  Number of days required to make an item available in inventory from the time it received.
• PreprocessingLeadTime: string
  Maximum Length: 255

  Number of days required to release a purchase order or create a job from the time the requirement is identified.
• ProcessingLeadTime: string
  Maximum Length: 255

  Number of days required to procure or manufacture an item.
• Quantity: integer (int64)
  Number that indicates the quantity of the available item.
• QuantityUOM: string
  Maximum Length: 255

  Value that indicates the unit of measure used for quantity.
• ReceivingCalendar: string
  Maximum Length: 255

  Value that identifies the receiving calendar used for receiving the material at the inventory organization or customer ship-to site.
• RequiredDate: string (date-time)
  Date when the material is required.
• RequiredQuantity: number
  Number that indicates the quantity required for promising the fulfillment line.
• ResourceCalendar: string
  Maximum Length: 255

  Value that identifies the calendar of the resource for which the availability is to be determined.
• ResourceId: string
  Maximum Length: 255

  Value that identifies the manufacturing resource.
• RoutingCode: string
  Maximum Length: 255

  Abbreviation that identifies the routing used in the capable to promise calculations for the fulfillment line request.
• ShipDate: string (date-time)
  Date when the supply will be shipped from the supplier site or source organization.
• ShippingCalendar: string
  Maximum Length: 255

  Value that identifies the shipping calendar used for shipping the material from supplier site to the inventory organization or the customer ship-to site.
• SourceOrgId: string
  Maximum Length: 255

  Value that uniquely identifies the organization that's the source of supply.
• StartDate: string (date-time)
  Date when manufacturing is expected to start for the item.
• SupplierId: string
  Maximum Length: 255

  Value that uniquely identifies the item supplier from whom supply is procured.
• SupplierSiteId: string
  Maximum Length: 255

  Value that uniquely identifies the item supplier site from which supply is procured.
• TransitLeadTime: string
  Maximum Length: 255

  Number of days required for transporting the requested item from source organization to the destination organization.
• UniqueOrderId: string
  Maximum Length: 38

  Value that uniquely identifies the fulfillment line.
• VariableLeadTime: string
  Maximum Length: 255

  Number that indicates the portion of manufacturing lead time that's dependent on order quantity.

{
    "type":"object",
    "properties":{
        "AllocationRule":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the allocation rule applicable to the demand class associated with the order.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedMode":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the mode of transport for shipping the material from the source inventory organization to the destination inventory organization, suggested by order promising.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedService":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the suggested service level used for shipping the material from the source inventory organization to destination inventory organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceivingCalendar":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the receiving calendar used for receiving the material at the inventory organization or customer ship-to site.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when manufacturing is expected to start for the item.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Item":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the item that's requested.",
            "nullable":true,
            "x-queryable":true
        },
        "PeggingdocId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the supply and demand pegging.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequiredDate":{
            "type":"string",
            "description":"Date when the material is required.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ShippingCalendar":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the shipping calendar used for shipping the material from supplier site to the inventory organization or the customer ship-to site.",
            "nullable":true,
            "x-queryable":true
        },
        "UniqueOrderId":{
            "maxLength":38,
            "type":"string",
            "description":"Value that uniquely identifies the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "PeggedATPType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of the supply.",
            "nullable":true,
            "x-queryable":true
        },
        "BOMCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the bill of material used in the capable to promise calculations for the fulfillment line request.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipDate":{
            "type":"string",
            "description":"Date when the supply will be shipped from the supplier site or source organization.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PreprocessingLeadTime":{
            "maxLength":255,
            "type":"string",
            "description":"Number of days required to release a purchase order or create a job from the time the requirement is identified.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the item supplier from whom supply is procured.",
            "nullable":true,
            "x-queryable":true
        },
        "ConsumptionDate":{
            "type":"string",
            "description":"Date when resource availability information needs to be returned.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AlternateResource":{
            "maxLength":255,
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then an alternate resources is considered. If false, then an alternate resources isn't considered. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "LeadTime":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the number of days of lead time.",
            "nullable":true,
            "x-queryable":true
        },
        "ATPCost":{
            "type":"integer",
            "description":"Number that indicates the cost associated with the available-to-promise inventory used for promising the fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "FulfillmentlineId":{
            "maxLength":38,
            "type":"string",
            "description":"Value that indicates the unique order identifier for the request.",
            "nullable":true,
            "x-queryable":true
        },
        "PostprocessingLeadTime":{
            "maxLength":255,
            "type":"string",
            "description":"Number of days required to make an item available in inventory from the time it received.",
            "nullable":true,
            "x-queryable":true
        },
        "ATPmode":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the mode of order promising used to promise the order. Valid values are infinite, lead-time, and supply chain search.",
            "nullable":true,
            "x-queryable":true
        },
        "FixedLeadTime":{
            "maxLength":255,
            "type":"string",
            "description":"Number of days of manufacturing lead time that's independent of the order quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionRank":{
            "type":"integer",
            "description":"Number that indicates the rank of the availability option.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":38
            },
            "x-queryable":true
        },
        "CarrierCalendar":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site.",
            "nullable":true,
            "x-queryable":true
        },
        "RequiredQuantity":{
            "type":"number",
            "description":"Number that indicates the quantity required for promising the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "BackToBackFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the item is a back to back enabled item. If false, then the item isn't a back to back enabled item. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the item supplier site from which supply is procured.",
            "nullable":true,
            "x-queryable":true
        },
        "DropshipSupplierSite":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the drop ship supplier site that ships items directly to the customer.",
            "nullable":true,
            "x-queryable":true
        },
        "DropshipSupplier":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the drop ship supplier that ships items directly to the customer.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessingLeadTime":{
            "maxLength":255,
            "type":"string",
            "description":"Number of days required to procure or manufacture an item.",
            "nullable":true,
            "x-queryable":true
        },
        "QuantityUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the unit of measure used for quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "VariableLeadTime":{
            "maxLength":255,
            "type":"string",
            "description":"Number that indicates the portion of manufacturing lead time that's dependent on order quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrgId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the organization that's the source of supply.",
            "nullable":true,
            "x-queryable":true
        },
        "ManufacturingCalendar":{
            "maxLength":255,
            "type":"string",
            "description":"Calendar that's associated with the manufacturing operations at an organization.",
            "nullable":true,
            "x-queryable":true
        },
        "AvailableItem":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the item that's available.",
            "nullable":true,
            "x-queryable":true
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the order line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":38
            },
            "x-queryable":true
        },
        "RoutingCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the routing used in the capable to promise calculations for the fulfillment line request.",
            "nullable":true,
            "x-queryable":true
        },
        "TransitLeadTime":{
            "maxLength":255,
            "type":"string",
            "description":"Number of days required for transporting the requested item from source organization to the destination organization.",
            "nullable":true,
            "x-queryable":true
        },
        "AvailabilityOption":{
            "maxLength":38,
            "type":"string",
            "description":"Value that identifies an availability option.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"integer",
            "description":"Number that indicates the quantity of the available item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":38
            },
            "x-queryable":true
        },
        "DestinationOrgId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the organization that represents the destination of supply for the transfer of supply.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when manufacturing ends for the item.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DemandClass":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the demand class that the order is associated with.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceCalendar":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the calendar of the resource for which the availability is to be determined.",
            "nullable":true,
            "x-queryable":true
        },
        "OrgId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the organization associated with the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedCarrier":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the suggested carrier from the source inventory organization to destination inventory organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ArrivalDate":{
            "type":"string",
            "description":"Date when the purchased supply will be available at the destination organization.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the manufacturing resource.",
            "nullable":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the department or work center to which a resource belongs.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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"
    }
}

Links

PeggingDetails

Operation: /fscmRestApi/resources/11.13.18.05/orderPromises/{UniqueOrderId}/child/AlternateOptions/{SplitLineIdentifier}/child/PeggingDetails

Parameters:

• SplitLineIdentifier: $request.path.SplitLineIdentifier
• UniqueOrderId: $request.path.UniqueOrderId

The Pegging Details resource manages the supply and demand pegging for a given fulfillment line.

Back to Top