Explore Plans
Mobile menu Close menu
Shippo

Create order

This action will create an order

Developer info

API endpoint slug
shippo.create_order
Filter code method
Shippo.createOrder.skip(string?: reason)
Runtime method
runAction("shippo.create_order", {})

Action fields

Name Text input > Other

Label
Name
Helper text
The name of the recipient for the order
Slug
name
Required
true
Can have default value
true
Filter code method
Shippo.createOrder.setName(string: name)

Email Text input > Other

Label
Email
Helper text
The email for the recipient of the order
Slug
email
Required
false
Can have default value
true
Filter code method
Shippo.createOrder.setEmail(string: email)

Company Text input > Other

Label
Company
Helper text
The company name of the recipient for the order
Slug
company
Required
false
Can have default value
true
Filter code method
Shippo.createOrder.setCompany(string: company)

Street1 Text input > Other

Label
Street Address Line 1
Helper text
Line 1 of the recipient address.
Slug
street1
Required
true
Can have default value
true
Filter code method
Shippo.createOrder.setStreet1(string: street1)

Street2 Text input > Other

Label
Street Address Line 2
Helper text
Line 2 of the recipient address.
Slug
street2
Required
false
Can have default value
true
Filter code method
Shippo.createOrder.setStreet2(string: street2)

City Text input > Other

Label
City
Helper text
The city of the recipient address
Slug
city
Required
true
Can have default value
true
Filter code method
Shippo.createOrder.setCity(string: city)

State Text input > Other

Label
State
Helper text
The state of the recipient address
Slug
state
Required
true
Can have default value
true
Filter code method
Shippo.createOrder.setState(string: state)

Zip Text input > Other

Label
Zip
Helper text
The zip code of the recipient address
Slug
zip
Required
true
Can have default value
true
Filter code method
Shippo.createOrder.setZip(string: zip)

Country Text input > Other

Label
Country
Helper text
The country of the recipient address
Slug
country
Required
true
Can have default value
true
Filter code method
Shippo.createOrder.setCountry(string: country)

Order number Text input > Other

Label
Order Number
Helper text
A custom order number.
Slug
order_number
Required
false
Can have default value
true
Filter code method
Shippo.createOrder.setOrder Number(string: order_number)

Order status Dropdown list

Label
Order Status
Helper text
The status of the order.
Slug
order_status
Required
true
Can have default value
true
Filter code method
Shippo.createOrder.setOrder Status(string: order_status)

Line item title Text input > Other

Label
Line Item Title
Helper text
The title of the line item.
Slug
line_item_title
Required
true
Can have default value
true
Filter code method
Shippo.createOrder.setLine Item Title(string: line_item_title)

Line item sku Text input > Other

Label
Line Item Sku
Helper text
The SKU of the line item.
Slug
line_item_sku
Required
false
Can have default value
true
Filter code method
Shippo.createOrder.setLine Item Sku(string: line_item_sku)

Line item quantity Text input > Other

Label
Line Item Quantity
Helper text
The quantity of the line item.
Slug
line_item_quantity
Required
true
Can have default value
true
Filter code method
Shippo.createOrder.setLine Item Quantity(string: line_item_quantity)

Line item total price Text input > Other

Label
Line Item Price
Helper text
The price of the line item, per quantity.
Slug
line_item_total_price
Required
true
Can have default value
true
Filter code method
Shippo.createOrder.setLine Item Total Price(string: line_item_total_price)

Line item currency Text input > Other

Label
Line Item Currency
Helper text
Enter the 3-letter currency code (i.e. USD, EUR, GBP).
Slug
line_item_currency
Required
true
Can have default value
true
Filter code method
Shippo.createOrder.setLine Item Currency(string: line_item_currency)

Line item weight Text input > Other

Label
Line Item Weight
Helper text
The numerical weight value of the line item.
Slug
line_item_weight
Required
true
Can have default value
true
Filter code method
Shippo.createOrder.setLine Item Weight(string: line_item_weight)

Line item weight unit Dropdown list

Label
Line Item Weight Unit
Helper text
The weight unit of the line item.
Slug
line_item_weight_unit
Required
true
Can have default value
true
Filter code method
Shippo.createOrder.setLine Item Weight Unit(string: line_item_weight_unit)

Shipping method Text input > Other

Label
Shipping method
Slug
shipping_method
Required
false
Can have default value
true
Filter code method
Shippo.createOrder.setShipping Method(string: shipping_method)

Shipping cost Text input > Other

Label
Shipping Cost
Helper text
The shipping cost.
Slug
shipping_cost
Required
false
Can have default value
true
Filter code method
Shippo.createOrder.setShipping Cost(string: shipping_cost)

Shipping cost currency Text input > Other

Label
Shipping Cost Currency
Helper text
Enter the 3-letter currency code (i.e. USD, EUR, GBP).
Slug
shipping_cost_currency
Required
false
Can have default value
true
Filter code method
Shippo.createOrder.setShipping Cost Currency(string: shipping_cost_currency)