SOAP-REST API migration

There is a REST version of the SOAP Shipping API. The REST Shipping API is a REST-based API that enables you to manage all of your shipping needs and it provides a modern developer experience.

REST-SOAP API interoperability

There is interoperability between the SOAP Shipping API and the REST Shipping API, so you can transition gradually from your integration with the SOAP Shipping API.

Requesting a SOAP-REST API migration

If you are currently using the SOAP Shipping API and want to move to the REST Shipping API, contact your Metapack Professional Services implementation consultant.

REST-SOAP API mappings

Each REST Shipping API endpoint has an equivalent SOAP API method.

REST Shipping API operation

REST Shipping API endpoint

Equivalent SOAP Shipping API method

Create a consignment without allocating it

or

Create a consignment and use shipping rules to allocate it

POST /consignments

/createConsignments

or

createAndAllocateConsignments

Create a consignment with paperwork and allocate it

POST /consignment-with-paperwork

/despatchConsignment

Update selected properties of an unallocated consignment

PATCH /consignments/{consignmentCode}

/update

Update an unallocated consignment

PUT/consignments/{consignmentCode}

/updateConsignments

Get a consignment

GET /consignments/{consignmentCode}

/findConsignmentByConsignmentCode

Search for consignments associated with a specific order identifier

GET /consignments?orderReference

/findConsignmentsByOrderReference

Search for consignments associated with a specific consignment tracking identifier assigned by carrier allocation

GET /consignments?consignmentTrackingIdentifier

/findConsignmentsByCarrierConsignmentCode

Search for consignments associated with a specific parcel tracking identifier

GET /consignments?parcelTrackingIdentifier

/findConsignmentsByParcelCode

Search for consignments associated with a specific parcel code

GET /consignments?parcelCode

/findConsignmentsByCartonId

Get the paperwork for a consignment

GET /consignments/{consignmentCode}/paperwork

/createPaperworkForConsignments

Delete a consignment

DEL /consignments/{consignmentCode}

/deleteConsignment

Add a parcel to a consignment

POST/consignments/{consignmentCode}/parcels

/appendParcelsToConsignment

Remove a parcel from a consignment

DEL/consignments/{consignmentCode}/parcels/{parcelCode}

/deleteParcelFromConsignmentWithCartonId

Get the paperwork of a parcel

GET /consignments/{consignmentCode}/ parcels/{parcelCode}/paperwork

/createPaperworkForCarton

Add a product to a parcel

POST/{consignmentCode}/parcels/{parcelCode}/items

/packProductsToParcel

Remove products from a parcel

DEL/consignments/{consignmentCode}/parcels/{parcelCode} /items/{itemRef}

/unpackProductsFromParcel

Consolidate a parcel with an outer consignment

POST/consignments/{consignmentCode}/parcels/{parcelCode} /consolidate

/addInnerToOuter

Remove the consolidation of a parcel with an outer consignment

DEL/consignments/{consignmentCode}/parcels/{parcelCode} /consolidate

/removeInnerFromOuter

Allocate a consignment

POST /consignments/{consignmentCode}/service

/allocateConsignment

Delete the allocation of a consignment

DEL /consignments/{consignmentCode}/service

/deallocate

Flag a consignment as manifest ready

POST/consignments/{consignmentCode}/status

Depending on the query parameter used:

/markConsignmentsAsReadyToManifest

or

markConsignmentsAsPrinted

Verify whether shipping rules can be applied

POST /consignment-validation

/findDeliveryOptions

Create a manifest for future despatch

POST /manifests

/createManifestForFutureDespatch

Get the paperwork of a manifest

GET /manifests/{manifestCode}/paperwork

/createManifestAsPDF

Create a set of shipping rates

POST/rates

/findDeliveryOptions

Get your carriers

GET /carriers

/findCarriers

Get your carrier services

GET /carriers/{carrierCode}/services

/findCarrierServices

Get your warehouses

GET /shippingLocations

/findWarehouses