REST-SOAP API mappings

If you are already familiar with the Shipping SOAP API, you might be interested in the mappings between the SOAP API and the Shipping REST API.

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

Shipping REST API operation

Shipping REST API endpoint

Equivalent Shipping SOAP API method

Create a consignment and optionally use shipping rules to allocate it

POST /consignments

/createConsignments

or

createAndAllocateConsignments

Update selected properties of an unallocated consignment

PATCH /consignments/{consignmentCode}

/update

Update an unallocated consignment

PUT /consignments/{consignmentCode}

/updateConsignments

Validate a consignment and its shipping rules

POST /consignment-validation

/findDeliveryOptions

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

Allocate an unallocated consignment to a subscribed carrier service

POST /consignments/{consignmentCode}/service

/allocateConsignment

Create a consignment with paperwork and allocate it

POST /consignment-with-paperwork

/despatchConsignment

Indicate the shipping readiness of a consignment

POST /consignments/{consignmentCode}/status

Depending on the query parameter used:

/markConsignmentsAsReadyToManifest

or

markConsignmentsAsPrinted

Delete the allocation of a consignment

DEL /consignments/{consignmentCode}/service

/deallocate

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 for a shipment

POST /rates

/findDeliveryOptions

Get a list of carriers associated with your shipper account

GET /carriers

/findCarriers

Get a list of carrier services associated with your shipper account

GET /carriers/{carrierCode}/services

/findCarrierServices

Get a list of warehouses associated with your shipper account

GET /shippingLocations

/findWarehouses