Shopee Open Platform

https://open.shopee.com/
Admin
Shopee Open Platform is an e-commerce API platform that empowers merchants with tools to manage...
Tokens:4,925
Snippets:74
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Push Mechanism Order Action Payloads

Source: https://open.shopee.com/push-mechanism/5

JSON payloads representing order-related events sent via the push mechanism. These examples illustrate the structure for place_order and cancel_order actions.

```json
{"data":{"shop_id":1274495,"item_id":18614185187,"variation_id":87912785718,"changed_values":[{"name":"reserved_stock","old":4951,"new":4950}],"promotion_type":"flash_sale","promotion_id":104993304719361,"action":"place_order","ordersn":"220810QXVJM3EX","update_time":1660124246},"shop_id":1274495,"code":8,"timestamp":1660124246}
```

```json
{"data":{"shop_id":1274495,"item_id":19213740442,"variation_id":154918396482,"changed_values":[{"name":"reserved_stock","old":199,"new":200}],"promotion_type":"flash_sale","promotion_id":103363389812736,"action":"cancel_order","ordersn":"220809KS77DXTS","update_time":1660124321},"shop_id":1274495,"code":8,"timestamp":1660124321}
```

--------------------------------

### Push Notification: place_order

Source: https://open.shopee.com/push-mechanism/5

Represents the data structure sent when an order is placed.

```APIDOC
## Push Event: place_order

### Description
Triggered when an order is successfully placed.

### Request Body
- **shop_id** (integer) - The ID of the shop.
- **code** (integer) - The event code.
- **timestamp** (integer) - The time the event occurred.
- **data** (object) - The event payload containing order details, item information, and changed values like reserved_stock.

### Example
{
  "data": {
    "shop_id": 1274495,
    "item_id": 18614185187,
    "variation_id": 87912785718,
    "changed_values": [{"name": "reserved_stock", "old": 4951, "new": 4950}],
    "promotion_type": "flash_sale",
    "promotion_id": 104993304719361,
    "action": "place_order",
    "ordersn": "220810QXVJM3EX",
    "update_time": 1660124246
  },
  "shop_id": 1274495,
  "code": 8,
  "timestamp": 1660124246
}
```

--------------------------------

### reserved_stock_change_push

Source: https://open.shopee.com/push-mechanism/5

The reserved_stock_change_push mechanism notifies external systems of changes to reserved stock levels, including details on the item, variation, and the specific action taken.

```APIDOC
## reserved_stock_change_push

### Description
This push notification provides logs for reserved stock changes. It is triggered by events such as placing or canceling orders.

### Push Parameters
- **data** (object) - Main Push message info
  - **shop_id** (int) - Shopee's unique identifier for a shop.
  - **item_id** (int) - Shopee's unique identifier for an item.
  - **variation_id** (int) - Shopee's unique identifier for a variation of an item.
  - **changed_values** (object[]) - Changed event details:
    - **name** (string) - The field value changed (e.g., "reserved_stock").
    - **old** (int) - The value before change.
    - **new** (int) - The value after change.
    - **promotion_type** (string) - The type of promotion associated with the change.
    - **promotion_id** (int) - The identity of item promotion.
    - **action** (string) - The action of the event ("place_order" or "cancel_order").
    - **ordersn** (string) - The ordersn associated with the event.
    - **update_time** (string) - The time of event.
- **shop_id** (int) - Shopee's unique identifier for a shop.
- **code** (int) - Shopee's unique identifier for a push notification (8).
- **timestamp** (timestamp) - Timestamp that indicates the message was sent.
```

--------------------------------

### Push Notification: cancel_order

Source: https://open.shopee.com/push-mechanism/5

Represents the data structure sent when an order is cancelled.

```APIDOC
## Push Event: cancel_order

### Description
Triggered when an order is cancelled.

### Request Body
- **shop_id** (integer) - The ID of the shop.
- **code** (integer) - The event code.
- **timestamp** (integer) - The time the event occurred.
- **data** (object) - The event payload containing order details, item information, and changed values like reserved_stock.

### Example
{
  "data": {
    "shop_id": 1274495,
    "item_id": 19213740442,
    "variation_id": 154918396482,
    "changed_values": [{"name": "reserved_stock", "old": 199, "new": 200}],
    "promotion_type": "flash_sale",
    "promotion_id": 103363389812736,
    "action": "cancel_order",
    "ordersn": "220809KS77DXTS",
    "update_time": 1660124321
  },
  "shop_id": 1274495,
  "code": 8,
  "timestamp": 1660124321
}
```
Tokens:
Raw