POST Edi/Inbound/SaveGenericOutbound
Use this method to create or update an outbound order.
Request Information
URI Parameters
None.
Body Parameters
SaveGenericOutboundEdiRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| PartnerChannel |
Identifies the EDI channel over which the instruction was received. |
PartnerChannel |
None. |
| CompanyCode |
The two-digit ID of the Frontier business entity that will execute the transaction. |
string |
None. |
| CustomerId |
The customer identifier that is the source of the EDI transaction. |
string |
None. |
| CustomerOrderId |
The customer's unique identifier for the order. |
string |
None. |
| CustomerReference |
An optional inventory-specific lookup value for the material to be shipped. |
string |
None. |
| EdiInterchangeId |
The Interchange ID of the EDI transmission. |
string |
None. |
| OrderStatusCode |
The single-digit element 473 value indicating the purpose of the EDI instruction. |
string |
None. |
| OrderStatus |
A read-only enum that interprets the OrderStatusCode. |
OrderStatus |
None. |
| PlantCode |
The customer's identifier for the Frontier location that will ship the delivery. |
string |
None. |
| PlantCostCenterId |
The Frontier Cost Center ID aligned with the customer's Plant Code. |
string |
None. |
| PlantGeoLocationIdNo |
Frontier's GeoLocationIdNo associated with the customer's Plant Code. |
integer |
None. |
| PlantStorageLocationId |
The customer's default Storage Location ID that is aligned with the customer's Plant Code. |
string |
None. |
| PlantBuildingNumber |
The building number assigned to the plant in the customer's system. |
string |
None. |
| ShipToCode |
The customer's ship-to ID for the destination. |
string |
None. |
| ShipToName |
The name of the destination company for the shipment. |
string |
None. |
| ShipToName2 |
Additional name of the destination company for the shipment. |
string |
None. |
| ShipToName3 |
Additional name of the destination company for the shipment. |
string |
None. |
| ShipToName4 |
Additional name of the destination company for the shipment. |
string |
None. |
| ShipToAddress |
The street address of the destination company for the shipment. |
string |
None. |
| ShipToAddress2 |
Additional street address of the destination company for the shipment. |
string |
None. |
| ShipToAddress3 |
Additional street address of the destination company for the shipment. |
string |
None. |
| ShipToCity |
The city name of the destination company for the shipment. |
string |
None. |
| ShipToPostalCode |
The postal code of the destination company for the shipment. |
string |
None. |
| ShipToCountryCode |
The country code of the destination company for the shipment. |
string |
None. |
| ShipToState |
The state or province of the destination company for the shipment. |
string |
None. |
| BookingId |
The ID of the maritime booking for the shipment. |
string |
None. |
| BookingContainerCount |
The total number of containers on the maritime booking. |
integer |
None. |
| BookingContainerType |
A string value used to indicate the type of container that will be used for the booking. |
string |
None. |
| BookingVesselName |
The name of the steamship that is transporting the material - applies only to ocean bookings. |
string |
None. |
| VoyageNumber |
The maritime voyage ID for the steamship - applies only to ocean bookings. |
string |
None. |
| PortOfLoading |
The port where loaded containers will be delivered for export - applies only to ocean bookings. |
string |
None. |
| DeliveryDateTime |
The delivery date for the shipment. |
date |
None. |
| EstimatedDeliveryDateTime |
The estimated delivery date for the shipment. |
date |
None. |
| ScheduledPickupDateTime |
The date the shipment is scheduled to be picked up from the warehouse. |
date |
None. |
| RequestedPickupDateTime |
The date the shipment is desired to be picked up from the warehouse. |
date |
None. |
| BookingEqCutoffDateTime |
The date when all ocean containers must be turned into the originating port - applies only to ocean bookings. |
date |
None. |
| BookingDocCutoffDateTime |
The date when documentation must be returned to the Freight Forwarded for the shipment - applies only to ocean bookings. |
date |
None. |
| ModeOfTransport |
A Frontier-specific string (such as "TL", "LTL", "Pkg. Container", etc.) that indicates what kind of shipment is being requested. |
string |
None. |
| LoadType |
A supplemental value used in conjuntion with ModeOfTransport to fully describe the type of shipment. |
string |
None. |
| FreightTerms |
The freight terms (typically "PP") applied to the shipment. |
string |
None. |
| CarrierSCAC |
The Standard Carrier Alpha Code (SCAC) for the delivering carrier. |
string |
None. |
| BolNotes |
Notes to print on the BOL. |
string |
None. |
| CarrierNotes |
Notes for the delivering carrier to observe. |
string |
None. |
| LoadingInstructions |
Loading instructions for the warehouse. |
string |
None. |
| ShippingMarks |
Shipping Marks for the warehouse. |
string |
None. |
| OutboundLineItems |
A collection of details pertaining the inventory items that will be shipped. |
Collection of GenericOutboundLineItem |
None. |
Request Formats
application/json, text/json
{
"PartnerChannel": 1,
"CompanyCode": "sample string 1",
"CustomerId": "SAMPLE STRING 2",
"CustomerOrderId": "sample string 3",
"CustomerReference": "sample string 4",
"EdiInterchangeId": "sample string 5",
"OrderStatusCode": "sample string 6",
"OrderStatus": 0,
"PlantCode": "sample string 7",
"PlantCostCenterId": "sample string 8",
"PlantGeoLocationIdNo": 1,
"PlantStorageLocationId": "sample string 9",
"PlantBuildingNumber": "sample string 10",
"ShipToCode": "sample string 11",
"ShipToName": "sample string 12",
"ShipToName2": "sample string 13",
"ShipToName3": "sample string 14",
"ShipToName4": "sample string 15",
"ShipToAddress": "sample string 16",
"ShipToAddress2": "sample string 17",
"ShipToAddress3": "sample string 18",
"ShipToCity": "sample string 19",
"ShipToPostalCode": "sample string 20",
"ShipToCountryCode": "sample string 21",
"ShipToState": "sample string 22",
"BookingId": "sample string 23",
"BookingContainerCount": 1,
"BookingContainerType": "sample string 24",
"BookingVesselName": "sample string 25",
"VoyageNumber": "sample string 26",
"PortOfLoading": "sample string 27",
"DeliveryDateTime": "2025-06-18T09:56:06.068086-05:00",
"EstimatedDeliveryDateTime": "2025-06-18T09:56:06.068086-05:00",
"ScheduledPickupDateTime": "2025-06-18T09:56:06.068086-05:00",
"RequestedPickupDateTime": "2025-06-18T09:56:06.068086-05:00",
"BookingEqCutoffDateTime": "2025-06-18T09:56:06.068086-05:00",
"BookingDocCutoffDateTime": "2025-06-18T09:56:06.068086-05:00",
"ModeOfTransport": "sample string 28",
"LoadType": "sample string 29",
"FreightTerms": "sample string 30",
"CarrierSCAC": "sample string 31",
"BolNotes": "sample string 32",
"CarrierNotes": "sample string 33",
"LoadingInstructions": "sample string 34",
"ShippingMarks": "sample string 35",
"OutboundLineItems": [
{
"CustomerOrderLineItemId": "SAMPLE STRING 1",
"SalesOrderId": "sample string 2",
"PurchaseOrderId": "sample string 3",
"AltPurchaseOrderId": "sample string 4",
"PackageQuantity": 5.0,
"PackageUOM": "SAMPLE STRING 6",
"PackageType": null,
"ProductAliasCode": "SAMPLE STRING 7",
"ProductAliasDescription": "SAMPLE STRING 8",
"ProductIdNo": 1,
"Lot": "SAMPLE STRING 9",
"NetWeight": 10.0,
"NetWeightUOM": "SAMPLE STRING 11",
"GrossWeight": 1.0,
"GrossWeightUOM": "sample string 12",
"CustomerId": "sample string 13",
"ValueCenterId": "sample string 14",
"TransportTypeId": "sample string 15",
"TransportTypeDescription": "sample string 16",
"ProductAliasCode2": "sample string 17",
"ProductAliasDescription2": "sample string 18",
"ProductIdNo2": 1
},
{
"CustomerOrderLineItemId": "SAMPLE STRING 1",
"SalesOrderId": "sample string 2",
"PurchaseOrderId": "sample string 3",
"AltPurchaseOrderId": "sample string 4",
"PackageQuantity": 5.0,
"PackageUOM": "SAMPLE STRING 6",
"PackageType": null,
"ProductAliasCode": "SAMPLE STRING 7",
"ProductAliasDescription": "SAMPLE STRING 8",
"ProductIdNo": 1,
"Lot": "SAMPLE STRING 9",
"NetWeight": 10.0,
"NetWeightUOM": "SAMPLE STRING 11",
"GrossWeight": 1.0,
"GrossWeightUOM": "sample string 12",
"CustomerId": "sample string 13",
"ValueCenterId": "sample string 14",
"TransportTypeId": "sample string 15",
"TransportTypeDescription": "sample string 16",
"ProductAliasCode2": "sample string 17",
"ProductAliasDescription2": "sample string 18",
"ProductIdNo2": 1
}
]
}
text/html
{"PartnerChannel":1,"CompanyCode":"sample string 1","CustomerId":"SAMPLE STRING 2","CustomerOrderId":"sample string 3","CustomerReference":"sample string 4","EdiInterchangeId":"sample string 5","OrderStatusCode":"sample string 6","OrderStatus":0,"PlantCode":"sample string 7","PlantCostCenterId":"sample string 8","PlantGeoLocationIdNo":1,"PlantStorageLocationId":"sample string 9","PlantBuildingNumber":"sample string 10","ShipToCode":"sample string 11","ShipToName":"sample string 12","ShipToName2":"sample string 13","ShipToName3":"sample string 14","ShipToName4":"sample string 15","ShipToAddress":"sample string 16","ShipToAddress2":"sample string 17","ShipToAddress3":"sample string 18","ShipToCity":"sample string 19","ShipToPostalCode":"sample string 20","ShipToCountryCode":"sample string 21","ShipToState":"sample string 22","BookingId":"sample string 23","BookingContainerCount":1,"BookingContainerType":"sample string 24","BookingVesselName":"sample string 25","VoyageNumber":"sample string 26","PortOfLoading":"sample string 27","DeliveryDateTime":"2025-06-18T09:56:06.068086-05:00","EstimatedDeliveryDateTime":"2025-06-18T09:56:06.068086-05:00","ScheduledPickupDateTime":"2025-06-18T09:56:06.068086-05:00","RequestedPickupDateTime":"2025-06-18T09:56:06.068086-05:00","BookingEqCutoffDateTime":"2025-06-18T09:56:06.068086-05:00","BookingDocCutoffDateTime":"2025-06-18T09:56:06.068086-05:00","ModeOfTransport":"sample string 28","LoadType":"sample string 29","FreightTerms":"sample string 30","CarrierSCAC":"sample string 31","BolNotes":"sample string 32","CarrierNotes":"sample string 33","LoadingInstructions":"sample string 34","ShippingMarks":"sample string 35","OutboundLineItems":[{"CustomerOrderLineItemId":"SAMPLE STRING 1","SalesOrderId":"sample string 2","PurchaseOrderId":"sample string 3","AltPurchaseOrderId":"sample string 4","PackageQuantity":5.0,"PackageUOM":"SAMPLE STRING 6","PackageType":null,"ProductAliasCode":"SAMPLE STRING 7","ProductAliasDescription":"SAMPLE STRING 8","ProductIdNo":1,"Lot":"SAMPLE STRING 9","NetWeight":10.0,"NetWeightUOM":"SAMPLE STRING 11","GrossWeight":1.0,"GrossWeightUOM":"sample string 12","CustomerId":"sample string 13","ValueCenterId":"sample string 14","TransportTypeId":"sample string 15","TransportTypeDescription":"sample string 16","ProductAliasCode2":"sample string 17","ProductAliasDescription2":"sample string 18","ProductIdNo2":1},{"CustomerOrderLineItemId":"SAMPLE STRING 1","SalesOrderId":"sample string 2","PurchaseOrderId":"sample string 3","AltPurchaseOrderId":"sample string 4","PackageQuantity":5.0,"PackageUOM":"SAMPLE STRING 6","PackageType":null,"ProductAliasCode":"SAMPLE STRING 7","ProductAliasDescription":"SAMPLE STRING 8","ProductIdNo":1,"Lot":"SAMPLE STRING 9","NetWeight":10.0,"NetWeightUOM":"SAMPLE STRING 11","GrossWeight":1.0,"GrossWeightUOM":"sample string 12","CustomerId":"sample string 13","ValueCenterId":"sample string 14","TransportTypeId":"sample string 15","TransportTypeDescription":"sample string 16","ProductAliasCode2":"sample string 17","ProductAliasDescription2":"sample string 18","ProductIdNo2":1}]}
Response Information
Resource Description
SaveGenericOutboundResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful |
Indicates if the transaction was successful or not. |
boolean |
None. |
| ReturnedMessages |
Contains a list of Informational, Warning, and/or Error messages regarding the outcome of the transaction. |
Collection of ReturnedMessage |
None. |
Response Formats
application/json, text/json
{
"IsSuccessful": true,
"ReturnedMessages": null
}
text/html
{"IsSuccessful":true,"ReturnedMessages":null}