omnicado-mall-proxy

Newly created orders have status set to blocked.

After MALL processes the order (validations passed and payment was successful), it's status will be set to open and confirmed to false (partner can list these orders using /orders/unconfirmed endpoint).

This is the moment where partner should start with expedition process, and it is necessary to confirm these orders by setting confirmed to true and start updating order status. More information about order statuses here.

⚠ ATTENTION

Exceptions to order statuses applies in case you are using MALL Delivery service. Please check the information here.

Our system also provides webhook feature so you can easily track order updates from MALL. Please check more information here.

When using MALL Delivery you can get parcel labels using /orders/labels endpoint bellow.

ℹ NOTE

To display test orders in list endpoints, use query param test=1.

Description of statuses

  • blocked - order is blocked and cannot be processed by partner
  • open - order is open and ready for shipment by partner
  • shipping - order is in shipment process and cannot be cancelled
  • shipped - order is shipped to the customer
  • delivered - order is delivered to the customer
  • returned - final status, order is returned as undelivered and is not invoiced
  • cancelled - final status, order is cancelled and is not invoiced
  • lost - final status, order consignment was lost during delivery ( only for orders shipped with MDP, status is managed by mall )

Statuses managed by partner

  • from open to cancelled, shipping or shipped
  • from shipping to cancelled or shipped
  • from shipped to delivered or returned

Order's labels and consignments

  • You can create order labels needed for order delivery by MALL transports. Number of parcel count is required for label creation. It returns base64 representation of PDF labels.
  • Returns consignments data if order labels were created.