POST api/Shipments/Save

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Shipment_ID	globally unique identifier	None.
Booking_ID	globally unique identifier	None.
Shipment_NO	string	None.
Direction_ID	integer	None.
TransportationMode_ID	integer	None.
ExecutedPlace	string	None.
Status_ID	integer	None.
HouseBill_NO	string	None.
MasterBill_NO	string	None.
Carrier_ID	integer	None.
Booking_NO	string	None.
CarrierBooking_NO	string	None.
PlaneVesselName	string	None.
FlightVoyage_NO	string	None.
ClientName	string	None.
POC_ID	integer	None.
AWB_ID	integer	None.
LocationTypes	Collection of ShipmentLocationTypeInputModel	None.
BillToCompany_ID	integer	None.
BillToCarrier_ID	integer	None.
CustomFieldsWithValues	Collection of CustomFieldOutputModel	None.

Request Formats

application/json, text/json

Sample:

{
  "Shipment_ID": "a8cc99f6-9b7f-4d06-9d7e-d7b17812bde3",
  "Booking_ID": "25a4f36a-e172-4559-b7a6-b9f4cc110769",
  "Shipment_NO": "sample string 3",
  "Direction_ID": 4,
  "TransportationMode_ID": 5,
  "ExecutedPlace": "sample string 6",
  "Status_ID": 7,
  "HouseBill_NO": "sample string 8",
  "MasterBill_NO": "sample string 9",
  "Carrier_ID": 1,
  "Booking_NO": "sample string 10",
  "CarrierBooking_NO": "sample string 11",
  "PlaneVesselName": "sample string 12",
  "FlightVoyage_NO": "sample string 13",
  "ClientName": "sample string 14",
  "POC_ID": 1,
  "AWB_ID": 1,
  "LocationTypes": [
    {
      "Location_ID": 1,
      "Company_ID": 1,
      "IFS_LocationType_ID": 1,
      "LocationType_ID": 2,
      "Site_ID": 1,
      "POC_ID": 1,
      "Tenant_ID": 3,
      "Branch_ID": 4
    },
    {
      "Location_ID": 1,
      "Company_ID": 1,
      "IFS_LocationType_ID": 1,
      "LocationType_ID": 2,
      "Site_ID": 1,
      "POC_ID": 1,
      "Tenant_ID": 3,
      "Branch_ID": 4
    }
  ],
  "BillToCompany_ID": 1,
  "BillToCarrier_ID": 1,
  "CustomFieldsWithValues": [
    {
      "FormFieldId": 1,
      "FormFieldName": "sample string 2",
      "FormFieldDisplayName": "sample string 3",
      "FormFieldTypeId": 4,
      "FormFieldAttributeId": 1,
      "FormFieldAttributeValue": "sample string 5"
    },
    {
      "FormFieldId": 1,
      "FormFieldName": "sample string 2",
      "FormFieldDisplayName": "sample string 3",
      "FormFieldTypeId": 4,
      "FormFieldAttributeId": 1,
      "FormFieldAttributeValue": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<SaveShipmentInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cyzerg.Model.WMS.InputOutputModels">
  <AWB_ID>1</AWB_ID>
  <BillToCarrier_ID>1</BillToCarrier_ID>
  <BillToCompany_ID>1</BillToCompany_ID>
  <Booking_ID>25a4f36a-e172-4559-b7a6-b9f4cc110769</Booking_ID>
  <Booking_NO>sample string 10</Booking_NO>
  <CarrierBooking_NO>sample string 11</CarrierBooking_NO>
  <Carrier_ID>1</Carrier_ID>
  <ClientName>sample string 14</ClientName>
  <CustomFieldsWithValues>
    <CustomFieldOutputModel>
      <FormFieldAttributeId>1</FormFieldAttributeId>
      <FormFieldAttributeValue>sample string 5</FormFieldAttributeValue>
      <FormFieldDisplayName>sample string 3</FormFieldDisplayName>
      <FormFieldId>1</FormFieldId>
      <FormFieldName>sample string 2</FormFieldName>
      <FormFieldTypeId>4</FormFieldTypeId>
    </CustomFieldOutputModel>
    <CustomFieldOutputModel>
      <FormFieldAttributeId>1</FormFieldAttributeId>
      <FormFieldAttributeValue>sample string 5</FormFieldAttributeValue>
      <FormFieldDisplayName>sample string 3</FormFieldDisplayName>
      <FormFieldId>1</FormFieldId>
      <FormFieldName>sample string 2</FormFieldName>
      <FormFieldTypeId>4</FormFieldTypeId>
    </CustomFieldOutputModel>
  </CustomFieldsWithValues>
  <Direction_ID>4</Direction_ID>
  <ExecutedPlace>sample string 6</ExecutedPlace>
  <FlightVoyage_NO>sample string 13</FlightVoyage_NO>
  <HouseBill_NO>sample string 8</HouseBill_NO>
  <LocationTypes>
    <ShipmentLocationTypeInputModel>
      <Branch_ID>4</Branch_ID>
      <Company_ID>1</Company_ID>
      <IFS_LocationType_ID>1</IFS_LocationType_ID>
      <LocationType_ID>2</LocationType_ID>
      <Location_ID>1</Location_ID>
      <POC_ID>1</POC_ID>
      <Site_ID>1</Site_ID>
      <Tenant_ID>3</Tenant_ID>
    </ShipmentLocationTypeInputModel>
    <ShipmentLocationTypeInputModel>
      <Branch_ID>4</Branch_ID>
      <Company_ID>1</Company_ID>
      <IFS_LocationType_ID>1</IFS_LocationType_ID>
      <LocationType_ID>2</LocationType_ID>
      <Location_ID>1</Location_ID>
      <POC_ID>1</POC_ID>
      <Site_ID>1</Site_ID>
      <Tenant_ID>3</Tenant_ID>
    </ShipmentLocationTypeInputModel>
  </LocationTypes>
  <MasterBill_NO>sample string 9</MasterBill_NO>
  <POC_ID>1</POC_ID>
  <PlaneVesselName>sample string 12</PlaneVesselName>
  <Shipment_ID>a8cc99f6-9b7f-4d06-9d7e-d7b17812bde3</Shipment_ID>
  <Shipment_NO>sample string 3</Shipment_NO>
  <Status_ID>7</Status_ID>
  <TransportationMode_ID>5</TransportationMode_ID>
</SaveShipmentInputModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

text/html

Sample:

{"Shipment_ID":"a8cc99f6-9b7f-4d06-9d7e-d7b17812bde3","Booking_ID":"25a4f36a-e172-4559-b7a6-b9f4cc110769","Shipment_NO":"sample string 3","Direction_ID":4,"TransportationMode_ID":5,"ExecutedPlace":"sample string 6","Status_ID":7,"HouseBill_NO":"sample string 8","MasterBill_NO":"sample string 9","Carrier_ID":1,"Booking_NO":"sample string 10","CarrierBooking_NO":"sample string 11","PlaneVesselName":"sample string 12","FlightVoyage_NO":"sample string 13","ClientName":"sample string 14","POC_ID":1,"AWB_ID":1,"LocationTypes":[{"Location_ID":1,"Company_ID":1,"IFS_LocationType_ID":1,"LocationType_ID":2,"Site_ID":1,"POC_ID":1,"Tenant_ID":3,"Branch_ID":4},{"Location_ID":1,"Company_ID":1,"IFS_LocationType_ID":1,"LocationType_ID":2,"Site_ID":1,"POC_ID":1,"Tenant_ID":3,"Branch_ID":4}],"BillToCompany_ID":1,"BillToCarrier_ID":1,"CustomFieldsWithValues":[{"FormFieldId":1,"FormFieldName":"sample string 2","FormFieldDisplayName":"sample string 3","FormFieldTypeId":4,"FormFieldAttributeId":1,"FormFieldAttributeValue":"sample string 5"},{"FormFieldId":1,"FormFieldName":"sample string 2","FormFieldDisplayName":"sample string 3","FormFieldTypeId":4,"FormFieldAttributeId":1,"FormFieldAttributeValue":"sample string 5"}]}

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, text/html

Sample:

Sample not available.