| Name
|
Data Type | Description |
| pgsiz
|
int |
must be positive; limit 4000, specifying more is an error; default 100;
max records to return per response; use "next" or "prev" link to paginate
|
| pgnum
|
int |
specify 0 to return model with only the TotalResults property populated;
considering pgsiz, returns the pgnum-th page, 1-indexed
|
| rql
|
string |
see RQL documentation
|
| sort
|
string |
see RQL documentation
|
|
Type |
Description |
| ResourceList |
IList<Order.Models.TrackPackageInfo>
|
|
| OrderId |
int
|
|
| CustomerIdentifier |
Generic.Models.CustomerIdentifier
|
|
| ExternalId |
string
|
|
| Name |
string
|
|
| Id |
int
|
|
| FacilityIdentifier |
Generic.Models.FacilityIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| ReferenceNum |
string
|
|
| PoNum |
string
|
|
| PackageId |
int?
|
|
| PackageUri |
string
|
|
| ShipTo |
Generic.Models.ContactInfo
|
in GETs: the contact; in POSTs or PUTs: identifies existing contact or properties of new contact
|
| ContactId |
int?
|
for identifying: if known specify only this; other fields are ignored
|
| CompanyName |
string
|
|
| Name |
string
|
|
| Title |
string
|
|
| Address1 |
string
|
|
| Address2 |
string
|
|
| City |
string
|
|
| State |
string
|
|
| Zip |
string
|
|
| Country |
string
|
|
| PhoneNumber |
string
|
|
| Fax |
string
|
|
| EmailAddress |
string
|
|
| Dept |
string
|
|
| IsAddressResidential |
bool
|
|
| Code |
string
|
for identifying: if known specify only this; if other fields also specified it is not used to identify
|
| AddressStatus |
Common.Enum.AddressStatusType
|
confirmation status
|
|
- 0: Unconfirmed |
|
|
- 1: Confirmed |
|
|
- 2: UserAccepted |
|
| Carrier |
string
|
|
| CarrierService |
string
|
|
| CarrierAccountId |
string
|
|
| CarrierCode |
string
|
|
| TrackingNumber |
string
|
|
| TrackingUrl |
string
|
|
| DeliveryStatus |
string
|
|
| ShipDate |
DateTime?
|
|
| CreationDate |
DateTime?
|
|
| DeliveryDate |
DateTime?
|
|
| DeliveryDateEstimated |
DateTime?
|
|
| TrackingUpdateDate |
DateTime?
|
|
| TrackingCarrierStatusDescription |
string
|
|
| TrackingCarrierStatusCode |
string
|
|
| isImperial |
bool
|
|
| Error |
string
|
|
| TotalResults |
int
|
|
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
next |
|
|
-
prev |
|
Sample accept: application/hal+json
{
"totalResults": 1,
"_embedded": {
"http://api.3plCentral.com/rels/orders/orderparceltrackpackageinfo": [
{
"orderId": 1,
"customerIdentifier": {
"externalId": "str",
"name": "str",
"id": 3
},
"facilityIdentifier": {
"name": "str",
"id": 2
},
"referenceNum": "str",
"poNum": "str",
"packageId": 1,
"packageUri": "str",
"shipTo": {
"contactId": 1,
"companyName": "str",
"name": "str",
"title": "str",
"address1": "str",
"address2": "str",
"city": "str",
"state": "str",
"zip": "str",
"country": "str",
"phoneNumber": "str",
"fax": "str",
"emailAddress": "str",
"dept": "str",
"isAddressResidential": true,
"code": "str",
"addressStatus": 0
},
"carrier": "str",
"carrierService": "str",
"carrierAccountId": "str",
"carrierCode": "str",
"trackingNumber": "str",
"trackingUrl": "str",
"deliveryStatus": "str",
"shipDate": "2016-12-25T23:00:00",
"creationDate": "2016-12-25T23:00:00",
"deliveryDate": "2016-12-25T23:00:00",
"deliveryDateEstimated": "2016-12-25T23:00:00",
"trackingUpdateDate": "2016-12-25T23:00:00",
"trackingCarrierStatusDescription": "str",
"trackingCarrierStatusCode": "str",
"isImperial": true,
"error": "str"
}
]
}
}
REL documentation