| Name | Description | Type | Additional information |
|---|---|---|---|
| TransactionType | OrderTransactionType |
Optional(Default transaction type is Sales)
|
|
| OrderType |
Order type |
string |
None. |
| AutoprocessShipment |
Flag to autoprocess shipment |
boolean |
None. |
| ShipDate |
Ship date in UTC |
date |
None. |
| OrderNumber |
This variable will be used to bind your order in FreightPop. Must be unique from Previous orders imported. |
string |
None. |
| QuoteId |
Optional, need to be passed from Rates V3 API. Must not be greater than 10 characters if passed. |
string |
None. |
| RateId |
Optional, need to be passed from Rates V3 API. |
string |
None. |
| CustomerId |
Company ID for customers when Logistics Provider flag is turned on. Otherwise it will be ignored. |
string |
None. |
| CompanyErpId |
Company ERP ID |
integer |
None. |
| ShipperAddress |
Shipper address |
OrderShipperAddressV4 |
None. |
| ReturnAddress |
Return Address |
OrderShipperAddressV4 |
None. |
| ConsigneeAddress |
Consignee address |
OrderConsigneeAddressV4 |
None. |
| SoldToAddress |
Sold to address |
OrderSoldToAddressV4 |
None. |
| Items |
Product details |
Collection of ShipmentItemV4Dto |
None. |
| ProductDetails |
Product Details |
Collection of ProductDetailV4 |
None. |
| ITN |
ITN (International Transaction Number) |
string |
None. |
| Carrier |
Carrier details |
CarrierV2 |
None. |
| PaymentTerm |
Order payment terms |
PaymentTerm |
None. |
| ThirdPartyAccountInfo |
Third party account details |
AccountDetails |
None. |
| Reference1 |
Reference field 1 |
string |
None. |
| Reference2 |
Reference field 2 |
string |
None. |
| Reference3 |
Reference field 3 |
string |
None. |
| Reference4 |
Reference field 4 |
string |
None. |
| Reference5 |
Reference field 5 |
string |
None. |
| Reference6 |
Reference field 6 |
string |
None. |
| AdditionalDetails |
Additional details |
AdditionalDetailsV4 |
None. |
| Documents | Collection of OrderDocumentDto |
Optional(Documents for the order)
|
|
| OrderProcessDate |
The date when an order was processed |
date |
Optional
|