Name
(* = required)
|
Data Type | Description |
batchId
*
|
string |
ID of rate batch |
returnAllRates
|
bool |
specify if all rates should be returned |
|
Type |
Description |
FaultedOrders |
Generic.Models.Exceptions.ListException
|
container of WmsExceptionBase-derived exceptions occuring during actions on lists, such as import or mass ops
|
Message |
string
|
|
Faults |
IList<Generic.Models.Exceptions.ListEntryFault>
|
|
EntryNumber |
int
|
1-indexed position in the source list
|
EntryInfo |
string
|
optional info about the entry in the source list, such as id, sku, ref#, etc.
|
WmsException |
Generic.Models.Exceptions.WmsExceptionBase
|
for more details at runtime see which WmsExceptionBase-derived exception it is
|
ErrorCode |
string
|
could have been a number, but is a short string for human readability; not to be localized
|
Hint |
string
|
helpful word or two if the thrower happens to know more things; not to be localized
|
Message |
string
|
|
InnerException |
System.Exception
|
|
ResourceList |
IList<Order.Models.ParcelRate>
|
|
OrderId |
int
|
|
Carrier |
string
|
|
Service |
string
|
|
ServiceCode |
string
|
|
Rate |
Order.Models.RateAmounts
|
|
shipping |
Double
|
|
insurance |
Double
|
|
confirmation |
Double
|
|
other |
Double
|
|
total |
Double
|
|
DeliveryDate |
DateTime?
|
|
PackageType |
string
|
|
CarrierAccount |
string
|
|
Nickname |
string
|
|
Provider |
string
|
|
RateDetails |
List<Order.Models.RateDetails>
|
|
RateDetailType |
string
|
|
CarrierDescription |
string
|
|
Amount |
Single
|
|
RequestId |
string
|
|
Days |
int?
|
|
SplitPackageRates |
List<Order.Models.SplitPackageRates>
|
|
packageId |
string
|
|
amounts |
Order.Models.RateAmounts
|
|
shipping |
Double
|
|
insurance |
Double
|
|
confirmation |
Double
|
|
other |
Double
|
|
total |
Double
|
|
rateDetails |
List<Order.Models.RateDetails>
|
|
RateDetailType |
string
|
|
CarrierDescription |
string
|
|
Amount |
Single
|
|
Links |
IList<WebApi.Hal.Link>
|
|
|
-
/rels/orders/order
|
|
Sample accept: application/hal+json
{
"faultedOrders": {
"message": "ListException: Faults [{EntryNumber 1, }]",
"faults": [
{
"entryNumber": 1,
"entryInfo": "str"
}
],
"data": {},
"helpLink": "str",
"source": "str",
"hResult": 3
},
"_embedded": {
"http://api.3plCentral.com/rels/orders/orderparcelshippinglabel": [
{
"orderId": 1,
"carrier": "str",
"service": "str",
"serviceCode": "str",
"rate": {
"shipping": 1.1,
"insurance": 2.1,
"confirmation": 3.1,
"other": 4.1,
"total": 5.1
},
"deliveryDate": "2016-12-25T23:00:00",
"packageType": "str",
"carrierAccount": "str",
"nickname": "str",
"provider": "str",
"rateDetails": [
{
"rateDetailType": "str",
"carrierDescription": "str",
"amount": 3.1
}
],
"requestId": "str",
"days": 1,
"splitPackageRates": [
{
"packageId": "str",
"amounts": {
"shipping": 1.1,
"insurance": 2.1,
"confirmation": 3.1,
"other": 4.1,
"total": 5.1
},
"rateDetails": [
{
"rateDetailType": "str",
"carrierDescription": "str",
"amount": 3.1
}
]
}
]
}
]
}
}