Jump to

• Request
• Response

Get one pegging detail

get

/fscmRestApi/resources/11.13.18.05/orderPromises/{UniqueOrderId}/child/FulFillmentLine/{SplitLineId}/child/PeggingDetails/{FulfillmentlineId}

Request

Path Parameters

• FulfillmentlineId(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=
• SplitLineId(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=
• 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=

Query Parameters

• dependency: string
  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>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(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-FulFillmentLine-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"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top