API

Qapla’ API Guide

The APIs provide the ability to integrate Qapla’ both for reading and writing with your proprietary ecommerce system or one for which a plugin or connector has not yet been implemented.
The integration allows both reading and writing operations, enabling complete management of:

• Orders
• Shipments
• Tracking
• Labels
• Couriers
• Channels and Statuses

To use the APIs, it is necessary to know the Private API Keys assigned to your channel(s), which can be found in the Control Panel under:
Settings > Channels [Channel Name] > Configure > Channel > Private API Key
Important: the Private API Key must be protected and kept secret.

 

Orders

The following APIs allow you to manage your orders:

• pushOrder to upload one or more orders.
• getOrder to retrieve order information.
• getOrders to get the list of imported orders.
• updateOrder to update an order.
• deleteOrder to delete an order.
• undeleteOrder to restore a deleted order.

• detectOrderCourier allows you to assign a courier to an order based on predefined rules (settings that need to be configured in the Control Panel).

Shipments

The following APIs allow you to manage your shipments:

• pushShipment to upload one or more shipments.
• getShipment to retrieve information and read the status of a shipment.
• getShipments to receive the list of imported shipments.
• updateShipment to update a shipment.
• deleteShipment to delete a shipment.
• undeleteShipment to restore a deleted shipment.

Tracking

The following APIs allow you to retrieve information and monitor the status of shipments:

• getShipment to retrieve information and read the status of a shipment.
• trackingByTimeFrame allows you to get the list of shipments that have had a tracking status update within the requested range.
• Tracking Script by configuring and embedding Qapla’s Tracking Script on your website, you can view the tracking history of a shipment in HTML format directly on your platform.
  For a complete and synchronized management of shipment progress status, it is recommended to also consider the use of the Webhook, specifically the Shipments webhook.

Platforms

• fetchPlatformOrders allows you to receive the list of orders on a platform (CMS/Marketplace). For the use of this API, the CMS and/or Marketplace must be configured.
• updatePlatformOrder allows you to update orders on a platform. For the use of this API, the CMS and/or Marketplace must be configured.

Labels

• createLabel allows you to create a shipment and obtain the label, equivalent to generation via the control panel “Create” and “Print”.
• confirmLabel allows you to transmit created shipments to the courier to complete the shipment generation. The response returns the loading list (borderò/manifest) in PDF format.

createLabel and confirmLabel entail a cost and require activation. If you have already bought the product, please request activation by writing to success@qapla.it.

• getLabel to obtain a label previously created on Qapla’ in the original courier label format (PDF, JPG, or ZPL).
• checkLabel to check the status of a previously created label on Qapla’.
• deleteLabel to delete a label created with createLabel.

Couriers

• getCouriers allows you to request the list of couriers either complete or by country/reason.
• detectCourier tries to determine the courier from the provided tracking number, responding with a list of couriers.
• getPudos allows you to request the list of PUDO (Pick Up Drop Off points, OOH) for multiple couriers simultaneously. This API entails a cost and requires activation. If you have already bought the product, please contact our Customer Care at support@qapla.it to request activation.
• getQuotes allows you to request shipping quotes from multiple couriers for multiple services simultaneously. This API entails a cost and requires activation. If you have already bought the product, please contact our Customer Care at support@qapla.it to request activation.

Virtual Courier

• apiVirtual allows updating the status of a virtual courier shipment.

Channels

• getChannel allows you to obtain information about the channel linked to the API Key and the company that created it.
• checkChannel allows you to verify the connections with the platform and the marketplaces configured on the channel.
• createChannel allows you to create a new channel.
• updateChannel allows you to modify some channel settings.
• deleteChannel allows you to delete a specific channel.

Qapla’ Status

• getQaplaStatus allows you to get the detailed list of Qapla’ shipment statuses.

Help

• Qapla’ Status is the interpretation of the shipment status with values assigned by Qapla’ to each possible courier status.
• Courier’s codes is the list of Qapla’ courier codes in alphabetical order.

 

Need help?
If you need assistance, contact Qapla’s Customer Care at support@qapla.it