NameDescriptionTypeAdditional information
WS_Key

(Mandatory) Webservice Key provided by 2ship support

string

None.

CarrierId

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

integer

None.

Sender

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

WS_Repository.Models.Requests.Hold.Contact

None.

UseAlternateSenderOnLabel

(Optional) Use alternate sender on label

boolean

None.

AlternateSender

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

WS_Repository.Models.Requests.Hold.Contact

None.

Recipient

(Mandatory) Recipient Contact

WS_Repository.Models.Requests.Hold.Contact

None.

Packages

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

Collection of WS_Repository.Models.Requests.Hold.Package

None.

PackagesAreSkids

(Optional) If is set to true it specify that all the items in Packages will be treated as Skids

boolean

None.

ShipmentReference

(Optional) Global Shipment reference, when is provided it is used to fill the package reference when there is no value. Also is save as Shipment Reference

string

None.

ShipmentReference2

(Optional) Global Shipment reference 2, when is provided it is used to fill the package reference 2 when there is no value. Also is save as Shipment Reference

string

None.

ShipmentInstructions

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

string

None.

CarrierRoute

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

string

None.

CarrierSequence

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

string

None.

ShipmentPONumber

(Optional) Global Shipment PO number, when is provided it is used to fill the package PO Numbeer when there is no value. Also is save as Shipment PO Number

string

None.

PickupDate

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

date

None.

Billing

(Optional) used to rate/ship with other account

WS_Repository.Models.Requests.Hold.BillingOptions

None.

ServiceCode

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

string

None.

InternationalOptions

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

WS_Repository.Models.Requests.Hold.InternationalOptions

None.

Contents

(Optional) Contents of the shipment packages

WS_Repository.Models.Requests.Hold.Contents

None.

ShipOptions

(Optional) Used to filter services that include some options

Collection of WS_Repository.Models.Requests.Hold.ShipmentOption

None.

LocationId

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

integer

None.

LocationName

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

string

None.

LocationAddressMatchWholeSenderAddress

(Optional) Used when no LocationId and no LocationName are supplied. If is set to true then the location id is populated just if the sender address match the whole location address, if not you will get an Exception

boolean

None.

OrderNumber

(Optional) Your internal order number of the order

string

None.

CallbackURL

(Optional) use to call your webservice back when a status of an order is changing when order is shipped i call this url with the following parameters TrackingNumber={Carrier Shipment Tr #}&OrderNumber={Your Order #}&CurrentStatus=Shipped&LabelUrl={Url of the label}&TotalCost={cost of the shipment}&CarrierId={Carrier id}&CarrierName={Carrier Name}&ServiceCode={Service Code}&ServiceName={Service Name}&TrackingNumbers={all packages tracking numbers separeted by ,}&Currency={cost currency}&LabelFormat={label format: Format_4x6, Format_85x11, Format_PackingSlip_85x11} when shipment is deleted after the ship i call this url with the following parameters TrackingNumber={Carrier Shipment Tr #}&OrderNumber={Your Order #}&CurrentStatus=Deleted

string

None.

ServiceGroup

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

integer

None.

ServiceGroupName

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

string

None.

MycarrierDetails

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

WS_Repository.Models.Requests.Hold.MyCarrierDetails

None.

OrderInfo

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

WS_Repository.Models.Requests.Hold.OrderInfo

None.

DepartmentDescription

(Optional) Department Description

string

None.

DepartmentCode

(Optional) Department Code

string

None.

CustomerMarkups

(Optional) Provide your own values for Customer Pricing calculation

Collection of WS_Repository.Models.Requests.Hold.CustomerMarkup

None.

ConsolidationUnit

(Optional) Used to consolidate the shipment

WS_Repository.Models.Common.ConsolidationUnit

None.

ApplyRate

(Optional) will rate your order and attach the cheapest rate, this meaning to find cheapest service for a carrier if you put the CarrierId‎ or find cheapest across all carriers if you do not put the CarrierId or find the rate for Carrier and Service if you put the CarrierId and a ServiceCode

boolean

None.

ApplyRateOptions

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

WS_Repository.Models.Requests.Hold.RateOptions

None.

DaysToSearchInHistory

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

integer

None.

BOLNumber

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

string

None.

SpecialInstructions

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

string

None.

ProjectId

(Optional) Use to group a bunch of shipments

string

None.

CartonDescription

(Optional) Used to populate the Contents area of a Carton Label. if this field is empty the Carton Label Contents will be populated with the shipment Contents.

string

None.

IsReturn

(Optional) the shipment will be treated as a return

boolean

None.

ReturnShipment

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

WS_Repository.Models.Requests.Hold.PrintReturnLabel

None.

RequestPickup

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

boolean

None.

EmailLabels

(Optional) Flag to specify the labels should be emailed

boolean

None.

EmailsList

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

Collection of string

None.

IsInboundShipment

(Optional) the shipment will be treated as an inbound

boolean

None.

InboundShipmentLocationId

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

integer

None.

GLCategory

(Optional) General Ledger Category

string

None.

GLSubCategory

(Optional) General Ledger sub Category

string

None.

eAlerts

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

WS_Repository.Models.Requests.Hold.eAlerts

None.

FilterByDeliveryDate

(Optional) Flag to filter the ratings by MaxDeliveryDate

boolean

None.

MaxDeliveryDate

(Optional) Max delivery date of the shipment

date

None.

RunAggregationAfterHold

(Optional) Run Aggregation After importing

boolean

None.

RunAggregationRateAfterHold

(Optional) Run Aggregation Rate After importing

boolean

None.

ExcludeOrderFromAggregation

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

boolean

None.

PackagesCanMergeInASinglePackageOnAggregation

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

boolean

None.

ShipperLoadAndCount

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

string

None.

BookingConfirmationNumber

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

string

None.

LabelPrintPreferences

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

WS_Repository.Models.Requests.Hold.LabelPrintPreferencesType

None.

ShipByDate

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

date

None.

CalculatePackagesByContents

(Optional) if this flag is set true then Packages field will be overridden with generated packages based on a 2ship packing algorithm and with parameters set on PackageGeneratingByContents field

boolean

None.

CalculatePackagesByContentsOptions

(Optional) Packages generation parameters

WS_Repository.Models.Requests.Hold.CalculatePackagesByContentsOptions

None.

InternalHandling

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

WS_Repository.Models.Requests.Hold.InternalHandling

None.

SourceOfOrder

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

string

None.

Webhooks

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

Collection of WS_Repository.Models.Requests.Hold.Webhook

None.

OrderProcessingSync

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

boolean

None.

CustomCharacterOverlayOnLabel

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

string

None.