MALL Delivery API integration

MALL Delivery (formerly MALL Transport), API

The MALL Delivery service is available not only in the partner portal, but also through the API. If you already have a connection, you can make relatively simple adjustments to call additional functions.

1. Calling order statuses

Orders with active MALL Delivery service can be recognized by the parameter mdp = true.

Make sure that in the new settings ordering process your system will not switch the status of these orders after the status SHIPPED (i.e., for example, the state of DELIVERED or RETURNED), the MALL Partner API will reject such calls.

Compared to the original settings, the system will no longer allow you to switch the order status immediately to the SHIPPED (state skipping SHIPPING). It is always necessary to switch to the state SHIPPINGin which shipments are deposited. The system allows you to switch to the state SHIPPED after your request for a label (see below).

The tracking number and url will be automatically added to your order by our system and you will be able to download it via API only after the status SHIPPED.

If you want to find out data about a specific order, such as the tracking number mentioned above, use the standard order detail call. https://mpapi-docs.mallgroup.com/#/Orders/get_v2_orders__orderId_

Old endpoint for order detail is deprecated. (GET/orders/{orderId}). It won't work with delivery services to pickup points.

2. Shipment loading and label printing

An endpoint for creating the number of packages and printing labels is available. Updates to the number of packages are only allowed in the state SHIPPING. Once you switch the order to the status SHIPPING, you can always call only the last saved version of the labels and you cannot change the number of labels.

Labels can be called in two formats - pdf and zpl. Both formats are automatically available by default.

Calling labels https://mpapi-docs.mallgroup.com/#/Orders/post_orders_labels

Order package numbers https://mpapi-docs.mallgroup.com/#/Orders/get_orders__orderId__consignments

To streamline the call, you can use the bulk label call option, which also allows you to specify the first label position (1st - 4th) in the case of pdf format.

https://mpapi-docs.mallgroup.com/#/Orders/post_orders_labels_bulk

3. Information on unclaimed parcels

Shipments that are not picked up by the customer will be returned to you.

Information about whether the shipment is currently available for pick-up (or that it will be delivered by a delivery service to your warehouse) is available on the order object.

For the determination of such a consignment, the following shall apply

  • parameter mdp = true
  • the order is in SHIPPED status
  • parameter ready_to_return = true

4. Reading changes on orders

For efficient retrieval of information about changes on individual orders, we recommend using webhook in combination with the order detail call.

In case you have any further questions, you can contact us via Help Centre.

How useful was this post?

Click on the star to rate the post!

Average rating: 5 / 5. Number of votes: 1

No one has voted yet. Be the first to rate this post.

en_USEnglish

Discover more from MALL Partner - Nápověda Marketplace

Subscribe now to keep reading and get access to the full archive.

Continue reading