Integrate Shipment Request and Shipment Confirmation Processes for External Applications
A third-party logistics (3PL) provider typically specializes in integrated operation, warehousing, and transportation services that can be scaled and configured to customer need based on market conditions. A warehouse management system (WMS) is a software application designed to support warehouse or distribution center management and staff. This application facilitates management of available resources to move and store materials into, within, and out of a warehouse, while supporting staff in material movement and storage.
Oracle Fusion Applications provide a central integration framework that coordinates communication with a 3PL application or WMS to support purchase order receipts, returns to suppliers, internal material transfers, inventory transactions, and sales order shipments. Using REST API, Oracle Inventory Management Cloud communicates receiving advice and shipment requests to a 3PL provider or external WMS for processing. After completion of processing in the 3PL application or WMS, Inventory Management accepts receipt confirmations, shipment confirmations, and inventory transactions from the 3PL application or WMS.
The following figure illustrates how Inventory Management integrates with 3PL and WMS applications.
Let's discuss this scenario briefly:
- Generate a shipment request
- Get shipment lines
- Manage shipment confirmation
Here's a typical application processing flow for the scenarios:
- You use the generateShipmentRequest custom action in the shipmentLineChangeRequests resource to select and send shipment lines to external applications such as a WMS and also indicates the lines as interfaced. The shipment lines are selected using input parameters, assigned to a picking batch, and their integration status is set to interfaced.
- You can use the shipmentLines resource to search for shipment lines by organization, pick wave identifier, order type, line status, order number, source order number, and many more such attributes.
- You map the output to the WMS service and call the appropriate WMS service.
- WMS picks, packs, and ships the material and sends the message to the integration layer.
- You map the message details to the shipmentTransactionRequests resource and use the resource to get the shipment transaction request information, which includes the details about related shipments, packing units, shipment lines, shipping costs, lots, serial numbers, and processing errors, if any.
- You can run the Perform Shipping Transactions scheduled process to process pending shipping transactions received through open interfaces.
Generate a Shipment Request
Let's consider that Amy Jones is a shipping agent who sends shipment requests to the WMS for the various documents, such as sales orders and transfer orders.
To accomplish sending a shipment request use the generateShipmentRequest custom action in the shipmentLineChangeRequests resource to select and send shipment lines to external applications such as a WMS and also indicates the lines as interfaced.
Example URL
Use this resource URL format to generate a group identifier for receipt advice lines.
POST
fscmRestApi/resources/version/shipmentLineChangeRequests
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/shipmentLineChangeRequests"
Example Request
Here's an example of the request body in JSON format.
{
"pickBatchName":"41214"
} Example Response
Here's an example of the response body in JSON format.
{
"ShipmentRequestId":41214,
"ShipmentRequest":"41214",
"ReturnStatus":"SUCCESS",
"Message":null
}Get Shipment Lines
Let's consider that Amy Scott is a shipping agent who sends shipment lines to be fulfilled from Inventory Management to WMS.
To accomplish sending a shipment request use the shipmentLines resource to search for shipment lines by organization, pick wave identifier, order type, line status, order number, source order number, and many more such attributes. You can get the shipment line information, which includes details about the related reservations. This shipment line information can be used to submit shipment lines for trade compliance verification.
Example URL
Use this resource URL format.
GET
curl -u username:password "https://servername/fscmRestApi/resources/version//latest/shipmentLines?onlyData=true&q=PickWaveId=41214&fields=ShipmentLine,Item,PickWaveId,PickWave"
Example Response
Here's an example of the response body in JSON format.
{
"ShipmentLine": 203814,
"OrderTypeCode": "SALES_ORDER",
"OrderType": "Sales order",
"Order": "56190",
"OrderLine": "4.1",
"OrderSchedule": null,
"InventoryItemId": 606,
"Item": "CM11222",
"ItemDescription": "Battery - Extended Life",
"Revision": null,
"UnitPrice": 48,
"SellingPrice": null,
"RequestedQuantity": 56,
"RequestedQuantityUOMCode": "Ea",
"RequestedQuantityUOM": "Each",
"SecondaryRequestedQuantity": null,
"SecondaryRequestedQuantityUOMCode": null,
"SecondaryRequestedQuantityUOM": null,
"FOBCode": "DEST",
"FOB": "DEST",
"FreightTermsCode": "Due",
"FreightTerms": null,
"ShippingPriorityCode": null,
"ShippingPriority": null,
"PreferredGrade": null,
"PreferredGradeName": null,
"CurrencyCode": "USD",
"CurrencyName": "US Dollar",
"ShipmentSet": null,
"ArrivalSet": null,
"CustomerPONumber": null,
"CustomerItemId": null,
"CustomerItem": null,
"CustomerItemDescription": null,
"RequestedDate": "2003-09-29T06:04:37+00:00",
"ScheduledShipDate": "2003-09-29T23:59:59+00:00",
"RequestedDateTypeCode": null,
"RequestedDateType": null,
"ShipToPartyId": 7891,
"ShipToCustomer": "Michael Smith",
"ShipToCustomerNumber": "6328",
"ShipToPartySiteId": null,
"ShipToPartySiteNumber": null,
"ShipToContactId": null,
"ShipToContact": null,
"ShipToContactFirstName": null,
"ShipToContactLastName": null,
"ShipToContactPhone": null,
"ShipToURL": null,
"ShipToFax": null,
"ShipToEmail": null,
"ShipToLocationId": 2541,
"ShipToLocationType": null,
"ShipToAddress1": "2391 L Street",
"ShipToAddress2": null,
"ShipToAddress3": null,
"ShipToAddress4": null,
"ShipToCity": "San Jose",
"ShipToCounty": "Santa Clara",
"ShipToPostalCode": "95106",
"ShipToRegion": null,
"ShipToState": "CA",
"ShipToCountry": "US",
"SoldToPartyId": 7891,
"SoldToCustomer": "Michael Smith",
"SoldToCustomerNumber": "6328",
"Supplier": null,
"SupplierPartyNumber": null,
"SoldToContactId": null,
"SoldToContact": null,
"SoldToContactFirstName": null,
"SoldToContactLastName": null,
"SoldToContactPhone": null,
"SoldToURL": null,
"SoldToFax": null,
"SoldToEmail": null,
"BillToPartyId": null,
"BillToCustomer": null,
"BillToCustomerNumber": null,
"BillToPartySiteId": null,
"BillToPartySiteNumber": null,
"BillToContactId": null,
"BillToContact": null,
"BillToContactFirstName": null,
"BillToContactLastName": null,
"BillToContactPhone": null,
"BillToURL": null,
"BillToFax": null,
"BillToEmail": null,
"BillToLocationId": null,
"BillToAddress1": null,
"BillToAddress2": null,
"BillToAddress3": null,
"BillToAddress4": null,
"BillToCity": null,
"BillToCounty": null,
"BillToPostalCode": null,
"BillToRegion": null,
"BillToState": null,
"BillToCountry": null,
"Subinventory": "Staging1",
"LocatorId": null,
"Locator": null,
"ShippedQuantity": 56,
"SecondaryShippedQuantity": null,
"NetWeight": 168,
"GrossWeight": 168,
"TareWeight": 0,
"WeightUOMCode": "Lbs",
"WeightUOM": "Pounds",
"Volume": 2,
"VolumeUOMCode": "FT3",
"VolumeUOM": "Cubic foot",
"LoadingSequence": null,
"LotNumber": "S50000",
"EndAssemblyItemNumber": null,
"OrganizationId": 207,
"OrganizationCode": "M1",
"OrganizationName": "Tall Manufacturing",
"ParentPackingUnitId": null,
"ParentPackingUnit": null,
"ShipmentId": 57896,
"Shipment": "57896",
"ProjectSalesOrderFlag": null,
"RcvShipmentLineId": null,
"LineStatusCode": "C",
"LineStatus": "Interfaced",
"TrackingNumber": null,
"SealNumber": null,
"PickWaveId": 41214,
"PickWave": "41214",
"SourceOrderId": 88983,
"SourceOrder": "56190",
"SourceOrderLineId": 185573,
"SourceOrderLine": "4.1",
"SourceOrderFulfillmentLineId": null,
"SourceOrderFulfillmentLine": null,
"TaxationCountryCode": null,
"TaxationCountry": null,
"FirstPartyTaxRegistrationId": null,
"FirstPartyTaxRegistrationNumber": null,
"ThirdPartyTaxRegistrationId": null,
"ThirdPartyTaxRegistrationNumber": null,
"LocationOfFinalDischargeId": null,
"LocationOfFinalDischargeCode": null,
"LocationOfFinalDischarge": null,
"DocumentFiscalClassificationCode": null,
"DocumentFiscalClassification": null,
"TransactionBusinessCategoryCode": null,
"TransactionBusinessCategory": null,
"UserDefinedFiscalClassificationCode": null,
"UserDefinedFiscalClassification": null,
"TaxInvoiceNumber": null,
"TaxInvoiceDate": null,
"ProductCategoryCode": null,
"ProductCategory": null,
"IntendedUseClassificationId": null,
"IntendedUse": null,
"ProductTypeCode": null,
"ProductType": null,
"AssessableValue": null,
"TaxClassificationCode": null,
"TaxClassification": null,
"TaxExemptionCertificateNumber": null,
"TaxExemptionReasonCode": null,
"TaxExemptionReason": null,
"ProductFiscalClassificationId": null,
"ProductFiscalClassification": null,
"TransportationPlanningStatusCode": null,
"TransportationPlanningStatus": null,
"TransportationPlanningDate": null,
"TransportationShipment": null,
"TransportationShipmentLine": null,
"InitialDestinationId": null,
"InitialDestination": null,
"TradeComplianceStatusCode": null,
"TradeComplianceStatus": null,
"TradeComplianceDate": null,
"TradeComplianceReason": null,
"TradeComplianceScreeningMethodCode": null,
"TradeComplianceScreeningMethod": null,
"ShipFromLocationId": 207,
"ShipFromAddress1": "3455 108th Avenue",
"ShipFromAddress2": null,
"ShipFromAddress3": null,
"ShipFromAddress4": null,
"ShipFromCity": "Seattle",
"ShipFromCounty": "King",
"ShipFromPostalCode": "98101",
"ShipFromRegion": null,
"ShipFromState": "WA",
"ShipFromCountry": "US",
"MaximumOvershipmentPercentage": 10,
"MaximumUndershipmentPercentage": 40,
"SourceRequestedQuantity": 56,
"SourceRequestedQuantityUOMCode": "Ea",
"SourceRequestedQuantityUOM": "Each",
"SecondarySourceRequestedQuantity": null,
"SecondarySourceRequestedQuantityUOMCode": null,
"SecondarySourceRequestedQuantityUOM": null,
"DeliveredQuantity": null,
"SecondaryDeliveredQuantity": null,
"CancelledQuantity": null,
"SecondaryCancelledQuantity": null,
"BackorderedQuantity": 0,
"SecondaryBackorderedQuantity": null,
"PickedQuantity": 56,
"SecondaryPickedQuantity": null,
"ConvertedQuantity": null,
"SecondaryConvertedQuantity": null,
"StagedQuantity": 0,
"SecondaryStagedQuantity": 0,
"PendingQuantity": 0,
"PendingQuantityFlag": false,
"CreationDate": "2003-09-29T00:00:00+00:00",
"CreatedBy": "1000148",
"LastUpdateDate": "2017-02-06T01:10:54+00:00",
"LastUpdatedBy": "FUSION",
"SplitFromShipmentLine": null,
"SourceSubinventory": null,
"CarrierId": null,
"Carrier": null,
"CarrierNumber": null,
"ModeOfTransportCode": null,
"ModeOfTransport": null,
"ServiceLevelCode": null,
"ServiceLevel": null,
"ShippingMethodCode": null,
"ShippingMethod": null,
"SourceDocumentTypeId": 2,
"UnitWeight": null,
"UnitVolume": null,
"LogisticsServiceProviderCustomerId": null,
"LogisticsServiceProviderCustomer": null,
"LogisticsServiceProviderCustomerNumber": null,
"SourceLineUpdateDate": null,
"SourceSystemId": null,
"SourceSystem": null,
"ShipmentAdviceStatusFlag": null,
"DoNotShipBeforeDate": null,
"DoNotShipAfterDate": null,
"IntegrationStatusCode": null,
"IntegrationStatus": null,
"QuickShipStatus": null,
"BusinessUnitId": 204,
"BusinessUnit": "Vision Operations",
"LegalEntityId": 204,
"LegalEntity": "Vision Operations",
"POHeaderId": null,
"PONumber": null,
"POBillToBusinessUnitId": null,
"POBillToBusinessUnit": null,
"POSoldToLegalEntityId": null,
"POSoldToLegalEntity": null,
"ConversionTypeCode": null,
"ConversionDate": null,
"ConversionRate": null,
"ParentItemId": null,
"ParentItem": null,
"ParentItemDescription": null,
"ParentSourceOrderFulfillmentLineId": null,
"BaseItemId": null,
"BaseItem": null,
"BaseItemDescription": null,
"SrcAttributeCategory": null,
"SrcAttribute1": null,
"SrcAttribute2": null,
"SrcAttribute3": null,
"SrcAttribute4": null,
"SrcAttribute5": null,
"SrcAttribute6": null,
"SrcAttribute7": null,
"SrcAttribute8": null,
"SrcAttribute9": null,
"SrcAttribute10": null,
"SrcAttribute11": null,
"SrcAttribute12": null,
"SrcAttribute13": null,
"SrcAttribute14": null,
"SrcAttribute15": null,
"SrcAttribute16": null,
"SrcAttribute17": null,
"SrcAttribute18": null,
"SrcAttribute19": null,
"SrcAttribute20": null,
"SrcAttributeDate1": null,
"SrcAttributeDate2": null,
"SrcAttributeDate3": null,
"SrcAttributeDate4": null,
"SrcAttributeDate5": null,
"SrcAttributeNumber1": null,
"SrcAttributeNumber2": null,
"SrcAttributeNumber3": null,
"SrcAttributeNumber4": null,
"SrcAttributeNumber5": null,
"SrcAttributeNumber6": null,
"SrcAttributeNumber7": null,
"SrcAttributeNumber8": null,
"SrcAttributeNumber9": null,
"SrcAttributeNumber10": null,
"SrcAttributeTimestamp1": null,
"SrcAttributeTimestamp2": null,
"SrcAttributeTimestamp3": null,
"SrcAttributeTimestamp4": null,
"SrcAttributeTimestamp5": null,
"TransportationShipmentFromEvent": null,
"TransportationShipmentLineFromEvent": null,
"TransportationShipmentCompleteFromEvent": null,
"TradeComplianceScreenedFromEvent": null,
"CurrentBackorderedQuantityFromEvent": null,
"OriginalShipmentLineFromEvent": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814",
"name": "shipmentLines",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814",
"name": "shipmentLines",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814/child/lotStandardDFF",
"name": "lotStandardDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814/child/lotAttributeDFF",
"name": "lotAttributeDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814/child/lineDFF",
"name": "lineDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814/child/serials",
"name": "serials",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814/child/notes",
"name": "notes",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814/child/costs",
"name": "costs",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814/child/reservations",
"name": "reservations",
"kind": "collection"
}
]
}
Manage Shipment Confirmation
Let's consider that Amy Scott is a shipping agent who manages shipments. To send shipment lines Amy can use the shipmentTransactionRequests resource to search for shipment transaction requests by transaction identifier, shipment, shipment line, organization, order number, actual ship date, and many more such attributes. You can get the shipment transaction request information, which includes the details about related shipments, packing units, shipment lines, shipping costs, lots, serial numbers, and processing errors, if any.
To manage shipment confirmation:
- Create shipment transaction request in the interface tables
- Run the Perform Shipping Transactions scheduled process to process this transaction request
- Get the shipment transaction request information
Create Shipment Transaction Request Example URL
Example URL
Use this resource URL format.
POST
/fscmRestApi/resources/11.13.18.05/shipmentTransactionRequests
For example:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests"
Example Request
Here's an example of the request body in JSON format.
{
"ActionCode": "CreateAndConfirmShipment",
"shipments": [
{
"Shipment": "SHP-11062018",
"ShipFromOrganizationCode": "M1",
"GrossWeight": 1000,
"NetWeight": 500,
"WeightUOM": "Pounds",
"Volume": 2000,
"VolumeUOM": "Cubic foot",
"Carrier": "DHL",
"ModeOfTransportCode": "AIR",
"ServiceLevelCode": "2DA",
"notes": [
{
"NoteTxt" : "Um91dGluZyBpbnN0cnVjdGlvbnMgb2YgdGhlIHNoaXBtZW50",
"NoteTypeCode" : "ROUTING_INSTRUCTIONS"
}
],
"shipmentDFF": [
{
"_Global1": "Global1",
"_Global2": "Global2"
}
],
"outerPackingUnits": [
{
"PackingUnit": "PU1",
"PackingUnitType": "Pallet",
"attachments": [
{
"DatatypeCode" : "FILE",
"Title": "Line att. from REST",
"Description": "TEXT UPLOAD for outer packing unit",
"FileName": "LineREST.txt",
"UploadedFileContentType": "text/plain",
"CategoryName" : "MISC",
"FileContents" : "TGluZSBSRVNUIGF0dGFjaG1lbnQgdGV4dA=="
}
],
"innerPackingUnits": [
{
"PackingUnit": "PU2",
"PackingUnitType": "BX54888",
"packedLines": [
{
"ShipmentLine": 3625811,
"Item": "INV-110",
"ShippedQuantity": 6,
"ShippedQuantityUOM": "Each",
"ItemRevision": "A",
"lots": [
{
"Lot": "YP-L001",
"Quantity": 4,
"serials": [
{
"FromSerialNumber": "SS0001",
"ToSerialNumber": "SS0004",
"Subinventory": "ABCSUB01",
"Locator": "ABC1.1.2"
}
]
},
{
"Lot": "YP-L002",
"Quantity": 2,
"serials": [
{
"FromSerialNumber": "SS0106",
"ToSerialNumber": "SS0107",
"Subinventory": "ABCSUB02"
}
]
}
]
}
]
}
],
"costs": [
{
"ShippingCostType": "Handling",
"Amount": 70,
"Currency": "USD",
"DFF": [
{
"_Global1": "PU GBL1",
"_Global2": "PU GBL2"
}
]
}
]
}
],
"unpackedLines": [
{
"ShipmentLine": 3625804,
"Item": "INV-100",
"Subinventory": "ABCSUB01",
"Locator": "ABC1.1.1",
"ShippedQuantity": 2,
"ShippedQuantityUOM": "Each"
}
],
"costs": [
{
"ShippingCostType": "CONTINUOUS MOVE DISTANCE RATE",
"Amount": 10,
"Currency": "USD"
}
]
}
]
}
Example Response
Here's an example of the response body in JSON format.
{
"TransactionId": 300100169688189,
"ActionCode": "CreateAndConfirmShipment",
"TransactionStatusCode": "AP",
"TransactionStatus": "Awaiting processing",
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:11.524+00:00",
"shipments": [
{
"DeliveryInterfaceId": 300100169688190,
"Shipment": "SHP-11062018",
"Description": null,
"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:15:11.031+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:11.525+00:00",
"shipmentDFF": [
{
"DeliveryInterfaceId": 300100169688190,
"_Global1": "Global1",
"_Global2": "Global2",
"_zBIADFF1": null,
"_BI_New_Deliveries_GBL": null,
"__FLEX_Context": null,
"__FLEX_Context_DisplayValue": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/shipmentDFF/300100169688190",
"name": "shipmentDFF",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/shipmentDFF/300100169688190",
"name": "shipmentDFF",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190",
"name": "shipments",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/shipmentDFF/300100169688190/lov/LVVO___FLEX_Context",
"name": "LVVO___FLEX_Context",
"kind": "collection"
}
]
}
],
"outerPackingUnits": [
{
"LPNInterfaceId": 300100169688193,
"PackingUnit": "PU1",
"TrackingNumber": null,
"MasterSerialNumber": null,
"SealNumber": null,
"PackingUnitType": "Pallet",
"FOBCode": null,
"Volume": null,
"VolumeUOM": null,
"GrossWeight": null,
"GrossWeightUOM": null,
"TareWeight": null,
"TareWeightUOM": null,
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11.343+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:11.594+00:00",
"innerPackingUnits": [
{
"LPNInterfaceId": 300100169688196,
"PackingUnit": "PU2",
"TrackingNumber": null,
"MasterSerialNumber": null,
"SealNumber": null,
"PackingUnitType": "BX54888",
"FOBCode": null,
"Volume": null,
"VolumeUOM": null,
"GrossWeight": null,
"GrossWeightUOM": null,
"TareWeight": null,
"TareWeightUOM": null,
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11.378+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:13.884+00:00",
"packedLines": [
{
"DeliveryDetailInterfaceId": 300100169688197,
"ShipmentLine": 3625811,
"Item": "INV-110",
"ItemRevision": "A",
"Subinventory": null,
"Locator": null,
"ShippedQuantity": 6,
"ShippedQuantityUOM": "Each",
"SecondaryShippedQuantity": null,
"SecondaryShippedQuantityUOM": null,
"NetWeight": null,
"GrossWeight": null,
"WeightUOM": null,
"Volume": null,
"VolumeUOM": null,
"LoadingSequence": null,
"TaxationCountry": null,
"TransactionBusinessCategory": null,
"DocumentFiscalClassification": null,
"UserDefinedFiscalClassificationCode": null,
"ProductFiscalClassification": null,
"IntendedUse": null,
"ProductCategory": null,
"LocationOfFinalDischargeCode": null,
"TaxClassificationCode": null,
"ProductTypeCode": null,
"FirstPartyTaxRegistrationNumber": null,
"ThirdPartyTaxRegistrationNumber": null,
"TaxInvoiceNumber": null,
"TaxInvoiceDate": null,
"AssessableValue": null,
"TaxExemptionCertificateNumber": null,
"TaxExemptionReasonCode": null,
"Order": null,
"SoldToCustomer": null,
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11.398+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:13.885+00:00",
"lots": [
{
"TransactionInterfaceId": 300100169688198,
"Lot": "YP-L001",
"Subinventory": null,
"Locator": null,
"Quantity": 4,
"SecondaryQuantity": null,
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11.419+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:13.887+00:00",
"serials": [
{
"TransactionInterfaceId": 300100169688199,
"FromSerialNumber": "SS0001",
"ToSerialNumber": "SS0004",
"Subinventory": "ABCSUB01",
"Locator": "ABC1.1.2",
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11.433+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:11.523+00:00",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031/child/serials/00020000000EACED00057708000110F08402E48700000006535330303031",
"name": "serials",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031/child/serials/00020000000EACED00057708000110F08402E48700000006535330303031",
"name": "serials",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031",
"name": "lots",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031/child/serials/00020000000EACED00057708000110F08402E48700000006535330303031/child/attributeDFF",
"name": "attributeDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031/child/serials/00020000000EACED00057708000110F08402E48700000006535330303031/child/errors",
"name": "errors",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031/child/serials/00020000000EACED00057708000110F08402E48700000006535330303031/child/standardDFF",
"name": "standardDFF",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031",
"name": "lots",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031",
"name": "lots",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197",
"name": "packedLines",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031/child/errors",
"name": "errors",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031/child/serials",
"name": "serials",
"kind": "collection"
}
]
},
{
"TransactionInterfaceId": 300100169688200,
"Lot": "YP-L002",
"Subinventory": null,
"Locator": null,
"Quantity": 2,
"SecondaryQuantity": null,
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11.435+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:13.936+00:00",
"serials": [
{
"TransactionInterfaceId": 300100169688201,
"FromSerialNumber": "SS0106",
"ToSerialNumber": "SS0107",
"Subinventory": "ABCSUB02",
"Locator": null,
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11.438+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:11.523+00:00",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032/child/serials/00020000000EACED00057708000110F08402E48900000006535330313036",
"name": "serials",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032/child/serials/00020000000EACED00057708000110F08402E48900000006535330313036",
"name": "serials",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032",
"name": "lots",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032/child/serials/00020000000EACED00057708000110F08402E48900000006535330313036/child/attributeDFF",
"name": "attributeDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032/child/serials/00020000000EACED00057708000110F08402E48900000006535330313036/child/errors",
"name": "errors",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032/child/serials/00020000000EACED00057708000110F08402E48900000006535330313036/child/standardDFF",
"name": "standardDFF",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032",
"name": "lots",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032",
"name": "lots",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197",
"name": "packedLines",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032/child/errors",
"name": "errors",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032/child/serials",
"name": "serials",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"https://servername/fscmRestApi/resources/version/shipmentTransactionRequests",
"name": "shipmentTransactionRequests",
"kind": "collection"
}
]
}
]
}
]
}
]
}
}
Get Shipment Transaction Request
Example URL
Use this resource URL format.
GET
/fscmRestApi/resources/11.13.18.05/shipmentTransactionRequests/{TransactionId} Example 1
curl -u username:password "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests?onlyData=true&finder=findByAttributes;Shipment=SHP_20200512_110810&fields=TransactionId,TransactionStatus;shipments:DeliveryInterfaceId,Shipment"
Example 1 Response
Here's an example of the response body in JSON format.
{
"items": [
{
"TransactionId": 300100195547958,
"TransactionStatus": "Awaiting processing",
"shipments": [
{
"DeliveryInterfaceId": 300100195547959,
"Shipment": "SHP_20200512_110810"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests",
"name": "shipmentTransactionRequests",
"kind": "collection"
}
]
}Example 2
curl -u username:password "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests?onlyData=true&finder=findByAttributes;Shipment=SHP_20200512_110810&expand=all"
Example 2 Response
Here's an example of the response body in JSON format.
{
"items": [
{
"TransactionId": 300100195547958,
"ActionCode": "CreateAndConfirmShipment",
"TransactionStatusCode": "AP",
"TransactionStatus": "Awaiting processing",
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2020-05-12T18:08:10+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2020-05-12T18:08:14.038+00:00",
"errors": [],
"shipments": [
{
"DeliveryInterfaceId": 300100195547959,
"Shipment": "SHP_20200512_110810",
"Description": null,
"ShipFromOrganizationCode": "V1",
"SoldToCustomerNumber": null,
"SoldToCustomer": null,
"ShipToPartySiteNumber": null,
"InitialShipDate": null,
"BillOfLading": null,
"GrossWeight": 1000,
"NetWeight": 500,
"WeightUOM": "Pounds",
"Volume": 2000,
"VolumeUOM": "Cubic foot",
"Equipment": null,
"EquipmentType": null,
"SealNumber": null,
"CarrierNumber": null,
"Carrier": "DHL",
"ModeOfTransportCode": "AIR",
"ServiceLevelCode": "2DA",
"Waybill": null,
"PackingSlip": null,
"ActualShipDate": null,
"PlannedDeliveryDate": null,
"FreightTermsCode": null,
"FreightTerms": null,
"FOBCode": null,
"FOBSiteNumber": 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,
"PlannedFlag": false,
"AutomaticallyPackFlag": null,
"EnableAutoshipFlag": null,
"ProrateWeightFlag": null,
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2020-05-12T18:08:10.162+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2020-05-12T18:08:15.209+00:00"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests",
"name": "shipmentTransactionRequests",
"kind": "collection"
}
]
}