Jump to

• Request
• Response

Create a default transfer order shipline

post

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

Request

Path Parameters

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

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ShipmentLineId: integer (int64)
  Title: Shipment Line ID

  Value that Identifies the shipment line.
• TradeOperationId: integer (int64)
  Title: Trade Operation ID

  Value that uniquely identifies a trade operation.
• TropDefaultToShipLineId: integer (int64)
  Value that uniquely identifies the default transfer order shiplines associated with a trade operation.

{
    "type":"object",
    "properties":{
        "TropDefaultToShipLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the default transfer order shiplines associated with a trade operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "TradeOperationId":{
            "title":"Trade Operation ID",
            "type":"integer",
            "description":"Value that uniquely identifies a trade operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ShipmentLineId":{
            "title":"Shipment Line ID",
            "type":"integer",
            "description":"Value that Identifies the shipment line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        }
    }
}

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-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 shiplines 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":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "DestinationOrganization":{
            "title":"Destination Organization",
            "maxLength":18,
            "type":"string",
            "description":"Destination organization receiving the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuantityShipped":{
            "title":"Shipped Quantity",
            "type":"number",
            "description":"Quantity shipped in the shipment.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "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
        },
        "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
        },
        "TropDefaultToShipLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the default transfer order shiplines associated with a trade operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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
        },
        "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
        },
        "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
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the item.",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "RequestedQuantity":{
            "title":"Requested Quantity",
            "type":"number",
            "description":"Requested quantity of the shipment.",
            "nullable":false,
            "readOnly":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
        }
    }
}

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