Jump to

• Request
• Response
• Examples

Get all shipment lines

get

/fscmRestApi/resources/11.13.18.05/shipmentLineTransactionRequests/{TransactionId}/child/shipmentLines

Request

Path Parameters

• TransactionId(required): integer(int64)
  Value that uniquely identifies the shipment line transaction request.

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 shipment lines according to the primary key criteria.
    Finder Variables:
    • DeliveryDetailInterfaceId; integer; Value that uniquely identifies the shipment line.
• 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:
  

  • BaseItem; string; Name of the base item.
  • BaseItemId; integer; Value that uniquely identifies the base Assemble to Order (ATO) model information used for internal processing.
  • Carrier; string; Name of the carrier that transports the shipment.
  • CarrierId; integer; Value that uniquely identifies the carrier.
  • CarrierNumber; string; Number that identifies the carrier that transports the shipment.
  • EndAssemblyItem; string; Number that identifies the finished assembled item to build by using the item shipped on this shipment line.
  • InitialDestinationId; integer; Value that uniquely identifies the initial leg of the transportation planned to deliver the shipment to the final destination.
  • Item; string; Value that uniquely identifies the item.
  • ItemId; integer; Value that uniquely identifies the inventory item.
  • ModeOfTransportCode; string; Abbreviation that identifies the mode of transport for the shipping method. A list of accepted values is defined in the lookup WSH_MODE_OF_TRANSPORT.
  • OrderTypeCode; string; Abbreviation the identifies the type of source document. The default value is SALES_ORDER. A list of accepted values is defined in the lookup ORA_WSH_ORDER_LINE_TYPE.
  • OrganizationCode; string; Abbreviation that identifies the ship-from organization.
  • OrganizationId; integer; Value that uniquely identifies the inventory organization.
  • OrganizationName; string; Name of the inventory organization.
  • ProjectCostingProjectName; string; Name of the project for standardized project cost collection. This attribute is associated with a feature that requires opt in.
  • ProjectCostingTaskName; string; Name of the task for standardized project cost collection. This attribute is associated with a feature that requires opt in.
  • RequestedDate; string; Date when the customer requested the order line.
  • ScheduledShipDate; string; Date when the order line is scheduled to be shipped.
  • ServiceLevelCode; string; Abbreviation that identifies the service level for the shipping method. A list of accepted values is defined in the lookup WSH_SERVICE_LEVELS.
  • TransportationShipment; string; Value that identifies the planned shipment from the transportation management application.
• 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:
  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.

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 : shipmentLineTransactionRequests-shipmentLines

Type: object

Show Source

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

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

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

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object shipmentLineTransactionRequests-shipmentLines-item-response

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

Type: object

Show Source

• ArrivalSet: string
  Maximum Length: 150

  Arrival set that contains the order line.
• AssessableValue: number
  Deemed price at which a product is valued by a tax authority for tax calculation purposes. The same product can have more than one assessable value as given by different tax authorities.
• attachments: array Attachments
  Title: Attachments

  The Attachments resource manages details about shipment line attachments.
• BackorderedQuantity: number
  Read Only: true

  Quantity that was withheld from processing until inventory becomes available.
• BaseItem: string
  Maximum Length: 300

  Name of the base item.
• BaseItemId: integer (int64)
  Value that uniquely identifies the base Assemble to Order (ATO) model information used for internal processing.
• BillToContact: string
  Maximum Length: 360

  Person to contact at the bill-to customer site.
• BillToContactId: integer (int64)
  Value that uniquely identifies the bill-to contact for the order line.
• BillToContactNumber: string
  Maximum Length: 30

  Number that identifies the person to contact at the bill-to customer.
• BillToCustomer: string
  Maximum Length: 360

  Name of the party to bill for the sales order line.
• BillToCustomerNumber: string
  Maximum Length: 30

  Number that identifies the person to be contacted for any billing details.
• BillToPartyId: integer (int64)
  Value that uniquely identifies the bill-to party for the order line.
• BillToPartySiteId: integer (int64)
  Value that uniquely identifies the bill-to party site.
• BillToPartySiteNumber: string
  Maximum Length: 150

  Number that identifies the bill-to party site.
• BusinessUnit: string
  Maximum Length: 240

  Name of the selling business unit.
• BusinessUnitId: integer (int64)
  Value that uniquely identifies the selling business unit.
• Carrier: string
  Maximum Length: 360

  Name of the carrier that transports the shipment.
• CarrierId: integer (int64)
  Value that uniquely identifies the carrier.
• CarrierNumber: string
  Maximum Length: 30

  Number that identifies the carrier that transports the shipment.
• ConvertedQuantity: number
  Read Only: true

  Shipped or backordered quantity of the line converted to ordered UOM.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the shipment line.
• CreationDate: string (date-time)
  Read Only: true

  Date when the shipment line was created.
• Currency: string
  Maximum Length: 15

  Abbreviation that identifies the currency of the shipment line.
• CustomerItem: string
  Maximum Length: 240

  Customer item number.
• CustomerPONumber: string
  Maximum Length: 50

  Number that identifies the customer purchase order.
• DeliveryDetailInterfaceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the shipment line.
• DFF: array Flexfields for Shipment Lines
  Title: Flexfields for Shipment Lines

  The Flexfields for Shipment Lines resource manages details about shipment lines.
• DocumentFiscalClassificationCode: string
  Maximum Length: 240

  Abbreviation that identifies the document fiscal classification code.
• DoNotShipAfterDate: string (date-time)
  Date after which the line cannot be shipped.
• DoNotShipBeforeDate: string (date-time)
  Date before which the line cannot be shipped.
• EarliestDropoffDate: string (date-time)
  Earliest date when the shipment line can be delivered to the customer.
• EarliestPickupDate: string (date-time)
  Earliest date when the shipment line can be picked up.
• EndAssemblyItem: string
  Maximum Length: 300

  Number that identifies the finished assembled item to build by using the item shipped on this shipment line.
• errors: array Errors
  Title: Errors

  The Errors resource manages errors encountered while processing an order from the interface to the base tables.
• FirstPartyTaxRegistrationId: integer (int64)
  Value that uniquely identifies the first party tax registration for the transaction.
• FirstPartyTaxRegistrationNumber: string
  Maximum Length: 30

  Number that identifies the first-party tax registration for the transaction.
• FOBCode: string
  Maximum Length: 30

  Abbreviation that identifies ownership of the items that are in transit. A list of acceptable values is defined in the lookup FOB.
• FreightTermsCode: string
  Maximum Length: 30

  Abbreviation that identifies the agreement that describes whether the buyer or seller pays the shipping cost of the sales order and when is the payment due. A list of acceptable values is defined in the lookup WSH_FREIGHT_CHARGE_TERMS.
• GradeCode: string
  Maximum Length: 150

  Abbreviation that identifies the preferred grade of the item.
• holds: array Holds
  Title: Holds

  The Holds resource manages details about shipment line holds.
• InitialDestinationId: integer (int64)
  Value that uniquely identifies the initial leg of the transportation planned to deliver the shipment to the final destination.
• IntendedUse: string
  Maximum Length: 30

  Name of the intended use classification identifier.
• IntendedUseClassificationId: number
  Value that uniquely identifies the intended use classification.
• Item: string
  Maximum Length: 240

  Value that uniquely identifies the item.
• ItemDescription: string
  Maximum Length: 250

  Description of the inventory item.
• ItemId: integer (int64)
  Value that uniquely identifies the inventory item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the shipment line was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the shipment line.
• LatestDropoffDate: string (date-time)
  Latest date when the shipment line can be delivered to the customer.
• LatestPickupDate: string (date-time)
  Latest date when the shipment line can be picked up.
• LineActionType: string
  Maximum Length: 30

  Abbreviation that identifies how to process this shipment line. Valid values are CREATE and UPDATE. This attribute is ignored when the action code at the header level is ValidateAndLock, Lock, ReleaseLock, TPUpdate, or TPDelete.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationOfFinalDischargeCode: string
  Maximum Length: 60

  Value that indicates the final destination location for the purchases made by the customer. The location code of the final customer or where the goods would be used is not necessarily the same as the initial ship-to location.
• LocationOfFinalDischargeId: integer (int64)
  Value that uniquely identifies the final discharge location.
• MaximumOvershipmentPercentage: number
  Maximum percent above the requested quantity that can ship on a shipment line.
• MaximumUndershipmentPercentage: number
  Maximum percent below the requested quantity that can ship on a shipment line.
• ModeOfTransportCode: string
  Maximum Length: 30

  Abbreviation that identifies the mode of transport for the shipping method. A list of accepted values is defined in the lookup WSH_MODE_OF_TRANSPORT.
• notes: array Notes
  Title: Notes

  The Notes resource manages details about shipment line notes, such as packing instructions and shipping instructions.
• Order: string
  Read Only: true

  Maximum Length: 150

  Sales order number from the application that stores the order.
• OrderLine: string
  Maximum Length: 150

  Sales order line number from the application that stores the order.
• OrderSchedule: string
  Maximum Length: 150

  Sales order shipment number from the application that stores the order.
• OrderTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation the identifies the type of source document. The default value is SALES_ORDER. A list of accepted values is defined in the lookup ORA_WSH_ORDER_LINE_TYPE.
• OrganizationCode: string
  Maximum Length: 240

  Abbreviation that identifies the ship-from organization.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization.
• OrganizationName: string
  Maximum Length: 240

  Name of the inventory organization.
• OriginalItemConvertedQuantity: number
  Read Only: true

  Shipped or backordered quantity of the line converted to an original item and ordered UOM.
• ParentItem: string
  Maximum Length: 240

  Name of the parent item.
• ParentItemId: integer (int64)
  Value that uniquely identifies the parent item.
• ParentSourceOrderFulfillmentLineId: integer (int64)
  Value that uniquely identifies the source shipment of the parent item.
• ProductCategoryCode: string
  Maximum Length: 240

  Abbreviation that identifies the product category of the transaction line.
• ProductFiscalClassification: string
  Maximum Length: 250

  Category of the attachment.
• ProductFiscalClassificationId: integer (int64)
  Value that uniquely identifies the product fiscal classification of the transaction line.
• ProductTypeCode: string
  Maximum Length: 240

  Abbreviation that identifies the product type of the inventory item.
• ProjectCostingProjectId: integer (int64)
  Value that uniquely identifies the project for standardized project cost collection.
• ProjectCostingProjectName: string
  Maximum Length: 240

  Name of the project for standardized project cost collection. This attribute is associated with a feature that requires opt in.
• ProjectCostingProjectNumber: string
  Maximum Length: 25

  Number that identifies the project for standardized project cost collection.
• ProjectCostingTaskId: integer (int64)
  Value that uniquely identifies the task for standardized project cost collection.
• ProjectCostingTaskName: string
  Maximum Length: 255

  Name of the task for standardized project cost collection. This attribute is associated with a feature that requires opt in.
• ProjectCostingTaskNumber: string
  Maximum Length: 100

  Number that identifies the task for standardized project cost collection.
• ProjectSalesOrderFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then project details available with source application. If false, then project details are not available with source application. This attribute does not have a default value.
• QuantityUOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the requested quantity on the source order line.
• ReleaseLockFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then release any existing lock against the fulfillment lines. If false, then retain any existing locks. The default value is false.
• RequestedDate: string (date-time)
  Date when the customer requested the order line.
• RequestedDateTypeCode: string
  Maximum Length: 30

  Abbreviation that indicates whether the requested date occurs when the material ships or when it arrives.
• ScheduledShipDate: string (date-time)
  Date when the order line is scheduled to be shipped.
• SecondaryBackorderedQuantity: number
  Read Only: true

  Backordered quantity in the secondary unit of measure.
• SecondaryConvertedQuantity: number
  Read Only: true

  Secondary shipped or backordered quantity converted into ordered quantity unit.
• SecondaryQuantityUOM: string
  Read Only: true

  Maximum Length: 25

  Secondary unit of measure for the requested quantity on the source order line.
• SecondaryQuantityUOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the secondary unit of measure for the requested quantity on the source order line.
• SecondarySourceRequestedQuantity: number
  Quantity, in the item's secondary unit of measure, requested on the source order line.
• SecondarySourceRequestedQuantityUOM: string
  Maximum Length: 25

  Secondary unit of measure for the requested quantity on the source order line.
• SecondarySourceRequestedQuantityUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the secondary unit of measure for the requested quantity on the source order line.
• SecondaryStagedQuantity: number
  Read Only: true

  Quantity of the order line that is staged in the secondary unit of measure.
• SellingPrice: number
  Unit of measure for the requested quantity on the source order line.
• SellingPriceCurrency: string
  Maximum Length: 15

  Value that uniquely identifies the type of currency used for the selling price.
• ServiceLevelCode: string
  Maximum Length: 30

  Abbreviation that identifies the service level for the shipping method. A list of accepted values is defined in the lookup WSH_SERVICE_LEVELS.
• ShipmentPriorityCode: string
  Maximum Length: 30

  Abbreviation that identifies the priority of the demand lines to ship. A list of acceptable values is defined in the lookup WSH_SHIPPING_PRIORITY.
• ShipmentSet: string
  Maximum Length: 150

  Shipment set that contains the order line.
• ShippedQuantity: number
  Read Only: true

  Quantity that was shipped in the requested unit of measure.
• ShipToContact: string
  Maximum Length: 360

  Person to contact at the ship-to customer site.
• ShipToContactId: integer (int64)
  Value that uniquely identifies the ship-to contact for the shipment line.
• ShipToContactNumber: string
  Maximum Length: 30

  Number that identifies the person to contact at the ship-to customer.
• ShipToCustomer: string
  Maximum Length: 360

  Name of the party who receives the sales order line that ships.
• ShipToCustomerNumber: string
  Maximum Length: 30

  Number that identifies the ship-to party.
• ShipToPartyId: integer (int64)
  Value that uniquely identifies the ship-to party.
• ShipToPartySiteId: integer (int64)
  Value that uniquely identifies the ship-to party site.
• ShipToPartySiteNumber: string
  Maximum Length: 150

  Number that identifies the ship-to party site.
• SoldToContact: string
  Maximum Length: 360

  Person to contact at the sold-to customer site.
• SoldToContactId: integer (int64)
  Value that uniquely identifies the sold-to contact for the shipment line.
• SoldToContactNumber: string
  Maximum Length: 30

  Number that identifies the person to contact at the sold-to customer.
• SoldToCustomer: string
  Maximum Length: 360

  Name of the party who purchased the sales order line.
• SoldToCustomerNumber: string
  Maximum Length: 30

  Number that identifies the sold-to party.
• SoldToPartyId: integer (int64)
  Value that uniquely identifies the sold-to party.
• SourceLineUpdateDate: string (date-time)
  Date when the source line was most recently updated.
• SourceOrder: string
  Read Only: true

  Maximum Length: 150

  Number that identifies the source order header.
• SourceOrderFulfillmentLine: string
  Maximum Length: 150

  Number that identifies the source order fulfillment line within the source order line.
• SourceOrderFulfillmentLineId: integer (int64)
  Value that uniquely identifies the source order fulfillment line.
• SourceOrderLine: string
  Maximum Length: 150

  Number that identifies the source order line within the source order header.
• SourceRequestedQuantity: number
  Quantity requested by the customer on the source order line.
• SourceRequestedQuantityUOM: string
  Maximum Length: 25

  Unit of measure for the requested quantity on the source order line.
• SourceRequestedQuantityUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the requested quantity on the source order line.
• SourceSubinventory: string
  Subinventory from which the requested item should be picked if the material is available.
• SourceSystem: string
  Read Only: true

  Maximum Length: 80

  Name of the source application.
• SourceSystemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the source application.
• SrcAttribute1: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the first user descriptive flexfield.
• SrcAttribute10: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the tenth user descriptive flexfield.
• SrcAttribute11: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the eleventh user descriptive flexfield.
• SrcAttribute12: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the twelfth user descriptive flexfield.
• SrcAttribute13: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the thirteenth user descriptive flexfield.
• SrcAttribute14: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the fourteenth user descriptive flexfield.
• SrcAttribute15: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the fifteenth user descriptive flexfield.
• SrcAttribute16: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the sixteenth user descriptive flexfield.
• SrcAttribute17: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the seventeenth user descriptive flexfield.
• SrcAttribute18: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the eighteenth user descriptive flexfield.
• SrcAttribute19: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the nineteenth user descriptive flexfield.
• SrcAttribute2: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the second user descriptive flexfield.
• SrcAttribute20: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the twentieth user descriptive flexfield.
• SrcAttribute3: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the third user descriptive flexfield.
• SrcAttribute4: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield.
• SrcAttribute5: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield.
• SrcAttribute6: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the sixth user descriptive flexfield.
• SrcAttribute7: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the seventh user descriptive flexfield.
• SrcAttribute8: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the eighth user descriptive flexfield.
• SrcAttribute9: string
  Maximum Length: 150

  Value that indicates the source application descriptive flexfield segment of the ninth user descriptive flexfield.
• SrcAttributeCategory: string
  Maximum Length: 30

  Value that identifies the category for the source application descriptive flexfields.
• SrcAttributeDate1: string (date)
  Date that indicates the source application descriptive flexfield segment of the first user descriptive flexfield.
• SrcAttributeDate2: string (date)
  Date that indicates the source application descriptive flexfield segment of the second user descriptive flexfield.
• SrcAttributeDate3: string (date)
  Date that indicates the source application descriptive flexfield segment of the third user descriptive flexfield.
• SrcAttributeDate4: string (date)
  Date that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield.
• SrcAttributeDate5: string (date)
  Date that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield.
• SrcAttributeNumber1: number
  Number that indicates the source application descriptive flexfield segment of the first user descriptive flexfield.
• SrcAttributeNumber10: number
  Number that indicates the source application descriptive flexfield segment of the tenth user descriptive flexfield.
• SrcAttributeNumber2: number
  Number that indicates the source application descriptive flexfield segment of the second user descriptive flexfield.
• SrcAttributeNumber3: number
  Number that indicates the source application descriptive flexfield segment of the third user descriptive flexfield.
• SrcAttributeNumber4: number
  Number that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield.
• SrcAttributeNumber5: number
  Number that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield.
• SrcAttributeNumber6: number
  Number that indicates the source application descriptive flexfield segment of the sixth user descriptive flexfield.
• SrcAttributeNumber7: number
  Number that indicates the source application descriptive flexfield segment of the seventh user descriptive flexfield.
• SrcAttributeNumber8: number
  Number that indicates the source application descriptive flexfield segment of the eighth user descriptive flexfield.
• SrcAttributeNumber9: number
  Number that indicates the source application descriptive flexfield segment of the ninth user descriptive flexfield.
• SrcAttributeTimestamp1: string (date-time)
  Date and time that indicates the source application descriptive flexfield segment of the first user descriptive flexfield.
• SrcAttributeTimestamp2: string (date-time)
  Date and time that indicates the source application descriptive flexfield segment of the second user descriptive flexfield.
• SrcAttributeTimestamp3: string (date-time)
  Date and time that indicates the source application descriptive flexfield segment of the third user descriptive flexfield.
• SrcAttributeTimestamp4: string (date-time)
  Date and time that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield.
• SrcAttributeTimestamp5: string (date-time)
  Date and time that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield.
• StagedQuantity: number
  Read Only: true

  Quantity of the order line that is staged.
• TaxationCountryCode: string
  Maximum Length: 2

  Abbreviation that identifies the country where the transaction has taken place for taxation purposes.
• TaxClassificationCode: string
  Maximum Length: 50

  Abbreviation that identifies the tax classification, a grouping of taxes for reporting, and processing purposes.
• TaxExemptionCertificateNumber: string
  Maximum Length: 80

  Number that identifies the tax exemption certificate.
• TaxExemptionReasonCode: string
  Maximum Length: 30

  Abbreviation that identifies the tax exemption reason.
• TaxInvoiceDate: string (date)
  Date and time when the tax invoice used to meet specific tax reporting requirements of different countries was generated.
• TaxInvoiceNumber: string
  Maximum Length: 150

  Number of the tax invoice used to meet specific tax reporting requirements of different countries.
• ThirdPartyTaxRegistrationId: integer (int64)
  Value that uniquely identifies the third party tax registration for the transaction.
• ThirdPartyTaxRegistrationNumber: string
  Maximum Length: 30

  Number that identifies the third-party tax registration for the transaction.
• TradeComplianceDate: string (date-time)
  Date when the trade compliance status was updated.
• TradeComplianceReason: string
  Maximum Length: 2000

  Reason for the trade compliance screening status.
• TradeComplianceStatusCode: string
  Maximum Length: 30

  Abbreviation that identifies the status of the trade compliance screening of the shipment line. A list of acceptable values is defined in the lookup ORA_WSH_TRD_COMP_STATUS.
• TransactionBusinessCategoryCode: string
  Maximum Length: 240

  Abbreviation that identifies the business classification used by Oracle Fusion Tax to identify and categorize an external transaction into a Oracle Fusion Tax transaction.
• TransportationPlanningDate: string (date-time)
  Date when the transportation planning of the shipment line is received.
• TransportationPlanningStatusCode: string
  Maximum Length: 30

  Abbreviation that identifies the status of the transportation planning of the shipment line. A list of acceptable values is defined in the lookup ORA_WSH_TRAN_PLAN_STATUS.
• TransportationShipment: string
  Maximum Length: 101

  Value that identifies the planned shipment from the transportation management application.
• TransportationShipmentLine: string
  Maximum Length: 101

  Value that identifies the planned shipment line from the transportation management application.
• UnitPrice: number
  Price of item for each unit.
• UserDefinedFiscalClassificationCode: string
  Maximum Length: 30

  Abbreviation that identifies the classification for any tax requirement that you cannot define using the existing fiscal classification types.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the shipment line was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SecondaryQuantityUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure for the requested quantity on the source order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EarliestDropoffDate":{
            "type":"string",
            "description":"Earliest date when the shipment line can be delivered to the customer.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TaxationCountryCode":{
            "maxLength":"2",
            "type":"string",
            "description":"Abbreviation that identifies the country where the transaction has taken place for taxation purposes.",
            "nullable":true,
            "x-queryable":false
        },
        "DFF":{
            "title":"Flexfields for Shipment Lines",
            "type":"array",
            "description":"The Flexfields for Shipment Lines resource manages details about shipment lines.",
            "items":{
                "$ref":"#/components/schemas/shipmentLineTransactionRequests-shipmentLines-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "SoldToContactNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the person to contact at the sold-to customer.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttribute9":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the ninth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "ScheduledShipDate":{
            "type":"string",
            "description":"Date when the order line is scheduled to be shipped.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LatestPickupDate":{
            "type":"string",
            "description":"Latest date when the shipment line can be picked up.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttribute8":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the eighth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "UserDefinedFiscalClassificationCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the classification for any tax requirement that you cannot define using the existing fiscal classification types.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to party.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TransportationShipmentLine":{
            "maxLength":"101",
            "type":"string",
            "description":"Value that identifies the planned shipment line from the transportation management application.",
            "nullable":true,
            "x-queryable":false
        },
        "Item":{
            "maxLength":"240",
            "type":"string",
            "description":"Value that uniquely identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ThirdPartyTaxRegistrationNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the third-party tax registration for the transaction.",
            "nullable":true,
            "x-queryable":false
        },
        "CarrierNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the carrier that transports the shipment.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductCategoryCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Abbreviation that identifies the product category of the transaction line.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to party for the order line.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Currency":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency of the shipment line.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToCustomer":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the party to bill for the sales order line.",
            "nullable":true,
            "x-queryable":false
        },
        "RequestedDate":{
            "type":"string",
            "description":"Date when the customer requested the order line.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the shipment line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BaseItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the base Assemble to Order (ATO) model information used for internal processing.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the shipment line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SoldToContact":{
            "maxLength":"360",
            "type":"string",
            "description":"Person to contact at the sold-to customer site.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToCustomerNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the person to be contacted for any billing details.",
            "nullable":true,
            "x-queryable":false
        },
        "ThirdPartyTaxRegistrationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the third party tax registration for the transaction.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DocumentFiscalClassificationCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Abbreviation that identifies the document fiscal classification code.",
            "nullable":true,
            "x-queryable":false
        },
        "TradeComplianceStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the status of the trade compliance screening of the shipment line. A list of acceptable values is defined in the lookup ORA_WSH_TRD_COMP_STATUS.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductFiscalClassification":{
            "maxLength":"250",
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-queryable":false
        },
        "ModeOfTransportCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the mode of transport for the shipping method. A list of accepted values is defined in the lookup WSH_MODE_OF_TRANSPORT.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the selling business unit.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToCustomer":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the party who receives the sales order line that ships.",
            "nullable":true,
            "x-queryable":false
        },
        "SoldToContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sold-to contact for the shipment line.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CustomerItem":{
            "maxLength":"240",
            "type":"string",
            "description":"Customer item number.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxInvoiceDate":{
            "type":"string",
            "description":"Date and time when the tax invoice used to meet specific tax reporting requirements of different countries was generated.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "OrderTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation the identifies the type of source document. The default value is SALES_ORDER. A list of accepted values is defined in the lookup ORA_WSH_ORDER_LINE_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages details about shipment line attachments.",
            "items":{
                "$ref":"#/components/schemas/shipmentLineTransactionRequests-shipmentLines-attachments-item-response"
            }
        },
        "ProjectCostingProjectNumber":{
            "maxLength":"25",
            "type":"string",
            "description":"Number that identifies the project for standardized project cost collection.",
            "nullable":true,
            "x-queryable":false
        },
        "ProjectSalesOrderFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then project details available with source application. If false, then project details are not available with source application. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":false
        },
        "SoldToCustomer":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the party who purchased the sales order line.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipmentPriorityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the priority of the demand lines to ship. A list of acceptable values is defined in the lookup WSH_SHIPPING_PRIORITY.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeDate1":{
            "type":"string",
            "description":"Date that indicates the source application descriptive flexfield segment of the first user descriptive flexfield.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerPONumber":{
            "maxLength":"50",
            "type":"string",
            "description":"Number that identifies the customer purchase order.",
            "nullable":true,
            "x-queryable":false
        },
        "CarrierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the carrier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReleaseLockFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then release any existing lock against the fulfillment lines. If false, then retain any existing locks. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeDate5":{
            "type":"string",
            "description":"Date that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "OrderLine":{
            "maxLength":"150",
            "type":"string",
            "description":"Sales order line number from the application that stores the order.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeDate4":{
            "type":"string",
            "description":"Date that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeDate3":{
            "type":"string",
            "description":"Date that indicates the source application descriptive flexfield segment of the third user descriptive flexfield.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeDate2":{
            "type":"string",
            "description":"Date that indicates the source application descriptive flexfield segment of the second user descriptive flexfield.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Abbreviation that identifies the ship-from organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCostingProjectName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project for standardized project cost collection. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumOvershipmentPercentage":{
            "type":"number",
            "description":"Maximum percent above the requested quantity that can ship on a shipment line.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationOfFinalDischargeCode":{
            "maxLength":"60",
            "type":"string",
            "description":"Value that indicates the final destination location for the purchases made by the customer. The location code of the final customer or where the goods would be used is not necessarily the same as the initial ship-to location.",
            "nullable":true,
            "x-queryable":false
        },
        "TransportationShipment":{
            "maxLength":"101",
            "type":"string",
            "description":"Value that identifies the planned shipment from the transportation management application.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSubinventory":{
            "type":"string",
            "description":"Subinventory from which the requested item should be picked if the material is available.",
            "nullable":true,
            "x-queryable":false
        },
        "StagedQuantity":{
            "type":"number",
            "description":"Quantity of the order line that is staged.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShippedQuantity":{
            "type":"number",
            "description":"Quantity that was shipped in the requested unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderSchedule":{
            "maxLength":"150",
            "type":"string",
            "description":"Sales order shipment number from the application that stores the order.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToPartySiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to party site.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ArrivalSet":{
            "maxLength":"150",
            "type":"string",
            "description":"Arrival set that contains the order line.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitPrice":{
            "type":"number",
            "description":"Price of item for each unit.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondarySourceRequestedQuantityUOM":{
            "maxLength":"25",
            "type":"string",
            "description":"Secondary unit of measure for the requested quantity on the source order line.",
            "nullable":true,
            "x-queryable":false
        },
        "holds":{
            "title":"Holds",
            "type":"array",
            "description":"The Holds resource manages details about shipment line holds.",
            "items":{
                "$ref":"#/components/schemas/shipmentLineTransactionRequests-shipmentLines-holds-item-response"
            }
        },
        "TaxExemptionCertificateNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Number that identifies the tax exemption certificate.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystem":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the source application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipmentSet":{
            "maxLength":"150",
            "type":"string",
            "description":"Shipment set that contains the order line.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the shipment line was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DeliveryDetailInterfaceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipment line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ConvertedQuantity":{
            "type":"number",
            "description":"Shipped or backordered quantity of the line converted to ordered UOM.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequestedDateTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that indicates whether the requested date occurs when the material ships or when it arrives.",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the service level for the shipping method. A list of accepted values is defined in the lookup WSH_SERVICE_LEVELS.",
            "nullable":true,
            "x-queryable":true
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The Notes resource manages details about shipment line notes, such as packing instructions and shipping instructions.",
            "items":{
                "$ref":"#/components/schemas/shipmentLineTransactionRequests-shipmentLines-notes-item-response"
            }
        },
        "SrcAttribute19":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the nineteenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondarySourceRequestedQuantityUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure for the requested quantity on the source order line.",
            "nullable":true,
            "x-queryable":false
        },
        "SoldToCustomerNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the sold-to party.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionBusinessCategoryCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Abbreviation that identifies the business classification used by Oracle Fusion Tax to identify and categorize an external transaction into a Oracle Fusion Tax transaction.",
            "nullable":true,
            "x-queryable":false
        },
        "EarliestPickupDate":{
            "type":"string",
            "description":"Earliest date when the shipment line can be picked up.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TradeComplianceDate":{
            "type":"string",
            "description":"Date when the trade compliance status was updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "SellingPriceCurrency":{
            "maxLength":"15",
            "type":"string",
            "description":"Value that uniquely identifies the type of currency used for the selling price.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceOrderFulfillmentLine":{
            "maxLength":"150",
            "type":"string",
            "description":"Number that identifies the source order fulfillment line within the source order line.",
            "nullable":true,
            "x-queryable":false
        },
        "InitialDestinationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the initial leg of the transportation planned to deliver the shipment to the final destination.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LocationOfFinalDischargeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the final discharge location.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SrcAttribute20":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the twentieth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "GradeCode":{
            "maxLength":"150",
            "type":"string",
            "description":"Abbreviation that identifies the preferred grade of the item.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Carrier":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the carrier that transports the shipment.",
            "nullable":true,
            "x-queryable":true
        },
        "LineActionType":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies how to process this shipment line. Valid values are CREATE and UPDATE. This attribute is ignored when the action code at the header level is ValidateAndLock, Lock, ReleaseLock, TPUpdate, or TPDelete.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToContact":{
            "maxLength":"360",
            "type":"string",
            "description":"Person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":false
        },
        "BaseItem":{
            "maxLength":"300",
            "type":"string",
            "description":"Name of the base item.",
            "nullable":true,
            "x-queryable":true
        },
        "Order":{
            "maxLength":"150",
            "type":"string",
            "description":"Sales order number from the application that stores the order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProjectCostingProjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the project for standardized project cost collection.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SrcAttributeNumber10":{
            "type":"number",
            "description":"Number that indicates the source application descriptive flexfield segment of the tenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryQuantityUOM":{
            "maxLength":"25",
            "type":"string",
            "description":"Secondary unit of measure for the requested quantity on the source order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipToContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to contact for the shipment line.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "FOBCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies ownership of the items that are in transit. A list of acceptable values is defined in the lookup FOB.",
            "nullable":true,
            "x-queryable":false
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the selling business unit.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceOrder":{
            "maxLength":"150",
            "type":"string",
            "description":"Number that identifies the source order header.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FirstPartyTaxRegistrationNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the first-party tax registration for the transaction.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxInvoiceNumber":{
            "maxLength":"150",
            "type":"string",
            "description":"Number of the tax invoice used to meet specific tax reporting requirements of different countries.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceLineUpdateDate":{
            "type":"string",
            "description":"Date when the source line was most recently updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "SourceOrderLine":{
            "maxLength":"150",
            "type":"string",
            "description":"Number that identifies the source order line within the source order header.",
            "nullable":true,
            "x-queryable":false
        },
        "SoldToPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sold-to party.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SellingPrice":{
            "type":"number",
            "description":"Unit of measure for the requested quantity on the source order line.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeNumber2":{
            "type":"number",
            "description":"Number that indicates the source application descriptive flexfield segment of the second user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentSourceOrderFulfillmentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source shipment of the parent item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SrcAttributeNumber1":{
            "type":"number",
            "description":"Number that indicates the source application descriptive flexfield segment of the first user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToContact":{
            "maxLength":"360",
            "type":"string",
            "description":"Person to contact at the ship-to customer site.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttribute10":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the tenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeNumber4":{
            "type":"number",
            "description":"Number that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryStagedQuantity":{
            "type":"number",
            "description":"Quantity of the order line that is staged in the secondary unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SrcAttributeNumber3":{
            "type":"number",
            "description":"Number that indicates the source application descriptive flexfield segment of the third user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "ProjectCostingTaskNumber":{
            "maxLength":"100",
            "type":"string",
            "description":"Number that identifies the task for standardized project cost collection.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeNumber6":{
            "type":"number",
            "description":"Number that indicates the source application descriptive flexfield segment of the sixth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeNumber5":{
            "type":"number",
            "description":"Number that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeNumber8":{
            "type":"number",
            "description":"Number that indicates the source application descriptive flexfield segment of the eighth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToContactNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the person to contact at the bill-to customer.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeNumber7":{
            "type":"number",
            "description":"Number that indicates the source application descriptive flexfield segment of the seventh user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxClassificationCode":{
            "maxLength":"50",
            "type":"string",
            "description":"Abbreviation that identifies the tax classification, a grouping of taxes for reporting, and processing purposes.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttribute16":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the sixteenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttribute15":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the fifteenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeNumber9":{
            "type":"number",
            "description":"Number that indicates the source application descriptive flexfield segment of the ninth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryBackorderedQuantity":{
            "type":"number",
            "description":"Backordered quantity in the secondary unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssessableValue":{
            "type":"number",
            "description":"Deemed price at which a product is valued by a tax authority for tax calculation purposes. The same product can have more than one assessable value as given by different tax authorities.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttribute18":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the eighteenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttribute17":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the seventeenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeTimestamp1":{
            "type":"string",
            "description":"Date and time that indicates the source application descriptive flexfield segment of the first user descriptive flexfield.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TransportationPlanningStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the status of the transportation planning of the shipment line. A list of acceptable values is defined in the lookup ORA_WSH_TRAN_PLAN_STATUS.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttribute12":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the twelfth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeTimestamp2":{
            "type":"string",
            "description":"Date and time that indicates the source application descriptive flexfield segment of the second user descriptive flexfield.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "DoNotShipAfterDate":{
            "type":"string",
            "description":"Date after which the line cannot be shipped.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttribute11":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the eleventh user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeTimestamp3":{
            "type":"string",
            "description":"Date and time that indicates the source application descriptive flexfield segment of the third user descriptive flexfield.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttribute14":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the fourteenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeTimestamp4":{
            "type":"string",
            "description":"Date and time that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "errors":{
            "title":"Errors",
            "type":"array",
            "description":"The Errors resource manages errors encountered while processing an order from the interface to the base tables.",
            "items":{
                "$ref":"#/components/schemas/shipmentLineTransactionRequests-shipmentLines-errors-item-response"
            }
        },
        "ProjectCostingTaskName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the task for standardized project cost collection. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "SrcAttribute13":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the thirteenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeTimestamp5":{
            "type":"string",
            "description":"Date and time that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the inventory organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCostingTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task for standardized project cost collection.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DoNotShipBeforeDate":{
            "type":"string",
            "description":"Date before which the line cannot be shipped.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttributeCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the category for the source application descriptive flexfields.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToContactNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the person to contact at the ship-to customer.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentItem":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the parent item.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductFiscalClassificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product fiscal classification of the transaction line.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceSystemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ItemDescription":{
            "maxLength":"250",
            "type":"string",
            "description":"Description of the inventory item.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductTypeCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Abbreviation that identifies the product type of the inventory item.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceRequestedQuantityUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the requested quantity on the source order line.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryConvertedQuantity":{
            "type":"number",
            "description":"Secondary shipped or backordered quantity converted into ordered quantity unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceRequestedQuantityUOM":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure for the requested quantity on the source order line.",
            "nullable":true,
            "x-queryable":false
        },
        "TradeComplianceReason":{
            "maxLength":"2000",
            "type":"string",
            "description":"Reason for the trade compliance screening status.",
            "nullable":true,
            "x-queryable":false
        },
        "IntendedUse":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the intended use classification identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToPartySiteNumber":{
            "maxLength":"150",
            "type":"string",
            "description":"Number that identifies the bill-to party site.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToCustomerNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the ship-to party.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceRequestedQuantity":{
            "type":"number",
            "description":"Quantity requested by the customer on the source order line.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToPartySiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to party site.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TransportationPlanningDate":{
            "type":"string",
            "description":"Date when the transportation planning of the shipment line is received.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "BackorderedQuantity":{
            "type":"number",
            "description":"Quantity that was withheld from processing until inventory becomes available.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QuantityUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the requested quantity on the source order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceOrderFulfillmentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source order fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TaxExemptionReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the tax exemption reason.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to contact for the order line.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "FirstPartyTaxRegistrationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the first party tax registration for the transaction.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ParentItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ShipToPartySiteNumber":{
            "maxLength":"150",
            "type":"string",
            "description":"Number that identifies the ship-to party site.",
            "nullable":true,
            "x-queryable":false
        },
        "IntendedUseClassificationId":{
            "type":"number",
            "description":"Value that uniquely identifies the intended use classification.",
            "nullable":true,
            "x-queryable":false
        },
        "SecondarySourceRequestedQuantity":{
            "type":"number",
            "description":"Quantity, in the item's secondary unit of measure, requested on the source order line.",
            "nullable":true,
            "x-queryable":false
        },
        "FreightTermsCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the agreement that describes whether the buyer or seller pays the shipping cost of the sales order and when is the payment due. A list of acceptable values is defined in the lookup WSH_FREIGHT_CHARGE_TERMS.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttribute7":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the seventh user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "EndAssemblyItem":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the finished assembled item to build by using the item shipped on this shipment line.",
            "nullable":true,
            "x-queryable":true
        },
        "SrcAttribute6":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the sixth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginalItemConvertedQuantity":{
            "type":"number",
            "description":"Shipped or backordered quantity of the line converted to an original item and ordered UOM.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LatestDropoffDate":{
            "type":"string",
            "description":"Latest date when the shipment line can be delivered to the customer.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttribute5":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttribute4":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "MaximumUndershipmentPercentage":{
            "type":"number",
            "description":"Maximum percent below the requested quantity that can ship on a shipment line.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttribute3":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the third user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttribute2":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the second user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcAttribute1":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the source application descriptive flexfield segment of the first user descriptive flexfield.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages details about shipment line attachments.

Show Source

• Array of: object shipmentLineTransactionRequests-shipmentLines-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages details about shipment line attachments.",
    "items":{
        "$ref":"#/components/schemas/shipmentLineTransactionRequests-shipmentLines-attachments-item-response"
    }
}

Nested Schema : Flexfields for Shipment Lines

Type: array

Title: Flexfields for Shipment Lines

The Flexfields for Shipment Lines resource manages details about shipment lines.

Show Source

• Array of: object shipmentLineTransactionRequests-shipmentLines-DFF-item-response

{
    "title":"Flexfields for Shipment Lines",
    "type":"array",
    "description":"The Flexfields for Shipment Lines resource manages details about shipment lines.",
    "items":{
        "$ref":"#/components/schemas/shipmentLineTransactionRequests-shipmentLines-DFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Errors

Type: array

Title: Errors

The Errors resource manages errors encountered while processing an order from the interface to the base tables.

Show Source

• Array of: object shipmentLineTransactionRequests-shipmentLines-errors-item-response

{
    "title":"Errors",
    "type":"array",
    "description":"The Errors resource manages errors encountered while processing an order from the interface to the base tables.",
    "items":{
        "$ref":"#/components/schemas/shipmentLineTransactionRequests-shipmentLines-errors-item-response"
    }
}

Nested Schema : Holds

Type: array

Title: Holds

The Holds resource manages details about shipment line holds.

Show Source

• Array of: object shipmentLineTransactionRequests-shipmentLines-holds-item-response

{
    "title":"Holds",
    "type":"array",
    "description":"The Holds resource manages details about shipment line holds.",
    "items":{
        "$ref":"#/components/schemas/shipmentLineTransactionRequests-shipmentLines-holds-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 : Notes

Type: array

Title: Notes

The Notes resource manages details about shipment line notes, such as packing instructions and shipping instructions.

Show Source

• Array of: object shipmentLineTransactionRequests-shipmentLines-notes-item-response

{
    "title":"Notes",
    "type":"array",
    "description":"The Notes resource manages details about shipment line notes, such as packing instructions and shipping instructions.",
    "items":{
        "$ref":"#/components/schemas/shipmentLineTransactionRequests-shipmentLines-notes-item-response"
    }
}

Nested Schema : shipmentLineTransactionRequests-shipmentLines-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the application shares the attachment. If false, then the application does not share the attachment. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Login that the user used when creating the document.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the user created the attachment.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• DownloadInfo: string
  Title: DownloadInfo

  JSON formatted string containing information required to programmatically retrieve a large file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the contents in the attachment expires.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Name of the attached file.
• FileUrl: string
  Title: File Url

  URL (Uniform Resource Locator) that locates the attachment. This attribute contains a value only if the attachment type is a URL. This is the reference to the file uploaded in the Oracle WebCenter Content server.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the user most recently updated the attachment.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who most recently updated the attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attached file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attached file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) appended to the base URI derived from the endpoint associated with application that is identified by the MODULE_ID.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) that locates the attachment. This attribute contains a value only if the attachment type is a URL.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login that the user used when adding or modifying the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) appended to the base URI derived from the endpoint associated with application that is identified by the MODULE_ID.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment. This attribute contains a value only if the attachment type is a URL.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON formatted string containing information required to programmatically retrieve a large file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Login that the user used when creating the document.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"User who most recently updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"Login that the user used when adding or modifying the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the document.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment. This attribute contains a value only if the attachment type is a URL. This is the reference to the file uploaded in the Oracle WebCenter Content server.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application shares the attachment. If false, then the application does not share the attachment. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents in the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the user most recently updated the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : shipmentLineTransactionRequests-shipmentLines-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context name for shipment lines.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Descriptive flexfield context display value for shipment lines.
• DeliveryDetailInterfaceId: integer (int64)
  Value that uniquely identifies the shipment line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "DeliveryDetailInterfaceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipment line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Descriptive flexfield context display value for shipment lines.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for shipment lines.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : shipmentLineTransactionRequests-shipmentLines-errors-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who received the error.
• CreationDate: string (date-time)
  Read Only: true

  Date when the error was generated.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the error was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the error.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageName: string
  Maximum Length: 30

  Name of the error message.
• MessageText: string
  Maximum Length: 4000

  Text of the error message.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the error.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the error was generated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who received the error.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MessageText":{
            "maxLength":"4000",
            "type":"string",
            "description":"Text of the error message.",
            "nullable":false,
            "x-queryable":false
        },
        "MessageName":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the error message.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the error was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : shipmentLineTransactionRequests-shipmentLines-holds-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the hold.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the hold.
• HoldActionCode: string
  Maximum Length: 30

  Abbreviation that identifies the action code for the hold.
• HoldId: integer (int64)
  Value that uniquely identifies the hold type.
• HoldReason: string
  Maximum Length: 2000

  Description of the reason for the hold.
• HoldReasonCode: string
  Maximum Length: 100

  Value that uniquely identifies the action to be run for this hold request. Valid vales are APPLY_HOLD and RELEASE_HOLD.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the hold.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the hold.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the hold.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the hold.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the action code for the hold.",
            "nullable":true,
            "x-queryable":true
        },
        "HoldId":{
            "type":"integer",
            "description":"Value that uniquely identifies the hold type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the hold.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldReasonCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that uniquely identifies the action to be run for this hold request. Valid vales are APPLY_HOLD and RELEASE_HOLD.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the hold.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldReason":{
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the reason for the hold.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : shipmentLineTransactionRequests-shipmentLines-notes-item-response

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  Value that uniquely identifies the relationship.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  Abbreviation that identifies the corporate currency.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the note.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the user created the note.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  Value that uniquely identifies the person who created the note.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  Type of currency conversion rate.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  Abbreviation that identifies the currency.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  Contains one of the following values: true or false. If true, then the user can delete the note. If false, then the user cannot delete the note. The default value is false.
• EmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  Email address of the user who created the note.
• FormattedAddress: string
  Title: Primary Address

  Read Only: true

  Address of the user who created the note.
• FormattedPhoneNumber: string
  Title: Primary Phone

  Read Only: true

  Phone number of the user who created the note.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the user most recently updated the note.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who most recently updated the note.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the note.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteId: integer (int64)
  Title: Note ID

  Read Only: true

  Value that uniquely identifies the note.
• NoteNumber: string
  Maximum Length: 30

  The alternate unique identifier of the note. A user key that's system generated or from an external system.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  The title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  Text of the actual note.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  Abbreviation that identifies the category of the note.
• ParentNoteId: integer (int64)
  Title: Parent Note ID

  Value that uniquely identifies the parent note.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  Value that uniquely identifies the party for the note.
• PartyName: string
  Title: Author

  Read Only: true

  Maximum Length: 360

  Name of the user who created the record.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  Abbreviation that identifies the object that the OBJECTS metadata defines for the note.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  Value that uniquely identifies the object that the OBJECTS metadata defines for the note.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

  Contains one of the following values: true or false. If true, then the user can update the note. If false, then the user cannot update the note. The default value is false.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  Abbreviation that identifies the visibility level of the note.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the note.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of currency conversion rate.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the visibility level of the note.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"Value that uniquely identifies the relationship.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the user can update the note. If false, then the user cannot update the note. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the note. A user key that's system generated or from an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the object that the OBJECTS metadata defines for the note.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"Phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the corporate currency.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"Text of the actual note.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":"500",
            "type":"string",
            "description":"The title of the note entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the note.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"Value that uniquely identifies the note.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the note.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"Value that uniquely identifies the person who created the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Primary Address",
            "type":"string",
            "description":"Address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the category of the note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"Email address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the user can delete the note. If false, then the user cannot delete the note. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"Value that uniquely identifies the object that the OBJECTS metadata defines for the note.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"Value that uniquely identifies the party for the note.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"Value that uniquely identifies the parent note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the user most recently updated the note.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating the note.",
            "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"
    }
}

Back to Top

Examples

This example describes how to get all shipment lines.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/TransactionId/child/shipmentLines"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"items": [
	{
		"DeliveryDetailInterfaceId": 300100171231594,
		"LineActionType": "CREATE",
		"OrderTypeCode": "SALES_ORDER",
		"Order": "WSH-1541616290",
		"OrderLine": "1",
		"OrderSchedule": null,
		"SourceOrder": "WSH-1541616290",
		"SourceOrderLine": "1",
		"SourceOrderFulfillmentLine": "1",
		"SourceOrderFulfillmentLineId": 1001,
		"OrganizationId": 208,
		"OrganizationCode": null,
		"OrganizationName": null,
		"ItemId": 149,
		"Item": null,
		"ItemDescription": null,
		"RequestedDate": "2012-08-26T00:00:00+00:00",
		"ScheduledShipDate": "2012-08-26T00:00:00+00:00",
		"RequestedDateTypeCode": null,
		"FreightTermsCode": null,
		"ShipmentPriorityCode": null,
		"FOBCode": null,
		"GradeCode": null,
		"CustomerPONumber": null,
		"CustomerItem": null,
		"ShippedQuantity": null,
		"ConvertedQuantity": null,
		"StagedQuantity": null,
		"BackorderedQuantity": null,
		"QuantityUOMCode": null,
		"SecondaryConvertedQuantity": null,
		"SecondaryStagedQuantity": null,
		"SecondaryBackorderedQuantity": null,
		"SecondaryQuantityUOMCode": null,
		"SecondaryQuantityUOM": null,
		"SourceRequestedQuantity": 3,
		"SourceRequestedQuantityUOMCode": "Ea",
		"SourceRequestedQuantityUOM": null,
		"SecondarySourceRequestedQuantity": null,
		"SecondarySourceRequestedQuantityUOMCode": null,
		"SecondarySourceRequestedQuantityUOM": null,
		"BusinessUnitId": 204,
		"BusinessUnit": null,
		"CarrierId": 12521,
		"Carrier": null,
		"CarrierNumber": null,
		"ModeOfTransportCode": "AIR",
		"ServiceLevelCode": "2DA",
		"EarliestPickupDate": null,
		"LatestPickupDate": null,
		"EarliestDropoffDate": null,
		"LatestDropoffDate": null,
		"ShipToPartyId": 1006,
		"ShipToCustomer": null,
		"ShipToCustomerNumber": null,
		"ShipToPartySiteId": 1089,
		"ShipToPartySiteNumber": null,
		"ShipToContactId": 1560,
		"ShipToContact": null,
		"ShipToContactNumber": null,
		"SoldToPartyId": 1006,
		"SoldToCustomer": null,
		"SoldToCustomerNumber": null,
		"SoldToContactId": null,
		"SoldToContact": null,
		"SoldToContactNumber": null,
		"BillToPartyId": 1006,
		"BillToCustomer": null,
		"BillToCustomerNumber": null,
		"BillToPartySiteId": 1090,
		"BillToPartySiteNumber": null,
		"BillToContactId": 1560,
		"BillToContact": null,
		"BillToContactNumber": null,
		"ShipmentSet": null,
		"ArrivalSet": null,
		"SourceLineUpdateDate": "2018-11-07T18:44:51+00:00",
		"SourceSystemId": 100000011825006,
		"SourceSystem": "OPS";
		"UnitPrice": 100,
		"Currency": "USD",
		"SellingPrice": null,
		"SellingPriceCurrency": "USD",
		"ReleaseLockFlag": null,
		"ParentItemId": null,
		"ParentItem": null,
		"ParentSourceOrderFulfillmentLineId": null,
		"BaseItemId": null,
		"BaseItem": null,
		"EndAssemblyItem": null,
		"SourceSubinventory": null,
		"DoNotShipBeforeDate": null,
		"DoNotShipAfterDate": null,
		"MaximumOvershipmentPercentage": null,
		"MaximumUndershipmentPercentage": null,
		"TaxationCountryCode": null,
		"FirstPartyTaxRegistrationId": null,
		"FirstPartyTaxRegistrationNumber": null,
		"ThirdPartyTaxRegistrationId": null,
		"ThirdPartyTaxRegistrationNumber": null,
		"LocationOfFinalDischargeId": null,
		"LocationOfFinalDischargeCode": null,
		"DocumentFiscalClassificationCode": null,
		"TransactionBusinessCategoryCode": null,
		"UserDefinedFiscalClassificationCode": null,
		"TaxInvoiceNumber": null,
		"TaxInvoiceDate": null,
		"ProductCategoryCode": null,
		"IntendedUseClassificationId": null,
		"IntendedUse": null,
		"ProductTypeCode": null,
		"AssessableValue": null,
		"TaxClassificationCode": null,
		"TaxExemptionCertificateNumber": null,
		"TaxExemptionReasonCode": null,
		"ProductFiscalClassificationId": null,
		"ProductFiscalClassification": null,
		"TransportationPlanningStatusCode": null,
		"TransportationPlanningDate": null,
		"TransportationShipment": null,
		"TransportationShipmentLine": null,
		"InitialDestinationId": null,
		"TradeComplianceStatusCode": null,
		"TradeComplianceDate": null,
		"TradeComplianceReason": null,
		"ProjectSalesOrderFlag": null,
		"SrcAttributeCategory": null,
		"SrcAttribute1": null,
		"SrcAttribute2": null,
		"SrcAttribute3": null,
		"SrcAttribute4": null,
		"SrcAttribute5": null,
		"SrcAttribute6": null,
		"SrcAttribute7": null,
		"SrcAttribute8": null,
		"SrcAttribute9": null,
		"SrcAttribute10": null,
		"SrcAttribute11": null,
		"SrcAttribute12": null,
		"SrcAttribute13": null,
		"SrcAttribute14": null,
		"SrcAttribute15": null,
		"SrcAttribute16": null,
		"SrcAttribute17": null,
		"SrcAttribute18": null,
		"SrcAttribute19": null,
		"SrcAttribute20": null,
		"SrcAttributeNumber1": null,
		"SrcAttributeNumber2": null,
		"SrcAttributeNumber3": null,
		"SrcAttributeNumber4": null,
		"SrcAttributeNumber5": null,
		"SrcAttributeNumber6": null,
		"SrcAttributeNumber7": null,
		"SrcAttributeNumber8": null,
		"SrcAttributeNumber9": null,
		"SrcAttributeNumber10": null,
		"SrcAttributeDate1": null,
		"SrcAttributeDate2": null,
		"SrcAttributeDate3": null,
		"SrcAttributeDate4": null,
		"SrcAttributeDate5": null,
		"SrcAttributeTimestamp1": null,
		"SrcAttributeTimestamp2": null,
		"SrcAttributeTimestamp3": null,
		"SrcAttributeTimestamp4": null,
		"SrcAttributeTimestamp5": null,
		"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
		"CreationDate": "2018-11-07T18:44:51.042+00:00",
		"LastUpdateDate": "2018-11-07T18:44:51+00:00",
		"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593/child/shipmentLines/300100171231594",
			"name": "shipmentLines",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593/child/shipmentLines/300100171231594",
			"name": "shipmentLines",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593",
			"name": "shipmentLineTransactionRequests",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593/child/shipmentLines/300100171231594/child/errors",
			"name": "errors",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593/child/shipmentLines/300100171231594/child/DFF",
			"name": "DFF",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593/child/shipmentLines/300100171231594/child/attachments",
			"name": "attachments",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593/child/shipmentLines/300100171231594/child/holds",
			"name": "holds",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593/child/shipmentLines/300100171231594/child/notes",
			"name": "notes",
			"kind": "collection"
		}
		]
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593/child/shipmentLines",
		"name": "shipmentLines",
		"kind": "collection"
	}
	]
}

Back to Top