POST api/Ship_V1
Ship an order and get back all the documents
Request Information
URI Parameters
None.
Body Parameters
The request is presented below!
WS_Repository.Models.Requests.Ship.CarrierShipRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| WS_Key |
(Mandatory) Webservice Key provided by 2ship support |
string |
None. |
| CarrierId |
(Conditionally Required) Carrier ID to ship with - if not specified then it must be specified the ShipByServiceGroup and ShipByServiceGroupOptions fields |
integer |
None. |
| Sender |
(Mandatory) Sender Contact |
WS_Repository.Models.Requests.Ship.Contact |
None. |
| ShipFromLockerOrLocation |
(Optional) Specify ship from a locker / carrier location / carrier retail location |
boolean |
None. |
| ShipFromLocationLockerInfo |
(Required if ShipFromLockerOrLocation = true) |
WS_Repository.Models.Common.ShipFromLocationLockerInfo |
None. |
| ShipToLockerOrLocation |
(Optional) Specify ship to a locker / carrier location / carrier retail location |
boolean |
None. |
| ShipToLocationLockerInfo |
(Required if ShipFromLockerOrLocation = true) |
WS_Repository.Models.Common.ShipToLocationLockerInfo |
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.Ship.Contact |
None. |
| Recipient |
(Mandatory) Recipient Contact |
WS_Repository.Models.Requests.Ship.Contact |
None. |
| CrossDockAddress |
(Optional) Cross Dock Address - used for 2 leg shipments to determinate the middle address of the shipment. this address become 1'st leg recipient and 2'nd leg sender |
WS_Repository.Models.Requests.Ship.Contact |
None. |
| RecipientIsAutomatedParcelMachineLocation |
(Optional) Specify that the Recipient is an Automated Parcel Machine Location |
boolean |
None. |
| AutomatedParcelMachineLocationId |
(Mandatory if RecipientIsAutomatedParcelMachineLocation = true) Specify Automated Parcel Machine Location Id/Code |
string |
None. |
| UseDropOffToAPM |
(Optional) Sender will Drop off the shipment to Automated Parcel Machine |
boolean |
None. |
| MaxDistanceToDropOff_APM |
(Mandatory if UseDropOffTo_APM = true) the maximum distance of a Drop Off Automated Parcel Machine (valid values: 0.1 ... 100 km/miles), used for getting the nearest drop off APM locations |
decimal number |
None. |
| MaxDistanceToDropOff_APM_UM |
(Optional) the default value is Kilometers |
WS_Repository.Models.Requests.Ship.DistanceType |
None. |
| APM_SystemId |
(Mandatory if RecipientIsAutomatedParcelMachineLocation = true or UseDropOffToAPM = true) Specify the system id wich send the request (ex. 101, 102....) |
string |
None. |
| APM_SystemName |
(Mandatory if RecipientIsAutomatedParcelMachineLocation = true or UseDropOffToAPM = true) Specify the system name wich send the request (ex. 2ship...) |
string |
None. |
| HasQRCodeLabelPrinting |
(Optional) Drop Off Location has QR code label printing available |
boolean |
None. |
| Packages |
(Mandatory) Array of Package |
Collection of WS_Repository.Models.Requests.Ship.Package |
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.Ship.CalculatePackagesByContentsOptions |
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. |
| 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. |
| ShipmentInstructions |
(Optional) Shipment Instructions, used for 4x8 doctab label |
string |
None. |
| ShipmentProtection |
(Optional) the Value of your Shipment (this can influence the cost of your shipment) |
decimal number |
None. |
| ShipmentProtectionCurrency |
(Optional) the Currency of you Insurance Value(CAD, USD... etc) |
string |
None. |
| CarrierRoute |
(Optional) Carrier Route, used for 4x8 doctab label |
string |
None. |
| CarrierSequence |
(Optional) Carrier Sequence, used for 4x8 doctab label |
string |
None. |
| InternalRoutingCode |
(Optional) Internal Routing Code, used for 4x8 doctab label |
string |
None. |
| PickupDate |
(Optional) The Ship Date (default is today) |
date |
None. |
| Billing |
(Optional) used to rate/ship with other account |
WS_Repository.Models.Requests.Ship.BillingOptions |
None. |
| ServiceCode |
(Conditionally Required) Carrier Service Code - if not specified then it must be specified the ShipByServiceGroup and ShipByServiceGroupOptions fields |
string |
None. |
| InternationalOptions |
(Optional) International Options of the shipment(mandatory if the shipment is international) |
WS_Repository.Models.Requests.Ship.InternationalOptions |
None. |
| Contents |
(Optional) Contents of the shipment packages |
WS_Repository.Models.Requests.Ship.Contents |
None. |
| ShipOptions |
(Optional) Options of the shipment - for a pecific carrier |
Collection of WS_Repository.Models.Requests.Ship.ShipmentOption |
None. |
| GlobalOptions |
(Optional) Global Shipment Options - For all carriers |
WS_Repository.Models.Common.GlobalOptions |
None. |
| LocationId |
(Optional) If not set will use 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. |
| LabelPrintPreferences |
(Optional) label printing preferences (Default is PDF and Format 8.5x11 in) |
WS_Repository.Models.Requests.Ship.LabelPrintPreferencesType |
None. |
| MycarrierDetails |
(Optional) when the carrier is My Carrier(999) here you can populate your carrier info |
WS_Repository.Models.Requests.Ship.MyCarrierDetails |
None. |
| OrderInfo |
(Optional) Order Info (MANDATORY when LabelPrintPreferencesType.OutputFormat = Format_PackingSlip_85x11) |
WS_Repository.Models.Requests.Ship.OrderInfo |
None. |
| DepartmentDescription |
(Optional) Department Description |
string |
None. |
| ShipByServiceGroup |
(Optional) Specify that the shipping carrier/service will be retrieve by a service group specified on the ShipByServiceGroupOptions field |
boolean |
None. |
| ShipByServiceGroupOptions |
(Conditionally required) Ship By ServiceG roup Options |
WS_Repository.Models.Requests.Ship.ShipByServiceGroupOptions |
None. |
| DepartmentCode |
(Optional) Department Code |
string |
None. |
| CustomerMarkup |
(Optional) Provide your own value for Customer Pricing calculation |
WS_Repository.Models.Requests.Ship.CustomerMarkup |
None. |
| ConsolidationUnit |
(Optional) Used to consolidate the shipment |
WS_Repository.Models.Common.ConsolidationUnit |
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. |
| PickupRequest |
Schedule a Pickup Request with the shipment creation |
WS_Repository.Models.Requests.Ship.PickupRequest |
None. |
| RetrieveBase64StringDocuments |
Use to get in the response also the documents in Base64String format |
boolean |
None. |
| BOLNumber |
(Optional) BOL Number (Used by ltl carriers to apear on Bill Of Lading) |
string |
None. |
| RemoveExistingOnholdOrder |
(Optional) Flag to specify to search and remove the existing onhold order - the search will be made if the OrderNumber field is provided |
boolean |
None. |
| SpecialInstructions |
(Optional) Special Instruction (Used by ltl carriers to apear on Bill Of Lading) |
string |
None. |
| RateCurrencySelect |
(Optional) Used to return rates in your selected currency using the 2Ship exchange rate from openexchangerates.org |
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. |
| OriginalShipmentInfo |
(Optional) Information about Original Shipment (Shipment Id or Tracking Number) |
WS_Repository.Models.Requests.Ship.OriginalShipmentInfo |
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. |
| InboundShipmentLocationName |
(Optional) if shipment is Inbound then add inbound location name. Note: can be null, inbound location name can be assigned in OPS |
string |
None. |
| GLCategory |
(Optional) General Ledger Category |
string |
None. |
| GLSubCategory |
(Optional) General Ledger sub Category |
string |
None. |
| EmailShippingDocuments |
(Optional) Used to send the shipping documents by email; |
WS_Repository.Models.Requests.Ship.EmailDocuments |
None. |
| UseUserPreferencesForEAlerts |
(Optional) Specify to use user preferences for eAlerts |
boolean |
None. |
| eAlerts |
(Optional) eAlert - send email alerts to the specified email list for the spcified events |
WS_Repository.Models.Requests.Ship.eAlerts |
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. |
| 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. |
| SourceOfOrder |
(Optional) This field will store source of order for history, search, reports, etc. (Maximum length = 100 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.Ship.Webhook |
None. |
| CustomCharacterOverlayOnLabel |
(Optional) Custom Character Overlay On Label (Max 1 character) |
string |
None. |
| CheckAndDeleteFromOnHold |
(Optional) Check if the order # you specify on the OrderNumber field if exists in onhold and delete it if this request is succeeded |
boolean |
None. |
| UseDefaultGlobalShipmentOptions |
(Optional) It specify to load the default global options from 2Ship |
boolean |
None. |
| SkipOrderIsAlreadyShippedCheck |
(Optional) if OrderNumber is present in your request and if you set this flag then it skip the checking if this order number is already shippend |
boolean |
None. |
| PreAssignTrackingNumber |
(Optional) Tracking Number pre-assign - Used by some carriers that accept this feautere |
string |
None. |
| ApplyDutiesAndTaxes |
(Optional) It specify to get estimated duties and taxes cost for international shipments |
boolean |
None. |
| ShipWithoutAPrinter |
(Optional) Use this filter to find the Carrier services that allow you to ship without the need for a printed label |
boolean |
None. |
| CustomField1 |
(Optional) Used to make rules with it |
string |
None. |
| CustomField2 |
(Optional) Used to make rules with it |
string |
None. |
| CustomField3 |
(Optional) Used to make rules with it |
string |
None. |
| CustomField4 |
(Optional) Used to make rules with it |
string |
None. |
| CustomField5 |
(Optional) Used to make rules with it |
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"
},
"ShipFromLockerOrLocation": true,
"ShipFromLocationLockerInfo": {
"Id": "sample string 1",
"Postal": "sample string 2",
"City": "sample string 3",
"State": "sample string 4",
"Country": "sample string 5",
"Address1": "sample string 6",
"Address2": "sample string 7",
"Address3": "sample string 8",
"Name": "sample string 9",
"LocationType": 0,
"LocationTypeDescription": "sample string 10"
},
"ShipToLockerOrLocation": true,
"ShipToLocationLockerInfo": {
"Id": "sample string 1",
"Postal": "sample string 2",
"City": "sample string 3",
"State": "sample string 4",
"Country": "sample string 5",
"Address1": "sample string 6",
"Address2": "sample string 7",
"Address3": "sample string 8",
"Name": "sample string 9",
"LocationType": 0,
"LocationTypeDescription": "sample string 10"
},
"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"
},
"CrossDockAddress": {
"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"
},
"RecipientIsAutomatedParcelMachineLocation": true,
"AutomatedParcelMachineLocationId": "sample string 7",
"UseDropOffToAPM": true,
"MaxDistanceToDropOff_APM": 9.0,
"MaxDistanceToDropOff_APM_UM": 0,
"APM_SystemId": "sample string 10",
"APM_SystemName": "sample string 11",
"HasQRCodeLabelPrinting": 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",
"OriginalWeight": 16.0,
"ShipmentId": "sample string 17",
"InvoiceNo": "sample string 18",
"IsStackable": true,
"OnHoldAggregatedOrderNumber": "sample string 20",
"LicencePlate": "sample string 21",
"PreAssignTrackingNumber": "sample string 22",
"ApplyWeightAndDimsFromTheAssignedCommodity": 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",
"OriginalWeight": 16.0,
"ShipmentId": "sample string 17",
"InvoiceNo": "sample string 18",
"IsStackable": true,
"OnHoldAggregatedOrderNumber": "sample string 20",
"LicencePlate": "sample string 21",
"PreAssignTrackingNumber": "sample string 22",
"ApplyWeightAndDimsFromTheAssignedCommodity": true
}
],
"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,
"EnableBoxBalancing": true
},
"ShipmentReference": "sample string 14",
"ShipmentReference2": "sample string 15",
"ShipmentPONumber": "sample string 16",
"ShipmentInstructions": "sample string 17",
"ShipmentProtection": 18.0,
"ShipmentProtectionCurrency": "sample string 19",
"CarrierRoute": "sample string 20",
"CarrierSequence": "sample string 21",
"InternalRoutingCode": "sample string 22",
"PickupDate": "2024-04-26T09:45:53.7986531Z",
"Billing": {
"BillingAccountName": "sample string 1",
"LoadAccountDetailsByNumber": true,
"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 3",
"TransitNumber": "sample string 4",
"ContractNumber": "sample string 5",
"SplitDutyVATIndicator": true
},
"ServiceCode": "sample string 24",
"InternationalOptions": {
"CustomsBillingOptions": {
"BillingAccountName": "sample string 1",
"LoadAccountDetailsByNumber": true,
"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 3",
"TransitNumber": "sample string 4",
"ContractNumber": "sample string 5",
"SplitDutyVATIndicator": true
},
"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,
"AdditionalChargesDescription": "sample string 8",
"CertificateNumber": "sample string 9",
"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,
"DoNotPrintCustomDocuments": 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": "2024-04-26T09:45:53.8035068-04:00",
"NAFTABlankedPeriodEnd": "2024-04-26T09:45:53.8035068-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,
"TaxPercentage": 1.0,
"TaxesAreIncluded": true,
"TotalWeight": 7.0,
"ItemWeight": 8.0,
"ItemLength": 9.0,
"ItemWidth": 10.0,
"ItemHeight": 11.0,
"ItemMeasurementsType": 0,
"HarmonizedCode": "sample string 12",
"Canada_HarmonizedCode": "sample string 13",
"USA_HarmonizedCode": "sample string 14",
"SerialNumber": "sample string 15",
"PartNumber": "sample string 16",
"MarksOrNumbers": "sample string 17",
"SKUOrItemOrUPS": "sample string 18",
"SKUOrItemOrUPC": "sample string 19",
"ExportLicense": "sample string 20",
"LicenseExpireDate": "sample string 21",
"NAFTA": true,
"NAFTACommodityDetails": {
"PreferenceCriterion": 0,
"ProducerDetermination": 0,
"NaftaNetCost": 0,
"NetCostBeginDate": "2024-04-26T09:45:53.8065079-04:00",
"NetCostEndDate": "2024-04-26T09:45:53.8065079-04:00"
},
"FDA": true,
"FCC": true,
"SenderIsProducer": true,
"Textile": true,
"TextileInformation": "sample string 27",
"FCCEntryNumber": "sample string 28",
"FCCPortOfEntry": "sample string 29",
"FCCDeviceModel": "sample string 30",
"FCCTradeName": "sample string 31",
"FCCID": "sample string 32",
"FCCDescribeRadioFrequency": "sample string 33",
"FDADescription": "sample string 34",
"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": 36.0,
"AccessionNumber": "sample string 37",
"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 39",
"NMFCItem": "sample string 40",
"NMFCSub": "sample string 41",
"MID": "sample string 42",
"LBSLTSFactor": 1.0,
"ShipAsItsOwnPackage": true,
"ShipInAnyPackage": true,
"ShipsOnSkidOnly": true,
"PlantArticle": true,
"PlantArticleGenus": "sample string 47",
"PlantArticleSpecies": "sample string 48",
"PlantArticleQuantity": "sample string 49",
"PlantArticlePercentRecycled": "sample string 50",
"ECCN": "sample string 52"
},
{
"ID": "sample string 1",
"Description": "sample string 2",
"MadeInCountryCode": "sample string 3",
"Quantity": 4.0,
"QuantityUnitOfMeasure": "sample string 5",
"UnitValue": 6.0,
"TaxPercentage": 1.0,
"TaxesAreIncluded": true,
"TotalWeight": 7.0,
"ItemWeight": 8.0,
"ItemLength": 9.0,
"ItemWidth": 10.0,
"ItemHeight": 11.0,
"ItemMeasurementsType": 0,
"HarmonizedCode": "sample string 12",
"Canada_HarmonizedCode": "sample string 13",
"USA_HarmonizedCode": "sample string 14",
"SerialNumber": "sample string 15",
"PartNumber": "sample string 16",
"MarksOrNumbers": "sample string 17",
"SKUOrItemOrUPS": "sample string 18",
"SKUOrItemOrUPC": "sample string 19",
"ExportLicense": "sample string 20",
"LicenseExpireDate": "sample string 21",
"NAFTA": true,
"NAFTACommodityDetails": {
"PreferenceCriterion": 0,
"ProducerDetermination": 0,
"NaftaNetCost": 0,
"NetCostBeginDate": "2024-04-26T09:45:53.8065079-04:00",
"NetCostEndDate": "2024-04-26T09:45:53.8065079-04:00"
},
"FDA": true,
"FCC": true,
"SenderIsProducer": true,
"Textile": true,
"TextileInformation": "sample string 27",
"FCCEntryNumber": "sample string 28",
"FCCPortOfEntry": "sample string 29",
"FCCDeviceModel": "sample string 30",
"FCCTradeName": "sample string 31",
"FCCID": "sample string 32",
"FCCDescribeRadioFrequency": "sample string 33",
"FDADescription": "sample string 34",
"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": 36.0,
"AccessionNumber": "sample string 37",
"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 39",
"NMFCItem": "sample string 40",
"NMFCSub": "sample string 41",
"MID": "sample string 42",
"LBSLTSFactor": 1.0,
"ShipAsItsOwnPackage": true,
"ShipInAnyPackage": true,
"ShipsOnSkidOnly": true,
"PlantArticle": true,
"PlantArticleGenus": "sample string 47",
"PlantArticleSpecies": "sample string 48",
"PlantArticleQuantity": "sample string 49",
"PlantArticlePercentRecycled": "sample string 50",
"ECCN": "sample string 52"
}
]
},
"ShipOptions": null,
"GlobalOptions": {
"SaturdayDelivery": true,
"SaturdayPickUp": true,
"CollectOnDelivery": {
"Amount": 1.0
},
"SignatureRequired": true,
"SignatureOption": 0,
"CheckOnDelivery": true,
"DangerousGoods": true,
"ShipToLocker": true,
"ShipToRetail": true,
"ShipToCarrier": true,
"ShipFromLocker": true,
"ShipFromRetail": true,
"ShipFromCarrier": true
},
"LocationId": 25,
"LocationName": "sample string 26",
"LocationAddressMatchWholeSenderAddress": true,
"OrderNumber": "sample string 28",
"LabelPrintPreferences": {
"Encoding": 0,
"OutputFormat": 0,
"PackingSlipType": 0
},
"MycarrierDetails": {
"CarrierName": "sample string 1",
"ServiceName": "sample string 2",
"ProNo_TrackingNo": "sample string 3",
"MyCarrierType": 0,
"ListPrice": 4.0,
"DiscountValue": 5.0,
"AccountFreight": 1.0,
"ClientFreight": 1.0,
"DiscountType": 0,
"FeulValue": 6.0,
"FuelType": 0,
"DeliveryDate": "2024-04-26T09:45:53.8217216-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": "2024-04-26T09:45:53.8225197-04:00"
},
"DepartmentDescription": "sample string 29",
"ShipByServiceGroup": true,
"ShipByServiceGroupOptions": {
"ServiceGroupID": 1,
"ServiceGroupName": "sample string 2",
"GetServiceByGroupType": 0
},
"DepartmentCode": "sample string 31",
"CustomerMarkup": {
"MarkupValue": 1.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": "2024-04-26T09:45:53.8265242Z",
"ApplyType": 0,
"CUCarrierID": 3,
"CUServiceCode": "sample string 4",
"SkidIndex": 5,
"CheckSenderAddress": true,
"CheckDistributionDate": true,
"DeconsolidationLocationId": 1,
"DeconsolidationLocationName": "sample string 8"
},
"DaysToSearchInHistory": 32,
"PickupRequest": {
"RequestAPickup": true,
"ReadyTime": "sample string 2",
"CompanyCloseTime": "sample string 3",
"PurolatorPickupRequest": {
"StreetNumber": "sample string 1",
"StreetType": "sample string 2",
"LoadingDockAvailable": true,
"Trailer53Accessible": true
},
"UPSPickupRequest": {
"OverweightIndicator": true,
"UPSPickupType": 0
}
},
"RetrieveBase64StringDocuments": true,
"BOLNumber": "sample string 34",
"RemoveExistingOnholdOrder": true,
"SpecialInstructions": "sample string 36",
"RateCurrencySelect": "sample string 37",
"CartonDescription": "sample string 38",
"IsReturn": true,
"OriginalShipmentInfo": {
"ShipmentId": 1,
"TrackingNumber": "sample string 2"
},
"IsInboundShipment": true,
"InboundShipmentLocationId": 41,
"InboundShipmentLocationName": "sample string 42",
"GLCategory": "sample string 43",
"GLSubCategory": "sample string 44",
"EmailShippingDocuments": {
"SendShippingDocumentsEmail": true,
"EmailsList": [
"sample string 1",
"sample string 2"
]
},
"UseUserPreferencesForEAlerts": true,
"eAlerts": {
"Events": {
"Ship": true,
"Exception": true,
"Delivery": true,
"OnEstimatedDelivery": true,
"OnPickup": true,
"OnTender": true,
"OnOutForDelivery": true,
"OnReturnToSender": true
},
"Emails": [
{
"Email": "sample string 1"
},
{
"Email": "sample string 1"
}
],
"AdditionalMessage": "sample string 1",
"AddPackageContents": true
},
"ShipperLoadAndCount": "sample string 46",
"BookingConfirmationNumber": "sample string 47",
"GetShipLabelByPiece": true,
"SourceOfOrder": "sample string 49",
"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
}
],
"CustomCharacterOverlayOnLabel": "sample string 50",
"CheckAndDeleteFromOnHold": true,
"UseDefaultGlobalShipmentOptions": true,
"SkipOrderIsAlreadyShippedCheck": true,
"PreAssignTrackingNumber": "sample string 54",
"ApplyDutiesAndTaxes": true,
"ShipWithoutAPrinter": true,
"CustomField1": "sample string 58",
"CustomField2": "sample string 59",
"CustomField3": "sample string 60",
"CustomField4": "sample string 61",
"CustomField5": "sample string 62"
}
application/xml, text/xml
Sample:
<CarrierShipRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Ship">
<APM_SystemId>sample string 10</APM_SystemId>
<APM_SystemName>sample string 11</APM_SystemName>
<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>
<ApplyDutiesAndTaxes>true</ApplyDutiesAndTaxes>
<AutomatedParcelMachineLocationId>sample string 7</AutomatedParcelMachineLocationId>
<BOLNumber>sample string 34</BOLNumber>
<Billing>
<BillingAccount>sample string 3</BillingAccount>
<BillingAccountName>sample string 1</BillingAccountName>
<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 5</ContractNumber>
<LoadAccountDetailsByNumber>true</LoadAccountDetailsByNumber>
<SplitDutyVATIndicator>true</SplitDutyVATIndicator>
<TransitNumber>sample string 4</TransitNumber>
</Billing>
<BookingConfirmationNumber>sample string 47</BookingConfirmationNumber>
<CalculatePackagesByContents>true</CalculatePackagesByContents>
<CalculatePackagesByContentsOptions>
<DoNotRotateItems>true</DoNotRotateItems>
<EnableBoxBalancing>true</EnableBoxBalancing>
<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_Ship>
<Height>5</Height>
<Length>4</Length>
<MaxWeight>2</MaxWeight>
<UseForFreight>true</UseForFreight>
<Width>3</Width>
</CalculatePackagesDimension_Ship>
<CalculatePackagesDimension_Ship>
<Height>5</Height>
<Length>4</Length>
<MaxWeight>2</MaxWeight>
<UseForFreight>true</UseForFreight>
<Width>3</Width>
</CalculatePackagesDimension_Ship>
</PackageDimensions>
<PaddingPercentage>12</PaddingPercentage>
<SplitPackagesAtSingleItemWeight>2</SplitPackagesAtSingleItemWeight>
</CalculatePackagesByContentsOptions>
<CarrierId>2</CarrierId>
<CarrierRoute>sample string 20</CarrierRoute>
<CarrierSequence>sample string 21</CarrierSequence>
<CartonDescription>sample string 38</CartonDescription>
<CheckAndDeleteFromOnHold>true</CheckAndDeleteFromOnHold>
<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:CheckDistributionDate>true</d2p1:CheckDistributionDate>
<d2p1:CheckSenderAddress>true</d2p1:CheckSenderAddress>
<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:DeconsolidationLocationId>1</d2p1:DeconsolidationLocationId>
<d2p1:DeconsolidationLocationName>sample string 8</d2p1:DeconsolidationLocationName>
<d2p1:DistributionDate>2024-04-26T09:45:53.8265242Z</d2p1:DistributionDate>
<d2p1:SkidIndex>5</d2p1:SkidIndex>
</ConsolidationUnit>
<Contents>
<Commodities>
<Commodity>
<AccessionNumber>sample string 37</AccessionNumber>
<Canada_HarmonizedCode>sample string 13</Canada_HarmonizedCode>
<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 2</Description>
<ECCN>sample string 52</ECCN>
<ExportLicense>sample string 20</ExportLicense>
<FCC>true</FCC>
<FCCDescribeRadioFrequency>sample string 33</FCCDescribeRadioFrequency>
<FCCDeviceModel>sample string 30</FCCDeviceModel>
<FCCEntryNumber>sample string 28</FCCEntryNumber>
<FCCID>sample string 32</FCCID>
<FCCPortOfEntry>sample string 29</FCCPortOfEntry>
<FCCTradeName>sample string 31</FCCTradeName>
<FDA>true</FDA>
<FDADescription>sample string 34</FDADescription>
<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>
<LBSLTSFactor>1</LBSLTSFactor>
<LTLClassId>sample string 39</LTLClassId>
<LicenseExpireDate>sample string 21</LicenseExpireDate>
<MID>sample string 42</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 17</MarksOrNumbers>
<NAFTA>true</NAFTA>
<NAFTACommodityDetails>
<NaftaNetCost>NC</NaftaNetCost>
<NetCostBeginDate>2024-04-26T09:45:53.8065079-04:00</NetCostBeginDate>
<NetCostEndDate>2024-04-26T09:45:53.8065079-04:00</NetCostEndDate>
<PreferenceCriterion>A</PreferenceCriterion>
<ProducerDetermination>YES</ProducerDetermination>
</NAFTACommodityDetails>
<NMFCItem>sample string 40</NMFCItem>
<NMFCSub>sample string 41</NMFCSub>
<OnHoldImportBooksPerBox>36</OnHoldImportBooksPerBox>
<PackageNumber>1</PackageNumber>
<PartNumber>sample string 16</PartNumber>
<PlantArticle>true</PlantArticle>
<PlantArticleGenus>sample string 47</PlantArticleGenus>
<PlantArticlePercentRecycled>sample string 50</PlantArticlePercentRecycled>
<PlantArticleQuantity>sample string 49</PlantArticleQuantity>
<PlantArticleSpecies>sample string 48</PlantArticleSpecies>
<Quantity>4</Quantity>
<QuantityAssignment>
<CommodityPacking_Ship>
<PackageIndex>1</PackageIndex>
<Quantity>2</Quantity>
</CommodityPacking_Ship>
<CommodityPacking_Ship>
<PackageIndex>1</PackageIndex>
<Quantity>2</Quantity>
</CommodityPacking_Ship>
</QuantityAssignment>
<QuantityUnitOfMeasure>sample string 5</QuantityUnitOfMeasure>
<SKUOrItemOrUPC>sample string 19</SKUOrItemOrUPC>
<SKUOrItemOrUPS>sample string 18</SKUOrItemOrUPS>
<SenderIsProducer>true</SenderIsProducer>
<SerialNumber>sample string 15</SerialNumber>
<ShipAsItsOwnPackage>true</ShipAsItsOwnPackage>
<ShipInAnyPackage>true</ShipInAnyPackage>
<ShipsOnSkidOnly>true</ShipsOnSkidOnly>
<TaxPercentage>1</TaxPercentage>
<TaxesAreIncluded>true</TaxesAreIncluded>
<Textile>true</Textile>
<TextileInformation>sample string 27</TextileInformation>
<TotalWeight>7</TotalWeight>
<USA_HarmonizedCode>sample string 14</USA_HarmonizedCode>
<UnitValue>6</UnitValue>
</Commodity>
<Commodity>
<AccessionNumber>sample string 37</AccessionNumber>
<Canada_HarmonizedCode>sample string 13</Canada_HarmonizedCode>
<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 2</Description>
<ECCN>sample string 52</ECCN>
<ExportLicense>sample string 20</ExportLicense>
<FCC>true</FCC>
<FCCDescribeRadioFrequency>sample string 33</FCCDescribeRadioFrequency>
<FCCDeviceModel>sample string 30</FCCDeviceModel>
<FCCEntryNumber>sample string 28</FCCEntryNumber>
<FCCID>sample string 32</FCCID>
<FCCPortOfEntry>sample string 29</FCCPortOfEntry>
<FCCTradeName>sample string 31</FCCTradeName>
<FDA>true</FDA>
<FDADescription>sample string 34</FDADescription>
<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>
<LBSLTSFactor>1</LBSLTSFactor>
<LTLClassId>sample string 39</LTLClassId>
<LicenseExpireDate>sample string 21</LicenseExpireDate>
<MID>sample string 42</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 17</MarksOrNumbers>
<NAFTA>true</NAFTA>
<NAFTACommodityDetails>
<NaftaNetCost>NC</NaftaNetCost>
<NetCostBeginDate>2024-04-26T09:45:53.8065079-04:00</NetCostBeginDate>
<NetCostEndDate>2024-04-26T09:45:53.8065079-04:00</NetCostEndDate>
<PreferenceCriterion>A</PreferenceCriterion>
<ProducerDetermination>YES</ProducerDetermination>
</NAFTACommodityDetails>
<NMFCItem>sample string 40</NMFCItem>
<NMFCSub>sample string 41</NMFCSub>
<OnHoldImportBooksPerBox>36</OnHoldImportBooksPerBox>
<PackageNumber>1</PackageNumber>
<PartNumber>sample string 16</PartNumber>
<PlantArticle>true</PlantArticle>
<PlantArticleGenus>sample string 47</PlantArticleGenus>
<PlantArticlePercentRecycled>sample string 50</PlantArticlePercentRecycled>
<PlantArticleQuantity>sample string 49</PlantArticleQuantity>
<PlantArticleSpecies>sample string 48</PlantArticleSpecies>
<Quantity>4</Quantity>
<QuantityAssignment>
<CommodityPacking_Ship>
<PackageIndex>1</PackageIndex>
<Quantity>2</Quantity>
</CommodityPacking_Ship>
<CommodityPacking_Ship>
<PackageIndex>1</PackageIndex>
<Quantity>2</Quantity>
</CommodityPacking_Ship>
</QuantityAssignment>
<QuantityUnitOfMeasure>sample string 5</QuantityUnitOfMeasure>
<SKUOrItemOrUPC>sample string 19</SKUOrItemOrUPC>
<SKUOrItemOrUPS>sample string 18</SKUOrItemOrUPS>
<SenderIsProducer>true</SenderIsProducer>
<SerialNumber>sample string 15</SerialNumber>
<ShipAsItsOwnPackage>true</ShipAsItsOwnPackage>
<ShipInAnyPackage>true</ShipInAnyPackage>
<ShipsOnSkidOnly>true</ShipsOnSkidOnly>
<TaxPercentage>1</TaxPercentage>
<TaxesAreIncluded>true</TaxesAreIncluded>
<Textile>true</Textile>
<TextileInformation>sample string 27</TextileInformation>
<TotalWeight>7</TotalWeight>
<USA_HarmonizedCode>sample string 14</USA_HarmonizedCode>
<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>
<CrossDockAddress>
<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>
</CrossDockAddress>
<CustomCharacterOverlayOnLabel>sample string 50</CustomCharacterOverlayOnLabel>
<CustomField1>sample string 58</CustomField1>
<CustomField2>sample string 59</CustomField2>
<CustomField3>sample string 60</CustomField3>
<CustomField4>sample string 61</CustomField4>
<CustomField5>sample string 62</CustomField5>
<CustomerMarkup>
<MarkupType>MarkupPercentage</MarkupType>
<MarkupValue>1</MarkupValue>
</CustomerMarkup>
<DaysToSearchInHistory>32</DaysToSearchInHistory>
<DepartmentCode>sample string 31</DepartmentCode>
<DepartmentDescription>sample string 29</DepartmentDescription>
<EmailShippingDocuments>
<EmailsList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</EmailsList>
<SendShippingDocumentsEmail>true</SendShippingDocumentsEmail>
</EmailShippingDocuments>
<GLCategory>sample string 43</GLCategory>
<GLSubCategory>sample string 44</GLSubCategory>
<GetShipLabelByPiece>true</GetShipLabelByPiece>
<GlobalOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Common">
<d2p1:CheckOnDelivery>true</d2p1:CheckOnDelivery>
<d2p1:CollectOnDelivery>
<d2p1:Amount>1</d2p1:Amount>
</d2p1:CollectOnDelivery>
<d2p1:DangerousGoods>true</d2p1:DangerousGoods>
<d2p1:SaturdayDelivery>true</d2p1:SaturdayDelivery>
<d2p1:SaturdayPickUp>true</d2p1:SaturdayPickUp>
<d2p1:ShipFromCarrier>true</d2p1:ShipFromCarrier>
<d2p1:ShipFromLocker>true</d2p1:ShipFromLocker>
<d2p1:ShipFromRetail>true</d2p1:ShipFromRetail>
<d2p1:ShipToCarrier>true</d2p1:ShipToCarrier>
<d2p1:ShipToLocker>true</d2p1:ShipToLocker>
<d2p1:ShipToRetail>true</d2p1:ShipToRetail>
<d2p1:SignatureOption>Default</d2p1:SignatureOption>
<d2p1:SignatureRequired>true</d2p1:SignatureRequired>
</GlobalOptions>
<HasQRCodeLabelPrinting>true</HasQRCodeLabelPrinting>
<InboundShipmentLocationId>41</InboundShipmentLocationId>
<InboundShipmentLocationName>sample string 42</InboundShipmentLocationName>
<InternalRoutingCode>sample string 22</InternalRoutingCode>
<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 3</BillingAccount>
<BillingAccountName>sample string 1</BillingAccountName>
<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 5</ContractNumber>
<LoadAccountDetailsByNumber>true</LoadAccountDetailsByNumber>
<SplitDutyVATIndicator>true</SplitDutyVATIndicator>
<TransitNumber>sample string 4</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>
<DoNotPrintCustomDocuments>true</DoNotPrintCustomDocuments>
<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>
<AdditionalChargesDescription>sample string 8</AdditionalChargesDescription>
<Amount>1</Amount>
<CertificateNumber>sample string 9</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>2024-04-26T09:45:53.8035068-04:00</NAFTABlankedPeriodEnd>
<NAFTABlankedPeriodStart>2024-04-26T09:45:53.8035068-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>25</LocationId>
<LocationName>sample string 26</LocationName>
<MaxDistanceToDropOff_APM>9</MaxDistanceToDropOff_APM>
<MaxDistanceToDropOff_APM_UM>Kilometers</MaxDistanceToDropOff_APM_UM>
<MycarrierDetails>
<AccountFreight>1</AccountFreight>
<CarrierName>sample string 1</CarrierName>
<ClientFreight>1</ClientFreight>
<DeliveryDate>2024-04-26T09:45:53.8217216-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>2024-04-26T09:45:53.8225197-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 28</OrderNumber>
<OriginalShipmentInfo>
<ShipmentId>1</ShipmentId>
<TrackingNumber>sample string 2</TrackingNumber>
</OriginalShipmentInfo>
<Packages>
<Package_Ship>
<ApplyWeightAndDimsFromTheAssignedCommodity>true</ApplyWeightAndDimsFromTheAssignedCommodity>
<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 18</InvoiceNo>
<IsStackable>true</IsStackable>
<Length>3</Length>
<LicencePlate>sample string 21</LicencePlate>
<NMFCItem>sample string 6</NMFCItem>
<NMFCSub>sample string 7</NMFCSub>
<NumberOfPiecesInSkid>14</NumberOfPiecesInSkid>
<OnHoldAggregatedOrderNumber>sample string 20</OnHoldAggregatedOrderNumber>
<OriginalWeight>16</OriginalWeight>
<PONumber>sample string 13</PONumber>
<Packaging>NotSet</Packaging>
<PreAssignTrackingNumber>sample string 22</PreAssignTrackingNumber>
<Reference1>sample string 11</Reference1>
<Reference2>sample string 12</Reference2>
<ShipmentId>sample string 17</ShipmentId>
<SkidDescription>sample string 15</SkidDescription>
<Weight>1</Weight>
<WeightType>Pounds</WeightType>
<Width>2</Width>
</Package_Ship>
<Package_Ship>
<ApplyWeightAndDimsFromTheAssignedCommodity>true</ApplyWeightAndDimsFromTheAssignedCommodity>
<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 18</InvoiceNo>
<IsStackable>true</IsStackable>
<Length>3</Length>
<LicencePlate>sample string 21</LicencePlate>
<NMFCItem>sample string 6</NMFCItem>
<NMFCSub>sample string 7</NMFCSub>
<NumberOfPiecesInSkid>14</NumberOfPiecesInSkid>
<OnHoldAggregatedOrderNumber>sample string 20</OnHoldAggregatedOrderNumber>
<OriginalWeight>16</OriginalWeight>
<PONumber>sample string 13</PONumber>
<Packaging>NotSet</Packaging>
<PreAssignTrackingNumber>sample string 22</PreAssignTrackingNumber>
<Reference1>sample string 11</Reference1>
<Reference2>sample string 12</Reference2>
<ShipmentId>sample string 17</ShipmentId>
<SkidDescription>sample string 15</SkidDescription>
<Weight>1</Weight>
<WeightType>Pounds</WeightType>
<Width>2</Width>
</Package_Ship>
</Packages>
<PickupDate>2024-04-26T09:45:53.7986531Z</PickupDate>
<PickupRequest>
<CompanyCloseTime>sample string 3</CompanyCloseTime>
<PurolatorPickupRequest>
<LoadingDockAvailable>true</LoadingDockAvailable>
<StreetNumber>sample string 1</StreetNumber>
<StreetType>sample string 2</StreetType>
<Trailer53Accessible>true</Trailer53Accessible>
</PurolatorPickupRequest>
<ReadyTime>sample string 2</ReadyTime>
<RequestAPickup>true</RequestAPickup>
<UPSPickupRequest>
<OverweightIndicator>true</OverweightIndicator>
<UPSPickupType>SameDayPickup</UPSPickupType>
</UPSPickupRequest>
</PickupRequest>
<PreAssignTrackingNumber>sample string 54</PreAssignTrackingNumber>
<RateCurrencySelect>sample string 37</RateCurrencySelect>
<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>
<RecipientIsAutomatedParcelMachineLocation>true</RecipientIsAutomatedParcelMachineLocation>
<RemoveExistingOnholdOrder>true</RemoveExistingOnholdOrder>
<RetrieveBase64StringDocuments>true</RetrieveBase64StringDocuments>
<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 24</ServiceCode>
<ShipByServiceGroup>true</ShipByServiceGroup>
<ShipByServiceGroupOptions>
<GetServiceByGroupType>CheapestInGroup</GetServiceByGroupType>
<ServiceGroupID>1</ServiceGroupID>
<ServiceGroupName>sample string 2</ServiceGroupName>
</ShipByServiceGroupOptions>
<ShipFromLocationLockerInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Common">
<d2p1:Address1>sample string 6</d2p1:Address1>
<d2p1:Address2>sample string 7</d2p1:Address2>
<d2p1:Address3>sample string 8</d2p1:Address3>
<d2p1:City>sample string 3</d2p1:City>
<d2p1:Country>sample string 5</d2p1:Country>
<d2p1:Id>sample string 1</d2p1:Id>
<d2p1:LocationType>Unknown</d2p1:LocationType>
<d2p1:LocationTypeDescription>sample string 10</d2p1:LocationTypeDescription>
<d2p1:Name>sample string 9</d2p1:Name>
<d2p1:Postal>sample string 2</d2p1:Postal>
<d2p1:State>sample string 4</d2p1:State>
</ShipFromLocationLockerInfo>
<ShipFromLockerOrLocation>true</ShipFromLockerOrLocation>
<ShipOptions i:nil="true" />
<ShipToLocationLockerInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Common">
<d2p1:Address1>sample string 6</d2p1:Address1>
<d2p1:Address2>sample string 7</d2p1:Address2>
<d2p1:Address3>sample string 8</d2p1:Address3>
<d2p1:City>sample string 3</d2p1:City>
<d2p1:Country>sample string 5</d2p1:Country>
<d2p1:Id>sample string 1</d2p1:Id>
<d2p1:LocationType>Unknown</d2p1:LocationType>
<d2p1:LocationTypeDescription>sample string 10</d2p1:LocationTypeDescription>
<d2p1:Name>sample string 9</d2p1:Name>
<d2p1:Postal>sample string 2</d2p1:Postal>
<d2p1:State>sample string 4</d2p1:State>
</ShipToLocationLockerInfo>
<ShipToLockerOrLocation>true</ShipToLockerOrLocation>
<ShipWithoutAPrinter>true</ShipWithoutAPrinter>
<ShipmentInstructions>sample string 17</ShipmentInstructions>
<ShipmentPONumber>sample string 16</ShipmentPONumber>
<ShipmentProtection>18</ShipmentProtection>
<ShipmentProtectionCurrency>sample string 19</ShipmentProtectionCurrency>
<ShipmentReference>sample string 14</ShipmentReference>
<ShipmentReference2>sample string 15</ShipmentReference2>
<ShipperLoadAndCount>sample string 46</ShipperLoadAndCount>
<SkipOrderIsAlreadyShippedCheck>true</SkipOrderIsAlreadyShippedCheck>
<SourceOfOrder>sample string 49</SourceOfOrder>
<SpecialInstructions>sample string 36</SpecialInstructions>
<UseAlternateSenderOnLabel>true</UseAlternateSenderOnLabel>
<UseDefaultGlobalShipmentOptions>true</UseDefaultGlobalShipmentOptions>
<UseDropOffToAPM>true</UseDropOffToAPM>
<UseUserPreferencesForEAlerts>true</UseUserPreferencesForEAlerts>
<WS_Key>sample string 1</WS_Key>
<Webhooks>
<Webhook_Ship>
<Password>sample string 3</Password>
<Type>ShipmentStatusChange</Type>
<Uri>http://webapihelppage1.com/</Uri>
<Username>sample string 2</Username>
</Webhook_Ship>
<Webhook_Ship>
<Password>sample string 3</Password>
<Type>ShipmentStatusChange</Type>
<Uri>http://webapihelppage1.com/</Uri>
<Username>sample string 2</Username>
</Webhook_Ship>
</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>
<OnOutForDelivery>true</OnOutForDelivery>
<OnPickup>true</OnPickup>
<OnReturnToSender>true</OnReturnToSender>
<OnTender>true</OnTender>
<Ship>true</Ship>
</Events>
</eAlerts>
</CarrierShipRequest>
application/x-www-form-urlencoded
Sample:
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:
text/json
Sample:
application/xml
Sample:
text/xml
Sample: