Update one inbound shipment
patch
/fscmRestApi/resources/11.13.18.05/inboundShipments/{inboundShipmentsUniqID}
Request
Path Parameters
-
inboundShipmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Inbound Shipments resource and used to uniquely identify an instance of Inbound Shipments. The client should not generate the hash key value. Instead, the client should query on the Inbound Shipments collection resource in order to navigate to a specific instance of Inbound Shipments to get the hash key.
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BillOfLading: string
Maximum Length:
25
Receipt that a carrier issues to the shipper as a contract for carriage of goods. This receipt acknowledges that the cargo is accepted for transportation and must be presented for taking delivery at the destination. -
Carrier: string
Maximum Length:
360
Name of the company that transports goods from one point to another by land, sea, or air. -
Comments: string
Maximum Length:
4000
Comments or notes entered in the inbound shipment header. -
ExpectedReceiptDate: string
(date-time)
Date when the inbound shipment is expected to arrive at the receiving organizations.
-
FreightCarrierId: integer
(int64)
Value that uniquely identifies the freight carrier.
-
FreightTerms: string
Maximum Length:
80
Agreement that describes whether the buyer or seller pays the shipping cost of the sales order, and when payment is due. -
FreightTermsCode: string
Maximum Length:
25
Abbreviation that identifies the freight terms. -
NetWeight: number
Weight of the products being shipped without considering the packaging.
-
NetWeightUOM: string
Maximum Length:
25
Unit of measure for the net weight of the shipment. -
NetWeightUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure used for net weight of the shipment. -
PackingSlip: string
Maximum Length:
25
Document that itemizes the contents of a package, carton, pallet, or container for shipment to a customer. -
shipmentHeaderDFFs: array
Flexfields for Shipment Headers
Title:
Flexfields for Shipment Headers
The Flexfields for Shipment Headers resource gets the descriptive flexfields for the information corresponding to the inbound shipment header. It includes global segments, context, and context sensitive segments. -
shipmentLines: array
Shipment Lines
Title:
Shipment Lines
The Shipment Lines resource manages details about the shipment lines for a specific shipment header. -
TarWeight: number
Weight of an empty vehicle or container. You can subtract the tare weight from the gross weight (laden weight) to find the weight of the carried goods (net weight).
-
TarWeightUOM: string
Maximum Length:
25
Unit of measure for the tare weight of the shipment. -
TarWeightUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure used for tare weight of the shipment.
Nested Schema : Flexfields for Shipment Headers
Type:
array
Title:
Flexfields for Shipment Headers
The Flexfields for Shipment Headers resource gets the descriptive flexfields for the information corresponding to the inbound shipment header. It includes global segments, context, and context sensitive segments.
Show Source
Nested Schema : Shipment Lines
Type:
array
Title:
Shipment Lines
The Shipment Lines resource manages details about the shipment lines for a specific shipment header.
Show Source
Nested Schema : inboundShipments-shipmentHeaderDFFs-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Context value of the descriptive flexfield that contains details about the inbound shipment header. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Nested Schema : schema
Type:
Show Source
object
-
attachments: array
Attachments
Title:
Attachments
The Attachments resource gets the details about the documents that the user attached to the shipment line. -
Comments: string
Maximum Length:
4000
Comments or notes entered for the inbound shipment line. -
inventoryStripingDFF: array
Flexfields for Inventory Striping Attributes
Title:
Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages the inventory striping attributes that the descriptive flexfield references associated with a inbound shipment line. Inventory striping (inventory tracking) attributes are a set of named attributes (project, task, and country of origin) as well as user-configurable attributes, which when specified as part of the receipt or receiving transaction, are used to track the inventory on hand. -
lots: array
Lots
Title:
Lots
The Lots resource gets the lot information for a specific inbound shipment line. -
PackingSlip: string
Maximum Length:
25
Document that itemizes the contents of a package, carton, pallet, or container for shipment to a customer. -
packingUnits: array
Packing Units
Title:
Packing Units
The Packing Units resource gets the packing unit hierarchy for a specific inbound shipment line. Each row in the result displays the packing unit and the parent packing unit. -
PrimaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the primary unit of measure of the item. -
Reason: string
Maximum Length:
30
Name of the inventory transaction reason. -
ReasonId: integer
(int64)
Value that uniquely identifies the inventory transaction reason.
-
Routing: string
Maximum Length:
80
Routing name for the type of transaction entry that determines the steps that receive the item. Values include Direct delivery, Inspection required, and Standard receipt. A list of valid routing header identifiers is defined using the lookup RCV_ROUTING_HEADERS. -
RoutingHeaderId: integer
(int64)
Value that uniquely identifies the receipt routing. Values include 1, 2, and 3. A list of valid routing header identifiers is defined using the lookup RCV_ROUTING_HEADERS.
-
serials: array
Serials
Title:
Serials
The Serials resource gets the serial numbers shipped for a specific inbound shipment line. Applies when only the serial controls the shipped item and is not lot controlled. -
shipmentLineDFFs: array
Flexfields for Shipment Lines
Title:
Flexfields for Shipment Lines
The Flexfields for Shipment Lines resource gets the descriptive flexfields for the information corresponding to the inbound shipment line. It includes global segments, context, and context sensitive segments.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource gets the details about the documents that the user attached to the shipment line.
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 inventory striping attributes that the descriptive flexfield references associated with a inbound shipment line. Inventory striping (inventory tracking) attributes are a set of named attributes (project, task, and country of origin) as well as user-configurable attributes, which when specified as part of the receipt or receiving transaction, are used to track the inventory on hand.
Show Source
Nested Schema : Lots
Type:
array
Title:
Lots
The Lots resource gets the lot information for a specific inbound shipment line.
Show Source
Nested Schema : Packing Units
Type:
array
Title:
Packing Units
The Packing Units resource gets the packing unit hierarchy for a specific inbound shipment line. Each row in the result displays the packing unit and the parent packing unit.
Show Source
Nested Schema : Serials
Type:
array
Title:
Serials
The Serials resource gets the serial numbers shipped for a specific inbound shipment line. Applies when only the serial controls the shipped item and is not lot controlled.
Show Source
Nested Schema : Flexfields for Shipment Lines
Type:
array
Title:
Flexfields for Shipment Lines
The Flexfields for Shipment Lines resource gets the descriptive flexfields for the information corresponding to the inbound shipment line. It includes global segments, context, and context sensitive segments.
Show Source
Nested Schema : inboundShipments-shipmentLines-attachments-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON-formatted string containing information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attachment. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment.
Nested Schema : inboundShipments-shipmentLines-inventoryStripingDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:40
Descriptive flexfield context name for inventory striping attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for inventory striping attributes. -
countryOfOriginCode: string
Title:
Country of Origin
Maximum Length:2
Abbreviation that identifies the country of manufacture for this item. -
countryOfOriginCode_Display: string
Title:
Country of Origin
Name of the country. -
projectId: integer
(int64)
Title:
Project
Value that uniquely identifies the project. -
projectId_Display: string
Title:
Project
Number that identifies the project. -
ShipmentLineId: integer
(int64)
Value that uniquely identifies the inbound shipment line.
-
taskId: integer
(int64)
Title:
Task
Value that uniquely identifies the task. -
taskId_Display: string
Title:
Task
Number that identifies the task.
Nested Schema : inboundShipments-shipmentLines-lots-lotSerials-item-patch-request
Type:
Show Source
object
Nested Schema : inboundShipments-shipmentLines-packingUnits-item-patch-request
Type:
Show Source
object
Nested Schema : inboundShipments-shipmentLines-shipmentLineDFFs-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Context value of the descriptive flexfield that contains details about the inbound shipment line. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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".
-
REST-Framework-Version(required):
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.
Root Schema : inboundShipments-item-response
Type:
Show Source
object
-
ASNType: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the document type that specifies how to use this transaction for in-transit shipments and transfer order shipments. This attribute contains one of the following values. ASN: represents an advance shipment notice; ASBN: represents an advance shipment billing notice; STD: represents a transfer order shipment or in-transit shipment. -
BillOfLading: string
Maximum Length:
25
Receipt that a carrier issues to the shipper as a contract for carriage of goods. This receipt acknowledges that the cargo is accepted for transportation and must be presented for taking delivery at the destination. -
Carrier: string
Maximum Length:
360
Name of the company that transports goods from one point to another by land, sea, or air. -
Comments: string
Maximum Length:
4000
Comments or notes entered in the inbound shipment header. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the inbound shipment header record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the inbound shipment header record was created. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the invoice amount currency. -
ExpectedReceiptDate: string
(date-time)
Date when the inbound shipment is expected to arrive at the receiving organizations.
-
FreightAmount: number
Read Only:
true
Price at which the cargo is delivered from one point to another. The price depends on the mode of transport, the weight of the cargo, and the distance of the delivery destination. -
FreightCarrierId: integer
(int64)
Value that uniquely identifies the freight carrier.
-
FreightTerms: string
Maximum Length:
80
Agreement that describes whether the buyer or seller pays the shipping cost of the sales order, and when payment is due. -
FreightTermsCode: string
Maximum Length:
25
Abbreviation that identifies the freight terms. -
GrossWeight: number
Read Only:
true
Weight of the fully loaded vehicle, container, or item, including packed items and packaging material. -
GrossWeightUOM: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure for the gross weight of the shipment. -
GrossWeightUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure used for gross weight of the shipment. -
HeaderInterfaceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the staged receiving header interface that was used in creating this inbound shipment. -
IntegratedSystemCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the integrated system status for an organization. -
InvoiceAmount: number
Read Only:
true
Amount on the invoice associated with the shipment or billing notice, such as, an advanced shipment notice with billing information. -
InvoiceDate: string
(date-time)
Read Only:
true
Date when the invoice associated with the shipment or billing notice, such as, an advanced shipment notice with billing information, is due. -
InvoiceNumber: string
Read Only:
true
Maximum Length:50
Number that identifies the invoice associated with the shipment/billing notice such as, advanced shipment notice with billing information. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the inbound shipment header record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Login of the user who updated the inbound shipment header record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NetWeight: number
Weight of the products being shipped without considering the packaging.
-
NetWeightUOM: string
Maximum Length:
25
Unit of measure for the net weight of the shipment. -
NetWeightUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure used for net weight of the shipment. -
NumberOfContainers: integer
(int64)
Read Only:
true
Number of packing units in the shipment. -
PackagingCode: string
Read Only:
true
Maximum Length:5
Abbreviation that identifies the material being transported. The unique packaging code is based on the United Nations Committee of Experts on the Transportation of Dangerous Goods recommendations. -
PackingSlip: string
Maximum Length:
25
Document that itemizes the contents of a package, carton, pallet, or container for shipment to a customer. -
PaymentTerms: string
Read Only:
true
Maximum Length:50
Name of the payment terms used to schedule payments and to calculate due dates, discount dates, and discount amounts, if applicable. -
PaymentTermsId: integer
(int64)
Read Only:
true
Value that uniquely identifies the payment terms. -
ReceiptNumber: string
Read Only:
true
Maximum Length:30
Number that acknowledges that a shipment was received in the warehouse. -
ReceiptSourceCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the source type for the inbound shipment. Values include VENDOR, INVENTORY, and TRANSFER ORDER. -
ShipFromOrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the originating organization of the in-transit shipment or transfer order shipment. -
ShipFromOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the originating organization of the in-transit shipment or transfer order shipment. -
shipmentHeaderDFFs: array
Flexfields for Shipment Headers
Title:
Flexfields for Shipment Headers
The Flexfields for Shipment Headers resource gets the descriptive flexfields for the information corresponding to the inbound shipment header. It includes global segments, context, and context sensitive segments. -
ShipmentHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inbound shipment header. -
shipmentLines: array
Shipment Lines
Title:
Shipment Lines
The Shipment Lines resource manages details about the shipment lines for a specific shipment header. -
ShipmentNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the inbound shipment. -
ShippedDate: string
(date-time)
Read Only:
true
Date when goods were shipped by the supplier. -
ShipToOrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the organization that receives the item. -
ShipToOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receiving organization. -
SpecialHandlingCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the handling instructions for the transported material. -
SupplierName: string
Read Only:
true
Maximum Length:360
Name of the supplier who provides the products in return for what may or may not require payment. -
SupplierNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the supplier. -
SupplierSiteCode: string
Read Only:
true
Maximum Length:240
Abbreviation that identifies the supplier site from other sites for a supplier. -
TarWeight: number
Weight of an empty vehicle or container. You can subtract the tare weight from the gross weight (laden weight) to find the weight of the carried goods (net weight).
-
TarWeightUOM: string
Maximum Length:
25
Unit of measure for the tare weight of the shipment. -
TarWeightUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure used for tare weight of the shipment. -
TaxAmount: number
Read Only:
true
Tax amount associated with the shipment or billing notice name indicated at the header level. -
VendorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier. -
VendorSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site. -
WaybillAirbillNumber: string
Read Only:
true
Maximum Length:20
Number that identifies the nonnegotiable document that describes the contract for transporting cargo.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Shipment Headers
Type:
array
Title:
Flexfields for Shipment Headers
The Flexfields for Shipment Headers resource gets the descriptive flexfields for the information corresponding to the inbound shipment header. It includes global segments, context, and context sensitive segments.
Show Source
Nested Schema : Shipment Lines
Type:
array
Title:
Shipment Lines
The Shipment Lines resource manages details about the shipment lines for a specific shipment header.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : inboundShipments-shipmentHeaderDFFs-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Context value of the descriptive flexfield that contains details about the inbound shipment header. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ShipmentHeaderId: integer
(int64)
Value that uniquely identifies the shipment header.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inboundShipments-shipmentLines-item-response
Type:
Show Source
object
-
ASNLPNId: integer
(int64)
Read Only:
true
Value that uniquely identifies the license plate number used for this advanced shipment notice line. -
attachments: array
Attachments
Title:
Attachments
The Attachments resource gets the details about the documents that the user attached to the shipment line. -
BackToBackOrder: string
Read Only:
true
Maximum Length:1
Value that indicates whether the supply source for a reservation is a back-to-back purchase order or a transfer order. -
BarCodeLabel: string
Read Only:
true
Maximum Length:35
Bar code label for the material on the shipment line. -
Comments: string
Maximum Length:
4000
Comments or notes entered for the inbound shipment line. -
ConsignmentLine: string
Read Only:
true
Maximum Length:1
Value that indicates whether the shipment line is created for consigned material. -
ContainerNumber: string
Read Only:
true
Maximum Length:35
Reference number assigned to the freight container, used for documentation purposes. -
CountryOfOrigin: string
Read Only:
true
Name of the country from which goods are exported. -
CountryOfOriginCode: string
Read Only:
true
Maximum Length:2
Abbreviation that identifies the country from which goods are exported. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the inbound shipment line record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the inbound shipment line record was created. -
DestinationType: string
Read Only:
true
Maximum Length:80
The destination type of the receiving transaction. A list of valid destination type codes is defined using the lookup RCV_DESTINATION_TYPE. -
DestinationTypeCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the destination type of the receiving transaction. A list of valid destination type codes is defined using the lookup RCV_DESTINATION_TYPE. -
FromOrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the originating organization of the in-transit shipment or transfer order shipment. -
FromOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the originating organization of the in-transit shipment or transfer order shipment. -
HazardClass: string
Read Only:
true
Maximum Length:255
Name of the hazard class that's used to identify and classify hazardous materials to comply with safety regulations. -
HazardClassId: integer
(int64)
Read Only:
true
Value that uniquely identifies the hazard class. -
IntegrationStatus: string
Read Only:
true
Maximum Length:80
Status that indicates whether the shipment line is interfaced to the external system for third-party logistics scenarios. Values include READY, INTERFACED, and CONFIRMED. -
InterfaceTransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the staged receiving transaction interface that created this inbound shipment line. -
InventoryShipmentTransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory transaction that creates the inbound shipment in receiving. -
inventoryStripingDFF: array
Flexfields for Inventory Striping Attributes
Title:
Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages the inventory striping attributes that the descriptive flexfield references associated with a inbound shipment line. Inventory striping (inventory tracking) attributes are a set of named attributes (project, task, and country of origin) as well as user-configurable attributes, which when specified as part of the receipt or receiving transaction, are used to track the inventory on hand. -
ItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item being shipped. -
ItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies an item. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies an item. -
ItemRevision: string
Read Only:
true
Maximum Length:18
Value that identifies an incremental change to the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the inbound shipment line record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Login of the user who updated the inbound shipment line record. -
LineNumber: integer
(int64)
Read Only:
true
Line number of the inbound shipment line for this shipment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Read Only:
true
Maximum Length:255
Physical area in the subinventory, such as a row, aisle, bin, or shelf, where you store material. -
LocatorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the locator. -
lots: array
Lots
Title:
Lots
The Lots resource gets the lot information for a specific inbound shipment line. -
LotsCount: integer
Read Only:
true
Number of lots in a shipment line. This attribute is intended for integration. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the receiving organization. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receiving organization. -
OriginalTOInvShipTransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the original transfer order inventory shipment transaction for this return transfer order shipment. -
PackingSlip: string
Maximum Length:
25
Document that itemizes the contents of a package, carton, pallet, or container for shipment to a customer. -
packingUnits: array
Packing Units
Title:
Packing Units
The Packing Units resource gets the packing unit hierarchy for a specific inbound shipment line. Each row in the result displays the packing unit and the parent packing unit. -
POHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order header. -
POLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order line. -
POLineLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order schedule. -
POLineNumber: number
Title:
Line
Read Only:true
Number that identifies the purchase order line corresponding to the advance shipment notice or advance shipment billing notice line. -
PONumber: string
Title:
Order
Read Only:true
Maximum Length:30
Number that identifies the purchase order corresponding to the advance shipment notice or advance shipment billing notice line. -
POScheduleNumber: number
Title:
Schedule
Read Only:true
Number that identifies the purchase order schedule corresponding to the advance shipment notice or advance shipment billing notice line. -
PrimaryQuantity: number
Read Only:
true
Shipped quantity in the primary unit of measure of the item. -
PrimaryUnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Primary unit of measure of the item. -
PrimaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the primary unit of measure of the item. -
QuantityAccepted: number
Read Only:
true
Net quantity accepted for this inbound shipment line. -
QuantityReceived: number
Read Only:
true
Net quantity received for the inbound shipment line. -
QuantityRejected: number
Read Only:
true
Net quantity rejected for this inbound shipment line. -
QuantityReturned: number
Read Only:
true
Net quantity returned for this inbound shipment line. -
QuantityShipped: number
Read Only:
true
Total quantity of goods shipped for this inbound shipment line. -
Reason: string
Maximum Length:
30
Name of the inventory transaction reason. -
ReasonId: integer
(int64)
Value that uniquely identifies the inventory transaction reason.
-
Routing: string
Maximum Length:
80
Routing name for the type of transaction entry that determines the steps that receive the item. Values include Direct delivery, Inspection required, and Standard receipt. A list of valid routing header identifiers is defined using the lookup RCV_ROUTING_HEADERS. -
RoutingHeaderId: integer
(int64)
Value that uniquely identifies the receipt routing. Values include 1, 2, and 3. A list of valid routing header identifiers is defined using the lookup RCV_ROUTING_HEADERS.
-
SecondaryQuantityReceived: number
Read Only:
true
Net quantity received for the inbound shipment line in the secondary unit of measure for the item. -
SecondaryQuantityShipped: number
Read Only:
true
Total quantity of goods shipped for this inbound shipment line in the secondary unit of measure for the item. -
SecondaryUOM: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Name of the secondary unit of measure of the item that belongs to the current shipment line. -
SecondaryUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the secondary unit of measure of the item in the inbound shipment line. -
serials: array
Serials
Title:
Serials
The Serials resource gets the serial numbers shipped for a specific inbound shipment line. Applies when only the serial controls the shipped item and is not lot controlled. -
SerialsCount: integer
Read Only:
true
Number of serials in a shipment line. This attribute is intended for integration. -
ShipmentHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inbound shipment header. -
shipmentLineDFFs: array
Flexfields for Shipment Lines
Title:
Flexfields for Shipment Lines
The Flexfields for Shipment Lines resource gets the descriptive flexfields for the information corresponding to the inbound shipment line. It includes global segments, context, and context sensitive segments. -
ShipmentLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inbound shipment line. -
ShipmentLineStatus: string
Read Only:
true
Maximum Length:80
Name of the state of the inbound shipment line. -
ShipmentLineStatusCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the state of the inbound shipment line. Valid include EXPECTED, PARTIALLY RECEIVED, FULLY RECEIVED, and CANCELLED. -
SourceDocumentCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the document classification based on the originating source such as purchase order or transfer order. A list of valid source document codes is defined using the lookup RCV_SOURCE_DOCUMENT_TYPE. -
SourcePackingUnit: string
Read Only:
true
Maximum Length:30
Value that identifies the originating packing unit for the item. -
Subinventory: string
Read Only:
true
Maximum Length:10
Subdivision of an organization, representing either a physical area or a local grouping of items, such as a storeroom or receiving dock. -
SupplierItemNumber: string
Title:
Supplier Item
Read Only:true
Maximum Length:300
Number that the supplier uses to identify the item on the purchase order line. -
TransferCost: number
Read Only:
true
Cost of transferring shipments between organizations. -
TransferOrderHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transfer order header associated with the transfer order shipment line. -
TransferOrderLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transfer order line associated with the transfer order shipment line. -
TransferOrderLineNumber: integer
(int32)
Title:
Transfer Order Line
Read Only:true
Number that identifies the transfer order line corresponding to the inbound shipment line. -
TransferOrderNumber: string
Title:
Transfer Order
Read Only:true
Maximum Length:50
Number that identifies the transfer order corresponding to the inbound shipment line. -
TransportationCost: number
Read Only:
true
Cost of transportation for the goods. -
TruckNumber: string
Read Only:
true
Maximum Length:35
Number of the truck used for shipment. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure used to quantify the inventory items. It is a physical unit (like kg, dozen, or meter) in which we measure and manage different items. -
UNNumber: string
Read Only:
true
Maximum Length:255
Number that the United Nations uses to identify hazardous material. -
UNNumberId: integer
(int64)
Read Only:
true
Value that uniquely identifies the number that the United Nations uses to identify hazardous material. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure in which the item corresponding to the current line is shipped.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource gets the details about the documents that the user attached to the shipment line.
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 inventory striping attributes that the descriptive flexfield references associated with a inbound shipment line. Inventory striping (inventory tracking) attributes are a set of named attributes (project, task, and country of origin) as well as user-configurable attributes, which when specified as part of the receipt or receiving transaction, are used to track the inventory on hand.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Lots
Type:
array
Title:
Lots
The Lots resource gets the lot information for a specific inbound shipment line.
Show Source
Nested Schema : Packing Units
Type:
array
Title:
Packing Units
The Packing Units resource gets the packing unit hierarchy for a specific inbound shipment line. Each row in the result displays the packing unit and the parent packing unit.
Show Source
Nested Schema : Serials
Type:
array
Title:
Serials
The Serials resource gets the serial numbers shipped for a specific inbound shipment line. Applies when only the serial controls the shipped item and is not lot controlled.
Show Source
Nested Schema : Flexfields for Shipment Lines
Type:
array
Title:
Flexfields for Shipment Lines
The Flexfields for Shipment Lines resource gets the descriptive flexfields for the information corresponding to the inbound shipment line. It includes global segments, context, and context sensitive segments.
Show Source
Nested Schema : inboundShipments-shipmentLines-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment of a shipment line. It is a primary key that the application generates when a document is attached to the shipment line. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment for the specification. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON-formatted string containing information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that is attached to the shipment line. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who updated the document that is attached to the shipment line. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the attachment for the specification. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inboundShipments-shipmentLines-inventoryStripingDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:40
Descriptive flexfield context name for inventory striping attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for inventory striping attributes. -
countryOfOriginCode: string
Title:
Country of Origin
Maximum Length:2
Abbreviation that identifies the country of manufacture for this item. -
countryOfOriginCode_Display: string
Title:
Country of Origin
Name of the country. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
Project
Value that uniquely identifies the project. -
projectId_Display: string
Title:
Project
Number that identifies the project. -
ShipmentLineId: integer
(int64)
Value that uniquely identifies the inbound shipment line.
-
taskId: integer
(int64)
Title:
Task
Value that uniquely identifies the task. -
taskId_Display: string
Title:
Task
Number that identifies the task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inboundShipments-shipmentLines-lots-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotExpirationDate: string
(date)
Read Only:
true
Date when the lot expires. -
LotNumber: string
Read Only:
true
Maximum Length:80
Number that identifies an inventory lot. -
lotSerials: array
Serials for Lots
Title:
Serials for Lots
The Serials for Lots resource displays the serial numbers shipped for a specific lot. Applies when both the lot and the serial control the shipped item. -
Quantity: number
Read Only:
true
Quantity of the item shipped as part of the current lot. -
SecondaryQuantity: number
Read Only:
true
Quantity of the item shipped as part of the current lot in the secondary unit of measure for the item. -
SecondaryUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the secondary unit of measure of the shipment line item. -
SerialTransactionId: number
Read Only:
true
Value that identifies a single lot transacted to the serials for this lot. Applied when the item is lot and serial controlled. -
ShipmentLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inbound shipment line for this lot. -
TransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the deliver transaction of the drop ship advanced shipment notice. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure in which the lot was shipped.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Serials for Lots
Type:
array
Title:
Serials for Lots
The Serials for Lots resource displays the serial numbers shipped for a specific lot. Applies when both the lot and the serial control the shipped item.
Show Source
Nested Schema : inboundShipments-shipmentLines-lots-lotSerials-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialNumber: string
Read Only:
true
Maximum Length:80
Number that identifies the item unit.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inboundShipments-shipmentLines-packingUnits-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LPNId: integer
(int64)
Read Only:
true
Value that uniquely identifies the license plate number. -
PackingUnit: string
Read Only:
true
Maximum Length:30
Name of the packing unit. -
ParentLPNId: integer
(int64)
Read Only:
true
Value that uniquely identifies the parent license plate number. -
ParentPackingUnit: string
Read Only:
true
Maximum Length:30
Name of the parent packing unit. -
RootLPNId: number
Read Only:
true
Value that uniquely identifies the outer most license plate number in the current packing unit hierarchy.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inboundShipments-shipmentLines-serials-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialNumber: string
Read Only:
true
Maximum Length:80
Number that identifies the item unit. -
ShipmentLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inbound shipment line. -
TransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the deliver transaction of the drop ship advanced shipment notice.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inboundShipments-shipmentLines-shipmentLineDFFs-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Context value of the descriptive flexfield that contains details about the inbound shipment line. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ShipmentLineId: integer
(int64)
Value that uniquely identifies the inbound shipment line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- shipmentHeaderDFFs
-
Parameters:
- inboundShipmentsUniqID:
$request.path.inboundShipmentsUniqID
The Flexfields for Shipment Headers resource gets the descriptive flexfields for the information corresponding to the inbound shipment header. It includes global segments, context, and context sensitive segments. - inboundShipmentsUniqID:
- shipmentLines
-
Operation: /fscmRestApi/resources/11.13.18.05/inboundShipments/{inboundShipmentsUniqID}/child/shipmentLinesParameters:
- inboundShipmentsUniqID:
$request.path.inboundShipmentsUniqID
The Shipment Lines resource manages details about the shipment lines for a specific shipment header. - inboundShipmentsUniqID:
Examples
This example describes how to update one inbound shipment.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/inboundShipments/compositeKey"
For example:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/inboundShipments/00040000000EACED0005770800000000002D7651FFFFFFFFFFFFFFFF0000000EACED0005770800000000000000CF
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "Carrier":"Airborne", "NetWeightUOM":"Each" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ShipmentHeaderId" : 2979409, "CreatedBy" : "WHSE_MGR_M1", "CreationDate" : "2018-06-27T07:35:12+00:00", "LastUpdateDate" : "2018-06-27T09:18:28.256+00:00", "LastUpdatedBy" : "WHSE_MGR_M1", "ReceiptSourceCode" : "VENDOR", "ASNType" : "ASN", "ShipFromOrganizationId" : null, "ShipFromOrganizationCode" : null, "ShipmentNumber" : "ASN270618", "ReceiptNumber" : null, "BillOfLading" : "BOL270618", "PackingSlip" : "PS270618", "PackagingCode" : "PC270", "SpecialHandlingCode" : "SHC", "ShippedDate" : "2018-06-27T00:00:00+00:00", "FreightCarrierId" : 12519, "Carrier" : "Airborne", "ExpectedReceiptDate" : "2018-06-27T00:00:00+00:00", "NumberOfContainers" : 3, "WaybillAirbillNumber" : "WB270618", "GrossWeight" : null, "GrossWeightUOMCode" : null, "GrossWeightUOM" : null, "NetWeight" : 500, "NetWeightUOMCode" : "Ea", "NetWeightUOM" : "Each", "TarWeight" : 50, "TarWeightUOMCode" : "10P", "TarWeightUOM" : "10Pack", "FreightTermsCode" : "PPD", "FreightTerms" : "PPD", "ShipToOrganizationId" : 207, "ShipToOrganizationCode" : "M1", "IntegratedSystemCode" : null, "Comments" : "ASN for demo", "VendorId" : 21, "SupplierName" : "PennyPack Systems", "VendorSiteId" : 1969, "SupplierSiteCode" : "FRESNO", "InvoiceNumber" : null, "InvoiceAmount" : null, "InvoiceDate" : null, "FreightAmount" : null, "TaxAmount" : null, "PaymentTermsId" : null, "PaymentTerms" : null, "CurrencyCode" : null, "HeaderInterfaceId" : 300100159322707, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/inboundShipments/00040000000EACED0005770800000000002D7651FFFFFFFFFFFFFFFF0000000EACED0005770800000000000000CF", "name" : "inboundShipments", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/inboundShipments/00040000000EACED0005770800000000002D7651FFFFFFFFFFFFFFFF0000000EACED0005770800000000000000CF", "name" : "inboundShipments", "kind" : "item" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/inboundShipments/00040000000EACED0005770800000000002D7651FFFFFFFFFFFFFFFF0000000EACED0005770800000000000000CF/lov/CarrierVA", "name" : "CarrierVA", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/inboundShipments/00040000000EACED0005770800000000002D7651FFFFFFFFFFFFFFFF0000000EACED0005770800000000000000CF/lov/LookupPVOFreightTermsVA", "name" : "LookupPVOFreightTermsVA", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/inboundShipments/00040000000EACED0005770800000000002D7651FFFFFFFFFFFFFFFF0000000EACED0005770800000000000000CF/lov/TarWeightUOMVA", "name" : "TarWeightUOMVA", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/inboundShipments/00040000000EACED0005770800000000002D7651FFFFFFFFFFFFFFFF0000000EACED0005770800000000000000CF/lov/NetWeightUOMVA", "name" : "NetWeightUOMVA", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/inboundShipments/00040000000EACED0005770800000000002D7651FFFFFFFFFFFFFFFF0000000EACED0005770800000000000000CF/child/shipmentLines", "name" : "shipmentLines", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/inboundShipments/00040000000EACED0005770800000000002D7651FFFFFFFFFFFFFFFF0000000EACED0005770800000000000000CF/child/shipmentHeaderDFFs", "name" : "shipmentHeaderDFFs", "kind" : "collection" } ] }