WS_Repository.Models.Requests.Ship.CarrierShipRequest

(Mandatory) Webservice Key provided by 2ship support

(Conditionally Required) Carrier ID to ship with - if not specified then it must be specified the ShipByServiceGroup and ShipByServiceGroupOptions fields

(Mandatory) Sender Contact

(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) 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) Specify that the Recipient is an Automated Parcel Machine Location

(Mandatory if RecipientIsAutomatedParcelMachineLocation = true) Specify Automated Parcel Machine Location Id/Code

(Optional) Sender will Drop off the shipment to Automated Parcel Machine

(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

(Optional) the default value is Kilometers

(Mandatory if RecipientIsAutomatedParcelMachineLocation = true or UseDropOffToAPM = true) Specify the system id wich send the request (ex. 101, 102....)

(Mandatory if RecipientIsAutomatedParcelMachineLocation = true or UseDropOffToAPM = true) Specify the system name wich send the request (ex. 2ship...)

(Optional) Drop Off Location has QR code label printing available

(Mandatory) Array of Package

(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) 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) 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) Shipment Instructions, used for 4x8 doctab label

(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) 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) The Ship Date (default is today)

(Optional) used to rate/ship with other account

(Conditionally Required) Carrier Service Code - if not specified then it must be specified the ShipByServiceGroup and ShipByServiceGroupOptions fields

(Optional) International Options of the shipment(mandatory if the shipment is international)

(Optional) Contents of the shipment packages

(Optional) Options of the shipment - for a pecific carrier

(Optional) Global Shipment Options - For all carriers

(Optional) If not set will use 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) label printing preferences (Default is PDF and Format 8.5x11 in)

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

(Optional) Order Info (MANDATORY when LabelPrintPreferencesType.OutputFormat = Format_PackingSlip_85x11)

(Optional) Department Description

(Optional) Specify that the shipping carrier/service will be retrieve by a service group specified on the ShipByServiceGroupOptions field

(Conditionally required) Ship By ServiceG roup Options

(Optional) Department Code

(Optional) Provide your own value for Customer Pricing calculation

(Optional) Used to consolidate the shipment

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

Schedule a Pickup Request with the shipment creation

Use to get in the response also the documents in Base64String format

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

(Optional) Flag to specify to search and remove the existing onhold order - the search will be made if the OrderNumber field is provided

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

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

(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) Information about Original Shipment (Shipment Id or Tracking Number)

(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) Used to send the shipping documents by email;

(Optional) Specify to use user preferences for eAlerts

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

(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) If this flag is set, the ship API response will return individual files for each package label - the document type will be PieceLabel

(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) Custom Character Overlay On Label (Max 1 character)

(Optional) Check if the order # you specify on the OrderNumber field if exists in onhold and delete it if this request is succeeded

(Optional) It specify to load the default global options from 2Ship

(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

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

(Optional) It specify to get estimated duties and taxes cost for international shipments

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

(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