Order Management
Order Creation
Use the /order endpoint to create a new shipping order.
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 |
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
{
"invoiceNumber": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "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,
"items": [
{
"itemCode": "string",
"upc": "string",
"price": 0.00,
"quantity": 0
}
]
}
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 |