Shipping API changelog

1.8.0 (2025-04-22)

Features

• Added new additional settings optional parameter to "Create a manifest for future despatch" call to support consolidated clearance process (numberOfContainers, format, resolution) See example
• Extend response body in "Get manifest paperwork" call, added new fields to support consolidated clearance process:
  • consolidatedClearanceLabel
  • commercialInvoice See example

1.7.0 (2025-03-12)

Features

• New API operations to retrieve consolidated clearance masters

See example

1.6.0 (2025-03-12)

Features

• Added new type parameter values to support paperless document printing:
  • paperless
  • label-and-paperless
  • all-and-paperless

  See example

1.5.0 (2025-02-15)

Features

• Introduced Contract Conditions . See the dedicated guide for setup and usage instructions.

1.4.0 (2025-02-10)

Features

• Addition of new addressReference optional parameter under the Address object. Generic field. Used as ClearancePortCode in Port of Entry.
• Addition of new accountNumber optional parameter under the Address object. Account number. In use for Importer of Records and Third Party Billing (Billing Address)

  See example

1.3.0 (2024-11-20)

Features

• Addition of new committedDeliveryWindow optional parameter under the Consignment object. This parameter is required if you want to display the delivery promise reporting in Intelligence.

  See example

1.2.0 (2024-11-07)

Features

• Addition of new isReturn optional parameter under the Consignment object. This parameter is used to indicate if a consignment is marked as a RETURN for reporting purposes.

  See example

1.1.0 (2024-07-17)

Features

• Added new fields to the Consignment object to handle the changes required by the Windsor Framework.
  • movementIndicator
  • windsorNotAtRiskIndicator
  • references/senderUKIMSNumber
  • references/recipientUKIMSNumber

  See example

1.0.0 (2024-04-10)

Features

• Addition of optional field PACKAGINGGROUP Packaging Group under Dangerous Goods in Shipping API

  See example

0.0.9 (2024-01-03)

Features

• Addition of new REST API endpoint to query Shipping Rules
  • Retrieve all shipping rules associated with your Metapack shipper account

  See example

0.0.8 (2023-07-25)

Features

• Addition of Indicate Tax Payment taxesPaid status parameter at Product Level in Shipping API

  See example

0.0.7 (2023-07-11)

Features

• Addition of Importer of Record Changes for Shipping API
  • Expose new fields in recipient/sender address under taxAndDuty section

  See example

0.0.6 (2023-07-05)

Features

• Addition of new tax identifier (TAXIDNumber) under taxAndDuty in recipient/sender address level in Shipping API

  See example

0.0.5 (2023-05-08)

Features

• Addition of new identifier parcel[].carrier.identifer under parcel level in Shipping API
  • Carrier identifer contains the full parcel code as returned on the label barcode

  See example

0.0.4 (2023-04-24)

Features

• Addition of References object under Consignment and Product levels in Shipping API
  • A key-value map containing custom references that some carriers need to use for external platforms

  See example

0.0.3 (2023-04-12)

Features

• Addition of Floor and Building fields to recipient/sender address in Shipping API

  See example

0.0.3 (2022-02-04)

Features

• New API operations that facilitate parent-child tracking (cartonisation):
  • Use Consolidate a parcel with an outer consignment for creating a relationship between two consignments.
  • Use Remove the consolidation of a parcel with an outer consignment for deleting a consolidation of two consignments that are linked.

0.0.2 (2021-10-29)

Features

• New API operations for managing parcel items in a multi-parcel consignment:
  • Use Add a product into a parcel for changing the contents of a parcel.
  • Use Remove products from a parcel for removing one or more products from a parcel.

0.0.1 (2021-08-26)

Features

• Initial API documentation of Metapack Shipping REST API