콘텐츠로 이동
TeapplixTeapplixTeapplix Help

Set Shipping Options

이 콘텐츠는 아직 번역되지 않았습니다.

You can set ship options, including shipping method, weight, dimensions, extra packages and other options on an existing unshipped order in your Teapplix using POST /OrderShipOptions API. Notice this API is designed to update orders not yet shipped without marking the order as shipped:

  • To get what is the current package and options on an order, download the order using GET /OrderNotification
  • To download information regarding an shipped order, optionally including labels, use /Shipment endpoint
  • To mark an order shipped, including uploading a label image, use POST /Shipment endpoint
https://api.teapplix.com/api2/OrderShipOptions Explorer

GET Request

Query parameters

PropertyTypeDescriptionConstraints
TxnId string Order ID to retrieve options for. Required
DetailLevel string Pass 'carrier' to receive the full carrier-specific Options tree. Default returns only carrier-agnostic fields (InsuranceType, Delivery).

GET Response - 200

ShippingOptionsGetResult

Response from GET /OrderShipOptions. By default returns only carrier-agnostic Options fields (InsuranceType, Delivery). Pass DetailLevel=carrier to receive the full carrier-specific Options tree.

PropertyTypeDescriptionConstraints
TxnId string Order ID. Required
Options Saved Shipping Options Shipping options for the order. By default contains carrier-agnostic fields only (InsuranceType, Delivery.Signature, Delivery.Residential). Pass DetailLevel=carrier to include the full carrier-specific options tree. Required

Saved Shipping Options

Shipping options for the order. By default contains carrier-agnostic fields only (InsuranceType, Delivery.Signature, Delivery.Residential). Pass DetailLevel=carrier to include the full carrier-specific options tree.

PropertyTypeDescriptionConstraints
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

DutyBilled

Duties and Taxes data

PropertyTypeDescriptionConstraints
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

Delivery

PropertyTypeDescriptionConstraints
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

PropertyTypeDescriptionConstraints
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

PropertyTypeDescriptionConstraints
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

PropertyTypeDescriptionConstraints
SurepostNonMachineable boolean UPS Surepost Non Machineable
Qvn Qvn
Freight UPS Freight

Fedex

FedEx specific options

PropertyTypeDescriptionConstraints
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

PropertyTypeDescriptionConstraints
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

PropertyTypeDescriptionConstraints
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

Amount

Declares any amount value

PropertyTypeDescriptionConstraints
Amount number
Currency string Pattern: [A-Z]{3}

ReturnAddress

Return address printed on labels

PropertyTypeDescriptionConstraints
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

PropertyTypeDescriptionConstraints
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

PropertyTypeDescriptionConstraints
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

PropertyTypeDescriptionConstraints
Kind string
ForeignZoneCode string
EntryNumber string
LicenseNumber string
ExpirationDate string Format: date

Recipient

Recipient

PropertyTypeDescriptionConstraints
TaxId CustomsId
CustomsId CustomsId

HoldAtLocation

Hold At Location

PropertyTypeDescriptionConstraints
Applied string
Address string
AddressType string

Instructions

Instructions

PropertyTypeDescriptionConstraints
Handling string
Delivery string
HomeDelivery string
Pickup string

FedEx Freight

Freight

PropertyTypeDescriptionConstraints
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

Handling

Handling

PropertyTypeDescriptionConstraints
Charge string Handling Charge
ChargeType string Handling Charge Type
ChargeValue string Handling Charge Value
Instructions string Instructions

DangerousGoods

UPS Dangerous Goods Data

PropertyTypeDescriptionConstraints
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

PropertyTypeDescriptionConstraints
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

PropertyTypeDescriptionConstraints
Type string
Number string

Freight Notification Recipient

PropertyTypeDescriptionConstraints
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

GET Response - 400

Message

PropertyTypeDescriptionConstraints
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

GET Response - 404

Message

PropertyTypeDescriptionConstraints
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

GET Response - 409

Message

PropertyTypeDescriptionConstraints
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

GET Response - 500

Message

PropertyTypeDescriptionConstraints
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
Test Request