Order Create
Overview
The Order API allows you to create and submit orders directly to Waldom. This API is designed for seamless integration into your existing ERP or website, facilitating efficient order processing.
Important: Prior to creating an order, you must have a checkout profile saved within your company account. This ensures that all necessary details for processing the order are already in place.
Acceptable Characters: Our API only accepts input containing standard English characters, specifically letters A-Z in both uppercase and lowercase formats. Inputs must not contain any diacritical marks or special characters, such as umlauts (e.g., ä, ö, ü) or other non-ASCII symbols. Please ensure all input data adheres strictly to these character restrictions to avoid any issues with processing.
Request Parameters
| Parameter | Description | Required |
|---|---|---|
| buyer email | The email address of the customer to be associated to the sales order | yes |
|
purchase order number
|
The customer order unique alphanumeric identifier. | yes |
|
on hold
|
On hold orders will not be processed untill they are released, allowed values: true,false. Blank is equivalent to false. | |
| shipping method | Check available shipping methods for possible values. If your account is setup with a default shipping method and this field is blank; the default shipping method will be selected. Shipping methods availability depends on the order shipping country. | yes |
|
shipping account No
|
Blank if not shipping with freight account number | |
|
other shipping carrier
|
Blank if shipping with listed carriers | |
|
invoice CC email
|
||
|
invoice CC email 2
|
||
|
notify when shipped
|
To receive email notification when order is shipped | |
|
ADM use
|
Is any product specifically earmarked for Aerospace, Defense, or Marine (ADM) end use | |
|
backorder option
|
1=order complete 2=line complete 3=split leav 0 for default | |
| shippingAddress | The shipping address for the order | yes |
| shippingAddress.company | The company name to be used for the ship-to address | yes |
| shippingAddress.countryTwoletterISOCode | The two character country code to be used for the ship-to address (e.g. US) | yes |
| shippingAddress.stateProvinceAbbreviation | The state or province to be used for the ultimate destination address | yes |
| shippingAddress.city | The city to be used for the ship-to address | yes |
| shippingAddress.address1 | The first address to be used for the ship-to address | yes |
| shippingAddress.address2 | The second address to be used for the ship-to address | |
| shippingAddress.zipPostalCode | The postal code to be used for the ship-to address | yes |
| shippingAddress.attention | The Attention to be used for the ship-to address | |
| paymentMethod | The payment method to pay for the order. Login to see payment methods possible values. | yes |
| order comment | Comment of the currently selected order | |
|
shipping comments
|
Shipping comments | |
|
EndCustomerNumber
|
End customer number | yes* |
|
EndCustomerOrderNumber
|
End customer order number | yes* |
|
EndCustomerPoNumber
|
End customer purchase order number | yes* |
|
EndCustomerCurrency
|
End customer currency | yes* |
| orderItem | yes | |
| orderItem.productId | The unique identifier for the order line item | yes |
| orderItem.lineNumber | The line number of the item | yes |
| orderItem.partNumber | ||
| orderItem.manufacturerName | ||
| orderItem.price | The product unit price | |
| orderItem.cutomerPartNumber | The customer custom part number | |
| orderItem.endCustomerCost | The cost of item for end customer | yes* |
|
orderItem.orderItemSchedules
|
||
|
orderItem.orderItemSchedules.scheduleQuantity
|
The number of items purchased | yes |
|
orderItem.orderItemSchedules.requestedShipDate
|
Requested date to ship | yes |
|
orderItem.orderItemSchedules.requestedDeliveryDate
|
Requested date to deliver | yes |
|
orderItem.orderItemSchedules.scheduleLineNumber
|
sequence number |
*Only required if order is a blind fulfilment order
Available Shipping Methods
USA Options domestic
| Service Code | |
|---|---|
| Add to Invoice | UPS 2nd DAY AIR, UPS 3RD DAY SELECT, UPS FREIGHT, UPS GROUND, UPS NEXT DAY AIR, UPS NEXT DAY AIR EARLY AM DEL, UPS NEXT DAY AIR SAT DEL, UPS NEXT DAY AIR SAVER, UPS SOLUTIONS, UPS STANDARD |
| Freight Account | AIRBORNE GROUND (DHL), AIRBORNE SECOND DAY (DHL), CONWAY CCX TRANS, FEDEX 2DAY, FEDEX EXPRESS SAVER - 3 DAY, FEDEX GROUND, FEDEX PRIORITY OVERNITE, FEDEX STANDARD OVERNITE, GEODIS WILSON, OTHER - SEE SPECIAL INSTRUCTIONS, ROADWAY, TNT, TODD TRANSIT, UPS 2nd DAY AIR, UPS 2nd DAY AIR, UPS 3RD DAY SELECT, UPS 3RD DAY SELECT, UPS FREIGHT, UPS FREIGHT, UPS GROUND, UPS NEXT DAY AIR, UPS NEXT DAY AIR, UPS NEXT DAY AIR EARLY AM DEL, UPS NEXT DAY AIR EARLY AM DEL, UPS NEXT DAY AIR SAT DEL, UPS NEXT DAY AIR SAT DEL, UPS NEXT DAY AIR SAVER, UPS NEXT DAY AIR SAVER, UPS SOLUTIONS, UPS SOLUTIONS, UPS STANDARD, USF HOLLAND, Will Call/Pickup, YELLOW FREIGHT |
USA Options Canada/Mexico
| Service Code | |
|---|---|
| Add to Invoice | UPS STANDARD, UPS WORLDWIDE EXPEDITED (3-5 DAYS), UPS WORLDWIDE EXPRESS (2-3 DAYS), UPS WORLDWIDE EXPRESS PLUS, UPS WORLDWIDE EXPRESS SAVER, UPS WW SAVER |
| Freight Account | AIRBORNE EXPRESS (DHL), AIRBORNE GROUND (DHL), AIRBORNE SECOND DAY (DHL), ASIA UPS WW SAVER, CENTRAL FREIGHT, CONWAY CCX TRANS, DHL EXPRESS, FEDEX INTERNATIONAL ECONOMY-3 DAY, FEDEX INTERNATIONAL GROUND, FEDEX INTERNATIONAL PRIORITY, FEDEX PRIORITY OVERNITE, FEDEX STANDARD OVERNITE, GEODIS WILSON, OTHER - SEE SPECIAL INSTRUCTIONS, ROADWAY, TNT, TODD TRANSIT, UPS FREIGHT, UPS NEXT DAY AIR EARLY AM DEL, UPS NEXT DAY AIR SAVER, UPS SOLUTIONS, UPS STANDARD, UPS WORLDWIDE EXPEDITED (3-5 DAYS), UPS WORLDWIDE EXPRESS (2-3 DAYS), UPS WORLDWIDE EXPRESS PLUS, UPS WORLDWIDE EXPRESS SAVER, UPS WW SAVER, USF HOLLAND, Will Call/Pickup, YELLOW FREIGHT |
USA Options International
| Service Code | |
|---|---|
| Add to Invoice | UPS WORLDWIDE EXPEDITED (3-5 DAYS), UPS WORLDWIDE EXPRESS (2-3 DAYS), UPS WORLDWIDE EXPRESS PLUS, UPS WORLDWIDE EXPRESS SAVER, UPS WW SAVER |
| Freight Account | AIRBORNE EXPRESS (DHL), AIRBORNE GROUND (DHL), AIRBORNE SECOND DAY (DHL), ASIA UPS WW SAVER, CENTRAL FREIGHT, CONWAY CCX TRANS, DHL EXPRESS, FEDEX GROUND, FEDEX INTERNATIONAL ECONOMY-3 DAY, FEDEX INTERNATIONAL GROUND, FEDEX INTERNATIONAL PRIORITY, FEDEX PRIORITY OVERNITE, FEDEX STANDARD OVERNITE, GEODIS WILSON, OTHER - SEE SPECIAL INSTRUCTIONS, ROADWAY, TNT, TODD TRANSIT, UPS FREIGHT, UPS NEXT DAY AIR EARLY AM DEL, UPS NEXT DAY AIR SAVER, UPS SOLUTIONS, UPS STANDARD, UPS WORLDWIDE EXPEDITED (3-5 DAYS), UPS WORLDWIDE EXPRESS (2-3 DAYS), UPS WORLDWIDE EXPRESS PLUS, UPS WORLDWIDE EXPRESS SAVER, UPS WW SAVER, USF HOLLAND, Will Call/Pickup, YELLOW FREIGHT |
Potential Error Messages
The following is a list of error messages that could be received as a result of an error in the API request or one of the Waldom internal prerequisites not being completed.
| Description |
|---|
| Invalid buyer email |
| Billing address missing in account |
| Shipping address is required |
| Invalid Shipping address country ISO code |
| Invalid Shipping address state province abbreviation |
| Invalid shipping method |
| Only freight account is allowed for shipping method. |
| Invalid payment method |
| one order item is required |
| Invalid Product |
| Invalid Product quantity |
