1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Inventory Management
  4. Shipments

Get one shipment

get

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

Request

Path Parameters
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 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
Links
attachments
Parameters:
  • Shipment: $request.path.Shipment
The Attachments for Shipments resource manages details about shipment attachments.
globalDFF
Parameters:
  • Shipment: $request.path.Shipment
The Global Flexfields for Shipments resource manages details about shipments.
outerPackingUnits
Parameters:
  • Shipment: $request.path.Shipment
The Outer Packing Units resource manages details about the outer packing units of a shipment.
shipmentRoutingInstructions
Parameters:
  • Shipment: $request.path.Shipment
The Shipment Routing Instructions resource manages details about the shipping route to use for the shipment.
shipmentShippingMarks
Parameters:
  • Shipment: $request.path.Shipment
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.
shipmentsDFF
Parameters:
  • Shipment: $request.path.Shipment
The Flexfields for Shipments resource manages details about shipments.
shippingCosts
Parameters:
  • Shipment: $request.path.Shipment
The Shipping Costs resource manages details about the shipping costs for the shipment.
unpackedShipmentLines
Parameters:
  • Shipment: $request.path.Shipment
The Unpacked Shipment Lines resource manages details about unpacked shipment lines.
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