Push Mechanism#
Subscribing to Omisell Push Mechanism helps you get immediate notifications when a specific event occurs. This lets you receive timely updates without having to periodically poll the API endpoint.⚠️ Note: Push Mechanism on the Omisell Platform Console is equivalent to what’s commonly known as webhooks.Here’s an overview of how Push Mechanism works on Omisell Open Platform:You subscribe to a specific push type for your platform and define a callback URL.
The specific event, such as an order status update, happens.
Omisell sends an HTTP POST request to the defined callback URL.
You receive a notification via your defined callback URL.
Understanding Push Mechanism notifications#
There are 3 categories of webhooks (Push) available on Omisell Platform:1. Order - Webhooks for order status and tracking number updates, return orders processed.
2. Shipment - Webhooks for shipment status and tracking number updates, return orders processed.
3. Return order - Webhooks for return order status and tracking number updates, return orders processed.
4. Sale invoiceRead more about these Push notifications below, ordered by popularity.How to set up webhook#
1.Setting webhook#
2. Add Hook#
3. Monitoring API Call & Push Log#
4. Push Authorization#
To prevent cyberattacks, we have provided an authorization signature for each Push request, which can be located in the Authorization field of the HTTP request header. With this, you can identify Omisell's authorization information.This step is technically optional, but we strongly recommend that developers use the following steps to validate the request to generate the authorization signature, ensuring that it matches the authorization signature generated from the Push request. Here's how you can generate the signature:Example of Omisell's request headers:Retry Rules#
Developers are required to provide a proper response to declare having received the notification successfully. Please return http header code 200 within 3 seconds for each notification, otherwise retries will be triggered as the follows:| Retry Times | Trigger Point |
|---|
| 1st Retry | 2 minutes after the initial push failure |
| 2nd Retry | 30 minutes after the 1st retry failure |
| 3rd Retry | 3 hours after the 2nd retry failure No further attempt will be made after the 3th retry failure |
Note: You need to rely on the request_id to check for the duplicate data before processing.Events#
1. Order Status Push#
| Event | Event name | Description |
|---|
| order.all | Order push | All key status as below |
| order.created | Order create | Push new order |
| order.ready_to_ship | Order RTS | Push when order status is RTS |
| order.shipped | Order Shipped | Push when order status is Shipped |
| order.completed | Order Completed | Push when order status is Completed |
| order.returned | Order Returned | Push when order status is Returned |
| order.cancelled | Order Cancelled | Push when order status is Cancelled |
| order.reconciled | Order Reconciled | Push when order status is Reconciled |
| order.return_receive | Returns Order Received | Push when returns order already received & restock at warehouse |
2. Shipment (DO) Status Push#
| Event | Event name | Description |
|---|
| shipment.all | Shipment push | All key status |
| shipment.created | Shipment create | Push new shipment |
| shipment.ready_to_ship | Shipment RTS | Push when shipment status is RTS |
| shipment.shipped | Shipment Shipped | Push when shipment status is Shipped |
| shipment.delivered | Shipment Delivered | Push when shipment status is Delivered |
| shipment.returned | Shipment Returned | Push when shipment status is Returned |
| shipment.cancelled | Shipment Cancelled | Push when shipment status is Cancelled |
3. Returns Order Push#
| Event | Event name | Description |
|---|
| order_return.all | Return push | All key status |
4. Sale Invoice Push#
| Event | Event name | Description |
|---|
| order.si.generate | Sale Invoice Request | All key status |
Modified at 2024-09-25 02:28:58
