POST api/Hold_V1

Import a shipment and put it on hold

Request Information

URI Parameters

None.

Body Parameters

The request is presented below!

WS_Repository.Models.Requests.Hold.HoldRequest

Name	Description	Type	Additional information
WS_Key	(Mandatory) Webservice Key provided by 2ship support	string	None.
CarrierId	(Optional) if pressent will get all services for that carrier	integer	None.
Sender	(Optional) Sender Contact - if not present then will get the default user sender	WS_Repository.Models.Requests.Hold.Contact	None.
UseAlternateSenderOnLabel	(Optional) Use alternate sender on label	boolean	None.
AlternateSender	Required if UseAlternateSederOnLabe = true, Specify the alternate address that will be printed on label	WS_Repository.Models.Requests.Hold.Contact	None.
Recipient	(Mandatory) Recipient Contact	WS_Repository.Models.Requests.Hold.Contact	None.
Packages	(Mandatory) Array of Package - Optional if CalculatePackagesByContents = true	Collection of WS_Repository.Models.Requests.Hold.Package	None.
PackagesAreSkids	(Optional) If is set to true it specify that all the items in Packages will be treated as Skids	boolean	None.
ShipmentReference	(Optional) Global Shipment reference, when is provided it is used to fill the package reference when there is no value. Also is save as Shipment Reference	string	None.
ShipmentReference2	(Optional) Global Shipment reference 2, when is provided it is used to fill the package reference 2 when there is no value. Also is save as Shipment Reference	string	None.
ShipmentInstructions	(Optional) Shipment Instructions, used for 4x8 doctab label	string	None.
CarrierRoute	(Optional) Carrier Route, used for 4x8 doctab label	string	None.
CarrierSequence	(Optional) Carrier Sequence, used for 4x8 doctab label	string	None.
ShipmentPONumber	(Optional) Global Shipment PO number, when is provided it is used to fill the package PO Numbeer when there is no value. Also is save as Shipment PO Number	string	None.
PickupDate	(Optional) the date of the pickup (default is today)	date	None.
Billing	(Optional) used to rate/ship with other account	WS_Repository.Models.Requests.Hold.BillingOptions	None.
ServiceCode	(Optional) can be present just if there is a Carrier Id	string	None.
InternationalOptions	(Optional) Internation Options of the order(if the order is intranational)	WS_Repository.Models.Requests.Hold.InternationalOptions	None.
Contents	(Optional) Contents of the shipment packages	WS_Repository.Models.Requests.Hold.Contents	None.
ShipOptions	(Optional) Used to filter services that include some options	Collection of WS_Repository.Models.Requests.Hold.ShipmentOption	None.
LocationId	(Optional) If not set will use the LocationName or the sender address to match the right Location to use.	integer	None.
LocationName	(Optional) If not set will use the LocationId or the sender address to match the right Location to use.	string	None.
LocationAddressMatchWholeSenderAddress	(Optional) Used when no LocationId and no LocationName are supplied. If is set to true then the location id is populated just if the sender address match the whole location address, if not you will get an Exception	boolean	None.
OrderNumber	(Optional) Your internal order number of the order	string	None.
CallbackURL	(Optional) use to call your webservice back when a status of an order is changing when order is shipped i call this url with the following parameters TrackingNumber={Carrier Shipment Tr #}&OrderNumber={Your Order #}&CurrentStatus=Shipped&LabelUrl={Url of the label}&TotalCost={cost of the shipment}&CarrierId={Carrier id}&CarrierName={Carrier Name}&ServiceCode={Service Code}&ServiceName={Service Name}&TrackingNumbers={all packages tracking numbers separeted by ,}&Currency={cost currency}&LabelFormat={label format: Format_4x6, Format_85x11, Format_PackingSlip_85x11} when shipment is deleted after the ship i call this url with the following parameters TrackingNumber={Carrier Shipment Tr #}&OrderNumber={Your Order #}&CurrentStatus=Deleted	string	None.
ServiceGroup	(Optional) Service Group Id - used to filter services which are in this Group	integer	None.
ServiceGroupName	(Optional) Service Group Name - used to filter services which are in this Group	string	None.
MycarrierDetails	(Optional) when the carrier is My Carrier(999) here you can populate your carrier info	WS_Repository.Models.Requests.Hold.MyCarrierDetails	None.
OrderInfo	(Optional) Order Info - will appear on Packing Slip Document when that type of label is setup on user	WS_Repository.Models.Requests.Hold.OrderInfo	None.
DepartmentDescription	(Optional) Department Description	string	None.
DepartmentCode	(Optional) Department Code	string	None.
CustomerMarkups	(Optional) Provide your own values for Customer Pricing calculation	Collection of WS_Repository.Models.Requests.Hold.CustomerMarkup	None.
ConsolidationUnit	(Optional) Used to consolidate the shipment	WS_Repository.Models.Common.ConsolidationUnit	None.
ApplyRate	(Optional) will rate your order and attach the cheapest rate, this meaning to find cheapest service for a carrier if you put the CarrierId‎ or find cheapest across all carriers if you do not put the CarrierId or find the rate for Carrier and Service if you put the CarrierId and a ServiceCode	boolean	None.
ApplyRateOptions	(Optional) used when Applyrate is set to get the cheapest service by filtering services that include the options specified in this field	WS_Repository.Models.Requests.Hold.RateOptions	None.
DaysToSearchInHistory	(Optional) How many days to search in history for an order. it apply just if you specify an OrderNumber (Default is 0 days)	integer	None.
BOLNumber	(Optional) BOL Number (Used by ltl carriers to apear on Bill Of Lading)	string	None.
SpecialInstructions	(Optional) Special Instruction (Used by ltl carriers to apear on Bill Of Lading)	string	None.
ProjectId	(Optional) Use to group a bunch of shipments	string	None.
CartonDescription	(Optional) Used to populate the Contents area of a Carton Label. if this field is empty the Carton Label Contents will be populated with the shipment Contents.	string	None.
IsReturn	(Optional) the shipment will be treated as a return	boolean	None.
ReturnShipment	(Optional) Settings for printing the return label simultaneously with the outbound shipment (this field is ignored when IsReturn flag is set on)	WS_Repository.Models.Requests.Hold.PrintReturnLabel	None.
RequestPickup	(Optional) Flag to specify a pickup request should be sheduled	boolean	None.
EmailLabels	(Optional) Flag to specify the labels should be emailed	boolean	None.
EmailsList	(Optional) the list of emails where to send the labels	Collection of string	None.
IsInboundShipment	(Optional) the shipment will be treated as an inbound	boolean	None.
InboundShipmentLocationId	(Optional) if shipment is Inbound then add inbound location id. Note: can be null, inbound location id can be assigned in OPS	integer	None.
GLCategory	(Optional) General Ledger Category	string	None.
GLSubCategory	(Optional) General Ledger sub Category	string	None.
eAlerts	(Optional) eAlert - send email alerts to the specified email list for the spcified events	WS_Repository.Models.Requests.Hold.eAlerts	None.
FilterByDeliveryDate	(Optional) Flag to filter the ratings by MaxDeliveryDate	boolean	None.
MaxDeliveryDate	(Optional) Max delivery date of the shipment	date	None.
RunAggregationAfterHold	(Optional) Run Aggregation After importing	boolean	None.
RunAggregationRateAfterHold	(Optional) Run Aggregation Rate After importing	boolean	None.
ExcludeOrderFromAggregation	(Optional) Specify that the order cannot aggregate with other orders	boolean	None.
PackagesCanMergeInASinglePackageOnAggregation	(Optional) Specify that the order packages will be merged in a single package when aggregate with other orders	boolean	None.
ShipperLoadAndCount	(Optional) Shipper Load And Count - Mandatory if the carrier is FedEx - CarrierId = 2 and the services are one of the Freight services	string	None.
BookingConfirmationNumber	(Optional) Booking Confirmation Number - Mandatory if the carrier is FedEx - CarrierId = 2 and the services are one of the Freight services	string	None.
LabelPrintPreferences	(Optional) label printing preferences (Default is PDF and Format 8.5x11 in)	WS_Repository.Models.Requests.Hold.LabelPrintPreferencesType	None.
ShipByDate	(Optional) the date by which the order must be shipped	date	None.
CalculatePackagesByContents	(Optional) if this flag is set true then Packages field will be overridden with generated packages based on a 2ship packing algorithm and with parameters set on PackageGeneratingByContents field	boolean	None.
CalculatePackagesByContentsOptions	(Optional) Packages generation parameters	WS_Repository.Models.Requests.Hold.CalculatePackagesByContentsOptions	None.
InternalHandling	(Optional) Specify that this order will print an extra label with the InternalHandlingText on it	WS_Repository.Models.Requests.Hold.InternalHandling	None.
SourceOfOrder	(Optional) This field will store source of order for history, search, reports, etc. (Maximum length = 20 characters. Default value = "API".)	string	None.
Webhooks	Optional webhook options, to have 2Ship post full shipment data in json format whenever this shipment changes status	Collection of WS_Repository.Models.Requests.Hold.Webhook	None.
OrderProcessingSync	(Optional) if this is set then when ApplyRate = true and/or CalculatePackagesByContents = true you will get the Response after these are done	boolean	None.
CustomCharacterOverlayOnLabel	(Optional) Custom Character Overlay On Label (Max 1 character)	string	None.

Request Formats

application/json, text/json

Sample:

{
  "WS_Key": "sample string 1",
  "CarrierId": 2,
  "Sender": {
    "Id": "sample string 1",
    "PersonName": "sample string 2",
    "CompanyName": "sample string 3",
    "Country": "sample string 4",
    "State": "sample string 5",
    "City": "sample string 6",
    "PostalCode": "sample string 7",
    "Address1": "sample string 8",
    "Address2": "sample string 9",
    "Address3": "sample string 10",
    "Telephone": "sample string 11",
    "TelephoneExtension": "sample string 12",
    "Email": "sample string 13",
    "IsResidential": true,
    "TaxID": "sample string 15",
    "RecipientType": "sample string 16",
    "AccountNo": "sample string 17"
  },
  "UseAlternateSenderOnLabel": true,
  "AlternateSender": {
    "Id": "sample string 1",
    "PersonName": "sample string 2",
    "CompanyName": "sample string 3",
    "Country": "sample string 4",
    "State": "sample string 5",
    "City": "sample string 6",
    "PostalCode": "sample string 7",
    "Address1": "sample string 8",
    "Address2": "sample string 9",
    "Address3": "sample string 10",
    "Telephone": "sample string 11",
    "TelephoneExtension": "sample string 12",
    "Email": "sample string 13",
    "IsResidential": true,
    "TaxID": "sample string 15",
    "RecipientType": "sample string 16",
    "AccountNo": "sample string 17"
  },
  "Recipient": {
    "Id": "sample string 1",
    "PersonName": "sample string 2",
    "CompanyName": "sample string 3",
    "Country": "sample string 4",
    "State": "sample string 5",
    "City": "sample string 6",
    "PostalCode": "sample string 7",
    "Address1": "sample string 8",
    "Address2": "sample string 9",
    "Address3": "sample string 10",
    "Telephone": "sample string 11",
    "TelephoneExtension": "sample string 12",
    "Email": "sample string 13",
    "IsResidential": true,
    "TaxID": "sample string 15",
    "RecipientType": "sample string 16",
    "AccountNo": "sample string 17"
  },
  "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"
    },
    {
      "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"
    }
  ],
  "PackagesAreSkids": true,
  "ShipmentReference": "sample string 5",
  "ShipmentReference2": "sample string 6",
  "ShipmentInstructions": "sample string 7",
  "CarrierRoute": "sample string 8",
  "CarrierSequence": "sample string 9",
  "ShipmentPONumber": "sample string 10",
  "PickupDate": "2020-07-05T07:42:09.4761735Z",
  "Billing": {
    "BillingType": 1,
    "BillingAddress": {
      "Id": "sample string 1",
      "PersonName": "sample string 2",
      "CompanyName": "sample string 3",
      "Country": "sample string 4",
      "State": "sample string 5",
      "City": "sample string 6",
      "PostalCode": "sample string 7",
      "Address1": "sample string 8",
      "Address2": "sample string 9",
      "Address3": "sample string 10",
      "Telephone": "sample string 11",
      "TelephoneExtension": "sample string 12",
      "Email": "sample string 13",
      "IsResidential": true,
      "TaxID": "sample string 15",
      "RecipientType": "sample string 16",
      "AccountNo": "sample string 17"
    },
    "BillingAccount": "sample string 1",
    "TransitNumber": "sample string 2",
    "ContractNumber": "sample string 3"
  },
  "ServiceCode": "sample string 12",
  "InternationalOptions": {
    "CustomsBillingOptions": {
      "BillingType": 1,
      "BillingAddress": {
        "Id": "sample string 1",
        "PersonName": "sample string 2",
        "CompanyName": "sample string 3",
        "Country": "sample string 4",
        "State": "sample string 5",
        "City": "sample string 6",
        "PostalCode": "sample string 7",
        "Address1": "sample string 8",
        "Address2": "sample string 9",
        "Address3": "sample string 10",
        "Telephone": "sample string 11",
        "TelephoneExtension": "sample string 12",
        "Email": "sample string 13",
        "IsResidential": true,
        "TaxID": "sample string 15",
        "RecipientType": "sample string 16",
        "AccountNo": "sample string 17"
      },
      "BillingAccount": "sample string 1",
      "TransitNumber": "sample string 2",
      "ContractNumber": "sample string 3"
    },
    "Invoice": {
      "Amount": 1.0,
      "InvoiceNumber": "sample string 2",
      "Comment": "sample string 3",
      "Curency": "sample string 4",
      "Currency": "sample string 5",
      "TermsOfSale": 1,
      "FreightChargeAmount": 6.0,
      "AdditionalChargesAmount": 7.0,
      "CertificateNumber": "sample string 8",
      "Purpose": 1,
      "UploadCustomsDocumentsElectronically": true,
      "UseCustomProformaCI": true,
      "ExcludeFromFedExIGC": true
    },
    "ImporterOfRecord": {
      "Id": "sample string 1",
      "PersonName": "sample string 2",
      "CompanyName": "sample string 3",
      "Country": "sample string 4",
      "State": "sample string 5",
      "City": "sample string 6",
      "PostalCode": "sample string 7",
      "Address1": "sample string 8",
      "Address2": "sample string 9",
      "Address3": "sample string 10",
      "Telephone": "sample string 11",
      "TelephoneExtension": "sample string 12",
      "Email": "sample string 13",
      "IsResidential": true,
      "TaxID": "sample string 15",
      "RecipientType": "sample string 16",
      "AccountNo": "sample string 17"
    },
    "Broker": {
      "Id": "sample string 1",
      "PersonName": "sample string 2",
      "CompanyName": "sample string 3",
      "Country": "sample string 4",
      "State": "sample string 5",
      "City": "sample string 6",
      "PostalCode": "sample string 7",
      "Address1": "sample string 8",
      "Address2": "sample string 9",
      "Address3": "sample string 10",
      "Telephone": "sample string 11",
      "TelephoneExtension": "sample string 12",
      "Email": "sample string 13",
      "IsResidential": true,
      "TaxID": "sample string 15",
      "RecipientType": "sample string 16",
      "AccountNo": "sample string 17"
    },
    "ExporterOfRecord": {
      "Id": "sample string 1",
      "PersonName": "sample string 2",
      "CompanyName": "sample string 3",
      "Country": "sample string 4",
      "State": "sample string 5",
      "City": "sample string 6",
      "PostalCode": "sample string 7",
      "Address1": "sample string 8",
      "Address2": "sample string 9",
      "Address3": "sample string 10",
      "Telephone": "sample string 11",
      "TelephoneExtension": "sample string 12",
      "Email": "sample string 13",
      "IsResidential": true,
      "TaxID": "sample string 15",
      "RecipientType": "sample string 16",
      "AccountNo": "sample string 17"
    },
    "CustomsDeclaration": {
      "ImportExportType": 0,
      "ShipperAndExporterRelated": true,
      "FedExCustomsDeclaration": {
        "B13AFilingOption": 1,
        "ExportStatementData": "sample string 1",
        "ExportPermitNumber": "sample string 2",
        "FedExCustomDeclarationType": 0,
        "FTR": "sample string 3",
        "EEISEDFillingOption": 0,
        "AESCitationType": 0,
        "ExportStatementDataUS": "sample string 4",
        "DestinationControlStatementType": 0,
        "DestinationControlStatementRecipient": "sample string 5",
        "DestinationControlStatementCountry": [
          "sample string 1",
          "sample string 2"
        ]
      },
      "DHLCustomsDeclaration": {
        "ScheduleB": "sample string 1",
        "FillingOption": 0,
        "FillingOptionValue": "sample string 2",
        "InterConsignee": "sample string 3",
        "ECCN": "sample string 4",
        "ConsigneeEIN": "sample string 5",
        "ConsigneeIdType": 0,
        "ShipperEIN": "sample string 6",
        "ShipperIdType": 0,
        "ImportLicense": "sample string 7",
        "CommerceLicense": "sample string 8",
        "SignatureName": "sample string 9",
        "SignatureTitle": "sample string 10"
      },
      "PurolatorServerCustomsDeclaration": {
        "PurolatorServerBrokerCode": "sample string 1"
      }
    },
    "DoNotPrintCI": true,
    "ImporterIsDifferentThanRecipient": true,
    "ExporterIsDifferentThanSender": true,
    "UseSoldToOnCI": true,
    "SoldToIsDifferentThenImporterOfRecords": true,
    "SoldTo": {
      "Id": "sample string 1",
      "PersonName": "sample string 2",
      "CompanyName": "sample string 3",
      "Country": "sample string 4",
      "State": "sample string 5",
      "City": "sample string 6",
      "PostalCode": "sample string 7",
      "Address1": "sample string 8",
      "Address2": "sample string 9",
      "Address3": "sample string 10",
      "Telephone": "sample string 11",
      "TelephoneExtension": "sample string 12",
      "Email": "sample string 13",
      "IsResidential": true,
      "TaxID": "sample string 15",
      "RecipientType": "sample string 16",
      "AccountNo": "sample string 17"
    },
    "NAFTADeclarationDetails": {
      "NAFTABlankedPeriodStart": "2020-07-05T07:42:09.4810563-04:00",
      "NAFTABlankedPeriodEnd": "2020-07-05T07:42:09.482031-04:00",
      "NaftaProducerSpecification": 0,
      "NaftaImporterSpecification": 0
    }
  },
  "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": [
      {
        "ID": "sample string 1",
        "Description": "sample string 2",
        "MadeInCountryCode": "sample string 3",
        "Quantity": 4.0,
        "QuantityUnitOfMeasure": "sample string 5",
        "UnitValue": 6.0,
        "TotalWeight": 7.0,
        "ItemWeight": 8.0,
        "ItemLength": 9.0,
        "ItemWidth": 10.0,
        "ItemHeight": 11.0,
        "ItemMeasurementsType": 0,
        "HarmonizedCode": "sample string 12",
        "PartNumber": "sample string 13",
        "MarksOrNumbers": "sample string 14",
        "SKUOrItemOrUPS": "sample string 15",
        "SKUOrItemOrUPC": "sample string 16",
        "ExportLicense": "sample string 17",
        "LicenseExpireDate": "sample string 18",
        "NAFTA": true,
        "NAFTACommodityDetails": {
          "PreferenceCriterion": 0,
          "ProducerDetermination": 0,
          "NaftaNetCost": 0,
          "NetCostBeginDate": "2020-07-05T07:42:09.4839854-04:00",
          "NetCostEndDate": "2020-07-05T07:42:09.4849627-04:00"
        },
        "FDA": true,
        "FCC": true,
        "SenderIsProducer": true,
        "Textile": true,
        "TextileInformation": "sample string 24",
        "FCCEntryNumber": "sample string 25",
        "FCCPortOfEntry": "sample string 26",
        "FCCDeviceModel": "sample string 27",
        "FCCTradeName": "sample string 28",
        "FCCID": "sample string 29",
        "FCCDescribeRadioFrequency": "sample string 30",
        "IsDutiable": true,
        "Manufacturer": {
          "Id": "sample string 1",
          "PersonName": "sample string 2",
          "CompanyName": "sample string 3",
          "Country": "sample string 4",
          "State": "sample string 5",
          "City": "sample string 6",
          "PostalCode": "sample string 7",
          "Address1": "sample string 8",
          "Address2": "sample string 9",
          "Address3": "sample string 10",
          "Telephone": "sample string 11",
          "TelephoneExtension": "sample string 12",
          "Email": "sample string 13",
          "IsResidential": true,
          "TaxID": "sample string 15",
          "RecipientType": "sample string 16",
          "AccountNo": "sample string 17"
        },
        "OnHoldImportBooksPerBox": 32.0,
        "AccessionNumber": "sample string 33",
        "PackageNumber": 1,
        "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"
        },
        "LTLClassId": "sample string 35",
        "NMFCItem": "sample string 36",
        "NMFCSub": "sample string 37",
        "MID": "sample string 38"
      },
      {
        "ID": "sample string 1",
        "Description": "sample string 2",
        "MadeInCountryCode": "sample string 3",
        "Quantity": 4.0,
        "QuantityUnitOfMeasure": "sample string 5",
        "UnitValue": 6.0,
        "TotalWeight": 7.0,
        "ItemWeight": 8.0,
        "ItemLength": 9.0,
        "ItemWidth": 10.0,
        "ItemHeight": 11.0,
        "ItemMeasurementsType": 0,
        "HarmonizedCode": "sample string 12",
        "PartNumber": "sample string 13",
        "MarksOrNumbers": "sample string 14",
        "SKUOrItemOrUPS": "sample string 15",
        "SKUOrItemOrUPC": "sample string 16",
        "ExportLicense": "sample string 17",
        "LicenseExpireDate": "sample string 18",
        "NAFTA": true,
        "NAFTACommodityDetails": {
          "PreferenceCriterion": 0,
          "ProducerDetermination": 0,
          "NaftaNetCost": 0,
          "NetCostBeginDate": "2020-07-05T07:42:09.4839854-04:00",
          "NetCostEndDate": "2020-07-05T07:42:09.4849627-04:00"
        },
        "FDA": true,
        "FCC": true,
        "SenderIsProducer": true,
        "Textile": true,
        "TextileInformation": "sample string 24",
        "FCCEntryNumber": "sample string 25",
        "FCCPortOfEntry": "sample string 26",
        "FCCDeviceModel": "sample string 27",
        "FCCTradeName": "sample string 28",
        "FCCID": "sample string 29",
        "FCCDescribeRadioFrequency": "sample string 30",
        "IsDutiable": true,
        "Manufacturer": {
          "Id": "sample string 1",
          "PersonName": "sample string 2",
          "CompanyName": "sample string 3",
          "Country": "sample string 4",
          "State": "sample string 5",
          "City": "sample string 6",
          "PostalCode": "sample string 7",
          "Address1": "sample string 8",
          "Address2": "sample string 9",
          "Address3": "sample string 10",
          "Telephone": "sample string 11",
          "TelephoneExtension": "sample string 12",
          "Email": "sample string 13",
          "IsResidential": true,
          "TaxID": "sample string 15",
          "RecipientType": "sample string 16",
          "AccountNo": "sample string 17"
        },
        "OnHoldImportBooksPerBox": 32.0,
        "AccessionNumber": "sample string 33",
        "PackageNumber": 1,
        "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"
        },
        "LTLClassId": "sample string 35",
        "NMFCItem": "sample string 36",
        "NMFCSub": "sample string 37",
        "MID": "sample string 38"
      }
    ]
  },
  "ShipOptions": [
    {
      "value": "sample string 1",
      "code": 2
    },
    {
      "value": "sample string 1",
      "code": 2
    }
  ],
  "LocationId": 13,
  "LocationName": "sample string 14",
  "LocationAddressMatchWholeSenderAddress": true,
  "OrderNumber": "sample string 16",
  "CallbackURL": "sample string 17",
  "ServiceGroup": 18,
  "ServiceGroupName": "sample string 19",
  "MycarrierDetails": {
    "CarrierName": "sample string 1",
    "ServiceName": "sample string 2",
    "ProNo_TrackingNo": "sample string 3",
    "MyCarrierType": 0,
    "ListPrice": 4.0,
    "DiscountValue": 5.0,
    "DiscountType": 0,
    "FeulValue": 6.0,
    "FuelType": 0,
    "DeliveryDate": "2020-07-05T07:42:09.4898474-04:00"
  },
  "OrderInfo": {
    "BillToAddress": {
      "Name": "sample string 1",
      "Country": "sample string 2",
      "State": "sample string 3",
      "City": "sample string 4",
      "PostalCode": "sample string 5",
      "Address1": "sample string 6",
      "Address2": "sample string 7",
      "Telephone": "sample string 8"
    },
    "SalesNumber": "sample string 1",
    "PackingSlipNumber": "sample string 2",
    "PromoMessage": "sample string 3",
    "PaymentMethod": "sample string 4",
    "ShipVia": "sample string 5",
    "CreditCard": "sample string 6",
    "SubTotal": 7.0,
    "Taxes": 8.0,
    "GrandTotal": 9.0,
    "ShippingCost": 10.0,
    "OrderDate": "2020-07-05T07:42:09.4917993-04:00"
  },
  "DepartmentDescription": "sample string 20",
  "DepartmentCode": "sample string 21",
  "CustomerMarkups": [
    {
      "CarrierId": 1,
      "MarkupValue": 2.0,
      "MarkupType": 0
    },
    {
      "CarrierId": 1,
      "MarkupValue": 2.0,
      "MarkupType": 0
    }
  ],
  "ConsolidationUnit": {
    "ConsolidationUnitId": 1,
    "DeconsolidationAddress": {
      "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",
      "Telephone": "sample string 9",
      "Email": "sample string 10"
    },
    "DistributionDate": "2020-07-05T07:42:09.4927726Z",
    "ApplyType": 0,
    "CUCarrierID": 3,
    "CUServiceCode": "sample string 4",
    "SkidIndex": 5
  },
  "ApplyRate": true,
  "ApplyRateOptions": {
    "SaturdayDelivery": true,
    "SaturdayPickUp": true,
    "CollectOnDelivery": {
      "Ammount": 1.0
    },
    "SignatureRequired": true,
    "DangerousGoods": true
  },
  "DaysToSearchInHistory": 23,
  "BOLNumber": "sample string 24",
  "SpecialInstructions": "sample string 25",
  "ProjectId": "sample string 26",
  "CartonDescription": "sample string 27",
  "IsReturn": true,
  "ReturnShipment": {
    "EnableReturnShipment": true,
    "PrintReturnLabelWithOutboundLabel": true,
    "DuplicateTheReturn": true,
    "DifferentReturnAddress": true,
    "ReturnAddress": {
      "Id": "sample string 1",
      "PersonName": "sample string 2",
      "CompanyName": "sample string 3",
      "Country": "sample string 4",
      "State": "sample string 5",
      "City": "sample string 6",
      "PostalCode": "sample string 7",
      "Address1": "sample string 8",
      "Address2": "sample string 9",
      "Address3": "sample string 10",
      "Telephone": "sample string 11",
      "TelephoneExtension": "sample string 12",
      "Email": "sample string 13",
      "IsResidential": true,
      "TaxID": "sample string 15",
      "RecipientType": "sample string 16",
      "AccountNo": "sample string 17"
    }
  },
  "RequestPickup": true,
  "EmailLabels": true,
  "EmailsList": [
    "sample string 1",
    "sample string 2"
  ],
  "IsInboundShipment": true,
  "InboundShipmentLocationId": 32,
  "GLCategory": "sample string 33",
  "GLSubCategory": "sample string 34",
  "eAlerts": {
    "Events": {
      "Ship": true,
      "Exception": true,
      "Delivery": true,
      "OnEstimatedDelivery": true,
      "OnTender": true
    },
    "Emails": [
      {
        "Email": "sample string 1"
      },
      {
        "Email": "sample string 1"
      }
    ],
    "AdditionalMessage": "sample string 1",
    "AddPackageContents": true
  },
  "FilterByDeliveryDate": true,
  "MaxDeliveryDate": "2020-07-05T07:42:09.4966801-04:00",
  "RunAggregationAfterHold": true,
  "RunAggregationRateAfterHold": true,
  "ExcludeOrderFromAggregation": true,
  "PackagesCanMergeInASinglePackageOnAggregation": true,
  "ShipperLoadAndCount": "sample string 41",
  "BookingConfirmationNumber": "sample string 42",
  "LabelPrintPreferences": {
    "Encoding": 0,
    "OutputFormat": 0,
    "PackingSlipType": 0
  },
  "ShipByDate": "2020-07-05T07:42:09.4976546-04:00",
  "CalculatePackagesByContents": true,
  "CalculatePackagesByContentsOptions": {
    "PackageDimensions": [
      {
        "UseForFreight": true,
        "MaxWeight": 2.0,
        "Width": 3.0,
        "Length": 4.0,
        "Height": 5.0
      },
      {
        "UseForFreight": true,
        "MaxWeight": 2.0,
        "Width": 3.0,
        "Length": 4.0,
        "Height": 5.0
      }
    ],
    "DoNotRotateItems": true,
    "SplitPackagesAtSingleItemWeight": 2.0,
    "MinTotalWeightToAddSkidsToo": 3.0,
    "MaxSingleItemWeightForSkidsOnly": 4.0,
    "MaxWeight": 5.0,
    "MaxLength": 6.0,
    "MaxLengthPlusGirth": 7.0,
    "MaxSingleItemLengthForSkid": 8.0,
    "MaxSingleItemWidthForSkid": 9.0,
    "MaxSingleItemHeightForSkid": 10.0,
    "MaxSkidWeight": 11.0,
    "PaddingPercentage": 12
  },
  "InternalHandling": {
    "IsInternalHandling": true,
    "InternalHandlingText": "sample string 2"
  },
  "SourceOfOrder": "sample string 45",
  "Webhooks": [
    {
      "Uri": "http://webapihelppage1.com",
      "Username": "sample string 2",
      "Password": "sample string 3",
      "Type": 0
    },
    {
      "Uri": "http://webapihelppage1.com",
      "Username": "sample string 2",
      "Password": "sample string 3",
      "Type": 0
    }
  ],
  "OrderProcessingSync": true,
  "CustomCharacterOverlayOnLabel": "sample string 47"
}

application/xml, text/xml

Sample:

<HoldRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Hold">
  <AlternateSender>
    <AccountNo>sample string 17</AccountNo>
    <Address1>sample string 8</Address1>
    <Address2>sample string 9</Address2>
    <Address3>sample string 10</Address3>
    <City>sample string 6</City>
    <CompanyName>sample string 3</CompanyName>
    <Country>sample string 4</Country>
    <Email>sample string 13</Email>
    <Id>sample string 1</Id>
    <IsResidential>true</IsResidential>
    <PersonName>sample string 2</PersonName>
    <PostalCode>sample string 7</PostalCode>
    <RecipientType>sample string 16</RecipientType>
    <State>sample string 5</State>
    <TaxID>sample string 15</TaxID>
    <Telephone>sample string 11</Telephone>
    <TelephoneExtension>sample string 12</TelephoneExtension>
  </AlternateSender>
  <ApplyRate>true</ApplyRate>
  <ApplyRateOptions>
    <CollectOnDelivery>
      <Ammount>1</Ammount>
    </CollectOnDelivery>
    <DangerousGoods>true</DangerousGoods>
    <SaturdayDelivery>true</SaturdayDelivery>
    <SaturdayPickUp>true</SaturdayPickUp>
    <SignatureRequired>true</SignatureRequired>
  </ApplyRateOptions>
  <BOLNumber>sample string 24</BOLNumber>
  <Billing>
    <BillingAccount>sample string 1</BillingAccount>
    <BillingAddress>
      <AccountNo>sample string 17</AccountNo>
      <Address1>sample string 8</Address1>
      <Address2>sample string 9</Address2>
      <Address3>sample string 10</Address3>
      <City>sample string 6</City>
      <CompanyName>sample string 3</CompanyName>
      <Country>sample string 4</Country>
      <Email>sample string 13</Email>
      <Id>sample string 1</Id>
      <IsResidential>true</IsResidential>
      <PersonName>sample string 2</PersonName>
      <PostalCode>sample string 7</PostalCode>
      <RecipientType>sample string 16</RecipientType>
      <State>sample string 5</State>
      <TaxID>sample string 15</TaxID>
      <Telephone>sample string 11</Telephone>
      <TelephoneExtension>sample string 12</TelephoneExtension>
    </BillingAddress>
    <BillingType>Prepaid</BillingType>
    <ContractNumber>sample string 3</ContractNumber>
    <TransitNumber>sample string 2</TransitNumber>
  </Billing>
  <BookingConfirmationNumber>sample string 42</BookingConfirmationNumber>
  <CalculatePackagesByContents>true</CalculatePackagesByContents>
  <CalculatePackagesByContentsOptions>
    <DoNotRotateItems>true</DoNotRotateItems>
    <MaxLength>6</MaxLength>
    <MaxLengthPlusGirth>7</MaxLengthPlusGirth>
    <MaxSingleItemHeightForSkid>10</MaxSingleItemHeightForSkid>
    <MaxSingleItemLengthForSkid>8</MaxSingleItemLengthForSkid>
    <MaxSingleItemWeightForSkidsOnly>4</MaxSingleItemWeightForSkidsOnly>
    <MaxSingleItemWidthForSkid>9</MaxSingleItemWidthForSkid>
    <MaxSkidWeight>11</MaxSkidWeight>
    <MaxWeight>5</MaxWeight>
    <MinTotalWeightToAddSkidsToo>3</MinTotalWeightToAddSkidsToo>
    <PackageDimensions>
      <CalculatePackagesDimension_Hold>
        <Height>5</Height>
        <Length>4</Length>
        <MaxWeight>2</MaxWeight>
        <UseForFreight>true</UseForFreight>
        <Width>3</Width>
      </CalculatePackagesDimension_Hold>
      <CalculatePackagesDimension_Hold>
        <Height>5</Height>
        <Length>4</Length>
        <MaxWeight>2</MaxWeight>
        <UseForFreight>true</UseForFreight>
        <Width>3</Width>
      </CalculatePackagesDimension_Hold>
    </PackageDimensions>
    <PaddingPercentage>12</PaddingPercentage>
    <SplitPackagesAtSingleItemWeight>2</SplitPackagesAtSingleItemWeight>
  </CalculatePackagesByContentsOptions>
  <CallbackURL>sample string 17</CallbackURL>
  <CarrierId>2</CarrierId>
  <CarrierRoute>sample string 8</CarrierRoute>
  <CarrierSequence>sample string 9</CarrierSequence>
  <CartonDescription>sample string 27</CartonDescription>
  <ConsolidationUnit xmlns:d2p1="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Common">
    <d2p1:ApplyType>ById</d2p1:ApplyType>
    <d2p1:CUCarrierID>3</d2p1:CUCarrierID>
    <d2p1:CUServiceCode>sample string 4</d2p1:CUServiceCode>
    <d2p1:ConsolidationUnitId>1</d2p1:ConsolidationUnitId>
    <d2p1:DeconsolidationAddress>
      <d2p1:Address1>sample string 7</d2p1:Address1>
      <d2p1:Address2>sample string 8</d2p1:Address2>
      <d2p1:City>sample string 5</d2p1:City>
      <d2p1:CompanyName>sample string 2</d2p1:CompanyName>
      <d2p1:Country>sample string 3</d2p1:Country>
      <d2p1:Email>sample string 10</d2p1:Email>
      <d2p1:PersonName>sample string 1</d2p1:PersonName>
      <d2p1:PostalCode>sample string 6</d2p1:PostalCode>
      <d2p1:State>sample string 4</d2p1:State>
      <d2p1:Telephone>sample string 9</d2p1:Telephone>
    </d2p1:DeconsolidationAddress>
    <d2p1:DistributionDate>2020-07-05T07:42:09.4927726Z</d2p1:DistributionDate>
    <d2p1:SkidIndex>5</d2p1:SkidIndex>
  </ConsolidationUnit>
  <Contents>
    <Commodities>
      <Commodity>
        <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>
          <OverPacked>true</OverPacked>
          <PackagingContainerType>sample string 8</PackagingContainerType>
          <PackagingType>sample string 9</PackagingType>
          <PackingGroup>NONE</PackingGroup>
          <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 2</Description>
        <ExportLicense>sample string 17</ExportLicense>
        <FCC>true</FCC>
        <FCCDescribeRadioFrequency>sample string 30</FCCDescribeRadioFrequency>
        <FCCDeviceModel>sample string 27</FCCDeviceModel>
        <FCCEntryNumber>sample string 25</FCCEntryNumber>
        <FCCID>sample string 29</FCCID>
        <FCCPortOfEntry>sample string 26</FCCPortOfEntry>
        <FCCTradeName>sample string 28</FCCTradeName>
        <FDA>true</FDA>
        <HarmonizedCode>sample string 12</HarmonizedCode>
        <ID>sample string 1</ID>
        <IsDutiable>true</IsDutiable>
        <ItemHeight>11</ItemHeight>
        <ItemLength>9</ItemLength>
        <ItemMeasurementsType>Imperial</ItemMeasurementsType>
        <ItemWeight>8</ItemWeight>
        <ItemWidth>10</ItemWidth>
        <LTLClassId>sample string 35</LTLClassId>
        <LicenseExpireDate>sample string 18</LicenseExpireDate>
        <MID>sample string 38</MID>
        <MadeInCountryCode>sample string 3</MadeInCountryCode>
        <Manufacturer>
          <AccountNo>sample string 17</AccountNo>
          <Address1>sample string 8</Address1>
          <Address2>sample string 9</Address2>
          <Address3>sample string 10</Address3>
          <City>sample string 6</City>
          <CompanyName>sample string 3</CompanyName>
          <Country>sample string 4</Country>
          <Email>sample string 13</Email>
          <Id>sample string 1</Id>
          <IsResidential>true</IsResidential>
          <PersonName>sample string 2</PersonName>
          <PostalCode>sample string 7</PostalCode>
          <RecipientType>sample string 16</RecipientType>
          <State>sample string 5</State>
          <TaxID>sample string 15</TaxID>
          <Telephone>sample string 11</Telephone>
          <TelephoneExtension>sample string 12</TelephoneExtension>
        </Manufacturer>
        <MarksOrNumbers>sample string 14</MarksOrNumbers>
        <NAFTA>true</NAFTA>
        <NAFTACommodityDetails>
          <NaftaNetCost>NC</NaftaNetCost>
          <NetCostBeginDate>2020-07-05T07:42:09.4839854-04:00</NetCostBeginDate>
          <NetCostEndDate>2020-07-05T07:42:09.4849627-04:00</NetCostEndDate>
          <PreferenceCriterion>A</PreferenceCriterion>
          <ProducerDetermination>YES</ProducerDetermination>
        </NAFTACommodityDetails>
        <NMFCItem>sample string 36</NMFCItem>
        <NMFCSub>sample string 37</NMFCSub>
        <OnHoldImportBooksPerBox>32</OnHoldImportBooksPerBox>
        <PackageNumber>1</PackageNumber>
        <PartNumber>sample string 13</PartNumber>
        <Quantity>4</Quantity>
        <QuantityUnitOfMeasure>sample string 5</QuantityUnitOfMeasure>
        <SKUOrItemOrUPC>sample string 16</SKUOrItemOrUPC>
        <SKUOrItemOrUPS>sample string 15</SKUOrItemOrUPS>
        <SenderIsProducer>true</SenderIsProducer>
        <Textile>true</Textile>
        <TextileInformation>sample string 24</TextileInformation>
        <TotalWeight>7</TotalWeight>
        <UnitValue>6</UnitValue>
      </Commodity>
      <Commodity>
        <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>
          <OverPacked>true</OverPacked>
          <PackagingContainerType>sample string 8</PackagingContainerType>
          <PackagingType>sample string 9</PackagingType>
          <PackingGroup>NONE</PackingGroup>
          <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 2</Description>
        <ExportLicense>sample string 17</ExportLicense>
        <FCC>true</FCC>
        <FCCDescribeRadioFrequency>sample string 30</FCCDescribeRadioFrequency>
        <FCCDeviceModel>sample string 27</FCCDeviceModel>
        <FCCEntryNumber>sample string 25</FCCEntryNumber>
        <FCCID>sample string 29</FCCID>
        <FCCPortOfEntry>sample string 26</FCCPortOfEntry>
        <FCCTradeName>sample string 28</FCCTradeName>
        <FDA>true</FDA>
        <HarmonizedCode>sample string 12</HarmonizedCode>
        <ID>sample string 1</ID>
        <IsDutiable>true</IsDutiable>
        <ItemHeight>11</ItemHeight>
        <ItemLength>9</ItemLength>
        <ItemMeasurementsType>Imperial</ItemMeasurementsType>
        <ItemWeight>8</ItemWeight>
        <ItemWidth>10</ItemWidth>
        <LTLClassId>sample string 35</LTLClassId>
        <LicenseExpireDate>sample string 18</LicenseExpireDate>
        <MID>sample string 38</MID>
        <MadeInCountryCode>sample string 3</MadeInCountryCode>
        <Manufacturer>
          <AccountNo>sample string 17</AccountNo>
          <Address1>sample string 8</Address1>
          <Address2>sample string 9</Address2>
          <Address3>sample string 10</Address3>
          <City>sample string 6</City>
          <CompanyName>sample string 3</CompanyName>
          <Country>sample string 4</Country>
          <Email>sample string 13</Email>
          <Id>sample string 1</Id>
          <IsResidential>true</IsResidential>
          <PersonName>sample string 2</PersonName>
          <PostalCode>sample string 7</PostalCode>
          <RecipientType>sample string 16</RecipientType>
          <State>sample string 5</State>
          <TaxID>sample string 15</TaxID>
          <Telephone>sample string 11</Telephone>
          <TelephoneExtension>sample string 12</TelephoneExtension>
        </Manufacturer>
        <MarksOrNumbers>sample string 14</MarksOrNumbers>
        <NAFTA>true</NAFTA>
        <NAFTACommodityDetails>
          <NaftaNetCost>NC</NaftaNetCost>
          <NetCostBeginDate>2020-07-05T07:42:09.4839854-04:00</NetCostBeginDate>
          <NetCostEndDate>2020-07-05T07:42:09.4849627-04:00</NetCostEndDate>
          <PreferenceCriterion>A</PreferenceCriterion>
          <ProducerDetermination>YES</ProducerDetermination>
        </NAFTACommodityDetails>
        <NMFCItem>sample string 36</NMFCItem>
        <NMFCSub>sample string 37</NMFCSub>
        <OnHoldImportBooksPerBox>32</OnHoldImportBooksPerBox>
        <PackageNumber>1</PackageNumber>
        <PartNumber>sample string 13</PartNumber>
        <Quantity>4</Quantity>
        <QuantityUnitOfMeasure>sample string 5</QuantityUnitOfMeasure>
        <SKUOrItemOrUPC>sample string 16</SKUOrItemOrUPC>
        <SKUOrItemOrUPS>sample string 15</SKUOrItemOrUPS>
        <SenderIsProducer>true</SenderIsProducer>
        <Textile>true</Textile>
        <TextileInformation>sample string 24</TextileInformation>
        <TotalWeight>7</TotalWeight>
        <UnitValue>6</UnitValue>
      </Commodity>
    </Commodities>
    <Documents>
      <Document>
        <Description>sample string 1</Description>
        <IsDutiable>true</IsDutiable>
        <MadeInCountryCode>sample string 3</MadeInCountryCode>
        <UnitValue>2</UnitValue>
      </Document>
      <Document>
        <Description>sample string 1</Description>
        <IsDutiable>true</IsDutiable>
        <MadeInCountryCode>sample string 3</MadeInCountryCode>
        <UnitValue>2</UnitValue>
      </Document>
    </Documents>
  </Contents>
  <CustomCharacterOverlayOnLabel>sample string 47</CustomCharacterOverlayOnLabel>
  <CustomerMarkups>
    <CustomerMarkup_Hold>
      <CarrierId>1</CarrierId>
      <MarkupType>MarkupPercentage</MarkupType>
      <MarkupValue>2</MarkupValue>
    </CustomerMarkup_Hold>
    <CustomerMarkup_Hold>
      <CarrierId>1</CarrierId>
      <MarkupType>MarkupPercentage</MarkupType>
      <MarkupValue>2</MarkupValue>
    </CustomerMarkup_Hold>
  </CustomerMarkups>
  <DaysToSearchInHistory>23</DaysToSearchInHistory>
  <DepartmentCode>sample string 21</DepartmentCode>
  <DepartmentDescription>sample string 20</DepartmentDescription>
  <EmailLabels>true</EmailLabels>
  <EmailsList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </EmailsList>
  <ExcludeOrderFromAggregation>true</ExcludeOrderFromAggregation>
  <FilterByDeliveryDate>true</FilterByDeliveryDate>
  <GLCategory>sample string 33</GLCategory>
  <GLSubCategory>sample string 34</GLSubCategory>
  <InboundShipmentLocationId>32</InboundShipmentLocationId>
  <InternalHandling>
    <InternalHandlingText>sample string 2</InternalHandlingText>
    <IsInternalHandling>true</IsInternalHandling>
  </InternalHandling>
  <InternationalOptions>
    <Broker>
      <AccountNo>sample string 17</AccountNo>
      <Address1>sample string 8</Address1>
      <Address2>sample string 9</Address2>
      <Address3>sample string 10</Address3>
      <City>sample string 6</City>
      <CompanyName>sample string 3</CompanyName>
      <Country>sample string 4</Country>
      <Email>sample string 13</Email>
      <Id>sample string 1</Id>
      <IsResidential>true</IsResidential>
      <PersonName>sample string 2</PersonName>
      <PostalCode>sample string 7</PostalCode>
      <RecipientType>sample string 16</RecipientType>
      <State>sample string 5</State>
      <TaxID>sample string 15</TaxID>
      <Telephone>sample string 11</Telephone>
      <TelephoneExtension>sample string 12</TelephoneExtension>
    </Broker>
    <CustomsBillingOptions>
      <BillingAccount>sample string 1</BillingAccount>
      <BillingAddress>
        <AccountNo>sample string 17</AccountNo>
        <Address1>sample string 8</Address1>
        <Address2>sample string 9</Address2>
        <Address3>sample string 10</Address3>
        <City>sample string 6</City>
        <CompanyName>sample string 3</CompanyName>
        <Country>sample string 4</Country>
        <Email>sample string 13</Email>
        <Id>sample string 1</Id>
        <IsResidential>true</IsResidential>
        <PersonName>sample string 2</PersonName>
        <PostalCode>sample string 7</PostalCode>
        <RecipientType>sample string 16</RecipientType>
        <State>sample string 5</State>
        <TaxID>sample string 15</TaxID>
        <Telephone>sample string 11</Telephone>
        <TelephoneExtension>sample string 12</TelephoneExtension>
      </BillingAddress>
      <BillingType>Prepaid</BillingType>
      <ContractNumber>sample string 3</ContractNumber>
      <TransitNumber>sample string 2</TransitNumber>
    </CustomsBillingOptions>
    <CustomsDeclaration>
      <DHLCustomsDeclaration>
        <CommerceLicense>sample string 8</CommerceLicense>
        <ConsigneeEIN>sample string 5</ConsigneeEIN>
        <ConsigneeIdType>Select</ConsigneeIdType>
        <ECCN>sample string 4</ECCN>
        <FillingOption>Select</FillingOption>
        <FillingOptionValue>sample string 2</FillingOptionValue>
        <ImportLicense>sample string 7</ImportLicense>
        <InterConsignee>sample string 3</InterConsignee>
        <ScheduleB>sample string 1</ScheduleB>
        <ShipperEIN>sample string 6</ShipperEIN>
        <ShipperIdType>Select</ShipperIdType>
        <SignatureName>sample string 9</SignatureName>
        <SignatureTitle>sample string 10</SignatureTitle>
      </DHLCustomsDeclaration>
      <FedExCustomsDeclaration>
        <AESCitationType>Select</AESCitationType>
        <B13AFilingOption>NotRequired</B13AFilingOption>
        <DestinationControlStatementCountry xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </DestinationControlStatementCountry>
        <DestinationControlStatementRecipient>sample string 5</DestinationControlStatementRecipient>
        <DestinationControlStatementType>DepartmentOfCommerce</DestinationControlStatementType>
        <EEISEDFillingOption>Select</EEISEDFillingOption>
        <ExportPermitNumber>sample string 2</ExportPermitNumber>
        <ExportStatementData>sample string 1</ExportStatementData>
        <ExportStatementDataUS>sample string 4</ExportStatementDataUS>
        <FTR>sample string 3</FTR>
        <FedExCustomDeclarationType>NoDeclarationRequired</FedExCustomDeclarationType>
      </FedExCustomsDeclaration>
      <ImportExportType>Permanent</ImportExportType>
      <PurolatorServerCustomsDeclaration>
        <PurolatorServerBrokerCode>sample string 1</PurolatorServerBrokerCode>
      </PurolatorServerCustomsDeclaration>
      <ShipperAndExporterRelated>true</ShipperAndExporterRelated>
    </CustomsDeclaration>
    <DoNotPrintCI>true</DoNotPrintCI>
    <ExporterIsDifferentThanSender>true</ExporterIsDifferentThanSender>
    <ExporterOfRecord>
      <AccountNo>sample string 17</AccountNo>
      <Address1>sample string 8</Address1>
      <Address2>sample string 9</Address2>
      <Address3>sample string 10</Address3>
      <City>sample string 6</City>
      <CompanyName>sample string 3</CompanyName>
      <Country>sample string 4</Country>
      <Email>sample string 13</Email>
      <Id>sample string 1</Id>
      <IsResidential>true</IsResidential>
      <PersonName>sample string 2</PersonName>
      <PostalCode>sample string 7</PostalCode>
      <RecipientType>sample string 16</RecipientType>
      <State>sample string 5</State>
      <TaxID>sample string 15</TaxID>
      <Telephone>sample string 11</Telephone>
      <TelephoneExtension>sample string 12</TelephoneExtension>
    </ExporterOfRecord>
    <ImporterIsDifferentThanRecipient>true</ImporterIsDifferentThanRecipient>
    <ImporterOfRecord>
      <AccountNo>sample string 17</AccountNo>
      <Address1>sample string 8</Address1>
      <Address2>sample string 9</Address2>
      <Address3>sample string 10</Address3>
      <City>sample string 6</City>
      <CompanyName>sample string 3</CompanyName>
      <Country>sample string 4</Country>
      <Email>sample string 13</Email>
      <Id>sample string 1</Id>
      <IsResidential>true</IsResidential>
      <PersonName>sample string 2</PersonName>
      <PostalCode>sample string 7</PostalCode>
      <RecipientType>sample string 16</RecipientType>
      <State>sample string 5</State>
      <TaxID>sample string 15</TaxID>
      <Telephone>sample string 11</Telephone>
      <TelephoneExtension>sample string 12</TelephoneExtension>
    </ImporterOfRecord>
    <Invoice>
      <AdditionalChargesAmount>7</AdditionalChargesAmount>
      <Amount>1</Amount>
      <CertificateNumber>sample string 8</CertificateNumber>
      <Comment>sample string 3</Comment>
      <Curency>sample string 4</Curency>
      <Currency>sample string 5</Currency>
      <ExcludeFromFedExIGC>true</ExcludeFromFedExIGC>
      <FreightChargeAmount>6</FreightChargeAmount>
      <InvoiceNumber>sample string 2</InvoiceNumber>
      <Purpose>Sold</Purpose>
      <TermsOfSale>FreeCarrier_FreeOnBoard</TermsOfSale>
      <UploadCustomsDocumentsElectronically>true</UploadCustomsDocumentsElectronically>
      <UseCustomProformaCI>true</UseCustomProformaCI>
    </Invoice>
    <NAFTADeclarationDetails>
      <NAFTABlankedPeriodEnd>2020-07-05T07:42:09.482031-04:00</NAFTABlankedPeriodEnd>
      <NAFTABlankedPeriodStart>2020-07-05T07:42:09.4810563-04:00</NAFTABlankedPeriodStart>
      <NaftaImporterSpecification>Importer</NaftaImporterSpecification>
      <NaftaProducerSpecification>Available_Upon_Request</NaftaProducerSpecification>
    </NAFTADeclarationDetails>
    <SoldTo>
      <AccountNo>sample string 17</AccountNo>
      <Address1>sample string 8</Address1>
      <Address2>sample string 9</Address2>
      <Address3>sample string 10</Address3>
      <City>sample string 6</City>
      <CompanyName>sample string 3</CompanyName>
      <Country>sample string 4</Country>
      <Email>sample string 13</Email>
      <Id>sample string 1</Id>
      <IsResidential>true</IsResidential>
      <PersonName>sample string 2</PersonName>
      <PostalCode>sample string 7</PostalCode>
      <RecipientType>sample string 16</RecipientType>
      <State>sample string 5</State>
      <TaxID>sample string 15</TaxID>
      <Telephone>sample string 11</Telephone>
      <TelephoneExtension>sample string 12</TelephoneExtension>
    </SoldTo>
    <SoldToIsDifferentThenImporterOfRecords>true</SoldToIsDifferentThenImporterOfRecords>
    <UseSoldToOnCI>true</UseSoldToOnCI>
  </InternationalOptions>
  <IsInboundShipment>true</IsInboundShipment>
  <IsReturn>true</IsReturn>
  <LabelPrintPreferences>
    <Encoding>PDF</Encoding>
    <OutputFormat>Format_85x11</OutputFormat>
    <PackingSlipType>Default</PackingSlipType>
  </LabelPrintPreferences>
  <LocationAddressMatchWholeSenderAddress>true</LocationAddressMatchWholeSenderAddress>
  <LocationId>13</LocationId>
  <LocationName>sample string 14</LocationName>
  <MaxDeliveryDate>2020-07-05T07:42:09.4966801-04:00</MaxDeliveryDate>
  <MycarrierDetails>
    <CarrierName>sample string 1</CarrierName>
    <DeliveryDate>2020-07-05T07:42:09.4898474-04:00</DeliveryDate>
    <DiscountType>FixedValue</DiscountType>
    <DiscountValue>5</DiscountValue>
    <FeulValue>6</FeulValue>
    <FuelType>FixedValue</FuelType>
    <ListPrice>4</ListPrice>
    <MyCarrierType>LTL</MyCarrierType>
    <ProNo_TrackingNo>sample string 3</ProNo_TrackingNo>
    <ServiceName>sample string 2</ServiceName>
  </MycarrierDetails>
  <OrderInfo>
    <BillToAddress>
      <Address1>sample string 6</Address1>
      <Address2>sample string 7</Address2>
      <City>sample string 4</City>
      <Country>sample string 2</Country>
      <Name>sample string 1</Name>
      <PostalCode>sample string 5</PostalCode>
      <State>sample string 3</State>
      <Telephone>sample string 8</Telephone>
    </BillToAddress>
    <CreditCard>sample string 6</CreditCard>
    <GrandTotal>9</GrandTotal>
    <OrderDate>2020-07-05T07:42:09.4917993-04:00</OrderDate>
    <PackingSlipNumber>sample string 2</PackingSlipNumber>
    <PaymentMethod>sample string 4</PaymentMethod>
    <PromoMessage>sample string 3</PromoMessage>
    <SalesNumber>sample string 1</SalesNumber>
    <ShipVia>sample string 5</ShipVia>
    <ShippingCost>10</ShippingCost>
    <SubTotal>7</SubTotal>
    <Taxes>8</Taxes>
  </OrderInfo>
  <OrderNumber>sample string 16</OrderNumber>
  <OrderProcessingSync>true</OrderProcessingSync>
  <Packages>
    <Package_Hold>
      <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>
      <Reference1>sample string 11</Reference1>
      <Reference2>sample string 12</Reference2>
      <ShipmentId>sample string 16</ShipmentId>
      <SkidDescription>sample string 15</SkidDescription>
      <Weight>1</Weight>
      <WeightType>Pounds</WeightType>
      <Width>2</Width>
    </Package_Hold>
    <Package_Hold>
      <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>
      <Reference1>sample string 11</Reference1>
      <Reference2>sample string 12</Reference2>
      <ShipmentId>sample string 16</ShipmentId>
      <SkidDescription>sample string 15</SkidDescription>
      <Weight>1</Weight>
      <WeightType>Pounds</WeightType>
      <Width>2</Width>
    </Package_Hold>
  </Packages>
  <PackagesAreSkids>true</PackagesAreSkids>
  <PackagesCanMergeInASinglePackageOnAggregation>true</PackagesCanMergeInASinglePackageOnAggregation>
  <PickupDate>2020-07-05T07:42:09.4761735Z</PickupDate>
  <ProjectId>sample string 26</ProjectId>
  <Recipient>
    <AccountNo>sample string 17</AccountNo>
    <Address1>sample string 8</Address1>
    <Address2>sample string 9</Address2>
    <Address3>sample string 10</Address3>
    <City>sample string 6</City>
    <CompanyName>sample string 3</CompanyName>
    <Country>sample string 4</Country>
    <Email>sample string 13</Email>
    <Id>sample string 1</Id>
    <IsResidential>true</IsResidential>
    <PersonName>sample string 2</PersonName>
    <PostalCode>sample string 7</PostalCode>
    <RecipientType>sample string 16</RecipientType>
    <State>sample string 5</State>
    <TaxID>sample string 15</TaxID>
    <Telephone>sample string 11</Telephone>
    <TelephoneExtension>sample string 12</TelephoneExtension>
  </Recipient>
  <RequestPickup>true</RequestPickup>
  <ReturnShipment>
    <DifferentReturnAddress>true</DifferentReturnAddress>
    <DuplicateTheReturn>true</DuplicateTheReturn>
    <EnableReturnShipment>true</EnableReturnShipment>
    <PrintReturnLabelWithOutboundLabel>true</PrintReturnLabelWithOutboundLabel>
    <ReturnAddress>
      <AccountNo>sample string 17</AccountNo>
      <Address1>sample string 8</Address1>
      <Address2>sample string 9</Address2>
      <Address3>sample string 10</Address3>
      <City>sample string 6</City>
      <CompanyName>sample string 3</CompanyName>
      <Country>sample string 4</Country>
      <Email>sample string 13</Email>
      <Id>sample string 1</Id>
      <IsResidential>true</IsResidential>
      <PersonName>sample string 2</PersonName>
      <PostalCode>sample string 7</PostalCode>
      <RecipientType>sample string 16</RecipientType>
      <State>sample string 5</State>
      <TaxID>sample string 15</TaxID>
      <Telephone>sample string 11</Telephone>
      <TelephoneExtension>sample string 12</TelephoneExtension>
    </ReturnAddress>
  </ReturnShipment>
  <RunAggregationAfterHold>true</RunAggregationAfterHold>
  <RunAggregationRateAfterHold>true</RunAggregationRateAfterHold>
  <Sender>
    <AccountNo>sample string 17</AccountNo>
    <Address1>sample string 8</Address1>
    <Address2>sample string 9</Address2>
    <Address3>sample string 10</Address3>
    <City>sample string 6</City>
    <CompanyName>sample string 3</CompanyName>
    <Country>sample string 4</Country>
    <Email>sample string 13</Email>
    <Id>sample string 1</Id>
    <IsResidential>true</IsResidential>
    <PersonName>sample string 2</PersonName>
    <PostalCode>sample string 7</PostalCode>
    <RecipientType>sample string 16</RecipientType>
    <State>sample string 5</State>
    <TaxID>sample string 15</TaxID>
    <Telephone>sample string 11</Telephone>
    <TelephoneExtension>sample string 12</TelephoneExtension>
  </Sender>
  <ServiceCode>sample string 12</ServiceCode>
  <ServiceGroup>18</ServiceGroup>
  <ServiceGroupName>sample string 19</ServiceGroupName>
  <ShipByDate>2020-07-05T07:42:09.4976546-04:00</ShipByDate>
  <ShipOptions>
    <ShipmentOption>
      <code>2</code>
      <value>sample string 1</value>
    </ShipmentOption>
    <ShipmentOption>
      <code>2</code>
      <value>sample string 1</value>
    </ShipmentOption>
  </ShipOptions>
  <ShipmentInstructions>sample string 7</ShipmentInstructions>
  <ShipmentPONumber>sample string 10</ShipmentPONumber>
  <ShipmentReference>sample string 5</ShipmentReference>
  <ShipmentReference2>sample string 6</ShipmentReference2>
  <ShipperLoadAndCount>sample string 41</ShipperLoadAndCount>
  <SourceOfOrder>sample string 45</SourceOfOrder>
  <SpecialInstructions>sample string 25</SpecialInstructions>
  <UseAlternateSenderOnLabel>true</UseAlternateSenderOnLabel>
  <WS_Key>sample string 1</WS_Key>
  <Webhooks>
    <Webhook_Hold>
      <Password>sample string 3</Password>
      <Type>ShipmentStatusChange</Type>
      <Uri>http://webapihelppage1.com/</Uri>
      <Username>sample string 2</Username>
    </Webhook_Hold>
    <Webhook_Hold>
      <Password>sample string 3</Password>
      <Type>ShipmentStatusChange</Type>
      <Uri>http://webapihelppage1.com/</Uri>
      <Username>sample string 2</Username>
    </Webhook_Hold>
  </Webhooks>
  <eAlerts>
    <AddPackageContents>true</AddPackageContents>
    <AdditionalMessage>sample string 1</AdditionalMessage>
    <Emails>
      <eAlertEmail>
        <Email>sample string 1</Email>
      </eAlertEmail>
      <eAlertEmail>
        <Email>sample string 1</Email>
      </eAlertEmail>
    </Emails>
    <Events>
      <Delivery>true</Delivery>
      <Exception>true</Exception>
      <OnEstimatedDelivery>true</OnEstimatedDelivery>
      <OnTender>true</OnTender>
      <Ship>true</Ship>
    </Events>
  </eAlerts>
</HoldRequest>

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.Hold.HoldRequest'.

Response Information

Resource Description

WS_Repository.Models.Responses.Hold.HoldResponse

Name	Description	Type	Additional information
HoldShipmentId	Internal 2ship Hold Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "HoldShipmentId": 1
}

application/xml, text/xml

Sample:

<HoldResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.Hold">
  <HoldShipmentId>1</HoldShipmentId>
</HoldResponse>