WS_Repository.Models.Requests.Hold.HoldRequest

(Mandatory) Webservice Key provided by 2ship support

(Optional) if pressent will get all services for that carrier

(Optional) Sender Contact - if not present then will get the default user sender

(Optional) Use alternate sender on label

Required if UseAlternateSederOnLabe = true, Specify the alternate address that will be printed on label

(Mandatory) Recipient Contact

(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

(Optional) Use the shipment level info instead of Packages

(Conditionally required (UseShipmentLevelInfo = true)) Shipment Level Info of the shipment

(Mandatory) Array of Package - Optional if CalculatePackagesByContents = true

(Optional) Array of skids - Skids alternative of the Packages

(Optional) If is set to true it specify that all the items in Packages will be treated as Skids - is taking in consideration only when no Skids are sent

(Optional) the Value of your Shipment (this can influence the cost of your shipment)

(Optional) the Currency of you Insurance Value(CAD, USD... etc)

(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

(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

(Optional) Shipment Instructions, used for 4x8 doctab label

(Optional) Carrier Route, used for 4x8 doctab label

(Optional) Carrier Sequence, used for 4x8 doctab label

(Optional) Internal Routing Code, used for 4x8 doctab label

(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

(Optional) The Ship Date (default is today)

(Optional) used to rate/ship with other account

(Optional) can be present just if there is a Carrier Id

(Optional) Internation Options of the order(if the order is intranational)

(Optional) Contents of the shipment packages

(Optional) Used to filter services that include some options

(Optional) If not set will use the LocationName or the sender address to match the right Location to use.

(Optional) If not set will use the LocationId or the sender address to match the right Location to use.

(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

(Optional) Your internal order number of the order

(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

(Optional) Service Group Id - used to filter services which are in this Group

(Optional) Service Group Name - used to filter services which are in this Group

(Optional) when the carrier is My Carrier(999) here you can populate your carrier info

(Optional) Order Info - will appear on Packing Slip Document when that type of label is setup on user

(Optional) Department Description

(Optional) Department Code

(Optional) Provide your own values for Customer Pricing calculation

(Optional) Used to consolidate the shipment

(Optional) Used to return rates in your selected currency using the 2Ship exchange rate from openexchangerates.org

(Optional) Will rate your order and attach the cheapest/fastest (based on ApplyRateType type) rate, this meaning to find cheapest/fastest service for a carrier if you put the CarrierId‎ or find cheapest/fastest 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

(Optional) Will get an estimate cost of duties and taxes for international shipments

(Optional) Used when Applyrate is set to get the cheapest/fastest service by filtering services that include the options specified in this field

(Optional) Based on this type it apply the cheapest or the fastest service

(Optional) How many days to search in history for an order. it apply just if you specify an OrderNumber (Default is 0 days)

(Optional) BOL Number (Used by ltl carriers to apear on Bill Of Lading)

(Optional) Special Instruction (Used by ltl carriers to apear on Bill Of Lading)

(Optional) Use to group a bunch of shipments

(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.

(Optional) the shipment will be treated as a return

(Optional) Settings for printing the return label simultaneously with the outbound shipment (this field is ignored when IsReturn flag is set on)

(Optional) Flag to specify a pickup request should be sheduled

(Optional) Flag to specify the labels should be emailed

(Optional) the list of emails where to send the labels

(Optional) the shipment will be treated as an inbound

(Optional) if shipment is Inbound then add inbound location id. Note: can be null, inbound location id can be assigned in OPS

(Optional) if shipment is Inbound then add inbound location name. Note: can be null, inbound location name can be assigned in OPS

(Optional) General Ledger Category

(Optional) General Ledger sub Category

(Optional) eAlert - send email alerts to the specified email list for the spcified events

(Optional) Flag to filter the ratings by MaxDeliveryDate

(Optional) Max delivery date of the shipment

(Optional) Run Aggregation After importing

(Optional) Run Aggregation Rate After importing

(Optional) Specify that the order cannot aggregate with other orders

(Optional) Specify that the order packages will be merged in a single package when aggregate with other orders

(Optional) Shipper Load And Count - Mandatory if the carrier is FedEx - CarrierId = 2 and the services are one of the Freight services

(Optional) Booking Confirmation Number - Mandatory if the carrier is FedEx - CarrierId = 2 and the services are one of the Freight services

(Optional) label printing preferences (Default is PDF and Format 8.5x11 in)

(Optional) the date by which the order must be shipped

(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

(Optional) Packages generation parameters

(Optional) Specify that this order will print an extra label with the InternalHandlingText on it

(Optional) This field will store source of order for history, search, reports, etc. (Maximum length = 100 characters. Default value = "API".)

Optional webhook options, to have 2Ship post full shipment data in json format whenever this shipment changes status

(Optional) if this is set then when ApplyRate = true and/or CalculatePackagesByContents = true you will get the Response after these are done

(Optional) Custom Character Overlay On Label (Max 1 character)

Optional information that is sent back on webhooks, and can be used to store internal ids so that webhook replies are aliased to these internal ids in the caller systems.

(Optional) Tracking Number pre-assign - Used by some carriers that accept this feautere

(Optional) Specify ship from a locker / carrier location / carrier retail location

(Required if ShipFromLockerOrLocation = true)

(Optional) Specify ship to a locker / carrier location / carrier retail location

(Required if ShipFromLockerOrLocation = true)

(Optional) Status of the Order in OnHold

(Optional) Use this filter to find the Carrier services that allow you to ship without the need for a printed label

(Optional) If this flag is true than the order need to be approved before ship

(Optional) Used to make rules with it

(Optional) Used to make rules with it

(Optional) Used to make rules with it

(Optional) Used to make rules with it

(Optional) Used to make rules with it

(Optional) filter out carriers that do not deliver to po box - only apply if your customer has this setting tuned on in client settings

(Optional) Specify to check the inventory and split the order if the contents are located to multiple warehouses. Only works for if your client has the inventory feature enabled.