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 |
or
|
Create a consignment with paperwork and allocate it |
POST |
|
Update selected properties of an unallocated consignment |
PATCH |
/ |
Update an unallocated consignment |
PUT |
|
Get a consignment |
GET |
|
Search for consignments associated with a specific order identifier |
GET |
|
Search for consignments associated with a specific consignment tracking identifier assigned by carrier allocation |
GET |
|
Search for consignments associated with a specific parcel tracking identifier |
GET |
|
Search for consignments associated with a specific parcel code |
GET |
|
Get the paperwork for a consignment |
GET |
|
Delete a consignment |
DEL |
|
Add a parcel to a consignment |
POST |
|
Remove a parcel from a consignment |
DEL |
|
Get the paperwork of a parcel |
GET |
|
Add a product to a parcel |
POST |
|
Remove products from a parcel |
DEL |
|
Consolidate a parcel with an outer consignment |
POST |
|
Remove the consolidation of a parcel with an outer consignment |
DEL |
|
Allocate a consignment |
POST |
|
Delete the allocation of a consignment |
DEL |
|
Flag a consignment as manifest ready |
POST |
Depending on the query parameter used:
or
|
Verify whether shipping rules can be applied |
POST |
|
Create a manifest for future despatch |
POST |
|
Get the paperwork of a manifest |
GET |
|
Create a set of shipping rates |
POST |
|
Get your carriers |
GET |
|
Get your carrier services |
GET |
|
Get your warehouses |
GET |
|