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

(Mandatory) Sender Contact

WS_Repository.Models.Requests.Edit.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.Edit.Contact

None.

Recipient

(Mandatory) Recipient Contact

WS_Repository.Models.Requests.Edit.Contact

None.

Packages

(Mandatory) Array of Package

Collection of WS_Repository.Models.Requests.Edit.Package

None.

Skids

(Mandatory) Array of Package

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

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.Edit.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.Edit.InternationalOptions

None.

Contents

(Optional) Contents of the shipment packages

WS_Repository.Models.Requests.Edit.Contents

None.

ShipOptions

(Optional) Used to filter services that include some options

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

OrderInfo

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

WS_Repository.Models.Requests.Edit.OrderInfo

None.

DepartmentDescription

(Optional) Department Description

string

None.

DepartmentCode

(Optional) Department Code

string

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.

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

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

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.Edit.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 (4679)

boolean

None.