Masterarbeit

Search

SearchSearch

Metapack Shipping REST API Postman Collection

Jun 20, 20249 min read

Search Link: https://www.google.com/search?channel=fs&client=ubuntu-sn&q=postman+collection+16359308-fe8fef63-1a22-4b61-876c-3e751f06c63b

Overview

GET /shipping/v1/consignments

Summary: Search for consignments by order reference

Return all consignments associated with a specific order identifier.

If any consignments have been allocated, the associated carrier and carrier service information is also returned. You can use this information to plan your deliveries and keep your customers updated.

POST /shipping/v1/consignments

Summary: Create a consignment

Create a consignment without allocating it.

Prerequisites: The sender of a consignment is a warehouse (shipping location), so warehouses must be configured for your Metapack shipper account. If you want to use shipping rules for allocation, carriers and carrier services must be configured for your account.

POST /shipping/v1/consignment-with-paperwork

Summary: Create a consignment with paperwork and allocate it

Create a consignment, use shipping rules to allocate it, and generate Base64-encoded labels and customs documents for it.

Shipping rules enable you to search for an optimal subscribed carrier service by using acceptable and unacceptable collection and delivery days and date and time slots, carrier services, carrier service groups, delivery location, and other filtering options.

Prerequisites: Warehouses, carriers, and carrier services must be configured for your Metapack shipper account.

Note: If a suitable subscribed carrier service is not found for the consignment, it will still be created but will remain Unallocated.

Tip: To generate the labels or documents from the strings included in a successful response, you must first decode the strings by using a Base64 encoder/decoder and then send them to a network printer.

GET /shipping/v1/consignments/{consignmentCode}

Summary: Get a consignment

Retrieve a consignment with a specific consignment code.

If the consignment has been allocated, the associated carrier and carrier service information is also returned. You can use this information to plan your deliveries and keep your customers updated.

PUT /shipping/v1/consignments/{consignmentCode}

Summary: Update an unallocated consignment

Update an Unallocated consignment.

Prerequisite: If a consignment is Allocated, use Delete consignment allocation before using this operation.

Note: You must resubmit the mandatory information of the consignment in addition to any other consignment data that you have added or modified.

PATCH /shipping/v1/consignments/{consignmentCode}

Summary: Update the manifest group code of an unallocated consignment

Update specific numeric and text properties of an Unallocated consignment.

Prerequisite: If a consignment is Allocated, use Delete consignment allocation before using this operation.

Note: Currently, manifestGroupCode is the only property of a consignment that can be modified by this operation.

PARAMETERS /shipping/v1/consignments/{consignmentCode}

GET /shipping/v1/consignments/{consignmentCode}/paperwork

Summary: Get consignment paperwork in PDF format

Retrieve the customs documents of an Allocated consignment.

Note: You can also use this operation if the consignment lifecycle status is Printed or Ready to manifest.

Tip: To generate documents from the strings included in a successful response, you must first decode the strings by using a Base64 encoder/decoder and then send them to a network printer.

PARAMETERS /shipping/v1/consignments/{consignmentCode}/paperwork

DELETE /shipping/v1/consignments/{consignment code}

Summary: Delete a consignment

If the consignment is unallocated, using this operation deletes it.

However, if the consignment is allocated, using this operation first deallocates it and then deletes it.

Note: You cannot delete a consignment if its lifecycle status is “manifested” or a later status.

PARAMETERS /shipping/v1/consignments/{consignment code}

POST /shipping/v1/consignments/{consignmentCode}/parcels

Summary: Add a parcel to a consignment

Add a parcel to an existing consignment.

If the consignment has already been Allocated, the tracking code for the new parcel is generated automatically and returned in the response.

In addition, the weight and value of the new parcel are added to the weight and value of the consignment.

Note: You can also use this operation if the consignment lifecycle status is Unallocated, Printed, or Ready to manifest. Using this operation resets the status of a modified consignment from Printed or Ready to manifest back to Allocated until all labels are generated.

PARAMETERS /shipping/v1/consignments/{consignmentCode}/parcels

DELETE /consignments/{consignmentCode}/parcels/{parcelCode}

Summary: Remove a parcel from a consignment

Remove a parcel from a multi-parcel consignment.

The weight of the removed parcel is subtracted automatically from the weight of the consignment.

If the consignment has already been Allocated, the charges are recalculated.

Note: You can also use this operation if the consignment lifecycle status is Unallocated, Printed, or Ready to manifest. Using the operation does not change the status of a modified consignment.

PARAMETERS /consignments/{consignmentCode}/parcels/{parcelCode}

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

Summary: Consolidate a parcel with an outer consignment

Create a relationship between two consignments by associating a parcel in an “inner” (child) consignment with a parcel in an “outer” (parent) consignment, which facilitates parent-child tracking.

Note: You can use this operation if the consignment lifecycle status of each consignment is Unallocated, Allocated, Printed, or Ready to manifest. Using the operation does not change the status of a modified consignment.

DELETE /shipping/v1/consignments/{consignmentCode}/parcels/{parcelCode}/consolidate

Summary: Remove the consolidation of a parcel with an outer consignment

Delete a consolidation of two consignments that are linked as “inner” (child) and “outer” (parent) consignments.

Note: You can use this operation if the consignment lifecycle status of each consignment is Unallocated, Allocated, Printed, or Ready to manifest. Using the operation does not change the status of a modified consignment.

PARAMETERS /shipping/v1/consignments/{consignmentCode}/parcels/{parcelCode}/consolidate

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

Summary: Get parcel paperwork

Retrieve the labels and customs documents of a specific parcel in an Allocated consignment.

Note: You can also use this operation if the consignment lifecycle status is Printed or Ready to manifest.

Tip: To generate labels or documents from the strings included in a successful response, you must first decode the strings by using a Base64 encoder/decoder and then send them to a network printer.

PARAMETERS /shipping/v1/consignments/{consignmentCode}/parcels/{parcelCode}/paperwork

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

Summary: Add a product to a parcel

Add a product to a parcel of an existing consignment.

Note:  You can use this operation if the consignment lifecycle status is Unallocated, Allocated, Printed, or Ready to manifest. Using the operation does not change the status of a modified consignment.

PARAMETERS /consignments/{consignmentCode}/parcels/{parcelCode}/items

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

Summary: Remove products from a parcel

Remove the products / items from the parcel.

Note: You can use this operation if the consignment lifecycle status is Unallocated, Allocated, Printed, or Ready to manifest. Using the operation does not change the status of a modified consignment.

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

POST /shipping/v1/consignments/{consignmentCode}/service

Summary: Allocate a consignment

Use shipping rules to allocate an Unallocated consignment to the optimal carrier service associated with your Metapack shipper account.

Shipping rules enable you to search for an optimal subscribed carrier service by using acceptable and unacceptable collection and delivery days and date and time slots, carrier services, delivery location, and other filtering options.

Note: If a suitable subscribed carrier service is not found for the consignment, it will remain Unallocated.

DELETE /shipping/v1/consignments/{consignmentCode}/service

Summary: Delete consignment allocation

Delete the allocation of a consignment to a subscribed carrier service and leave it Unallocated.

Note: You can use this operation if the consignment lifecycle status is Allocated, Printed, or Ready to manifest.

To verify that the consignment is Unallocated, use the Get a consignment operation.

To reallocate the consignment, use the Allocate a consignment operation.

PARAMETERS /shipping/v1/consignments/{consignmentCode}/service

POST /shipping/v1/consignments/{consignmentCode}/status

Summary: Flag consignment manifest readiness

Flag a Printed consignment as Ready to manifest.

You can then use the Create a manifest for future despatch operation to add the consignment to a post-dated manifest, which will change the status to Manifested.

You can also reallocate or delete the consignment, or add parcels to it. Adding a parcel will change the status to Allocated. Modifying the consignment will require deleting its allocation, which will change the  status to Unallocated.

Alternatively, flag a Ready to manifest consignment as not manifest-ready, which changes the status back to Printed.

You can then reallocate or delete the consignment, or add parcels to it. Adding a parcel will change the status to Allocated. Modifying the consignment will require deleting its allocation, which will change the status to Unallocated.

PARAMETERS /shipping/v1/consignments/{consignmentCode}/status

POST /shipping/v1/consignments-validation

Summary: Verify whether shipping rules can be applied

Verify whether an Unallocated consignment can be allocated using the specified shipping rules.

POST /shipping/v1/manifests

Summary: Create a manifest for future despatch

Add Ready to manifest consignments to a post-dated manifest and clear the consignments from your current transactional flow.

You might want to do this because you expect a large number of orders to go out on a particular day in the future, but you want to leave sufficient time to pack and process them beforehand.

GET /shipping/v1/manifests/{manifestCode}/paperwork

Summary: Get manifest paperwork

Generate a manifest in Base64-encoded format.

Note: You can use this operation only if the consignment lifecycle status is Manifested.

Tip: To generate the manifest as a PDF file, you must first decode the string included in a successful response by using a Base64 encoder/decoder and then send it to a network printer.

PARAMETERS /shipping/v1/manifests/{manifestCode}/paperwork

POST /shipping/v1/rates

Summary: Create shipping rates

Verify which carrier services associated with your Metapack shipper account can offer the best rates for delivering a consignment.

You also have the option to specify shipping rules, which enable you to search for an optimal subscribed carrier service by using acceptable and unacceptable collection and delivery days and date and time slots, carrier services, delivery location, and other filtering options.

A successful response returns all carrier services that can deliver the consignment in order of shipping cost, with the cheapest first.

Prerequisites: Warehouses, carriers, carrier services, and carrier costs must be configured for your Metapack shipper account. Refer to API setup data.

Tip: You can reuse the request body for this operation to create a consignment.

GET /shipping/v1/carriers

Summary: Get your carriers

Retrieve all carriers associated with your Metapack shipper account.

Prerequisite: Carriers must be configured for your Metapack shipper account.

GET /shipping/v1/carriers/{carrierCode}/services

Summary: Get your carrier services

Retrieve all carrier services associated with your Metapack shipper account.

Prerequisite: Carrier services must be configured for your Metapack shipper account.

PARAMETERS /shipping/v1/carriers/{carrierCode}/services

GET /shipping/v1/shippinglocations

Summary: Get your warehouses

Retrieve all warehouses associated with your Metapack shipper account.

A warehouse is any location used for shipping orders. Example locations include stores, distribution centres, and logistics channels.

Prerequisite: Warehouses must be configured for your Metapack shipper account.

Graph View

Backlinks

  • No backlinks found