NameDescriptionTypeAdditional 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 GetShipLabelByPiece and GetShipLabelByPieceOptions fields

integer

None.

Sender

(Mandatory) Sender Contact

WS_Repository.Models.Requests.Ship.Contact

None.

UseAlternateSenderOnLabel

(Optional) Use alternate sender on label

boolean

None.

AlternateSender

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

WS_Repository.Models.Requests.Ship.Contact

None.

Recipient

(Mandatory) Recipient Contact

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.

Packages

(Mandatory) Array of Package

Collection of WS_Repository.Models.Requests.Ship.Package

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.

CarrierRoute

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

string

None.

CarrierSequence

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

string

None.

PickupDate

(Optional) the date of the pickup (default is today)

date

None.

Billing

(Optional) used to rate/ship with other account

WS_Repository.Models.Requests.Ship.BillingOptions

None.

ServiceCode

(Conditionally Required) Carrier Service Code - if not specified then it must be specified the GetShipLabelByPiece and GetShipLabelByPieceOptions 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

Collection of WS_Repository.Models.Requests.Ship.ShipmentOption

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.

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.

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 = 20 characters. Default value = "API".)

string

None.

Webhooks

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

Collection of WS_Repository.Models.Requests.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.