GET api/GreenShipments?originAddress={originAddress}&destinationAddress={destinationAddress}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
originAddress

string

Required

destinationAddress

string

Required

Body Parameters

GreenShipment
NameDescriptionTypeAdditional information
GR_SH_ID

integer

None.

MemberCode

integer

None.

Carrier

string

None.

ContainerNo

string

None.

ContainerSize

string

None.

Vessel

string

None.

Voyage

string

None.

VesselIMO

string

None.

BLType

string

None.

OriginLocCode

string

None.

LoadPortLocCode

string

None.

TransPortLocCode

string

None.

DischargePortLocCode

string

None.

InlandCYRampCode

string

None.

DestLocCode

string

None.

Origin

string

None.

LoadPort

string

None.

TransPort

string

None.

DischargePort

string

None.

InlandCYRamp

string

None.

Destination

string

None.

OriginToLoadPortTranMode

string

None.

LoadPortToTransPortTranMode

string

None.

TransPortToDischargePortTranMode

string

None.

DischargePortToInlandRampTranMode

string

None.

InlandRampToDestTranMode

string

None.

CO2EmissionFlag

string

None.

CO2Emission_in_grams

decimal number

None.

InsertDate

date

None.

Emission_Cacl_Date

date

None.

SCAC

string

None.

FailReason

string

None.

Emission_Cacl_Basis

string

None.

LoadType

string

None.

NoOfCartons

integer

None.

TotalWeight

decimal number

None.

TotalVolume

decimal number

None.

NOR

string

None.

BLNo

string

None.

POLDate

date

None.

TranshipVesselName

string

None.

Comment1

string

None.

Comment2

string

None.

OriginAddress

string

None.

OriginZIPcode

string

None.

DestinationAddress

string

None.

DestinationZIPcode

string

None.

Request Formats

application/json, text/json

Sample:
{
  "GR_SH_ID": 1,
  "MemberCode": 2,
  "Carrier": "sample string 3",
  "ContainerNo": "sample string 4",
  "ContainerSize": "sample string 5",
  "Vessel": "sample string 6",
  "Voyage": "sample string 7",
  "VesselIMO": "sample string 8",
  "BLType": "sample string 9",
  "OriginLocCode": "sample string 10",
  "LoadPortLocCode": "sample string 11",
  "TransPortLocCode": "sample string 12",
  "DischargePortLocCode": "sample string 13",
  "InlandCYRampCode": "sample string 14",
  "DestLocCode": "sample string 15",
  "Origin": "sample string 16",
  "LoadPort": "sample string 17",
  "TransPort": "sample string 18",
  "DischargePort": "sample string 19",
  "InlandCYRamp": "sample string 20",
  "Destination": "sample string 21",
  "OriginToLoadPortTranMode": "sample string 22",
  "LoadPortToTransPortTranMode": "sample string 23",
  "TransPortToDischargePortTranMode": "sample string 24",
  "DischargePortToInlandRampTranMode": "sample string 25",
  "InlandRampToDestTranMode": "sample string 26",
  "CO2EmissionFlag": "sample string 27",
  "CO2Emission_in_grams": 28.0,
  "InsertDate": "2024-10-31T03:37:04.3742886+00:00",
  "Emission_Cacl_Date": "2024-10-31T03:37:04.3742886+00:00",
  "SCAC": "sample string 31",
  "FailReason": "sample string 32",
  "Emission_Cacl_Basis": "sample string 33",
  "LoadType": "sample string 34",
  "NoOfCartons": 35,
  "TotalWeight": 36.0,
  "TotalVolume": 37.0,
  "NOR": "sample string 38",
  "BLNo": "sample string 39",
  "POLDate": "2024-10-31T03:37:04.3742886+00:00",
  "TranshipVesselName": "sample string 40",
  "Comment1": "sample string 41",
  "Comment2": "sample string 42",
  "OriginAddress": "sample string 43",
  "OriginZIPcode": "sample string 44",
  "DestinationAddress": "sample string 45",
  "DestinationZIPcode": "sample string 46"
}

application/xml, text/xml

Sample:
<GreenShipment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GeminiShippers.Common.RESTfulGreenable">
  <BLNo>sample string 39</BLNo>
  <BLType>sample string 9</BLType>
  <CO2EmissionFlag>sample string 27</CO2EmissionFlag>
  <CO2Emission_in_grams>28</CO2Emission_in_grams>
  <Carrier>sample string 3</Carrier>
  <Comment1>sample string 41</Comment1>
  <Comment2>sample string 42</Comment2>
  <ContainerNo>sample string 4</ContainerNo>
  <ContainerSize>sample string 5</ContainerSize>
  <DestLocCode>sample string 15</DestLocCode>
  <Destination>sample string 21</Destination>
  <DestinationAddress>sample string 45</DestinationAddress>
  <DestinationZIPcode>sample string 46</DestinationZIPcode>
  <DischargePort>sample string 19</DischargePort>
  <DischargePortLocCode>sample string 13</DischargePortLocCode>
  <DischargePortToInlandRampTranMode>sample string 25</DischargePortToInlandRampTranMode>
  <Emission_Cacl_Basis>sample string 33</Emission_Cacl_Basis>
  <Emission_Cacl_Date>2024-10-31T03:37:04.3742886+00:00</Emission_Cacl_Date>
  <FailReason>sample string 32</FailReason>
  <GR_SH_ID>1</GR_SH_ID>
  <InlandCYRamp>sample string 20</InlandCYRamp>
  <InlandCYRampCode>sample string 14</InlandCYRampCode>
  <InlandRampToDestTranMode>sample string 26</InlandRampToDestTranMode>
  <InsertDate>2024-10-31T03:37:04.3742886+00:00</InsertDate>
  <LoadPort>sample string 17</LoadPort>
  <LoadPortLocCode>sample string 11</LoadPortLocCode>
  <LoadPortToTransPortTranMode>sample string 23</LoadPortToTransPortTranMode>
  <LoadType>sample string 34</LoadType>
  <MemberCode>2</MemberCode>
  <NOR>sample string 38</NOR>
  <NoOfCartons>35</NoOfCartons>
  <Origin>sample string 16</Origin>
  <OriginAddress>sample string 43</OriginAddress>
  <OriginLocCode>sample string 10</OriginLocCode>
  <OriginToLoadPortTranMode>sample string 22</OriginToLoadPortTranMode>
  <OriginZIPcode>sample string 44</OriginZIPcode>
  <POLDate>2024-10-31T03:37:04.3742886+00:00</POLDate>
  <SCAC>sample string 31</SCAC>
  <TotalVolume>37</TotalVolume>
  <TotalWeight>36</TotalWeight>
  <TransPort>sample string 18</TransPort>
  <TransPortLocCode>sample string 12</TransPortLocCode>
  <TransPortToDischargePortTranMode>sample string 24</TransPortToDischargePortTranMode>
  <TranshipVesselName>sample string 40</TranshipVesselName>
  <Vessel>sample string 6</Vessel>
  <VesselIMO>sample string 8</VesselIMO>
  <Voyage>sample string 7</Voyage>
</GreenShipment>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

decimal number

Response Formats

application/json, text/json

Sample:
1.1

application/xml, text/xml

Sample:
<double xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1.1</double>