\nThe integration allows both reading and writing<\/strong> operations, enabling complete management of:<\/p>\n
- \n
- Orders<\/strong><\/li>\n
- Shipments<\/strong><\/li>\n
- Tracking<\/strong><\/li>\n
- Labels<\/strong><\/li>\n
- Couriers<\/strong><\/li>\n
- Channels and Statuses<\/strong><\/li>\n<\/ul>\n
To use the APIs, it is necessary to know the Private API Keys<\/strong> assigned to your channel(s), which can be found in the\u00a0Control Panel<\/a>\u00a0under:
\nSettings > Channels [Channel Name] > Configure > Channel > Private API Key
\nImportant<\/strong>: the Private API Key must be protected and kept secret.<\/p>\n![\"\"](\"http:\/\/help.qapla.it\/wp-content\/uploads\/2025\/09\/EN-API-KEY-1024x194.png\")
<\/a><\/p>\nOrders<\/h3>\n
The following APIs allow you to manage your orders:<\/p>\n
- \n
- pushOrder<\/a><\/strong> to upload one or more orders.<\/li>\n
- getOrder<\/a>\u00a0<\/strong>to retrieve order information.<\/li>\n
- getOrders<\/a>\u00a0<\/strong>to get the list of imported orders.<\/li>\n
- updateOrder<\/a><\/strong> to update an order.<\/li>\n
- deleteOrder<\/a><\/strong> to delete an order.<\/li>\n
- undeleteOrder<\/a><\/strong> to restore a deleted order.<\/li>\n<\/ul>\n
- \n
- detectOrderCourier<\/strong><\/a> allows you to assign a courier to an order based on predefined rules (settings that need to be configured in the Control Panel).<\/li>\n<\/ul>\n
Shipments<\/h3>\n
The following APIs allow you to manage your shipments:<\/p>\n
- \n
- pushShipment<\/a>\u00a0<\/strong>to upload one or more shipments.<\/li>\n
- getShipment<\/a><\/strong> to retrieve information and read the status of a shipment.<\/li>\n
- getShipments<\/strong><\/a> to receive the list of imported shipments.<\/li>\n
- updateShipment<\/a><\/strong> to update a shipment.<\/li>\n
- deleteShipment<\/a><\/strong> to delete a shipment.<\/li>\n
- undeleteShipment<\/a>\u00a0<\/strong>to restore a deleted shipment.<\/li>\n<\/ul>\n
Tracking<\/h3>\n
The following APIs allow you to retrieve information and monitor the status of shipments:<\/p>\n
- \n
- getShipment<\/a><\/strong> to retrieve information and read the status of a shipment.<\/li>\n
- trackingByTimeFrame<\/a>\u00a0<\/strong>allows you to get the list of shipments that have had a tracking status update within the requested range.<\/li>\n
- Tracking Script<\/strong><\/a>\u00a0by configuring and embedding Qapla\u2019s Tracking Script on your website, you can view the tracking history of a shipment in HTML format directly on your platform.
\nFor a complete and synchronized management of shipment progress status, it is recommended to also consider the use of the Webhook, specifically the\u00a0Shipments webhook<\/a>.<\/li>\n<\/ul>\nPlatforms<\/h3>\n
- \n
- fetchPlatformOrders<\/a><\/strong>\u00a0allows 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.<\/li>\n
- updatePlatformOrder<\/a>\u00a0<\/strong>allows you to update orders on a platform. For the use of this API, the CMS and\/or Marketplace must be configured.<\/li>\n<\/ul>\n
Labels<\/h3>\n
- \n
- createLabel<\/strong><\/a>\u00a0allows you to create a shipment and obtain the label, equivalent to generation via the control panel “Create” and “Print”.<\/li>\n
- confirmLabel<\/a>\u00a0<\/strong>allows you to transmit created shipments to the courier to complete the shipment generation. The response returns the loading list (border\u00f2\/manifest) in PDF format.<\/li>\n<\/ul>\n
createLabel<\/strong> and confirmLabel<\/strong> entail a cost and require activation. If you have already bought the product, please request activation by writing to success@qapla.it<\/a>.<\/p>\n
- \n
- getLabel<\/a>\u00a0<\/strong>to obtain a label previously created on Qapla\u2019 in the original courier label format (PDF, JPG, or ZPL).<\/li>\n
- checkLabel<\/a>\u00a0<\/strong>to check the status of a previously created label on Qapla\u2019.<\/li>\n
- deleteLabel<\/a>\u00a0<\/strong>to delete a label created with createLabel.<\/li>\n<\/ul>\n
Couriers<\/h3>\n
- \n
- getCouriers<\/strong><\/a>\u00a0allows you to request the list of couriers either complete or by country\/reason.<\/li>\n
- detectCourier<\/a><\/strong>\u00a0tries to determine the courier from the provided tracking number, responding with a list of couriers.<\/li>\n
- getPudos<\/strong><\/a> 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<\/a> to request activation.<\/li>\n
- getQuotes<\/a><\/strong> 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<\/a> to request activation.<\/li>\n<\/ul>\n
Virtual Courier<\/h3>\n
- \n
- \n
apiVirtual<\/strong><\/a>\u00a0<\/strong>allows updating the status of a virtual courier shipment.<\/p>\n<\/li>\n<\/ul>\n
Channels<\/h3>\n
- \n
- getChannel<\/a><\/strong> allows you to obtain information about the channel linked to the API Key and the company that created it.<\/li>\n
- checkChannel<\/strong><\/a> allows you to verify the connections with the platform and the marketplaces configured on the channel.<\/li>\n
- createChannel<\/a><\/strong> allows you to create a new channel.<\/li>\n
- updateChannel<\/a><\/strong> allows you to modify some channel settings.<\/li>\n
- deleteChannel<\/a><\/strong> allows you to delete a specific channel.<\/li>\n<\/ul>\n
Qapla\u2019 Status<\/h3>\n
- \n
- \n
getQaplaStatus<\/a><\/strong>\u00a0allows you to get the detailed list of Qapla\u2019 shipment statuses.<\/p>\n<\/li>\n<\/ul>\n
Help<\/h3>\n
- \n
- Qapla\u2019 Status<\/a><\/strong>\u00a0is the interpretation of the shipment status with values assigned by Qapla\u2019 to each possible courier status.<\/li>\n
- Courier\u2019s codes<\/strong><\/a>\u00a0is the list of Qapla\u2019 courier codes in alphabetical order.<\/li>\n<\/ul>\n
<\/p>\n
Need help?<\/strong>
\nIf you need assistance, contact\u00a0Qapla\u2019s Customer Care<\/strong>\u00a0at\u00a0support@qapla.it<\/strong><\/p>\n<\/p>\n","protected":false},"excerpt":{"rendered":"
Qapla\u2019 API Guide The\u00a0APIs\u00a0provide the ability to integrate Qapla\u2019 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 […]<\/p>\n","protected":false},"author":6,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"inline_featured_image":false,"footnotes":""},"categories":[68],"tags":[],"class_list":["post-7979","post","type-post","status-publish","format-standard","hentry","category-information-developer"],"yoast_head":"\n
API - Qapla' Help<\/title>\n<meta name=\"description\" content=\"Qapla\u2019 API Guide The\u00a0APIs\u00a0provide the ability to integrate Qapla\u2019 both for reading and writing with your proprietary ecommerce system or one for which a\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/help.qapla.it\/en\/api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"API - Qapla' Help\" \/>\n<meta property=\"og:description\" content=\"Qapla\u2019 API Guide The\u00a0APIs\u00a0provide the ability to integrate Qapla\u2019 both for reading and writing with your proprietary ecommerce system or one for which a\" \/>\n<meta property=\"og:url\" content=\"https:\/\/help.qapla.it\/en\/api\/\" \/>\n<meta property=\"og:site_name\" content=\"Qapla' Help\" \/>\n<meta property=\"article:published_time\" content=\"2025-09-03T10:29:04+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-09-15T09:42:08+00:00\" \/>\n<meta property=\"og:image\" content=\"http:\/\/help.qapla.it\/wp-content\/uploads\/2025\/09\/EN-API-KEY-1024x194.png\" \/>\n<meta name=\"author\" content=\"Gabriela Sifuentes\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Gabriela Sifuentes\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"5 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/api\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/api\\\/\"},\"author\":{\"name\":\"Gabriela Sifuentes\",\"@id\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/#\\\/schema\\\/person\\\/878122abbf5f8a5a392941fdf4f498aa\"},\"headline\":\"API\",\"datePublished\":\"2025-09-03T10:29:04+00:00\",\"dateModified\":\"2025-09-15T09:42:08+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/api\\\/\"},\"wordCount\":750,\"image\":{\"@id\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/api\\\/#primaryimage\"},\"thumbnailUrl\":\"http:\\\/\\\/help.qapla.it\\\/wp-content\\\/uploads\\\/2025\\\/09\\\/EN-API-KEY-1024x194.png\",\"articleSection\":[\"Information For Developers\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/api\\\/\",\"url\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/api\\\/\",\"name\":\"API - Qapla' Help\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/api\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/api\\\/#primaryimage\"},\"thumbnailUrl\":\"http:\\\/\\\/help.qapla.it\\\/wp-content\\\/uploads\\\/2025\\\/09\\\/EN-API-KEY-1024x194.png\",\"datePublished\":\"2025-09-03T10:29:04+00:00\",\"dateModified\":\"2025-09-15T09:42:08+00:00\",\"author\":{\"@id\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/#\\\/schema\\\/person\\\/878122abbf5f8a5a392941fdf4f498aa\"},\"description\":\"Qapla\u2019 API Guide The\u00a0APIs\u00a0provide the ability to integrate Qapla\u2019 both for reading and writing with your proprietary ecommerce system or one for which a\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/api\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/help.qapla.it\\\/en\\\/api\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/api\\\/#primaryimage\",\"url\":\"http:\\\/\\\/help.qapla.it\\\/wp-content\\\/uploads\\\/2025\\\/09\\\/EN-API-KEY-1024x194.png\",\"contentUrl\":\"http:\\\/\\\/help.qapla.it\\\/wp-content\\\/uploads\\\/2025\\\/09\\\/EN-API-KEY-1024x194.png\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/api\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/#website\",\"url\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/\",\"name\":\"Qapla' Help\",\"description\":\"Knowledge base\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/#\\\/schema\\\/person\\\/878122abbf5f8a5a392941fdf4f498aa\",\"name\":\"Gabriela Sifuentes\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/834f61704200af858f1e448327e4ecad263c7c4d0a2e481df25014002526e276?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/834f61704200af858f1e448327e4ecad263c7c4d0a2e481df25014002526e276?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/834f61704200af858f1e448327e4ecad263c7c4d0a2e481df25014002526e276?s=96&d=mm&r=g\",\"caption\":\"Gabriela Sifuentes\"},\"url\":\"https:\\\/\\\/help.qapla.it\\\/en\\\/author\\\/gabriela\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"API - Qapla' Help","description":"Qapla\u2019 API Guide The\u00a0APIs\u00a0provide the ability to integrate Qapla\u2019 both for reading and writing with your proprietary ecommerce system or one for which a","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/help.qapla.it\/en\/api\/","og_locale":"en_US","og_type":"article","og_title":"API - Qapla' Help","og_description":"Qapla\u2019 API Guide The\u00a0APIs\u00a0provide the ability to integrate Qapla\u2019 both for reading and writing with your proprietary ecommerce system or one for which a","og_url":"https:\/\/help.qapla.it\/en\/api\/","og_site_name":"Qapla' Help","article_published_time":"2025-09-03T10:29:04+00:00","article_modified_time":"2025-09-15T09:42:08+00:00","og_image":[{"url":"http:\/\/help.qapla.it\/wp-content\/uploads\/2025\/09\/EN-API-KEY-1024x194.png","type":"","width":"","height":""}],"author":"Gabriela Sifuentes","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Gabriela Sifuentes","Est. reading time":"5 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/help.qapla.it\/en\/api\/#article","isPartOf":{"@id":"https:\/\/help.qapla.it\/en\/api\/"},"author":{"name":"Gabriela Sifuentes","@id":"https:\/\/help.qapla.it\/en\/#\/schema\/person\/878122abbf5f8a5a392941fdf4f498aa"},"headline":"API","datePublished":"2025-09-03T10:29:04+00:00","dateModified":"2025-09-15T09:42:08+00:00","mainEntityOfPage":{"@id":"https:\/\/help.qapla.it\/en\/api\/"},"wordCount":750,"image":{"@id":"https:\/\/help.qapla.it\/en\/api\/#primaryimage"},"thumbnailUrl":"http:\/\/help.qapla.it\/wp-content\/uploads\/2025\/09\/EN-API-KEY-1024x194.png","articleSection":["Information For Developers"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/help.qapla.it\/en\/api\/","url":"https:\/\/help.qapla.it\/en\/api\/","name":"API - Qapla' Help","isPartOf":{"@id":"https:\/\/help.qapla.it\/en\/#website"},"primaryImageOfPage":{"@id":"https:\/\/help.qapla.it\/en\/api\/#primaryimage"},"image":{"@id":"https:\/\/help.qapla.it\/en\/api\/#primaryimage"},"thumbnailUrl":"http:\/\/help.qapla.it\/wp-content\/uploads\/2025\/09\/EN-API-KEY-1024x194.png","datePublished":"2025-09-03T10:29:04+00:00","dateModified":"2025-09-15T09:42:08+00:00","author":{"@id":"https:\/\/help.qapla.it\/en\/#\/schema\/person\/878122abbf5f8a5a392941fdf4f498aa"},"description":"Qapla\u2019 API Guide The\u00a0APIs\u00a0provide the ability to integrate Qapla\u2019 both for reading and writing with your proprietary ecommerce system or one for which a","breadcrumb":{"@id":"https:\/\/help.qapla.it\/en\/api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/help.qapla.it\/en\/api\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/help.qapla.it\/en\/api\/#primaryimage","url":"http:\/\/help.qapla.it\/wp-content\/uploads\/2025\/09\/EN-API-KEY-1024x194.png","contentUrl":"http:\/\/help.qapla.it\/wp-content\/uploads\/2025\/09\/EN-API-KEY-1024x194.png"},{"@type":"BreadcrumbList","@id":"https:\/\/help.qapla.it\/en\/api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/help.qapla.it\/en\/"},{"@type":"ListItem","position":2,"name":"API"}]},{"@type":"WebSite","@id":"https:\/\/help.qapla.it\/en\/#website","url":"https:\/\/help.qapla.it\/en\/","name":"Qapla' Help","description":"Knowledge base","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/help.qapla.it\/en\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/help.qapla.it\/en\/#\/schema\/person\/878122abbf5f8a5a392941fdf4f498aa","name":"Gabriela Sifuentes","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/834f61704200af858f1e448327e4ecad263c7c4d0a2e481df25014002526e276?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/834f61704200af858f1e448327e4ecad263c7c4d0a2e481df25014002526e276?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/834f61704200af858f1e448327e4ecad263c7c4d0a2e481df25014002526e276?s=96&d=mm&r=g","caption":"Gabriela Sifuentes"},"url":"https:\/\/help.qapla.it\/en\/author\/gabriela\/"}]}},"_links":{"self":[{"href":"https:\/\/help.qapla.it\/en\/wp-json\/wp\/v2\/posts\/7979","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.qapla.it\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/help.qapla.it\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/help.qapla.it\/en\/wp-json\/wp\/v2\/users\/6"}],"replies":[{"embeddable":true,"href":"https:\/\/help.qapla.it\/en\/wp-json\/wp\/v2\/comments?post=7979"}],"version-history":[{"count":7,"href":"https:\/\/help.qapla.it\/en\/wp-json\/wp\/v2\/posts\/7979\/revisions"}],"predecessor-version":[{"id":8117,"href":"https:\/\/help.qapla.it\/en\/wp-json\/wp\/v2\/posts\/7979\/revisions\/8117"}],"wp:attachment":[{"href":"https:\/\/help.qapla.it\/en\/wp-json\/wp\/v2\/media?parent=7979"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/help.qapla.it\/en\/wp-json\/wp\/v2\/categories?post=7979"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/help.qapla.it\/en\/wp-json\/wp\/v2\/tags?post=7979"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}} - Courier\u2019s codes<\/strong><\/a>\u00a0is the list of Qapla\u2019 courier codes in alphabetical order.<\/li>\n<\/ul>\n
- Qapla\u2019 Status<\/a><\/strong>\u00a0is the interpretation of the shipment status with values assigned by Qapla\u2019 to each possible courier status.<\/li>\n
- checkChannel<\/strong><\/a> allows you to verify the connections with the platform and the marketplaces configured on the channel.<\/li>\n
- getChannel<\/a><\/strong> allows you to obtain information about the channel linked to the API Key and the company that created it.<\/li>\n
- detectCourier<\/a><\/strong>\u00a0tries to determine the courier from the provided tracking number, responding with a list of couriers.<\/li>\n
- checkLabel<\/a>\u00a0<\/strong>to check the status of a previously created label on Qapla\u2019.<\/li>\n
- confirmLabel<\/a>\u00a0<\/strong>allows you to transmit created shipments to the courier to complete the shipment generation. The response returns the loading list (border\u00f2\/manifest) in PDF format.<\/li>\n<\/ul>\n
- updatePlatformOrder<\/a>\u00a0<\/strong>allows you to update orders on a platform. For the use of this API, the CMS and\/or Marketplace must be configured.<\/li>\n<\/ul>\n
- trackingByTimeFrame<\/a>\u00a0<\/strong>allows you to get the list of shipments that have had a tracking status update within the requested range.<\/li>\n
- getShipment<\/a><\/strong> to retrieve information and read the status of a shipment.<\/li>\n
- pushShipment<\/a>\u00a0<\/strong>to upload one or more shipments.<\/li>\n
- getOrder<\/a>\u00a0<\/strong>to retrieve order information.<\/li>\n
- Shipments<\/strong><\/li>\n