POST Edi/Inbound/SaveGenericInbound
Use this method to create or update an inbound order.
Request Information
URI Parameters
None.
Body Parameters
SaveGenericInboundEdiRequest| 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 inbound material. |
string |
None. |
| InterchangeId |
The Interchange ID of the EDI transmission. |
string |
None. |
| AltCustomerOrderId |
An optional identifier (such as a PO#) that is also used to identify the order. |
string |
None. |
| EstimatedArrivalDate |
The date that the delivery is expected to arrive. |
date |
None. |
| PlantCode |
The customer's identifier for the Frontier location that will receive the delivery. |
string |
None. |
| PlantCostCenterId |
The Frontier Cost Center ID aligned with the customer's Plant Code. |
string |
None. |
| PlantStorageLocationId |
The customer's default Storage Location ID that is aligned with the customer's Plant Code. |
string |
None. |
| PlantGeoLocationIdNo |
Frontier's GeoLocationIdNo associated with the customer's Plant Code. |
integer |
None. |
| BookingVessel |
The name of the steamship that is transporting the material - applies only to ocean bookings. |
string |
None. |
| BookingVoyageNumber |
The maritime voyage ID for the steamship - applies only to ocean bookings. |
string |
None. |
| PortOfUnloading |
The name of the port where the steamship will arrive with the inbound container. |
string |
None. |
| ShippingType |
The Element 91 value indicating the shipment mode for the inbound. |
string |
None. |
| CarrierSCAC |
The Standard Carrier Alpha Code (SCAC) for the delivering carrier. |
string |
None. |
| EquipmentInitial |
The alpha portion of the equipment that will deliver the inbound. |
string |
None. |
| EquipmentNumber |
The numeric portion of the equipment that will deliver the inbound. |
string |
None. |
| LoadingInstructionNotes |
The Loading Instructions for the inbound. |
string |
None. |
| BolNotes |
The BOL Notes for the inbound. |
string |
None. |
| EquipmentLabel |
Read-only string with the full equipment label. |
string |
None. |
| SealNumbers |
Lists the seal numbers used to seal the trailer, container, or railcar. |
Collection of string |
None. |
| LineItems |
A collection of details pertaining the inventory items that will be received. |
Collection of GenericInboundLineItem |
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",
"InterchangeId": "sample string 5",
"AltCustomerOrderId": "SAMPLE STRING 6",
"EstimatedArrivalDate": "2025-11-05T15:04:56.8821844-06:00",
"PlantCode": "SAMPLE STRING 7",
"PlantCostCenterId": "SAMPLE STRING 8",
"PlantStorageLocationId": "SAMPLE STRING 9",
"PlantGeoLocationIdNo": 1,
"BookingVessel": "SAMPLE STRING 10",
"BookingVoyageNumber": "SAMPLE STRING 11",
"PortOfUnloading": "SAMPLE STRING 12",
"ShippingType": "SAMPLE STRING 13",
"CarrierSCAC": "SAMPLE STRING 14",
"EquipmentInitial": "SAMPLE STRING 15",
"EquipmentNumber": "SAMPLE STRING 16",
"LoadingInstructionNotes": "sample string 17",
"BolNotes": "sample string 18",
"EquipmentLabel": "SAMPLE STRING 15SAMPLE STRING 16",
"SealNumbers": [
"sample string 1",
"sample string 2"
],
"LineItems": [
{
"CustomerOrderLineItemId": "SAMPLE STRING 1",
"AltCustomerOrderLineItemId": "SAMPLE STRING 2",
"PackageQuantity": 3.0,
"PackageUOM": "SAMPLE STRING 4",
"ProductAliasCode": "SAMPLE STRING 5",
"ProductAliasDescription": "SAMPLE STRING 6",
"CustomerId": "SAMPLE STRING 7",
"Lot": "SAMPLE STRING 8",
"NetWeight": 9.0,
"NetWeightUOM": "SAMPLE STRING 10"
},
{
"CustomerOrderLineItemId": "SAMPLE STRING 1",
"AltCustomerOrderLineItemId": "SAMPLE STRING 2",
"PackageQuantity": 3.0,
"PackageUOM": "SAMPLE STRING 4",
"ProductAliasCode": "SAMPLE STRING 5",
"ProductAliasDescription": "SAMPLE STRING 6",
"CustomerId": "SAMPLE STRING 7",
"Lot": "SAMPLE STRING 8",
"NetWeight": 9.0,
"NetWeightUOM": "SAMPLE STRING 10"
}
]
}
text/html
{"PartnerChannel":1,"CompanyCode":"SAMPLE STRING 1","CustomerId":"SAMPLE STRING 2","CustomerOrderId":"SAMPLE STRING 3","CustomerReference":"SAMPLE STRING 4","InterchangeId":"sample string 5","AltCustomerOrderId":"SAMPLE STRING 6","EstimatedArrivalDate":"2025-11-05T15:04:56.8821844-06:00","PlantCode":"SAMPLE STRING 7","PlantCostCenterId":"SAMPLE STRING 8","PlantStorageLocationId":"SAMPLE STRING 9","PlantGeoLocationIdNo":1,"BookingVessel":"SAMPLE STRING 10","BookingVoyageNumber":"SAMPLE STRING 11","PortOfUnloading":"SAMPLE STRING 12","ShippingType":"SAMPLE STRING 13","CarrierSCAC":"SAMPLE STRING 14","EquipmentInitial":"SAMPLE STRING 15","EquipmentNumber":"SAMPLE STRING 16","LoadingInstructionNotes":"sample string 17","BolNotes":"sample string 18","EquipmentLabel":"SAMPLE STRING 15SAMPLE STRING 16","SealNumbers":["sample string 1","sample string 2"],"LineItems":[{"CustomerOrderLineItemId":"SAMPLE STRING 1","AltCustomerOrderLineItemId":"SAMPLE STRING 2","PackageQuantity":3.0,"PackageUOM":"SAMPLE STRING 4","ProductAliasCode":"SAMPLE STRING 5","ProductAliasDescription":"SAMPLE STRING 6","CustomerId":"SAMPLE STRING 7","Lot":"SAMPLE STRING 8","NetWeight":9.0,"NetWeightUOM":"SAMPLE STRING 10"},{"CustomerOrderLineItemId":"SAMPLE STRING 1","AltCustomerOrderLineItemId":"SAMPLE STRING 2","PackageQuantity":3.0,"PackageUOM":"SAMPLE STRING 4","ProductAliasCode":"SAMPLE STRING 5","ProductAliasDescription":"SAMPLE STRING 6","CustomerId":"SAMPLE STRING 7","Lot":"SAMPLE STRING 8","NetWeight":9.0,"NetWeightUOM":"SAMPLE STRING 10"}]}
Response Information
Resource Description
SaveGenericInboundResponse| 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}