POST api/ShipOnHoldOrder_V1

Ship an existing onhold Order

Request Information

URI Parameters

None.

Body Parameters

The request is presented below!

WS_Repository.Models.Requests.OrderAggregation.ShipOnHoldOrderRequest

Name	Description	Type	Additional information
WS_Key	(Mandatory) Webservice Key provided by 2ship support	string	None.
OrderNumber	(Mandatory) Order Number to be shipped	string	None.
RateCurrencySelect	(Optional) Used to return rates in your selected currency using the 2Ship exchange rate from openexchangerates.org	string	None.
GetShipLabelByPiece	(Optional) If this flag is set, the ship API response will return individual files for each package label - the document type will be PieceLabel	boolean	None.
RetrieveBase64StringDocuments	(Optional) Use to get in the responso also the documents in Base64String format	boolean	None.
PackagesAreSkids	(Optional) If is set to true it specify that all the items in Packages will be treated as Skids	boolean	None.
Packages	(Optional) Array of Package - If this is missing then will use the stored packages on the order - if there is a Partial Shipment involve then this field become Mandatory	Collection of WS_Repository.Models.Requests.OrderAggregation.Package	None.
Contents	(Optional) Contents of the shipment packages	WS_Repository.Models.Requests.OrderAggregation.Contents	None.
PartialShipSettings	(Optional) Use to get set the Partial Ship Settings - this field should be populated just if your user have Partial Ship feature enable	WS_Repository.Models.Requests.OrderAggregation.PartialShipSettings	None.
ExternalOrderIdentifier	(Optional) External Order Identifier	string	None.
CheckPackageReference	(Optional) Check Package Reference 1 if is already processed	boolean	None.
CheckClientDeliveryBoundaries	(Optional) Check Client Delivery Boundaries	boolean	None.
AutoPrintOnPrintHUB	please contact support@2ship.com for info about this flag	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "WS_Key": "sample string 1",
  "OrderNumber": "sample string 2",
  "RateCurrencySelect": "sample string 3",
  "GetShipLabelByPiece": true,
  "RetrieveBase64StringDocuments": true,
  "PackagesAreSkids": true,
  "Packages": [
    {
      "Weight": 1.0,
      "Width": 2.0,
      "Length": 3.0,
      "Height": 4.0,
      "FreightClassId": 5.0,
      "NMFCItem": "sample string 6",
      "NMFCSub": "sample string 7",
      "WeightType": 0,
      "DimensionType": 0,
      "DimensionCode": "sample string 8",
      "Packaging": 0,
      "InsuranceAmount": 9.0,
      "InsuranceCurrency": "sample string 10",
      "Reference1": "sample string 11",
      "Reference2": "sample string 12",
      "PONumber": "sample string 13",
      "NumberOfPiecesInSkid": 14,
      "SkidDescription": "sample string 15",
      "ShipmentId": "sample string 16",
      "InvoiceNo": "sample string 17",
      "IsStackable": true,
      "LicencePlate": "sample string 19",
      "PreAssignTrackingNumber": "sample string 20",
      "UsePackageInfoFromOrderWhenMissing": true
    },
    {
      "Weight": 1.0,
      "Width": 2.0,
      "Length": 3.0,
      "Height": 4.0,
      "FreightClassId": 5.0,
      "NMFCItem": "sample string 6",
      "NMFCSub": "sample string 7",
      "WeightType": 0,
      "DimensionType": 0,
      "DimensionCode": "sample string 8",
      "Packaging": 0,
      "InsuranceAmount": 9.0,
      "InsuranceCurrency": "sample string 10",
      "Reference1": "sample string 11",
      "Reference2": "sample string 12",
      "PONumber": "sample string 13",
      "NumberOfPiecesInSkid": 14,
      "SkidDescription": "sample string 15",
      "ShipmentId": "sample string 16",
      "InvoiceNo": "sample string 17",
      "IsStackable": true,
      "LicencePlate": "sample string 19",
      "PreAssignTrackingNumber": "sample string 20",
      "UsePackageInfoFromOrderWhenMissing": true
    }
  ],
  "Contents": {
    "Documents": [
      {
        "Description": "sample string 1",
        "UnitValue": 2.0,
        "MadeInCountryCode": "sample string 3",
        "IsDutiable": true
      },
      {
        "Description": "sample string 1",
        "UnitValue": 2.0,
        "MadeInCountryCode": "sample string 3",
        "IsDutiable": true
      }
    ],
    "Commodities": [
      {
        "Description": "sample string 1",
        "MadeInCountryCode": "sample string 2",
        "Quantity": 3.0,
        "QuantityUnitOfMeasure": "sample string 4",
        "UnitValue": 5.0,
        "TotalWeight": 6.0,
        "ItemWeight": 7.0,
        "ItemLength": 8.0,
        "ItemWidth": 9.0,
        "ItemHeight": 10.0,
        "ItemMeasurementsType": 0,
        "HarmonizedCode": "sample string 11",
        "PartNumber": "sample string 12",
        "MarksOrNumbers": "sample string 13",
        "SKUOrItemOrUPS": "sample string 14",
        "SKUOrItemOrUPC": "sample string 15",
        "ExportLicense": "sample string 16",
        "LicenseExpireDate": "sample string 17",
        "NAFTA": true,
        "FDA": true,
        "FCC": true,
        "SenderIsProducer": true,
        "Textile": true,
        "TextileInformation": "sample string 23",
        "FCCEntryNumber": "sample string 24",
        "FCCPortOfEntry": "sample string 25",
        "FCCDeviceModel": "sample string 26",
        "FCCTradeName": "sample string 27",
        "FCCID": "sample string 28",
        "FCCDescribeRadioFrequency": "sample string 29",
        "FDADescription": "sample string 30",
        "IsDutiable": true,
        "Manufacturer": {
          "PersonName": "sample string 1",
          "CompanyName": "sample string 2",
          "Country": "sample string 3",
          "State": "sample string 4",
          "City": "sample string 5",
          "PostalCode": "sample string 6",
          "Address1": "sample string 7",
          "Address2": "sample string 8",
          "Address3": "sample string 9",
          "Telephone": "sample string 10",
          "TelephoneExtension": "sample string 11",
          "Email": "sample string 12",
          "IsResidential": true,
          "TaxID": "sample string 14"
        },
        "OnHoldImportBooksPerBox": 32.0,
        "AccessionNumber": "sample string 33",
        "PackageNumber": 1,
        "QuantityAssignment": [
          {
            "PackageIndex": 1,
            "Quantity": 2.0
          },
          {
            "PackageIndex": 1,
            "Quantity": 2.0
          }
        ],
        "DangerousGoodsInfo": {
          "ContainsDangerousGoods": true,
          "Accessible": true,
          "RegulationSet": 0,
          "RegulationLevelCode": 0,
          "UN": "sample string 2",
          "Class": "sample string 3",
          "PackingGroup": 0,
          "Authorization": "sample string 4",
          "AdditionalHandlingInformation": "sample string 5",
          "TechnicalName": "sample string 6",
          "AdditionalDescription": "sample string 7",
          "PackagingContainerType": "sample string 8",
          "PackagingType": "sample string 9",
          "SignatureName": "sample string 10",
          "SignaturePlace": "sample string 11",
          "SignatureDate": "sample string 12",
          "SignatureTitle": "sample string 13",
          "TransportType": 0,
          "DGPackingType": 0,
          "Radioactive": true,
          "EmergencyPhone": "sample string 14",
          "EmergencyContact": "sample string 15",
          "AllPackedInOne": true,
          "OverPacked": true,
          "QValue": "sample string 16",
          "ChemicalRecord": "sample string 17",
          "HazardLabelRequired": "sample string 18",
          "SubRiskClass": "sample string 19",
          "TunelRestriction": true,
          "AirportDeparture": "sample string 20",
          "AirportDestination": "sample string 21",
          "Offeror": "sample string 22",
          "PackageInstructions": "sample string 23",
          "ProperShippingName": "sample string 24"
        },
        "LTLClassId": "sample string 34",
        "NMFCItem": "sample string 35",
        "NMFCSub": "sample string 36",
        "MID": "sample string 37",
        "LBSLTSFactor": 1.0,
        "PlantArticle": true,
        "PlantArticleGenus": "sample string 39",
        "PlantArticleSpecies": "sample string 40",
        "PlantArticleQuantity": "sample string 41",
        "PlantArticlePercentRecycled": "sample string 42",
        "ECCN": "sample string 43"
      },
      {
        "Description": "sample string 1",
        "MadeInCountryCode": "sample string 2",
        "Quantity": 3.0,
        "QuantityUnitOfMeasure": "sample string 4",
        "UnitValue": 5.0,
        "TotalWeight": 6.0,
        "ItemWeight": 7.0,
        "ItemLength": 8.0,
        "ItemWidth": 9.0,
        "ItemHeight": 10.0,
        "ItemMeasurementsType": 0,
        "HarmonizedCode": "sample string 11",
        "PartNumber": "sample string 12",
        "MarksOrNumbers": "sample string 13",
        "SKUOrItemOrUPS": "sample string 14",
        "SKUOrItemOrUPC": "sample string 15",
        "ExportLicense": "sample string 16",
        "LicenseExpireDate": "sample string 17",
        "NAFTA": true,
        "FDA": true,
        "FCC": true,
        "SenderIsProducer": true,
        "Textile": true,
        "TextileInformation": "sample string 23",
        "FCCEntryNumber": "sample string 24",
        "FCCPortOfEntry": "sample string 25",
        "FCCDeviceModel": "sample string 26",
        "FCCTradeName": "sample string 27",
        "FCCID": "sample string 28",
        "FCCDescribeRadioFrequency": "sample string 29",
        "FDADescription": "sample string 30",
        "IsDutiable": true,
        "Manufacturer": {
          "PersonName": "sample string 1",
          "CompanyName": "sample string 2",
          "Country": "sample string 3",
          "State": "sample string 4",
          "City": "sample string 5",
          "PostalCode": "sample string 6",
          "Address1": "sample string 7",
          "Address2": "sample string 8",
          "Address3": "sample string 9",
          "Telephone": "sample string 10",
          "TelephoneExtension": "sample string 11",
          "Email": "sample string 12",
          "IsResidential": true,
          "TaxID": "sample string 14"
        },
        "OnHoldImportBooksPerBox": 32.0,
        "AccessionNumber": "sample string 33",
        "PackageNumber": 1,
        "QuantityAssignment": [
          {
            "PackageIndex": 1,
            "Quantity": 2.0
          },
          {
            "PackageIndex": 1,
            "Quantity": 2.0
          }
        ],
        "DangerousGoodsInfo": {
          "ContainsDangerousGoods": true,
          "Accessible": true,
          "RegulationSet": 0,
          "RegulationLevelCode": 0,
          "UN": "sample string 2",
          "Class": "sample string 3",
          "PackingGroup": 0,
          "Authorization": "sample string 4",
          "AdditionalHandlingInformation": "sample string 5",
          "TechnicalName": "sample string 6",
          "AdditionalDescription": "sample string 7",
          "PackagingContainerType": "sample string 8",
          "PackagingType": "sample string 9",
          "SignatureName": "sample string 10",
          "SignaturePlace": "sample string 11",
          "SignatureDate": "sample string 12",
          "SignatureTitle": "sample string 13",
          "TransportType": 0,
          "DGPackingType": 0,
          "Radioactive": true,
          "EmergencyPhone": "sample string 14",
          "EmergencyContact": "sample string 15",
          "AllPackedInOne": true,
          "OverPacked": true,
          "QValue": "sample string 16",
          "ChemicalRecord": "sample string 17",
          "HazardLabelRequired": "sample string 18",
          "SubRiskClass": "sample string 19",
          "TunelRestriction": true,
          "AirportDeparture": "sample string 20",
          "AirportDestination": "sample string 21",
          "Offeror": "sample string 22",
          "PackageInstructions": "sample string 23",
          "ProperShippingName": "sample string 24"
        },
        "LTLClassId": "sample string 34",
        "NMFCItem": "sample string 35",
        "NMFCSub": "sample string 36",
        "MID": "sample string 37",
        "LBSLTSFactor": 1.0,
        "PlantArticle": true,
        "PlantArticleGenus": "sample string 39",
        "PlantArticleSpecies": "sample string 40",
        "PlantArticleQuantity": "sample string 41",
        "PlantArticlePercentRecycled": "sample string 42",
        "ECCN": "sample string 43"
      }
    ]
  },
  "PartialShipSettings": {
    "ShipThisOrderPartial": true,
    "CloseTheOrder": true
  },
  "ExternalOrderIdentifier": "sample string 7",
  "CheckPackageReference": true,
  "CheckClientDeliveryBoundaries": true,
  "AutoPrintOnPrintHUB": true
}

application/xml, text/xml

Sample:

<ShipOnHoldOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.OrderAggregation">
  <AutoPrintOnPrintHUB>true</AutoPrintOnPrintHUB>
  <CheckClientDeliveryBoundaries>true</CheckClientDeliveryBoundaries>
  <CheckPackageReference>true</CheckPackageReference>
  <Contents>
    <Commodities>
      <Commodity_ShipOnHold>
        <AccessionNumber>sample string 33</AccessionNumber>
        <DangerousGoodsInfo>
          <Accessible>true</Accessible>
          <AdditionalDescription>sample string 7</AdditionalDescription>
          <AdditionalHandlingInformation>sample string 5</AdditionalHandlingInformation>
          <AirportDeparture>sample string 20</AirportDeparture>
          <AirportDestination>sample string 21</AirportDestination>
          <AllPackedInOne>true</AllPackedInOne>
          <Authorization>sample string 4</Authorization>
          <ChemicalRecord>sample string 17</ChemicalRecord>
          <Class>sample string 3</Class>
          <ContainsDangerousGoods>true</ContainsDangerousGoods>
          <DGPackingType>OTHER</DGPackingType>
          <EmergencyContact>sample string 15</EmergencyContact>
          <EmergencyPhone>sample string 14</EmergencyPhone>
          <HazardLabelRequired>sample string 18</HazardLabelRequired>
          <Offeror>sample string 22</Offeror>
          <OverPacked>true</OverPacked>
          <PackageInstructions>sample string 23</PackageInstructions>
          <PackagingContainerType>sample string 8</PackagingContainerType>
          <PackagingType>sample string 9</PackagingType>
          <PackingGroup>NONE</PackingGroup>
          <ProperShippingName>sample string 24</ProperShippingName>
          <QValue>sample string 16</QValue>
          <Radioactive>true</Radioactive>
          <RegulationLevelCode>FullyRegulated</RegulationLevelCode>
          <RegulationSet>CFR</RegulationSet>
          <SignatureDate>sample string 12</SignatureDate>
          <SignatureName>sample string 10</SignatureName>
          <SignaturePlace>sample string 11</SignaturePlace>
          <SignatureTitle>sample string 13</SignatureTitle>
          <SubRiskClass>sample string 19</SubRiskClass>
          <TechnicalName>sample string 6</TechnicalName>
          <TransportType>PassengerAndCargoAircraft</TransportType>
          <TunelRestriction>true</TunelRestriction>
          <UN>sample string 2</UN>
        </DangerousGoodsInfo>
        <Description>sample string 1</Description>
        <ECCN>sample string 43</ECCN>
        <ExportLicense>sample string 16</ExportLicense>
        <FCC>true</FCC>
        <FCCDescribeRadioFrequency>sample string 29</FCCDescribeRadioFrequency>
        <FCCDeviceModel>sample string 26</FCCDeviceModel>
        <FCCEntryNumber>sample string 24</FCCEntryNumber>
        <FCCID>sample string 28</FCCID>
        <FCCPortOfEntry>sample string 25</FCCPortOfEntry>
        <FCCTradeName>sample string 27</FCCTradeName>
        <FDA>true</FDA>
        <FDADescription>sample string 30</FDADescription>
        <HarmonizedCode>sample string 11</HarmonizedCode>
        <IsDutiable>true</IsDutiable>
        <ItemHeight>10</ItemHeight>
        <ItemLength>8</ItemLength>
        <ItemMeasurementsType>Imperial</ItemMeasurementsType>
        <ItemWeight>7</ItemWeight>
        <ItemWidth>9</ItemWidth>
        <LBSLTSFactor>1</LBSLTSFactor>
        <LTLClassId>sample string 34</LTLClassId>
        <LicenseExpireDate>sample string 17</LicenseExpireDate>
        <MID>sample string 37</MID>
        <MadeInCountryCode>sample string 2</MadeInCountryCode>
        <Manufacturer>
          <Address1>sample string 7</Address1>
          <Address2>sample string 8</Address2>
          <Address3>sample string 9</Address3>
          <City>sample string 5</City>
          <CompanyName>sample string 2</CompanyName>
          <Country>sample string 3</Country>
          <Email>sample string 12</Email>
          <IsResidential>true</IsResidential>
          <PersonName>sample string 1</PersonName>
          <PostalCode>sample string 6</PostalCode>
          <State>sample string 4</State>
          <TaxID>sample string 14</TaxID>
          <Telephone>sample string 10</Telephone>
          <TelephoneExtension>sample string 11</TelephoneExtension>
        </Manufacturer>
        <MarksOrNumbers>sample string 13</MarksOrNumbers>
        <NAFTA>true</NAFTA>
        <NMFCItem>sample string 35</NMFCItem>
        <NMFCSub>sample string 36</NMFCSub>
        <OnHoldImportBooksPerBox>32</OnHoldImportBooksPerBox>
        <PackageNumber>1</PackageNumber>
        <PartNumber>sample string 12</PartNumber>
        <PlantArticle>true</PlantArticle>
        <PlantArticleGenus>sample string 39</PlantArticleGenus>
        <PlantArticlePercentRecycled>sample string 42</PlantArticlePercentRecycled>
        <PlantArticleQuantity>sample string 41</PlantArticleQuantity>
        <PlantArticleSpecies>sample string 40</PlantArticleSpecies>
        <Quantity>3</Quantity>
        <QuantityAssignment>
          <CommodityPacking_SOH>
            <PackageIndex>1</PackageIndex>
            <Quantity>2</Quantity>
          </CommodityPacking_SOH>
          <CommodityPacking_SOH>
            <PackageIndex>1</PackageIndex>
            <Quantity>2</Quantity>
          </CommodityPacking_SOH>
        </QuantityAssignment>
        <QuantityUnitOfMeasure>sample string 4</QuantityUnitOfMeasure>
        <SKUOrItemOrUPC>sample string 15</SKUOrItemOrUPC>
        <SKUOrItemOrUPS>sample string 14</SKUOrItemOrUPS>
        <SenderIsProducer>true</SenderIsProducer>
        <Textile>true</Textile>
        <TextileInformation>sample string 23</TextileInformation>
        <TotalWeight>6</TotalWeight>
        <UnitValue>5</UnitValue>
      </Commodity_ShipOnHold>
      <Commodity_ShipOnHold>
        <AccessionNumber>sample string 33</AccessionNumber>
        <DangerousGoodsInfo>
          <Accessible>true</Accessible>
          <AdditionalDescription>sample string 7</AdditionalDescription>
          <AdditionalHandlingInformation>sample string 5</AdditionalHandlingInformation>
          <AirportDeparture>sample string 20</AirportDeparture>
          <AirportDestination>sample string 21</AirportDestination>
          <AllPackedInOne>true</AllPackedInOne>
          <Authorization>sample string 4</Authorization>
          <ChemicalRecord>sample string 17</ChemicalRecord>
          <Class>sample string 3</Class>
          <ContainsDangerousGoods>true</ContainsDangerousGoods>
          <DGPackingType>OTHER</DGPackingType>
          <EmergencyContact>sample string 15</EmergencyContact>
          <EmergencyPhone>sample string 14</EmergencyPhone>
          <HazardLabelRequired>sample string 18</HazardLabelRequired>
          <Offeror>sample string 22</Offeror>
          <OverPacked>true</OverPacked>
          <PackageInstructions>sample string 23</PackageInstructions>
          <PackagingContainerType>sample string 8</PackagingContainerType>
          <PackagingType>sample string 9</PackagingType>
          <PackingGroup>NONE</PackingGroup>
          <ProperShippingName>sample string 24</ProperShippingName>
          <QValue>sample string 16</QValue>
          <Radioactive>true</Radioactive>
          <RegulationLevelCode>FullyRegulated</RegulationLevelCode>
          <RegulationSet>CFR</RegulationSet>
          <SignatureDate>sample string 12</SignatureDate>
          <SignatureName>sample string 10</SignatureName>
          <SignaturePlace>sample string 11</SignaturePlace>
          <SignatureTitle>sample string 13</SignatureTitle>
          <SubRiskClass>sample string 19</SubRiskClass>
          <TechnicalName>sample string 6</TechnicalName>
          <TransportType>PassengerAndCargoAircraft</TransportType>
          <TunelRestriction>true</TunelRestriction>
          <UN>sample string 2</UN>
        </DangerousGoodsInfo>
        <Description>sample string 1</Description>
        <ECCN>sample string 43</ECCN>
        <ExportLicense>sample string 16</ExportLicense>
        <FCC>true</FCC>
        <FCCDescribeRadioFrequency>sample string 29</FCCDescribeRadioFrequency>
        <FCCDeviceModel>sample string 26</FCCDeviceModel>
        <FCCEntryNumber>sample string 24</FCCEntryNumber>
        <FCCID>sample string 28</FCCID>
        <FCCPortOfEntry>sample string 25</FCCPortOfEntry>
        <FCCTradeName>sample string 27</FCCTradeName>
        <FDA>true</FDA>
        <FDADescription>sample string 30</FDADescription>
        <HarmonizedCode>sample string 11</HarmonizedCode>
        <IsDutiable>true</IsDutiable>
        <ItemHeight>10</ItemHeight>
        <ItemLength>8</ItemLength>
        <ItemMeasurementsType>Imperial</ItemMeasurementsType>
        <ItemWeight>7</ItemWeight>
        <ItemWidth>9</ItemWidth>
        <LBSLTSFactor>1</LBSLTSFactor>
        <LTLClassId>sample string 34</LTLClassId>
        <LicenseExpireDate>sample string 17</LicenseExpireDate>
        <MID>sample string 37</MID>
        <MadeInCountryCode>sample string 2</MadeInCountryCode>
        <Manufacturer>
          <Address1>sample string 7</Address1>
          <Address2>sample string 8</Address2>
          <Address3>sample string 9</Address3>
          <City>sample string 5</City>
          <CompanyName>sample string 2</CompanyName>
          <Country>sample string 3</Country>
          <Email>sample string 12</Email>
          <IsResidential>true</IsResidential>
          <PersonName>sample string 1</PersonName>
          <PostalCode>sample string 6</PostalCode>
          <State>sample string 4</State>
          <TaxID>sample string 14</TaxID>
          <Telephone>sample string 10</Telephone>
          <TelephoneExtension>sample string 11</TelephoneExtension>
        </Manufacturer>
        <MarksOrNumbers>sample string 13</MarksOrNumbers>
        <NAFTA>true</NAFTA>
        <NMFCItem>sample string 35</NMFCItem>
        <NMFCSub>sample string 36</NMFCSub>
        <OnHoldImportBooksPerBox>32</OnHoldImportBooksPerBox>
        <PackageNumber>1</PackageNumber>
        <PartNumber>sample string 12</PartNumber>
        <PlantArticle>true</PlantArticle>
        <PlantArticleGenus>sample string 39</PlantArticleGenus>
        <PlantArticlePercentRecycled>sample string 42</PlantArticlePercentRecycled>
        <PlantArticleQuantity>sample string 41</PlantArticleQuantity>
        <PlantArticleSpecies>sample string 40</PlantArticleSpecies>
        <Quantity>3</Quantity>
        <QuantityAssignment>
          <CommodityPacking_SOH>
            <PackageIndex>1</PackageIndex>
            <Quantity>2</Quantity>
          </CommodityPacking_SOH>
          <CommodityPacking_SOH>
            <PackageIndex>1</PackageIndex>
            <Quantity>2</Quantity>
          </CommodityPacking_SOH>
        </QuantityAssignment>
        <QuantityUnitOfMeasure>sample string 4</QuantityUnitOfMeasure>
        <SKUOrItemOrUPC>sample string 15</SKUOrItemOrUPC>
        <SKUOrItemOrUPS>sample string 14</SKUOrItemOrUPS>
        <SenderIsProducer>true</SenderIsProducer>
        <Textile>true</Textile>
        <TextileInformation>sample string 23</TextileInformation>
        <TotalWeight>6</TotalWeight>
        <UnitValue>5</UnitValue>
      </Commodity_ShipOnHold>
    </Commodities>
    <Documents>
      <Document_ShipOnHold>
        <Description>sample string 1</Description>
        <IsDutiable>true</IsDutiable>
        <MadeInCountryCode>sample string 3</MadeInCountryCode>
        <UnitValue>2</UnitValue>
      </Document_ShipOnHold>
      <Document_ShipOnHold>
        <Description>sample string 1</Description>
        <IsDutiable>true</IsDutiable>
        <MadeInCountryCode>sample string 3</MadeInCountryCode>
        <UnitValue>2</UnitValue>
      </Document_ShipOnHold>
    </Documents>
  </Contents>
  <ExternalOrderIdentifier>sample string 7</ExternalOrderIdentifier>
  <GetShipLabelByPiece>true</GetShipLabelByPiece>
  <OrderNumber>sample string 2</OrderNumber>
  <Packages>
    <Package_ShipOnHold>
      <DimensionCode>sample string 8</DimensionCode>
      <DimensionType>Inches</DimensionType>
      <FreightClassId>5</FreightClassId>
      <Height>4</Height>
      <InsuranceAmount>9</InsuranceAmount>
      <InsuranceCurrency>sample string 10</InsuranceCurrency>
      <InvoiceNo>sample string 17</InvoiceNo>
      <IsStackable>true</IsStackable>
      <Length>3</Length>
      <LicencePlate>sample string 19</LicencePlate>
      <NMFCItem>sample string 6</NMFCItem>
      <NMFCSub>sample string 7</NMFCSub>
      <NumberOfPiecesInSkid>14</NumberOfPiecesInSkid>
      <PONumber>sample string 13</PONumber>
      <Packaging>NotSet</Packaging>
      <PreAssignTrackingNumber>sample string 20</PreAssignTrackingNumber>
      <Reference1>sample string 11</Reference1>
      <Reference2>sample string 12</Reference2>
      <ShipmentId>sample string 16</ShipmentId>
      <SkidDescription>sample string 15</SkidDescription>
      <UsePackageInfoFromOrderWhenMissing>true</UsePackageInfoFromOrderWhenMissing>
      <Weight>1</Weight>
      <WeightType>Pounds</WeightType>
      <Width>2</Width>
    </Package_ShipOnHold>
    <Package_ShipOnHold>
      <DimensionCode>sample string 8</DimensionCode>
      <DimensionType>Inches</DimensionType>
      <FreightClassId>5</FreightClassId>
      <Height>4</Height>
      <InsuranceAmount>9</InsuranceAmount>
      <InsuranceCurrency>sample string 10</InsuranceCurrency>
      <InvoiceNo>sample string 17</InvoiceNo>
      <IsStackable>true</IsStackable>
      <Length>3</Length>
      <LicencePlate>sample string 19</LicencePlate>
      <NMFCItem>sample string 6</NMFCItem>
      <NMFCSub>sample string 7</NMFCSub>
      <NumberOfPiecesInSkid>14</NumberOfPiecesInSkid>
      <PONumber>sample string 13</PONumber>
      <Packaging>NotSet</Packaging>
      <PreAssignTrackingNumber>sample string 20</PreAssignTrackingNumber>
      <Reference1>sample string 11</Reference1>
      <Reference2>sample string 12</Reference2>
      <ShipmentId>sample string 16</ShipmentId>
      <SkidDescription>sample string 15</SkidDescription>
      <UsePackageInfoFromOrderWhenMissing>true</UsePackageInfoFromOrderWhenMissing>
      <Weight>1</Weight>
      <WeightType>Pounds</WeightType>
      <Width>2</Width>
    </Package_ShipOnHold>
  </Packages>
  <PackagesAreSkids>true</PackagesAreSkids>
  <PartialShipSettings>
    <CloseTheOrder>true</CloseTheOrder>
    <ShipThisOrderPartial>true</ShipThisOrderPartial>
  </PartialShipSettings>
  <RateCurrencySelect>sample string 3</RateCurrencySelect>
  <RetrieveBase64StringDocuments>true</RetrieveBase64StringDocuments>
  <WS_Key>sample string 1</WS_Key>
</ShipOnHoldOrderRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'WS_Repository.Models.Requests.OrderAggregation.ShipOnHoldOrderRequest'.

Response Information

Resource Description

WS_Repository.Models.Responses.Ship.CarrierShipResponse

Name	Description	Type	Additional information
ShipDocuments	Array of Ship Documents	Collection of WS_Repository.Models.Responses.Ship.ShipDocument	None.
ShipId	Internal 2ship Shipment Id	integer	None.
OrderNumber	Order number, optional, assigned by callers on the request	string	None.
CloseAggregationId	Specify if the shipment is aggregated with other shipments at close transaction - the close aggregation id represent the firstshipment id from the group of aggregated shipments - Used on GetShipments transaction	integer	None.
Service	Rate Service	WS_Repository.Models.Responses.Rate.RateService	None.
Carrier	Rate Service	WS_Repository.Models.Responses.Rate.Carrier	None.
LocationId	2Ship Location Id	integer	None.
LocationName	2Ship Location Name	string	None.
ProNumber	Pro Number - will be populated when the carrier is LTL and was shipped with a Pro Number	string	None.
TrackingNumber	Carrier Master TrackingNumber of the shipment	string	None.
TrackingUrl	2Ship Tracking Url	string	None.
AirwayBillNumber	Carrier Airway Bill Number of the shipment (not used by all carriers)	string	None.
PackageTrackingNumbers	Carrier Package TrackingNumbers of the shipment	Collection of string	None.
ShipmentDetails	Details of the shipment	WS_Repository.Models.Responses.Ship.ShipmentDetails	None.
ExchangeRate	Exchange Rate object available if the RateCurrencySelect is specify on the ship request	WS_Repository.Models.Responses.Ship.ExchangeRate	None.
MycarrierDetails	when the carrier is My Carrier(999) here are populated your carrier info	WS_Repository.Models.Responses.Ship.MyCarrierDetails	None.
Status	The current status of the shipment (returned only from GetChanges ws call): Shipped, Deleted, Closed, DeletedOnHold, Imported	string	None.
StatusTimestamp	The timestamp when the shipment changed to the given status (returned only from GetChanges ws call)	string	None.
QRCodeValue	QR Code Value	string	None.
QRCodeImageURL	QR Code Image URL	string	None.
ClientId	ClientId of Client created the shipment	integer	None.
ExternalClientID	External client ID	string	None.
UserId	UserId of user created the shipment	integer	None.
UserName	User name of user created the shipment	string	None.
WebsiteUrl	(Only available on ShipmentStatusChange webhooks at ship/delete) WebsiteUrl	string	None.
OriginHubCode	Origin Hub/Airport Code	string	None.
DestinationHubCode	Origin Hub/Airport Code	string	None.
InternalNotes	Internal notes	string	None.
ShipWithoutPrinterMessage	(Optional) Use this filter to find the Carrier services that allow you to ship without the need for a printed label	string	None.
WebhookType	Webhook Type	string	None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'WS_Repository.Models.Responses.Ship.Commodity'. Path 'ShipmentDetails.Contents.Commodities[0].BundleComponents'.

text/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'WS_Repository.Models.Responses.Ship.Commodity'. Path 'ShipmentDetails.Contents.Commodities[0].BundleComponents'.

application/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[WS_Repository.Models.Responses.Ship.Commodity, WS_Repository.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[WS_Repository.Models.Responses.Ship.Commodity, WS_Repository.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.