|
updated the email validation to only allow valid email address characters |
Receiver email address is now optional rather than mandatory |
|
Corrected response Consignment Cancellation typeThe response type was incorrectly defined in the spec and did not match actually what was being returned. The api specification has been updated from application/json to text/plain in the ‘/v1/carriers/{carrierName}/customers/{customerId}/consignments/{consignmentId}/cancellationrequests’ endpoint. NOTE: This update is purely in documentation and there has been no change to the api itself. |
Sender and Receiver Contact Details and Rate CallspickupAddress and deliveryAddress are now mandatory but also removed address portion, just lat\lon are required. Example { "lon": 172.572266, "lat": -43.531668 } Address FormatAdded secondary address line to address object for consignments
Field LengthsLengthened the following fields to 80 characters:
|
Receiver Contact is no Longer MandatoryThe contact field in the consignment is no longer mandatory eventType Values are ConsistentThe TrackingEvent eventTypes were inconsistent in some had values and others had codes, the values are as follows
These values only apply to the TrackingEvents, the notification eventType are different. These values only apply to the TrackingEvents, the notification eventType are different. No Split DeliveryNo split delivery can be requested when creating a consignment, a new property noSplitDelivery has been added. This defaults to false. |
Phone NumbersPhone number validation regex patterns are now consistent and have a minimum and maximum length. ConsignmentItem itemReferenceWas previously used to specify both the itemReference and the part number, now the part number is automatically assigned so it now performs a single role as such:
|
Tracking Events for ConsignmentThe tracking events can now be queried for a consignment, two endpoints are available, the tracking-events endpoint will return all the events for a consignment item between two optional dates. The attachments endpoint will return an image for a tracking event.
|
PaginationThe pagination details returned as part of a collection have been changed from Old
New
Consignments
Rates
AddressRight
The 3 different search methods are supported, each returns a collection of addresses strings and an AddressRight Id. The /v1/addresses/{addressId} can be used to exchange the Id for an address object which can be used in rating and consignments. Pickup Requests
|