Jump to

• Request
• Response

Create a default transfer order shipment line

post

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

Request

Path Parameters

• TradeOperationId(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=

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
• TradeOperationId: integer (int64)
  Title: Trade Operation ID
• TropDefaultToShipLineId: integer (int64)

{
    "type":"object",
    "properties":{
        "ShipmentLineId":{
            "title":"Shipment Line ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "TradeOperationId":{
            "title":"Trade Operation ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TropDefaultToShipLineId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

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
• DestinationOrganizationId: integer (int64)
  Title: Destination Organization

  Read Only: true
• HeaderId: integer (int64)
  Title: Shipment Header ID

  Read Only: true
• InventoryItemId: integer (int64)
  Title: Item ID

  Read Only: true
• ItemNumber: string
  Title: Item

  Read Only: true

  Maximum Length: 300
• LineId: integer (int64)
  Title: Line

  Read Only: true
• LineNumber: integer (int32)
  Title: Line Number

  Read Only: true
• links: array Links
  Title: Links

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

  Read Only: true
• RequestedQuantity: number
  Title: Requested Quantity

  Read Only: true
• ShipmentHeaderId: integer (int64)
  Title: Shipment Header ID

  Read Only: true
• ShipmentLineId: integer (int64)
  Title: Shipment Line ID
• ShipmentLineNumber: integer (int64)
  Title: Shipment Line Number

  Read Only: true
• ShipmentNumber: string
  Title: Shipment Number

  Read Only: true

  Maximum Length: 30
• ShippedDate: string (date-time)
  Title: Shipped Date

  Read Only: true
• SourceOrganization: string
  Title: Source Organization

  Read Only: true

  Maximum Length: 18
• SourceOrganizationId: integer (int64)
  Title: Source Organization

  Read Only: true
• TradeOperationId: integer (int64)
  Title: Trade Operation ID
• TransferOrder: string
  Title: Transfer Order

  Read Only: true

  Maximum Length: 50
• TropDefaultToShipLineId: integer (int64)
• UnitOfMeasure: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 25
• UOMCode: string
  Title: UOM

  Read Only: true

  Maximum Length: 3

{
    "type":"object",
    "properties":{
        "DestinationOrganization":{
            "title":"Destination Organization",
            "maxLength":18,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationOrganizationId":{
            "title":"Destination Organization",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HeaderId":{
            "title":"Shipment Header ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineId":{
            "title":"Line",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line Number",
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "QuantityShipped":{
            "title":"Shipped Quantity",
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedQuantity":{
            "title":"Requested Quantity",
            "type":"number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentHeaderId":{
            "title":"Shipment Header ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipmentLineId":{
            "title":"Shipment Line ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ShipmentLineNumber":{
            "title":"Shipment Line Number",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipmentNumber":{
            "title":"Shipment Number",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShippedDate":{
            "title":"Shipped Date",
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganization":{
            "title":"Source Organization",
            "maxLength":18,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "title":"Source Organization",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TradeOperationId":{
            "title":"Trade Operation ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransferOrder":{
            "title":"Transfer Order",
            "maxLength":50,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TropDefaultToShipLineId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":25,
            "type":"string",
            "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