Jump to

• Request
• Response

Get all transfer order recommendations.

get

/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}/child/TransferOrderRecommendations

Request

Path Parameters

• PlanId(required): integer(int64)
  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
• 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 Find the transfer order recommendations using the primary key.
    Finder Variables
    • PlanId; integer; Value that uniquely identifies a plan with transfer order recommendations.
    • RecommendationType; integer; Type of recommendation made, such as expedite transfer orders.
    • RecommendationsId; integer; Value that uniquely identifies a transfer order recommendation.
• 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:
  

  • Category; string; Category of the item in the transfer order. The category is derived from the default product hierarchy or any product hierarchy of the item associated in the plan's dimension catalog.
  • CompressionDays; number; Number of days the transfer order supply is compressed.
  • CurrencyCode; string; Currency code associated with the transfer order.
  • DataSecurityEditAllowed; string; Contains one of the following: yes or null. If yes, then the user has data security edit privileges. If null, then the user doesn't have data security edit privileges.
  • Description; string; Description of the item in the transfer order.
  • ExpediteDate; string; Date when supply is needed.
  • ExpediteDays; number; Number of days the supply is required sooner than currently planned.
  • FirmPlannedType; integer; Indicates whether a supply order is firm. Valid values are 1 and 2. This attribute doesn't have a default value.
  • FirmStatus; string; Indicates whether a supply order is firm. Valid values are firm or not firm. This attribute doesn't have a default value.
  • InventoryItemId; integer; Unique identifier of an inventory item.
  • Item; string; Name of the item in the transfer order.
  • LastUpdateDate; string; Date when the transfer order was last updated.
  • LastUpdatedBy; string; Name of the user who last updated the transfer order.
  • Notes; integer; Notes regarding when the transfer order was created or updated.
  • OrderLineNumber; string; Line number of the supply in the transfer order.
  • OrderNumber; string; Order number of the supply in the transfer order.
  • OrderQuantity; number; Order quantity for the transfer supply order.
  • OrderType; integer; Order type of the transfer supply order.
  • OrderTypeText; string; Name of the supply order types, such as transfer order and planned transfer order.
  • OrderValue; number; Order value of the supply in the transfer order.
  • Organization; string; Name of the organization in the transfer order recommendation.
  • OrganizationId; integer; Value that uniquely identifies the organization of the transfer order.
  • PlanId; integer; Value that uniquely identifies the plan in which transfer order recommendations are generated.
  • PlanningAttribute10; string; Value that identifies planning attribute number 10 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute10Id; integer; Value that uniquely identifies the ID of the planning attribute number 10 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute11; string; Value that identifies planning attribute number 11 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute11Id; integer; Value that uniquely identifies the ID of the planning attribute number 11 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute12; string; Value that identifies planning attribute number 12 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute12Id; integer; Value that uniquely identifies the ID of the planning attribute number 12 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute13; string; Value that identifies planning attribute number 13 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute13Id; integer; Value that uniquely identifies the ID of the planning attribute number 13 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute14; string; Value that identifies planning attribute number 14 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute14Id; integer; Value that uniquely identifies the ID of the planning attribute number 14 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute15; string; Value that identifies planning attribute number 15 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute15Id; integer; Value that uniquely identifies the ID of the planning attribute number 15 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute3; string; Value that identifies planning attribute number 3 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute3Id; integer; Value that uniquely identifies the ID of the planning attribute number 3 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute4; string; Value that identifies planning attribute number 4 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute4Id; integer; Value that uniquely identifies the ID of the planning attribute number 4 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute5; string; Value that identifies planning attribute number 5 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute5Id; integer; Value that uniquely identifies the ID of the planning attribute number 5 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute6; string; Value that identifies planning attribute number 6 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute6Id; integer; Value that uniquely identifies the ID of the planning attribute number 6 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute7; string; Value that identifies planning attribute number 7 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute7Id; integer; Value that uniquely identifies the ID of the planning attribute number 7 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute8; string; Value that identifies planning attribute number 8 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute8Id; integer; Value that uniquely identifies the ID of the planning attribute number 8 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute9; string; Value that identifies planning attribute number 9 associated with the transfer order in an attribute-based plan.
  • PlanningAttribute9Id; integer; Value that uniquely identifies the ID of the planning attribute number 9 associated with the transfer order in an attribute-based plan.
  • ProjectGroupValue; string; Value that identifies the project group associated with the transfer order in an attribute-based plan.
  • ProjectGroupValueId; integer; Value that uniquely identifies the ID of the project group associated with the transfer order in an attribute-based plan.
  • ProjectValue; string; Value that identifies the project associated with the transfer order in an attribute-based plan.
  • ProjectValueId; integer; Value that uniquely identifies the ID of the project associated with the transfer order in an attribute-based plan.
  • RecommendationType; integer; Type of recommendation made, such as expedite transfer orders.
  • RecommendationsId; integer; Unique identifier of the recommendation type.
  • RescheduleDays; number; Number of days to reschedule the transfer supply order.
  • SourceOrganization; string; Source organization for the transfer order.
  • SourceOrganizationId; integer; Unique identifier for the source organization.
  • Status; integer; Status value of the expedite transfer order recommendation. Valid values are 1 - Accepted, 2 - In review, and 3 - Pending. The default value is 3 - Pending.
  • StatusText; string; Status of the expedite transfer order recommendation. Valid values are Pending, In review, and Accepted. The default value is Pending.
  • SuggestedDueDate; string; Date when a supply is expected to be completed.
  • TaskValue; string; Value that identifies the task associated with the transfer order in an attribute-based plan.
  • TaskValueId; integer; Value that uniquely identifies the ID of the task associated with the transfer order in an attribute-based plan.
  • TimeZone; string; Value that uniquely identifies the time zone.
  • TransactionId; integer; Value that uniquely identifies the supply transaction. This value is internally generated by the application.
  • UOM; string; Name of the unit of measure associated with the 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 : supplyPlans-TransferOrderRecommendations

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/supplyPlans-TransferOrderRecommendations-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object supplyPlans-TransferOrderRecommendations-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/supplyPlans-TransferOrderRecommendations-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 : supplyPlans-TransferOrderRecommendations-item-response

Type: object

Show Source

• Category: string
  Read Only: true

  Maximum Length: 4000

  Category of the item in the transfer order. The category is derived from the default product hierarchy or any product hierarchy of the item associated in the plan's dimension catalog.
• CompressionDays: number
  Number of days the transfer order supply is compressed.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 4000

  Currency code associated with the transfer order.
• DataSecurityEditAllowed: string
  Read Only: true

  Contains one of the following: yes or null. If yes, then the user has data security edit privileges. If null, then the user doesn't have data security edit privileges.
• Description: string
  Read Only: true

  Maximum Length: 240

  Description of the item in the transfer order.
• ExpediteDate: string (date)
  Date when supply is needed.
• ExpediteDays: number
  Number of days the supply is required sooner than currently planned.
• FirmPlannedType: integer
  Read Only: true

  Indicates whether a supply order is firm. Valid values are 1 and 2. This attribute doesn't have a default value.
• FirmStatus: string
  Read Only: true

  Maximum Length: 4000

  Indicates whether a supply order is firm. Valid values are firm or not firm. This attribute doesn't have a default value.
• InventoryItemId: integer
  Unique identifier of an inventory item.
• Item: string
  Read Only: true

  Maximum Length: 300

  Name of the item in the transfer order.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the transfer order was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the transfer order.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Notes: integer
  Read Only: true

  Notes regarding when the transfer order was created or updated.
• OrderLineNumber: string
  Maximum Length: 100

  Line number of the supply in the transfer order.
• OrderNumber: string
  Maximum Length: 240

  Order number of the supply in the transfer order.
• OrderQuantity: number
  Order quantity for the transfer supply order.
• OrderType: integer
  Order type of the transfer supply order.
• OrderTypeText: string
  Read Only: true

  Maximum Length: 4000

  Name of the supply order types, such as transfer order and planned transfer order.
• OrderValue: number
  Read Only: true

  Order value of the supply in the transfer order.
• Organization: string
  Read Only: true

  Maximum Length: 49

  Name of the organization in the transfer order recommendation.
• OrganizationId: integer
  Value that uniquely identifies the organization of the transfer order.
• PlanId: integer
  Value that uniquely identifies the plan in which transfer order recommendations are generated.
• PlanningAttribute10: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 10 associated with the transfer order in an attribute-based plan.
• PlanningAttribute10Id: integer (int64)
  Read Only: true

  Value that uniquely identifies the ID of the planning attribute number 10 associated with the transfer order in an attribute-based plan.
• PlanningAttribute11: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 11 associated with the transfer order in an attribute-based plan.
• PlanningAttribute11Id: integer (int64)
  Read Only: true

  Value that uniquely identifies the ID of the planning attribute number 11 associated with the transfer order in an attribute-based plan.
• PlanningAttribute12: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 12 associated with the transfer order in an attribute-based plan.
• PlanningAttribute12Id: integer (int64)
  Read Only: true

  Value that uniquely identifies the ID of the planning attribute number 12 associated with the transfer order in an attribute-based plan.
• PlanningAttribute13: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 13 associated with the transfer order in an attribute-based plan.
• PlanningAttribute13Id: integer (int64)
  Read Only: true

  Value that uniquely identifies the ID of the planning attribute number 13 associated with the transfer order in an attribute-based plan.
• PlanningAttribute14: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 14 associated with the transfer order in an attribute-based plan.
• PlanningAttribute14Id: integer (int64)
  Read Only: true

  Value that uniquely identifies the ID of the planning attribute number 14 associated with the transfer order in an attribute-based plan.
• PlanningAttribute15: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 15 associated with the transfer order in an attribute-based plan.
• PlanningAttribute15Id: integer (int64)
  Read Only: true

  Value that uniquely identifies the ID of the planning attribute number 15 associated with the transfer order in an attribute-based plan.
• PlanningAttribute3: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 3 associated with the transfer order in an attribute-based plan.
• PlanningAttribute3Id: integer (int64)
  Read Only: true

  Value that uniquely identifies the ID of the planning attribute number 3 associated with the transfer order in an attribute-based plan.
• PlanningAttribute4: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 4 associated with the transfer order in an attribute-based plan.
• PlanningAttribute4Id: integer (int64)
  Read Only: true

  Value that uniquely identifies the ID of the planning attribute number 4 associated with the transfer order in an attribute-based plan.
• PlanningAttribute5: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 5 associated with the transfer order in an attribute-based plan.
• PlanningAttribute5Id: integer (int64)
  Read Only: true

  Value that uniquely identifies the ID of the planning attribute number 5 associated with the transfer order in an attribute-based plan.
• PlanningAttribute6: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 6 associated with the transfer order in an attribute-based plan.
• PlanningAttribute6Id: integer (int64)
  Read Only: true

  Value that uniquely identifies the ID of the planning attribute number 6 associated with the transfer order in an attribute-based plan.
• PlanningAttribute7: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 7 associated with the transfer order in an attribute-based plan.
• PlanningAttribute7Id: integer (int64)
  Read Only: true

  Value that uniquely identifies the ID of the planning attribute number 7 associated with the transfer order in an attribute-based plan.
• PlanningAttribute8: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 8 associated with the transfer order in an attribute-based plan.
• PlanningAttribute8Id: integer (int64)
  Read Only: true

  Value that uniquely identifies the ID of the planning attribute number 8 associated with the transfer order in an attribute-based plan.
• PlanningAttribute9: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 9 associated with the transfer order in an attribute-based plan.
• PlanningAttribute9Id: integer (int64)
  Read Only: true

  Value that uniquely identifies the ID of the planning attribute number 9 associated with the transfer order in an attribute-based plan.
• ProjectGroupValue: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies the project group associated with the transfer order in an attribute-based plan.
• ProjectGroupValueId: integer (int64)
  Read Only: true

  Value that uniquely identifies the ID of the project group associated with the transfer order in an attribute-based plan.
• ProjectValue: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies the project associated with the transfer order in an attribute-based plan.
• ProjectValueId: integer (int64)
  Read Only: true

  Value that uniquely identifies the ID of the project associated with the transfer order in an attribute-based plan.
• RecommendationsId: integer
  Unique identifier of the recommendation type.
• RecommendationType: integer
  Type of recommendation made, such as expedite transfer orders.
• RescheduleDays: number
  Number of days to reschedule the transfer supply order.
• SourceOrganization: string
  Read Only: true

  Maximum Length: 4000

  Source organization for the transfer order.
• SourceOrganizationId: integer
  Read Only: true

  Unique identifier for the source organization.
• Status: integer
  Status value of the expedite transfer order recommendation. Valid values are 1 - Accepted, 2 - In review, and 3 - Pending. The default value is 3 - Pending.
• StatusText: string
  Read Only: true

  Maximum Length: 4000

  Status of the expedite transfer order recommendation. Valid values are Pending, In review, and Accepted. The default value is Pending.
• SuggestedDueDate: string (date)
  Date when a supply is expected to be completed.
• TaskValue: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies the task associated with the transfer order in an attribute-based plan.
• TaskValueId: integer (int64)
  Read Only: true

  Value that uniquely identifies the ID of the task associated with the transfer order in an attribute-based plan.
• TimeZone: string
  Read Only: true

  Maximum Length: 4000

  Value that uniquely identifies the time zone.
• TransactionId: integer
  Value that uniquely identifies the supply transaction. This value is internally generated by the application.
• UOM: string
  Read Only: true

  Maximum Length: 4000

  Name of the unit of measure associated with the order quantity.

{
    "type":"object",
    "properties":{
        "Category":{
            "maxLength":4000,
            "type":"string",
            "description":"Category of the item in the transfer order. The category is derived from the default product hierarchy or any product hierarchy of the item associated in the plan's dimension catalog.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompressionDays":{
            "type":"number",
            "description":"Number of days the transfer order supply is compressed.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":4000,
            "type":"string",
            "description":"Currency code associated with the transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSecurityEditAllowed":{
            "type":"string",
            "description":"Contains one of the following: yes or null. If yes, then the user has data security edit privileges. If null, then the user doesn't have data security edit privileges.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item in the transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpediteDate":{
            "type":"string",
            "description":"Date when supply is needed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExpediteDays":{
            "type":"number",
            "description":"Number of days the supply is required sooner than currently planned.",
            "nullable":true,
            "x-queryable":true
        },
        "FirmPlannedType":{
            "type":"integer",
            "description":"Indicates whether a supply order is firm. Valid values are 1 and 2. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmStatus":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates whether a supply order is firm. Valid values are firm or not firm. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Unique identifier of an inventory item.",
            "nullable":true,
            "x-queryable":true
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the item in the transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the transfer order was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the transfer order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Notes":{
            "type":"integer",
            "description":"Notes regarding when the transfer order was created or updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderLineNumber":{
            "maxLength":100,
            "type":"string",
            "description":"Line number of the supply in the transfer order.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Order number of the supply in the transfer order.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderQuantity":{
            "type":"number",
            "description":"Order quantity for the transfer supply order.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderType":{
            "type":"integer",
            "description":"Order type of the transfer supply order.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderTypeText":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the supply order types, such as transfer order and planned transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderValue":{
            "type":"number",
            "description":"Order value of the supply in the transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":49,
            "type":"string",
            "description":"Name of the organization in the transfer order recommendation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization of the transfer order.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan in which transfer order recommendations are generated.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningAttribute10":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies planning attribute number 10 associated with the transfer order in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute10Id":{
            "type":"integer",
            "description":"Value that uniquely identifies the ID of the planning attribute number 10 associated with the transfer order in an attribute-based plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningAttribute11":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies planning attribute number 11 associated with the transfer order in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute11Id":{
            "type":"integer",
            "description":"Value that uniquely identifies the ID of the planning attribute number 11 associated with the transfer order in an attribute-based plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningAttribute12":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies planning attribute number 12 associated with the transfer order in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute12Id":{
            "type":"integer",
            "description":"Value that uniquely identifies the ID of the planning attribute number 12 associated with the transfer order in an attribute-based plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningAttribute13":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies planning attribute number 13 associated with the transfer order in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute13Id":{
            "type":"integer",
            "description":"Value that uniquely identifies the ID of the planning attribute number 13 associated with the transfer order in an attribute-based plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningAttribute14":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies planning attribute number 14 associated with the transfer order in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute14Id":{
            "type":"integer",
            "description":"Value that uniquely identifies the ID of the planning attribute number 14 associated with the transfer order in an attribute-based plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningAttribute15":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies planning attribute number 15 associated with the transfer order in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute15Id":{
            "type":"integer",
            "description":"Value that uniquely identifies the ID of the planning attribute number 15 associated with the transfer order in an attribute-based plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningAttribute3":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies planning attribute number 3 associated with the transfer order in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute3Id":{
            "type":"integer",
            "description":"Value that uniquely identifies the ID of the planning attribute number 3 associated with the transfer order in an attribute-based plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningAttribute4":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies planning attribute number 4 associated with the transfer order in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute4Id":{
            "type":"integer",
            "description":"Value that uniquely identifies the ID of the planning attribute number 4 associated with the transfer order in an attribute-based plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningAttribute5":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies planning attribute number 5 associated with the transfer order in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute5Id":{
            "type":"integer",
            "description":"Value that uniquely identifies the ID of the planning attribute number 5 associated with the transfer order in an attribute-based plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningAttribute6":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies planning attribute number 6 associated with the transfer order in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute6Id":{
            "type":"integer",
            "description":"Value that uniquely identifies the ID of the planning attribute number 6 associated with the transfer order in an attribute-based plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningAttribute7":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies planning attribute number 7 associated with the transfer order in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute7Id":{
            "type":"integer",
            "description":"Value that uniquely identifies the ID of the planning attribute number 7 associated with the transfer order in an attribute-based plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningAttribute8":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies planning attribute number 8 associated with the transfer order in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute8Id":{
            "type":"integer",
            "description":"Value that uniquely identifies the ID of the planning attribute number 8 associated with the transfer order in an attribute-based plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningAttribute9":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies planning attribute number 9 associated with the transfer order in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute9Id":{
            "type":"integer",
            "description":"Value that uniquely identifies the ID of the planning attribute number 9 associated with the transfer order in an attribute-based plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectGroupValue":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies the project group associated with the transfer order in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectGroupValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ID of the project group associated with the transfer order in an attribute-based plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectValue":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies the project associated with the transfer order in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ID of the project associated with the transfer order in an attribute-based plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecommendationType":{
            "type":"integer",
            "description":"Type of recommendation made, such as expedite transfer orders.",
            "nullable":true,
            "x-queryable":true
        },
        "RecommendationsId":{
            "type":"integer",
            "description":"Unique identifier of the recommendation type.",
            "nullable":true,
            "x-queryable":true
        },
        "RescheduleDays":{
            "type":"number",
            "description":"Number of days to reschedule the transfer supply order.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrganization":{
            "maxLength":4000,
            "type":"string",
            "description":"Source organization for the transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "type":"integer",
            "description":"Unique identifier for the source organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"integer",
            "description":"Status value of the expedite transfer order recommendation. Valid values are 1 - Accepted, 2 - In review, and 3 - Pending. The default value is 3 - Pending.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusText":{
            "maxLength":4000,
            "type":"string",
            "description":"Status of the expedite transfer order recommendation. Valid values are Pending, In review, and Accepted. The default value is Pending.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedDueDate":{
            "type":"string",
            "description":"Date when a supply is expected to be completed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TaskValue":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies the task associated with the transfer order in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ID of the task associated with the transfer order in an attribute-based plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TimeZone":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that uniquely identifies the time zone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply transaction. This value is internally generated by the application.",
            "nullable":true,
            "x-queryable":true
        },
        "UOM":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the unit of measure associated with the order quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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