Jump to

• Request
• Response

Get all default transfer order shipment lines

get

/fscmRestApi/resources/11.13.18.05/tradeOperations/{TradeOperationId}/child/defaultTOShipLines

Request

Path Parameters

• TradeOperationId(required): integer(int64)
  Value that uniquely identifies the trade operation.

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 shipment lines of the default transfer order related to a trade operation using the default transfer order shipment line identifier as the primary key.
    Finder Variables:
    • TropDefaultToShipLineId; integer; Value that uniquely identifies the default transfer order shipment line for a trade operation.
  • findDefaultToShiplines: Finds the default transfer order shipment lines of a trade operation.
    Finder Variables:
    • bindDestinationOrganization; string; Finds the default transfer order shipment lines for a trade operation based on the destination organization.
    • bindDestinationOrganizationId; integer; Finds default transfer order shipment lines for a trade operation based on the destination organization ID.
    • bindShipmentNumber; string; Finds default transfer order shipment lines for a trade operation based on the associated shipment number.
    • bindSourceOrganization; string; Finds default transfer order shipment lines for a trade operation based on the source organization.
    • bindSourceOrganizationId; integer; Finds default transfer order shipment lines for a trade operation based on the source organization ID.
    • bindTransferOrder; string; Finds the default transfer order shipment lines for a trade operation based on the associated transfer order.
    • bindTropDefaultToShipLineId; integer; Value that uniquely identifies the default transfer order shipment line of a trade operation.
• 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:
  

  • DestinationOrganization; string; Destination organization receiving the item.
  • DestinationOrganizationId; integer; Value that uniquely identifies the destination organization receiving the item.
  • HeaderId; integer; Value that uniquely identifies a transfer order header.
  • InventoryItemId; integer; Value that uniquely identifies the item.
  • ItemNumber; string; Number that identifies the item.
  • LineId; integer; Value that uniquely identifies a transfer order line.
  • LineNumber; integer; Number that identifies the transfer order line associated with a trade operation.
  • QuantityShipped; number; Quantity shipped in the shipment.
  • RequestedQuantity; number; Requested quantity of the shipment.
  • ShipmentHeaderId; integer; Value that uniquely identifies a shipment header.
  • ShipmentLineId; integer; Value that Identifies the shipment line.
  • ShipmentLineNumber; integer; Number that identifies the shipment line of a transfer order.
  • ShipmentNumber; string; Number that Identifies the shipment number of a transfer order.
  • ShippedDate; string; Value that indicates the shipment date.
  • SourceOrganization; string; Source organization from which the item is shipped.
  • SourceOrganizationId; integer; Value that uniquely identifies the source organization shipping the item.
  • TradeOperationId; integer; Value that uniquely identifies a trade operation.
  • TransferOrder; string; Number that identifies the transfer order associated with a trade operation.
  • TropDefaultToShipLineId; integer; Value that uniquely identifies the default transfer order shipment lines associated with a trade operation.
  • UOMCode; string; Unit of measure for the shipment quantity in the transfer order.
  • UnitOfMeasure; string; Unit of measure used for the transfer order shipment 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 : tradeOperations-defaultTOShipLines

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/tradeOperations-defaultTOShipLines-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 tradeOperations-defaultTOShipLines-item-response

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

Type: object

Show Source

• DestinationOrganization: string
  Title: Destination Organization

  Read Only: true

  Maximum Length: 18

  Destination organization receiving the item.
• DestinationOrganizationId: integer (int64)
  Title: Destination Organization

  Read Only: true

  Value that uniquely identifies the destination organization receiving the item.
• HeaderId: integer (int64)
  Title: Shipment Header ID

  Read Only: true

  Value that uniquely identifies a transfer order header.
• InventoryItemId: integer (int64)
  Title: Item ID

  Read Only: true

  Value that uniquely identifies the item.
• ItemNumber: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Number that identifies the item.
• LineId: integer (int64)
  Title: Line

  Read Only: true

  Value that uniquely identifies a transfer order line.
• LineNumber: integer (int32)
  Title: Line Number

  Read Only: true

  Number that identifies the transfer order line associated with a trade operation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuantityShipped: number
  Title: Shipped Quantity

  Read Only: true

  Quantity shipped in the shipment.
• RequestedQuantity: number
  Title: Requested Quantity

  Read Only: true

  Requested quantity of the shipment.
• ShipmentHeaderId: integer (int64)
  Title: Shipment Header ID

  Read Only: true

  Value that uniquely identifies a shipment header.
• ShipmentLineId: integer (int64)
  Title: Shipment Line ID

  Value that Identifies the shipment line.
• ShipmentLineNumber: integer (int64)
  Title: Shipment Line Number

  Read Only: true

  Number that identifies the shipment line of a transfer order.
• ShipmentNumber: string
  Title: Shipment Number

  Read Only: true

  Maximum Length: 30

  Number that Identifies the shipment number of a transfer order.
• ShippedDate: string (date-time)
  Title: Shipped Date

  Read Only: true

  Value that indicates the shipment date.
• SourceOrganization: string
  Title: Source Organization

  Read Only: true

  Maximum Length: 18

  Source organization from which the item is shipped.
• SourceOrganizationId: integer (int64)
  Title: Source Organization

  Read Only: true

  Value that uniquely identifies the source organization shipping the item.
• TradeOperationId: integer (int64)
  Title: Trade Operation ID

  Value that uniquely identifies a trade operation.
• TransferOrder: string
  Title: Transfer Order

  Read Only: true

  Maximum Length: 50

  Number that identifies the transfer order associated with a trade operation.
• TropDefaultToShipLineId: integer (int64)
  Value that uniquely identifies the default transfer order shipment lines associated with a trade operation.
• UnitOfMeasure: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 25

  Unit of measure used for the transfer order shipment quantity.
• UOMCode: string
  Title: UOM

  Read Only: true

  Maximum Length: 3

  Unit of measure for the shipment quantity in the transfer order.

{
    "type":"object",
    "properties":{
        "DestinationOrganization":{
            "title":"Destination Organization",
            "maxLength":18,
            "type":"string",
            "description":"Destination organization receiving the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationOrganizationId":{
            "title":"Destination Organization",
            "type":"integer",
            "description":"Value that uniquely identifies the destination organization receiving the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HeaderId":{
            "title":"Shipment Header ID",
            "type":"integer",
            "description":"Value that uniquely identifies a transfer order header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineId":{
            "title":"Line",
            "type":"integer",
            "description":"Value that uniquely identifies a transfer order line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"Number that identifies the transfer order line associated with a trade operation.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "QuantityShipped":{
            "title":"Shipped Quantity",
            "type":"number",
            "description":"Quantity shipped in the shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedQuantity":{
            "title":"Requested Quantity",
            "type":"number",
            "description":"Requested quantity of the shipment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentHeaderId":{
            "title":"Shipment Header ID",
            "type":"integer",
            "description":"Value that uniquely identifies a shipment header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipmentLineId":{
            "title":"Shipment Line ID",
            "type":"integer",
            "description":"Value that Identifies the shipment line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ShipmentLineNumber":{
            "title":"Shipment Line Number",
            "type":"integer",
            "description":"Number that identifies the shipment line of a transfer order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipmentNumber":{
            "title":"Shipment Number",
            "maxLength":30,
            "type":"string",
            "description":"Number that Identifies the shipment number of a transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShippedDate":{
            "title":"Shipped Date",
            "type":"string",
            "description":"Value that indicates the shipment date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganization":{
            "title":"Source Organization",
            "maxLength":18,
            "type":"string",
            "description":"Source organization from which the item is shipped.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "title":"Source Organization",
            "type":"integer",
            "description":"Value that uniquely identifies the source organization shipping the item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TradeOperationId":{
            "title":"Trade Operation ID",
            "type":"integer",
            "description":"Value that uniquely identifies a trade operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransferOrder":{
            "title":"Transfer Order",
            "maxLength":50,
            "type":"string",
            "description":"Number that identifies the transfer order associated with a trade operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TropDefaultToShipLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the default transfer order shipment lines associated with a trade operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"Unit of measure for the shipment quantity in the transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure used for the transfer order shipment quantity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "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