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    "firstName": "string",
4    "lastName": "string",
5    "email": "string",
6    "phone": "string",
7    "address1": "string",
8    "address2": "string",
9    "city": "string",
10    "state": "string",
11    "zip": "string",
12    "country": "string",
13    "total": 0.00,
14    "salesTax": 0.00,
15    "handling": 0.00,
16    "subtotal": 0.00,
17    "shipping": 0.00,
18    "weight": 0.00,
19    "discount": 0.00,
20    "items": [
21        {
22            "itemCode": "string",
23            "upc": "string",
24            "price": 0.00,
25            "quantity": 0
26        }
27    ]
28}

Response Structure

Order Object (response)

{
  "id": 0,
  "customerId": 0,
  "invoiceNumber": "string",
  "orderNumber": "string",
  "orderStatus": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "phone": "string",
  "address1": "string",
  "address2": "string",
  "address3": "string",
  "city": "string",
  "state": "string",
  "zip": "string",
  "country": "string",
  "total": 0.00,
  "salesTax": 0.00,
  "handling": 0.00,
  "subtotal": 0.00,
  "shipping": 0.00,
  "weight": 0.00,
  "discount": 0.00,
  "length": 0.00,
  "width": 0.00,
  "height": 0.00,
  "orderNote": "string",
  "dateTime": "date",
  "shipment": {
    "shipDate": "date",
    "shippingMethod": "string",
    "shippingCost": 0.00,
    "trackingNumber": "string",
    "trackingURL": "string",
    "shippingLabelURL": "string"
  },
  "items": [
    {
      "id": 0,
      "itemCode": "string",
      "upc": "string",
      "price": 0.00,
      "quantity": 0,
      "totalPrice": 0.00
    }
  ]
}

Shipment Object

Field	Type	Description
shipDate	date	Date the label was purchased / the order shipped
shippingMethod	string	Service the label was bought with
shippingCost	decimal	Amount charged for the label
trackingNumber	string	Carrier tracking number; null until a label is purchased
trackingURL	string	Carrier tracking page for this shipment
shippingLabelURL	string	URL of the printable label

Item Object (response)

Field	Type	Description
id	integer	Ship.com item id
itemCode	string	Unique item identifier
upc	string	Universal Product Code
price	decimal	Item price
quantity	integer	Quantity ordered
totalPrice	decimal	price multiplied by quantity

< Order Batch Creation

Order Edit >

On this page

Order Creation Objects Request Parameters Item Object Structure Request Example Response Structure