PUT api/v1/MAWB/{MawbID}/HAWB/{id}

Update HAWB

Request Information

Parameters

NameDescriptionAdditional information
id 
HawbID

Define this parameter in the request URI.
HAWB_POST_DTO 
Hawb dto

Define this parameter in the request body.
MawbID 
No documentation available.

Define this parameter in the request URI.

Request body formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample: 
{
  "HawbNumber": "sample string 1",
  "NumberOfPieces": 2,
  "GrossWeight": {
    "Value": 1.0,
    "UOM": "sample string 2"
  },
  "Locations": {
    "PortOfOrigin": {
      "Code": "sample string 1",
      "Name": "sample string 1 (sample string 2)"
    },
    "PortOfDestination": {
      "Code": "sample string 1",
      "Name": "sample string 1 (sample string 2)"
    }
  },
  "Commodity": "sample string 3",
  "PrintCommodity": "sample string 4",
  "SLAC": 1,
  "Parties": {
    "Shipper": {
      "TheId": 1,
      "WinId": 1,
      "AccountNumber": "sample string 1",
      "Name": "sample string 2",
      "Phone": "sample string 3",
      "Fax": "sample string 4",
      "Email": "sample string 5",
      "Address": {
        "Line1": "sample string 1",
        "Line2": "sample string 2",
        "Place": "sample string 3",
        "City": {
          "Code": "sample string 1",
          "Name": "sample string 2"
        },
        "PostalCode": "sample string 4",
        "StateProvince": "sample string 5",
        "Country": {
          "Code": "sample string 1",
          "Name": "sample string 1 - sample string 2"
        }
      },
      "PrintPartyDetails": "sample string 6"
    },
    "Consignee": {
      "TheId": 1,
      "WinId": 1,
      "AccountNumber": "sample string 1",
      "Name": "sample string 2",
      "Phone": "sample string 3",
      "Fax": "sample string 4",
      "Email": "sample string 5",
      "Address": {
        "Line1": "sample string 1",
        "Line2": "sample string 2",
        "Place": "sample string 3",
        "City": {
          "Code": "sample string 1",
          "Name": "sample string 2"
        },
        "PostalCode": "sample string 4",
        "StateProvince": "sample string 5",
        "Country": {
          "Code": "sample string 1",
          "Name": "sample string 1 - sample string 2"
        }
      },
      "PrintPartyDetails": "sample string 6"
    }
  },
  "Charges": {
    "Currency": {
      "Code": "sample string 1"
    },
    "WeightOrValuation": "sample string 1",
    "Other": "sample string 2",
    "ValuesForCarriage": 1.0,
    "ValuesForCustom": 1.0,
    "ValuesForInsurance": 1.0
  },
  "Cargo": {
    "HSCode": [
      {
        "Code": "sample string 1"
      },
      {
        "Code": "sample string 1"
      },
      {
        "Code": "sample string 1"
      }
    ],
    "SpecialHandling": [
      {
        "Code": "sample string 1"
      },
      {
        "Code": "sample string 1"
      },
      {
        "Code": "sample string 1"
      }
    ],
    "GoodsDescription": "sample string 1"
  },
  "Optional": {
    "OtherCustoms": [
      {
        "TheID": 1,
        "Country": {
          "Code": "sample string 1",
          "Name": "sample string 1 - sample string 2"
        },
        "InformationIdentifier": "sample string 1",
        "ControlIdentifier": "sample string 2",
        "SupplementControlInformation": "sample string 3"
      },
      {
        "TheID": 1,
        "Country": {
          "Code": "sample string 1",
          "Name": "sample string 1 - sample string 2"
        },
        "InformationIdentifier": "sample string 1",
        "ControlIdentifier": "sample string 2",
        "SupplementControlInformation": "sample string 3"
      },
      {
        "TheID": 1,
        "Country": {
          "Code": "sample string 1",
          "Name": "sample string 1 - sample string 2"
        },
        "InformationIdentifier": "sample string 1",
        "ControlIdentifier": "sample string 2",
        "SupplementControlInformation": "sample string 3"
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<HAWB_POST_DTO>
  <HawbNumber>sample string 1</HawbNumber>
  <NumberOfPieces>2</NumberOfPieces>
  <GrossWeight>
    <Value>1</Value>
    <UOM>sample string 2</UOM>
  </GrossWeight>
  <Locations>
    <PortOfOrigin>
      <Code>sample string 1</Code>
      <Name>sample string 1 (sample string 2)</Name>
    </PortOfOrigin>
    <PortOfDestination>
      <Code>sample string 1</Code>
      <Name>sample string 1 (sample string 2)</Name>
    </PortOfDestination>
  </Locations>
  <Commodity>sample string 3</Commodity>
  <PrintCommodity>sample string 4</PrintCommodity>
  <SLAC>1</SLAC>
  <Parties>
    <Shipper>
      <TheId>1</TheId>
      <WinId>1</WinId>
      <AccountNumber>sample string 1</AccountNumber>
      <Name>sample string 2</Name>
      <Phone>sample string 3</Phone>
      <Fax>sample string 4</Fax>
      <Email>sample string 5</Email>
      <Address>
        <Line1>sample string 1</Line1>
        <Line2>sample string 2</Line2>
        <Place>sample string 3</Place>
        <City>
          <Code>sample string 1</Code>
          <Name>sample string 2</Name>
        </City>
        <PostalCode>sample string 4</PostalCode>
        <StateProvince>sample string 5</StateProvince>
        <Country>
          <Code>sample string 1</Code>
          <Name>sample string 1 - sample string 2</Name>
        </Country>
      </Address>
      <PrintPartyDetails>sample string 6</PrintPartyDetails>
    </Shipper>
    <Consignee>
      <TheId>1</TheId>
      <WinId>1</WinId>
      <AccountNumber>sample string 1</AccountNumber>
      <Name>sample string 2</Name>
      <Phone>sample string 3</Phone>
      <Fax>sample string 4</Fax>
      <Email>sample string 5</Email>
      <Address>
        <Line1>sample string 1</Line1>
        <Line2>sample string 2</Line2>
        <Place>sample string 3</Place>
        <City>
          <Code>sample string 1</Code>
          <Name>sample string 2</Name>
        </City>
        <PostalCode>sample string 4</PostalCode>
        <StateProvince>sample string 5</StateProvince>
        <Country>
          <Code>sample string 1</Code>
          <Name>sample string 1 - sample string 2</Name>
        </Country>
      </Address>
      <PrintPartyDetails>sample string 6</PrintPartyDetails>
    </Consignee>
  </Parties>
  <Charges>
    <Currency>
      <Code>sample string 1</Code>
    </Currency>
    <WeightOrValuation>sample string 1</WeightOrValuation>
    <Other>sample string 2</Other>
    <ValuesForCarriage>1</ValuesForCarriage>
    <ValuesForCustom>1</ValuesForCustom>
    <ValuesForInsurance>1</ValuesForInsurance>
  </Charges>
  <Cargo>
    <HSCode>
      <Code>sample string 1</Code>
    </HSCode>
    <HSCode>
      <Code>sample string 1</Code>
    </HSCode>
    <HSCode>
      <Code>sample string 1</Code>
    </HSCode>
    <SpecialHandling>
      <Code>sample string 1</Code>
    </SpecialHandling>
    <SpecialHandling>
      <Code>sample string 1</Code>
    </SpecialHandling>
    <SpecialHandling>
      <Code>sample string 1</Code>
    </SpecialHandling>
    <GoodsDescription>sample string 1</GoodsDescription>
  </Cargo>
  <Optional>
    <OtherCustoms>
      <TheID>1</TheID>
      <Country>
        <Code>sample string 1</Code>
        <Name>sample string 1 - sample string 2</Name>
      </Country>
      <InformationIdentifier>sample string 1</InformationIdentifier>
      <ControlIdentifier>sample string 2</ControlIdentifier>
      <SupplementControlInformation>sample string 3</SupplementControlInformation>
    </OtherCustoms>
    <OtherCustoms>
      <TheID>1</TheID>
      <Country>
        <Code>sample string 1</Code>
        <Name>sample string 1 - sample string 2</Name>
      </Country>
      <InformationIdentifier>sample string 1</InformationIdentifier>
      <ControlIdentifier>sample string 2</ControlIdentifier>
      <SupplementControlInformation>sample string 3</SupplementControlInformation>
    </OtherCustoms>
    <OtherCustoms>
      <TheID>1</TheID>
      <Country>
        <Code>sample string 1</Code>
        <Name>sample string 1 - sample string 2</Name>
      </Country>
      <InformationIdentifier>sample string 1</InformationIdentifier>
      <ControlIdentifier>sample string 2</ControlIdentifier>
      <SupplementControlInformation>sample string 3</SupplementControlInformation>
    </OtherCustoms>
  </Optional>
</HAWB_POST_DTO>

Response Information

HAWB_GET_DTO

Response body formats

application/json, text/json

Sample: 
{
  "HawbID": 1,
  "HawbNumber": "sample string 2",
  "MawbID": 3,
  "Status": "sample string 4",
  "LastStatus": "sample string 5",
  "NumberOfPieces": 6,
  "GrossWeight": {
    "Value": 1.0,
    "UOM": "sample string 2"
  },
  "Locations": {
    "PortOfOrigin": {
      "Name": "sample string 2 (sample string 1)",
      "Code": "sample string 2"
    },
    "PortOfDestination": {
      "Name": "sample string 2 (sample string 1)",
      "Code": "sample string 2"
    }
  },
  "Commodity": "sample string 7",
  "PrintCommodity": "sample string 8",
  "SLAC": 1,
  "Parties": {
    "Shipper": {
      "TheId": 1,
      "WinId": 1,
      "AccountNumber": "sample string 1",
      "Name": "sample string 2",
      "Phone": "sample string 3",
      "Fax": "sample string 4",
      "Email": "sample string 5",
      "Address": {
        "Line1": "sample string 1",
        "Line2": "sample string 2",
        "Place": "sample string 3",
        "City": {
          "Code": "sample string 1",
          "Name": "sample string 2"
        },
        "PostalCode": "sample string 4",
        "StateProvince": "sample string 5",
        "Country": {
          "Code": "sample string 1",
          "Name": "sample string 1 - sample string 2"
        }
      },
      "PrintPartyDetails": "sample string 6"
    },
    "Consignee": {
      "TheId": 1,
      "WinId": 1,
      "AccountNumber": "sample string 1",
      "Name": "sample string 2",
      "Phone": "sample string 3",
      "Fax": "sample string 4",
      "Email": "sample string 5",
      "Address": {
        "Line1": "sample string 1",
        "Line2": "sample string 2",
        "Place": "sample string 3",
        "City": {
          "Code": "sample string 1",
          "Name": "sample string 2"
        },
        "PostalCode": "sample string 4",
        "StateProvince": "sample string 5",
        "Country": {
          "Code": "sample string 1",
          "Name": "sample string 1 - sample string 2"
        }
      },
      "PrintPartyDetails": "sample string 6"
    }
  },
  "Charges": {
    "Currency": {
      "Code": "sample string 1",
      "Name": "sample string 2"
    },
    "WeightOrValuation": "sample string 1",
    "Other": "sample string 2",
    "ValuesForCarriage": 1.0,
    "ValuesForCustom": 1.0,
    "ValuesForInsurance": 1.0
  },
  "Cargo": {
    "HSCode": [
      {
        "Name": "sample string 1",
        "Code": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Code": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Code": "sample string 2"
      }
    ],
    "SpecialHandling": [
      {
        "Name": "sample string 1",
        "Code": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Code": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Code": "sample string 2"
      }
    ],
    "GoodsDescription": "sample string 1"
  },
  "Optional": {
    "OtherCustoms": [
      {
        "TheID": 1,
        "Country": {
          "Code": "sample string 1",
          "Name": "sample string 1 - sample string 2"
        },
        "InformationIdentifier": "sample string 1",
        "ControlIdentifier": "sample string 2",
        "SupplementControlInformation": "sample string 3"
      },
      {
        "TheID": 1,
        "Country": {
          "Code": "sample string 1",
          "Name": "sample string 1 - sample string 2"
        },
        "InformationIdentifier": "sample string 1",
        "ControlIdentifier": "sample string 2",
        "SupplementControlInformation": "sample string 3"
      },
      {
        "TheID": 1,
        "Country": {
          "Code": "sample string 1",
          "Name": "sample string 1 - sample string 2"
        },
        "InformationIdentifier": "sample string 1",
        "ControlIdentifier": "sample string 2",
        "SupplementControlInformation": "sample string 3"
      }
    ]
  },
  "Created": null,
  "Updated": {
    "AgentID": 1,
    "AgentIDAsText": "1",
    "AgentName": null,
    "ContactID": 0,
    "ContactIDAsText": "0",
    "ContactName": null,
    "Datetime": null,
    "DatetimeAsText": null
  }
}

application/xml, text/xml

Sample: 
<HAWB_GET_DTO>
  <HawbID>1</HawbID>
  <HawbNumber>sample string 2</HawbNumber>
  <MawbID>3</MawbID>
  <Status>sample string 4</Status>
  <LastStatus>sample string 5</LastStatus>
  <NumberOfPieces>6</NumberOfPieces>
  <GrossWeight>
    <Value>1</Value>
    <UOM>sample string 2</UOM>
  </GrossWeight>
  <Locations>
    <PortOfOrigin>
      <Code>sample string 2</Code>
      <Name>sample string 2 (sample string 1)</Name>
    </PortOfOrigin>
    <PortOfDestination>
      <Code>sample string 2</Code>
      <Name>sample string 2 (sample string 1)</Name>
    </PortOfDestination>
  </Locations>
  <Commodity>sample string 7</Commodity>
  <PrintCommodity>sample string 8</PrintCommodity>
  <SLAC>1</SLAC>
  <Parties>
    <Shipper>
      <TheId>1</TheId>
      <WinId>1</WinId>
      <AccountNumber>sample string 1</AccountNumber>
      <Name>sample string 2</Name>
      <Phone>sample string 3</Phone>
      <Fax>sample string 4</Fax>
      <Email>sample string 5</Email>
      <Address>
        <Line1>sample string 1</Line1>
        <Line2>sample string 2</Line2>
        <Place>sample string 3</Place>
        <City>
          <Code>sample string 1</Code>
          <Name>sample string 2</Name>
        </City>
        <PostalCode>sample string 4</PostalCode>
        <StateProvince>sample string 5</StateProvince>
        <Country>
          <Code>sample string 1</Code>
          <Name>sample string 1 - sample string 2</Name>
        </Country>
      </Address>
      <PrintPartyDetails>sample string 6</PrintPartyDetails>
    </Shipper>
    <Consignee>
      <TheId>1</TheId>
      <WinId>1</WinId>
      <AccountNumber>sample string 1</AccountNumber>
      <Name>sample string 2</Name>
      <Phone>sample string 3</Phone>
      <Fax>sample string 4</Fax>
      <Email>sample string 5</Email>
      <Address>
        <Line1>sample string 1</Line1>
        <Line2>sample string 2</Line2>
        <Place>sample string 3</Place>
        <City>
          <Code>sample string 1</Code>
          <Name>sample string 2</Name>
        </City>
        <PostalCode>sample string 4</PostalCode>
        <StateProvince>sample string 5</StateProvince>
        <Country>
          <Code>sample string 1</Code>
          <Name>sample string 1 - sample string 2</Name>
        </Country>
      </Address>
      <PrintPartyDetails>sample string 6</PrintPartyDetails>
    </Consignee>
  </Parties>
  <Charges>
    <Currency>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Currency>
    <WeightOrValuation>sample string 1</WeightOrValuation>
    <Other>sample string 2</Other>
    <ValuesForCarriage>1</ValuesForCarriage>
    <ValuesForCustom>1</ValuesForCustom>
    <ValuesForInsurance>1</ValuesForInsurance>
  </Charges>
  <Cargo>
    <HSCode>
      <Code>sample string 2</Code>
      <Name>sample string 1</Name>
    </HSCode>
    <HSCode>
      <Code>sample string 2</Code>
      <Name>sample string 1</Name>
    </HSCode>
    <HSCode>
      <Code>sample string 2</Code>
      <Name>sample string 1</Name>
    </HSCode>
    <SpecialHandling>
      <Code>sample string 2</Code>
      <Name>sample string 1</Name>
    </SpecialHandling>
    <SpecialHandling>
      <Code>sample string 2</Code>
      <Name>sample string 1</Name>
    </SpecialHandling>
    <SpecialHandling>
      <Code>sample string 2</Code>
      <Name>sample string 1</Name>
    </SpecialHandling>
    <GoodsDescription>sample string 1</GoodsDescription>
  </Cargo>
  <Optional>
    <OtherCustoms>
      <TheID>1</TheID>
      <Country>
        <Code>sample string 1</Code>
        <Name>sample string 1 - sample string 2</Name>
      </Country>
      <InformationIdentifier>sample string 1</InformationIdentifier>
      <ControlIdentifier>sample string 2</ControlIdentifier>
      <SupplementControlInformation>sample string 3</SupplementControlInformation>
    </OtherCustoms>
    <OtherCustoms>
      <TheID>1</TheID>
      <Country>
        <Code>sample string 1</Code>
        <Name>sample string 1 - sample string 2</Name>
      </Country>
      <InformationIdentifier>sample string 1</InformationIdentifier>
      <ControlIdentifier>sample string 2</ControlIdentifier>
      <SupplementControlInformation>sample string 3</SupplementControlInformation>
    </OtherCustoms>
    <OtherCustoms>
      <TheID>1</TheID>
      <Country>
        <Code>sample string 1</Code>
        <Name>sample string 1 - sample string 2</Name>
      </Country>
      <InformationIdentifier>sample string 1</InformationIdentifier>
      <ControlIdentifier>sample string 2</ControlIdentifier>
      <SupplementControlInformation>sample string 3</SupplementControlInformation>
    </OtherCustoms>
  </Optional>
  <Created />
  <Updated>
    <AgentID>1</AgentID>
    <AgentName />
    <ContactID>0</ContactID>
    <ContactName />
  </Updated>
</HAWB_GET_DTO>