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

Get one shipment

get

/fscmRestApi/resources/11.13.18.05/shipmentTransactionRequests/{TransactionId}/child/shipments/{DeliveryInterfaceId}

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 : shipmentTransactionRequests-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 : Costs for Shipments
Type: array
Title: Costs for Shipments
The Costs for Shipments resource manages details about the shipping costs for shipments.
Show Source
Nested Schema : Errors for Shipments
Type: array
Title: Errors for Shipments
The Errors for Shipments resource manages errors that occur when processing a shipment.
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_flex_scm_shipping_shipConfirm_deliveries_restModel_WshNewDelIntGdfDFF_view_WshNewDelIntGdfDFFWshITPackingSlipVO-item-response", "WshPTShipmentInfo":"#/components/schemas/oracle_apps_flex_scm_shipping_shipConfirm_deliveries_restModel_WshNewDelIntGdfDFF_view_WshNewDelIntGdfDFFWshPTShipmentInfoVO-item-response" } }
Nested Schema : Notes for Shipments
Type: array
Title: Notes for Shipments
The Notes for Shipments resource manages details about shipment notes, such as routing instructions and shipping marks.
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 : Flexfields for Shipments
Type: array
Title: Flexfields for Shipments
The Flexfields for Shipments resource manages details about shipments.
Show Source
Nested Schema : Unpacked Shipment Lines
Type: array
Title: Unpacked Shipment Lines
The Unpacked Shipment Lines resource manages details about the shipment lines that are not packed under a packing unit.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-attachments-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-costs-item-response
Type: object
Show Source
Nested Schema : Flexfields for Costs
Type: array
Title: Flexfields for Costs
The Flexfields for Costs resource manages details about shipping costs.
Show Source
Nested Schema : Errors for Costs
Type: array
Title: Errors for Costs
The Errors for Costs resource manages errors that occur when processing a shipping cost.
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 details about inventory striping attributes for shipping costs. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-costs-DFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-costs-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-costs-wshFreightCostsInvDFF-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.
  • Value that uniquely identifies the candidate shipping cost. 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 : shipmentTransactionRequests-shipments-errors-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_flex_scm_shipping_shipConfirm_deliveries_restModel_WshNewDelIntGdfDFF_view_WshNewDelIntGdfDFFWshITPackingSlipVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_shipping_shipConfirm_deliveries_restModel_WshNewDelIntGdfDFF_view_WshNewDelIntGdfDFFWshPTShipmentInfoVO-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-notes-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-item-response
Type: object
Show Source
Nested Schema : Attachments for Outer Packing Units
Type: array
Title: Attachments for Outer Packing Units
The Attachments for Outer Packing Units resource manages details about outer packing unit attachments.
Show Source
Nested Schema : Costs for Outer Packing Units
Type: array
Title: Costs for Outer Packing Units
The Costs for Outer Packing Units resource manages details about the shipping costs for outer packing units.
Show Source
Nested Schema : Flexfields for Costs
Type: array
Title: Flexfields for Costs
The Flexfields for Costs resource manages details about shipping costs.
Show Source
Nested Schema : Errors for Outer Packing Units
Type: array
Title: Errors for Outer Packing Units
The Errors for Outer Packing Units resource manages errors that occur when processing an outer packing unit.
Show Source
Nested Schema : Inner Packing Units
Type: array
Title: Inner Packing Units
The Inner Packing Units resource manages details about packing units that are packed within a packing unit.
Show Source
Nested Schema : Notes for Outer Packing Units
Type: array
Title: Notes for Outer Packing Units
The Notes for Outer Packing Units resource manages details about outer packing unit notes, such as packing instructions and shipping instructions.
Show Source
Nested Schema : Packed Shipment Lines
Type: array
Title: Packed Shipment Lines
The Packed Shipment Lines resource manages details about the shipment lines that are packed within a packing unit.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-attachments-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-costs-item-response
Type: object
Show Source
Nested Schema : Flexfields for Costs
Type: array
Title: Flexfields for Costs
The Flexfields for Costs resource manages details about shipping costs.
Show Source
Nested Schema : Errors for Costs
Type: array
Title: Errors for Costs
The Errors for Costs resource manages errors that occur when processing a shipping cost.
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 details about inventory striping attributes for shipping costs. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-costs-DFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-costs-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-costs-wshFreightCostsInvDFF-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.
  • Value that uniquely identifies the candidate shipping cost. 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 : shipmentTransactionRequests-shipments-outerPackingUnits-DFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-item-response
Type: object
Show Source
Nested Schema : Attachments for Inner Packing Units
Type: array
Title: Attachments for Inner Packing Units
The Attachments for Inner Packing Units resource manages details about inner packing unit attachments.
Show Source
Nested Schema : Costs for Inner Packing Units
Type: array
Title: Costs for Inner Packing Units
The Costs for Inner Packing Units resource manages details about the shipping costs for inner packing units.
Show Source
Nested Schema : Flexfields for Costs
Type: array
Title: Flexfields for Costs
The Flexfields for Costs resource manages details about shipping costs.
Show Source
Nested Schema : Errors
Type: array
Title: Errors
The Errors resource manages errors that occur when processing a transaction request.
Show Source
Nested Schema : Inner Packing Units
Type: array
Title: Inner Packing Units
The Inner Packing Units resource manages details about packing units that are packed within a packing unit.
Show Source
Nested Schema : Notes for Inner Packing Units
Type: array
Title: Notes for Inner Packing Units
The Notes for Inner Packing Units resource manages details about inner packing unit notes, such as packing instructions and shipping instructions.
Show Source
Nested Schema : Packed Shipment Lines
Type: array
Title: Packed Shipment Lines
The Packed Shipment Lines resource manages details about the shipment lines that are packed within a packing unit.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-attachments-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-costs-item-response
Type: object
Show Source
Nested Schema : Flexfields for Costs
Type: array
Title: Flexfields for Costs
The Flexfields for Costs resource manages details about shipping costs.
Show Source
Nested Schema : Errors for Costs
Type: array
Title: Errors for Costs
The Errors for Costs resource manages errors that occur when processing a shipping cost.
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 details about inventory striping attributes for shipping costs. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-costs-DFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-costs-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-costs-wshFreightCostsInvDFF-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.
  • Value that uniquely identifies the candidate shipping cost. 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 : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-DFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-innerPackingUnits-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-notes-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-item-response
Type: object
Show Source
Nested Schema : Attachments for Packed Shipment Lines
Type: array
Title: Attachments for Packed Shipment Lines
The Attachments for Packed Shipment Lines resource manages details about packed shipment line attachments.
Show Source
Nested Schema : Costs for Packed Shipment Lines
Type: array
Title: Costs for Packed Shipment Lines
The Costs for Packed Shipment Lines resource manages details about the shipping costs for packed shipment lines.
Show Source
Nested Schema : Flexfields for Packed Shipment Lines
Type: array
Title: Flexfields for Packed Shipment Lines
The Flexfields for Packed Shipment Lines resource manages details about packed shipment lines.
Show Source
Nested Schema : Errors for Packed Shipment Lines
Type: array
Title: Errors for Packed Shipment Lines
The Errors for Packed Shipment Lines resource manages errors that occur when processing a packed line.
Show Source
Nested Schema : Lots for Packed Shipment Lines
Type: array
Title: Lots for Packed Shipment Lines
The Lots for Packed Shipment Lines resource manages details about lot numbers for items under lot control in packed shipment lines.
Show Source
Nested Schema : Notes for Packed Shipment Lines
Type: array
Title: Notes for Packed Shipment Lines
The Notes for Packed Shipment Lines resource manages details about packed shipment line notes, such as packing instructions and shipping instructions.
Show Source
Nested Schema : Serials for Packed Shipment Lines
Type: array
Title: Serials for Packed Shipment Lines
The Serials for Packed Shipment Lines resource manages details about serial numbers for items under serial control in packed shipment lines.
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 for packed shipment lines. 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 : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-attachments-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-costs-item-response
Type: object
Show Source
Nested Schema : Flexfields for Costs
Type: array
Title: Flexfields for Costs
The Flexfields for Costs resource manages details about shipping costs.
Show Source
Nested Schema : Errors for Costs
Type: array
Title: Errors for Costs
The Errors for Costs resource manages errors that occur when processing a shipping cost.
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 details about inventory striping attributes for shipping costs. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-costs-DFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-costs-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-costs-wshFreightCostsInvDFF-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.
  • Value that uniquely identifies the candidate shipping cost. 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 : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-DFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-lots-item-response
Type: object
Show Source
Nested Schema : Errors for Lots
Type: array
Title: Errors for Lots
The Errors for Lots resource manages errors that occur when processing a lot.
Show Source
Nested Schema : Serials for Lots
Type: array
Title: Serials for Lots
The Serials for Lots resource manages details about serial numbers for items under both serial and lot control.
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 details about inventory striping attributes for lot controlled items. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-lots-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-lots-serials-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.
Show Source
Nested Schema : Errors for Serials
Type: array
Title: Errors for Serials
The Errors for Serials resource manages errors that occur when processing 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 : Flexfields for Inventory Striping Attributes
Type: array
Title: Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages details about inventory striping attributes for serial controlled items. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-lots-serials-attributeDFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-lots-serials-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-lots-serials-standardDFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-lots-serials-wshSerialInvDFF-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.
  • Maximum Length: 80
    Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. 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.
  • Value that uniquely identifies the interfaced shipment transaction. This attribute is associated with a feature that requires opt in.
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-lots-wshLotsInvDFF-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.
  • Links
  • Maximum Length: 80
    Number that identifies the lot for the item. This attribute is used when the warehouse places the item under lot control. This attribute is associated with a feature that requires opt in.
  • 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.
  • Value that uniquely identifies the interfaced shipment transaction. This attribute is associated with a feature that requires opt in.
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-notes-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-serials-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.
Show Source
Nested Schema : Errors for Serials
Type: array
Title: Errors for Serials
The Errors for Serials resource manages errors that occur when processing 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 : Flexfields for Inventory Striping Attributes
Type: array
Title: Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages details about inventory striping attributes for serial controlled items. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-serials-attributeDFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-serials-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-serials-standardDFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-serials-wshSerialInvDFF-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.
  • Maximum Length: 80
    Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. 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.
  • Value that uniquely identifies the interfaced shipment transaction. This attribute is associated with a feature that requires opt in.
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-wshInvStripingDFF-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.
  • Value that uniquely identifies the candidate 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 : shipmentTransactionRequests-shipments-outerPackingUnits-notes-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-item-response
Type: object
Show Source
Nested Schema : Attachments for Packed Shipment Lines
Type: array
Title: Attachments for Packed Shipment Lines
The Attachments for Packed Shipment Lines resource manages details about packed shipment line attachments.
Show Source
Nested Schema : Costs for Packed Shipment Lines
Type: array
Title: Costs for Packed Shipment Lines
The Costs for Packed Shipment Lines resource manages details about the shipping costs for packed shipment lines.
Show Source
Nested Schema : Flexfields for Packed Shipment Lines
Type: array
Title: Flexfields for Packed Shipment Lines
The Flexfields for Packed Shipment Lines resource manages details about packed shipment lines.
Show Source
Nested Schema : Errors for Packed Shipment Lines
Type: array
Title: Errors for Packed Shipment Lines
The Errors for Packed Shipment Lines resource manages errors that occur when processing a packed line.
Show Source
Nested Schema : Lots for Packed Shipment Lines
Type: array
Title: Lots for Packed Shipment Lines
The Lots for Packed Shipment Lines resource manages details about lot numbers for items under lot control in packed shipment lines.
Show Source
Nested Schema : Notes for Packed Shipment Lines
Type: array
Title: Notes for Packed Shipment Lines
The Notes for Packed Shipment Lines resource manages details about packed shipment line notes, such as packing instructions and shipping instructions.
Show Source
Nested Schema : Serials for Packed Shipment Lines
Type: array
Title: Serials for Packed Shipment Lines
The Serials for Packed Shipment Lines resource manages details about serial numbers for items under serial control in packed shipment lines.
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 for packed shipment lines. 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 : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-attachments-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-costs-item-response
Type: object
Show Source
Nested Schema : Flexfields for Costs
Type: array
Title: Flexfields for Costs
The Flexfields for Costs resource manages details about shipping costs.
Show Source
Nested Schema : Errors for Costs
Type: array
Title: Errors for Costs
The Errors for Costs resource manages errors that occur when processing a shipping cost.
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 details about inventory striping attributes for shipping costs. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-costs-DFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-costs-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-costs-wshFreightCostsInvDFF-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.
  • Value that uniquely identifies the candidate shipping cost. 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 : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-DFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-lots-item-response
Type: object
Show Source
Nested Schema : Errors for Lots
Type: array
Title: Errors for Lots
The Errors for Lots resource manages errors that occur when processing a lot.
Show Source
Nested Schema : Serials for Lots
Type: array
Title: Serials for Lots
The Serials for Lots resource manages details about serial numbers for items under both serial and lot control.
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 details about inventory striping attributes for lot controlled items. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-lots-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-lots-serials-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.
Show Source
Nested Schema : Errors for Serials
Type: array
Title: Errors for Serials
The Errors for Serials resource manages errors that occur when processing 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 : Flexfields for Inventory Striping Attributes
Type: array
Title: Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages details about inventory striping attributes for serial controlled items. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-lots-serials-attributeDFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-lots-serials-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-lots-serials-standardDFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-lots-serials-wshSerialInvDFF-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.
  • Maximum Length: 80
    Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. 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.
  • Value that uniquely identifies the interfaced shipment transaction. This attribute is associated with a feature that requires opt in.
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-lots-wshLotsInvDFF-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.
  • Links
  • Maximum Length: 80
    Number that identifies the lot for the item. This attribute is used when the warehouse places the item under lot control. This attribute is associated with a feature that requires opt in.
  • 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.
  • Value that uniquely identifies the interfaced shipment transaction. This attribute is associated with a feature that requires opt in.
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-notes-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-serials-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.
Show Source
Nested Schema : Errors for Serials
Type: array
Title: Errors for Serials
The Errors for Serials resource manages errors that occur when processing 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 : Flexfields for Inventory Striping Attributes
Type: array
Title: Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages details about inventory striping attributes for serial controlled items. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-serials-attributeDFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-serials-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-serials-standardDFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-serials-wshSerialInvDFF-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.
  • Maximum Length: 80
    Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. 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.
  • Value that uniquely identifies the interfaced shipment transaction. This attribute is associated with a feature that requires opt in.
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-packedLines-wshInvStripingDFF-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.
  • Value that uniquely identifies the candidate 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 : shipmentTransactionRequests-shipments-shipmentDFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-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 : Costs for Unpacked Shipment Lines
Type: array
Title: Costs for Unpacked Shipment Lines
The Costs for Unpacked Shipment Lines resource manages details about the shipping costs for 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 : Errors for Unpacked Shipment Lines
Type: array
Title: Errors for Unpacked Shipment Lines
The Errors for Unpacked Shipment Lines resource manages errors that occur when processing an unpacked shipment line.
Show Source
Nested Schema : Lots for Unpacked Shipment Lines
Type: array
Title: Lots for Unpacked Shipment Lines
The Lots for Unpacked Shipment Lines resource manages details about lot numbers for items under lot control in unpacked shipment lines.
Show Source
Nested Schema : Notes for Unpacked Shipment Lines
Type: array
Title: Notes for Unpacked Shipment Lines
The Notes for Unpacked Shipment Lines resource manages details about unpacked shipment line notes, such as packing instructions and shipping instructions.
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 under serial control in unpacked shipment lines.
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 for unpacked shipment lines. 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 : shipmentTransactionRequests-shipments-unpackedLines-attachments-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-costs-item-response
Type: object
Show Source
Nested Schema : Flexfields for Costs
Type: array
Title: Flexfields for Costs
The Flexfields for Costs resource manages details about shipping costs.
Show Source
Nested Schema : Errors for Costs
Type: array
Title: Errors for Costs
The Errors for Costs resource manages errors that occur when processing a shipping cost.
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 details about inventory striping attributes for shipping costs. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-costs-DFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-costs-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-costs-wshFreightCostsInvDFF-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.
  • Value that uniquely identifies the candidate shipping cost. 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 : shipmentTransactionRequests-shipments-unpackedLines-DFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-lots-item-response
Type: object
Show Source
Nested Schema : Errors for Lots
Type: array
Title: Errors for Lots
The Errors for Lots resource manages errors that occur when processing a lot.
Show Source
Nested Schema : Serials for Lots
Type: array
Title: Serials for Lots
The Serials for Lots resource manages details about serial numbers for items under both serial and lot control.
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 details about inventory striping attributes for lot controlled items. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-lots-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-lots-serials-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.
Show Source
Nested Schema : Errors for Serials
Type: array
Title: Errors for Serials
The Errors for Serials resource manages errors that occur when processing 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 : Flexfields for Inventory Striping Attributes
Type: array
Title: Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages details about inventory striping attributes for serial controlled items. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-lots-serials-attributeDFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-lots-serials-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-lots-serials-standardDFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-lots-serials-wshSerialInvDFF-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.
  • Maximum Length: 80
    Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. 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.
  • Value that uniquely identifies the interfaced shipment transaction. This attribute is associated with a feature that requires opt in.
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-lots-wshLotsInvDFF-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.
  • Links
  • Maximum Length: 80
    Number that identifies the lot for the item. This attribute is used when the warehouse places the item under lot control. This attribute is associated with a feature that requires opt in.
  • 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.
  • Value that uniquely identifies the interfaced shipment transaction. This attribute is associated with a feature that requires opt in.
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-notes-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-serials-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.
Show Source
Nested Schema : Errors for Serials
Type: array
Title: Errors for Serials
The Errors for Serials resource manages errors that occur when processing 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 : Flexfields for Inventory Striping Attributes
Type: array
Title: Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages details about inventory striping attributes for serial controlled items. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-serials-attributeDFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-serials-errors-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-serials-standardDFF-item-response
Type: object
Show Source
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-serials-wshSerialInvDFF-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.
  • Maximum Length: 80
    Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. 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.
  • Value that uniquely identifies the interfaced shipment transaction. This attribute is associated with a feature that requires opt in.
Nested Schema : shipmentTransactionRequests-shipments-unpackedLines-wshInvStripingDFF-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.
  • Value that uniquely identifies the candidate 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.
Links
attachments
Parameters:
  • DeliveryInterfaceId: $request.path.DeliveryInterfaceId
  • TransactionId: $request.path.TransactionId
The Attachments for Shipments resource manages details about shipment attachments.
costs
Parameters:
  • DeliveryInterfaceId: $request.path.DeliveryInterfaceId
  • TransactionId: $request.path.TransactionId
The Costs for Shipments resource manages details about the shipping costs for shipments.
errors
Parameters:
  • DeliveryInterfaceId: $request.path.DeliveryInterfaceId
  • TransactionId: $request.path.TransactionId
The Errors for Shipments resource manages errors that occur when processing a shipment.
globalDFF
Parameters:
  • DeliveryInterfaceId: $request.path.DeliveryInterfaceId
  • TransactionId: $request.path.TransactionId
The Global Flexfields for Shipments resource manages details about shipments.
notes
Parameters:
  • DeliveryInterfaceId: $request.path.DeliveryInterfaceId
  • TransactionId: $request.path.TransactionId
The Notes for Shipments resource manages details about shipment notes, such as routing instructions and shipping marks.
outerPackingUnits
Parameters:
  • DeliveryInterfaceId: $request.path.DeliveryInterfaceId
  • TransactionId: $request.path.TransactionId
The Outer Packing Units resource manages details about the outer packing units of a shipment.
shipmentDFF
Parameters:
  • DeliveryInterfaceId: $request.path.DeliveryInterfaceId
  • TransactionId: $request.path.TransactionId
The Flexfields for Shipments resource manages details about shipments.
unpackedLines
Parameters:
  • DeliveryInterfaceId: $request.path.DeliveryInterfaceId
  • TransactionId: $request.path.TransactionId
The Unpacked Shipment Lines resource manages details about the shipment lines that are not packed under a packing unit.
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:

curl -u username:password "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/TransactionId/child/shipments/DeliveryInterfaceId"

For example, the following command gets one shipment:

curl -u username:password "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688173/child/shipments/300100169688174"

Example Response Body

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

{
    "DeliveryInterfaceId": 300100169688174,
    "Shipment": "SHP-11062018",
    "Description": "Edited description",
    "ShipFromOrganizationCode": "M1",
    "InitialShipDate": null,
    "BillOfLading": null,
    "GrossWeight": 1000,
    "NetWeight": 500,
    "WeightUOM": "Pounds",
    "Volume": 2000,
    "VolumeUOM": "Cubic foot",
    "Equipment": null,
    "EquipmentType": null,
    "SealNumber": null,
    "Carrier": "DHL",
    "ModeOfTransportCode": "AIR",
    "ServiceLevelCode": "2DA",
    "Waybill": null,
    "PackingSlip": null,
    "ActualShipDate": null,
    "PlannedDeliveryDate": null,
    "FreightTermsCode": null,
    "FOBCode": null,
    "FOBAddress1": null,
    "FOBAddress2": null,
    "FOBAddress3": null,
    "FOBAddress4": null,
    "FOBCity": null,
    "FOBCounty": null,
    "FOBPostalCode": null,
    "FOBRegion": null,
    "FOBState": null,
    "FOBCountry": null,
    "Dock": null,
    "CODAmount": null,
    "CODCurrency": null,
    "CODPaidBy": null,
    "CODRemitTo": null,
    "ASNSentDate": null,
    "ConfirmedDate": null,
    "ConfirmedBy": null,
    "LoadingSequenceRule": null,
    "ProblemContactReference": null,
    "TransportationReasonCode": null,
    "CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
    "CreationDate": "2018-11-07T00:06:33.024+00:00",
    "LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
    "LastUpdateDate": "2018-11-07T00:11:56+00:00"
}
Back to Top