Create an order with POST https://app.ship.com/public/order. Requires the Authorization: Bearer header. Orders are matched to a customer record by exact email within your account, creating one if none exists; pass customerId to attach the order to a specific customer record instead.

Request Parameters

Field	Type	Max Length	Required	Description
invoiceNumber	string	-	Yes	Unique invoice identifier
firstName	string	50	Yes	Recipient's first name
lastName	string	50	Yes	Recipient's last name
email	string	100	No	Recipient's email
phone	string	10	No	Recipient's phone number
address1	string	50	Yes	Primary shipping address
address2	string	50	No	Secondary shipping address
city	string	50	Yes	City name
state	string	2	Yes	Two-letter state code
zip	string	5	Yes	Five-digit zip code
country	string	2	Yes	Two-letter country code
total	decimal	-	No	Order total amount
salesTax	decimal	-	No	Sales tax amount
handling	decimal	-	No	Handling fees
subtotal	decimal	-	No	Order subtotal
shipping	decimal	-	No	Shipping cost
weight	decimal	-	No	Order weight
discount	decimal	-	No	Discount amount
items	array	-	Yes	Array of order items
customerId	int	–	No	Attach the order to a customer record you own (get ids from GET /public/customers or any order read); when supplied, email matching is skipped
orderNote	string	50	No	Order note

Item Object Structure

Field	Type	Required	Description
itemCode	string	Yes	Unique item identifier
upc	string	No	Universal Product Code
price	decimal	No	Item price
quantity	integer	Yes	Quantity ordered

Request Example

1{
2	"invoiceNumber": "string",
3    "customerId": 0,
4    "firstName": "string",
5    "lastName": "string",
6    "email": "string",
7    "phone": "string",
8    "address1": "string",
9    "address2": "string",
10    "city": "string",
11    "state": "string",
12    "zip": "string",
13    "country": "string",
14    "total": 0.00,
15    "salesTax": 0.00,
16    "handling": 0.00,
17    "subtotal": 0.00,
18    "shipping": 0.00,
19    "weight": 0.00,
20    "discount": 0.00,
21    "orderNote": "string",
22    "items": [
23        {
24            "itemCode": "string",
25            "upc": "string",
26            "price": 0.00,
27            "quantity": 0
28        }
29    ]
30}

Response Structure

Field	Type	Description
success	boolean	Indicates if the request was successful
result	object	The created order object, including id, customerId, orderStatus, and shipment
error	string	Error message if request failed

< Order List

Order Batch Creation >

On this page

Order Creation Request Parameters Item Object Structure Request Example Response Structure