Jump to

• Request
• Response

Get all pegging details

get

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

Request

Path Parameters

• AlternateOptionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- UniqueOrderId, OptionRank, FulfillmentLineId and SplitLineIdentifier ---for the Alternate Options resource and used to uniquely identify an instance of Alternate Options. The client should not generate the hash key value. Instead, the client should query on the Alternate Options collection resource with a filter on the primary key values in order to navigate to a specific instance of Alternate Options.
  
  For example: AlternateOptions?q=UniqueOrderId=<value1>;OptionRank=<value2>;FulfillmentLineId=<value3>;SplitLineIdentifier=<value4>
• UniqueOrderId(required): string
  Value that uniquely identifies the order.

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

  • PrimaryKey: Finds pegging details according to the fulfillment line identifier.
    Finder Variables:
    • FulfillmentlineId; string; Value that uniquley identifies a fulfillment line.
    • LineId; integer; Value that uniquley identifies a pegging line.
    • OptionRank; integer; Value that uniquley identifies alternate availability.
    • UniqueOrderId; string; Value that uniquely identifies the order.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ATPCost; integer; Number that indicates the cost associated with the available-to-promise inventory used for promising the fulfillment line.
  • ATPmode; string; Value that indicates the mode of order promising used to promise the order. Valid values are infinite, lead-time, and supply chain search.
  • AllocConsumptionWeek; string; This column stores the start of the week when promising consumed the allocation.
  • AllocationNodeId; string; This column stores the unique identifier of the allocation node.
  • AllocationRule; string; Value that identifies the allocation rule applicable to the demand class associated with the order.
  • AlternateResource; string; Contains one of the following values: true or false. If true, then an alternate resources is considered. If false, then an alternate resources is not considered. This attribute does not have a default value.
  • ArrivalDate; string; Date when the purchased supply will be available at the destination organization.
  • AvailabilityOption; string; Value that identifies an availability option.
  • AvailableItem; string; Value that uniquely identifies the item that is available.
  • BOMCode; string; Abbreviation that identifies the bill of material used in the capable to promise calculations for the fulfillment line request.
  • 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 is not a back to back enabled item. This attribute does not have a default value.
  • CarrierCalendar; string; Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site.
  • ConsumedAllocation; number; This column stores quantity that promising consumed for the allocation.
  • ConsumptionDate; string; Date when resource availability information needs to be returned.
  • DemandClass; string; Value that identifies the demand class that the order is associated with.
  • DepartmentId; string; Value that identifies the department or work center to which a resource belongs.
  • DestinationOrgId; string; Abbreviation that identifies the organization that represents the destination of supply for the transfer of supply.
  • DropshipSupplier; string; Name of the drop ship supplier that ships items directly to the customer.
  • DropshipSupplierSite; string; Name of the drop ship supplier site that ships items directly to the customer.
  • EndDate; string; Date when manufacturing ends for the item.
  • ExpectedCarrier; string; Value that identifies the suggested carrier from the source inventory organization to destination inventory organization.
  • ExpectedMode; string; 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; Value that identifies the suggested service level used for shipping the material from the source inventory organization to destination inventory organization.
  • FixedLeadTime; string; Number of days of manufacturing lead time that is independent of the order quantity.
  • FulfillmentlineId; string; Value that indicates the unique order identifier for the request.
  • Item; string; Value that uniquely identifies the item that is requested.
  • LeadTime; string; Value that indicates the number of days of lead time.
  • LineId; integer; Value that uniquely identifies the order line.
  • ManufacturingCalendar; string; Calendar that is associated with the manufacturing operations at an organization.
  • OptionRank; integer; Number that indicates the rank of the availability option.
  • OrgId; string; Value that uniquely identifies the organization associated with the item.
  • ParentLineId; string; This column stores parent line identifier used in pegging.
  • PeggedATPType; string; Type of the supply.
  • PeggingdocId; string; Value that uniquely identifies the supply and demand pegging.
  • PickDate; string; This column stores the date on which the shipment is expected to be picked at the pickup organization by the customer.
  • PostprocessingLeadTime; string; Number of days required to make an item available in inventory from the time it received.
  • PreprocessingLeadTime; string; Number of days required to release a purchase order or create a job from the time the requirement is identified.
  • ProcessingLeadTime; string; Number of days required to procure or manufacture an item.
  • Quantity; integer; Number that indicates the quantity of the available item.
  • QuantityUOM; string; Value that indicates the unit of measure used for quantity.
  • ReceivingCalendar; string; Value that identifies the receiving calendar used for receiving the material at the inventory organization or customer ship-to site.
  • RedeployedFlag; boolean; This column indicates whether promising can redeploy quantity from allocation node.
  • RequiredDate; string; Date when the material is required.
  • RequiredQuantity; number; Number that indicates the quantity required for promising the fulfillment line.
  • ReservedArriveDate; string; This column stores the supply dock date of ordered item with reservation after rescheduling.
  • ReservedJobEndDate; string; This column stores the WIP job end date of ordered item with reservation after rescheduling.
  • ResourceCalendar; string; Value that identifies the calendar of the resource for which the availability is to be determined.
  • ResourceId; string; Value that identifies the manufacturing resource.
  • RoutingCode; string; Abbreviation that identifies the routing used in the capable to promise calculations for the fulfillment line request.
  • ShipDate; string; Date when the supply will be shipped from the supplier site or source organization.
  • ShippingCalendar; string; 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; Value that uniquely identifies the organization that is the source of supply.
  • StartDate; string; Date when manufacturing is expected to start for the item.
  • SupplierId; string; Value that uniquely identifies the item supplier from whom supply is procured.
  • SupplierSiteId; string; Value that uniquely identifies the item supplier site from which supply is procured.
  • TimezoneCode; string; This column stores the time zone code for the shipping or receiving partners.
  • TransitLeadTime; string; Number of days required for transporting the requested item from source organization to the destination organization.
  • UniqueOrderId; string; Value that uniquely identifies the fulfillment line.
  • VariableLeadTime; string; Number that indicates the portion of manufacturing lead time that is dependent on order quantity.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  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: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : orderPromises-AlternateOptions-PeggingDetails

Type: object

Show Source

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

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

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

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

Type: object

Show Source

• AllocationNodeId: string
  Maximum Length: 255

  This column stores the unique identifier of the allocation node.
• AllocationRule: string
  Maximum Length: 255

  Value that identifies the allocation rule applicable to the demand class associated with the order.
• AllocConsumptionWeek: string (date-time)
  This column stores the start of the week when promising consumed the allocation.
• 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 is not considered. This attribute does not 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 is 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 is not a back to back enabled item. This attribute does not 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.
• ConsumedAllocation: number
  This column stores quantity that promising consumed for the allocation.
• 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

  Abbreviation that 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 is 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 is 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 is 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.
• ParentLineId: string
  Maximum Length: 255

  This column stores parent line identifier used in pegging.
• PeggedATPType: string
  Maximum Length: 255

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

  Value that uniquely identifies the supply and demand pegging.
• PickDate: string (date-time)
  This column stores the date on which the shipment is expected to be picked at the pickup organization by the customer.
• 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.
• RedeployedFlag: boolean
  Maximum Length: 1

  This column indicates whether promising can redeploy quantity from allocation node.
• RequiredDate: string (date-time)
  Date when the material is required.
• RequiredQuantity: number
  Number that indicates the quantity required for promising the fulfillment line.
• ReservedArriveDate: string (date-time)
  This column stores the supply dock date of ordered item with reservation after rescheduling.
• ReservedJobEndDate: string (date-time)
  This column stores the WIP job end date of ordered item with reservation after rescheduling.
• 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 is 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.
• TimezoneCode: string
  Maximum Length: 255

  This column stores the time zone code for the shipping or receiving partners.
• 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 is 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
        },
        "ParentLineId":{
            "maxLength":255,
            "type":"string",
            "description":"This column stores parent line identifier used in pegging.",
            "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 is 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 is not considered. This attribute does not 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
        },
        "AllocConsumptionWeek":{
            "type":"string",
            "description":"This column stores the start of the week when promising consumed the allocation.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TimezoneCode":{
            "maxLength":255,
            "type":"string",
            "description":"This column stores the time zone code for the shipping or receiving partners.",
            "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
        },
        "ReservedArriveDate":{
            "type":"string",
            "description":"This column stores the supply dock date of ordered item with reservation after rescheduling.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FixedLeadTime":{
            "maxLength":255,
            "type":"string",
            "description":"Number of days of manufacturing lead time that is 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
        },
        "PickDate":{
            "type":"string",
            "description":"This column stores the date on which the shipment is expected to be picked at the pickup organization by the customer.",
            "format":"date-time",
            "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
        },
        "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 is not a back to back enabled item. This attribute does not 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 is dependent on order quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrgId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the organization that is the source of supply.",
            "nullable":true,
            "x-queryable":true
        },
        "ManufacturingCalendar":{
            "maxLength":255,
            "type":"string",
            "description":"Calendar that is 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 is 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
        },
        "RedeployedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"This column indicates whether promising can redeploy quantity from allocation node.",
            "nullable":true,
            "x-queryable":true
        },
        "DestinationOrgId":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that 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
        },
        "ConsumedAllocation":{
            "type":"number",
            "description":"This column stores quantity that promising consumed for the allocation.",
            "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
        },
        "ReservedJobEndDate":{
            "type":"string",
            "description":"This column stores the WIP job end date of ordered item with reservation after rescheduling.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AllocationNodeId":{
            "maxLength":255,
            "type":"string",
            "description":"This column stores the unique identifier of the allocation node.",
            "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