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

Get all shipments

get

/fscmRestApi/resources/11.13.18.05/shipments

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 shipments according to the unique identifier.
      Finder Variables:
      • DeliveryId; integer; Value that uniquely identifies the shipment.
    • findByFulfillmentLineId: Finds shipments according to the fulfillment line.
      Finder Variables:
      • SourceOrderFulfillmentLineId; string; Value that uniquely identifies the fulfillment line for the source order.
      • SourceSystemId; string; Value that uniquely identifies the source application.
    • findByLineAttributes: Finds shipments according to attributes.
      Finder Variables:
      • BaseItem; string; Name of the model to use for an assemble-to-order configured item.
      • EndAssemblyItemNumber; string; Number that identifies the finished, assembled item to build, using the item shipped on this shipment line.
      • IntegrationStatus; string; Value that determines 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.
      • Item; string; Value that uniquely identifies the inventory item.
      • LineStatus; string; Value that determines the status of the shipment line. Values include ready to release, released, staged, shipped, or backordered. A list of accepted values is defined in the lookup type WSH_PICK_STATUS.
      • OrderNumber; string; Sale order number.
      • OrderType; string; Order type.
      • OrderTypeCode; string; Abbreviation that identifies the order type.
      • ParentPackingUnit; string; Parent packing unit that contains the item that the shipment line references.
      • PickWave; string; Name of the group of sales orders that the application released into picking.
      • QuickShipStatus; string; Value that determines the status of the quick ship for the shipment line.
      • RcvShipmentLineId; integer; Value that uniquely identifies a line on the advanced shipment notice (ASN) in receiving for the shipment line that the supplier supplies.
      • ShipToCustomer; string; Ship-to customer.
      • ShipToPartyId; string; Value that uniquely identifies the ship-to customer.
      • ShipmentSet; string; Name of the shipset that contains the order line.
      • 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.
      • SourceOrderLine; string; Number that identifies the source order line in the source order header.
      • TradeComplianceStatus; string; Value that determines the status of trade compliance screening for the shipment line.
      • TransportationPlanningStatus; string; Value that determines the status of the transportation planning of the shipment line.
    • findByShipmentName: Finds shipments according to shipment name.
      Finder Variables:
      • Shipment; string; Value that uniquely identifies the shipment.
  • 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:
    • ASNDateSent; string; Date when the application sent the advanced shipment notice.
    • ActualShipDate; string; Date when the shipment shipped.
    • ActualShipDateTime; string; Date and time when the shipment was shipped.
    • BillOfLading; string; Receipt that the carrier gives to the shipper. This receipt acknowledges receipt of the shipped goods and specifies the shipment terms.
    • CODAmount; number; Collect on delivery amount.
    • CODCurrencyCode; string; Abbreviation that identifies the currency to use when collecting the delivery amount.
    • CODPaidBy; string; Person or party who paid the collect on delivery amount.
    • CODRemitTo; string; Person or party to reference when remitting the collect on delivery amount.
    • Carrier; string; Name of the party that transports the shipment.
    • CarrierId; integer; Value that uniquely identifies the freight carrier.
    • CarrierNumber; string; Number that identifies the carrier.
    • CommercialInvoice; string; Number that identifies the customs document that includes the contents of the shipment.
    • ConfirmedBy; string; Person or user who confirmed the shipment.
    • ConfirmedDate; string; Date and time when the person or user confirmed the shipment.
    • DeliveryId; integer; Value that uniquely identifies the shipment.
    • DockCode; string; Abbreviation that identifies the place of loading for the shipment.
    • Equipment; string; Registration number of vehicle or equipment that transports the shipment.
    • EquipmentType; string; Type of vehicle or equipment that transports the shipment.
    • ExternalSystemTransactionReference; string; Value that contains reference information for the corresponding transaction in external applications.
    • FOB; string; Value that indicates the ownership of the items that are in transit. A list of accepted values is defined in the lookup type FOB.
    • FOBAddress1; string; First line of the free on board address.
    • FOBAddress2; string; Second line of the free on board address.
    • FOBAddress3; string; Third line of the free on board address.
    • FOBAddress4; string; Fourth line of the free on board address.
    • FOBCity; string; Free on board city.
    • FOBCode; string; Abbreviation that identifies ownership of the items that are in transit.
    • FOBCountry; string; Free on board country.
    • FOBCounty; string; Free on board county.
    • FOBLocationId; integer; Value that uniquely identifies the free on board location.
    • FOBPostalCode; string; Abbreviation that identifies the postal code, such as a zip code, for free on board.
    • FOBRegion; string; Free on board region.
    • FOBState; string; Free on board state.
    • 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.
    • GrossWeight; number; Gross weight of the shipment.
    • GroupingCriteriaHashString; string; String that contains the value of the shipment grouping attributes of a shipment.
    • GroupingCriteriaHashValue; number; Value that uniquely identifies the string that contains the value of the shipment grouping attributes of a shipment.
    • InitialPickupDate; string; Date when the warehouse plans to ship the shipment.
    • LoadingSequenceRule; number; Rule to apply on shipment lines for loading into the truck. A list of accepted values is defined in the lookup type WSH_LINES_LOADING_ORDER.
    • ModeOfTransport; string; Mode of transportation that ships goods. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT.
    • ModeOfTransportCode; string; Abbreviation that identifies the mode of transport for the shipping method.
    • NetWeight; number; Net weight of the shipment.
    • OrderTypeCode; string; Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type 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.
    • PackingSlipNumber; string; Document that itemizes and describes the contents of the shipment.
    • PlannedFlag; boolean; Contains one of the following values: true or false. If true, then the contents of the shipment are planned. If false, then the contents of the shipment are not planned. The default value is false.
    • ProblemContactReference; string; Person to contact if a problem occurs during shipment.
    • RcvShipmentHeaderId; integer; Value that uniquely identifies the supplier advanced shipment notice in receiving.
    • RcvShipmentNumber; string; Number that identifies the advanced shipment notice from the supplier.
    • SealNumber; string; Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport.
    • ServiceLevel; string; Transportation priority that determines how quickly to transport goods. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS.
    • ServiceLevelCode; string; Abbreviation that identifies the service level for the shipping method.
    • ShipToCustomer; string; Name of the ship-to party.
    • ShipToCustomerNumber; string; Number that identifies the ship-to party.
    • ShipToPartyId; integer; Value that uniquely identifies the ship-to party.
    • Shipment; string; Name of the material shipment.
    • ShipmentDescription; string; Description of the shipment.
    • ShipmentStatus; string; State or condition of the shipment. A list of accepted values is defined in the lookup type WSH_DELIVERY_STATUS.
    • ShipmentStatusCode; string; Abbreviation that identifies the state or condition of the shipment. A list of accepted values is defined in the lookup type WSH_DELIVERY_STATUS.
    • SoldToCustomer; string; Name of the sold-to party.
    • SoldToCustomerNumber; string; Number that identifies the sold-to party.
    • SoldToPartyId; integer; Value that uniquely identifies the sold-to party.
    • SourceSystem; string; Name of the source application.
    • SourceSystemId; integer; Value that uniquely identifies the source application.
    • Supplier; string; Name of the supplier.
    • SupplierPartyNumber; string; Number that identifies the supplier party.
    • TradeComplianceScreenedFromEvent; string; Value that indicates if the shipment line was screened for trade compliance when publishing shipment advice.
    • TransportationShipment; string; Identifies the planned shipment. The transportation management application provides this value.
    • TransportationShipmentCompleteFromEvent; string; Value that indicates if the transportation shipment is completed when publishing shipment advice.
    • TransportationShipmentFromEvent; string; Value that identifies the planned shipment from the transportation management application when publishing shipment advice.
    • UltimateDropoffDate; string; Date shipping expects the shipment to arrive at the customer location.
    • Volume; number; Volume of a shipment.
    • VolumeUOM; string; Unit of measure for volume of the shipment.
    • VolumeUOMCode; string; Abbreviation that identifies the unit of measure for volume.
    • Waybill; string; Nonnegotiable document that describes the contract for transporting cargo.
    • WeightUOM; string; Unit of measure for the weight.
    • WeightUOMCode; string; Abbreviation that identifies the unit of measure 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 : shipments
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : shipments-item-response
Type: object
Show Source
Nested Schema : Attachments for Shipments
Type: array
Title: Attachments for Shipments
The Attachments for Shipments resource manages details about shipment attachments.
Show Source
Nested Schema : Global Flexfields for Shipments
Type: array
Title: Global Flexfields for Shipments
The Global Flexfields for Shipments resource manages details about shipments.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "WshITPackingSlip":"#/components/schemas/oracle_apps_publicFlex_scm_shipping_shipConfirm_deliveries_view_ShipmentGdfWshITPackingSlipVO-item-response", "WshPTShipmentInfo":"#/components/schemas/oracle_apps_publicFlex_scm_shipping_shipConfirm_deliveries_view_ShipmentGdfWshPTShipmentInfoVO-item-response" } }
Nested Schema : Outer Packing Units
Type: array
Title: Outer Packing Units
The Outer Packing Units resource manages details about the outer packing units of a shipment.
Show Source
Nested Schema : Shipment Routing Instructions
Type: array
Title: Shipment Routing Instructions
The Shipment Routing Instructions resource manages details about the shipping route to use for the shipment.
Show Source
Nested Schema : Flexfields for Shipments
Type: array
Title: Flexfields for Shipments
The Flexfields for Shipments resource manages details about shipments.
Show Source
Nested Schema : Shipment Shipping Marks
Type: array
Title: Shipment Shipping Marks
The Shipment Shipping Marks resource manages details that describe how to move the package without delay or confusion to the final destination, and to allow personnel to verify cargo against documents.
Show Source
Nested Schema : Shipping Costs
Type: array
Title: Shipping Costs
The Shipping Costs resource manages details about the shipping costs for the shipment.
Show Source
Nested Schema : Unpacked Shipment Lines
Type: array
Title: Unpacked Shipment Lines
The Unpacked Shipment Lines resource manages details about unpacked shipment lines.
Show Source
Nested Schema : shipments-attachments-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_publicFlex_scm_shipping_shipConfirm_deliveries_view_ShipmentGdfWshITPackingSlipVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_publicFlex_scm_shipping_shipConfirm_deliveries_view_ShipmentGdfWshPTShipmentInfoVO-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-item-response
Type: object
Show Source
Nested Schema : Attachments for Packing Units
Type: array
Title: Attachments for Packing Units
The Attachments for Packing Units resource manages details about packing unit attachments.
Show Source
Nested Schema : Inner Packing Units
Type: array
Title: Inner Packing Units
The Inner Packing Units resource manages details about the packing unit that's packed in an outer packing unit.
Show Source
Nested Schema : Packing Unit Costs
Type: array
Title: Packing Unit Costs
The Packing Unit Costs resource manages details about the shipping costs for a packing unit.
Show Source
Nested Schema : Packing Instructions for Packing Units
Type: array
Title: Packing Instructions for Packing Units
The Packing Instructions for Packing Units resource manages details about how to pack a packing unit.
Show Source
Nested Schema : Flexfields for Packing Units
Type: array
Title: Flexfields for Packing Units
The Flexfields for Packing Units resource manages details about packing units.
Show Source
Nested Schema : Shipping Instructions for Packing Units
Type: array
Title: Shipping Instructions for Packing Units
The Shipping Instructions for Packing Units resource manages details about how to ship a packing unit.
Show Source
Nested Schema : Shipment Lines
Type: array
Title: Shipment Lines
The Shipment Lines resource manages details about the packed shipment lines.
Show Source
Nested Schema : shipments-outerPackingUnits-attachments-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-innerPackingUnits-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-packingUnitCosts-item-response
Type: object
Show Source
Nested Schema : Flexfields for Shipping Costs in Packing Units
Type: array
Title: Flexfields for Shipping Costs in Packing Units
The Flexfields for Shipping Costs in Packing Units resource manages details about shipping costs.
Show Source
Nested Schema : shipments-outerPackingUnits-packingUnitCosts-shippingCostsDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-packingUnitPackingInstructions-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-packingUnitsDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-packingUnitShippingInstructions-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-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 : 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 : Packing Instructions for Shipment Lines
Type: array
Title: Packing Instructions for Shipment Lines
The Packing Instructions for Shipment Lines resource manages details about how to pack an item.
Show Source
Nested Schema : Shipping Instructions for Shipment Lines
Type: array
Title: Shipping Instructions for Shipment Lines
The Shipping Instructions for Shipment Lines resource manages details about how to ship items.
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 for the shipment lines.
Show Source
Nested Schema : Flexfields for Lots
Type: array
Title: Flexfields for Lots
The Flexfields for Lots resource manages details about lots for shipment lines.
Show Source
Nested Schema : Prorated Costs for Shipment Lines
Type: array
Title: Prorated Costs for Shipment Lines
The Prorated Costs for Shipment Lines resource manages details about prorated costs for shipment lines.
Show Source
Nested Schema : Shipment Line Costs
Type: array
Title: Shipment Line Costs
The Shipment Line Costs resource manages details about the shipping costs for an item.
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 : 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 : shipments-outerPackingUnits-shipmentLines-attachments-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-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 : shipments-outerPackingUnits-shipmentLines-linePackingInstructions-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-lineShippingInstructions-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-lotAttributeDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-lotStandardDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-proratedCosts-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineCosts-item-response
Type: object
Show Source
Nested Schema : Flexfields for Shipment Line Costs
Type: array
Title: Flexfields for Shipment Line Costs
The Flexfields for Shipment Line Costs resource manages details about shipment line costs.
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineCosts-shippingCostsDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLinesDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-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 the 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. This attribute is used 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 for the shipment lines.
  • 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. This attribute is used 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 has 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 the serial numbers.
Show Source
Nested Schema : Serial Numbers
Type: array
Title: Serial Numbers
The Serial Numbers resource manages details about individual serial numbers for the shipment lines.
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 : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-attributeDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-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 the 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 : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-serialNumbers-attributeDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-serialNumbers-standardDFF-item-response
Type: object
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-standardDFF-item-response
Type: object
Show Source
Nested Schema : shipments-shipmentRoutingInstructions-item-response
Type: object
Show Source
Nested Schema : shipments-shipmentsDFF-item-response
Type: object
Show Source
Nested Schema : shipments-shipmentShippingMarks-item-response
Type: object
Show Source
  • Links
  • Read Only: true
    Value that identifies the shipping marks that display on each package. These marks help to move the package without delay or confusion to the final destination, and to allow personnel to verify cargo against documents.
  • Read Only: true
    Shipping marks that display on each package. These marks help to move the package without delay or confusion to the final destination, and to allow personnel to verify cargo against documents.
Nested Schema : shipments-shippingCosts-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 the shipping costs.
Show Source
Nested Schema : shipments-shippingCosts-shippingCostsDFF-item-response
Type: object
Show Source
Nested Schema : shipments-unpackedShipmentLines-item-response
Type: object
Show Source
Nested Schema : Attachments for Unpacked Shipment Lines
Type: array
Title: Attachments for Unpacked Shipment Lines
The Attachments for Unpacked Shipment Lines resource manages details about unpacked shipment line attachments.
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 : Packing Instructions for Unpacked Shipment Lines
Type: array
Title: Packing Instructions for Unpacked Shipment Lines
The Packing Instructions for Unpacked Shipment Lines resource manages details about how to pack an item in an unpacked shipment line.
Show Source
Nested Schema : Shipping Instructions for Unpacked Shipment Lines
Type: array
Title: Shipping Instructions for Unpacked Shipment Lines
The Shipping Instructions for Unpacked Shipment Lines resource manages details about how to ship items in unpacked 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 for the unpacked shipment lines.
Show Source
Nested Schema : Flexfields for Lots
Type: array
Title: Flexfields for Lots
The Flexfields for Lots resource manages details about lots for unpacked shipment lines.
Show Source
Nested Schema : Prorated Costs for Unpacked Shipment Lines
Type: array
Title: Prorated Costs for Unpacked Shipment Lines
The Prorated Costs for Unpacked Shipment Lines resource manages details about prorated costs for unpacked shipment lines.
Show Source
Nested Schema : Shipment Line Costs for Unpacked Shipment Lines
Type: array
Title: Shipment Line Costs for Unpacked Shipment Lines
The Shipment Line Costs for Unpacked Shipment Lines resource manages details about the shipping costs for an item in unpacked shipment lines.
Show Source
Nested Schema : Flexfields for Unpacked Shipment Lines
Type: array
Title: Flexfields for Unpacked Shipment Lines
The Flexfields for Unpacked Shipment Lines resource manages details about unpacked shipment lines.
Show Source
Nested Schema : Serials for Unpacked Shipment Lines
Type: array
Title: Serials for Unpacked Shipment Lines
The Serials for Unpacked Shipment Lines resource manages details about serial numbers for items in unpacked shipment lines.
Show Source
Nested Schema : shipments-unpackedShipmentLines-attachments-item-response
Type: object
Show Source
Nested Schema : shipments-unpackedShipmentLines-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 : shipments-unpackedShipmentLines-linePackingInstructions-item-response
Type: object
Show Source
Nested Schema : shipments-unpackedShipmentLines-lineShippingInstructions-item-response
Type: object
Show Source
Nested Schema : shipments-unpackedShipmentLines-lotAttributeDFF-item-response
Type: object
Show Source
Nested Schema : shipments-unpackedShipmentLines-lotStandardDFF-item-response
Type: object
Show Source
Nested Schema : shipments-unpackedShipmentLines-proratedCosts-item-response
Type: object
Show Source
Nested Schema : shipments-unpackedShipmentLines-shipmentLineCosts-item-response
Type: object
Show Source
Nested Schema : Flexfields for Shipment Line Costs
Type: array
Title: Flexfields for Shipment Line Costs
The Flexfields for Shipment Line Costs resource manages details about shipment line costs.
Show Source
Nested Schema : shipments-unpackedShipmentLines-shipmentLineCosts-shippingCostsDFF-item-response
Type: object
Show Source
Nested Schema : shipments-unpackedShipmentLines-shipmentLinesDFF-item-response
Type: object
Show Source
Nested Schema : shipments-unpackedShipmentLines-shipmentLineSerials-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 the 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. This attribute is used 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 for the shipment lines.
  • 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. This attribute is used 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 has 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 the serial numbers.
Show Source
Nested Schema : Serial Numbers
Type: array
Title: Serial Numbers
The Serial Numbers resource manages details about individual serial numbers for the shipment lines.
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 : shipments-unpackedShipmentLines-shipmentLineSerials-attributeDFF-item-response
Type: object
Show Source
Nested Schema : shipments-unpackedShipmentLines-shipmentLineSerials-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 the 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 : shipments-unpackedShipmentLines-shipmentLineSerials-serialNumbers-attributeDFF-item-response
Type: object
Show Source
Nested Schema : shipments-unpackedShipmentLines-shipmentLineSerials-serialNumbers-standardDFF-item-response
Type: object
Show Source
Nested Schema : shipments-unpackedShipmentLines-shipmentLineSerials-standardDFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all shipments.

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/shipments"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "items": [
    {
      "Shipment": "DEL-126001",
      "DeliveryId": 2503798,
      "ShipmentDescription": "Delivery Interface Testing",
      "InitialPickupDate": "2016-08-02",
      "BillOfLading": "BILL- 126001",
      "GrossWeight": 100,
      "NetWeight": 50,
      "WeightUOMCode": "Lbs",
      "WeightUOM": "Pounds",
      "Equipment": "veh-123456",
      "EquipmentType": "PLCARGO",
      "SealNumber": "222",
      "Volume": 150,
      "VolumeUOMCode": "FT3",
      "VolumeUOM": "Cubic foot",
      "CarrierId": 12519,
      "Carrier": "Airborne",
      "ServiceLevelCode": "2DA",
      "ServiceLevel": "2nd day air",
      "ModeOfTransportCode": "PARCEL",
      "ModeOfTransport": "Parcel",
      "Waybill": "Waybill",
      "PackingSlipNumber": "PACK- 126001",
      "ActualShipDate": "2016-08-02",
      "UltimateDropoffDate": "2016-08-02",
      "FreightTermsCode": "ADD",
      "FreightTerms": "Add freight",
      "FOBCode": "DEST",
      "FOB": "DEST",
      "FOBLocationId": null,
      "FOBAddress1": null,
      "FOBAddress2": null,
      "FOBAddress3": null,
      "FOBAddress4": null,
      "FOBCity": null,
      "FOBCounty": null,
      "FOBPostalCode": null,
      "FOBRegion": null,
      "FOBState": null,
      "FOBCountry": null,
      "DockCode": "dock code",
      "CODAmount": 100,
      "CODPaidBy": "Oracle India Pvt Ltd",
      "CODCurrencyCode": "AED",
      "CODRemitTo": "Oracle",
      "ASNDateSent": "2016-08-02",
      "ConfirmedDate": "2016-08-02",
      "ConfirmedBy": "SHIPPING_MANAGER_V1_VISION_OPERATIONS",
      "LoadingSequenceRule": null,
      "ProblemContactReference": "Oracle",
      "OrganizationId": 204,
      "OrganizationCode": "V1",
      "OrganizationName": "Vision Operations",
      "links": [
        {
          "rel": "self",
          "href": "https://servername/fscmRestApi/resources/version/shipments/DEL-126001",
          "name": "shipments",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername/fscmRestApi/resources/version/shipments/DEL-126001",
          "name": "shipments",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/DEL-126001/child/shipmentsDFF",
          "name": "shipmentsDFF",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/DEL-126001/child/shipmentRoutingInstructions",
          "name": "shipmentRoutingInstructions",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/DEL-126001/child/outerPackingUnits",
          "name": "outerPackingUnits",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/DEL-126001/child/shippingCosts",
          "name": "shippingCosts",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/DEL-126001/child/unpackedShipmentLines",
          "name": "unpackedShipmentLines",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/DEL-126001/child/shipmentShippingMarks",
          "name": "shipmentShippingMarks",
          "kind": "collection"
         }
      ]
    },
    {
      "Shipment": "DEL-126002",
      "DeliveryId": 2503801,
      "ShipmentDescription": "Delivery Interface Testing",
      "InitialPickupDate": "2016-08-02",
      "BillOfLading": "BILL- 126002",
      "GrossWeight": 100,
      "NetWeight": 50,
      "WeightUOMCode": "Lbs",
      "WeightUOM": "Pounds",
      "Equipment": "veh-123456",
      "EquipmentType": "PLCARGO",
      "SealNumber": "222",
      "Volume": 150,
      "VolumeUOMCode": "FT3",
      "VolumeUOM": "Cubic foot",
      "CarrierId": 12519,
      "Carrier": "Airborne",
      "ServiceLevelCode": "2DA",
      "ServiceLevel": "2nd day air",
      "ModeOfTransportCode": "PARCEL",
      "ModeOfTransport": "Parcel",
      "Waybill": "Waybill",
      "PackingSlipNumber": "PACK- 126002",
      "ActualShipDate": "2016-08-02",
      "UltimateDropoffDate": "2016-08-02",
      "FreightTermsCode": "ADD",
      "FreightTerms": "Add freight",
      "FOBCode": "DEST",
      "FOB": "DEST",
      "FOBLocationId": null,
      "FOBAddress1": null,
      "FOBAddress2": null,
      "FOBAddress3": null,
      "FOBAddress4": null,
      "FOBCity": null,
      "FOBCounty": null,
      "FOBPostalCode": null,
      "FOBRegion": null,
      "FOBState": null,
      "FOBCountry": null,
      "DockCode": "dock code",
      "CODAmount": 100,
      "CODPaidBy": "Oracle India Pvt Ltd",
      "CODCurrencyCode": "AED",
      "CODRemitTo": "Oracle",
      "ASNDateSent": "2016-08-02",
      "ConfirmedDate": "2016-08-02",
      "ConfirmedBy": "SHIPPING_MANAGER_V1_VISION_OPERATIONS",
      "LoadingSequenceRule": null,
      "ProblemContactReference": "Oracle",
      "OrganizationId": 204,
      "OrganizationCode": "V1",
      "OrganizationName": "Vision Operations",
      "links": [
        {
          "rel": "self",
          "href": "https://servername/fscmRestApi/resources/version/shipments/DEL-126002",
          "name": "shipments",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername/fscmRestApi/resources/version/shipments/DEL-126002",
          "name": "shipments",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/DEL-126002/child/shipmentsDFF",
          "name": "shipmentsDFF",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/DEL-126002/child/shipmentRoutingInstructions",
          "name": "shipmentRoutingInstructions",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/DEL-126002/child/outerPackingUnits",
          "name": "outerPackingUnits",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/DEL-126002/child/shippingCosts",
          "name": "shippingCosts",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/DEL-126002/child/unpackedShipmentLines",
          "name": "unpackedShipmentLines",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/DEL-126002/child/shipmentShippingMarks",
          "name": "shipmentShippingMarks",
          "kind": "collection"
        }
      ]
    },
    {
"count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername/fscmRestApi/resources/version/shipments",
      "name": "shipments",
      "kind": "collection"
    }
  ]
}
Back to Top