Get one shipment

get

/fscmRestApi/resources/11.13.18.05/shipments/{Shipment}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : globalDFF
Type: array
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 : shipmentsDFF
Type: array
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 : Costs for Shipment Lines
Type: array
Title: Costs for Shipment Lines
The Packing Unit Costs resource manages details about the shipping costs for 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-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
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
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 : Costs for Shipment Lines
Type: array
Title: Costs for Shipment Lines
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 : packingUnitsDFF
Type: array
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 : shipmentPackingUnitDFFs
Type: array
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 : shippingCostsDFF
Type: array
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
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : inventoryStripingDFF
Type: array
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 : 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 : lotAttributeDFF
Type: array
Show Source
Nested Schema : lotStandardDFF
Type: array
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 : Costs for Shipment Lines
Type: array
Title: Costs for Shipment Lines
The Packing Unit Costs resource manages details about the shipping costs for a packing unit.
Show Source
Nested Schema : shipmentLinesDFF
Type: array
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
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 : shippingCostsDFF
Type: array
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
Nested Schema : attributeDFF
Type: array
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 : standardDFF
Type: array
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 : attributeDFF
Type: array
Show Source
Nested Schema : standardDFF
Type: array
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-outerPackingUnits-shipmentPackingUnitDFFs-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 : shippingCostsDFF
Type: array
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
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : inventoryStripingDFF
Type: array
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 : 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 : lotAttributeDFF
Type: array
Show Source
Nested Schema : lotStandardDFF
Type: array
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 : Costs for Shipment Lines
Type: array
Title: Costs for Shipment Lines
The Packing Unit Costs resource manages details about the shipping costs for a packing unit.
Show Source
Nested Schema : shipmentLinesDFF
Type: array
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-unpackedShipmentLines-attachments-item-response
Type: object
Show Source
Nested Schema : shipments-unpackedShipmentLines-inventoryStripingDFF-item-response
Type: object
Show Source
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 : shippingCostsDFF
Type: array
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
Nested Schema : attributeDFF
Type: array
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 : standardDFF
Type: array
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 : attributeDFF
Type: array
Show Source
Nested Schema : standardDFF
Type: array
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 one shipment.

Example cURL Command

Use the following cURL command to submit a request on the REST resource. This example gets details for shipment 2238047:

curl -u username:password "https://servername/fscmRestApi/resources/version/shipments?q=Shipment=2238047"

Example Response Body

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

{
  "items": [
    {
      "Shipment": "2238047",
      "DeliveryId": 2238047,
      "ShipmentDescription": null,
      "InitialPickupDate": "2009-10-06",
      "BillOfLading": "972559",
      "GrossWeight": 151,
      "NetWeight": 150,
      "WeightUOMCode": "Lbs",
      "WeightUOM": "Pounds",
      "Equipment": null,
      "EquipmentType": null,
      "SealNumber": null,
      "Volume": 10,
      "VolumeUOMCode": "FT3",
      "VolumeUOM": "Cubic foot",
      "CarrierId": null,
      "Carrier": null,
      "ServiceLevelCode": null,
      "ServiceLevel": null,
      "ModeOfTransportCode": null,
      "ModeOfTransport": null,
      "Waybill": null,
      "PackingSlipNumber": null,
      "ActualShipDate": null,
      "UltimateDropoffDate": "2009-10-06",
      "FreightTermsCode": null,
      "FreightTerms": null,
      "FOBCode": null,
      "FOB": null,
      "FOBLocationId": null,
      "FOBAddress1": null,
      "FOBAddress2": null,
      "FOBAddress3": null,
      "FOBAddress4": null,
      "FOBCity": null,
      "FOBCounty": null,
      "FOBPostalCode": null,
      "FOBRegion": null,
      "FOBState": null,
      "FOBCountry": null,
      "DockCode": null,
      "CODAmount": null,
      "CODPaidBy": null,
      "CODCurrencyCode": null,
      "CODRemitTo": null,
      "ASNDateSent": null,
      "ConfirmedDate": null,
      "ConfirmedBy": null,
      "LoadingSequenceRule": null,
      "ProblemContactReference": null,
      "OrganizationId": 204,
      "OrganizationCode": "V1",
      "OrganizationName": "Vision Operations",
      "links": [
        {
          "rel": "self",
          "href": "https://servername/fscmRestApi/resources/version/shipments/2238047",
          "name": "shipments",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername/fscmRestApi/resources/version/shipments/2238047",
          "name": "shipments",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/2238047/child/shipmentsDFF",
          "name": "shipmentsDFF",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/2238047/child/shipmentRoutingInstructions",
          "name": "shipmentRoutingInstructions",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/2238047/child/outerPackingUnits",
          "name": "outerPackingUnits",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/2238047/child/shippingCosts",
          "name": "shippingCosts",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/2238047/child/unpackedShipmentLines",
          "name": "unpackedShipmentLines",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/fscmRestApi/resources/version/shipments/2238047/child/shipmentShippingMarks",
          "name": "shipmentShippingMarks",
          "kind": "collection"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername/fscmRestApi/resources/version/shipments",
      "name": "shipments",
      "kind": "collection"
    }
  ]
}
Back to Top