Change log for MetaPack Manager REST API

New version: 0.14.2

Fixed validation for the Dimension attributes.

New version: 0.14.0

Added support for consignments status update

Reduced timeouts and updated documentation

Remove the manifest-requests endpoint from the API. Manifesting will be done using the /consignment-lists endpoint.

Deprecated endpoint /manifest-requests.

Included error code O-COL-6001 in API Error Codes appendix.

Added constraint violation code for invalid consignment URI.

New version: 0.13.0

Added documentation for the new endpoint /consignment-lists. The endpoint is not accessible yet.

New version: 0.12.0

Removed support for deprecated version 0.6

Removed support for create shipment from the API and removed references to create shipment from the docs.

Removed postcode validation of addresses in the Republic Of Ireland.

Updated South Korea postcode validation, in line with the new 5-digit format introduced in August 2015.

Changed the constraint on the maximum number of Trade Items per Logistics Unit from 10 to 20.

Removed error code O-NFO-3005 from API Error Code table. Api was updated so that, when a non-existing logistics service is specified, an Allocation error is returned instead.

Added "DeliveryWindow" error code to allocation error code table for backwards compatibility

New document interface

Added DeliveryWindowRejectedForCutOff, "DeliveryWindowRejectedForTransitTimes" and "DeliveryWindowRejectedForWorkingDays" error codes to allocation error code table

Deleted "DeliveryWindow" error codes from allocation error code table

Added "TooLow", "TooHigh" and "NoLogisticsServiceAvailable" error codes to allocation error code table

Added "object" and "field" to allocation error table

Updated error response body structure to include allocationErrors.

Added allocation error response example.

Added allocation error table

Added allocation error code table

Fixed introductory text in the Required Address Fields section.

Updated the documentation for Deallocating a consignment and Consignments to reflect that this feature is available from version 0.9.0

Included error code O-ALE-4002 in API Error Codes appendix.

Included error codes O-ALE-4000 and O-ALE-4001 in API Error Codes appendix.

New version: 0.9.0

Deallocating a consignment is supported in this version.

New endpoint /manifest-requests

Added constraint definition: CompatibleType.

Added constraint definition: UnsupportedType.

Updated the samples for create consignment to use the version 0.

Minor Required Address Fields updates.

Enhanced Required Address Fields documentation section.

Added and/or documented constraints on several object data elements.

Switched samples to use https:// rather than http://

Fixed type description of shipment orders to reflect that it is a collection.

Fixed logisticsService URI in consignment samples.

Removed uri, collectionPointProviderID and collectionPointID for a shipment and consignment delivery under the destination agent.

Removed uri for a delivery shipment and consignment under the receiver agent.

Added definition of URI to glossary and attached hyperlinks to all occurrences of URI.

Fixed samples to use supported measurement unit.

Street validation no-longer includes the inclusion of the values from the following properties: floor, houseNo, houseExt, block, building

Fixed date on last changelog entry

Updated version header example to use the preferred version 0 header

A HTTP 503 (Service Unavailable) will be returned if there is an internal error on the platform, see Error Statuses and Codes.

0.8.0 release

Added version header 0: "application/vnd.metapack.mm.v0+json"

Included error code O-ALE-4000 in Table 3 of Error Statuses and Codes.

Added constraint definition: ValidDestinationURI.

Updated ValidURI description to be more specific.

Added CollectionPointID and CollectionPointProviderID fields into Destination (Collection).

Fixed a version error for the URI field of Receiver.

Refactored the Shipment, Destination and Receiver Appendices to clarify the differences between Collection and Delivery shipment types.

Reordered the entries in Appendix A so that the Object Data Elements are in alphabetic order.

Updated the constraint on Destination for Collection Shipments. A Destination must now have either: 1) a valid URI or 2) a collectionPointID, a collectionPointProviderID, a valid address and, optionally, a valid contact.

0.7.5 release

Updated the API Security section with examples on how to use the bearer token. Changed example host name in our examples to be our https://security.uat.metapack.net/ endpoint.

Fixed the documentation to highlight that the DPI parameter is mandatory for PNG format. See Retrieve documentation.

0.7.2 release

A new agent type Destination has been added.

A new constraint ValidTypeAndDestinationCombination has been added. Specifies that if a Shipment is of type COLLECTION, the destination must have a valid URI.

Add PNG on the list of label formats supported.

0.7.1 release

Renamed query parameter logisticsServiceCode to logisticsServiceURI

Updated Dates and times section to mandate use of UTC.

Added new code ISODateTimeFormat to Constraint violations.

A new agent type has been added: Receiver

A new constraint has been added: ValidTypeAndReceiverCombination. Specifies that if a Shipment is of type COLLECTION, the receiver must have either a valid URI or valid Address and Agent.

Removed agent type Destination.

Removed constraint ValidTypeAndDestinationCombination

COLLECTION shipment type has been added.

A new agent type Destination has been added.

A new constraint ValidTypeAndDestinationCombination has been added. Specifies that if a Shipment is of type COLLECTION, the destination must have either a valid URI or valid Address and Agent.

The sender field of the Shipment has been updated from an Agent to an Agent URI

The Origin object become Agent URI

Added orderProperties field in Order

Updated Logistics Service documentation to reflect endpoint-changes.

Added Complimentary Services info.

Added appendix Required Address Fields

Updated Origin so it just consists of a url (where the contact and address details can be retrieved from).

Added field constraint-details to various items in Appendix A.

Added new codes to Constraint violations.

Added optional attribute twoMan for ShipmentAttributes

Removed latestDespatchDate from Consignment

Removed miscellaneousInfo property from TradeItem

0.7.0 release

Refer to Versions section for details.

Added validation to firstname & lastname of Contact

Removed the mandatory constraint on undeliverable address in Shipment

Added shipmentRef to Shipments

Deprecated existing /documents endpoints to be replaced by Retrieve documentation

Fixed typeOfDocument property on Identity

Enabled nested validation of Shipments

Updated /consignments to accept optional parameters; logisticsServiceGroup, latestDeliveryDate

Display Logistics Unit constraints in the docs

Renamed lg to limitedQuantity in ShipmentAttributes

0.6.0 release

Renamed agentRef to ref in Agent

Removed manifestGroupCode from Shipment

Removed SAFEPLACE in ProofOfDeliveryType for ShipmentAttributes

Changed order to a collection of orders in Shipment

Removed cashOnDelivery from Logistics Unit

Removed insuranceValue from Logistics Unit

Removed @context from all examples

Reduced document types to just label & paperwork

Updated TradeItems to include HazardousTradeItems on the Logistics Unit

Removed hazardousGoodsCodes element from LogisticsUnit

Changed /documentation resource to /documents

Changed the documentation resource to only support a specific set of Acceptable DPI values.

Rename the type Logistics Unit Documentation to Logistics Unit Document

Remove labelUrl, customsDocumentationUrl and commercialInvoiceUrl fields from Logistics Unit Document

Rename the field logisticsUnitIdentifier to shipperRef into the types Logistics Unit and Logistics Unit Document

Reverted to single Shipment

Added origin, destination, sender and receiver to Shipment

Removed seller, shipper, recipient and billing from Shipment

Removed Shipper and Seller entities

Added "agentRef" to Agent

Renamed RetailerProperties to ShipmentProperties in Shipment

Renamed returns address to undeliverable address in Shipment

Created a new entity called ShipmentAttributes

Renamed ShipmentFlags to ShipmentAttributes in Shipment

Renamed termsOfTrade to incoterms in Shipment

Added PHONE to notificationType (see Notification)

Modified the error response body structure

Renamed Validation Error to Constraint violation

Added the Constraint violation code section

Updated the authorisation to include more granular permissions. See API Security for details.

Added new entity DeliveryPromise to Consignment

Renamed despatchDate to latestDespatchDate in Consignment

Removed line1, line2, line3 and line4 from Address

Renamed harmonisedProductCode to resources-trade-item on Trade Item

Added notificationTypes to Contact

New endpoint /sellers

New endpoint /shippers

New endpoint /logistics-services

0.5.0 release

New endpoint /shipments

New endpoint /consignments

New endpoint /documentation