Light Mode

Migration to the New API

We in Salla are delighted to introduce our latest API for the Shipping App, which is designed to provide a more efficient and reliable shipping management process. The new API features a variety of new endpoints and webhooks, which are essential for enhancing the merchant experience and simplifying the management of multiple shipments from various locations.

:::caution[Alert]
Migrating to the new API is highly recommended to ensure that the Shipping App can take advantage of the latest features and benefits. The new API is designed to give merchants more control over their shipments and more information about where they are in the shipping process.
:::

In this article, we'll go into more about the new API. We'll compare the old and new APIs to give a full rundown of the benefits of switching to the new API.

Old vs. New Webhooks

The webhooks for our shipping app have been updated to a new and improved version to enhance the merchant experience. Here's a comparison between the old and new webhooks:

	Old Webhooks	New Webhooks
Purpose	Trigger events when orders or shipments are created, returned, or canceled.	Trigger only two webhooks when shipments are created, retuned, or canceled.
Webhook Names	`order.shipment.creating` `order.shipment.return.creating` `order.shipment.cancelled` `order.shipment.return.cancelled`	`shipment.creatingshipment.created` `shipment cancelled`

As you can see, the old webhooks were designed to trigger events when orders or shipments were being created, returned, or canceled. The new webhooks have been streamlined to have only two webhooks providing greater clarity and simplicity for developers to work with. The new webhooks, shipment.creating, shipment.created, and shipment.cancelled, trigger events when shipments are created, returned, or canceled, respectively.

:::tip[Note]
The new webhooks provide an updated and more efficient way of handling shipments and the process of creating and canceling them. Updating to the new webhooks will allow merchants to enjoy a more streamlined and hassle-free shipping experience.
:::

Old vs. New Endpoints

The endpoints for our shipping app have been updated to a new and improved version to provide greater flexibility and efficiency when managing shipments. Here's a comparison between the old and new endpoints:

	Old Endpoints	New Endpoints
Purpose	Used to update, list, and cancel order shipments.	Used to create, list, update, cancel, and return shipments.
Endpoint URLs	`GET /orders/{order_id}/shipments` `PUT /orders/{order_id}/update-shipment` `POST /orders/{order_id}/cancel-shipment`	`POST /shipments` `GET /shipments` `PUT /shipments/{shipment_id}` `GET /shipments/{shipment_id}` `POST /shipments/{shipment_id}/cancel` `POST /shipments/{shipment_id}/return`

As you can see, the old endpoints were designed to update, list, and cancel order shipments. In contrast, the new endpoints provide greater flexibility and efficiency, allowing merchants to create, list, update, cancel, and return shipments. The new endpoints provide a more clearly defined and intuitive actions to enable a more seamless shipping experience.

:::tip[Note]
Updating to the new endpoints will allow merchants to manage their shipments more effectively, providing greater control and visibility of their shipments. The new endpoints also simplify the process of creating and managing shipments, which can reduce time and resource demands for merchants.
:::

In conclusion, the new APIs for our shipping app with their new webhooks and endpoints provide better functionality, reliability, and ease of use than the old APIs. The new webhooks and endpoints are simpler, more intuitive, making it easier for developers to use them. We highly recommend our users to migrate to the new APIs as soon as possible to take advantage of these improvements and avoid any disruption of service.

Last modified: 3 months ago