Shopee setup guide

Agents look after orders, products and customers in your store.

Ways to connect

Company admins connect apps, on the Integrations page in Everdeck: open Shopee, choose one of the ways below, follow its steps and fill in its fields. Everdeck checks what you enter before it saves anything, and asks you to confirm it’s you (your second factor) before you type any secret. How connecting works.

Your Shopee Open Platform app (Seller In-house System)

Your OAuth app.

This way signs in with an OAuth app you create for Shopee, as its steps describe: Everdeck never uses an app of its own. Register this redirect URI with your app:

https://everdeck.io/api/oauth/callback

Then save the app’s client ID and secret in Everdeck, on the connect page or under OAuth apps, and sign in.

1. Sign in at https://open.shopee.com with a developer account registered as a Shopee seller (Individual Seller or Registered Business Seller) and approved by Shopee.
2. In the Console create an App of type Seller In-house System. In the app's settings set the Live Redirect URL Domain to the domain of https://everdeck.io/api/oauth/callback.
3. Submit the app with Go Live. Shopee reviews it (allow 24 hours), including a Declaration of IT Assets: list Everdeck's outbound IP addresses (ask Everdeck support for the current list of addresses).
4. Once live, copy the Live Partner ID into Client ID and the Live Key into Client secret.
5. Click Connect, log in with the shop's main or shop account (not a sub-account), confirm the authorization and choose how long it lasts (up to 365 days).

Field	What to enter
Authorization site (optional)	Choice: Global (all markets except Brazil and mainland China), Brazil, Mainland China developers. Starts as https://open.shopee.com.

Disconnecting deletes the tokens Everdeck saved. Shopee's cancel_auth_partner is a page the seller opens in a browser, not a server call.

What agents can do

An agent uses an action only when its charter grants it, on the agent’s Tools tab, where you choose whether each one runs by itself (Auto), asks first or never runs. Each action has a risk tier: tier 3 actions, which customers or the public see, ask first unless you choose otherwise, and tier 4 actions (money, deleting things, access) always need a person. How tools and tiers work.

Actions marked Reads outside content return things people outside your company may have written. Agents treat what they read as information, never as instructions, and their riskier actions later in the same session need approval.

• List ordersTier 0 · ReadReads outside contentshopee_list_orders

  List order numbers created or updated in a time window of at most 15 days, optionally with one status. Returns order_sn and status; use get_orders for details.

• Read ordersTier 0 · ReadReads outside contentshopee_get_orders

  Read up to 50 orders by order_sn: status, buyer, recipient address (masked in some markets), items, total, payment method, carrier, ship-by date, packages, seller note and cancellation details.

• Set the seller's order noteTier 2 · ReversibleReads outside contentshopee_set_order_note

  Set the seller's private note on an order (replaces the existing note). Buyers don't see it.

• Cancel an orderTier 4 · Money or irreversibleReads outside contentshopee_cancel_order

  Cancel an order that hasn't shipped, with a reason. OUT_OF_STOCK needs the out-of-stock items. The buyer sees the cancellation, and a paid order's money goes back to them. Cannot be undone.

• Get shipping options for an orderTier 0 · ReadReads outside contentshopee_get_shipping_parameter

  Before arranging shipment, read what the order's logistics channel needs: pickup addresses and time slots, drop-off branches, or a tracking number for non-integrated channels.

• Arrange shipmentTier 3 · ExternalReads outside contentshopee_ship_order

  Arrange pickup, drop-off or (non-integrated channels) enter a tracking number for an order, using the options from get_shipping_parameter. The order moves to processed and the buyer sees the progress.

• Search productsTier 0 · ReadReads outside contentshopee_search_items

  Find product ids by name or SKU, optionally by status. Use get_items for details.

• Read productsTier 0 · ReadReads outside contentshopee_get_items

  Read up to 50 products: name, SKU, status, description, category, price (for items without variations), stock, whether it has variations and promotion flags.

• Read a product's variationsTier 0 · ReadReads outside contentshopee_get_models

  Read a product's variations (models) with SKU, price, stock by location and status.

• Update stockTier 2 · ReversibleReads outside contentshopee_update_stock

  Set the seller stock of an item or of its variations (model_id 0 for items without variations). Stock can't go below what's reserved for running promotions.

• Update pricesTier 4 · Money or irreversibleReads outside contentshopee_update_price

  Set the original (list) price of an item or of its variations (model_id 0 for items without variations), in the shop's currency. Shops in SG, MY, BR, MX, PL, ES and AR may use two decimal places; other markets accept whole numbers only. Takes effect on the storefront at once.

• List return and refund requestsTier 0 · ReadReads outside contentshopee_list_returns

  List return/refund requests by creation or update time (windows of at most 15 days) and status, with reason, refund amount, items, buyer and due dates.

What can start work

These events from Shopee can become tasks for your agents through Intake. How Intake works.

An order's status changed, including new paid orders and cancellations (checked every 5 minutes).

Connect Shopee first. Then, on the Intake page, open Webhooks and sources, find it under Connector triggers and select Start watching. Then, on the Rules tab, select New rule to say which requests become tasks and who gets them.

Testing, problems and disconnecting

Everdeck checks the connection when you save it. On the connection’s page in Integrations, Test checks it again at any time.

If Shopee later refuses the connection, for example because a key was deleted or a sign-in expired, the connection shows Needs attention on the Integrations page and the people who manage connections are told. Agents can’t use it until a company admin fixes it with Edit or Reconnect.

To stop agents using Shopee, open the connection and select Disconnect. Agents stop using it at once and its saved credentials are deleted. What else happens depends on how it was connected: each way above says.