1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Shipment Lines

Get all shipment lines

get

/fscmRestApi/resources/11.13.18.05/shipmentLines

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds shipment lines according to the primary key criteria.
      Finder Variables:
      • ShipmentLine; integer; Value that uniquely identifies the shipment line.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AllowItemSubstitutionFlag; boolean; Contains one of the following values: true or false. If true, then allow item substitution. If false, then do not allow item substitution. This attribute does not have a default value. This attribute is not currently used.
    • ArrivalSet; string; Arrival set that contains the order line.
    • BaseItem; string; Name of the model to use for an assemble-to-order configured item.
    • BaseItemId; integer; Value that uniquely identifies the model to use for an assemble-to-order configured item.
    • BillToAddress1; string; First line of the bill-to customer address.
    • BillToAddress2; string; Second line of the bill-to customer address.
    • BillToAddress3; string; Third line of the bill-to customer address.
    • BillToAddress4; string; Fourth line of the bill-to customer address.
    • BillToCity; string; City of the bill-to customer address.
    • BillToContact; string; Name of the person to contact at the bill-to customer site.
    • BillToContactId; integer; Value that uniquely identifies the bill-to contact for the order line.
    • BillToContactPhone; string; Phone number of the person to contact at the bill-to customer site.
    • BillToCountry; string; Country of the bill-to customer address.
    • BillToCounty; string; County of the bill-to customer address.
    • BillToCustomer; string; Name of the party to bill for the sales order line.
    • BillToFax; string; Fax number of the bill-to customer.
    • BillToLocationId; integer; Value that uniquely identifies the bill-to location for the order line.
    • BillToPartyId; integer; Value that uniquely identifies the bill-to party for the order line.
    • BillToPartySiteId; integer; Value that uniquely identifies the bill-to party site.
    • BillToPostalCode; string; Postal code of the bill-to customer address.
    • BillToRegion; string; Region of the bill-to customer address.
    • BillToState; string; State of the bill-to customer address.
    • BillToURL; string; URL (Uniform Resource Locator) of the bill-to customer.
    • CancelBackorders; string; Indicates if the remaining quantity on the shipment line can be automatically canceled during the pick release, pick confirm, and ship confirm processes.
    • Carrier; string; Name of the carrier who transports the shipment.
    • CarrierId; integer; Value that uniquely identifies the carrier.
    • CarrierNumber; string; Number that identifies the carrier who transports the shipment.
    • CurrencyCode; string; Abbreviation that identifies the currency of the shipment line.
    • CurrentBackorderedQuantityFromEvent; number; Quantity back ordered currently for the shipment line when publishing a back order.
    • CustomerItem; string; Number that identifies the customer item.
    • CustomerItemId; integer; Value that uniquely identifies the customer item.
    • CustomerPONumber; string; Number that identifies the customer purchase order.
    • DestinationOrganizationCode; string; Value of the Destination Organization Code that's retrieved when the Source Document Type is Transfer Order.
    • EndAssemblyItemNumber; string; Finished, assembled item to build, using the item shipped on this shipment line.
    • EnforceSingleShipment; string; Indicates if the order can be fulfilled using a single shipment and the remaining quantity can be automatically canceled during the ship confirm process.
    • FOB; string; Free on board, which indicates the ownership of items that are in transit. A list of accepted values is defined in the lookup type FOB.
    • FOBCode; string; Abbreviation that indicates the ownership of the items that are in transit. A list of accepted values is defined in the lookup type FOB.
    • FreightTerms; string; Agreement that describes whether the buyer or seller pays the shipping cost of the sales order, and when payment is due. A list of accepted values is defined in the lookup type WSH_FREIGHT_CHARGE_TERMS.
    • FreightTermsCode; string; Abbreviation that identifies the freight terms. A list of accepted values is defined in the lookup type WSH_FREIGHT_CHARGE_TERMS.
    • GrossWeight; integer; Gross weight of the shipment line.
    • IntegrationStatus; string; Value that indicates the integration status of a shipment line in an application that resides outside of Oracle applications. A list of accepted values is defined in the lookup type ORA_RCV_EXT_SYS_INTG_STATUS.
    • IntegrationStatusCode; string; Abbreviation that identifies the integration status of a shipment line in an application that resides outside of Oracle applications. A list of accepted values is defined in the lookup type ORA_RCV_EXT_SYS_INTG_STATUS.
    • InventoryItemId; integer; Value that uniquely identifies the inventory item.
    • Item; string; Value that uniquely identifies the item.
    • ItemDescription; string; Description of the inventory item.
    • LineGrossWeight; number; Gross weight of the shipment line. This attribute is associated with a feature that requires opt in.
    • LineNetWeight; number; Net weight of the shipment line. This attribute is associated with a feature that requires opt in.
    • LineStatus; string; Value that indicates the status of the shipment line. Valid values include ready to release, released, staged, shipped, or backordered. A list of accepted values is defined in the lookup type WSH_PICK_STATUS.
    • LineStatusCode; string; Abbreviation that identifies the status code of the shipment line. A list of accepted values is defined in the lookup type WSH_PICK_STATUS.
    • LoadingSequence; integer; Sequence to use when loading the shipment line.
    • Locator; string; Concatenated name of the inventory locator that provides the source for material that ships.
    • LocatorId; integer; Value that uniquely identifies the item locator for the shipment line.
    • LotNumber; string; Number that identifies the lot for the item. The application uses this attribute when the warehouse places the item under lot control.
    • ModeOfTransportCode; string; Abbreviation that identifies the mode of transport for the shipping method. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT.
    • MovementRequestLineId; integer; Value that uniquely identifies the movement request line.
    • NetWeight; integer; Net weight of the shipment line.
    • Order; string; Order number from the order capture application.
    • OrderLine; string; Order line number from the order capture application.
    • OrderSchedule; string; Order shipment number from the order capture application.
    • OrderType; string; Type of source line.
    • OrderTypeCode; string; Abbreviation that identifies the type of source line.
    • 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.
    • OriginalDeliveryDetailId; integer; Value that uniquely identifies the original shipment line. This attribute is not currently used.
    • OriginalItemId; integer; Value that uniquely identifies the original inventory item. This attribute is not currently used.
    • OriginalItemNumber; string; Value that uniquely identifies the original item. This attribute is not currently used.
    • OriginalShipmentLineFromEvent; integer; Value that uniquely identifies the shipment line from which the quantity was originally backordered. This attribute contains a value different from the shipment line when the parameter to consolidate backorders is enabled.
    • OriginalSourceOrderFulfillmentLine; string; Original fulfillment number that identifies the fulfillment line for the order line in the source order.
    • OriginalSourceOrderFulfillmentLineId; integer; Original fulfillment value that uniquely identifies the fulfillment line in the source order.
    • ParentPackingUnit; string; Parent packing unit that contains the item that the shipment line references.
    • ParentPackingUnitId; integer; Value that uniquely identifies the parent packing unit to which the shipment line is packed.
    • PickWave; string; Name of the group of sales orders that the application released into picking.
    • PickWaveId; integer; Value that uniquely identifies the group of sales orders that the application released into picking.
    • PreferredGrade; string; Abbreviation that identifies the preferred grade of the item.
    • PrimaryImageURL; string; Indicates the attachment URL for the primary image of the item.
    • ProjectCostingProjectId; integer; Value that uniquely identifies the project for standardized project cost collection. This attribute is associated with a feature that requires opt in.
    • ProjectCostingProjectNumber; string; Number that identifies the project for standardized project cost collection. This attribute is associated with a feature that requires opt in.
    • ProjectCostingTaskId; integer; Value that uniquely identifies the task for standardized project cost collection. This attribute is associated with a feature that requires opt in.
    • ProjectCostingTaskNumber; string; Number that identifies the task for standardized project cost collection. This attribute is associated with a feature that requires opt in.
    • QuickShipStatus; string; Status of the quick ship process for the shipment line.
    • RcvShipmentLineId; integer; Value that uniquely identifies the advanced shipment notice (ASN) for the shipment line that the supplier supplies in receiving.
    • RequestedDate; string; Date when the customer requested to ship the order line.
    • RequestedDateType; string; Value that determines whether the requested date occurs when the material ships or when it arrives.
    • RequestedDateTypeCode; string; Abbreviation that indicates whether the requested date occurs when the material ships or when it arrives.
    • RequestedQuantity; number; Quantity of the item that the sales order line requests, in the primary unit of measure.
    • RequestedQuantityUOM; string; Primary unit of measure for the ordered quantity.
    • RequestedQuantityUOMCode; string; Abbreviation that identifies the primary unit of measure for the ordered quantity.
    • ReservableFlag; boolean; Contains one of the following values: true or false. If true, the item can be reserved. If false, then the item can't be reserved.
    • ReturnType; string; Value that indicates the type of return order lines. A list of accepted values is defined in the lookup ORA_WSH_ORDER_LINE_RETURN_TYPE.
    • ReturnTypeCode; string; Abbreviation that indicates the type of return order lines. A list of accepted values is defined in the lookup ORA_WSH_ORDER_LINE_RETURN_TYPE.
    • Revision; string; Revision of the item.
    • ScheduledShipDate; string; Date when the order line is scheduled to ship.
    • SecondaryRequestedQuantity; number; Quantity of the item requested on the sales order line, in the secondary unit of measure.
    • SecondaryRequestedQuantityUOM; string; Secondary unit of measure for the ordered quantity.
    • SecondaryRequestedQuantityUOMCode; string; Abbreviation that identifies the secondary unit of measure for the ordered quantity.
    • SecondaryShippedQuantity; number; Shipped quantity, in the secondary unit of measure.
    • SellingPrice; integer; Selling price of the item.
    • ServiceLevelCode; string; Abbreviation that identifies the service level for the shipping method. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS.
    • ShipFromLocationId; integer; Value that uniquely identifies the ship-from location.
    • ShipToAddress1; string; First line of the ship-to customer address.
    • ShipToAddress2; string; Second line of the ship-to customer address.
    • ShipToAddress3; string; Third line of the ship-to customer address.
    • ShipToAddress4; string; Fourth line of the ship-to customer address.
    • ShipToCity; string; City of the ship-to customer address.
    • ShipToContact; string; Name of the person to contact at the ship-to customer site.
    • ShipToContactId; integer; Value that uniquely identifies the contact at the ship-to location.
    • ShipToContactPhone; string; Telephone number for the person to contact at the ship-to customer site.
    • ShipToCountry; string; Country of the ship-to customer address.
    • ShipToCounty; string; County of the ship-to customer address.
    • ShipToCustomer; string; Name of the party who will receive the sales order line that ships.
    • ShipToCustomerNumber; string; Number that identifies the ship-to party.
    • ShipToFax; string; Fax number of the ship-to customer.
    • ShipToLocationId; integer; Value that uniquely identifies the ship-to location.
    • ShipToLocationType; string; Defines the ship-to location type.
    • ShipToPartyId; integer; Value that uniquely identifies the ship-to party.
    • ShipToPartySiteId; integer; Value that uniquely identifies the ship-to party site.
    • ShipToPostalCode; string; Postal code of the ship-to customer address.
    • ShipToRegion; string; Region of the ship-to customer address.
    • ShipToState; string; State of the ship-to customer address.
    • ShipToURL; string; URL (Uniform Resource Locator) that locates the ship-to customer.
    • Shipment; string; Name of the material shipment.
    • ShipmentId; integer; Value that uniquely identifies the shipment.
    • ShipmentLine; integer; Value that uniquely identifies the shipment line.
    • ShipmentSet; string; Shipment set that contains the order line.
    • ShippedQuantity; number; Shipped quantity, in the requested unit of measure.
    • ShippingMethodCode; string; Abbreviation that identifies the transportation method for the shipment line.
    • ShippingPriority; string; Value that indicates the priority of the demand lines to be shipped. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY.
    • ShippingPriorityCode; string; Abbreviation that identifies the priority of the demand lines to ship. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY.
    • SoldToContact; string; Name of the person to contact at the sold-to customer site.
    • SoldToContactId; integer; Value that uniquely identifies the sold-to contact for the shipment line.
    • SoldToContactPhone; string; Phone number for the person to contact at the sold-to customer site.
    • SoldToCustomer; string; Name of the party who purchased the sales order line.
    • SoldToCustomerNumber; string; Number that identifies the sold-to party.
    • SoldToFax; string; Fax number of the sold-to customer.
    • SoldToPartyId; integer; Value that uniquely identifies the sold-to party.
    • SoldToURL; string; URL (Uniform Resource Locator) of the sold-to customer.
    • SourceOrder; string; Number that identifies the source order header.
    • SourceOrderFulfillmentLine; string; Number that identifies the fulfillment line for the order line in the source order.
    • SourceOrderFulfillmentLineId; integer; Value that uniquely identifies the fulfillment line in source order.
    • SourceOrderId; integer; Value that uniquely identifies the source order header.
    • SourceOrderLine; string; Number that identifies the source order line in the source order header.
    • SourceOrderLineId; integer; Value that uniquely identifies the source order line.
    • SourceSystem; string; Name of the source application.
    • SourceSystemId; integer; Value that uniquely identifies the source application.
    • Subinventory; string; Subinventory to use when fulfilling the item to shipped.
    • TradeComplianceScreenedFromEvent; string; Value that indicates if the shipment line is screened for trade compliance when publishing a back order.
    • TradeComplianceStatus; string; Value that indicates the status of trade compliance screening for the shipment line.
    • TradeComplianceStatusCode; string; Abbreviation that identifies the status of trade compliance screening for the shipment line.
    • TransportationPlanningStatus; string; Value that indicates the status of transportation planning for the shipment line. A list of accepted values is defined in the lookup type ORA_WSH_TRAN_PLAN_STATUS.
    • TransportationPlanningStatusCode; string; Abbreviation that identifies the status of transportation planning for the shipment line. A list of accepted values is defined in the lookup type ORA_WSH_TRAN_PLAN_STATUS.
    • TransportationShipment; string; Value that identifies the planned shipment that the transportation management application provides.
    • TransportationShipmentCompleteFromEvent; string; Value that indicates if the transportation shipment is completed when publishing a back order.
    • TransportationShipmentFromEvent; string; Value that identifies the planned shipment from the transportation management application when publishing a back order.
    • TransportationShipmentLineFromEvent; string; Value that identifies the planned shipment line from the transportation management application when publishing a back order.
    • UnitPrice; integer; Price of item for each unit.
    • Volume; integer; Volume of the material for the shipment line.
    • VolumeUOM; string; Unit of measure for volume.
    • VolumeUOMCode; string; Abbreviation that identifies the unit of measure to use for volume.
    • WeightUOM; string; Unit of measure for weight.
    • WeightUOMCode; string; Abbreviation that identifies the unit of measure to use for weight.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : shipmentLines
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : shipmentLines-item-response
Type: object
Show Source
Nested Schema : Attachments for Shipment Lines
Type: array
Title: Attachments for Shipment Lines
The Attachments for Shipment Lines resource manages details about shipment line attachments.
Show Source
Nested Schema : Costs for Shipment Lines
Type: array
Title: Costs for Shipment Lines
The Costs for Shipment Lines resource manages details about the shipping costs for an item.
Show Source
Nested Schema : Flexfields for Inventory Striping Attributes
Type: array
Title: Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages the details of the inventory striping attributes. The inventory striping attributes are a set of named attributes, project, task, and country of origin. This resource is associated with a feature that requires opt in.
Show Source
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
Nested Schema : Flexfields for Lot Attributes
Type: array
Title: Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages details about lot attributes.
Show Source
Nested Schema : Flexfields for Lots
Type: array
Title: Flexfields for Lots
The Flexfields for Lots resource manages details about lots.
Show Source
Nested Schema : Notes for Shipment Lines
Type: array
Title: Notes for Shipment Lines
The Notes for Shipment Lines resource manages details about shipment line notes.
Show Source
Nested Schema : Reservations for Shipment Lines
Type: array
Title: Reservations for Shipment Lines
The Reservations for Shipment Lines resource manages details about the reservations for a shipment line when the supply is not the on-hand quantity.
Show Source
Nested Schema : Serials for Shipment Lines
Type: array
Title: Serials for Shipment Lines
The Serials for Shipment Lines resource manages details about serial numbers for items in shipment lines.
Show Source
Nested Schema : shipmentLines-attachments-item-response
Type: object
Show Source
Nested Schema : shipmentLines-costs-item-response
Type: object
Show Source
Nested Schema : Flexfields for Shipping Costs
Type: array
Title: Flexfields for Shipping Costs
The Flexfields for Shipping Costs resource manages details about shipping costs.
Show Source
Nested Schema : shipmentLines-costs-DFF-item-response
Type: object
Show Source
Nested Schema : shipmentLines-inventoryStripingDFF-item-response
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 40
    Descriptive flexfield context name of the inventory striping attributes for shipment lines. This attribute is associated with a feature that requires opt in.
  • Title: Context Segment
    Descriptive flexfield context display value of the inventory striping attributes for shipment lines. This attribute is associated with a feature that requires opt in.
  • Title: Country of Origin
    Maximum Length: 2
    Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in.
  • Title: Country of Origin
    Name of the country of origin. This attribute is associated with a feature that requires opt in.
  • Title: Line
    Value that uniquely identifies the shipment line. This attribute is associated with a feature that requires opt in.
  • Links
  • Title: Project
    Value that uniquely identifies the inventory attribute project. This attribute is associated with a feature that requires opt in.
  • Title: Project
    Number that identifies the inventory attribute project. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Value that uniquely identifies the inventory attribute task. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Number that identifies the inventory attribute task. This attribute is associated with a feature that requires opt in.
Nested Schema : shipmentLines-lineDFF-item-response
Type: object
Show Source
Nested Schema : shipmentLines-lotAttributeDFF-item-response
Type: object
Show Source
Nested Schema : shipmentLines-lotStandardDFF-item-response
Type: object
Show Source
Nested Schema : shipmentLines-notes-item-response
Type: object
Show Source
Nested Schema : shipmentLines-reservations-item-response
Type: object
Show Source
Nested Schema : shipmentLines-serials-item-response
Type: object
Show Source
  • Flexfields for Serial Attributes
    Title: Flexfields for Serial Attributes
    The Flexfields for Serial Attributes resource manages details about serial attributes for serial numbers.
  • Read Only: true
    Value that uniquely identifies the shipment line.
  • Read Only: true
    Maximum Length: 255
    Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control.
  • Links
  • Serial Numbers
    Title: Serial Numbers
    The Serial Numbers resource manages details about individual serial numbers.
  • Flexfields for Serials
    Title: Flexfields for Serials
    The Flexfields for Serials resource manages details about serial numbers.
  • Read Only: true
    Maximum Length: 80
    Serial number assigned to the item by the supplier.
  • Read Only: true
    Maximum Length: 80
    Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control.
  • Read Only: true
    Value that uniquely identifies a row in the transaction table for temporary inventory.
  • Value that creates a relationship between the serial number and the shipment line. If the line already shipped, then this attribute identifies the shipment line. If the line has not shipped, then this attribute identifies the transaction for a row in a temporary transaction table that references the serial number.
Nested Schema : Flexfields for Serial Attributes
Type: array
Title: Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages details about serial attributes for serial numbers.
Show Source
Nested Schema : Serial Numbers
Type: array
Title: Serial Numbers
The Serial Numbers resource manages details about individual serial numbers.
Show Source
Nested Schema : Flexfields for Serials
Type: array
Title: Flexfields for Serials
The Flexfields for Serials resource manages details about serial numbers.
Show Source
Nested Schema : shipmentLines-serials-attributeDFF-item-response
Type: object
Show Source
Nested Schema : shipmentLines-serials-serialNumbers-item-response
Type: object
Show Source
Nested Schema : Flexfields for Serial Attributes
Type: array
Title: Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages details about serial attributes for serial numbers.
Show Source
Nested Schema : Flexfields for Serials
Type: array
Title: Flexfields for Serials
The Flexfields for Serials resource manages details about serial numbers.
Show Source
Nested Schema : shipmentLines-serials-serialNumbers-attributeDFF-item-response
Type: object
Show Source
Nested Schema : shipmentLines-serials-serialNumbers-standardDFF-item-response
Type: object
Show Source
Nested Schema : shipmentLines-serials-standardDFF-item-response
Type: object
Show Source
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/shipmentLines"

Example Response Body

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

{
    "items": [
        {
            "ShipmentLine": 169003,
            "OrderTypeCode": "SALES_ORDER",
            "OrderType": "Sales order",
            "Order": "180003",
            "OrderLine": "1.1",
            "OrderSchedule": null,
            "InventoryItemId": 3259,
            "Item": "IN01001",
            "ItemDescription": "Smead Hanging Folders",
            "Revision": null,
            "UnitPrice": 4,
            "SellingPrice": null,
            "RequestedQuantity": 1,
            "RequestedQuantityUOMCode": "Box",
            "RequestedQuantityUOM": "Box",
            "SecondaryRequestedQuantity": null,
            "SecondaryRequestedQuantityUOMCode": null,
            "SecondaryRequestedQuantityUOM": null,
            "FOBCode": "Destination",
            "FOB": "Destination",
            "FreightTermsCode": "Paid",
            "FreightTerms": null,
            "ShippingPriorityCode": null,
            "ShippingPriority": null,
            "PreferredGrade": null,
            "PreferredGradeName": null,
            "CurrencyCode": "GBP",
            "CurrencyName": "Pound Sterling",
            "ShipmentSet": null,
            "ArrivalSet": null,
            "CustomerPONumber": null,
            "CustomerItemId": null,
            "CustomerItem": null,
            "CustomerItemDescription": null,
            "RequestedDate": "2002-11-17T00:00:00+00:00",
            "ScheduledShipDate": "2002-11-15T00:00:00+00:00",
            "RequestedDateTypeCode": null,
            "RequestedDateType": null,
            "ShipToPartyId": 14294,
            "ShipToCustomer": "Progress UK",
            "ShipToCustomerNumber": "11765",
            "ShipToPartySiteId": null,
            "ShipToPartySiteNumber": null,
            "ShipToContactId": null,
            "ShipToContact": null,
            "ShipToContactFirstName": null,
            "ShipToContactLastName": null,
            "ShipToContactPhone": null,
            "ShipToURL": null,
            "ShipToFax": null,
            "ShipToEmail": null,
            "ShipToLocationId": 11200,
            "ShipToLocationType": null,
            "ShipToAddress1": "Healthcare",
            "ShipToAddress2": "Oracle Parkway",
            "ShipToAddress3": "Thames Valley Park",
            "ShipToAddress4": null,
            "ShipToCity": "Reading",
            "ShipToCounty": "Berkshire",
            "ShipToPostalCode": "RG6 1RA",
            "ShipToRegion": null,
            "ShipToState": null,
            "ShipToCountry": "GB",
            "SoldToPartyId": 14294,
            "SoldToCustomer": "Progress UK",
            "SoldToCustomerNumber": "11765",
            "Supplier": null,
            "SupplierPartyNumber": null,
            "SoldToContactId": null,
            "SoldToContact": null,
            "SoldToContactFirstName": null,
            "SoldToContactLastName": null,
            "SoldToContactPhone": null,
            "SoldToURL": null,
            "SoldToFax": null,
            "SoldToEmail": null,
            "BillToPartyId": null,
            "BillToCustomer": null,
            "BillToCustomerNumber": null,
            "BillToPartySiteId": null,
            "BillToPartySiteNumber": null,
            "BillToContactId": null,
            "BillToContact": null,
            "BillToContactFirstName": null,
            "BillToContactLastName": null,
            "BillToContactPhone": null,
            "BillToURL": null,
            "BillToFax": null,
            "BillToEmail": null,
            "BillToLocationId": null,
            "BillToAddress1": null,
            "BillToAddress2": null,
            "BillToAddress3": null,
            "BillToAddress4": null,
            "BillToCity": null,
            "BillToCounty": null,
            "BillToPostalCode": null,
            "BillToRegion": null,
            "BillToState": null,
            "BillToCountry": null,
            "Subinventory": "Staging",
            "LocatorId": null,
            "Locator": null,
            "ShippedQuantity": 1,
            "SecondaryShippedQuantity": null,
            "NetWeight": 0,
            "GrossWeight": 0,
            "TareWeight": 0,
            "WeightUOMCode": null,
            "WeightUOM": null,
            "Volume": 0,
            "VolumeUOMCode": null,
            "VolumeUOM": null,
            "LoadingSequence": null,
            "LotNumber": null,
            "EndAssemblyItemNumber": null,
            "OrganizationId": 3512,
            "OrganizationCode": null,
            "OrganizationName": null,
            "ParentPackingUnitId": null,
            "ParentPackingUnit": null,
            "ShipmentId": 42685,
            "Shipment": "42685",
            "ProjectSalesOrderFlag": null,
            "RcvShipmentLineId": null,
            "LineStatusCode": "C",
            "LineStatus": "Interfaced",
            "TrackingNumber": null,
            "SealNumber": null,
            "PickWaveId": null,
            "PickWave": null,
            "SourceOrderId": 73067,
            "SourceOrder": "180003",
            "SourceOrderLineId": 150557,
            "SourceOrderLine": "1.1",
            "SourceOrderFulfillmentLineId": null,
            "SourceOrderFulfillmentLine": null,
            "TaxationCountryCode": null,
            "TaxationCountry": null,
            "FirstPartyTaxRegistrationId": null,
            "FirstPartyTaxRegistrationNumber": null,
            "ThirdPartyTaxRegistrationId": null,
            "ThirdPartyTaxRegistrationNumber": null,
            "LocationOfFinalDischargeId": null,
            "LocationOfFinalDischargeCode": null,
            "LocationOfFinalDischarge": null,
            "DocumentFiscalClassificationCode": null,
            "DocumentFiscalClassification": null,
            "TransactionBusinessCategoryCode": null,
            "TransactionBusinessCategory": null,
            "UserDefinedFiscalClassificationCode": null,
            "UserDefinedFiscalClassification": null,
            "TaxInvoiceNumber": null,
            "TaxInvoiceDate": null,
            "ProductCategoryCode": null,
            "ProductCategory": null,
            "IntendedUseClassificationId": null,
            "IntendedUse": null,
            "ProductTypeCode": null,
            "ProductType": null,
            "AssessableValue": null,
            "TaxClassificationCode": null,
            "TaxClassification": null,
            "TaxExemptionCertificateNumber": null,
            "TaxExemptionReasonCode": null,
            "TaxExemptionReason": null,
            "ProductFiscalClassificationId": null,
            "ProductFiscalClassification": null,
            "TransportationPlanningStatusCode": null,
            "TransportationPlanningStatus": null,
            "TransportationPlanningDate": null,
            "TransportationShipment": null,
            "TransportationShipmentLine": null,
            "InitialDestinationId": null,
            "InitialDestination": null,
            "TradeComplianceStatusCode": null,
            "TradeComplianceStatus": null,
            "TradeComplianceDate": null,
            "TradeComplianceReason": null,
            "TradeComplianceScreeningMethodCode": null,
            "TradeComplianceScreeningMethod": null,
            "ShipFromLocationId": 11199,
            "ShipFromAddress1": "Oracle Parkway",
            "ShipFromAddress2": "Thames Valley Park",
            "ShipFromAddress3": null,
            "ShipFromAddress4": null,
            "ShipFromCity": "Reading",
            "ShipFromCounty": "BER",
            "ShipFromPostalCode": "RG6 1RA",
            "ShipFromRegion": null,
            "ShipFromState": null,
            "ShipFromCountry": "GB",
            "MaximumOvershipmentPercentage": 0,
            "MaximumUndershipmentPercentage": 0,
            "SourceRequestedQuantity": 1,
            "SourceRequestedQuantityUOMCode": "Box",
            "SourceRequestedQuantityUOM": "Box",
            "SecondarySourceRequestedQuantity": null,
            "SecondarySourceRequestedQuantityUOMCode": null,
            "SecondarySourceRequestedQuantityUOM": null,
            "DeliveredQuantity": null,
            "SecondaryDeliveredQuantity": null,
            "CancelledQuantity": null,
            "SecondaryCancelledQuantity": null,
            "BackorderedQuantity": 0,
            "SecondaryBackorderedQuantity": null,
            "PickedQuantity": 1,
            "SecondaryPickedQuantity": null,
            "ConvertedQuantity": null,
            "SecondaryConvertedQuantity": null,
            "StagedQuantity": 0,
            "SecondaryStagedQuantity": 0,
            "PendingQuantity": 0,
            "PendingQuantityFlag": false,
            "CreationDate": "2002-11-15T00:00:00+00:00",
            "CreatedBy": "1001406",
            "LastUpdateDate": "2017-02-06T01:10:39+00:00",
            "LastUpdatedBy": "FUSION",
            "SplitFromShipmentLine": null,
            "SourceSubinventory": "Stores",
            "CarrierId": null,
            "Carrier": null,
            "CarrierNumber": null,
            "ModeOfTransportCode": null,
            "ModeOfTransport": null,
            "ServiceLevelCode": null,
            "ServiceLevel": null,
            "ShippingMethodCode": null,
            "ShippingMethod": null,
            "SourceDocumentTypeId": 2,
            "UnitWeight": null,
            "UnitVolume": null,
            "LogisticsServiceProviderCustomerId": null,
            "LogisticsServiceProviderCustomer": null,
            "LogisticsServiceProviderCustomerNumber": null,
            "SourceLineUpdateDate": null,
            "SourceSystemId": null,
            "SourceSystem": null,
            "ShipmentAdviceStatusFlag": null,
            "DoNotShipBeforeDate": null,
            "DoNotShipAfterDate": null,
            "IntegrationStatusCode": null,
            "IntegrationStatus": null,
            "QuickShipStatus": null,
            "BusinessUnitId": 1668,
            "BusinessUnit": null,
            "LegalEntityId": 1668,
            "LegalEntity": "Progress UK",
            "POHeaderId": null,
            "PONumber": null,
            "POBillToBusinessUnitId": null,
            "POBillToBusinessUnit": null,
            "POSoldToLegalEntityId": null,
            "POSoldToLegalEntity": null,
            "ConversionTypeCode": null,
            "ConversionDate": null,
            "ConversionRate": null,
            "ParentItemId": null,
            "ParentItem": null,
            "ParentItemDescription": null,
            "ParentSourceOrderFulfillmentLineId": null,
            "BaseItemId": null,
            "BaseItem": null,
            "BaseItemDescription": 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,
            "SrcAttributeDate1": null,
            "SrcAttributeDate2": null,
            "SrcAttributeDate3": null,
            "SrcAttributeDate4": null,
            "SrcAttributeDate5": null,
            "SrcAttributeNumber1": null,
            "SrcAttributeNumber2": null,
            "SrcAttributeNumber3": null,
            "SrcAttributeNumber4": null,
            "SrcAttributeNumber5": null,
            "SrcAttributeNumber6": null,
            "SrcAttributeNumber7": null,
            "SrcAttributeNumber8": null,
            "SrcAttributeNumber9": null,
            "SrcAttributeNumber10": null,
            "SrcAttributeTimestamp1": null,
            "SrcAttributeTimestamp2": null,
            "SrcAttributeTimestamp3": null,
            "SrcAttributeTimestamp4": null,
            "SrcAttributeTimestamp5": null,
            "TransportationShipmentFromEvent": null,
            "TransportationShipmentLineFromEvent": null,
            "TransportationShipmentCompleteFromEvent": null,
            "TradeComplianceScreenedFromEvent": null,
            "CurrentBackorderedQuantityFromEvent": null,
            "OriginalShipmentLineFromEvent": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/shipmentLines/169003",
                    "name": "shipmentLines",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/shipmentLines/169003",
                    "name": "shipmentLines",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/shipmentLines/169003/child/lotStandardDFF",
                    "name": "lotStandardDFF",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/shipmentLines/169003/child/lotAttributeDFF",
                    "name": "lotAttributeDFF",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/shipmentLines/169003/child/lineDFF",
                    "name": "lineDFF",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/shipmentLines/169003/child/attachments",
                    "name": "attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/shipmentLines/169003/child/serials",
                    "name": "serials",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/shipmentLines/169003/child/notes",
                    "name": "notes",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/shipmentLines/169003/child/costs",
                    "name": "costs",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/shipmentLines/169003/child/reservations",
                    "name": "reservations",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/shipmentLines",
            "name": "shipmentLines",
            "kind": "collection"
        }
    ]
}
Back to Top