Order Management
Order Management

Order Batch Creation

Use the https://app.ship.com/public/order/batch endpoint create a new shipping order

Request Parameters

Array of order creation objects. (Same as Order Creation)

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

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

Field Type Description
success boolean Indicates if the request was successful
result object Contains the created order details
error string Error message if request failed