Purchase Label

Purchase Label Request allow you to perform a shipping transaction and obtain a link to a shipping label, without needing an order in your Teapplix account.

Note that ClientRequestId in the passed json will uniquely identify a “label request”. If you do not pass one, a unique id will be generated and returned to you. You can use the id in subsequent requests to cancel the label, or request the label again.

Note, if you purchase a label using a given ClientRequestId, and send a purchase label request again given the same ClientRequestId, the system will follow the behavior below:

If you changed address, recipient name, company name, or shipping method, weight or dimensions, you will be given an error
If you did not change any of the above, Teapplix will return the same label from the last purchase

If the purchase label did not succeed, and you call again using the same ClientRequestId and different address, shipping options and customs declaration. The label purchase will be based on the newly passed address, shipping options and customs declaration.

Here are the API REST schema:

POST

https://api.teapplix.com/api2/PurchaseLabel Explorer

POST Request

Purchase Label Request

Represents single label purchase request

Property	Type	Description	Constraints
`ClientRequestId`	string	Caller supplied unique id for each request. If you call next time using the same unique id, the previously purchased label will be returned to you instead of purchasing a new one.	Required
`ShipDate`	string	Shipping date of package. Only today or future date is allowed. Past date will be auto-corrected to today.	Pattern: ^\d\d\d\d-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3[01])$
`From`	ReturnAddress \| ProfileId	Sender address or shipping profile id	Required
`To`	To	Recipient address	Required
`Packages`	Package[]	Packages to be sent	Required
`Options`	Order Shipping Options	Shipment options
`CustomsDeclaration`	Customs declaration	Customs declaration
`ImageFormat`	Image Format	Format of returned labels
`IsReturn`	boolean	Should be set if return label is requested
`Provider`	string	Provider if specified will force usage of label from MARKETPLACE vs NATIVE carrier accounts linked in Teapplix.	One of: NATIVE, MARKETPLACE, TEAPPLIX, DHL, DHL_EXPRESS, FEDEX, UPS, ONTRAC, AMAZON_BUY_SHIPPING, ENDICIA, RATESHOP

To

Recipient address

Property	Type	Description	Constraints
`Name`	string	Full name. Use instead of FirstName + LastName when the name split is unavailable. At least one of Name, FirstName + LastName, or Company is required.	Max-Length: 128
`FirstName`	string	First name. Use together with LastName instead of Name when the name split is available. Cannot be combined with Name.	Max-Length: 128
`LastName`	string	Last name. Use together with FirstName instead of Name when the name split is available. Cannot be combined with Name.	Max-Length: 128
`Company`	string	Company or organization name. At least one of Name, FirstName + LastName, or Company is required.	Max-Length: 127
`Street`	string	Street address, line 1 (building number and street name).	Max-Length: 255
`Street2`	string	Street address, line 2 (apartment, suite, unit, floor, etc.).	Max-Length: 255
`City`	string	City or town name.	Max-Length: 40Min-Length: 1
`State`	string	US state abbreviation (e.g. CA) or province/region name for international addresses.	Max-Length: 40
`ZipCode`	string	US ZIP code or international postal code.
`CountryCode`	string	ISO 3166-1 alpha-2 country code (e.g. US, CA, GB).	Max-Length: 2Min-Length: 2Pattern: [A-Z]{2}
`Country`	string	Full country name (e.g. United States, Canada). Defaults to United States
`PhoneNumber`	string	Phone number. Format may be normalized by the carrier.	Max-Length: 40
`Email`	string	Email address.

Order Shipping Options

Shipment options

Property	Type	Description	Constraints
`InsuranceType`	string	Insurance Type	One of: none, teapplix, carrier
`InsuranceClosed`	boolean	Insurance Closed flag. Ignored on input.
`InsuranceClosedReason`	string	Insurance Closed Reason message. Ignored on input.
`Billed`	DutyBilled	Duties and Taxes data
`DutyBilled`	DutyBilled	Duties and Taxes data
`SplitDutyVAT`	boolean	Split Duty VAT
`Delivery`	Delivery	Delivery
`Service`	Service
`Cod`	Cod	C.O.D. details
`Ups`	Ups	UPS specific options
`Fedex`	Fedex	FedEx specific options
`DHL`	DHL	DHLeC specific options
`DHLE`	DHLE	DHL Express specific options
`ReasonForExport`	string	DEPRECATED! Reason for export	Max-Length: 20

Customs declaration

Property	Type	Description	Constraints
`ReasonForExport`	string		Max-Length: 20
`IOSSNumber`	string	The IOSS number of the seller. Sellers selling in the EU will be assigned a unique IOSS number that must be listed on all packages sent to the EU.
`BrokerAddress`	string	Broker Address
`Items`	Customs item[]	For ForOrder version of the API, Teapplix will use your order items to build ocmmercial invoice if Items list is not specified.

Image Format

Format of returned labels

Property	Type	Description	Constraints
`Layout`	string	DEPRECATED! Shipping Profile layout settings are used to select label layout.	One of: 4x6, 4x6_PACKING, 4x6_ROTATED, 8x11, 8x11_PACKING, A4, 10CM
`Type`	string	Selects the format label image should be returned in. <br /><strong>PDF</strong>: Return label as a PDF, with overlays and transformations as dictated by shipping profile. <br /><strong>RAW</strong>: Return native image from the carrier, without any transfromations.	One of: PDF, RAW
`LabelReturn`	string	Selects how result label should be returned. <br /><strong>URL</strong>: return URL to download the label document with in LabelData Content. You must call API DownloadLabel separately to obtain the label <br /><strong>INLINE</strong>: return base64 encoded label in LabelData Content.	One of: INLINE, URL, PRINT

Package

Declares packages to be shipped

Property	Type	Description	Constraints
`Method`	string	Shipping method used to print label. One of <br /><strong>USPS:</strong><br />'USPS_GROUND_ADVANTAGE', 'USPS_GROUND_ADVANTAGE_SOFTPACK', 'USPS_GROUND_ADVANTAGE_CUBIC', 'USPS_FIRST_ENVELOPE', 'USPS_FIRST_ENVELOPE_NON_MACHINABLE', 'USPS_FIRST_FLAT', 'USPS_FIRST_FLAT_NON_MACHINABLE', 'USPS_PARCELSELECT_LIGHTWEIGHT_PACKAGE', 'USPS_PARCELSELECT_PACKAGE', 'USPS_PRIORITY_PACKAGE', 'USPS_PRIORITY_CUBIC', 'USPS_PRIORITY_ENVELOPE', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_PADDED', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_LEGAL', 'USPS_PRIORITY_FLAT_RATE_BOX_SMALL', 'USPS_PRIORITY_FLAT_RATE_BOX', 'USPS_PRIORITY_FLAT_RATE_BOX_LARGE', 'USPS_PRIORITY_REGIONALRATEBOXA', 'USPS_PRIORITY_REGIONALRATEBOXB', 'USPS_PRIORITY_REGIONALRATEBOXC', 'USPS_PRIORITY_FLATRATEBOXAPOFPO', 'USPS_PRIORITY_SOFTPACK', 'USPS_PRIORITY_EXPRESS_PACKAGE', 'USPS_PRIORITY_EXPRESS_PACKAGE_NON_MACHINABLE', 'USPS_PRIORITY_EXPRESS_ENVELOPE', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE_LEGAL', 'USPS_EXPRESS_FLATRATEMEDIUMBOX', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE_PADDED', 'USPS_MEDIAMAIL_RECTPARCEL', 'USPS_CRITICAL_ENVELOPE', 'USPS_CRITICAL_FLAT', 'CONSDOM/Standard', 'CONSDOM/Expedited'<br /><strong>USPS Intl:</strong><br />'USPS_FIRST_PACKAGE_INTERNATIONAL', 'USPS_FIRST_ENVELOPE_INTERNATIONAL', 'USPS_FIRST_ENVELOPE_NON_MACHINABLE_INTERNATIONAL', 'USPS_FIRST_FLAT_INTERNATIONAL', 'USPS_PRIORITY_PACKAGE_INTERNATIONAL', 'INTLPRIORITY/ENVELOPE', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_PADDED_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_LEGAL_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_BOX_SMALL_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_BOX_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_BOX_LARGE_INTERNATIONAL', 'USPS_PRIORITY_EXPRESS_PACKAGE_INTERNATIONAL', 'USPS_PRIORITY_EXPRESS_ENVELOPE_INTERNATIONAL', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE_INTERNATIONAL', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE_LEGAL_INTERNATIONAL', 'INTLEXPRESS/FLATRATEMEDIUMBOX', 'USPS_PRIORITY_AIRMAIL_INTERNATIONAL', 'USPS_ISAL_RECTPARCEL', 'CONSINTL/RECTPARCEL', 'CONSINTL1/RECTPARCEL', 'CONSINTL2/RECTPARCEL', 'CONSINTL3/RECTPARCEL', 'CONSINTL4/RECTPARCEL', 'CONSINTL5/RECTPARCEL', 'CONSINTL6/RECTPARCEL', 'CONSINTL7/RECTPARCEL', 'CONSINTL8/RECTPARCEL', 'CONSINTL9/RECTPARCEL', 'CONSINTL10/RECTPARCEL', 'CONSINTL11/RECTPARCEL', 'CONSINTL12/RECTPARCEL', 'CONSINTL13/RECTPARCEL', 'CONSINTL14/RECTPARCEL', 'CONSINTL15/RECTPARCEL', 'CONSINTL16/RECTPARCEL', 'USPS_COMMERCIAL_EPACKET_INTERNATIONAL'<br /><strong>FedEx:</strong><br />'FEDEX_GROUND', 'FEDEX_HOME', 'FEDEX_FIRST_OVERNIGHT', 'FEDEX_PRIORITY_OVERNIGHT', 'FEDEX_STANDARD_OVERNIGHT', 'FEDEX_FIRST_OVERNIGHT_EXTRA_HOURS', 'FEDEX_PRIORITY_OVERNIGHT_EXTRA_HOURS', 'FEDEX_STANDARD_OVERNIGHT_EXTRA_HOURS', 'FEDEX_2DAY', 'FEDEX_2DAY_AM', 'FEDEX_EXPRESS_SAVER', 'FEDEX_SMART_POST', 'FEDEX_FIRST_OVERNIGHT_INTERNATIONAL', 'FEDEX_PRIORITY_OVERNIGHT_INTERNATIONAL', 'FEDEX_ECONOMY_INTERNATIONAL', 'FEDEX_GROUND_INTERNATIONAL', 'FEDEX_FREIGHT_1DAY', 'FEDEX_FREIGHT_2DAY', 'FEDEX_FREIGHT_3DAY', 'FEDEX_FREIGHT_FIRST', 'FEDEX_FREIGHT_ECONOMY', 'FEDEX_FREIGHT_PRIORITY', 'FEDEX_FREIGHT_PRIORITY_INTERNATIONAL', 'FEDEX_FREIGHT_ECONOMY_INTERNATIONAL', 'FEDEX_CONNECT_PLUS_INTERNATIONAL', 'FEDEX_PRIORITY_EXPRESS_INTERNATIONAL', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_ONE_RATE_PAK', 'FEDEX_2DAY_ONE_RATE_TUBE', 'FEDEX_2DAY_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_AM_ONE_RATE_PAK', 'FEDEX_2DAY_AM_ONE_RATE_TUBE', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_AM_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_PAK', 'FEDEX_EXPRESS_SAVER_ONE_RATE_TUBE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_MEDIUM_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_ENVELOPE', 'FEDEX_2DAY_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ENVELOPE', 'FEDEX_2DAYAM_ENVELOPE', 'FEDEX_INTLGROUNDCONSOLIDATION', 'FEDEX_STANDARDOVERNIGHT_ENVELOPE'<br /><strong>UPS:</strong><br />'UPS_GROUND', 'UPS_NEXT_DAY_AIR', 'UPS_NEXT_DAY_AIR_EARLY_AM', 'UPS_NEXT_DAY_AIR_SAVER', 'UPS_2DAY_AIR_AM', 'UPS_2DAY_AIR', 'UPS_3DAY_SELECT', 'UPS_STANDARD', 'UPS_EXPRESS_EARLY_AM', 'UPS_EXPRESS', 'UPS_EXPRESS_SAVER', 'UPS_EXPEDITED', 'UPS_WORLDWIDE_EXPRESS_PLUS', 'UPS_WORLDWIDE_EXPRESS', 'UPS_WORLDWIDE_SAVER', 'UPS_WORLDWIDE_EXPEDITED', 'UPS_STANDARD_TO_CANADA', 'UPS_GROUND_SAVER', 'UPS_SUREPOST_LESS1LB', 'UPS_SUREPOST_LESS1LB_IRREGULAR', 'UPS_SUREPOST_MORE1LB_IRREGULAR', 'UPS_SUREPOST_MEDIA_IRREGULAR', 'UPS_SUREPOST_BPM_IRREGULAR', 'UPS_SUREPOST_1LB_OR_GREATER_MACHINABLE', 'UPS_MAILINNOVATIONS_LESS1LB', 'UPS_MAILINNOVATIONS_PARCELPOST', 'UPS_MAILINNOVATIONS_MACHINABLE', 'UPS_MAILINNOVATIONS_STANDARD_FLAT', 'UPS_MAILINNOVATIONS_BPM_PARCEL', 'UPS_MAILINNOVATIONS_BPM_FLAT', 'UPS_MAILINNOVATIONS_MEDIA', 'UPS_MAILINNOVATIONS_FIRST', 'UPS_MAILINNOVATIONS_PRIORITY', 'UPS_MAILINNOVATIONS_PRIORITY_INTERNATIONAL', 'UPS_MAILINNOVATIONS_ECONOMY_INTERNATIONAL', 'UPS_FREIGHT', 'UPS_FREIGHT_GUARANTEED', 'UPS_FREIGHT_GUARANTEED_AM', 'UPS_FREIGHT_STANDARD', 'UPS_GROUND_SIMPLE_RATE_XS', 'UPS_GROUND_SIMPLE_RATE_S', 'UPS_GROUND_SIMPLE_RATE_M', 'UPS_GROUND_SIMPLE_RATE_L', 'UPS_GROUND_SIMPLE_RATE_XL', 'UPS_2DAY_AIR_SIMPLE_RATE_XS', 'UPS_2DAY_AIR_SIMPLE_RATE_S', 'UPS_2DAY_AIR_SIMPLE_RATE_M', 'UPS_2DAY_AIR_SIMPLE_RATE_L', 'UPS_2DAY_AIR_SIMPLE_RATE_XL', 'UPS_3DAY_SELECT_SIMPLE_RATE_XS', 'UPS_3DAY_SELECT_SIMPLE_RATE_S', 'UPS_3DAY_SELECT_SIMPLE_RATE_M', 'UPS_3DAY_SELECT_SIMPLE_RATE_L', 'UPS_3DAY_SELECT_SIMPLE_RATE_XL', 'UPS_ST_CA', 'UPS_WORLDWIDE_SAVER_ASIA', 'UPS_WORLDWIDE_EXPEDITED_ASIA', 'UPS_WORLDWIDE_EXPRESS_ASIA', 'UPS_WORLDWIDE_EXPRESS_PLUS_ASIA', 'UPS_WORLDWIDE_SAVER_CANADA', 'UPS_3DAY_SELECT_CANADA', 'UPS_WORLDWIDE_EXPEDITED_CANADA', 'UPS_WORLDWIDE_EXPRESS_PLUS_CANADA', 'UPS_WORLDWIDE_EXPRESS_CANADA'<br /><strong>DHL Express:</strong><br />'DHLE_EXPRESS_9AM', 'DHLE_ECONOMY_SELECT', 'DHLE_EXPRESS_1030AM', 'DHLE_DOMESTIC_EXPRESS', 'DHLE_EXPRESS_WORLDWIDE', 'DHLE_EUROPACK', 'DHLE_EXPRESS_1200AM', 'DHLE_EXPRESS_WORLDWIDE_DOC', 'DHLE_EXPRESS_1200AM_DOC', 'DHLE_EXPRESS_9AM_DOC', 'DHLE_EXPRESS_1030AM_DOC', 'DHLE_ECONOMYSELECT_A', 'DHLE_EXPRESS1030AM_A', 'DHLE_EXPRESS1200AM_A', 'DHLE_EXPRESS9AM_A', 'DHLE_EXPRESSENVELOPE', 'DHLE_EXPRESSENVELOPE_A', 'DHLE_EXPRESSWORLDWIDE_A'<br /><strong>DHL eCommerce:</strong><br />'DHLEC_PARCELS_GROUND', 'DHLEC_PARCELS_GROUND_IRREGULAR', 'DHLEC_PARCELS_PLUS_GROUND', 'DHLEC_PARCELS_PLUS_GROUND_IRREGULAR', 'DHLEC_PARCEL_GROUND_IRREGULAR', 'DHLEC_PARCEL_PLUS_GROUND_IRREGULAR', 'DHLEC_PARCELS_EXPEDITED', 'DHLEC_PARCELS_EXPEDITED_IRREGULAR', 'DHLEC_PARCELS_EXPEDITED_MAX', 'DHLEC_PARCELS_PLUS_EXPEDITED', 'DHLEC_PARCELS_PLUS_EXPEDITED_MAX', 'DHLEC_PARCEL_EXPEDITED_MAX', 'DHLEC_PARCEL_PLUS_EXPEDITED_MAX', 'DHLEC_PRIORITY', 'DHLEC_FIRST_PARCEL', 'DHLEC_FIRST_PARCEL_IRREGULAR', 'DHLEC_MARKETING_PARCEL_GROUND', 'DHLEC_MARKETING_PARCEL_GROUND_IRREGULAR', 'DHLEC_MARKETING_PARCEL_EXPEDITED', 'DHLEC_MARKETING_PARCEL_EXPEDITED_IRREGULAR', 'DHLEC_BPM_GROUND', 'DHLEC_BPM_EXPEDITED', 'DHLEC_CATALOG_BPM_GROUND', 'DHLEC_CATALOG_BPM_EXPEDITED', 'DHLEC_PACKET_STANDARD', 'DHLEC_PACKET_PRIORITY', 'DHLEC_PACKET_PLUS', 'DHLEC_PACKET_IPA', 'DHLEC_PACKET_ISAL', 'DHLEC_PARCEL_STANDARD', 'DHLEC_PARCEL_PRIORITY', 'DHLEC_PARCEL_DIRECT', 'DHLEC_PARCEL_DIRECT_EXPRESS', 'DHLEC_BUSINESS_STANDARD', 'DHLEC_BUSINESS_PRIORITY', 'DHLEC_BUSINESS_IPA', 'DHLEC_BUSINESS_ISAL', 'DHLEC_EXPEDITED_FLAT', 'DHLEC_GROUND_FLAT', 'DHLEC_PARCEL_RETURN_PLUS', 'DHLEC_PARCEL_RETURN_GROUND', 'DHLEC_PARCEL_RETURN_LIGHT', 'DHLEC_PARCEL_DIRECT_INBOUND_PRIORITY_INFORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_STANDARD_INFORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_PRIORITY_FORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_STANDARD_FORMAL', 'DHLEC_PARCEL_DIRECT_INTL', 'DHLEC_PARCEL_DIRECT_STANDARD_CA', 'DHLEC_PARCEL_DIRECT_PRIORITY_CA', 'DHLEC_PARCEL_DIRECT_MAX_CA', 'DHLEC_PARCELDIRECTEXPEDITED_RECTPARCEL'<br /><strong>OnTrac:</strong><br />'ONTRAC_GROUND', 'ONTRAC_SUNRISE', 'ONTRAC_SUNRISE_GOLD'<br /><strong>Estes:</strong><br />'ESTES_GUARANTEED_STANDARD', 'ESTES_GUARANTEED_ECONOMY', 'ESTES_GUARANTEED_BASIC', 'ESTES_GUARANTEED_EXCLUSIVE', 'ESTES_GUARANTEED_5PM', 'ESTES_GUARANTEED_12PM', 'ESTES_GUARANTEED_10AM', 'ESTES_STANDARD'<br /><strong>Purolator:</strong><br />'PUROLATOR_GROUND', 'PUROLATOR_GROUND_9AM', 'PUROLATOR_GROUND_10:30AM', 'PUROLATOR_GROUND_EVENING', 'PUROLATOR_EXPRESS', 'PUROLATOR_EXPRESS_9AM', 'PUROLATOR_EXPRESS_10:30AM', 'PUROLATOR_EXPRESS_12PM', 'PUROLATOR_EXPRESS_EVENING', 'PUROLATOR_EXPRESS_ENVELOPE', 'PUROLATOR_EXPRESS_ENVELOPE_9AM', 'PUROLATOR_EXPRESS_ENVELOPE_10:30AM', 'PUROLATOR_EXPRESS_ENVELOPE_12PM', 'PUROLATOR_EXPRESS_ENVELOPE_EVENING', 'PUROLATOR_EXPRESS_PACK', 'PUROLATOR_EXPRESS_PACK_9AM', 'PUROLATOR_EXPRESS_PACK_10:30AM', 'PUROLATOR_EXPRESS_PACK_12PM', 'PUROLATOR_EXPRESS_PACK_EVENING', 'PUROLATOR_EXPRESS_BOX', 'PUROLATOR_EXPRESS_BOX_9AM', 'PUROLATOR_EXPRESS_BOX_10:30AM', 'PUROLATOR_EXPRESS_BOX_12PM', 'PUROLATOR_EXPRESS_BOX_EVENING'<br /><strong>Amazon:</strong><br />'AMAZON_SHIPPING_GROUND'<br /><strong>GoFo Express:</strong><br />'GOFO_STANDARD', 'GOFO_GROUND'<br /><strong>UniUni:</strong><br />'UNIUNI_STANDARD', 'UNIUNI_EXPRESS'<br /><strong>Yanwen:</strong><br />'YW_STANDARD'<br /><strong>Canada Post:</strong><br />'CAPOST_CADOM_EP', 'CAPOST_CADOM_PC', 'CAPOST_CADOM_RP', 'CAPOST_CADOM_XP', 'CAPOST_CAINT_IP_AIR', 'CAPOST_CAINT_IP_SURF', 'CAPOST_CAINT_PW_ENV', 'CAPOST_CAINT_PW_PAK', 'CAPOST_CAINT_PW_PARCEL', 'CAPOST_CAINT_SP_AIR', 'CAPOST_CAINT_SP_SURF', 'CAPOST_CAINT_TP', 'CAPOST_CAINT_XP', 'CAPOST_CAUSA_EP', 'CAPOST_CAUSA_PW_ENV', 'CAPOST_CAUSA_PW_PAK', 'CAPOST_CAUSA_PW_PARCEL', 'CAPOST_CAUSA_SP_AIR', 'CAPOST_CAUSA_TP', 'CAPOST_CAUSA_XP'	Required
`Weight`	Weight	Weight of a package or an item.
`Dimensions`	Dimensions of package	If not set Teapplix will apply 6x6x4 by default
`IdenticalPackageCount`	integer	Count of identical packages. Currently supported only for FedEx/UPS	Minimum: 1
`Type`	PackageType \| CustomPackageName	Allows you to specify a built-in package type (integer) defined by the carrier, or a custom package you defined by name in your Teapplix account. You should specify one of 'Type' or 'Dimensions' in your input.
`PackageItems`	PackageItem[]	Items and their quantities inside the package. This information is required for certain marketplaces.
`Reference`	string	This value will be printed on label. BBCODE placeholders can be used.
`InsuranceValue`	number	Insurance Value.
`InsuranceFee`	number	Insurance Fee. This value is ignored for input.

DutyBilled

Duties and Taxes data

Property	Type	Description	Constraints
`Role`	string	Role	RequiredOne of: sender, recipient, third_party
`AccountNumber`	string	Account number
`AccountPostalCode`	string	Account Postal Code. Currently UPS only	Max-Length: 10
`AccountCountryCode`	string	Account Country Code. Currently UPS only	Max-Length: 2Min-Length: 2Pattern: [A-Z]{2}

Delivery

Property	Type	Description	Constraints
`Signature`	string	Signature type	One of: NOT_REQUIRED, ANY_REQUIRED, ADULT_REQUIRED, DIRECT_REQUIRED, INDIRECT_REQUIRED, SERVICE_DEFAULT
`Saturday`	integer	Saturday delivery
`Sunday`	boolean	Sunday delivery
`Holiday`	boolean	Holiday delivery
`Weekend`	boolean	Weekend delivery
`Am`	boolean	AM delivery
`Restricted`	boolean	Restricted area delivery
`Inside`	boolean	Inside delivery
`Residential`	integer	Residential delivery
`HomeDeliveryDate`	string	Home delivery date	Format: date
`Instructions`	string	Delivery Instructions, including HomeDelivery Instructions
`LiftGate`	boolean	Lift gate
`LimitedAccess`	boolean
`ConstructionSite`	boolean	Construction site
`CallBefore`	boolean	Call before

Service

Property	Type	Description
`RegisteredMail`	boolean	Registered mail
`AdditionalHandling`	boolean	Additional handling
`ShipperRelease`	boolean	Shipper Release
`CarbonNeutral`	boolean	Carbon neutral
`DangerousGoods`	boolean	Dangerous goods flag
`HandlingCharge`	boolean	Handling charge
`ExtremeLength`	boolean	Extreme length
`ReturnsClearance`	boolean	Returns clearance
`Pickup`	boolean	Pickup

Cod

C.O.D. details

Property	Type	Description	Constraints
`Amount`	Amount	Declares any amount value
`Kind`	string	Kind
`CollectionType`	string	Collection Type	One of: 1, 2, 3, 4, 5
`Address`	ReturnAddress	Return address printed on labels
`ReferenceIndicator`	string	Reference indicator
`TransportationChargesDetail`	string	Transportation Charges Detail	One of: ADD_ACCOUNT_COD_SURCHARGE, ADD_ACCOUNT_NET_CHARGE, ADD_ACCOUNT_NET_FREIGHT, ADD_ACCOUNT_TOTAL_CUSTOMER_CHARGE, ADD_LIST_COD_SURCHARGE, ADD_LIST_NET_CHARGE, ADD_LIST_NET_FREIGHT, ADD_LIST_TOTAL_CUSTOMER_CHARGE
`RecipientAccountNumber`	string	Recipient Account Number	Pattern: \d+
`BillingOption`	string	Billing Option	One of: Prepaid, Freight Collect

Ups

UPS specific options

Property	Type	Description
`SurepostNonMachineable`	boolean	UPS Surepost Non Machineable
`Qvn`	Qvn
`Freight`	UPS Freight

Fedex

FedEx specific options

Property	Type	Description
`CustomsOption`	string	Customs option
`Coverage`	string
`ExportDetail`	ExportDetail	Export detail
`Recipient`	Recipient	Recipient
`HoldAtLocation`	HoldAtLocation	Hold At Location
`SmartPostEndiciaType`	string
`TotalPalletWeight`	number
`FreightGuaranteeDetailDate`	string
`Delivery`	Delivery	Delivery
`Instructions`	Instructions	Instructions
`Freight`	FedEx Freight	Freight
`BillAccount`	string
`CollectTermsType`	string
`BrokerType`	string
`SignatureReleaseNumber`	string
`HandlingUnits`	string
`ExpressFreightBookingConfirmationNumber`	string
`B13aFilling`	string
`ExportStatement`	string
`ImportOfRecordAccountNumber`	string

DHL

DHLeC specific options

Property	Type	Description	Constraints
`TermsOfTrade`	string	Terms of Trade	One of: DDP, DAP
`ConsigneeTaxIdType`	string	Consignee Tax Id Type	One of: OTHER, GSTVAT, EORI, IOSS, TBD, PAN
`ConsigneeTaxId`	string	Consignee Tax Id
`ConsigneeIdType`	string	Consignee Id Type
`ConsigneeId`	string	Consignee Id

DHLE

DHL Express specific options

Property	Type	Description	Constraints
`DeliveryType`	string	Delivery Type: NONE DD (Door to Door) DA (Door to Airport) AA (Airport to Airport) DC (Door to Door non- Compliant)	One of: NONE, DD, DA, AA, DC

Weight

Weight of a package or an item.

Property	Type	Description	Constraints
`Value`	number	Absolute weight value	Required
`Unit`	string	Unit	RequiredOne of: OZ, LB, GR, KG

Dimensions of package

If not set Teapplix will apply 6x6x4 by default

Property	Type	Description	Constraints
`Length`	number	Length	Required
`Width`	number	Width	Required
`Depth`	number	Depth	Required
`Unit`	string	Unit of measurement	RequiredOne of: IN, CM

Amount

Declares any amount value

Property	Type	Description	Constraints
`Amount`	number
`Currency`	string		Pattern: [A-Z]{3}

ReturnAddress

Return address printed on labels

Property	Type	Description	Constraints
`Name`	string	Full name. Use instead of FirstName + LastName when the name split is unavailable. At least one of Name, FirstName + LastName, or Company is required.	Max-Length: 128
`FirstName`	string	First name. Use together with LastName instead of Name when the name split is available. Cannot be combined with Name.	Max-Length: 128
`LastName`	string	Last name. Use together with FirstName instead of Name when the name split is available. Cannot be combined with Name.	Max-Length: 128
`Company`	string	Company or organization name. At least one of Name, FirstName + LastName, or Company is required.	Max-Length: 127
`Street`	string	Street address, line 1 (building number and street name).	Max-Length: 255
`Street2`	string	Street address, line 2 (apartment, suite, unit, floor, etc.).	Max-Length: 255
`City`	string	City or town name.	Max-Length: 40Min-Length: 1
`State`	string	US state abbreviation (e.g. CA) or province/region name for international addresses.	Max-Length: 40
`ZipCode`	string	US ZIP code or international postal code.
`CountryCode`	string	ISO 3166-1 alpha-2 country code (e.g. US, CA, GB).	Max-Length: 2Min-Length: 2Pattern: [A-Z]{2}
`Country`	string	Full country name (e.g. United States, Canada). Defaults to United States
`PhoneNumber`	string	Phone number. Format may be normalized by the carrier.	Max-Length: 40
`Email`	string	Email address.

Qvn

Property	Type	Description
`Qvn`	integer	Qvn
`From`	string	From
`EmailOnFail`	string	Email on fail
`Subject`	string	Subject
`Memo`	string	Memo
`Recipients`	Freight Notification Recipient[]	Qvn Recipients

UPS Freight

Property	Type	Description	Constraints
`Class`	number	Freight Class
`PackageType`	string	Freight Package Type
`PackagesQuantity`	integer	Packages Quantity
`PayerName`	string	Payer Name	Max-Length: 40
`PayerAddress`	string	Payer Address	Max-Length: 255
`PayerCity`	string	Payer City	Max-Length: 50
`PayerState`	string	Payer State	Max-Length: 50
`SortingAndSegregating`	boolean	Sorting And Segregating
`SortingQuantity`	string	Sorting Quantity
`ExtremeLength`	boolean	Extreme Length
`FreezableProtection`	boolean	Freezable Protection
`Handling`	Handling	Handling
`DangerousGoods`	DangerousGoods	UPS Dangerous Goods Data
`Pickup`	Pickup

ExportDetail

Export detail

Property	Type	Constraints
`Kind`	string
`ForeignZoneCode`	string
`EntryNumber`	string
`LicenseNumber`	string
`ExpirationDate`	string	Format: date

Recipient

Property	Type	Description	Constraints
`TaxId`	CustomsId
`CustomsId`	CustomsId

HoldAtLocation

Hold At Location

Property	Type	Description	Constraints
`Applied`	string
`Address`	string
`AddressType`	string

Instructions

Property	Type	Description	Constraints
`Handling`	string
`Delivery`	string
`HomeDelivery`	string
`Pickup`	string

FedEx Freight

Freight

Property	Type	Description	Constraints
`Class`	string	Freight Class	One of: CLASS_050, CLASS_055, CLASS_060, CLASS_065, CLASS_070, CLASS_077_5, CLASS_085, CLASS_092_5, CLASS_100, CLASS_110, CLASS_125, CLASS_150, CLASS_175, CLASS_200, CLASS_250, CLASS_300, CLASS_400, CLASS_500
`PackageType`	string	Freight Package Type	One of: BAG, BARREL, BASKET, BOX, BUCKET, BUNDLE, CARTON, CASE, CONTAINER, CRATE, CYLINDER, DRUM, ENVELOPE, HAMPER, OTHER, PAIL, PALLET, PIECE, REEL, ROLL, SKID, TANK, TUBE
`PrintedReferenceType`	string	Printed Reference Type	One of: BILL_OF_LADING, CONSIGNEE_ID_NUMBER, SHIPPER_ID_NUMBER
`PrintedReferenceValue`	string	Printed Reference Value	Max-Length: 255
`GuaranteeDetailType`	string	Freight Guarantee Detail Type	One of: GUARANTEED_DATE, GUARANTEED_MORNING
`GuaranteeDetailDate`	string	Freight Guarantee Detail Date	Format: date
`Note`	string	Note	Max-Length: 255
`FreightDirectType`	string	Freight Direct Type	Max-Length: 255
`FreightDirectTransportationType`	string	Freight Direct Transportation Type	Max-Length: 255
`FreightDirectEmail`	string	Freight Direct Email	Max-Length: 255
`FreightDirectPhoneType1`	string	Freight Direct Phone Type 1	Max-Length: 255
`FreightDirectPhoneNumber1`	string	Freight Direct Phone Number 1	Max-Length: 255
`FreightDirectPhoneType2`	string	Freight Direct Phone Type 2	Max-Length: 255
`FreightDirectPhoneNumber2`	string	Freight Direct Phone Number 2	Max-Length: 255
`FreightDirectPhoneType3`	string	Freight Direct Phone Type 3	Max-Length: 255
`FreightDirectPhoneNumber3`	string	Freight Direct Phone Number 3	Max-Length: 255

Customs item

Customs declaration item

Property	Type	Description	Constraints
`Name`	string	Item's name	RequiredMax-Length: 255
`Sku`	string	Item SKU, should be set if known	Max-Length: 127
`Description`	string	Item's description. Some carriers can print it on label	RequiredMax-Length: 255
`Quantity`	integer	Quantity of item in the shipment	RequiredMinimum: 1
`Amount`	number	Customs value subtotal for this item	Required
`Currency`	string		Pattern: [A-Z]{3}
`CustomsWeight`	Weight	Weight of a package or an item.
`OriginCountry`	string	Country code of origin country	Pattern: [A-Z]{2}
`TariffCode`	string	Harmonized Tariff code
`DGType`	integer	USPS Dangerous Goods Type - typically used only for domestic shipments, applies USPS and DHL

PackageItem

Declares package item to be shipped

Property	Type	Description	Constraints
`LineNumber`	integer	One of Line Number or Item Name is required.
`Name`	string	Specify Name of Item only if it is unique in Order Items list, otherwise specify Line Number. One of Line Number or Name is required.
`Quantity`	integer	Quantity.	RequiredMinimum: 1

Handling

Property	Type	Description
`Charge`	string	Handling Charge
`ChargeType`	string	Handling Charge Type
`ChargeValue`	string	Handling Charge Value
`Instructions`	string	Instructions

DangerousGoods

UPS Dangerous Goods Data

Property	Type	Description	Constraints
`Type`	integer
`Name`	string	Dangerous Goods Name	Max-Length: 40
`PhoneNumber`	string	Dangerous Goods Phone Number	Max-Length: 40
`PhoneExtension`	string	Dangerous Goods Phone Extension	Max-Length: 10

Pickup

Property	Type	Description
`Weekend`	boolean	Weekend
`Holiday`	boolean	Holiday
`Inside`	boolean	Inside
`Residential`	boolean	Residential
`LimitedAccess`	boolean	Limited access
`LiftGate`	boolean	Lift Gate Pickup Required
`Instructions`	string	Instructions

CustomsId

Property	Type	Description	Constraints
`Type`	string
`Number`	string

Freight Notification Recipient

Property	Type	Description
`CompanyOrName`	string	Company or Name
`ContactName`	string	Contact Name
`Email`	string	Email
`ShipNotify`	boolean	Ship Notify
`ExceptionNotify`	boolean	Exception Notify
`DeliveryNotify`	boolean	Delivery Notify
`BolNotify`	boolean	Bol Notify
`BolEmailSubject`	string	Bol Email Subject
`BolEmailText`	string	Bol Email Text

POST Response - 200

Purchase Label Result

Represents purchase label result

Property	Type	Description	Constraints
`Success`	boolean	DEPRECATED: always true on this envelope. Read Status instead. Will be removed in the next API major version.
`Status`	string	Operation status: 'Purchased' on success.	RequiredOne of: Purchased
`Message`	string	Human-readable result message.
`Description`	string[]	Detailed description
`ClientRequestId`	string	This is the same ClientRequestId that caller passed in, returned to the caller.
`TrackingInfo`	Tracking Info[]	Array with tracking info for generated labels
`LabelData`	Document[]	Array with base64 encoded data of label image, in the requested format.
`DocumentsData`	Document[]	Array with document URL or contents
`PostageAmount`	Amount	Declares any amount value
`ASN`	string	DEPRECATED! ASN Number for Walmart DSV ship to store orders
`Provider`	string	Provider if specified will force usage of label from MARKETPLACE vs NATIVE carrier accounts linked in Teapplix.	One of: NATIVE, MARKETPLACE, TEAPPLIX, DHL, DHL_EXPRESS, FEDEX, UPS, ONTRAC, AMAZON_BUY_SHIPPING, ENDICIA, RATESHOP

Amount

Declares any amount value

Property	Type	Description	Constraints
`Amount`	number
`Currency`	string		Pattern: [A-Z]{3}

Tracking Info

Tracking info

Property	Type	Description	Constraints
`TrackingNumber`	string	Tracking number of shipment	Max-Length: 50
`CarrierName`	string	Carrier name which is assigned with tracking
`SSCC`	string	Serial Shipping Container Code

Document

Document details

Property	Type	Constraints
`Type`	string	One of: URL, INLINE
`ContentType`	string	One of: PDF, ZIP, PNG, HTML, CSV
`Content`	string	RequiredMin-Length: 1

POST Response - 400

Message

Property	Type	Description	Constraints
`Success`	boolean	Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status.	Required
`Code`	integer	Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115
`Message`	string	Message typically associated with errors
`Description`	string[]	Detailed description

POST Response - 500

Message

Property	Type	Description	Constraints
`Success`	boolean	Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status.	Required
`Code`	integer	Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115
`Message`	string	Message typically associated with errors
`Description`	string[]	Detailed description

URL APIToken Body

Cloud Print
If you specified a shipping profile to cloud print, and in API use the ProfileId parameter and specify LabelReturn=“PRINT”, then API will check that the profile has proper cloud print settings, and send the label directly to cloud printer.